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/
31 * lnet/include/lnet/lib-lnet.h
33 * Top level include for library side routines
36 #ifndef __LNET_LIB_LNET_H__
37 #define __LNET_LIB_LNET_H__
40 #define CFS_FAIL_PTLRPC_OST_BULK_CB2 0xe000
42 #include <linux/netdevice.h>
44 #include <libcfs/libcfs.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>
52 extern struct lnet the_lnet; /* THE network */
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
58 #else /* 64-bit system */
60 * 256 CPTs for thousands of CPUs, allowing more CPTs might make us
61 * under risk of consuming all lh_cookie.
63 # define LNET_CPT_MAX_BITS 8
64 #endif /* BITS_PER_LONG == 32 */
66 /* max allowed CPT number */
67 #define LNET_CPT_MAX (1 << LNET_CPT_MAX_BITS)
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)
74 #define LNET_LOCK_EX CFS_PERCPT_LOCK_EX
76 /* default timeout and credits */
77 #define DEFAULT_PEER_TIMEOUT 180
78 #define DEFAULT_PEER_CREDITS 8
79 #define DEFAULT_CREDITS 256
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)
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)
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.
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)
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))
109 int choose_ipv4_src(__u32 *ret,
110 int interface, __u32 dst_ipaddr, struct net *ns);
112 bool lnet_is_route_alive(struct lnet_route *route);
113 bool lnet_is_gateway_alive(struct lnet_peer *gw);
115 static inline int lnet_is_wire_handle_none(struct lnet_handle_wire *wh)
117 return (wh->wh_interface_cookie == LNET_WIRE_HANDLE_COOKIE_NONE &&
118 wh->wh_object_cookie == LNET_WIRE_HANDLE_COOKIE_NONE);
121 static inline int lnet_md_exhausted(struct lnet_libmd *md)
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));
128 static inline int lnet_md_unlinkable(struct lnet_libmd *md)
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.
135 if (md->md_refcount != 0)
138 if ((md->md_flags & LNET_MD_FLAG_ZOMBIE) != 0)
141 return ((md->md_flags & LNET_MD_FLAG_AUTO_UNLINK) != 0 &&
142 lnet_md_exhausted(md));
145 #define lnet_cpt_table() (the_lnet.ln_cpt_table)
146 #define lnet_cpt_current() cfs_cpt_current(the_lnet.ln_cpt_table, 1)
149 lnet_cpt_of_cookie(__u64 cookie)
151 unsigned int cpt = (cookie >> LNET_COOKIE_TYPE_BITS) & LNET_CPT_MASK;
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;
159 lnet_res_lock(int cpt)
161 cfs_percpt_lock(the_lnet.ln_res_lock, cpt);
165 lnet_res_unlock(int cpt)
167 cfs_percpt_unlock(the_lnet.ln_res_lock, cpt);
171 lnet_res_lock_current(void)
173 int cpt = lnet_cpt_current();
180 lnet_net_lock(int cpt)
182 cfs_percpt_lock(the_lnet.ln_net_lock, cpt);
186 lnet_net_unlock(int cpt)
188 cfs_percpt_unlock(the_lnet.ln_net_lock, cpt);
192 lnet_net_lock_current(void)
194 int cpt = lnet_cpt_current();
200 #define LNET_LOCK() lnet_net_lock(LNET_LOCK_EX)
201 #define LNET_UNLOCK() lnet_net_unlock(LNET_LOCK_EX)
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)
208 #define MAX_PORTALS 64
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
214 extern struct kmem_cache *lnet_udsp_cachep;
215 extern struct kmem_cache *lnet_rspt_cachep;
216 extern struct kmem_cache *lnet_msg_cachep;
219 lnet_ni_set_status_locked(struct lnet_ni *ni, __u32 status)
220 __must_hold(&ni->ni_lock)
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;
235 static inline unsigned int
236 lnet_ni_get_status_locked(struct lnet_ni *ni)
237 __must_hold(&ni->ni_lock)
239 if (ni->ni_nid == LNET_NID_LO_0)
240 return LNET_NI_STATUS_UP;
241 else if (atomic_read(&ni->ni_fatal_error_on))
242 return LNET_NI_STATUS_DOWN;
243 else if (ni->ni_status)
244 return ni->ni_status->ns_status;
246 return LNET_NI_STATUS_UP;
250 lnet_ni_set_status(struct lnet_ni *ni, __u32 status)
255 update = lnet_ni_set_status_locked(ni, status);
261 static inline void lnet_md_wait_handling(struct lnet_libmd *md, int cpt)
263 wait_queue_head_t *wq = __var_waitqueue(md);
264 #ifdef HAVE_WAIT_QUEUE_ENTRY
265 struct wait_bit_queue_entry entry;
266 wait_queue_entry_t *wqe = &entry.wq_entry;
268 struct wait_bit_queue entry;
269 wait_queue_entry_t *wqe = &entry.wait;
271 init_wait_var_entry(&entry, md, 0);
272 prepare_to_wait_event(wq, wqe, TASK_IDLE);
273 if (md->md_flags & LNET_MD_FLAG_HANDLING) {
274 /* Race with unlocked call to ->md_handler.
275 * It is safe to drop the res_lock here as the
276 * caller has only just claimed it.
278 lnet_res_unlock(cpt);
280 /* Cannot check md now, it might be freed. Caller
281 * must reclaim reference and check.
285 finish_wait(wq, wqe);
289 lnet_md_free(struct lnet_libmd *md)
293 LASSERTF(md->md_rspt_ptr == NULL, "md %p rsp %p\n", md, md->md_rspt_ptr);
295 size = offsetof(struct lnet_libmd, md_kiov[md->md_niov]);
297 if (size <= LNET_SMALL_MD_SIZE) {
298 CDEBUG(D_MALLOC, "slab-freed 'md' at %p.\n", md);
299 kmem_cache_free(lnet_small_mds_cachep, md);
301 LIBCFS_FREE(md, size);
305 struct lnet_libhandle *lnet_res_lh_lookup(struct lnet_res_container *rec,
307 void lnet_res_lh_initialize(struct lnet_res_container *rec,
308 struct lnet_libhandle *lh);
310 lnet_res_lh_invalidate(struct lnet_libhandle *lh)
312 /* ALWAYS called with resource lock held */
313 /* NB: cookie is still useful, don't reset it */
314 list_del(&lh->lh_hash_chain);
318 lnet_md2handle(struct lnet_handle_md *handle, struct lnet_libmd *md)
320 handle->cookie = md->md_lh.lh_cookie;
323 static inline struct lnet_libmd *
324 lnet_handle2md(struct lnet_handle_md *handle)
326 /* ALWAYS called with resource lock held */
327 struct lnet_libhandle *lh;
330 cpt = lnet_cpt_of_cookie(handle->cookie);
331 lh = lnet_res_lh_lookup(the_lnet.ln_md_containers[cpt],
336 return lh_entry(lh, struct lnet_libmd, md_lh);
339 static inline struct lnet_libmd *
340 lnet_wire_handle2md(struct lnet_handle_wire *wh)
342 /* ALWAYS called with resource lock held */
343 struct lnet_libhandle *lh;
346 if (wh->wh_interface_cookie != the_lnet.ln_interface_cookie)
349 cpt = lnet_cpt_of_cookie(wh->wh_object_cookie);
350 lh = lnet_res_lh_lookup(the_lnet.ln_md_containers[cpt],
351 wh->wh_object_cookie);
355 return lh_entry(lh, struct lnet_libmd, md_lh);
359 lnet_peer_net_addref_locked(struct lnet_peer_net *lpn)
361 atomic_inc(&lpn->lpn_refcount);
364 extern void lnet_destroy_peer_net_locked(struct lnet_peer_net *lpn);
367 lnet_peer_net_decref_locked(struct lnet_peer_net *lpn)
369 if (atomic_dec_and_test(&lpn->lpn_refcount))
370 lnet_destroy_peer_net_locked(lpn);
374 lnet_peer_addref_locked(struct lnet_peer *lp)
376 atomic_inc(&lp->lp_refcount);
379 extern void lnet_destroy_peer_locked(struct lnet_peer *lp);
382 lnet_peer_decref_locked(struct lnet_peer *lp)
384 if (atomic_dec_and_test(&lp->lp_refcount))
385 lnet_destroy_peer_locked(lp);
389 lnet_peer_ni_addref_locked(struct lnet_peer_ni *lp)
391 kref_get(&lp->lpni_kref);
394 extern void lnet_destroy_peer_ni_locked(struct kref *ref);
397 lnet_peer_ni_decref_locked(struct lnet_peer_ni *lp)
399 kref_put(&lp->lpni_kref, lnet_destroy_peer_ni_locked);
403 lnet_isrouter(struct lnet_peer_ni *lpni)
405 return lpni->lpni_peer_net->lpn_peer->lp_rtr_refcount != 0;
409 lnet_ni_addref_locked(struct lnet_ni *ni, int cpt)
411 LASSERT(cpt >= 0 && cpt < LNET_CPT_NUMBER);
412 LASSERT(*ni->ni_refs[cpt] >= 0);
414 (*ni->ni_refs[cpt])++;
418 lnet_ni_addref(struct lnet_ni *ni)
421 lnet_ni_addref_locked(ni, 0);
426 lnet_ni_decref_locked(struct lnet_ni *ni, int cpt)
428 LASSERT(cpt >= 0 && cpt < LNET_CPT_NUMBER);
429 LASSERT(*ni->ni_refs[cpt] > 0);
431 (*ni->ni_refs[cpt])--;
435 lnet_ni_decref(struct lnet_ni *ni)
438 lnet_ni_decref_locked(ni, 0);
442 static inline struct lnet_msg *
445 struct lnet_msg *msg;
447 msg = kmem_cache_zalloc(lnet_msg_cachep, GFP_NOFS);
453 lnet_msg_free(struct lnet_msg *msg)
455 LASSERT(!msg->msg_onactivelist);
456 kmem_cache_free(lnet_msg_cachep, msg);
459 static inline struct lnet_rsp_tracker *
460 lnet_rspt_alloc(int cpt)
462 struct lnet_rsp_tracker *rspt;
464 rspt = kmem_cache_zalloc(lnet_rspt_cachep, GFP_NOFS);
467 the_lnet.ln_counters[cpt]->lct_health.lch_rst_alloc++;
468 lnet_net_unlock(cpt);
470 CDEBUG(D_MALLOC, "rspt alloc %p\n", rspt);
475 lnet_rspt_free(struct lnet_rsp_tracker *rspt, int cpt)
477 CDEBUG(D_MALLOC, "rspt free %p\n", rspt);
479 kmem_cache_free(lnet_rspt_cachep, rspt);
481 the_lnet.ln_counters[cpt]->lct_health.lch_rst_alloc--;
482 lnet_net_unlock(cpt);
485 void lnet_ni_free(struct lnet_ni *ni);
486 void lnet_net_free(struct lnet_net *net);
489 lnet_net_alloc(__u32 net_type, struct list_head *netlist);
492 lnet_ni_alloc(struct lnet_net *net, struct cfs_expr_list *el,
495 lnet_ni_alloc_w_cpt_array(struct lnet_net *net, __u32 *cpts, __u32 ncpts,
499 lnet_nid2peerhash(lnet_nid_t nid)
501 return hash_long(nid, LNET_PEER_HASH_BITS);
504 static inline struct list_head *
505 lnet_net2rnethash(__u32 net)
507 return &the_lnet.ln_remote_nets_hash[(LNET_NETNUM(net) +
509 ((1U << the_lnet.ln_remote_nets_hbits) - 1)];
512 extern const struct lnet_lnd the_lolnd;
513 extern int avoid_asym_router_failure;
515 extern unsigned int lnet_nid_cpt_hash(lnet_nid_t nid, unsigned int number);
516 extern int lnet_cpt_of_nid_locked(lnet_nid_t nid, struct lnet_ni *ni);
517 extern int lnet_cpt_of_nid(lnet_nid_t nid, struct lnet_ni *ni);
518 extern struct lnet_ni *lnet_nid2ni_locked(lnet_nid_t nid, int cpt);
519 extern struct lnet_ni *lnet_nid2ni_addref(lnet_nid_t nid);
520 extern struct lnet_ni *lnet_net2ni_locked(__u32 net, int cpt);
521 extern struct lnet_ni *lnet_net2ni_addref(__u32 net);
522 struct lnet_net *lnet_get_net_locked(__u32 net_id);
524 int lnet_lib_init(void);
525 void lnet_lib_exit(void);
527 extern unsigned int lnet_response_tracking;
528 extern unsigned lnet_transaction_timeout;
529 extern unsigned lnet_retry_count;
530 extern unsigned int lnet_lnd_timeout;
531 extern unsigned int lnet_numa_range;
532 extern unsigned int lnet_health_sensitivity;
533 extern unsigned int lnet_recovery_interval;
534 extern unsigned int lnet_recovery_limit;
535 extern unsigned int lnet_peer_discovery_disabled;
536 extern unsigned int lnet_drop_asym_route;
537 extern unsigned int router_sensitivity_percentage;
538 extern int alive_router_check_interval;
539 extern int live_router_check_interval;
540 extern int dead_router_check_interval;
541 extern int portal_rotor;
543 void lnet_mt_event_handler(struct lnet_event *event);
545 int lnet_notify(struct lnet_ni *ni, lnet_nid_t peer, bool alive, bool reset,
547 void lnet_notify_locked(struct lnet_peer_ni *lp, int notifylnd, int alive,
549 int lnet_add_route(__u32 net, __u32 hops, lnet_nid_t gateway_nid,
550 __u32 priority, __u32 sensitivity);
551 int lnet_del_route(__u32 net, lnet_nid_t gw_nid);
552 void lnet_move_route(struct lnet_route *route, struct lnet_peer *lp,
553 struct list_head *rt_list);
554 void lnet_destroy_routes(void);
555 int lnet_get_route(int idx, __u32 *net, __u32 *hops,
556 lnet_nid_t *gateway, __u32 *alive, __u32 *priority,
558 int lnet_get_rtr_pool_cfg(int idx, struct lnet_ioctl_pool_cfg *pool_cfg);
559 struct lnet_ni *lnet_get_next_ni_locked(struct lnet_net *mynet,
560 struct lnet_ni *prev);
561 struct lnet_ni *lnet_get_ni_idx_locked(int idx);
562 int lnet_get_net_healthv_locked(struct lnet_net *net);
564 extern int libcfs_ioctl_getdata(struct libcfs_ioctl_hdr **hdr_pp,
565 struct libcfs_ioctl_hdr __user *uparam);
566 extern int lnet_get_peer_list(__u32 *countp, __u32 *sizep,
567 struct lnet_process_id __user *ids);
568 extern void lnet_peer_ni_set_healthv(lnet_nid_t nid, int value, bool all);
569 extern void lnet_peer_ni_add_to_recoveryq_locked(struct lnet_peer_ni *lpni,
570 struct list_head *queue,
572 extern int lnet_peer_add_pref_nid(struct lnet_peer_ni *lpni, lnet_nid_t nid);
573 extern void lnet_peer_clr_pref_nids(struct lnet_peer_ni *lpni);
574 extern int lnet_peer_del_pref_nid(struct lnet_peer_ni *lpni, lnet_nid_t nid);
575 void lnet_peer_ni_set_selection_priority(struct lnet_peer_ni *lpni,
577 extern void lnet_ni_add_to_recoveryq_locked(struct lnet_ni *ni,
578 struct list_head *queue,
581 void lnet_router_debugfs_init(void);
582 void lnet_router_debugfs_fini(void);
583 int lnet_rtrpools_alloc(int im_a_router);
584 void lnet_destroy_rtrbuf(struct lnet_rtrbuf *rb, int npages);
585 int lnet_rtrpools_adjust(int tiny, int small, int large);
586 int lnet_rtrpools_enable(void);
587 void lnet_rtrpools_disable(void);
588 void lnet_rtrpools_free(int keep_pools);
589 void lnet_rtr_transfer_to_peer(struct lnet_peer *src,
590 struct lnet_peer *target);
591 struct lnet_remotenet *lnet_find_rnet_locked(__u32 net);
592 int lnet_dyn_add_net(struct lnet_ioctl_config_data *conf);
593 int lnet_dyn_del_net(__u32 net);
594 int lnet_dyn_add_ni(struct lnet_ioctl_config_ni *conf);
595 int lnet_dyn_del_ni(struct lnet_ioctl_config_ni *conf);
596 int lnet_clear_lazy_portal(struct lnet_ni *ni, int portal, char *reason);
597 struct lnet_net *lnet_get_net_locked(__u32 net_id);
598 void lnet_net_clr_pref_rtrs(struct lnet_net *net);
599 int lnet_net_add_pref_rtr(struct lnet_net *net, lnet_nid_t gw_nid);
601 int lnet_islocalnid(lnet_nid_t nid);
602 int lnet_islocalnet(__u32 net);
603 int lnet_islocalnet_locked(__u32 net);
605 void lnet_msg_attach_md(struct lnet_msg *msg, struct lnet_libmd *md,
606 unsigned int offset, unsigned int mlen);
607 void lnet_build_unlink_event(struct lnet_libmd *md, struct lnet_event *ev);
608 void lnet_build_msg_event(struct lnet_msg *msg, enum lnet_event_kind ev_type);
609 void lnet_msg_commit(struct lnet_msg *msg, int cpt);
610 void lnet_msg_decommit(struct lnet_msg *msg, int cpt, int status);
612 void lnet_prep_send(struct lnet_msg *msg, int type,
613 struct lnet_process_id target, unsigned int offset,
615 int lnet_send(lnet_nid_t nid, struct lnet_msg *msg, lnet_nid_t rtr_nid);
616 int lnet_send_ping(lnet_nid_t dest_nid, struct lnet_handle_md *mdh, int nnis,
617 void *user_ptr, lnet_handler_t handler, bool recovery);
618 void lnet_return_tx_credits_locked(struct lnet_msg *msg);
619 void lnet_return_rx_credits_locked(struct lnet_msg *msg);
620 void lnet_schedule_blocked_locked(struct lnet_rtrbufpool *rbp);
621 void lnet_drop_routed_msgs_locked(struct list_head *list, int cpt);
623 struct list_head **lnet_create_array_of_queues(void);
625 /* portals functions */
626 /* portals attributes */
628 lnet_ptl_is_lazy(struct lnet_portal *ptl)
630 return !!(ptl->ptl_options & LNET_PTL_LAZY);
634 lnet_ptl_is_unique(struct lnet_portal *ptl)
636 return !!(ptl->ptl_options & LNET_PTL_MATCH_UNIQUE);
640 lnet_ptl_is_wildcard(struct lnet_portal *ptl)
642 return !!(ptl->ptl_options & LNET_PTL_MATCH_WILDCARD);
646 lnet_ptl_setopt(struct lnet_portal *ptl, int opt)
648 ptl->ptl_options |= opt;
652 lnet_ptl_unsetopt(struct lnet_portal *ptl, int opt)
654 ptl->ptl_options &= ~opt;
657 /* match-table functions */
658 struct list_head *lnet_mt_match_head(struct lnet_match_table *mtable,
659 struct lnet_process_id id, __u64 mbits);
660 struct lnet_match_table *lnet_mt_of_attach(unsigned int index,
661 struct lnet_process_id id,
662 __u64 mbits, __u64 ignore_bits,
663 enum lnet_ins_pos pos);
664 int lnet_mt_match_md(struct lnet_match_table *mtable,
665 struct lnet_match_info *info, struct lnet_msg *msg);
667 /* portals match/attach functions */
668 void lnet_ptl_attach_md(struct lnet_me *me, struct lnet_libmd *md,
669 struct list_head *matches, struct list_head *drops);
670 void lnet_ptl_detach_md(struct lnet_me *me, struct lnet_libmd *md);
671 int lnet_ptl_match_md(struct lnet_match_info *info, struct lnet_msg *msg);
673 /* initialized and finalize portals */
674 int lnet_portals_create(void);
675 void lnet_portals_destroy(void);
677 /* message functions */
678 int lnet_parse(struct lnet_ni *ni, struct lnet_hdr *hdr,
679 lnet_nid_t fromnid, void *private, int rdma_req);
680 int lnet_parse_local(struct lnet_ni *ni, struct lnet_msg *msg);
681 int lnet_parse_forward_locked(struct lnet_ni *ni, struct lnet_msg *msg);
683 void lnet_recv(struct lnet_ni *ni, void *private, struct lnet_msg *msg,
684 int delayed, unsigned int offset, unsigned int mlen,
686 void lnet_ni_recv(struct lnet_ni *ni, void *private, struct lnet_msg *msg,
687 int delayed, unsigned int offset,
688 unsigned int mlen, unsigned int rlen);
689 void lnet_ni_send(struct lnet_ni *ni, struct lnet_msg *msg);
691 struct lnet_msg *lnet_create_reply_msg(struct lnet_ni *ni,
692 struct lnet_msg *get_msg);
693 void lnet_set_reply_msg_len(struct lnet_ni *ni, struct lnet_msg *msg,
695 void lnet_detach_rsp_tracker(struct lnet_libmd *md, int cpt);
696 void lnet_clean_zombie_rstqs(void);
698 bool lnet_md_discarded(struct lnet_libmd *md);
699 void lnet_finalize(struct lnet_msg *msg, int rc);
700 bool lnet_send_error_simulation(struct lnet_msg *msg,
701 enum lnet_msg_hstatus *hstatus);
702 void lnet_handle_remote_failure_locked(struct lnet_peer_ni *lpni);
704 void lnet_drop_message(struct lnet_ni *ni, int cpt, void *private,
705 unsigned int nob, __u32 msg_type);
706 void lnet_drop_delayed_msg_list(struct list_head *head, char *reason);
707 void lnet_recv_delayed_msg_list(struct list_head *head);
709 int lnet_msg_container_setup(struct lnet_msg_container *container, int cpt);
710 void lnet_msg_container_cleanup(struct lnet_msg_container *container);
711 void lnet_msg_containers_destroy(void);
712 int lnet_msg_containers_create(void);
714 char *lnet_health_error2str(enum lnet_msg_hstatus hstatus);
715 char *lnet_msgtyp2str(int type);
716 int lnet_fail_nid(lnet_nid_t nid, unsigned int threshold);
718 /** \addtogroup lnet_fault_simulation @{ */
720 int lnet_fault_ctl(int cmd, struct libcfs_ioctl_data *data);
721 int lnet_fault_init(void);
722 void lnet_fault_fini(void);
724 bool lnet_drop_rule_match(struct lnet_hdr *hdr, lnet_nid_t local_nid,
725 enum lnet_msg_hstatus *hstatus);
727 int lnet_delay_rule_add(struct lnet_fault_attr *attr);
728 int lnet_delay_rule_del(lnet_nid_t src, lnet_nid_t dst, bool shutdown);
729 int lnet_delay_rule_list(int pos, struct lnet_fault_attr *attr,
730 struct lnet_fault_stat *stat);
731 void lnet_delay_rule_reset(void);
732 void lnet_delay_rule_check(void);
733 bool lnet_delay_rule_match_locked(struct lnet_hdr *hdr, struct lnet_msg *msg);
735 /** @} lnet_fault_simulation */
737 void lnet_counters_get_common(struct lnet_counters_common *common);
738 int lnet_counters_get(struct lnet_counters *counters);
739 void lnet_counters_reset(void);
741 lnet_ni_set_sel_priority_locked(struct lnet_ni *ni, __u32 priority)
743 ni->ni_sel_priority = priority;
747 lnet_net_set_sel_priority_locked(struct lnet_net *net, __u32 priority)
749 net->net_sel_priority = priority;
752 unsigned int lnet_iov_nob(unsigned int niov, struct kvec *iov);
753 unsigned int lnet_kiov_nob(unsigned int niov, struct bio_vec *iov);
754 int lnet_extract_kiov(int dst_niov, struct bio_vec *dst,
755 int src_niov, struct bio_vec *src,
756 unsigned int offset, unsigned int len);
758 void lnet_copy_iov2iov(unsigned int ndiov, struct kvec *diov,
759 unsigned int doffset,
760 unsigned int nsiov, struct kvec *siov,
761 unsigned int soffset, unsigned int nob);
762 void lnet_copy_kiov2iov(unsigned int niov, struct kvec *iov,
763 unsigned int iovoffset,
764 unsigned int nkiov, struct bio_vec *kiov,
765 unsigned int kiovoffset, unsigned int nob);
766 void lnet_copy_iov2kiov(unsigned int nkiov, struct bio_vec *kiov,
767 unsigned int kiovoffset,
768 unsigned int niov, struct kvec *iov,
769 unsigned int iovoffset, unsigned int nob);
770 void lnet_copy_kiov2kiov(unsigned int ndkiov, struct bio_vec *dkiov,
771 unsigned int doffset,
772 unsigned int nskiov, struct bio_vec *skiov,
773 unsigned int soffset, unsigned int nob);
776 lnet_copy_kiov2flat(int dlen, void *dest, unsigned int doffset,
777 unsigned int nsiov, struct bio_vec *skiov,
778 unsigned int soffset, unsigned int nob)
780 struct kvec diov = { .iov_base = dest, .iov_len = dlen };
782 lnet_copy_kiov2iov(1, &diov, doffset,
783 nsiov, skiov, soffset, nob);
787 lnet_copy_flat2kiov(unsigned int ndiov, struct bio_vec *dkiov,
788 unsigned int doffset, int slen, void *src,
789 unsigned int soffset, unsigned int nob)
791 struct kvec siov = { .iov_base = src, .iov_len = slen };
792 lnet_copy_iov2kiov(ndiov, dkiov, doffset,
793 1, &siov, soffset, nob);
796 void lnet_me_unlink(struct lnet_me *me);
798 void lnet_md_unlink(struct lnet_libmd *md);
799 void lnet_md_deconstruct(struct lnet_libmd *lmd, struct lnet_event *ev);
800 struct page *lnet_kvaddr_to_page(unsigned long vaddr);
801 struct page *lnet_get_first_page(struct lnet_libmd *md, unsigned int offset);
802 int lnet_cpt_of_md(struct lnet_libmd *md, unsigned int offset);
804 unsigned int lnet_get_lnd_timeout(void);
805 void lnet_register_lnd(const struct lnet_lnd *lnd);
806 void lnet_unregister_lnd(const struct lnet_lnd *lnd);
808 struct socket *lnet_connect(lnet_nid_t peer_nid, int interface,
809 struct sockaddr *peeraddr, struct net *ns);
810 void lnet_connect_console_error(int rc, lnet_nid_t peer_nid,
811 struct sockaddr *sa);
812 int lnet_count_acceptor_nets(void);
813 int lnet_acceptor_timeout(void);
814 int lnet_acceptor_port(void);
815 int lnet_acceptor_start(void);
816 void lnet_acceptor_stop(void);
818 struct lnet_inetdev {
823 char li_name[IFNAMSIZ];
826 int lnet_inet_enumerate(struct lnet_inetdev **dev_list, struct net *ns);
827 void lnet_sock_setbuf(struct socket *socket, int txbufsize, int rxbufsize);
828 void lnet_sock_getbuf(struct socket *socket, int *txbufsize, int *rxbufsize);
829 int lnet_sock_getaddr(struct socket *socket, bool remote,
830 struct sockaddr_storage *peer);
831 int lnet_sock_write(struct socket *sock, void *buffer, int nob, int timeout);
832 int lnet_sock_read(struct socket *sock, void *buffer, int nob, int timeout);
834 struct socket *lnet_sock_listen(int port, int backlog,
836 struct socket *lnet_sock_connect(int interface, int local_port,
837 struct sockaddr *peeraddr,
840 int lnet_peers_start_down(void);
841 int lnet_peer_buffer_credits(struct lnet_net *net);
842 void lnet_consolidate_routes_locked(struct lnet_peer *orig_lp,
843 struct lnet_peer *new_lp);
844 void lnet_router_discovery_complete(struct lnet_peer *lp);
845 void lnet_router_discovery_ping_reply(struct lnet_peer *lp);
847 int lnet_monitor_thr_start(void);
848 void lnet_monitor_thr_stop(void);
850 bool lnet_router_checker_active(void);
851 void lnet_check_routers(void);
852 void lnet_wait_router_start(void);
853 void lnet_swap_pinginfo(struct lnet_ping_buffer *pbuf);
855 int lnet_ping_info_validate(struct lnet_ping_info *pinfo);
856 struct lnet_ping_buffer *lnet_ping_buffer_alloc(int nnis, gfp_t gfp);
857 void lnet_ping_buffer_free(struct lnet_ping_buffer *pbuf);
859 static inline void lnet_ping_buffer_addref(struct lnet_ping_buffer *pbuf)
861 atomic_inc(&pbuf->pb_refcnt);
864 static inline void lnet_ping_buffer_decref(struct lnet_ping_buffer *pbuf)
866 if (atomic_dec_and_test(&pbuf->pb_refcnt)) {
867 wake_up_var(&pbuf->pb_refcnt);
868 lnet_ping_buffer_free(pbuf);
872 static inline int lnet_push_target_resize_needed(void)
874 return the_lnet.ln_push_target->pb_nnis < the_lnet.ln_push_target_nnis;
877 int lnet_push_target_resize(void);
878 int lnet_push_target_post(struct lnet_ping_buffer *pbuf,
879 struct lnet_handle_md *mdh);
880 void lnet_peer_push_event(struct lnet_event *ev);
882 int lnet_parse_ip2nets(const char **networksp, const char *ip2nets);
883 int lnet_parse_routes(const char *route_str, int *im_a_router);
884 int lnet_parse_networks(struct list_head *nilist, const char *networks);
885 bool lnet_net_unique(__u32 net_id, struct list_head *nilist,
886 struct lnet_net **net);
887 bool lnet_ni_unique_net(struct list_head *nilist, char *iface);
888 void lnet_incr_dlc_seq(void);
889 __u32 lnet_get_dlc_seq_locked(void);
891 struct lnet_peer_net *lnet_get_next_peer_net_locked(struct lnet_peer *lp,
893 struct lnet_peer_ni *lnet_get_next_peer_ni_locked(struct lnet_peer *peer,
894 struct lnet_peer_net *peer_net,
895 struct lnet_peer_ni *prev);
896 struct lnet_peer_ni *lnet_nid2peerni_locked(lnet_nid_t nid, lnet_nid_t pref,
898 struct lnet_peer_ni *lnet_nid2peerni_ex(lnet_nid_t nid, int cpt);
899 struct lnet_peer_ni *lnet_peer_get_ni_locked(struct lnet_peer *lp,
901 struct lnet_peer_ni *lnet_find_peer_ni_locked(lnet_nid_t nid);
902 struct lnet_peer *lnet_find_peer(lnet_nid_t nid);
903 void lnet_peer_net_added(struct lnet_net *net);
904 lnet_nid_t lnet_peer_primary_nid_locked(lnet_nid_t nid);
905 int lnet_discover_peer_locked(struct lnet_peer_ni *lpni, int cpt, bool block);
906 void lnet_peer_queue_message(struct lnet_peer *lp, struct lnet_msg *msg);
907 int lnet_peer_discovery_start(void);
908 void lnet_peer_discovery_stop(void);
909 void lnet_push_update_to_peers(int force);
910 void lnet_peer_tables_cleanup(struct lnet_net *net);
911 void lnet_peer_uninit(void);
912 int lnet_peer_tables_create(void);
913 void lnet_debug_peer(lnet_nid_t nid);
914 struct lnet_peer_net *lnet_peer_get_net_locked(struct lnet_peer *peer,
916 bool lnet_peer_is_pref_nid_locked(struct lnet_peer_ni *lpni, lnet_nid_t nid);
917 int lnet_peer_add_pref_nid(struct lnet_peer_ni *lpni, lnet_nid_t nid);
918 void lnet_peer_clr_pref_nids(struct lnet_peer_ni *lpni);
919 bool lnet_peer_is_pref_rtr_locked(struct lnet_peer_ni *lpni, lnet_nid_t gw_nid);
920 void lnet_peer_clr_pref_rtrs(struct lnet_peer_ni *lpni);
921 int lnet_peer_add_pref_rtr(struct lnet_peer_ni *lpni, lnet_nid_t nid);
922 int lnet_peer_ni_set_non_mr_pref_nid(struct lnet_peer_ni *lpni, lnet_nid_t nid);
923 int lnet_add_peer_ni(lnet_nid_t key_nid, lnet_nid_t nid, bool mr);
924 int lnet_del_peer_ni(lnet_nid_t key_nid, lnet_nid_t nid);
925 int lnet_get_peer_info(struct lnet_ioctl_peer_cfg *cfg, void __user *bulk);
926 int lnet_get_peer_ni_info(__u32 peer_index, __u64 *nid,
927 char alivness[LNET_MAX_STR_LEN],
928 __u32 *cpt_iter, __u32 *refcount,
929 __u32 *ni_peer_tx_credits, __u32 *peer_tx_credits,
930 __u32 *peer_rtr_credits, __u32 *peer_min_rtr_credtis,
931 __u32 *peer_tx_qnob);
932 int lnet_get_peer_ni_hstats(struct lnet_ioctl_peer_ni_hstats *stats);
935 lnet_peer_net_set_sel_priority_locked(struct lnet_peer_net *lpn, __u32 priority)
937 lpn->lpn_sel_priority = priority;
941 static inline struct lnet_peer_net *
942 lnet_find_peer_net_locked(struct lnet_peer *peer, __u32 net_id)
944 struct lnet_peer_net *peer_net;
946 list_for_each_entry(peer_net, &peer->lp_peer_nets, lpn_peer_nets) {
947 if (peer_net->lpn_net_id == net_id)
955 lnet_peer_is_multi_rail(struct lnet_peer *lp)
957 if (lp->lp_state & LNET_PEER_MULTI_RAIL)
963 lnet_peer_ni_is_configured(struct lnet_peer_ni *lpni)
965 if (lpni->lpni_peer_net->lpn_peer->lp_state & LNET_PEER_CONFIGURED)
971 lnet_peer_ni_is_primary(struct lnet_peer_ni *lpni)
973 return lpni->lpni_nid == lpni->lpni_peer_net->lpn_peer->lp_primary_nid;
976 bool lnet_peer_is_uptodate(struct lnet_peer *lp);
977 bool lnet_peer_is_uptodate_locked(struct lnet_peer *lp);
978 bool lnet_is_discovery_disabled(struct lnet_peer *lp);
979 bool lnet_is_discovery_disabled_locked(struct lnet_peer *lp);
980 bool lnet_peer_gw_discovery(struct lnet_peer *lp);
983 lnet_peer_needs_push(struct lnet_peer *lp)
985 if (!(lp->lp_state & LNET_PEER_MULTI_RAIL))
987 if (lp->lp_state & LNET_PEER_MARK_DELETED)
989 if (lp->lp_state & LNET_PEER_FORCE_PUSH)
991 if (lp->lp_state & LNET_PEER_NO_DISCOVERY)
993 /* if discovery is not enabled then no need to push */
994 if (lnet_peer_discovery_disabled)
996 if (lp->lp_node_seqno < atomic_read(&the_lnet.ln_ping_target_seqno))
1001 #define LNET_RECOVERY_INTERVAL_MAX 900
1002 static inline unsigned int
1003 lnet_get_next_recovery_ping(unsigned int ping_count, time64_t now)
1005 unsigned int interval;
1007 /* 2^9 = 512, 2^10 = 1024 */
1009 interval = LNET_RECOVERY_INTERVAL_MAX;
1011 interval = 1 << ping_count;
1013 return now + interval;
1017 lnet_peer_ni_set_next_ping(struct lnet_peer_ni *lpni, time64_t now)
1019 lpni->lpni_next_ping =
1020 lnet_get_next_recovery_ping(lpni->lpni_ping_count, now);
1024 lnet_ni_set_next_ping(struct lnet_ni *ni, time64_t now)
1026 ni->ni_next_ping = lnet_get_next_recovery_ping(ni->ni_ping_count, now);
1030 * A peer NI is alive if it satisfies the following two conditions:
1031 * 1. peer NI health >= LNET_MAX_HEALTH_VALUE * router_sensitivity_percentage
1032 * 2. the cached NI status received when we discover the peer is UP
1035 lnet_is_peer_ni_alive(struct lnet_peer_ni *lpni)
1037 bool halive = false;
1039 halive = (atomic_read(&lpni->lpni_healthv) >=
1040 (LNET_MAX_HEALTH_VALUE * router_sensitivity_percentage / 100));
1042 return halive && lpni->lpni_ns_status == LNET_NI_STATUS_UP;
1046 lnet_update_peer_net_healthv(struct lnet_peer_ni *lpni)
1048 struct lnet_peer_net *lpn;
1049 int best_healthv = 0;
1051 lpn = lpni->lpni_peer_net;
1053 list_for_each_entry(lpni, &lpn->lpn_peer_nis, lpni_peer_nis) {
1054 int lpni_healthv = atomic_read(&lpni->lpni_healthv);
1055 if (best_healthv < lpni_healthv)
1056 best_healthv = lpni_healthv;
1059 lpn->lpn_healthv = best_healthv;
1063 lnet_set_lpni_healthv_locked(struct lnet_peer_ni *lpni, int value)
1065 if (atomic_read(&lpni->lpni_healthv) == value)
1067 atomic_set(&lpni->lpni_healthv, value);
1068 lnet_update_peer_net_healthv(lpni);
1072 lnet_atomic_add_unless_max(atomic_t *v, int a, int u)
1074 int c = atomic_read(v);
1087 old = atomic_cmpxchg(v, c, m);
1103 lnet_inc_lpni_healthv_locked(struct lnet_peer_ni *lpni, int value)
1105 /* only adjust the net health if the lpni health value changed */
1106 if (lnet_atomic_add_unless_max(&lpni->lpni_healthv, value,
1107 LNET_MAX_HEALTH_VALUE))
1108 lnet_update_peer_net_healthv(lpni);
1112 lnet_inc_healthv(atomic_t *healthv, int value)
1114 lnet_atomic_add_unless_max(healthv, value, LNET_MAX_HEALTH_VALUE);
1118 lnet_get_list_len(struct list_head *list)
1120 struct list_head *l;
1123 list_for_each(l, list)
1129 void lnet_incr_stats(struct lnet_element_stats *stats,
1130 enum lnet_msg_type msg_type,
1131 enum lnet_stats_type stats_type);
1133 __u32 lnet_sum_stats(struct lnet_element_stats *stats,
1134 enum lnet_stats_type stats_type);
1136 void lnet_usr_translate_stats(struct lnet_ioctl_element_msg_stats *msg_stats,
1137 struct lnet_element_stats *stats);
1140 lnet_set_route_aliveness(struct lnet_route *route, bool alive)
1142 bool old = atomic_xchg(&route->lr_alive, alive);
1145 CERROR("route to %s through %s has gone from %s to %s\n",
1146 libcfs_net2str(route->lr_net),
1147 libcfs_nid2str(route->lr_gateway->lp_primary_nid),
1148 old ? "up" : "down",
1149 alive ? "up" : "down");