4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
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.
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).
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
23 * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Use is subject to license terms.
26 * Copyright (c) 2012, 2013, Intel Corporation.
29 * This file is part of Lustre, http://www.lustre.org/
30 * Lustre is a trademark of Sun Microsystems, Inc.
34 * Match Entry management routines
37 #define DEBUG_SUBSYSTEM S_LNET
39 #include <lnet/lib-lnet.h>
42 * Create and attach a match entry to the match list of \a portal. The new
43 * ME is empty, i.e. not associated with a memory descriptor. LNetMDAttach()
44 * can be used to attach a MD to an empty ME.
46 * \param portal The portal table index where the ME should be attached.
47 * \param match_id Specifies the match criteria for the process ID of
48 * the requester. The constants LNET_PID_ANY and LNET_NID_ANY can be
49 * used to wildcard either of the identifiers in the struct lnet_process_id
51 * \param match_bits,ignore_bits Specify the match criteria to apply
52 * to the match bits in the incoming request. The ignore bits are used
53 * to mask out insignificant bits in the incoming match bits. The resulting
54 * bits are then compared to the ME's match bits to determine if the
55 * incoming request meets the match criteria.
56 * \param unlink Indicates whether the ME should be unlinked when the memory
57 * descriptor associated with it is unlinked (Note that the check for
58 * unlinking a ME only occurs when the memory descriptor is unlinked.).
59 * Valid values are LNET_RETAIN and LNET_UNLINK.
60 * \param pos Indicates whether the new ME should be prepended or
61 * appended to the match list. Allowed constants: LNET_INS_BEFORE,
64 * \retval A handle to the newly created ME is returned on success
65 * \retval ERR_PTR(-EINVAL) If \a portal is invalid.
66 * \retval ERR_PTR(-ENOMEM) If new ME object cannot be allocated.
69 LNetMEAttach(unsigned int portal,
70 struct lnet_process_id match_id,
71 __u64 match_bits, __u64 ignore_bits,
72 enum lnet_unlink unlink, enum lnet_ins_pos pos)
74 struct lnet_match_table *mtable;
76 struct list_head *head;
78 LASSERT(the_lnet.ln_refcount > 0);
80 if ((int)portal >= the_lnet.ln_nportals)
81 return ERR_PTR(-EINVAL);
83 mtable = lnet_mt_of_attach(portal, match_id,
84 match_bits, ignore_bits, pos);
85 if (mtable == NULL) /* can't match portal type */
86 return ERR_PTR(-EPERM);
88 me = kmem_cache_alloc(lnet_mes_cachep, GFP_NOFS | __GFP_ZERO);
90 CDEBUG(D_MALLOC, "failed to allocate 'me'\n");
91 return ERR_PTR(-ENOMEM);
93 CDEBUG(D_MALLOC, "slab-alloced 'me' at %p.\n", me);
95 lnet_res_lock(mtable->mt_cpt);
97 me->me_portal = portal;
98 me->me_match_id = match_id;
99 me->me_match_bits = match_bits;
100 me->me_ignore_bits = ignore_bits;
101 me->me_unlink = unlink;
104 me->me_cpt = mtable->mt_cpt;
106 if (ignore_bits != 0)
107 head = &mtable->mt_mhash[LNET_MT_HASH_IGNORE];
109 head = lnet_mt_match_head(mtable, match_id, match_bits);
111 me->me_pos = head - &mtable->mt_mhash[0];
112 if (pos == LNET_INS_AFTER || pos == LNET_INS_LOCAL)
113 list_add_tail(&me->me_list, head);
115 list_add(&me->me_list, head);
117 lnet_res_unlock(mtable->mt_cpt);
120 EXPORT_SYMBOL(LNetMEAttach);
123 * Unlink a match entry from its match list.
125 * This operation also releases any resources associated with the ME. If a
126 * memory descriptor is attached to the ME, then it will be unlinked as well
127 * and an unlink event will be generated. It is an error to use the ME handle
128 * after calling LNetMEUnlink().
130 * \param meh A handle for the ME to be unlinked.
132 * \retval 0 On success.
133 * \retval -ENOENT If \a meh does not point to a valid ME.
134 * \see LNetMDUnlink() for the discussion on delivering unlink event.
137 LNetMEUnlink(struct lnet_me *me)
139 struct lnet_libmd *md;
140 struct lnet_event ev;
143 LASSERT(the_lnet.ln_refcount > 0);
150 md->md_flags |= LNET_MD_FLAG_ABORTED;
151 if (md->md_eq != NULL && md->md_refcount == 0) {
152 lnet_build_unlink_event(md, &ev);
153 lnet_eq_enqueue_event(md->md_eq, &ev);
159 lnet_res_unlock(cpt);
161 EXPORT_SYMBOL(LNetMEUnlink);
163 /* call with lnet_res_lock please */
165 lnet_me_unlink(struct lnet_me *me)
167 list_del(&me->me_list);
169 if (me->me_md != NULL) {
170 struct lnet_libmd *md = me->me_md;
172 /* detach MD from portal of this ME */
173 lnet_ptl_detach_md(me, md);
177 CDEBUG(D_MALLOC, "slab-freed 'me' at %p.\n", me);
178 kmem_cache_free(lnet_mes_cachep, me);
183 lib_me_dump(struct lnet_me *me)
185 CWARN("Match Entry %p (%#llx)\n", me,
186 me->me_lh.lh_cookie);
188 CWARN("\tMatch/Ignore\t= %016lx / %016lx\n",
189 me->me_match_bits, me->me_ignore_bits);
191 CWARN("\tMD\t= %p\n", me->md);
192 CWARN("\tprev\t= %p\n",
193 list_entry(me->me_list.prev, struct lnet_me, me_list));
194 CWARN("\tnext\t= %p\n",
195 list_entry(me->me_list.next, struct lnet_me, me_list));