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