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