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.sun.com/software/products/lustre/docs/GPLv2.pdf
  19  *
  20  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  21  * CA 95054 USA or visit www.sun.com if you need additional information or
  22  * have any questions.
  23  *
  24  * GPL HEADER END
  25  */
  26 /*
  27  * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
  28  * Use is subject to license terms.
  29  */
  30 /*
  31  * This file is part of Lustre, http://www.lustre.org/
  32  * Lustre is a trademark of Sun Microsystems, Inc.
  33  */
  34
  35 #ifndef __LNET_TYPES_H__
  36 #define __LNET_TYPES_H__
  37
  38 /** \addtogroup lnet
  39  * @{ */
  40
  41 #include <libcfs/libcfs.h>
  42
  43 /** \addtogroup lnet_addr
  44  * @{ */
  45
  46 /** Portal reserved for LNet's own use.
  47  * \see lustre/include/lustre/lustre_idl.h for Lustre portal assignments.
  48  */
  49 #define LNET_RESERVED_PORTAL      0
  50
  51 /**
  52  * Address of an end-point in an LNet network.
  53  *
  54  * A node can have multiple end-points and hence multiple addresses.
  55  * An LNet network can be a simple network (e.g. tcp0) or a network of
  56  * LNet networks connected by LNet routers. Therefore an end-point address
  57  * has two parts: network ID, and address within a network.
  58  *
  59  * \see LNET_NIDNET, LNET_NIDADDR, and LNET_MKNID.
  60  */
  61 typedef __u64 lnet_nid_t;
  62 /**
  63  * ID of a process in a node. Shortened as PID to distinguish from
  64  * lnet_process_id_t, 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 #ifdef CRAY_XT3
  74 typedef __u32 lnet_uid_t;
  75 #define LNET_UID_ANY      ((lnet_uid_t) -1)
  76 #endif
  77
  78 #define LNET_PID_RESERVED 0xf0000000 /* reserved bits in PID */
  79 #define LNET_PID_USERFLAG 0x80000000 /* set in userspace peers */
  80
  81 #define LNET_TIME_FOREVER    (-1)
  82
  83 /**
  84  * Objects maintained by the LNet are accessed through handles. Handle types
  85  * have names of the form lnet_handle_xx_t, where xx is one of the two letter
  86  * object type codes ('eq' for event queue, 'md' for memory descriptor, and
  87  * 'me' for match entry).
  88  * Each type of object is given a unique handle type to enhance type checking.
  89  * The type lnet_handle_any_t can be used when a generic handle is needed.
  90  * Every handle value can be converted into a value of type lnet_handle_any_t
  91  * without loss of information.
  92  */
  93 typedef struct {
  94         __u64         cookie;
  95 } lnet_handle_any_t;
  96
  97 typedef lnet_handle_any_t lnet_handle_eq_t;
  98 typedef lnet_handle_any_t lnet_handle_md_t;
  99 typedef lnet_handle_any_t lnet_handle_me_t;
 100
 101 #define LNET_WIRE_HANDLE_COOKIE_NONE   (-1)
 102
 103 /**
 104  * Invalidate handle \a h.
 105  */
 106 static inline void LNetInvalidateHandle(lnet_handle_any_t *h)
 107 {
 108         h->cookie = LNET_WIRE_HANDLE_COOKIE_NONE;
 109 }
 110
 111 /**
 112  * Compare handles \a h1 and \a h2.
 113  *
 114  * \return 1 if handles are equal, 0 if otherwise.
 115  */
 116 static inline int LNetHandleIsEqual (lnet_handle_any_t h1, lnet_handle_any_t h2)
 117 {
 118         return (h1.cookie == h2.cookie);
 119 }
 120
 121 /**
 122  * Check whether handle \a h is invalid.
 123  *
 124  * \return 1 if handle is invalid, 0 if valid.
 125  */
 126 static inline int LNetHandleIsInvalid(lnet_handle_any_t h)
 127 {
 128         return (LNET_WIRE_HANDLE_COOKIE_NONE == h.cookie);
 129 }
 130
 131 /**
 132  * Global process ID.
 133  */
 134 typedef struct {
 135         /** node id */
 136         lnet_nid_t nid;
 137         /** process id */
 138         lnet_pid_t pid;
 139 } lnet_process_id_t;
 140 /** @} lnet_addr */
 141
 142 /** \addtogroup lnet_me
 143  * @{ */
 144
 145 /**
 146  * Specifies whether the match entry or memory descriptor should be unlinked
 147  * automatically (LNET_UNLINK) or not (LNET_RETAIN).
 148  */
 149 typedef enum {
 150         LNET_RETAIN = 0,
 151         LNET_UNLINK
 152 } lnet_unlink_t;
 153
 154 /**
 155  * Values of the type lnet_ins_pos_t are used to control where a new match
 156  * entry is inserted. The value LNET_INS_BEFORE is used to insert the new
 157  * entry before the current entry or before the head of the list. The value
 158  * LNET_INS_AFTER is used to insert the new entry after the current entry
 159  * or after the last item in the list.
 160  */
 161 typedef enum {
 162         /** insert ME before current position or head of the list */
 163         LNET_INS_BEFORE,
 164         /** insert ME after current position or tail of the list */
 165         LNET_INS_AFTER,
 166         /** attach ME at tail of local CPU partition ME list */
 167         LNET_INS_LOCAL
 168 } lnet_ins_pos_t;
 169
 170 /** @} lnet_me */
 171
 172 /** \addtogroup lnet_md
 173  * @{ */
 174
 175 /**
 176  * Defines the visible parts of a memory descriptor. Values of this type
 177  * are used to initialize memory descriptors.
 178  */
 179 typedef struct {
 180         /**
 181          * Specify the memory region associated with the memory descriptor.
 182          * If the options field has:
 183          * - LNET_MD_KIOV bit set: The start field points to the starting
 184          * address of an array of lnet_kiov_t and the length field specifies
 185          * the number of entries in the array. The length can't be bigger
 186          * than LNET_MAX_IOV. The lnet_kiov_t is used to describe page-based
 187          * fragments that are not necessarily mapped in virtal memory.
 188          * - LNET_MD_IOVEC bit set: The start field points to the starting
 189          * address of an array of struct iovec and the length field specifies
 190          * the number of entries in the array. The length can't be bigger
 191          * than LNET_MAX_IOV. The struct iovec is used to describe fragments
 192          * that have virtual addresses.
 193          * - Otherwise: The memory region is contiguous. The start field
 194          * specifies the starting address for the memory region and the
 195          * length field specifies its length.
 196          *
 197          * When the memory region is fragmented, all fragments but the first
 198          * one must start on page boundary, and all but the last must end on
 199          * page boundary.
 200          */
 201         void            *start;
 202         unsigned int     length;
 203         /**
 204          * Specifies the maximum number of operations that can be performed
 205          * on the memory descriptor. An operation is any action that could
 206          * possibly generate an event. In the usual case, the threshold value
 207          * is decremented for each operation on the MD. When the threshold
 208          * drops to zero, the MD becomes inactive and does not respond to
 209          * operations. A threshold value of LNET_MD_THRESH_INF indicates that
 210          * there is no bound on the number of operations that may be applied
 211          * to a MD.
 212          */
 213         int              threshold;
 214         /**
 215          * Specifies the largest incoming request that the memory descriptor
 216          * should respond to. When the unused portion of a MD (length -
 217          * local offset) falls below this value, the MD becomes inactive and
 218          * does not respond to further operations. This value is only used
 219          * if the LNET_MD_MAX_SIZE option is set.
 220          */
 221         int              max_size;
 222         /**
 223          * Specifies the behavior of the memory descriptor. A bitwise OR
 224          * of the following values can be used:
 225          * - LNET_MD_OP_PUT: The LNet PUT operation is allowed on this MD.
 226          * - LNET_MD_OP_GET: The LNet GET operation is allowed on this MD.
 227          * - LNET_MD_MANAGE_REMOTE: The offset used in accessing the memory
 228          *   region is provided by the incoming request. By default, the
 229          *   offset is maintained locally. When maintained locally, the
 230          *   offset is incremented by the length of the request so that
 231          *   the next operation (PUT or GET) will access the next part of
 232          *   the memory region. Note that only one offset variable exists
 233          *   per memory descriptor. If both PUT and GET operations are
 234          *   performed on a memory descriptor, the offset is updated each time.
 235          * - LNET_MD_TRUNCATE: The length provided in the incoming request can
 236          *   be reduced to match the memory available in the region (determined
 237          *   by subtracting the offset from the length of the memory region).
 238          *   By default, if the length in the incoming operation is greater
 239          *   than the amount of memory available, the operation is rejected.
 240          * - LNET_MD_ACK_DISABLE: An acknowledgment should not be sent for
 241          *   incoming PUT operations, even if requested. By default,
 242          *   acknowledgments are sent for PUT operations that request an
 243          *   acknowledgment. Acknowledgments are never sent for GET operations.
 244          *   The data sent in the REPLY serves as an implicit acknowledgment.
 245          * - LNET_MD_KIOV: The start and length fields specify an array of
 246          *   lnet_kiov_t.
 247          * - LNET_MD_IOVEC: The start and length fields specify an array of
 248          *   struct iovec.
 249          * - LNET_MD_MAX_SIZE: The max_size field is valid.
 250          *
 251          * Note:
 252          * - LNET_MD_KIOV or LNET_MD_IOVEC allows for a scatter/gather
 253          *   capability for memory descriptors. They can't be both set.
 254          * - When LNET_MD_MAX_SIZE is set, the total length of the memory
 255          *   region (i.e. sum of all fragment lengths) must not be less than
 256          *   \a max_size.
 257          */
 258         unsigned int     options;
 259         /**
 260          * A user-specified value that is associated with the memory
 261          * descriptor. The value does not need to be a pointer, but must fit
 262          * in the space used by a pointer. This value is recorded in events
 263          * associated with operations on this MD.
 264          */
 265         void            *user_ptr;
 266         /**
 267          * A handle for the event queue used to log the operations performed on
 268          * the memory region. If this argument is a NULL handle (i.e. nullified
 269          * by LNetInvalidateHandle()), operations performed on this memory
 270          * descriptor are not logged.
 271          */
 272         lnet_handle_eq_t eq_handle;
 273 } lnet_md_t;
 274
 275 /* Max Transfer Unit (minimum supported everywhere) */
 276 #define LNET_MTU_BITS   20
 277 #define LNET_MTU        (1<<LNET_MTU_BITS)
 278
 279 /** limit on the number of fragments in discontiguous MDs */
 280 #define LNET_MAX_IOV    256
 281
 282 /* Max payload size */
 283 #ifndef LNET_MAX_PAYLOAD
 284 # error "LNET_MAX_PAYLOAD must be defined in config.h"
 285 #else
 286 # if (LNET_MAX_PAYLOAD < LNET_MTU)
 287 #  error "LNET_MAX_PAYLOAD too small - error in configure --with-max-payload-mb"
 288 # elif defined(__KERNEL__)
 289 #  if (LNET_MAX_PAYLOAD > (PAGE_SIZE * LNET_MAX_IOV))
 290 /*  PAGE_SIZE is a constant: check with cpp! */
 291 #   error "LNET_MAX_PAYLOAD too large - error in configure --with-max-payload-mb"
 292 #  endif
 293 # endif
 294 #endif
 295
 296 /**
 297  * Options for the MD structure. See lnet_md_t::options.
 298  */
 299 #define LNET_MD_OP_PUT               (1 << 0)
 300 /** See lnet_md_t::options. */
 301 #define LNET_MD_OP_GET               (1 << 1)
 302 /** See lnet_md_t::options. */
 303 #define LNET_MD_MANAGE_REMOTE        (1 << 2)
 304 /* unused                            (1 << 3) */
 305 /** See lnet_md_t::options. */
 306 #define LNET_MD_TRUNCATE             (1 << 4)
 307 /** See lnet_md_t::options. */
 308 #define LNET_MD_ACK_DISABLE          (1 << 5)
 309 /** See lnet_md_t::options. */
 310 #define LNET_MD_IOVEC                (1 << 6)
 311 /** See lnet_md_t::options. */
 312 #define LNET_MD_MAX_SIZE             (1 << 7)
 313 /** See lnet_md_t::options. */
 314 #define LNET_MD_KIOV                 (1 << 8)
 315
 316 /* For compatibility with Cray Portals */
 317 #define LNET_MD_PHYS                         0
 318
 319 /** Infinite threshold on MD operations. See lnet_md_t::threshold */
 320 #define LNET_MD_THRESH_INF       (-1)
 321
 322 /* NB lustre portals uses struct iovec internally! */
 323 typedef struct iovec lnet_md_iovec_t;
 324
 325 /**
 326  * A page-based fragment of a MD.
 327  */
 328 typedef struct {
 329         /** Pointer to the page where the fragment resides */
 330         cfs_page_t      *kiov_page;
 331         /** Length in bytes of the fragment */
 332         unsigned int     kiov_len;
 333         /**
 334          * Starting offset of the fragment within the page. Note that the
 335          * end of the fragment must not pass the end of the page; i.e.,
 336          * kiov_len + kiov_offset <= CFS_PAGE_SIZE.
 337          */
 338         unsigned int     kiov_offset;
 339 } lnet_kiov_t;
 340 /** @} lnet_md */
 341
 342 /** \addtogroup lnet_eq
 343  * @{ */
 344
 345 /**
 346  * Six types of events can be logged in an event queue.
 347  */
 348 typedef enum {
 349         /** An incoming GET operation has completed on the MD. */
 350         LNET_EVENT_GET          = 1,
 351         /**
 352          * An incoming PUT operation has completed on the MD. The
 353          * underlying layers will not alter the memory (on behalf of this
 354          * operation) once this event has been logged.
 355          */
 356         LNET_EVENT_PUT,
 357         /**
 358          * A REPLY operation has completed. This event is logged after the
 359          * data (if any) from the REPLY has been written into the MD.
 360          */
 361         LNET_EVENT_REPLY,
 362         /** An acknowledgment has been received. */
 363         LNET_EVENT_ACK,
 364         /**
 365          * An outgoing send (PUT or GET) operation has completed. This event
 366          * is logged after the entire buffer has been sent and it is safe for
 367          * the caller to reuse the buffer.
 368          *
 369          * Note:
 370          * - The LNET_EVENT_SEND doesn't guarantee message delivery. It can
 371          *   happen even when the message has not yet been put out on wire.
 372          * - It's unsafe to assume that in an outgoing GET operation
 373          *   the LNET_EVENT_SEND event would happen before the
 374          *   LNET_EVENT_REPLY event. The same holds for LNET_EVENT_SEND and
 375          *   LNET_EVENT_ACK events in an outgoing PUT operation.
 376          */
 377         LNET_EVENT_SEND,
 378         /**
 379          * A MD has been unlinked. Note that LNetMDUnlink() does not
 380          * necessarily trigger an LNET_EVENT_UNLINK event.
 381          * \see LNetMDUnlink
 382          */
 383         LNET_EVENT_UNLINK,
 384 } lnet_event_kind_t;
 385
 386 #define LNET_SEQ_BASETYPE       long
 387 typedef unsigned LNET_SEQ_BASETYPE lnet_seq_t;
 388 #define LNET_SEQ_GT(a,b)        (((signed LNET_SEQ_BASETYPE)((a) - (b))) > 0)
 389
 390 /* XXX
 391  * cygwin need the pragma line, not clear if it's needed in other places.
 392  * checking!!!
 393  */
 394 #ifdef __CYGWIN__
 395 #pragma pack(push, 4)
 396 #endif
 397
 398 /**
 399  * Information about an event on a MD.
 400  */
 401 typedef struct {
 402         /** The identifier (nid, pid) of the target. */
 403         lnet_process_id_t   target;
 404         /** The identifier (nid, pid) of the initiator. */
 405         lnet_process_id_t   initiator;
 406         /**
 407          * The NID of the immediate sender. If the request has been forwarded
 408          * by routers, this is the NID of the last hop; otherwise it's the
 409          * same as the initiator.
 410          */
 411         lnet_nid_t          sender;
 412         /** Indicates the type of the event. */
 413         lnet_event_kind_t   type;
 414         /** The portal table index specified in the request */
 415         unsigned int        pt_index;
 416         /** A copy of the match bits specified in the request. */
 417         __u64               match_bits;
 418         /** The length (in bytes) specified in the request. */
 419         unsigned int        rlength;
 420         /**
 421          * The length (in bytes) of the data that was manipulated by the
 422          * operation. For truncated operations, the manipulated length will be
 423          * the number of bytes specified by the MD (possibly with an offset,
 424          * see lnet_md_t). For all other operations, the manipulated length
 425          * will be the length of the requested operation, i.e. rlength.
 426          */
 427         unsigned int        mlength;
 428         /**
 429          * The handle to the MD associated with the event. The handle may be
 430          * invalid if the MD has been unlinked.
 431          */
 432         lnet_handle_md_t    md_handle;
 433         /**
 434          * A snapshot of the state of the MD immediately after the event has
 435          * been processed. In particular, the threshold field in md will
 436          * reflect the value of the threshold after the operation occurred.
 437          */
 438         lnet_md_t           md;
 439         /**
 440          * 64 bits of out-of-band user data. Only valid for LNET_EVENT_PUT.
 441          * \see LNetPut
 442          */
 443         __u64               hdr_data;
 444         /**
 445          * Indicates the completion status of the operation. It's 0 for
 446          * successful operations, otherwise it's an error code.
 447          */
 448         int                 status;
 449         /**
 450          * Indicates whether the MD has been unlinked. Note that:
 451          * - An event with unlinked set is the last event on the MD.
 452          * - This field is also set for an explicit LNET_EVENT_UNLINK event.
 453          * \see LNetMDUnlink
 454          */
 455         int                 unlinked;
 456         /**
 457          * The displacement (in bytes) into the memory region that the
 458          * operation used. The offset can be determined by the operation for
 459          * a remote managed MD or by the local MD.
 460          * \see lnet_md_t::options
 461          */
 462         unsigned int        offset;
 463 #ifdef CRAY_XT3
 464         lnet_uid_t          uid;
 465 #endif
 466
 467         /**
 468          * The sequence number for this event. Sequence numbers are unique
 469          * to each event.
 470          */
 471         volatile lnet_seq_t sequence;
 472 } lnet_event_t;
 473 #ifdef __CYGWIN__
 474 #pragma pop
 475 #endif
 476
 477 /**
 478  * Event queue handler function type.
 479  *
 480  * The EQ handler runs for each event that is deposited into the EQ. The
 481  * handler is supplied with a pointer to the event that triggered the
 482  * handler invocation.
 483  *
 484  * The handler must not block, must be reentrant, and must not call any LNet
 485  * API functions. It should return as quickly as possible.
 486  */
 487 typedef void (*lnet_eq_handler_t)(lnet_event_t *event);
 488 #define LNET_EQ_HANDLER_NONE NULL
 489 /** @} lnet_eq */
 490
 491 /** \addtogroup lnet_data
 492  * @{ */
 493
 494 /**
 495  * Specify whether an acknowledgment should be sent by target when the PUT
 496  * operation completes (i.e., when the data has been written to a MD of the
 497  * target process).
 498  *
 499  * \see lnet_md_t::options for the discussion on LNET_MD_ACK_DISABLE by which
 500  * acknowledgments can be disabled for a MD.
 501  */
 502 typedef enum {
 503         /** Request an acknowledgment */
 504         LNET_ACK_REQ,
 505         /** Request that no acknowledgment should be generated. */
 506         LNET_NOACK_REQ
 507 } lnet_ack_req_t;
 508 /** @} lnet_data */
 509
 510 /** @} lnet */
 511 #endif