lnet/include/lnet/types.h

   1 /*
   2  * GPL HEADER START
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   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.
   9  *
  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).
  15  *
  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.gnu.org/licenses/gpl-2.0.html
  19  *
  20  * GPL HEADER END
  21  */
  22 /*
  23  * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
  24  * Use is subject to license terms.
  25  *
  26  * Copyright (c) 2012, 2015, Intel Corporation.
  27  */
  28 /*
  29  * This file is part of Lustre, http://www.lustre.org/
  30  * Lustre is a trademark of Sun Microsystems, Inc.
  31  */
  32
  33 #ifndef __LNET_TYPES_H__
  34 #define __LNET_TYPES_H__
  35
  36 /** \addtogroup lnet
  37  * @{ */
  38
  39 #include <linux/types.h>
  40 /** \addtogroup lnet_addr
  41  * @{ */
  42
  43 #define LNET_VERSION            "0.7.0"
  44
  45 /** Portal reserved for LNet's own use.
  46  * \see lustre/include/lustre/lustre_idl.h for Lustre portal assignments.
  47  */
  48 #define LNET_RESERVED_PORTAL      0
  49
  50 /**
  51  * Address of an end-point in an LNet network.
  52  *
  53  * A node can have multiple end-points and hence multiple addresses.
  54  * An LNet network can be a simple network (e.g. tcp0) or a network of
  55  * LNet networks connected by LNet routers. Therefore an end-point address
  56  * has two parts: network ID, and address within a network.
  57  *
  58  * \see LNET_NIDNET, LNET_NIDADDR, and LNET_MKNID.
  59  */
  60 typedef __u64 lnet_nid_t;
  61 /**
  62  * ID of a process in a node. Shortened as PID to distinguish from
  63  * lnet_process_id_t, the global process ID.
  64  */
  65 typedef __u32 lnet_pid_t;
  66
  67 /** wildcard NID that matches any end-point address */
  68 #define LNET_NID_ANY      ((lnet_nid_t) -1)
  69 /** wildcard PID that matches any lnet_pid_t */
  70 #define LNET_PID_ANY      ((lnet_pid_t) -1)
  71
  72 #define LNET_PID_RESERVED 0xf0000000 /* reserved bits in PID */
  73 #define LNET_PID_USERFLAG 0x80000000 /* set in userspace peers */
  74 #define LNET_PID_LUSTRE 12345
  75
  76 /* how an LNET NID encodes net:address */
  77 /** extract the address part of an lnet_nid_t */
  78
  79 static inline __u32 LNET_NIDADDR(lnet_nid_t nid)
  80 {
  81         return nid & 0xffffffff;
  82 }
  83
  84 static inline __u32 LNET_NIDNET(lnet_nid_t nid)
  85 {
  86         return (nid >> 32) & 0xffffffff;
  87 }
  88
  89 static inline lnet_nid_t LNET_MKNID(__u32 net, __u32 addr)
  90 {
  91         return (((__u64)net) << 32) | addr;
  92 }
  93
  94 static inline __u32 LNET_NETNUM(__u32 net)
  95 {
  96         return net & 0xffff;
  97 }
  98
  99 static inline __u32 LNET_NETTYP(__u32 net)
 100 {
 101         return (net >> 16) & 0xffff;
 102 }
 103
 104 static inline __u32 LNET_MKNET(__u32 type, __u32 num)
 105 {
 106         return (type << 16) | num;
 107 }
 108
 109 #define WIRE_ATTR       __attribute__((packed))
 110
 111 /* Packed version of lnet_process_id_t to transfer via network */
 112 typedef struct lnet_process_id_packed {
 113         lnet_nid_t nid;
 114         lnet_pid_t pid; /* node id / process id */
 115 } WIRE_ATTR lnet_process_id_packed_t;
 116
 117 /* The wire handle's interface cookie only matches one network interface in
 118  * one epoch (i.e. new cookie when the interface restarts or the node
 119  * reboots).  The object cookie only matches one object on that interface
 120  * during that object's lifetime (i.e. no cookie re-use). */
 121 typedef struct lnet_handle_wire {
 122         __u64 wh_interface_cookie;
 123         __u64 wh_object_cookie;
 124 } WIRE_ATTR lnet_handle_wire_t;
 125
 126 typedef enum {
 127         LNET_MSG_ACK = 0,
 128         LNET_MSG_PUT,
 129         LNET_MSG_GET,
 130         LNET_MSG_REPLY,
 131         LNET_MSG_HELLO,
 132 } lnet_msg_type_t;
 133
 134 /* The variant fields of the portals message header are aligned on an 8
 135  * byte boundary in the message header.  Note that all types used in these
 136  * wire structs MUST be fixed size and the smaller types are placed at the
 137  * end. */
 138 struct lnet_ack {
 139         struct lnet_handle_wire dst_wmd;
 140         __u64                   match_bits;
 141         __u32                   mlength;
 142 } WIRE_ATTR;
 143
 144 struct lnet_put {
 145         struct lnet_handle_wire ack_wmd;
 146         __u64                   match_bits;
 147         __u64                   hdr_data;
 148         __u32                   ptl_index;
 149         __u32                   offset;
 150 } WIRE_ATTR;
 151
 152 struct lnet_get {
 153         struct lnet_handle_wire return_wmd;
 154         __u64                   match_bits;
 155         __u32                   ptl_index;
 156         __u32                   src_offset;
 157         __u32                   sink_length;
 158 } WIRE_ATTR;
 159
 160 struct lnet_reply {
 161         struct lnet_handle_wire dst_wmd;
 162 } WIRE_ATTR;
 163
 164 struct lnet_hello {
 165         __u64                   incarnation;
 166         __u32                   type;
 167 } WIRE_ATTR;
 168
 169 typedef struct lnet_hdr {
 170         lnet_nid_t      dest_nid;
 171         lnet_nid_t      src_nid;
 172         lnet_pid_t      dest_pid;
 173         lnet_pid_t      src_pid;
 174         __u32           type;           /* lnet_msg_type_t */
 175         __u32           payload_length; /* payload data to follow */
 176         /*<------__u64 aligned------->*/
 177         union {
 178                 struct lnet_ack         ack;
 179                 struct lnet_put         put;
 180                 struct lnet_get         get;
 181                 struct lnet_reply       reply;
 182                 struct lnet_hello       hello;
 183         } msg;
 184 } WIRE_ATTR lnet_hdr_t;
 185
 186 /* A HELLO message contains a magic number and protocol version
 187  * code in the header's dest_nid, the peer's NID in the src_nid, and
 188  * LNET_MSG_HELLO in the type field.  All other common fields are zero
 189  * (including payload_size; i.e. no payload).
 190  * This is for use by byte-stream LNDs (e.g. TCP/IP) to check the peer is
 191  * running the same protocol and to find out its NID. These LNDs should
 192  * exchange HELLO messages when a connection is first established.  Individual
 193  * LNDs can put whatever else they fancy in lnet_hdr_t::msg.
 194  */
 195 typedef struct lnet_magicversion {
 196         __u32   magic;          /* LNET_PROTO_TCP_MAGIC */
 197         __u16   version_major;  /* increment on incompatible change */
 198         __u16   version_minor;  /* increment on compatible change */
 199 } WIRE_ATTR lnet_magicversion_t;
 200
 201 /* PROTO MAGIC for LNDs */
 202 #define LNET_PROTO_IB_MAGIC             0x0be91b91
 203 #define LNET_PROTO_GNI_MAGIC            0xb00fbabe /* ask Kim */
 204 #define LNET_PROTO_TCP_MAGIC            0xeebc0ded
 205 #define LNET_PROTO_ACCEPTOR_MAGIC       0xacce7100
 206 #define LNET_PROTO_PING_MAGIC           0x70696E67 /* 'ping' */
 207
 208 /* Placeholder for a future "unified" protocol across all LNDs */
 209 /* Current LNDs that receive a request with this magic will respond
 210  * with a "stub" reply using their current protocol */
 211 #define LNET_PROTO_MAGIC                0x45726963 /* ! */
 212
 213 #define LNET_PROTO_TCP_VERSION_MAJOR    1
 214 #define LNET_PROTO_TCP_VERSION_MINOR    0
 215
 216 /* Acceptor connection request */
 217 typedef struct lnet_acceptor_connreq {
 218         __u32   acr_magic;      /* PTL_ACCEPTOR_PROTO_MAGIC */
 219         __u32   acr_version;    /* protocol version */
 220         __u64   acr_nid;        /* target NID */
 221 } WIRE_ATTR lnet_acceptor_connreq_t;
 222
 223 #define LNET_PROTO_ACCEPTOR_VERSION     1
 224
 225 typedef struct lnet_counters {
 226         __u32   msgs_alloc;
 227         __u32   msgs_max;
 228         __u32   errors;
 229         __u32   send_count;
 230         __u32   recv_count;
 231         __u32   route_count;
 232         __u32   drop_count;
 233         __u64   send_length;
 234         __u64   recv_length;
 235         __u64   route_length;
 236         __u64   drop_length;
 237 } WIRE_ATTR lnet_counters_t;
 238
 239 #define LNET_NI_STATUS_UP       0x15aac0de
 240 #define LNET_NI_STATUS_DOWN     0xdeadface
 241 #define LNET_NI_STATUS_INVALID  0x00000000
 242
 243 #define LNET_MAX_INTERFACES     16
 244
 245 /**
 246  * Objects maintained by the LNet are accessed through handles. Handle types
 247  * have names of the form lnet_handle_xx_t, where xx is one of the two letter
 248  * object type codes ('eq' for event queue, 'md' for memory descriptor, and
 249  * 'me' for match entry).
 250  * Each type of object is given a unique handle type to enhance type checking.
 251  * The type lnet_handle_any_t can be used when a generic handle is needed.
 252  * Every handle value can be converted into a value of type lnet_handle_any_t
 253  * without loss of information.
 254  */
 255 typedef struct {
 256         __u64   cookie;
 257 } lnet_handle_any_t;
 258
 259 typedef lnet_handle_any_t lnet_handle_eq_t;
 260 typedef lnet_handle_any_t lnet_handle_md_t;
 261 typedef lnet_handle_any_t lnet_handle_me_t;
 262
 263 #define LNET_WIRE_HANDLE_COOKIE_NONE   (-1)
 264
 265 /**
 266  * Invalidate handle \a h.
 267  */
 268 static inline void LNetInvalidateHandle(lnet_handle_any_t *h)
 269 {
 270         h->cookie = LNET_WIRE_HANDLE_COOKIE_NONE;
 271 }
 272
 273 /**
 274  * Compare handles \a h1 and \a h2.
 275  *
 276  * \return 1 if handles are equal, 0 if otherwise.
 277  */
 278 static inline int LNetHandleIsEqual (lnet_handle_any_t h1, lnet_handle_any_t h2)
 279 {
 280         return (h1.cookie == h2.cookie);
 281 }
 282
 283 /**
 284  * Check whether handle \a h is invalid.
 285  *
 286  * \return 1 if handle is invalid, 0 if valid.
 287  */
 288 static inline int LNetHandleIsInvalid(lnet_handle_any_t h)
 289 {
 290         return (LNET_WIRE_HANDLE_COOKIE_NONE == h.cookie);
 291 }
 292
 293 /**
 294  * Global process ID.
 295  */
 296 typedef struct {
 297         /** node id */
 298         lnet_nid_t nid;
 299         /** process id */
 300         lnet_pid_t pid;
 301 } lnet_process_id_t;
 302 /** @} lnet_addr */
 303
 304 /** \addtogroup lnet_me
 305  * @{ */
 306
 307 /**
 308  * Specifies whether the match entry or memory descriptor should be unlinked
 309  * automatically (LNET_UNLINK) or not (LNET_RETAIN).
 310  */
 311 typedef enum {
 312         LNET_RETAIN = 0,
 313         LNET_UNLINK
 314 } lnet_unlink_t;
 315
 316 /**
 317  * Values of the type lnet_ins_pos_t are used to control where a new match
 318  * entry is inserted. The value LNET_INS_BEFORE is used to insert the new
 319  * entry before the current entry or before the head of the list. The value
 320  * LNET_INS_AFTER is used to insert the new entry after the current entry
 321  * or after the last item in the list.
 322  */
 323 typedef enum {
 324         /** insert ME before current position or head of the list */
 325         LNET_INS_BEFORE,
 326         /** insert ME after current position or tail of the list */
 327         LNET_INS_AFTER,
 328         /** attach ME at tail of local CPU partition ME list */
 329         LNET_INS_LOCAL
 330 } lnet_ins_pos_t;
 331
 332 /** @} lnet_me */
 333
 334 /** \addtogroup lnet_md
 335  * @{ */
 336
 337 /**
 338  * Defines the visible parts of a memory descriptor. Values of this type
 339  * are used to initialize memory descriptors.
 340  */
 341 typedef struct {
 342         /**
 343          * Specify the memory region associated with the memory descriptor.
 344          * If the options field has:
 345          * - LNET_MD_KIOV bit set: The start field points to the starting
 346          * address of an array of lnet_kiov_t and the length field specifies
 347          * the number of entries in the array. The length can't be bigger
 348          * than LNET_MAX_IOV. The lnet_kiov_t is used to describe page-based
 349          * fragments that are not necessarily mapped in virtal memory.
 350          * - LNET_MD_IOVEC bit set: The start field points to the starting
 351          * address of an array of struct kvec and the length field specifies
 352          * the number of entries in the array. The length can't be bigger
 353          * than LNET_MAX_IOV. The struct kvec is used to describe fragments
 354          * that have virtual addresses.
 355          * - Otherwise: The memory region is contiguous. The start field
 356          * specifies the starting address for the memory region and the
 357          * length field specifies its length.
 358          *
 359          * When the memory region is fragmented, all fragments but the first
 360          * one must start on page boundary, and all but the last must end on
 361          * page boundary.
 362          */
 363         void            *start;
 364         unsigned int     length;
 365         /**
 366          * Specifies the maximum number of operations that can be performed
 367          * on the memory descriptor. An operation is any action that could
 368          * possibly generate an event. In the usual case, the threshold value
 369          * is decremented for each operation on the MD. When the threshold
 370          * drops to zero, the MD becomes inactive and does not respond to
 371          * operations. A threshold value of LNET_MD_THRESH_INF indicates that
 372          * there is no bound on the number of operations that may be applied
 373          * to a MD.
 374          */
 375         int              threshold;
 376         /**
 377          * Specifies the largest incoming request that the memory descriptor
 378          * should respond to. When the unused portion of a MD (length -
 379          * local offset) falls below this value, the MD becomes inactive and
 380          * does not respond to further operations. This value is only used
 381          * if the LNET_MD_MAX_SIZE option is set.
 382          */
 383         int              max_size;
 384         /**
 385          * Specifies the behavior of the memory descriptor. A bitwise OR
 386          * of the following values can be used:
 387          * - LNET_MD_OP_PUT: The LNet PUT operation is allowed on this MD.
 388          * - LNET_MD_OP_GET: The LNet GET operation is allowed on this MD.
 389          * - LNET_MD_MANAGE_REMOTE: The offset used in accessing the memory
 390          *   region is provided by the incoming request. By default, the
 391          *   offset is maintained locally. When maintained locally, the
 392          *   offset is incremented by the length of the request so that
 393          *   the next operation (PUT or GET) will access the next part of
 394          *   the memory region. Note that only one offset variable exists
 395          *   per memory descriptor. If both PUT and GET operations are
 396          *   performed on a memory descriptor, the offset is updated each time.
 397          * - LNET_MD_TRUNCATE: The length provided in the incoming request can
 398          *   be reduced to match the memory available in the region (determined
 399          *   by subtracting the offset from the length of the memory region).
 400          *   By default, if the length in the incoming operation is greater
 401          *   than the amount of memory available, the operation is rejected.
 402          * - LNET_MD_ACK_DISABLE: An acknowledgment should not be sent for
 403          *   incoming PUT operations, even if requested. By default,
 404          *   acknowledgments are sent for PUT operations that request an
 405          *   acknowledgment. Acknowledgments are never sent for GET operations.
 406          *   The data sent in the REPLY serves as an implicit acknowledgment.
 407          * - LNET_MD_KIOV: The start and length fields specify an array of
 408          *   lnet_kiov_t.
 409          * - LNET_MD_IOVEC: The start and length fields specify an array of
 410          *   struct iovec.
 411          * - LNET_MD_MAX_SIZE: The max_size field is valid.
 412          * - LNET_MD_BULK_HANDLE: The bulk_handle field is valid.
 413          *
 414          * Note:
 415          * - LNET_MD_KIOV or LNET_MD_IOVEC allows for a scatter/gather
 416          *   capability for memory descriptors. They can't be both set.
 417          * - When LNET_MD_MAX_SIZE is set, the total length of the memory
 418          *   region (i.e. sum of all fragment lengths) must not be less than
 419          *   \a max_size.
 420          */
 421         unsigned int     options;
 422         /**
 423          * A user-specified value that is associated with the memory
 424          * descriptor. The value does not need to be a pointer, but must fit
 425          * in the space used by a pointer. This value is recorded in events
 426          * associated with operations on this MD.
 427          */
 428         void            *user_ptr;
 429         /**
 430          * A handle for the event queue used to log the operations performed on
 431          * the memory region. If this argument is a NULL handle (i.e. nullified
 432          * by LNetInvalidateHandle()), operations performed on this memory
 433          * descriptor are not logged.
 434          */
 435         lnet_handle_eq_t eq_handle;
 436         /**
 437          * The bulk MD handle which was registered to describe the buffers
 438          * either to be used to transfer data to the peer or receive data
 439          * from the peer. This allows LNet to properly determine the NUMA
 440          * node on which the memory was allocated and use that to select the
 441          * nearest local network interface. This value is only used
 442          * if the LNET_MD_BULK_HANDLE option is set.
 443          */
 444         lnet_handle_md_t bulk_handle;
 445 } lnet_md_t;
 446
 447 /* Max Transfer Unit (minimum supported everywhere).
 448  * CAVEAT EMPTOR, with multinet (i.e. routers forwarding between networks)
 449  * these limits are system wide and not interface-local. */
 450 #define LNET_MTU_BITS   20
 451 #define LNET_MTU        (1 << LNET_MTU_BITS)
 452
 453 /** limit on the number of fragments in discontiguous MDs */
 454 #define LNET_MAX_IOV    256
 455
 456 /**
 457  * Options for the MD structure. See lnet_md_t::options.
 458  */
 459 #define LNET_MD_OP_PUT               (1 << 0)
 460 /** See lnet_md_t::options. */
 461 #define LNET_MD_OP_GET               (1 << 1)
 462 /** See lnet_md_t::options. */
 463 #define LNET_MD_MANAGE_REMOTE        (1 << 2)
 464 /* unused                            (1 << 3) */
 465 /** See lnet_md_t::options. */
 466 #define LNET_MD_TRUNCATE             (1 << 4)
 467 /** See lnet_md_t::options. */
 468 #define LNET_MD_ACK_DISABLE          (1 << 5)
 469 /** See lnet_md_t::options. */
 470 #define LNET_MD_IOVEC                (1 << 6)
 471 /** See lnet_md_t::options. */
 472 #define LNET_MD_MAX_SIZE             (1 << 7)
 473 /** See lnet_md_t::options. */
 474 #define LNET_MD_KIOV                 (1 << 8)
 475 /** See lnet_md_t::options. */
 476 #define LNET_MD_BULK_HANDLE          (1 << 9)
 477
 478 /* For compatibility with Cray Portals */
 479 #define LNET_MD_PHYS                         0
 480
 481 /** Infinite threshold on MD operations. See lnet_md_t::threshold */
 482 #define LNET_MD_THRESH_INF       (-1)
 483
 484 /* NB lustre portals uses struct iovec internally! */
 485 typedef struct iovec lnet_md_iovec_t;
 486
 487 /**
 488  * A page-based fragment of a MD.
 489  */
 490 typedef struct {
 491         /** Pointer to the page where the fragment resides */
 492         struct page      *kiov_page;
 493         /** Length in bytes of the fragment */
 494         unsigned int     kiov_len;
 495         /**
 496          * Starting offset of the fragment within the page. Note that the
 497          * end of the fragment must not pass the end of the page; i.e.,
 498          * kiov_len + kiov_offset <= PAGE_SIZE.
 499          */
 500         unsigned int     kiov_offset;
 501 } lnet_kiov_t;
 502 /** @} lnet_md */
 503
 504 /** \addtogroup lnet_eq
 505  * @{ */
 506
 507 /**
 508  * Six types of events can be logged in an event queue.
 509  */
 510 typedef enum {
 511         /** An incoming GET operation has completed on the MD. */
 512         LNET_EVENT_GET          = 1,
 513         /**
 514          * An incoming PUT operation has completed on the MD. The
 515          * underlying layers will not alter the memory (on behalf of this
 516          * operation) once this event has been logged.
 517          */
 518         LNET_EVENT_PUT,
 519         /**
 520          * A REPLY operation has completed. This event is logged after the
 521          * data (if any) from the REPLY has been written into the MD.
 522          */
 523         LNET_EVENT_REPLY,
 524         /** An acknowledgment has been received. */
 525         LNET_EVENT_ACK,
 526         /**
 527          * An outgoing send (PUT or GET) operation has completed. This event
 528          * is logged after the entire buffer has been sent and it is safe for
 529          * the caller to reuse the buffer.
 530          *
 531          * Note:
 532          * - The LNET_EVENT_SEND doesn't guarantee message delivery. It can
 533          *   happen even when the message has not yet been put out on wire.
 534          * - It's unsafe to assume that in an outgoing GET operation
 535          *   the LNET_EVENT_SEND event would happen before the
 536          *   LNET_EVENT_REPLY event. The same holds for LNET_EVENT_SEND and
 537          *   LNET_EVENT_ACK events in an outgoing PUT operation.
 538          */
 539         LNET_EVENT_SEND,
 540         /**
 541          * A MD has been unlinked. Note that LNetMDUnlink() does not
 542          * necessarily trigger an LNET_EVENT_UNLINK event.
 543          * \see LNetMDUnlink
 544          */
 545         LNET_EVENT_UNLINK,
 546 } lnet_event_kind_t;
 547
 548 #define LNET_SEQ_BASETYPE       long
 549 typedef unsigned LNET_SEQ_BASETYPE lnet_seq_t;
 550 #define LNET_SEQ_GT(a, b)       (((signed LNET_SEQ_BASETYPE)((a) - (b))) > 0)
 551
 552 /**
 553  * Information about an event on a MD.
 554  */
 555 typedef struct {
 556         /** The identifier (nid, pid) of the target. */
 557         lnet_process_id_t   target;
 558         /** The identifier (nid, pid) of the initiator. */
 559         lnet_process_id_t   initiator;
 560         /** The source NID on the initiator. */
 561         lnet_process_id_t   source;
 562         /**
 563          * The NID of the immediate sender. If the request has been forwarded
 564          * by routers, this is the NID of the last hop; otherwise it's the
 565          * same as the source.
 566          */
 567         lnet_nid_t          sender;
 568         /** Indicates the type of the event. */
 569         lnet_event_kind_t   type;
 570         /** The portal table index specified in the request */
 571         unsigned int        pt_index;
 572         /** A copy of the match bits specified in the request. */
 573         __u64               match_bits;
 574         /** The length (in bytes) specified in the request. */
 575         unsigned int        rlength;
 576         /**
 577          * The length (in bytes) of the data that was manipulated by the
 578          * operation. For truncated operations, the manipulated length will be
 579          * the number of bytes specified by the MD (possibly with an offset,
 580          * see lnet_md_t). For all other operations, the manipulated length
 581          * will be the length of the requested operation, i.e. rlength.
 582          */
 583         unsigned int        mlength;
 584         /**
 585          * The handle to the MD associated with the event. The handle may be
 586          * invalid if the MD has been unlinked.
 587          */
 588         lnet_handle_md_t    md_handle;
 589         /**
 590          * A snapshot of the state of the MD immediately after the event has
 591          * been processed. In particular, the threshold field in md will
 592          * reflect the value of the threshold after the operation occurred.
 593          */
 594         lnet_md_t           md;
 595         /**
 596          * 64 bits of out-of-band user data. Only valid for LNET_EVENT_PUT.
 597          * \see LNetPut
 598          */
 599         __u64               hdr_data;
 600         /**
 601          * Indicates the completion status of the operation. It's 0 for
 602          * successful operations, otherwise it's an error code.
 603          */
 604         int                 status;
 605         /**
 606          * Indicates whether the MD has been unlinked. Note that:
 607          * - An event with unlinked set is the last event on the MD.
 608          * - This field is also set for an explicit LNET_EVENT_UNLINK event.
 609          * \see LNetMDUnlink
 610          */
 611         int                 unlinked;
 612         /**
 613          * The displacement (in bytes) into the memory region that the
 614          * operation used. The offset can be determined by the operation for
 615          * a remote managed MD or by the local MD.
 616          * \see lnet_md_t::options
 617          */
 618         unsigned int        offset;
 619         /**
 620          * The sequence number for this event. Sequence numbers are unique
 621          * to each event.
 622          */
 623         volatile lnet_seq_t sequence;
 624 } lnet_event_t;
 625
 626 /**
 627  * Event queue handler function type.
 628  *
 629  * The EQ handler runs for each event that is deposited into the EQ. The
 630  * handler is supplied with a pointer to the event that triggered the
 631  * handler invocation.
 632  *
 633  * The handler must not block, must be reentrant, and must not call any LNet
 634  * API functions. It should return as quickly as possible.
 635  */
 636 typedef void (*lnet_eq_handler_t)(lnet_event_t *event);
 637 #define LNET_EQ_HANDLER_NONE NULL
 638 /** @} lnet_eq */
 639
 640 /** \addtogroup lnet_data
 641  * @{ */
 642
 643 /**
 644  * Specify whether an acknowledgment should be sent by target when the PUT
 645  * operation completes (i.e., when the data has been written to a MD of the
 646  * target process).
 647  *
 648  * \see lnet_md_t::options for the discussion on LNET_MD_ACK_DISABLE by which
 649  * acknowledgments can be disabled for a MD.
 650  */
 651 typedef enum {
 652         /** Request an acknowledgment */
 653         LNET_ACK_REQ,
 654         /** Request that no acknowledgment should be generated. */
 655         LNET_NOACK_REQ
 656 } lnet_ack_req_t;
 657 /** @} lnet_data */
 658
 659 /** @} lnet */
 660 #endif