Subversion Repositories HelenOS

Rev

Rev 1336 | Rev 1350 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
954 palkovsky 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
#include <ipc.h>
30
#include <libc.h>
999 palkovsky 31
#include <malloc.h>
32
#include <errno.h>
33
#include <list.h>
34
#include <stdio.h>
35
#include <unistd.h>
954 palkovsky 36
 
999 palkovsky 37
/** Structure used for keeping track of sent async msgs
38
 * and queing unsent msgs
39
 *
40
 */
41
typedef struct {
42
    link_t list;
43
 
44
    ipc_async_callback_t callback;
45
    void *private;
46
    union {
47
        ipc_callid_t callid;
48
        struct {
1091 palkovsky 49
            ipc_call_t data;
999 palkovsky 50
            int phoneid;
51
        } msg;
52
    }u;
53
} async_call_t;
54
 
55
LIST_INITIALIZE(dispatched_calls);
56
LIST_INITIALIZE(queued_calls);
57
 
58
int ipc_call_sync(int phoneid, ipcarg_t method, ipcarg_t arg1,
59
          ipcarg_t *result)
954 palkovsky 60
{
1091 palkovsky 61
    ipc_call_t resdata;
966 palkovsky 62
    int callres;
63
 
999 palkovsky 64
    callres = __SYSCALL4(SYS_IPC_CALL_SYNC_FAST, phoneid, method, arg1,
966 palkovsky 65
                 (sysarg_t)&resdata);
66
    if (callres)
67
        return callres;
68
    if (result)
69
        *result = IPC_GET_ARG1(resdata);
70
    return IPC_GET_RETVAL(resdata);
954 palkovsky 71
}
72
 
999 palkovsky 73
int ipc_call_sync_3(int phoneid, ipcarg_t method, ipcarg_t arg1,
74
            ipcarg_t arg2, ipcarg_t arg3,
75
            ipcarg_t *result1, ipcarg_t *result2, ipcarg_t *result3)
954 palkovsky 76
{
1091 palkovsky 77
    ipc_call_t data;
966 palkovsky 78
    int callres;
79
 
80
    IPC_SET_METHOD(data, method);
81
    IPC_SET_ARG1(data, arg1);
82
    IPC_SET_ARG2(data, arg2);
83
    IPC_SET_ARG3(data, arg3);
84
 
1006 palkovsky 85
    callres = __SYSCALL3(SYS_IPC_CALL_SYNC, phoneid, (sysarg_t)&data,
86
                 (sysarg_t)&data);
966 palkovsky 87
    if (callres)
88
        return callres;
89
 
90
    if (result1)
91
        *result1 = IPC_GET_ARG1(data);
92
    if (result2)
93
        *result2 = IPC_GET_ARG2(data);
94
    if (result3)
95
        *result3 = IPC_GET_ARG3(data);
96
    return IPC_GET_RETVAL(data);
97
}
98
 
999 palkovsky 99
/** Syscall to send asynchronous message */
1091 palkovsky 100
static  ipc_callid_t _ipc_call_async(int phoneid, ipc_call_t *data)
999 palkovsky 101
{
102
    return __SYSCALL2(SYS_IPC_CALL_ASYNC, phoneid, (sysarg_t)data);
103
}
104
 
966 palkovsky 105
/** Send asynchronous message
106
 *
107
 * - if fatal error, call callback handler with proper error code
108
 * - if message cannot be temporarily sent, add to queue
109
 */
999 palkovsky 110
void ipc_call_async_2(int phoneid, ipcarg_t method, ipcarg_t arg1,
111
              ipcarg_t arg2, void *private,
966 palkovsky 112
              ipc_async_callback_t callback)
113
{
999 palkovsky 114
    async_call_t *call;
966 palkovsky 115
    ipc_callid_t callid;
116
 
999 palkovsky 117
    call = malloc(sizeof(*call));
118
    if (!call) {
119
        callback(private, ENOMEM, NULL);
1028 palkovsky 120
        return;
999 palkovsky 121
    }
122
 
123
    callid = __SYSCALL4(SYS_IPC_CALL_ASYNC_FAST, phoneid, method, arg1, arg2);
966 palkovsky 124
    if (callid == IPC_CALLRET_FATAL) {
125
        /* Call asynchronous handler with error code */
999 palkovsky 126
        callback(private, ENOENT, NULL);
127
        free(call);
966 palkovsky 128
        return;
129
    }
999 palkovsky 130
 
131
    call->callback = callback;
132
    call->private = private;
133
 
966 palkovsky 134
    if (callid == IPC_CALLRET_TEMPORARY) {
135
        /* Add asynchronous call to queue of non-dispatched async calls */
999 palkovsky 136
        call->u.msg.phoneid = phoneid;
137
        IPC_SET_METHOD(call->u.msg.data, method);
138
        IPC_SET_ARG1(call->u.msg.data, arg1);
139
        IPC_SET_ARG2(call->u.msg.data, arg2);
140
 
141
        list_append(&call->list, &queued_calls);
966 palkovsky 142
        return;
143
    }
999 palkovsky 144
    call->u.callid = callid;
145
    /* Add call to list of dispatched calls */
146
    list_append(&call->list, &dispatched_calls);
954 palkovsky 147
}
148
 
966 palkovsky 149
 
1343 jermar 150
/** Send a fast answer to a received call.
151
 *
152
 * The fast answer makes use of passing retval and first two arguments in registers.
153
 * If you need to return more, use the ipc_answer() instead.
154
 *
155
 * @param callid ID of the call being answered.
156
 * @param retval Return value.
157
 * @param arg1 First return argument.
158
 * @param arg2 Second return argument.
159
 *
160
 * @return Zero on success or a value from @ref errno.h on failure.
161
 */
162
ipcarg_t ipc_answer_fast(ipc_callid_t callid, ipcarg_t retval, ipcarg_t arg1,
999 palkovsky 163
        ipcarg_t arg2)
954 palkovsky 164
{
1330 palkovsky 165
    return __SYSCALL4(SYS_IPC_ANSWER_FAST, callid, retval, arg1, arg2);
954 palkovsky 166
}
167
 
1343 jermar 168
/** Send a full answer to a received call.
169
 *
170
 * @param callid ID of the call being answered.
171
 * @param call Call data. Must be already initialized by the responder.
172
 *
173
 * @return Zero on success or a value from @ref errno.h on failure.
174
 */
175
ipcarg_t ipc_answer(ipc_callid_t callid, ipc_call_t *call)
176
{
177
    return __SYSCALL2(SYS_IPC_ANSWER, callid, (sysarg_t) call);
178
}
179
 
180
 
999 palkovsky 181
/** Try to dispatch queed calls from async queue */
182
static void try_dispatch_queued_calls(void)
183
{
184
    async_call_t *call;
185
    ipc_callid_t callid;
186
 
187
    while (!list_empty(&queued_calls)) {
188
        call = list_get_instance(queued_calls.next, async_call_t,
189
                     list);
190
 
191
        callid = _ipc_call_async(call->u.msg.phoneid,
192
                     &call->u.msg.data);
193
        if (callid == IPC_CALLRET_TEMPORARY)
194
            break;
195
        list_remove(&call->list);
196
        if (callid == IPC_CALLRET_FATAL) {
197
            call->callback(call->private, ENOENT, NULL);
198
            free(call);
199
        } else {
200
            call->u.callid = callid;
201
            list_append(&call->list, &dispatched_calls);
202
        }
203
    }
204
}
205
 
206
/** Handle received answer
207
 *
208
 * TODO: Make it use hash table
209
 *
210
 * @param callid Callid (with first bit set) of the answered call
211
 */
1091 palkovsky 212
static void handle_answer(ipc_callid_t callid, ipc_call_t *data)
999 palkovsky 213
{
214
    link_t *item;
215
    async_call_t *call;
216
 
217
    callid &= ~IPC_CALLID_ANSWERED;
218
 
219
    for (item = dispatched_calls.next; item != &dispatched_calls;
220
         item = item->next) {
221
        call = list_get_instance(item, async_call_t, list);
222
        if (call->u.callid == callid) {
223
            list_remove(&call->list);
224
            call->callback(call->private,
225
                       IPC_GET_RETVAL(*data),
226
                       data);
227
            return;
228
        }
229
    }
230
    printf("Received unidentified answer: %P!!!\n", callid);
231
}
232
 
233
 
954 palkovsky 234
/** Wait for IPC call and return
235
 *
236
 * - dispatch ASYNC reoutines in the background
999 palkovsky 237
 * @param data Space where the message is stored
238
 * @return Callid or 0 if nothing available and started with
239
 *         IPC_WAIT_NONBLOCKING
954 palkovsky 240
 */
1028 palkovsky 241
ipc_callid_t ipc_wait_for_call(ipc_call_t *call, int flags)
954 palkovsky 242
{
243
    ipc_callid_t callid;
244
 
966 palkovsky 245
    do {
999 palkovsky 246
        try_dispatch_queued_calls();
247
 
1091 palkovsky 248
        callid = __SYSCALL2(SYS_IPC_WAIT, (sysarg_t)call, flags);
999 palkovsky 249
        /* Handle received answers */
250
        if (callid & IPC_CALLID_ANSWERED)
1091 palkovsky 251
            handle_answer(callid, call);
966 palkovsky 252
    } while (callid & IPC_CALLID_ANSWERED);
999 palkovsky 253
 
954 palkovsky 254
    return callid;
255
}
1028 palkovsky 256
 
1091 palkovsky 257
/** Ask destination to do a callback connection
258
 *
259
 * @return 0 - OK, error code
260
 */
261
int ipc_connect_to_me(int phoneid, int arg1, int arg2, ipcarg_t *phone)
1028 palkovsky 262
{
1091 palkovsky 263
    return ipc_call_sync_3(phoneid, IPC_M_CONNECT_TO_ME, arg1,
264
                   arg2, 0, 0, 0, phone);
1028 palkovsky 265
}
1061 palkovsky 266
 
1091 palkovsky 267
/** Ask through phone for a new connection to some service
268
 *
269
 * @return new phoneid - OK, error code
270
 */
1061 palkovsky 271
int ipc_connect_me_to(int phoneid, int arg1, int arg2)
272
{
1092 palkovsky 273
    ipcarg_t newphid;
1091 palkovsky 274
    int res;
275
 
276
    res =  ipc_call_sync_3(phoneid, IPC_M_CONNECT_ME_TO, arg1,
277
                   arg2, 0, 0, 0, &newphid);
278
    if (res)
279
        return res;
280
    return newphid;
1061 palkovsky 281
}
282
 
1089 palkovsky 283
/* Hang up specified phone */
284
int ipc_hangup(int phoneid)
285
{
286
    return __SYSCALL1(SYS_IPC_HANGUP, phoneid);
287
}
1259 palkovsky 288
 
1282 palkovsky 289
int ipc_register_irq(int irq, irq_code_t *ucode)
1259 palkovsky 290
{
1282 palkovsky 291
    return __SYSCALL2(SYS_IPC_REGISTER_IRQ, irq, (sysarg_t) ucode);
1259 palkovsky 292
}
293
 
294
int ipc_unregister_irq(int irq)
295
{
296
    return __SYSCALL1(SYS_IPC_UNREGISTER_IRQ, irq);
297
}
1330 palkovsky 298
 
1336 jermar 299
int ipc_forward_fast(ipc_callid_t callid, int phoneid, int method, ipcarg_t arg1)
300
{
301
    return __SYSCALL4(SYS_IPC_FORWARD_FAST, callid, phoneid, method, arg1);
302
}
303
 
1330 palkovsky 304
/*
305
int ipc_open_dgrconn(int pohoneid, size_t max_dgram)
306
{
307
 
308
}
309
 
310
 
311
*/