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));
92 #define LNET_LOCK() cfs_spin_lock(&the_lnet.ln_lock)
93 #define LNET_UNLOCK() cfs_spin_unlock(&the_lnet.ln_lock)
94 #define LNET_MUTEX_DOWN(m) cfs_mutex_down(m)
95 #define LNET_MUTEX_UP(m) cfs_mutex_up(m)
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 (cfs_list_empty (&fl->fl_list))
140 o = cfs_list_entry (fl->fl_list.next, lnet_freeobj_t, fo_list);
141 cfs_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 = cfs_list_entry (obj, lnet_freeobj_t, fo_contents);
151 cfs_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);
186 CFS_INIT_LIST_HEAD(&md->md_list);
192 lnet_md_free (lnet_libmd_t *md)
194 /* ALWAYS called with liblock held */
195 lnet_freelist_free (&the_lnet.ln_free_mds, md);
198 static inline lnet_me_t *
201 /* NEVER called with liblock held */
205 me = (lnet_me_t *)lnet_freelist_alloc(&the_lnet.ln_free_mes);
212 lnet_me_free (lnet_me_t *me)
214 /* ALWAYS called with liblock held */
215 lnet_freelist_free (&the_lnet.ln_free_mes, me);
218 static inline lnet_msg_t *
219 lnet_msg_alloc (void)
221 /* NEVER called with liblock held */
225 msg = (lnet_msg_t *)lnet_freelist_alloc(&the_lnet.ln_free_msgs);
229 /* NULL pointers, clear flags etc */
230 memset (msg, 0, sizeof (*msg));
232 msg->msg_ev.uid = LNET_UID_ANY;
239 lnet_msg_free (lnet_msg_t *msg)
241 /* ALWAYS called with liblock held */
242 LASSERT (!msg->msg_onactivelist);
243 lnet_freelist_free(&the_lnet.ln_free_msgs, msg);
248 static inline lnet_eq_t *
251 /* NEVER called with liblock held */
254 LIBCFS_ALLOC(eq, sizeof(*eq));
259 lnet_eq_free (lnet_eq_t *eq)
261 /* ALWAYS called with liblock held */
262 LIBCFS_FREE(eq, sizeof(*eq));
265 static inline lnet_libmd_t *
266 lnet_md_alloc (lnet_md_t *umd)
268 /* NEVER called with liblock held */
273 if ((umd->options & LNET_MD_KIOV) != 0) {
275 size = offsetof(lnet_libmd_t, md_iov.kiov[niov]);
277 niov = ((umd->options & LNET_MD_IOVEC) != 0) ?
279 size = offsetof(lnet_libmd_t, md_iov.iov[niov]);
282 LIBCFS_ALLOC(md, size);
285 /* Set here in case of early free */
286 md->md_options = umd->options;
288 CFS_INIT_LIST_HEAD(&md->md_list);
295 lnet_md_free (lnet_libmd_t *md)
297 /* ALWAYS called with liblock held */
300 if ((md->md_options & LNET_MD_KIOV) != 0)
301 size = offsetof(lnet_libmd_t, md_iov.kiov[md->md_niov]);
303 size = offsetof(lnet_libmd_t, md_iov.iov[md->md_niov]);
305 LIBCFS_FREE(md, size);
308 static inline lnet_me_t *
311 /* NEVER called with liblock held */
314 LIBCFS_ALLOC(me, sizeof(*me));
319 lnet_me_free(lnet_me_t *me)
321 /* ALWAYS called with liblock held */
322 LIBCFS_FREE(me, sizeof(*me));
325 static inline lnet_msg_t *
328 /* NEVER called with liblock held */
331 LIBCFS_ALLOC(msg, sizeof(*msg));
334 /* NULL pointers, clear flags etc */
335 memset (msg, 0, sizeof (*msg));
337 msg->msg_ev.uid = LNET_UID_ANY;
344 lnet_msg_free(lnet_msg_t *msg)
346 /* ALWAYS called with liblock held */
347 LASSERT (!msg->msg_onactivelist);
348 LIBCFS_FREE(msg, sizeof(*msg));
352 extern lnet_libhandle_t *lnet_lookup_cookie (__u64 cookie, int type);
353 extern void lnet_initialise_handle (lnet_libhandle_t *lh, int type);
354 extern void lnet_invalidate_handle (lnet_libhandle_t *lh);
357 lnet_eq2handle (lnet_handle_eq_t *handle, lnet_eq_t *eq)
360 LNetInvalidateHandle(handle);
364 handle->cookie = eq->eq_lh.lh_cookie;
367 static inline lnet_eq_t *
368 lnet_handle2eq (lnet_handle_eq_t *handle)
370 /* ALWAYS called with liblock held */
371 lnet_libhandle_t *lh = lnet_lookup_cookie(handle->cookie,
372 LNET_COOKIE_TYPE_EQ);
376 return (lh_entry (lh, lnet_eq_t, eq_lh));
380 lnet_md2handle (lnet_handle_md_t *handle, lnet_libmd_t *md)
382 handle->cookie = md->md_lh.lh_cookie;
385 static inline lnet_libmd_t *
386 lnet_handle2md (lnet_handle_md_t *handle)
388 /* ALWAYS called with liblock held */
389 lnet_libhandle_t *lh = lnet_lookup_cookie(handle->cookie,
390 LNET_COOKIE_TYPE_MD);
394 return (lh_entry (lh, lnet_libmd_t, md_lh));
397 static inline lnet_libmd_t *
398 lnet_wire_handle2md (lnet_handle_wire_t *wh)
400 /* ALWAYS called with liblock held */
401 lnet_libhandle_t *lh;
403 if (wh->wh_interface_cookie != the_lnet.ln_interface_cookie)
406 lh = lnet_lookup_cookie(wh->wh_object_cookie,
407 LNET_COOKIE_TYPE_MD);
411 return (lh_entry (lh, lnet_libmd_t, md_lh));
415 lnet_me2handle (lnet_handle_me_t *handle, lnet_me_t *me)
417 handle->cookie = me->me_lh.lh_cookie;
420 static inline lnet_me_t *
421 lnet_handle2me (lnet_handle_me_t *handle)
423 /* ALWAYS called with liblock held */
424 lnet_libhandle_t *lh = lnet_lookup_cookie(handle->cookie,
425 LNET_COOKIE_TYPE_ME);
429 return (lh_entry (lh, lnet_me_t, me_lh));
433 lnet_peer_addref_locked(lnet_peer_t *lp)
435 LASSERT (lp->lp_refcount > 0);
439 extern void lnet_destroy_peer_locked(lnet_peer_t *lp);
442 lnet_peer_decref_locked(lnet_peer_t *lp)
444 LASSERT (lp->lp_refcount > 0);
446 if (lp->lp_refcount == 0)
447 lnet_destroy_peer_locked(lp);
451 lnet_isrouter(lnet_peer_t *lp)
453 return lp->lp_rtr_refcount != 0;
457 lnet_ni_addref_locked(lnet_ni_t *ni)
459 LASSERT (ni->ni_refcount > 0);
464 lnet_ni_addref(lnet_ni_t *ni)
467 lnet_ni_addref_locked(ni);
472 lnet_ni_decref_locked(lnet_ni_t *ni)
474 LASSERT (ni->ni_refcount > 0);
476 if (ni->ni_refcount == 0)
477 cfs_list_add_tail(&ni->ni_list, &the_lnet.ln_zombie_nis);
481 lnet_ni_decref(lnet_ni_t *ni)
484 lnet_ni_decref_locked(ni);
488 static inline cfs_list_t *
489 lnet_nid2peerhash (lnet_nid_t nid)
491 unsigned int idx = LNET_NIDADDR(nid) % LNET_PEER_HASHSIZE;
493 return &the_lnet.ln_peer_hash[idx];
496 extern lnd_t the_lolnd;
499 /* unconditional registration */
500 #define LNET_REGISTER_ULND(lnd) \
504 lnet_register_lnd(&(lnd)); \
507 /* conditional registration */
508 #define LNET_REGISTER_ULND_IF_PRESENT(lnd) \
510 extern lnd_t lnd __attribute__ ((weak, alias("the_lolnd"))); \
512 if (&(lnd) != &the_lolnd) \
513 lnet_register_lnd(&(lnd)); \
519 lnet_set_msg_uid(lnet_ni_t *ni, lnet_msg_t *msg, lnet_uid_t uid)
521 LASSERT (msg->msg_ev.uid == LNET_UID_ANY);
522 msg->msg_ev.uid = uid;
526 extern lnet_ni_t *lnet_nid2ni_locked (lnet_nid_t nid);
527 extern lnet_ni_t *lnet_net2ni_locked (__u32 net);
528 static inline lnet_ni_t *
529 lnet_net2ni (__u32 net)
534 ni = lnet_net2ni_locked(net);
540 int lnet_notify(lnet_ni_t *ni, lnet_nid_t peer, int alive, cfs_time_t when);
541 void lnet_notify_locked(lnet_peer_t *lp, int notifylnd, int alive, cfs_time_t when);
542 int lnet_add_route(__u32 net, unsigned int hops, lnet_nid_t gateway_nid);
543 int lnet_check_routes(void);
544 int lnet_del_route(__u32 net, lnet_nid_t gw_nid);
545 void lnet_destroy_routes(void);
546 int lnet_get_route(int idx, __u32 *net, __u32 *hops,
547 lnet_nid_t *gateway, __u32 *alive);
548 void lnet_proc_init(void);
549 void lnet_proc_fini(void);
550 void lnet_init_rtrpools(void);
551 int lnet_alloc_rtrpools(int im_a_router);
552 void lnet_free_rtrpools(void);
553 lnet_remotenet_t *lnet_find_net_locked (__u32 net);
555 int lnet_islocalnid(lnet_nid_t nid);
556 int lnet_islocalnet(__u32 net);
558 void lnet_build_unlink_event(lnet_libmd_t *md, lnet_event_t *ev);
559 void lnet_enq_event_locked(lnet_eq_t *eq, lnet_event_t *ev);
560 void lnet_prep_send(lnet_msg_t *msg, int type, lnet_process_id_t target,
561 unsigned int offset, unsigned int len);
562 int lnet_send(lnet_nid_t nid, lnet_msg_t *msg);
563 void lnet_return_credits_locked (lnet_msg_t *msg);
564 void lnet_match_blocked_msg(lnet_libmd_t *md);
565 int lnet_parse (lnet_ni_t *ni, lnet_hdr_t *hdr,
566 lnet_nid_t fromnid, void *private, int rdma_req);
567 void lnet_recv(lnet_ni_t *ni, void *private, lnet_msg_t *msg, int delayed,
568 unsigned int offset, unsigned int mlen, unsigned int rlen);
569 lnet_msg_t *lnet_create_reply_msg (lnet_ni_t *ni, lnet_msg_t *get_msg);
570 void lnet_set_reply_msg_len(lnet_ni_t *ni, lnet_msg_t *msg, unsigned int len);
571 void lnet_finalize(lnet_ni_t *ni, lnet_msg_t *msg, int rc);
573 char *lnet_msgtyp2str (int type);
574 void lnet_print_hdr (lnet_hdr_t * hdr);
575 int lnet_fail_nid(lnet_nid_t nid, unsigned int threshold);
577 unsigned int lnet_iov_nob (unsigned int niov, struct iovec *iov);
578 int lnet_extract_iov (int dst_niov, struct iovec *dst,
579 int src_niov, struct iovec *src,
580 unsigned int offset, unsigned int len);
582 unsigned int lnet_kiov_nob (unsigned int niov, lnet_kiov_t *iov);
583 int lnet_extract_kiov (int dst_niov, lnet_kiov_t *dst,
584 int src_niov, lnet_kiov_t *src,
585 unsigned int offset, unsigned int len);
587 void lnet_copy_iov2iov (unsigned int ndiov, struct iovec *diov,
588 unsigned int doffset,
589 unsigned int nsiov, struct iovec *siov,
590 unsigned int soffset, unsigned int nob);
591 void lnet_copy_kiov2iov (unsigned int niov, struct iovec *iov,
592 unsigned int iovoffset,
593 unsigned int nkiov, lnet_kiov_t *kiov,
594 unsigned int kiovoffset, unsigned int nob);
595 void lnet_copy_iov2kiov (unsigned int nkiov, lnet_kiov_t *kiov,
596 unsigned int kiovoffset,
597 unsigned int niov, struct iovec *iov,
598 unsigned int iovoffset, unsigned int nob);
599 void lnet_copy_kiov2kiov (unsigned int ndkiov, lnet_kiov_t *dkiov,
600 unsigned int doffset,
601 unsigned int nskiov, lnet_kiov_t *skiov,
602 unsigned int soffset, unsigned int nob);
605 lnet_copy_iov2flat(int dlen, void *dest, unsigned int doffset,
606 unsigned int nsiov, struct iovec *siov, unsigned int soffset,
609 struct iovec diov = {/*.iov_base = */ dest, /*.iov_len = */ dlen};
611 lnet_copy_iov2iov(1, &diov, doffset,
612 nsiov, siov, soffset, nob);
616 lnet_copy_kiov2flat(int dlen, void *dest, unsigned int doffset,
617 unsigned int nsiov, lnet_kiov_t *skiov, unsigned int soffset,
620 struct iovec diov = {/* .iov_base = */ dest, /* .iov_len = */ dlen};
622 lnet_copy_kiov2iov(1, &diov, doffset,
623 nsiov, skiov, soffset, nob);
627 lnet_copy_flat2iov(unsigned int ndiov, struct iovec *diov, unsigned int doffset,
628 int slen, void *src, unsigned int soffset, unsigned int nob)
630 struct iovec siov = {/*.iov_base = */ src, /*.iov_len = */slen};
631 lnet_copy_iov2iov(ndiov, diov, doffset,
632 1, &siov, soffset, nob);
636 lnet_copy_flat2kiov(unsigned int ndiov, lnet_kiov_t *dkiov, unsigned int doffset,
637 int slen, void *src, unsigned int soffset, unsigned int nob)
639 struct iovec siov = {/* .iov_base = */ src, /* .iov_len = */ slen};
640 lnet_copy_iov2kiov(ndiov, dkiov, doffset,
641 1, &siov, soffset, nob);
644 void lnet_me_unlink(lnet_me_t *me);
646 void lnet_md_unlink(lnet_libmd_t *md);
647 void lnet_md_deconstruct(lnet_libmd_t *lmd, lnet_md_t *umd);
649 void lnet_register_lnd(lnd_t *lnd);
650 void lnet_unregister_lnd(lnd_t *lnd);
651 int lnet_set_ip_niaddr (lnet_ni_t *ni);
654 int lnet_connect(cfs_socket_t **sockp, lnet_nid_t peer_nid,
655 __u32 local_ip, __u32 peer_ip, int peer_port);
656 void lnet_connect_console_error(int rc, lnet_nid_t peer_nid,
657 __u32 peer_ip, int port);
658 int lnet_count_acceptor_nis(void);
659 int lnet_acceptor_timeout(void);
660 int lnet_acceptor_port(void);
662 void lnet_router_checker(void);
666 int lnet_count_acceptor_nis(void);
667 int lnet_acceptor_port(void);
670 int lnet_acceptor_start(void);
671 void lnet_acceptor_stop(void);
673 void lnet_get_tunables(void);
674 int lnet_peers_start_down(void);
675 int lnet_peer_buffer_credits(lnet_ni_t *ni);
677 int lnet_router_checker_start(void);
678 void lnet_router_checker_stop(void);
679 void lnet_swap_pinginfo(lnet_ping_info_t *info);
680 int lnet_router_down_ni(lnet_peer_t *rtr, __u32 net);
682 int lnet_ping_target_init(void);
683 void lnet_ping_target_fini(void);
684 int lnet_ping(lnet_process_id_t id, int timeout_ms,
685 lnet_process_id_t *ids, int n_ids);
687 int lnet_parse_ip2nets (char **networksp, char *ip2nets);
688 int lnet_parse_routes (char *route_str, int *im_a_router);
689 int lnet_parse_networks (cfs_list_t *nilist, char *networks);
691 int lnet_nid2peer_locked(lnet_peer_t **lpp, lnet_nid_t nid);
692 lnet_peer_t *lnet_find_peer_locked (lnet_nid_t nid);
693 void lnet_clear_peer_table(void);
694 void lnet_destroy_peer_table(void);
695 int lnet_create_peer_table(void);
696 void lnet_debug_peer(lnet_nid_t nid);
700 lnet_parse_int_tunable(int *value, char *name)
702 char *env = getenv(name);
708 *value = strtoull(env, &end, 0);
712 CERROR("Can't parse tunable %s=%s\n", name, env);