Whamcloud - gitweb
LU-1425 build: make Lustre build ready for gcov
[fs/lustre-release.git] / lnet / lnet / lib-md.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 /*
31  * This file is part of Lustre, http://www.lustre.org/
32  * Lustre is a trademark of Sun Microsystems, Inc.
33  *
34  * lnet/lnet/lib-md.c
35  *
36  * Memory Descriptor management routines
37  */
38
39 #define DEBUG_SUBSYSTEM S_LNET
40
41 #include <lnet/lib-lnet.h>
42
43 /* must be called with lnet_res_lock held */
44 void
45 lnet_md_unlink(lnet_libmd_t *md)
46 {
47         if ((md->md_flags & LNET_MD_FLAG_ZOMBIE) == 0) {
48                 /* first unlink attempt... */
49                 lnet_me_t *me = md->md_me;
50
51                 md->md_flags |= LNET_MD_FLAG_ZOMBIE;
52
53                 /* Disassociate from ME (if any), and unlink it if it was created
54                  * with LNET_UNLINK */
55                 if (me != NULL) {
56                         /* detach MD from portal */
57                         lnet_ptl_detach_md(me, md);
58                         if (me->me_unlink == LNET_UNLINK)
59                                 lnet_me_unlink(me);
60                 }
61
62                 /* ensure all future handle lookups fail */
63                 lnet_res_lh_invalidate(&md->md_lh);
64         }
65
66         if (md->md_refcount != 0) {
67                 CDEBUG(D_NET, "Queueing unlink of md %p\n", md);
68                 return;
69         }
70
71         CDEBUG(D_NET, "Unlinking md %p\n", md);
72
73         if (md->md_eq != NULL) {
74                 int     cpt = lnet_cpt_of_cookie(md->md_lh.lh_cookie);
75
76                 LASSERT(*md->md_eq->eq_refs[cpt] > 0);
77                 (*md->md_eq->eq_refs[cpt])--;
78         }
79
80         LASSERT(!cfs_list_empty(&md->md_list));
81         cfs_list_del_init(&md->md_list);
82         lnet_md_free_locked(md);
83 }
84
85 static int
86 lnet_md_build(lnet_libmd_t *lmd, lnet_md_t *umd, int unlink)
87 {
88         int          i;
89         unsigned int niov;
90         int          total_length = 0;
91
92         lmd->md_me = NULL;
93         lmd->md_start = umd->start;
94         lmd->md_offset = 0;
95         lmd->md_max_size = umd->max_size;
96         lmd->md_options = umd->options;
97         lmd->md_user_ptr = umd->user_ptr;
98         lmd->md_eq = NULL;
99         lmd->md_threshold = umd->threshold;
100         lmd->md_refcount = 0;
101         lmd->md_flags = (unlink == LNET_UNLINK) ? LNET_MD_FLAG_AUTO_UNLINK : 0;
102
103         if ((umd->options & LNET_MD_IOVEC) != 0) {
104
105                 if ((umd->options & LNET_MD_KIOV) != 0) /* Can't specify both */
106                         return -EINVAL;
107
108                 lmd->md_niov = niov = umd->length;
109                 memcpy(lmd->md_iov.iov, umd->start,
110                        niov * sizeof (lmd->md_iov.iov[0]));
111
112                 for (i = 0; i < (int)niov; i++) {
113                         /* We take the base address on trust */
114                         if (lmd->md_iov.iov[i].iov_len <= 0) /* invalid length */
115                                 return -EINVAL;
116
117                         total_length += lmd->md_iov.iov[i].iov_len;
118                 }
119
120                 lmd->md_length = total_length;
121
122                 if ((umd->options & LNET_MD_MAX_SIZE) != 0 && /* max size used */
123                     (umd->max_size < 0 ||
124                      umd->max_size > total_length)) // illegal max_size
125                         return -EINVAL;
126
127         } else if ((umd->options & LNET_MD_KIOV) != 0) {
128 #ifndef __KERNEL__
129                 return -EINVAL;
130 #else
131                 lmd->md_niov = niov = umd->length;
132                 memcpy(lmd->md_iov.kiov, umd->start,
133                        niov * sizeof (lmd->md_iov.kiov[0]));
134
135                 for (i = 0; i < (int)niov; i++) {
136                         /* We take the page pointer on trust */
137                         if (lmd->md_iov.kiov[i].kiov_offset +
138                             lmd->md_iov.kiov[i].kiov_len > CFS_PAGE_SIZE )
139                                 return -EINVAL; /* invalid length */
140
141                         total_length += lmd->md_iov.kiov[i].kiov_len;
142                 }
143
144                 lmd->md_length = total_length;
145
146                 if ((umd->options & LNET_MD_MAX_SIZE) != 0 && /* max size used */
147                     (umd->max_size < 0 ||
148                      umd->max_size > total_length)) // illegal max_size
149                         return -EINVAL;
150 #endif
151         } else {   /* contiguous */
152                 lmd->md_length = umd->length;
153                 lmd->md_niov = niov = 1;
154                 lmd->md_iov.iov[0].iov_base = umd->start;
155                 lmd->md_iov.iov[0].iov_len = umd->length;
156
157                 if ((umd->options & LNET_MD_MAX_SIZE) != 0 && /* max size used */
158                     (umd->max_size < 0 ||
159                      umd->max_size > (int)umd->length)) // illegal max_size
160                         return -EINVAL;
161         }
162
163         return 0;
164 }
165
166 /* must be called with resource lock held */
167 static int
168 lnet_md_link(lnet_libmd_t *md, lnet_handle_eq_t eq_handle, int cpt)
169 {
170         struct lnet_res_container *container = the_lnet.ln_md_containers[cpt];
171
172         /* NB we are passed an allocated, but inactive md.
173          * if we return success, caller may lnet_md_unlink() it.
174          * otherwise caller may only lnet_md_free() it.
175          */
176         /* This implementation doesn't know how to create START events or
177          * disable END events.  Best to LASSERT our caller is compliant so
178          * we find out quickly...  */
179         /*  TODO - reevaluate what should be here in light of
180          * the removal of the start and end events
181          * maybe there we shouldn't even allow LNET_EQ_NONE!)
182          * LASSERT (eq == NULL);
183          */
184         if (!LNetHandleIsInvalid(eq_handle)) {
185                 md->md_eq = lnet_handle2eq(&eq_handle);
186
187                 if (md->md_eq == NULL)
188                         return -ENOENT;
189
190                 (*md->md_eq->eq_refs[cpt])++;
191         }
192
193         lnet_res_lh_initialize(container, &md->md_lh);
194
195         LASSERT(cfs_list_empty(&md->md_list));
196         cfs_list_add(&md->md_list, &container->rec_active);
197
198         return 0;
199 }
200
201 /* must be called with lnet_res_lock held */
202 void
203 lnet_md_deconstruct(lnet_libmd_t *lmd, lnet_md_t *umd)
204 {
205         /* NB this doesn't copy out all the iov entries so when a
206          * discontiguous MD is copied out, the target gets to know the
207          * original iov pointer (in start) and the number of entries it had
208          * and that's all.
209          */
210         umd->start = lmd->md_start;
211         umd->length = ((lmd->md_options & (LNET_MD_IOVEC | LNET_MD_KIOV)) == 0) ?
212                       lmd->md_length : lmd->md_niov;
213         umd->threshold = lmd->md_threshold;
214         umd->max_size = lmd->md_max_size;
215         umd->options = lmd->md_options;
216         umd->user_ptr = lmd->md_user_ptr;
217         lnet_eq2handle(&umd->eq_handle, lmd->md_eq);
218 }
219
220 int
221 lnet_md_validate(lnet_md_t *umd)
222 {
223         if (umd->start == NULL && umd->length != 0) {
224                 CERROR("MD start pointer can not be NULL with length %u\n",
225                        umd->length);
226                 return -EINVAL;
227         }
228
229         if ((umd->options & (LNET_MD_KIOV | LNET_MD_IOVEC)) != 0 &&
230             umd->length > LNET_MAX_IOV) {
231                 CERROR("Invalid option: too many fragments %u, %d max\n",
232                        umd->length, LNET_MAX_IOV);
233                 return -EINVAL;
234         }
235
236         return 0;
237 }
238
239 /**
240  * Create a memory descriptor and attach it to a ME
241  *
242  * \param meh A handle for a ME to associate the new MD with.
243  * \param umd Provides initial values for the user-visible parts of a MD.
244  * Other than its use for initialization, there is no linkage between this
245  * structure and the MD maintained by the LNet.
246  * \param unlink A flag to indicate whether the MD is automatically unlinked
247  * when it becomes inactive, either because the operation threshold drops to
248  * zero or because the available memory becomes less than \a umd.max_size.
249  * (Note that the check for unlinking a MD only occurs after the completion
250  * of a successful operation on the MD.) The value LNET_UNLINK enables auto
251  * unlinking; the value LNET_RETAIN disables it.
252  * \param handle On successful returns, a handle to the newly created MD is
253  * saved here. This handle can be used later in LNetMDUnlink().
254  *
255  * \retval 0       On success.
256  * \retval -EINVAL If \a umd is not valid.
257  * \retval -ENOMEM If new MD cannot be allocated.
258  * \retval -ENOENT Either \a meh or \a umd.eq_handle does not point to a
259  * valid object. Note that it's OK to supply a NULL \a umd.eq_handle by
260  * calling LNetInvalidateHandle() on it.
261  * \retval -EBUSY  If the ME pointed to by \a meh is already associated with
262  * a MD.
263  */
264 int
265 LNetMDAttach(lnet_handle_me_t meh, lnet_md_t umd,
266              lnet_unlink_t unlink, lnet_handle_md_t *handle)
267 {
268         CFS_LIST_HEAD           (matches);
269         CFS_LIST_HEAD           (drops);
270         struct lnet_me          *me;
271         struct lnet_libmd       *md;
272         int                     cpt;
273         int                     rc;
274
275         LASSERT (the_lnet.ln_init);
276         LASSERT (the_lnet.ln_refcount > 0);
277
278         if (lnet_md_validate(&umd) != 0)
279                 return -EINVAL;
280
281         if ((umd.options & (LNET_MD_OP_GET | LNET_MD_OP_PUT)) == 0) {
282                 CERROR("Invalid option: no MD_OP set\n");
283                 return -EINVAL;
284         }
285
286         md = lnet_md_alloc(&umd);
287         if (md == NULL)
288                 return -ENOMEM;
289
290         rc = lnet_md_build(md, &umd, unlink);
291         cpt = lnet_cpt_of_cookie(meh.cookie);
292
293         lnet_res_lock(cpt);
294         if (rc != 0)
295                 goto failed;
296
297         me = lnet_handle2me(&meh);
298         if (me == NULL)
299                 rc = -ENOENT;
300         else if (me->me_md != NULL)
301                 rc = -EBUSY;
302         else
303                 rc = lnet_md_link(md, umd.eq_handle, cpt);
304
305         if (rc != 0)
306                 goto failed;
307
308         /* attach this MD to portal of ME and check if it matches any
309          * blocked msgs on this portal */
310         lnet_ptl_attach_md(me, md, &matches, &drops);
311
312         lnet_md2handle(handle, md);
313
314         lnet_res_unlock(cpt);
315
316         lnet_drop_delayed_msg_list(&drops, "Bad match");
317         lnet_recv_delayed_msg_list(&matches);
318
319         return 0;
320
321  failed:
322         lnet_md_free_locked(md);
323
324         lnet_res_unlock(cpt);
325         return rc;
326 }
327 EXPORT_SYMBOL(LNetMDAttach);
328
329 /**
330  * Create a "free floating" memory descriptor - a MD that is not associated
331  * with a ME. Such MDs are usually used in LNetPut() and LNetGet() operations.
332  *
333  * \param umd,unlink See the discussion for LNetMDAttach().
334  * \param handle On successful returns, a handle to the newly created MD is
335  * saved here. This handle can be used later in LNetMDUnlink(), LNetPut(),
336  * and LNetGet() operations.
337  *
338  * \retval 0       On success.
339  * \retval -EINVAL If \a umd is not valid.
340  * \retval -ENOMEM If new MD cannot be allocated.
341  * \retval -ENOENT \a umd.eq_handle does not point to a valid EQ. Note that
342  * it's OK to supply a NULL \a umd.eq_handle by calling
343  * LNetInvalidateHandle() on it.
344  */
345 int
346 LNetMDBind(lnet_md_t umd, lnet_unlink_t unlink, lnet_handle_md_t *handle)
347 {
348         lnet_libmd_t    *md;
349         int             cpt;
350         int             rc;
351
352         LASSERT (the_lnet.ln_init);
353         LASSERT (the_lnet.ln_refcount > 0);
354
355         if (lnet_md_validate(&umd) != 0)
356                 return -EINVAL;
357
358         if ((umd.options & (LNET_MD_OP_GET | LNET_MD_OP_PUT)) != 0) {
359                 CERROR("Invalid option: GET|PUT illegal on active MDs\n");
360                 return -EINVAL;
361         }
362
363         md = lnet_md_alloc(&umd);
364         if (md == NULL)
365                 return -ENOMEM;
366
367         rc = lnet_md_build(md, &umd, unlink);
368
369         cpt = lnet_res_lock_current();
370         if (rc != 0)
371                 goto failed;
372
373         rc = lnet_md_link(md, umd.eq_handle, cpt);
374         if (rc != 0)
375                 goto failed;
376
377         lnet_md2handle(handle, md);
378
379         lnet_res_unlock(cpt);
380         return 0;
381
382  failed:
383         lnet_md_free_locked(md);
384
385         lnet_res_unlock(cpt);
386         return rc;
387 }
388 EXPORT_SYMBOL(LNetMDBind);
389
390 /**
391  * Unlink the memory descriptor from any ME it may be linked to and release
392  * the internal resources associated with it.
393  *
394  * This function does not free the memory region associated with the MD;
395  * i.e., the memory the user allocated for this MD. If the ME associated with
396  * this MD is not NULL and was created with auto unlink enabled, the ME is
397  * unlinked as well (see LNetMEAttach()).
398  *
399  * Explicitly unlinking a MD via this function call has the same behavior as
400  * a MD that has been automatically unlinked, except that no LNET_EVENT_UNLINK
401  * is generated in the latter case.
402  *
403  * An unlinked event can be reported in two ways:
404  * - If there's no pending operations on the MD, it's unlinked immediately
405  *   and an LNET_EVENT_UNLINK event is logged before this function returns.
406  * - Otherwise, the MD is only marked for deletion when this function
407  *   returns, and the unlinked event will be piggybacked on the event of
408  *   the completion of the last operation by setting the unlinked field of
409  *   the event. No dedicated LNET_EVENT_UNLINK event is generated.
410  *
411  * Note that in both cases the unlinked field of the event is always set; no
412  * more event will happen on the MD after such an event is logged.
413  *
414  * \param mdh A handle for the MD to be unlinked.
415  *
416  * \retval 0       On success.
417  * \retval -ENOENT If \a mdh does not point to a valid MD object.
418  */
419 int
420 LNetMDUnlink (lnet_handle_md_t mdh)
421 {
422         lnet_event_t    ev;
423         lnet_libmd_t    *md;
424         int             cpt;
425
426         LASSERT(the_lnet.ln_init);
427         LASSERT(the_lnet.ln_refcount > 0);
428
429         cpt = lnet_cpt_of_cookie(mdh.cookie);
430         lnet_res_lock(cpt);
431
432         md = lnet_handle2md(&mdh);
433         if (md == NULL) {
434                 lnet_res_unlock(cpt);
435                 return -ENOENT;
436         }
437
438         /* If the MD is busy, lnet_md_unlink just marks it for deletion, and
439          * when the NAL is done, the completion event flags that the MD was
440          * unlinked.  Otherwise, we enqueue an event now... */
441
442         if (md->md_eq != NULL &&
443             md->md_refcount == 0) {
444                 lnet_build_unlink_event(md, &ev);
445                 lnet_eq_enqueue_event(md->md_eq, &ev);
446         }
447
448         lnet_md_unlink(md);
449
450         lnet_res_unlock(cpt);
451         return 0;
452 }
453 EXPORT_SYMBOL(LNetMDUnlink);