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,
63 * \param handle On successful returns, a handle to the newly created ME
64 * object is saved here. This handle can be used later in LNetMEInsert(),
65 * LNetMEUnlink(), or LNetMDAttach() functions.
67 * \retval 0 On success.
68 * \retval -EINVAL If \a portal is invalid.
69 * \retval -ENOMEM If new ME object cannot be allocated.
72 LNetMEAttach(unsigned int portal,
73 struct lnet_process_id match_id,
74 __u64 match_bits, __u64 ignore_bits,
75 enum lnet_unlink unlink, enum lnet_ins_pos pos,
76 struct lnet_handle_me *handle)
78 struct lnet_match_table *mtable;
80 struct list_head *head;
82 LASSERT(the_lnet.ln_refcount > 0);
84 if ((int)portal >= the_lnet.ln_nportals)
87 mtable = lnet_mt_of_attach(portal, match_id,
88 match_bits, ignore_bits, pos);
89 if (mtable == NULL) /* can't match portal type */
96 lnet_res_lock(mtable->mt_cpt);
98 me->me_portal = portal;
99 me->me_match_id = match_id;
100 me->me_match_bits = match_bits;
101 me->me_ignore_bits = ignore_bits;
102 me->me_unlink = unlink;
105 lnet_res_lh_initialize(the_lnet.ln_me_containers[mtable->mt_cpt],
107 if (ignore_bits != 0)
108 head = &mtable->mt_mhash[LNET_MT_HASH_IGNORE];
110 head = lnet_mt_match_head(mtable, match_id, match_bits);
112 me->me_pos = head - &mtable->mt_mhash[0];
113 if (pos == LNET_INS_AFTER || pos == LNET_INS_LOCAL)
114 list_add_tail(&me->me_list, head);
116 list_add(&me->me_list, head);
118 lnet_me2handle(handle, me);
120 lnet_res_unlock(mtable->mt_cpt);
123 EXPORT_SYMBOL(LNetMEAttach);
126 * Create and a match entry and insert it before or after the ME pointed to by
127 * \a current_meh. The new ME is empty, i.e. not associated with a memory
128 * descriptor. LNetMDAttach() can be used to attach a MD to an empty ME.
130 * This function is identical to LNetMEAttach() except for the position
131 * where the new ME is inserted.
133 * \param current_meh A handle for a ME. The new ME will be inserted
134 * immediately before or immediately after this ME.
135 * \param match_id,match_bits,ignore_bits,unlink,pos,handle See the discussion
136 * for LNetMEAttach().
138 * \retval 0 On success.
139 * \retval -ENOMEM If new ME object cannot be allocated.
140 * \retval -ENOENT If \a current_meh does not point to a valid match entry.
143 LNetMEInsert(struct lnet_handle_me current_meh,
144 struct lnet_process_id match_id,
145 __u64 match_bits, __u64 ignore_bits,
146 enum lnet_unlink unlink, enum lnet_ins_pos pos,
147 struct lnet_handle_me *handle)
149 struct lnet_me *current_me;
150 struct lnet_me *new_me;
151 struct lnet_portal *ptl;
154 LASSERT(the_lnet.ln_refcount > 0);
156 if (pos == LNET_INS_LOCAL)
159 new_me = lnet_me_alloc();
163 cpt = lnet_cpt_of_cookie(current_meh.cookie);
167 current_me = lnet_handle2me(¤t_meh);
168 if (current_me == NULL) {
169 lnet_me_free(new_me);
171 lnet_res_unlock(cpt);
175 LASSERT(current_me->me_portal < the_lnet.ln_nportals);
177 ptl = the_lnet.ln_portals[current_me->me_portal];
178 if (lnet_ptl_is_unique(ptl)) {
179 /* nosense to insertion on unique portal */
180 lnet_me_free(new_me);
181 lnet_res_unlock(cpt);
185 new_me->me_pos = current_me->me_pos;
186 new_me->me_portal = current_me->me_portal;
187 new_me->me_match_id = match_id;
188 new_me->me_match_bits = match_bits;
189 new_me->me_ignore_bits = ignore_bits;
190 new_me->me_unlink = unlink;
191 new_me->me_md = NULL;
193 lnet_res_lh_initialize(the_lnet.ln_me_containers[cpt], &new_me->me_lh);
195 if (pos == LNET_INS_AFTER)
196 list_add(&new_me->me_list, ¤t_me->me_list);
198 list_add_tail(&new_me->me_list, ¤t_me->me_list);
200 lnet_me2handle(handle, new_me);
202 lnet_res_unlock(cpt);
206 EXPORT_SYMBOL(LNetMEInsert);
209 * Unlink a match entry from its match list.
211 * This operation also releases any resources associated with the ME. If a
212 * memory descriptor is attached to the ME, then it will be unlinked as well
213 * and an unlink event will be generated. It is an error to use the ME handle
214 * after calling LNetMEUnlink().
216 * \param meh A handle for the ME to be unlinked.
218 * \retval 0 On success.
219 * \retval -ENOENT If \a meh does not point to a valid ME.
220 * \see LNetMDUnlink() for the discussion on delivering unlink event.
223 LNetMEUnlink(struct lnet_handle_me meh)
226 struct lnet_libmd *md;
227 struct lnet_event ev;
230 LASSERT(the_lnet.ln_refcount > 0);
232 cpt = lnet_cpt_of_cookie(meh.cookie);
235 me = lnet_handle2me(&meh);
237 lnet_res_unlock(cpt);
243 md->md_flags |= LNET_MD_FLAG_ABORTED;
244 if (md->md_eq != NULL && md->md_refcount == 0) {
245 lnet_build_unlink_event(md, &ev);
246 lnet_eq_enqueue_event(md->md_eq, &ev);
252 lnet_res_unlock(cpt);
255 EXPORT_SYMBOL(LNetMEUnlink);
257 /* call with lnet_res_lock please */
259 lnet_me_unlink(struct lnet_me *me)
261 list_del(&me->me_list);
263 if (me->me_md != NULL) {
264 struct lnet_libmd *md = me->me_md;
266 /* detach MD from portal of this ME */
267 lnet_ptl_detach_md(me, md);
271 lnet_res_lh_invalidate(&me->me_lh);
277 lib_me_dump(struct lnet_me *me)
279 CWARN("Match Entry %p (%#llx)\n", me,
280 me->me_lh.lh_cookie);
282 CWARN("\tMatch/Ignore\t= %016lx / %016lx\n",
283 me->me_match_bits, me->me_ignore_bits);
285 CWARN("\tMD\t= %p\n", me->md);
286 CWARN("\tprev\t= %p\n",
287 list_entry(me->me_list.prev, struct lnet_me, me_list));
288 CWARN("\tnext\t= %p\n",
289 list_entry(me->me_list.next, struct lnet_me, me_list));