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 /* default number of connections per peer */
82 #define DEFAULT_CONNS_PER_PEER 0
84 #ifdef HAVE_KERN_SOCK_GETNAME_2ARGS
85 #define lnet_kernel_getpeername(sock, addr, addrlen) \
86 kernel_getpeername(sock, addr)
87 #define lnet_kernel_getsockname(sock, addr, addrlen) \
88 kernel_getsockname(sock, addr)
90 #define lnet_kernel_getpeername(sock, addr, addrlen) \
91 kernel_getpeername(sock, addr, addrlen)
92 #define lnet_kernel_getsockname(sock, addr, addrlen) \
93 kernel_getsockname(sock, addr, addrlen)
97 * kernel 5.3: commit ef11db3310e272d3d8dbe8739e0770820dd20e52
98 * kernel 4.18.0-193.el8:
99 * added in_dev_for_each_ifa_rtnl and in_dev_for_each_ifa_rcu
100 * and removed for_ifa and endfor_ifa.
101 * Use the _rntl variant as the current locking is rtnl.
103 #ifdef HAVE_IN_DEV_FOR_EACH_IFA_RTNL
104 #define DECLARE_CONST_IN_IFADDR(ifa) const struct in_ifaddr *ifa
105 #define endfor_ifa(in_dev)
107 #define DECLARE_CONST_IN_IFADDR(ifa)
108 #define in_dev_for_each_ifa_rtnl(ifa, in_dev) for_ifa((in_dev))
109 #define in_dev_for_each_ifa_rcu(ifa, in_dev) for_ifa((in_dev))
112 int choose_ipv4_src(__u32 *ret,
113 int interface, __u32 dst_ipaddr, struct net *ns);
115 bool lnet_is_route_alive(struct lnet_route *route);
116 bool lnet_is_gateway_alive(struct lnet_peer *gw);
118 static inline int lnet_is_wire_handle_none(struct lnet_handle_wire *wh)
120 return (wh->wh_interface_cookie == LNET_WIRE_HANDLE_COOKIE_NONE &&
121 wh->wh_object_cookie == LNET_WIRE_HANDLE_COOKIE_NONE);
124 static inline int lnet_md_exhausted(struct lnet_libmd *md)
126 return (md->md_threshold == 0 ||
127 ((md->md_options & LNET_MD_MAX_SIZE) != 0 &&
128 md->md_offset + md->md_max_size > md->md_length));
131 static inline int lnet_md_unlinkable(struct lnet_libmd *md)
133 /* Should unlink md when its refcount is 0 and either:
134 * - md has been flagged for deletion (by auto unlink or LNetM[DE]Unlink,
135 * in the latter case md may not be exhausted).
136 * - auto unlink is on and md is exhausted.
138 if (md->md_refcount != 0)
141 if ((md->md_flags & LNET_MD_FLAG_ZOMBIE) != 0)
144 return ((md->md_flags & LNET_MD_FLAG_AUTO_UNLINK) != 0 &&
145 lnet_md_exhausted(md));
148 #define lnet_cpt_table() (the_lnet.ln_cpt_table)
149 #define lnet_cpt_current() cfs_cpt_current(the_lnet.ln_cpt_table, 1)
152 lnet_cpt_of_cookie(__u64 cookie)
154 unsigned int cpt = (cookie >> LNET_COOKIE_TYPE_BITS) & LNET_CPT_MASK;
156 /* LNET_CPT_NUMBER doesn't have to be power2, which means we can
157 * get illegal cpt from it's invalid cookie */
158 return cpt < LNET_CPT_NUMBER ? cpt : cpt % LNET_CPT_NUMBER;
162 lnet_res_lock(int cpt)
164 cfs_percpt_lock(the_lnet.ln_res_lock, cpt);
168 lnet_res_unlock(int cpt)
170 cfs_percpt_unlock(the_lnet.ln_res_lock, cpt);
174 lnet_res_lock_current(void)
176 int cpt = lnet_cpt_current();
183 lnet_net_lock(int cpt)
185 cfs_percpt_lock(the_lnet.ln_net_lock, cpt);
189 lnet_net_unlock(int cpt)
191 cfs_percpt_unlock(the_lnet.ln_net_lock, cpt);
195 lnet_net_lock_current(void)
197 int cpt = lnet_cpt_current();
203 #define LNET_LOCK() lnet_net_lock(LNET_LOCK_EX)
204 #define LNET_UNLOCK() lnet_net_unlock(LNET_LOCK_EX)
206 #define lnet_ptl_lock(ptl) spin_lock(&(ptl)->ptl_lock)
207 #define lnet_ptl_unlock(ptl) spin_unlock(&(ptl)->ptl_lock)
208 #define lnet_ni_lock(ni) spin_lock(&(ni)->ni_lock)
209 #define lnet_ni_unlock(ni) spin_unlock(&(ni)->ni_lock)
211 #define MAX_PORTALS 64
213 #define LNET_SMALL_MD_SIZE offsetof(struct lnet_libmd, md_kiov[1])
214 extern struct kmem_cache *lnet_mes_cachep; /* MEs kmem_cache */
215 extern struct kmem_cache *lnet_small_mds_cachep; /* <= LNET_SMALL_MD_SIZE bytes
217 extern struct kmem_cache *lnet_udsp_cachep;
218 extern struct kmem_cache *lnet_rspt_cachep;
219 extern struct kmem_cache *lnet_msg_cachep;
222 lnet_ni_set_status_locked(struct lnet_ni *ni, __u32 status)
223 __must_hold(&ni->ni_lock)
227 if (ni->ni_status && ni->ni_status->ns_status != status) {
228 CDEBUG(D_NET, "ni %s status changed from %#x to %#x\n",
229 libcfs_nidstr(&ni->ni_nid),
230 ni->ni_status->ns_status, status);
231 ni->ni_status->ns_status = status;
238 static inline unsigned int
239 lnet_ni_get_status_locked(struct lnet_ni *ni)
240 __must_hold(&ni->ni_lock)
242 if (nid_is_lo0(&ni->ni_nid))
243 return LNET_NI_STATUS_UP;
244 else if (atomic_read(&ni->ni_fatal_error_on))
245 return LNET_NI_STATUS_DOWN;
246 else if (ni->ni_status)
247 return ni->ni_status->ns_status;
249 return LNET_NI_STATUS_UP;
253 lnet_ni_set_status(struct lnet_ni *ni, __u32 status)
258 update = lnet_ni_set_status_locked(ni, status);
264 static inline void lnet_md_wait_handling(struct lnet_libmd *md, int cpt)
266 wait_queue_head_t *wq = __var_waitqueue(md);
267 #ifdef HAVE_WAIT_QUEUE_ENTRY
268 struct wait_bit_queue_entry entry;
269 wait_queue_entry_t *wqe = &entry.wq_entry;
271 struct wait_bit_queue entry;
272 wait_queue_entry_t *wqe = &entry.wait;
274 init_wait_var_entry(&entry, md, 0);
275 prepare_to_wait_event(wq, wqe, TASK_IDLE);
276 if (md->md_flags & LNET_MD_FLAG_HANDLING) {
277 /* Race with unlocked call to ->md_handler.
278 * It is safe to drop the res_lock here as the
279 * caller has only just claimed it.
281 lnet_res_unlock(cpt);
283 /* Cannot check md now, it might be freed. Caller
284 * must reclaim reference and check.
288 finish_wait(wq, wqe);
292 lnet_md_free(struct lnet_libmd *md)
296 LASSERTF(md->md_rspt_ptr == NULL, "md %p rsp %p\n", md, md->md_rspt_ptr);
298 size = offsetof(struct lnet_libmd, md_kiov[md->md_niov]);
300 if (size <= LNET_SMALL_MD_SIZE) {
301 CDEBUG(D_MALLOC, "slab-freed 'md' at %p.\n", md);
302 kmem_cache_free(lnet_small_mds_cachep, md);
304 LIBCFS_FREE(md, size);
308 struct lnet_libhandle *lnet_res_lh_lookup(struct lnet_res_container *rec,
310 void lnet_res_lh_initialize(struct lnet_res_container *rec,
311 struct lnet_libhandle *lh);
313 lnet_res_lh_invalidate(struct lnet_libhandle *lh)
315 /* ALWAYS called with resource lock held */
316 /* NB: cookie is still useful, don't reset it */
317 list_del(&lh->lh_hash_chain);
321 lnet_md2handle(struct lnet_handle_md *handle, struct lnet_libmd *md)
323 handle->cookie = md->md_lh.lh_cookie;
326 static inline struct lnet_libmd *
327 lnet_handle2md(struct lnet_handle_md *handle)
329 /* ALWAYS called with resource lock held */
330 struct lnet_libhandle *lh;
333 cpt = lnet_cpt_of_cookie(handle->cookie);
334 lh = lnet_res_lh_lookup(the_lnet.ln_md_containers[cpt],
339 return lh_entry(lh, struct lnet_libmd, md_lh);
342 static inline struct lnet_libmd *
343 lnet_wire_handle2md(struct lnet_handle_wire *wh)
345 /* ALWAYS called with resource lock held */
346 struct lnet_libhandle *lh;
349 if (wh->wh_interface_cookie != the_lnet.ln_interface_cookie)
352 cpt = lnet_cpt_of_cookie(wh->wh_object_cookie);
353 lh = lnet_res_lh_lookup(the_lnet.ln_md_containers[cpt],
354 wh->wh_object_cookie);
358 return lh_entry(lh, struct lnet_libmd, md_lh);
362 lnet_peer_net_addref_locked(struct lnet_peer_net *lpn)
364 atomic_inc(&lpn->lpn_refcount);
367 extern void lnet_destroy_peer_net_locked(struct lnet_peer_net *lpn);
370 lnet_peer_net_decref_locked(struct lnet_peer_net *lpn)
372 if (atomic_dec_and_test(&lpn->lpn_refcount))
373 lnet_destroy_peer_net_locked(lpn);
377 lnet_peer_addref_locked(struct lnet_peer *lp)
379 atomic_inc(&lp->lp_refcount);
382 extern void lnet_destroy_peer_locked(struct lnet_peer *lp);
385 lnet_peer_decref_locked(struct lnet_peer *lp)
387 if (atomic_dec_and_test(&lp->lp_refcount))
388 lnet_destroy_peer_locked(lp);
392 lnet_peer_ni_addref_locked(struct lnet_peer_ni *lp)
394 kref_get(&lp->lpni_kref);
397 extern void lnet_destroy_peer_ni_locked(struct kref *ref);
400 lnet_peer_ni_decref_locked(struct lnet_peer_ni *lp)
402 kref_put(&lp->lpni_kref, lnet_destroy_peer_ni_locked);
406 lnet_isrouter(struct lnet_peer_ni *lpni)
408 return lpni->lpni_peer_net->lpn_peer->lp_rtr_refcount != 0;
412 lnet_ni_addref_locked(struct lnet_ni *ni, int cpt)
414 LASSERT(cpt >= 0 && cpt < LNET_CPT_NUMBER);
415 LASSERT(*ni->ni_refs[cpt] >= 0);
417 (*ni->ni_refs[cpt])++;
421 lnet_ni_addref(struct lnet_ni *ni)
424 lnet_ni_addref_locked(ni, 0);
429 lnet_ni_decref_locked(struct lnet_ni *ni, int cpt)
431 LASSERT(cpt >= 0 && cpt < LNET_CPT_NUMBER);
432 LASSERT(*ni->ni_refs[cpt] > 0);
434 (*ni->ni_refs[cpt])--;
438 lnet_ni_decref(struct lnet_ni *ni)
441 lnet_ni_decref_locked(ni, 0);
445 static inline struct lnet_msg *
448 struct lnet_msg *msg;
450 msg = kmem_cache_zalloc(lnet_msg_cachep, GFP_NOFS);
456 lnet_msg_free(struct lnet_msg *msg)
458 LASSERT(!msg->msg_onactivelist);
459 kmem_cache_free(lnet_msg_cachep, msg);
462 static inline struct lnet_rsp_tracker *
463 lnet_rspt_alloc(int cpt)
465 struct lnet_rsp_tracker *rspt;
467 rspt = kmem_cache_zalloc(lnet_rspt_cachep, GFP_NOFS);
470 the_lnet.ln_counters[cpt]->lct_health.lch_rst_alloc++;
471 lnet_net_unlock(cpt);
473 CDEBUG(D_MALLOC, "rspt alloc %p\n", rspt);
478 lnet_rspt_free(struct lnet_rsp_tracker *rspt, int cpt)
480 CDEBUG(D_MALLOC, "rspt free %p\n", rspt);
482 kmem_cache_free(lnet_rspt_cachep, rspt);
484 the_lnet.ln_counters[cpt]->lct_health.lch_rst_alloc--;
485 lnet_net_unlock(cpt);
488 void lnet_ni_free(struct lnet_ni *ni);
489 void lnet_net_free(struct lnet_net *net);
492 lnet_net_alloc(__u32 net_type, struct list_head *netlist);
495 lnet_ni_alloc(struct lnet_net *net, struct cfs_expr_list *el,
498 lnet_ni_alloc_w_cpt_array(struct lnet_net *net, __u32 *cpts, __u32 ncpts,
502 lnet_nid2peerhash(struct lnet_nid *nid)
507 for (i = 0; i < 4; i++)
508 h = hash_32(nid->nid_addr[i]^h, 32);
509 return hash_32(LNET_NID_NET(nid) ^ h, LNET_PEER_HASH_BITS);
512 static inline struct list_head *
513 lnet_net2rnethash(__u32 net)
515 return &the_lnet.ln_remote_nets_hash[(LNET_NETNUM(net) +
517 ((1U << the_lnet.ln_remote_nets_hbits) - 1)];
520 extern const struct lnet_lnd the_lolnd;
521 extern int avoid_asym_router_failure;
523 extern unsigned int lnet_nid_cpt_hash(struct lnet_nid *nid,
524 unsigned int number);
525 extern int lnet_cpt_of_nid_locked(struct lnet_nid *nid, struct lnet_ni *ni);
526 extern int lnet_cpt_of_nid(lnet_nid_t nid, struct lnet_ni *ni);
527 extern int lnet_nid2cpt(struct lnet_nid *nid, struct lnet_ni *ni);
528 extern struct lnet_ni *lnet_nid2ni_locked(lnet_nid_t nid, int cpt);
529 extern struct lnet_ni *lnet_nid2ni_addref(lnet_nid_t nid);
530 extern struct lnet_ni *lnet_net2ni_locked(__u32 net, int cpt);
531 extern struct lnet_ni *lnet_net2ni_addref(__u32 net);
532 extern struct lnet_ni *lnet_nid_to_ni_addref(struct lnet_nid *nid);
533 struct lnet_net *lnet_get_net_locked(__u32 net_id);
535 int lnet_lib_init(void);
536 void lnet_lib_exit(void);
538 extern unsigned int lnet_response_tracking;
539 extern unsigned lnet_transaction_timeout;
540 extern unsigned lnet_retry_count;
541 extern unsigned int lnet_lnd_timeout;
542 extern unsigned int lnet_numa_range;
543 extern unsigned int lnet_health_sensitivity;
544 extern unsigned int lnet_recovery_interval;
545 extern unsigned int lnet_recovery_limit;
546 extern unsigned int lnet_peer_discovery_disabled;
547 extern unsigned int lnet_drop_asym_route;
548 extern unsigned int router_sensitivity_percentage;
549 extern int alive_router_check_interval;
550 extern int live_router_check_interval;
551 extern int dead_router_check_interval;
552 extern int portal_rotor;
554 void lnet_mt_event_handler(struct lnet_event *event);
556 int lnet_notify(struct lnet_ni *ni, lnet_nid_t peer, bool alive, bool reset,
558 void lnet_notify_locked(struct lnet_peer_ni *lp, int notifylnd, int alive,
560 int lnet_add_route(__u32 net, __u32 hops, struct lnet_nid *gateway,
561 __u32 priority, __u32 sensitivity);
562 int lnet_del_route(__u32 net, lnet_nid_t gw_nid);
563 void lnet_move_route(struct lnet_route *route, struct lnet_peer *lp,
564 struct list_head *rt_list);
565 void lnet_destroy_routes(void);
566 int lnet_get_route(int idx, __u32 *net, __u32 *hops,
567 lnet_nid_t *gateway, __u32 *alive, __u32 *priority,
569 int lnet_get_rtr_pool_cfg(int idx, struct lnet_ioctl_pool_cfg *pool_cfg);
570 struct lnet_ni *lnet_get_next_ni_locked(struct lnet_net *mynet,
571 struct lnet_ni *prev);
572 struct lnet_ni *lnet_get_ni_idx_locked(int idx);
573 int lnet_get_net_healthv_locked(struct lnet_net *net);
575 extern int libcfs_ioctl_getdata(struct libcfs_ioctl_hdr **hdr_pp,
576 struct libcfs_ioctl_hdr __user *uparam);
577 extern int lnet_get_peer_list(__u32 *countp, __u32 *sizep,
578 struct lnet_process_id __user *ids);
579 extern void lnet_peer_ni_set_healthv(lnet_nid_t nid, int value, bool all);
580 extern void lnet_peer_ni_add_to_recoveryq_locked(struct lnet_peer_ni *lpni,
581 struct list_head *queue,
583 extern int lnet_peer_add_pref_nid(struct lnet_peer_ni *lpni, lnet_nid_t nid);
584 extern void lnet_peer_clr_pref_nids(struct lnet_peer_ni *lpni);
585 extern int lnet_peer_del_pref_nid(struct lnet_peer_ni *lpni, lnet_nid_t nid);
586 void lnet_peer_ni_set_selection_priority(struct lnet_peer_ni *lpni,
588 extern void lnet_ni_add_to_recoveryq_locked(struct lnet_ni *ni,
589 struct list_head *queue,
592 void lnet_router_debugfs_init(void);
593 void lnet_router_debugfs_fini(void);
594 int lnet_rtrpools_alloc(int im_a_router);
595 void lnet_destroy_rtrbuf(struct lnet_rtrbuf *rb, int npages);
596 int lnet_rtrpools_adjust(int tiny, int small, int large);
597 int lnet_rtrpools_enable(void);
598 void lnet_rtrpools_disable(void);
599 void lnet_rtrpools_free(int keep_pools);
600 void lnet_rtr_transfer_to_peer(struct lnet_peer *src,
601 struct lnet_peer *target);
602 struct lnet_remotenet *lnet_find_rnet_locked(__u32 net);
603 int lnet_dyn_add_net(struct lnet_ioctl_config_data *conf);
604 int lnet_dyn_del_net(__u32 net);
605 int lnet_dyn_add_ni(struct lnet_ioctl_config_ni *conf);
606 int lnet_dyn_del_ni(struct lnet_ioctl_config_ni *conf);
607 int lnet_clear_lazy_portal(struct lnet_ni *ni, int portal, char *reason);
608 struct lnet_net *lnet_get_net_locked(__u32 net_id);
609 void lnet_net_clr_pref_rtrs(struct lnet_net *net);
610 int lnet_net_add_pref_rtr(struct lnet_net *net, lnet_nid_t gw_nid);
612 int lnet_islocalnid4(lnet_nid_t nid);
613 int lnet_islocalnid(struct lnet_nid *nid);
614 int lnet_islocalnet(__u32 net);
615 int lnet_islocalnet_locked(__u32 net);
617 void lnet_msg_attach_md(struct lnet_msg *msg, struct lnet_libmd *md,
618 unsigned int offset, unsigned int mlen);
619 void lnet_build_unlink_event(struct lnet_libmd *md, struct lnet_event *ev);
620 void lnet_build_msg_event(struct lnet_msg *msg, enum lnet_event_kind ev_type);
621 void lnet_msg_commit(struct lnet_msg *msg, int cpt);
622 void lnet_msg_decommit(struct lnet_msg *msg, int cpt, int status);
624 void lnet_prep_send(struct lnet_msg *msg, int type,
625 struct lnet_process_id target, unsigned int offset,
627 int lnet_send(lnet_nid_t nid, struct lnet_msg *msg, lnet_nid_t rtr_nid);
628 int lnet_send_ping(lnet_nid_t dest_nid, struct lnet_handle_md *mdh, int nnis,
629 void *user_ptr, lnet_handler_t handler, bool recovery);
630 void lnet_return_tx_credits_locked(struct lnet_msg *msg);
631 void lnet_return_rx_credits_locked(struct lnet_msg *msg);
632 void lnet_schedule_blocked_locked(struct lnet_rtrbufpool *rbp);
633 void lnet_drop_routed_msgs_locked(struct list_head *list, int cpt);
635 struct list_head **lnet_create_array_of_queues(void);
637 /* portals functions */
638 /* portals attributes */
640 lnet_ptl_is_lazy(struct lnet_portal *ptl)
642 return !!(ptl->ptl_options & LNET_PTL_LAZY);
646 lnet_ptl_is_unique(struct lnet_portal *ptl)
648 return !!(ptl->ptl_options & LNET_PTL_MATCH_UNIQUE);
652 lnet_ptl_is_wildcard(struct lnet_portal *ptl)
654 return !!(ptl->ptl_options & LNET_PTL_MATCH_WILDCARD);
658 lnet_ptl_setopt(struct lnet_portal *ptl, int opt)
660 ptl->ptl_options |= opt;
664 lnet_ptl_unsetopt(struct lnet_portal *ptl, int opt)
666 ptl->ptl_options &= ~opt;
669 /* match-table functions */
670 struct list_head *lnet_mt_match_head(struct lnet_match_table *mtable,
671 struct lnet_process_id id, __u64 mbits);
672 struct lnet_match_table *lnet_mt_of_attach(unsigned int index,
673 struct lnet_process_id id,
674 __u64 mbits, __u64 ignore_bits,
675 enum lnet_ins_pos pos);
676 int lnet_mt_match_md(struct lnet_match_table *mtable,
677 struct lnet_match_info *info, struct lnet_msg *msg);
679 /* portals match/attach functions */
680 void lnet_ptl_attach_md(struct lnet_me *me, struct lnet_libmd *md,
681 struct list_head *matches, struct list_head *drops);
682 void lnet_ptl_detach_md(struct lnet_me *me, struct lnet_libmd *md);
683 int lnet_ptl_match_md(struct lnet_match_info *info, struct lnet_msg *msg);
685 /* initialized and finalize portals */
686 int lnet_portals_create(void);
687 void lnet_portals_destroy(void);
689 /* message functions */
690 int lnet_parse(struct lnet_ni *ni, struct lnet_hdr *hdr,
691 lnet_nid_t fromnid, void *private, int rdma_req);
692 int lnet_parse_local(struct lnet_ni *ni, struct lnet_msg *msg);
693 int lnet_parse_forward_locked(struct lnet_ni *ni, struct lnet_msg *msg);
695 void lnet_recv(struct lnet_ni *ni, void *private, struct lnet_msg *msg,
696 int delayed, unsigned int offset, unsigned int mlen,
698 void lnet_ni_recv(struct lnet_ni *ni, void *private, struct lnet_msg *msg,
699 int delayed, unsigned int offset,
700 unsigned int mlen, unsigned int rlen);
701 void lnet_ni_send(struct lnet_ni *ni, struct lnet_msg *msg);
703 struct lnet_msg *lnet_create_reply_msg(struct lnet_ni *ni,
704 struct lnet_msg *get_msg);
705 void lnet_set_reply_msg_len(struct lnet_ni *ni, struct lnet_msg *msg,
707 void lnet_detach_rsp_tracker(struct lnet_libmd *md, int cpt);
708 void lnet_clean_zombie_rstqs(void);
710 bool lnet_md_discarded(struct lnet_libmd *md);
711 void lnet_finalize(struct lnet_msg *msg, int rc);
712 bool lnet_send_error_simulation(struct lnet_msg *msg,
713 enum lnet_msg_hstatus *hstatus);
714 void lnet_handle_remote_failure_locked(struct lnet_peer_ni *lpni);
716 void lnet_drop_message(struct lnet_ni *ni, int cpt, void *private,
717 unsigned int nob, __u32 msg_type);
718 void lnet_drop_delayed_msg_list(struct list_head *head, char *reason);
719 void lnet_recv_delayed_msg_list(struct list_head *head);
721 int lnet_msg_container_setup(struct lnet_msg_container *container, int cpt);
722 void lnet_msg_container_cleanup(struct lnet_msg_container *container);
723 void lnet_msg_containers_destroy(void);
724 int lnet_msg_containers_create(void);
726 char *lnet_health_error2str(enum lnet_msg_hstatus hstatus);
727 char *lnet_msgtyp2str(int type);
728 int lnet_fail_nid(lnet_nid_t nid, unsigned int threshold);
730 /** \addtogroup lnet_fault_simulation @{ */
732 int lnet_fault_ctl(int cmd, struct libcfs_ioctl_data *data);
733 int lnet_fault_init(void);
734 void lnet_fault_fini(void);
736 bool lnet_drop_rule_match(struct lnet_hdr *hdr, lnet_nid_t local_nid,
737 enum lnet_msg_hstatus *hstatus);
739 int lnet_delay_rule_add(struct lnet_fault_attr *attr);
740 int lnet_delay_rule_del(lnet_nid_t src, lnet_nid_t dst, bool shutdown);
741 int lnet_delay_rule_list(int pos, struct lnet_fault_attr *attr,
742 struct lnet_fault_stat *stat);
743 void lnet_delay_rule_reset(void);
744 void lnet_delay_rule_check(void);
745 bool lnet_delay_rule_match_locked(struct lnet_hdr *hdr, struct lnet_msg *msg);
747 /** @} lnet_fault_simulation */
749 void lnet_counters_get_common(struct lnet_counters_common *common);
750 int lnet_counters_get(struct lnet_counters *counters);
751 void lnet_counters_reset(void);
753 lnet_ni_set_sel_priority_locked(struct lnet_ni *ni, __u32 priority)
755 ni->ni_sel_priority = priority;
759 lnet_net_set_sel_priority_locked(struct lnet_net *net, __u32 priority)
761 net->net_sel_priority = priority;
764 unsigned int lnet_iov_nob(unsigned int niov, struct kvec *iov);
765 unsigned int lnet_kiov_nob(unsigned int niov, struct bio_vec *iov);
766 int lnet_extract_kiov(int dst_niov, struct bio_vec *dst,
767 int src_niov, struct bio_vec *src,
768 unsigned int offset, unsigned int len);
770 void lnet_copy_iov2iov(unsigned int ndiov, struct kvec *diov,
771 unsigned int doffset,
772 unsigned int nsiov, struct kvec *siov,
773 unsigned int soffset, unsigned int nob);
774 void lnet_copy_kiov2iov(unsigned int niov, struct kvec *iov,
775 unsigned int iovoffset,
776 unsigned int nkiov, struct bio_vec *kiov,
777 unsigned int kiovoffset, unsigned int nob);
778 void lnet_copy_iov2kiov(unsigned int nkiov, struct bio_vec *kiov,
779 unsigned int kiovoffset,
780 unsigned int niov, struct kvec *iov,
781 unsigned int iovoffset, unsigned int nob);
782 void lnet_copy_kiov2kiov(unsigned int ndkiov, struct bio_vec *dkiov,
783 unsigned int doffset,
784 unsigned int nskiov, struct bio_vec *skiov,
785 unsigned int soffset, unsigned int nob);
788 lnet_copy_kiov2flat(int dlen, void *dest, unsigned int doffset,
789 unsigned int nsiov, struct bio_vec *skiov,
790 unsigned int soffset, unsigned int nob)
792 struct kvec diov = { .iov_base = dest, .iov_len = dlen };
794 lnet_copy_kiov2iov(1, &diov, doffset,
795 nsiov, skiov, soffset, nob);
799 lnet_copy_flat2kiov(unsigned int ndiov, struct bio_vec *dkiov,
800 unsigned int doffset, int slen, void *src,
801 unsigned int soffset, unsigned int nob)
803 struct kvec siov = { .iov_base = src, .iov_len = slen };
804 lnet_copy_iov2kiov(ndiov, dkiov, doffset,
805 1, &siov, soffset, nob);
808 void lnet_me_unlink(struct lnet_me *me);
810 void lnet_md_unlink(struct lnet_libmd *md);
811 void lnet_md_deconstruct(struct lnet_libmd *lmd, struct lnet_event *ev);
812 struct page *lnet_kvaddr_to_page(unsigned long vaddr);
813 struct page *lnet_get_first_page(struct lnet_libmd *md, unsigned int offset);
814 int lnet_cpt_of_md(struct lnet_libmd *md, unsigned int offset);
816 unsigned int lnet_get_lnd_timeout(void);
817 void lnet_register_lnd(const struct lnet_lnd *lnd);
818 void lnet_unregister_lnd(const struct lnet_lnd *lnd);
820 struct socket *lnet_connect(struct lnet_nid *peer_nid, int interface,
821 struct sockaddr *peeraddr, struct net *ns);
822 void lnet_connect_console_error(int rc, struct lnet_nid *peer_nid,
823 struct sockaddr *sa);
824 int lnet_count_acceptor_nets(void);
825 int lnet_acceptor_timeout(void);
826 int lnet_acceptor_port(void);
827 int lnet_acceptor_start(void);
828 void lnet_acceptor_stop(void);
830 struct lnet_inetdev {
835 char li_name[IFNAMSIZ];
838 int lnet_inet_enumerate(struct lnet_inetdev **dev_list, struct net *ns);
839 void lnet_sock_setbuf(struct socket *socket, int txbufsize, int rxbufsize);
840 void lnet_sock_getbuf(struct socket *socket, int *txbufsize, int *rxbufsize);
841 int lnet_sock_getaddr(struct socket *socket, bool remote,
842 struct sockaddr_storage *peer);
843 int lnet_sock_write(struct socket *sock, void *buffer, int nob, int timeout);
844 int lnet_sock_read(struct socket *sock, void *buffer, int nob, int timeout);
846 struct socket *lnet_sock_listen(int port, int backlog,
848 struct socket *lnet_sock_connect(int interface, int local_port,
849 struct sockaddr *peeraddr,
852 int lnet_peers_start_down(void);
853 int lnet_peer_buffer_credits(struct lnet_net *net);
854 void lnet_consolidate_routes_locked(struct lnet_peer *orig_lp,
855 struct lnet_peer *new_lp);
856 void lnet_router_discovery_complete(struct lnet_peer *lp);
857 void lnet_router_discovery_ping_reply(struct lnet_peer *lp);
859 int lnet_monitor_thr_start(void);
860 void lnet_monitor_thr_stop(void);
862 bool lnet_router_checker_active(void);
863 void lnet_check_routers(void);
864 void lnet_wait_router_start(void);
865 void lnet_swap_pinginfo(struct lnet_ping_buffer *pbuf);
867 int lnet_ping_info_validate(struct lnet_ping_info *pinfo);
868 struct lnet_ping_buffer *lnet_ping_buffer_alloc(int nnis, gfp_t gfp);
869 void lnet_ping_buffer_free(struct lnet_ping_buffer *pbuf);
871 static inline void lnet_ping_buffer_addref(struct lnet_ping_buffer *pbuf)
873 atomic_inc(&pbuf->pb_refcnt);
876 static inline void lnet_ping_buffer_decref(struct lnet_ping_buffer *pbuf)
878 if (atomic_dec_and_test(&pbuf->pb_refcnt)) {
879 wake_up_var(&pbuf->pb_refcnt);
880 lnet_ping_buffer_free(pbuf);
884 static inline int lnet_push_target_resize_needed(void)
886 return the_lnet.ln_push_target->pb_nnis < the_lnet.ln_push_target_nnis;
889 int lnet_push_target_resize(void);
890 int lnet_push_target_post(struct lnet_ping_buffer *pbuf,
891 struct lnet_handle_md *mdh);
892 void lnet_peer_push_event(struct lnet_event *ev);
894 int lnet_parse_ip2nets(const char **networksp, const char *ip2nets);
895 int lnet_parse_routes(const char *route_str, int *im_a_router);
896 int lnet_parse_networks(struct list_head *nilist, const char *networks);
897 bool lnet_net_unique(__u32 net_id, struct list_head *nilist,
898 struct lnet_net **net);
899 bool lnet_ni_unique_net(struct list_head *nilist, char *iface);
900 void lnet_incr_dlc_seq(void);
901 __u32 lnet_get_dlc_seq_locked(void);
903 struct lnet_peer_net *lnet_get_next_peer_net_locked(struct lnet_peer *lp,
905 struct lnet_peer_ni *lnet_get_next_peer_ni_locked(struct lnet_peer *peer,
906 struct lnet_peer_net *peer_net,
907 struct lnet_peer_ni *prev);
908 struct lnet_peer_ni *lnet_nid2peerni_locked(lnet_nid_t nid, lnet_nid_t pref,
910 struct lnet_peer_ni *lnet_nid2peerni_ex(struct lnet_nid *nid, int cpt);
911 struct lnet_peer_ni *lnet_peer_get_ni_locked(struct lnet_peer *lp,
913 struct lnet_peer_ni *lnet_peer_ni_get_locked(struct lnet_peer *lp,
914 struct lnet_nid *nid);
915 struct lnet_peer_ni *lnet_find_peer_ni_locked(lnet_nid_t nid);
916 struct lnet_peer_ni *lnet_peer_ni_find_locked(struct lnet_nid *nid);
917 struct lnet_peer *lnet_find_peer(lnet_nid_t nid);
918 void lnet_peer_net_added(struct lnet_net *net);
919 lnet_nid_t lnet_peer_primary_nid_locked(lnet_nid_t nid);
920 int lnet_discover_peer_locked(struct lnet_peer_ni *lpni, int cpt, bool block);
921 void lnet_peer_queue_message(struct lnet_peer *lp, struct lnet_msg *msg);
922 int lnet_peer_discovery_start(void);
923 void lnet_peer_discovery_stop(void);
924 void lnet_push_update_to_peers(int force);
925 void lnet_peer_tables_cleanup(struct lnet_net *net);
926 void lnet_peer_uninit(void);
927 int lnet_peer_tables_create(void);
928 void lnet_debug_peer(lnet_nid_t nid);
929 struct lnet_peer_net *lnet_peer_get_net_locked(struct lnet_peer *peer,
931 bool lnet_peer_is_pref_nid_locked(struct lnet_peer_ni *lpni, lnet_nid_t nid);
932 int lnet_peer_add_pref_nid(struct lnet_peer_ni *lpni, lnet_nid_t nid);
933 void lnet_peer_clr_pref_nids(struct lnet_peer_ni *lpni);
934 bool lnet_peer_is_pref_rtr_locked(struct lnet_peer_ni *lpni, lnet_nid_t gw_nid);
935 void lnet_peer_clr_pref_rtrs(struct lnet_peer_ni *lpni);
936 int lnet_peer_add_pref_rtr(struct lnet_peer_ni *lpni, lnet_nid_t nid);
937 int lnet_peer_ni_set_non_mr_pref_nid(struct lnet_peer_ni *lpni, lnet_nid_t nid);
938 int lnet_add_peer_ni(lnet_nid_t key_nid, lnet_nid_t nid, bool mr, bool temp);
939 int lnet_del_peer_ni(lnet_nid_t key_nid, lnet_nid_t nid);
940 int lnet_get_peer_info(struct lnet_ioctl_peer_cfg *cfg, void __user *bulk);
941 int lnet_get_peer_ni_info(__u32 peer_index, __u64 *nid,
942 char alivness[LNET_MAX_STR_LEN],
943 __u32 *cpt_iter, __u32 *refcount,
944 __u32 *ni_peer_tx_credits, __u32 *peer_tx_credits,
945 __u32 *peer_rtr_credits, __u32 *peer_min_rtr_credtis,
946 __u32 *peer_tx_qnob);
947 int lnet_get_peer_ni_hstats(struct lnet_ioctl_peer_ni_hstats *stats);
950 lnet_peer_net_set_sel_priority_locked(struct lnet_peer_net *lpn, __u32 priority)
952 lpn->lpn_sel_priority = priority;
956 static inline struct lnet_peer_net *
957 lnet_find_peer_net_locked(struct lnet_peer *peer, __u32 net_id)
959 struct lnet_peer_net *peer_net;
961 list_for_each_entry(peer_net, &peer->lp_peer_nets, lpn_peer_nets) {
962 if (peer_net->lpn_net_id == net_id)
970 lnet_peer_is_multi_rail(struct lnet_peer *lp)
972 if (lp->lp_state & LNET_PEER_MULTI_RAIL)
978 lnet_peer_ni_is_configured(struct lnet_peer_ni *lpni)
980 if (lpni->lpni_peer_net->lpn_peer->lp_state & LNET_PEER_CONFIGURED)
986 lnet_peer_ni_is_primary(struct lnet_peer_ni *lpni)
988 return nid_same(&lpni->lpni_nid,
989 &lpni->lpni_peer_net->lpn_peer->lp_primary_nid);
992 bool lnet_peer_is_uptodate(struct lnet_peer *lp);
993 bool lnet_peer_is_uptodate_locked(struct lnet_peer *lp);
994 bool lnet_is_discovery_disabled(struct lnet_peer *lp);
995 bool lnet_is_discovery_disabled_locked(struct lnet_peer *lp);
996 bool lnet_peer_gw_discovery(struct lnet_peer *lp);
999 lnet_peer_needs_push(struct lnet_peer *lp)
1001 if (!(lp->lp_state & LNET_PEER_MULTI_RAIL))
1003 if (lp->lp_state & LNET_PEER_MARK_DELETED)
1005 if (lp->lp_state & LNET_PEER_FORCE_PUSH)
1007 if (lp->lp_state & LNET_PEER_NO_DISCOVERY)
1009 /* if discovery is not enabled then no need to push */
1010 if (lnet_peer_discovery_disabled)
1012 if (lp->lp_node_seqno < atomic_read(&the_lnet.ln_ping_target_seqno))
1017 #define LNET_RECOVERY_INTERVAL_MAX 900
1018 static inline unsigned int
1019 lnet_get_next_recovery_ping(unsigned int ping_count, time64_t now)
1021 unsigned int interval;
1023 /* 2^9 = 512, 2^10 = 1024 */
1025 interval = LNET_RECOVERY_INTERVAL_MAX;
1027 interval = 1 << ping_count;
1029 return now + interval;
1033 lnet_peer_ni_set_next_ping(struct lnet_peer_ni *lpni, time64_t now)
1035 lpni->lpni_next_ping =
1036 lnet_get_next_recovery_ping(lpni->lpni_ping_count, now);
1040 lnet_ni_set_next_ping(struct lnet_ni *ni, time64_t now)
1042 ni->ni_next_ping = lnet_get_next_recovery_ping(ni->ni_ping_count, now);
1046 * A peer NI is alive if it satisfies the following two conditions:
1047 * 1. peer NI health >= LNET_MAX_HEALTH_VALUE * router_sensitivity_percentage
1048 * 2. the cached NI status received when we discover the peer is UP
1051 lnet_is_peer_ni_alive(struct lnet_peer_ni *lpni)
1053 bool halive = false;
1055 halive = (atomic_read(&lpni->lpni_healthv) >=
1056 (LNET_MAX_HEALTH_VALUE * router_sensitivity_percentage / 100));
1058 return halive && lpni->lpni_ns_status == LNET_NI_STATUS_UP;
1062 lnet_update_peer_net_healthv(struct lnet_peer_ni *lpni)
1064 struct lnet_peer_net *lpn;
1065 int best_healthv = 0;
1067 lpn = lpni->lpni_peer_net;
1069 list_for_each_entry(lpni, &lpn->lpn_peer_nis, lpni_peer_nis) {
1070 int lpni_healthv = atomic_read(&lpni->lpni_healthv);
1071 if (best_healthv < lpni_healthv)
1072 best_healthv = lpni_healthv;
1075 lpn->lpn_healthv = best_healthv;
1079 lnet_set_lpni_healthv_locked(struct lnet_peer_ni *lpni, int value)
1081 if (atomic_read(&lpni->lpni_healthv) == value)
1083 atomic_set(&lpni->lpni_healthv, value);
1084 lnet_update_peer_net_healthv(lpni);
1088 lnet_atomic_add_unless_max(atomic_t *v, int a, int u)
1090 int c = atomic_read(v);
1103 old = atomic_cmpxchg(v, c, m);
1119 lnet_inc_lpni_healthv_locked(struct lnet_peer_ni *lpni, int value)
1121 /* only adjust the net health if the lpni health value changed */
1122 if (lnet_atomic_add_unless_max(&lpni->lpni_healthv, value,
1123 LNET_MAX_HEALTH_VALUE))
1124 lnet_update_peer_net_healthv(lpni);
1128 lnet_inc_healthv(atomic_t *healthv, int value)
1130 lnet_atomic_add_unless_max(healthv, value, LNET_MAX_HEALTH_VALUE);
1134 lnet_get_list_len(struct list_head *list)
1136 struct list_head *l;
1139 list_for_each(l, list)
1145 void lnet_incr_stats(struct lnet_element_stats *stats,
1146 enum lnet_msg_type msg_type,
1147 enum lnet_stats_type stats_type);
1149 __u32 lnet_sum_stats(struct lnet_element_stats *stats,
1150 enum lnet_stats_type stats_type);
1152 void lnet_usr_translate_stats(struct lnet_ioctl_element_msg_stats *msg_stats,
1153 struct lnet_element_stats *stats);
1156 lnet_set_route_aliveness(struct lnet_route *route, bool alive)
1158 bool old = atomic_xchg(&route->lr_alive, alive);
1161 CERROR("route to %s through %s has gone from %s to %s\n",
1162 libcfs_net2str(route->lr_net),
1163 libcfs_nidstr(&route->lr_gateway->lp_primary_nid),
1164 old ? "up" : "down",
1165 alive ? "up" : "down");