4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
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.
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).
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.sun.com/software/products/lustre/docs/GPLv2.pdf
20 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
21 * CA 95054 USA or visit www.sun.com if you need additional information or
27 * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
28 * Use is subject to license terms.
30 * Copyright (c) 2012, Intel Corporation.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
36 * lnet/include/lnet/lib-lnet.h
38 * Top level include for library side routines
41 #ifndef __LNET_LIB_LNET_H__
42 #define __LNET_LIB_LNET_H__
44 #include "../libcfs/libcfs.h"
48 #include "lib-types.h"
50 extern lnet_t the_lnet; /* THE network */
52 #if (BITS_PER_LONG == 32)
53 /* 2 CPTs, allowing more CPTs might make us under memory pressure */
54 # define LNET_CPT_MAX_BITS 1
56 #else /* 64-bit system */
58 * 256 CPTs for thousands of CPUs, allowing more CPTs might make us
59 * under risk of consuming all lh_cookie.
61 # define LNET_CPT_MAX_BITS 8
62 #endif /* BITS_PER_LONG == 32 */
64 /* max allowed CPT number */
65 #define LNET_CPT_MAX (1 << LNET_CPT_MAX_BITS)
67 #define LNET_CPT_NUMBER (the_lnet.ln_cpt_number)
68 #define LNET_CPT_BITS (the_lnet.ln_cpt_bits)
69 #define LNET_CPT_MASK ((1ULL << LNET_CPT_BITS) - 1)
72 #define LNET_LOCK_EX CFS_PERCPT_LOCK_EX
74 static inline int lnet_is_wire_handle_none(lnet_handle_wire_t *wh)
76 return (wh->wh_interface_cookie == LNET_WIRE_HANDLE_COOKIE_NONE &&
77 wh->wh_object_cookie == LNET_WIRE_HANDLE_COOKIE_NONE);
80 static inline int lnet_md_exhausted(lnet_libmd_t *md)
82 return (md->md_threshold == 0 ||
83 ((md->md_options & LNET_MD_MAX_SIZE) != 0 &&
84 md->md_offset + md->md_max_size > md->md_length));
87 static inline int lnet_md_unlinkable(lnet_libmd_t *md)
89 /* Should unlink md when its refcount is 0 and either:
90 * - md has been flagged for deletion (by auto unlink or
91 * LNetM[DE]Unlink, in the latter case md may not be exhausted).
92 * - auto unlink is on and md is exhausted.
94 if (md->md_refcount != 0)
97 if ((md->md_flags & LNET_MD_FLAG_ZOMBIE) != 0)
100 return ((md->md_flags & LNET_MD_FLAG_AUTO_UNLINK) != 0 &&
101 lnet_md_exhausted(md));
104 #define lnet_cpt_table() (the_lnet.ln_cpt_table)
105 #define lnet_cpt_current() cfs_cpt_current(the_lnet.ln_cpt_table, 1)
108 lnet_cpt_of_cookie(__u64 cookie)
110 unsigned int cpt = (cookie >> LNET_COOKIE_TYPE_BITS) & LNET_CPT_MASK;
112 /* LNET_CPT_NUMBER doesn't have to be power2, which means we can
113 * get illegal cpt from it's invalid cookie */
114 return cpt < LNET_CPT_NUMBER ? cpt : cpt % LNET_CPT_NUMBER;
118 lnet_res_lock(int cpt)
120 cfs_percpt_lock(the_lnet.ln_res_lock, cpt);
124 lnet_res_unlock(int cpt)
126 cfs_percpt_unlock(the_lnet.ln_res_lock, cpt);
130 lnet_res_lock_current(void)
132 int cpt = lnet_cpt_current();
139 lnet_net_lock(int cpt)
141 cfs_percpt_lock(the_lnet.ln_net_lock, cpt);
145 lnet_net_unlock(int cpt)
147 cfs_percpt_unlock(the_lnet.ln_net_lock, cpt);
151 lnet_net_lock_current(void)
153 int cpt = lnet_cpt_current();
159 #define LNET_LOCK() lnet_net_lock(LNET_LOCK_EX)
160 #define LNET_UNLOCK() lnet_net_unlock(LNET_LOCK_EX)
162 #define lnet_ptl_lock(ptl) spin_lock(&(ptl)->ptl_lock)
163 #define lnet_ptl_unlock(ptl) spin_unlock(&(ptl)->ptl_lock)
164 #define lnet_eq_wait_lock() spin_lock(&the_lnet.ln_eq_wait_lock)
165 #define lnet_eq_wait_unlock() spin_unlock(&the_lnet.ln_eq_wait_lock)
166 #define lnet_ni_lock(ni) spin_lock(&(ni)->ni_lock)
167 #define lnet_ni_unlock(ni) spin_unlock(&(ni)->ni_lock)
169 #define MAX_PORTALS 64
171 static inline lnet_eq_t *
176 LIBCFS_ALLOC(eq, sizeof(*eq));
181 lnet_eq_free(lnet_eq_t *eq)
183 LIBCFS_FREE(eq, sizeof(*eq));
186 static inline lnet_libmd_t *
187 lnet_md_alloc(lnet_md_t *umd)
193 if ((umd->options & LNET_MD_KIOV) != 0) {
195 size = offsetof(lnet_libmd_t, md_iov.kiov[niov]);
197 niov = ((umd->options & LNET_MD_IOVEC) != 0) ?
199 size = offsetof(lnet_libmd_t, md_iov.iov[niov]);
202 LIBCFS_ALLOC(md, size);
205 /* Set here in case of early free */
206 md->md_options = umd->options;
208 INIT_LIST_HEAD(&md->md_list);
215 lnet_md_free(lnet_libmd_t *md)
219 if ((md->md_options & LNET_MD_KIOV) != 0)
220 size = offsetof(lnet_libmd_t, md_iov.kiov[md->md_niov]);
222 size = offsetof(lnet_libmd_t, md_iov.iov[md->md_niov]);
224 LIBCFS_FREE(md, size);
227 static inline lnet_me_t *
232 LIBCFS_ALLOC(me, sizeof(*me));
237 lnet_me_free(lnet_me_t *me)
239 LIBCFS_FREE(me, sizeof(*me));
242 static inline lnet_msg_t *
247 LIBCFS_ALLOC(msg, sizeof(*msg));
249 /* no need to zero, LIBCFS_ALLOC does for us */
254 lnet_msg_free(lnet_msg_t *msg)
256 LASSERT(!msg->msg_onactivelist);
257 LIBCFS_FREE(msg, sizeof(*msg));
260 lnet_libhandle_t *lnet_res_lh_lookup(struct lnet_res_container *rec,
262 void lnet_res_lh_initialize(struct lnet_res_container *rec,
263 lnet_libhandle_t *lh);
265 lnet_res_lh_invalidate(lnet_libhandle_t *lh)
267 /* NB: cookie is still useful, don't reset it */
268 list_del(&lh->lh_hash_chain);
272 lnet_eq2handle(lnet_handle_eq_t *handle, lnet_eq_t *eq)
275 LNetInvalidateHandle(handle);
279 handle->cookie = eq->eq_lh.lh_cookie;
282 static inline lnet_eq_t *
283 lnet_handle2eq(lnet_handle_eq_t *handle)
285 lnet_libhandle_t *lh;
287 lh = lnet_res_lh_lookup(&the_lnet.ln_eq_container, handle->cookie);
291 return lh_entry(lh, lnet_eq_t, eq_lh);
295 lnet_md2handle(lnet_handle_md_t *handle, lnet_libmd_t *md)
297 handle->cookie = md->md_lh.lh_cookie;
300 static inline lnet_libmd_t *
301 lnet_handle2md(lnet_handle_md_t *handle)
303 /* ALWAYS called with resource lock held */
304 lnet_libhandle_t *lh;
307 cpt = lnet_cpt_of_cookie(handle->cookie);
308 lh = lnet_res_lh_lookup(the_lnet.ln_md_containers[cpt],
313 return lh_entry(lh, lnet_libmd_t, md_lh);
316 static inline lnet_libmd_t *
317 lnet_wire_handle2md(lnet_handle_wire_t *wh)
319 /* ALWAYS called with resource lock held */
320 lnet_libhandle_t *lh;
323 if (wh->wh_interface_cookie != the_lnet.ln_interface_cookie)
326 cpt = lnet_cpt_of_cookie(wh->wh_object_cookie);
327 lh = lnet_res_lh_lookup(the_lnet.ln_md_containers[cpt],
328 wh->wh_object_cookie);
332 return lh_entry(lh, lnet_libmd_t, md_lh);
336 lnet_me2handle(lnet_handle_me_t *handle, lnet_me_t *me)
338 handle->cookie = me->me_lh.lh_cookie;
341 static inline lnet_me_t *
342 lnet_handle2me(lnet_handle_me_t *handle)
344 /* ALWAYS called with resource lock held */
345 lnet_libhandle_t *lh;
348 cpt = lnet_cpt_of_cookie(handle->cookie);
349 lh = lnet_res_lh_lookup(the_lnet.ln_me_containers[cpt],
354 return lh_entry(lh, lnet_me_t, me_lh);
358 lnet_peer_addref_locked(lnet_peer_t *lp)
360 LASSERT(lp->lp_refcount > 0);
364 void lnet_destroy_peer_locked(lnet_peer_t *lp);
367 lnet_peer_decref_locked(lnet_peer_t *lp)
369 LASSERT(lp->lp_refcount > 0);
371 if (lp->lp_refcount == 0)
372 lnet_destroy_peer_locked(lp);
376 lnet_isrouter(lnet_peer_t *lp)
378 return lp->lp_rtr_refcount != 0;
382 lnet_ni_addref_locked(lnet_ni_t *ni, int cpt)
384 LASSERT(cpt >= 0 && cpt < LNET_CPT_NUMBER);
385 LASSERT(*ni->ni_refs[cpt] >= 0);
387 (*ni->ni_refs[cpt])++;
391 lnet_ni_addref(lnet_ni_t *ni)
394 lnet_ni_addref_locked(ni, 0);
399 lnet_ni_decref_locked(lnet_ni_t *ni, int cpt)
401 LASSERT(cpt >= 0 && cpt < LNET_CPT_NUMBER);
402 LASSERT(*ni->ni_refs[cpt] > 0);
404 (*ni->ni_refs[cpt])--;
408 lnet_ni_decref(lnet_ni_t *ni)
411 lnet_ni_decref_locked(ni, 0);
415 void lnet_ni_free(lnet_ni_t *ni);
418 lnet_nid2peerhash(lnet_nid_t nid)
420 return hash_long(nid, LNET_PEER_HASH_BITS);
423 static inline struct list_head *
424 lnet_net2rnethash(__u32 net)
426 return &the_lnet.ln_remote_nets_hash[(LNET_NETNUM(net) +
428 ((1U << the_lnet.ln_remote_nets_hbits) - 1)];
431 extern lnd_t the_lolnd;
432 extern int avoid_asym_router_failure;
434 int lnet_cpt_of_nid_locked(lnet_nid_t nid);
435 int lnet_cpt_of_nid(lnet_nid_t nid);
436 lnet_ni_t *lnet_nid2ni_locked(lnet_nid_t nid, int cpt);
437 lnet_ni_t *lnet_net2ni_locked(__u32 net, int cpt);
438 lnet_ni_t *lnet_net2ni(__u32 net);
440 int lnet_notify(lnet_ni_t *ni, lnet_nid_t peer, int alive, unsigned long when);
441 void lnet_notify_locked(lnet_peer_t *lp, int notifylnd, int alive,
443 int lnet_add_route(__u32 net, unsigned int hops, lnet_nid_t gateway_nid,
444 unsigned int priority);
445 int lnet_check_routes(void);
446 int lnet_del_route(__u32 net, lnet_nid_t gw_nid);
447 void lnet_destroy_routes(void);
448 int lnet_get_route(int idx, __u32 *net, __u32 *hops,
449 lnet_nid_t *gateway, __u32 *alive, __u32 *priority);
450 void lnet_proc_init(void);
451 void lnet_proc_fini(void);
452 int lnet_rtrpools_alloc(int im_a_router);
453 void lnet_rtrpools_free(void);
454 lnet_remotenet_t *lnet_find_net_locked(__u32 net);
456 int lnet_islocalnid(lnet_nid_t nid);
457 int lnet_islocalnet(__u32 net);
459 void lnet_msg_attach_md(lnet_msg_t *msg, lnet_libmd_t *md,
460 unsigned int offset, unsigned int mlen);
461 void lnet_msg_detach_md(lnet_msg_t *msg, int status);
462 void lnet_build_unlink_event(lnet_libmd_t *md, lnet_event_t *ev);
463 void lnet_build_msg_event(lnet_msg_t *msg, lnet_event_kind_t ev_type);
464 void lnet_msg_commit(lnet_msg_t *msg, int cpt);
465 void lnet_msg_decommit(lnet_msg_t *msg, int cpt, int status);
467 void lnet_eq_enqueue_event(lnet_eq_t *eq, lnet_event_t *ev);
468 void lnet_prep_send(lnet_msg_t *msg, int type, lnet_process_id_t target,
469 unsigned int offset, unsigned int len);
470 int lnet_send(lnet_nid_t nid, lnet_msg_t *msg, lnet_nid_t rtr_nid);
471 void lnet_return_tx_credits_locked(lnet_msg_t *msg);
472 void lnet_return_rx_credits_locked(lnet_msg_t *msg);
474 /* portals functions */
475 /* portals attributes */
477 lnet_ptl_is_lazy(lnet_portal_t *ptl)
479 return !!(ptl->ptl_options & LNET_PTL_LAZY);
483 lnet_ptl_is_unique(lnet_portal_t *ptl)
485 return !!(ptl->ptl_options & LNET_PTL_MATCH_UNIQUE);
489 lnet_ptl_is_wildcard(lnet_portal_t *ptl)
491 return !!(ptl->ptl_options & LNET_PTL_MATCH_WILDCARD);
495 lnet_ptl_setopt(lnet_portal_t *ptl, int opt)
497 ptl->ptl_options |= opt;
501 lnet_ptl_unsetopt(lnet_portal_t *ptl, int opt)
503 ptl->ptl_options &= ~opt;
506 /* match-table functions */
507 struct list_head *lnet_mt_match_head(struct lnet_match_table *mtable,
508 lnet_process_id_t id, __u64 mbits);
509 struct lnet_match_table *lnet_mt_of_attach(unsigned int index,
510 lnet_process_id_t id, __u64 mbits,
513 int lnet_mt_match_md(struct lnet_match_table *mtable,
514 struct lnet_match_info *info, struct lnet_msg *msg);
516 /* portals match/attach functions */
517 void lnet_ptl_attach_md(lnet_me_t *me, lnet_libmd_t *md,
518 struct list_head *matches, struct list_head *drops);
519 void lnet_ptl_detach_md(lnet_me_t *me, lnet_libmd_t *md);
520 int lnet_ptl_match_md(struct lnet_match_info *info, struct lnet_msg *msg);
522 /* initialized and finalize portals */
523 int lnet_portals_create(void);
524 void lnet_portals_destroy(void);
526 /* message functions */
527 int lnet_parse(lnet_ni_t *ni, lnet_hdr_t *hdr,
528 lnet_nid_t fromnid, void *private, int rdma_req);
529 void lnet_recv(lnet_ni_t *ni, void *private, lnet_msg_t *msg, int delayed,
530 unsigned int offset, unsigned int mlen, unsigned int rlen);
531 lnet_msg_t *lnet_create_reply_msg(lnet_ni_t *ni, lnet_msg_t *get_msg);
532 void lnet_set_reply_msg_len(lnet_ni_t *ni, lnet_msg_t *msg, unsigned int len);
533 void lnet_finalize(lnet_ni_t *ni, lnet_msg_t *msg, int rc);
534 void lnet_drop_delayed_msg_list(struct list_head *head, char *reason);
535 void lnet_recv_delayed_msg_list(struct list_head *head);
537 int lnet_msg_container_setup(struct lnet_msg_container *container, int cpt);
538 void lnet_msg_container_cleanup(struct lnet_msg_container *container);
539 void lnet_msg_containers_destroy(void);
540 int lnet_msg_containers_create(void);
542 char *lnet_msgtyp2str(int type);
543 void lnet_print_hdr(lnet_hdr_t *hdr);
544 int lnet_fail_nid(lnet_nid_t nid, unsigned int threshold);
546 void lnet_counters_get(lnet_counters_t *counters);
547 void lnet_counters_reset(void);
549 unsigned int lnet_iov_nob(unsigned int niov, struct kvec *iov);
550 int lnet_extract_iov(int dst_niov, struct kvec *dst,
551 int src_niov, struct kvec *src,
552 unsigned int offset, unsigned int len);
554 unsigned int lnet_kiov_nob(unsigned int niov, lnet_kiov_t *iov);
555 int lnet_extract_kiov(int dst_niov, lnet_kiov_t *dst,
556 int src_niov, lnet_kiov_t *src,
557 unsigned int offset, unsigned int len);
559 void lnet_copy_iov2iov(unsigned int ndiov, struct kvec *diov,
560 unsigned int doffset,
561 unsigned int nsiov, struct kvec *siov,
562 unsigned int soffset, unsigned int nob);
563 void lnet_copy_kiov2iov(unsigned int niov, struct kvec *iov,
564 unsigned int iovoffset,
565 unsigned int nkiov, lnet_kiov_t *kiov,
566 unsigned int kiovoffset, unsigned int nob);
567 void lnet_copy_iov2kiov(unsigned int nkiov, lnet_kiov_t *kiov,
568 unsigned int kiovoffset,
569 unsigned int niov, struct kvec *iov,
570 unsigned int iovoffset, unsigned int nob);
571 void lnet_copy_kiov2kiov(unsigned int ndkiov, lnet_kiov_t *dkiov,
572 unsigned int doffset,
573 unsigned int nskiov, lnet_kiov_t *skiov,
574 unsigned int soffset, unsigned int nob);
577 lnet_copy_iov2flat(int dlen, void *dest, unsigned int doffset,
578 unsigned int nsiov, struct kvec *siov, unsigned int soffset,
581 struct kvec diov = {/*.iov_base = */ dest, /*.iov_len = */ dlen};
583 lnet_copy_iov2iov(1, &diov, doffset,
584 nsiov, siov, soffset, nob);
588 lnet_copy_kiov2flat(int dlen, void *dest, unsigned int doffset,
589 unsigned int nsiov, lnet_kiov_t *skiov,
590 unsigned int soffset, unsigned int nob)
592 struct kvec diov = {/* .iov_base = */ dest, /* .iov_len = */ dlen};
594 lnet_copy_kiov2iov(1, &diov, doffset,
595 nsiov, skiov, soffset, nob);
599 lnet_copy_flat2iov(unsigned int ndiov, struct kvec *diov, unsigned int doffset,
600 int slen, void *src, unsigned int soffset, unsigned int nob)
602 struct kvec siov = {/*.iov_base = */ src, /*.iov_len = */slen};
604 lnet_copy_iov2iov(ndiov, diov, doffset,
605 1, &siov, soffset, nob);
609 lnet_copy_flat2kiov(unsigned int ndiov, lnet_kiov_t *dkiov,
610 unsigned int doffset, int slen, void *src,
611 unsigned int soffset, unsigned int nob)
613 struct kvec siov = {/* .iov_base = */ src, /* .iov_len = */ slen};
615 lnet_copy_iov2kiov(ndiov, dkiov, doffset,
616 1, &siov, soffset, nob);
619 void lnet_me_unlink(lnet_me_t *me);
621 void lnet_md_unlink(lnet_libmd_t *md);
622 void lnet_md_deconstruct(lnet_libmd_t *lmd, lnet_md_t *umd);
624 void lnet_register_lnd(lnd_t *lnd);
625 void lnet_unregister_lnd(lnd_t *lnd);
627 int lnet_connect(struct socket **sockp, lnet_nid_t peer_nid,
628 __u32 local_ip, __u32 peer_ip, int peer_port);
629 void lnet_connect_console_error(int rc, lnet_nid_t peer_nid,
630 __u32 peer_ip, int port);
631 int lnet_count_acceptor_nis(void);
632 int lnet_acceptor_timeout(void);
633 int lnet_acceptor_port(void);
635 int lnet_count_acceptor_nis(void);
636 int lnet_acceptor_port(void);
638 int lnet_acceptor_start(void);
639 void lnet_acceptor_stop(void);
641 int lnet_ipif_query(char *name, int *up, __u32 *ip, __u32 *mask);
642 int lnet_ipif_enumerate(char ***names);
643 void lnet_ipif_free_enumeration(char **names, int n);
644 int lnet_sock_setbuf(struct socket *socket, int txbufsize, int rxbufsize);
645 int lnet_sock_getbuf(struct socket *socket, int *txbufsize, int *rxbufsize);
646 int lnet_sock_getaddr(struct socket *socket, bool remote, __u32 *ip, int *port);
647 int lnet_sock_write(struct socket *sock, void *buffer, int nob, int timeout);
648 int lnet_sock_read(struct socket *sock, void *buffer, int nob, int timeout);
650 int lnet_sock_listen(struct socket **sockp, __u32 ip, int port, int backlog);
651 int lnet_sock_accept(struct socket **newsockp, struct socket *sock);
652 int lnet_sock_connect(struct socket **sockp, int *fatal,
653 __u32 local_ip, int local_port,
654 __u32 peer_ip, int peer_port);
655 void libcfs_sock_release(struct socket *sock);
657 int lnet_peers_start_down(void);
658 int lnet_peer_buffer_credits(lnet_ni_t *ni);
660 int lnet_router_checker_start(void);
661 void lnet_router_checker_stop(void);
662 void lnet_router_ni_update_locked(lnet_peer_t *gw, __u32 net);
663 void lnet_swap_pinginfo(lnet_ping_info_t *info);
665 int lnet_ping_target_init(void);
666 void lnet_ping_target_fini(void);
667 int lnet_ping(lnet_process_id_t id, int timeout_ms,
668 lnet_process_id_t *ids, int n_ids);
670 int lnet_parse_ip2nets(char **networksp, char *ip2nets);
671 int lnet_parse_routes(char *route_str, int *im_a_router);
672 int lnet_parse_networks(struct list_head *nilist, char *networks);
674 int lnet_nid2peer_locked(lnet_peer_t **lpp, lnet_nid_t nid, int cpt);
675 lnet_peer_t *lnet_find_peer_locked(struct lnet_peer_table *ptable,
677 void lnet_peer_tables_cleanup(void);
678 void lnet_peer_tables_destroy(void);
679 int lnet_peer_tables_create(void);
680 void lnet_debug_peer(lnet_nid_t nid);
682 static inline void lnet_peer_set_alive(lnet_peer_t *lp)
684 lp->lp_last_alive = lp->lp_last_query = get_seconds();
686 lnet_notify_locked(lp, 0, 1, lp->lp_last_alive);