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