Whamcloud - gitweb
LU-3030 build: Update Master Copyrights pre 2.4 split
[fs/lustre-release.git] / lnet / include / lnet / lib-lnet.h
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  * Copyright (c) 2012, 2013, Intel Corporation.
31  */
32 /*
33  * This file is part of Lustre, http://www.lustre.org/
34  * Lustre is a trademark of Sun Microsystems, Inc.
35  *
36  * lnet/include/lnet/lib-lnet.h
37  *
38  * Top level include for library side routines
39  */
40
41 #ifndef __LNET_LIB_LNET_H__
42 #define __LNET_LIB_LNET_H__
43
44 #if defined(__linux__)
45 #include <lnet/linux/lib-lnet.h>
46 #elif defined(__APPLE__)
47 #include <lnet/darwin/lib-lnet.h>
48 #elif defined(__WINNT__)
49 #include <lnet/winnt/lib-lnet.h>
50 #else
51 #error Unsupported Operating System
52 #endif
53
54 #include <libcfs/libcfs.h>
55 #include <lnet/types.h>
56 #include <lnet/lnet.h>
57 #include <lnet/lib-types.h>
58
59 extern lnet_t  the_lnet;                        /* THE network */
60
61 #if !defined(__KERNEL__) || defined(LNET_USE_LIB_FREELIST)
62 /* 1 CPT, simplify implementation... */
63 # define LNET_CPT_MAX_BITS      0
64
65 #else /* KERNEL and no freelist */
66
67 # if (BITS_PER_LONG == 32)
68 /* 2 CPTs, allowing more CPTs might make us under memory pressure */
69 #  define LNET_CPT_MAX_BITS     1
70
71 # else /* 64-bit system */
72 /*
73  * 256 CPTs for thousands of CPUs, allowing more CPTs might make us
74  * under risk of consuming all lh_cookie.
75  */
76 #  define LNET_CPT_MAX_BITS     8
77 # endif /* BITS_PER_LONG == 32 */
78 #endif
79
80 /* max allowed CPT number */
81 #define LNET_CPT_MAX            (1 << LNET_CPT_MAX_BITS)
82
83 #define LNET_CPT_NUMBER         (the_lnet.ln_cpt_number)
84 #define LNET_CPT_BITS           (the_lnet.ln_cpt_bits)
85 #define LNET_CPT_MASK           ((1ULL << LNET_CPT_BITS) - 1)
86
87 /** exclusive lock */
88 #define LNET_LOCK_EX            CFS_PERCPT_LOCK_EX
89
90 static inline int lnet_is_wire_handle_none (lnet_handle_wire_t *wh)
91 {
92         return (wh->wh_interface_cookie == LNET_WIRE_HANDLE_COOKIE_NONE &&
93                 wh->wh_object_cookie == LNET_WIRE_HANDLE_COOKIE_NONE);
94 }
95
96 static inline int lnet_md_exhausted (lnet_libmd_t *md)
97 {
98         return (md->md_threshold == 0 ||
99                 ((md->md_options & LNET_MD_MAX_SIZE) != 0 &&
100                  md->md_offset + md->md_max_size > md->md_length));
101 }
102
103 static inline int lnet_md_unlinkable (lnet_libmd_t *md)
104 {
105         /* Should unlink md when its refcount is 0 and either:
106          *  - md has been flagged for deletion (by auto unlink or LNetM[DE]Unlink,
107          *    in the latter case md may not be exhausted).
108          *  - auto unlink is on and md is exhausted.
109          */
110         if (md->md_refcount != 0)
111                 return 0;
112
113         if ((md->md_flags & LNET_MD_FLAG_ZOMBIE) != 0)
114                 return 1;
115
116         return ((md->md_flags & LNET_MD_FLAG_AUTO_UNLINK) != 0 &&
117                 lnet_md_exhausted(md));
118 }
119
120 #define lnet_cpt_table()        (the_lnet.ln_cpt_table)
121 #define lnet_cpt_current()      cfs_cpt_current(the_lnet.ln_cpt_table, 1)
122
123 static inline int
124 lnet_cpt_of_cookie(__u64 cookie)
125 {
126         unsigned int cpt = (cookie >> LNET_COOKIE_TYPE_BITS) & LNET_CPT_MASK;
127
128         /* LNET_CPT_NUMBER doesn't have to be power2, which means we can
129          * get illegal cpt from it's invalid cookie */
130         return cpt < LNET_CPT_NUMBER ? cpt : cpt % LNET_CPT_NUMBER;
131 }
132
133 static inline void
134 lnet_res_lock(int cpt)
135 {
136         cfs_percpt_lock(the_lnet.ln_res_lock, cpt);
137 }
138
139 static inline void
140 lnet_res_unlock(int cpt)
141 {
142         cfs_percpt_unlock(the_lnet.ln_res_lock, cpt);
143 }
144
145 static inline int
146 lnet_res_lock_current(void)
147 {
148         int cpt = lnet_cpt_current();
149
150         lnet_res_lock(cpt);
151         return cpt;
152 }
153
154 static inline void
155 lnet_net_lock(int cpt)
156 {
157         cfs_percpt_lock(the_lnet.ln_net_lock, cpt);
158 }
159
160 static inline void
161 lnet_net_unlock(int cpt)
162 {
163         cfs_percpt_unlock(the_lnet.ln_net_lock, cpt);
164 }
165
166 static inline int
167 lnet_net_lock_current(void)
168 {
169         int cpt = lnet_cpt_current();
170
171         lnet_net_lock(cpt);
172         return cpt;
173 }
174
175 #define LNET_LOCK()             lnet_net_lock(LNET_LOCK_EX)
176 #define LNET_UNLOCK()           lnet_net_unlock(LNET_LOCK_EX)
177
178 #ifdef __KERNEL__
179
180 #define lnet_ptl_lock(ptl)      spin_lock(&(ptl)->ptl_lock)
181 #define lnet_ptl_unlock(ptl)    spin_unlock(&(ptl)->ptl_lock)
182 #define lnet_eq_wait_lock()     spin_lock(&the_lnet.ln_eq_wait_lock)
183 #define lnet_eq_wait_unlock()   spin_unlock(&the_lnet.ln_eq_wait_lock)
184 #define lnet_ni_lock(ni)        spin_lock(&(ni)->ni_lock)
185 #define lnet_ni_unlock(ni)      spin_unlock(&(ni)->ni_lock)
186 #define LNET_MUTEX_LOCK(m)      mutex_lock(m)
187 #define LNET_MUTEX_UNLOCK(m)    mutex_unlock(m)
188
189 #else /* !__KERNEL__ */
190
191 # ifndef HAVE_LIBPTHREAD
192 #define LNET_SINGLE_THREADED_LOCK(l)            \
193 do {                                            \
194         LASSERT ((l) == 0);                     \
195         (l) = 1;                                \
196 } while (0)
197
198 #define LNET_SINGLE_THREADED_UNLOCK(l)          \
199 do {                                            \
200         LASSERT ((l) == 1);                     \
201         (l) = 0;                                \
202 } while (0)
203
204 #define LNET_MUTEX_LOCK(m)      LNET_SINGLE_THREADED_LOCK(*(m))
205 #define LNET_MUTEX_UNLOCK(m)    LNET_SINGLE_THREADED_UNLOCK(*(m))
206
207 #define lnet_ptl_lock(ptl)                      \
208         LNET_SINGLE_THREADED_LOCK((ptl)->ptl_lock)
209 #define lnet_ptl_unlock(ptl)                    \
210         LNET_SINGLE_THREADED_UNLOCK((ptl)->ptl_lock)
211
212 #define lnet_eq_wait_lock()                     \
213         LNET_SINGLE_THREADED_LOCK(the_lnet.ln_eq_wait_lock)
214 #define lnet_eq_wait_unlock()                   \
215         LNET_SINGLE_THREADED_UNLOCK(the_lnet.ln_eq_wait_lock)
216
217 #define lnet_ni_lock(ni)                        \
218         LNET_SINGLE_THREADED_LOCK((ni)->ni_lock)
219 #define lnet_ni_unlock(ni)                      \
220         LNET_SINGLE_THREADED_UNLOCK((ni)->ni_lock)
221
222 # else /* HAVE_LIBPTHREAD */
223
224 #define LNET_MUTEX_LOCK(m)      pthread_mutex_lock(m)
225 #define LNET_MUTEX_UNLOCK(m)    pthread_mutex_unlock(m)
226
227 #define lnet_ptl_lock(ptl)      pthread_mutex_lock(&(ptl)->ptl_lock)
228 #define lnet_ptl_unlock(ptl)    pthread_mutex_unlock(&(ptl)->ptl_lock)
229
230 #define lnet_eq_wait_lock()     pthread_mutex_lock(&the_lnet.ln_eq_wait_lock)
231 #define lnet_eq_wait_unlock()   pthread_mutex_unlock(&the_lnet.ln_eq_wait_lock)
232
233 #define lnet_ni_lock(ni)        pthread_mutex_lock(&(ni)->ni_lock)
234 #define lnet_ni_unlock(ni)      pthread_mutex_unlock(&(ni)->ni_lock)
235
236 # endif /* HAVE_LIBPTHREAD */
237 #endif /* __KERNEL__ */
238
239 #define MAX_PORTALS     64
240
241 /* these are only used by code with LNET_USE_LIB_FREELIST, but we still
242  * exported them to !LNET_USE_LIB_FREELIST for easy implemetation */
243 #define LNET_FL_MAX_MES         2048
244 #define LNET_FL_MAX_MDS         2048
245 #define LNET_FL_MAX_EQS         512
246 #define LNET_FL_MAX_MSGS        2048    /* Outstanding messages */
247
248 #ifdef LNET_USE_LIB_FREELIST
249
250 int lnet_freelist_init(lnet_freelist_t *fl, int n, int size);
251 void lnet_freelist_fini(lnet_freelist_t *fl);
252
253 static inline void *
254 lnet_freelist_alloc (lnet_freelist_t *fl)
255 {
256         /* ALWAYS called with liblock held */
257         lnet_freeobj_t *o;
258
259         if (cfs_list_empty (&fl->fl_list))
260                 return (NULL);
261
262         o = cfs_list_entry (fl->fl_list.next, lnet_freeobj_t, fo_list);
263         cfs_list_del (&o->fo_list);
264         return ((void *)&o->fo_contents);
265 }
266
267 static inline void
268 lnet_freelist_free (lnet_freelist_t *fl, void *obj)
269 {
270         /* ALWAYS called with liblock held */
271         lnet_freeobj_t *o = cfs_list_entry (obj, lnet_freeobj_t, fo_contents);
272
273         cfs_list_add (&o->fo_list, &fl->fl_list);
274 }
275
276
277 static inline lnet_eq_t *
278 lnet_eq_alloc (void)
279 {
280         /* NEVER called with resource lock held */
281         struct lnet_res_container *rec = &the_lnet.ln_eq_container;
282         lnet_eq_t                 *eq;
283
284         LASSERT(LNET_CPT_NUMBER == 1);
285
286         lnet_res_lock(0);
287         eq = (lnet_eq_t *)lnet_freelist_alloc(&rec->rec_freelist);
288         lnet_res_unlock(0);
289
290         return eq;
291 }
292
293 static inline void
294 lnet_eq_free_locked(lnet_eq_t *eq)
295 {
296         /* ALWAYS called with resource lock held */
297         struct lnet_res_container *rec = &the_lnet.ln_eq_container;
298
299         LASSERT(LNET_CPT_NUMBER == 1);
300         lnet_freelist_free(&rec->rec_freelist, eq);
301 }
302
303 static inline void
304 lnet_eq_free(lnet_eq_t *eq)
305 {
306         lnet_res_lock(0);
307         lnet_eq_free_locked(eq);
308         lnet_res_unlock(0);
309 }
310
311 static inline lnet_libmd_t *
312 lnet_md_alloc (lnet_md_t *umd)
313 {
314         /* NEVER called with resource lock held */
315         struct lnet_res_container *rec = the_lnet.ln_md_containers[0];
316         lnet_libmd_t              *md;
317
318         LASSERT(LNET_CPT_NUMBER == 1);
319
320         lnet_res_lock(0);
321         md = (lnet_libmd_t *)lnet_freelist_alloc(&rec->rec_freelist);
322         lnet_res_unlock(0);
323
324         if (md != NULL)
325                 CFS_INIT_LIST_HEAD(&md->md_list);
326
327         return md;
328 }
329
330 static inline void
331 lnet_md_free_locked(lnet_libmd_t *md)
332 {
333         /* ALWAYS called with resource lock held */
334         struct lnet_res_container *rec = the_lnet.ln_md_containers[0];
335
336         LASSERT(LNET_CPT_NUMBER == 1);
337         lnet_freelist_free(&rec->rec_freelist, md);
338 }
339
340 static inline void
341 lnet_md_free(lnet_libmd_t *md)
342 {
343         lnet_res_lock(0);
344         lnet_md_free_locked(md);
345         lnet_res_unlock(0);
346 }
347
348 static inline lnet_me_t *
349 lnet_me_alloc(void)
350 {
351         /* NEVER called with resource lock held */
352         struct lnet_res_container *rec = the_lnet.ln_me_containers[0];
353         lnet_me_t                 *me;
354
355         LASSERT(LNET_CPT_NUMBER == 1);
356
357         lnet_res_lock(0);
358         me = (lnet_me_t *)lnet_freelist_alloc(&rec->rec_freelist);
359         lnet_res_unlock(0);
360
361         return me;
362 }
363
364 static inline void
365 lnet_me_free_locked(lnet_me_t *me)
366 {
367         /* ALWAYS called with resource lock held */
368         struct lnet_res_container *rec = the_lnet.ln_me_containers[0];
369
370         LASSERT(LNET_CPT_NUMBER == 1);
371         lnet_freelist_free(&rec->rec_freelist, me);
372 }
373
374 static inline void
375 lnet_me_free(lnet_me_t *me)
376 {
377         lnet_res_lock(0);
378         lnet_me_free_locked(me);
379         lnet_res_unlock(0);
380 }
381
382 static inline lnet_msg_t *
383 lnet_msg_alloc (void)
384 {
385         /* NEVER called with network lock held */
386         struct lnet_msg_container *msc = the_lnet.ln_msg_containers[0];
387         lnet_msg_t                *msg;
388
389         LASSERT(LNET_CPT_NUMBER == 1);
390
391         lnet_net_lock(0);
392         msg = (lnet_msg_t *)lnet_freelist_alloc(&msc->msc_freelist);
393         lnet_net_unlock(0);
394
395         if (msg != NULL) {
396                 /* NULL pointers, clear flags etc */
397                 memset(msg, 0, sizeof(*msg));
398         }
399         return msg;
400 }
401
402 static inline void
403 lnet_msg_free_locked(lnet_msg_t *msg)
404 {
405         /* ALWAYS called with network lock held */
406         struct lnet_msg_container *msc = the_lnet.ln_msg_containers[0];
407
408         LASSERT(LNET_CPT_NUMBER == 1);
409         LASSERT(!msg->msg_onactivelist);
410         lnet_freelist_free(&msc->msc_freelist, msg);
411 }
412
413 static inline void
414 lnet_msg_free (lnet_msg_t *msg)
415 {
416         lnet_net_lock(0);
417         lnet_msg_free_locked(msg);
418         lnet_net_unlock(0);
419 }
420
421 #else /* !LNET_USE_LIB_FREELIST */
422
423 static inline lnet_eq_t *
424 lnet_eq_alloc (void)
425 {
426         /* NEVER called with liblock held */
427         lnet_eq_t *eq;
428
429         LIBCFS_ALLOC(eq, sizeof(*eq));
430         return (eq);
431 }
432
433 static inline void
434 lnet_eq_free(lnet_eq_t *eq)
435 {
436         /* ALWAYS called with resource lock held */
437         LIBCFS_FREE(eq, sizeof(*eq));
438 }
439
440 static inline lnet_libmd_t *
441 lnet_md_alloc (lnet_md_t *umd)
442 {
443         /* NEVER called with liblock held */
444         lnet_libmd_t *md;
445         unsigned int  size;
446         unsigned int  niov;
447
448         if ((umd->options & LNET_MD_KIOV) != 0) {
449                 niov = umd->length;
450                 size = offsetof(lnet_libmd_t, md_iov.kiov[niov]);
451         } else {
452                 niov = ((umd->options & LNET_MD_IOVEC) != 0) ?
453                        umd->length : 1;
454                 size = offsetof(lnet_libmd_t, md_iov.iov[niov]);
455         }
456
457         LIBCFS_ALLOC(md, size);
458
459         if (md != NULL) {
460                 /* Set here in case of early free */
461                 md->md_options = umd->options;
462                 md->md_niov = niov;
463                 CFS_INIT_LIST_HEAD(&md->md_list);
464         }
465
466         return (md);
467 }
468
469 static inline void
470 lnet_md_free(lnet_libmd_t *md)
471 {
472         /* ALWAYS called with resource lock held */
473         unsigned int  size;
474
475         if ((md->md_options & LNET_MD_KIOV) != 0)
476                 size = offsetof(lnet_libmd_t, md_iov.kiov[md->md_niov]);
477         else
478                 size = offsetof(lnet_libmd_t, md_iov.iov[md->md_niov]);
479
480         LIBCFS_FREE(md, size);
481 }
482
483 static inline lnet_me_t *
484 lnet_me_alloc (void)
485 {
486         /* NEVER called with liblock held */
487         lnet_me_t *me;
488
489         LIBCFS_ALLOC(me, sizeof(*me));
490         return (me);
491 }
492
493 static inline void
494 lnet_me_free(lnet_me_t *me)
495 {
496         /* ALWAYS called with resource lock held */
497         LIBCFS_FREE(me, sizeof(*me));
498 }
499
500 static inline lnet_msg_t *
501 lnet_msg_alloc(void)
502 {
503         /* NEVER called with liblock held */
504         lnet_msg_t *msg;
505
506         LIBCFS_ALLOC(msg, sizeof(*msg));
507
508         /* no need to zero, LIBCFS_ALLOC does for us */
509         return (msg);
510 }
511
512 static inline void
513 lnet_msg_free(lnet_msg_t *msg)
514 {
515         /* ALWAYS called with network lock held */
516         LASSERT(!msg->msg_onactivelist);
517         LIBCFS_FREE(msg, sizeof(*msg));
518 }
519
520 #define lnet_eq_free_locked(eq)         lnet_eq_free(eq)
521 #define lnet_md_free_locked(md)         lnet_md_free(md)
522 #define lnet_me_free_locked(me)         lnet_me_free(me)
523 #define lnet_msg_free_locked(msg)       lnet_msg_free(msg)
524
525 #endif /* LNET_USE_LIB_FREELIST */
526
527 lnet_libhandle_t *lnet_res_lh_lookup(struct lnet_res_container *rec,
528                                      __u64 cookie);
529 void lnet_res_lh_initialize(struct lnet_res_container *rec,
530                             lnet_libhandle_t *lh);
531 static inline void
532 lnet_res_lh_invalidate(lnet_libhandle_t *lh)
533 {
534         /* ALWAYS called with resource lock held */
535         /* NB: cookie is still useful, don't reset it */
536         cfs_list_del(&lh->lh_hash_chain);
537 }
538
539 static inline void
540 lnet_eq2handle (lnet_handle_eq_t *handle, lnet_eq_t *eq)
541 {
542         if (eq == NULL) {
543                 LNetInvalidateHandle(handle);
544                 return;
545         }
546
547         handle->cookie = eq->eq_lh.lh_cookie;
548 }
549
550 static inline lnet_eq_t *
551 lnet_handle2eq(lnet_handle_eq_t *handle)
552 {
553         /* ALWAYS called with resource lock held */
554         lnet_libhandle_t *lh;
555
556         lh = lnet_res_lh_lookup(&the_lnet.ln_eq_container, handle->cookie);
557         if (lh == NULL)
558                 return NULL;
559
560         return lh_entry(lh, lnet_eq_t, eq_lh);
561 }
562
563 static inline void
564 lnet_md2handle (lnet_handle_md_t *handle, lnet_libmd_t *md)
565 {
566         handle->cookie = md->md_lh.lh_cookie;
567 }
568
569 static inline lnet_libmd_t *
570 lnet_handle2md(lnet_handle_md_t *handle)
571 {
572         /* ALWAYS called with resource lock held */
573         lnet_libhandle_t *lh;
574         int              cpt;
575
576         cpt = lnet_cpt_of_cookie(handle->cookie);
577         lh = lnet_res_lh_lookup(the_lnet.ln_md_containers[cpt],
578                                 handle->cookie);
579         if (lh == NULL)
580                 return NULL;
581
582         return lh_entry(lh, lnet_libmd_t, md_lh);
583 }
584
585 static inline lnet_libmd_t *
586 lnet_wire_handle2md(lnet_handle_wire_t *wh)
587 {
588         /* ALWAYS called with resource lock held */
589         lnet_libhandle_t *lh;
590         int              cpt;
591
592         if (wh->wh_interface_cookie != the_lnet.ln_interface_cookie)
593                 return NULL;
594
595         cpt = lnet_cpt_of_cookie(wh->wh_object_cookie);
596         lh = lnet_res_lh_lookup(the_lnet.ln_md_containers[cpt],
597                                 wh->wh_object_cookie);
598         if (lh == NULL)
599                 return NULL;
600
601         return lh_entry(lh, lnet_libmd_t, md_lh);
602 }
603
604 static inline void
605 lnet_me2handle (lnet_handle_me_t *handle, lnet_me_t *me)
606 {
607         handle->cookie = me->me_lh.lh_cookie;
608 }
609
610 static inline lnet_me_t *
611 lnet_handle2me(lnet_handle_me_t *handle)
612 {
613         /* ALWAYS called with resource lock held */
614         lnet_libhandle_t *lh;
615         int              cpt;
616
617         cpt = lnet_cpt_of_cookie(handle->cookie);
618         lh = lnet_res_lh_lookup(the_lnet.ln_me_containers[cpt],
619                                 handle->cookie);
620         if (lh == NULL)
621                 return NULL;
622
623         return lh_entry(lh, lnet_me_t, me_lh);
624 }
625
626 static inline void
627 lnet_peer_addref_locked(lnet_peer_t *lp)
628 {
629         LASSERT (lp->lp_refcount > 0);
630         lp->lp_refcount++;
631 }
632
633 extern void lnet_destroy_peer_locked(lnet_peer_t *lp);
634
635 static inline void
636 lnet_peer_decref_locked(lnet_peer_t *lp)
637 {
638         LASSERT (lp->lp_refcount > 0);
639         lp->lp_refcount--;
640         if (lp->lp_refcount == 0)
641                 lnet_destroy_peer_locked(lp);
642 }
643
644 static inline int
645 lnet_isrouter(lnet_peer_t *lp)
646 {
647         return lp->lp_rtr_refcount != 0;
648 }
649
650 static inline void
651 lnet_ni_addref_locked(lnet_ni_t *ni, int cpt)
652 {
653         LASSERT(cpt >= 0 && cpt < LNET_CPT_NUMBER);
654         LASSERT(*ni->ni_refs[cpt] >= 0);
655
656         (*ni->ni_refs[cpt])++;
657 }
658
659 static inline void
660 lnet_ni_addref(lnet_ni_t *ni)
661 {
662         lnet_net_lock(0);
663         lnet_ni_addref_locked(ni, 0);
664         lnet_net_unlock(0);
665 }
666
667 static inline void
668 lnet_ni_decref_locked(lnet_ni_t *ni, int cpt)
669 {
670         LASSERT(cpt >= 0 && cpt < LNET_CPT_NUMBER);
671         LASSERT(*ni->ni_refs[cpt] > 0);
672
673         (*ni->ni_refs[cpt])--;
674 }
675
676 static inline void
677 lnet_ni_decref(lnet_ni_t *ni)
678 {
679         lnet_net_lock(0);
680         lnet_ni_decref_locked(ni, 0);
681         lnet_net_unlock(0);
682 }
683
684 void lnet_ni_free(lnet_ni_t *ni);
685
686 static inline int
687 lnet_nid2peerhash(lnet_nid_t nid)
688 {
689         return cfs_hash_long(nid, LNET_PEER_HASH_BITS);
690 }
691
692 static inline cfs_list_t *
693 lnet_net2rnethash(__u32 net)
694 {
695         return &the_lnet.ln_remote_nets_hash[(LNET_NETNUM(net) +
696                 LNET_NETTYP(net)) &
697                 ((1U << the_lnet.ln_remote_nets_hbits) - 1)];
698 }
699
700 extern lnd_t the_lolnd;
701
702 #ifndef __KERNEL__
703 /* unconditional registration */
704 #define LNET_REGISTER_ULND(lnd)                 \
705 do {                                            \
706         extern lnd_t lnd;                       \
707                                                 \
708         lnet_register_lnd(&(lnd));              \
709 } while (0)
710
711 /* conditional registration */
712 #define LNET_REGISTER_ULND_IF_PRESENT(lnd)                              \
713 do {                                                                    \
714         extern lnd_t lnd __attribute__ ((weak, alias("the_lolnd")));    \
715                                                                         \
716         if (&(lnd) != &the_lolnd)                                       \
717                 lnet_register_lnd(&(lnd));                              \
718 } while (0)
719 #endif
720
721 extern int lnet_cpt_of_nid_locked(lnet_nid_t nid);
722 extern int lnet_cpt_of_nid(lnet_nid_t nid);
723 extern lnet_ni_t *lnet_nid2ni_locked(lnet_nid_t nid, int cpt);
724 extern lnet_ni_t *lnet_net2ni_locked(__u32 net, int cpt);
725 extern lnet_ni_t *lnet_net2ni(__u32 net);
726
727 int lnet_notify(lnet_ni_t *ni, lnet_nid_t peer, int alive, cfs_time_t when);
728 void lnet_notify_locked(lnet_peer_t *lp, int notifylnd, int alive, cfs_time_t when);
729 int lnet_add_route(__u32 net, unsigned int hops, lnet_nid_t gateway_nid);
730 int lnet_check_routes(void);
731 int lnet_del_route(__u32 net, lnet_nid_t gw_nid);
732 void lnet_destroy_routes(void);
733 int lnet_get_route(int idx, __u32 *net, __u32 *hops,
734                    lnet_nid_t *gateway, __u32 *alive);
735 void lnet_proc_init(void);
736 void lnet_proc_fini(void);
737 int  lnet_rtrpools_alloc(int im_a_router);
738 void lnet_rtrpools_free(void);
739 lnet_remotenet_t *lnet_find_net_locked (__u32 net);
740
741 int lnet_islocalnid(lnet_nid_t nid);
742 int lnet_islocalnet(__u32 net);
743
744 void lnet_msg_attach_md(lnet_msg_t *msg, lnet_libmd_t *md,
745                         unsigned int offset, unsigned int mlen);
746 void lnet_msg_detach_md(lnet_msg_t *msg, int status);
747 void lnet_build_unlink_event(lnet_libmd_t *md, lnet_event_t *ev);
748 void lnet_build_msg_event(lnet_msg_t *msg, lnet_event_kind_t ev_type);
749 void lnet_msg_commit(lnet_msg_t *msg, int cpt);
750 void lnet_msg_decommit(lnet_msg_t *msg, int cpt, int status);
751
752 void lnet_eq_enqueue_event(lnet_eq_t *eq, lnet_event_t *ev);
753 void lnet_prep_send(lnet_msg_t *msg, int type, lnet_process_id_t target,
754                     unsigned int offset, unsigned int len);
755 int lnet_send(lnet_nid_t nid, lnet_msg_t *msg, lnet_nid_t rtr_nid);
756 void lnet_return_tx_credits_locked(lnet_msg_t *msg);
757 void lnet_return_rx_credits_locked(lnet_msg_t *msg);
758
759 /* portals functions */
760 /* portals attributes */
761 static inline int
762 lnet_ptl_is_lazy(lnet_portal_t *ptl)
763 {
764         return !!(ptl->ptl_options & LNET_PTL_LAZY);
765 }
766
767 static inline int
768 lnet_ptl_is_unique(lnet_portal_t *ptl)
769 {
770         return !!(ptl->ptl_options & LNET_PTL_MATCH_UNIQUE);
771 }
772
773 static inline int
774 lnet_ptl_is_wildcard(lnet_portal_t *ptl)
775 {
776         return !!(ptl->ptl_options & LNET_PTL_MATCH_WILDCARD);
777 }
778
779 static inline void
780 lnet_ptl_setopt(lnet_portal_t *ptl, int opt)
781 {
782         ptl->ptl_options |= opt;
783 }
784
785 static inline void
786 lnet_ptl_unsetopt(lnet_portal_t *ptl, int opt)
787 {
788         ptl->ptl_options &= ~opt;
789 }
790
791 /* match-table functions */
792 cfs_list_t *lnet_mt_match_head(struct lnet_match_table *mtable,
793                                lnet_process_id_t id, __u64 mbits);
794 struct lnet_match_table *lnet_mt_of_attach(unsigned int index,
795                                            lnet_process_id_t id, __u64 mbits,
796                                            __u64 ignore_bits,
797                                            lnet_ins_pos_t pos);
798 int lnet_mt_match_md(struct lnet_match_table *mtable,
799                      struct lnet_match_info *info, struct lnet_msg *msg);
800
801 /* portals match/attach functions */
802 void lnet_ptl_attach_md(lnet_me_t *me, lnet_libmd_t *md,
803                         cfs_list_t *matches, cfs_list_t *drops);
804 void lnet_ptl_detach_md(lnet_me_t *me, lnet_libmd_t *md);
805 int lnet_ptl_match_md(struct lnet_match_info *info, struct lnet_msg *msg);
806
807 /* initialized and finalize portals */
808 int lnet_portals_create(void);
809 void lnet_portals_destroy(void);
810
811 /* message functions */
812 int lnet_parse (lnet_ni_t *ni, lnet_hdr_t *hdr,
813                 lnet_nid_t fromnid, void *private, int rdma_req);
814 void lnet_recv(lnet_ni_t *ni, void *private, lnet_msg_t *msg, int delayed,
815                unsigned int offset, unsigned int mlen, unsigned int rlen);
816 lnet_msg_t *lnet_create_reply_msg (lnet_ni_t *ni, lnet_msg_t *get_msg);
817 void lnet_set_reply_msg_len(lnet_ni_t *ni, lnet_msg_t *msg, unsigned int len);
818 void lnet_finalize(lnet_ni_t *ni, lnet_msg_t *msg, int rc);
819 void lnet_drop_delayed_msg_list(cfs_list_t *head, char *reason);
820 void lnet_recv_delayed_msg_list(cfs_list_t *head);
821
822 int lnet_msg_container_setup(struct lnet_msg_container *container, int cpt);
823 void lnet_msg_container_cleanup(struct lnet_msg_container *container);
824 void lnet_msg_containers_destroy(void);
825 int lnet_msg_containers_create(void);
826
827 char *lnet_msgtyp2str (int type);
828 void lnet_print_hdr (lnet_hdr_t * hdr);
829 int lnet_fail_nid(lnet_nid_t nid, unsigned int threshold);
830
831 void lnet_counters_get(lnet_counters_t *counters);
832 void lnet_counters_reset(void);
833
834 unsigned int lnet_iov_nob (unsigned int niov, struct iovec *iov);
835 int lnet_extract_iov (int dst_niov, struct iovec *dst,
836                       int src_niov, struct iovec *src,
837                       unsigned int offset, unsigned int len);
838
839 unsigned int lnet_kiov_nob (unsigned int niov, lnet_kiov_t *iov);
840 int lnet_extract_kiov (int dst_niov, lnet_kiov_t *dst,
841                       int src_niov, lnet_kiov_t *src,
842                       unsigned int offset, unsigned int len);
843
844 void lnet_copy_iov2iov (unsigned int ndiov, struct iovec *diov,
845                         unsigned int doffset,
846                         unsigned int nsiov, struct iovec *siov,
847                         unsigned int soffset, unsigned int nob);
848 void lnet_copy_kiov2iov (unsigned int niov, struct iovec *iov,
849                          unsigned int iovoffset,
850                          unsigned int nkiov, lnet_kiov_t *kiov,
851                          unsigned int kiovoffset, unsigned int nob);
852 void lnet_copy_iov2kiov (unsigned int nkiov, lnet_kiov_t *kiov,
853                          unsigned int kiovoffset,
854                          unsigned int niov, struct iovec *iov,
855                          unsigned int iovoffset, unsigned int nob);
856 void lnet_copy_kiov2kiov (unsigned int ndkiov, lnet_kiov_t *dkiov,
857                           unsigned int doffset,
858                           unsigned int nskiov, lnet_kiov_t *skiov,
859                           unsigned int soffset, unsigned int nob);
860
861 static inline void
862 lnet_copy_iov2flat(int dlen, void *dest, unsigned int doffset,
863                    unsigned int nsiov, struct iovec *siov, unsigned int soffset,
864                    unsigned int nob)
865 {
866         struct iovec diov = {/*.iov_base = */ dest, /*.iov_len = */ dlen};
867
868         lnet_copy_iov2iov(1, &diov, doffset,
869                           nsiov, siov, soffset, nob);
870 }
871
872 static inline void
873 lnet_copy_kiov2flat(int dlen, void *dest, unsigned int doffset,
874                     unsigned int nsiov, lnet_kiov_t *skiov, unsigned int soffset,
875                     unsigned int nob)
876 {
877         struct iovec diov = {/* .iov_base = */ dest, /* .iov_len = */ dlen};
878
879         lnet_copy_kiov2iov(1, &diov, doffset,
880                            nsiov, skiov, soffset, nob);
881 }
882
883 static inline void
884 lnet_copy_flat2iov(unsigned int ndiov, struct iovec *diov, unsigned int doffset,
885                    int slen, void *src, unsigned int soffset, unsigned int nob)
886 {
887         struct iovec siov = {/*.iov_base = */ src, /*.iov_len = */slen};
888         lnet_copy_iov2iov(ndiov, diov, doffset,
889                           1, &siov, soffset, nob);
890 }
891
892 static inline void
893 lnet_copy_flat2kiov(unsigned int ndiov, lnet_kiov_t *dkiov, unsigned int doffset,
894                     int slen, void *src, unsigned int soffset, unsigned int nob)
895 {
896         struct iovec siov = {/* .iov_base = */ src, /* .iov_len = */ slen};
897         lnet_copy_iov2kiov(ndiov, dkiov, doffset,
898                            1, &siov, soffset, nob);
899 }
900
901 void lnet_me_unlink(lnet_me_t *me);
902
903 void lnet_md_unlink(lnet_libmd_t *md);
904 void lnet_md_deconstruct(lnet_libmd_t *lmd, lnet_md_t *umd);
905
906 void lnet_register_lnd(lnd_t *lnd);
907 void lnet_unregister_lnd(lnd_t *lnd);
908 int lnet_set_ip_niaddr (lnet_ni_t *ni);
909
910 #ifdef __KERNEL__
911 int lnet_connect(cfs_socket_t **sockp, lnet_nid_t peer_nid,
912                  __u32 local_ip, __u32 peer_ip, int peer_port);
913 void lnet_connect_console_error(int rc, lnet_nid_t peer_nid,
914                                 __u32 peer_ip, int port);
915 int lnet_count_acceptor_nis(void);
916 int lnet_acceptor_timeout(void);
917 int lnet_acceptor_port(void);
918 #else
919 void lnet_router_checker(void);
920 #endif
921
922 #ifdef HAVE_LIBPTHREAD
923 int lnet_count_acceptor_nis(void);
924 int lnet_acceptor_port(void);
925 #endif
926
927 int lnet_acceptor_start(void);
928 void lnet_acceptor_stop(void);
929
930 void lnet_get_tunables(void);
931 int lnet_peers_start_down(void);
932 int lnet_peer_buffer_credits(lnet_ni_t *ni);
933
934 int lnet_router_checker_start(void);
935 void lnet_router_checker_stop(void);
936 void lnet_swap_pinginfo(lnet_ping_info_t *info);
937
938 int lnet_ping_target_init(void);
939 void lnet_ping_target_fini(void);
940 int lnet_ping(lnet_process_id_t id, int timeout_ms,
941               lnet_process_id_t *ids, int n_ids);
942
943 int lnet_parse_ip2nets (char **networksp, char *ip2nets);
944 int lnet_parse_routes (char *route_str, int *im_a_router);
945 int lnet_parse_networks (cfs_list_t *nilist, char *networks);
946
947 int lnet_nid2peer_locked(lnet_peer_t **lpp, lnet_nid_t nid, int cpt);
948 lnet_peer_t *lnet_find_peer_locked(struct lnet_peer_table *ptable,
949                                    lnet_nid_t nid);
950 void lnet_peer_tables_cleanup(void);
951 void lnet_peer_tables_destroy(void);
952 int lnet_peer_tables_create(void);
953 void lnet_debug_peer(lnet_nid_t nid);
954
955 #ifndef __KERNEL__
956 static inline int
957 lnet_parse_int_tunable(int *value, char *name)
958 {
959         char    *env = getenv(name);
960         char    *end;
961
962         if (env == NULL)
963                 return 0;
964
965         *value = strtoull(env, &end, 0);
966         if (*end == 0)
967                 return 0;
968
969         CERROR("Can't parse tunable %s=%s\n", name, env);
970         return -EINVAL;
971 }
972 #endif
973
974 #endif