4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
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.
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).
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
23 * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Use is subject to license terms.
26 * Copyright (c) 2012, 2017, Intel Corporation.
29 * This file is part of Lustre, http://www.lustre.org/
30 * Lustre is a trademark of Sun Microsystems, Inc.
32 * lnet/include/lnet/lib-lnet.h
34 * Top level include for library side routines
37 #ifndef __LNET_LIB_LNET_H__
38 #define __LNET_LIB_LNET_H__
41 #define CFS_FAIL_PTLRPC_OST_BULK_CB2 0xe000
43 #include <linux/netdevice.h>
45 #include <libcfs/libcfs.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>
53 extern struct lnet the_lnet; /* THE network */
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
59 #else /* 64-bit system */
61 * 256 CPTs for thousands of CPUs, allowing more CPTs might make us
62 * under risk of consuming all lh_cookie.
64 # define LNET_CPT_MAX_BITS 8
65 #endif /* BITS_PER_LONG == 32 */
67 /* max allowed CPT number */
68 #define LNET_CPT_MAX (1 << LNET_CPT_MAX_BITS)
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)
75 #define LNET_LOCK_EX CFS_PERCPT_LOCK_EX
77 /* default timeout and credits */
78 #define DEFAULT_PEER_TIMEOUT 180
79 #define DEFAULT_PEER_CREDITS 8
80 #define DEFAULT_CREDITS 256
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)
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)
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.
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)
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))
110 int choose_ipv4_src(__u32 *ret,
111 int interface, __u32 dst_ipaddr, struct net *ns);
113 bool lnet_is_route_alive(struct lnet_route *route);
114 bool lnet_is_gateway_alive(struct lnet_peer *gw);
116 static inline int lnet_is_wire_handle_none(struct lnet_handle_wire *wh)
118 return (wh->wh_interface_cookie == LNET_WIRE_HANDLE_COOKIE_NONE &&
119 wh->wh_object_cookie == LNET_WIRE_HANDLE_COOKIE_NONE);
122 static inline int lnet_md_exhausted(struct lnet_libmd *md)
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));
129 static inline int lnet_md_unlinkable(struct lnet_libmd *md)
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.
136 if (md->md_refcount != 0)
139 if ((md->md_flags & LNET_MD_FLAG_ZOMBIE) != 0)
142 return ((md->md_flags & LNET_MD_FLAG_AUTO_UNLINK) != 0 &&
143 lnet_md_exhausted(md));
146 #define lnet_cpt_table() (the_lnet.ln_cpt_table)
147 #define lnet_cpt_current() cfs_cpt_current(the_lnet.ln_cpt_table, 1)
150 lnet_cpt_of_cookie(__u64 cookie)
152 unsigned int cpt = (cookie >> LNET_COOKIE_TYPE_BITS) & LNET_CPT_MASK;
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;
160 lnet_res_lock(int cpt)
162 cfs_percpt_lock(the_lnet.ln_res_lock, cpt);
166 lnet_res_unlock(int cpt)
168 cfs_percpt_unlock(the_lnet.ln_res_lock, cpt);
172 lnet_res_lock_current(void)
174 int cpt = lnet_cpt_current();
181 lnet_net_lock(int cpt)
183 cfs_percpt_lock(the_lnet.ln_net_lock, cpt);
187 lnet_net_unlock(int cpt)
189 cfs_percpt_unlock(the_lnet.ln_net_lock, cpt);
193 lnet_net_lock_current(void)
195 int cpt = lnet_cpt_current();
201 #define LNET_LOCK() lnet_net_lock(LNET_LOCK_EX)
202 #define LNET_UNLOCK() lnet_net_unlock(LNET_LOCK_EX)
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)
209 #define MAX_PORTALS 64
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
215 extern struct kmem_cache *lnet_udsp_cachep;
216 extern struct kmem_cache *lnet_rspt_cachep;
217 extern struct kmem_cache *lnet_msg_cachep;
220 lnet_ni_set_status_locked(struct lnet_ni *ni, __u32 status)
221 __must_hold(&ni->ni_lock)
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;
237 lnet_ni_set_status(struct lnet_ni *ni, __u32 status)
242 update = lnet_ni_set_status_locked(ni, status);
248 static inline void lnet_md_wait_handling(struct lnet_libmd *md, int cpt)
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;
255 struct wait_bit_queue entry;
256 wait_queue_entry_t *wqe = &entry.wait;
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.
265 lnet_res_unlock(cpt);
267 /* Cannot check md now, it might be freed. Caller
268 * must reclaim reference and check.
272 finish_wait(wq, wqe);
276 lnet_md_free(struct lnet_libmd *md)
280 LASSERTF(md->md_rspt_ptr == NULL, "md %p rsp %p\n", md, md->md_rspt_ptr);
282 size = offsetof(struct lnet_libmd, md_kiov[md->md_niov]);
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);
288 LIBCFS_FREE(md, size);
292 struct lnet_libhandle *lnet_res_lh_lookup(struct lnet_res_container *rec,
294 void lnet_res_lh_initialize(struct lnet_res_container *rec,
295 struct lnet_libhandle *lh);
297 lnet_res_lh_invalidate(struct lnet_libhandle *lh)
299 /* ALWAYS called with resource lock held */
300 /* NB: cookie is still useful, don't reset it */
301 list_del(&lh->lh_hash_chain);
305 lnet_md2handle(struct lnet_handle_md *handle, struct lnet_libmd *md)
307 handle->cookie = md->md_lh.lh_cookie;
310 static inline struct lnet_libmd *
311 lnet_handle2md(struct lnet_handle_md *handle)
313 /* ALWAYS called with resource lock held */
314 struct lnet_libhandle *lh;
317 cpt = lnet_cpt_of_cookie(handle->cookie);
318 lh = lnet_res_lh_lookup(the_lnet.ln_md_containers[cpt],
323 return lh_entry(lh, struct lnet_libmd, md_lh);
326 static inline struct lnet_libmd *
327 lnet_wire_handle2md(struct lnet_handle_wire *wh)
329 /* ALWAYS called with resource lock held */
330 struct lnet_libhandle *lh;
333 if (wh->wh_interface_cookie != the_lnet.ln_interface_cookie)
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);
342 return lh_entry(lh, struct lnet_libmd, md_lh);
346 lnet_peer_net_addref_locked(struct lnet_peer_net *lpn)
348 atomic_inc(&lpn->lpn_refcount);
351 extern void lnet_destroy_peer_net_locked(struct lnet_peer_net *lpn);
354 lnet_peer_net_decref_locked(struct lnet_peer_net *lpn)
356 if (atomic_dec_and_test(&lpn->lpn_refcount))
357 lnet_destroy_peer_net_locked(lpn);
361 lnet_peer_addref_locked(struct lnet_peer *lp)
363 atomic_inc(&lp->lp_refcount);
366 extern void lnet_destroy_peer_locked(struct lnet_peer *lp);
369 lnet_peer_decref_locked(struct lnet_peer *lp)
371 if (atomic_dec_and_test(&lp->lp_refcount))
372 lnet_destroy_peer_locked(lp);
376 lnet_peer_ni_addref_locked(struct lnet_peer_ni *lp)
378 LASSERT(atomic_read(&lp->lpni_refcount) > 0);
379 atomic_inc(&lp->lpni_refcount);
382 extern void lnet_destroy_peer_ni_locked(struct lnet_peer_ni *lp);
385 lnet_peer_ni_decref_locked(struct lnet_peer_ni *lp)
387 LASSERT(atomic_read(&lp->lpni_refcount) > 0);
388 if (atomic_dec_and_test(&lp->lpni_refcount))
389 lnet_destroy_peer_ni_locked(lp);
393 lnet_isrouter(struct lnet_peer_ni *lpni)
395 return lpni->lpni_peer_net->lpn_peer->lp_rtr_refcount != 0;
399 lnet_ni_addref_locked(struct lnet_ni *ni, int cpt)
401 LASSERT(cpt >= 0 && cpt < LNET_CPT_NUMBER);
402 LASSERT(*ni->ni_refs[cpt] >= 0);
404 (*ni->ni_refs[cpt])++;
408 lnet_ni_addref(struct lnet_ni *ni)
411 lnet_ni_addref_locked(ni, 0);
416 lnet_ni_decref_locked(struct lnet_ni *ni, int cpt)
418 LASSERT(cpt >= 0 && cpt < LNET_CPT_NUMBER);
419 LASSERT(*ni->ni_refs[cpt] > 0);
421 (*ni->ni_refs[cpt])--;
425 lnet_ni_decref(struct lnet_ni *ni)
428 lnet_ni_decref_locked(ni, 0);
432 static inline struct lnet_msg *
435 struct lnet_msg *msg;
437 msg = kmem_cache_zalloc(lnet_msg_cachep, GFP_NOFS);
443 lnet_msg_free(struct lnet_msg *msg)
445 LASSERT(!msg->msg_onactivelist);
446 kmem_cache_free(lnet_msg_cachep, msg);
449 static inline struct lnet_rsp_tracker *
450 lnet_rspt_alloc(int cpt)
452 struct lnet_rsp_tracker *rspt;
454 rspt = kmem_cache_zalloc(lnet_rspt_cachep, GFP_NOFS);
457 the_lnet.ln_counters[cpt]->lct_health.lch_rst_alloc++;
458 lnet_net_unlock(cpt);
460 CDEBUG(D_MALLOC, "rspt alloc %p\n", rspt);
465 lnet_rspt_free(struct lnet_rsp_tracker *rspt, int cpt)
467 CDEBUG(D_MALLOC, "rspt free %p\n", rspt);
469 kmem_cache_free(lnet_rspt_cachep, rspt);
471 the_lnet.ln_counters[cpt]->lct_health.lch_rst_alloc--;
472 lnet_net_unlock(cpt);
475 void lnet_ni_free(struct lnet_ni *ni);
476 void lnet_net_free(struct lnet_net *net);
479 lnet_net_alloc(__u32 net_type, struct list_head *netlist);
482 lnet_ni_alloc(struct lnet_net *net, struct cfs_expr_list *el,
485 lnet_ni_alloc_w_cpt_array(struct lnet_net *net, __u32 *cpts, __u32 ncpts,
489 lnet_nid2peerhash(lnet_nid_t nid)
491 return hash_long(nid, LNET_PEER_HASH_BITS);
494 static inline struct list_head *
495 lnet_net2rnethash(__u32 net)
497 return &the_lnet.ln_remote_nets_hash[(LNET_NETNUM(net) +
499 ((1U << the_lnet.ln_remote_nets_hbits) - 1)];
502 extern const struct lnet_lnd the_lolnd;
503 extern int avoid_asym_router_failure;
505 extern unsigned int lnet_nid_cpt_hash(lnet_nid_t nid, unsigned int number);
506 extern int lnet_cpt_of_nid_locked(lnet_nid_t nid, struct lnet_ni *ni);
507 extern int lnet_cpt_of_nid(lnet_nid_t nid, struct lnet_ni *ni);
508 extern struct lnet_ni *lnet_nid2ni_locked(lnet_nid_t nid, int cpt);
509 extern struct lnet_ni *lnet_nid2ni_addref(lnet_nid_t nid);
510 extern struct lnet_ni *lnet_net2ni_locked(__u32 net, int cpt);
511 extern struct lnet_ni *lnet_net2ni_addref(__u32 net);
512 struct lnet_net *lnet_get_net_locked(__u32 net_id);
514 int lnet_lib_init(void);
515 void lnet_lib_exit(void);
517 extern unsigned int lnet_response_tracking;
518 extern unsigned lnet_transaction_timeout;
519 extern unsigned lnet_retry_count;
520 extern unsigned int lnet_lnd_timeout;
521 extern unsigned int lnet_numa_range;
522 extern unsigned int lnet_health_sensitivity;
523 extern unsigned int lnet_recovery_interval;
524 extern unsigned int lnet_recovery_limit;
525 extern unsigned int lnet_peer_discovery_disabled;
526 extern unsigned int lnet_drop_asym_route;
527 extern unsigned int router_sensitivity_percentage;
528 extern int alive_router_check_interval;
529 extern int live_router_check_interval;
530 extern int dead_router_check_interval;
531 extern int portal_rotor;
533 void lnet_mt_event_handler(struct lnet_event *event);
535 int lnet_notify(struct lnet_ni *ni, lnet_nid_t peer, bool alive, bool reset,
537 void lnet_notify_locked(struct lnet_peer_ni *lp, int notifylnd, int alive,
539 int lnet_add_route(__u32 net, __u32 hops, lnet_nid_t gateway_nid,
540 __u32 priority, __u32 sensitivity);
541 int lnet_del_route(__u32 net, lnet_nid_t gw_nid);
542 void lnet_move_route(struct lnet_route *route, struct lnet_peer *lp,
543 struct list_head *rt_list);
544 void lnet_destroy_routes(void);
545 int lnet_get_route(int idx, __u32 *net, __u32 *hops,
546 lnet_nid_t *gateway, __u32 *alive, __u32 *priority,
548 int lnet_get_rtr_pool_cfg(int idx, struct lnet_ioctl_pool_cfg *pool_cfg);
549 struct lnet_ni *lnet_get_next_ni_locked(struct lnet_net *mynet,
550 struct lnet_ni *prev);
551 struct lnet_ni *lnet_get_ni_idx_locked(int idx);
552 int lnet_get_net_healthv_locked(struct lnet_net *net);
554 extern int libcfs_ioctl_getdata(struct libcfs_ioctl_hdr **hdr_pp,
555 struct libcfs_ioctl_hdr __user *uparam);
556 extern int lnet_get_peer_list(__u32 *countp, __u32 *sizep,
557 struct lnet_process_id __user *ids);
558 extern void lnet_peer_ni_set_healthv(lnet_nid_t nid, int value, bool all);
559 extern void lnet_peer_ni_add_to_recoveryq_locked(struct lnet_peer_ni *lpni,
560 struct list_head *queue,
562 extern int lnet_peer_add_pref_nid(struct lnet_peer_ni *lpni, lnet_nid_t nid);
563 extern void lnet_peer_clr_pref_nids(struct lnet_peer_ni *lpni);
564 extern int lnet_peer_del_pref_nid(struct lnet_peer_ni *lpni, lnet_nid_t nid);
565 void lnet_peer_ni_set_selection_priority(struct lnet_peer_ni *lpni,
568 void lnet_router_debugfs_init(void);
569 void lnet_router_debugfs_fini(void);
570 int lnet_rtrpools_alloc(int im_a_router);
571 void lnet_destroy_rtrbuf(struct lnet_rtrbuf *rb, int npages);
572 int lnet_rtrpools_adjust(int tiny, int small, int large);
573 int lnet_rtrpools_enable(void);
574 void lnet_rtrpools_disable(void);
575 void lnet_rtrpools_free(int keep_pools);
576 void lnet_rtr_transfer_to_peer(struct lnet_peer *src,
577 struct lnet_peer *target);
578 struct lnet_remotenet *lnet_find_rnet_locked(__u32 net);
579 int lnet_dyn_add_net(struct lnet_ioctl_config_data *conf);
580 int lnet_dyn_del_net(__u32 net);
581 int lnet_dyn_add_ni(struct lnet_ioctl_config_ni *conf);
582 int lnet_dyn_del_ni(struct lnet_ioctl_config_ni *conf);
583 int lnet_clear_lazy_portal(struct lnet_ni *ni, int portal, char *reason);
584 struct lnet_net *lnet_get_net_locked(__u32 net_id);
585 void lnet_net_clr_pref_rtrs(struct lnet_net *net);
586 int lnet_net_add_pref_rtr(struct lnet_net *net, lnet_nid_t gw_nid);
588 int lnet_islocalnid(lnet_nid_t nid);
589 int lnet_islocalnet(__u32 net);
590 int lnet_islocalnet_locked(__u32 net);
592 void lnet_msg_attach_md(struct lnet_msg *msg, struct lnet_libmd *md,
593 unsigned int offset, unsigned int mlen);
594 void lnet_build_unlink_event(struct lnet_libmd *md, struct lnet_event *ev);
595 void lnet_build_msg_event(struct lnet_msg *msg, enum lnet_event_kind ev_type);
596 void lnet_msg_commit(struct lnet_msg *msg, int cpt);
597 void lnet_msg_decommit(struct lnet_msg *msg, int cpt, int status);
599 void lnet_prep_send(struct lnet_msg *msg, int type,
600 struct lnet_process_id target, unsigned int offset,
602 int lnet_send(lnet_nid_t nid, struct lnet_msg *msg, lnet_nid_t rtr_nid);
603 int lnet_send_ping(lnet_nid_t dest_nid, struct lnet_handle_md *mdh, int nnis,
604 void *user_ptr, lnet_handler_t handler, bool recovery);
605 void lnet_return_tx_credits_locked(struct lnet_msg *msg);
606 void lnet_return_rx_credits_locked(struct lnet_msg *msg);
607 void lnet_schedule_blocked_locked(struct lnet_rtrbufpool *rbp);
608 void lnet_drop_routed_msgs_locked(struct list_head *list, int cpt);
610 struct list_head **lnet_create_array_of_queues(void);
612 /* portals functions */
613 /* portals attributes */
615 lnet_ptl_is_lazy(struct lnet_portal *ptl)
617 return !!(ptl->ptl_options & LNET_PTL_LAZY);
621 lnet_ptl_is_unique(struct lnet_portal *ptl)
623 return !!(ptl->ptl_options & LNET_PTL_MATCH_UNIQUE);
627 lnet_ptl_is_wildcard(struct lnet_portal *ptl)
629 return !!(ptl->ptl_options & LNET_PTL_MATCH_WILDCARD);
633 lnet_ptl_setopt(struct lnet_portal *ptl, int opt)
635 ptl->ptl_options |= opt;
639 lnet_ptl_unsetopt(struct lnet_portal *ptl, int opt)
641 ptl->ptl_options &= ~opt;
644 /* match-table functions */
645 struct list_head *lnet_mt_match_head(struct lnet_match_table *mtable,
646 struct lnet_process_id id, __u64 mbits);
647 struct lnet_match_table *lnet_mt_of_attach(unsigned int index,
648 struct lnet_process_id id,
649 __u64 mbits, __u64 ignore_bits,
650 enum lnet_ins_pos pos);
651 int lnet_mt_match_md(struct lnet_match_table *mtable,
652 struct lnet_match_info *info, struct lnet_msg *msg);
654 /* portals match/attach functions */
655 void lnet_ptl_attach_md(struct lnet_me *me, struct lnet_libmd *md,
656 struct list_head *matches, struct list_head *drops);
657 void lnet_ptl_detach_md(struct lnet_me *me, struct lnet_libmd *md);
658 int lnet_ptl_match_md(struct lnet_match_info *info, struct lnet_msg *msg);
660 /* initialized and finalize portals */
661 int lnet_portals_create(void);
662 void lnet_portals_destroy(void);
664 /* message functions */
665 int lnet_parse(struct lnet_ni *ni, struct lnet_hdr *hdr,
666 lnet_nid_t fromnid, void *private, int rdma_req);
667 int lnet_parse_local(struct lnet_ni *ni, struct lnet_msg *msg);
668 int lnet_parse_forward_locked(struct lnet_ni *ni, struct lnet_msg *msg);
670 void lnet_recv(struct lnet_ni *ni, void *private, struct lnet_msg *msg,
671 int delayed, unsigned int offset, unsigned int mlen,
673 void lnet_ni_recv(struct lnet_ni *ni, void *private, struct lnet_msg *msg,
674 int delayed, unsigned int offset,
675 unsigned int mlen, unsigned int rlen);
677 struct lnet_msg *lnet_create_reply_msg(struct lnet_ni *ni,
678 struct lnet_msg *get_msg);
679 void lnet_set_reply_msg_len(struct lnet_ni *ni, struct lnet_msg *msg,
681 void lnet_detach_rsp_tracker(struct lnet_libmd *md, int cpt);
682 void lnet_clean_zombie_rstqs(void);
684 bool lnet_md_discarded(struct lnet_libmd *md);
685 void lnet_finalize(struct lnet_msg *msg, int rc);
686 bool lnet_send_error_simulation(struct lnet_msg *msg,
687 enum lnet_msg_hstatus *hstatus);
688 void lnet_handle_remote_failure_locked(struct lnet_peer_ni *lpni);
690 void lnet_drop_message(struct lnet_ni *ni, int cpt, void *private,
691 unsigned int nob, __u32 msg_type);
692 void lnet_drop_delayed_msg_list(struct list_head *head, char *reason);
693 void lnet_recv_delayed_msg_list(struct list_head *head);
695 int lnet_msg_container_setup(struct lnet_msg_container *container, int cpt);
696 void lnet_msg_container_cleanup(struct lnet_msg_container *container);
697 void lnet_msg_containers_destroy(void);
698 int lnet_msg_containers_create(void);
700 char *lnet_health_error2str(enum lnet_msg_hstatus hstatus);
701 char *lnet_msgtyp2str(int type);
702 int lnet_fail_nid(lnet_nid_t nid, unsigned int threshold);
704 /** \addtogroup lnet_fault_simulation @{ */
706 int lnet_fault_ctl(int cmd, struct libcfs_ioctl_data *data);
707 int lnet_fault_init(void);
708 void lnet_fault_fini(void);
710 bool lnet_drop_rule_match(struct lnet_hdr *hdr, lnet_nid_t local_nid,
711 enum lnet_msg_hstatus *hstatus);
713 int lnet_delay_rule_add(struct lnet_fault_attr *attr);
714 int lnet_delay_rule_del(lnet_nid_t src, lnet_nid_t dst, bool shutdown);
715 int lnet_delay_rule_list(int pos, struct lnet_fault_attr *attr,
716 struct lnet_fault_stat *stat);
717 void lnet_delay_rule_reset(void);
718 void lnet_delay_rule_check(void);
719 bool lnet_delay_rule_match_locked(struct lnet_hdr *hdr, struct lnet_msg *msg);
721 /** @} lnet_fault_simulation */
723 void lnet_counters_get_common(struct lnet_counters_common *common);
724 int lnet_counters_get(struct lnet_counters *counters);
725 void lnet_counters_reset(void);
727 lnet_ni_set_sel_priority_locked(struct lnet_ni *ni, __u32 priority)
729 ni->ni_sel_priority = priority;
733 lnet_net_set_sel_priority_locked(struct lnet_net *net, __u32 priority)
735 net->net_sel_priority = priority;
738 unsigned int lnet_iov_nob(unsigned int niov, struct kvec *iov);
739 unsigned int lnet_kiov_nob(unsigned int niov, struct bio_vec *iov);
740 int lnet_extract_kiov(int dst_niov, struct bio_vec *dst,
741 int src_niov, struct bio_vec *src,
742 unsigned int offset, unsigned int len);
744 void lnet_copy_iov2iov(unsigned int ndiov, struct kvec *diov,
745 unsigned int doffset,
746 unsigned int nsiov, struct kvec *siov,
747 unsigned int soffset, unsigned int nob);
748 void lnet_copy_kiov2iov(unsigned int niov, struct kvec *iov,
749 unsigned int iovoffset,
750 unsigned int nkiov, struct bio_vec *kiov,
751 unsigned int kiovoffset, unsigned int nob);
752 void lnet_copy_iov2kiov(unsigned int nkiov, struct bio_vec *kiov,
753 unsigned int kiovoffset,
754 unsigned int niov, struct kvec *iov,
755 unsigned int iovoffset, unsigned int nob);
756 void lnet_copy_kiov2kiov(unsigned int ndkiov, struct bio_vec *dkiov,
757 unsigned int doffset,
758 unsigned int nskiov, struct bio_vec *skiov,
759 unsigned int soffset, unsigned int nob);
762 lnet_copy_kiov2flat(int dlen, void *dest, unsigned int doffset,
763 unsigned int nsiov, struct bio_vec *skiov,
764 unsigned int soffset, unsigned int nob)
766 struct kvec diov = { .iov_base = dest, .iov_len = dlen };
768 lnet_copy_kiov2iov(1, &diov, doffset,
769 nsiov, skiov, soffset, nob);
773 lnet_copy_flat2kiov(unsigned int ndiov, struct bio_vec *dkiov,
774 unsigned int doffset, int slen, void *src,
775 unsigned int soffset, unsigned int nob)
777 struct kvec siov = { .iov_base = src, .iov_len = slen };
778 lnet_copy_iov2kiov(ndiov, dkiov, doffset,
779 1, &siov, soffset, nob);
782 void lnet_me_unlink(struct lnet_me *me);
784 void lnet_md_unlink(struct lnet_libmd *md);
785 void lnet_md_deconstruct(struct lnet_libmd *lmd, struct lnet_event *ev);
786 struct page *lnet_kvaddr_to_page(unsigned long vaddr);
787 int lnet_cpt_of_md(struct lnet_libmd *md, unsigned int offset);
789 unsigned int lnet_get_lnd_timeout(void);
790 void lnet_register_lnd(const struct lnet_lnd *lnd);
791 void lnet_unregister_lnd(const struct lnet_lnd *lnd);
793 struct socket *lnet_connect(lnet_nid_t peer_nid, int interface,
794 struct sockaddr *peeraddr, struct net *ns);
795 void lnet_connect_console_error(int rc, lnet_nid_t peer_nid,
796 struct sockaddr *sa);
797 int lnet_count_acceptor_nets(void);
798 int lnet_acceptor_timeout(void);
799 int lnet_acceptor_port(void);
800 int lnet_acceptor_start(void);
801 void lnet_acceptor_stop(void);
803 struct lnet_inetdev {
808 char li_name[IFNAMSIZ];
811 int lnet_inet_enumerate(struct lnet_inetdev **dev_list, struct net *ns);
812 void lnet_sock_setbuf(struct socket *socket, int txbufsize, int rxbufsize);
813 void lnet_sock_getbuf(struct socket *socket, int *txbufsize, int *rxbufsize);
814 int lnet_sock_getaddr(struct socket *socket, bool remote,
815 struct sockaddr_storage *peer);
816 int lnet_sock_write(struct socket *sock, void *buffer, int nob, int timeout);
817 int lnet_sock_read(struct socket *sock, void *buffer, int nob, int timeout);
819 struct socket *lnet_sock_listen(int port, int backlog,
821 struct socket *lnet_sock_connect(int interface, int local_port,
822 struct sockaddr *peeraddr,
825 int lnet_peers_start_down(void);
826 int lnet_peer_buffer_credits(struct lnet_net *net);
827 void lnet_consolidate_routes_locked(struct lnet_peer *orig_lp,
828 struct lnet_peer *new_lp);
829 void lnet_router_discovery_complete(struct lnet_peer *lp);
830 void lnet_router_discovery_ping_reply(struct lnet_peer *lp);
832 int lnet_monitor_thr_start(void);
833 void lnet_monitor_thr_stop(void);
835 bool lnet_router_checker_active(void);
836 void lnet_check_routers(void);
837 void lnet_wait_router_start(void);
838 void lnet_swap_pinginfo(struct lnet_ping_buffer *pbuf);
840 int lnet_ping_info_validate(struct lnet_ping_info *pinfo);
841 struct lnet_ping_buffer *lnet_ping_buffer_alloc(int nnis, gfp_t gfp);
842 void lnet_ping_buffer_free(struct lnet_ping_buffer *pbuf);
844 static inline void lnet_ping_buffer_addref(struct lnet_ping_buffer *pbuf)
846 atomic_inc(&pbuf->pb_refcnt);
849 static inline void lnet_ping_buffer_decref(struct lnet_ping_buffer *pbuf)
851 if (atomic_dec_and_test(&pbuf->pb_refcnt)) {
852 wake_up_var(&pbuf->pb_refcnt);
853 lnet_ping_buffer_free(pbuf);
857 static inline int lnet_push_target_resize_needed(void)
859 return the_lnet.ln_push_target->pb_nnis < the_lnet.ln_push_target_nnis;
862 int lnet_push_target_resize(void);
863 int lnet_push_target_post(struct lnet_ping_buffer *pbuf,
864 struct lnet_handle_md *mdh);
865 void lnet_peer_push_event(struct lnet_event *ev);
867 int lnet_parse_ip2nets(const char **networksp, const char *ip2nets);
868 int lnet_parse_routes(const char *route_str, int *im_a_router);
869 int lnet_parse_networks(struct list_head *nilist, const char *networks,
870 bool use_tcp_bonding);
871 bool lnet_net_unique(__u32 net_id, struct list_head *nilist,
872 struct lnet_net **net);
873 bool lnet_ni_unique_net(struct list_head *nilist, char *iface);
874 void lnet_incr_dlc_seq(void);
875 __u32 lnet_get_dlc_seq_locked(void);
876 int lnet_get_net_count(void);
877 extern unsigned int lnet_current_net_count;
879 struct lnet_peer_net *lnet_get_next_peer_net_locked(struct lnet_peer *lp,
881 struct lnet_peer_ni *lnet_get_next_peer_ni_locked(struct lnet_peer *peer,
882 struct lnet_peer_net *peer_net,
883 struct lnet_peer_ni *prev);
884 struct lnet_peer_ni *lnet_nid2peerni_locked(lnet_nid_t nid, lnet_nid_t pref,
886 struct lnet_peer_ni *lnet_nid2peerni_ex(lnet_nid_t nid, int cpt);
887 struct lnet_peer_ni *lnet_peer_get_ni_locked(struct lnet_peer *lp,
889 struct lnet_peer_ni *lnet_find_peer_ni_locked(lnet_nid_t nid);
890 struct lnet_peer *lnet_find_peer(lnet_nid_t nid);
891 void lnet_peer_net_added(struct lnet_net *net);
892 lnet_nid_t lnet_peer_primary_nid_locked(lnet_nid_t nid);
893 int lnet_discover_peer_locked(struct lnet_peer_ni *lpni, int cpt, bool block);
894 void lnet_peer_queue_message(struct lnet_peer *lp, struct lnet_msg *msg);
895 int lnet_peer_discovery_start(void);
896 void lnet_peer_discovery_stop(void);
897 void lnet_push_update_to_peers(int force);
898 void lnet_peer_tables_cleanup(struct lnet_net *net);
899 void lnet_peer_uninit(void);
900 int lnet_peer_tables_create(void);
901 void lnet_debug_peer(lnet_nid_t nid);
902 struct lnet_peer_net *lnet_peer_get_net_locked(struct lnet_peer *peer,
904 bool lnet_peer_is_pref_nid_locked(struct lnet_peer_ni *lpni, lnet_nid_t nid);
905 int lnet_peer_add_pref_nid(struct lnet_peer_ni *lpni, lnet_nid_t nid);
906 void lnet_peer_clr_pref_nids(struct lnet_peer_ni *lpni);
907 bool lnet_peer_is_pref_rtr_locked(struct lnet_peer_ni *lpni, lnet_nid_t gw_nid);
908 void lnet_peer_clr_pref_rtrs(struct lnet_peer_ni *lpni);
909 int lnet_peer_add_pref_rtr(struct lnet_peer_ni *lpni, lnet_nid_t nid);
910 int lnet_peer_ni_set_non_mr_pref_nid(struct lnet_peer_ni *lpni, lnet_nid_t nid);
911 int lnet_add_peer_ni(lnet_nid_t key_nid, lnet_nid_t nid, bool mr);
912 int lnet_del_peer_ni(lnet_nid_t key_nid, lnet_nid_t nid);
913 int lnet_get_peer_info(struct lnet_ioctl_peer_cfg *cfg, void __user *bulk);
914 int lnet_get_peer_ni_info(__u32 peer_index, __u64 *nid,
915 char alivness[LNET_MAX_STR_LEN],
916 __u32 *cpt_iter, __u32 *refcount,
917 __u32 *ni_peer_tx_credits, __u32 *peer_tx_credits,
918 __u32 *peer_rtr_credits, __u32 *peer_min_rtr_credtis,
919 __u32 *peer_tx_qnob);
920 int lnet_get_peer_ni_hstats(struct lnet_ioctl_peer_ni_hstats *stats);
923 lnet_peer_net_set_sel_priority_locked(struct lnet_peer_net *lpn, __u32 priority)
925 lpn->lpn_sel_priority = priority;
929 static inline struct lnet_peer_net *
930 lnet_find_peer_net_locked(struct lnet_peer *peer, __u32 net_id)
932 struct lnet_peer_net *peer_net;
934 list_for_each_entry(peer_net, &peer->lp_peer_nets, lpn_peer_nets) {
935 if (peer_net->lpn_net_id == net_id)
943 lnet_peer_is_multi_rail(struct lnet_peer *lp)
945 if (lp->lp_state & LNET_PEER_MULTI_RAIL)
951 lnet_peer_ni_is_configured(struct lnet_peer_ni *lpni)
953 if (lpni->lpni_peer_net->lpn_peer->lp_state & LNET_PEER_CONFIGURED)
959 lnet_peer_ni_is_primary(struct lnet_peer_ni *lpni)
961 return lpni->lpni_nid == lpni->lpni_peer_net->lpn_peer->lp_primary_nid;
964 bool lnet_peer_is_uptodate(struct lnet_peer *lp);
965 bool lnet_peer_is_uptodate_locked(struct lnet_peer *lp);
966 bool lnet_is_discovery_disabled(struct lnet_peer *lp);
967 bool lnet_is_discovery_disabled_locked(struct lnet_peer *lp);
968 bool lnet_peer_gw_discovery(struct lnet_peer *lp);
971 lnet_peer_needs_push(struct lnet_peer *lp)
973 if (!(lp->lp_state & LNET_PEER_MULTI_RAIL))
975 if (lp->lp_state & LNET_PEER_MARK_DELETED)
977 if (lp->lp_state & LNET_PEER_FORCE_PUSH)
979 if (lp->lp_state & LNET_PEER_NO_DISCOVERY)
981 /* if discovery is not enabled then no need to push */
982 if (lnet_peer_discovery_disabled)
984 if (lp->lp_node_seqno < atomic_read(&the_lnet.ln_ping_target_seqno))
989 #define LNET_RECOVERY_INTERVAL_MAX 900
990 static inline unsigned int
991 lnet_get_next_recovery_ping(unsigned int ping_count, time64_t now)
993 unsigned int interval;
995 /* 2^9 = 512, 2^10 = 1024 */
997 interval = LNET_RECOVERY_INTERVAL_MAX;
999 interval = 1 << ping_count;
1001 return now + interval;
1005 lnet_peer_ni_set_next_ping(struct lnet_peer_ni *lpni, time64_t now)
1007 lpni->lpni_next_ping =
1008 lnet_get_next_recovery_ping(lpni->lpni_ping_count, now);
1012 * A peer NI is alive if it satisfies the following two conditions:
1013 * 1. peer NI health >= LNET_MAX_HEALTH_VALUE * router_sensitivity_percentage
1014 * 2. the cached NI status received when we discover the peer is UP
1017 lnet_is_peer_ni_alive(struct lnet_peer_ni *lpni)
1019 bool halive = false;
1021 halive = (atomic_read(&lpni->lpni_healthv) >=
1022 (LNET_MAX_HEALTH_VALUE * router_sensitivity_percentage / 100));
1024 return halive && lpni->lpni_ns_status == LNET_NI_STATUS_UP;
1028 lnet_update_peer_net_healthv(struct lnet_peer_ni *lpni)
1030 struct lnet_peer_net *lpn;
1031 int best_healthv = 0;
1033 lpn = lpni->lpni_peer_net;
1035 list_for_each_entry(lpni, &lpn->lpn_peer_nis, lpni_peer_nis) {
1036 int lpni_healthv = atomic_read(&lpni->lpni_healthv);
1037 if (best_healthv < lpni_healthv)
1038 best_healthv = lpni_healthv;
1041 lpn->lpn_healthv = best_healthv;
1045 lnet_set_lpni_healthv_locked(struct lnet_peer_ni *lpni, int value)
1047 if (atomic_read(&lpni->lpni_healthv) == value)
1049 atomic_set(&lpni->lpni_healthv, value);
1050 lnet_update_peer_net_healthv(lpni);
1054 lnet_atomic_add_unless_max(atomic_t *v, int a, int u)
1056 int c = atomic_read(v);
1069 old = atomic_cmpxchg(v, c, m);
1085 lnet_inc_lpni_healthv_locked(struct lnet_peer_ni *lpni, int value)
1087 /* only adjust the net health if the lpni health value changed */
1088 if (lnet_atomic_add_unless_max(&lpni->lpni_healthv, value,
1089 LNET_MAX_HEALTH_VALUE))
1090 lnet_update_peer_net_healthv(lpni);
1094 lnet_inc_healthv(atomic_t *healthv, int value)
1096 lnet_atomic_add_unless_max(healthv, value, LNET_MAX_HEALTH_VALUE);
1100 lnet_get_list_len(struct list_head *list)
1102 struct list_head *l;
1105 list_for_each(l, list)
1111 void lnet_incr_stats(struct lnet_element_stats *stats,
1112 enum lnet_msg_type msg_type,
1113 enum lnet_stats_type stats_type);
1115 __u32 lnet_sum_stats(struct lnet_element_stats *stats,
1116 enum lnet_stats_type stats_type);
1118 void lnet_usr_translate_stats(struct lnet_ioctl_element_msg_stats *msg_stats,
1119 struct lnet_element_stats *stats);