src/rx/rx_event.c

   1 /*
   2  * Copyright 2000, International Business Machines Corporation and others.
   3  * All Rights Reserved.
   4  *
   5  * This software has been released under the terms of the IBM Public
   6  * License.  For details, see the LICENSE file in the top-level source
   7  * directory or online at http://www.openafs.org/dl/license10.html
   8  */
   9
  10 #include <afsconfig.h>
  11 #ifdef  KERNEL
  12 #include "afs/param.h"
  13 #else
  14 #include <afs/param.h>
  15 #endif
  16
  17 #ifdef AFS_SUN59_ENV
  18 #include <sys/time_impl.h>
  19 #endif
  20
  21 RCSID
  22     ("$Header$");
  23
  24 #ifdef KERNEL
  25 #ifndef UKERNEL
  26 #include "afs/afs_osi.h"
  27 #else /* !UKERNEL */
  28 #include "afs/sysincludes.h"
  29 #include "afsincludes.h"
  30 #endif /* !UKERNEL */
  31 #include "rx/rx_clock.h"
  32 #include "rx/rx_queue.h"
  33 #include "rx/rx_event.h"
  34 #include "rx/rx_kernel.h"
  35 #include "rx_kmutex.h"
  36 #ifdef RX_ENABLE_LOCKS
  37 #include "rx/rx.h"
  38 #endif /* RX_ENABLE_LOCKS */
  39 #include "rx/rx_globals.h"
  40 #if defined(AFS_SGI_ENV)
  41 #include "sys/debug.h"
  42 /* These are necessary to get curproc (used by GLOCK asserts) to work. */
  43 #include "h/proc.h"
  44 #if !defined(AFS_SGI64_ENV) && !defined(UKERNEL)
  45 #include "h/user.h"
  46 #endif
  47 extern void *osi_Alloc();
  48 #endif
  49 #if defined(AFS_OBSD_ENV)
  50 #include "h/proc.h"
  51 #endif
  52 #else /* KERNEL */
  53 #include <stdio.h>
  54 #include "rx_clock.h"
  55 #include "rx_queue.h"
  56 #include "rx_event.h"
  57 #include "rx_user.h"
  58 #ifdef AFS_PTHREAD_ENV
  59 #include <rx/rx_pthread.h>
  60 #else
  61 #include "rx_lwp.h"
  62 #endif
  63 #ifdef RX_ENABLE_LOCKS
  64 #include "rx.h"
  65 #endif /* RX_ENABLE_LOCKS */
  66 #include "rx_globals.h"
  67 #ifdef AFS_NT40_ENV
  68 #include <malloc.h>
  69 #endif
  70 #endif /* KERNEL */
  71
  72
  73 /* All event processing is relative to the apparent current time given by clock_GetTime */
  74
  75 /* This should be static, but event_test wants to look at the free list... */
  76 struct rx_queue rxevent_free;   /* It's somewhat bogus to use a doubly-linked queue for the free list */
  77 struct rx_queue rxepoch_free;   /* It's somewhat bogus to use a doubly-linked queue for the free list */
  78 static struct rx_queue rxepoch_queue;   /* list of waiting epochs */
  79 static int rxevent_allocUnit = 10;      /* Allocation unit (number of event records to allocate at one time) */
  80 static int rxepoch_allocUnit = 10;      /* Allocation unit (number of epoch records to allocate at one time) */
  81 int rxevent_nFree;              /* Number of free event records */
  82 int rxevent_nPosted;            /* Current number of posted events */
  83 int rxepoch_nFree;              /* Number of free epoch records */
  84 static void (*rxevent_ScheduledEarlierEvent) (void);    /* Proc to call when an event is scheduled that is earlier than all other events */
  85 struct xfreelist {
  86     void *mem;
  87     int size;
  88     struct xfreelist *next;
  89 };
  90 static struct xfreelist *xfreemallocs = 0, *xsp = 0;
  91
  92 struct clock rxevent_nextRaiseEvents;   /* Time of next call to raise events */
  93 int rxevent_raiseScheduled;     /* true if raise events is scheduled */
  94
  95 #ifdef RX_ENABLE_LOCKS
  96 #ifdef RX_LOCKS_DB
  97 /* rxdb_fileID is used to identify the lock location, along with line#. */
  98 static int rxdb_fileID = RXDB_FILE_RX_EVENT;
  99 #endif /* RX_LOCKS_DB */
 100 #define RX_ENABLE_LOCKS  1
 101 afs_kmutex_t rxevent_lock;
 102 #endif /* RX_ENABLE_LOCKS */
 103
 104 #ifdef AFS_PTHREAD_ENV
 105 /*
 106  * This mutex protects the following global variables:
 107  * rxevent_initialized
 108  */
 109
 110 #include <assert.h>
 111 pthread_mutex_t rx_event_mutex;
 112 #define LOCK_EV_INIT assert(pthread_mutex_lock(&rx_event_mutex)==0)
 113 #define UNLOCK_EV_INIT assert(pthread_mutex_unlock(&rx_event_mutex)==0)
 114 #else
 115 #define LOCK_EV_INIT
 116 #define UNLOCK_EV_INIT
 117 #endif /* AFS_PTHREAD_ENV */
 118
 119
 120 /* Pass in the number of events to allocate at a time */
 121 int rxevent_initialized = 0;
 122 void
 123 rxevent_Init(int nEvents, void (*scheduler) (void))
 124 {
 125     LOCK_EV_INIT;
 126     if (rxevent_initialized) {
 127         UNLOCK_EV_INIT;
 128         return;
 129     }
 130     MUTEX_INIT(&rxevent_lock, "rxevent_lock", MUTEX_DEFAULT, 0);
 131     clock_Init();
 132     if (nEvents)
 133         rxevent_allocUnit = nEvents;
 134     queue_Init(&rxevent_free);
 135     queue_Init(&rxepoch_free);
 136     queue_Init(&rxepoch_queue);
 137     rxevent_nFree = rxevent_nPosted = 0;
 138     rxepoch_nFree = 0;
 139     rxevent_ScheduledEarlierEvent = scheduler;
 140     rxevent_initialized = 1;
 141     clock_Zero(&rxevent_nextRaiseEvents);
 142     rxevent_raiseScheduled = 0;
 143     UNLOCK_EV_INIT;
 144 }
 145
 146 /* Create and initialize new epoch structure */
 147 struct rxepoch *
 148 rxepoch_Allocate(struct clock *when)
 149 {
 150     struct rxepoch *ep;
 151     int i;
 152
 153     /* If we are short on free epoch entries, create a block of new oned
 154      * and add them to the free queue */
 155     if (queue_IsEmpty(&rxepoch_free)) {
 156 #if    defined(AFS_AIX32_ENV) && defined(KERNEL)
 157         ep = (struct rxepoch *)rxi_Alloc(sizeof(struct rxepoch));
 158         queue_Append(&rxepoch_free, &ep[0]), rxepoch_nFree++;
 159 #else
 160         ep = (struct rxepoch *)
 161             osi_Alloc(sizeof(struct rxepoch) * rxepoch_allocUnit);
 162         xsp = xfreemallocs;
 163         xfreemallocs =
 164             (struct xfreelist *)osi_Alloc(sizeof(struct xfreelist));
 165         xfreemallocs->mem = (void *)ep;
 166         xfreemallocs->size = sizeof(struct rxepoch) * rxepoch_allocUnit;
 167         xfreemallocs->next = xsp;
 168         for (i = 0; i < rxepoch_allocUnit; i++)
 169             queue_Append(&rxepoch_free, &ep[i]), rxepoch_nFree++;
 170 #endif
 171     }
 172     ep = queue_First(&rxepoch_free, rxepoch);
 173     queue_Remove(ep);
 174     rxepoch_nFree--;
 175     ep->epochSec = when->sec;
 176     queue_Init(&ep->events);
 177     return ep;
 178 }
 179
 180 /* Add the indicated event (function, arg) at the specified clock time.  The
 181  * "when" argument specifies when "func" should be called, in clock (clock.h)
 182  * units. */
 183
 184 #if 0
 185 struct rxevent *
 186 rxevent_Post(struct clock *when,
 187              void (*func) (struct rxevent * event,
 188                            struct rx_connection * conn,
 189                            struct rx_call * acall), void *arg, void *arg1)
 190 #else
 191 struct rxevent *
 192 rxevent_Post(struct clock *when, void (*func) (), void *arg, void *arg1)
 193 #endif
 194 {
 195     register struct rxevent *ev, *evqe, *evqpr;
 196     register struct rxepoch *ep, *epqe, *epqpr;
 197     int isEarliest = 0;
 198
 199     MUTEX_ENTER(&rxevent_lock);
 200     AFS_ASSERT_RXGLOCK();
 201 #ifdef RXDEBUG
 202     if (rx_Log_event) {
 203         struct clock now;
 204         clock_GetTime(&now);
 205         fprintf(rx_Log_event, "%d.%d: rxevent_Post(%d.%d, %x, %x)\n",
 206                 (int)now.sec, (int)now.usec, (int)when->sec, (int)when->usec,
 207                 (unsigned int)func, (unsigned int)arg);
 208     }
 209 #endif
 210
 211     /* Get a pointer to the epoch for this event, if none is found then
 212      * create a new epoch and insert it into the sorted list */
 213     for (ep = NULL, queue_ScanBackwards(&rxepoch_queue, epqe, epqpr, rxepoch)) {
 214         if (when->sec == epqe->epochSec) {
 215             /* already have an structure for this epoch */
 216             ep = epqe;
 217             if (ep == queue_First(&rxepoch_queue, rxepoch))
 218                 isEarliest = 1;
 219             break;
 220         } else if (when->sec > epqe->epochSec) {
 221             /* Create a new epoch and insert after qe */
 222             ep = rxepoch_Allocate(when);
 223             queue_InsertAfter(epqe, ep);
 224             break;
 225         }
 226     }
 227     if (ep == NULL) {
 228         /* Create a new epoch and place it at the head of the list */
 229         ep = rxepoch_Allocate(when);
 230         queue_Prepend(&rxepoch_queue, ep);
 231         isEarliest = 1;
 232     }
 233
 234     /* If we're short on free event entries, create a block of new ones and add
 235      * them to the free queue */
 236     if (queue_IsEmpty(&rxevent_free)) {
 237         register int i;
 238 #if     defined(AFS_AIX32_ENV) && defined(KERNEL)
 239         ev = (struct rxevent *)rxi_Alloc(sizeof(struct rxevent));
 240         queue_Append(&rxevent_free, &ev[0]), rxevent_nFree++;
 241 #else
 242         ev = (struct rxevent *)osi_Alloc(sizeof(struct rxevent) *
 243                                          rxevent_allocUnit);
 244         xsp = xfreemallocs;
 245         xfreemallocs =
 246             (struct xfreelist *)osi_Alloc(sizeof(struct xfreelist));
 247         xfreemallocs->mem = (void *)ev;
 248         xfreemallocs->size = sizeof(struct rxevent) * rxevent_allocUnit;
 249         xfreemallocs->next = xsp;
 250         for (i = 0; i < rxevent_allocUnit; i++)
 251             queue_Append(&rxevent_free, &ev[i]), rxevent_nFree++;
 252 #endif
 253     }
 254
 255     /* Grab and initialize a new rxevent structure */
 256     ev = queue_First(&rxevent_free, rxevent);
 257     queue_Remove(ev);
 258     rxevent_nFree--;
 259
 260     /* Record user defined event state */
 261     ev->eventTime = *when;
 262     ev->func = func;
 263     ev->arg = arg;
 264     ev->arg1 = arg1;
 265     rxevent_nPosted += 1;       /* Rather than ++, to shut high-C up
 266                                  *  regarding never-set variables
 267                                  */
 268
 269     /* Insert the event into the sorted list of events for this epoch */
 270     for (queue_ScanBackwards(&ep->events, evqe, evqpr, rxevent)) {
 271         if (when->usec >= evqe->eventTime.usec) {
 272             /* Insert event after evqe */
 273             queue_InsertAfter(evqe, ev);
 274             MUTEX_EXIT(&rxevent_lock);
 275             return ev;
 276         }
 277     }
 278     /* Insert event at head of current epoch */
 279     queue_Prepend(&ep->events, ev);
 280     if (isEarliest && rxevent_ScheduledEarlierEvent
 281         && (!rxevent_raiseScheduled
 282             || clock_Lt(&ev->eventTime, &rxevent_nextRaiseEvents))) {
 283         rxevent_raiseScheduled = 1;
 284         clock_Zero(&rxevent_nextRaiseEvents);
 285         MUTEX_EXIT(&rxevent_lock);
 286         /* Notify our external scheduler */
 287         (*rxevent_ScheduledEarlierEvent) ();
 288         MUTEX_ENTER(&rxevent_lock);
 289     }
 290     MUTEX_EXIT(&rxevent_lock);
 291     return ev;
 292 }
 293
 294 /* Cancel an event by moving it from the event queue to the free list.
 295  * Warning, the event must be on the event queue!  If not, this should core
 296  * dump (reference through 0).  This routine should be called using the macro
 297  * event_Cancel, which checks for a null event and also nulls the caller's
 298  * event pointer after cancelling the event.
 299  */
 300 #ifdef RX_ENABLE_LOCKS
 301 #ifdef RX_REFCOUNT_CHECK
 302 int rxevent_Cancel_type = 0;
 303 #endif
 304 #endif
 305
 306 void
 307 rxevent_Cancel_1(register struct rxevent *ev, register struct rx_call *call,
 308                  register int type)
 309 {
 310 #ifdef RXDEBUG
 311     if (rx_Log_event) {
 312         struct clock now;
 313         clock_GetTime(&now);
 314         fprintf(rx_Log_event, "%d.%d: rxevent_Cancel_1(%d.%d, %x, %x)\n",
 315                 (int)now.sec, (int)now.usec, (int)ev->eventTime.sec,
 316                 (int)ev->eventTime.usec, (unsigned int)ev->func,
 317                 (unsigned int)ev->arg);
 318     }
 319 #endif
 320     /* Append it to the free list (rather than prepending) to keep the free
 321      * list hot so nothing pages out
 322      */
 323     AFS_ASSERT_RXGLOCK();
 324     MUTEX_ENTER(&rxevent_lock);
 325     if (!ev) {
 326         MUTEX_EXIT(&rxevent_lock);
 327         return;
 328     }
 329 #ifdef RX_ENABLE_LOCKS
 330     /* It's possible we're currently processing this event. */
 331     if (queue_IsOnQueue(ev)) {
 332         queue_MoveAppend(&rxevent_free, ev);
 333         rxevent_nPosted--;
 334         rxevent_nFree++;
 335         if (call) {
 336             call->refCount--;
 337 #ifdef RX_REFCOUNT_CHECK
 338             call->refCDebug[type]--;
 339             if (call->refCDebug[type] < 0) {
 340                 rxevent_Cancel_type = type;
 341                 osi_Panic("rxevent_Cancel: call refCount < 0");
 342             }
 343 #endif /* RX_REFCOUNT_CHECK */
 344         }
 345     }
 346 #else /* RX_ENABLE_LOCKS */
 347     queue_MoveAppend(&rxevent_free, ev);
 348     rxevent_nPosted--;
 349     rxevent_nFree++;
 350 #endif /* RX_ENABLE_LOCKS */
 351     MUTEX_EXIT(&rxevent_lock);
 352 }
 353
 354 /* Process all epochs that have expired relative to the current clock time
 355  * (which is not re-evaluated unless clock_NewTime has been called).  The
 356  * relative time to the next epoch is returned in the output parameter next
 357  * and the function returns 1.  If there are is no next epoch, the function
 358  * returns 0.
 359  */
 360 int
 361 rxevent_RaiseEvents(struct clock *next)
 362 {
 363     register struct rxepoch *ep;
 364     register struct rxevent *ev;
 365     volatile struct clock now;
 366
 367     MUTEX_ENTER(&rxevent_lock);
 368
 369     AFS_ASSERT_RXGLOCK();
 370
 371     /* Events are sorted by time, so only scan until an event is found that has
 372      * not yet timed out */
 373
 374     clock_Zero(&now);
 375     while (queue_IsNotEmpty(&rxepoch_queue)) {
 376         ep = queue_First(&rxepoch_queue, rxepoch);
 377         if (queue_IsEmpty(&ep->events)) {
 378             queue_Remove(ep);
 379             queue_Append(&rxepoch_free, ep);
 380             rxepoch_nFree++;
 381             continue;
 382         }
 383         do {
 384             ev = queue_First(&ep->events, rxevent);
 385             if (clock_Lt(&now, &ev->eventTime)) {
 386                 clock_GetTime(&now);
 387                 if (clock_Lt(&now, &ev->eventTime)) {
 388                     *next = rxevent_nextRaiseEvents = ev->eventTime;
 389                     rxevent_raiseScheduled = 1;
 390                     clock_Sub(next, &now);
 391                     MUTEX_EXIT(&rxevent_lock);
 392                     return 1;
 393                 }
 394             }
 395             queue_Remove(ev);
 396             rxevent_nPosted--;
 397             MUTEX_EXIT(&rxevent_lock);
 398             ev->func(ev, ev->arg, ev->arg1);
 399             MUTEX_ENTER(&rxevent_lock);
 400             queue_Append(&rxevent_free, ev);
 401             rxevent_nFree++;
 402         } while (queue_IsNotEmpty(&ep->events));
 403     }
 404 #ifdef RXDEBUG
 405     if (rx_Log_event)
 406         fprintf(rx_Log_event, "rxevent_RaiseEvents(%d.%d)\n", (int)now.sec,
 407                 (int)now.usec);
 408 #endif
 409     rxevent_raiseScheduled = 0;
 410     MUTEX_EXIT(&rxevent_lock);
 411     return 0;
 412 }
 413
 414 void
 415 shutdown_rxevent(void)
 416 {
 417     struct xfreelist *xp, *nxp;
 418
 419     LOCK_EV_INIT;
 420     if (!rxevent_initialized) {
 421         UNLOCK_EV_INIT;
 422         return;
 423     }
 424     rxevent_initialized = 0;
 425     UNLOCK_EV_INIT;
 426     MUTEX_DESTROY(&rxevent_lock);
 427 #if     defined(AFS_AIX32_ENV) && defined(KERNEL)
 428     /* Everything is freed in afs_osinet.c */
 429 #else
 430     xp = xfreemallocs;
 431     while (xp) {
 432         nxp = xp->next;
 433         osi_Free((char *)xp->mem, xp->size);
 434         osi_Free((char *)xp, sizeof(struct xfreelist));
 435         xp = nxp;
 436     }
 437     xfreemallocs = NULL;
 438 #endif
 439
 440 }