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.gnu.org/licenses/gpl-2.0.html
  19  *
  20  * GPL HEADER END
  21  */
  22 /*
  23  * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
  24  * Use is subject to license terms.
  25  *
  26  * Copyright (c) 2012, 2016, Intel Corporation.
  27  */
  28 /*
  29  * This file is part of Lustre, http://www.lustre.org/
  30  * Lustre is a trademark of Sun Microsystems, Inc.
  31  *
  32  * lnet/lnet/lib-eq.c
  33  *
  34  * Library level Event queue management routines
  35  */
  36
  37 #define DEBUG_SUBSYSTEM S_LNET
  38 #include <lnet/lib-lnet.h>
  39
  40 /**
  41  * Create an event queue that has room for \a count number of events.
  42  *
  43  * The event queue is circular and older events will be overwritten by new
  44  * ones if they are not removed in time by the user using the functions
  45  * LNetEQGet(), LNetEQWait(), or LNetEQPoll(). It is up to the user to
  46  * determine the appropriate size of the event queue to prevent this loss
  47  * of events. Note that when EQ handler is specified in \a callback, no
  48  * event loss can happen, since the handler is run for each event deposited
  49  * into the EQ.
  50  *
  51  * \param count The number of events to be stored in the event queue. It
  52  * will be rounded up to the next power of two.
  53  * \param callback A handler function that runs when an event is deposited
  54  * into the EQ. The constant value LNET_EQ_HANDLER_NONE can be used to
  55  * indicate that no event handler is desired.
  56  * \param handle On successful return, this location will hold a handle for
  57  * the newly created EQ.
  58  *
  59  * \retval 0       On success.
  60  * \retval -EINVAL If an parameter is not valid.
  61  * \retval -ENOMEM If memory for the EQ can't be allocated.
  62  *
  63  * \see lnet_eq_handler_t for the discussion on EQ handler semantics.
  64  */
  65 int
  66 LNetEQAlloc(unsigned int count, lnet_eq_handler_t callback,
  67             struct lnet_handle_eq *handle)
  68 {
  69         struct lnet_eq *eq;
  70
  71         LASSERT(the_lnet.ln_refcount > 0);
  72
  73         /* We need count to be a power of 2 so that when eq_{enq,deq}_seq
  74          * overflow, they don't skip entries, so the queue has the same
  75          * apparent capacity at all times */
  76
  77         if (count)
  78                 count = roundup_pow_of_two(count);
  79
  80         if (callback != LNET_EQ_HANDLER_NONE && count != 0) {
  81                 CWARN("EQ callback is guaranteed to get every event, "
  82                       "do you still want to set eqcount %d for polling "
  83                       "event which will have locking overhead? "
  84                       "Please contact with developer to confirm\n", count);
  85         }
  86
  87         /* count can be 0 if only need callback, we can eliminate
  88          * overhead of enqueue event */
  89         if (count == 0 && callback == LNET_EQ_HANDLER_NONE)
  90                 return -EINVAL;
  91
  92         eq = lnet_eq_alloc();
  93         if (eq == NULL)
  94                 return -ENOMEM;
  95
  96         if (count != 0) {
  97                 LIBCFS_ALLOC(eq->eq_events, count * sizeof(struct lnet_event));
  98                 if (eq->eq_events == NULL)
  99                         goto failed;
 100                 /* NB allocator has set all event sequence numbers to 0,
 101                  * so all them should be earlier than eq_deq_seq */
 102         }
 103
 104         eq->eq_deq_seq = 1;
 105         eq->eq_enq_seq = 1;
 106         eq->eq_size = count;
 107         eq->eq_callback = callback;
 108
 109         eq->eq_refs = cfs_percpt_alloc(lnet_cpt_table(),
 110                                        sizeof(*eq->eq_refs[0]));
 111         if (eq->eq_refs == NULL)
 112                 goto failed;
 113
 114         /* MUST hold both exclusive lnet_res_lock */
 115         lnet_res_lock(LNET_LOCK_EX);
 116         /* NB: hold lnet_eq_wait_lock for EQ link/unlink, so we can do
 117          * both EQ lookup and poll event with only lnet_eq_wait_lock */
 118         lnet_eq_wait_lock();
 119
 120         lnet_res_lh_initialize(&the_lnet.ln_eq_container, &eq->eq_lh);
 121         list_add(&eq->eq_list, &the_lnet.ln_eq_container.rec_active);
 122
 123         lnet_eq_wait_unlock();
 124         lnet_res_unlock(LNET_LOCK_EX);
 125
 126         lnet_eq2handle(handle, eq);
 127         return 0;
 128
 129 failed:
 130         if (eq->eq_events != NULL)
 131                 LIBCFS_FREE(eq->eq_events, count * sizeof(struct lnet_event));
 132
 133         if (eq->eq_refs != NULL)
 134                 cfs_percpt_free(eq->eq_refs);
 135
 136         lnet_eq_free(eq);
 137         return -ENOMEM;
 138 }
 139 EXPORT_SYMBOL(LNetEQAlloc);
 140
 141 /**
 142  * Release the resources associated with an event queue if it's idle;
 143  * otherwise do nothing and it's up to the user to try again.
 144  *
 145  * \param eqh A handle for the event queue to be released.
 146  *
 147  * \retval 0 If the EQ is not in use and freed.
 148  * \retval -ENOENT If \a eqh does not point to a valid EQ.
 149  * \retval -EBUSY  If the EQ is still in use by some MDs.
 150  */
 151 int
 152 LNetEQFree(struct lnet_handle_eq eqh)
 153 {
 154         struct lnet_eq  *eq;
 155         struct lnet_event       *events = NULL;
 156         int             **refs = NULL;
 157         int             *ref;
 158         int             rc = 0;
 159         int             size = 0;
 160         int             i;
 161
 162         LASSERT(the_lnet.ln_refcount > 0);
 163
 164         lnet_res_lock(LNET_LOCK_EX);
 165         /* NB: hold lnet_eq_wait_lock for EQ link/unlink, so we can do
 166          * both EQ lookup and poll event with only lnet_eq_wait_lock */
 167         lnet_eq_wait_lock();
 168
 169         eq = lnet_handle2eq(&eqh);
 170         if (eq == NULL) {
 171                 rc = -ENOENT;
 172                 goto out;
 173         }
 174
 175         cfs_percpt_for_each(ref, i, eq->eq_refs) {
 176                 LASSERT(*ref >= 0);
 177                 if (*ref == 0)
 178                         continue;
 179
 180                 CDEBUG(D_NET, "Event equeue (%d: %d) busy on destroy.\n",
 181                        i, *ref);
 182                 rc = -EBUSY;
 183                 goto out;
 184         }
 185
 186         /* stash for free after lock dropped */
 187         events  = eq->eq_events;
 188         size    = eq->eq_size;
 189         refs    = eq->eq_refs;
 190
 191         lnet_res_lh_invalidate(&eq->eq_lh);
 192         list_del(&eq->eq_list);
 193         lnet_eq_free(eq);
 194  out:
 195         lnet_eq_wait_unlock();
 196         lnet_res_unlock(LNET_LOCK_EX);
 197
 198         if (events != NULL)
 199                 LIBCFS_FREE(events, size * sizeof(struct lnet_event));
 200         if (refs != NULL)
 201                 cfs_percpt_free(refs);
 202
 203         return rc;
 204 }
 205 EXPORT_SYMBOL(LNetEQFree);
 206
 207 void
 208 lnet_eq_enqueue_event(struct lnet_eq *eq, struct lnet_event *ev)
 209 {
 210         /* MUST called with resource lock hold but w/o lnet_eq_wait_lock */
 211         int index;
 212
 213         if (eq->eq_size == 0) {
 214                 LASSERT(eq->eq_callback != LNET_EQ_HANDLER_NONE);
 215                 eq->eq_callback(ev);
 216                 return;
 217         }
 218
 219         lnet_eq_wait_lock();
 220         ev->sequence = eq->eq_enq_seq++;
 221
 222         LASSERT(eq->eq_size == LOWEST_BIT_SET(eq->eq_size));
 223         index = ev->sequence & (eq->eq_size - 1);
 224
 225         eq->eq_events[index] = *ev;
 226
 227         if (eq->eq_callback != LNET_EQ_HANDLER_NONE)
 228                 eq->eq_callback(ev);
 229
 230         /* Wake anyone waiting in LNetEQPoll() */
 231         if (waitqueue_active(&the_lnet.ln_eq_waitq))
 232                 wake_up_all(&the_lnet.ln_eq_waitq);
 233         lnet_eq_wait_unlock();
 234 }
 235
 236 static int
 237 lnet_eq_dequeue_event(struct lnet_eq *eq, struct lnet_event *ev)
 238 {
 239         int             new_index = eq->eq_deq_seq & (eq->eq_size - 1);
 240         struct lnet_event       *new_event = &eq->eq_events[new_index];
 241         int             rc;
 242         ENTRY;
 243
 244         /* must called with lnet_eq_wait_lock hold */
 245         if (LNET_SEQ_GT(eq->eq_deq_seq, new_event->sequence))
 246                 RETURN(0);
 247
 248         /* We've got a new event... */
 249         *ev = *new_event;
 250
 251         CDEBUG(D_INFO, "event: %p, sequence: %lu, eq->size: %u\n",
 252                new_event, eq->eq_deq_seq, eq->eq_size);
 253
 254         /* ...but did it overwrite an event we've not seen yet? */
 255         if (eq->eq_deq_seq == new_event->sequence) {
 256                 rc = 1;
 257         } else {
 258                 /* don't complain with CERROR: some EQs are sized small
 259                  * anyway; if it's important, the caller should complain */
 260                 CDEBUG(D_NET, "Event Queue Overflow: eq seq %lu ev seq %lu\n",
 261                        eq->eq_deq_seq, new_event->sequence);
 262                 rc = -EOVERFLOW;
 263         }
 264
 265         eq->eq_deq_seq = new_event->sequence + 1;
 266         RETURN(rc);
 267 }
 268
 269 /**
 270  * A nonblocking function that can be used to get the next event in an EQ.
 271  * If an event handler is associated with the EQ, the handler will run before
 272  * this function returns successfully. The event is removed from the queue.
 273  *
 274  * \param eventq A handle for the event queue.
 275  * \param event On successful return (1 or -EOVERFLOW), this location will
 276  * hold the next event in the EQ.
 277  *
 278  * \retval 0          No pending event in the EQ.
 279  * \retval 1          Indicates success.
 280  * \retval -ENOENT    If \a eventq does not point to a valid EQ.
 281  * \retval -EOVERFLOW Indicates success (i.e., an event is returned) and that
 282  * at least one event between this event and the last event obtained from the
 283  * EQ has been dropped due to limited space in the EQ.
 284  */
 285 int
 286 LNetEQGet(struct lnet_handle_eq eventq, struct lnet_event *event)
 287 {
 288         int which;
 289
 290         return LNetEQPoll(&eventq, 1, 0,
 291                          event, &which);
 292 }
 293 EXPORT_SYMBOL(LNetEQGet);
 294
 295 /**
 296  * Block the calling process until there is an event in the EQ.
 297  * If an event handler is associated with the EQ, the handler will run before
 298  * this function returns successfully. This function returns the next event
 299  * in the EQ and removes it from the EQ.
 300  *
 301  * \param eventq A handle for the event queue.
 302  * \param event On successful return (1 or -EOVERFLOW), this location will
 303  * hold the next event in the EQ.
 304  *
 305  * \retval 1          Indicates success.
 306  * \retval -ENOENT    If \a eventq does not point to a valid EQ.
 307  * \retval -EOVERFLOW Indicates success (i.e., an event is returned) and that
 308  * at least one event between this event and the last event obtained from the
 309  * EQ has been dropped due to limited space in the EQ.
 310  */
 311 int
 312 LNetEQWait(struct lnet_handle_eq eventq, struct lnet_event *event)
 313 {
 314         int which;
 315
 316         return LNetEQPoll(&eventq, 1, MAX_SCHEDULE_TIMEOUT,
 317                           event, &which);
 318 }
 319 EXPORT_SYMBOL(LNetEQWait);
 320
 321 static int
 322 lnet_eq_wait_locked(signed long *timeout)
 323 __must_hold(&the_lnet.ln_eq_wait_lock)
 324 {
 325         signed long tms = *timeout;
 326         wait_queue_entry_t wl;
 327         int wait;
 328
 329         if (tms == 0)
 330                 return -ENXIO; /* don't want to wait and no new event */
 331
 332         init_waitqueue_entry(&wl, current);
 333         add_wait_queue(&the_lnet.ln_eq_waitq, &wl);
 334
 335         lnet_eq_wait_unlock();
 336
 337         tms = schedule_timeout_interruptible(tms);
 338         wait = tms != 0; /* might need to call here again */
 339         *timeout = tms;
 340
 341         lnet_eq_wait_lock();
 342         remove_wait_queue(&the_lnet.ln_eq_waitq, &wl);
 343
 344         return wait;
 345 }
 346
 347 /**
 348  * Block the calling process until there's an event from a set of EQs or
 349  * timeout happens.
 350  *
 351  * If an event handler is associated with the EQ, the handler will run before
 352  * this function returns successfully, in which case the corresponding event
 353  * is consumed.
 354  *
 355  * LNetEQPoll() provides a timeout to allow applications to poll, block for a
 356  * fixed period, or block indefinitely.
 357  *
 358  * \param eventqs,neq An array of EQ handles, and size of the array.
 359  * \param timeout Time in jiffies to wait for an event to occur on
 360  * one of the EQs. The constant MAX_SCHEDULE_TIMEOUT can be used to indicate an
 361  * infinite timeout.
 362  * \param event,which On successful return (1 or -EOVERFLOW), \a event will
 363  * hold the next event in the EQs, and \a which will contain the index of the
 364  * EQ from which the event was taken.
 365  *
 366  * \retval 0          No pending event in the EQs after timeout.
 367  * \retval 1          Indicates success.
 368  * \retval -EOVERFLOW Indicates success (i.e., an event is returned) and that
 369  * at least one event between this event and the last event obtained from the
 370  * EQ indicated by \a which has been dropped due to limited space in the EQ.
 371  * \retval -ENOENT    If there's an invalid handle in \a eventqs.
 372  */
 373 int
 374 LNetEQPoll(struct lnet_handle_eq *eventqs, int neq, signed long timeout,
 375            struct lnet_event *event, int *which)
 376 {
 377         int     wait = 1;
 378         int     rc;
 379         int     i;
 380         ENTRY;
 381
 382         LASSERT(the_lnet.ln_refcount > 0);
 383
 384         if (neq < 1)
 385                 RETURN(-ENOENT);
 386
 387         lnet_eq_wait_lock();
 388
 389         for (;;) {
 390                 for (i = 0; i < neq; i++) {
 391                         struct lnet_eq *eq = lnet_handle2eq(&eventqs[i]);
 392
 393                         if (eq == NULL) {
 394                                 lnet_eq_wait_unlock();
 395                                 RETURN(-ENOENT);
 396                         }
 397
 398                         rc = lnet_eq_dequeue_event(eq, event);
 399                         if (rc != 0) {
 400                                 lnet_eq_wait_unlock();
 401                                 *which = i;
 402                                 RETURN(rc);
 403                         }
 404                 }
 405
 406                 if (wait == 0)
 407                         break;
 408
 409                 /*
 410                  * return value of lnet_eq_wait_locked:
 411                  * -1 : did nothing and it's sure no new event
 412                  *  1 : sleep inside and wait until new event
 413                  *  0 : don't want to wait anymore, but might have new event
 414                  *      so need to call dequeue again
 415                  */
 416                 wait = lnet_eq_wait_locked(&timeout);
 417                 if (wait < 0) /* no new event */
 418                         break;
 419         }
 420
 421         lnet_eq_wait_unlock();
 422         RETURN(0);
 423 }