Subversion Repositories HelenOS

Rev

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

Rev 2310 Rev 2471
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
/** @addtogroup genericipc
29
/** @addtogroup genericipc
30
 * @{
30
 * @{
31
 */
31
 */
32
/** @file
32
/** @file
33
 */
33
 */
34
 
34
 
35
/* Lock ordering
35
/* Lock ordering
36
 *
36
 *
37
 * First the answerbox, then the phone
37
 * First the answerbox, then the phone.
38
 */
38
 */
39
 
39
 
40
#include <synch/spinlock.h>
40
#include <synch/spinlock.h>
41
#include <synch/waitq.h>
41
#include <synch/waitq.h>
42
#include <synch/synch.h>
42
#include <synch/synch.h>
43
#include <ipc/ipc.h>
43
#include <ipc/ipc.h>
44
#include <errno.h>
44
#include <errno.h>
45
#include <mm/slab.h>
45
#include <mm/slab.h>
46
#include <arch.h>
46
#include <arch.h>
47
#include <proc/task.h>
47
#include <proc/task.h>
48
#include <memstr.h>
48
#include <memstr.h>
49
#include <debug.h>
49
#include <debug.h>
50
 
50
 
51
#include <print.h>
51
#include <print.h>
52
#include <proc/thread.h>
52
#include <proc/thread.h>
53
#include <arch/interrupt.h>
53
#include <arch/interrupt.h>
54
#include <ipc/irq.h>
54
#include <ipc/irq.h>
55
 
55
 
56
/* Open channel that is assigned automatically to new tasks */
56
/** Open channel that is assigned automatically to new tasks */
57
answerbox_t *ipc_phone_0 = NULL;
57
answerbox_t *ipc_phone_0 = NULL;
58
 
58
 
59
static slab_cache_t *ipc_call_slab;
59
static slab_cache_t *ipc_call_slab;
60
 
60
 
61
/* Initialize new call */
61
/** Initialize a call structure.
-
 
62
 *
-
 
63
 * @param call      Call structure to be initialized.
-
 
64
 */
62
static void _ipc_call_init(call_t *call)
65
static void _ipc_call_init(call_t *call)
63
{
66
{
64
    memsetb((uintptr_t)call, sizeof(*call), 0);
67
    memsetb((uintptr_t) call, sizeof(*call), 0);
65
    call->callerbox = &TASK->answerbox;
68
    call->callerbox = &TASK->answerbox;
66
    call->sender = TASK;
69
    call->sender = TASK;
67
}
70
}
68
 
71
 
69
/** Allocate & initialize call structure
72
/** Allocate and initialize a call structure.
70
 *
73
 *
71
 * The call is initialized, so that the reply will be directed
74
 * The call is initialized, so that the reply will be directed to
72
 * to TASK->answerbox
75
 * TASK->answerbox.
-
 
76
 *
-
 
77
 * @param flags     Parameters for slab_alloc (e.g FRAME_ATOMIC).
73
 *
78
 *
74
 * @param flags Parameters for slab_alloc (ATOMIC, etc.)
79
 * @return      If flags permit it, return NULL, or initialized kernel
-
 
80
 *          call structure.
75
 */
81
 */
76
call_t * ipc_call_alloc(int flags)
82
call_t *ipc_call_alloc(int flags)
77
{
83
{
78
    call_t *call;
84
    call_t *call;
79
 
85
 
80
    call = slab_alloc(ipc_call_slab, flags);
86
    call = slab_alloc(ipc_call_slab, flags);
81
    _ipc_call_init(call);
87
    _ipc_call_init(call);
82
 
88
 
83
    return call;
89
    return call;
84
}
90
}
85
 
91
 
86
/** Initialize allocated call */
92
/** Initialize a statically allocated call structure.
-
 
93
 *
-
 
94
 * @param call      Statically allocated kernel call structure to be
-
 
95
 *          initialized.
-
 
96
 */
87
void ipc_call_static_init(call_t *call)
97
void ipc_call_static_init(call_t *call)
88
{
98
{
89
    _ipc_call_init(call);
99
    _ipc_call_init(call);
90
    call->flags |= IPC_CALL_STATIC_ALLOC;
100
    call->flags |= IPC_CALL_STATIC_ALLOC;
91
}
101
}
92
 
102
 
93
/** Deallocate call stracuture */
103
/** Deallocate a call stracuture.
-
 
104
 *
-
 
105
 * @param call      Call structure to be freed.
-
 
106
 */
94
void ipc_call_free(call_t *call)
107
void ipc_call_free(call_t *call)
95
{
108
{
-
 
109
    ASSERT(!(call->flags & IPC_CALL_STATIC_ALLOC));
96
    slab_free(ipc_call_slab, call);
110
    slab_free(ipc_call_slab, call);
97
}
111
}
98
 
112
 
99
/** Initialize answerbox structure
113
/** Initialize an answerbox structure.
-
 
114
 *
-
 
115
 * @param box       Answerbox structure to be initialized.
100
 */
116
 */
101
void ipc_answerbox_init(answerbox_t *box)
117
void ipc_answerbox_init(answerbox_t *box)
102
{
118
{
103
    spinlock_initialize(&box->lock, "ipc_box_lock");
119
    spinlock_initialize(&box->lock, "ipc_box_lock");
104
    spinlock_initialize(&box->irq_lock, "ipc_box_irqlock");
120
    spinlock_initialize(&box->irq_lock, "ipc_box_irqlock");
105
    waitq_initialize(&box->wq);
121
    waitq_initialize(&box->wq);
106
    list_initialize(&box->connected_phones);
122
    list_initialize(&box->connected_phones);
107
    list_initialize(&box->calls);
123
    list_initialize(&box->calls);
108
    list_initialize(&box->dispatched_calls);
124
    list_initialize(&box->dispatched_calls);
109
    list_initialize(&box->answers);
125
    list_initialize(&box->answers);
110
    list_initialize(&box->irq_notifs);
126
    list_initialize(&box->irq_notifs);
111
    list_initialize(&box->irq_head);
127
    list_initialize(&box->irq_head);
112
    box->task = TASK;
128
    box->task = TASK;
113
}
129
}
114
 
130
 
115
/** Connect phone to answerbox */
131
/** Connect a phone to an answerbox.
-
 
132
 *
-
 
133
 * @param phone     Initialized phone structure.
-
 
134
 * @param box       Initialized answerbox structure.
-
 
135
 */
116
void ipc_phone_connect(phone_t *phone, answerbox_t *box)
136
void ipc_phone_connect(phone_t *phone, answerbox_t *box)
117
{
137
{
118
    spinlock_lock(&phone->lock);
138
    spinlock_lock(&phone->lock);
119
 
139
 
120
    phone->state = IPC_PHONE_CONNECTED;
140
    phone->state = IPC_PHONE_CONNECTED;
121
    phone->callee = box;
141
    phone->callee = box;
122
 
142
 
123
    spinlock_lock(&box->lock);
143
    spinlock_lock(&box->lock);
124
    list_append(&phone->link, &box->connected_phones);
144
    list_append(&phone->link, &box->connected_phones);
125
    spinlock_unlock(&box->lock);
145
    spinlock_unlock(&box->lock);
126
 
146
 
127
    spinlock_unlock(&phone->lock);
147
    spinlock_unlock(&phone->lock);
128
}
148
}
129
 
149
 
-
 
150
/** Initialize a phone structure.
-
 
151
 *
130
/** Initialize phone structure and connect phone to answerbox
152
 * @param phone     Phone structure to be initialized.
131
 */
153
 */
132
void ipc_phone_init(phone_t *phone)
154
void ipc_phone_init(phone_t *phone)
133
{
155
{
134
    spinlock_initialize(&phone->lock, "phone_lock");
156
    spinlock_initialize(&phone->lock, "phone_lock");
135
    phone->callee = NULL;
157
    phone->callee = NULL;
136
    phone->state = IPC_PHONE_FREE;
158
    phone->state = IPC_PHONE_FREE;
137
    atomic_set(&phone->active_calls, 0);
159
    atomic_set(&phone->active_calls, 0);
138
}
160
}
139
 
161
 
140
/** Helper function to facilitate synchronous calls */
162
/** Helper function to facilitate synchronous calls.
-
 
163
 *
-
 
164
 * @param phone     Destination kernel phone structure.
-
 
165
 * @param request   Call structure with request.
-
 
166
 */
141
void ipc_call_sync(phone_t *phone, call_t *request)
167
void ipc_call_sync(phone_t *phone, call_t *request)
142
{
168
{
143
    answerbox_t sync_box;
169
    answerbox_t sync_box;
144
 
170
 
145
    ipc_answerbox_init(&sync_box);
171
    ipc_answerbox_init(&sync_box);
146
 
172
 
147
    /* We will receive data on special box */
173
    /* We will receive data in a special box. */
148
    request->callerbox = &sync_box;
174
    request->callerbox = &sync_box;
149
 
175
 
150
    ipc_call(phone, request);
176
    ipc_call(phone, request);
151
    ipc_wait_for_call(&sync_box, SYNCH_NO_TIMEOUT, SYNCH_FLAGS_NONE);
177
    ipc_wait_for_call(&sync_box, SYNCH_NO_TIMEOUT, SYNCH_FLAGS_NONE);
152
}
178
}
153
 
179
 
154
/** Answer message that was not dispatched and is not entered in
180
/** Answer a message which was not dispatched and is not listed in any queue.
155
 * any queue
181
 *
-
 
182
 * @param call      Call structure to be answered.
156
 */
183
 */
157
static void _ipc_answer_free_call(call_t *call)
184
static void _ipc_answer_free_call(call_t *call)
158
{
185
{
159
    answerbox_t *callerbox = call->callerbox;
186
    answerbox_t *callerbox = call->callerbox;
160
 
187
 
161
    call->flags |= IPC_CALL_ANSWERED;
188
    call->flags |= IPC_CALL_ANSWERED;
162
 
189
 
163
    spinlock_lock(&callerbox->lock);
190
    spinlock_lock(&callerbox->lock);
164
    list_append(&call->link, &callerbox->answers);
191
    list_append(&call->link, &callerbox->answers);
165
    spinlock_unlock(&callerbox->lock);
192
    spinlock_unlock(&callerbox->lock);
166
    waitq_wakeup(&callerbox->wq, WAKEUP_FIRST);
193
    waitq_wakeup(&callerbox->wq, WAKEUP_FIRST);
167
}
194
}
168
 
195
 
169
/** Answer message, that is in callee queue
196
/** Answer a message which is in a callee queue.
170
 *
197
 *
171
 * @param box Answerbox that is answering the message
198
 * @param box       Answerbox that is answering the message.
172
 * @param call Modified request that is being sent back
199
 * @param call      Modified request that is being sent back.
173
 */
200
 */
174
void ipc_answer(answerbox_t *box, call_t *call)
201
void ipc_answer(answerbox_t *box, call_t *call)
175
{
202
{
176
    /* Remove from active box */
203
    /* Remove from active box */
177
    spinlock_lock(&box->lock);
204
    spinlock_lock(&box->lock);
178
    list_remove(&call->link);
205
    list_remove(&call->link);
179
    spinlock_unlock(&box->lock);
206
    spinlock_unlock(&box->lock);
180
    /* Send back answer */
207
    /* Send back answer */
181
    _ipc_answer_free_call(call);
208
    _ipc_answer_free_call(call);
182
}
209
}
183
 
210
 
184
/** Simulate sending back a message
211
/** Simulate sending back a message.
185
 *
212
 *
186
 * Most errors are better handled by forming a normal backward
213
 * Most errors are better handled by forming a normal backward
187
 * message and sending it as a normal answer.
214
 * message and sending it as a normal answer.
-
 
215
 *
-
 
216
 * @param phone     Phone structure the call should appear to come from.
-
 
217
 * @param call      Call structure to be answered.
-
 
218
 * @param err       Return value to be used for the answer.
188
 */
219
 */
189
void ipc_backsend_err(phone_t *phone, call_t *call, unative_t err)
220
void ipc_backsend_err(phone_t *phone, call_t *call, unative_t err)
190
{
221
{
191
    call->data.phone = phone;
222
    call->data.phone = phone;
192
    atomic_inc(&phone->active_calls);
223
    atomic_inc(&phone->active_calls);
193
    IPC_SET_RETVAL(call->data, err);
224
    IPC_SET_RETVAL(call->data, err);
194
    _ipc_answer_free_call(call);
225
    _ipc_answer_free_call(call);
195
}
226
}
196
 
227
 
197
/* Unsafe unchecking ipc_call */
228
/** Unsafe unchecking version of ipc_call.
-
 
229
 *
-
 
230
 * @param phone     Phone structure the call comes from.
-
 
231
 * @param box       Destination answerbox structure.
-
 
232
 */
198
static void _ipc_call(phone_t *phone, answerbox_t *box, call_t *call)
233
static void _ipc_call(phone_t *phone, answerbox_t *box, call_t *call)
199
{
234
{
200
    if (! (call->flags & IPC_CALL_FORWARDED)) {
235
    if (!(call->flags & IPC_CALL_FORWARDED)) {
201
        atomic_inc(&phone->active_calls);
236
        atomic_inc(&phone->active_calls);
202
        call->data.phone = phone;
237
        call->data.phone = phone;
203
    }
238
    }
204
 
239
 
205
    spinlock_lock(&box->lock);
240
    spinlock_lock(&box->lock);
206
    list_append(&call->link, &box->calls);
241
    list_append(&call->link, &box->calls);
207
    spinlock_unlock(&box->lock);
242
    spinlock_unlock(&box->lock);
208
    waitq_wakeup(&box->wq, WAKEUP_FIRST);
243
    waitq_wakeup(&box->wq, WAKEUP_FIRST);
209
}
244
}
210
 
245
 
211
/** Send a asynchronous request using phone to answerbox
246
/** Send an asynchronous request using a phone to an answerbox.
-
 
247
 *
-
 
248
 * @param phone     Phone structure the call comes from and which is
-
 
249
 *          connected to the destination answerbox.
-
 
250
 * @param call      Call structure with request.
212
 *
251
 *
213
 * @param phone Phone connected to answerbox.
252
 * @return      Return 0 on success, ENOENT on error.
214
 * @param call Structure representing the call.
-
 
215
 */
253
 */
216
int ipc_call(phone_t *phone, call_t *call)
254
int ipc_call(phone_t *phone, call_t *call)
217
{
255
{
218
    answerbox_t *box;
256
    answerbox_t *box;
219
 
257
 
220
    spinlock_lock(&phone->lock);
258
    spinlock_lock(&phone->lock);
221
    if (phone->state != IPC_PHONE_CONNECTED) {
259
    if (phone->state != IPC_PHONE_CONNECTED) {
222
        spinlock_unlock(&phone->lock);
260
        spinlock_unlock(&phone->lock);
223
        if (call->flags & IPC_CALL_FORWARDED) {
261
        if (call->flags & IPC_CALL_FORWARDED) {
224
            IPC_SET_RETVAL(call->data, EFORWARD);
262
            IPC_SET_RETVAL(call->data, EFORWARD);
225
            _ipc_answer_free_call(call);
263
            _ipc_answer_free_call(call);
226
        } else {
264
        } else {
227
            if (phone->state == IPC_PHONE_HUNGUP)
265
            if (phone->state == IPC_PHONE_HUNGUP)
228
                ipc_backsend_err(phone, call, EHANGUP);
266
                ipc_backsend_err(phone, call, EHANGUP);
229
            else
267
            else
230
                ipc_backsend_err(phone, call, ENOENT);
268
                ipc_backsend_err(phone, call, ENOENT);
231
        }
269
        }
232
        return ENOENT;
270
        return ENOENT;
233
    }
271
    }
234
    box = phone->callee;
272
    box = phone->callee;
235
    _ipc_call(phone, box, call);
273
    _ipc_call(phone, box, call);
236
   
274
   
237
    spinlock_unlock(&phone->lock);
275
    spinlock_unlock(&phone->lock);
238
    return 0;
276
    return 0;
239
}
277
}
240
 
278
 
241
/** Disconnect phone from answerbox
279
/** Disconnect phone from answerbox.
242
 *
280
 *
243
 * This call leaves the phone in HUNGUP state. The change to 'free' is done
281
 * This call leaves the phone in the HUNGUP state. The change to 'free' is done
244
 * lazily later.
282
 * lazily later.
245
 *
283
 *
246
 * @param phone Phone to be hung up
284
 * @param phone     Phone structure to be hung up.
247
 *              
285
 *              
-
 
286
 * @return      Return 0 if the phone is disconnected.
248
 * @return 0 - phone disconnected, -1 - the phone was already disconnected
287
 *          Return -1 if the phone was already disconnected.
249
 */
288
 */
250
int ipc_phone_hangup(phone_t *phone)
289
int ipc_phone_hangup(phone_t *phone)
251
{
290
{
252
    answerbox_t *box;
291
    answerbox_t *box;
253
    call_t *call;
292
    call_t *call;
254
   
293
   
255
    spinlock_lock(&phone->lock);
294
    spinlock_lock(&phone->lock);
256
    if (phone->state == IPC_PHONE_FREE || phone->state ==IPC_PHONE_HUNGUP \
295
    if (phone->state == IPC_PHONE_FREE || phone->state == IPC_PHONE_HUNGUP ||
257
        || phone->state == IPC_PHONE_CONNECTING) {
296
        phone->state == IPC_PHONE_CONNECTING) {
258
        spinlock_unlock(&phone->lock);
297
        spinlock_unlock(&phone->lock);
259
        return -1;
298
        return -1;
260
    }
299
    }
261
    box = phone->callee;
300
    box = phone->callee;
262
    if (phone->state != IPC_PHONE_SLAMMED) {
301
    if (phone->state != IPC_PHONE_SLAMMED) {
263
        /* Remove myself from answerbox */
302
        /* Remove myself from answerbox */
264
        spinlock_lock(&box->lock);
303
        spinlock_lock(&box->lock);
265
        list_remove(&phone->link);
304
        list_remove(&phone->link);
266
        spinlock_unlock(&box->lock);
305
        spinlock_unlock(&box->lock);
267
 
306
 
268
        if (phone->state != IPC_PHONE_SLAMMED) {
307
        if (phone->state != IPC_PHONE_SLAMMED) {
269
            call = ipc_call_alloc(0);
308
            call = ipc_call_alloc(0);
270
            IPC_SET_METHOD(call->data, IPC_M_PHONE_HUNGUP);
309
            IPC_SET_METHOD(call->data, IPC_M_PHONE_HUNGUP);
271
            call->flags |= IPC_CALL_DISCARD_ANSWER;
310
            call->flags |= IPC_CALL_DISCARD_ANSWER;
272
            _ipc_call(phone, box, call);
311
            _ipc_call(phone, box, call);
273
        }
312
        }
274
    }
313
    }
275
 
314
 
276
    phone->state = IPC_PHONE_HUNGUP;
315
    phone->state = IPC_PHONE_HUNGUP;
277
    spinlock_unlock(&phone->lock);
316
    spinlock_unlock(&phone->lock);
278
 
317
 
279
    return 0;
318
    return 0;
280
}
319
}
281
 
320
 
282
/** Forwards call from one answerbox to a new one
321
/** Forwards call from one answerbox to another one.
283
 *
322
 *
284
 * @param call Call to be redirected.
323
 * @param call      Call structure to be redirected.
285
 * @param newphone Phone to target answerbox.
324
 * @param newphone  Phone structure to target answerbox.
286
 * @param oldbox Old answerbox
325
 * @param oldbox    Old answerbox structure.
-
 
326
 *
287
 * @return 0 on forward ok, error code, if there was error
327
 * @return      Return 0 if forwarding succeeded or an error code if
-
 
328
 *          there was error.
288
 *
329
 *
289
 * - the return value serves only as an information for the forwarder,
330
 * The return value serves only as an information for the forwarder,
290
 *   the original caller is notified automatically with EFORWARD
331
 * the original caller is notified automatically with EFORWARD.
291
 */
332
 */
292
int ipc_forward(call_t *call, phone_t *newphone, answerbox_t *oldbox)
333
int ipc_forward(call_t *call, phone_t *newphone, answerbox_t *oldbox)
293
{
334
{
294
    spinlock_lock(&oldbox->lock);
335
    spinlock_lock(&oldbox->lock);
295
    list_remove(&call->link);
336
    list_remove(&call->link);
296
    spinlock_unlock(&oldbox->lock);
337
    spinlock_unlock(&oldbox->lock);
297
 
338
 
298
    return ipc_call(newphone, call);
339
    return ipc_call(newphone, call);
299
}
340
}
300
 
341
 
301
 
342
 
302
/** Wait for phone call
343
/** Wait for a phone call.
303
 *
344
 *
304
 * @param box Answerbox expecting the call.
345
 * @param box       Answerbox expecting the call.
305
 * @param usec Timeout in microseconds. See documentation for waitq_sleep_timeout() for
346
 * @param usec      Timeout in microseconds. See documentation for
306
 *         decription of its special meaning.
347
 *          waitq_sleep_timeout() for decription of its special
-
 
348
 *          meaning.
307
 * @param flags Select mode of sleep operation. See documentation for waitq_sleep_timeout()i
349
 * @param flags     Select mode of sleep operation. See documentation for
308
 *      for description of its special meaning.
350
 *          waitq_sleep_timeout() for description of its special
-
 
351
 *          meaning.
309
 * @return Recived message address
352
 * @return      Recived call structure or NULL.
-
 
353
 *
310
 * - to distinguish between call and answer, look at call->flags
354
 * To distinguish between a call and an answer, have a look at call->flags.
311
 */
355
 */
312
call_t * ipc_wait_for_call(answerbox_t *box, uint32_t usec, int flags)
356
call_t *ipc_wait_for_call(answerbox_t *box, uint32_t usec, int flags)
313
{
357
{
314
    call_t *request;
358
    call_t *request;
315
    ipl_t ipl;
359
    ipl_t ipl;
316
    int rc;
360
    int rc;
317
 
361
 
318
restart:
362
restart:
319
    rc = waitq_sleep_timeout(&box->wq, usec, flags);
363
    rc = waitq_sleep_timeout(&box->wq, usec, flags);
320
    if (SYNCH_FAILED(rc))
364
    if (SYNCH_FAILED(rc))
321
        return NULL;
365
        return NULL;
322
   
366
   
323
    spinlock_lock(&box->lock);
367
    spinlock_lock(&box->lock);
324
    if (!list_empty(&box->irq_notifs)) {
368
    if (!list_empty(&box->irq_notifs)) {
325
        ipl = interrupts_disable();
369
        ipl = interrupts_disable();
326
        spinlock_lock(&box->irq_lock);
370
        spinlock_lock(&box->irq_lock);
327
 
371
 
328
        request = list_get_instance(box->irq_notifs.next, call_t, link);
372
        request = list_get_instance(box->irq_notifs.next, call_t, link);
329
        list_remove(&request->link);
373
        list_remove(&request->link);
330
 
374
 
331
        spinlock_unlock(&box->irq_lock);
375
        spinlock_unlock(&box->irq_lock);
332
        interrupts_restore(ipl);
376
        interrupts_restore(ipl);
333
    } else if (!list_empty(&box->answers)) {
377
    } else if (!list_empty(&box->answers)) {
334
        /* Handle asynchronous answers */
378
        /* Handle asynchronous answers */
335
        request = list_get_instance(box->answers.next, call_t, link);
379
        request = list_get_instance(box->answers.next, call_t, link);
336
        list_remove(&request->link);
380
        list_remove(&request->link);
337
        atomic_dec(&request->data.phone->active_calls);
381
        atomic_dec(&request->data.phone->active_calls);
338
    } else if (!list_empty(&box->calls)) {
382
    } else if (!list_empty(&box->calls)) {
339
        /* Handle requests */
383
        /* Handle requests */
340
        request = list_get_instance(box->calls.next, call_t, link);
384
        request = list_get_instance(box->calls.next, call_t, link);
341
        list_remove(&request->link);
385
        list_remove(&request->link);
342
        /* Append request to dispatch queue */
386
        /* Append request to dispatch queue */
343
        list_append(&request->link, &box->dispatched_calls);
387
        list_append(&request->link, &box->dispatched_calls);
344
    } else {
388
    } else {
345
        /* This can happen regularly after ipc_cleanup */
389
        /* This can happen regularly after ipc_cleanup */
346
        spinlock_unlock(&box->lock);
390
        spinlock_unlock(&box->lock);
347
        goto restart;
391
        goto restart;
348
    }
392
    }
349
    spinlock_unlock(&box->lock);
393
    spinlock_unlock(&box->lock);
350
    return request;
394
    return request;
351
}
395
}
352
 
396
 
353
/** Answer all calls from list with EHANGUP msg */
397
/** Answer all calls from list with EHANGUP answer.
-
 
398
 *
-
 
399
 * @param lst       Head of the list to be cleaned up.
-
 
400
 */
354
static void ipc_cleanup_call_list(link_t *lst)
401
static void ipc_cleanup_call_list(link_t *lst)
355
{
402
{
356
    call_t *call;
403
    call_t *call;
357
 
404
 
358
    while (!list_empty(lst)) {
405
    while (!list_empty(lst)) {
359
        call = list_get_instance(lst->next, call_t, link);
406
        call = list_get_instance(lst->next, call_t, link);
360
        list_remove(&call->link);
407
        list_remove(&call->link);
361
 
408
 
362
        IPC_SET_RETVAL(call->data, EHANGUP);
409
        IPC_SET_RETVAL(call->data, EHANGUP);
363
        _ipc_answer_free_call(call);
410
        _ipc_answer_free_call(call);
364
    }
411
    }
365
}
412
}
366
 
413
 
367
/** Cleans up all IPC communication of the current task
414
/** Cleans up all IPC communication of the current task.
368
 *
415
 *
369
 * Note: ipc_hangup sets returning answerbox to TASK->answerbox, you
416
 * Note: ipc_hangup sets returning answerbox to TASK->answerbox, you
370
 * have to change it as well if you want to cleanup other current then current.
417
 * have to change it as well if you want to cleanup other tasks than TASK.
371
 */
418
 */
372
void ipc_cleanup(void)
419
void ipc_cleanup(void)
373
{
420
{
374
    int i;
421
    int i;
375
    call_t *call;
422
    call_t *call;
376
    phone_t *phone;
423
    phone_t *phone;
377
    DEADLOCK_PROBE_INIT(p_phonelck);
424
    DEADLOCK_PROBE_INIT(p_phonelck);
378
 
425
 
379
    /* Disconnect all our phones ('ipc_phone_hangup') */
426
    /* Disconnect all our phones ('ipc_phone_hangup') */
380
    for (i=0;i < IPC_MAX_PHONES; i++)
427
    for (i = 0; i < IPC_MAX_PHONES; i++)
381
        ipc_phone_hangup(&TASK->phones[i]);
428
        ipc_phone_hangup(&TASK->phones[i]);
382
 
429
 
383
    /* Disconnect all connected irqs */
430
    /* Disconnect all connected irqs */
384
    ipc_irq_cleanup(&TASK->answerbox);
431
    ipc_irq_cleanup(&TASK->answerbox);
385
 
432
 
386
    /* Disconnect all phones connected to our answerbox */
433
    /* Disconnect all phones connected to our answerbox */
387
restart_phones:
434
restart_phones:
388
    spinlock_lock(&TASK->answerbox.lock);
435
    spinlock_lock(&TASK->answerbox.lock);
389
    while (!list_empty(&TASK->answerbox.connected_phones)) {
436
    while (!list_empty(&TASK->answerbox.connected_phones)) {
390
        phone = list_get_instance(TASK->answerbox.connected_phones.next,
437
        phone = list_get_instance(TASK->answerbox.connected_phones.next,
391
            phone_t, link);
438
            phone_t, link);
392
        if (! spinlock_trylock(&phone->lock)) {
439
        if (! spinlock_trylock(&phone->lock)) {
393
            spinlock_unlock(&TASK->answerbox.lock);
440
            spinlock_unlock(&TASK->answerbox.lock);
394
            DEADLOCK_PROBE(p_phonelck, DEADLOCK_THRESHOLD);
441
            DEADLOCK_PROBE(p_phonelck, DEADLOCK_THRESHOLD);
395
            goto restart_phones;
442
            goto restart_phones;
396
        }
443
        }
397
       
444
       
398
        /* Disconnect phone */
445
        /* Disconnect phone */
399
        ASSERT(phone->state == IPC_PHONE_CONNECTED);
446
        ASSERT(phone->state == IPC_PHONE_CONNECTED);
400
        phone->state = IPC_PHONE_SLAMMED;
447
        phone->state = IPC_PHONE_SLAMMED;
401
        list_remove(&phone->link);
448
        list_remove(&phone->link);
402
 
449
 
403
        spinlock_unlock(&phone->lock);
450
        spinlock_unlock(&phone->lock);
404
    }
451
    }
405
 
452
 
406
    /* Answer all messages in 'calls' and 'dispatched_calls' queues */
453
    /* Answer all messages in 'calls' and 'dispatched_calls' queues */
407
    ipc_cleanup_call_list(&TASK->answerbox.dispatched_calls);
454
    ipc_cleanup_call_list(&TASK->answerbox.dispatched_calls);
408
    ipc_cleanup_call_list(&TASK->answerbox.calls);
455
    ipc_cleanup_call_list(&TASK->answerbox.calls);
409
    spinlock_unlock(&TASK->answerbox.lock);
456
    spinlock_unlock(&TASK->answerbox.lock);
410
   
457
   
411
    /* Wait for all async answers to arrive */
458
    /* Wait for all async answers to arrive */
412
    while (1) {
459
    while (1) {
413
        /* Go through all phones, until all are FREE... */
460
        /* Go through all phones, until all are FREE... */
414
        /* Locking not needed, no one else should modify
461
        /* Locking not needed, no one else should modify
415
         * it, when we are in cleanup */
462
         * it, when we are in cleanup */
416
        for (i=0;i < IPC_MAX_PHONES; i++) {
463
        for (i = 0; i < IPC_MAX_PHONES; i++) {
417
            if (TASK->phones[i].state == IPC_PHONE_HUNGUP && \
464
            if (TASK->phones[i].state == IPC_PHONE_HUNGUP &&
418
                atomic_get(&TASK->phones[i].active_calls) == 0)
465
                atomic_get(&TASK->phones[i].active_calls) == 0)
419
                TASK->phones[i].state = IPC_PHONE_FREE;
466
                TASK->phones[i].state = IPC_PHONE_FREE;
420
           
467
           
421
            /* Just for sure, we might have had some
468
            /* Just for sure, we might have had some
422
             * IPC_PHONE_CONNECTING phones */
469
             * IPC_PHONE_CONNECTING phones */
423
            if (TASK->phones[i].state == IPC_PHONE_CONNECTED)
470
            if (TASK->phones[i].state == IPC_PHONE_CONNECTED)
424
                ipc_phone_hangup(&TASK->phones[i]);
471
                ipc_phone_hangup(&TASK->phones[i]);
425
            /* If the hangup succeeded, it has sent a HANGUP
472
            /* If the hangup succeeded, it has sent a HANGUP
426
             * message, the IPC is now in HUNGUP state, we
473
             * message, the IPC is now in HUNGUP state, we
427
             * wait for the reply to come */
474
             * wait for the reply to come */
428
           
475
           
429
            if (TASK->phones[i].state != IPC_PHONE_FREE)
476
            if (TASK->phones[i].state != IPC_PHONE_FREE)
430
                break;
477
                break;
431
        }
478
        }
432
        /* Voila, got into cleanup */
479
        /* Voila, got into cleanup */
433
        if (i == IPC_MAX_PHONES)
480
        if (i == IPC_MAX_PHONES)
434
            break;
481
            break;
435
       
482
       
436
        call = ipc_wait_for_call(&TASK->answerbox, SYNCH_NO_TIMEOUT, SYNCH_FLAGS_NONE);
483
        call = ipc_wait_for_call(&TASK->answerbox, SYNCH_NO_TIMEOUT,
-
 
484
            SYNCH_FLAGS_NONE);
437
        ASSERT((call->flags & IPC_CALL_ANSWERED) || (call->flags & IPC_CALL_NOTIF));
485
        ASSERT((call->flags & IPC_CALL_ANSWERED) ||
-
 
486
            (call->flags & IPC_CALL_NOTIF));
438
        ASSERT(! (call->flags & IPC_CALL_STATIC_ALLOC));
487
        ASSERT(!(call->flags & IPC_CALL_STATIC_ALLOC));
439
       
488
       
440
        atomic_dec(&TASK->active_calls);
489
        atomic_dec(&TASK->active_calls);
441
        ipc_call_free(call);
490
        ipc_call_free(call);
442
    }
491
    }
443
}
492
}
444
 
493
 
445
 
494
 
446
/** Initilize IPC subsystem */
495
/** Initilize IPC subsystem */
447
void ipc_init(void)
496
void ipc_init(void)
448
{
497
{
449
    ipc_call_slab = slab_cache_create("ipc_call", sizeof(call_t), 0, NULL, NULL, 0);
498
    ipc_call_slab = slab_cache_create("ipc_call", sizeof(call_t), 0, NULL,
-
 
499
        NULL, 0);
450
}
500
}
451
 
501
 
452
 
502
 
453
/** Kconsole - list answerbox contents */
503
/** List answerbox contents.
-
 
504
 *
-
 
505
 * @param taskid    Task ID.
-
 
506
 */
454
void ipc_print_task(task_id_t taskid)
507
void ipc_print_task(task_id_t taskid)
455
{
508
{
456
    task_t *task;
509
    task_t *task;
457
    int i;
510
    int i;
458
    call_t *call;
511
    call_t *call;
459
    link_t *tmp;
512
    link_t *tmp;
460
   
513
   
461
    spinlock_lock(&tasks_lock);
514
    spinlock_lock(&tasks_lock);
462
    task = task_find_by_id(taskid);
515
    task = task_find_by_id(taskid);
463
    if (task)
516
    if (task)
464
        spinlock_lock(&task->lock);
517
        spinlock_lock(&task->lock);
465
    spinlock_unlock(&tasks_lock);
518
    spinlock_unlock(&tasks_lock);
466
    if (!task)
519
    if (!task)
467
        return;
520
        return;
468
 
521
 
469
    /* Print opened phones & details */
522
    /* Print opened phones & details */
470
    printf("PHONE:\n");
523
    printf("PHONE:\n");
471
    for (i=0; i < IPC_MAX_PHONES;i++) {
524
    for (i = 0; i < IPC_MAX_PHONES; i++) {
472
        spinlock_lock(&task->phones[i].lock);
525
        spinlock_lock(&task->phones[i].lock);
473
        if (task->phones[i].state != IPC_PHONE_FREE) {
526
        if (task->phones[i].state != IPC_PHONE_FREE) {
474
            printf("%d: ",i);
527
            printf("%d: ", i);
475
            switch (task->phones[i].state) {
528
            switch (task->phones[i].state) {
476
            case IPC_PHONE_CONNECTING:
529
            case IPC_PHONE_CONNECTING:
477
                printf("connecting ");
530
                printf("connecting ");
478
                break;
531
                break;
479
            case IPC_PHONE_CONNECTED:
532
            case IPC_PHONE_CONNECTED:
480
                printf("connected to: %p ",
533
                printf("connected to: %p ",
481
                       task->phones[i].callee);
534
                       task->phones[i].callee);
482
                break;
535
                break;
483
            case IPC_PHONE_SLAMMED:
536
            case IPC_PHONE_SLAMMED:
484
                printf("slammed by: %p ",
537
                printf("slammed by: %p ",
485
                       task->phones[i].callee);
538
                       task->phones[i].callee);
486
                break;
539
                break;
487
            case IPC_PHONE_HUNGUP:
540
            case IPC_PHONE_HUNGUP:
488
                printf("hung up - was: %p ",
541
                printf("hung up - was: %p ",
489
                       task->phones[i].callee);
542
                       task->phones[i].callee);
490
                break;
543
                break;
491
            default:
544
            default:
492
                break;
545
                break;
493
            }
546
            }
494
            printf("active: %d\n", atomic_get(&task->phones[i].active_calls));
547
            printf("active: %d\n", atomic_get(&task->phones[i].active_calls));
495
        }
548
        }
496
        spinlock_unlock(&task->phones[i].lock);
549
        spinlock_unlock(&task->phones[i].lock);
497
    }
550
    }
498
 
551
 
499
 
552
 
500
    /* Print answerbox - calls */
553
    /* Print answerbox - calls */
501
    spinlock_lock(&task->answerbox.lock);
554
    spinlock_lock(&task->answerbox.lock);
502
    printf("ABOX - CALLS:\n");
555
    printf("ABOX - CALLS:\n");
503
    for (tmp=task->answerbox.calls.next; tmp != &task->answerbox.calls;tmp = tmp->next) {
556
    for (tmp=task->answerbox.calls.next; tmp != &task->answerbox.calls;tmp = tmp->next) {
504
        call = list_get_instance(tmp, call_t, link);
557
        call = list_get_instance(tmp, call_t, link);
505
        printf("Callid: %p Srctask:%llu M:%d A1:%d A2:%d A3:%d Flags:%x\n",call,
558
        printf("Callid: %p Srctask:%llu M:%d A1:%d A2:%d A3:%d Flags:%x\n",call,
506
               call->sender->taskid, IPC_GET_METHOD(call->data), IPC_GET_ARG1(call->data),
559
               call->sender->taskid, IPC_GET_METHOD(call->data), IPC_GET_ARG1(call->data),
507
               IPC_GET_ARG2(call->data), IPC_GET_ARG3(call->data), call->flags);
560
               IPC_GET_ARG2(call->data), IPC_GET_ARG3(call->data), call->flags);
508
    }
561
    }
509
    /* Print answerbox - calls */
562
    /* Print answerbox - calls */
510
    printf("ABOX - DISPATCHED CALLS:\n");
563
    printf("ABOX - DISPATCHED CALLS:\n");
511
    for (tmp=task->answerbox.dispatched_calls.next;
564
    for (tmp=task->answerbox.dispatched_calls.next;
512
         tmp != &task->answerbox.dispatched_calls;
565
         tmp != &task->answerbox.dispatched_calls;
513
         tmp = tmp->next) {
566
         tmp = tmp->next) {
514
        call = list_get_instance(tmp, call_t, link);
567
        call = list_get_instance(tmp, call_t, link);
515
        printf("Callid: %p Srctask:%llu M:%d A1:%d A2:%d A3:%d Flags:%x\n",call,
568
        printf("Callid: %p Srctask:%llu M:%d A1:%d A2:%d A3:%d Flags:%x\n",call,
516
               call->sender->taskid, IPC_GET_METHOD(call->data), IPC_GET_ARG1(call->data),
569
               call->sender->taskid, IPC_GET_METHOD(call->data), IPC_GET_ARG1(call->data),
517
               IPC_GET_ARG2(call->data), IPC_GET_ARG3(call->data), call->flags);
570
               IPC_GET_ARG2(call->data), IPC_GET_ARG3(call->data), call->flags);
518
    }
571
    }
519
    /* Print answerbox - calls */
572
    /* Print answerbox - calls */
520
    printf("ABOX - ANSWERS:\n");
573
    printf("ABOX - ANSWERS:\n");
521
    for (tmp=task->answerbox.answers.next; tmp != &task->answerbox.answers; tmp = tmp->next) {
574
    for (tmp=task->answerbox.answers.next; tmp != &task->answerbox.answers; tmp = tmp->next) {
522
        call = list_get_instance(tmp, call_t, link);
575
        call = list_get_instance(tmp, call_t, link);
523
        printf("Callid:%p M:%d A1:%d A2:%d A3:%d Flags:%x\n",call,
576
        printf("Callid:%p M:%d A1:%d A2:%d A3:%d Flags:%x\n",call,
524
               IPC_GET_METHOD(call->data), IPC_GET_ARG1(call->data),
577
               IPC_GET_METHOD(call->data), IPC_GET_ARG1(call->data),
525
               IPC_GET_ARG2(call->data), IPC_GET_ARG3(call->data), call->flags);
578
               IPC_GET_ARG2(call->data), IPC_GET_ARG3(call->data), call->flags);
526
    }
579
    }
527
 
580
 
528
    spinlock_unlock(&task->answerbox.lock);
581
    spinlock_unlock(&task->answerbox.lock);
529
    spinlock_unlock(&task->lock);
582
    spinlock_unlock(&task->lock);
530
}
583
}
531
 
584
 
532
/** @}
585
/** @}
533
 */
586
 */
534
 
587