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.
31 * This file is part of Lustre, http://www.lustre.org/
32 * Lustre is a trademark of Sun Microsystems, Inc.
34 * lnet/include/lnet/lib-lnet.h
36 * Top level include for library side routines
39 #ifndef __LNET_LIB_LNET_H__
40 #define __LNET_LIB_LNET_H__
42 #if defined(__linux__)
43 #include <lnet/linux/lib-lnet.h>
44 #elif defined(__APPLE__)
45 #include <lnet/darwin/lib-lnet.h>
46 #elif defined(__WINNT__)
47 #include <lnet/winnt/lib-lnet.h>
49 #error Unsupported Operating System
52 #include <libcfs/libcfs.h>
53 #include <lnet/types.h>
54 #include <lnet/lnet.h>
55 #include <lnet/lib-types.h>
57 extern lnet_t the_lnet; /* THE network */
59 static inline int lnet_is_wire_handle_none (lnet_handle_wire_t *wh)
61 return (wh->wh_interface_cookie == LNET_WIRE_HANDLE_COOKIE_NONE &&
62 wh->wh_object_cookie == LNET_WIRE_HANDLE_COOKIE_NONE);
65 static inline int lnet_md_exhausted (lnet_libmd_t *md)
67 return (md->md_threshold == 0 ||
68 ((md->md_options & LNET_MD_MAX_SIZE) != 0 &&
69 md->md_offset + md->md_max_size > md->md_length));
72 static inline int lnet_md_unlinkable (lnet_libmd_t *md)
74 /* Should unlink md when its refcount is 0 and either:
75 * - md has been flagged for deletion (by auto unlink or LNetM[DE]Unlink,
76 * in the latter case md may not be exhausted).
77 * - auto unlink is on and md is exhausted.
79 if (md->md_refcount != 0)
82 if ((md->md_flags & LNET_MD_FLAG_ZOMBIE) != 0)
85 return ((md->md_flags & LNET_MD_FLAG_AUTO_UNLINK) != 0 &&
86 lnet_md_exhausted(md));
89 static inline unsigned int
90 lnet_match_to_hash(lnet_process_id_t id, __u64 mbits)
92 mbits += id.nid + id.pid;
93 return cfs_hash_long((unsigned long)mbits, LNET_PORTAL_HASH_BITS);
97 #define LNET_LOCK() cfs_spin_lock(&the_lnet.ln_lock)
98 #define LNET_UNLOCK() cfs_spin_unlock(&the_lnet.ln_lock)
99 #define LNET_MUTEX_LOCK(m) cfs_mutex_lock(m)
100 #define LNET_MUTEX_UNLOCK(m) cfs_mutex_unlock(m)
102 # ifndef HAVE_LIBPTHREAD
103 #define LNET_SINGLE_THREADED_LOCK(l) \
105 LASSERT ((l) == 0); \
109 #define LNET_SINGLE_THREADED_UNLOCK(l) \
111 LASSERT ((l) == 1); \
115 #define LNET_LOCK() LNET_SINGLE_THREADED_LOCK(the_lnet.ln_lock)
116 #define LNET_UNLOCK() LNET_SINGLE_THREADED_UNLOCK(the_lnet.ln_lock)
117 #define LNET_MUTEX_LOCK(m) LNET_SINGLE_THREADED_LOCK(*(m))
118 #define LNET_MUTEX_UNLOCK(m) LNET_SINGLE_THREADED_UNLOCK(*(m))
120 #define LNET_LOCK() pthread_mutex_lock(&the_lnet.ln_lock)
121 #define LNET_UNLOCK() pthread_mutex_unlock(&the_lnet.ln_lock)
122 #define LNET_MUTEX_LOCK(m) pthread_mutex_lock(m)
123 #define LNET_MUTEX_UNLOCK(m) pthread_mutex_unlock(m)
127 #define MAX_PORTALS 64
129 #ifdef LNET_USE_LIB_FREELIST
133 #define MAX_MSGS 2048 /* Outstanding messages */
137 lnet_freelist_alloc (lnet_freelist_t *fl)
139 /* ALWAYS called with liblock held */
142 if (cfs_list_empty (&fl->fl_list))
145 o = cfs_list_entry (fl->fl_list.next, lnet_freeobj_t, fo_list);
146 cfs_list_del (&o->fo_list);
147 return ((void *)&o->fo_contents);
151 lnet_freelist_free (lnet_freelist_t *fl, void *obj)
153 /* ALWAYS called with liblock held */
154 lnet_freeobj_t *o = cfs_list_entry (obj, lnet_freeobj_t, fo_contents);
156 cfs_list_add (&o->fo_list, &fl->fl_list);
160 static inline lnet_eq_t *
163 /* NEVER called with liblock held */
167 eq = (lnet_eq_t *)lnet_freelist_alloc(&the_lnet.ln_free_eqs);
174 lnet_eq_free (lnet_eq_t *eq)
176 /* ALWAYS called with liblock held */
177 lnet_freelist_free(&the_lnet.ln_free_eqs, eq);
180 static inline lnet_libmd_t *
181 lnet_md_alloc (lnet_md_t *umd)
183 /* NEVER called with liblock held */
187 md = (lnet_libmd_t *)lnet_freelist_alloc(&the_lnet.ln_free_mds);
191 CFS_INIT_LIST_HEAD(&md->md_list);
197 lnet_md_free (lnet_libmd_t *md)
199 /* ALWAYS called with liblock held */
200 lnet_freelist_free (&the_lnet.ln_free_mds, md);
203 static inline lnet_me_t *
206 /* NEVER called with liblock held */
210 me = (lnet_me_t *)lnet_freelist_alloc(&the_lnet.ln_free_mes);
217 lnet_me_free (lnet_me_t *me)
219 /* ALWAYS called with liblock held */
220 lnet_freelist_free (&the_lnet.ln_free_mes, me);
223 static inline lnet_msg_t *
224 lnet_msg_alloc (void)
226 /* NEVER called with liblock held */
230 msg = (lnet_msg_t *)lnet_freelist_alloc(&the_lnet.ln_free_msgs);
234 /* NULL pointers, clear flags etc */
235 memset (msg, 0, sizeof (*msg));
237 msg->msg_ev.uid = LNET_UID_ANY;
244 lnet_msg_free (lnet_msg_t *msg)
246 /* ALWAYS called with liblock held */
247 LASSERT (!msg->msg_onactivelist);
248 lnet_freelist_free(&the_lnet.ln_free_msgs, msg);
253 static inline lnet_eq_t *
256 /* NEVER called with liblock held */
259 LIBCFS_ALLOC(eq, sizeof(*eq));
264 lnet_eq_free (lnet_eq_t *eq)
266 /* ALWAYS called with liblock held */
267 LIBCFS_FREE(eq, sizeof(*eq));
270 static inline lnet_libmd_t *
271 lnet_md_alloc (lnet_md_t *umd)
273 /* NEVER called with liblock held */
278 if ((umd->options & LNET_MD_KIOV) != 0) {
280 size = offsetof(lnet_libmd_t, md_iov.kiov[niov]);
282 niov = ((umd->options & LNET_MD_IOVEC) != 0) ?
284 size = offsetof(lnet_libmd_t, md_iov.iov[niov]);
287 LIBCFS_ALLOC(md, size);
290 /* Set here in case of early free */
291 md->md_options = umd->options;
293 CFS_INIT_LIST_HEAD(&md->md_list);
300 lnet_md_free (lnet_libmd_t *md)
302 /* ALWAYS called with liblock held */
305 if ((md->md_options & LNET_MD_KIOV) != 0)
306 size = offsetof(lnet_libmd_t, md_iov.kiov[md->md_niov]);
308 size = offsetof(lnet_libmd_t, md_iov.iov[md->md_niov]);
310 LIBCFS_FREE(md, size);
313 static inline lnet_me_t *
316 /* NEVER called with liblock held */
319 LIBCFS_ALLOC(me, sizeof(*me));
324 lnet_me_free(lnet_me_t *me)
326 /* ALWAYS called with liblock held */
327 LIBCFS_FREE(me, sizeof(*me));
330 static inline lnet_msg_t *
333 /* NEVER called with liblock held */
336 LIBCFS_ALLOC(msg, sizeof(*msg));
338 /* no need to zero, LIBCFS_ALLOC does for us */
342 msg->msg_ev.uid = LNET_UID_ANY;
349 lnet_msg_free(lnet_msg_t *msg)
351 /* ALWAYS called with liblock held */
352 LASSERT (!msg->msg_onactivelist);
353 LIBCFS_FREE(msg, sizeof(*msg));
357 extern lnet_libhandle_t *lnet_lookup_cookie (__u64 cookie, int type);
358 extern void lnet_initialise_handle (lnet_libhandle_t *lh, int type);
359 extern void lnet_invalidate_handle (lnet_libhandle_t *lh);
362 lnet_eq2handle (lnet_handle_eq_t *handle, lnet_eq_t *eq)
365 LNetInvalidateHandle(handle);
369 handle->cookie = eq->eq_lh.lh_cookie;
372 static inline lnet_eq_t *
373 lnet_handle2eq (lnet_handle_eq_t *handle)
375 /* ALWAYS called with liblock held */
376 lnet_libhandle_t *lh = lnet_lookup_cookie(handle->cookie,
377 LNET_COOKIE_TYPE_EQ);
381 return (lh_entry (lh, lnet_eq_t, eq_lh));
385 lnet_md2handle (lnet_handle_md_t *handle, lnet_libmd_t *md)
387 handle->cookie = md->md_lh.lh_cookie;
390 static inline lnet_libmd_t *
391 lnet_handle2md (lnet_handle_md_t *handle)
393 /* ALWAYS called with liblock held */
394 lnet_libhandle_t *lh = lnet_lookup_cookie(handle->cookie,
395 LNET_COOKIE_TYPE_MD);
399 return (lh_entry (lh, lnet_libmd_t, md_lh));
402 static inline lnet_libmd_t *
403 lnet_wire_handle2md (lnet_handle_wire_t *wh)
405 /* ALWAYS called with liblock held */
406 lnet_libhandle_t *lh;
408 if (wh->wh_interface_cookie != the_lnet.ln_interface_cookie)
411 lh = lnet_lookup_cookie(wh->wh_object_cookie,
412 LNET_COOKIE_TYPE_MD);
416 return (lh_entry (lh, lnet_libmd_t, md_lh));
420 lnet_me2handle (lnet_handle_me_t *handle, lnet_me_t *me)
422 handle->cookie = me->me_lh.lh_cookie;
425 static inline lnet_me_t *
426 lnet_handle2me (lnet_handle_me_t *handle)
428 /* ALWAYS called with liblock held */
429 lnet_libhandle_t *lh = lnet_lookup_cookie(handle->cookie,
430 LNET_COOKIE_TYPE_ME);
434 return (lh_entry (lh, lnet_me_t, me_lh));
438 lnet_portal_is_lazy(lnet_portal_t *ptl)
440 return !!(ptl->ptl_options & LNET_PTL_LAZY);
444 lnet_portal_is_unique(lnet_portal_t *ptl)
446 return !!(ptl->ptl_options & LNET_PTL_MATCH_UNIQUE);
450 lnet_portal_is_wildcard(lnet_portal_t *ptl)
452 return !!(ptl->ptl_options & LNET_PTL_MATCH_WILDCARD);
456 lnet_portal_setopt(lnet_portal_t *ptl, int opt)
458 ptl->ptl_options |= opt;
462 lnet_portal_unsetopt(lnet_portal_t *ptl, int opt)
464 ptl->ptl_options &= ~opt;
468 lnet_match_is_unique(lnet_process_id_t match_id,
469 __u64 match_bits, __u64 ignore_bits)
471 return ignore_bits == 0 &&
472 match_id.nid != LNET_NID_ANY &&
473 match_id.pid != LNET_PID_ANY;
476 static inline cfs_list_t *
477 lnet_portal_me_head(int index, lnet_process_id_t id, __u64 mbits)
479 lnet_portal_t *ptl = &the_lnet.ln_portals[index];
481 if (lnet_portal_is_wildcard(ptl)) {
482 return &ptl->ptl_mlist;
483 } else if (lnet_portal_is_unique(ptl)) {
484 LASSERT (ptl->ptl_mhash != NULL);
485 return &ptl->ptl_mhash[lnet_match_to_hash(id, mbits)];
490 cfs_list_t *lnet_portal_mhash_alloc(void);
491 void lnet_portal_mhash_free(cfs_list_t *mhash);
494 lnet_peer_addref_locked(lnet_peer_t *lp)
496 LASSERT (lp->lp_refcount > 0);
500 extern void lnet_destroy_peer_locked(lnet_peer_t *lp);
503 lnet_peer_decref_locked(lnet_peer_t *lp)
505 LASSERT (lp->lp_refcount > 0);
507 if (lp->lp_refcount == 0)
508 lnet_destroy_peer_locked(lp);
512 lnet_isrouter(lnet_peer_t *lp)
514 return lp->lp_rtr_refcount != 0;
518 lnet_ni_addref_locked(lnet_ni_t *ni)
520 LASSERT (ni->ni_refcount > 0);
525 lnet_ni_addref(lnet_ni_t *ni)
528 lnet_ni_addref_locked(ni);
533 lnet_ni_decref_locked(lnet_ni_t *ni)
535 LASSERT (ni->ni_refcount > 0);
537 if (ni->ni_refcount == 0)
538 cfs_list_add_tail(&ni->ni_list, &the_lnet.ln_zombie_nis);
542 lnet_ni_decref(lnet_ni_t *ni)
545 lnet_ni_decref_locked(ni);
549 static inline cfs_list_t *
550 lnet_nid2peerhash (lnet_nid_t nid)
552 unsigned int idx = LNET_NIDADDR(nid) % LNET_PEER_HASHSIZE;
554 return &the_lnet.ln_peer_hash[idx];
557 extern lnd_t the_lolnd;
560 /* unconditional registration */
561 #define LNET_REGISTER_ULND(lnd) \
565 lnet_register_lnd(&(lnd)); \
568 /* conditional registration */
569 #define LNET_REGISTER_ULND_IF_PRESENT(lnd) \
571 extern lnd_t lnd __attribute__ ((weak, alias("the_lolnd"))); \
573 if (&(lnd) != &the_lolnd) \
574 lnet_register_lnd(&(lnd)); \
580 lnet_set_msg_uid(lnet_ni_t *ni, lnet_msg_t *msg, lnet_uid_t uid)
582 LASSERT (msg->msg_ev.uid == LNET_UID_ANY);
583 msg->msg_ev.uid = uid;
587 extern lnet_ni_t *lnet_nid2ni_locked (lnet_nid_t nid);
588 extern lnet_ni_t *lnet_net2ni_locked (__u32 net);
589 static inline lnet_ni_t *
590 lnet_net2ni (__u32 net)
595 ni = lnet_net2ni_locked(net);
601 int lnet_notify(lnet_ni_t *ni, lnet_nid_t peer, int alive, cfs_time_t when);
602 void lnet_notify_locked(lnet_peer_t *lp, int notifylnd, int alive, cfs_time_t when);
603 int lnet_add_route(__u32 net, unsigned int hops, lnet_nid_t gateway_nid);
604 int lnet_check_routes(void);
605 int lnet_del_route(__u32 net, lnet_nid_t gw_nid);
606 void lnet_destroy_routes(void);
607 int lnet_get_route(int idx, __u32 *net, __u32 *hops,
608 lnet_nid_t *gateway, __u32 *alive);
609 void lnet_proc_init(void);
610 void lnet_proc_fini(void);
611 void lnet_init_rtrpools(void);
612 int lnet_alloc_rtrpools(int im_a_router);
613 void lnet_free_rtrpools(void);
614 lnet_remotenet_t *lnet_find_net_locked (__u32 net);
616 int lnet_islocalnid(lnet_nid_t nid);
617 int lnet_islocalnet(__u32 net);
619 void lnet_build_unlink_event(lnet_libmd_t *md, lnet_event_t *ev);
620 void lnet_enq_event_locked(lnet_eq_t *eq, lnet_event_t *ev);
621 void lnet_prep_send(lnet_msg_t *msg, int type, lnet_process_id_t target,
622 unsigned int offset, unsigned int len);
623 int lnet_send(lnet_nid_t nid, lnet_msg_t *msg);
624 void lnet_return_credits_locked (lnet_msg_t *msg);
625 void lnet_match_blocked_msg(lnet_libmd_t *md);
626 int lnet_parse (lnet_ni_t *ni, lnet_hdr_t *hdr,
627 lnet_nid_t fromnid, void *private, int rdma_req);
628 void lnet_recv(lnet_ni_t *ni, void *private, lnet_msg_t *msg, int delayed,
629 unsigned int offset, unsigned int mlen, unsigned int rlen);
630 lnet_msg_t *lnet_create_reply_msg (lnet_ni_t *ni, lnet_msg_t *get_msg);
631 void lnet_set_reply_msg_len(lnet_ni_t *ni, lnet_msg_t *msg, unsigned int len);
632 void lnet_finalize(lnet_ni_t *ni, lnet_msg_t *msg, int rc);
634 char *lnet_msgtyp2str (int type);
635 void lnet_print_hdr (lnet_hdr_t * hdr);
636 int lnet_fail_nid(lnet_nid_t nid, unsigned int threshold);
638 unsigned int lnet_iov_nob (unsigned int niov, struct iovec *iov);
639 int lnet_extract_iov (int dst_niov, struct iovec *dst,
640 int src_niov, struct iovec *src,
641 unsigned int offset, unsigned int len);
643 unsigned int lnet_kiov_nob (unsigned int niov, lnet_kiov_t *iov);
644 int lnet_extract_kiov (int dst_niov, lnet_kiov_t *dst,
645 int src_niov, lnet_kiov_t *src,
646 unsigned int offset, unsigned int len);
648 void lnet_copy_iov2iov (unsigned int ndiov, struct iovec *diov,
649 unsigned int doffset,
650 unsigned int nsiov, struct iovec *siov,
651 unsigned int soffset, unsigned int nob);
652 void lnet_copy_kiov2iov (unsigned int niov, struct iovec *iov,
653 unsigned int iovoffset,
654 unsigned int nkiov, lnet_kiov_t *kiov,
655 unsigned int kiovoffset, unsigned int nob);
656 void lnet_copy_iov2kiov (unsigned int nkiov, lnet_kiov_t *kiov,
657 unsigned int kiovoffset,
658 unsigned int niov, struct iovec *iov,
659 unsigned int iovoffset, unsigned int nob);
660 void lnet_copy_kiov2kiov (unsigned int ndkiov, lnet_kiov_t *dkiov,
661 unsigned int doffset,
662 unsigned int nskiov, lnet_kiov_t *skiov,
663 unsigned int soffset, unsigned int nob);
666 lnet_copy_iov2flat(int dlen, void *dest, unsigned int doffset,
667 unsigned int nsiov, struct iovec *siov, unsigned int soffset,
670 struct iovec diov = {/*.iov_base = */ dest, /*.iov_len = */ dlen};
672 lnet_copy_iov2iov(1, &diov, doffset,
673 nsiov, siov, soffset, nob);
677 lnet_copy_kiov2flat(int dlen, void *dest, unsigned int doffset,
678 unsigned int nsiov, lnet_kiov_t *skiov, unsigned int soffset,
681 struct iovec diov = {/* .iov_base = */ dest, /* .iov_len = */ dlen};
683 lnet_copy_kiov2iov(1, &diov, doffset,
684 nsiov, skiov, soffset, nob);
688 lnet_copy_flat2iov(unsigned int ndiov, struct iovec *diov, unsigned int doffset,
689 int slen, void *src, unsigned int soffset, unsigned int nob)
691 struct iovec siov = {/*.iov_base = */ src, /*.iov_len = */slen};
692 lnet_copy_iov2iov(ndiov, diov, doffset,
693 1, &siov, soffset, nob);
697 lnet_copy_flat2kiov(unsigned int ndiov, lnet_kiov_t *dkiov, unsigned int doffset,
698 int slen, void *src, unsigned int soffset, unsigned int nob)
700 struct iovec siov = {/* .iov_base = */ src, /* .iov_len = */ slen};
701 lnet_copy_iov2kiov(ndiov, dkiov, doffset,
702 1, &siov, soffset, nob);
705 void lnet_me_unlink(lnet_me_t *me);
707 void lnet_md_unlink(lnet_libmd_t *md);
708 void lnet_md_deconstruct(lnet_libmd_t *lmd, lnet_md_t *umd);
710 void lnet_register_lnd(lnd_t *lnd);
711 void lnet_unregister_lnd(lnd_t *lnd);
712 int lnet_set_ip_niaddr (lnet_ni_t *ni);
715 int lnet_connect(cfs_socket_t **sockp, lnet_nid_t peer_nid,
716 __u32 local_ip, __u32 peer_ip, int peer_port);
717 void lnet_connect_console_error(int rc, lnet_nid_t peer_nid,
718 __u32 peer_ip, int port);
719 int lnet_count_acceptor_nis(void);
720 int lnet_acceptor_timeout(void);
721 int lnet_acceptor_port(void);
723 void lnet_router_checker(void);
726 #ifdef HAVE_LIBPTHREAD
727 int lnet_count_acceptor_nis(void);
728 int lnet_acceptor_port(void);
731 int lnet_acceptor_start(void);
732 void lnet_acceptor_stop(void);
734 void lnet_get_tunables(void);
735 int lnet_peers_start_down(void);
736 int lnet_peer_buffer_credits(lnet_ni_t *ni);
738 int lnet_router_checker_start(void);
739 void lnet_router_checker_stop(void);
740 void lnet_swap_pinginfo(lnet_ping_info_t *info);
741 int lnet_router_down_ni(lnet_peer_t *rtr, __u32 net);
743 int lnet_ping_target_init(void);
744 void lnet_ping_target_fini(void);
745 int lnet_ping(lnet_process_id_t id, int timeout_ms,
746 lnet_process_id_t *ids, int n_ids);
748 int lnet_parse_ip2nets (char **networksp, char *ip2nets);
749 int lnet_parse_routes (char *route_str, int *im_a_router);
750 int lnet_parse_networks (cfs_list_t *nilist, char *networks);
752 int lnet_nid2peer_locked(lnet_peer_t **lpp, lnet_nid_t nid);
753 lnet_peer_t *lnet_find_peer_locked (lnet_nid_t nid);
754 void lnet_clear_peer_table(void);
755 void lnet_destroy_peer_table(void);
756 int lnet_create_peer_table(void);
757 void lnet_debug_peer(lnet_nid_t nid);
761 lnet_parse_int_tunable(int *value, char *name)
763 char *env = getenv(name);
769 *value = strtoull(env, &end, 0);
773 CERROR("Can't parse tunable %s=%s\n", name, env);