1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2 * vim:expandtab:shiftwidth=8:tabstop=8:
6 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 only,
10 * as published by the Free Software Foundation.
12 * This program is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * General Public License version 2 for more details (a copy is included
16 * in the LICENSE file that accompanied this code).
18 * You should have received a copy of the GNU General Public License
19 * version 2 along with this program; If not, see
20 * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
22 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
23 * CA 95054 USA or visit www.sun.com if you need additional information or
29 * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
30 * Use is subject to license terms.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
38 * Memory Descriptor management routines
41 #define DEBUG_SUBSYSTEM S_LNET
43 #include <lnet/lib-lnet.h>
45 /* must be called with LNET_LOCK held */
47 lnet_md_unlink(lnet_libmd_t *md)
49 if ((md->md_flags & LNET_MD_FLAG_ZOMBIE) == 0) {
50 /* first unlink attempt... */
51 lnet_me_t *me = md->md_me;
53 md->md_flags |= LNET_MD_FLAG_ZOMBIE;
55 /* Disassociate from ME (if any), and unlink it if it was created
60 if (me->me_unlink == LNET_UNLINK)
64 /* ensure all future handle lookups fail */
65 lnet_invalidate_handle(&md->md_lh);
68 if (md->md_refcount != 0) {
69 CDEBUG(D_NET, "Queueing unlink of md %p\n", md);
73 CDEBUG(D_NET, "Unlinking md %p\n", md);
75 if (md->md_eq != NULL) {
76 md->md_eq->eq_refcount--;
77 LASSERT (md->md_eq->eq_refcount >= 0);
80 LASSERT (!cfs_list_empty(&md->md_list));
81 cfs_list_del_init (&md->md_list);
85 /* must be called with LNET_LOCK held */
87 lib_md_build(lnet_libmd_t *lmd, lnet_md_t *umd, int unlink)
94 /* NB we are passed an allocated, but uninitialised/active md.
95 * if we return success, caller may lnet_md_unlink() it.
96 * otherwise caller may only lnet_md_free() it.
99 if (!LNetHandleIsInvalid (umd->eq_handle)) {
100 eq = lnet_handle2eq(&umd->eq_handle);
105 /* This implementation doesn't know how to create START events or
106 * disable END events. Best to LASSERT our caller is compliant so
107 * we find out quickly... */
108 /* TODO - reevaluate what should be here in light of
109 * the removal of the start and end events
110 * maybe there we shouldn't even allow LNET_EQ_NONE!)
111 LASSERT (eq == NULL);
115 lmd->md_start = umd->start;
117 lmd->md_max_size = umd->max_size;
118 lmd->md_options = umd->options;
119 lmd->md_user_ptr = umd->user_ptr;
121 lmd->md_threshold = umd->threshold;
122 lmd->md_refcount = 0;
123 lmd->md_flags = (unlink == LNET_UNLINK) ? LNET_MD_FLAG_AUTO_UNLINK : 0;
125 if ((umd->options & LNET_MD_IOVEC) != 0) {
127 if ((umd->options & LNET_MD_KIOV) != 0) /* Can't specify both */
130 lmd->md_niov = niov = umd->length;
131 memcpy(lmd->md_iov.iov, umd->start,
132 niov * sizeof (lmd->md_iov.iov[0]));
134 for (i = 0; i < (int)niov; i++) {
135 /* We take the base address on trust */
136 if (lmd->md_iov.iov[i].iov_len <= 0) /* invalid length */
139 total_length += lmd->md_iov.iov[i].iov_len;
142 lmd->md_length = total_length;
144 if ((umd->options & LNET_MD_MAX_SIZE) != 0 && /* max size used */
145 (umd->max_size < 0 ||
146 umd->max_size > total_length)) // illegal max_size
149 } else if ((umd->options & LNET_MD_KIOV) != 0) {
153 lmd->md_niov = niov = umd->length;
154 memcpy(lmd->md_iov.kiov, umd->start,
155 niov * sizeof (lmd->md_iov.kiov[0]));
157 for (i = 0; i < (int)niov; i++) {
158 /* We take the page pointer on trust */
159 if (lmd->md_iov.kiov[i].kiov_offset +
160 lmd->md_iov.kiov[i].kiov_len > CFS_PAGE_SIZE )
161 return -EINVAL; /* invalid length */
163 total_length += lmd->md_iov.kiov[i].kiov_len;
166 lmd->md_length = total_length;
168 if ((umd->options & LNET_MD_MAX_SIZE) != 0 && /* max size used */
169 (umd->max_size < 0 ||
170 umd->max_size > total_length)) // illegal max_size
173 } else { /* contiguous */
174 lmd->md_length = umd->length;
175 lmd->md_niov = niov = 1;
176 lmd->md_iov.iov[0].iov_base = umd->start;
177 lmd->md_iov.iov[0].iov_len = umd->length;
179 if ((umd->options & LNET_MD_MAX_SIZE) != 0 && /* max size used */
180 (umd->max_size < 0 ||
181 umd->max_size > (int)umd->length)) // illegal max_size
188 /* It's good; let handle2md succeed and add to active mds */
189 lnet_initialise_handle (&lmd->md_lh, LNET_COOKIE_TYPE_MD);
190 LASSERT (cfs_list_empty(&lmd->md_list));
191 cfs_list_add (&lmd->md_list, &the_lnet.ln_active_mds);
196 /* must be called with LNET_LOCK held */
198 lnet_md_deconstruct(lnet_libmd_t *lmd, lnet_md_t *umd)
200 /* NB this doesn't copy out all the iov entries so when a
201 * discontiguous MD is copied out, the target gets to know the
202 * original iov pointer (in start) and the number of entries it had
205 umd->start = lmd->md_start;
206 umd->length = ((lmd->md_options & (LNET_MD_IOVEC | LNET_MD_KIOV)) == 0) ?
207 lmd->md_length : lmd->md_niov;
208 umd->threshold = lmd->md_threshold;
209 umd->max_size = lmd->md_max_size;
210 umd->options = lmd->md_options;
211 umd->user_ptr = lmd->md_user_ptr;
212 lnet_eq2handle(&umd->eq_handle, lmd->md_eq);
216 lnet_md_validate(lnet_md_t *umd)
218 if (umd->start == NULL) {
219 CERROR("MD start pointer can not be NULL\n");
223 if ((umd->options & (LNET_MD_KIOV | LNET_MD_IOVEC)) != 0 &&
224 umd->length > LNET_MAX_IOV) {
225 CERROR("Invalid option: too many fragments %u, %d max\n",
226 umd->length, LNET_MAX_IOV);
234 * Create a memory descriptor and attach it to a ME
236 * \param meh A handle for a ME to associate the new MD with.
237 * \param umd Provides initial values for the user-visible parts of a MD.
238 * Other than its use for initialization, there is no linkage between this
239 * structure and the MD maintained by the LNet.
240 * \param unlink A flag to indicate whether the MD is automatically unlinked
241 * when it becomes inactive, either because the operation threshold drops to
242 * zero or because the available memory becomes less than \a umd.max_size.
243 * (Note that the check for unlinking a MD only occurs after the completion
244 * of a successful operation on the MD.) The value LNET_UNLINK enables auto
245 * unlinking; the value LNET_RETAIN disables it.
246 * \param handle On successful returns, a handle to the newly created MD is
247 * saved here. This handle can be used later in LNetMDUnlink().
249 * \retval 0 On success.
250 * \retval -EINVAL If \a umd is not valid.
251 * \retval -ENOMEM If new MD cannot be allocated.
252 * \retval -ENOENT Either \a meh or \a umd.eq_handle does not point to a
253 * valid object. Note that it's OK to supply a NULL \a umd.eq_handle by
254 * calling LNetInvalidateHandle() on it.
255 * \retval -EBUSY If the ME pointed to by \a meh is already associated with
259 LNetMDAttach(lnet_handle_me_t meh, lnet_md_t umd,
260 lnet_unlink_t unlink, lnet_handle_md_t *handle)
266 LASSERT (the_lnet.ln_init);
267 LASSERT (the_lnet.ln_refcount > 0);
269 if (lnet_md_validate(&umd) != 0)
272 if ((umd.options & (LNET_MD_OP_GET | LNET_MD_OP_PUT)) == 0) {
273 CERROR("Invalid option: no MD_OP set\n");
277 md = lnet_md_alloc(&umd);
283 me = lnet_handle2me(&meh);
286 } else if (me->me_md != NULL) {
289 rc = lib_md_build(md, &umd, unlink);
291 the_lnet.ln_portals[me->me_portal].ptl_ml_version++;
296 lnet_md2handle(handle, md);
298 /* check if this MD matches any blocked msgs */
299 lnet_match_blocked_msg(md); /* expects LNET_LOCK held */
313 * Create a "free floating" memory descriptor - a MD that is not associated
314 * with a ME. Such MDs are usually used in LNetPut() and LNetGet() operations.
316 * \param umd,unlink See the discussion for LNetMDAttach().
317 * \param handle On successful returns, a handle to the newly created MD is
318 * saved here. This handle can be used later in LNetMDUnlink(), LNetPut(),
319 * and LNetGet() operations.
321 * \retval 0 On success.
322 * \retval -EINVAL If \a umd is not valid.
323 * \retval -ENOMEM If new MD cannot be allocated.
324 * \retval -ENOENT \a umd.eq_handle does not point to a valid EQ. Note that
325 * it's OK to supply a NULL \a umd.eq_handle by calling
326 * LNetInvalidateHandle() on it.
329 LNetMDBind(lnet_md_t umd, lnet_unlink_t unlink, lnet_handle_md_t *handle)
334 LASSERT (the_lnet.ln_init);
335 LASSERT (the_lnet.ln_refcount > 0);
337 if (lnet_md_validate(&umd) != 0)
340 if ((umd.options & (LNET_MD_OP_GET | LNET_MD_OP_PUT)) != 0) {
341 CERROR("Invalid option: GET|PUT illegal on active MDs\n");
345 md = lnet_md_alloc(&umd);
351 rc = lib_md_build(md, &umd, unlink);
354 lnet_md2handle(handle, md);
367 * Unlink the memory descriptor from any ME it may be linked to and release
368 * the internal resources associated with it.
370 * This function does not free the memory region associated with the MD;
371 * i.e., the memory the user allocated for this MD. If the ME associated with
372 * this MD is not NULL and was created with auto unlink enabled, the ME is
373 * unlinked as well (see LNetMEAttach()).
375 * Explicitly unlinking a MD via this function call has the same behavior as
376 * a MD that has been automatically unlinked, except that no LNET_EVENT_UNLINK
377 * is generated in the latter case.
379 * An unlinked event can be reported in two ways:
380 * - If there's no pending operations on the MD, it's unlinked immediately
381 * and an LNET_EVENT_UNLINK event is logged before this function returns.
382 * - Otherwise, the MD is only marked for deletion when this function
383 * returns, and the unlinked event will be piggybacked on the event of
384 * the completion of the last operation by setting the unlinked field of
385 * the event. No dedicated LNET_EVENT_UNLINK event is generated.
387 * Note that in both cases the unlinked field of the event is always set; no
388 * more event will happen on the MD after such an event is logged.
390 * \param mdh A handle for the MD to be unlinked.
392 * \retval 0 On success.
393 * \retval -ENOENT If \a mdh does not point to a valid MD object.
396 LNetMDUnlink (lnet_handle_md_t mdh)
401 LASSERT (the_lnet.ln_init);
402 LASSERT (the_lnet.ln_refcount > 0);
406 md = lnet_handle2md(&mdh);
412 /* If the MD is busy, lnet_md_unlink just marks it for deletion, and
413 * when the NAL is done, the completion event flags that the MD was
414 * unlinked. Otherwise, we enqueue an event now... */
416 if (md->md_eq != NULL &&
417 md->md_refcount == 0) {
418 lnet_build_unlink_event(md, &ev);
419 lnet_enq_event_locked(md->md_eq, &ev);