Whamcloud - gitweb
LU-9480 lnet: reference counts on lnet_peer/lnet_peer_net
[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.gnu.org/licenses/gpl-2.0.html
19  *
20  * GPL HEADER END
21  */
22 /*
23  * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
24  * Use is subject to license terms.
25  *
26  * Copyright (c) 2012, 2016, Intel Corporation.
27  */
28 /*
29  * This file is part of Lustre, http://www.lustre.org/
30  * Lustre is a trademark of Sun Microsystems, Inc.
31  *
32  * lnet/include/lnet/lib-lnet.h
33  *
34  * Top level include for library side routines
35  */
36
37 #ifndef __LNET_LIB_LNET_H__
38 #define __LNET_LIB_LNET_H__
39
40 #ifndef __KERNEL__
41 # error This include is only for kernel use.
42 #endif
43
44 #include <libcfs/libcfs.h>
45 #include <lnet/api.h>
46 #include <lnet/lib-types.h>
47 #include <uapi/linux/lnet/lnet-dlc.h>
48 #include <uapi/linux/lnet/lnet-types.h>
49 #include <uapi/linux/lnet/lnetctl.h>
50 #include <uapi/linux/lnet/nidstr.h>
51
52 extern struct lnet the_lnet;                    /* THE network */
53
54 #if (BITS_PER_LONG == 32)
55 /* 2 CPTs, allowing more CPTs might make us under memory pressure */
56 # define LNET_CPT_MAX_BITS     1
57
58 #else /* 64-bit system */
59 /*
60  * 256 CPTs for thousands of CPUs, allowing more CPTs might make us
61  * under risk of consuming all lh_cookie.
62  */
63 # define LNET_CPT_MAX_BITS     8
64 #endif /* BITS_PER_LONG == 32 */
65
66 /* max allowed CPT number */
67 #define LNET_CPT_MAX            (1 << LNET_CPT_MAX_BITS)
68
69 #define LNET_CPT_NUMBER         (the_lnet.ln_cpt_number)
70 #define LNET_CPT_BITS           (the_lnet.ln_cpt_bits)
71 #define LNET_CPT_MASK           ((1ULL << LNET_CPT_BITS) - 1)
72
73 /** exclusive lock */
74 #define LNET_LOCK_EX            CFS_PERCPT_LOCK_EX
75
76 static inline int lnet_is_route_alive(struct lnet_route *route)
77 {
78         if (!route->lr_gateway->lpni_alive)
79                 return 0; /* gateway is down */
80         if ((route->lr_gateway->lpni_ping_feats &
81              LNET_PING_FEAT_NI_STATUS) == 0)
82                 return 1; /* no NI status, assume it's alive */
83         /* has NI status, check # down NIs */
84         return route->lr_downis == 0;
85 }
86
87 static inline int lnet_is_wire_handle_none(struct lnet_handle_wire *wh)
88 {
89         return (wh->wh_interface_cookie == LNET_WIRE_HANDLE_COOKIE_NONE &&
90                 wh->wh_object_cookie == LNET_WIRE_HANDLE_COOKIE_NONE);
91 }
92
93 static inline int lnet_md_exhausted(struct lnet_libmd *md)
94 {
95         return (md->md_threshold == 0 ||
96                 ((md->md_options & LNET_MD_MAX_SIZE) != 0 &&
97                  md->md_offset + md->md_max_size > md->md_length));
98 }
99
100 static inline int lnet_md_unlinkable(struct lnet_libmd *md)
101 {
102         /* Should unlink md when its refcount is 0 and either:
103          *  - md has been flagged for deletion (by auto unlink or LNetM[DE]Unlink,
104          *    in the latter case md may not be exhausted).
105          *  - auto unlink is on and md is exhausted.
106          */
107         if (md->md_refcount != 0)
108                 return 0;
109
110         if ((md->md_flags & LNET_MD_FLAG_ZOMBIE) != 0)
111                 return 1;
112
113         return ((md->md_flags & LNET_MD_FLAG_AUTO_UNLINK) != 0 &&
114                 lnet_md_exhausted(md));
115 }
116
117 #define lnet_cpt_table()        (the_lnet.ln_cpt_table)
118 #define lnet_cpt_current()      cfs_cpt_current(the_lnet.ln_cpt_table, 1)
119
120 static inline int
121 lnet_cpt_of_cookie(__u64 cookie)
122 {
123         unsigned int cpt = (cookie >> LNET_COOKIE_TYPE_BITS) & LNET_CPT_MASK;
124
125         /* LNET_CPT_NUMBER doesn't have to be power2, which means we can
126          * get illegal cpt from it's invalid cookie */
127         return cpt < LNET_CPT_NUMBER ? cpt : cpt % LNET_CPT_NUMBER;
128 }
129
130 static inline void
131 lnet_res_lock(int cpt)
132 {
133         cfs_percpt_lock(the_lnet.ln_res_lock, cpt);
134 }
135
136 static inline void
137 lnet_res_unlock(int cpt)
138 {
139         cfs_percpt_unlock(the_lnet.ln_res_lock, cpt);
140 }
141
142 static inline int
143 lnet_res_lock_current(void)
144 {
145         int cpt = lnet_cpt_current();
146
147         lnet_res_lock(cpt);
148         return cpt;
149 }
150
151 static inline void
152 lnet_net_lock(int cpt)
153 {
154         cfs_percpt_lock(the_lnet.ln_net_lock, cpt);
155 }
156
157 static inline void
158 lnet_net_unlock(int cpt)
159 {
160         cfs_percpt_unlock(the_lnet.ln_net_lock, cpt);
161 }
162
163 static inline int
164 lnet_net_lock_current(void)
165 {
166         int cpt = lnet_cpt_current();
167
168         lnet_net_lock(cpt);
169         return cpt;
170 }
171
172 #define LNET_LOCK()             lnet_net_lock(LNET_LOCK_EX)
173 #define LNET_UNLOCK()           lnet_net_unlock(LNET_LOCK_EX)
174
175 #define lnet_ptl_lock(ptl)      spin_lock(&(ptl)->ptl_lock)
176 #define lnet_ptl_unlock(ptl)    spin_unlock(&(ptl)->ptl_lock)
177 #define lnet_eq_wait_lock()     spin_lock(&the_lnet.ln_eq_wait_lock)
178 #define lnet_eq_wait_unlock()   spin_unlock(&the_lnet.ln_eq_wait_lock)
179 #define lnet_ni_lock(ni)        spin_lock(&(ni)->ni_lock)
180 #define lnet_ni_unlock(ni)      spin_unlock(&(ni)->ni_lock)
181
182 #define MAX_PORTALS     64
183
184 #define LNET_SMALL_MD_SIZE   offsetof(struct lnet_libmd, md_iov.iov[1])
185 extern struct kmem_cache *lnet_mes_cachep;       /* MEs kmem_cache */
186 extern struct kmem_cache *lnet_small_mds_cachep; /* <= LNET_SMALL_MD_SIZE bytes
187                                                   * MDs kmem_cache */
188
189 static inline struct lnet_eq *
190 lnet_eq_alloc (void)
191 {
192         struct lnet_eq *eq;
193
194         LIBCFS_ALLOC(eq, sizeof(*eq));
195         return (eq);
196 }
197
198 static inline void
199 lnet_eq_free(struct lnet_eq *eq)
200 {
201         LIBCFS_FREE(eq, sizeof(*eq));
202 }
203
204 static inline struct lnet_libmd *
205 lnet_md_alloc(struct lnet_md *umd)
206 {
207         struct lnet_libmd *md;
208         unsigned int  size;
209         unsigned int  niov;
210
211         if ((umd->options & LNET_MD_KIOV) != 0) {
212                 niov = umd->length;
213                 size = offsetof(struct lnet_libmd, md_iov.kiov[niov]);
214         } else {
215                 niov = ((umd->options & LNET_MD_IOVEC) != 0) ?
216                        umd->length : 1;
217                 size = offsetof(struct lnet_libmd, md_iov.iov[niov]);
218         }
219
220         if (size <= LNET_SMALL_MD_SIZE) {
221                 md = kmem_cache_alloc(lnet_small_mds_cachep,
222                                       GFP_NOFS | __GFP_ZERO);
223                 if (md) {
224                         CDEBUG(D_MALLOC, "slab-alloced 'md' of size %u at "
225                                "%p.\n", size, md);
226                 } else {
227                         CDEBUG(D_MALLOC, "failed to allocate 'md' of size %u\n",
228                                size);
229                         return NULL;
230                 }
231         } else {
232                 LIBCFS_ALLOC(md, size);
233         }
234
235         if (md != NULL) {
236                 /* Set here in case of early free */
237                 md->md_options = umd->options;
238                 md->md_niov = niov;
239                 INIT_LIST_HEAD(&md->md_list);
240         }
241
242         return md;
243 }
244
245 static inline void
246 lnet_md_free(struct lnet_libmd *md)
247 {
248         unsigned int  size;
249
250         if ((md->md_options & LNET_MD_KIOV) != 0)
251                 size = offsetof(struct lnet_libmd, md_iov.kiov[md->md_niov]);
252         else
253                 size = offsetof(struct lnet_libmd, md_iov.iov[md->md_niov]);
254
255         if (size <= LNET_SMALL_MD_SIZE) {
256                 CDEBUG(D_MALLOC, "slab-freed 'md' at %p.\n", md);
257                 kmem_cache_free(lnet_small_mds_cachep, md);
258         } else {
259                 LIBCFS_FREE(md, size);
260         }
261 }
262
263 static inline struct lnet_me *
264 lnet_me_alloc (void)
265 {
266         struct lnet_me *me;
267
268         me = kmem_cache_alloc(lnet_mes_cachep, GFP_NOFS | __GFP_ZERO);
269
270         if (me)
271                 CDEBUG(D_MALLOC, "slab-alloced 'me' at %p.\n", me);
272         else
273                 CDEBUG(D_MALLOC, "failed to allocate 'me'\n");
274
275         return me;
276 }
277
278 static inline void
279 lnet_me_free(struct lnet_me *me)
280 {
281         CDEBUG(D_MALLOC, "slab-freed 'me' at %p.\n", me);
282         kmem_cache_free(lnet_mes_cachep, me);
283 }
284
285 struct lnet_libhandle *lnet_res_lh_lookup(struct lnet_res_container *rec,
286                                      __u64 cookie);
287 void lnet_res_lh_initialize(struct lnet_res_container *rec,
288                             struct lnet_libhandle *lh);
289 static inline void
290 lnet_res_lh_invalidate(struct lnet_libhandle *lh)
291 {
292         /* ALWAYS called with resource lock held */
293         /* NB: cookie is still useful, don't reset it */
294         list_del(&lh->lh_hash_chain);
295 }
296
297 static inline void
298 lnet_eq2handle(struct lnet_handle_eq *handle, struct lnet_eq *eq)
299 {
300         if (eq == NULL) {
301                 LNetInvalidateEQHandle(handle);
302                 return;
303         }
304
305         handle->cookie = eq->eq_lh.lh_cookie;
306 }
307
308 static inline struct lnet_eq *
309 lnet_handle2eq(struct lnet_handle_eq *handle)
310 {
311         /* ALWAYS called with resource lock held */
312         struct lnet_libhandle *lh;
313
314         lh = lnet_res_lh_lookup(&the_lnet.ln_eq_container, handle->cookie);
315         if (lh == NULL)
316                 return NULL;
317
318         return lh_entry(lh, struct lnet_eq, eq_lh);
319 }
320
321 static inline void
322 lnet_md2handle(struct lnet_handle_md *handle, struct lnet_libmd *md)
323 {
324         handle->cookie = md->md_lh.lh_cookie;
325 }
326
327 static inline struct lnet_libmd *
328 lnet_handle2md(struct lnet_handle_md *handle)
329 {
330         /* ALWAYS called with resource lock held */
331         struct lnet_libhandle *lh;
332         int              cpt;
333
334         cpt = lnet_cpt_of_cookie(handle->cookie);
335         lh = lnet_res_lh_lookup(the_lnet.ln_md_containers[cpt],
336                                 handle->cookie);
337         if (lh == NULL)
338                 return NULL;
339
340         return lh_entry(lh, struct lnet_libmd, md_lh);
341 }
342
343 static inline struct lnet_libmd *
344 lnet_wire_handle2md(struct lnet_handle_wire *wh)
345 {
346         /* ALWAYS called with resource lock held */
347         struct lnet_libhandle *lh;
348         int              cpt;
349
350         if (wh->wh_interface_cookie != the_lnet.ln_interface_cookie)
351                 return NULL;
352
353         cpt = lnet_cpt_of_cookie(wh->wh_object_cookie);
354         lh = lnet_res_lh_lookup(the_lnet.ln_md_containers[cpt],
355                                 wh->wh_object_cookie);
356         if (lh == NULL)
357                 return NULL;
358
359         return lh_entry(lh, struct lnet_libmd, md_lh);
360 }
361
362 static inline void
363 lnet_me2handle(struct lnet_handle_me *handle, struct lnet_me *me)
364 {
365         handle->cookie = me->me_lh.lh_cookie;
366 }
367
368 static inline struct lnet_me *
369 lnet_handle2me(struct lnet_handle_me *handle)
370 {
371         /* ALWAYS called with resource lock held */
372         struct lnet_libhandle *lh;
373         int              cpt;
374
375         cpt = lnet_cpt_of_cookie(handle->cookie);
376         lh = lnet_res_lh_lookup(the_lnet.ln_me_containers[cpt],
377                                 handle->cookie);
378         if (lh == NULL)
379                 return NULL;
380
381         return lh_entry(lh, struct lnet_me, me_lh);
382 }
383
384 static inline void
385 lnet_peer_net_addref_locked(struct lnet_peer_net *lpn)
386 {
387         atomic_inc(&lpn->lpn_refcount);
388 }
389
390 extern void lnet_destroy_peer_net_locked(struct lnet_peer_net *lpn);
391
392 static inline void
393 lnet_peer_net_decref_locked(struct lnet_peer_net *lpn)
394 {
395         if (atomic_dec_and_test(&lpn->lpn_refcount))
396                 lnet_destroy_peer_net_locked(lpn);
397 }
398
399 static inline void
400 lnet_peer_addref_locked(struct lnet_peer *lp)
401 {
402         atomic_inc(&lp->lp_refcount);
403 }
404
405 extern void lnet_destroy_peer_locked(struct lnet_peer *lp);
406
407 static inline void
408 lnet_peer_decref_locked(struct lnet_peer *lp)
409 {
410         if (atomic_dec_and_test(&lp->lp_refcount))
411                 lnet_destroy_peer_locked(lp);
412 }
413
414 static inline void
415 lnet_peer_ni_addref_locked(struct lnet_peer_ni *lp)
416 {
417         LASSERT(atomic_read(&lp->lpni_refcount) > 0);
418         atomic_inc(&lp->lpni_refcount);
419 }
420
421 extern void lnet_destroy_peer_ni_locked(struct lnet_peer_ni *lp);
422
423 static inline void
424 lnet_peer_ni_decref_locked(struct lnet_peer_ni *lp)
425 {
426         LASSERT(atomic_read(&lp->lpni_refcount) > 0);
427         if (atomic_dec_and_test(&lp->lpni_refcount))
428                 lnet_destroy_peer_ni_locked(lp);
429 }
430
431 static inline int
432 lnet_isrouter(struct lnet_peer_ni *lp)
433 {
434         return lp->lpni_rtr_refcount != 0;
435 }
436
437 static inline void
438 lnet_ni_addref_locked(struct lnet_ni *ni, int cpt)
439 {
440         LASSERT(cpt >= 0 && cpt < LNET_CPT_NUMBER);
441         LASSERT(*ni->ni_refs[cpt] >= 0);
442
443         (*ni->ni_refs[cpt])++;
444 }
445
446 static inline void
447 lnet_ni_addref(struct lnet_ni *ni)
448 {
449         lnet_net_lock(0);
450         lnet_ni_addref_locked(ni, 0);
451         lnet_net_unlock(0);
452 }
453
454 static inline void
455 lnet_ni_decref_locked(struct lnet_ni *ni, int cpt)
456 {
457         LASSERT(cpt >= 0 && cpt < LNET_CPT_NUMBER);
458         LASSERT(*ni->ni_refs[cpt] > 0);
459
460         (*ni->ni_refs[cpt])--;
461 }
462
463 static inline void
464 lnet_ni_decref(struct lnet_ni *ni)
465 {
466         lnet_net_lock(0);
467         lnet_ni_decref_locked(ni, 0);
468         lnet_net_unlock(0);
469 }
470
471 static inline struct lnet_msg *
472 lnet_msg_alloc(void)
473 {
474         struct lnet_msg *msg;
475
476         LIBCFS_ALLOC(msg, sizeof(*msg));
477
478         /* no need to zero, LIBCFS_ALLOC does for us */
479         return (msg);
480 }
481
482 static inline void
483 lnet_msg_free(struct lnet_msg *msg)
484 {
485         LASSERT(!msg->msg_onactivelist);
486         LIBCFS_FREE(msg, sizeof(*msg));
487 }
488
489 void lnet_ni_free(struct lnet_ni *ni);
490 void lnet_net_free(struct lnet_net *net);
491
492 struct lnet_net *
493 lnet_net_alloc(__u32 net_type, struct list_head *netlist);
494
495 struct lnet_ni *
496 lnet_ni_alloc(struct lnet_net *net, struct cfs_expr_list *el,
497               char *iface);
498 struct lnet_ni *
499 lnet_ni_alloc_w_cpt_array(struct lnet_net *net, __u32 *cpts, __u32 ncpts,
500                           char *iface);
501
502 static inline int
503 lnet_nid2peerhash(lnet_nid_t nid)
504 {
505         return hash_long(nid, LNET_PEER_HASH_BITS);
506 }
507
508 static inline struct list_head *
509 lnet_net2rnethash(__u32 net)
510 {
511         return &the_lnet.ln_remote_nets_hash[(LNET_NETNUM(net) +
512                 LNET_NETTYP(net)) &
513                 ((1U << the_lnet.ln_remote_nets_hbits) - 1)];
514 }
515
516 extern struct lnet_lnd the_lolnd;
517 extern int avoid_asym_router_failure;
518
519 extern unsigned int lnet_nid_cpt_hash(lnet_nid_t nid, unsigned int number);
520 extern int lnet_cpt_of_nid_locked(lnet_nid_t nid, struct lnet_ni *ni);
521 extern int lnet_cpt_of_nid(lnet_nid_t nid, struct lnet_ni *ni);
522 extern struct lnet_ni *lnet_nid2ni_locked(lnet_nid_t nid, int cpt);
523 extern struct lnet_ni *lnet_nid2ni_addref(lnet_nid_t nid);
524 extern struct lnet_ni *lnet_net2ni_locked(__u32 net, int cpt);
525 extern struct lnet_ni *lnet_net2ni_addref(__u32 net);
526 bool lnet_is_ni_healthy_locked(struct lnet_ni *ni);
527 struct lnet_net *lnet_get_net_locked(__u32 net_id);
528
529 int lnet_lib_init(void);
530 void lnet_lib_exit(void);
531
532 extern unsigned int lnet_numa_range;
533 extern int portal_rotor;
534
535 int lnet_notify(struct lnet_ni *ni, lnet_nid_t peer, int alive,
536                 cfs_time_t when);
537 void lnet_notify_locked(struct lnet_peer_ni *lp, int notifylnd, int alive,
538                         cfs_time_t when);
539 int lnet_add_route(__u32 net, __u32 hops, lnet_nid_t gateway_nid,
540                    unsigned int priority);
541 int lnet_check_routes(void);
542 int lnet_del_route(__u32 net, lnet_nid_t gw_nid);
543 void lnet_destroy_routes(void);
544 int lnet_get_route(int idx, __u32 *net, __u32 *hops,
545                    lnet_nid_t *gateway, __u32 *alive, __u32 *priority);
546 int lnet_get_rtr_pool_cfg(int idx, struct lnet_ioctl_pool_cfg *pool_cfg);
547 struct lnet_ni *lnet_get_next_ni_locked(struct lnet_net *mynet,
548                                         struct lnet_ni *prev);
549 struct lnet_ni *lnet_get_ni_idx_locked(int idx);
550
551 struct libcfs_ioctl_handler {
552         struct list_head item;
553         int (*handle_ioctl)(unsigned int cmd, struct libcfs_ioctl_hdr *hdr);
554 };
555
556 #define DECLARE_IOCTL_HANDLER(ident, func)                      \
557         static struct libcfs_ioctl_handler ident = {            \
558                 .item         = LIST_HEAD_INIT(ident.item),     \
559                 .handle_ioctl = func                            \
560         }
561
562 extern int libcfs_register_ioctl(struct libcfs_ioctl_handler *hand);
563 extern int libcfs_deregister_ioctl(struct libcfs_ioctl_handler *hand);
564 extern int libcfs_ioctl_getdata(struct libcfs_ioctl_hdr **hdr_pp,
565                                 struct libcfs_ioctl_hdr __user *uparam);
566
567 void lnet_proc_init(void);
568 void lnet_proc_fini(void);
569 int  lnet_rtrpools_alloc(int im_a_router);
570 void lnet_destroy_rtrbuf(struct lnet_rtrbuf *rb, int npages);
571 int  lnet_rtrpools_adjust(int tiny, int small, int large);
572 int lnet_rtrpools_enable(void);
573 void lnet_rtrpools_disable(void);
574 void lnet_rtrpools_free(int keep_pools);
575 struct lnet_remotenet *lnet_find_rnet_locked(__u32 net);
576 int lnet_dyn_add_net(struct lnet_ioctl_config_data *conf);
577 int lnet_dyn_del_net(__u32 net);
578 int lnet_dyn_add_ni(struct lnet_ioctl_config_ni *conf);
579 int lnet_dyn_del_ni(struct lnet_ioctl_config_ni *conf);
580 int lnet_clear_lazy_portal(struct lnet_ni *ni, int portal, char *reason);
581 struct lnet_net *lnet_get_net_locked(__u32 net_id);
582
583 int lnet_islocalnid(lnet_nid_t nid);
584 int lnet_islocalnet(__u32 net);
585
586 void lnet_msg_attach_md(struct lnet_msg *msg, struct lnet_libmd *md,
587                         unsigned int offset, unsigned int mlen);
588 void lnet_msg_detach_md(struct lnet_msg *msg, int status);
589 void lnet_build_unlink_event(struct lnet_libmd *md, struct lnet_event *ev);
590 void lnet_build_msg_event(struct lnet_msg *msg, enum lnet_event_kind ev_type);
591 void lnet_msg_commit(struct lnet_msg *msg, int cpt);
592 void lnet_msg_decommit(struct lnet_msg *msg, int cpt, int status);
593
594 void lnet_eq_enqueue_event(struct lnet_eq *eq, struct lnet_event *ev);
595 void lnet_prep_send(struct lnet_msg *msg, int type,
596                     struct lnet_process_id target, unsigned int offset,
597                     unsigned int len);
598 int lnet_send(lnet_nid_t nid, struct lnet_msg *msg, lnet_nid_t rtr_nid);
599 void lnet_return_tx_credits_locked(struct lnet_msg *msg);
600 void lnet_return_rx_credits_locked(struct lnet_msg *msg);
601 void lnet_schedule_blocked_locked(struct lnet_rtrbufpool *rbp);
602 void lnet_drop_routed_msgs_locked(struct list_head *list, int cpt);
603
604 /* portals functions */
605 /* portals attributes */
606 static inline int
607 lnet_ptl_is_lazy(struct lnet_portal *ptl)
608 {
609         return !!(ptl->ptl_options & LNET_PTL_LAZY);
610 }
611
612 static inline int
613 lnet_ptl_is_unique(struct lnet_portal *ptl)
614 {
615         return !!(ptl->ptl_options & LNET_PTL_MATCH_UNIQUE);
616 }
617
618 static inline int
619 lnet_ptl_is_wildcard(struct lnet_portal *ptl)
620 {
621         return !!(ptl->ptl_options & LNET_PTL_MATCH_WILDCARD);
622 }
623
624 static inline void
625 lnet_ptl_setopt(struct lnet_portal *ptl, int opt)
626 {
627         ptl->ptl_options |= opt;
628 }
629
630 static inline void
631 lnet_ptl_unsetopt(struct lnet_portal *ptl, int opt)
632 {
633         ptl->ptl_options &= ~opt;
634 }
635
636 /* match-table functions */
637 struct list_head *lnet_mt_match_head(struct lnet_match_table *mtable,
638                                struct lnet_process_id id, __u64 mbits);
639 struct lnet_match_table *lnet_mt_of_attach(unsigned int index,
640                                            struct lnet_process_id id,
641                                            __u64 mbits, __u64 ignore_bits,
642                                            enum lnet_ins_pos pos);
643 int lnet_mt_match_md(struct lnet_match_table *mtable,
644                      struct lnet_match_info *info, struct lnet_msg *msg);
645
646 /* portals match/attach functions */
647 void lnet_ptl_attach_md(struct lnet_me *me, struct lnet_libmd *md,
648                         struct list_head *matches, struct list_head *drops);
649 void lnet_ptl_detach_md(struct lnet_me *me, struct lnet_libmd *md);
650 int lnet_ptl_match_md(struct lnet_match_info *info, struct lnet_msg *msg);
651
652 /* initialized and finalize portals */
653 int lnet_portals_create(void);
654 void lnet_portals_destroy(void);
655
656 /* message functions */
657 int lnet_parse(struct lnet_ni *ni, struct lnet_hdr *hdr,
658                lnet_nid_t fromnid, void *private, int rdma_req);
659 int lnet_parse_local(struct lnet_ni *ni, struct lnet_msg *msg);
660 int lnet_parse_forward_locked(struct lnet_ni *ni, struct lnet_msg *msg);
661
662 void lnet_recv(struct lnet_ni *ni, void *private, struct lnet_msg *msg,
663                int delayed, unsigned int offset, unsigned int mlen,
664                unsigned int rlen);
665 void lnet_ni_recv(struct lnet_ni *ni, void *private, struct lnet_msg *msg,
666                   int delayed, unsigned int offset,
667                   unsigned int mlen, unsigned int rlen);
668
669 struct lnet_msg *lnet_create_reply_msg(struct lnet_ni *ni,
670                                        struct lnet_msg *get_msg);
671 void lnet_set_reply_msg_len(struct lnet_ni *ni, struct lnet_msg *msg,
672                             unsigned int len);
673
674 void lnet_finalize(struct lnet_msg *msg, int rc);
675
676 void lnet_drop_message(struct lnet_ni *ni, int cpt, void *private,
677                        unsigned int nob);
678 void lnet_drop_delayed_msg_list(struct list_head *head, char *reason);
679 void lnet_recv_delayed_msg_list(struct list_head *head);
680
681 int lnet_msg_container_setup(struct lnet_msg_container *container, int cpt);
682 void lnet_msg_container_cleanup(struct lnet_msg_container *container);
683 void lnet_msg_containers_destroy(void);
684 int lnet_msg_containers_create(void);
685
686 char *lnet_msgtyp2str(int type);
687 void lnet_print_hdr(struct lnet_hdr *hdr);
688 int lnet_fail_nid(lnet_nid_t nid, unsigned int threshold);
689
690 /** \addtogroup lnet_fault_simulation @{ */
691
692 int lnet_fault_ctl(int cmd, struct libcfs_ioctl_data *data);
693 int lnet_fault_init(void);
694 void lnet_fault_fini(void);
695
696 bool lnet_drop_rule_match(struct lnet_hdr *hdr);
697
698 int lnet_delay_rule_add(struct lnet_fault_attr *attr);
699 int lnet_delay_rule_del(lnet_nid_t src, lnet_nid_t dst, bool shutdown);
700 int lnet_delay_rule_list(int pos, struct lnet_fault_attr *attr,
701                          struct lnet_fault_stat *stat);
702 void lnet_delay_rule_reset(void);
703 void lnet_delay_rule_check(void);
704 bool lnet_delay_rule_match_locked(struct lnet_hdr *hdr, struct lnet_msg *msg);
705
706 /** @} lnet_fault_simulation */
707
708 void lnet_counters_get(struct lnet_counters *counters);
709 void lnet_counters_reset(void);
710
711 unsigned int lnet_iov_nob(unsigned int niov, struct kvec *iov);
712 int lnet_extract_iov(int dst_niov, struct kvec *dst,
713                       int src_niov, struct kvec *src,
714                       unsigned int offset, unsigned int len);
715
716 unsigned int lnet_kiov_nob (unsigned int niov, lnet_kiov_t *iov);
717 int lnet_extract_kiov(int dst_niov, lnet_kiov_t *dst,
718                      int src_niov, lnet_kiov_t *src,
719                      unsigned int offset, unsigned int len);
720
721 void lnet_copy_iov2iov(unsigned int ndiov, struct kvec *diov,
722                        unsigned int doffset,
723                        unsigned int nsiov, struct kvec *siov,
724                        unsigned int soffset, unsigned int nob);
725 void lnet_copy_kiov2iov(unsigned int niov, struct kvec *iov,
726                         unsigned int iovoffset,
727                         unsigned int nkiov, lnet_kiov_t *kiov,
728                         unsigned int kiovoffset, unsigned int nob);
729 void lnet_copy_iov2kiov(unsigned int nkiov, lnet_kiov_t *kiov,
730                         unsigned int kiovoffset,
731                         unsigned int niov, struct kvec *iov,
732                         unsigned int iovoffset, unsigned int nob);
733 void lnet_copy_kiov2kiov(unsigned int ndkiov, lnet_kiov_t *dkiov,
734                          unsigned int doffset,
735                          unsigned int nskiov, lnet_kiov_t *skiov,
736                          unsigned int soffset, unsigned int nob);
737
738 static inline void
739 lnet_copy_iov2flat(int dlen, void *dest, unsigned int doffset,
740                    unsigned int nsiov, struct kvec *siov, unsigned int soffset,
741                    unsigned int nob)
742 {
743         struct kvec diov = { .iov_base = dest, .iov_len = dlen };
744
745         lnet_copy_iov2iov(1, &diov, doffset,
746                           nsiov, siov, soffset, nob);
747 }
748
749 static inline void
750 lnet_copy_kiov2flat(int dlen, void *dest, unsigned int doffset,
751                     unsigned int nsiov, lnet_kiov_t *skiov,
752                     unsigned int soffset, unsigned int nob)
753 {
754         struct kvec diov = { .iov_base = dest, .iov_len = dlen };
755
756         lnet_copy_kiov2iov(1, &diov, doffset,
757                            nsiov, skiov, soffset, nob);
758 }
759
760 static inline void
761 lnet_copy_flat2iov(unsigned int ndiov, struct kvec *diov, unsigned int doffset,
762                    int slen, void *src, unsigned int soffset,
763                    unsigned int nob)
764 {
765         struct kvec siov = { .iov_base = src, .iov_len = slen };
766         lnet_copy_iov2iov(ndiov, diov, doffset,
767                           1, &siov, soffset, nob);
768 }
769
770 static inline void
771 lnet_copy_flat2kiov(unsigned int ndiov, lnet_kiov_t *dkiov,
772                     unsigned int doffset, int slen, void *src,
773                     unsigned int soffset, unsigned int nob)
774 {
775         struct kvec siov = { .iov_base = src, .iov_len = slen };
776         lnet_copy_iov2kiov(ndiov, dkiov, doffset,
777                            1, &siov, soffset, nob);
778 }
779
780 void lnet_me_unlink(struct lnet_me *me);
781
782 void lnet_md_unlink(struct lnet_libmd *md);
783 void lnet_md_deconstruct(struct lnet_libmd *lmd, struct lnet_md *umd);
784 struct page *lnet_kvaddr_to_page(unsigned long vaddr);
785 int lnet_cpt_of_md(struct lnet_libmd *md, unsigned int offset);
786
787 void lnet_register_lnd(struct lnet_lnd *lnd);
788 void lnet_unregister_lnd(struct lnet_lnd *lnd);
789
790 int lnet_connect(struct socket **sockp, lnet_nid_t peer_nid,
791                  __u32 local_ip, __u32 peer_ip, int peer_port);
792 void lnet_connect_console_error(int rc, lnet_nid_t peer_nid,
793                                 __u32 peer_ip, int port);
794 int lnet_count_acceptor_nets(void);
795 int lnet_acceptor_timeout(void);
796 int lnet_acceptor_port(void);
797 int lnet_acceptor_start(void);
798 void lnet_acceptor_stop(void);
799
800 int lnet_ipif_query(char *name, int *up, __u32 *ip, __u32 *mask);
801 int lnet_ipif_enumerate(char ***names);
802 void lnet_ipif_free_enumeration(char **names, int n);
803 int lnet_sock_setbuf(struct socket *socket, int txbufsize, int rxbufsize);
804 int lnet_sock_getbuf(struct socket *socket, int *txbufsize, int *rxbufsize);
805 int lnet_sock_getaddr(struct socket *socket, bool remote, __u32 *ip, int *port);
806 int lnet_sock_write(struct socket *sock, void *buffer, int nob, int timeout);
807 int lnet_sock_read(struct socket *sock, void *buffer, int nob, int timeout);
808
809 int lnet_sock_listen(struct socket **sockp, __u32 ip, int port, int backlog);
810 int lnet_sock_accept(struct socket **newsockp, struct socket *sock);
811 int lnet_sock_connect(struct socket **sockp, int *fatal,
812                         __u32 local_ip, int local_port,
813                         __u32 peer_ip, int peer_port);
814
815 int lnet_peers_start_down(void);
816 int lnet_peer_buffer_credits(struct lnet_net *net);
817
818 int lnet_router_checker_start(void);
819 void lnet_router_checker_stop(void);
820 void lnet_router_ni_update_locked(struct lnet_peer_ni *gw, __u32 net);
821 void lnet_swap_pinginfo(struct lnet_ping_buffer *pbuf);
822
823 int lnet_ping_info_validate(struct lnet_ping_info *pinfo);
824 struct lnet_ping_buffer *lnet_ping_buffer_alloc(int nnis, gfp_t gfp);
825 void lnet_ping_buffer_free(struct lnet_ping_buffer *pbuf);
826
827 static inline void lnet_ping_buffer_addref(struct lnet_ping_buffer *pbuf)
828 {
829         atomic_inc(&pbuf->pb_refcnt);
830 }
831
832 static inline void lnet_ping_buffer_decref(struct lnet_ping_buffer *pbuf)
833 {
834         if (atomic_dec_and_test(&pbuf->pb_refcnt))
835                 lnet_ping_buffer_free(pbuf);
836 }
837
838 static inline int lnet_ping_buffer_numref(struct lnet_ping_buffer *pbuf)
839 {
840         return atomic_read(&pbuf->pb_refcnt);
841 }
842
843 int lnet_parse_ip2nets(char **networksp, char *ip2nets);
844 int lnet_parse_routes(char *route_str, int *im_a_router);
845 int lnet_parse_networks(struct list_head *nilist, char *networks,
846                         bool use_tcp_bonding);
847 bool lnet_net_unique(__u32 net_id, struct list_head *nilist,
848                      struct lnet_net **net);
849 bool lnet_ni_unique_net(struct list_head *nilist, char *iface);
850 void lnet_incr_dlc_seq(void);
851 __u32 lnet_get_dlc_seq_locked(void);
852
853 struct lnet_peer_ni *lnet_get_next_peer_ni_locked(struct lnet_peer *peer,
854                                                   struct lnet_peer_net *peer_net,
855                                                   struct lnet_peer_ni *prev);
856 struct lnet_peer_ni *lnet_nid2peerni_locked(lnet_nid_t nid, lnet_nid_t pref,
857                                         int cpt);
858 struct lnet_peer_ni *lnet_nid2peerni_ex(lnet_nid_t nid, int cpt);
859 struct lnet_peer_ni *lnet_find_peer_ni_locked(lnet_nid_t nid);
860 void lnet_peer_net_added(struct lnet_net *net);
861 lnet_nid_t lnet_peer_primary_nid_locked(lnet_nid_t nid);
862 void lnet_peer_tables_cleanup(struct lnet_net *net);
863 void lnet_peer_uninit(void);
864 int lnet_peer_tables_create(void);
865 void lnet_debug_peer(lnet_nid_t nid);
866 struct lnet_peer_net *lnet_peer_get_net_locked(struct lnet_peer *peer,
867                                                __u32 net_id);
868 bool lnet_peer_is_pref_nid_locked(struct lnet_peer_ni *lpni, lnet_nid_t nid);
869 int lnet_peer_ni_set_non_mr_pref_nid(struct lnet_peer_ni *lpni, lnet_nid_t nid);
870 int lnet_add_peer_ni(lnet_nid_t key_nid, lnet_nid_t nid, bool mr);
871 int lnet_del_peer_ni(lnet_nid_t key_nid, lnet_nid_t nid);
872 int lnet_get_peer_info(__u32 idx, lnet_nid_t *primary_nid, lnet_nid_t *nid,
873                        bool *mr,
874                        struct lnet_peer_ni_credit_info __user *peer_ni_info,
875                        struct lnet_ioctl_element_stats __user *peer_ni_stats);
876 int lnet_get_peer_ni_info(__u32 peer_index, __u64 *nid,
877                           char alivness[LNET_MAX_STR_LEN],
878                           __u32 *cpt_iter, __u32 *refcount,
879                           __u32 *ni_peer_tx_credits, __u32 *peer_tx_credits,
880                           __u32 *peer_rtr_credits, __u32 *peer_min_rtr_credtis,
881                           __u32 *peer_tx_qnob);
882
883
884 static inline bool
885 lnet_is_peer_ni_healthy_locked(struct lnet_peer_ni *lpni)
886 {
887         return lpni->lpni_healthy;
888 }
889
890 static inline void
891 lnet_set_peer_ni_health_locked(struct lnet_peer_ni *lpni, bool health)
892 {
893         lpni->lpni_healthy = health;
894 }
895
896 static inline bool
897 lnet_is_peer_net_healthy_locked(struct lnet_peer_net *peer_net)
898 {
899         struct lnet_peer_ni *lpni;
900
901         list_for_each_entry(lpni, &peer_net->lpn_peer_nis,
902                             lpni_peer_nis) {
903                 if (lnet_is_peer_ni_healthy_locked(lpni))
904                         return true;
905         }
906
907         return false;
908 }
909
910 static inline bool
911 lnet_is_peer_healthy_locked(struct lnet_peer *peer)
912 {
913         struct lnet_peer_net *peer_net;
914
915         list_for_each_entry(peer_net, &peer->lp_peer_nets, lpn_peer_nets) {
916                 if (lnet_is_peer_net_healthy_locked(peer_net))
917                         return true;
918         }
919
920         return false;
921 }
922
923 static inline void
924 lnet_peer_set_alive(struct lnet_peer_ni *lp)
925 {
926         lp->lpni_last_alive = lp->lpni_last_query = cfs_time_current();
927         if (!lp->lpni_alive)
928                 lnet_notify_locked(lp, 0, 1, lp->lpni_last_alive);
929 }
930
931 static inline bool
932 lnet_peer_is_multi_rail(struct lnet_peer *lp)
933 {
934         if (lp->lp_state & LNET_PEER_MULTI_RAIL)
935                 return true;
936         return false;
937 }
938
939 static inline bool
940 lnet_peer_ni_is_configured(struct lnet_peer_ni *lpni)
941 {
942         if (lpni->lpni_peer_net->lpn_peer->lp_state & LNET_PEER_CONFIGURED)
943                 return true;
944         return false;
945 }
946
947 static inline bool
948 lnet_peer_ni_is_primary(struct lnet_peer_ni *lpni)
949 {
950         return lpni->lpni_nid == lpni->lpni_peer_net->lpn_peer->lp_primary_nid;
951 }
952
953 #endif