src/rx/rx_event.c

   1 /*
   2  * Copyright (c) 2011 Your File System Inc. All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions
   6  * are met:
   7  * 1. Redistributions of source code must retain the above copyright
   8  *    notice, this list of conditions and the following disclaimer.
   9  * 2. Redistributions in binary form must reproduce the above copyright
  10  *    notice, this list of conditions and the following disclaimer in the
  11  *    documentation and/or other materials provided with the distribution.
  12  *
  13  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR `AS IS'' AND ANY EXPRESS OR
  14  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  15  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  16  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  17  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  18  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  19  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  20  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  21  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  22  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  23  */
  24
  25 /* A reimplementation of the rx_event handler using red/black trees
  26  *
  27  * The first rx_event implementation used a simple sorted queue of all
  28  * events, which lead to O(n^2) performance, where n is the number of
  29  * outstanding events. This was found to scale poorly, so was replaced.
  30  *
  31  * The second implementation used a set of per-second buckets to store
  32  * events. Each bucket (referred to as an epoch in the code) stored all
  33  * of the events which expired in that second. However, on modern networks
  34  * where RTT times are in the millisecond, most connections will have events
  35  * expiring within the next second, so the problem reoccurs.
  36  *
  37  * This new implementation uses Red-Black trees to store a sorted list of
  38  * events. Red Black trees are guaranteed to have no worse than O(log N)
  39  * insertion, and are commonly used in timer applications
  40  */
  41
  42 #include <afsconfig.h>
  43 #include <afs/param.h>
  44
  45 #ifdef KERNEL
  46 # include "afs/sysincludes.h"
  47 # include "afsincludes.h"
  48 #else
  49 # include <roken.h>
  50 #endif
  51
  52 #include <afs/opr.h>
  53 #include <opr/queue.h>
  54 #include <opr/rbtree.h>
  55
  56 #include "rx.h"
  57 #include "rx_atomic.h"
  58 #include "rx_call.h"
  59 #include "rx_globals.h"
  60
  61 struct rxevent {
  62     struct opr_queue q;
  63     struct opr_rbtree_node node;
  64     struct clock eventTime;
  65     struct rxevent *next;
  66     rx_atomic_t refcnt;
  67     int handled;
  68     void (*func)(struct rxevent *, void *, void *, int);
  69     void *arg;
  70     void *arg1;
  71     int arg2;
  72 };
  73
  74 struct malloclist {
  75     void *mem;
  76     int size;
  77     struct malloclist *next;
  78 };
  79
  80 static struct {
  81     afs_kmutex_t lock;
  82     struct opr_queue list;
  83     struct malloclist *mallocs;
  84 } freeEvents;
  85
  86 static struct {
  87     afs_kmutex_t lock;
  88     struct opr_rbtree head;
  89     struct rxevent *first;
  90 } eventTree;
  91
  92 static struct {
  93     afs_kmutex_t lock;
  94     struct clock last;
  95     struct clock next;
  96     void (*func)(void);
  97     int raised;
  98 } eventSchedule;
  99
 100 static int allocUnit = 10;
 101
 102 static struct rxevent *
 103 rxevent_alloc(void) {
 104      struct rxevent *evlist;
 105      struct rxevent *ev;
 106      struct malloclist *mrec;
 107      int i;
 108
 109      MUTEX_ENTER(&freeEvents.lock);
 110      if (opr_queue_IsEmpty(&freeEvents.list)) {
 111         MUTEX_EXIT(&freeEvents.lock);
 112
 113 #if     defined(AFS_AIX32_ENV) && defined(KERNEL)
 114         ev = rxi_Alloc(sizeof(struct rxevent));
 115 #else
 116         evlist = osi_Alloc(sizeof(struct rxevent) * allocUnit);
 117         mrec = osi_Alloc(sizeof(struct malloclist));
 118
 119         mrec->mem = evlist;
 120         mrec->size = sizeof(struct rxevent) * allocUnit;
 121
 122         MUTEX_ENTER(&freeEvents.lock);
 123         for (i = 1; i < allocUnit; i++) {
 124             opr_queue_Append(&freeEvents.list, &evlist[i].q);
 125         }
 126         mrec->next = freeEvents.mallocs;
 127         freeEvents.mallocs = mrec;
 128         MUTEX_EXIT(&freeEvents.lock);
 129 #endif
 130         ev = &evlist[0];
 131     } else {
 132         ev = opr_queue_First(&freeEvents.list, struct rxevent, q);
 133         opr_queue_Remove(&ev->q);
 134         MUTEX_EXIT(&freeEvents.lock);
 135     }
 136
 137     memset(ev, 0, sizeof(struct rxevent));
 138     rx_atomic_set(&ev->refcnt, 1);
 139
 140     return ev;
 141 }
 142
 143 static void
 144 rxevent_free(struct rxevent *ev) {
 145     MUTEX_ENTER(&freeEvents.lock);
 146     opr_queue_Prepend(&freeEvents.list, &ev->q);
 147     MUTEX_EXIT(&freeEvents.lock);
 148 }
 149
 150 static_inline void
 151 rxevent_put(struct rxevent *ev) {
 152     if (rx_atomic_dec_and_read(&ev->refcnt) == 0) {
 153         rxevent_free(ev);
 154     }
 155 }
 156
 157 void
 158 rxevent_Put(struct rxevent *ev) {
 159     rxevent_put(ev);
 160 }
 161
 162 static_inline struct rxevent *
 163 rxevent_get(struct rxevent *ev) {
 164     rx_atomic_inc(&ev->refcnt);
 165     return ev;
 166 }
 167
 168 struct rxevent *
 169 rxevent_Get(struct rxevent *ev) {
 170     return rxevent_get(ev);
 171 }
 172
 173 /* Called if the time now is older than the last time we recorded running an
 174  * event. This test catches machines where the system time has been set
 175  * backwards, and avoids RX completely stalling when timers fail to fire.
 176  *
 177  * Take the different between now and the last event time, and subtract that
 178  * from the timing of every event on the system. This does a relatively slow
 179  * walk of the completely eventTree, but time-travel will hopefully be a pretty
 180  * rare occurrence.
 181  *
 182  * This can only safely be called from the event thread, as it plays with the
 183  * schedule directly.
 184  *
 185  */
 186 static void
 187 adjustTimes(void)
 188 {
 189     struct opr_rbtree_node *node;
 190     struct clock adjTime, now;
 191
 192     MUTEX_ENTER(&eventTree.lock);
 193     /* Time adjustment is expensive, make absolutely certain that we have
 194      * to do it, by getting an up to date time to base our decision on
 195      * once we've acquired the relevant locks.
 196      */
 197     clock_GetTime(&now);
 198     if (!clock_Lt(&now, &eventSchedule.last))
 199         goto out;
 200
 201     adjTime = eventSchedule.last;
 202     clock_Zero(&eventSchedule.last);
 203
 204     clock_Sub(&adjTime, &now);
 205
 206     node = opr_rbtree_first(&eventTree.head);
 207     while(node) {
 208         struct rxevent *event = opr_containerof(node, struct rxevent, node);
 209
 210         clock_Sub(&event->eventTime, &adjTime);
 211         node = opr_rbtree_next(node);
 212     }
 213     eventSchedule.next = eventTree.first->eventTime;
 214
 215 out:
 216     MUTEX_EXIT(&eventTree.lock);
 217 }
 218
 219 static int initialised = 0;
 220 void
 221 rxevent_Init(int nEvents, void (*scheduler)(void))
 222 {
 223     if (initialised)
 224         return;
 225
 226     initialised = 1;
 227
 228     clock_Init();
 229     MUTEX_INIT(&eventTree.lock, "event tree lock", MUTEX_DEFAULT, 0);
 230     opr_rbtree_init(&eventTree.head);
 231
 232     MUTEX_INIT(&freeEvents.lock, "free events lock", MUTEX_DEFAULT, 0);
 233     opr_queue_Init(&freeEvents.list);
 234     freeEvents.mallocs = NULL;
 235
 236     if (nEvents)
 237         allocUnit = nEvents;
 238
 239     clock_Zero(&eventSchedule.next);
 240     clock_Zero(&eventSchedule.last);
 241     eventSchedule.raised = 0;
 242     eventSchedule.func = scheduler;
 243 }
 244
 245 struct rxevent *
 246 rxevent_Post(struct clock *when, struct clock *now,
 247              void (*func) (struct rxevent *, void *, void *, int),
 248              void *arg, void *arg1, int arg2)
 249 {
 250     struct rxevent *ev, *event;
 251     struct opr_rbtree_node **childptr, *parent = NULL;
 252
 253     ev = rxevent_alloc();
 254     ev->eventTime = *when;
 255     ev->func = func;
 256     ev->arg = arg;
 257     ev->arg1 = arg1;
 258     ev->arg2 = arg2;
 259
 260     if (clock_Lt(now, &eventSchedule.last))
 261         adjustTimes();
 262
 263     MUTEX_ENTER(&eventTree.lock);
 264
 265     /* Work out where in the tree we'll be storing this */
 266     childptr = &eventTree.head.root;
 267
 268     while(*childptr) {
 269         event = opr_containerof((*childptr), struct rxevent, node);
 270
 271         parent = *childptr;
 272         if (clock_Lt(when, &event->eventTime))
 273             childptr = &(*childptr)->left;
 274         else if (clock_Gt(when, &event->eventTime))
 275             childptr = &(*childptr)->right;
 276         else {
 277             opr_queue_Append(&event->q, &ev->q);
 278             goto out;
 279         }
 280     }
 281     opr_queue_Init(&ev->q);
 282     opr_rbtree_insert(&eventTree.head, parent, childptr, &ev->node);
 283
 284     if (eventTree.first == NULL ||
 285         clock_Lt(when, &(eventTree.first->eventTime))) {
 286         eventTree.first = ev;
 287         eventSchedule.raised = 1;
 288         clock_Zero(&eventSchedule.next);
 289         MUTEX_EXIT(&eventTree.lock);
 290         if (eventSchedule.func != NULL)
 291             (*eventSchedule.func)();
 292         return rxevent_get(ev);
 293     }
 294
 295 out:
 296     MUTEX_EXIT(&eventTree.lock);
 297     return rxevent_get(ev);
 298 }
 299
 300 /* We're going to remove ev from the tree, so set the first pointer to the
 301  * next event after it */
 302 static_inline void
 303 resetFirst(struct rxevent *ev)
 304 {
 305     struct opr_rbtree_node *next = opr_rbtree_next(&ev->node);
 306     if (next)
 307         eventTree.first = opr_containerof(next, struct rxevent, node);
 308     else
 309         eventTree.first = NULL;
 310 }
 311
 312 void
 313 rxevent_Cancel(struct rxevent **evp, struct rx_call *call, int type)
 314 {
 315     struct rxevent *event;
 316
 317     if (!evp || !*evp)
 318         return;
 319
 320     event = *evp;
 321
 322     MUTEX_ENTER(&eventTree.lock);
 323
 324     if (!event->handled) {
 325         /* We're a node on the red/black tree. If our list is non-empty,
 326          * then swap the first element in the list in in our place,
 327          * promoting it to the list head */
 328         if (event->node.parent == NULL
 329             && eventTree.head.root != &event->node) {
 330             /* Not in the rbtree, therefore must be a list element */
 331             opr_queue_Remove(&event->q);
 332         } else {
 333             if (!opr_queue_IsEmpty(&event->q)) {
 334                 struct rxevent *next;
 335
 336                 next = opr_queue_First(&event->q, struct rxevent, q);
 337                 opr_queue_Remove(&next->q); /* Remove ourselves from list */
 338                 if (event->q.prev == &event->q) {
 339                     next->q.prev = next->q.next = &next->q;
 340                 } else {
 341                     next->q = event->q;
 342                     next->q.prev->next = &next->q;
 343                     next->q.next->prev = &next->q;
 344                 }
 345
 346                 opr_rbtree_replace(&eventTree.head, &event->node,
 347                                    &next->node);
 348
 349                 if (eventTree.first == event)
 350                     eventTree.first = next;
 351
 352             } else {
 353                 if (eventTree.first == event)
 354                     resetFirst(event);
 355
 356                 opr_rbtree_remove(&eventTree.head, &event->node);
 357             }
 358         }
 359         event->handled = 1;
 360         rxevent_put(event); /* Dispose of eventTree reference */
 361     }
 362
 363     MUTEX_EXIT(&eventTree.lock);
 364
 365     *evp = NULL;
 366     rxevent_put(event); /* Dispose of caller's reference */
 367
 368     if (call)
 369         CALL_RELE(call, type);
 370 }
 371
 372 /* Process all events which have expired. If events remain, then the relative
 373  * time until the next event is returned in the parameter 'wait', and the
 374  * function returns 1. If no events currently remain, the function returns 0
 375  *
 376  * If the current time is older than that of the last event processed, then we
 377  * assume that time has gone backwards (for example, due to a system time reset)
 378  * When this happens, all events in the current queue are rescheduled, using
 379  * the difference between the current time and the last event time as a delta
 380  */
 381
 382 int
 383 rxevent_RaiseEvents(struct clock *wait)
 384 {
 385     struct clock now;
 386     struct rxevent *event;
 387     int ret;
 388
 389     clock_GetTime(&now);
 390
 391     /* Check for time going backwards */
 392     if (clock_Lt(&now, &eventSchedule.last))
 393           adjustTimes();
 394     eventSchedule.last = now;
 395
 396     MUTEX_ENTER(&eventTree.lock);
 397     /* Lock our event tree */
 398     while (eventTree.first != NULL
 399            && clock_Lt(&eventTree.first->eventTime, &now)) {
 400
 401         /* Grab the next node, either in the event's list, or in the tree node
 402          * itself, and remove it from the event tree */
 403         event = eventTree.first;
 404         if (!opr_queue_IsEmpty(&event->q)) {
 405             event = opr_queue_Last(&event->q, struct rxevent, q);
 406             opr_queue_Remove(&event->q);
 407         } else {
 408             resetFirst(event);
 409             opr_rbtree_remove(&eventTree.head, &event->node);
 410         }
 411         event->handled = 1;
 412         MUTEX_EXIT(&eventTree.lock);
 413
 414         /* Fire the event, then free the structure */
 415         event->func(event, event->arg, event->arg1, event->arg2);
 416         rxevent_put(event);
 417
 418         MUTEX_ENTER(&eventTree.lock);
 419     }
 420
 421     /* Figure out when we next need to be scheduled */
 422     if (eventTree.first != NULL) {
 423         *wait = eventSchedule.next = eventTree.first->eventTime;
 424         ret = eventSchedule.raised = 1;
 425         clock_Sub(wait, &now);
 426     } else {
 427         ret = eventSchedule.raised = 0;
 428     }
 429
 430     MUTEX_EXIT(&eventTree.lock);
 431
 432     return ret;
 433 }
 434
 435 void
 436 shutdown_rxevent(void)
 437 {
 438     struct malloclist *mrec, *nmrec;
 439
 440     if (!initialised) {
 441         return;
 442     }
 443     MUTEX_DESTROY(&eventTree.lock);
 444
 445 #if !defined(AFS_AIX32_ENV) || !defined(KERNEL)
 446     MUTEX_DESTROY(&freeEvents.lock);
 447     mrec = freeEvents.mallocs;
 448     while (mrec) {
 449         nmrec = mrec->next;
 450         osi_Free(mrec->mem, mrec->size);
 451         osi_Free(mrec, sizeof(struct malloclist));
 452         mrec = nmrec;
 453     }
 454     mrec = NULL;
 455 #endif
 456 }