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