Subversion Repositories HelenOS

Rev

Rev 1086 | Rev 1090 | Go to most recent revision | Only display areas with differences | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed

Rev 1086 Rev 1088
1
/*
1
/*
2
 * Copyright (C) 2006 Ondrej Palkovsky
2
 * Copyright (C) 2006 Ondrej Palkovsky
3
 * All rights reserved.
3
 * All rights reserved.
4
 *
4
 *
5
 * Redistribution and use in source and binary forms, with or without
5
 * Redistribution and use in source and binary forms, with or without
6
 * modification, are permitted provided that the following conditions
6
 * modification, are permitted provided that the following conditions
7
 * are met:
7
 * are met:
8
 *
8
 *
9
 * - Redistributions of source code must retain the above copyright
9
 * - Redistributions of source code must retain the above copyright
10
 *   notice, this list of conditions and the following disclaimer.
10
 *   notice, this list of conditions and the following disclaimer.
11
 * - Redistributions in binary form must reproduce the above copyright
11
 * - Redistributions in binary form must reproduce the above copyright
12
 *   notice, this list of conditions and the following disclaimer in the
12
 *   notice, this list of conditions and the following disclaimer in the
13
 *   documentation and/or other materials provided with the distribution.
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
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.
15
 *   derived from this software without specific prior written permission.
16
 *
16
 *
17
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
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
18
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
20
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
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
23
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
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
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.
26
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27
 */
27
 */
28
 
28
 
29
/* Lock ordering
29
/* Lock ordering
30
 *
30
 *
31
 * First the answerbox, then the phone
31
 * First the answerbox, then the phone
32
 */
32
 */
33
 
33
 
34
#include <synch/spinlock.h>
34
#include <synch/spinlock.h>
35
#include <synch/waitq.h>
35
#include <synch/waitq.h>
36
#include <ipc/ipc.h>
36
#include <ipc/ipc.h>
37
#include <errno.h>
37
#include <errno.h>
38
#include <mm/slab.h>
38
#include <mm/slab.h>
39
#include <arch.h>
39
#include <arch.h>
40
#include <proc/task.h>
40
#include <proc/task.h>
41
#include <memstr.h>
41
#include <memstr.h>
42
#include <debug.h>
42
#include <debug.h>
43
 
43
 
44
#include <print.h>
44
#include <print.h>
45
#include <proc/thread.h>
45
#include <proc/thread.h>
46
 
46
 
47
/* Open channel that is assigned automatically to new tasks */
47
/* Open channel that is assigned automatically to new tasks */
48
answerbox_t *ipc_phone_0 = NULL;
48
answerbox_t *ipc_phone_0 = NULL;
49
 
49
 
50
static slab_cache_t *ipc_call_slab;
50
static slab_cache_t *ipc_call_slab;
51
 
51
 
52
/* Initialize new call */
52
/* Initialize new call */
53
static void _ipc_call_init(call_t *call)
53
static void _ipc_call_init(call_t *call)
54
{
54
{
55
    memsetb((__address)call, sizeof(*call), 0);
55
    memsetb((__address)call, sizeof(*call), 0);
56
    call->callerbox = &TASK->answerbox;
56
    call->callerbox = &TASK->answerbox;
57
    call->sender = TASK;
57
    call->sender = TASK;
58
}
58
}
59
 
59
 
60
/** Allocate & initialize call structure
60
/** Allocate & initialize call structure
61
 *
61
 *
62
 * The call is initialized, so that the reply will be directed
62
 * The call is initialized, so that the reply will be directed
63
 * to TASK->answerbox
63
 * to TASK->answerbox
64
 */
64
 */
65
call_t * ipc_call_alloc(void)
65
call_t * ipc_call_alloc(void)
66
{
66
{
67
    call_t *call;
67
    call_t *call;
68
 
68
 
69
    call = slab_alloc(ipc_call_slab, 0);
69
    call = slab_alloc(ipc_call_slab, 0);
70
    _ipc_call_init(call);
70
    _ipc_call_init(call);
71
 
71
 
72
    return call;
72
    return call;
73
}
73
}
74
 
74
 
75
/** Initialize allocated call */
75
/** Initialize allocated call */
76
void ipc_call_static_init(call_t *call)
76
void ipc_call_static_init(call_t *call)
77
{
77
{
78
    _ipc_call_init(call);
78
    _ipc_call_init(call);
79
    call->flags |= IPC_CALL_STATIC_ALLOC;
79
    call->flags |= IPC_CALL_STATIC_ALLOC;
80
}
80
}
81
 
81
 
82
/** Deallocate call stracuture */
82
/** Deallocate call stracuture */
83
void ipc_call_free(call_t *call)
83
void ipc_call_free(call_t *call)
84
{
84
{
85
    slab_free(ipc_call_slab, call);
85
    slab_free(ipc_call_slab, call);
86
}
86
}
87
 
87
 
88
/** Initialize answerbox structure
88
/** Initialize answerbox structure
89
 */
89
 */
90
void ipc_answerbox_init(answerbox_t *box)
90
void ipc_answerbox_init(answerbox_t *box)
91
{
91
{
92
    spinlock_initialize(&box->lock, "ipc_box_lock");
92
    spinlock_initialize(&box->lock, "ipc_box_lock");
93
    waitq_initialize(&box->wq);
93
    waitq_initialize(&box->wq);
94
    list_initialize(&box->connected_phones);
94
    list_initialize(&box->connected_phones);
95
    list_initialize(&box->calls);
95
    list_initialize(&box->calls);
96
    list_initialize(&box->dispatched_calls);
96
    list_initialize(&box->dispatched_calls);
97
    list_initialize(&box->answers);
97
    list_initialize(&box->answers);
98
    box->task = TASK;
98
    box->task = TASK;
99
}
99
}
100
 
100
 
101
/** Connect phone to answerbox */
101
/** Connect phone to answerbox */
102
void ipc_phone_connect(phone_t *phone, answerbox_t *box)
102
void ipc_phone_connect(phone_t *phone, answerbox_t *box)
103
{
103
{
104
    spinlock_lock(&phone->lock);
104
    spinlock_lock(&phone->lock);
105
 
105
 
106
    ASSERT(!phone->callee);
106
    ASSERT(!phone->callee);
107
    phone->busy = 1;
107
    phone->busy = IPC_BUSY_CONNECTED;
108
    phone->callee = box;
108
    phone->callee = box;
109
 
109
 
110
    spinlock_lock(&box->lock);
110
    spinlock_lock(&box->lock);
111
    list_append(&phone->list, &box->connected_phones);
111
    list_append(&phone->list, &box->connected_phones);
112
    spinlock_unlock(&box->lock);
112
    spinlock_unlock(&box->lock);
113
 
113
 
114
    spinlock_unlock(&phone->lock);
114
    spinlock_unlock(&phone->lock);
115
}
115
}
116
 
116
 
117
/** Initialize phone structure and connect phone to naswerbox
117
/** Initialize phone structure and connect phone to naswerbox
118
 */
118
 */
119
void ipc_phone_init(phone_t *phone)
119
void ipc_phone_init(phone_t *phone)
120
{
120
{
121
    spinlock_initialize(&phone->lock, "phone_lock");
121
    spinlock_initialize(&phone->lock, "phone_lock");
122
    phone->callee = NULL;
122
    phone->callee = NULL;
123
    phone->busy = 0;
123
    phone->busy = IPC_BUSY_FREE;
-
 
124
    atomic_set(&phone->active_calls, 0);
124
}
125
}
125
 
126
 
126
/** Helper function to facilitate synchronous calls */
127
/** Helper function to facilitate synchronous calls */
127
void ipc_call_sync(phone_t *phone, call_t *request)
128
void ipc_call_sync(phone_t *phone, call_t *request)
128
{
129
{
129
    answerbox_t sync_box;
130
    answerbox_t sync_box;
130
 
131
 
131
    ipc_answerbox_init(&sync_box);
132
    ipc_answerbox_init(&sync_box);
132
 
133
 
133
    /* We will receive data on special box */
134
    /* We will receive data on special box */
134
    request->callerbox = &sync_box;
135
    request->callerbox = &sync_box;
135
 
136
 
136
    ipc_call(phone, request);
137
    ipc_call(phone, request);
137
    ipc_wait_for_call(&sync_box, 0);
138
    ipc_wait_for_call(&sync_box, 0);
138
}
139
}
139
 
140
 
140
/** Answer message that was not dispatched and is not entered in
141
/** Answer message that was not dispatched and is not entered in
141
 * any queue
142
 * any queue
142
 */
143
 */
143
static void _ipc_answer_free_call(call_t *call)
144
static void _ipc_answer_free_call(call_t *call)
144
{
145
{
145
    answerbox_t *callerbox = call->callerbox;
146
    answerbox_t *callerbox = call->callerbox;
146
 
147
 
147
    call->flags &= ~IPC_CALL_DISPATCHED;
148
    call->flags &= ~IPC_CALL_DISPATCHED;
148
    call->flags |= IPC_CALL_ANSWERED;
149
    call->flags |= IPC_CALL_ANSWERED;
149
 
150
 
150
    spinlock_lock(&callerbox->lock);
151
    spinlock_lock(&callerbox->lock);
151
    list_append(&call->list, &callerbox->answers);
152
    list_append(&call->list, &callerbox->answers);
152
    spinlock_unlock(&callerbox->lock);
153
    spinlock_unlock(&callerbox->lock);
153
    waitq_wakeup(&callerbox->wq, 0);
154
    waitq_wakeup(&callerbox->wq, 0);
154
}
155
}
155
 
156
 
156
/** Answer message, that is in callee queue
157
/** Answer message, that is in callee queue
157
 *
158
 *
158
 * @param box Answerbox that is answering the message
159
 * @param box Answerbox that is answering the message
159
 * @param call Modified request that is being sent back
160
 * @param call Modified request that is being sent back
160
 */
161
 */
161
void ipc_answer(answerbox_t *box, call_t *call)
162
void ipc_answer(answerbox_t *box, call_t *call)
162
{
163
{
163
    /* Remove from active box */
164
    /* Remove from active box */
164
    spinlock_lock(&box->lock);
165
    spinlock_lock(&box->lock);
165
    list_remove(&call->list);
166
    list_remove(&call->list);
166
    spinlock_unlock(&box->lock);
167
    spinlock_unlock(&box->lock);
167
    /* Send back answer */
168
    /* Send back answer */
168
    _ipc_answer_free_call(call);
169
    _ipc_answer_free_call(call);
169
}
170
}
170
 
171
 
171
/* Unsafe unchecking ipc_call */
172
/* Unsafe unchecking ipc_call */
172
static void _ipc_call(phone_t *phone, answerbox_t *box, call_t *call)
173
static void _ipc_call(phone_t *phone, answerbox_t *box, call_t *call)
173
{
174
{
-
 
175
    if (! (call->flags & IPC_CALL_FORWARDED)) {
174
    atomic_inc(&phone->active_calls);
176
        atomic_inc(&phone->active_calls);
175
    call->data.phone = phone;
177
        call->data.phone = phone;
-
 
178
    }
176
 
179
 
177
    spinlock_lock(&box->lock);
180
    spinlock_lock(&box->lock);
178
    list_append(&call->list, &box->calls);
181
    list_append(&call->list, &box->calls);
179
    spinlock_unlock(&box->lock);
182
    spinlock_unlock(&box->lock);
180
    waitq_wakeup(&box->wq, 0);
183
    waitq_wakeup(&box->wq, 0);
181
}
184
}
182
 
185
 
183
/** Send a asynchronous request using phone to answerbox
186
/** Send a asynchronous request using phone to answerbox
184
 *
187
 *
185
 * @param phone Phone connected to answerbox
188
 * @param phone Phone connected to answerbox
186
 * @param request Request to be sent
189
 * @param request Request to be sent
187
 */
190
 */
188
void ipc_call(phone_t *phone, call_t *call)
191
int ipc_call(phone_t *phone, call_t *call)
189
{
192
{
190
    answerbox_t *box;
193
    answerbox_t *box;
191
 
194
 
192
    spinlock_lock(&phone->lock);
195
    spinlock_lock(&phone->lock);
193
 
196
 
194
    box = phone->callee;
197
    box = phone->callee;
195
    if (!box) {
198
    if (!box) {
196
        /* Trying to send over disconnected phone */
199
        /* Trying to send over disconnected phone */
197
        spinlock_unlock(&phone->lock);
200
        spinlock_unlock(&phone->lock);
-
 
201
        if (call->flags & IPC_CALL_FORWARDED) {
-
 
202
            IPC_SET_RETVAL(call->data, EFORWARD);
-
 
203
        } else { /* Simulate sending a message */
-
 
204
            call->data.phone = phone;
-
 
205
            atomic_inc(&phone->active_calls);
-
 
206
            if (phone->busy == IPC_BUSY_CONNECTED)
-
 
207
                IPC_SET_RETVAL(call->data, EHANGUP);
-
 
208
            else
-
 
209
                IPC_SET_RETVAL(call->data, ENOENT);
-
 
210
        }
198
 
211
 
199
        call->data.phone = phone;
-
 
200
        IPC_SET_RETVAL(call->data, ENOENT);
-
 
201
        _ipc_answer_free_call(call);
212
        _ipc_answer_free_call(call);
202
        return;
213
        return ENOENT;
203
    }
214
    }
204
    _ipc_call(phone, box, call);
215
    _ipc_call(phone, box, call);
205
   
216
   
206
    spinlock_unlock(&phone->lock);
217
    spinlock_unlock(&phone->lock);
-
 
218
    return 0;
207
}
219
}
208
 
220
 
209
/** Disconnect phone from answerbox
221
/** Disconnect phone from answerbox
210
 *
222
 *
211
 * It is allowed to call disconnect on already disconnected phone
223
 * It is allowed to call disconnect on already disconnected phone
212
 *
224
 *
213
 * @return 0 - phone disconnected, -1 - the phone was already disconnected
225
 * @return 0 - phone disconnected, -1 - the phone was already disconnected
214
 */
226
 */
215
int ipc_phone_hangup(phone_t *phone)
227
int ipc_phone_hangup(phone_t *phone)
216
{
228
{
217
    answerbox_t *box;
229
    answerbox_t *box;
218
    call_t *call;
230
    call_t *call;
219
   
231
   
220
    spinlock_lock(&phone->lock);
232
    spinlock_lock(&phone->lock);
221
    box = phone->callee;
233
    box = phone->callee;
222
    if (!box) {
234
    if (!box) {
-
 
235
        if (phone->busy == IPC_BUSY_CONNECTING) {
-
 
236
            spinlock_unlock(&phone->lock);
-
 
237
            return -1;
-
 
238
        }
-
 
239
        /* Already disconnected phone */
-
 
240
        phone->busy = IPC_BUSY_FREE;
223
        spinlock_unlock(&phone->lock);
241
        spinlock_unlock(&phone->lock);
224
        return -1;
242
        return 0;
225
    }
243
    }
226
 
244
 
227
    spinlock_lock(&box->lock);
245
    spinlock_lock(&box->lock);
228
    list_remove(&phone->list);
246
    list_remove(&phone->list);
229
    phone->callee = NULL;
247
    phone->callee = NULL;
230
    spinlock_unlock(&box->lock);
248
    spinlock_unlock(&box->lock);
231
 
249
 
232
    call = ipc_call_alloc();
250
    call = ipc_call_alloc();
233
    IPC_SET_METHOD(call->data, IPC_M_PHONE_HUNGUP);
251
    IPC_SET_METHOD(call->data, IPC_M_PHONE_HUNGUP);
234
    call->flags |= IPC_CALL_DISCARD_ANSWER;
252
    call->flags |= IPC_CALL_DISCARD_ANSWER;
235
    _ipc_call(phone, box, call);
253
    _ipc_call(phone, box, call);
236
 
254
 
237
    phone->busy = 0;
255
    phone->busy = IPC_BUSY_FREE;
238
 
256
 
239
    spinlock_unlock(&phone->lock);
257
    spinlock_unlock(&phone->lock);
240
 
258
 
241
    return 0;
259
    return 0;
242
}
260
}
243
 
261
 
244
/** Forwards call from one answerbox to a new one
262
/** Forwards call from one answerbox to a new one
245
 *
263
 *
246
 * @param request Request to be forwarded
264
 * @param request Request to be forwarded
247
 * @param newbox Target answerbox
265
 * @param newbox Target answerbox
248
 * @param oldbox Old answerbox
266
 * @param oldbox Old answerbox
-
 
267
 * @return 0 on forward ok, error code, if there was error
-
 
268
 *
-
 
269
 * - the return value serves only as an information for the forwarder,
-
 
270
 *   the original caller is notified automatically with EFORWARD
249
 */
271
 */
250
void ipc_forward(call_t *call, phone_t *newphone, answerbox_t *oldbox)
272
int ipc_forward(call_t *call, phone_t *newphone, answerbox_t *oldbox)
251
{
273
{
252
    spinlock_lock(&oldbox->lock);
274
    spinlock_lock(&oldbox->lock);
253
    atomic_dec(&call->data.phone->active_calls);
-
 
254
    list_remove(&call->list);
275
    list_remove(&call->list);
255
    spinlock_unlock(&oldbox->lock);
276
    spinlock_unlock(&oldbox->lock);
256
 
277
 
257
    ipc_call(newphone, call);
278
    return ipc_call(newphone, call);
258
}
279
}
259
 
280
 
260
 
281
 
261
/** Wait for phone call
282
/** Wait for phone call
262
 *
283
 *
263
 * @return Recived message address
284
 * @return Recived message address
264
 * - to distinguish between call and answer, look at call->flags
285
 * - to distinguish between call and answer, look at call->flags
265
 */
286
 */
266
call_t * ipc_wait_for_call(answerbox_t *box, int flags)
287
call_t * ipc_wait_for_call(answerbox_t *box, int flags)
267
{
288
{
268
    call_t *request;
289
    call_t *request;
269
 
290
 
270
restart:      
291
restart:      
271
    if (flags & IPC_WAIT_NONBLOCKING) {
292
    if (flags & IPC_WAIT_NONBLOCKING) {
272
        if (waitq_sleep_timeout(&box->wq,0,1) == ESYNCH_WOULD_BLOCK)
293
        if (waitq_sleep_timeout(&box->wq,0,1) == ESYNCH_WOULD_BLOCK)
273
            return NULL;
294
            return NULL;
274
    } else
295
    } else
275
        waitq_sleep(&box->wq);
296
        waitq_sleep(&box->wq);
276
   
297
   
277
    spinlock_lock(&box->lock);
298
    spinlock_lock(&box->lock);
278
    if (!list_empty(&box->answers)) {
299
    if (!list_empty(&box->answers)) {
279
        /* Handle asynchronous answers */
300
        /* Handle asynchronous answers */
280
        request = list_get_instance(box->answers.next, call_t, list);
301
        request = list_get_instance(box->answers.next, call_t, list);
281
        list_remove(&request->list);
302
        list_remove(&request->list);
282
        printf("%d %P\n", IPC_GET_METHOD(request->data),
-
 
283
               request->data.phone);
-
 
284
        atomic_dec(&request->data.phone->active_calls);
303
        atomic_dec(&request->data.phone->active_calls);
285
    } else if (!list_empty(&box->calls)) {
304
    } else if (!list_empty(&box->calls)) {
286
        /* Handle requests */
305
        /* Handle requests */
287
        request = list_get_instance(box->calls.next, call_t, list);
306
        request = list_get_instance(box->calls.next, call_t, list);
288
        list_remove(&request->list);
307
        list_remove(&request->list);
289
        /* Append request to dispatch queue */
308
        /* Append request to dispatch queue */
290
        list_append(&request->list, &box->dispatched_calls);
309
        list_append(&request->list, &box->dispatched_calls);
291
        request->flags |= IPC_CALL_DISPATCHED;
310
        request->flags |= IPC_CALL_DISPATCHED;
292
    } else {
311
    } else {
293
        printf("WARNING: Spurious IPC wakeup.\n");
312
        printf("WARNING: Spurious IPC wakeup.\n");
294
        spinlock_unlock(&box->lock);
313
        spinlock_unlock(&box->lock);
295
        goto restart;
314
        goto restart;
296
    }
315
    }
297
    spinlock_unlock(&box->lock);
316
    spinlock_unlock(&box->lock);
298
    return request;
317
    return request;
299
}
318
}
300
 
319
 
301
/** Initilize ipc subsystem */
320
/** Initilize ipc subsystem */
302
void ipc_init(void)
321
void ipc_init(void)
303
{
322
{
304
    ipc_call_slab = slab_cache_create("ipc_call",
323
    ipc_call_slab = slab_cache_create("ipc_call",
305
                      sizeof(call_t),
324
                      sizeof(call_t),
306
                      0,
325
                      0,
307
                      NULL, NULL, 0);
326
                      NULL, NULL, 0);
308
}
327
}
309
 
328
 
310
/** Cleans up all IPC communication of the given task
329
/** Cleans up all IPC communication of the given task
311
 *
330
 *
312
 *
331
 *
313
 */
332
 */
314
void ipc_cleanup(task_t *task)
333
void ipc_cleanup(task_t *task)
315
{
334
{
-
 
335
    int i;
-
 
336
 
-
 
337
    /* Disconnect all our phones ('ipc_phone_hangup') */
-
 
338
    for (i=0;i < IPC_MAX_PHONES; i++)
-
 
339
        ipc_phone_hangup(&task->phones[i]);
-
 
340
 
-
 
341
    /* Disconnect all phones connected to answerbox */
-
 
342
 
316
    /* Cancel all calls in my dispatch queue */
343
    /* Answer all messages in 'calls' and 'dispatched_calls' queues */
317
   
344
   
-
 
345
    /* Wait for all async answers to arrive */
318
}
346
}
319
 
347