lnet/include/uapi/linux/lnet/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, 2017, 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 __UAPI_LNET_TYPES_H__
  34 #define __UAPI_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 /**
  63  * ID of a process in a node. Shortened as PID to distinguish from
  64  * lnet_process_id, the global process ID.
  65  */
  66 typedef __u32 lnet_pid_t;
  67
  68 /** wildcard NID that matches any end-point address */
  69 #define LNET_NID_ANY      ((lnet_nid_t) -1)
  70 /** wildcard PID that matches any lnet_pid_t */
  71 #define LNET_PID_ANY      ((lnet_pid_t) -1)
  72
  73 #define LNET_PID_RESERVED 0xf0000000 /* reserved bits in PID */
  74 #define LNET_PID_USERFLAG 0x80000000 /* set in userspace peers */
  75 #define LNET_PID_LUSTRE 12345
  76
  77 /* how an LNET NID encodes net:address */
  78 /** extract the address part of an lnet_nid_t */
  79
  80 static inline __u32 LNET_NIDADDR(lnet_nid_t nid)
  81 {
  82         return nid & 0xffffffff;
  83 }
  84
  85 static inline __u32 LNET_NIDNET(lnet_nid_t nid)
  86 {
  87         return (nid >> 32) & 0xffffffff;
  88 }
  89
  90 static inline lnet_nid_t LNET_MKNID(__u32 net, __u32 addr)
  91 {
  92         return (((__u64)net) << 32) | addr;
  93 }
  94
  95 static inline __u32 LNET_NETNUM(__u32 net)
  96 {
  97         return net & 0xffff;
  98 }
  99
 100 static inline __u32 LNET_NETTYP(__u32 net)
 101 {
 102         return (net >> 16) & 0xffff;
 103 }
 104
 105 static inline __u32 LNET_MKNET(__u32 type, __u32 num)
 106 {
 107         return (type << 16) | num;
 108 }
 109
 110 /** The lolnd NID (i.e. myself) */
 111 #define LNET_NID_LO_0 LNET_MKNID(LNET_MKNET(LOLND, 0), 0)
 112
 113 #define WIRE_ATTR       __attribute__((packed))
 114
 115 /* Packed version of struct lnet_process_id to transfer via network */
 116 struct lnet_process_id_packed {
 117         lnet_nid_t nid;
 118         lnet_pid_t pid; /* node id / process id */
 119 } WIRE_ATTR;
 120
 121 /* The wire handle's interface cookie only matches one network interface in
 122  * one epoch (i.e. new cookie when the interface restarts or the node
 123  * reboots).  The object cookie only matches one object on that interface
 124  * during that object's lifetime (i.e. no cookie re-use). */
 125 struct lnet_handle_wire {
 126         __u64 wh_interface_cookie;
 127         __u64 wh_object_cookie;
 128 } WIRE_ATTR;
 129
 130 enum lnet_msg_type {
 131         LNET_MSG_ACK = 0,
 132         LNET_MSG_PUT,
 133         LNET_MSG_GET,
 134         LNET_MSG_REPLY,
 135         LNET_MSG_HELLO,
 136 };
 137
 138 /* The variant fields of the portals message header are aligned on an 8
 139  * byte boundary in the message header.  Note that all types used in these
 140  * wire structs MUST be fixed size and the smaller types are placed at the
 141  * end. */
 142 struct lnet_ack {
 143         struct lnet_handle_wire dst_wmd;
 144         __u64                   match_bits;
 145         __u32                   mlength;
 146 } WIRE_ATTR;
 147
 148 struct lnet_put {
 149         struct lnet_handle_wire ack_wmd;
 150         __u64                   match_bits;
 151         __u64                   hdr_data;
 152         __u32                   ptl_index;
 153         __u32                   offset;
 154 } WIRE_ATTR;
 155
 156 struct lnet_get {
 157         struct lnet_handle_wire return_wmd;
 158         __u64                   match_bits;
 159         __u32                   ptl_index;
 160         __u32                   src_offset;
 161         __u32                   sink_length;
 162 } WIRE_ATTR;
 163
 164 struct lnet_reply {
 165         struct lnet_handle_wire dst_wmd;
 166 } WIRE_ATTR;
 167
 168 struct lnet_hello {
 169         __u64                   incarnation;
 170         __u32                   type;
 171 } WIRE_ATTR;
 172
 173 struct lnet_hdr {
 174         lnet_nid_t      dest_nid;
 175         lnet_nid_t      src_nid;
 176         lnet_pid_t      dest_pid;
 177         lnet_pid_t      src_pid;
 178         __u32           type;           /* enum lnet_msg_type */
 179         __u32           payload_length; /* payload data to follow */
 180         /*<------__u64 aligned------->*/
 181         union {
 182                 struct lnet_ack         ack;
 183                 struct lnet_put         put;
 184                 struct lnet_get         get;
 185                 struct lnet_reply       reply;
 186                 struct lnet_hello       hello;
 187         } msg;
 188 } WIRE_ATTR;
 189
 190 /* A HELLO message contains a magic number and protocol version
 191  * code in the header's dest_nid, the peer's NID in the src_nid, and
 192  * LNET_MSG_HELLO in the type field.  All other common fields are zero
 193  * (including payload_size; i.e. no payload).
 194  * This is for use by byte-stream LNDs (e.g. TCP/IP) to check the peer is
 195  * running the same protocol and to find out its NID. These LNDs should
 196  * exchange HELLO messages when a connection is first established.  Individual
 197  * LNDs can put whatever else they fancy in lnet_hdr::msg.
 198  */
 199 struct lnet_magicversion {
 200         __u32   magic;          /* LNET_PROTO_TCP_MAGIC */
 201         __u16   version_major;  /* increment on incompatible change */
 202         __u16   version_minor;  /* increment on compatible change */
 203 } WIRE_ATTR;
 204
 205 /* PROTO MAGIC for LNDs */
 206 #define LNET_PROTO_IB_MAGIC             0x0be91b91
 207 #define LNET_PROTO_GNI_MAGIC            0xb00fbabe /* ask Kim */
 208 #define LNET_PROTO_TCP_MAGIC            0xeebc0ded
 209 #define LNET_PROTO_ACCEPTOR_MAGIC       0xacce7100
 210 #define LNET_PROTO_PING_MAGIC           0x70696E67 /* 'ping' */
 211
 212 /* Placeholder for a future "unified" protocol across all LNDs */
 213 /* Current LNDs that receive a request with this magic will respond
 214  * with a "stub" reply using their current protocol */
 215 #define LNET_PROTO_MAGIC                0x45726963 /* ! */
 216
 217 #define LNET_PROTO_TCP_VERSION_MAJOR    1
 218 #define LNET_PROTO_TCP_VERSION_MINOR    0
 219
 220 /* Acceptor connection request */
 221 struct lnet_acceptor_connreq {
 222         __u32   acr_magic;      /* PTL_ACCEPTOR_PROTO_MAGIC */
 223         __u32   acr_version;    /* protocol version */
 224         __u64   acr_nid;        /* target NID */
 225 } WIRE_ATTR;
 226
 227 #define LNET_PROTO_ACCEPTOR_VERSION     1
 228
 229 struct lnet_counters_common {
 230         __u32   lcc_msgs_alloc;
 231         __u32   lcc_msgs_max;
 232         __u32   lcc_errors;
 233         __u32   lcc_send_count;
 234         __u32   lcc_recv_count;
 235         __u32   lcc_route_count;
 236         __u32   lcc_drop_count;
 237         __u64   lcc_send_length;
 238         __u64   lcc_recv_length;
 239         __u64   lcc_route_length;
 240         __u64   lcc_drop_length;
 241 } WIRE_ATTR;
 242
 243 struct lnet_counters_health {
 244         __u32   lch_rst_alloc;
 245         __u32   lch_resend_count;
 246         __u32   lch_response_timeout_count;
 247         __u32   lch_local_interrupt_count;
 248         __u32   lch_local_dropped_count;
 249         __u32   lch_local_aborted_count;
 250         __u32   lch_local_no_route_count;
 251         __u32   lch_local_timeout_count;
 252         __u32   lch_local_error_count;
 253         __u32   lch_remote_dropped_count;
 254         __u32   lch_remote_error_count;
 255         __u32   lch_remote_timeout_count;
 256         __u32   lch_network_timeout_count;
 257 };
 258
 259 struct lnet_counters {
 260         struct lnet_counters_common lct_common;
 261         struct lnet_counters_health lct_health;
 262 };
 263
 264 #define LNET_NI_STATUS_UP       0x15aac0de
 265 #define LNET_NI_STATUS_DOWN     0xdeadface
 266 #define LNET_NI_STATUS_INVALID  0x00000000
 267
 268 struct lnet_ni_status {
 269         lnet_nid_t ns_nid;
 270         __u32      ns_status;
 271         __u32      ns_unused;
 272 } WIRE_ATTR;
 273
 274 /*
 275  * NB: value of these features equal to LNET_PROTO_PING_VERSION_x
 276  * of old LNet, so there shouldn't be any compatibility issue
 277  */
 278 #define LNET_PING_FEAT_INVAL            (0)             /* no feature */
 279 #define LNET_PING_FEAT_BASE             (1 << 0)        /* just a ping */
 280 #define LNET_PING_FEAT_NI_STATUS        (1 << 1)        /* return NI status */
 281 #define LNET_PING_FEAT_RTE_DISABLED     (1 << 2)        /* Routing enabled */
 282 #define LNET_PING_FEAT_MULTI_RAIL       (1 << 3)        /* Multi-Rail aware */
 283 #define LNET_PING_FEAT_DISCOVERY        (1 << 4)        /* Supports Discovery */
 284
 285 /*
 286  * All ping feature bits fit to hit the wire.
 287  * In lnet_assert_wire_constants() this is compared against its open-coded
 288  * value, and in lnet_ping_target_update() it is used to verify that no
 289  * unknown bits have been set.
 290  * New feature bits can be added, just be aware that this does change the
 291  * over-the-wire protocol.
 292  */
 293 #define LNET_PING_FEAT_BITS             (LNET_PING_FEAT_BASE | \
 294                                          LNET_PING_FEAT_NI_STATUS | \
 295                                          LNET_PING_FEAT_RTE_DISABLED | \
 296                                          LNET_PING_FEAT_MULTI_RAIL | \
 297                                          LNET_PING_FEAT_DISCOVERY)
 298
 299 struct lnet_ping_info {
 300         __u32                   pi_magic;
 301         __u32                   pi_features;
 302         lnet_pid_t              pi_pid;
 303         __u32                   pi_nnis;
 304         struct lnet_ni_status   pi_ni[0];
 305 } WIRE_ATTR;
 306
 307 #define LNET_PING_INFO_SIZE(NNIDS) \
 308         offsetof(struct lnet_ping_info, pi_ni[NNIDS])
 309 #define LNET_PING_INFO_LONI(PINFO)      ((PINFO)->pi_ni[0].ns_nid)
 310 #define LNET_PING_INFO_SEQNO(PINFO)     ((PINFO)->pi_ni[0].ns_status)
 311
 312 /*
 313  * This is a hard-coded limit on the number of interfaces supported by
 314  * the interface bonding implemented by the ksocknal LND. It must be
 315  * defined here because it is used in LNet data structures that are
 316  * common to all LNDs.
 317  */
 318 #define LNET_INTERFACES_NUM     16
 319
 320 /* The minimum number of interfaces per node supported by LNet. */
 321 #define LNET_INTERFACES_MIN     16
 322 /* The default - arbitrary - value of the lnet_max_interfaces tunable. */
 323 #define LNET_INTERFACES_MAX_DEFAULT     200
 324
 325 /**
 326  * Objects maintained by the LNet are accessed through handles. Handle types
 327  * have names of the form lnet_handle_xx, where xx is one of the two letter
 328  * object type codes ('md' for memory descriptor, and
 329  * 'me' for match entry). Each type of object is given a unique handle type
 330  * to enhance type checking.
 331  */
 332 #define LNET_WIRE_HANDLE_COOKIE_NONE   (-1)
 333
 334 struct lnet_handle_md {
 335         __u64   cookie;
 336 };
 337
 338 /**
 339  * Invalidate md handle \a h.
 340  */
 341 static inline void LNetInvalidateMDHandle(struct lnet_handle_md *h)
 342 {
 343         h->cookie = LNET_WIRE_HANDLE_COOKIE_NONE;
 344 }
 345
 346 /**
 347  * Check whether handler \a h is invalid.
 348  *
 349  * \return 1 if handle is invalid, 0 if valid.
 350  */
 351 static inline int LNetMDHandleIsInvalid(struct lnet_handle_md h)
 352 {
 353         return (LNET_WIRE_HANDLE_COOKIE_NONE == h.cookie);
 354 }
 355
 356 /**
 357  * Global process ID.
 358  */
 359 struct lnet_process_id {
 360         /** node id */
 361         lnet_nid_t nid;
 362         /** process id */
 363         lnet_pid_t pid;
 364 };
 365 /** @} lnet_addr */
 366
 367 /** \addtogroup lnet_me
 368  * @{ */
 369
 370 /**
 371  * Specifies whether the match entry or memory descriptor should be unlinked
 372  * automatically (LNET_UNLINK) or not (LNET_RETAIN).
 373  */
 374 enum lnet_unlink {
 375         LNET_RETAIN = 0,
 376         LNET_UNLINK
 377 };
 378
 379 /**
 380  * Values of the type enum lnet_ins_pos are used to control where a new match
 381  * entry is inserted. The value LNET_INS_BEFORE is used to insert the new
 382  * entry before the current entry or before the head of the list. The value
 383  * LNET_INS_AFTER is used to insert the new entry after the current entry
 384  * or after the last item in the list.
 385  */
 386 enum lnet_ins_pos {
 387         /** insert ME before current position or head of the list */
 388         LNET_INS_BEFORE,
 389         /** insert ME after current position or tail of the list */
 390         LNET_INS_AFTER,
 391         /** attach ME at tail of local CPU partition ME list */
 392         LNET_INS_LOCAL
 393 };
 394
 395 /** @} lnet_me */
 396
 397 /** \addtogroup lnet_md
 398  * @{ */
 399
 400 /**
 401  * Event queue handler function type.
 402  *
 403  * The EQ handler runs for each event that is deposited into the EQ. The
 404  * handler is supplied with a pointer to the event that triggered the
 405  * handler invocation.
 406  *
 407  * The handler must not block, must be reentrant, and must not call any LNet
 408  * API functions. It should return as quickly as possible.
 409  */
 410 struct lnet_event;
 411 typedef void (*lnet_handler_t)(struct lnet_event *event);
 412
 413 /**
 414  * Defines the visible parts of a memory descriptor. Values of this type
 415  * are used to initialize memory descriptors.
 416  */
 417 struct lnet_md {
 418         /**
 419          * Specify the memory region associated with the memory descriptor.
 420          * If the options field has:
 421          * - LNET_MD_KIOV bit set: The start field points to the starting
 422          * address of an array of struct bio_vec and the length field specifies
 423          * the number of entries in the array. The length can't be bigger
 424          * than LNET_MAX_IOV. The struct bio_vec is used to describe page-based
 425          * fragments that are not necessarily mapped in virtal memory.
 426          * - Otherwise: The memory region is contiguous. The start field
 427          * specifies the starting address for the memory region and the
 428          * length field specifies its length.
 429          *
 430          * When the memory region is fragmented, all fragments but the first
 431          * one must start on page boundary, and all but the last must end on
 432          * page boundary.
 433          */
 434         void            *start;
 435         unsigned int     length;
 436         /**
 437          * Specifies the maximum number of operations that can be performed
 438          * on the memory descriptor. An operation is any action that could
 439          * possibly generate an event. In the usual case, the threshold value
 440          * is decremented for each operation on the MD. When the threshold
 441          * drops to zero, the MD becomes inactive and does not respond to
 442          * operations. A threshold value of LNET_MD_THRESH_INF indicates that
 443          * there is no bound on the number of operations that may be applied
 444          * to a MD.
 445          */
 446         int              threshold;
 447         /**
 448          * Specifies the largest incoming request that the memory descriptor
 449          * should respond to. When the unused portion of a MD (length -
 450          * local offset) falls below this value, the MD becomes inactive and
 451          * does not respond to further operations. This value is only used
 452          * if the LNET_MD_MAX_SIZE option is set.
 453          */
 454         int              max_size;
 455         /**
 456          * Specifies the behavior of the memory descriptor. A bitwise OR
 457          * of the following values can be used:
 458          * - LNET_MD_OP_PUT: The LNet PUT operation is allowed on this MD.
 459          * - LNET_MD_OP_GET: The LNet GET operation is allowed on this MD.
 460          * - LNET_MD_MANAGE_REMOTE: The offset used in accessing the memory
 461          *   region is provided by the incoming request. By default, the
 462          *   offset is maintained locally. When maintained locally, the
 463          *   offset is incremented by the length of the request so that
 464          *   the next operation (PUT or GET) will access the next part of
 465          *   the memory region. Note that only one offset variable exists
 466          *   per memory descriptor. If both PUT and GET operations are
 467          *   performed on a memory descriptor, the offset is updated each time.
 468          * - LNET_MD_TRUNCATE: The length provided in the incoming request can
 469          *   be reduced to match the memory available in the region (determined
 470          *   by subtracting the offset from the length of the memory region).
 471          *   By default, if the length in the incoming operation is greater
 472          *   than the amount of memory available, the operation is rejected.
 473          * - LNET_MD_ACK_DISABLE: An acknowledgment should not be sent for
 474          *   incoming PUT operations, even if requested. By default,
 475          *   acknowledgments are sent for PUT operations that request an
 476          *   acknowledgment. Acknowledgments are never sent for GET operations.
 477          *   The data sent in the REPLY serves as an implicit acknowledgment.
 478          * - LNET_MD_KIOV: The start and length fields specify an array of
 479          *   struct bio_vec.
 480          * - LNET_MD_MAX_SIZE: The max_size field is valid.
 481          * - LNET_MD_BULK_HANDLE: The bulk_handle field is valid.
 482          * - LNET_MD_TRACK_RESPONSE: Enable response tracking on this MD
 483          *   regardless of the value of the lnet_response_tracking param.
 484          * - LNET_MD_NO_TRACK_RESPONSE: Disable response tracking on this MD
 485          *   regardless of the value of the lnet_response_tracking param.
 486          *
 487          * Note:
 488          * - LNET_MD_KIOV allows for a scatter/gather capability for memory
 489          *   descriptors.
 490          * - When LNET_MD_MAX_SIZE is set, the total length of the memory
 491          *   region (i.e. sum of all fragment lengths) must not be less than
 492          *   \a max_size.
 493          */
 494         unsigned int     options;
 495         /**
 496          * A user-specified value that is associated with the memory
 497          * descriptor. The value does not need to be a pointer, but must fit
 498          * in the space used by a pointer. This value is recorded in events
 499          * associated with operations on this MD.
 500          */
 501         void            *user_ptr;
 502         /**
 503          * The event handler used to log the operations performed on
 504          * the memory region. If this argument is NULL operations
 505          * performed on this memory descriptor are not logged.
 506          */
 507         lnet_handler_t  handler;
 508         /**
 509          * The bulk MD handle which was registered to describe the buffers
 510          * either to be used to transfer data to the peer or receive data
 511          * from the peer. This allows LNet to properly determine the NUMA
 512          * node on which the memory was allocated and use that to select the
 513          * nearest local network interface. This value is only used
 514          * if the LNET_MD_BULK_HANDLE option is set.
 515          */
 516         struct lnet_handle_md bulk_handle;
 517 };
 518
 519 /* Max Transfer Unit (minimum supported everywhere).
 520  * CAVEAT EMPTOR, with multinet (i.e. routers forwarding between networks)
 521  * these limits are system wide and not interface-local. */
 522 #define LNET_MTU_BITS   20
 523 #define LNET_MTU        (1 << LNET_MTU_BITS)
 524
 525 /**
 526  * Options for the MD structure. See struct lnet_md::options.
 527  */
 528 #define LNET_MD_OP_PUT               (1 << 0)
 529 /** See struct lnet_md::options. */
 530 #define LNET_MD_OP_GET               (1 << 1)
 531 /** See struct lnet_md::options. */
 532 #define LNET_MD_MANAGE_REMOTE        (1 << 2)
 533 /* unused                            (1 << 3) */
 534 /** See struct lnet_md::options. */
 535 #define LNET_MD_TRUNCATE             (1 << 4)
 536 /** See struct lnet_md::options. */
 537 #define LNET_MD_ACK_DISABLE          (1 << 5)
 538 /** See struct lnet_md::options. */
 539 /* deprecated #define LNET_MD_IOVEC  (1 << 6) */
 540 /** See struct lnet_md::options. */
 541 #define LNET_MD_MAX_SIZE             (1 << 7)
 542 /** See struct lnet_md::options. */
 543 #define LNET_MD_KIOV                 (1 << 8)
 544 /** See struct lnet_md::options. */
 545 #define LNET_MD_BULK_HANDLE          (1 << 9)
 546 /** See struct lnet_md::options. */
 547 #define LNET_MD_TRACK_RESPONSE       (1 << 10)
 548 /** See struct lnet_md::options. */
 549 #define LNET_MD_NO_TRACK_RESPONSE    (1 << 11)
 550
 551 /* For compatibility with Cray Portals */
 552 #define LNET_MD_PHYS                         0
 553
 554 /** Infinite threshold on MD operations. See struct lnet_md::threshold */
 555 #define LNET_MD_THRESH_INF       (-1)
 556
 557 /** @} lnet_md */
 558
 559 /** \addtogroup lnet_eq
 560  * @{ */
 561
 562 /**
 563  * Six types of events can be logged in an event queue.
 564  */
 565 enum lnet_event_kind {
 566         /** An incoming GET operation has completed on the MD. */
 567         LNET_EVENT_GET          = 1,
 568         /**
 569          * An incoming PUT operation has completed on the MD. The
 570          * underlying layers will not alter the memory (on behalf of this
 571          * operation) once this event has been logged.
 572          */
 573         LNET_EVENT_PUT,
 574         /**
 575          * A REPLY operation has completed. This event is logged after the
 576          * data (if any) from the REPLY has been written into the MD.
 577          */
 578         LNET_EVENT_REPLY,
 579         /** An acknowledgment has been received. */
 580         LNET_EVENT_ACK,
 581         /**
 582          * An outgoing send (PUT or GET) operation has completed. This event
 583          * is logged after the entire buffer has been sent and it is safe for
 584          * the caller to reuse the buffer.
 585          *
 586          * Note:
 587          * - The LNET_EVENT_SEND doesn't guarantee message delivery. It can
 588          *   happen even when the message has not yet been put out on wire.
 589          * - It's unsafe to assume that in an outgoing GET operation
 590          *   the LNET_EVENT_SEND event would happen before the
 591          *   LNET_EVENT_REPLY event. The same holds for LNET_EVENT_SEND and
 592          *   LNET_EVENT_ACK events in an outgoing PUT operation.
 593          */
 594         LNET_EVENT_SEND,
 595         /**
 596          * A MD has been unlinked. Note that LNetMDUnlink() does not
 597          * necessarily trigger an LNET_EVENT_UNLINK event.
 598          * \see LNetMDUnlink
 599          */
 600         LNET_EVENT_UNLINK,
 601 };
 602
 603 #define LNET_SEQ_GT(a, b)       (((signed long)((a) - (b))) > 0)
 604
 605 /**
 606  * Information about an event on a MD.
 607  */
 608 struct lnet_event {
 609         /** The identifier (nid, pid) of the target. */
 610         struct lnet_process_id   target;
 611         /** The identifier (nid, pid) of the initiator. */
 612         struct lnet_process_id   initiator;
 613         /** The source NID on the initiator. */
 614         struct lnet_process_id   source;
 615         /**
 616          * The NID of the immediate sender. If the request has been forwarded
 617          * by routers, this is the NID of the last hop; otherwise it's the
 618          * same as the source.
 619          */
 620         lnet_nid_t          sender;
 621         /** Indicates the type of the event. */
 622         enum lnet_event_kind    type;
 623         /** The portal table index specified in the request */
 624         unsigned int        pt_index;
 625         /** A copy of the match bits specified in the request. */
 626         __u64               match_bits;
 627         /** The length (in bytes) specified in the request. */
 628         unsigned int        rlength;
 629         /**
 630          * The length (in bytes) of the data that was manipulated by the
 631          * operation. For truncated operations, the manipulated length will be
 632          * the number of bytes specified by the MD (possibly with an offset,
 633          * see struct lnet_md). For all other operations, the manipulated length
 634          * will be the length of the requested operation, i.e. rlength.
 635          */
 636         unsigned int        mlength;
 637         /**
 638          * The handle to the MD associated with the event. The handle may be
 639          * invalid if the MD has been unlinked.
 640          */
 641         struct lnet_handle_md   md_handle;
 642         /**
 643          * A snapshot of relevant state of the MD immediately after the event
 644          * has been processed.
 645          */
 646         void                    *md_start;
 647         void                    *md_user_ptr;
 648         unsigned int            md_options;
 649         /**
 650          * 64 bits of out-of-band user data. Only valid for LNET_EVENT_PUT.
 651          * \see LNetPut
 652          */
 653         __u64               hdr_data;
 654         /**
 655          * The message type, to ensure a handler for LNET_EVENT_SEND can
 656          * distinguish between LNET_MSG_GET and LNET_MSG_PUT.
 657          */
 658         __u32               msg_type;
 659         /**
 660          * Indicates the completion status of the operation. It's 0 for
 661          * successful operations, otherwise it's an error code.
 662          */
 663         int                 status;
 664         /**
 665          * Indicates whether the MD has been unlinked. Note that:
 666          * - An event with unlinked set is the last event on the MD.
 667          * - This field is also set for an explicit LNET_EVENT_UNLINK event.
 668          * \see LNetMDUnlink
 669          */
 670         int                 unlinked;
 671         /**
 672          * The displacement (in bytes) into the memory region that the
 673          * operation used. The offset can be determined by the operation for
 674          * a remote managed MD or by the local MD.
 675          * \see struct lnet_md::options
 676          */
 677         unsigned int        offset;
 678         /**
 679          * The sequence number for this event. Sequence numbers are unique
 680          * to each event.
 681          */
 682         volatile unsigned long sequence;
 683 };
 684
 685 /** \addtogroup lnet_data
 686  * @{ */
 687
 688 /**
 689  * Specify whether an acknowledgment should be sent by target when the PUT
 690  * operation completes (i.e., when the data has been written to a MD of the
 691  * target process).
 692  *
 693  * \see struct lnet_md::options for the discussion on LNET_MD_ACK_DISABLE
 694  * by which acknowledgments can be disabled for a MD.
 695  */
 696 enum lnet_ack_req {
 697         /** Request an acknowledgment */
 698         LNET_ACK_REQ,
 699         /** Request that no acknowledgment should be generated. */
 700         LNET_NOACK_REQ
 701 };
 702 /** @} lnet_data */
 703
 704 /** @} lnet */
 705 #endif