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_common {
 227         __u32   lcc_msgs_alloc;
 228         __u32   lcc_msgs_max;
 229         __u32   lcc_errors;
 230         __u32   lcc_send_count;
 231         __u32   lcc_recv_count;
 232         __u32   lcc_route_count;
 233         __u32   lcc_drop_count;
 234         __u64   lcc_send_length;
 235         __u64   lcc_recv_length;
 236         __u64   lcc_route_length;
 237         __u64   lcc_drop_length;
 238 } WIRE_ATTR;
 239
 240 struct lnet_counters_health {
 241         __u32   lch_rst_alloc;
 242         __u32   lch_resend_count;
 243         __u32   lch_response_timeout_count;
 244         __u32   lch_local_interrupt_count;
 245         __u32   lch_local_dropped_count;
 246         __u32   lch_local_aborted_count;
 247         __u32   lch_local_no_route_count;
 248         __u32   lch_local_timeout_count;
 249         __u32   lch_local_error_count;
 250         __u32   lch_remote_dropped_count;
 251         __u32   lch_remote_error_count;
 252         __u32   lch_remote_timeout_count;
 253         __u32   lch_network_timeout_count;
 254 };
 255
 256 struct lnet_counters {
 257         struct lnet_counters_common lct_common;
 258         struct lnet_counters_health lct_health;
 259 };
 260
 261 #define LNET_NI_STATUS_UP       0x15aac0de
 262 #define LNET_NI_STATUS_DOWN     0xdeadface
 263 #define LNET_NI_STATUS_INVALID  0x00000000
 264
 265 struct lnet_ni_status {
 266         lnet_nid_t ns_nid;
 267         __u32      ns_status;
 268         __u32      ns_unused;
 269 } WIRE_ATTR;
 270
 271 /*
 272  * NB: value of these features equal to LNET_PROTO_PING_VERSION_x
 273  * of old LNet, so there shouldn't be any compatibility issue
 274  */
 275 #define LNET_PING_FEAT_INVAL            (0)             /* no feature */
 276 #define LNET_PING_FEAT_BASE             (1 << 0)        /* just a ping */
 277 #define LNET_PING_FEAT_NI_STATUS        (1 << 1)        /* return NI status */
 278 #define LNET_PING_FEAT_RTE_DISABLED     (1 << 2)        /* Routing enabled */
 279 #define LNET_PING_FEAT_MULTI_RAIL       (1 << 3)        /* Multi-Rail aware */
 280 #define LNET_PING_FEAT_DISCOVERY        (1 << 4)        /* Supports Discovery */
 281
 282 /*
 283  * All ping feature bits fit to hit the wire.
 284  * In lnet_assert_wire_constants() this is compared against its open-coded
 285  * value, and in lnet_ping_target_update() it is used to verify that no
 286  * unknown bits have been set.
 287  * New feature bits can be added, just be aware that this does change the
 288  * over-the-wire protocol.
 289  */
 290 #define LNET_PING_FEAT_BITS             (LNET_PING_FEAT_BASE | \
 291                                          LNET_PING_FEAT_NI_STATUS | \
 292                                          LNET_PING_FEAT_RTE_DISABLED | \
 293                                          LNET_PING_FEAT_MULTI_RAIL | \
 294                                          LNET_PING_FEAT_DISCOVERY)
 295
 296 struct lnet_ping_info {
 297         __u32                   pi_magic;
 298         __u32                   pi_features;
 299         lnet_pid_t              pi_pid;
 300         __u32                   pi_nnis;
 301         struct lnet_ni_status   pi_ni[0];
 302 } WIRE_ATTR;
 303
 304 #define LNET_PING_INFO_SIZE(NNIDS) \
 305         offsetof(struct lnet_ping_info, pi_ni[NNIDS])
 306 #define LNET_PING_INFO_LONI(PINFO)      ((PINFO)->pi_ni[0].ns_nid)
 307 #define LNET_PING_INFO_SEQNO(PINFO)     ((PINFO)->pi_ni[0].ns_status)
 308
 309 /*
 310  * This is a hard-coded limit on the number of interfaces supported by
 311  * the interface bonding implemented by the ksocknal LND. It must be
 312  * defined here because it is used in LNet data structures that are
 313  * common to all LNDs.
 314  */
 315 #define LNET_INTERFACES_NUM     16
 316
 317 /* The minimum number of interfaces per node supported by LNet. */
 318 #define LNET_INTERFACES_MIN     16
 319 /* The default - arbitrary - value of the lnet_max_interfaces tunable. */
 320 #define LNET_INTERFACES_MAX_DEFAULT     200
 321
 322 /**
 323  * Objects maintained by the LNet are accessed through handles. Handle types
 324  * have names of the form lnet_handle_xx, where xx is one of the two letter
 325  * object type codes ('eq' for event queue, 'md' for memory descriptor, and
 326  * 'me' for match entry). Each type of object is given a unique handle type
 327  * to enhance type checking.
 328  */
 329 #define LNET_WIRE_HANDLE_COOKIE_NONE   (-1)
 330
 331 struct lnet_handle_eq {
 332         __u64   cookie;
 333 };
 334
 335 /**
 336  * Invalidate eq handle \a h.
 337  */
 338 static inline void LNetInvalidateEQHandle(struct lnet_handle_eq *h)
 339 {
 340         h->cookie = LNET_WIRE_HANDLE_COOKIE_NONE;
 341 }
 342
 343 /**
 344  * Check whether eq handle \a h is invalid.
 345  *
 346  * \return 1 if handle is invalid, 0 if valid.
 347  */
 348 static inline int LNetEQHandleIsInvalid(struct lnet_handle_eq h)
 349 {
 350         return (LNET_WIRE_HANDLE_COOKIE_NONE == h.cookie);
 351 }
 352
 353 struct lnet_handle_md {
 354         __u64   cookie;
 355 };
 356
 357 /**
 358  * Invalidate md handle \a h.
 359  */
 360 static inline void LNetInvalidateMDHandle(struct lnet_handle_md *h)
 361 {
 362         h->cookie = LNET_WIRE_HANDLE_COOKIE_NONE;
 363 }
 364
 365 /**
 366  * Check whether eq handle \a h is invalid.
 367  *
 368  * \return 1 if handle is invalid, 0 if valid.
 369  */
 370 static inline int LNetMDHandleIsInvalid(struct lnet_handle_md h)
 371 {
 372         return (LNET_WIRE_HANDLE_COOKIE_NONE == h.cookie);
 373 }
 374
 375 struct lnet_handle_me {
 376         __u64   cookie;
 377 };
 378
 379 /**
 380  * Global process ID.
 381  */
 382 struct lnet_process_id {
 383         /** node id */
 384         lnet_nid_t nid;
 385         /** process id */
 386         lnet_pid_t pid;
 387 };
 388 /** @} lnet_addr */
 389
 390 /** \addtogroup lnet_me
 391  * @{ */
 392
 393 /**
 394  * Specifies whether the match entry or memory descriptor should be unlinked
 395  * automatically (LNET_UNLINK) or not (LNET_RETAIN).
 396  */
 397 enum lnet_unlink {
 398         LNET_RETAIN = 0,
 399         LNET_UNLINK
 400 };
 401
 402 /**
 403  * Values of the type enum lnet_ins_pos are used to control where a new match
 404  * entry is inserted. The value LNET_INS_BEFORE is used to insert the new
 405  * entry before the current entry or before the head of the list. The value
 406  * LNET_INS_AFTER is used to insert the new entry after the current entry
 407  * or after the last item in the list.
 408  */
 409 enum lnet_ins_pos {
 410         /** insert ME before current position or head of the list */
 411         LNET_INS_BEFORE,
 412         /** insert ME after current position or tail of the list */
 413         LNET_INS_AFTER,
 414         /** attach ME at tail of local CPU partition ME list */
 415         LNET_INS_LOCAL
 416 };
 417
 418 /** @} lnet_me */
 419
 420 /** \addtogroup lnet_md
 421  * @{ */
 422
 423 /**
 424  * Defines the visible parts of a memory descriptor. Values of this type
 425  * are used to initialize memory descriptors.
 426  */
 427 struct lnet_md {
 428         /**
 429          * Specify the memory region associated with the memory descriptor.
 430          * If the options field has:
 431          * - LNET_MD_KIOV bit set: The start field points to the starting
 432          * address of an array of lnet_kiov_t and the length field specifies
 433          * the number of entries in the array. The length can't be bigger
 434          * than LNET_MAX_IOV. The lnet_kiov_t is used to describe page-based
 435          * fragments that are not necessarily mapped in virtal memory.
 436          * - LNET_MD_IOVEC bit set: The start field points to the starting
 437          * address of an array of struct kvec and the length field specifies
 438          * the number of entries in the array. The length can't be bigger
 439          * than LNET_MAX_IOV. The struct kvec is used to describe fragments
 440          * that have virtual addresses.
 441          * - Otherwise: The memory region is contiguous. The start field
 442          * specifies the starting address for the memory region and the
 443          * length field specifies its length.
 444          *
 445          * When the memory region is fragmented, all fragments but the first
 446          * one must start on page boundary, and all but the last must end on
 447          * page boundary.
 448          */
 449         void            *start;
 450         unsigned int     length;
 451         /**
 452          * Specifies the maximum number of operations that can be performed
 453          * on the memory descriptor. An operation is any action that could
 454          * possibly generate an event. In the usual case, the threshold value
 455          * is decremented for each operation on the MD. When the threshold
 456          * drops to zero, the MD becomes inactive and does not respond to
 457          * operations. A threshold value of LNET_MD_THRESH_INF indicates that
 458          * there is no bound on the number of operations that may be applied
 459          * to a MD.
 460          */
 461         int              threshold;
 462         /**
 463          * Specifies the largest incoming request that the memory descriptor
 464          * should respond to. When the unused portion of a MD (length -
 465          * local offset) falls below this value, the MD becomes inactive and
 466          * does not respond to further operations. This value is only used
 467          * if the LNET_MD_MAX_SIZE option is set.
 468          */
 469         int              max_size;
 470         /**
 471          * Specifies the behavior of the memory descriptor. A bitwise OR
 472          * of the following values can be used:
 473          * - LNET_MD_OP_PUT: The LNet PUT operation is allowed on this MD.
 474          * - LNET_MD_OP_GET: The LNet GET operation is allowed on this MD.
 475          * - LNET_MD_MANAGE_REMOTE: The offset used in accessing the memory
 476          *   region is provided by the incoming request. By default, the
 477          *   offset is maintained locally. When maintained locally, the
 478          *   offset is incremented by the length of the request so that
 479          *   the next operation (PUT or GET) will access the next part of
 480          *   the memory region. Note that only one offset variable exists
 481          *   per memory descriptor. If both PUT and GET operations are
 482          *   performed on a memory descriptor, the offset is updated each time.
 483          * - LNET_MD_TRUNCATE: The length provided in the incoming request can
 484          *   be reduced to match the memory available in the region (determined
 485          *   by subtracting the offset from the length of the memory region).
 486          *   By default, if the length in the incoming operation is greater
 487          *   than the amount of memory available, the operation is rejected.
 488          * - LNET_MD_ACK_DISABLE: An acknowledgment should not be sent for
 489          *   incoming PUT operations, even if requested. By default,
 490          *   acknowledgments are sent for PUT operations that request an
 491          *   acknowledgment. Acknowledgments are never sent for GET operations.
 492          *   The data sent in the REPLY serves as an implicit acknowledgment.
 493          * - LNET_MD_KIOV: The start and length fields specify an array of
 494          *   lnet_kiov_t.
 495          * - LNET_MD_IOVEC: The start and length fields specify an array of
 496          *   struct iovec.
 497          * - LNET_MD_MAX_SIZE: The max_size field is valid.
 498          * - LNET_MD_BULK_HANDLE: The bulk_handle field is valid.
 499          *
 500          * Note:
 501          * - LNET_MD_KIOV or LNET_MD_IOVEC allows for a scatter/gather
 502          *   capability for memory descriptors. They can't be both set.
 503          * - When LNET_MD_MAX_SIZE is set, the total length of the memory
 504          *   region (i.e. sum of all fragment lengths) must not be less than
 505          *   \a max_size.
 506          */
 507         unsigned int     options;
 508         /**
 509          * A user-specified value that is associated with the memory
 510          * descriptor. The value does not need to be a pointer, but must fit
 511          * in the space used by a pointer. This value is recorded in events
 512          * associated with operations on this MD.
 513          */
 514         void            *user_ptr;
 515         /**
 516          * A handle for the event queue used to log the operations performed on
 517          * the memory region. If this argument is a NULL handle (i.e. nullified
 518          * by LNetInvalidateHandle()), operations performed on this memory
 519          * descriptor are not logged.
 520          */
 521         struct lnet_handle_eq eq_handle;
 522         /**
 523          * The bulk MD handle which was registered to describe the buffers
 524          * either to be used to transfer data to the peer or receive data
 525          * from the peer. This allows LNet to properly determine the NUMA
 526          * node on which the memory was allocated and use that to select the
 527          * nearest local network interface. This value is only used
 528          * if the LNET_MD_BULK_HANDLE option is set.
 529          */
 530         struct lnet_handle_md bulk_handle;
 531 };
 532
 533 /* Max Transfer Unit (minimum supported everywhere).
 534  * CAVEAT EMPTOR, with multinet (i.e. routers forwarding between networks)
 535  * these limits are system wide and not interface-local. */
 536 #define LNET_MTU_BITS   20
 537 #define LNET_MTU        (1 << LNET_MTU_BITS)
 538
 539 /**
 540  * Options for the MD structure. See struct lnet_md::options.
 541  */
 542 #define LNET_MD_OP_PUT               (1 << 0)
 543 /** See struct lnet_md::options. */
 544 #define LNET_MD_OP_GET               (1 << 1)
 545 /** See struct lnet_md::options. */
 546 #define LNET_MD_MANAGE_REMOTE        (1 << 2)
 547 /* unused                            (1 << 3) */
 548 /** See struct lnet_md::options. */
 549 #define LNET_MD_TRUNCATE             (1 << 4)
 550 /** See struct lnet_md::options. */
 551 #define LNET_MD_ACK_DISABLE          (1 << 5)
 552 /** See struct lnet_md::options. */
 553 #define LNET_MD_IOVEC                (1 << 6)
 554 /** See struct lnet_md::options. */
 555 #define LNET_MD_MAX_SIZE             (1 << 7)
 556 /** See struct lnet_md::options. */
 557 #define LNET_MD_KIOV                 (1 << 8)
 558 /** See struct lnet_md::options. */
 559 #define LNET_MD_BULK_HANDLE          (1 << 9)
 560
 561 /* For compatibility with Cray Portals */
 562 #define LNET_MD_PHYS                         0
 563
 564 /** Infinite threshold on MD operations. See struct lnet_md::threshold */
 565 #define LNET_MD_THRESH_INF       (-1)
 566
 567 /**
 568  * A page-based fragment of a MD.
 569  */
 570 typedef struct {
 571         /** Pointer to the page where the fragment resides */
 572         struct page      *kiov_page;
 573         /** Length in bytes of the fragment */
 574         unsigned int     kiov_len;
 575         /**
 576          * Starting offset of the fragment within the page. Note that the
 577          * end of the fragment must not pass the end of the page; i.e.,
 578          * kiov_len + kiov_offset <= PAGE_SIZE.
 579          */
 580         unsigned int     kiov_offset;
 581 } lnet_kiov_t;
 582 /** @} lnet_md */
 583
 584 /** \addtogroup lnet_eq
 585  * @{ */
 586
 587 /**
 588  * Six types of events can be logged in an event queue.
 589  */
 590 enum lnet_event_kind {
 591         /** An incoming GET operation has completed on the MD. */
 592         LNET_EVENT_GET          = 1,
 593         /**
 594          * An incoming PUT operation has completed on the MD. The
 595          * underlying layers will not alter the memory (on behalf of this
 596          * operation) once this event has been logged.
 597          */
 598         LNET_EVENT_PUT,
 599         /**
 600          * A REPLY operation has completed. This event is logged after the
 601          * data (if any) from the REPLY has been written into the MD.
 602          */
 603         LNET_EVENT_REPLY,
 604         /** An acknowledgment has been received. */
 605         LNET_EVENT_ACK,
 606         /**
 607          * An outgoing send (PUT or GET) operation has completed. This event
 608          * is logged after the entire buffer has been sent and it is safe for
 609          * the caller to reuse the buffer.
 610          *
 611          * Note:
 612          * - The LNET_EVENT_SEND doesn't guarantee message delivery. It can
 613          *   happen even when the message has not yet been put out on wire.
 614          * - It's unsafe to assume that in an outgoing GET operation
 615          *   the LNET_EVENT_SEND event would happen before the
 616          *   LNET_EVENT_REPLY event. The same holds for LNET_EVENT_SEND and
 617          *   LNET_EVENT_ACK events in an outgoing PUT operation.
 618          */
 619         LNET_EVENT_SEND,
 620         /**
 621          * A MD has been unlinked. Note that LNetMDUnlink() does not
 622          * necessarily trigger an LNET_EVENT_UNLINK event.
 623          * \see LNetMDUnlink
 624          */
 625         LNET_EVENT_UNLINK,
 626 };
 627
 628 #define LNET_SEQ_GT(a, b)       (((signed long)((a) - (b))) > 0)
 629
 630 /**
 631  * Information about an event on a MD.
 632  */
 633 struct lnet_event {
 634         /** The identifier (nid, pid) of the target. */
 635         struct lnet_process_id   target;
 636         /** The identifier (nid, pid) of the initiator. */
 637         struct lnet_process_id   initiator;
 638         /** The source NID on the initiator. */
 639         struct lnet_process_id   source;
 640         /**
 641          * The NID of the immediate sender. If the request has been forwarded
 642          * by routers, this is the NID of the last hop; otherwise it's the
 643          * same as the source.
 644          */
 645         lnet_nid_t          sender;
 646         /** Indicates the type of the event. */
 647         enum lnet_event_kind    type;
 648         /** The portal table index specified in the request */
 649         unsigned int        pt_index;
 650         /** A copy of the match bits specified in the request. */
 651         __u64               match_bits;
 652         /** The length (in bytes) specified in the request. */
 653         unsigned int        rlength;
 654         /**
 655          * The length (in bytes) of the data that was manipulated by the
 656          * operation. For truncated operations, the manipulated length will be
 657          * the number of bytes specified by the MD (possibly with an offset,
 658          * see struct lnet_md). For all other operations, the manipulated length
 659          * will be the length of the requested operation, i.e. rlength.
 660          */
 661         unsigned int        mlength;
 662         /**
 663          * The handle to the MD associated with the event. The handle may be
 664          * invalid if the MD has been unlinked.
 665          */
 666         struct lnet_handle_md   md_handle;
 667         /**
 668          * A snapshot of the state of the MD immediately after the event has
 669          * been processed. In particular, the threshold field in md will
 670          * reflect the value of the threshold after the operation occurred.
 671          */
 672         struct lnet_md           md;
 673         /**
 674          * 64 bits of out-of-band user data. Only valid for LNET_EVENT_PUT.
 675          * \see LNetPut
 676          */
 677         __u64               hdr_data;
 678         /**
 679          * The message type, to ensure a handler for LNET_EVENT_SEND can
 680          * distinguish between LNET_MSG_GET and LNET_MSG_PUT.
 681          */
 682         __u32               msg_type;
 683         /**
 684          * Indicates the completion status of the operation. It's 0 for
 685          * successful operations, otherwise it's an error code.
 686          */
 687         int                 status;
 688         /**
 689          * Indicates whether the MD has been unlinked. Note that:
 690          * - An event with unlinked set is the last event on the MD.
 691          * - This field is also set for an explicit LNET_EVENT_UNLINK event.
 692          * \see LNetMDUnlink
 693          */
 694         int                 unlinked;
 695         /**
 696          * The displacement (in bytes) into the memory region that the
 697          * operation used. The offset can be determined by the operation for
 698          * a remote managed MD or by the local MD.
 699          * \see struct lnet_md::options
 700          */
 701         unsigned int        offset;
 702         /**
 703          * The sequence number for this event. Sequence numbers are unique
 704          * to each event.
 705          */
 706         volatile unsigned long sequence;
 707 };
 708
 709 /**
 710  * Event queue handler function type.
 711  *
 712  * The EQ handler runs for each event that is deposited into the EQ. The
 713  * handler is supplied with a pointer to the event that triggered the
 714  * handler invocation.
 715  *
 716  * The handler must not block, must be reentrant, and must not call any LNet
 717  * API functions. It should return as quickly as possible.
 718  */
 719 typedef void (*lnet_eq_handler_t)(struct lnet_event *event);
 720 #define LNET_EQ_HANDLER_NONE NULL
 721 /** @} lnet_eq */
 722
 723 /** \addtogroup lnet_data
 724  * @{ */
 725
 726 /**
 727  * Specify whether an acknowledgment should be sent by target when the PUT
 728  * operation completes (i.e., when the data has been written to a MD of the
 729  * target process).
 730  *
 731  * \see struct lnet_md::options for the discussion on LNET_MD_ACK_DISABLE
 732  * by which acknowledgments can be disabled for a MD.
 733  */
 734 enum lnet_ack_req {
 735         /** Request an acknowledgment */
 736         LNET_ACK_REQ,
 737         /** Request that no acknowledgment should be generated. */
 738         LNET_NOACK_REQ
 739 };
 740 /** @} lnet_data */
 741
 742 /** @} lnet */
 743 #endif