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