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-types.h
38 * Types used by the library side routines that do not need to be
39 * exposed to the user application
42 #ifndef __LNET_LIB_TYPES_H__
43 #define __LNET_LIB_TYPES_H__
45 #if defined(__linux__)
46 #include <lnet/linux/lib-types.h>
47 #elif defined(__APPLE__)
48 #include <lnet/darwin/lib-types.h>
49 #elif defined(__WINNT__)
50 #include <lnet/winnt/lib-types.h>
52 #error Unsupported Operating System
55 #include <libcfs/libcfs.h>
56 #include <libcfs/list.h>
57 #include <lnet/types.h>
59 #define WIRE_ATTR __attribute__((packed))
61 /* Packed version of lnet_process_id_t to transfer via network */
62 #include <libcfs/libcfs_pack.h>
65 lnet_pid_t pid; /* node id / process id */
66 } WIRE_ATTR lnet_process_id_packed_t;
68 /* The wire handle's interface cookie only matches one network interface in
69 * one epoch (i.e. new cookie when the interface restarts or the node
70 * reboots). The object cookie only matches one object on that interface
71 * during that object's lifetime (i.e. no cookie re-use). */
73 __u64 wh_interface_cookie;
74 __u64 wh_object_cookie;
75 } WIRE_ATTR lnet_handle_wire_t;
76 #include <libcfs/libcfs_unpack.h>
86 /* The variant fields of the portals message header are aligned on an 8
87 * byte boundary in the message header. Note that all types used in these
88 * wire structs MUST be fixed size and the smaller types are placed at the
90 #include <libcfs/libcfs_pack.h>
91 typedef struct lnet_ack {
92 lnet_handle_wire_t dst_wmd;
95 } WIRE_ATTR lnet_ack_t;
97 typedef struct lnet_put {
98 lnet_handle_wire_t ack_wmd;
103 } WIRE_ATTR lnet_put_t;
105 typedef struct lnet_get {
106 lnet_handle_wire_t return_wmd;
111 } WIRE_ATTR lnet_get_t;
113 typedef struct lnet_reply {
114 lnet_handle_wire_t dst_wmd;
115 } WIRE_ATTR lnet_reply_t;
117 typedef struct lnet_hello {
120 } WIRE_ATTR lnet_hello_t;
127 __u32 type; /* lnet_msg_type_t */
128 __u32 payload_length; /* payload data to follow */
129 /*<------__u64 aligned------->*/
137 } WIRE_ATTR lnet_hdr_t;
139 /* A HELLO message contains a magic number and protocol version
140 * code in the header's dest_nid, the peer's NID in the src_nid, and
141 * LNET_MSG_HELLO in the type field. All other common fields are zero
142 * (including payload_size; i.e. no payload).
143 * This is for use by byte-stream LNDs (e.g. TCP/IP) to check the peer is
144 * running the same protocol and to find out its NID. These LNDs should
145 * exchange HELLO messages when a connection is first established. Individual
146 * LNDs can put whatever else they fancy in lnet_hdr_t::msg.
149 __u32 magic; /* LNET_PROTO_TCP_MAGIC */
150 __u16 version_major; /* increment on incompatible change */
151 __u16 version_minor; /* increment on compatible change */
152 } WIRE_ATTR lnet_magicversion_t;
154 /* PROTO MAGIC for LNDs */
155 #define LNET_PROTO_IB_MAGIC 0x0be91b91
156 #define LNET_PROTO_OPENIB_MAGIC LNET_PROTO_IB_MAGIC
157 #define LNET_PROTO_IIB_MAGIC LNET_PROTO_IB_MAGIC
158 #define LNET_PROTO_VIB_MAGIC LNET_PROTO_IB_MAGIC
159 #define LNET_PROTO_RA_MAGIC 0x0be91b92
160 #define LNET_PROTO_QSW_MAGIC 0x0be91b93
161 #define LNET_PROTO_TCP_MAGIC 0xeebc0ded
162 #define LNET_PROTO_PTL_MAGIC 0x50746C4E /* 'PtlN' unique magic */
163 #define LNET_PROTO_GM_MAGIC 0x6d797269 /* 'myri'! */
164 #define LNET_PROTO_MX_MAGIC 0x4d583130 /* 'MX10'! */
165 #define LNET_PROTO_ACCEPTOR_MAGIC 0xacce7100
166 #define LNET_PROTO_PING_MAGIC 0x70696E67 /* 'ping' */
168 /* Placeholder for a future "unified" protocol across all LNDs */
169 /* Current LNDs that receive a request with this magic will respond with a
170 * "stub" reply using their current protocol */
171 #define LNET_PROTO_MAGIC 0x45726963 /* ! */
174 #define LNET_PROTO_TCP_VERSION_MAJOR 1
175 #define LNET_PROTO_TCP_VERSION_MINOR 0
177 /* Acceptor connection request */
179 __u32 acr_magic; /* PTL_ACCEPTOR_PROTO_MAGIC */
180 __u32 acr_version; /* protocol version */
181 __u64 acr_nid; /* target NID */
182 } WIRE_ATTR lnet_acceptor_connreq_t;
183 #include <libcfs/libcfs_unpack.h>
185 #define LNET_PROTO_ACCEPTOR_VERSION 1
190 typedef struct lnet_msg {
191 cfs_list_t msg_activelist;
192 cfs_list_t msg_list; /* Q for credits/MD */
194 lnet_process_id_t msg_target;
197 unsigned int msg_target_is_router:1; /* sending to a router */
198 unsigned int msg_routing:1; /* being forwarded */
199 unsigned int msg_ack:1; /* ack on finalize (PUT) */
200 unsigned int msg_sending:1; /* outgoing message */
201 unsigned int msg_receiving:1; /* being received */
202 unsigned int msg_delayed:1; /* had to Q for buffer or tx credit */
203 unsigned int msg_txcredit:1; /* taken an NI send credit */
204 unsigned int msg_peertxcredit:1; /* taken a peer send credit */
205 unsigned int msg_rtrcredit:1; /* taken a globel router credit */
206 unsigned int msg_peerrtrcredit:1; /* taken a peer router credit */
207 unsigned int msg_onactivelist:1; /* on the activelist */
209 struct lnet_peer *msg_txpeer; /* peer I'm sending to */
210 struct lnet_peer *msg_rxpeer; /* peer I received from */
213 struct lnet_libmd *msg_md;
215 unsigned int msg_len;
216 unsigned int msg_wanted;
217 unsigned int msg_offset;
218 unsigned int msg_niov;
219 struct iovec *msg_iov;
220 lnet_kiov_t *msg_kiov;
227 typedef struct lnet_libhandle {
228 cfs_list_t lh_hash_chain;
232 #define lh_entry(ptr, type, member) \
233 ((type *)((char *)(ptr)-(char *)(&((type *)0)->member)))
235 typedef struct lnet_eq {
237 lnet_libhandle_t eq_lh;
238 lnet_seq_t eq_enq_seq;
239 lnet_seq_t eq_deq_seq;
240 unsigned int eq_size;
241 lnet_event_t *eq_events;
243 lnet_eq_handler_t eq_callback;
246 typedef struct lnet_me {
248 lnet_libhandle_t me_lh;
249 lnet_process_id_t me_match_id;
250 unsigned int me_portal;
252 __u64 me_ignore_bits;
253 lnet_unlink_t me_unlink;
254 struct lnet_libmd *me_md;
257 typedef struct lnet_libmd {
259 lnet_libhandle_t md_lh;
262 unsigned int md_offset;
263 unsigned int md_length;
264 unsigned int md_max_size;
267 unsigned int md_options;
268 unsigned int md_flags;
271 unsigned int md_niov; /* # frags */
273 struct iovec iov[LNET_MAX_IOV];
274 lnet_kiov_t kiov[LNET_MAX_IOV];
278 #define LNET_MD_FLAG_ZOMBIE (1 << 0)
279 #define LNET_MD_FLAG_AUTO_UNLINK (1 << 1)
281 #ifdef LNET_USE_LIB_FREELIST
284 void *fl_objs; /* single contiguous array of objects */
285 int fl_nobjs; /* the number of them */
286 int fl_objsize; /* the size (including overhead) of each of them */
287 cfs_list_t fl_list; /* where they are enqueued */
292 cfs_list_t fo_list; /* enqueue on fl_list */
293 void *fo_contents; /* aligned contents */
298 /* info about peers we are trying to fail */
299 cfs_list_t tp_list; /* ln_test_peers */
300 lnet_nid_t tp_nid; /* matching nid */
301 unsigned int tp_threshold; /* # failures to simulate */
304 #define LNET_COOKIE_TYPE_MD 1
305 #define LNET_COOKIE_TYPE_ME 2
306 #define LNET_COOKIE_TYPE_EQ 3
307 #define LNET_COOKIE_TYPES 4
308 /* LNET_COOKIE_TYPES must be a power of 2, so the cookie type can be
309 * extracted by masking with (LNET_COOKIE_TYPES - 1) */
311 struct lnet_ni; /* forward ref */
313 typedef struct lnet_lnd
315 /* fields managed by portals */
316 cfs_list_t lnd_list; /* stash in the LND table */
317 int lnd_refcount; /* # active instances */
319 /* fields initialised by the LND */
320 unsigned int lnd_type;
322 int (*lnd_startup) (struct lnet_ni *ni);
323 void (*lnd_shutdown) (struct lnet_ni *ni);
324 int (*lnd_ctl)(struct lnet_ni *ni, unsigned int cmd, void *arg);
326 /* In data movement APIs below, payload buffers are described as a set
327 * of 'niov' fragments which are...
329 * in virtual memory (struct iovec *iov != NULL)
331 * in pages (kernel only: plt_kiov_t *kiov != NULL).
332 * The LND may NOT overwrite these fragment descriptors.
333 * An 'offset' and may specify a byte offset within the set of
334 * fragments to start from
337 /* Start sending a preformatted message. 'private' is NULL for PUT and
338 * GET messages; otherwise this is a response to an incoming message
339 * and 'private' is the 'private' passed to lnet_parse(). Return
340 * non-zero for immediate failure, otherwise complete later with
342 int (*lnd_send)(struct lnet_ni *ni, void *private, lnet_msg_t *msg);
344 /* Start receiving 'mlen' bytes of payload data, skipping the following
345 * 'rlen' - 'mlen' bytes. 'private' is the 'private' passed to
346 * lnet_parse(). Return non-zero for immedaite failure, otherwise
347 * complete later with lnet_finalize(). This also gives back a receive
348 * credit if the LND does flow control. */
349 int (*lnd_recv)(struct lnet_ni *ni, void *private, lnet_msg_t *msg,
350 int delayed, unsigned int niov,
351 struct iovec *iov, lnet_kiov_t *kiov,
352 unsigned int offset, unsigned int mlen, unsigned int rlen);
354 /* lnet_parse() has had to delay processing of this message
355 * (e.g. waiting for a forwarding buffer or send credits). Give the
356 * LND a chance to free urgently needed resources. If called, return 0
357 * for success and do NOT give back a receive credit; that has to wait
358 * until lnd_recv() gets called. On failure return < 0 and
359 * release resources; lnd_recv() will not be called. */
360 int (*lnd_eager_recv)(struct lnet_ni *ni, void *private, lnet_msg_t *msg,
361 void **new_privatep);
363 /* notification of peer health */
364 void (*lnd_notify)(struct lnet_ni *ni, lnet_nid_t peer, int alive);
366 /* query of peer aliveness */
367 void (*lnd_query)(struct lnet_ni *ni, lnet_nid_t peer, cfs_time_t *when);
369 #if defined(__KERNEL__) || defined(HAVE_PTHREAD)
370 /* accept a new connection */
371 int (*lnd_accept)(struct lnet_ni *ni, cfs_socket_t *sock);
375 /* wait for something to happen */
376 void (*lnd_wait)(struct lnet_ni *ni, int milliseconds);
378 /* ensure non-RDMA messages can be received outside liblustre */
379 int (*lnd_setasync)(struct lnet_ni *ni, lnet_process_id_t id, int nasync);
383 #define LNET_NI_STATUS_UP 0x15aac0de
384 #define LNET_NI_STATUS_DOWN 0xdeadface
385 #define LNET_NI_STATUS_INVALID 0x00000000
390 } WIRE_ATTR lnet_ni_status_t;
392 #define LNET_MAX_INTERFACES 16
394 typedef struct lnet_ni {
395 cfs_list_t ni_list; /* chain on ln_nis */
396 cfs_list_t ni_txq; /* messages waiting for tx credits */
397 int ni_maxtxcredits; /* # tx credits */
398 int ni_txcredits; /* # tx credits free */
399 int ni_mintxcredits; /* lowest it's been */
400 int ni_peertxcredits; /* # per-peer send credits */
401 int ni_peerrtrcredits; /* # per-peer router buffer credits */
402 int ni_peertimeout; /* seconds to consider peer dead */
403 lnet_nid_t ni_nid; /* interface's NID */
404 void *ni_data; /* instance-specific data */
405 lnd_t *ni_lnd; /* procedural interface */
406 int ni_refcount; /* reference count */
407 cfs_time_t ni_last_alive; /* when I was last alive */
408 lnet_ni_status_t *ni_status; /* my health status */
409 char *ni_interfaces[LNET_MAX_INTERFACES]; /* equivalent interfaces to use */
412 #define LNET_PROTO_PING_MATCHBITS 0x8000000000000000LL
413 #define LNET_PROTO_PING_VERSION 2
414 #define LNET_PROTO_PING_VERSION1 1
420 lnet_ni_status_t pi_ni[0];
421 } WIRE_ATTR lnet_ping_info_t;
423 /* router checker data, per router */
424 #define LNET_MAX_RTR_NIS 16
425 #define LNET_PINGINFO_SIZE offsetof(lnet_ping_info_t, pi_ni[LNET_MAX_RTR_NIS])
427 cfs_list_t rcd_list; /* chain on the_lnet.ln_zombie_rcd */
428 lnet_handle_md_t rcd_mdh; /* ping buffer MD */
429 lnet_ping_info_t *rcd_pinginfo; /* ping buffer */
432 typedef struct lnet_peer {
433 cfs_list_t lp_hashlist; /* chain on peer hash */
434 cfs_list_t lp_txq; /* messages blocking for tx credits */
435 cfs_list_t lp_rtrq; /* messages blocking for router credits */
436 cfs_list_t lp_rtr_list; /* chain on router list */
437 int lp_txcredits; /* # tx credits available */
438 int lp_mintxcredits; /* low water mark */
439 int lp_rtrcredits; /* # router credits */
440 int lp_minrtrcredits; /* low water mark */
441 unsigned int lp_alive:1; /* alive/dead? */
442 unsigned int lp_notify:1; /* notification outstanding? */
443 unsigned int lp_notifylnd:1; /* outstanding notification for LND? */
444 unsigned int lp_notifying:1; /* some thread is handling notification */
445 unsigned int lp_ping_notsent; /* SEND event outstanding from ping */
446 int lp_alive_count; /* # times router went dead<->alive */
447 long lp_txqnob; /* bytes queued for sending */
448 cfs_time_t lp_timestamp; /* time of last aliveness news */
449 cfs_time_t lp_ping_timestamp; /* time of last ping attempt */
450 cfs_time_t lp_ping_deadline; /* != 0 if ping reply expected */
451 cfs_time_t lp_last_alive; /* when I was last alive */
452 cfs_time_t lp_last_query; /* when lp_ni was queried last time */
453 lnet_ni_t *lp_ni; /* interface peer is on */
454 lnet_nid_t lp_nid; /* peer's NID */
455 int lp_refcount; /* # refs */
456 int lp_rtr_refcount; /* # refs from lnet_route_t::lr_gateway */
457 lnet_rc_data_t *lp_rcd; /* router checker state */
460 #define lnet_peer_aliveness_enabled(lp) ((lp)->lp_ni->ni_peertimeout > 0)
463 cfs_list_t lr_list; /* chain on net */
464 lnet_peer_t *lr_gateway; /* router node */
465 unsigned int lr_hops; /* how far I am */
469 cfs_list_t lrn_list; /* chain on ln_remote_nets */
470 cfs_list_t lrn_routes; /* routes to me */
471 __u32 lrn_net; /* my net number */
475 cfs_list_t rbp_bufs; /* my free buffer pool */
476 cfs_list_t rbp_msgs; /* messages blocking for a buffer */
477 int rbp_npages; /* # pages in each buffer */
478 int rbp_nbuffers; /* # buffers */
479 int rbp_credits; /* # free buffers / blocked messages */
480 int rbp_mincredits; /* low water mark */
484 cfs_list_t rb_list; /* chain on rbp_bufs */
485 lnet_rtrbufpool_t *rb_pool; /* owning pool */
486 lnet_kiov_t rb_kiov[0]; /* the buffer space */
489 #include <libcfs/libcfs_pack.h>
502 } WIRE_ATTR lnet_counters_t;
503 #include <libcfs/libcfs_unpack.h>
505 #define LNET_PEER_HASHSIZE 503 /* prime! */
507 #define LNET_NRBPOOLS 3 /* # different router buffer pools */
509 /* Options for lnet_portal_t::ptl_options */
510 #define LNET_PTL_LAZY (1 << 0)
512 cfs_list_t ptl_ml; /* match list */
513 cfs_list_t ptl_msgq; /* messages blocking for MD */
514 __u64 ptl_ml_version; /* validity stamp, only changed for new attached MD */
515 __u64 ptl_msgq_version; /* validity stamp */
516 unsigned int ptl_options;
519 /* Router Checker states */
520 #define LNET_RC_STATE_SHUTDOWN 0 /* not started */
521 #define LNET_RC_STATE_RUNNING 1 /* started up OK */
522 #define LNET_RC_STATE_STOPTHREAD 2 /* telling thread to stop */
523 #define LNET_RC_STATE_UNLINKING 3 /* unlinking RC MD */
524 #define LNET_RC_STATE_UNLINKED 4 /* RC's MD has been unlinked */
528 /* Stuff initialised at LNetInit() */
529 int ln_init; /* LNetInit() called? */
530 int ln_refcount; /* LNetNIInit/LNetNIFini counter */
531 int ln_niinit_self; /* Have I called LNetNIInit myself? */
533 cfs_list_t ln_lnds; /* registered LNDs */
536 cfs_spinlock_t ln_lock;
537 cfs_waitq_t ln_waitq;
538 cfs_semaphore_t ln_api_mutex;
539 cfs_semaphore_t ln_lnd_mutex;
541 # ifndef HAVE_PTHREAD
546 pthread_cond_t ln_cond;
547 pthread_mutex_t ln_lock;
548 pthread_mutex_t ln_api_mutex;
549 pthread_mutex_t ln_lnd_mutex;
553 /* Stuff initialised at LNetNIInit() */
555 int ln_shutdown; /* shutdown in progress */
556 int ln_nportals; /* # portals */
557 lnet_portal_t *ln_portals; /* the vector of portals */
559 lnet_pid_t ln_pid; /* requested pid */
561 cfs_list_t ln_nis; /* LND instances */
562 lnet_ni_t *ln_loni; /* the loopback NI */
563 lnet_ni_t *ln_eqwaitni; /* NI to wait for events in */
564 cfs_list_t ln_zombie_nis; /* dying LND instances */
565 int ln_nzombie_nis; /* # of NIs to wait for */
567 cfs_list_t ln_remote_nets; /* remote networks with routes to them */
568 __u64 ln_remote_nets_version; /* validity stamp */
570 cfs_list_t ln_routers; /* list of all known routers */
571 __u64 ln_routers_version; /* validity stamp */
573 cfs_list_t *ln_peer_hash; /* NID->peer hash */
574 int ln_npeers; /* # peers extant */
575 int ln_peertable_version; /* /proc validity stamp */
577 int ln_routing; /* am I a router? */
578 lnet_rtrbufpool_t ln_rtrpools[LNET_NRBPOOLS]; /* router buffer pools */
580 int ln_lh_hash_size; /* size of lib handle hash table */
581 cfs_list_t *ln_lh_hash_table; /* all extant lib handles, this interface */
582 __u64 ln_next_object_cookie; /* cookie generator */
583 __u64 ln_interface_cookie; /* uniquely identifies this ni in this epoch */
585 char *ln_network_tokens; /* space for network names */
586 int ln_network_tokens_nob;
588 int ln_testprotocompat; /* test protocol compatibility flags */
590 cfs_list_t ln_finalizeq; /* msgs waiting to complete finalizing */
592 void **ln_finalizers; /* threads doing finalization */
593 int ln_nfinalizers; /* max # threads finalizing */
597 cfs_list_t ln_test_peers; /* failure simulation */
599 lnet_handle_md_t ln_ping_target_md;
600 lnet_handle_eq_t ln_ping_target_eq;
601 lnet_ping_info_t *ln_ping_info;
604 cfs_semaphore_t ln_rc_signal; /* serialise startup/shutdown */
606 int ln_rc_state; /* router checker startup/shutdown state */
607 lnet_handle_eq_t ln_rc_eqh; /* router checker's event queue */
608 lnet_handle_md_t ln_rc_mdh;
609 cfs_list_t ln_zombie_rcd;
611 #ifdef LNET_USE_LIB_FREELIST
612 lnet_freelist_t ln_free_mes;
613 lnet_freelist_t ln_free_msgs;
614 lnet_freelist_t ln_free_mds;
615 lnet_freelist_t ln_free_eqs;
617 cfs_list_t ln_active_msgs;
618 cfs_list_t ln_active_mds;
619 cfs_list_t ln_active_eqs;
621 lnet_counters_t ln_counters;
624 /* Temporary workaround to allow uOSS and test programs force
625 * server mode in userspace. The only place where we use it is
626 * lnet_prepare(). The only way to turn this flag on is to
627 * call lnet_server_mode() */
629 int ln_server_mode_flag;