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