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