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