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         LNET_INS_BEFORE,
 163         LNET_INS_AFTER
 164 } lnet_ins_pos_t;
 165
 166 /** @} lnet_me */
 167
 168 /** \addtogroup lnet_md
 169  * @{ */
 170
 171 /**
 172  * Defines the visible parts of a memory descriptor. Values of this type
 173  * are used to initialize memory descriptors.
 174  */
 175 typedef struct {
 176         /**
 177          * Specify the memory region associated with the memory descriptor.
 178          * If the options field has:
 179          * - LNET_MD_KIOV bit set: The start field points to the starting
 180          * address of an array of lnet_kiov_t and the length field specifies
 181          * the number of entries in the array. The length can't be bigger
 182          * than LNET_MAX_IOV. The lnet_kiov_t is used to describe page-based
 183          * fragments that are not necessarily mapped in virtal memory.
 184          * - LNET_MD_IOVEC bit set: The start field points to the starting
 185          * address of an array of struct iovec and the length field specifies
 186          * the number of entries in the array. The length can't be bigger
 187          * than LNET_MAX_IOV. The struct iovec is used to describe fragments
 188          * that have virtual addresses.
 189          * - Otherwise: The memory region is contiguous. The start field
 190          * specifies the starting address for the memory region and the
 191          * length field specifies its length.
 192          *
 193          * When the memory region is fragmented, all fragments but the first
 194          * one must start on page boundary, and all but the last must end on
 195          * page boundary.
 196          */
 197         void            *start;
 198         unsigned int     length;
 199         /**
 200          * Specifies the maximum number of operations that can be performed
 201          * on the memory descriptor. An operation is any action that could
 202          * possibly generate an event. In the usual case, the threshold value
 203          * is decremented for each operation on the MD. When the threshold
 204          * drops to zero, the MD becomes inactive and does not respond to
 205          * operations. A threshold value of LNET_MD_THRESH_INF indicates that
 206          * there is no bound on the number of operations that may be applied
 207          * to a MD.
 208          */
 209         int              threshold;
 210         /**
 211          * Specifies the largest incoming request that the memory descriptor
 212          * should respond to. When the unused portion of a MD (length -
 213          * local offset) falls below this value, the MD becomes inactive and
 214          * does not respond to further operations. This value is only used
 215          * if the LNET_MD_MAX_SIZE option is set.
 216          */
 217         int              max_size;
 218         /**
 219          * Specifies the behavior of the memory descriptor. A bitwise OR
 220          * of the following values can be used:
 221          * - LNET_MD_OP_PUT: The LNet PUT operation is allowed on this MD.
 222          * - LNET_MD_OP_GET: The LNet GET operation is allowed on this MD.
 223          * - LNET_MD_MANAGE_REMOTE: The offset used in accessing the memory
 224          *   region is provided by the incoming request. By default, the
 225          *   offset is maintained locally. When maintained locally, the
 226          *   offset is incremented by the length of the request so that
 227          *   the next operation (PUT or GET) will access the next part of
 228          *   the memory region. Note that only one offset variable exists
 229          *   per memory descriptor. If both PUT and GET operations are
 230          *   performed on a memory descriptor, the offset is updated each time.
 231          * - LNET_MD_TRUNCATE: The length provided in the incoming request can
 232          *   be reduced to match the memory available in the region (determined
 233          *   by subtracting the offset from the length of the memory region).
 234          *   By default, if the length in the incoming operation is greater
 235          *   than the amount of memory available, the operation is rejected.
 236          * - LNET_MD_ACK_DISABLE: An acknowledgment should not be sent for
 237          *   incoming PUT operations, even if requested. By default,
 238          *   acknowledgments are sent for PUT operations that request an
 239          *   acknowledgment. Acknowledgments are never sent for GET operations.
 240          *   The data sent in the REPLY serves as an implicit acknowledgment.
 241          * - LNET_MD_KIOV: The start and length fields specify an array of
 242          *   lnet_kiov_t.
 243          * - LNET_MD_IOVEC: The start and length fields specify an array of
 244          *   struct iovec.
 245          * - LNET_MD_MAX_SIZE: The max_size field is valid.
 246          *
 247          * Note:
 248          * - LNET_MD_KIOV or LNET_MD_IOVEC allows for a scatter/gather
 249          *   capability for memory descriptors. They can't be both set.
 250          * - When LNET_MD_MAX_SIZE is set, the total length of the memory
 251          *   region (i.e. sum of all fragment lengths) must not be less than
 252          *   \a max_size.
 253          */
 254         unsigned int     options;
 255         /**
 256          * A user-specified value that is associated with the memory
 257          * descriptor. The value does not need to be a pointer, but must fit
 258          * in the space used by a pointer. This value is recorded in events
 259          * associated with operations on this MD.
 260          */
 261         void            *user_ptr;
 262         /**
 263          * A handle for the event queue used to log the operations performed on
 264          * the memory region. If this argument is a NULL handle (i.e. nullified
 265          * by LNetInvalidateHandle()), operations performed on this memory
 266          * descriptor are not logged.
 267          */
 268         lnet_handle_eq_t eq_handle;
 269 } lnet_md_t;
 270
 271 /* Max Transfer Unit (minimum supported everywhere) */
 272 #define LNET_MTU_BITS   20
 273 #define LNET_MTU        (1<<LNET_MTU_BITS)
 274
 275 /** limit on the number of fragments in discontiguous MDs */
 276 #define LNET_MAX_IOV    256
 277
 278 /* Max payload size */
 279 #ifndef LNET_MAX_PAYLOAD
 280 # error "LNET_MAX_PAYLOAD must be defined in config.h"
 281 #else
 282 # if (LNET_MAX_PAYLOAD < LNET_MTU)
 283 #  error "LNET_MAX_PAYLOAD too small - error in configure --with-max-payload-mb"
 284 # elif defined(__KERNEL__)
 285 #  if (LNET_MAX_PAYLOAD > (PAGE_SIZE * LNET_MAX_IOV))
 286 /*  PAGE_SIZE is a constant: check with cpp! */
 287 #   error "LNET_MAX_PAYLOAD too large - error in configure --with-max-payload-mb"
 288 #  endif
 289 # endif
 290 #endif
 291
 292 /**
 293  * Options for the MD structure. See lnet_md_t::options.
 294  */
 295 #define LNET_MD_OP_PUT               (1 << 0)
 296 /** See lnet_md_t::options. */
 297 #define LNET_MD_OP_GET               (1 << 1)
 298 /** See lnet_md_t::options. */
 299 #define LNET_MD_MANAGE_REMOTE        (1 << 2)
 300 /* unused                            (1 << 3) */
 301 /** See lnet_md_t::options. */
 302 #define LNET_MD_TRUNCATE             (1 << 4)
 303 /** See lnet_md_t::options. */
 304 #define LNET_MD_ACK_DISABLE          (1 << 5)
 305 /** See lnet_md_t::options. */
 306 #define LNET_MD_IOVEC                (1 << 6)
 307 /** See lnet_md_t::options. */
 308 #define LNET_MD_MAX_SIZE             (1 << 7)
 309 /** See lnet_md_t::options. */
 310 #define LNET_MD_KIOV                 (1 << 8)
 311
 312 /* For compatibility with Cray Portals */
 313 #define LNET_MD_PHYS                         0
 314
 315 /** Infinite threshold on MD operations. See lnet_md_t::threshold */
 316 #define LNET_MD_THRESH_INF       (-1)
 317
 318 /* NB lustre portals uses struct iovec internally! */
 319 typedef struct iovec lnet_md_iovec_t;
 320
 321 /**
 322  * A page-based fragment of a MD.
 323  */
 324 typedef struct {
 325         /** Pointer to the page where the fragment resides */
 326         cfs_page_t      *kiov_page;
 327         /** Length in bytes of the fragment */
 328         unsigned int     kiov_len;
 329         /**
 330          * Starting offset of the fragment within the page. Note that the
 331          * end of the fragment must not pass the end of the page; i.e.,
 332          * kiov_len + kiov_offset <= CFS_PAGE_SIZE.
 333          */
 334         unsigned int     kiov_offset;
 335 } lnet_kiov_t;
 336 /** @} lnet_md */
 337
 338 /** \addtogroup lnet_eq
 339  * @{ */
 340
 341 /**
 342  * Six types of events can be logged in an event queue.
 343  */
 344 typedef enum {
 345         /** An incoming GET operation has completed on the MD. */
 346         LNET_EVENT_GET          = 1,
 347         /**
 348          * An incoming PUT operation has completed on the MD. The
 349          * underlying layers will not alter the memory (on behalf of this
 350          * operation) once this event has been logged.
 351          */
 352         LNET_EVENT_PUT,
 353         /**
 354          * A REPLY operation has completed. This event is logged after the
 355          * data (if any) from the REPLY has been written into the MD.
 356          */
 357         LNET_EVENT_REPLY,
 358         /** An acknowledgment has been received. */
 359         LNET_EVENT_ACK,
 360         /**
 361          * An outgoing send (PUT or GET) operation has completed. This event
 362          * is logged after the entire buffer has been sent and it is safe for
 363          * the caller to reuse the buffer.
 364          *
 365          * Note:
 366          * - The LNET_EVENT_SEND doesn't guarantee message delivery. It can
 367          *   happen even when the message has not yet been put out on wire.
 368          * - It's unsafe to assume that in an outgoing GET operation
 369          *   the LNET_EVENT_SEND event would happen before the
 370          *   LNET_EVENT_REPLY event. The same holds for LNET_EVENT_SEND and
 371          *   LNET_EVENT_ACK events in an outgoing PUT operation.
 372          */
 373         LNET_EVENT_SEND,
 374         /**
 375          * A MD has been unlinked. Note that LNetMDUnlink() does not
 376          * necessarily trigger an LNET_EVENT_UNLINK event.
 377          * \see LNetMDUnlink
 378          */
 379         LNET_EVENT_UNLINK,
 380 } lnet_event_kind_t;
 381
 382 #define LNET_SEQ_BASETYPE       long
 383 typedef unsigned LNET_SEQ_BASETYPE lnet_seq_t;
 384 #define LNET_SEQ_GT(a,b)        (((signed LNET_SEQ_BASETYPE)((a) - (b))) > 0)
 385
 386 /* XXX
 387  * cygwin need the pragma line, not clear if it's needed in other places.
 388  * checking!!!
 389  */
 390 #ifdef __CYGWIN__
 391 #pragma pack(push, 4)
 392 #endif
 393
 394 /**
 395  * Information about an event on a MD.
 396  */
 397 typedef struct {
 398         /** The identifier (nid, pid) of the target. */
 399         lnet_process_id_t   target;
 400         /** The identifier (nid, pid) of the initiator. */
 401         lnet_process_id_t   initiator;
 402         /**
 403          * The NID of the immediate sender. If the request has been forwarded
 404          * by routers, this is the NID of the last hop; otherwise it's the
 405          * same as the initiator.
 406          */
 407         lnet_nid_t          sender;
 408         /** Indicates the type of the event. */
 409         lnet_event_kind_t   type;
 410         /** The portal table index specified in the request */
 411         unsigned int        pt_index;
 412         /** A copy of the match bits specified in the request. */
 413         __u64               match_bits;
 414         /** The length (in bytes) specified in the request. */
 415         unsigned int        rlength;
 416         /**
 417          * The length (in bytes) of the data that was manipulated by the
 418          * operation. For truncated operations, the manipulated length will be
 419          * the number of bytes specified by the MD (possibly with an offset,
 420          * see lnet_md_t). For all other operations, the manipulated length
 421          * will be the length of the requested operation, i.e. rlength.
 422          */
 423         unsigned int        mlength;
 424         /**
 425          * The handle to the MD associated with the event. The handle may be
 426          * invalid if the MD has been unlinked.
 427          */
 428         lnet_handle_md_t    md_handle;
 429         /**
 430          * A snapshot of the state of the MD immediately after the event has
 431          * been processed. In particular, the threshold field in md will
 432          * reflect the value of the threshold after the operation occurred.
 433          */
 434         lnet_md_t           md;
 435         /**
 436          * 64 bits of out-of-band user data. Only valid for LNET_EVENT_PUT.
 437          * \see LNetPut
 438          */
 439         __u64               hdr_data;
 440         /**
 441          * Indicates the completion status of the operation. It's 0 for
 442          * successful operations, otherwise it's an error code.
 443          */
 444         int                 status;
 445         /**
 446          * Indicates whether the MD has been unlinked. Note that:
 447          * - An event with unlinked set is the last event on the MD.
 448          * - This field is also set for an explicit LNET_EVENT_UNLINK event.
 449          * \see LNetMDUnlink
 450          */
 451         int                 unlinked;
 452         /**
 453          * The displacement (in bytes) into the memory region that the
 454          * operation used. The offset can be determined by the operation for
 455          * a remote managed MD or by the local MD.
 456          * \see lnet_md_t::options
 457          */
 458         unsigned int        offset;
 459 #ifdef CRAY_XT3
 460         lnet_uid_t          uid;
 461 #endif
 462
 463         /**
 464          * The sequence number for this event. Sequence numbers are unique
 465          * to each event.
 466          */
 467         volatile lnet_seq_t sequence;
 468 } lnet_event_t;
 469 #ifdef __CYGWIN__
 470 #pragma pop
 471 #endif
 472
 473 /**
 474  * Event queue handler function type.
 475  *
 476  * The EQ handler runs for each event that is deposited into the EQ. The
 477  * handler is supplied with a pointer to the event that triggered the
 478  * handler invocation.
 479  *
 480  * The handler must not block, must be reentrant, and must not call any LNet
 481  * API functions. It should return as quickly as possible.
 482  */
 483 typedef void (*lnet_eq_handler_t)(lnet_event_t *event);
 484 #define LNET_EQ_HANDLER_NONE NULL
 485 /** @} lnet_eq */
 486
 487 /** \addtogroup lnet_data
 488  * @{ */
 489
 490 /**
 491  * Specify whether an acknowledgment should be sent by target when the PUT
 492  * operation completes (i.e., when the data has been written to a MD of the
 493  * target process).
 494  *
 495  * \see lnet_md_t::options for the discussion on LNET_MD_ACK_DISABLE by which
 496  * acknowledgments can be disabled for a MD.
 497  */
 498 typedef enum {
 499         /** Request an acknowledgment */
 500         LNET_ACK_REQ,
 501         /** Request that no acknowledgment should be generated. */
 502         LNET_NOACK_REQ
 503 } lnet_ack_req_t;
 504 /** @} lnet_data */
 505
 506 /** @} lnet */
 507 #endif