Subversion Repositories HelenOS

Rev

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

Rev Author Line No. Line
1027 palkovsky 1
/*
2071 jermar 2
 * Copyright (c) 2006 Ondrej Palkovsky
1027 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
 
1757 jermar 29
/** @addtogroup genericipc
1702 cejka 30
 * @{
31
 */
32
/** @file
33
 */
34
 
1027 palkovsky 35
#include <arch.h>
36
#include <proc/task.h>
1288 jermar 37
#include <proc/thread.h>
1027 palkovsky 38
#include <errno.h>
39
#include <memstr.h>
40
#include <debug.h>
41
#include <ipc/ipc.h>
42
#include <ipc/sysipc.h>
1281 palkovsky 43
#include <ipc/irq.h>
1072 palkovsky 44
#include <ipc/ipcrsc.h>
1258 palkovsky 45
#include <arch/interrupt.h>
1027 palkovsky 46
#include <print.h>
1288 jermar 47
#include <syscall/copy.h>
1297 jermar 48
#include <security/cap.h>
1329 palkovsky 49
#include <mm/as.h>
1875 jermar 50
#include <print.h>
1027 palkovsky 51
 
2494 jermar 52
/** Maximum buffer size allowed for IPC_M_DATA_SEND requests. */
53
#define DATA_SEND_LIMIT     (64 * 1024)
54
 
2471 jermar 55
#define GET_CHECK_PHONE(phone, phoneid, err) \
56
{ \
57
    if (phoneid > IPC_MAX_PHONES) { \
58
        err; \
59
    } \
60
    phone = &TASK->phones[phoneid]; \
1084 palkovsky 61
}
62
 
2471 jermar 63
#define STRUCT_TO_USPACE(dst, src)  copy_to_uspace(dst, src, sizeof(*(src)))
1084 palkovsky 64
 
2471 jermar 65
/** Decide if the method is a system method.
66
 *
67
 * @param method    Method to be decided.
68
 *
69
 * @return      Return 1 if the method is a system method.
70
 *          Otherwise return 0.
71
 */
2557 jermar 72
static inline int method_is_system(unative_t method)
1040 palkovsky 73
{
74
    if (method <= IPC_M_LAST_SYSTEM)
75
        return 1;
76
    return 0;
77
}
78
 
2471 jermar 79
/** Decide if the message with this method is forwardable.
1040 palkovsky 80
 *
81
 * - some system messages may be forwarded, for some of them
82
 *   it is useless
2471 jermar 83
 *
84
 * @param method    Method to be decided.
85
 *
86
 * @return      Return 1 if the method is forwardable.
87
 *          Otherwise return 0.
1040 palkovsky 88
 */
2557 jermar 89
static inline int method_is_forwardable(unative_t method)
1040 palkovsky 90
{
2494 jermar 91
    switch (method) {
92
    case IPC_M_PHONE_HUNGUP:
93
        /* This message is meant only for the original recipient. */
94
        return 0;
95
    default:
96
        return 1;
97
    }
1040 palkovsky 98
}
99
 
2557 jermar 100
/** Decide if the message with this method is immutable on forward.
101
 *
2601 jermar 102
 * - some system messages may be forwarded but their content cannot be altered
2557 jermar 103
 *
104
 * @param method    Method to be decided.
105
 *
106
 * @return      Return 1 if the method is immutable on forward.
107
 *          Otherwise return 0.
108
 */
109
static inline int method_is_immutable(unative_t method)
110
{
111
    switch (method) {
112
    case IPC_M_AS_AREA_SEND:
113
    case IPC_M_AS_AREA_RECV:
114
    case IPC_M_DATA_SEND:
115
        return 1;
116
        break;
117
    default:
118
        return 0;
119
    }
120
}
1027 palkovsky 121
 
2557 jermar 122
 
2471 jermar 123
/***********************************************************************
124
 * Functions that preprocess answer before sending it to the recepient.
125
 ***********************************************************************/
126
 
127
/** Decide if the caller (e.g. ipc_answer()) should save the old call contents
128
 * for answer_preprocess().
129
 *
130
 * @param call      Call structure to be decided.
131
 *
132
 * @return      Return 1 if the old call contents should be saved.
133
 *          Return 0 otherwise.
1027 palkovsky 134
 */
1088 palkovsky 135
static inline int answer_need_old(call_t *call)
1027 palkovsky 136
{
2494 jermar 137
    switch (IPC_GET_METHOD(call->data)) {
138
    case IPC_M_CONNECT_TO_ME:
139
    case IPC_M_CONNECT_ME_TO:
140
    case IPC_M_AS_AREA_SEND:
141
    case IPC_M_AS_AREA_RECV:
142
    case IPC_M_DATA_SEND:
1027 palkovsky 143
        return 1;
2494 jermar 144
    default:
145
        return 0;
146
    }
1027 palkovsky 147
}
148
 
2471 jermar 149
/** Interpret process answer as control information.
1428 palkovsky 150
 *
2471 jermar 151
 * This function is called directly after sys_ipc_answer().
152
 *
153
 * @param answer    Call structure with the answer.
154
 * @param olddata   Saved data of the request.
155
 *
156
 * @return      Return 0 on success or an error code.
1428 palkovsky 157
 */
1329 palkovsky 158
static inline int answer_preprocess(call_t *answer, ipc_data_t *olddata)
1027 palkovsky 159
{
160
    int phoneid;
161
 
1088 palkovsky 162
    if (IPC_GET_RETVAL(answer->data) == EHANGUP) {
1141 palkovsky 163
        /* In case of forward, hangup the forwared phone,
164
         * not the originator
165
         */
166
        spinlock_lock(&answer->data.phone->lock);
167
        spinlock_lock(&TASK->answerbox.lock);
1568 palkovsky 168
        if (answer->data.phone->state == IPC_PHONE_CONNECTED) {
1573 palkovsky 169
            list_remove(&answer->data.phone->link);
1568 palkovsky 170
            answer->data.phone->state = IPC_PHONE_SLAMMED;
1141 palkovsky 171
        }
172
        spinlock_unlock(&TASK->answerbox.lock);
173
        spinlock_unlock(&answer->data.phone->lock);
1088 palkovsky 174
    }
175
 
176
    if (!olddata)
1329 palkovsky 177
        return 0;
1088 palkovsky 178
 
1086 palkovsky 179
    if (IPC_GET_METHOD(*olddata) == IPC_M_CONNECT_TO_ME) {
1040 palkovsky 180
        phoneid = IPC_GET_ARG3(*olddata);
1027 palkovsky 181
        if (IPC_GET_RETVAL(answer->data)) {
182
            /* The connection was not accepted */
183
            phone_dealloc(phoneid);
1040 palkovsky 184
        } else {
1090 palkovsky 185
            /* The connection was accepted */
2359 jermar 186
            phone_connect(phoneid, &answer->sender->answerbox);
2471 jermar 187
            /* Set 'phone hash' as arg3 of response */
2359 jermar 188
            IPC_SET_ARG3(answer->data,
189
                (unative_t) &TASK->phones[phoneid]);
1027 palkovsky 190
        }
1086 palkovsky 191
    } else if (IPC_GET_METHOD(*olddata) == IPC_M_CONNECT_ME_TO) {
1060 palkovsky 192
        /* If the users accepted call, connect */
193
        if (!IPC_GET_RETVAL(answer->data)) {
2359 jermar 194
            ipc_phone_connect((phone_t *) IPC_GET_ARG3(*olddata),
195
                &TASK->answerbox);
1060 palkovsky 196
        }
1359 jermar 197
    } else if (IPC_GET_METHOD(*olddata) == IPC_M_AS_AREA_SEND) {
2359 jermar 198
        if (!IPC_GET_RETVAL(answer->data)) {
199
            /* Accepted, handle as_area receipt */
1413 jermar 200
            ipl_t ipl;
1461 palkovsky 201
            int rc;
1413 jermar 202
            as_t *as;
203
 
204
            ipl = interrupts_disable();
205
            spinlock_lock(&answer->sender->lock);
206
            as = answer->sender->as;
207
            spinlock_unlock(&answer->sender->lock);
208
            interrupts_restore(ipl);
209
 
2359 jermar 210
            rc = as_area_share(as, IPC_GET_ARG1(*olddata),
211
                IPC_GET_ARG2(*olddata), AS,
212
                IPC_GET_ARG1(answer->data), IPC_GET_ARG3(*olddata));
1461 palkovsky 213
            IPC_SET_RETVAL(answer->data, rc);
214
            return rc;
1329 palkovsky 215
        }
1428 palkovsky 216
    } else if (IPC_GET_METHOD(*olddata) == IPC_M_AS_AREA_RECV) {
217
        if (!IPC_GET_RETVAL(answer->data)) {
218
            ipl_t ipl;
219
            as_t *as;
1434 palkovsky 220
            int rc;
1428 palkovsky 221
 
222
            ipl = interrupts_disable();
223
            spinlock_lock(&answer->sender->lock);
224
            as = answer->sender->as;
225
            spinlock_unlock(&answer->sender->lock);
226
            interrupts_restore(ipl);
227
 
2359 jermar 228
            rc = as_area_share(AS, IPC_GET_ARG1(answer->data),
229
                IPC_GET_ARG2(*olddata), as, IPC_GET_ARG1(*olddata),
230
                IPC_GET_ARG2(answer->data));
1434 palkovsky 231
            IPC_SET_RETVAL(answer->data, rc);
1428 palkovsky 232
        }
2494 jermar 233
    } else if (IPC_GET_METHOD(*olddata) == IPC_M_DATA_SEND) {
234
        if (!IPC_GET_RETVAL(answer->data)) {
235
            int rc;
236
            uintptr_t dst;
237
            uintptr_t size;
238
 
239
            ASSERT(answer->buffer);
240
 
241
            dst = IPC_GET_ARG1(answer->data);
242
            size = IPC_GET_ARG3(answer->data);
243
 
244
            rc = copy_to_uspace((void *) dst, answer->buffer, size);
245
            if (rc != 0)
246
                IPC_SET_RETVAL(answer->data, rc);
247
            free(answer->buffer);
248
            answer->buffer = NULL;
249
        }
1027 palkovsky 250
    }
1329 palkovsky 251
    return 0;
1027 palkovsky 252
}
253
 
2471 jermar 254
/** Called before the request is sent.
1090 palkovsky 255
 *
2471 jermar 256
 * @param call      Call structure with the request.
257
 *
258
 * @return      Return 0 on success, ELIMIT or EPERM on error.
1090 palkovsky 259
 */
260
static int request_preprocess(call_t *call)
261
{
262
    int newphid;
1329 palkovsky 263
    size_t size;
2494 jermar 264
    uintptr_t src;
265
    int rc;
1090 palkovsky 266
 
267
    switch (IPC_GET_METHOD(call->data)) {
268
    case IPC_M_CONNECT_ME_TO:
269
        newphid = phone_alloc();
270
        if (newphid < 0)
271
            return ELIMIT;
272
        /* Set arg3 for server */
2359 jermar 273
        IPC_SET_ARG3(call->data, (unative_t) &TASK->phones[newphid]);
1090 palkovsky 274
        call->flags |= IPC_CALL_CONN_ME_TO;
2098 decky 275
        call->priv = newphid;
1090 palkovsky 276
        break;
1359 jermar 277
    case IPC_M_AS_AREA_SEND:
2556 jermar 278
        size = as_area_get_size(IPC_GET_ARG1(call->data));
2471 jermar 279
        if (!size)
1329 palkovsky 280
            return EPERM;
1417 jermar 281
        IPC_SET_ARG2(call->data, size);
1329 palkovsky 282
        break;
2494 jermar 283
    case IPC_M_DATA_SEND:
284
        src = IPC_GET_ARG2(call->data);
285
        size = IPC_GET_ARG3(call->data);
286
 
287
        if ((size <= 0) || (size > DATA_SEND_LIMIT))
288
            return ELIMIT;
289
 
290
        call->buffer = (uint8_t *) malloc(size, 0);
291
        rc = copy_from_uspace(call->buffer, (void *) src, size);
292
        if (rc != 0) {
293
            free(call->buffer);
294
            return rc;
295
        }
296
        break;
1090 palkovsky 297
    default:
298
        break;
299
    }
300
    return 0;
301
}
302
 
2471 jermar 303
/*******************************************************************************
304
 * Functions called to process received call/answer before passing it to uspace.
305
 *******************************************************************************/
306
 
307
/** Do basic kernel processing of received call answer.
308
 *
309
 * @param call      Call structure with the answer.
1027 palkovsky 310
 */
1090 palkovsky 311
static void process_answer(call_t *call)
1027 palkovsky 312
{
2359 jermar 313
    if (IPC_GET_RETVAL(call->data) == EHANGUP &&
314
        (call->flags & IPC_CALL_FORWARDED))
1088 palkovsky 315
        IPC_SET_RETVAL(call->data, EFORWARD);
1090 palkovsky 316
 
317
    if (call->flags & IPC_CALL_CONN_ME_TO) {
318
        if (IPC_GET_RETVAL(call->data))
2098 decky 319
            phone_dealloc(call->priv);
1090 palkovsky 320
        else
2098 decky 321
            IPC_SET_ARG3(call->data, call->priv);
1090 palkovsky 322
    }
1027 palkovsky 323
}
324
 
2471 jermar 325
/** Do basic kernel processing of received call request.
1027 palkovsky 326
 *
2471 jermar 327
 * @param box       Destination answerbox structure.
328
 * @param call      Call structure with the request.
329
 *
330
 * @return      Return 0 if the call should be passed to userspace.
331
 *          Return -1 if the call should be ignored.
1027 palkovsky 332
 */
2359 jermar 333
static int process_request(answerbox_t *box, call_t *call)
1027 palkovsky 334
{
335
    int phoneid;
336
 
1086 palkovsky 337
    if (IPC_GET_METHOD(call->data) == IPC_M_CONNECT_TO_ME) {
1040 palkovsky 338
        phoneid = phone_alloc();
1027 palkovsky 339
        if (phoneid < 0) { /* Failed to allocate phone */
340
            IPC_SET_RETVAL(call->data, ELIMIT);
2471 jermar 341
            ipc_answer(box, call);
1027 palkovsky 342
            return -1;
343
        }
344
        IPC_SET_ARG3(call->data, phoneid);
345
    }
346
    return 0;
347
}
348
 
2471 jermar 349
/** Make a fast call over IPC, wait for reply and return to user.
1027 palkovsky 350
 *
2615 jermar 351
 * This function can handle only three arguments of payload, but is faster than
352
 * the generic function (i.e. sys_ipc_call_sync_slow()).
2471 jermar 353
 *
354
 * @param phoneid   Phone handle for the call.
355
 * @param method    Method of the call.
356
 * @param arg1      Service-defined payload argument.
2615 jermar 357
 * @param arg2      Service-defined payload argument.
358
 * @param arg3      Service-defined payload argument.
2471 jermar 359
 * @param data      Address of userspace structure where the reply call will
360
 *          be stored.
361
 *
362
 * @return      Returns 0 on success.
363
 *          Return ENOENT if there is no such phone handle.
1027 palkovsky 364
 */
2359 jermar 365
unative_t sys_ipc_call_sync_fast(unative_t phoneid, unative_t method,
2615 jermar 366
    unative_t arg1, unative_t arg2, unative_t arg3, ipc_data_t *data)
1027 palkovsky 367
{
368
    call_t call;
369
    phone_t *phone;
1090 palkovsky 370
    int res;
2617 jermar 371
    int rc;
1027 palkovsky 372
 
1084 palkovsky 373
    GET_CHECK_PHONE(phone, phoneid, return ENOENT);
1027 palkovsky 374
 
1084 palkovsky 375
    ipc_call_static_init(&call);
1027 palkovsky 376
    IPC_SET_METHOD(call.data, method);
377
    IPC_SET_ARG1(call.data, arg1);
2615 jermar 378
    IPC_SET_ARG2(call.data, arg2);
379
    IPC_SET_ARG3(call.data, arg3);
1027 palkovsky 380
 
2471 jermar 381
    if (!(res = request_preprocess(&call))) {
1090 palkovsky 382
        ipc_call_sync(phone, &call);
383
        process_answer(&call);
2471 jermar 384
    } else {
1090 palkovsky 385
        IPC_SET_RETVAL(call.data, res);
2471 jermar 386
    }
2617 jermar 387
    rc = STRUCT_TO_USPACE(&data->args, &call.data.args);
388
    if (rc != 0)
389
        return rc;
1027 palkovsky 390
 
391
    return 0;
392
}
393
 
2471 jermar 394
/** Make a synchronous IPC call allowing to transmit the entire payload.
395
 *
396
 * @param phoneid   Phone handle for the call.
397
 * @param question  Userspace address of call data with the request.
2494 jermar 398
 * @param reply     Userspace address of call data where to store the
399
 *          answer.
2471 jermar 400
 *
401
 * @return      Zero on success or an error code.
402
 */
2615 jermar 403
unative_t sys_ipc_call_sync_slow(unative_t phoneid, ipc_data_t *question,
2359 jermar 404
    ipc_data_t *reply)
1027 palkovsky 405
{
406
    call_t call;
407
    phone_t *phone;
1090 palkovsky 408
    int res;
1288 jermar 409
    int rc;
1027 palkovsky 410
 
1084 palkovsky 411
    ipc_call_static_init(&call);
2359 jermar 412
    rc = copy_from_uspace(&call.data.args, &question->args,
413
        sizeof(call.data.args));
1288 jermar 414
    if (rc != 0)
1780 jermar 415
        return (unative_t) rc;
1040 palkovsky 416
 
1084 palkovsky 417
    GET_CHECK_PHONE(phone, phoneid, return ENOENT);
1072 palkovsky 418
 
2471 jermar 419
    if (!(res = request_preprocess(&call))) {
1090 palkovsky 420
        ipc_call_sync(phone, &call);
421
        process_answer(&call);
422
    } else
423
        IPC_SET_RETVAL(call.data, res);
1027 palkovsky 424
 
1288 jermar 425
    rc = STRUCT_TO_USPACE(&reply->args, &call.data.args);
426
    if (rc != 0)
427
        return rc;
1027 palkovsky 428
 
429
    return 0;
430
}
431
 
2471 jermar 432
/** Check that the task did not exceed the allowed limit of asynchronous calls.
1027 palkovsky 433
 *
2471 jermar 434
 * @return      Return 0 if limit not reached or -1 if limit exceeded.
1027 palkovsky 435
 */
436
static int check_call_limit(void)
437
{
438
    if (atomic_preinc(&TASK->active_calls) > IPC_MAX_ASYNC_CALLS) {
439
        atomic_dec(&TASK->active_calls);
440
        return -1;
441
    }
442
    return 0;
443
}
444
 
2471 jermar 445
/** Make a fast asynchronous call over IPC.
1027 palkovsky 446
 *
2471 jermar 447
 * This function can only handle two arguments of payload, but is faster than
448
 * the generic function sys_ipc_call_async().
449
 *
450
 * @param phoneid   Phone handle for the call.
451
 * @param method    Method of the call.
452
 * @param arg1      Service-defined payload argument.
453
 * @param arg2      Service-defined payload argument.
454
 *
455
 * @return      Return call hash on success.
456
 *          Return IPC_CALLRET_FATAL in case of a fatal error and
457
 *          IPC_CALLRET_TEMPORARY if there are too many pending
458
 *          asynchronous requests; answers should be handled first.
1027 palkovsky 459
 */
2359 jermar 460
unative_t sys_ipc_call_async_fast(unative_t phoneid, unative_t method,
461
    unative_t arg1, unative_t arg2)
1027 palkovsky 462
{
463
    call_t *call;
464
    phone_t *phone;
1090 palkovsky 465
    int res;
1027 palkovsky 466
 
467
    if (check_call_limit())
468
        return IPC_CALLRET_TEMPORARY;
469
 
1090 palkovsky 470
    GET_CHECK_PHONE(phone, phoneid, return IPC_CALLRET_FATAL);
1072 palkovsky 471
 
1258 palkovsky 472
    call = ipc_call_alloc(0);
1027 palkovsky 473
    IPC_SET_METHOD(call->data, method);
474
    IPC_SET_ARG1(call->data, arg1);
475
    IPC_SET_ARG2(call->data, arg2);
1669 palkovsky 476
    IPC_SET_ARG3(call->data, 0);
1027 palkovsky 477
 
2359 jermar 478
    if (!(res = request_preprocess(call)))
1090 palkovsky 479
        ipc_call(phone, call);
480
    else
481
        ipc_backsend_err(phone, call, res);
1027 palkovsky 482
 
1780 jermar 483
    return (unative_t) call;
1027 palkovsky 484
}
485
 
2471 jermar 486
/** Make an asynchronous IPC call allowing to transmit the entire payload.
1027 palkovsky 487
 *
2471 jermar 488
 * @param phoneid   Phone handle for the call.
489
 * @param data      Userspace address of call data with the request.
490
 *
491
 * @return      See sys_ipc_call_async_fast().
1027 palkovsky 492
 */
1780 jermar 493
unative_t sys_ipc_call_async(unative_t phoneid, ipc_data_t *data)
1027 palkovsky 494
{
495
    call_t *call;
496
    phone_t *phone;
1090 palkovsky 497
    int res;
1288 jermar 498
    int rc;
1027 palkovsky 499
 
1072 palkovsky 500
    if (check_call_limit())
501
        return IPC_CALLRET_TEMPORARY;
502
 
1090 palkovsky 503
    GET_CHECK_PHONE(phone, phoneid, return IPC_CALLRET_FATAL);
1027 palkovsky 504
 
1258 palkovsky 505
    call = ipc_call_alloc(0);
2359 jermar 506
    rc = copy_from_uspace(&call->data.args, &data->args,
507
        sizeof(call->data.args));
1293 palkovsky 508
    if (rc != 0) {
509
        ipc_call_free(call);
1780 jermar 510
        return (unative_t) rc;
1293 palkovsky 511
    }
2359 jermar 512
    if (!(res = request_preprocess(call)))
1090 palkovsky 513
        ipc_call(phone, call);
514
    else
515
        ipc_backsend_err(phone, call, res);
1040 palkovsky 516
 
1780 jermar 517
    return (unative_t) call;
1027 palkovsky 518
}
519
 
2471 jermar 520
/** Forward a received call to another destination.
1040 palkovsky 521
 *
2471 jermar 522
 * @param callid    Hash of the call to forward.
523
 * @param phoneid   Phone handle to use for forwarding.
524
 * @param method    New method to use for the forwarded call.
525
 * @param arg1      New value of the first argument for the forwarded call.
1060 palkovsky 526
 *
2471 jermar 527
 * @return      Return 0 on succes, otherwise return an error code.
528
 *
529
 * In case the original method is a system method, ARG1 and ARG2 are overwritten
530
 * in the forwarded message with the new method and the new arg1, respectively.
531
 * Otherwise the METHOD and ARG1 are rewritten with the new method and arg1,
2557 jermar 532
 * respectively. Also note there is a set of immutable methods, for which the
533
 * new method and argument is not set and these values are ignored.
2471 jermar 534
 *
1060 palkovsky 535
 * Warning: If implementing non-fast version, make sure that
2471 jermar 536
 *          ARG3 is not rewritten for certain system IPC
1040 palkovsky 537
 */
1780 jermar 538
unative_t sys_ipc_forward_fast(unative_t callid, unative_t phoneid,
2359 jermar 539
    unative_t method, unative_t arg1)
1040 palkovsky 540
{
541
    call_t *call;
542
    phone_t *phone;
543
 
544
    call = get_call(callid);
545
    if (!call)
546
        return ENOENT;
547
 
1088 palkovsky 548
    call->flags |= IPC_CALL_FORWARDED;
549
 
1084 palkovsky 550
    GET_CHECK_PHONE(phone, phoneid, {
1040 palkovsky 551
        IPC_SET_RETVAL(call->data, EFORWARD);
552
        ipc_answer(&TASK->answerbox, call);
553
        return ENOENT;
1084 palkovsky 554
    });    
1040 palkovsky 555
 
2557 jermar 556
    if (!method_is_forwardable(IPC_GET_METHOD(call->data))) {
1040 palkovsky 557
        IPC_SET_RETVAL(call->data, EFORWARD);
558
        ipc_answer(&TASK->answerbox, call);
559
        return EPERM;
560
    }
561
 
2557 jermar 562
    /*
563
     * Userspace is not allowed to change method of system methods on
564
     * forward, allow changing ARG1 and ARG2 by means of method and arg1.
565
     * If the method is immutable, don't change anything.
1040 palkovsky 566
     */
2557 jermar 567
    if (!method_is_immutable(IPC_GET_METHOD(call->data))) {
568
        if (method_is_system(IPC_GET_METHOD(call->data))) {
569
            if (IPC_GET_METHOD(call->data) == IPC_M_CONNECT_TO_ME)
570
                phone_dealloc(IPC_GET_ARG3(call->data));
1090 palkovsky 571
 
2557 jermar 572
            IPC_SET_ARG1(call->data, method);
573
            IPC_SET_ARG2(call->data, arg1);
574
        } else {
575
            IPC_SET_METHOD(call->data, method);
576
            IPC_SET_ARG1(call->data, arg1);
577
        }
1040 palkovsky 578
    }
579
 
1088 palkovsky 580
    return ipc_forward(call, phone, &TASK->answerbox);
1040 palkovsky 581
}
582
 
2471 jermar 583
/** Answer an IPC call - fast version.
584
 *
585
 * This function can handle only two return arguments of payload, but is faster
586
 * than the generic sys_ipc_answer().
587
 *
588
 * @param callid    Hash of the call to be answered.
589
 * @param retval    Return value of the answer.
590
 * @param arg1      Service-defined return value.
591
 * @param arg2      Service-defined return value.
592
 *
593
 * @return      Return 0 on success, otherwise return an error code.   
594
 */
2359 jermar 595
unative_t sys_ipc_answer_fast(unative_t callid, unative_t retval,
596
    unative_t arg1, unative_t arg2)
1027 palkovsky 597
{
598
    call_t *call;
1040 palkovsky 599
    ipc_data_t saved_data;
1088 palkovsky 600
    int saveddata = 0;
1329 palkovsky 601
    int rc;
1027 palkovsky 602
 
1346 palkovsky 603
    /* Do not answer notification callids */
604
    if (callid & IPC_CALLID_NOTIFICATION)
605
        return 0;
606
 
1040 palkovsky 607
    call = get_call(callid);
608
    if (!call)
609
        return ENOENT;
1027 palkovsky 610
 
1088 palkovsky 611
    if (answer_need_old(call)) {
1040 palkovsky 612
        memcpy(&saved_data, &call->data, sizeof(call->data));
1088 palkovsky 613
        saveddata = 1;
1027 palkovsky 614
    }
615
 
616
    IPC_SET_RETVAL(call->data, retval);
617
    IPC_SET_ARG1(call->data, arg1);
618
    IPC_SET_ARG2(call->data, arg2);
1329 palkovsky 619
    rc = answer_preprocess(call, saveddata ? &saved_data : NULL);
1040 palkovsky 620
 
1027 palkovsky 621
    ipc_answer(&TASK->answerbox, call);
1329 palkovsky 622
    return rc;
1027 palkovsky 623
}
624
 
2471 jermar 625
/** Answer an IPC call.
626
 *
627
 * @param callid    Hash of the call to be answered.
628
 * @param data      Userspace address of call data with the answer.
629
 *
630
 * @return      Return 0 on success, otherwise return an error code.
631
 */
1780 jermar 632
unative_t sys_ipc_answer(unative_t callid, ipc_data_t *data)
1027 palkovsky 633
{
634
    call_t *call;
1040 palkovsky 635
    ipc_data_t saved_data;
1088 palkovsky 636
    int saveddata = 0;
1288 jermar 637
    int rc;
1027 palkovsky 638
 
1346 palkovsky 639
    /* Do not answer notification callids */
640
    if (callid & IPC_CALLID_NOTIFICATION)
641
        return 0;
642
 
1040 palkovsky 643
    call = get_call(callid);
644
    if (!call)
645
        return ENOENT;
1027 palkovsky 646
 
1088 palkovsky 647
    if (answer_need_old(call)) {
1040 palkovsky 648
        memcpy(&saved_data, &call->data, sizeof(call->data));
1088 palkovsky 649
        saveddata = 1;
1027 palkovsky 650
    }
1288 jermar 651
    rc = copy_from_uspace(&call->data.args, &data->args,
2359 jermar 652
        sizeof(call->data.args));
1288 jermar 653
    if (rc != 0)
654
        return rc;
1027 palkovsky 655
 
1329 palkovsky 656
    rc = answer_preprocess(call, saveddata ? &saved_data : NULL);
1027 palkovsky 657
 
658
    ipc_answer(&TASK->answerbox, call);
659
 
1329 palkovsky 660
    return rc;
1027 palkovsky 661
}
662
 
2471 jermar 663
/** Hang up a phone.
1086 palkovsky 664
 *
2471 jermar 665
 * @param       Phone handle of the phone to be hung up.
666
 *
667
 * @return      Return 0 on success or an error code.
1086 palkovsky 668
 */
1780 jermar 669
unative_t sys_ipc_hangup(int phoneid)
1086 palkovsky 670
{
671
    phone_t *phone;
672
 
673
    GET_CHECK_PHONE(phone, phoneid, return ENOENT);
674
 
1591 palkovsky 675
    if (ipc_phone_hangup(phone))
1086 palkovsky 676
        return -1;
677
 
678
    return 0;
679
}
680
 
2471 jermar 681
/** Wait for an incoming IPC call or an answer.
1027 palkovsky 682
 *
2359 jermar 683
 * @param calldata  Pointer to buffer where the call/answer data is stored.
684
 * @param usec      Timeout. See waitq_sleep_timeout() for explanation.
685
 * @param flags     Select mode of sleep operation. See waitq_sleep_timeout()
686
 *          for explanation.
1364 jermar 687
 *
2471 jermar 688
 * @return      Hash of the call.
689
 *          If IPC_CALLID_NOTIFICATION bit is set in the hash, the
690
 *          call is a notification. IPC_CALLID_ANSWERED denotes an
691
 *          answer.
1027 palkovsky 692
 */
1780 jermar 693
unative_t sys_ipc_wait_for_call(ipc_data_t *calldata, uint32_t usec, int flags)
1027 palkovsky 694
{
695
    call_t *call;
696
 
697
restart:   
2359 jermar 698
    call = ipc_wait_for_call(&TASK->answerbox, usec,
699
        flags | SYNCH_FLAGS_INTERRUPTIBLE);
1088 palkovsky 700
    if (!call)
701
        return 0;
1027 palkovsky 702
 
1258 palkovsky 703
    if (call->flags & IPC_CALL_NOTIF) {
704
        ASSERT(! (call->flags & IPC_CALL_STATIC_ALLOC));
1693 palkovsky 705
 
706
        /* Set in_phone_hash to the interrupt counter */
2098 decky 707
        call->data.phone = (void *) call->priv;
1693 palkovsky 708
 
709
        STRUCT_TO_USPACE(calldata, &call->data);
710
 
1258 palkovsky 711
        ipc_call_free(call);
712
 
2471 jermar 713
        return ((unative_t) call) | IPC_CALLID_NOTIFICATION;
1258 palkovsky 714
    }
715
 
1027 palkovsky 716
    if (call->flags & IPC_CALL_ANSWERED) {
1090 palkovsky 717
        process_answer(call);
1027 palkovsky 718
 
1086 palkovsky 719
        ASSERT(! (call->flags & IPC_CALL_STATIC_ALLOC));
720
 
1027 palkovsky 721
        atomic_dec(&TASK->active_calls);
1086 palkovsky 722
 
723
        if (call->flags & IPC_CALL_DISCARD_ANSWER) {
724
            ipc_call_free(call);
725
            goto restart;
726
        }
727
 
728
        STRUCT_TO_USPACE(&calldata->args, &call->data.args);
1027 palkovsky 729
        ipc_call_free(call);
730
 
2471 jermar 731
        return ((unative_t) call) | IPC_CALLID_ANSWERED;
1027 palkovsky 732
    }
1086 palkovsky 733
 
1027 palkovsky 734
    if (process_request(&TASK->answerbox, call))
735
        goto restart;
1086 palkovsky 736
 
1090 palkovsky 737
    /* Include phone address('id') of the caller in the request,
738
     * copy whole call->data, not only call->data.args */
1396 palkovsky 739
    if (STRUCT_TO_USPACE(calldata, &call->data)) {
740
        return 0;
741
    }
1780 jermar 742
    return (unative_t)call;
1027 palkovsky 743
}
1258 palkovsky 744
 
2471 jermar 745
/** Connect an IRQ handler to a task.
1923 jermar 746
 *
2471 jermar 747
 * @param inr       IRQ number.
748
 * @param devno     Device number.
749
 * @param method    Method to be associated with the notification.
750
 * @param ucode     Uspace pointer to the top-half pseudocode.
1923 jermar 751
 *
2471 jermar 752
 * @return      EPERM or a return code returned by ipc_irq_register().
1923 jermar 753
 */
2359 jermar 754
unative_t sys_ipc_register_irq(inr_t inr, devno_t devno, unative_t method,
755
    irq_code_t *ucode)
1258 palkovsky 756
{
1297 jermar 757
    if (!(cap_get(TASK) & CAP_IRQ_REG))
758
        return EPERM;
759
 
1923 jermar 760
    return ipc_irq_register(&TASK->answerbox, inr, devno, method, ucode);
1258 palkovsky 761
}
762
 
2471 jermar 763
/** Disconnect an IRQ handler from a task.
1923 jermar 764
 *
2471 jermar 765
 * @param inr       IRQ number.
766
 * @param devno     Device number.
767
 *
768
 * @return      Zero on success or EPERM on error..
1923 jermar 769
 */
770
unative_t sys_ipc_unregister_irq(inr_t inr, devno_t devno)
1258 palkovsky 771
{
1297 jermar 772
    if (!(cap_get(TASK) & CAP_IRQ_REG))
773
        return EPERM;
774
 
1923 jermar 775
    ipc_irq_unregister(&TASK->answerbox, inr, devno);
1258 palkovsky 776
 
777
    return 0;
778
}
1702 cejka 779
 
1757 jermar 780
/** @}
1702 cejka 781
 */