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
  59 struct rxevent {
  60     struct opr_queue q;
  61     struct opr_rbtree_node node;
  62     struct clock eventTime;
  63     struct rxevent *next;
  64     rx_atomic_t refcnt;
  65     int handled;
  66     void (*func)(struct rxevent *, void *, void *, int);
  67     void *arg;
  68     void *arg1;
  69     int arg2;
  70 };
  71
  72 struct malloclist {
  73     void *mem;
  74     int size;
  75     struct malloclist *next;
  76 };
  77
  78 static struct {
  79     afs_kmutex_t lock;
  80     struct opr_queue list;
  81     struct malloclist *mallocs;
  82 } freeEvents;
  83
  84 static struct {
  85     afs_kmutex_t lock;
  86     struct opr_rbtree head;
  87     struct rxevent *first;
  88 } eventTree;
  89
  90 static struct {
  91     afs_kmutex_t lock;
  92     struct clock last;
  93     struct clock next;
  94     void (*func)(void);
  95     int raised;
  96 } eventSchedule;
  97
  98 static int allocUnit = 10;
  99
 100 static struct rxevent *
 101 rxevent_alloc(void) {
 102      struct rxevent *evlist;
 103      struct rxevent *ev;
 104      struct malloclist *mrec;
 105      int i;
 106
 107      MUTEX_ENTER(&freeEvents.lock);
 108      if (opr_queue_IsEmpty(&freeEvents.list)) {
 109         MUTEX_EXIT(&freeEvents.lock);
 110
 111 #if     defined(AFS_AIX32_ENV) && defined(KERNEL)
 112         ev = rxi_Alloc(sizeof(struct rxevent));
 113 #else
 114         evlist = osi_Alloc(sizeof(struct rxevent) * allocUnit);
 115         mrec = osi_Alloc(sizeof(struct malloclist));
 116
 117         mrec->mem = evlist;
 118         mrec->size = sizeof(struct rxevent) * allocUnit;
 119
 120         MUTEX_ENTER(&freeEvents.lock);
 121         for (i = 1; i < allocUnit; i++) {
 122             opr_queue_Append(&freeEvents.list, &evlist[i].q);
 123         }
 124         mrec->next = freeEvents.mallocs;
 125         freeEvents.mallocs = mrec;
 126         MUTEX_EXIT(&freeEvents.lock);
 127 #endif
 128         ev = &evlist[0];
 129     } else {
 130         ev = opr_queue_First(&freeEvents.list, struct rxevent, q);
 131         opr_queue_Remove(&ev->q);
 132         MUTEX_EXIT(&freeEvents.lock);
 133     }
 134
 135     memset(ev, 0, sizeof(struct rxevent));
 136     rx_atomic_set(&ev->refcnt, 1);
 137
 138     return ev;
 139 }
 140
 141 static void
 142 rxevent_free(struct rxevent *ev) {
 143     MUTEX_ENTER(&freeEvents.lock);
 144     opr_queue_Prepend(&freeEvents.list, &ev->q);
 145     MUTEX_EXIT(&freeEvents.lock);
 146 }
 147
 148 static_inline void
 149 rxevent_put(struct rxevent *ev) {
 150     if (rx_atomic_dec_and_read(&ev->refcnt) == 0) {
 151         rxevent_free(ev);
 152     }
 153 }
 154
 155 void
 156 rxevent_Put(struct rxevent *ev) {
 157     rxevent_put(ev);
 158 }
 159
 160 static_inline struct rxevent *
 161 rxevent_get(struct rxevent *ev) {
 162     rx_atomic_inc(&ev->refcnt);
 163     return ev;
 164 }
 165
 166 struct rxevent *
 167 rxevent_Get(struct rxevent *ev) {
 168     return rxevent_get(ev);
 169 }
 170
 171 /* Called if the time now is older than the last time we recorded running an
 172  * event. This test catches machines where the system time has been set
 173  * backwards, and avoids RX completely stalling when timers fail to fire.
 174  *
 175  * Take the different between now and the last event time, and subtract that
 176  * from the timing of every event on the system. This does a relatively slow
 177  * walk of the completely eventTree, but time-travel will hopefully be a pretty
 178  * rare occurrence.
 179  *
 180  * This can only safely be called from the event thread, as it plays with the
 181  * schedule directly.
 182  *
 183  */
 184 static void
 185 adjustTimes(void)
 186 {
 187     struct opr_rbtree_node *node;
 188     struct clock adjTime, now;
 189
 190     MUTEX_ENTER(&eventTree.lock);
 191     /* Time adjustment is expensive, make absolutely certain that we have
 192      * to do it, by getting an up to date time to base our decision on
 193      * once we've acquired the relevant locks.
 194      */
 195     clock_GetTime(&now);
 196     if (!clock_Lt(&now, &eventSchedule.last))
 197         goto out;
 198
 199     adjTime = eventSchedule.last;
 200     clock_Zero(&eventSchedule.last);
 201
 202     clock_Sub(&adjTime, &now);
 203
 204     node = opr_rbtree_first(&eventTree.head);
 205     while(node) {
 206         struct rxevent *event = opr_containerof(node, struct rxevent, node);
 207
 208         clock_Sub(&event->eventTime, &adjTime);
 209         node = opr_rbtree_next(node);
 210     }
 211     eventSchedule.next = eventTree.first->eventTime;
 212
 213 out:
 214     MUTEX_EXIT(&eventTree.lock);
 215 }
 216
 217 static int initialised = 0;
 218 void
 219 rxevent_Init(int nEvents, void (*scheduler)(void))
 220 {
 221     if (initialised)
 222         return;
 223
 224     initialised = 1;
 225
 226     clock_Init();
 227     MUTEX_INIT(&eventTree.lock, "event tree lock", MUTEX_DEFAULT, 0);
 228     opr_rbtree_init(&eventTree.head);
 229
 230     MUTEX_INIT(&freeEvents.lock, "free events lock", MUTEX_DEFAULT, 0);
 231     opr_queue_Init(&freeEvents.list);
 232     freeEvents.mallocs = NULL;
 233
 234     if (nEvents)
 235         allocUnit = nEvents;
 236
 237     clock_Zero(&eventSchedule.next);
 238     clock_Zero(&eventSchedule.last);
 239     eventSchedule.raised = 0;
 240     eventSchedule.func = scheduler;
 241 }
 242
 243 struct rxevent *
 244 rxevent_Post(struct clock *when, struct clock *now,
 245              void (*func) (struct rxevent *, void *, void *, int),
 246              void *arg, void *arg1, int arg2)
 247 {
 248     struct rxevent *ev, *event;
 249     struct opr_rbtree_node **childptr, *parent = NULL;
 250
 251     ev = rxevent_alloc();
 252     ev->eventTime = *when;
 253     ev->func = func;
 254     ev->arg = arg;
 255     ev->arg1 = arg1;
 256     ev->arg2 = arg2;
 257
 258     if (clock_Lt(now, &eventSchedule.last))
 259         adjustTimes();
 260
 261     MUTEX_ENTER(&eventTree.lock);
 262
 263     /* Work out where in the tree we'll be storing this */
 264     childptr = &eventTree.head.root;
 265
 266     while(*childptr) {
 267         event = opr_containerof((*childptr), struct rxevent, node);
 268
 269         parent = *childptr;
 270         if (clock_Lt(when, &event->eventTime))
 271             childptr = &(*childptr)->left;
 272         else if (clock_Gt(when, &event->eventTime))
 273             childptr = &(*childptr)->right;
 274         else {
 275             opr_queue_Append(&event->q, &ev->q);
 276             goto out;
 277         }
 278     }
 279     opr_queue_Init(&ev->q);
 280     opr_rbtree_insert(&eventTree.head, parent, childptr, &ev->node);
 281
 282     if (eventTree.first == NULL ||
 283         clock_Lt(when, &(eventTree.first->eventTime))) {
 284         eventTree.first = ev;
 285         eventSchedule.raised = 1;
 286         clock_Zero(&eventSchedule.next);
 287         MUTEX_EXIT(&eventTree.lock);
 288         if (eventSchedule.func != NULL)
 289             (*eventSchedule.func)();
 290         return rxevent_get(ev);
 291     }
 292
 293 out:
 294     MUTEX_EXIT(&eventTree.lock);
 295     return rxevent_get(ev);
 296 }
 297
 298 /* We're going to remove ev from the tree, so set the first pointer to the
 299  * next event after it */
 300 static_inline void
 301 resetFirst(struct rxevent *ev)
 302 {
 303     struct opr_rbtree_node *next = opr_rbtree_next(&ev->node);
 304     if (next)
 305         eventTree.first = opr_containerof(next, struct rxevent, node);
 306     else
 307         eventTree.first = NULL;
 308 }
 309
 310 void
 311 rxevent_Cancel(struct rxevent **evp, struct rx_call *call, int type)
 312 {
 313     struct rxevent *event;
 314
 315     if (!evp || !*evp)
 316         return;
 317
 318     event = *evp;
 319
 320     MUTEX_ENTER(&eventTree.lock);
 321
 322     if (!event->handled) {
 323         /* We're a node on the red/black tree. If our list is non-empty,
 324          * then swap the first element in the list in in our place,
 325          * promoting it to the list head */
 326         if (event->node.parent == NULL
 327             && eventTree.head.root != &event->node) {
 328             /* Not in the rbtree, therefore must be a list element */
 329             opr_queue_Remove(&event->q);
 330         } else {
 331             if (!opr_queue_IsEmpty(&event->q)) {
 332                 struct rxevent *next;
 333
 334                 next = opr_queue_First(&event->q, struct rxevent, q);
 335                 opr_queue_Remove(&next->q); /* Remove ourselves from list */
 336                 if (event->q.prev == &event->q) {
 337                     next->q.prev = next->q.next = &next->q;
 338                 } else {
 339                     next->q = event->q;
 340                     next->q.prev->next = &next->q;
 341                     next->q.next->prev = &next->q;
 342                 }
 343
 344                 opr_rbtree_replace(&eventTree.head, &event->node,
 345                                    &next->node);
 346
 347                 if (eventTree.first == event)
 348                     eventTree.first = next;
 349
 350             } else {
 351                 if (eventTree.first == event)
 352                     resetFirst(event);
 353
 354                 opr_rbtree_remove(&eventTree.head, &event->node);
 355             }
 356         }
 357         event->handled = 1;
 358         rxevent_put(event); /* Dispose of eventTree reference */
 359     }
 360
 361     MUTEX_EXIT(&eventTree.lock);
 362
 363     *evp = NULL;
 364     rxevent_put(event); /* Dispose of caller's reference */
 365
 366     if (call)
 367         CALL_RELE(call, type);
 368 }
 369
 370 /* Process all events which have expired. If events remain, then the relative
 371  * time until the next event is returned in the parameter 'wait', and the
 372  * function returns 1. If no events currently remain, the function returns 0
 373  *
 374  * If the current time is older than that of the last event processed, then we
 375  * assume that time has gone backwards (for example, due to a system time reset)
 376  * When this happens, all events in the current queue are rescheduled, using
 377  * the difference between the current time and the last event time as a delta
 378  */
 379
 380 int
 381 rxevent_RaiseEvents(struct clock *wait)
 382 {
 383     struct clock now;
 384     struct rxevent *event;
 385     int ret;
 386
 387     clock_GetTime(&now);
 388
 389     /* Check for time going backwards */
 390     if (clock_Lt(&now, &eventSchedule.last))
 391           adjustTimes();
 392     eventSchedule.last = now;
 393
 394     MUTEX_ENTER(&eventTree.lock);
 395     /* Lock our event tree */
 396     while (eventTree.first != NULL
 397            && clock_Lt(&eventTree.first->eventTime, &now)) {
 398
 399         /* Grab the next node, either in the event's list, or in the tree node
 400          * itself, and remove it from the event tree */
 401         event = eventTree.first;
 402         if (!opr_queue_IsEmpty(&event->q)) {
 403             event = opr_queue_Last(&event->q, struct rxevent, q);
 404             opr_queue_Remove(&event->q);
 405         } else {
 406             resetFirst(event);
 407             opr_rbtree_remove(&eventTree.head, &event->node);
 408         }
 409         event->handled = 1;
 410         MUTEX_EXIT(&eventTree.lock);
 411
 412         /* Fire the event, then free the structure */
 413         event->func(event, event->arg, event->arg1, event->arg2);
 414         rxevent_put(event);
 415
 416         MUTEX_ENTER(&eventTree.lock);
 417     }
 418
 419     /* Figure out when we next need to be scheduled */
 420     if (eventTree.first != NULL) {
 421         *wait = eventSchedule.next = eventTree.first->eventTime;
 422         ret = eventSchedule.raised = 1;
 423         clock_Sub(wait, &now);
 424     } else {
 425         ret = eventSchedule.raised = 0;
 426     }
 427
 428     MUTEX_EXIT(&eventTree.lock);
 429
 430     return ret;
 431 }
 432
 433 void
 434 shutdown_rxevent(void)
 435 {
 436     struct malloclist *mrec, *nmrec;
 437
 438     if (!initialised) {
 439         return;
 440     }
 441     MUTEX_DESTROY(&eventTree.lock);
 442
 443 #if !defined(AFS_AIX32_ENV) || !defined(KERNEL)
 444     MUTEX_DESTROY(&freeEvents.lock);
 445     mrec = freeEvents.mallocs;
 446     while (mrec) {
 447         nmrec = mrec->next;
 448         osi_Free(mrec->mem, mrec->size);
 449         osi_Free(mrec, sizeof(struct malloclist));
 450         mrec = nmrec;
 451     }
 452     mrec = NULL;
 453 #endif
 454 }