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 2008 Sun Microsystems, Inc. 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_NONE.wh_interface_cookie &&
64 wh->wh_object_cookie == LNET_WIRE_HANDLE_NONE.wh_object_cookie);
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));
92 #define LNET_LOCK() spin_lock(&the_lnet.ln_lock)
93 #define LNET_UNLOCK() spin_unlock(&the_lnet.ln_lock)
94 #define LNET_MUTEX_DOWN(m) mutex_down(m)
95 #define LNET_MUTEX_UP(m) mutex_up(m)
97 # ifndef HAVE_LIBPTHREAD
98 #define LNET_SINGLE_THREADED_LOCK(l) \
100 LASSERT ((l) == 0); \
104 #define LNET_SINGLE_THREADED_UNLOCK(l) \
106 LASSERT ((l) == 1); \
110 #define LNET_LOCK() LNET_SINGLE_THREADED_LOCK(the_lnet.ln_lock)
111 #define LNET_UNLOCK() LNET_SINGLE_THREADED_UNLOCK(the_lnet.ln_lock)
112 #define LNET_MUTEX_DOWN(m) LNET_SINGLE_THREADED_LOCK(*(m))
113 #define LNET_MUTEX_UP(m) LNET_SINGLE_THREADED_UNLOCK(*(m))
115 #define LNET_LOCK() pthread_mutex_lock(&the_lnet.ln_lock)
116 #define LNET_UNLOCK() pthread_mutex_unlock(&the_lnet.ln_lock)
117 #define LNET_MUTEX_DOWN(m) pthread_mutex_lock(m)
118 #define LNET_MUTEX_UP(m) pthread_mutex_unlock(m)
122 #define MAX_PORTALS 64
124 #ifdef LNET_USE_LIB_FREELIST
128 #define MAX_MSGS 2048 /* Outstanding messages */
132 lnet_freelist_alloc (lnet_freelist_t *fl)
134 /* ALWAYS called with liblock held */
137 if (list_empty (&fl->fl_list))
140 o = list_entry (fl->fl_list.next, lnet_freeobj_t, fo_list);
141 list_del (&o->fo_list);
142 return ((void *)&o->fo_contents);
146 lnet_freelist_free (lnet_freelist_t *fl, void *obj)
148 /* ALWAYS called with liblock held */
149 lnet_freeobj_t *o = list_entry (obj, lnet_freeobj_t, fo_contents);
151 list_add (&o->fo_list, &fl->fl_list);
155 static inline lnet_eq_t *
158 /* NEVER called with liblock held */
162 eq = (lnet_eq_t *)lnet_freelist_alloc(&the_lnet.ln_free_eqs);
169 lnet_eq_free (lnet_eq_t *eq)
171 /* ALWAYS called with liblock held */
172 lnet_freelist_free(&the_lnet.ln_free_eqs, eq);
175 static inline lnet_libmd_t *
176 lnet_md_alloc (lnet_md_t *umd)
178 /* NEVER called with liblock held */
182 md = (lnet_libmd_t *)lnet_freelist_alloc(&the_lnet.ln_free_mds);
189 lnet_md_free (lnet_libmd_t *md)
191 /* ALWAYS called with liblock held */
192 lnet_freelist_free (&the_lnet.ln_free_mds, md);
195 static inline lnet_me_t *
198 /* NEVER called with liblock held */
202 me = (lnet_me_t *)lnet_freelist_alloc(&the_lnet.ln_free_mes);
209 lnet_me_free (lnet_me_t *me)
211 /* ALWAYS called with liblock held */
212 lnet_freelist_free (&the_lnet.ln_free_mes, me);
215 static inline lnet_msg_t *
216 lnet_msg_alloc (void)
218 /* NEVER called with liblock held */
222 msg = (lnet_msg_t *)lnet_freelist_alloc(&the_lnet.ln_free_msgs);
226 /* NULL pointers, clear flags etc */
227 memset (msg, 0, sizeof (*msg));
229 msg->msg_ev.uid = LNET_UID_ANY;
236 lnet_msg_free (lnet_msg_t *msg)
238 /* ALWAYS called with liblock held */
239 LASSERT (!msg->msg_onactivelist);
240 lnet_freelist_free(&the_lnet.ln_free_msgs, msg);
245 static inline lnet_eq_t *
248 /* NEVER called with liblock held */
251 LIBCFS_ALLOC(eq, sizeof(*eq));
256 lnet_eq_free (lnet_eq_t *eq)
258 /* ALWAYS called with liblock held */
259 LIBCFS_FREE(eq, sizeof(*eq));
262 static inline lnet_libmd_t *
263 lnet_md_alloc (lnet_md_t *umd)
265 /* NEVER called with liblock held */
270 if ((umd->options & LNET_MD_KIOV) != 0) {
272 size = offsetof(lnet_libmd_t, md_iov.kiov[niov]);
274 niov = ((umd->options & LNET_MD_IOVEC) != 0) ?
276 size = offsetof(lnet_libmd_t, md_iov.iov[niov]);
279 LIBCFS_ALLOC(md, size);
282 /* Set here in case of early free */
283 md->md_options = umd->options;
291 lnet_md_free (lnet_libmd_t *md)
293 /* ALWAYS called with liblock held */
296 if ((md->md_options & LNET_MD_KIOV) != 0)
297 size = offsetof(lnet_libmd_t, md_iov.kiov[md->md_niov]);
299 size = offsetof(lnet_libmd_t, md_iov.iov[md->md_niov]);
301 LIBCFS_FREE(md, size);
304 static inline lnet_me_t *
307 /* NEVER called with liblock held */
310 LIBCFS_ALLOC(me, sizeof(*me));
315 lnet_me_free(lnet_me_t *me)
317 /* ALWAYS called with liblock held */
318 LIBCFS_FREE(me, sizeof(*me));
321 static inline lnet_msg_t *
324 /* NEVER called with liblock held */
327 LIBCFS_ALLOC(msg, sizeof(*msg));
330 /* NULL pointers, clear flags etc */
331 memset (msg, 0, sizeof (*msg));
333 msg->msg_ev.uid = LNET_UID_ANY;
340 lnet_msg_free(lnet_msg_t *msg)
342 /* ALWAYS called with liblock held */
343 LASSERT (!msg->msg_onactivelist);
344 LIBCFS_FREE(msg, sizeof(*msg));
348 extern lnet_libhandle_t *lnet_lookup_cookie (__u64 cookie, int type);
349 extern void lnet_initialise_handle (lnet_libhandle_t *lh, int type);
350 extern void lnet_invalidate_handle (lnet_libhandle_t *lh);
353 lnet_eq2handle (lnet_handle_eq_t *handle, lnet_eq_t *eq)
356 *handle = LNET_EQ_NONE;
360 handle->cookie = eq->eq_lh.lh_cookie;
363 static inline lnet_eq_t *
364 lnet_handle2eq (lnet_handle_eq_t *handle)
366 /* ALWAYS called with liblock held */
367 lnet_libhandle_t *lh = lnet_lookup_cookie(handle->cookie,
368 LNET_COOKIE_TYPE_EQ);
372 return (lh_entry (lh, lnet_eq_t, eq_lh));
376 lnet_md2handle (lnet_handle_md_t *handle, lnet_libmd_t *md)
378 handle->cookie = md->md_lh.lh_cookie;
381 static inline lnet_libmd_t *
382 lnet_handle2md (lnet_handle_md_t *handle)
384 /* ALWAYS called with liblock held */
385 lnet_libhandle_t *lh = lnet_lookup_cookie(handle->cookie,
386 LNET_COOKIE_TYPE_MD);
390 return (lh_entry (lh, lnet_libmd_t, md_lh));
393 static inline lnet_libmd_t *
394 lnet_wire_handle2md (lnet_handle_wire_t *wh)
396 /* ALWAYS called with liblock held */
397 lnet_libhandle_t *lh;
399 if (wh->wh_interface_cookie != the_lnet.ln_interface_cookie)
402 lh = lnet_lookup_cookie(wh->wh_object_cookie,
403 LNET_COOKIE_TYPE_MD);
407 return (lh_entry (lh, lnet_libmd_t, md_lh));
411 lnet_me2handle (lnet_handle_me_t *handle, lnet_me_t *me)
413 handle->cookie = me->me_lh.lh_cookie;
416 static inline lnet_me_t *
417 lnet_handle2me (lnet_handle_me_t *handle)
419 /* ALWAYS called with liblock held */
420 lnet_libhandle_t *lh = lnet_lookup_cookie(handle->cookie,
421 LNET_COOKIE_TYPE_ME);
425 return (lh_entry (lh, lnet_me_t, me_lh));
429 lnet_peer_addref_locked(lnet_peer_t *lp)
431 LASSERT (lp->lp_refcount > 0);
435 extern void lnet_destroy_peer_locked(lnet_peer_t *lp);
438 lnet_peer_decref_locked(lnet_peer_t *lp)
440 LASSERT (lp->lp_refcount > 0);
442 if (lp->lp_refcount == 0)
443 lnet_destroy_peer_locked(lp);
447 lnet_isrouter(lnet_peer_t *lp)
449 return lp->lp_rtr_refcount != 0;
453 lnet_ni_addref_locked(lnet_ni_t *ni)
455 LASSERT (ni->ni_refcount > 0);
460 lnet_ni_addref(lnet_ni_t *ni)
463 lnet_ni_addref_locked(ni);
468 lnet_ni_decref_locked(lnet_ni_t *ni)
470 LASSERT (ni->ni_refcount > 0);
472 if (ni->ni_refcount == 0)
473 list_add_tail(&ni->ni_list, &the_lnet.ln_zombie_nis);
477 lnet_ni_decref(lnet_ni_t *ni)
480 lnet_ni_decref_locked(ni);
484 static inline struct list_head *
485 lnet_nid2peerhash (lnet_nid_t nid)
487 unsigned int idx = LNET_NIDADDR(nid) % LNET_PEER_HASHSIZE;
489 return &the_lnet.ln_peer_hash[idx];
492 extern lnd_t the_lolnd;
495 /* unconditional registration */
496 #define LNET_REGISTER_ULND(lnd) \
500 lnet_register_lnd(&(lnd)); \
503 /* conditional registration */
504 #define LNET_REGISTER_ULND_IF_PRESENT(lnd) \
506 extern lnd_t lnd __attribute__ ((weak, alias("the_lolnd"))); \
508 if (&(lnd) != &the_lolnd) \
509 lnet_register_lnd(&(lnd)); \
515 lnet_set_msg_uid(lnet_ni_t *ni, lnet_msg_t *msg, lnet_uid_t uid)
517 LASSERT (msg->msg_ev.uid == LNET_UID_ANY);
518 msg->msg_ev.uid = uid;
522 extern lnet_ni_t *lnet_nid2ni_locked (lnet_nid_t nid);
523 extern lnet_ni_t *lnet_net2ni_locked (__u32 net);
524 static inline lnet_ni_t *
525 lnet_net2ni (__u32 net)
530 ni = lnet_net2ni_locked(net);
536 int lnet_notify(lnet_ni_t *ni, lnet_nid_t peer, int alive, time_t when);
537 int lnet_add_route(__u32 net, unsigned int hops, lnet_nid_t gateway_nid);
538 int lnet_check_routes(void);
539 int lnet_del_route(__u32 net, lnet_nid_t gw_nid);
540 void lnet_destroy_routes(void);
541 int lnet_get_route(int idx, __u32 *net, __u32 *hops,
542 lnet_nid_t *gateway, __u32 *alive);
543 void lnet_proc_init(void);
544 void lnet_proc_fini(void);
545 void lnet_init_rtrpools(void);
546 int lnet_alloc_rtrpools(int im_a_router);
547 void lnet_free_rtrpools(void);
548 lnet_remotenet_t *lnet_find_net_locked (__u32 net);
550 int lnet_islocalnid(lnet_nid_t nid);
551 int lnet_islocalnet(__u32 net);
553 void lnet_build_unlink_event(lnet_libmd_t *md, lnet_event_t *ev);
554 void lnet_enq_event_locked(lnet_eq_t *eq, lnet_event_t *ev);
555 void lnet_prep_send(lnet_msg_t *msg, int type, lnet_process_id_t target,
556 unsigned int offset, unsigned int len);
557 int lnet_send(lnet_nid_t nid, lnet_msg_t *msg);
558 void lnet_return_credits_locked (lnet_msg_t *msg);
559 void lnet_match_blocked_msg(lnet_libmd_t *md);
560 int lnet_parse (lnet_ni_t *ni, lnet_hdr_t *hdr,
561 lnet_nid_t fromnid, void *private, int rdma_req);
562 void lnet_recv(lnet_ni_t *ni, void *private, lnet_msg_t *msg, int delayed,
563 unsigned int offset, unsigned int mlen, unsigned int rlen);
564 lnet_msg_t *lnet_create_reply_msg (lnet_ni_t *ni, lnet_msg_t *get_msg);
565 void lnet_set_reply_msg_len(lnet_ni_t *ni, lnet_msg_t *msg, unsigned int len);
566 void lnet_finalize(lnet_ni_t *ni, lnet_msg_t *msg, int rc);
568 char *lnet_msgtyp2str (int type);
569 void lnet_print_hdr (lnet_hdr_t * hdr);
570 int lnet_fail_nid(lnet_nid_t nid, unsigned int threshold);
572 unsigned int lnet_iov_nob (unsigned int niov, struct iovec *iov);
573 int lnet_extract_iov (int dst_niov, struct iovec *dst,
574 int src_niov, struct iovec *src,
575 unsigned int offset, unsigned int len);
577 unsigned int lnet_kiov_nob (unsigned int niov, lnet_kiov_t *iov);
578 int lnet_extract_kiov (int dst_niov, lnet_kiov_t *dst,
579 int src_niov, lnet_kiov_t *src,
580 unsigned int offset, unsigned int len);
582 void lnet_copy_iov2iov (unsigned int ndiov, struct iovec *diov,
583 unsigned int doffset,
584 unsigned int nsiov, struct iovec *siov,
585 unsigned int soffset, unsigned int nob);
586 void lnet_copy_kiov2iov (unsigned int niov, struct iovec *iov,
587 unsigned int iovoffset,
588 unsigned int nkiov, lnet_kiov_t *kiov,
589 unsigned int kiovoffset, unsigned int nob);
590 void lnet_copy_iov2kiov (unsigned int nkiov, lnet_kiov_t *kiov,
591 unsigned int kiovoffset,
592 unsigned int niov, struct iovec *iov,
593 unsigned int iovoffset, unsigned int nob);
594 void lnet_copy_kiov2kiov (unsigned int ndkiov, lnet_kiov_t *dkiov,
595 unsigned int doffset,
596 unsigned int nskiov, lnet_kiov_t *skiov,
597 unsigned int soffset, unsigned int nob);
600 lnet_copy_iov2flat(int dlen, void *dest, unsigned int doffset,
601 unsigned int nsiov, struct iovec *siov, unsigned int soffset,
604 struct iovec diov = {/*.iov_base = */ dest, /*.iov_len = */ dlen};
606 lnet_copy_iov2iov(1, &diov, doffset,
607 nsiov, siov, soffset, nob);
611 lnet_copy_kiov2flat(int dlen, void *dest, unsigned int doffset,
612 unsigned int nsiov, lnet_kiov_t *skiov, unsigned int soffset,
615 struct iovec diov = {/* .iov_base = */ dest, /* .iov_len = */ dlen};
617 lnet_copy_kiov2iov(1, &diov, doffset,
618 nsiov, skiov, soffset, nob);
622 lnet_copy_flat2iov(unsigned int ndiov, struct iovec *diov, unsigned int doffset,
623 int slen, void *src, unsigned int soffset, unsigned int nob)
625 struct iovec siov = {/*.iov_base = */ src, /*.iov_len = */slen};
626 lnet_copy_iov2iov(ndiov, diov, doffset,
627 1, &siov, soffset, nob);
631 lnet_copy_flat2kiov(unsigned int ndiov, lnet_kiov_t *dkiov, unsigned int doffset,
632 int slen, void *src, unsigned int soffset, unsigned int nob)
634 struct iovec siov = {/* .iov_base = */ src, /* .iov_len = */ slen};
635 lnet_copy_iov2kiov(ndiov, dkiov, doffset,
636 1, &siov, soffset, nob);
639 void lnet_me_unlink(lnet_me_t *me);
641 void lnet_md_unlink(lnet_libmd_t *md);
642 void lnet_md_deconstruct(lnet_libmd_t *lmd, lnet_md_t *umd);
644 void lnet_register_lnd(lnd_t *lnd);
645 void lnet_unregister_lnd(lnd_t *lnd);
646 int lnet_set_ip_niaddr (lnet_ni_t *ni);
649 int lnet_connect(cfs_socket_t **sockp, lnet_nid_t peer_nid,
650 __u32 local_ip, __u32 peer_ip, int peer_port);
651 void lnet_connect_console_error(int rc, lnet_nid_t peer_nid,
652 __u32 peer_ip, int port);
653 int lnet_count_acceptor_nis(void);
654 int lnet_acceptor_timeout(void);
655 int lnet_acceptor_port(void);
658 #ifdef HAVE_LIBPTHREAD
659 int lnet_count_acceptor_nis(void);
660 int lnet_acceptor_port(void);
663 int lnet_acceptor_start(void);
664 void lnet_acceptor_stop(void);
666 int lnet_peers_start_down(void);
667 int lnet_router_checker_start(void);
668 void lnet_router_checker_stop(void);
670 int lnet_ping_target_init(void);
671 void lnet_ping_target_fini(void);
672 int lnet_ping(lnet_process_id_t id, int timeout_ms,
673 lnet_process_id_t *ids, int n_ids);
675 int lnet_parse_ip2nets (char **networksp, char *ip2nets);
676 int lnet_parse_routes (char *route_str, int *im_a_router);
677 int lnet_parse_networks (struct list_head *nilist, char *networks);
679 int lnet_nid2peer_locked(lnet_peer_t **lpp, lnet_nid_t nid);
680 lnet_peer_t *lnet_find_peer_locked (lnet_nid_t nid);
681 void lnet_clear_peer_table(void);
682 void lnet_destroy_peer_table(void);
683 int lnet_create_peer_table(void);
684 void lnet_debug_peer(lnet_nid_t nid);