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