Whamcloud - gitweb
LU-13780 lnet: Leverage peer aliveness more efficiently
[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         kref_get(&lp->lpni_kref);
379 }
380
381 extern void lnet_destroy_peer_ni_locked(struct kref *ref);
382
383 static inline void
384 lnet_peer_ni_decref_locked(struct lnet_peer_ni *lp)
385 {
386         kref_put(&lp->lpni_kref, lnet_destroy_peer_ni_locked);
387 }
388
389 static inline int
390 lnet_isrouter(struct lnet_peer_ni *lpni)
391 {
392         return lpni->lpni_peer_net->lpn_peer->lp_rtr_refcount != 0;
393 }
394
395 static inline void
396 lnet_ni_addref_locked(struct lnet_ni *ni, int cpt)
397 {
398         LASSERT(cpt >= 0 && cpt < LNET_CPT_NUMBER);
399         LASSERT(*ni->ni_refs[cpt] >= 0);
400
401         (*ni->ni_refs[cpt])++;
402 }
403
404 static inline void
405 lnet_ni_addref(struct lnet_ni *ni)
406 {
407         lnet_net_lock(0);
408         lnet_ni_addref_locked(ni, 0);
409         lnet_net_unlock(0);
410 }
411
412 static inline void
413 lnet_ni_decref_locked(struct lnet_ni *ni, int cpt)
414 {
415         LASSERT(cpt >= 0 && cpt < LNET_CPT_NUMBER);
416         LASSERT(*ni->ni_refs[cpt] > 0);
417
418         (*ni->ni_refs[cpt])--;
419 }
420
421 static inline void
422 lnet_ni_decref(struct lnet_ni *ni)
423 {
424         lnet_net_lock(0);
425         lnet_ni_decref_locked(ni, 0);
426         lnet_net_unlock(0);
427 }
428
429 static inline struct lnet_msg *
430 lnet_msg_alloc(void)
431 {
432         struct lnet_msg *msg;
433
434         msg = kmem_cache_zalloc(lnet_msg_cachep, GFP_NOFS);
435
436         return (msg);
437 }
438
439 static inline void
440 lnet_msg_free(struct lnet_msg *msg)
441 {
442         LASSERT(!msg->msg_onactivelist);
443         kmem_cache_free(lnet_msg_cachep, msg);
444 }
445
446 static inline struct lnet_rsp_tracker *
447 lnet_rspt_alloc(int cpt)
448 {
449         struct lnet_rsp_tracker *rspt;
450
451         rspt = kmem_cache_zalloc(lnet_rspt_cachep, GFP_NOFS);
452         if (rspt) {
453                 lnet_net_lock(cpt);
454                 the_lnet.ln_counters[cpt]->lct_health.lch_rst_alloc++;
455                 lnet_net_unlock(cpt);
456         }
457         CDEBUG(D_MALLOC, "rspt alloc %p\n", rspt);
458         return rspt;
459 }
460
461 static inline void
462 lnet_rspt_free(struct lnet_rsp_tracker *rspt, int cpt)
463 {
464         CDEBUG(D_MALLOC, "rspt free %p\n", rspt);
465
466         kmem_cache_free(lnet_rspt_cachep, rspt);
467         lnet_net_lock(cpt);
468         the_lnet.ln_counters[cpt]->lct_health.lch_rst_alloc--;
469         lnet_net_unlock(cpt);
470 }
471
472 void lnet_ni_free(struct lnet_ni *ni);
473 void lnet_net_free(struct lnet_net *net);
474
475 struct lnet_net *
476 lnet_net_alloc(__u32 net_type, struct list_head *netlist);
477
478 struct lnet_ni *
479 lnet_ni_alloc(struct lnet_net *net, struct cfs_expr_list *el,
480               char *iface);
481 struct lnet_ni *
482 lnet_ni_alloc_w_cpt_array(struct lnet_net *net, __u32 *cpts, __u32 ncpts,
483                           char *iface);
484
485 static inline int
486 lnet_nid2peerhash(lnet_nid_t nid)
487 {
488         return hash_long(nid, LNET_PEER_HASH_BITS);
489 }
490
491 static inline struct list_head *
492 lnet_net2rnethash(__u32 net)
493 {
494         return &the_lnet.ln_remote_nets_hash[(LNET_NETNUM(net) +
495                 LNET_NETTYP(net)) &
496                 ((1U << the_lnet.ln_remote_nets_hbits) - 1)];
497 }
498
499 extern const struct lnet_lnd the_lolnd;
500 extern int avoid_asym_router_failure;
501
502 extern unsigned int lnet_nid_cpt_hash(lnet_nid_t nid, unsigned int number);
503 extern int lnet_cpt_of_nid_locked(lnet_nid_t nid, struct lnet_ni *ni);
504 extern int lnet_cpt_of_nid(lnet_nid_t nid, struct lnet_ni *ni);
505 extern struct lnet_ni *lnet_nid2ni_locked(lnet_nid_t nid, int cpt);
506 extern struct lnet_ni *lnet_nid2ni_addref(lnet_nid_t nid);
507 extern struct lnet_ni *lnet_net2ni_locked(__u32 net, int cpt);
508 extern struct lnet_ni *lnet_net2ni_addref(__u32 net);
509 struct lnet_net *lnet_get_net_locked(__u32 net_id);
510
511 int lnet_lib_init(void);
512 void lnet_lib_exit(void);
513
514 extern unsigned int lnet_response_tracking;
515 extern unsigned lnet_transaction_timeout;
516 extern unsigned lnet_retry_count;
517 extern unsigned int lnet_lnd_timeout;
518 extern unsigned int lnet_numa_range;
519 extern unsigned int lnet_health_sensitivity;
520 extern unsigned int lnet_recovery_interval;
521 extern unsigned int lnet_recovery_limit;
522 extern unsigned int lnet_peer_discovery_disabled;
523 extern unsigned int lnet_drop_asym_route;
524 extern unsigned int router_sensitivity_percentage;
525 extern int alive_router_check_interval;
526 extern int live_router_check_interval;
527 extern int dead_router_check_interval;
528 extern int portal_rotor;
529
530 void lnet_mt_event_handler(struct lnet_event *event);
531
532 int lnet_notify(struct lnet_ni *ni, lnet_nid_t peer, bool alive, bool reset,
533                 time64_t when);
534 void lnet_notify_locked(struct lnet_peer_ni *lp, int notifylnd, int alive,
535                         time64_t when);
536 int lnet_add_route(__u32 net, __u32 hops, lnet_nid_t gateway_nid,
537                    __u32 priority, __u32 sensitivity);
538 int lnet_del_route(__u32 net, lnet_nid_t gw_nid);
539 void lnet_move_route(struct lnet_route *route, struct lnet_peer *lp,
540                      struct list_head *rt_list);
541 void lnet_destroy_routes(void);
542 int lnet_get_route(int idx, __u32 *net, __u32 *hops,
543                    lnet_nid_t *gateway, __u32 *alive, __u32 *priority,
544                    __u32 *sensitivity);
545 int lnet_get_rtr_pool_cfg(int idx, struct lnet_ioctl_pool_cfg *pool_cfg);
546 struct lnet_ni *lnet_get_next_ni_locked(struct lnet_net *mynet,
547                                         struct lnet_ni *prev);
548 struct lnet_ni *lnet_get_ni_idx_locked(int idx);
549 int lnet_get_net_healthv_locked(struct lnet_net *net);
550
551 extern int libcfs_ioctl_getdata(struct libcfs_ioctl_hdr **hdr_pp,
552                                 struct libcfs_ioctl_hdr __user *uparam);
553 extern int lnet_get_peer_list(__u32 *countp, __u32 *sizep,
554                               struct lnet_process_id __user *ids);
555 extern void lnet_peer_ni_set_healthv(lnet_nid_t nid, int value, bool all);
556 extern void lnet_peer_ni_add_to_recoveryq_locked(struct lnet_peer_ni *lpni,
557                                                  struct list_head *queue,
558                                                  time64_t now);
559 extern int lnet_peer_add_pref_nid(struct lnet_peer_ni *lpni, lnet_nid_t nid);
560 extern void lnet_peer_clr_pref_nids(struct lnet_peer_ni *lpni);
561 extern int lnet_peer_del_pref_nid(struct lnet_peer_ni *lpni, lnet_nid_t nid);
562 void lnet_peer_ni_set_selection_priority(struct lnet_peer_ni *lpni,
563                                          __u32 priority);
564
565 void lnet_router_debugfs_init(void);
566 void lnet_router_debugfs_fini(void);
567 int  lnet_rtrpools_alloc(int im_a_router);
568 void lnet_destroy_rtrbuf(struct lnet_rtrbuf *rb, int npages);
569 int  lnet_rtrpools_adjust(int tiny, int small, int large);
570 int lnet_rtrpools_enable(void);
571 void lnet_rtrpools_disable(void);
572 void lnet_rtrpools_free(int keep_pools);
573 void lnet_rtr_transfer_to_peer(struct lnet_peer *src,
574                                struct lnet_peer *target);
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 void lnet_net_clr_pref_rtrs(struct lnet_net *net);
583 int lnet_net_add_pref_rtr(struct lnet_net *net, lnet_nid_t gw_nid);
584
585 int lnet_islocalnid(lnet_nid_t nid);
586 int lnet_islocalnet(__u32 net);
587 int lnet_islocalnet_locked(__u32 net);
588
589 void lnet_msg_attach_md(struct lnet_msg *msg, struct lnet_libmd *md,
590                         unsigned int offset, unsigned int mlen);
591 void lnet_build_unlink_event(struct lnet_libmd *md, struct lnet_event *ev);
592 void lnet_build_msg_event(struct lnet_msg *msg, enum lnet_event_kind ev_type);
593 void lnet_msg_commit(struct lnet_msg *msg, int cpt);
594 void lnet_msg_decommit(struct lnet_msg *msg, int cpt, int status);
595
596 void lnet_prep_send(struct lnet_msg *msg, int type,
597                     struct lnet_process_id target, unsigned int offset,
598                     unsigned int len);
599 int lnet_send(lnet_nid_t nid, struct lnet_msg *msg, lnet_nid_t rtr_nid);
600 int lnet_send_ping(lnet_nid_t dest_nid, struct lnet_handle_md *mdh, int nnis,
601                    void *user_ptr, lnet_handler_t handler, bool recovery);
602 void lnet_return_tx_credits_locked(struct lnet_msg *msg);
603 void lnet_return_rx_credits_locked(struct lnet_msg *msg);
604 void lnet_schedule_blocked_locked(struct lnet_rtrbufpool *rbp);
605 void lnet_drop_routed_msgs_locked(struct list_head *list, int cpt);
606
607 struct list_head **lnet_create_array_of_queues(void);
608
609 /* portals functions */
610 /* portals attributes */
611 static inline int
612 lnet_ptl_is_lazy(struct lnet_portal *ptl)
613 {
614         return !!(ptl->ptl_options & LNET_PTL_LAZY);
615 }
616
617 static inline int
618 lnet_ptl_is_unique(struct lnet_portal *ptl)
619 {
620         return !!(ptl->ptl_options & LNET_PTL_MATCH_UNIQUE);
621 }
622
623 static inline int
624 lnet_ptl_is_wildcard(struct lnet_portal *ptl)
625 {
626         return !!(ptl->ptl_options & LNET_PTL_MATCH_WILDCARD);
627 }
628
629 static inline void
630 lnet_ptl_setopt(struct lnet_portal *ptl, int opt)
631 {
632         ptl->ptl_options |= opt;
633 }
634
635 static inline void
636 lnet_ptl_unsetopt(struct lnet_portal *ptl, int opt)
637 {
638         ptl->ptl_options &= ~opt;
639 }
640
641 /* match-table functions */
642 struct list_head *lnet_mt_match_head(struct lnet_match_table *mtable,
643                                struct lnet_process_id id, __u64 mbits);
644 struct lnet_match_table *lnet_mt_of_attach(unsigned int index,
645                                            struct lnet_process_id id,
646                                            __u64 mbits, __u64 ignore_bits,
647                                            enum lnet_ins_pos pos);
648 int lnet_mt_match_md(struct lnet_match_table *mtable,
649                      struct lnet_match_info *info, struct lnet_msg *msg);
650
651 /* portals match/attach functions */
652 void lnet_ptl_attach_md(struct lnet_me *me, struct lnet_libmd *md,
653                         struct list_head *matches, struct list_head *drops);
654 void lnet_ptl_detach_md(struct lnet_me *me, struct lnet_libmd *md);
655 int lnet_ptl_match_md(struct lnet_match_info *info, struct lnet_msg *msg);
656
657 /* initialized and finalize portals */
658 int lnet_portals_create(void);
659 void lnet_portals_destroy(void);
660
661 /* message functions */
662 int lnet_parse(struct lnet_ni *ni, struct lnet_hdr *hdr,
663                lnet_nid_t fromnid, void *private, int rdma_req);
664 int lnet_parse_local(struct lnet_ni *ni, struct lnet_msg *msg);
665 int lnet_parse_forward_locked(struct lnet_ni *ni, struct lnet_msg *msg);
666
667 void lnet_recv(struct lnet_ni *ni, void *private, struct lnet_msg *msg,
668                int delayed, unsigned int offset, unsigned int mlen,
669                unsigned int rlen);
670 void lnet_ni_recv(struct lnet_ni *ni, void *private, struct lnet_msg *msg,
671                   int delayed, unsigned int offset,
672                   unsigned int mlen, unsigned int rlen);
673
674 struct lnet_msg *lnet_create_reply_msg(struct lnet_ni *ni,
675                                        struct lnet_msg *get_msg);
676 void lnet_set_reply_msg_len(struct lnet_ni *ni, struct lnet_msg *msg,
677                             unsigned int len);
678 void lnet_detach_rsp_tracker(struct lnet_libmd *md, int cpt);
679 void lnet_clean_zombie_rstqs(void);
680
681 bool lnet_md_discarded(struct lnet_libmd *md);
682 void lnet_finalize(struct lnet_msg *msg, int rc);
683 bool lnet_send_error_simulation(struct lnet_msg *msg,
684                                 enum lnet_msg_hstatus *hstatus);
685 void lnet_handle_remote_failure_locked(struct lnet_peer_ni *lpni);
686
687 void lnet_drop_message(struct lnet_ni *ni, int cpt, void *private,
688                        unsigned int nob, __u32 msg_type);
689 void lnet_drop_delayed_msg_list(struct list_head *head, char *reason);
690 void lnet_recv_delayed_msg_list(struct list_head *head);
691
692 int lnet_msg_container_setup(struct lnet_msg_container *container, int cpt);
693 void lnet_msg_container_cleanup(struct lnet_msg_container *container);
694 void lnet_msg_containers_destroy(void);
695 int lnet_msg_containers_create(void);
696
697 char *lnet_health_error2str(enum lnet_msg_hstatus hstatus);
698 char *lnet_msgtyp2str(int type);
699 int lnet_fail_nid(lnet_nid_t nid, unsigned int threshold);
700
701 /** \addtogroup lnet_fault_simulation @{ */
702
703 int lnet_fault_ctl(int cmd, struct libcfs_ioctl_data *data);
704 int lnet_fault_init(void);
705 void lnet_fault_fini(void);
706
707 bool lnet_drop_rule_match(struct lnet_hdr *hdr, lnet_nid_t local_nid,
708                           enum lnet_msg_hstatus *hstatus);
709
710 int lnet_delay_rule_add(struct lnet_fault_attr *attr);
711 int lnet_delay_rule_del(lnet_nid_t src, lnet_nid_t dst, bool shutdown);
712 int lnet_delay_rule_list(int pos, struct lnet_fault_attr *attr,
713                          struct lnet_fault_stat *stat);
714 void lnet_delay_rule_reset(void);
715 void lnet_delay_rule_check(void);
716 bool lnet_delay_rule_match_locked(struct lnet_hdr *hdr, struct lnet_msg *msg);
717
718 /** @} lnet_fault_simulation */
719
720 void lnet_counters_get_common(struct lnet_counters_common *common);
721 int lnet_counters_get(struct lnet_counters *counters);
722 void lnet_counters_reset(void);
723 static inline void
724 lnet_ni_set_sel_priority_locked(struct lnet_ni *ni, __u32 priority)
725 {
726         ni->ni_sel_priority = priority;
727 }
728
729 static inline void
730 lnet_net_set_sel_priority_locked(struct lnet_net *net, __u32 priority)
731 {
732         net->net_sel_priority = priority;
733 }
734
735 unsigned int lnet_iov_nob(unsigned int niov, struct kvec *iov);
736 unsigned int lnet_kiov_nob(unsigned int niov, struct bio_vec *iov);
737 int lnet_extract_kiov(int dst_niov, struct bio_vec *dst,
738                       int src_niov, struct bio_vec *src,
739                       unsigned int offset, unsigned int len);
740
741 void lnet_copy_iov2iov(unsigned int ndiov, struct kvec *diov,
742                        unsigned int doffset,
743                        unsigned int nsiov, struct kvec *siov,
744                        unsigned int soffset, unsigned int nob);
745 void lnet_copy_kiov2iov(unsigned int niov, struct kvec *iov,
746                         unsigned int iovoffset,
747                         unsigned int nkiov, struct bio_vec *kiov,
748                         unsigned int kiovoffset, unsigned int nob);
749 void lnet_copy_iov2kiov(unsigned int nkiov, struct bio_vec *kiov,
750                         unsigned int kiovoffset,
751                         unsigned int niov, struct kvec *iov,
752                         unsigned int iovoffset, unsigned int nob);
753 void lnet_copy_kiov2kiov(unsigned int ndkiov, struct bio_vec *dkiov,
754                          unsigned int doffset,
755                          unsigned int nskiov, struct bio_vec *skiov,
756                          unsigned int soffset, unsigned int nob);
757
758 static inline void
759 lnet_copy_kiov2flat(int dlen, void *dest, unsigned int doffset,
760                     unsigned int nsiov, struct bio_vec *skiov,
761                     unsigned int soffset, unsigned int nob)
762 {
763         struct kvec diov = { .iov_base = dest, .iov_len = dlen };
764
765         lnet_copy_kiov2iov(1, &diov, doffset,
766                            nsiov, skiov, soffset, nob);
767 }
768
769 static inline void
770 lnet_copy_flat2kiov(unsigned int ndiov, struct bio_vec *dkiov,
771                     unsigned int doffset, int slen, void *src,
772                     unsigned int soffset, unsigned int nob)
773 {
774         struct kvec siov = { .iov_base = src, .iov_len = slen };
775         lnet_copy_iov2kiov(ndiov, dkiov, doffset,
776                            1, &siov, soffset, nob);
777 }
778
779 void lnet_me_unlink(struct lnet_me *me);
780
781 void lnet_md_unlink(struct lnet_libmd *md);
782 void lnet_md_deconstruct(struct lnet_libmd *lmd, struct lnet_event *ev);
783 struct page *lnet_kvaddr_to_page(unsigned long vaddr);
784 int lnet_cpt_of_md(struct lnet_libmd *md, unsigned int offset);
785
786 unsigned int lnet_get_lnd_timeout(void);
787 void lnet_register_lnd(const struct lnet_lnd *lnd);
788 void lnet_unregister_lnd(const struct lnet_lnd *lnd);
789
790 struct socket *lnet_connect(lnet_nid_t peer_nid, int interface,
791                             struct sockaddr *peeraddr, struct net *ns);
792 void lnet_connect_console_error(int rc, lnet_nid_t peer_nid,
793                                 struct sockaddr *sa);
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 struct lnet_inetdev {
801         u32     li_cpt;
802         u32     li_flags;
803         u32     li_ipaddr;
804         u32     li_netmask;
805         char    li_name[IFNAMSIZ];
806 };
807
808 int lnet_inet_enumerate(struct lnet_inetdev **dev_list, struct net *ns);
809 void lnet_sock_setbuf(struct socket *socket, int txbufsize, int rxbufsize);
810 void lnet_sock_getbuf(struct socket *socket, int *txbufsize, int *rxbufsize);
811 int lnet_sock_getaddr(struct socket *socket, bool remote,
812                       struct sockaddr_storage *peer);
813 int lnet_sock_write(struct socket *sock, void *buffer, int nob, int timeout);
814 int lnet_sock_read(struct socket *sock, void *buffer, int nob, int timeout);
815
816 struct socket *lnet_sock_listen(int port, int backlog,
817                                 struct net *ns);
818 struct socket *lnet_sock_connect(int interface, int local_port,
819                                  struct sockaddr *peeraddr,
820                                  struct net *ns);
821
822 int lnet_peers_start_down(void);
823 int lnet_peer_buffer_credits(struct lnet_net *net);
824 void lnet_consolidate_routes_locked(struct lnet_peer *orig_lp,
825                                     struct lnet_peer *new_lp);
826 void lnet_router_discovery_complete(struct lnet_peer *lp);
827 void lnet_router_discovery_ping_reply(struct lnet_peer *lp);
828
829 int lnet_monitor_thr_start(void);
830 void lnet_monitor_thr_stop(void);
831
832 bool lnet_router_checker_active(void);
833 void lnet_check_routers(void);
834 void lnet_wait_router_start(void);
835 void lnet_swap_pinginfo(struct lnet_ping_buffer *pbuf);
836
837 int lnet_ping_info_validate(struct lnet_ping_info *pinfo);
838 struct lnet_ping_buffer *lnet_ping_buffer_alloc(int nnis, gfp_t gfp);
839 void lnet_ping_buffer_free(struct lnet_ping_buffer *pbuf);
840
841 static inline void lnet_ping_buffer_addref(struct lnet_ping_buffer *pbuf)
842 {
843         atomic_inc(&pbuf->pb_refcnt);
844 }
845
846 static inline void lnet_ping_buffer_decref(struct lnet_ping_buffer *pbuf)
847 {
848         if (atomic_dec_and_test(&pbuf->pb_refcnt)) {
849                 wake_up_var(&pbuf->pb_refcnt);
850                 lnet_ping_buffer_free(pbuf);
851         }
852 }
853
854 static inline int lnet_push_target_resize_needed(void)
855 {
856         return the_lnet.ln_push_target->pb_nnis < the_lnet.ln_push_target_nnis;
857 }
858
859 int lnet_push_target_resize(void);
860 int lnet_push_target_post(struct lnet_ping_buffer *pbuf,
861                           struct lnet_handle_md *mdh);
862 void lnet_peer_push_event(struct lnet_event *ev);
863
864 int lnet_parse_ip2nets(const char **networksp, const char *ip2nets);
865 int lnet_parse_routes(const char *route_str, int *im_a_router);
866 int lnet_parse_networks(struct list_head *nilist, const char *networks);
867 bool lnet_net_unique(__u32 net_id, struct list_head *nilist,
868                      struct lnet_net **net);
869 bool lnet_ni_unique_net(struct list_head *nilist, char *iface);
870 void lnet_incr_dlc_seq(void);
871 __u32 lnet_get_dlc_seq_locked(void);
872 int lnet_get_net_count(void);
873 extern unsigned int lnet_current_net_count;
874
875 struct lnet_peer_net *lnet_get_next_peer_net_locked(struct lnet_peer *lp,
876                                                     __u32 prev_lpn_id);
877 struct lnet_peer_ni *lnet_get_next_peer_ni_locked(struct lnet_peer *peer,
878                                                   struct lnet_peer_net *peer_net,
879                                                   struct lnet_peer_ni *prev);
880 struct lnet_peer_ni *lnet_nid2peerni_locked(lnet_nid_t nid, lnet_nid_t pref,
881                                         int cpt);
882 struct lnet_peer_ni *lnet_nid2peerni_ex(lnet_nid_t nid, int cpt);
883 struct lnet_peer_ni *lnet_peer_get_ni_locked(struct lnet_peer *lp,
884                                              lnet_nid_t nid);
885 struct lnet_peer_ni *lnet_find_peer_ni_locked(lnet_nid_t nid);
886 struct lnet_peer *lnet_find_peer(lnet_nid_t nid);
887 void lnet_peer_net_added(struct lnet_net *net);
888 lnet_nid_t lnet_peer_primary_nid_locked(lnet_nid_t nid);
889 int lnet_discover_peer_locked(struct lnet_peer_ni *lpni, int cpt, bool block);
890 void lnet_peer_queue_message(struct lnet_peer *lp, struct lnet_msg *msg);
891 int lnet_peer_discovery_start(void);
892 void lnet_peer_discovery_stop(void);
893 void lnet_push_update_to_peers(int force);
894 void lnet_peer_tables_cleanup(struct lnet_net *net);
895 void lnet_peer_uninit(void);
896 int lnet_peer_tables_create(void);
897 void lnet_debug_peer(lnet_nid_t nid);
898 struct lnet_peer_net *lnet_peer_get_net_locked(struct lnet_peer *peer,
899                                                __u32 net_id);
900 bool lnet_peer_is_pref_nid_locked(struct lnet_peer_ni *lpni, lnet_nid_t nid);
901 int lnet_peer_add_pref_nid(struct lnet_peer_ni *lpni, lnet_nid_t nid);
902 void lnet_peer_clr_pref_nids(struct lnet_peer_ni *lpni);
903 bool lnet_peer_is_pref_rtr_locked(struct lnet_peer_ni *lpni, lnet_nid_t gw_nid);
904 void lnet_peer_clr_pref_rtrs(struct lnet_peer_ni *lpni);
905 int lnet_peer_add_pref_rtr(struct lnet_peer_ni *lpni, lnet_nid_t nid);
906 int lnet_peer_ni_set_non_mr_pref_nid(struct lnet_peer_ni *lpni, lnet_nid_t nid);
907 int lnet_add_peer_ni(lnet_nid_t key_nid, lnet_nid_t nid, bool mr);
908 int lnet_del_peer_ni(lnet_nid_t key_nid, lnet_nid_t nid);
909 int lnet_get_peer_info(struct lnet_ioctl_peer_cfg *cfg, void __user *bulk);
910 int lnet_get_peer_ni_info(__u32 peer_index, __u64 *nid,
911                           char alivness[LNET_MAX_STR_LEN],
912                           __u32 *cpt_iter, __u32 *refcount,
913                           __u32 *ni_peer_tx_credits, __u32 *peer_tx_credits,
914                           __u32 *peer_rtr_credits, __u32 *peer_min_rtr_credtis,
915                           __u32 *peer_tx_qnob);
916 int lnet_get_peer_ni_hstats(struct lnet_ioctl_peer_ni_hstats *stats);
917
918 static inline void
919 lnet_peer_net_set_sel_priority_locked(struct lnet_peer_net *lpn, __u32 priority)
920 {
921         lpn->lpn_sel_priority = priority;
922 }
923
924
925 static inline struct lnet_peer_net *
926 lnet_find_peer_net_locked(struct lnet_peer *peer, __u32 net_id)
927 {
928         struct lnet_peer_net *peer_net;
929
930         list_for_each_entry(peer_net, &peer->lp_peer_nets, lpn_peer_nets) {
931                 if (peer_net->lpn_net_id == net_id)
932                         return peer_net;
933         }
934
935         return NULL;
936 }
937
938 static inline bool
939 lnet_peer_is_multi_rail(struct lnet_peer *lp)
940 {
941         if (lp->lp_state & LNET_PEER_MULTI_RAIL)
942                 return true;
943         return false;
944 }
945
946 static inline bool
947 lnet_peer_ni_is_configured(struct lnet_peer_ni *lpni)
948 {
949         if (lpni->lpni_peer_net->lpn_peer->lp_state & LNET_PEER_CONFIGURED)
950                 return true;
951         return false;
952 }
953
954 static inline bool
955 lnet_peer_ni_is_primary(struct lnet_peer_ni *lpni)
956 {
957         return lpni->lpni_nid == lpni->lpni_peer_net->lpn_peer->lp_primary_nid;
958 }
959
960 bool lnet_peer_is_uptodate(struct lnet_peer *lp);
961 bool lnet_peer_is_uptodate_locked(struct lnet_peer *lp);
962 bool lnet_is_discovery_disabled(struct lnet_peer *lp);
963 bool lnet_is_discovery_disabled_locked(struct lnet_peer *lp);
964 bool lnet_peer_gw_discovery(struct lnet_peer *lp);
965
966 static inline bool
967 lnet_peer_needs_push(struct lnet_peer *lp)
968 {
969         if (!(lp->lp_state & LNET_PEER_MULTI_RAIL))
970                 return false;
971         if (lp->lp_state & LNET_PEER_MARK_DELETED)
972                 return false;
973         if (lp->lp_state & LNET_PEER_FORCE_PUSH)
974                 return true;
975         if (lp->lp_state & LNET_PEER_NO_DISCOVERY)
976                 return false;
977         /* if discovery is not enabled then no need to push */
978         if (lnet_peer_discovery_disabled)
979                 return false;
980         if (lp->lp_node_seqno < atomic_read(&the_lnet.ln_ping_target_seqno))
981                 return true;
982         return false;
983 }
984
985 #define LNET_RECOVERY_INTERVAL_MAX 900
986 static inline unsigned int
987 lnet_get_next_recovery_ping(unsigned int ping_count, time64_t now)
988 {
989         unsigned int interval;
990
991         /* 2^9 = 512, 2^10 = 1024 */
992         if (ping_count > 9)
993                 interval = LNET_RECOVERY_INTERVAL_MAX;
994         else
995                 interval = 1 << ping_count;
996
997         return now + interval;
998 }
999
1000 static inline void
1001 lnet_peer_ni_set_next_ping(struct lnet_peer_ni *lpni, time64_t now)
1002 {
1003         lpni->lpni_next_ping =
1004                 lnet_get_next_recovery_ping(lpni->lpni_ping_count, now);
1005 }
1006
1007 /*
1008  * A peer NI is alive if it satisfies the following two conditions:
1009  *  1. peer NI health >= LNET_MAX_HEALTH_VALUE * router_sensitivity_percentage
1010  *  2. the cached NI status received when we discover the peer is UP
1011  */
1012 static inline bool
1013 lnet_is_peer_ni_alive(struct lnet_peer_ni *lpni)
1014 {
1015         bool halive = false;
1016
1017         halive = (atomic_read(&lpni->lpni_healthv) >=
1018                  (LNET_MAX_HEALTH_VALUE * router_sensitivity_percentage / 100));
1019
1020         return halive && lpni->lpni_ns_status == LNET_NI_STATUS_UP;
1021 }
1022
1023 static inline void
1024 lnet_update_peer_net_healthv(struct lnet_peer_ni *lpni)
1025 {
1026         struct lnet_peer_net *lpn;
1027         int best_healthv = 0;
1028
1029         lpn = lpni->lpni_peer_net;
1030
1031         list_for_each_entry(lpni, &lpn->lpn_peer_nis, lpni_peer_nis) {
1032                 int lpni_healthv = atomic_read(&lpni->lpni_healthv);
1033                 if (best_healthv < lpni_healthv)
1034                         best_healthv = lpni_healthv;
1035         }
1036
1037         lpn->lpn_healthv = best_healthv;
1038 }
1039
1040 static inline void
1041 lnet_set_lpni_healthv_locked(struct lnet_peer_ni *lpni, int value)
1042 {
1043         if (atomic_read(&lpni->lpni_healthv) == value)
1044                 return;
1045         atomic_set(&lpni->lpni_healthv, value);
1046         lnet_update_peer_net_healthv(lpni);
1047 }
1048
1049 static inline bool
1050 lnet_atomic_add_unless_max(atomic_t *v, int a, int u)
1051 {
1052         int c = atomic_read(v);
1053         bool mod = false;
1054         int old;
1055         int m;
1056
1057         if (c == u)
1058                 return mod;
1059
1060         for (;;) {
1061                 if (c + a >= u)
1062                         m = u;
1063                 else
1064                         m = c + a;
1065                 old = atomic_cmpxchg(v, c, m);
1066
1067                 if (old == u)
1068                         break;
1069
1070                 if (old == c) {
1071                         mod = true;
1072                         break;
1073                 }
1074                 c = old;
1075         }
1076
1077         return mod;
1078 }
1079
1080 static inline void
1081 lnet_inc_lpni_healthv_locked(struct lnet_peer_ni *lpni, int value)
1082 {
1083         /* only adjust the net health if the lpni health value changed */
1084         if (lnet_atomic_add_unless_max(&lpni->lpni_healthv, value,
1085                                        LNET_MAX_HEALTH_VALUE))
1086                 lnet_update_peer_net_healthv(lpni);
1087 }
1088
1089 static inline void
1090 lnet_inc_healthv(atomic_t *healthv, int value)
1091 {
1092         lnet_atomic_add_unless_max(healthv, value, LNET_MAX_HEALTH_VALUE);
1093 }
1094
1095 static inline int
1096 lnet_get_list_len(struct list_head *list)
1097 {
1098         struct list_head *l;
1099         int count = 0;
1100
1101         list_for_each(l, list)
1102                 count++;
1103
1104         return count;
1105 }
1106
1107 void lnet_incr_stats(struct lnet_element_stats *stats,
1108                      enum lnet_msg_type msg_type,
1109                      enum lnet_stats_type stats_type);
1110
1111 __u32 lnet_sum_stats(struct lnet_element_stats *stats,
1112                      enum lnet_stats_type stats_type);
1113
1114 void lnet_usr_translate_stats(struct lnet_ioctl_element_msg_stats *msg_stats,
1115                               struct lnet_element_stats *stats);
1116
1117 static inline void
1118 lnet_set_route_aliveness(struct lnet_route *route, bool alive)
1119 {
1120         bool old = atomic_xchg(&route->lr_alive, alive);
1121
1122         if (old != alive)
1123                 CERROR("route to %s through %s has gone from %s to %s\n",
1124                        libcfs_net2str(route->lr_net),
1125                        libcfs_nid2str(route->lr_gateway->lp_primary_nid),
1126                        old ? "up" : "down",
1127                        alive ? "up" : "down");
1128 }
1129 #endif