Whamcloud - gitweb
* Landed b_cray_portals_merge (3148, 3158)
[fs/lustre-release.git] / lnet / include / lnet / types.h
1 #ifndef _P30_TYPES_H_
2 #define _P30_TYPES_H_
3
4 #include "build_check.h"
5
6 #include <linux/libcfs.h>
7 #include <portals/errno.h>
8
9 /* This implementation uses the same type for API function return codes and
10  * the completion status in an event  */
11 #define PTL_NI_OK  PTL_OK
12 typedef ptl_err_t ptl_ni_fail_t;
13
14 typedef __u64 ptl_nid_t;
15 typedef __u32 ptl_pid_t;
16 typedef __u32 ptl_pt_index_t;
17 typedef __u32 ptl_ac_index_t;
18 typedef __u64 ptl_match_bits_t;
19 typedef __u64 ptl_hdr_data_t;
20 typedef __u32 ptl_size_t;
21
22 #define PTL_TIME_FOREVER    (-1)
23
24 typedef struct {
25         unsigned long nal_idx;                  /* which network interface */
26         __u64         cookie;                   /* which thing on that interface */
27 } ptl_handle_any_t;
28
29 typedef ptl_handle_any_t ptl_handle_ni_t;
30 typedef ptl_handle_any_t ptl_handle_eq_t;
31 typedef ptl_handle_any_t ptl_handle_md_t;
32 typedef ptl_handle_any_t ptl_handle_me_t;
33
34 #define PTL_INVALID_HANDLE \
35     ((const ptl_handle_any_t){.nal_idx = -1, .cookie = -1})
36 #define PTL_EQ_NONE PTL_INVALID_HANDLE
37
38 static inline int PtlHandleIsEqual (ptl_handle_any_t h1, ptl_handle_any_t h2)
39 {
40         return (h1.nal_idx == h2.nal_idx && h1.cookie == h2.cookie);
41 }
42
43 #define PTL_NID_ANY      ((ptl_nid_t) -1)
44 #define PTL_PID_ANY      ((ptl_pid_t) -1)
45
46 typedef struct {
47         ptl_nid_t nid;
48         ptl_pid_t pid;   /* node id / process id */
49 } ptl_process_id_t;
50
51 typedef enum {
52         PTL_RETAIN = 0,
53         PTL_UNLINK
54 } ptl_unlink_t;
55
56 typedef enum {
57         PTL_INS_BEFORE,
58         PTL_INS_AFTER
59 } ptl_ins_pos_t;
60
61 typedef struct {
62         void            *start;
63         ptl_size_t       length;
64         int              threshold;
65         int              max_size;
66         unsigned int     options;
67         void            *user_ptr;
68         ptl_handle_eq_t  eventq;
69 } ptl_md_t;
70
71 /* Options for the MD structure */
72 #define PTL_MD_OP_PUT               (1 << 0)
73 #define PTL_MD_OP_GET               (1 << 1)
74 #define PTL_MD_MANAGE_REMOTE        (1 << 2)
75 /* unused                           (1 << 3) */
76 #define PTL_MD_TRUNCATE             (1 << 4)
77 #define PTL_MD_ACK_DISABLE          (1 << 5)
78 #define PTL_MD_IOVEC                (1 << 6)
79 #define PTL_MD_MAX_SIZE             (1 << 7)
80 #define PTL_MD_KIOV                 (1 << 8)
81 #define PTL_MD_EVENT_START_DISABLE  (1 << 9)
82 #define PTL_MD_EVENT_END_DISABLE    (1 << 10)
83
84 /* For compatibility with Cray Portals */
85 #define PTL_MD_LUSTRE_COMPLETION_SEMANTICS  0
86 #define PTL_MD_PHYS                         0
87
88 #define PTL_MD_THRESH_INF       (-1)
89
90 /* NB lustre portals uses struct iovec internally! */
91 typedef struct iovec ptl_md_iovec_t;
92
93 typedef struct {
94         struct page     *kiov_page;
95         unsigned int     kiov_len;
96         unsigned int     kiov_offset;
97 } ptl_kiov_t;
98
99 typedef enum {
100         PTL_EVENT_GET_START,
101         PTL_EVENT_GET_END,
102
103         PTL_EVENT_PUT_START,
104         PTL_EVENT_PUT_END,
105
106         PTL_EVENT_REPLY_START,
107         PTL_EVENT_REPLY_END,
108
109         PTL_EVENT_ACK,
110
111         PTL_EVENT_SEND_START,
112         PTL_EVENT_SEND_END,
113
114         PTL_EVENT_UNLINK,
115 } ptl_event_kind_t;
116
117 #define PTL_SEQ_BASETYPE        long
118 typedef unsigned PTL_SEQ_BASETYPE ptl_seq_t;
119 #define PTL_SEQ_GT(a,b) (((signed PTL_SEQ_BASETYPE)((a) - (b))) > 0)
120
121 /* XXX
122  * cygwin need the pragma line, not clear if it's needed in other places.
123  * checking!!!
124  */
125 #ifdef __CYGWIN__
126 #pragma pack(push, 4)
127 #endif
128 typedef struct {
129         ptl_event_kind_t   type;
130         ptl_process_id_t   initiator;
131         ptl_pt_index_t     portal;
132         ptl_match_bits_t   match_bits;
133         ptl_size_t         rlength;
134         ptl_size_t         mlength;
135         ptl_size_t         offset;
136         ptl_md_t           mem_desc;
137         ptl_hdr_data_t     hdr_data;
138         int                unlinked;
139         ptl_ni_fail_t      ni_fail_type;
140
141         volatile ptl_seq_t sequence;
142 } ptl_event_t;
143 #ifdef __CYGWIN__
144 #pragma pop
145 #endif
146
147 typedef enum {
148         PTL_ACK_REQ,
149         PTL_NOACK_REQ
150 } ptl_ack_req_t;
151
152 typedef void (*ptl_eq_handler_t)(ptl_event_t *event);
153 #define PTL_EQ_HANDLER_NONE NULL
154
155 typedef struct {
156         volatile ptl_seq_t sequence;
157         ptl_size_t size;
158         ptl_event_t *base;
159         ptl_handle_any_t cb_eq_handle;
160 } ptl_eq_t;
161
162 typedef struct {
163         ptl_eq_t *eq;
164 } ptl_ni_t;
165
166 typedef struct {
167         int max_mes;
168         int max_mds;
169         int max_eqs;
170         int max_ac_index;
171         int max_pt_index;
172         int max_md_iovecs;
173         int max_me_list;
174         int max_getput_md;
175 } ptl_ni_limits_t;
176
177 /*
178  * Status registers
179  */
180 typedef enum {
181         PTL_SR_DROP_COUNT,
182         PTL_SR_DROP_LENGTH,
183         PTL_SR_RECV_COUNT,
184         PTL_SR_RECV_LENGTH,
185         PTL_SR_SEND_COUNT,
186         PTL_SR_SEND_LENGTH,
187         PTL_SR_MSGS_MAX,
188 } ptl_sr_index_t;
189
190 typedef int ptl_sr_value_t;
191
192 typedef int ptl_interface_t;
193 #define PTL_IFACE_DEFAULT    (-1)
194
195 #endif