source: mainline/uspace/lib/c/include/async.h@ a676574

lfn serial ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export
Last change on this file since a676574 was c1c0184, checked in by Jiri Svoboda <jiri@…>, 15 years ago

Make session management explicit.

  • Property mode set to 100644
File size: 16.8 KB
Line 
1/*
2 * Copyright (c) 2006 Ondrej Palkovsky
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 *
9 * - Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * - Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 * - The name of the author may not be used to endorse or promote products
15 * derived from this software without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 */
28
29/** @addtogroup libc
30 * @{
31 */
32/** @file
33 */
34
35#ifndef LIBC_ASYNC_H_
36#define LIBC_ASYNC_H_
37
38#include <ipc/ipc.h>
39#include <async_sess.h>
40#include <fibril.h>
41#include <sys/time.h>
42#include <atomic.h>
43#include <bool.h>
44
45typedef ipc_callid_t aid_t;
46typedef void (*async_client_conn_t)(ipc_callid_t callid, ipc_call_t *call);
47
48extern atomic_t async_futex;
49
50extern atomic_t threads_in_ipc_wait;
51
52extern int __async_init(void);
53extern ipc_callid_t async_get_call_timeout(ipc_call_t *call, suseconds_t usecs);
54
55static inline ipc_callid_t async_get_call(ipc_call_t *data)
56{
57 return async_get_call_timeout(data, 0);
58}
59
60static inline void async_manager(void)
61{
62 fibril_switch(FIBRIL_TO_MANAGER);
63}
64
65/*
66 * User-friendly wrappers for async_send_fast() and async_send_slow(). The
67 * macros are in the form async_send_m(), where m denotes the number of payload
68 * arguments. Each macros chooses between the fast and the slow version based
69 * on m.
70 */
71
72#define async_send_0(phoneid, method, dataptr) \
73 async_send_fast((phoneid), (method), 0, 0, 0, 0, (dataptr))
74#define async_send_1(phoneid, method, arg1, dataptr) \
75 async_send_fast((phoneid), (method), (arg1), 0, 0, 0, (dataptr))
76#define async_send_2(phoneid, method, arg1, arg2, dataptr) \
77 async_send_fast((phoneid), (method), (arg1), (arg2), 0, 0, (dataptr))
78#define async_send_3(phoneid, method, arg1, arg2, arg3, dataptr) \
79 async_send_fast((phoneid), (method), (arg1), (arg2), (arg3), 0, (dataptr))
80#define async_send_4(phoneid, method, arg1, arg2, arg3, arg4, dataptr) \
81 async_send_fast((phoneid), (method), (arg1), (arg2), (arg3), (arg4), \
82 (dataptr))
83#define async_send_5(phoneid, method, arg1, arg2, arg3, arg4, arg5, dataptr) \
84 async_send_slow((phoneid), (method), (arg1), (arg2), (arg3), (arg4), \
85 (arg5), (dataptr))
86
87extern aid_t async_send_fast(int phoneid, sysarg_t method, sysarg_t arg1,
88 sysarg_t arg2, sysarg_t arg3, sysarg_t arg4, ipc_call_t *dataptr);
89extern aid_t async_send_slow(int phoneid, sysarg_t method, sysarg_t arg1,
90 sysarg_t arg2, sysarg_t arg3, sysarg_t arg4, sysarg_t arg5,
91 ipc_call_t *dataptr);
92extern void async_wait_for(aid_t amsgid, sysarg_t *result);
93extern int async_wait_timeout(aid_t amsgid, sysarg_t *retval,
94 suseconds_t timeout);
95
96extern fid_t async_new_connection(sysarg_t in_phone_hash, ipc_callid_t callid,
97 ipc_call_t *call, void (*cthread)(ipc_callid_t, ipc_call_t *));
98extern void async_usleep(suseconds_t timeout);
99extern void async_create_manager(void);
100extern void async_destroy_manager(void);
101
102extern void async_set_client_connection(async_client_conn_t conn);
103extern void async_set_interrupt_received(async_client_conn_t conn);
104
105/* Wrappers for simple communication */
106#define async_msg_0(phone, method) \
107 ipc_call_async_0((phone), (method), NULL, NULL, true)
108#define async_msg_1(phone, method, arg1) \
109 ipc_call_async_1((phone), (method), (arg1), NULL, NULL, \
110 true)
111#define async_msg_2(phone, method, arg1, arg2) \
112 ipc_call_async_2((phone), (method), (arg1), (arg2), NULL, NULL, \
113 true)
114#define async_msg_3(phone, method, arg1, arg2, arg3) \
115 ipc_call_async_3((phone), (method), (arg1), (arg2), (arg3), NULL, NULL, \
116 true)
117#define async_msg_4(phone, method, arg1, arg2, arg3, arg4) \
118 ipc_call_async_4((phone), (method), (arg1), (arg2), (arg3), (arg4), NULL, \
119 NULL, true)
120#define async_msg_5(phone, method, arg1, arg2, arg3, arg4, arg5) \
121 ipc_call_async_5((phone), (method), (arg1), (arg2), (arg3), (arg4), \
122 (arg5), NULL, NULL, true)
123
124/*
125 * User-friendly wrappers for async_req_fast() and async_req_slow(). The macros
126 * are in the form async_req_m_n(), where m is the number of payload arguments
127 * and n is the number of return arguments. The macros decide between the fast
128 * and slow verion based on m.
129 */
130#define async_req_0_0(phoneid, method) \
131 async_req_fast((phoneid), (method), 0, 0, 0, 0, NULL, NULL, NULL, NULL, \
132 NULL)
133#define async_req_0_1(phoneid, method, r1) \
134 async_req_fast((phoneid), (method), 0, 0, 0, 0, (r1), NULL, NULL, NULL, \
135 NULL)
136#define async_req_0_2(phoneid, method, r1, r2) \
137 async_req_fast((phoneid), (method), 0, 0, 0, 0, (r1), (r2), NULL, NULL, \
138 NULL)
139#define async_req_0_3(phoneid, method, r1, r2, r3) \
140 async_req_fast((phoneid), (method), 0, 0, 0, 0, (r1), (r2), (r3), NULL, \
141 NULL)
142#define async_req_0_4(phoneid, method, r1, r2, r3, r4) \
143 async_req_fast((phoneid), (method), 0, 0, 0, 0, (r1), (r2), (r3), (r4), \
144 NULL)
145#define async_req_0_5(phoneid, method, r1, r2, r3, r4, r5) \
146 async_req_fast((phoneid), (method), 0, 0, 0, 0, (r1), (r2), (r3), (r4), \
147 (r5))
148#define async_req_1_0(phoneid, method, arg1) \
149 async_req_fast((phoneid), (method), (arg1), 0, 0, 0, NULL, NULL, NULL, \
150 NULL, NULL)
151#define async_req_1_1(phoneid, method, arg1, rc1) \
152 async_req_fast((phoneid), (method), (arg1), 0, 0, 0, (rc1), NULL, NULL, \
153 NULL, NULL)
154#define async_req_1_2(phoneid, method, arg1, rc1, rc2) \
155 async_req_fast((phoneid), (method), (arg1), 0, 0, 0, (rc1), (rc2), NULL, \
156 NULL, NULL)
157#define async_req_1_3(phoneid, method, arg1, rc1, rc2, rc3) \
158 async_req_fast((phoneid), (method), (arg1), 0, 0, 0, (rc1), (rc2), (rc3), \
159 NULL, NULL)
160#define async_req_1_4(phoneid, method, arg1, rc1, rc2, rc3, rc4) \
161 async_req_fast((phoneid), (method), (arg1), 0, 0, 0, (rc1), (rc2), (rc3), \
162 (rc4), NULL)
163#define async_req_1_5(phoneid, method, arg1, rc1, rc2, rc3, rc4, rc5) \
164 async_req_fast((phoneid), (method), (arg1), 0, 0, 0, (rc1), (rc2), (rc3), \
165 (rc4), (rc5))
166#define async_req_2_0(phoneid, method, arg1, arg2) \
167 async_req_fast((phoneid), (method), (arg1), (arg2), 0, 0, NULL, NULL, \
168 NULL, NULL, NULL)
169#define async_req_2_1(phoneid, method, arg1, arg2, rc1) \
170 async_req_fast((phoneid), (method), (arg1), (arg2), 0, 0, (rc1), NULL, \
171 NULL, NULL, NULL)
172#define async_req_2_2(phoneid, method, arg1, arg2, rc1, rc2) \
173 async_req_fast((phoneid), (method), (arg1), (arg2), 0, 0, (rc1), (rc2), \
174 NULL, NULL, NULL)
175#define async_req_2_3(phoneid, method, arg1, arg2, rc1, rc2, rc3) \
176 async_req_fast((phoneid), (method), (arg1), (arg2), 0, 0, (rc1), (rc2), \
177 (rc3), NULL, NULL)
178#define async_req_2_4(phoneid, method, arg1, arg2, rc1, rc2, rc3, rc4) \
179 async_req_fast((phoneid), (method), (arg1), (arg2), 0, 0, (rc1), (rc2), \
180 (rc3), (rc4), NULL)
181#define async_req_2_5(phoneid, method, arg1, arg2, rc1, rc2, rc3, rc4, rc5) \
182 async_req_fast((phoneid), (method), (arg1), (arg2), 0, 0, (rc1), (rc2), \
183 (rc3), (rc4), (rc5))
184#define async_req_3_0(phoneid, method, arg1, arg2, arg3) \
185 async_req_fast((phoneid), (method), (arg1), (arg2), (arg3), 0, NULL, NULL, \
186 NULL, NULL, NULL)
187#define async_req_3_1(phoneid, method, arg1, arg2, arg3, rc1) \
188 async_req_fast((phoneid), (method), (arg1), (arg2), (arg3), 0, (rc1), \
189 NULL, NULL, NULL, NULL)
190#define async_req_3_2(phoneid, method, arg1, arg2, arg3, rc1, rc2) \
191 async_req_fast((phoneid), (method), (arg1), (arg2), (arg3), 0, (rc1), \
192 (rc2), NULL, NULL, NULL)
193#define async_req_3_3(phoneid, method, arg1, arg2, arg3, rc1, rc2, rc3) \
194 async_req_fast((phoneid), (method), (arg1), (arg2), (arg3), 0, (rc1), \
195 (rc2), (rc3), NULL, NULL)
196#define async_req_3_4(phoneid, method, arg1, arg2, arg3, rc1, rc2, rc3, rc4) \
197 async_req_fast((phoneid), (method), (arg1), (arg2), (arg3), 0, (rc1), \
198 (rc2), (rc3), (rc4), NULL)
199#define async_req_3_5(phoneid, method, arg1, arg2, arg3, rc1, rc2, rc3, rc4, \
200 rc5) \
201 async_req_fast((phoneid), (method), (arg1), (arg2), (arg3), 0, (rc1), \
202 (rc2), (rc3), (rc4), (rc5))
203#define async_req_4_0(phoneid, method, arg1, arg2, arg3, arg4) \
204 async_req_fast((phoneid), (method), (arg1), (arg2), (arg3), (arg4), NULL, \
205 NULL, NULL, NULL, NULL)
206#define async_req_4_1(phoneid, method, arg1, arg2, arg3, arg4, rc1) \
207 async_req_fast((phoneid), (method), (arg1), (arg2), (arg3), (arg4), (rc1), \
208 NULL, NULL, NULL, NULL)
209#define async_req_4_2(phoneid, method, arg1, arg2, arg3, arg4, rc1, rc2) \
210 async_req_fast((phoneid), (method), (arg1), (arg2), (arg3), (arg4), (rc1), \
211 (rc2), NULL, NULL, NULL)
212#define async_req_4_3(phoneid, method, arg1, arg2, arg3, arg4, rc1, rc2, rc3) \
213 async_req_fast((phoneid), (method), (arg1), (arg2), (arg3), (arg4), (rc1), \
214 (rc2), (rc3), NULL, NULL)
215#define async_req_4_4(phoneid, method, arg1, arg2, arg3, arg4, rc1, rc2, rc3, \
216 rc4) \
217 async_req_fast((phoneid), (method), (arg1), (arg2), (arg3), (arg4), \
218 (rc1), (rc2), (rc3), (rc4), NULL)
219#define async_req_4_5(phoneid, method, arg1, arg2, arg3, arg4, rc1, rc2, rc3, \
220 rc4, rc5) \
221 async_req_fast((phoneid), (method), (arg1), (arg2), (arg3), (arg4), \
222 (rc1), (rc2), (rc3), (rc4), (rc5))
223#define async_req_5_0(phoneid, method, arg1, arg2, arg3, arg4, arg5) \
224 async_req_slow((phoneid), (method), (arg1), (arg2), (arg3), (arg4), \
225 (arg5), NULL, NULL, NULL, NULL, NULL)
226#define async_req_5_1(phoneid, method, arg1, arg2, arg3, arg4, arg5, rc1) \
227 async_req_slow((phoneid), (method), (arg1), (arg2), (arg3), (arg4), \
228 (arg5), (rc1), NULL, NULL, NULL, NULL)
229#define async_req_5_2(phoneid, method, arg1, arg2, arg3, arg4, arg5, rc1, rc2) \
230 async_req_slow((phoneid), (method), (arg1), (arg2), (arg3), (arg4), \
231 (arg5), (rc1), (rc2), NULL, NULL, NULL)
232#define async_req_5_3(phoneid, method, arg1, arg2, arg3, arg4, arg5, rc1, rc2, \
233 rc3) \
234 async_req_slow((phoneid), (method), (arg1), (arg2), (arg3), (arg4), \
235 (arg5), (rc1), (rc2), (rc3), NULL, NULL)
236#define async_req_5_4(phoneid, method, arg1, arg2, arg3, arg4, arg5, rc1, rc2, \
237 rc3, rc4) \
238 async_req_slow((phoneid), (method), (arg1), (arg2), (arg3), (arg4), \
239 (arg5), (rc1), (rc2), (rc3), (rc4), NULL)
240#define async_req_5_5(phoneid, method, arg1, arg2, arg3, arg4, arg5, rc1, rc2, \
241 rc3, rc4, rc5) \
242 async_req_slow((phoneid), (method), (arg1), (arg2), (arg3), (arg4), \
243 (arg5), (rc1), (rc2), (rc3), (rc4), (rc5))
244
245extern sysarg_t async_req_fast(int phoneid, sysarg_t method, sysarg_t arg1,
246 sysarg_t arg2, sysarg_t arg3, sysarg_t arg4, sysarg_t *r1, sysarg_t *r2,
247 sysarg_t *r3, sysarg_t *r4, sysarg_t *r5);
248extern sysarg_t async_req_slow(int phoneid, sysarg_t method, sysarg_t arg1,
249 sysarg_t arg2, sysarg_t arg3, sysarg_t arg4, sysarg_t arg5, sysarg_t *r1,
250 sysarg_t *r2, sysarg_t *r3, sysarg_t *r4, sysarg_t *r5);
251
252static inline void async_serialize_start(void)
253{
254 fibril_inc_sercount();
255}
256
257static inline void async_serialize_end(void)
258{
259 fibril_dec_sercount();
260}
261
262extern int async_connect_me_to(int, sysarg_t, sysarg_t, sysarg_t);
263extern int async_connect_me_to_blocking(int, sysarg_t, sysarg_t, sysarg_t);
264
265/*
266 * User-friendly wrappers for async_share_in_start().
267 */
268#define async_share_in_start_0_0(phoneid, dst, size) \
269 async_share_in_start((phoneid), (dst), (size), 0, NULL)
270#define async_share_in_start_0_1(phoneid, dst, size, flags) \
271 async_share_in_start((phoneid), (dst), (size), 0, (flags))
272#define async_share_in_start_1_0(phoneid, dst, size, arg) \
273 async_share_in_start((phoneid), (dst), (size), (arg), NULL)
274#define async_share_in_start_1_1(phoneid, dst, size, arg, flags) \
275 async_share_in_start((phoneid), (dst), (size), (arg), (flags))
276
277extern int async_share_in_start(int, void *, size_t, sysarg_t, int *);
278extern int async_share_in_receive(ipc_callid_t *, size_t *);
279extern int async_share_in_finalize(ipc_callid_t, void *, int );
280extern int async_share_out_start(int, void *, int);
281extern int async_share_out_receive(ipc_callid_t *, size_t *, int *);
282extern int async_share_out_finalize(ipc_callid_t, void *);
283
284/*
285 * User-friendly wrappers for async_data_read_forward_fast().
286 */
287#define async_data_read_forward_0_0(phoneid, method, answer) \
288 async_data_read_forward_fast((phoneid), (method), 0, 0, 0, 0, NULL)
289#define async_data_read_forward_0_1(phoneid, method, answer) \
290 async_data_read_forward_fast((phoneid), (method), 0, 0, 0, 0, (answer))
291#define async_data_read_forward_1_0(phoneid, method, arg1, answer) \
292 async_data_read_forward_fast((phoneid), (method), (arg1), 0, 0, 0, NULL)
293#define async_data_read_forward_1_1(phoneid, method, arg1, answer) \
294 async_data_read_forward_fast((phoneid), (method), (arg1), 0, 0, 0, (answer))
295#define async_data_read_forward_2_0(phoneid, method, arg1, arg2, answer) \
296 async_data_read_forward_fast((phoneid), (method), (arg1), (arg2), 0, 0, NULL)
297#define async_data_read_forward_2_1(phoneid, method, arg1, arg2, answer) \
298 async_data_read_forward_fast((phoneid), (method), (arg1), (arg2), 0, 0, \
299 (answer))
300#define async_data_read_forward_3_0(phoneid, method, arg1, arg2, arg3, answer) \
301 async_data_read_forward_fast((phoneid), (method), (arg1), (arg2), (arg3), 0, \
302 NULL)
303#define async_data_read_forward_3_1(phoneid, method, arg1, arg2, arg3, answer) \
304 async_data_read_forward_fast((phoneid), (method), (arg1), (arg2), (arg3), 0, \
305 (answer))
306#define async_data_read_forward_4_0(phoneid, method, arg1, arg2, arg3, arg4, answer) \
307 async_data_read_forward_fast((phoneid), (method), (arg1), (arg2), (arg3), \
308 (arg4), NULL)
309#define async_data_read_forward_4_1(phoneid, method, arg1, arg2, arg3, arg4, answer) \
310 async_data_read_forward_fast((phoneid), (method), (arg1), (arg2), (arg3), \
311 (arg4), (answer))
312
313extern int async_data_read_start(int, void *, size_t);
314extern int async_data_read_receive(ipc_callid_t *, size_t *);
315extern int async_data_read_finalize(ipc_callid_t, const void *, size_t);
316
317extern int async_data_read_forward_fast(int, sysarg_t, sysarg_t, sysarg_t,
318 sysarg_t, sysarg_t, ipc_call_t *);
319
320/*
321 * User-friendly wrappers for async_data_write_forward_fast().
322 */
323#define async_data_write_forward_0_0(phoneid, method, answer) \
324 async_data_write_forward_fast((phoneid), (method), 0, 0, 0, 0, NULL)
325#define async_data_write_forward_0_1(phoneid, method, answer) \
326 async_data_write_forward_fast((phoneid), (method), 0, 0, 0, 0, (answer))
327#define async_data_write_forward_1_0(phoneid, method, arg1, answer) \
328 async_data_write_forward_fast((phoneid), (method), (arg1), 0, 0, 0, NULL)
329#define async_data_write_forward_1_1(phoneid, method, arg1, answer) \
330 async_data_write_forward_fast((phoneid), (method), (arg1), 0, 0, 0, \
331 (answer))
332#define async_data_write_forward_2_0(phoneid, method, arg1, arg2, answer) \
333 async_data_write_forward_fast((phoneid), (method), (arg1), (arg2), 0, 0, \
334 NULL)
335#define async_data_write_forward_2_1(phoneid, method, arg1, arg2, answer) \
336 async_data_write_forward_fast((phoneid), (method), (arg1), (arg2), 0, 0, \
337 (answer))
338#define async_data_write_forward_3_0(phoneid, method, arg1, arg2, arg3, answer) \
339 async_data_write_forward_fast((phoneid), (method), (arg1), (arg2), (arg3), \
340 0, NULL)
341#define async_data_write_forward_3_1(phoneid, method, arg1, arg2, arg3, answer) \
342 async_data_write_forward_fast((phoneid), (method), (arg1), (arg2), (arg3), \
343 0, (answer))
344#define async_data_write_forward_4_0(phoneid, method, arg1, arg2, arg3, arg4, answer) \
345 async_data_write_forward_fast((phoneid), (method), (arg1), (arg2), (arg3), \
346 (arg4), NULL)
347#define async_data_write_forward_4_1(phoneid, method, arg1, arg2, arg3, arg4, answer) \
348 async_data_write_forward_fast((phoneid), (method), (arg1), (arg2), (arg3), \
349 (arg4), (answer))
350
351extern int async_data_write_start(int, const void *, size_t);
352extern int async_data_write_receive(ipc_callid_t *, size_t *);
353extern int async_data_write_finalize(ipc_callid_t, void *, size_t);
354
355extern int async_data_write_accept(void **, const bool, const size_t,
356 const size_t, const size_t, size_t *);
357extern void async_data_write_void(const int);
358
359extern int async_data_write_forward_fast(int, sysarg_t, sysarg_t, sysarg_t,
360 sysarg_t, sysarg_t, ipc_call_t *);
361
362#endif
363
364/** @}
365 */
Note: See TracBrowser for help on using the repository browser.