Subversion Repositories HelenOS-historic

Rev

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

Rev Author Line No. Line
1027 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 <arch.h>
30
#include <proc/task.h>
1288 jermar 31
#include <proc/thread.h>
1027 palkovsky 32
#include <errno.h>
33
#include <memstr.h>
34
#include <debug.h>
35
#include <ipc/ipc.h>
36
#include <ipc/sysipc.h>
1281 palkovsky 37
#include <ipc/irq.h>
1072 palkovsky 38
#include <ipc/ipcrsc.h>
1258 palkovsky 39
#include <arch/interrupt.h>
1027 palkovsky 40
#include <print.h>
1288 jermar 41
#include <syscall/copy.h>
1027 palkovsky 42
 
1084 palkovsky 43
#define GET_CHECK_PHONE(phone,phoneid,err) { \
44
      if (phoneid > IPC_MAX_PHONES) { err; } \
45
      phone = &TASK->phones[phoneid]; \
46
}
47
 
1090 palkovsky 48
#define STRUCT_TO_USPACE(dst,src) copy_to_uspace(dst,src,sizeof(*(src)))
1084 palkovsky 49
 
1040 palkovsky 50
/** Return true if the method is a system method */
51
static inline int is_system_method(__native method)
52
{
53
    if (method <= IPC_M_LAST_SYSTEM)
54
        return 1;
55
    return 0;
56
}
57
 
58
/** Return true if the message with this method is forwardable
59
 *
60
 * - some system messages may be forwarded, for some of them
61
 *   it is useless
62
 */
63
static inline int is_forwardable(__native method)
64
{
1086 palkovsky 65
    if (method == IPC_M_PHONE_HUNGUP)
66
        return 0; /* This message is meant only for the receiver */
1040 palkovsky 67
    return 1;
68
}
69
 
1027 palkovsky 70
/****************************************************/
71
/* Functions that preprocess answer before sending
72
 * it to the recepient
73
 */
74
 
75
/** Return true if the caller (ipc_answer) should save
1088 palkovsky 76
 * the old call contents for answer_preprocess
1027 palkovsky 77
 */
1088 palkovsky 78
static inline int answer_need_old(call_t *call)
1027 palkovsky 79
{
1086 palkovsky 80
    if (IPC_GET_METHOD(call->data) == IPC_M_CONNECT_TO_ME)
1027 palkovsky 81
        return 1;
1086 palkovsky 82
    if (IPC_GET_METHOD(call->data) == IPC_M_CONNECT_ME_TO)
1060 palkovsky 83
        return 1;
1027 palkovsky 84
    return 0;
85
}
86
 
87
/** Interpret process answer as control information */
1040 palkovsky 88
static inline void answer_preprocess(call_t *answer, ipc_data_t *olddata)
1027 palkovsky 89
{
90
    int phoneid;
91
 
1088 palkovsky 92
    if (IPC_GET_RETVAL(answer->data) == EHANGUP) {
1141 palkovsky 93
        /* In case of forward, hangup the forwared phone,
94
         * not the originator
95
         */
96
        spinlock_lock(&answer->data.phone->lock);
97
        spinlock_lock(&TASK->answerbox.lock);
98
        if (answer->data.phone->callee) {
99
            list_remove(&answer->data.phone->list);
100
            answer->data.phone->callee = 0;
101
        }
102
        spinlock_unlock(&TASK->answerbox.lock);
103
        spinlock_unlock(&answer->data.phone->lock);
1088 palkovsky 104
    }
105
 
106
    if (!olddata)
107
        return;
108
 
1086 palkovsky 109
    if (IPC_GET_METHOD(*olddata) == IPC_M_CONNECT_TO_ME) {
1040 palkovsky 110
        phoneid = IPC_GET_ARG3(*olddata);
1027 palkovsky 111
        if (IPC_GET_RETVAL(answer->data)) {
112
            /* The connection was not accepted */
113
            phone_dealloc(phoneid);
1040 palkovsky 114
        } else {
1090 palkovsky 115
            /* The connection was accepted */
1040 palkovsky 116
            phone_connect(phoneid,&answer->sender->answerbox);
1090 palkovsky 117
            /* Set 'phone identification' as arg3 of response */
118
            IPC_SET_ARG3(answer->data, (__native)&TASK->phones[phoneid]);
1027 palkovsky 119
        }
1086 palkovsky 120
    } else if (IPC_GET_METHOD(*olddata) == IPC_M_CONNECT_ME_TO) {
1060 palkovsky 121
        /* If the users accepted call, connect */
122
        if (!IPC_GET_RETVAL(answer->data)) {
123
            ipc_phone_connect((phone_t *)IPC_GET_ARG3(*olddata),
124
                      &TASK->answerbox);
125
        }
1027 palkovsky 126
    }
127
}
128
 
1090 palkovsky 129
/** Called before the request is sent
130
 *
131
 * @return 0 - no error, -1 - report error to user
132
 */
133
static int request_preprocess(call_t *call)
134
{
135
    int newphid;
136
 
137
    switch (IPC_GET_METHOD(call->data)) {
138
    case IPC_M_CONNECT_ME_TO:
139
        newphid = phone_alloc();
140
        if (newphid < 0)
141
            return ELIMIT;
142
        /* Set arg3 for server */
143
        IPC_SET_ARG3(call->data, (__native)&TASK->phones[newphid]);
144
        call->flags |= IPC_CALL_CONN_ME_TO;
145
        call->private = newphid;
146
        break;
147
    default:
148
        break;
149
    }
150
    return 0;
151
}
152
 
1027 palkovsky 153
/****************************************************/
154
/* Functions called to process received call/answer
155
 * before passing to uspace
156
 */
157
 
158
/** Do basic kernel processing of received call answer */
1090 palkovsky 159
static void process_answer(call_t *call)
1027 palkovsky 160
{
1088 palkovsky 161
    if (IPC_GET_RETVAL(call->data) == EHANGUP && \
162
        call->flags & IPC_CALL_FORWARDED)
163
        IPC_SET_RETVAL(call->data, EFORWARD);
1090 palkovsky 164
 
165
    if (call->flags & IPC_CALL_CONN_ME_TO) {
166
        if (IPC_GET_RETVAL(call->data))
167
            phone_dealloc(call->private);
168
        else
169
            IPC_SET_ARG3(call->data, call->private);
170
    }
1027 palkovsky 171
}
172
 
173
/** Do basic kernel processing of received call request
174
 *
175
 * @return 0 - the call should be passed to userspace, 1 - ignore call
176
 */
177
static int process_request(answerbox_t *box,call_t *call)
178
{
179
    int phoneid;
180
 
1086 palkovsky 181
    if (IPC_GET_METHOD(call->data) == IPC_M_CONNECT_TO_ME) {
1040 palkovsky 182
        phoneid = phone_alloc();
1027 palkovsky 183
        if (phoneid < 0) { /* Failed to allocate phone */
184
            IPC_SET_RETVAL(call->data, ELIMIT);
185
            ipc_answer(box,call);
186
            return -1;
187
        }
188
        IPC_SET_ARG3(call->data, phoneid);
189
    }
190
    return 0;
191
}
192
 
193
/** Send a call over IPC, wait for reply, return to user
194
 *
195
 * @return Call identification, returns -1 on fatal error,
196
           -2 on 'Too many async request, handle answers first
197
 */
198
__native sys_ipc_call_sync_fast(__native phoneid, __native method,
1086 palkovsky 199
                __native arg1, ipc_data_t *data)
1027 palkovsky 200
{
201
    call_t call;
202
    phone_t *phone;
1090 palkovsky 203
    int res;
1027 palkovsky 204
 
1084 palkovsky 205
    GET_CHECK_PHONE(phone, phoneid, return ENOENT);
1027 palkovsky 206
 
1084 palkovsky 207
    ipc_call_static_init(&call);
1027 palkovsky 208
    IPC_SET_METHOD(call.data, method);
209
    IPC_SET_ARG1(call.data, arg1);
210
 
1090 palkovsky 211
    if (!(res=request_preprocess(&call))) {
212
        ipc_call_sync(phone, &call);
213
        process_answer(&call);
214
    } else
215
        IPC_SET_RETVAL(call.data, res);
1086 palkovsky 216
    STRUCT_TO_USPACE(&data->args, &call.data.args);
1027 palkovsky 217
 
218
    return 0;
219
}
220
 
221
/** Synchronous IPC call allowing to send whole message */
1086 palkovsky 222
__native sys_ipc_call_sync(__native phoneid, ipc_data_t *question,
223
               ipc_data_t *reply)
1027 palkovsky 224
{
225
    call_t call;
226
    phone_t *phone;
1090 palkovsky 227
    int res;
1288 jermar 228
    int rc;
1027 palkovsky 229
 
1084 palkovsky 230
    ipc_call_static_init(&call);
1288 jermar 231
    rc = copy_from_uspace(&call.data.args, &question->args, sizeof(call.data.args));
232
    if (rc != 0)
233
        return (__native) rc;
1040 palkovsky 234
 
1084 palkovsky 235
    GET_CHECK_PHONE(phone, phoneid, return ENOENT);
1072 palkovsky 236
 
1090 palkovsky 237
    if (!(res=request_preprocess(&call))) {
238
        ipc_call_sync(phone, &call);
239
        process_answer(&call);
240
    } else
241
        IPC_SET_RETVAL(call.data, res);
1027 palkovsky 242
 
1288 jermar 243
    rc = STRUCT_TO_USPACE(&reply->args, &call.data.args);
244
    if (rc != 0)
245
        return rc;
1027 palkovsky 246
 
247
    return 0;
248
}
249
 
250
/** Check that the task did not exceed allowed limit
251
 *
252
 * @return 0 - Limit OK,   -1 - limit exceeded
253
 */
254
static int check_call_limit(void)
255
{
256
    if (atomic_preinc(&TASK->active_calls) > IPC_MAX_ASYNC_CALLS) {
257
        atomic_dec(&TASK->active_calls);
258
        return -1;
259
    }
260
    return 0;
261
}
262
 
263
/** Send an asynchronous call over ipc
264
 *
265
 * @return Call identification, returns -1 on fatal error,
266
           -2 on 'Too many async request, handle answers first
267
 */
268
__native sys_ipc_call_async_fast(__native phoneid, __native method,
269
                 __native arg1, __native arg2)
270
{
271
    call_t *call;
272
    phone_t *phone;
1090 palkovsky 273
    int res;
1027 palkovsky 274
 
275
    if (check_call_limit())
276
        return IPC_CALLRET_TEMPORARY;
277
 
1090 palkovsky 278
    GET_CHECK_PHONE(phone, phoneid, return IPC_CALLRET_FATAL);
1072 palkovsky 279
 
1258 palkovsky 280
    call = ipc_call_alloc(0);
1027 palkovsky 281
    IPC_SET_METHOD(call->data, method);
282
    IPC_SET_ARG1(call->data, arg1);
283
    IPC_SET_ARG2(call->data, arg2);
284
 
1090 palkovsky 285
    if (!(res=request_preprocess(call)))
286
        ipc_call(phone, call);
287
    else
288
        ipc_backsend_err(phone, call, res);
1027 palkovsky 289
 
290
    return (__native) call;
291
}
292
 
293
/** Synchronous IPC call allowing to send whole message
294
 *
295
 * @return The same as sys_ipc_call_async
296
 */
1086 palkovsky 297
__native sys_ipc_call_async(__native phoneid, ipc_data_t *data)
1027 palkovsky 298
{
299
    call_t *call;
300
    phone_t *phone;
1090 palkovsky 301
    int res;
1288 jermar 302
    int rc;
1027 palkovsky 303
 
1072 palkovsky 304
    if (check_call_limit())
305
        return IPC_CALLRET_TEMPORARY;
306
 
1090 palkovsky 307
    GET_CHECK_PHONE(phone, phoneid, return IPC_CALLRET_FATAL);
1027 palkovsky 308
 
1258 palkovsky 309
    call = ipc_call_alloc(0);
1288 jermar 310
    rc = copy_from_uspace(&call->data.args, &data->args, sizeof(call->data.args));
311
    if (rc != 0)
312
        return (__native) rc;
1090 palkovsky 313
    if (!(res=request_preprocess(call)))
314
        ipc_call(phone, call);
315
    else
316
        ipc_backsend_err(phone, call, res);
1040 palkovsky 317
 
1027 palkovsky 318
    return (__native) call;
319
}
320
 
1040 palkovsky 321
/** Forward received call to another destination
322
 *
323
 * The arg1 and arg2 are changed in the forwarded message
1060 palkovsky 324
 *
325
 * Warning: If implementing non-fast version, make sure that
326
 *          arg3 is not rewritten for certain system IPC
1040 palkovsky 327
 */
328
__native sys_ipc_forward_fast(__native callid, __native phoneid,
329
                  __native method, __native arg1)
330
{
331
    call_t *call;
332
    phone_t *phone;
333
 
334
    call = get_call(callid);
335
    if (!call)
336
        return ENOENT;
337
 
1088 palkovsky 338
    call->flags |= IPC_CALL_FORWARDED;
339
 
1084 palkovsky 340
    GET_CHECK_PHONE(phone, phoneid, {
1040 palkovsky 341
        IPC_SET_RETVAL(call->data, EFORWARD);
342
        ipc_answer(&TASK->answerbox, call);
343
        return ENOENT;
1084 palkovsky 344
    });    
1040 palkovsky 345
 
346
    if (!is_forwardable(IPC_GET_METHOD(call->data))) {
347
        IPC_SET_RETVAL(call->data, EFORWARD);
348
        ipc_answer(&TASK->answerbox, call);
349
        return EPERM;
350
    }
351
 
352
    /* Userspace is not allowed to change method of system methods
353
     * on forward, allow changing ARG1 and ARG2 by means of method and arg1
354
     */
355
    if (is_system_method(IPC_GET_METHOD(call->data))) {
1090 palkovsky 356
        if (IPC_GET_METHOD(call->data) == IPC_M_CONNECT_TO_ME)
357
            phone_dealloc(IPC_GET_ARG3(call->data));
358
 
1040 palkovsky 359
        IPC_SET_ARG1(call->data, method);
360
        IPC_SET_ARG2(call->data, arg1);
361
    } else {
362
        IPC_SET_METHOD(call->data, method);
363
        IPC_SET_ARG1(call->data, arg1);
364
    }
365
 
1088 palkovsky 366
    return ipc_forward(call, phone, &TASK->answerbox);
1040 palkovsky 367
}
368
 
1027 palkovsky 369
/** Send IPC answer */
370
__native sys_ipc_answer_fast(__native callid, __native retval,
371
                 __native arg1, __native arg2)
372
{
373
    call_t *call;
1040 palkovsky 374
    ipc_data_t saved_data;
1088 palkovsky 375
    int saveddata = 0;
1027 palkovsky 376
 
1040 palkovsky 377
    call = get_call(callid);
378
    if (!call)
379
        return ENOENT;
1027 palkovsky 380
 
1088 palkovsky 381
    if (answer_need_old(call)) {
1040 palkovsky 382
        memcpy(&saved_data, &call->data, sizeof(call->data));
1088 palkovsky 383
        saveddata = 1;
1027 palkovsky 384
    }
385
 
386
    IPC_SET_RETVAL(call->data, retval);
387
    IPC_SET_ARG1(call->data, arg1);
388
    IPC_SET_ARG2(call->data, arg2);
1088 palkovsky 389
    answer_preprocess(call, saveddata ? &saved_data : NULL);
1040 palkovsky 390
 
1027 palkovsky 391
    ipc_answer(&TASK->answerbox, call);
392
    return 0;
393
}
394
 
395
/** Send IPC answer */
1086 palkovsky 396
__native sys_ipc_answer(__native callid, ipc_data_t *data)
1027 palkovsky 397
{
398
    call_t *call;
1040 palkovsky 399
    ipc_data_t saved_data;
1088 palkovsky 400
    int saveddata = 0;
1288 jermar 401
    int rc;
1027 palkovsky 402
 
1040 palkovsky 403
    call = get_call(callid);
404
    if (!call)
405
        return ENOENT;
1027 palkovsky 406
 
1088 palkovsky 407
    if (answer_need_old(call)) {
1040 palkovsky 408
        memcpy(&saved_data, &call->data, sizeof(call->data));
1088 palkovsky 409
        saveddata = 1;
1027 palkovsky 410
    }
1288 jermar 411
    rc = copy_from_uspace(&call->data.args, &data->args,
1086 palkovsky 412
             sizeof(call->data.args));
1288 jermar 413
    if (rc != 0)
414
        return rc;
1027 palkovsky 415
 
1088 palkovsky 416
    answer_preprocess(call, saveddata ? &saved_data : NULL);
1027 palkovsky 417
 
418
    ipc_answer(&TASK->answerbox, call);
419
 
420
    return 0;
421
}
422
 
1086 palkovsky 423
/** Hang up the phone
424
 *
425
 */
426
__native sys_ipc_hangup(int phoneid)
427
{
428
    phone_t *phone;
429
 
430
    GET_CHECK_PHONE(phone, phoneid, return ENOENT);
431
 
432
    if (ipc_phone_hangup(phone))
433
        return -1;
434
 
435
    return 0;
436
}
437
 
1027 palkovsky 438
/** Wait for incoming ipc call or answer
439
 *
1086 palkovsky 440
 * @param calldata Pointer to buffer where the call/answer data is stored
1027 palkovsky 441
 * @param flags
442
 * @return Callid, if callid & 1, then the call is answer
443
 */
1090 palkovsky 444
__native sys_ipc_wait_for_call(ipc_data_t *calldata, __native flags)
1027 palkovsky 445
{
446
    call_t *call;
447
 
448
restart:   
449
    call = ipc_wait_for_call(&TASK->answerbox, flags);
1088 palkovsky 450
    if (!call)
451
        return 0;
1027 palkovsky 452
 
1258 palkovsky 453
    if (call->flags & IPC_CALL_NOTIF) {
454
        ASSERT(! (call->flags & IPC_CALL_STATIC_ALLOC));
455
        STRUCT_TO_USPACE(&calldata->args, &call->data.args);
456
        ipc_call_free(call);
457
 
458
        return ((__native)call) | IPC_CALLID_NOTIFICATION;
459
    }
460
 
1027 palkovsky 461
    if (call->flags & IPC_CALL_ANSWERED) {
1090 palkovsky 462
        process_answer(call);
1027 palkovsky 463
 
1086 palkovsky 464
        ASSERT(! (call->flags & IPC_CALL_STATIC_ALLOC));
465
 
1027 palkovsky 466
        atomic_dec(&TASK->active_calls);
1086 palkovsky 467
 
468
        if (call->flags & IPC_CALL_DISCARD_ANSWER) {
469
            ipc_call_free(call);
470
            goto restart;
471
        }
472
 
473
        STRUCT_TO_USPACE(&calldata->args, &call->data.args);
1027 palkovsky 474
        ipc_call_free(call);
475
 
476
        return ((__native)call) | IPC_CALLID_ANSWERED;
477
    }
1086 palkovsky 478
 
1027 palkovsky 479
    if (process_request(&TASK->answerbox, call))
480
        goto restart;
1086 palkovsky 481
 
1090 palkovsky 482
    /* Include phone address('id') of the caller in the request,
483
     * copy whole call->data, not only call->data.args */
1086 palkovsky 484
    STRUCT_TO_USPACE(calldata, &call->data);
1027 palkovsky 485
    return (__native)call;
486
}
1258 palkovsky 487
 
488
/** Connect irq handler to task */
1281 palkovsky 489
__native sys_ipc_register_irq(__native irq, irq_code_t *ucode)
1258 palkovsky 490
{
491
    if (irq >= IRQ_COUNT)
492
        return -ELIMIT;
493
 
494
    irq_ipc_bind_arch(irq);
1281 palkovsky 495
 
496
    return ipc_irq_register(&TASK->answerbox, irq, ucode);
1258 palkovsky 497
}
498
 
499
/* Disconnect irq handler from task */
500
__native sys_ipc_unregister_irq(__native irq)
501
{
502
    if (irq >= IRQ_COUNT)
503
        return -ELIMIT;
504
 
505
    ipc_irq_unregister(&TASK->answerbox, irq);
506
 
507
    return 0;
508
}