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