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