lnet/lnet/lib-eq.c

   1 /*
   2  * GPL HEADER START
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License version 2 only,
   8  * as published by the Free Software Foundation.
   9  *
  10  * This program is distributed in the hope that it will be useful, but
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * General Public License version 2 for more details (a copy is included
  14  * in the LICENSE file that accompanied this code).
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * version 2 along with this program; If not, see
  18  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
  19  *
  20  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  21  * CA 95054 USA or visit www.sun.com if you need additional information or
  22  * have any questions.
  23  *
  24  * GPL HEADER END
  25  */
  26 /*
  27  * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
  28  * Use is subject to license terms.
  29  */
  30 /*
  31  * This file is part of Lustre, http://www.lustre.org/
  32  * Lustre is a trademark of Sun Microsystems, Inc.
  33  *
  34  * lnet/lnet/lib-eq.c
  35  *
  36  * Library level Event queue management routines
  37  */
  38
  39 #define DEBUG_SUBSYSTEM S_LNET
  40 #include <lnet/lib-lnet.h>
  41
  42 /**
  43  * Create an event queue that has room for \a count number of events.
  44  *
  45  * The event queue is circular and older events will be overwritten by new
  46  * ones if they are not removed in time by the user using the functions
  47  * LNetEQGet(), LNetEQWait(), or LNetEQPoll(). It is up to the user to
  48  * determine the appropriate size of the event queue to prevent this loss
  49  * of events. Note that when EQ handler is specified in \a callback, no
  50  * event loss can happen, since the handler is run for each event deposited
  51  * into the EQ.
  52  *
  53  * \param count The number of events to be stored in the event queue. It
  54  * will be rounded up to the next power of two.
  55  * \param callback A handler function that runs when an event is deposited
  56  * into the EQ. The constant value LNET_EQ_HANDLER_NONE can be used to
  57  * indicate that no event handler is desired.
  58  * \param handle On successful return, this location will hold a handle for
  59  * the newly created EQ.
  60  *
  61  * \retval 0       On success.
  62  * \retval -EINVAL If an parameter is not valid.
  63  * \retval -ENOMEM If memory for the EQ can't be allocated.
  64  *
  65  * \see lnet_eq_handler_t for the discussion on EQ handler semantics.
  66  */
  67 int
  68 LNetEQAlloc(unsigned int count, lnet_eq_handler_t callback,
  69             lnet_handle_eq_t *handle)
  70 {
  71         lnet_eq_t     *eq;
  72
  73         LASSERT (the_lnet.ln_init);
  74         LASSERT (the_lnet.ln_refcount > 0);
  75
  76         /* We need count to be a power of 2 so that when eq_{enq,deq}_seq
  77          * overflow, they don't skip entries, so the queue has the same
  78          * apparent capacity at all times */
  79
  80         count = cfs_power2_roundup(count);
  81
  82         if (callback != LNET_EQ_HANDLER_NONE && count != 0) {
  83                 CWARN("EQ callback is guaranteed to get every event, "
  84                       "do you still want to set eqcount %d for polling "
  85                       "event which will have locking overhead? "
  86                       "Please contact with developer to confirm\n", count);
  87         }
  88
  89         /* count can be 0 if only need callback, we can eliminate
  90          * overhead of enqueue event */
  91         if (count == 0 && callback == LNET_EQ_HANDLER_NONE)
  92                 return -EINVAL;
  93
  94         eq = lnet_eq_alloc();
  95         if (eq == NULL)
  96                 return -ENOMEM;
  97
  98         if (count != 0) {
  99                 LIBCFS_ALLOC(eq->eq_events, count * sizeof(lnet_event_t));
 100                 if (eq->eq_events == NULL) {
 101                         lnet_eq_free(eq);
 102                         return -ENOMEM;
 103                 }
 104                 /* NB allocator has set all event sequence numbers to 0,
 105                  * so all them should be earlier than eq_deq_seq */
 106         }
 107
 108         eq->eq_deq_seq = 1;
 109         eq->eq_enq_seq = 1;
 110         eq->eq_size = count;
 111         eq->eq_refcount = 0;
 112         eq->eq_callback = callback;
 113
 114         lnet_res_lock();
 115
 116         lnet_res_lh_initialize(&the_lnet.ln_eq_container, &eq->eq_lh);
 117         cfs_list_add(&eq->eq_list, &the_lnet.ln_eq_container.rec_active);
 118
 119         lnet_res_unlock();
 120
 121         lnet_eq2handle(handle, eq);
 122         return 0;
 123 }
 124
 125 /**
 126  * Release the resources associated with an event queue if it's idle;
 127  * otherwise do nothing and it's up to the user to try again.
 128  *
 129  * \param eqh A handle for the event queue to be released.
 130  *
 131  * \retval 0 If the EQ is not in use and freed.
 132  * \retval -ENOENT If \a eqh does not point to a valid EQ.
 133  * \retval -EBUSY  If the EQ is still in use by some MDs.
 134  */
 135 int
 136 LNetEQFree(lnet_handle_eq_t eqh)
 137 {
 138         lnet_eq_t     *eq;
 139         int            size;
 140         lnet_event_t  *events;
 141
 142         LASSERT (the_lnet.ln_init);
 143         LASSERT (the_lnet.ln_refcount > 0);
 144
 145         lnet_res_lock();
 146
 147         eq = lnet_handle2eq(&eqh);
 148         if (eq == NULL) {
 149                 lnet_res_unlock();
 150                 return -ENOENT;
 151         }
 152
 153         if (eq->eq_refcount != 0) {
 154                 CDEBUG(D_NET, "Event queue (%d) busy on destroy.\n",
 155                        eq->eq_refcount);
 156                 lnet_res_unlock();
 157                 return -EBUSY;
 158         }
 159
 160         /* stash for free after lock dropped */
 161         events  = eq->eq_events;
 162         size    = eq->eq_size;
 163
 164         lnet_res_lh_invalidate(&eq->eq_lh);
 165         cfs_list_del(&eq->eq_list);
 166         lnet_eq_free_locked(eq);
 167
 168         lnet_res_unlock();
 169
 170         if (events != NULL)
 171                 LIBCFS_FREE(events, size * sizeof(lnet_event_t));
 172
 173         return 0;
 174 }
 175
 176 void
 177 lnet_eq_enqueue_event(lnet_eq_t *eq, lnet_event_t *ev)
 178 {
 179         /* MUST called with resource lock hold */
 180         int index;
 181
 182         if (eq->eq_size == 0) {
 183                 LASSERT(eq->eq_callback != LNET_EQ_HANDLER_NONE);
 184                 eq->eq_callback(ev);
 185                 return;
 186         }
 187
 188         ev->sequence = eq->eq_enq_seq++;
 189
 190         LASSERT(eq->eq_size == LOWEST_BIT_SET(eq->eq_size));
 191         index = ev->sequence & (eq->eq_size - 1);
 192
 193         eq->eq_events[index] = *ev;
 194
 195         if (eq->eq_callback != LNET_EQ_HANDLER_NONE)
 196                 eq->eq_callback(ev);
 197
 198 #ifdef __KERNEL__
 199         /* Wake anyone waiting in LNetEQPoll() */
 200         if (cfs_waitq_active(&the_lnet.ln_eq_waitq))
 201                 cfs_waitq_broadcast(&the_lnet.ln_eq_waitq);
 202 #else
 203 # ifndef HAVE_LIBPTHREAD
 204         /* LNetEQPoll() calls into _the_ LND to wait for action */
 205 # else
 206         /* Wake anyone waiting in LNetEQPoll() */
 207         pthread_cond_broadcast(&the_lnet.ln_eq_cond);
 208 # endif
 209 #endif
 210 }
 211
 212 int
 213 lnet_eq_dequeue_event(lnet_eq_t *eq, lnet_event_t *ev)
 214 {
 215         int           new_index = eq->eq_deq_seq & (eq->eq_size - 1);
 216         lnet_event_t *new_event = &eq->eq_events[new_index];
 217         int           rc;
 218         ENTRY;
 219
 220         if (LNET_SEQ_GT (eq->eq_deq_seq, new_event->sequence)) {
 221                 RETURN(0);
 222         }
 223
 224         /* We've got a new event... */
 225         *ev = *new_event;
 226
 227         CDEBUG(D_INFO, "event: %p, sequence: %lu, eq->size: %u\n",
 228                new_event, eq->eq_deq_seq, eq->eq_size);
 229
 230         /* ...but did it overwrite an event we've not seen yet? */
 231         if (eq->eq_deq_seq == new_event->sequence) {
 232                 rc = 1;
 233         } else {
 234                 /* don't complain with CERROR: some EQs are sized small
 235                  * anyway; if it's important, the caller should complain */
 236                 CDEBUG(D_NET, "Event Queue Overflow: eq seq %lu ev seq %lu\n",
 237                        eq->eq_deq_seq, new_event->sequence);
 238                 rc = -EOVERFLOW;
 239         }
 240
 241         eq->eq_deq_seq = new_event->sequence + 1;
 242         RETURN(rc);
 243 }
 244
 245 /**
 246  * A nonblocking function that can be used to get the next event in an EQ.
 247  * If an event handler is associated with the EQ, the handler will run before
 248  * this function returns successfully. The event is removed from the queue.
 249  *
 250  * \param eventq A handle for the event queue.
 251  * \param event On successful return (1 or -EOVERFLOW), this location will
 252  * hold the next event in the EQ.
 253  *
 254  * \retval 0          No pending event in the EQ.
 255  * \retval 1          Indicates success.
 256  * \retval -ENOENT    If \a eventq does not point to a valid EQ.
 257  * \retval -EOVERFLOW Indicates success (i.e., an event is returned) and that
 258  * at least one event between this event and the last event obtained from the
 259  * EQ has been dropped due to limited space in the EQ.
 260  */
 261 int
 262 LNetEQGet (lnet_handle_eq_t eventq, lnet_event_t *event)
 263 {
 264         int which;
 265
 266         return LNetEQPoll(&eventq, 1, 0,
 267                          event, &which);
 268 }
 269
 270 /**
 271  * Block the calling process until there is an event in the EQ.
 272  * If an event handler is associated with the EQ, the handler will run before
 273  * this function returns successfully. This function returns the next event
 274  * in the EQ and removes it from the EQ.
 275  *
 276  * \param eventq A handle for the event queue.
 277  * \param event On successful return (1 or -EOVERFLOW), this location will
 278  * hold the next event in the EQ.
 279  *
 280  * \retval 1          Indicates success.
 281  * \retval -ENOENT    If \a eventq does not point to a valid EQ.
 282  * \retval -EOVERFLOW Indicates success (i.e., an event is returned) and that
 283  * at least one event between this event and the last event obtained from the
 284  * EQ has been dropped due to limited space in the EQ.
 285  */
 286 int
 287 LNetEQWait (lnet_handle_eq_t eventq, lnet_event_t *event)
 288 {
 289         int which;
 290
 291         return LNetEQPoll(&eventq, 1, LNET_TIME_FOREVER,
 292                          event, &which);
 293 }
 294
 295 #ifdef __KERNEL__
 296
 297 static int
 298 lnet_eq_wait_locked(int *timeout_ms)
 299 {
 300         int              tms = *timeout_ms;
 301         int              wait;
 302         cfs_waitlink_t   wl;
 303         cfs_time_t       now;
 304
 305         if (tms == 0)
 306                 return -1; /* don't want to wait and no new event */
 307
 308         cfs_waitlink_init(&wl);
 309         cfs_set_current_state(CFS_TASK_INTERRUPTIBLE);
 310         cfs_waitq_add(&the_lnet.ln_eq_waitq, &wl);
 311
 312         lnet_res_unlock();
 313
 314         if (tms < 0) {
 315                 cfs_waitq_wait(&wl, CFS_TASK_INTERRUPTIBLE);
 316
 317         } else {
 318                 struct timeval tv;
 319
 320                 now = cfs_time_current();
 321                 cfs_waitq_timedwait(&wl, CFS_TASK_INTERRUPTIBLE,
 322                                     cfs_time_seconds(tms) / 1000);
 323                 cfs_duration_usec(cfs_time_sub(cfs_time_current(), now), &tv);
 324                 tms -= (int)(tv.tv_sec * 1000 + tv.tv_usec / 1000);
 325                 if (tms < 0) /* no more wait but may have new event */
 326                         tms = 0;
 327         }
 328
 329         wait = tms != 0; /* might need to call here again */
 330         *timeout_ms = tms;
 331
 332         lnet_res_lock();
 333         cfs_waitq_del(&the_lnet.ln_eq_waitq, &wl);
 334
 335         return wait;
 336 }
 337
 338 #else /* !__KERNEL__ */
 339
 340 # ifdef HAVE_LIBPTHREAD
 341 static void
 342 lnet_eq_cond_wait(struct timespec *ts)
 343 {
 344         if (ts == NULL) {
 345                 pthread_cond_wait(&the_lnet.ln_eq_cond, &the_lnet.ln_res_lock);
 346         } else {
 347                 pthread_cond_timedwait(&the_lnet.ln_eq_cond,
 348                                        &the_lnet.ln_res_lock, ts);
 349         }
 350 }
 351 # endif
 352
 353 static int
 354 lnet_eq_wait_locked(int *timeout_ms)
 355 {
 356         lnet_ni_t         *eq_waitni = NULL;
 357         int                tms = *timeout_ms;
 358         int                wait;
 359         struct timeval     then;
 360         struct timeval     now;
 361
 362         if (the_lnet.ln_eq_waitni != NULL) {
 363                 /* I have a single NI that I have to call into, to get
 364                  * events queued, or to block. */
 365                 lnet_res_unlock();
 366
 367                 LNET_LOCK();
 368                 eq_waitni = the_lnet.ln_eq_waitni;
 369                 if (unlikely(eq_waitni == NULL)) {
 370                         LNET_UNLOCK();
 371
 372                         lnet_res_lock();
 373                         return -1;
 374                 }
 375
 376                 lnet_ni_addref_locked(eq_waitni);
 377                 LNET_UNLOCK();
 378
 379                 if (tms <= 0) { /* even for tms == 0 */
 380                         (eq_waitni->ni_lnd->lnd_wait)(eq_waitni, tms);
 381
 382                 } else {
 383                         gettimeofday(&then, NULL);
 384
 385                         (eq_waitni->ni_lnd->lnd_wait)(eq_waitni, tms);
 386
 387                         gettimeofday(&now, NULL);
 388                         tms -= (now.tv_sec - then.tv_sec) * 1000 +
 389                                (now.tv_usec - then.tv_usec) / 1000;
 390                         if (tms < 0)
 391                                 tms = 0;
 392                 }
 393
 394                 lnet_ni_decref(eq_waitni);
 395                 lnet_res_lock();
 396         } else { /* w/o eq_waitni */
 397 # ifndef HAVE_LIBPTHREAD
 398                 /* If I'm single-threaded, LNET fails at startup if it can't
 399                  * set the_lnet.ln_eqwaitni correctly.  */
 400                 LBUG();
 401 # else /* HAVE_LIBPTHREAD */
 402                 struct timespec  ts;
 403
 404                 if (tms == 0) /* don't want to wait and new event */
 405                         return -1;
 406
 407                 if (tms < 0) {
 408                         lnet_eq_cond_wait(NULL);
 409
 410                 } else {
 411
 412                         gettimeofday(&then, NULL);
 413
 414                         ts.tv_sec = then.tv_sec + tms / 1000;
 415                         ts.tv_nsec = then.tv_usec * 1000 +
 416                                      (tms % 1000) * 1000000;
 417                         if (ts.tv_nsec >= 1000000000) {
 418                                 ts.tv_sec++;
 419                                 ts.tv_nsec -= 1000000000;
 420                         }
 421
 422                         lnet_eq_cond_wait(&ts);
 423
 424                         gettimeofday(&now, NULL);
 425                         tms -= (now.tv_sec - then.tv_sec) * 1000 +
 426                                (now.tv_usec - then.tv_usec) / 1000;
 427                         if (tms < 0)
 428                                 tms = 0;
 429                 }
 430 # endif /* HAVE_LIBPTHREAD */
 431         }
 432
 433         wait = tms != 0;
 434         *timeout_ms = tms;
 435
 436         return wait;
 437 }
 438
 439 #endif /* __KERNEL__ */
 440
 441
 442 /**
 443  * Block the calling process until there's an event from a set of EQs or
 444  * timeout happens.
 445  *
 446  * If an event handler is associated with the EQ, the handler will run before
 447  * this function returns successfully, in which case the corresponding event
 448  * is consumed.
 449  *
 450  * LNetEQPoll() provides a timeout to allow applications to poll, block for a
 451  * fixed period, or block indefinitely.
 452  *
 453  * \param eventqs,neq An array of EQ handles, and size of the array.
 454  * \param timeout_ms Time in milliseconds to wait for an event to occur on
 455  * one of the EQs. The constant LNET_TIME_FOREVER can be used to indicate an
 456  * infinite timeout.
 457  * \param event,which On successful return (1 or -EOVERFLOW), \a event will
 458  * hold the next event in the EQs, and \a which will contain the index of the
 459  * EQ from which the event was taken.
 460  *
 461  * \retval 0          No pending event in the EQs after timeout.
 462  * \retval 1          Indicates success.
 463  * \retval -EOVERFLOW Indicates success (i.e., an event is returned) and that
 464  * at least one event between this event and the last event obtained from the
 465  * EQ indicated by \a which has been dropped due to limited space in the EQ.
 466  * \retval -ENOENT    If there's an invalid handle in \a eventqs.
 467  */
 468 int
 469 LNetEQPoll (lnet_handle_eq_t *eventqs, int neq, int timeout_ms,
 470             lnet_event_t *event, int *which)
 471 {
 472         int     wait = 1;
 473         int     rc;
 474         int     i;
 475         ENTRY;
 476
 477         LASSERT (the_lnet.ln_init);
 478         LASSERT (the_lnet.ln_refcount > 0);
 479
 480         if (neq < 1)
 481                 RETURN(-ENOENT);
 482
 483         lnet_res_lock();
 484
 485         for (;;) {
 486 #ifndef __KERNEL__
 487                 lnet_res_unlock();
 488
 489                 /* Recursion breaker */
 490                 if (the_lnet.ln_rc_state == LNET_RC_STATE_RUNNING &&
 491                     !LNetHandleIsEqual(eventqs[0], the_lnet.ln_rc_eqh))
 492                         lnet_router_checker();
 493
 494                 lnet_res_lock();
 495 #endif
 496                 for (i = 0; i < neq; i++) {
 497                         lnet_eq_t *eq = lnet_handle2eq(&eventqs[i]);
 498
 499                         if (eq == NULL) {
 500                                 lnet_res_unlock();
 501                                 RETURN(-ENOENT);
 502                         }
 503
 504                         rc = lnet_eq_dequeue_event(eq, event);
 505                         if (rc != 0) {
 506                                 lnet_res_unlock();
 507                                 *which = i;
 508                                 RETURN(rc);
 509                         }
 510                 }
 511
 512                 if (wait == 0)
 513                         break;
 514
 515                 /*
 516                  * return value of lnet_eq_wait_locked:
 517                  * -1 : did nothing and it's sure no new event
 518                  *  1 : sleep inside and wait until new event
 519                  *  0 : don't want to wait anymore, but might have new event
 520                  *      so need to call dequeue again
 521                  */
 522                 wait = lnet_eq_wait_locked(&timeout_ms);
 523                 if (wait < 0) /* no new event */
 524                         break;
 525         }
 526
 527         lnet_res_unlock();
 528         RETURN(0);
 529 }