Debian Codegraph @

dat/include/dat2/udat_redirection.h

raw
1 /*
2 * Copyright (c) 2002-2006, Network Appliance, Inc. All rights reserved.
3 *
4 * This Software is licensed under all of the following licenses:
5 *
6 * 1) under the terms of the "Common Public License 1.0" a copy of which is
7 * in the file LICENSE.txt in the root directory. The license is also
8 * available from the Open Source Initiative, see
9 * http://www.opensource.org/licenses/cpl.php.
10 *
11 * 2) under the terms of the "The BSD License" a copy of which is in the file
12 * LICENSE2.txt in the root directory. The license is also available from
13 * the Open Source Initiative, see
14 * http://www.opensource.org/licenses/bsd-license.php.
15 *
16 * 3) under the terms of the "GNU General Public License (GPL) Version 2" a
17 * copy of which is in the file LICENSE3.txt in the root directory. The
18 * license is also available from the Open Source Initiative, see
19 * http://www.opensource.org/licenses/gpl-license.php.
20 *
21 * Licensee has the right to choose one of the above licenses.
22 *
23 * Redistribution and use in source and binary forms, with or without
24 * modification, are permitted provided that the following conditions are
25 * met:
26 *
27 * Redistributions of source code must retain both the above copyright
28 * notice and one of the license notices.
29 *
30 * Redistributions in binary form must reproduce both the above copyright
31 * notice, one of the license notices in the documentation
32 * and/or other materials provided with the distribution.
33 *
34 * Neither the name of Network Appliance, Inc. nor the names of other DAT
35 * Collaborative contributors may be used to endorse or promote
36 * products derived from this software without specific prior written
37 * permission.
38 */
39
40 /****************************************************************
41 *
42 * HEADER: udat_redirection.h
43 *
44 * PURPOSE: User DAT macro definitions
45 *
46 * Description: Macros to invoke DAPL functions from the dat_registry
47 *
48 * Mapping rules:
49 * All global symbols are prepended with DAT_ or dat_
50 * All DAT objects have an 'api' tag which, such as 'ep' or 'lmr'
51 * The method table is in the provider definition structure.
52 *
53 **********************************************************/
54 #ifndef _UDAT_REDIRECTION_H_
55 #define _UDAT_REDIRECTION_H_
56
57
58 #define DAT_LMR_CREATE(ia, mem_type, reg_desc, len, pz, priv, va_type, \
59 lmr, lmr_context, rmr_context, reg_len, reg_addr) \
60 (*DAT_HANDLE_TO_PROVIDER(ia)->lmr_create_func)(\
61 (ia), \
62 (mem_type), \
63 (reg_desc), \
64 (len), \
65 (pz), \
66 (priv), \
67 (va_type), \
68 (lmr), \
69 (lmr_context), \
70 (rmr_context), \
71 (reg_len), \
72 (reg_addr))
73
74 #define DAT_EVD_CREATE(ia, qlen, cno, flags, handle) \
75 (*DAT_HANDLE_TO_PROVIDER(ia)->evd_create_func)(\
76 (ia), \
77 (qlen), \
78 (cno), \
79 (flags), \
80 (handle))
81
82 #define DAT_EVD_ENABLE(evd) \
83 (*DAT_HANDLE_TO_PROVIDER(evd)->evd_enable_func)(\
84 (evd))
85
86 #define DAT_EVD_WAIT(evd, timeout, threshold, event, nmore) \
87 (*DAT_HANDLE_TO_PROVIDER(evd)->evd_wait_func)(\
88 (evd), \
89 (timeout), \
90 (threshold), \
91 (event), \
92 (nmore))
93
94 #define DAT_EVD_DISABLE(evd) \
95 (*DAT_HANDLE_TO_PROVIDER(evd)->evd_disable_func)(\
96 (evd))
97
98 #define DAT_EVD_SET_UNWAITABLE(evd) \
99 (*DAT_HANDLE_TO_PROVIDER(evd)->evd_set_unwaitable_func)(\
100 (evd))
101
102 #define DAT_EVD_CLEAR_UNWAITABLE(evd) \
103 (*DAT_HANDLE_TO_PROVIDER(evd)->evd_clear_unwaitable_func)(\
104 (evd))
105
106 #define DAT_EVD_MODIFY_CNO(evd, cno) \
107 (*DAT_HANDLE_TO_PROVIDER(evd)->evd_modify_cno_func)(\
108 (evd), \
109 (cno))
110
111 #define DAT_CNO_CREATE(ia, proxy, cno) \
112 (*DAT_HANDLE_TO_PROVIDER(ia)->cno_create_func)(\
113 (ia), \
114 (proxy), \
115 (cno))
116
117 #define DAT_CNO_FD_CREATE(ia, fd, cno) \
118 (*DAT_HANDLE_TO_PROVIDER(ia)->cno_fd_create_func)(\
119 (ia), \
120 (fd), \
121 (cno))
122
123 #define DAT_CNO_TRIGGER(cno, evd) \
124 (*DAT_HANDLE_TO_PROVIDER(cno)->cno_trigger_func)(\
125 (cno), \
126 (evd))
127
128
129 #define DAT_CNO_MODIFY_AGENT(cno, proxy) \
130 (*DAT_HANDLE_TO_PROVIDER(cno)->cno_modify_agent_func)(\
131 (cno), \
132 (proxy))
133
134 #define DAT_CNO_QUERY(cno, mask, param) \
135 (*DAT_HANDLE_TO_PROVIDER(cno)->cno_query_func)(\
136 (cno), \
137 (mask), \
138 (param))
139
140 #define DAT_CNO_FREE(cno) \
141 (*DAT_HANDLE_TO_PROVIDER(cno)->cno_free_func)(\
142 (cno))
143
144 #define DAT_CNO_WAIT(cno,timeout,evd) \
145 (*DAT_HANDLE_TO_PROVIDER(cno)->cno_wait_func)(\
146 (cno), \
147 (timeout), \
148 (evd))
149
150 /***************************************************************
151 * FUNCTION PROTOTYPES
152 *
153 * User DAT function call definitions,
154 *
155 ****************************************************************/
156
157 typedef DAT_RETURN (DAT_API *DAT_LMR_CREATE_FUNC) (
158 IN DAT_IA_HANDLE, /* ia_handle */
159 IN DAT_MEM_TYPE, /* mem_type */
160 IN DAT_REGION_DESCRIPTION, /* region_description */
161 IN DAT_VLEN, /* length */
162 IN DAT_PZ_HANDLE, /* pz_handle */
163 IN DAT_MEM_PRIV_FLAGS, /* privileges */
164 IN DAT_VA_TYPE, /* va_type */
165 OUT DAT_LMR_HANDLE *, /* lmr_handle */
166 OUT DAT_LMR_CONTEXT *, /* lmr_context */
167 OUT DAT_RMR_CONTEXT *, /* rmr_context */
168 OUT DAT_VLEN *, /* registered_length */
169 OUT DAT_VADDR * ); /* registered_address */
170
171 typedef DAT_RETURN (DAT_API *DAT_LMR_QUERY_FUNC) (
172 IN DAT_LMR_HANDLE, /* lmr_handle */
173 IN DAT_LMR_PARAM_MASK, /* lmr_param_mask */
174 OUT DAT_LMR_PARAM *); /* lmr_param */
175
176 /* Event functions */
177
178 typedef DAT_RETURN (DAT_API *DAT_EVD_CREATE_FUNC) (
179 IN DAT_IA_HANDLE, /* ia_handle */
180 IN DAT_COUNT, /* evd_min_qlen */
181 IN DAT_CNO_HANDLE, /* cno_handle */
182 IN DAT_EVD_FLAGS, /* evd_flags */
183 OUT DAT_EVD_HANDLE * ); /* evd_handle */
184
185 typedef DAT_RETURN (DAT_API *DAT_EVD_MODIFY_CNO_FUNC) (
186 IN DAT_EVD_HANDLE, /* evd_handle */
187 IN DAT_CNO_HANDLE); /* cno_handle */
188
189 typedef DAT_RETURN (DAT_API *DAT_CNO_CREATE_FUNC) (
190 IN DAT_IA_HANDLE, /* ia_handle */
191 IN DAT_OS_WAIT_PROXY_AGENT,/* agent */
192 OUT DAT_CNO_HANDLE *); /* cno_handle */
193
194 typedef DAT_RETURN (DAT_API *DAT_CNO_FD_CREATE_FUNC) (
195 IN DAT_IA_HANDLE, /* ia_handle */
196 OUT DAT_FD *, /* file_descriptor */
197 OUT DAT_CNO_HANDLE *); /* cno_handle */
198
199 typedef DAT_RETURN (DAT_API *DAT_CNO_TRIGGER_FUNC) (
200 IN DAT_CNO_HANDLE, /* cno_handle */
201 OUT DAT_EVD_HANDLE *); /* trigger */
202
203 typedef DAT_RETURN (DAT_API *DAT_CNO_MODIFY_AGENT_FUNC) (
204 IN DAT_CNO_HANDLE, /* cno_handle */
205 IN DAT_OS_WAIT_PROXY_AGENT);/* agent */
206
207 typedef DAT_RETURN (DAT_API *DAT_CNO_QUERY_FUNC) (
208 IN DAT_CNO_HANDLE, /* cno_handle */
209 IN DAT_CNO_PARAM_MASK, /* cno_param_mask */
210 OUT DAT_CNO_PARAM * ); /* cno_param */
211
212 typedef DAT_RETURN (DAT_API *DAT_CNO_FREE_FUNC) (
213 IN DAT_CNO_HANDLE); /* cno_handle */
214
215 typedef DAT_RETURN (DAT_API *DAT_CNO_WAIT_FUNC) (
216 IN DAT_CNO_HANDLE, /* cno_handle */
217 IN DAT_TIMEOUT, /* timeout */
218 OUT DAT_EVD_HANDLE *); /* evd_handle */
219
220 typedef DAT_RETURN (DAT_API *DAT_EVD_ENABLE_FUNC) (
221 IN DAT_EVD_HANDLE); /* evd_handle */
222
223 typedef DAT_RETURN (DAT_API *DAT_EVD_WAIT_FUNC) (
224 IN DAT_EVD_HANDLE, /* evd_handle */
225 IN DAT_TIMEOUT, /* Timeout */
226 IN DAT_COUNT, /* Threshold */
227 OUT DAT_EVENT *, /* event */
228 OUT DAT_COUNT * ); /* N more events */
229
230 typedef DAT_RETURN (DAT_API *DAT_EVD_DISABLE_FUNC) (
231 IN DAT_EVD_HANDLE); /* evd_handle */
232
233 typedef DAT_RETURN (DAT_API *DAT_EVD_SET_UNWAITABLE_FUNC) (
234 IN DAT_EVD_HANDLE); /* evd_handle */
235
236 typedef DAT_RETURN (DAT_API *DAT_EVD_CLEAR_UNWAITABLE_FUNC) (
237 IN DAT_EVD_HANDLE); /* evd_handle */
238
239
240 #include <dat2/dat_redirection.h>
241
242 struct dat_provider
243 {
244 const char * device_name;
245 DAT_PVOID extension;
246
247 DAT_IA_OPEN_FUNC ia_open_func;
248 DAT_IA_QUERY_FUNC ia_query_func;
249 DAT_IA_CLOSE_FUNC ia_close_func;
250
251 DAT_SET_CONSUMER_CONTEXT_FUNC set_consumer_context_func;
252 DAT_GET_CONSUMER_CONTEXT_FUNC get_consumer_context_func;
253 DAT_GET_HANDLE_TYPE_FUNC get_handle_type_func;
254
255 DAT_CNO_CREATE_FUNC cno_create_func; /* udat only */
256 DAT_CNO_MODIFY_AGENT_FUNC cno_modify_agent_func; /* udat only */
257 DAT_CNO_QUERY_FUNC cno_query_func; /* udat only */
258 DAT_CNO_FREE_FUNC cno_free_func; /* udat only */
259 DAT_CNO_WAIT_FUNC cno_wait_func; /* udat only */
260
261 DAT_CR_QUERY_FUNC cr_query_func;
262 DAT_CR_ACCEPT_FUNC cr_accept_func;
263 DAT_CR_REJECT_FUNC cr_reject_func;
264 DAT_CR_HANDOFF_FUNC cr_handoff_func;
265
266 DAT_EVD_CREATE_FUNC evd_create_func;
267 DAT_EVD_QUERY_FUNC evd_query_func;
268
269 DAT_EVD_MODIFY_CNO_FUNC evd_modify_cno_func; /* udat only */
270 DAT_EVD_ENABLE_FUNC evd_enable_func; /* udat only */
271 DAT_EVD_DISABLE_FUNC evd_disable_func; /* udat only */
272 DAT_EVD_WAIT_FUNC evd_wait_func; /* udat only */
273
274 DAT_EVD_RESIZE_FUNC evd_resize_func;
275 DAT_EVD_POST_SE_FUNC evd_post_se_func;
276 DAT_EVD_DEQUEUE_FUNC evd_dequeue_func;
277 DAT_EVD_FREE_FUNC evd_free_func;
278
279 DAT_EP_CREATE_FUNC ep_create_func;
280 DAT_EP_QUERY_FUNC ep_query_func;
281 DAT_EP_MODIFY_FUNC ep_modify_func;
282 DAT_EP_CONNECT_FUNC ep_connect_func;
283 DAT_EP_DUP_CONNECT_FUNC ep_dup_connect_func;
284 DAT_EP_DISCONNECT_FUNC ep_disconnect_func;
285 DAT_EP_POST_SEND_FUNC ep_post_send_func;
286 DAT_EP_POST_RECV_FUNC ep_post_recv_func;
287 DAT_EP_POST_RDMA_READ_FUNC ep_post_rdma_read_func;
288 DAT_EP_POST_RDMA_WRITE_FUNC ep_post_rdma_write_func;
289 DAT_EP_GET_STATUS_FUNC ep_get_status_func;
290 DAT_EP_FREE_FUNC ep_free_func;
291
292 DAT_LMR_CREATE_FUNC lmr_create_func;
293 DAT_LMR_QUERY_FUNC lmr_query_func;
294
295 DAT_LMR_FREE_FUNC lmr_free_func;
296
297 DAT_RMR_CREATE_FUNC rmr_create_func;
298 DAT_RMR_QUERY_FUNC rmr_query_func;
299 DAT_RMR_BIND_FUNC rmr_bind_func;
300 DAT_RMR_FREE_FUNC rmr_free_func;
301
302 DAT_PSP_CREATE_FUNC psp_create_func;
303 DAT_PSP_QUERY_FUNC psp_query_func;
304 DAT_PSP_FREE_FUNC psp_free_func;
305
306 DAT_RSP_CREATE_FUNC rsp_create_func;
307 DAT_RSP_QUERY_FUNC rsp_query_func;
308 DAT_RSP_FREE_FUNC rsp_free_func;
309
310 DAT_PZ_CREATE_FUNC pz_create_func;
311 DAT_PZ_QUERY_FUNC pz_query_func;
312 DAT_PZ_FREE_FUNC pz_free_func;
313
314 /* dat-1.1 */
315 DAT_PSP_CREATE_ANY_FUNC psp_create_any_func; /* dat-1.1 */
316 DAT_EP_RESET_FUNC ep_reset_func; /* dat-1.1 */
317
318 /* udat-1.1 */
319 DAT_EVD_SET_UNWAITABLE_FUNC evd_set_unwaitable_func; /* udat-1.1 */
320 DAT_EVD_CLEAR_UNWAITABLE_FUNC evd_clear_unwaitable_func; /* udat-1.1 */
321 /* dat-1.2 */
322 DAT_LMR_SYNC_RDMA_READ_FUNC lmr_sync_rdma_read_func;
323 DAT_LMR_SYNC_RDMA_WRITE_FUNC lmr_sync_rdma_write_func;
324
325 DAT_EP_CREATE_WITH_SRQ_FUNC ep_create_with_srq_func;
326 DAT_EP_RECV_QUERY_FUNC ep_recv_query_func;
327 DAT_EP_SET_WATERMARK_FUNC ep_set_watermark_func;
328 DAT_SRQ_CREATE_FUNC srq_create_func;
329 DAT_SRQ_FREE_FUNC srq_free_func;
330 DAT_SRQ_POST_RECV_FUNC srq_post_recv_func;
331 DAT_SRQ_QUERY_FUNC srq_query_func;
332 DAT_SRQ_RESIZE_FUNC srq_resize_func;
333 DAT_SRQ_SET_LW_FUNC srq_set_lw_func;
334
335 /* DAT 2.0 functions */
336 DAT_CSP_CREATE_FUNC csp_create_func;
337 DAT_CSP_QUERY_FUNC csp_query_func;
338 DAT_CSP_FREE_FUNC csp_free_func;
339
340 DAT_EP_COMMON_CONNECT_FUNC ep_common_connect_func;
341
342 DAT_RMR_CREATE_FOR_EP_FUNC rmr_create_for_ep_func;
343 DAT_EP_POST_SEND_WITH_INVALIDATE_FUNC ep_post_send_with_invalidate_func;
344 DAT_EP_POST_RDMA_READ_TO_RMR_FUNC ep_post_rdma_read_to_rmr_func;
345
346 DAT_CNO_FD_CREATE_FUNC cno_fd_create_func;
347 DAT_CNO_TRIGGER_FUNC cno_trigger_func;
348
349 DAT_IA_HA_RELATED_FUNC ia_ha_related_func;
350
351 #ifdef DAT_EXTENSIONS
352 DAT_HANDLE_EXTENDEDOP_FUNC handle_extendedop_func;
353 #endif /* DAT_EXTENSIONS */
354 };
355
356 #endif /* _UDAT_REDIRECTION_H_ */