1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2 * vim:expandtab:shiftwidth=8:tabstop=8:
6 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 only,
10 * as published by the Free Software Foundation.
12 * This program is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * General Public License version 2 for more details (a copy is included
16 * in the LICENSE file that accompanied this code).
18 * You should have received a copy of the GNU General Public License
19 * version 2 along with this program; If not, see
20 * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
22 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
23 * CA 95054 USA or visit www.sun.com if you need additional information or
29 * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
30 * Use is subject to license terms.
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 #if defined(__linux__)
45 #include <lnet/linux/lib-lnet.h>
46 #elif defined(__APPLE__)
47 #include <lnet/darwin/lib-lnet.h>
48 #elif defined(__WINNT__)
49 #include <lnet/winnt/lib-lnet.h>
51 #error Unsupported Operating System
54 #include <libcfs/libcfs.h>
55 #include <lnet/types.h>
56 #include <lnet/lnet.h>
57 #include <lnet/lib-types.h>
59 extern lnet_t the_lnet; /* THE network */
61 static inline int lnet_is_wire_handle_none (lnet_handle_wire_t *wh)
63 return (wh->wh_interface_cookie == LNET_WIRE_HANDLE_COOKIE_NONE &&
64 wh->wh_object_cookie == LNET_WIRE_HANDLE_COOKIE_NONE);
67 static inline int lnet_md_exhausted (lnet_libmd_t *md)
69 return (md->md_threshold == 0 ||
70 ((md->md_options & LNET_MD_MAX_SIZE) != 0 &&
71 md->md_offset + md->md_max_size > md->md_length));
74 static inline int lnet_md_unlinkable (lnet_libmd_t *md)
76 /* Should unlink md when its refcount is 0 and either:
77 * - md has been flagged for deletion (by auto unlink or LNetM[DE]Unlink,
78 * in the latter case md may not be exhausted).
79 * - auto unlink is on and md is exhausted.
81 if (md->md_refcount != 0)
84 if ((md->md_flags & LNET_MD_FLAG_ZOMBIE) != 0)
87 return ((md->md_flags & LNET_MD_FLAG_AUTO_UNLINK) != 0 &&
88 lnet_md_exhausted(md));
91 static inline unsigned int
92 lnet_match_to_hash(lnet_process_id_t id, __u64 mbits)
94 mbits += id.nid + id.pid;
95 return cfs_hash_long((unsigned long)mbits, LNET_PORTAL_HASH_BITS);
99 #define LNET_LOCK() cfs_spin_lock(&the_lnet.ln_lock)
100 #define LNET_UNLOCK() cfs_spin_unlock(&the_lnet.ln_lock)
101 #define LNET_MUTEX_DOWN(m) cfs_mutex_down(m)
102 #define LNET_MUTEX_UP(m) cfs_mutex_up(m)
104 # ifndef HAVE_LIBPTHREAD
105 #define LNET_SINGLE_THREADED_LOCK(l) \
107 LASSERT ((l) == 0); \
111 #define LNET_SINGLE_THREADED_UNLOCK(l) \
113 LASSERT ((l) == 1); \
117 #define LNET_LOCK() LNET_SINGLE_THREADED_LOCK(the_lnet.ln_lock)
118 #define LNET_UNLOCK() LNET_SINGLE_THREADED_UNLOCK(the_lnet.ln_lock)
119 #define LNET_MUTEX_DOWN(m) LNET_SINGLE_THREADED_LOCK(*(m))
120 #define LNET_MUTEX_UP(m) LNET_SINGLE_THREADED_UNLOCK(*(m))
122 #define LNET_LOCK() pthread_mutex_lock(&the_lnet.ln_lock)
123 #define LNET_UNLOCK() pthread_mutex_unlock(&the_lnet.ln_lock)
124 #define LNET_MUTEX_DOWN(m) pthread_mutex_lock(m)
125 #define LNET_MUTEX_UP(m) pthread_mutex_unlock(m)
129 #define MAX_PORTALS 64
131 #ifdef LNET_USE_LIB_FREELIST
135 #define MAX_MSGS 2048 /* Outstanding messages */
139 lnet_freelist_alloc (lnet_freelist_t *fl)
141 /* ALWAYS called with liblock held */
144 if (cfs_list_empty (&fl->fl_list))
147 o = cfs_list_entry (fl->fl_list.next, lnet_freeobj_t, fo_list);
148 cfs_list_del (&o->fo_list);
149 return ((void *)&o->fo_contents);
153 lnet_freelist_free (lnet_freelist_t *fl, void *obj)
155 /* ALWAYS called with liblock held */
156 lnet_freeobj_t *o = cfs_list_entry (obj, lnet_freeobj_t, fo_contents);
158 cfs_list_add (&o->fo_list, &fl->fl_list);
162 static inline lnet_eq_t *
165 /* NEVER called with liblock held */
169 eq = (lnet_eq_t *)lnet_freelist_alloc(&the_lnet.ln_free_eqs);
176 lnet_eq_free (lnet_eq_t *eq)
178 /* ALWAYS called with liblock held */
179 lnet_freelist_free(&the_lnet.ln_free_eqs, eq);
182 static inline lnet_libmd_t *
183 lnet_md_alloc (lnet_md_t *umd)
185 /* NEVER called with liblock held */
189 md = (lnet_libmd_t *)lnet_freelist_alloc(&the_lnet.ln_free_mds);
193 CFS_INIT_LIST_HEAD(&md->md_list);
199 lnet_md_free (lnet_libmd_t *md)
201 /* ALWAYS called with liblock held */
202 lnet_freelist_free (&the_lnet.ln_free_mds, md);
205 static inline lnet_me_t *
208 /* NEVER called with liblock held */
212 me = (lnet_me_t *)lnet_freelist_alloc(&the_lnet.ln_free_mes);
219 lnet_me_free (lnet_me_t *me)
221 /* ALWAYS called with liblock held */
222 lnet_freelist_free (&the_lnet.ln_free_mes, me);
225 static inline lnet_msg_t *
226 lnet_msg_alloc (void)
228 /* NEVER called with liblock held */
232 msg = (lnet_msg_t *)lnet_freelist_alloc(&the_lnet.ln_free_msgs);
236 /* NULL pointers, clear flags etc */
237 memset (msg, 0, sizeof (*msg));
239 msg->msg_ev.uid = LNET_UID_ANY;
246 lnet_msg_free (lnet_msg_t *msg)
248 /* ALWAYS called with liblock held */
249 LASSERT (!msg->msg_onactivelist);
250 lnet_freelist_free(&the_lnet.ln_free_msgs, msg);
255 static inline lnet_eq_t *
258 /* NEVER called with liblock held */
261 LIBCFS_ALLOC(eq, sizeof(*eq));
266 lnet_eq_free (lnet_eq_t *eq)
268 /* ALWAYS called with liblock held */
269 LIBCFS_FREE(eq, sizeof(*eq));
272 static inline lnet_libmd_t *
273 lnet_md_alloc (lnet_md_t *umd)
275 /* NEVER called with liblock held */
280 if ((umd->options & LNET_MD_KIOV) != 0) {
282 size = offsetof(lnet_libmd_t, md_iov.kiov[niov]);
284 niov = ((umd->options & LNET_MD_IOVEC) != 0) ?
286 size = offsetof(lnet_libmd_t, md_iov.iov[niov]);
289 LIBCFS_ALLOC(md, size);
292 /* Set here in case of early free */
293 md->md_options = umd->options;
295 CFS_INIT_LIST_HEAD(&md->md_list);
302 lnet_md_free (lnet_libmd_t *md)
304 /* ALWAYS called with liblock held */
307 if ((md->md_options & LNET_MD_KIOV) != 0)
308 size = offsetof(lnet_libmd_t, md_iov.kiov[md->md_niov]);
310 size = offsetof(lnet_libmd_t, md_iov.iov[md->md_niov]);
312 LIBCFS_FREE(md, size);
315 static inline lnet_me_t *
318 /* NEVER called with liblock held */
321 LIBCFS_ALLOC(me, sizeof(*me));
326 lnet_me_free(lnet_me_t *me)
328 /* ALWAYS called with liblock held */
329 LIBCFS_FREE(me, sizeof(*me));
332 static inline lnet_msg_t *
335 /* NEVER called with liblock held */
338 LIBCFS_ALLOC(msg, sizeof(*msg));
340 /* no need to zero, LIBCFS_ALLOC does for us */
344 msg->msg_ev.uid = LNET_UID_ANY;
351 lnet_msg_free(lnet_msg_t *msg)
353 /* ALWAYS called with liblock held */
354 LASSERT (!msg->msg_onactivelist);
355 LIBCFS_FREE(msg, sizeof(*msg));
359 extern lnet_libhandle_t *lnet_lookup_cookie (__u64 cookie, int type);
360 extern void lnet_initialise_handle (lnet_libhandle_t *lh, int type);
361 extern void lnet_invalidate_handle (lnet_libhandle_t *lh);
364 lnet_eq2handle (lnet_handle_eq_t *handle, lnet_eq_t *eq)
367 LNetInvalidateHandle(handle);
371 handle->cookie = eq->eq_lh.lh_cookie;
374 static inline lnet_eq_t *
375 lnet_handle2eq (lnet_handle_eq_t *handle)
377 /* ALWAYS called with liblock held */
378 lnet_libhandle_t *lh = lnet_lookup_cookie(handle->cookie,
379 LNET_COOKIE_TYPE_EQ);
383 return (lh_entry (lh, lnet_eq_t, eq_lh));
387 lnet_md2handle (lnet_handle_md_t *handle, lnet_libmd_t *md)
389 handle->cookie = md->md_lh.lh_cookie;
392 static inline lnet_libmd_t *
393 lnet_handle2md (lnet_handle_md_t *handle)
395 /* ALWAYS called with liblock held */
396 lnet_libhandle_t *lh = lnet_lookup_cookie(handle->cookie,
397 LNET_COOKIE_TYPE_MD);
401 return (lh_entry (lh, lnet_libmd_t, md_lh));
404 static inline lnet_libmd_t *
405 lnet_wire_handle2md (lnet_handle_wire_t *wh)
407 /* ALWAYS called with liblock held */
408 lnet_libhandle_t *lh;
410 if (wh->wh_interface_cookie != the_lnet.ln_interface_cookie)
413 lh = lnet_lookup_cookie(wh->wh_object_cookie,
414 LNET_COOKIE_TYPE_MD);
418 return (lh_entry (lh, lnet_libmd_t, md_lh));
422 lnet_me2handle (lnet_handle_me_t *handle, lnet_me_t *me)
424 handle->cookie = me->me_lh.lh_cookie;
427 static inline lnet_me_t *
428 lnet_handle2me (lnet_handle_me_t *handle)
430 /* ALWAYS called with liblock held */
431 lnet_libhandle_t *lh = lnet_lookup_cookie(handle->cookie,
432 LNET_COOKIE_TYPE_ME);
436 return (lh_entry (lh, lnet_me_t, me_lh));
440 lnet_portal_is_lazy(lnet_portal_t *ptl)
442 return !!(ptl->ptl_options & LNET_PTL_LAZY);
446 lnet_portal_is_unique(lnet_portal_t *ptl)
448 return !!(ptl->ptl_options & LNET_PTL_MATCH_UNIQUE);
452 lnet_portal_is_wildcard(lnet_portal_t *ptl)
454 return !!(ptl->ptl_options & LNET_PTL_MATCH_WILDCARD);
458 lnet_portal_setopt(lnet_portal_t *ptl, int opt)
460 ptl->ptl_options |= opt;
464 lnet_portal_unsetopt(lnet_portal_t *ptl, int opt)
466 ptl->ptl_options &= ~opt;
470 lnet_match_is_unique(lnet_process_id_t match_id,
471 __u64 match_bits, __u64 ignore_bits)
473 return ignore_bits == 0 &&
474 match_id.nid != LNET_NID_ANY &&
475 match_id.pid != LNET_PID_ANY;
478 static inline cfs_list_t *
479 lnet_portal_me_head(int index, lnet_process_id_t id, __u64 mbits)
481 lnet_portal_t *ptl = &the_lnet.ln_portals[index];
483 if (lnet_portal_is_wildcard(ptl)) {
484 return &ptl->ptl_mlist;
485 } else if (lnet_portal_is_unique(ptl)) {
486 LASSERT (ptl->ptl_mhash != NULL);
487 return &ptl->ptl_mhash[lnet_match_to_hash(id, mbits)];
492 cfs_list_t *lnet_portal_mhash_alloc(void);
493 void lnet_portal_mhash_free(cfs_list_t *mhash);
496 lnet_peer_addref_locked(lnet_peer_t *lp)
498 LASSERT (lp->lp_refcount > 0);
502 extern void lnet_destroy_peer_locked(lnet_peer_t *lp);
505 lnet_peer_decref_locked(lnet_peer_t *lp)
507 LASSERT (lp->lp_refcount > 0);
509 if (lp->lp_refcount == 0)
510 lnet_destroy_peer_locked(lp);
514 lnet_isrouter(lnet_peer_t *lp)
516 return lp->lp_rtr_refcount != 0;
520 lnet_ni_addref_locked(lnet_ni_t *ni)
522 LASSERT (ni->ni_refcount > 0);
527 lnet_ni_addref(lnet_ni_t *ni)
530 lnet_ni_addref_locked(ni);
535 lnet_ni_decref_locked(lnet_ni_t *ni)
537 LASSERT (ni->ni_refcount > 0);
539 if (ni->ni_refcount == 0)
540 cfs_list_add_tail(&ni->ni_list, &the_lnet.ln_zombie_nis);
544 lnet_ni_decref(lnet_ni_t *ni)
547 lnet_ni_decref_locked(ni);
551 static inline cfs_list_t *
552 lnet_nid2peerhash (lnet_nid_t nid)
554 unsigned int idx = LNET_NIDADDR(nid) % LNET_PEER_HASHSIZE;
556 return &the_lnet.ln_peer_hash[idx];
559 extern lnd_t the_lolnd;
562 /* unconditional registration */
563 #define LNET_REGISTER_ULND(lnd) \
567 lnet_register_lnd(&(lnd)); \
570 /* conditional registration */
571 #define LNET_REGISTER_ULND_IF_PRESENT(lnd) \
573 extern lnd_t lnd __attribute__ ((weak, alias("the_lolnd"))); \
575 if (&(lnd) != &the_lolnd) \
576 lnet_register_lnd(&(lnd)); \
582 lnet_set_msg_uid(lnet_ni_t *ni, lnet_msg_t *msg, lnet_uid_t uid)
584 LASSERT (msg->msg_ev.uid == LNET_UID_ANY);
585 msg->msg_ev.uid = uid;
589 extern lnet_ni_t *lnet_nid2ni_locked (lnet_nid_t nid);
590 extern lnet_ni_t *lnet_net2ni_locked (__u32 net);
591 static inline lnet_ni_t *
592 lnet_net2ni (__u32 net)
597 ni = lnet_net2ni_locked(net);
603 int lnet_notify(lnet_ni_t *ni, lnet_nid_t peer, int alive, cfs_time_t when);
604 void lnet_notify_locked(lnet_peer_t *lp, int notifylnd, int alive, cfs_time_t when);
605 int lnet_add_route(__u32 net, unsigned int hops, lnet_nid_t gateway_nid);
606 int lnet_check_routes(void);
607 int lnet_del_route(__u32 net, lnet_nid_t gw_nid);
608 void lnet_destroy_routes(void);
609 int lnet_get_route(int idx, __u32 *net, __u32 *hops,
610 lnet_nid_t *gateway, __u32 *alive);
611 void lnet_proc_init(void);
612 void lnet_proc_fini(void);
613 void lnet_init_rtrpools(void);
614 int lnet_alloc_rtrpools(int im_a_router);
615 void lnet_free_rtrpools(void);
616 lnet_remotenet_t *lnet_find_net_locked (__u32 net);
618 int lnet_islocalnid(lnet_nid_t nid);
619 int lnet_islocalnet(__u32 net);
621 void lnet_build_unlink_event(lnet_libmd_t *md, lnet_event_t *ev);
622 void lnet_enq_event_locked(lnet_eq_t *eq, lnet_event_t *ev);
623 void lnet_prep_send(lnet_msg_t *msg, int type, lnet_process_id_t target,
624 unsigned int offset, unsigned int len);
625 int lnet_send(lnet_nid_t nid, lnet_msg_t *msg);
626 void lnet_return_credits_locked (lnet_msg_t *msg);
627 void lnet_match_blocked_msg(lnet_libmd_t *md);
628 int lnet_parse (lnet_ni_t *ni, lnet_hdr_t *hdr,
629 lnet_nid_t fromnid, void *private, int rdma_req);
630 void lnet_recv(lnet_ni_t *ni, void *private, lnet_msg_t *msg, int delayed,
631 unsigned int offset, unsigned int mlen, unsigned int rlen);
632 lnet_msg_t *lnet_create_reply_msg (lnet_ni_t *ni, lnet_msg_t *get_msg);
633 void lnet_set_reply_msg_len(lnet_ni_t *ni, lnet_msg_t *msg, unsigned int len);
634 void lnet_finalize(lnet_ni_t *ni, lnet_msg_t *msg, int rc);
636 char *lnet_msgtyp2str (int type);
637 void lnet_print_hdr (lnet_hdr_t * hdr);
638 int lnet_fail_nid(lnet_nid_t nid, unsigned int threshold);
640 unsigned int lnet_iov_nob (unsigned int niov, struct iovec *iov);
641 int lnet_extract_iov (int dst_niov, struct iovec *dst,
642 int src_niov, struct iovec *src,
643 unsigned int offset, unsigned int len);
645 unsigned int lnet_kiov_nob (unsigned int niov, lnet_kiov_t *iov);
646 int lnet_extract_kiov (int dst_niov, lnet_kiov_t *dst,
647 int src_niov, lnet_kiov_t *src,
648 unsigned int offset, unsigned int len);
650 void lnet_copy_iov2iov (unsigned int ndiov, struct iovec *diov,
651 unsigned int doffset,
652 unsigned int nsiov, struct iovec *siov,
653 unsigned int soffset, unsigned int nob);
654 void lnet_copy_kiov2iov (unsigned int niov, struct iovec *iov,
655 unsigned int iovoffset,
656 unsigned int nkiov, lnet_kiov_t *kiov,
657 unsigned int kiovoffset, unsigned int nob);
658 void lnet_copy_iov2kiov (unsigned int nkiov, lnet_kiov_t *kiov,
659 unsigned int kiovoffset,
660 unsigned int niov, struct iovec *iov,
661 unsigned int iovoffset, unsigned int nob);
662 void lnet_copy_kiov2kiov (unsigned int ndkiov, lnet_kiov_t *dkiov,
663 unsigned int doffset,
664 unsigned int nskiov, lnet_kiov_t *skiov,
665 unsigned int soffset, unsigned int nob);
668 lnet_copy_iov2flat(int dlen, void *dest, unsigned int doffset,
669 unsigned int nsiov, struct iovec *siov, unsigned int soffset,
672 struct iovec diov = {/*.iov_base = */ dest, /*.iov_len = */ dlen};
674 lnet_copy_iov2iov(1, &diov, doffset,
675 nsiov, siov, soffset, nob);
679 lnet_copy_kiov2flat(int dlen, void *dest, unsigned int doffset,
680 unsigned int nsiov, lnet_kiov_t *skiov, unsigned int soffset,
683 struct iovec diov = {/* .iov_base = */ dest, /* .iov_len = */ dlen};
685 lnet_copy_kiov2iov(1, &diov, doffset,
686 nsiov, skiov, soffset, nob);
690 lnet_copy_flat2iov(unsigned int ndiov, struct iovec *diov, unsigned int doffset,
691 int slen, void *src, unsigned int soffset, unsigned int nob)
693 struct iovec siov = {/*.iov_base = */ src, /*.iov_len = */slen};
694 lnet_copy_iov2iov(ndiov, diov, doffset,
695 1, &siov, soffset, nob);
699 lnet_copy_flat2kiov(unsigned int ndiov, lnet_kiov_t *dkiov, unsigned int doffset,
700 int slen, void *src, unsigned int soffset, unsigned int nob)
702 struct iovec siov = {/* .iov_base = */ src, /* .iov_len = */ slen};
703 lnet_copy_iov2kiov(ndiov, dkiov, doffset,
704 1, &siov, soffset, nob);
707 void lnet_me_unlink(lnet_me_t *me);
709 void lnet_md_unlink(lnet_libmd_t *md);
710 void lnet_md_deconstruct(lnet_libmd_t *lmd, lnet_md_t *umd);
712 void lnet_register_lnd(lnd_t *lnd);
713 void lnet_unregister_lnd(lnd_t *lnd);
714 int lnet_set_ip_niaddr (lnet_ni_t *ni);
717 int lnet_connect(cfs_socket_t **sockp, lnet_nid_t peer_nid,
718 __u32 local_ip, __u32 peer_ip, int peer_port);
719 void lnet_connect_console_error(int rc, lnet_nid_t peer_nid,
720 __u32 peer_ip, int port);
721 int lnet_count_acceptor_nis(void);
722 int lnet_acceptor_timeout(void);
723 int lnet_acceptor_port(void);
725 void lnet_router_checker(void);
728 #ifdef HAVE_LIBPTHREAD
729 int lnet_count_acceptor_nis(void);
730 int lnet_acceptor_port(void);
733 int lnet_acceptor_start(void);
734 void lnet_acceptor_stop(void);
736 void lnet_get_tunables(void);
737 int lnet_peers_start_down(void);
738 int lnet_peer_buffer_credits(lnet_ni_t *ni);
740 int lnet_router_checker_start(void);
741 void lnet_router_checker_stop(void);
742 void lnet_swap_pinginfo(lnet_ping_info_t *info);
743 int lnet_router_down_ni(lnet_peer_t *rtr, __u32 net);
745 int lnet_ping_target_init(void);
746 void lnet_ping_target_fini(void);
747 int lnet_ping(lnet_process_id_t id, int timeout_ms,
748 lnet_process_id_t *ids, int n_ids);
750 int lnet_parse_ip2nets (char **networksp, char *ip2nets);
751 int lnet_parse_routes (char *route_str, int *im_a_router);
752 int lnet_parse_networks (cfs_list_t *nilist, char *networks);
754 int lnet_nid2peer_locked(lnet_peer_t **lpp, lnet_nid_t nid);
755 lnet_peer_t *lnet_find_peer_locked (lnet_nid_t nid);
756 void lnet_clear_peer_table(void);
757 void lnet_destroy_peer_table(void);
758 int lnet_create_peer_table(void);
759 void lnet_debug_peer(lnet_nid_t nid);
763 lnet_parse_int_tunable(int *value, char *name)
765 char *env = getenv(name);
771 *value = strtoull(env, &end, 0);
775 CERROR("Can't parse tunable %s=%s\n", name, env);