Whamcloud - gitweb
LU-1425 build: make Lustre build ready for gcov
[fs/lustre-release.git] / lnet / lnet / lib-me.c
index eaa1576..8df9917 100644 (file)
@@ -1,6 +1,4 @@
-/* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
- * vim:expandtab:shiftwidth=8:tabstop=8:
- *
+/*
  * GPL HEADER START
  *
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
@@ -16,8 +14,8 @@
  * in the LICENSE file that accompanied this code).
  *
  * You should have received a copy of the GNU General Public License
- * version 2 along with this program; If not, see [sun.com URL with a
- * copy of GPLv2].
+ * version 2 along with this program; If not, see
+ * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
  *
  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  * CA 95054 USA or visit www.sun.com if you need additional information or
@@ -26,7 +24,7 @@
  * GPL HEADER END
  */
 /*
- * Copyright  2008 Sun Microsystems, Inc. All rights reserved
+ * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
  * Use is subject to license terms.
  */
 /*
 
 #include <lnet/lib-lnet.h>
 
+/**
+ * Create and attach a match entry to the match list of \a portal. The new
+ * ME is empty, i.e. not associated with a memory descriptor. LNetMDAttach()
+ * can be used to attach a MD to an empty ME.
+ *
+ * \param portal The portal table index where the ME should be attached.
+ * \param match_id Specifies the match criteria for the process ID of
+ * the requester. The constants LNET_PID_ANY and LNET_NID_ANY can be
+ * used to wildcard either of the identifiers in the lnet_process_id_t
+ * structure.
+ * \param match_bits,ignore_bits Specify the match criteria to apply
+ * to the match bits in the incoming request. The ignore bits are used
+ * to mask out insignificant bits in the incoming match bits. The resulting
+ * bits are then compared to the ME's match bits to determine if the
+ * incoming request meets the match criteria.
+ * \param unlink Indicates whether the ME should be unlinked when the memory
+ * descriptor associated with it is unlinked (Note that the check for
+ * unlinking a ME only occurs when the memory descriptor is unlinked.).
+ * Valid values are LNET_RETAIN and LNET_UNLINK.
+ * \param pos Indicates whether the new ME should be prepended or
+ * appended to the match list. Allowed constants: LNET_INS_BEFORE,
+ * LNET_INS_AFTER.
+ * \param handle On successful returns, a handle to the newly created ME
+ * object is saved here. This handle can be used later in LNetMEInsert(),
+ * LNetMEUnlink(), or LNetMDAttach() functions.
+ *
+ * \retval 0       On success.
+ * \retval -EINVAL If \a portal is invalid.
+ * \retval -ENOMEM If new ME object cannot be allocated.
+ */
 int
 LNetMEAttach(unsigned int portal,
-             lnet_process_id_t match_id, 
+             lnet_process_id_t match_id,
              __u64 match_bits, __u64 ignore_bits,
-             lnet_unlink_t unlink, lnet_ins_pos_t pos, 
+             lnet_unlink_t unlink, lnet_ins_pos_t pos,
              lnet_handle_me_t *handle)
 {
-        lnet_me_t     *me;
+       struct lnet_match_table *mtable;
+       struct lnet_me          *me;
+       cfs_list_t              *head;
+
+       LASSERT(the_lnet.ln_init);
+       LASSERT(the_lnet.ln_refcount > 0);
+
+       if ((int)portal >= the_lnet.ln_nportals)
+               return -EINVAL;
 
-        LASSERT (the_lnet.ln_init);
-        LASSERT (the_lnet.ln_refcount > 0);
-        
-        if (portal >= the_lnet.ln_nportals)
-                return -EINVAL;
+       mtable = lnet_mt_of_attach(portal, match_id,
+                                  match_bits, ignore_bits, pos);
+       if (mtable == NULL) /* can't match portal type */
+               return -EPERM;
 
-        me = lnet_me_alloc();
-        if (me == NULL)
-                return -ENOMEM;
+       me = lnet_me_alloc();
+       if (me == NULL)
+               return -ENOMEM;
 
-        LNET_LOCK();
+       lnet_res_lock(mtable->mt_cpt);
 
         me->me_portal = portal;
         me->me_match_id = match_id;
@@ -70,47 +105,88 @@ LNetMEAttach(unsigned int portal,
         me->me_unlink = unlink;
         me->me_md = NULL;
 
-        lnet_initialise_handle (&me->me_lh, LNET_COOKIE_TYPE_ME);
+       lnet_res_lh_initialize(the_lnet.ln_me_containers[mtable->mt_cpt],
+                              &me->me_lh);
+       if (ignore_bits != 0)
+               head = &mtable->mt_mhash[LNET_MT_HASH_IGNORE];
+       else
+               head = lnet_mt_match_head(mtable, match_id, match_bits);
 
-        if (pos == LNET_INS_AFTER)
-                list_add_tail(&me->me_list, &(the_lnet.ln_portals[portal].ptl_ml));
-        else
-                list_add(&me->me_list, &(the_lnet.ln_portals[portal].ptl_ml));
+       me->me_pos = head - &mtable->mt_mhash[0];
+       if (pos == LNET_INS_AFTER || pos == LNET_INS_LOCAL)
+               cfs_list_add_tail(&me->me_list, head);
+       else
+               cfs_list_add(&me->me_list, head);
 
-        lnet_me2handle(handle, me);
+       lnet_me2handle(handle, me);
 
-        LNET_UNLOCK();
-
-        return 0;
+       lnet_res_unlock(mtable->mt_cpt);
+       return 0;
 }
+EXPORT_SYMBOL(LNetMEAttach);
 
-int 
-LNetMEInsert(lnet_handle_me_t current_meh, 
-             lnet_process_id_t match_id, 
+/**
+ * Create and a match entry and insert it before or after the ME pointed to by
+ * \a current_meh. The new ME is empty, i.e. not associated with a memory
+ * descriptor. LNetMDAttach() can be used to attach a MD to an empty ME.
+ *
+ * This function is identical to LNetMEAttach() except for the position
+ * where the new ME is inserted.
+ *
+ * \param current_meh A handle for a ME. The new ME will be inserted
+ * immediately before or immediately after this ME.
+ * \param match_id,match_bits,ignore_bits,unlink,pos,handle See the discussion
+ * for LNetMEAttach().
+ *
+ * \retval 0       On success.
+ * \retval -ENOMEM If new ME object cannot be allocated.
+ * \retval -ENOENT If \a current_meh does not point to a valid match entry.
+ */
+int
+LNetMEInsert(lnet_handle_me_t current_meh,
+             lnet_process_id_t match_id,
              __u64 match_bits, __u64 ignore_bits,
              lnet_unlink_t unlink, lnet_ins_pos_t pos,
              lnet_handle_me_t *handle)
 {
-        lnet_me_t     *current_me;
-        lnet_me_t     *new_me;
+       struct lnet_me          *current_me;
+       struct lnet_me          *new_me;
+       struct lnet_portal      *ptl;
+       int                     cpt;
 
-        LASSERT (the_lnet.ln_init);        
-        LASSERT (the_lnet.ln_refcount > 0);
-        
-        new_me = lnet_me_alloc();
-        if (new_me == NULL)
-                return -ENOMEM;
+       LASSERT(the_lnet.ln_init);
+       LASSERT(the_lnet.ln_refcount > 0);
 
-        LNET_LOCK();
+       if (pos == LNET_INS_LOCAL)
+               return -EPERM;
 
-        current_me = lnet_handle2me(&current_meh);
-        if (current_me == NULL) {
-                lnet_me_free (new_me);
+       new_me = lnet_me_alloc();
+       if (new_me == NULL)
+               return -ENOMEM;
 
-                LNET_UNLOCK();
-                return -ENOENT;
+       cpt = lnet_cpt_of_cookie(current_meh.cookie);
+
+       lnet_res_lock(cpt);
+
+       current_me = lnet_handle2me(&current_meh);
+       if (current_me == NULL) {
+               lnet_me_free_locked(new_me);
+
+               lnet_res_unlock(cpt);
+               return -ENOENT;
+       }
+
+       LASSERT(current_me->me_portal < the_lnet.ln_nportals);
+
+       ptl = the_lnet.ln_portals[current_me->me_portal];
+       if (lnet_ptl_is_unique(ptl)) {
+               /* nosense to insertion on unique portal */
+               lnet_me_free_locked(new_me);
+               lnet_res_unlock(cpt);
+               return -EPERM;
         }
 
+       new_me->me_pos = current_me->me_pos;
         new_me->me_portal = current_me->me_portal;
         new_me->me_match_id = match_id;
         new_me->me_match_bits = match_bits;
@@ -118,35 +194,52 @@ LNetMEInsert(lnet_handle_me_t current_meh,
         new_me->me_unlink = unlink;
         new_me->me_md = NULL;
 
-        lnet_initialise_handle (&new_me->me_lh, LNET_COOKIE_TYPE_ME);
+       lnet_res_lh_initialize(the_lnet.ln_me_containers[cpt], &new_me->me_lh);
 
         if (pos == LNET_INS_AFTER)
-                list_add_tail(&new_me->me_list, &current_me->me_list);
+                cfs_list_add(&new_me->me_list, &current_me->me_list);
         else
-                list_add(&new_me->me_list, &current_me->me_list);
+                cfs_list_add_tail(&new_me->me_list, &current_me->me_list);
 
         lnet_me2handle(handle, new_me);
 
-        LNET_UNLOCK();
+       lnet_res_unlock(cpt);
 
-        return 0;
+       return 0;
 }
+EXPORT_SYMBOL(LNetMEInsert);
 
+/**
+ * Unlink a match entry from its match list.
+ *
+ * This operation also releases any resources associated with the ME. If a
+ * memory descriptor is attached to the ME, then it will be unlinked as well
+ * and an unlink event will be generated. It is an error to use the ME handle
+ * after calling LNetMEUnlink().
+ *
+ * \param meh A handle for the ME to be unlinked.
+ *
+ * \retval 0       On success.
+ * \retval -ENOENT If \a meh does not point to a valid ME.
+ * \see LNetMDUnlink() for the discussion on delivering unlink event.
+ */
 int
 LNetMEUnlink(lnet_handle_me_t meh)
 {
-        lnet_me_t    *me;
-        lnet_libmd_t *md;
-        lnet_event_t  ev;
+       lnet_me_t       *me;
+       lnet_libmd_t    *md;
+       lnet_event_t    ev;
+       int             cpt;
 
-        LASSERT (the_lnet.ln_init);
-        LASSERT (the_lnet.ln_refcount > 0);
+       LASSERT(the_lnet.ln_init);
+       LASSERT(the_lnet.ln_refcount > 0);
 
-        LNET_LOCK();
+       cpt = lnet_cpt_of_cookie(meh.cookie);
+       lnet_res_lock(cpt);
 
-        me = lnet_handle2me(&meh);
-        if (me == NULL) {
-                LNET_UNLOCK();
+       me = lnet_handle2me(&meh);
+       if (me == NULL) {
+               lnet_res_unlock(cpt);
                 return -ENOENT;
         }
 
@@ -155,28 +248,32 @@ LNetMEUnlink(lnet_handle_me_t meh)
             md->md_eq != NULL &&
             md->md_refcount == 0) {
                 lnet_build_unlink_event(md, &ev);
-                lnet_enq_event_locked(md->md_eq, &ev);
-        }
+               lnet_eq_enqueue_event(md->md_eq, &ev);
+       }
 
-        lnet_me_unlink(me);
+       lnet_me_unlink(me);
 
-        LNET_UNLOCK();
-        return 0;
+       lnet_res_unlock(cpt);
+       return 0;
 }
+EXPORT_SYMBOL(LNetMEUnlink);
 
-/* call with LNET_LOCK please */
+/* call with lnet_res_lock please */
 void
 lnet_me_unlink(lnet_me_t *me)
 {
-        list_del (&me->me_list);
+       cfs_list_del(&me->me_list);
 
-        if (me->me_md != NULL) {
-                me->me_md->md_me = NULL;
-                lnet_md_unlink(me->me_md);
-        }
+       if (me->me_md != NULL) {
+               lnet_libmd_t *md = me->me_md;
+
+               /* detach MD from portal of this ME */
+               lnet_ptl_detach_md(me, md);
+               lnet_md_unlink(md);
+       }
 
-        lnet_invalidate_handle (&me->me_lh);
-        lnet_me_free(me);
+       lnet_res_lh_invalidate(&me->me_lh);
+       lnet_me_free_locked(me);
 }
 
 #if 0
@@ -191,8 +288,8 @@ lib_me_dump(lnet_me_t *me)
 
         CWARN("\tMD\t= %p\n", me->md);
         CWARN("\tprev\t= %p\n",
-              list_entry(me->me_list.prev, lnet_me_t, me_list));
+              cfs_list_entry(me->me_list.prev, lnet_me_t, me_list));
         CWARN("\tnext\t= %p\n",
-              list_entry(me->me_list.next, lnet_me_t, me_list));
+              cfs_list_entry(me->me_list.next, lnet_me_t, me_list));
 }
 #endif