lnet/lnet/lib-me.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, 2013, 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-me.c
  37  *
  38  * Match Entry management routines
  39  */
  40
  41 #define DEBUG_SUBSYSTEM S_LNET
  42
  43 #include <lnet/lib-lnet.h>
  44
  45 /**
  46  * Create and attach a match entry to the match list of \a portal. The new
  47  * ME is empty, i.e. not associated with a memory descriptor. LNetMDAttach()
  48  * can be used to attach a MD to an empty ME.
  49  *
  50  * \param portal The portal table index where the ME should be attached.
  51  * \param match_id Specifies the match criteria for the process ID of
  52  * the requester. The constants LNET_PID_ANY and LNET_NID_ANY can be
  53  * used to wildcard either of the identifiers in the lnet_process_id_t
  54  * structure.
  55  * \param match_bits,ignore_bits Specify the match criteria to apply
  56  * to the match bits in the incoming request. The ignore bits are used
  57  * to mask out insignificant bits in the incoming match bits. The resulting
  58  * bits are then compared to the ME's match bits to determine if the
  59  * incoming request meets the match criteria.
  60  * \param unlink Indicates whether the ME should be unlinked when the memory
  61  * descriptor associated with it is unlinked (Note that the check for
  62  * unlinking a ME only occurs when the memory descriptor is unlinked.).
  63  * Valid values are LNET_RETAIN and LNET_UNLINK.
  64  * \param pos Indicates whether the new ME should be prepended or
  65  * appended to the match list. Allowed constants: LNET_INS_BEFORE,
  66  * LNET_INS_AFTER.
  67  * \param handle On successful returns, a handle to the newly created ME
  68  * object is saved here. This handle can be used later in LNetMEInsert(),
  69  * LNetMEUnlink(), or LNetMDAttach() functions.
  70  *
  71  * \retval 0       On success.
  72  * \retval -EINVAL If \a portal is invalid.
  73  * \retval -ENOMEM If new ME object cannot be allocated.
  74  */
  75 int
  76 LNetMEAttach(unsigned int portal,
  77              lnet_process_id_t match_id,
  78              __u64 match_bits, __u64 ignore_bits,
  79              lnet_unlink_t unlink, lnet_ins_pos_t pos,
  80              lnet_handle_me_t *handle)
  81 {
  82         struct lnet_match_table *mtable;
  83         struct lnet_me          *me;
  84         struct list_head        *head;
  85
  86         LASSERT(the_lnet.ln_refcount > 0);
  87
  88         if ((int)portal >= the_lnet.ln_nportals)
  89                 return -EINVAL;
  90
  91         mtable = lnet_mt_of_attach(portal, match_id,
  92                                    match_bits, ignore_bits, pos);
  93         if (mtable == NULL) /* can't match portal type */
  94                 return -EPERM;
  95
  96         me = lnet_me_alloc();
  97         if (me == NULL)
  98                 return -ENOMEM;
  99
 100         lnet_res_lock(mtable->mt_cpt);
 101
 102         me->me_portal = portal;
 103         me->me_match_id = match_id;
 104         me->me_match_bits = match_bits;
 105         me->me_ignore_bits = ignore_bits;
 106         me->me_unlink = unlink;
 107         me->me_md = NULL;
 108
 109         lnet_res_lh_initialize(the_lnet.ln_me_containers[mtable->mt_cpt],
 110                                &me->me_lh);
 111         if (ignore_bits != 0)
 112                 head = &mtable->mt_mhash[LNET_MT_HASH_IGNORE];
 113         else
 114                 head = lnet_mt_match_head(mtable, match_id, match_bits);
 115
 116         me->me_pos = head - &mtable->mt_mhash[0];
 117         if (pos == LNET_INS_AFTER || pos == LNET_INS_LOCAL)
 118                 list_add_tail(&me->me_list, head);
 119         else
 120                 list_add(&me->me_list, head);
 121
 122         lnet_me2handle(handle, me);
 123
 124         lnet_res_unlock(mtable->mt_cpt);
 125         return 0;
 126 }
 127 EXPORT_SYMBOL(LNetMEAttach);
 128
 129 /**
 130  * Create and a match entry and insert it before or after the ME pointed to by
 131  * \a current_meh. The new ME is empty, i.e. not associated with a memory
 132  * descriptor. LNetMDAttach() can be used to attach a MD to an empty ME.
 133  *
 134  * This function is identical to LNetMEAttach() except for the position
 135  * where the new ME is inserted.
 136  *
 137  * \param current_meh A handle for a ME. The new ME will be inserted
 138  * immediately before or immediately after this ME.
 139  * \param match_id,match_bits,ignore_bits,unlink,pos,handle See the discussion
 140  * for LNetMEAttach().
 141  *
 142  * \retval 0       On success.
 143  * \retval -ENOMEM If new ME object cannot be allocated.
 144  * \retval -ENOENT If \a current_meh does not point to a valid match entry.
 145  */
 146 int
 147 LNetMEInsert(lnet_handle_me_t current_meh,
 148              lnet_process_id_t match_id,
 149              __u64 match_bits, __u64 ignore_bits,
 150              lnet_unlink_t unlink, lnet_ins_pos_t pos,
 151              lnet_handle_me_t *handle)
 152 {
 153         struct lnet_me          *current_me;
 154         struct lnet_me          *new_me;
 155         struct lnet_portal      *ptl;
 156         int                     cpt;
 157
 158         LASSERT(the_lnet.ln_refcount > 0);
 159
 160         if (pos == LNET_INS_LOCAL)
 161                 return -EPERM;
 162
 163         new_me = lnet_me_alloc();
 164         if (new_me == NULL)
 165                 return -ENOMEM;
 166
 167         cpt = lnet_cpt_of_cookie(current_meh.cookie);
 168
 169         lnet_res_lock(cpt);
 170
 171         current_me = lnet_handle2me(&current_meh);
 172         if (current_me == NULL) {
 173                 lnet_me_free(new_me);
 174
 175                 lnet_res_unlock(cpt);
 176                 return -ENOENT;
 177         }
 178
 179         LASSERT(current_me->me_portal < the_lnet.ln_nportals);
 180
 181         ptl = the_lnet.ln_portals[current_me->me_portal];
 182         if (lnet_ptl_is_unique(ptl)) {
 183                 /* nosense to insertion on unique portal */
 184                 lnet_me_free(new_me);
 185                 lnet_res_unlock(cpt);
 186                 return -EPERM;
 187         }
 188
 189         new_me->me_pos = current_me->me_pos;
 190         new_me->me_portal = current_me->me_portal;
 191         new_me->me_match_id = match_id;
 192         new_me->me_match_bits = match_bits;
 193         new_me->me_ignore_bits = ignore_bits;
 194         new_me->me_unlink = unlink;
 195         new_me->me_md = NULL;
 196
 197         lnet_res_lh_initialize(the_lnet.ln_me_containers[cpt], &new_me->me_lh);
 198
 199         if (pos == LNET_INS_AFTER)
 200                 list_add(&new_me->me_list, &current_me->me_list);
 201         else
 202                 list_add_tail(&new_me->me_list, &current_me->me_list);
 203
 204         lnet_me2handle(handle, new_me);
 205
 206         lnet_res_unlock(cpt);
 207
 208         return 0;
 209 }
 210 EXPORT_SYMBOL(LNetMEInsert);
 211
 212 /**
 213  * Unlink a match entry from its match list.
 214  *
 215  * This operation also releases any resources associated with the ME. If a
 216  * memory descriptor is attached to the ME, then it will be unlinked as well
 217  * and an unlink event will be generated. It is an error to use the ME handle
 218  * after calling LNetMEUnlink().
 219  *
 220  * \param meh A handle for the ME to be unlinked.
 221  *
 222  * \retval 0       On success.
 223  * \retval -ENOENT If \a meh does not point to a valid ME.
 224  * \see LNetMDUnlink() for the discussion on delivering unlink event.
 225  */
 226 int
 227 LNetMEUnlink(lnet_handle_me_t meh)
 228 {
 229         lnet_me_t       *me;
 230         lnet_libmd_t    *md;
 231         lnet_event_t    ev;
 232         int             cpt;
 233
 234         LASSERT(the_lnet.ln_refcount > 0);
 235
 236         cpt = lnet_cpt_of_cookie(meh.cookie);
 237         lnet_res_lock(cpt);
 238
 239         me = lnet_handle2me(&meh);
 240         if (me == NULL) {
 241                 lnet_res_unlock(cpt);
 242                 return -ENOENT;
 243         }
 244
 245         md = me->me_md;
 246         if (md != NULL) {
 247                 md->md_flags |= LNET_MD_FLAG_ABORTED;
 248                 if (md->md_eq != NULL && md->md_refcount == 0) {
 249                         lnet_build_unlink_event(md, &ev);
 250                         lnet_eq_enqueue_event(md->md_eq, &ev);
 251                 }
 252         }
 253
 254         lnet_me_unlink(me);
 255
 256         lnet_res_unlock(cpt);
 257         return 0;
 258 }
 259 EXPORT_SYMBOL(LNetMEUnlink);
 260
 261 /* call with lnet_res_lock please */
 262 void
 263 lnet_me_unlink(lnet_me_t *me)
 264 {
 265         list_del(&me->me_list);
 266
 267         if (me->me_md != NULL) {
 268                 lnet_libmd_t *md = me->me_md;
 269
 270                 /* detach MD from portal of this ME */
 271                 lnet_ptl_detach_md(me, md);
 272                 lnet_md_unlink(md);
 273         }
 274
 275         lnet_res_lh_invalidate(&me->me_lh);
 276         lnet_me_free(me);
 277 }
 278
 279 #if 0
 280 static void
 281 lib_me_dump(lnet_me_t *me)
 282 {
 283         CWARN("Match Entry %p ("LPX64")\n", me,
 284               me->me_lh.lh_cookie);
 285
 286         CWARN("\tMatch/Ignore\t= %016lx / %016lx\n",
 287               me->me_match_bits, me->me_ignore_bits);
 288
 289         CWARN("\tMD\t= %p\n", me->md);
 290         CWARN("\tprev\t= %p\n",
 291               list_entry(me->me_list.prev, lnet_me_t, me_list));
 292         CWARN("\tnext\t= %p\n",
 293               list_entry(me->me_list.next, lnet_me_t, me_list));
 294 }
 295 #endif