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
  22 #ifdef KERNEL
  23 #ifndef UKERNEL
  24 #include "afs/afs_osi.h"
  25 #else /* !UKERNEL */
  26 #include "afs/sysincludes.h"
  27 #include "afsincludes.h"
  28 #endif /* !UKERNEL */
  29 #include "rx/rx_clock.h"
  30 #include "rx/rx_queue.h"
  31 #include "rx/rx_event.h"
  32 #include "rx/rx_kernel.h"
  33 #include "rx_kmutex.h"
  34 #ifdef RX_ENABLE_LOCKS
  35 #include "rx/rx.h"
  36 #endif /* RX_ENABLE_LOCKS */
  37 #include "rx/rx_globals.h"
  38 #if defined(AFS_SGI_ENV)
  39 #include "sys/debug.h"
  40 /* These are necessary to get curproc (used by GLOCK asserts) to work. */
  41 #include "h/proc.h"
  42 #if !defined(AFS_SGI64_ENV) && !defined(UKERNEL)
  43 #include "h/user.h"
  44 #endif
  45 extern void *osi_Alloc();
  46 #endif
  47 #if defined(AFS_OBSD_ENV)
  48 #include "h/proc.h"
  49 #endif
  50 #else /* KERNEL */
  51 #include <stdio.h>
  52 #include "rx_clock.h"
  53 #include "rx_queue.h"
  54 #include "rx_event.h"
  55 #include "rx_user.h"
  56 #ifdef AFS_PTHREAD_ENV
  57 #include <rx/rx_pthread.h>
  58 #else
  59 #include "rx_lwp.h"
  60 #endif
  61 #ifdef RX_ENABLE_LOCKS
  62 #include "rx.h"
  63 #endif /* RX_ENABLE_LOCKS */
  64 #include "rx_globals.h"
  65 #ifdef AFS_NT40_ENV
  66 #include <malloc.h>
  67 #endif
  68 #endif /* KERNEL */
  69
  70
  71 /* All event processing is relative to the apparent current time given by clock_GetTime */
  72
  73 /* This should be static, but event_test wants to look at the free list... */
  74 struct rx_queue rxevent_free;   /* It's somewhat bogus to use a doubly-linked queue for the free list */
  75 struct rx_queue rxepoch_free;   /* It's somewhat bogus to use a doubly-linked queue for the free list */
  76 static struct rx_queue rxepoch_queue;   /* list of waiting epochs */
  77 static int rxevent_allocUnit = 10;      /* Allocation unit (number of event records to allocate at one time) */
  78 static int rxepoch_allocUnit = 10;      /* Allocation unit (number of epoch records to allocate at one time) */
  79 int rxevent_nFree;              /* Number of free event records */
  80 int rxevent_nPosted;            /* Current number of posted events */
  81 int rxepoch_nFree;              /* Number of free epoch records */
  82 static void (*rxevent_ScheduledEarlierEvent) (void);    /* Proc to call when an event is scheduled that is earlier than all other events */
  83 struct xfreelist {
  84     void *mem;
  85     int size;
  86     struct xfreelist *next;
  87 };
  88 static struct xfreelist *xfreemallocs = 0, *xsp = 0;
  89
  90 struct clock rxevent_nextRaiseEvents;   /* Time of next call to raise events */
  91 struct clock rxevent_lastEvent;        /* backwards time detection */
  92 int rxevent_raiseScheduled;     /* true if raise events is scheduled */
  93
  94 #ifdef RX_ENABLE_LOCKS
  95 #ifdef RX_LOCKS_DB
  96 /* rxdb_fileID is used to identify the lock location, along with line#. */
  97 static int rxdb_fileID = RXDB_FILE_RX_EVENT;
  98 #endif /* RX_LOCKS_DB */
  99 #define RX_ENABLE_LOCKS  1
 100 afs_kmutex_t rxevent_lock;
 101 #endif /* RX_ENABLE_LOCKS */
 102
 103 #ifdef AFS_PTHREAD_ENV
 104 /*
 105  * This mutex protects the following global variables:
 106  * rxevent_initialized
 107  */
 108
 109 #include <assert.h>
 110 afs_kmutex_t rx_event_mutex;
 111 #define LOCK_EV_INIT MUTEX_ENTER(&rx_event_mutex)
 112 #define UNLOCK_EV_INIT MUTEX_EXIT(&rx_event_mutex)
 113 #else
 114 #define LOCK_EV_INIT
 115 #define UNLOCK_EV_INIT
 116 #endif /* AFS_PTHREAD_ENV */
 117
 118
 119 int
 120 rxevent_adjTimes(struct clock *adjTime)
 121 {
 122     /* backwards clock correction */
 123     int nAdjusted = 0;
 124     struct rxepoch *qep, *nqep;
 125     struct rxevent *qev, *nqev;
 126
 127     for (queue_Scan(&rxepoch_queue, qep, nqep, rxepoch)) {
 128         for (queue_Scan(&qep->events, qev, nqev, rxevent)) {
 129             if (clock_Gt(&qev->eventTime, adjTime)) {
 130                 clock_Sub(&qev->eventTime, adjTime);
 131                 nAdjusted++;
 132             }
 133         }
 134         if (qep->epochSec > adjTime->sec) {
 135             qep->epochSec -= adjTime->sec;
 136         }
 137     }
 138     return nAdjusted;
 139 }
 140
 141 /* Pass in the number of events to allocate at a time */
 142 int rxevent_initialized = 0;
 143 void
 144 rxevent_Init(int nEvents, void (*scheduler) (void))
 145 {
 146     LOCK_EV_INIT;
 147     if (rxevent_initialized) {
 148         UNLOCK_EV_INIT;
 149         return;
 150     }
 151     MUTEX_INIT(&rxevent_lock, "rxevent_lock", MUTEX_DEFAULT, 0);
 152     clock_Init();
 153     if (nEvents)
 154         rxevent_allocUnit = nEvents;
 155     queue_Init(&rxevent_free);
 156     queue_Init(&rxepoch_free);
 157     queue_Init(&rxepoch_queue);
 158     rxevent_nFree = rxevent_nPosted = 0;
 159     rxepoch_nFree = 0;
 160     rxevent_ScheduledEarlierEvent = scheduler;
 161     rxevent_initialized = 1;
 162     clock_Zero(&rxevent_nextRaiseEvents);
 163     clock_Zero(&rxevent_lastEvent);
 164     rxevent_raiseScheduled = 0;
 165     UNLOCK_EV_INIT;
 166 }
 167
 168 /* Create and initialize new epoch structure */
 169 struct rxepoch *
 170 rxepoch_Allocate(struct clock *when)
 171 {
 172     struct rxepoch *ep;
 173     int i;
 174
 175     /* If we are short on free epoch entries, create a block of new oned
 176      * and add them to the free queue */
 177     if (queue_IsEmpty(&rxepoch_free)) {
 178 #if    defined(AFS_AIX32_ENV) && defined(KERNEL)
 179         ep = (struct rxepoch *)rxi_Alloc(sizeof(struct rxepoch));
 180         queue_Append(&rxepoch_free, &ep[0]), rxepoch_nFree++;
 181 #else
 182 #if defined(KERNEL) && !defined(UKERNEL) && defined(AFS_FBSD80_ENV)
 183         ep = (struct rxepoch *)
 184             afs_osi_Alloc_NoSleep(sizeof(struct rxepoch) * rxepoch_allocUnit);
 185         xsp = xfreemallocs;
 186         xfreemallocs =
 187             (struct xfreelist *)afs_osi_Alloc_NoSleep(sizeof(struct xfreelist));
 188 #else
 189         ep = (struct rxepoch *)
 190             osi_Alloc(sizeof(struct rxepoch) * rxepoch_allocUnit);
 191         xsp = xfreemallocs;
 192         xfreemallocs =
 193             (struct xfreelist *)osi_Alloc(sizeof(struct xfreelist));
 194 #endif
 195         xfreemallocs->mem = (void *)ep;
 196         xfreemallocs->size = sizeof(struct rxepoch) * rxepoch_allocUnit;
 197         xfreemallocs->next = xsp;
 198         for (i = 0; i < rxepoch_allocUnit; i++)
 199             queue_Append(&rxepoch_free, &ep[i]), rxepoch_nFree++;
 200 #endif
 201     }
 202     ep = queue_First(&rxepoch_free, rxepoch);
 203     queue_Remove(ep);
 204     rxepoch_nFree--;
 205     ep->epochSec = when->sec;
 206     queue_Init(&ep->events);
 207     return ep;
 208 }
 209
 210 /* Add the indicated event (function, arg) at the specified clock time.  The
 211  * "when" argument specifies when "func" should be called, in clock (clock.h)
 212  * units. */
 213
 214 static struct rxevent *
 215 _rxevent_Post(struct clock *when, struct clock *now,
 216               void (*func) (struct rxevent *, void *, void *, int),
 217               void *arg, void *arg1, int arg2, int newargs)
 218 {
 219     struct rxevent *ev, *evqe, *evqpr;
 220     struct rxepoch *ep, *epqe, *epqpr;
 221     int isEarliest = 0;
 222
 223     MUTEX_ENTER(&rxevent_lock);
 224 #ifdef RXDEBUG
 225     if (rx_Log_event) {
 226         struct clock now1;
 227         clock_GetTime(&now1);
 228         fprintf(rx_Log_event, "%ld.%ld: rxevent_Post(%ld.%ld, %lp, %lp, %lp, %d)\n",
 229                 afs_printable_int32_ld(now1.sec),
 230                 afs_printable_int32_ld(now1.usec),
 231                 afs_printable_int32_ld(when->sec),
 232                 afs_printable_int32_ld(when->usec),
 233                 func, arg,
 234                 arg1, arg2);
 235     }
 236 #endif
 237     /* If a time was provided, check for consistency */
 238     if (now->sec) {
 239         if (clock_Gt(&rxevent_lastEvent, now)) {
 240             struct clock adjTime = rxevent_lastEvent;
 241             clock_Sub(&adjTime, now);
 242             rxevent_adjTimes(&adjTime);
 243         }
 244         rxevent_lastEvent = *now;
 245     }
 246     /* Get a pointer to the epoch for this event, if none is found then
 247      * create a new epoch and insert it into the sorted list */
 248     for (ep = NULL, queue_ScanBackwards(&rxepoch_queue, epqe, epqpr, rxepoch)) {
 249         if (when->sec == epqe->epochSec) {
 250             /* already have an structure for this epoch */
 251             ep = epqe;
 252             if (ep == queue_First(&rxepoch_queue, rxepoch))
 253                 isEarliest = 1;
 254             break;
 255         } else if (when->sec > epqe->epochSec) {
 256             /* Create a new epoch and insert after qe */
 257             ep = rxepoch_Allocate(when);
 258             queue_InsertAfter(epqe, ep);
 259             break;
 260         }
 261     }
 262     if (ep == NULL) {
 263         /* Create a new epoch and place it at the head of the list */
 264         ep = rxepoch_Allocate(when);
 265         queue_Prepend(&rxepoch_queue, ep);
 266         isEarliest = 1;
 267     }
 268
 269     /* If we're short on free event entries, create a block of new ones and add
 270      * them to the free queue */
 271     if (queue_IsEmpty(&rxevent_free)) {
 272         int i;
 273 #if     defined(AFS_AIX32_ENV) && defined(KERNEL)
 274         ev = (struct rxevent *)rxi_Alloc(sizeof(struct rxevent));
 275         queue_Append(&rxevent_free, &ev[0]), rxevent_nFree++;
 276 #else
 277
 278 #if defined(KERNEL) && !defined(UKERNEL) && defined(AFS_FBSD80_ENV)
 279         ev = (struct rxevent *)afs_osi_Alloc_NoSleep(sizeof(struct rxevent) *
 280                                          rxevent_allocUnit);
 281         xsp = xfreemallocs;
 282         xfreemallocs =
 283             (struct xfreelist *)afs_osi_Alloc_NoSleep(sizeof(struct xfreelist));
 284 #else
 285         ev = (struct rxevent *)osi_Alloc(sizeof(struct rxevent) *
 286                                          rxevent_allocUnit);
 287         xsp = xfreemallocs;
 288         xfreemallocs =
 289             (struct xfreelist *)osi_Alloc(sizeof(struct xfreelist));
 290 #endif
 291         xfreemallocs->mem = (void *)ev;
 292         xfreemallocs->size = sizeof(struct rxevent) * rxevent_allocUnit;
 293         xfreemallocs->next = xsp;
 294         for (i = 0; i < rxevent_allocUnit; i++)
 295             queue_Append(&rxevent_free, &ev[i]), rxevent_nFree++;
 296 #endif
 297     }
 298
 299     /* Grab and initialize a new rxevent structure */
 300     ev = queue_First(&rxevent_free, rxevent);
 301     queue_Remove(ev);
 302     rxevent_nFree--;
 303
 304     /* Record user defined event state */
 305     ev->eventTime = *when;
 306     if (newargs) {
 307         ev->func.newfunc = func;
 308     } else {
 309         ev->func.oldfunc = (void (*)(struct rxevent *, void *, void*))func;
 310     }
 311     ev->arg = arg;
 312     ev->arg1 = arg1;
 313     ev->arg2 = arg2;
 314     ev->newargs = newargs;
 315     rxevent_nPosted += 1;       /* Rather than ++, to shut high-C up
 316                                  *  regarding never-set variables
 317                                  */
 318
 319     /* Insert the event into the sorted list of events for this epoch */
 320     for (queue_ScanBackwards(&ep->events, evqe, evqpr, rxevent)) {
 321         if (when->usec >= evqe->eventTime.usec) {
 322             /* Insert event after evqe */
 323             queue_InsertAfter(evqe, ev);
 324             MUTEX_EXIT(&rxevent_lock);
 325             return ev;
 326         }
 327     }
 328     /* Insert event at head of current epoch */
 329     queue_Prepend(&ep->events, ev);
 330     if (isEarliest && rxevent_ScheduledEarlierEvent
 331         && (!rxevent_raiseScheduled
 332             || clock_Lt(&ev->eventTime, &rxevent_nextRaiseEvents))) {
 333         rxevent_raiseScheduled = 1;
 334         clock_Zero(&rxevent_nextRaiseEvents);
 335         MUTEX_EXIT(&rxevent_lock);
 336         /* Notify our external scheduler */
 337         (*rxevent_ScheduledEarlierEvent) ();
 338         MUTEX_ENTER(&rxevent_lock);
 339     }
 340     MUTEX_EXIT(&rxevent_lock);
 341     return ev;
 342 }
 343
 344 struct rxevent *
 345 rxevent_Post(struct clock *when,
 346              void (*func) (struct rxevent *, void *, void *),
 347              void *arg, void *arg1)
 348 {
 349     struct clock now;
 350     clock_Zero(&now);
 351     return _rxevent_Post(when, &now,
 352                          (void (*)(struct rxevent *, void *, void *, int))func,
 353                          arg, arg1, 0, 0);
 354 }
 355
 356 struct rxevent *
 357 rxevent_Post2(struct clock *when,
 358               void (*func) (struct rxevent *, void *, void *, int),
 359               void *arg, void *arg1, int arg2)
 360 {
 361     struct clock now;
 362     clock_Zero(&now);
 363     return _rxevent_Post(when, &now, func, arg, arg1, arg2, 1);
 364 }
 365
 366 struct rxevent *
 367 rxevent_PostNow(struct clock *when, struct clock *now,
 368                 void (*func) (struct rxevent *, void *, void *),
 369                 void *arg, void *arg1)
 370 {
 371     return _rxevent_Post(when, now,
 372                          (void (*)(struct rxevent *, void *, void *, int))func,
 373                          arg, arg1, 0, 0);
 374 }
 375
 376 struct rxevent *
 377 rxevent_PostNow2(struct clock *when, struct clock *now,
 378                  void (*func) (struct rxevent *, void *, void *, int),
 379                  void *arg, void *arg1, int arg2)
 380 {
 381     return _rxevent_Post(when, now, func, arg, arg1, arg2, 1);
 382 }
 383
 384 /* Cancel an event by moving it from the event queue to the free list.
 385  * Warning, the event must be on the event queue!  If not, this should core
 386  * dump (reference through 0).  This routine should be called using the macro
 387  * event_Cancel, which checks for a null event and also nulls the caller's
 388  * event pointer after cancelling the event.
 389  */
 390 #ifdef RX_ENABLE_LOCKS
 391 #ifdef RX_REFCOUNT_CHECK
 392 int rxevent_Cancel_type = 0;
 393 #endif
 394 #endif
 395
 396 void
 397 rxevent_Cancel_1(struct rxevent *ev, struct rx_call *call,
 398                  int type)
 399 {
 400 #ifdef RXDEBUG
 401     if (rx_Log_event) {
 402         struct clock now;
 403         clock_GetTime(&now);
 404         fprintf(rx_Log_event, "%d.%d: rxevent_Cancel_1(%d.%d, %lp, %lp)\n",
 405                 (int)now.sec, (int)now.usec, (int)ev->eventTime.sec,
 406                 (int)ev->eventTime.usec, ev->func.newfunc,
 407                 ev->arg);
 408     }
 409 #endif
 410     /* Append it to the free list (rather than prepending) to keep the free
 411      * list hot so nothing pages out
 412      */
 413     MUTEX_ENTER(&rxevent_lock);
 414     if (!ev) {
 415         MUTEX_EXIT(&rxevent_lock);
 416         return;
 417     }
 418 #ifdef RX_ENABLE_LOCKS
 419     /* It's possible we're currently processing this event. */
 420     if (queue_IsOnQueue(ev)) {
 421         queue_MoveAppend(&rxevent_free, ev);
 422         rxevent_nPosted--;
 423         rxevent_nFree++;
 424         if (call) {
 425             call->refCount--;
 426 #ifdef RX_REFCOUNT_CHECK
 427             call->refCDebug[type]--;
 428             if (call->refCDebug[type] < 0) {
 429                 rxevent_Cancel_type = type;
 430                 osi_Panic("rxevent_Cancel: call refCount < 0");
 431             }
 432 #endif /* RX_REFCOUNT_CHECK */
 433         }
 434     }
 435 #else /* RX_ENABLE_LOCKS */
 436     queue_MoveAppend(&rxevent_free, ev);
 437     rxevent_nPosted--;
 438     rxevent_nFree++;
 439 #endif /* RX_ENABLE_LOCKS */
 440     MUTEX_EXIT(&rxevent_lock);
 441 }
 442
 443 /* Process all epochs that have expired relative to the current clock time
 444  * (which is not re-evaluated unless clock_NewTime has been called).  The
 445  * relative time to the next epoch is returned in the output parameter next
 446  * and the function returns 1.  If there are is no next epoch, the function
 447  * returns 0.
 448  */
 449 int
 450 rxevent_RaiseEvents(struct clock *next)
 451 {
 452     struct rxepoch *ep;
 453     struct rxevent *ev;
 454     volatile struct clock now;
 455     MUTEX_ENTER(&rxevent_lock);
 456
 457     /* Events are sorted by time, so only scan until an event is found that has
 458      * not yet timed out */
 459
 460     clock_Zero(&now);
 461     while (queue_IsNotEmpty(&rxepoch_queue)) {
 462         ep = queue_First(&rxepoch_queue, rxepoch);
 463         if (queue_IsEmpty(&ep->events)) {
 464             queue_Remove(ep);
 465             queue_Append(&rxepoch_free, ep);
 466             rxepoch_nFree++;
 467             continue;
 468         }
 469         do {
 470         reraise:
 471             ev = queue_First(&ep->events, rxevent);
 472             if (clock_Lt(&now, &ev->eventTime)) {
 473                 clock_GetTime(&now);
 474                 if (clock_Gt(&rxevent_lastEvent, &now)) {
 475                     struct clock adjTime = rxevent_lastEvent;
 476                     int adjusted;
 477                     clock_Sub(&adjTime, &now);
 478                     adjusted = rxevent_adjTimes(&adjTime);
 479                     rxevent_lastEvent = now;
 480                     if (adjusted > 0)
 481                         goto reraise;
 482                 }
 483                 if (clock_Lt(&now, &ev->eventTime)) {
 484                     *next = rxevent_nextRaiseEvents = ev->eventTime;
 485                     rxevent_raiseScheduled = 1;
 486                     clock_Sub(next, &now);
 487                     MUTEX_EXIT(&rxevent_lock);
 488                     return 1;
 489                 }
 490             }
 491             queue_Remove(ev);
 492             rxevent_nPosted--;
 493             MUTEX_EXIT(&rxevent_lock);
 494             if (ev->newargs) {
 495                 ev->func.newfunc(ev, ev->arg, ev->arg1, ev->arg2);
 496             } else {
 497                 ev->func.oldfunc(ev, ev->arg, ev->arg1);
 498             }
 499             MUTEX_ENTER(&rxevent_lock);
 500             queue_Append(&rxevent_free, ev);
 501             rxevent_nFree++;
 502         } while (queue_IsNotEmpty(&ep->events));
 503     }
 504 #ifdef RXDEBUG
 505     if (rx_Log_event)
 506         fprintf(rx_Log_event, "rxevent_RaiseEvents(%d.%d)\n", (int)now.sec,
 507                 (int)now.usec);
 508 #endif
 509     rxevent_raiseScheduled = 0;
 510     MUTEX_EXIT(&rxevent_lock);
 511     return 0;
 512 }
 513
 514 void
 515 shutdown_rxevent(void)
 516 {
 517     struct xfreelist *xp, *nxp;
 518
 519     LOCK_EV_INIT;
 520     if (!rxevent_initialized) {
 521         UNLOCK_EV_INIT;
 522         return;
 523     }
 524     rxevent_initialized = 0;
 525     UNLOCK_EV_INIT;
 526     MUTEX_DESTROY(&rxevent_lock);
 527 #if     defined(AFS_AIX32_ENV) && defined(KERNEL)
 528     /* Everything is freed in afs_osinet.c */
 529 #else
 530     xp = xfreemallocs;
 531     while (xp) {
 532         nxp = xp->next;
 533         osi_Free((char *)xp->mem, xp->size);
 534         osi_Free((char *)xp, sizeof(struct xfreelist));
 535         xp = nxp;
 536     }
 537     xfreemallocs = NULL;
 538 #endif
 539
 540 }