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