Subversion Repositories HelenOS

Rev

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