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