lnet/include/lnet/types.h

   1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
   2  * vim:expandtab:shiftwidth=8:tabstop=8:
   3  */
   4 #ifndef __LNET_TYPES_H__
   5 #define __LNET_TYPES_H__
   6
   7 #include <libcfs/libcfs.h>
   8
   9 #define LNET_RESERVED_PORTAL      0  /* portals reserved for lnet's own use */
  10
  11 typedef __u64 lnet_nid_t;
  12 typedef __u32 lnet_pid_t;
  13
  14 #define LNET_NID_ANY      ((lnet_nid_t) -1)
  15 #define LNET_PID_ANY      ((lnet_pid_t) -1)
  16
  17 #ifdef CRAY_XT3
  18 typedef __u32 lnet_uid_t;
  19 #define LNET_UID_ANY      ((lnet_uid_t) -1)
  20 #endif
  21
  22 #define LNET_PID_RESERVED 0xf0000000 /* reserved bits in PID */
  23 #define LNET_PID_USERFLAG 0x80000000 /* set in userspace peers */
  24
  25 #define LNET_TIME_FOREVER    (-1)
  26
  27 typedef struct {
  28         __u64         cookie;
  29 } lnet_handle_any_t;
  30
  31 typedef lnet_handle_any_t lnet_handle_eq_t;
  32 typedef lnet_handle_any_t lnet_handle_md_t;
  33 typedef lnet_handle_any_t lnet_handle_me_t;
  34
  35 #define LNET_INVALID_HANDLE \
  36     ((const lnet_handle_any_t){.cookie = -1})
  37 #define LNET_EQ_NONE LNET_INVALID_HANDLE
  38
  39 static inline int LNetHandleIsEqual (lnet_handle_any_t h1, lnet_handle_any_t h2)
  40 {
  41         return (h1.cookie == h2.cookie);
  42 }
  43
  44 typedef struct {
  45         lnet_nid_t nid;
  46         lnet_pid_t pid;   /* node id / process id */
  47 } lnet_process_id_t;
  48
  49 typedef enum {
  50         LNET_RETAIN = 0,
  51         LNET_UNLINK
  52 } lnet_unlink_t;
  53
  54 typedef enum {
  55         LNET_INS_BEFORE,
  56         LNET_INS_AFTER
  57 } lnet_ins_pos_t;
  58
  59 typedef struct {
  60         void            *start;
  61         unsigned int     length;
  62         int              threshold;
  63         int              max_size;
  64         unsigned int     options;
  65         void            *user_ptr;
  66         lnet_handle_eq_t eq_handle;
  67 } lnet_md_t;
  68
  69 /* Max Transfer Unit (minimum supported everywhere) */
  70 #define LNET_MTU_BITS   20
  71 #define LNET_MTU        (1<<LNET_MTU_BITS)
  72
  73 /* limit on the number of entries in discontiguous MDs */
  74 #define LNET_MAX_IOV    256
  75
  76 /* Max payload size */
  77 #ifndef LNET_MAX_PAYLOAD
  78 # error "LNET_MAX_PAYLOAD must be defined in config.h"
  79 #else
  80 # if (LNET_MAX_PAYLOAD < LNET_MTU)
  81 #  error "LNET_MAX_PAYLOAD too small - error in configure --with-max-payload-mb"
  82 # elif defined(__KERNEL__)
  83 #  if (LNET_MAX_PAYLOAD > (PAGE_SIZE * LNET_MAX_IOV))
  84 /*  PAGE_SIZE is a constant: check with cpp! */
  85 #   error "LNET_MAX_PAYLOAD too large - error in configure --with-max-payload-mb"
  86 #  endif
  87 # endif
  88 #endif
  89
  90 /* Options for the MD structure */
  91 #define LNET_MD_OP_PUT               (1 << 0)
  92 #define LNET_MD_OP_GET               (1 << 1)
  93 #define LNET_MD_MANAGE_REMOTE        (1 << 2)
  94 /* unused                            (1 << 3) */
  95 #define LNET_MD_TRUNCATE             (1 << 4)
  96 #define LNET_MD_ACK_DISABLE          (1 << 5)
  97 #define LNET_MD_IOVEC                (1 << 6)
  98 #define LNET_MD_MAX_SIZE             (1 << 7)
  99 #define LNET_MD_KIOV                 (1 << 8)
 100
 101 /* For compatibility with Cray Portals */
 102 #define LNET_MD_PHYS                         0
 103
 104 #define LNET_MD_THRESH_INF       (-1)
 105
 106 /* NB lustre portals uses struct iovec internally! */
 107 typedef struct iovec lnet_md_iovec_t;
 108
 109 typedef struct {
 110         cfs_page_t      *kiov_page;
 111         unsigned int     kiov_len;
 112         unsigned int     kiov_offset;
 113 } lnet_kiov_t;
 114
 115 typedef enum {
 116         LNET_EVENT_GET,
 117         LNET_EVENT_PUT,
 118         LNET_EVENT_REPLY,
 119         LNET_EVENT_ACK,
 120         LNET_EVENT_SEND,
 121         LNET_EVENT_UNLINK,
 122 } lnet_event_kind_t;
 123
 124 #define LNET_SEQ_BASETYPE       long
 125 typedef unsigned LNET_SEQ_BASETYPE lnet_seq_t;
 126 #define LNET_SEQ_GT(a,b)        (((signed LNET_SEQ_BASETYPE)((a) - (b))) > 0)
 127
 128 /* XXX
 129  * cygwin need the pragma line, not clear if it's needed in other places.
 130  * checking!!!
 131  */
 132 #ifdef __CYGWIN__
 133 #pragma pack(push, 4)
 134 #endif
 135 typedef struct {
 136         lnet_process_id_t   target;
 137         lnet_process_id_t   initiator;
 138         lnet_nid_t          sender;
 139         lnet_event_kind_t   type;
 140         unsigned int        pt_index;
 141         __u64               match_bits;
 142         unsigned int        rlength;
 143         unsigned int        mlength;
 144         lnet_handle_md_t    md_handle;
 145         lnet_md_t           md;
 146         __u64               hdr_data;
 147         int                 status;
 148         int                 unlinked;
 149         unsigned int        offset;
 150 #ifdef CRAY_XT3
 151         lnet_uid_t          uid;
 152 #endif
 153
 154         volatile lnet_seq_t sequence;
 155 } lnet_event_t;
 156 #ifdef __CYGWIN__
 157 #pragma pop
 158 #endif
 159
 160 typedef enum {
 161         LNET_ACK_REQ,
 162         LNET_NOACK_REQ
 163 } lnet_ack_req_t;
 164
 165 typedef void (*lnet_eq_handler_t)(lnet_event_t *event);
 166 #define LNET_EQ_HANDLER_NONE NULL
 167
 168 #endif