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