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