Subversion Repositories HelenOS

Rev

Rev 3492 | 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>
3492 rimsky 45
#include <ipc/kbox.h>
46
#include <udebug/udebug_ipc.h>
1258 palkovsky 47
#include <arch/interrupt.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
         */
3020 jermar 172
        mutex_lock(&answer->data.phone->lock);
1141 palkovsky 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);
3020 jermar 179
        mutex_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);
2934 jermar 247
            if (size && size <= max_size) {
2662 jermar 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
                }
2934 jermar 262
            } else if (!size) {
263
                IPC_SET_RETVAL(answer->data, EOK);
2662 jermar 264
            } else {
265
                IPC_SET_RETVAL(answer->data, ELIMIT);
266
            }
267
        }
2660 jermar 268
    } else if (IPC_GET_METHOD(*olddata) == IPC_M_DATA_WRITE) {
2661 jermar 269
        ASSERT(answer->buffer);
2494 jermar 270
        if (!IPC_GET_RETVAL(answer->data)) {
2662 jermar 271
            /* The recipient agreed to receive data. */
2494 jermar 272
            int rc;
273
            uintptr_t dst;
3332 jermar 274
            size_t size;
275
            size_t max_size;
2494 jermar 276
 
3332 jermar 277
            dst = (uintptr_t)IPC_GET_ARG1(answer->data);
278
            size = (size_t)IPC_GET_ARG2(answer->data);
279
            max_size = (size_t)IPC_GET_ARG2(*olddata);
2494 jermar 280
 
2662 jermar 281
            if (size <= max_size) {
282
                rc = copy_to_uspace((void *) dst,
283
                    answer->buffer, size);
284
                if (rc)
285
                    IPC_SET_RETVAL(answer->data, rc);
286
            } else {
287
                IPC_SET_RETVAL(answer->data, ELIMIT);
288
            }
2494 jermar 289
        }
2661 jermar 290
        free(answer->buffer);
291
        answer->buffer = NULL;
1027 palkovsky 292
    }
1329 palkovsky 293
    return 0;
1027 palkovsky 294
}
295
 
2471 jermar 296
/** Called before the request is sent.
1090 palkovsky 297
 *
2471 jermar 298
 * @param call      Call structure with the request.
3492 rimsky 299
 * @param phone     Phone that the call will be sent through.
2471 jermar 300
 *
301
 * @return      Return 0 on success, ELIMIT or EPERM on error.
1090 palkovsky 302
 */
3492 rimsky 303
static int request_preprocess(call_t *call, phone_t *phone)
1090 palkovsky 304
{
305
    int newphid;
1329 palkovsky 306
    size_t size;
2494 jermar 307
    uintptr_t src;
308
    int rc;
1090 palkovsky 309
 
310
    switch (IPC_GET_METHOD(call->data)) {
311
    case IPC_M_CONNECT_ME_TO:
312
        newphid = phone_alloc();
313
        if (newphid < 0)
314
            return ELIMIT;
2638 jermar 315
        /* Set arg5 for server */
2635 cejka 316
        IPC_SET_ARG5(call->data, (unative_t) &TASK->phones[newphid]);
1090 palkovsky 317
        call->flags |= IPC_CALL_CONN_ME_TO;
2098 decky 318
        call->priv = newphid;
1090 palkovsky 319
        break;
2677 jermar 320
    case IPC_M_SHARE_OUT:
2556 jermar 321
        size = as_area_get_size(IPC_GET_ARG1(call->data));
2471 jermar 322
        if (!size)
1329 palkovsky 323
            return EPERM;
1417 jermar 324
        IPC_SET_ARG2(call->data, size);
1329 palkovsky 325
        break;
2662 jermar 326
    case IPC_M_DATA_READ:
327
        size = IPC_GET_ARG2(call->data);
328
        if ((size <= 0 || (size > DATA_XFER_LIMIT)))
329
            return ELIMIT;
330
        break;
2660 jermar 331
    case IPC_M_DATA_WRITE:
2676 jermar 332
        src = IPC_GET_ARG1(call->data);
333
        size = IPC_GET_ARG2(call->data);
2494 jermar 334
 
2660 jermar 335
        if ((size <= 0) || (size > DATA_XFER_LIMIT))
2494 jermar 336
            return ELIMIT;
337
 
338
        call->buffer = (uint8_t *) malloc(size, 0);
339
        rc = copy_from_uspace(call->buffer, (void *) src, size);
340
        if (rc != 0) {
341
            free(call->buffer);
342
            return rc;
343
        }
344
        break;
3492 rimsky 345
#ifdef CONFIG_UDEBUG
346
    case IPC_M_DEBUG_ALL:
347
        return udebug_request_preprocess(call, phone);
348
#endif
1090 palkovsky 349
    default:
350
        break;
351
    }
352
    return 0;
353
}
354
 
2471 jermar 355
/*******************************************************************************
356
 * Functions called to process received call/answer before passing it to uspace.
357
 *******************************************************************************/
358
 
359
/** Do basic kernel processing of received call answer.
360
 *
361
 * @param call      Call structure with the answer.
1027 palkovsky 362
 */
1090 palkovsky 363
static void process_answer(call_t *call)
1027 palkovsky 364
{
2745 decky 365
    if (((native_t) IPC_GET_RETVAL(call->data) == EHANGUP) &&
2359 jermar 366
        (call->flags & IPC_CALL_FORWARDED))
1088 palkovsky 367
        IPC_SET_RETVAL(call->data, EFORWARD);
1090 palkovsky 368
 
369
    if (call->flags & IPC_CALL_CONN_ME_TO) {
370
        if (IPC_GET_RETVAL(call->data))
2098 decky 371
            phone_dealloc(call->priv);
1090 palkovsky 372
        else
2635 cejka 373
            IPC_SET_ARG5(call->data, call->priv);
1090 palkovsky 374
    }
2662 jermar 375
 
376
    if (call->buffer) {
377
        /* This must be an affirmative answer to IPC_M_DATA_READ. */
3492 rimsky 378
        /* or IPC_M_DEBUG_ALL/UDEBUG_M_MEM_READ... */
2662 jermar 379
        uintptr_t dst = IPC_GET_ARG1(call->data);
380
        size_t size = IPC_GET_ARG2(call->data);
381
        int rc = copy_to_uspace((void *) dst, call->buffer, size);
382
        if (rc)
383
            IPC_SET_RETVAL(call->data, rc);
384
        free(call->buffer);
385
        call->buffer = NULL;
386
    }
1027 palkovsky 387
}
388
 
2471 jermar 389
/** Do basic kernel processing of received call request.
1027 palkovsky 390
 *
2471 jermar 391
 * @param box       Destination answerbox structure.
392
 * @param call      Call structure with the request.
393
 *
394
 * @return      Return 0 if the call should be passed to userspace.
395
 *          Return -1 if the call should be ignored.
1027 palkovsky 396
 */
2359 jermar 397
static int process_request(answerbox_t *box, call_t *call)
1027 palkovsky 398
{
399
    int phoneid;
400
 
1086 palkovsky 401
    if (IPC_GET_METHOD(call->data) == IPC_M_CONNECT_TO_ME) {
1040 palkovsky 402
        phoneid = phone_alloc();
1027 palkovsky 403
        if (phoneid < 0) { /* Failed to allocate phone */
404
            IPC_SET_RETVAL(call->data, ELIMIT);
2471 jermar 405
            ipc_answer(box, call);
1027 palkovsky 406
            return -1;
407
        }
2637 cejka 408
        IPC_SET_ARG5(call->data, phoneid);
3492 rimsky 409
    }
410
    switch (IPC_GET_METHOD(call->data)) {
411
    case IPC_M_DEBUG_ALL:
412
        return -1;
413
    default:
414
        break;
415
    }
1027 palkovsky 416
    return 0;
417
}
418
 
2471 jermar 419
/** Make a fast call over IPC, wait for reply and return to user.
1027 palkovsky 420
 *
2615 jermar 421
 * This function can handle only three arguments of payload, but is faster than
422
 * the generic function (i.e. sys_ipc_call_sync_slow()).
2471 jermar 423
 *
424
 * @param phoneid   Phone handle for the call.
425
 * @param method    Method of the call.
426
 * @param arg1      Service-defined payload argument.
2615 jermar 427
 * @param arg2      Service-defined payload argument.
428
 * @param arg3      Service-defined payload argument.
2471 jermar 429
 * @param data      Address of userspace structure where the reply call will
430
 *          be stored.
431
 *
432
 * @return      Returns 0 on success.
433
 *          Return ENOENT if there is no such phone handle.
1027 palkovsky 434
 */
2359 jermar 435
unative_t sys_ipc_call_sync_fast(unative_t phoneid, unative_t method,
2615 jermar 436
    unative_t arg1, unative_t arg2, unative_t arg3, ipc_data_t *data)
1027 palkovsky 437
{
438
    call_t call;
439
    phone_t *phone;
1090 palkovsky 440
    int res;
2617 jermar 441
    int rc;
3054 decky 442
 
1084 palkovsky 443
    GET_CHECK_PHONE(phone, phoneid, return ENOENT);
1027 palkovsky 444
 
1084 palkovsky 445
    ipc_call_static_init(&call);
1027 palkovsky 446
    IPC_SET_METHOD(call.data, method);
447
    IPC_SET_ARG1(call.data, arg1);
2615 jermar 448
    IPC_SET_ARG2(call.data, arg2);
449
    IPC_SET_ARG3(call.data, arg3);
2620 jermar 450
    /*
451
     * To achieve deterministic behavior, zero out arguments that are beyond
452
     * the limits of the fast version.
453
     */
454
    IPC_SET_ARG4(call.data, 0);
455
    IPC_SET_ARG5(call.data, 0);
1027 palkovsky 456
 
3492 rimsky 457
    if (!(res = request_preprocess(&call, phone))) {
3665 rimsky 458
#ifdef CONFIG_UDEBUG
459
        udebug_stoppable_begin();
460
#endif
3397 rimsky 461
        rc = ipc_call_sync(phone, &call);
3665 rimsky 462
#ifdef CONFIG_UDEBUG
463
        udebug_stoppable_end();
464
#endif
3397 rimsky 465
        if (rc != EOK)
466
            return rc;
1090 palkovsky 467
        process_answer(&call);
3665 rimsky 468
 
2471 jermar 469
    } else {
1090 palkovsky 470
        IPC_SET_RETVAL(call.data, res);
2471 jermar 471
    }
2617 jermar 472
    rc = STRUCT_TO_USPACE(&data->args, &call.data.args);
473
    if (rc != 0)
474
        return rc;
1027 palkovsky 475
 
476
    return 0;
477
}
478
 
2471 jermar 479
/** Make a synchronous IPC call allowing to transmit the entire payload.
480
 *
481
 * @param phoneid   Phone handle for the call.
482
 * @param question  Userspace address of call data with the request.
2494 jermar 483
 * @param reply     Userspace address of call data where to store the
484
 *          answer.
2471 jermar 485
 *
486
 * @return      Zero on success or an error code.
487
 */
2615 jermar 488
unative_t sys_ipc_call_sync_slow(unative_t phoneid, ipc_data_t *question,
2359 jermar 489
    ipc_data_t *reply)
1027 palkovsky 490
{
491
    call_t call;
492
    phone_t *phone;
1090 palkovsky 493
    int res;
1288 jermar 494
    int rc;
1027 palkovsky 495
 
1084 palkovsky 496
    ipc_call_static_init(&call);
2359 jermar 497
    rc = copy_from_uspace(&call.data.args, &question->args,
498
        sizeof(call.data.args));
1288 jermar 499
    if (rc != 0)
1780 jermar 500
        return (unative_t) rc;
1040 palkovsky 501
 
1084 palkovsky 502
    GET_CHECK_PHONE(phone, phoneid, return ENOENT);
1072 palkovsky 503
 
3492 rimsky 504
    if (!(res = request_preprocess(&call, phone))) {
3665 rimsky 505
#ifdef CONFIG_UDEBUG
506
        udebug_stoppable_begin();
507
#endif
3397 rimsky 508
        rc = ipc_call_sync(phone, &call);
3665 rimsky 509
#ifdef CONFIG_UDEBUG
510
        udebug_stoppable_end();
511
#endif
3397 rimsky 512
        if (rc != EOK)
513
            return rc;
1090 palkovsky 514
        process_answer(&call);
515
    } else
516
        IPC_SET_RETVAL(call.data, res);
1027 palkovsky 517
 
1288 jermar 518
    rc = STRUCT_TO_USPACE(&reply->args, &call.data.args);
519
    if (rc != 0)
520
        return rc;
1027 palkovsky 521
 
522
    return 0;
523
}
524
 
2471 jermar 525
/** Check that the task did not exceed the allowed limit of asynchronous calls.
1027 palkovsky 526
 *
2471 jermar 527
 * @return      Return 0 if limit not reached or -1 if limit exceeded.
1027 palkovsky 528
 */
529
static int check_call_limit(void)
530
{
531
    if (atomic_preinc(&TASK->active_calls) > IPC_MAX_ASYNC_CALLS) {
532
        atomic_dec(&TASK->active_calls);
533
        return -1;
534
    }
535
    return 0;
536
}
537
 
2471 jermar 538
/** Make a fast asynchronous call over IPC.
1027 palkovsky 539
 *
2618 jermar 540
 * This function can only handle four arguments of payload, but is faster than
541
 * the generic function sys_ipc_call_async_slow().
2471 jermar 542
 *
543
 * @param phoneid   Phone handle for the call.
544
 * @param method    Method of the call.
545
 * @param arg1      Service-defined payload argument.
546
 * @param arg2      Service-defined payload argument.
2618 jermar 547
 * @param arg3      Service-defined payload argument.
548
 * @param arg4      Service-defined payload argument.
2471 jermar 549
 *
550
 * @return      Return call hash on success.
551
 *          Return IPC_CALLRET_FATAL in case of a fatal error and
552
 *          IPC_CALLRET_TEMPORARY if there are too many pending
553
 *          asynchronous requests; answers should be handled first.
1027 palkovsky 554
 */
2359 jermar 555
unative_t sys_ipc_call_async_fast(unative_t phoneid, unative_t method,
2618 jermar 556
    unative_t arg1, unative_t arg2, unative_t arg3, unative_t arg4)
1027 palkovsky 557
{
558
    call_t *call;
559
    phone_t *phone;
1090 palkovsky 560
    int res;
1027 palkovsky 561
 
562
    if (check_call_limit())
563
        return IPC_CALLRET_TEMPORARY;
564
 
1090 palkovsky 565
    GET_CHECK_PHONE(phone, phoneid, return IPC_CALLRET_FATAL);
1072 palkovsky 566
 
1258 palkovsky 567
    call = ipc_call_alloc(0);
1027 palkovsky 568
    IPC_SET_METHOD(call->data, method);
569
    IPC_SET_ARG1(call->data, arg1);
570
    IPC_SET_ARG2(call->data, arg2);
2618 jermar 571
    IPC_SET_ARG3(call->data, arg3);
572
    IPC_SET_ARG4(call->data, arg4);
2620 jermar 573
    /*
574
     * To achieve deterministic behavior, zero out arguments that are beyond
575
     * the limits of the fast version.
576
     */
577
    IPC_SET_ARG5(call->data, 0);
1027 palkovsky 578
 
3492 rimsky 579
    if (!(res = request_preprocess(call, phone)))
1090 palkovsky 580
        ipc_call(phone, call);
581
    else
582
        ipc_backsend_err(phone, call, res);
1027 palkovsky 583
 
1780 jermar 584
    return (unative_t) call;
1027 palkovsky 585
}
586
 
2471 jermar 587
/** Make an asynchronous IPC call allowing to transmit the entire payload.
1027 palkovsky 588
 *
2471 jermar 589
 * @param phoneid   Phone handle for the call.
590
 * @param data      Userspace address of call data with the request.
591
 *
592
 * @return      See sys_ipc_call_async_fast().
1027 palkovsky 593
 */
2618 jermar 594
unative_t sys_ipc_call_async_slow(unative_t phoneid, ipc_data_t *data)
1027 palkovsky 595
{
596
    call_t *call;
597
    phone_t *phone;
1090 palkovsky 598
    int res;
1288 jermar 599
    int rc;
1027 palkovsky 600
 
1072 palkovsky 601
    if (check_call_limit())
602
        return IPC_CALLRET_TEMPORARY;
603
 
1090 palkovsky 604
    GET_CHECK_PHONE(phone, phoneid, return IPC_CALLRET_FATAL);
1027 palkovsky 605
 
1258 palkovsky 606
    call = ipc_call_alloc(0);
2359 jermar 607
    rc = copy_from_uspace(&call->data.args, &data->args,
608
        sizeof(call->data.args));
1293 palkovsky 609
    if (rc != 0) {
610
        ipc_call_free(call);
1780 jermar 611
        return (unative_t) rc;
1293 palkovsky 612
    }
3492 rimsky 613
    if (!(res = request_preprocess(call, phone)))
1090 palkovsky 614
        ipc_call(phone, call);
615
    else
616
        ipc_backsend_err(phone, call, res);
1040 palkovsky 617
 
1780 jermar 618
    return (unative_t) call;
1027 palkovsky 619
}
620
 
2471 jermar 621
/** Forward a received call to another destination.
1040 palkovsky 622
 *
2471 jermar 623
 * @param callid    Hash of the call to forward.
624
 * @param phoneid   Phone handle to use for forwarding.
625
 * @param method    New method to use for the forwarded call.
626
 * @param arg1      New value of the first argument for the forwarded call.
2636 jermar 627
 * @param arg2      New value of the second argument for the forwarded call.
2622 jermar 628
 * @param mode      Flags that specify mode of the forward operation.
1060 palkovsky 629
 *
2471 jermar 630
 * @return      Return 0 on succes, otherwise return an error code.
631
 *
2636 jermar 632
 * In case the original method is a system method, ARG1, ARG2 and ARG3 are
633
 * overwritten in the forwarded message with the new method and the new arg1 and
634
 * arg2, respectively. Otherwise the METHOD, ARG1 and ARG2 are rewritten with
635
 * the new method, arg1 and arg2, respectively. Also note there is a set of
636
 * immutable methods, for which the new method and argument is not set and
637
 * these values are ignored.
2471 jermar 638
 *
2622 jermar 639
 * Warning: When implementing support for changing additional payload
2636 jermar 640
 *      arguments, make sure that ARG5 is not rewritten for certain
2622 jermar 641
 *      system IPC
1040 palkovsky 642
 */
1780 jermar 643
unative_t sys_ipc_forward_fast(unative_t callid, unative_t phoneid,
2635 cejka 644
    unative_t method, unative_t arg1, unative_t arg2, int mode)
1040 palkovsky 645
{
646
    call_t *call;
647
    phone_t *phone;
648
 
649
    call = get_call(callid);
650
    if (!call)
651
        return ENOENT;
652
 
1088 palkovsky 653
    call->flags |= IPC_CALL_FORWARDED;
654
 
1084 palkovsky 655
    GET_CHECK_PHONE(phone, phoneid, {
1040 palkovsky 656
        IPC_SET_RETVAL(call->data, EFORWARD);
657
        ipc_answer(&TASK->answerbox, call);
658
        return ENOENT;
3054 decky 659
    });
1040 palkovsky 660
 
2557 jermar 661
    if (!method_is_forwardable(IPC_GET_METHOD(call->data))) {
1040 palkovsky 662
        IPC_SET_RETVAL(call->data, EFORWARD);
663
        ipc_answer(&TASK->answerbox, call);
664
        return EPERM;
665
    }
666
 
2557 jermar 667
    /*
668
     * Userspace is not allowed to change method of system methods on
2635 cejka 669
     * forward, allow changing ARG1, ARG2 and ARG3 by means of method,
670
     * arg1 and arg2.
2557 jermar 671
     * If the method is immutable, don't change anything.
1040 palkovsky 672
     */
2557 jermar 673
    if (!method_is_immutable(IPC_GET_METHOD(call->data))) {
674
        if (method_is_system(IPC_GET_METHOD(call->data))) {
675
            if (IPC_GET_METHOD(call->data) == IPC_M_CONNECT_TO_ME)
2635 cejka 676
                phone_dealloc(IPC_GET_ARG5(call->data));
1090 palkovsky 677
 
2557 jermar 678
            IPC_SET_ARG1(call->data, method);
679
            IPC_SET_ARG2(call->data, arg1);
2635 cejka 680
            IPC_SET_ARG3(call->data, arg2);
2557 jermar 681
        } else {
682
            IPC_SET_METHOD(call->data, method);
683
            IPC_SET_ARG1(call->data, arg1);
2635 cejka 684
            IPC_SET_ARG2(call->data, arg2);
2557 jermar 685
        }
1040 palkovsky 686
    }
687
 
2622 jermar 688
    return ipc_forward(call, phone, &TASK->answerbox, mode);
1040 palkovsky 689
}
690
 
2471 jermar 691
/** Answer an IPC call - fast version.
692
 *
693
 * This function can handle only two return arguments of payload, but is faster
694
 * than the generic sys_ipc_answer().
695
 *
696
 * @param callid    Hash of the call to be answered.
697
 * @param retval    Return value of the answer.
698
 * @param arg1      Service-defined return value.
699
 * @param arg2      Service-defined return value.
2619 jermar 700
 * @param arg3      Service-defined return value.
701
 * @param arg4      Service-defined return value.
2471 jermar 702
 *
703
 * @return      Return 0 on success, otherwise return an error code.   
704
 */
2359 jermar 705
unative_t sys_ipc_answer_fast(unative_t callid, unative_t retval,
2619 jermar 706
    unative_t arg1, unative_t arg2, unative_t arg3, unative_t arg4)
1027 palkovsky 707
{
708
    call_t *call;
1040 palkovsky 709
    ipc_data_t saved_data;
1088 palkovsky 710
    int saveddata = 0;
1329 palkovsky 711
    int rc;
1027 palkovsky 712
 
1346 palkovsky 713
    /* Do not answer notification callids */
714
    if (callid & IPC_CALLID_NOTIFICATION)
715
        return 0;
716
 
1040 palkovsky 717
    call = get_call(callid);
718
    if (!call)
719
        return ENOENT;
1027 palkovsky 720
 
1088 palkovsky 721
    if (answer_need_old(call)) {
1040 palkovsky 722
        memcpy(&saved_data, &call->data, sizeof(call->data));
1088 palkovsky 723
        saveddata = 1;
1027 palkovsky 724
    }
725
 
726
    IPC_SET_RETVAL(call->data, retval);
727
    IPC_SET_ARG1(call->data, arg1);
728
    IPC_SET_ARG2(call->data, arg2);
2619 jermar 729
    IPC_SET_ARG3(call->data, arg3);
730
    IPC_SET_ARG4(call->data, arg4);
2620 jermar 731
    /*
732
     * To achieve deterministic behavior, zero out arguments that are beyond
733
     * the limits of the fast version.
734
     */
735
    IPC_SET_ARG5(call->data, 0);
1329 palkovsky 736
    rc = answer_preprocess(call, saveddata ? &saved_data : NULL);
1040 palkovsky 737
 
1027 palkovsky 738
    ipc_answer(&TASK->answerbox, call);
1329 palkovsky 739
    return rc;
1027 palkovsky 740
}
741
 
2471 jermar 742
/** Answer an IPC call.
743
 *
744
 * @param callid    Hash of the call to be answered.
745
 * @param data      Userspace address of call data with the answer.
746
 *
747
 * @return      Return 0 on success, otherwise return an error code.
748
 */
2619 jermar 749
unative_t sys_ipc_answer_slow(unative_t callid, ipc_data_t *data)
1027 palkovsky 750
{
751
    call_t *call;
1040 palkovsky 752
    ipc_data_t saved_data;
1088 palkovsky 753
    int saveddata = 0;
1288 jermar 754
    int rc;
1027 palkovsky 755
 
1346 palkovsky 756
    /* Do not answer notification callids */
757
    if (callid & IPC_CALLID_NOTIFICATION)
758
        return 0;
759
 
1040 palkovsky 760
    call = get_call(callid);
761
    if (!call)
762
        return ENOENT;
1027 palkovsky 763
 
1088 palkovsky 764
    if (answer_need_old(call)) {
1040 palkovsky 765
        memcpy(&saved_data, &call->data, sizeof(call->data));
1088 palkovsky 766
        saveddata = 1;
1027 palkovsky 767
    }
1288 jermar 768
    rc = copy_from_uspace(&call->data.args, &data->args,
2359 jermar 769
        sizeof(call->data.args));
1288 jermar 770
    if (rc != 0)
771
        return rc;
1027 palkovsky 772
 
1329 palkovsky 773
    rc = answer_preprocess(call, saveddata ? &saved_data : NULL);
1027 palkovsky 774
 
775
    ipc_answer(&TASK->answerbox, call);
776
 
1329 palkovsky 777
    return rc;
1027 palkovsky 778
}
779
 
2471 jermar 780
/** Hang up a phone.
1086 palkovsky 781
 *
2471 jermar 782
 * @param       Phone handle of the phone to be hung up.
783
 *
784
 * @return      Return 0 on success or an error code.
1086 palkovsky 785
 */
1780 jermar 786
unative_t sys_ipc_hangup(int phoneid)
1086 palkovsky 787
{
788
    phone_t *phone;
789
 
790
    GET_CHECK_PHONE(phone, phoneid, return ENOENT);
791
 
1591 palkovsky 792
    if (ipc_phone_hangup(phone))
1086 palkovsky 793
        return -1;
794
 
795
    return 0;
796
}
797
 
2471 jermar 798
/** Wait for an incoming IPC call or an answer.
1027 palkovsky 799
 *
2359 jermar 800
 * @param calldata  Pointer to buffer where the call/answer data is stored.
801
 * @param usec      Timeout. See waitq_sleep_timeout() for explanation.
802
 * @param flags     Select mode of sleep operation. See waitq_sleep_timeout()
803
 *          for explanation.
1364 jermar 804
 *
2471 jermar 805
 * @return      Hash of the call.
806
 *          If IPC_CALLID_NOTIFICATION bit is set in the hash, the
807
 *          call is a notification. IPC_CALLID_ANSWERED denotes an
808
 *          answer.
1027 palkovsky 809
 */
1780 jermar 810
unative_t sys_ipc_wait_for_call(ipc_data_t *calldata, uint32_t usec, int flags)
1027 palkovsky 811
{
812
    call_t *call;
813
 
3665 rimsky 814
restart:
815
 
816
#ifdef CONFIG_UDEBUG
817
    udebug_stoppable_begin();
818
#endif  
2359 jermar 819
    call = ipc_wait_for_call(&TASK->answerbox, usec,
820
        flags | SYNCH_FLAGS_INTERRUPTIBLE);
3665 rimsky 821
 
822
#ifdef CONFIG_UDEBUG
823
    udebug_stoppable_end();
824
#endif
1088 palkovsky 825
    if (!call)
826
        return 0;
1027 palkovsky 827
 
1258 palkovsky 828
    if (call->flags & IPC_CALL_NOTIF) {
829
        ASSERT(! (call->flags & IPC_CALL_STATIC_ALLOC));
1693 palkovsky 830
 
831
        /* Set in_phone_hash to the interrupt counter */
2098 decky 832
        call->data.phone = (void *) call->priv;
1693 palkovsky 833
 
834
        STRUCT_TO_USPACE(calldata, &call->data);
835
 
1258 palkovsky 836
        ipc_call_free(call);
837
 
2471 jermar 838
        return ((unative_t) call) | IPC_CALLID_NOTIFICATION;
1258 palkovsky 839
    }
840
 
1027 palkovsky 841
    if (call->flags & IPC_CALL_ANSWERED) {
1090 palkovsky 842
        process_answer(call);
1027 palkovsky 843
 
1086 palkovsky 844
        ASSERT(! (call->flags & IPC_CALL_STATIC_ALLOC));
845
 
846
        if (call->flags & IPC_CALL_DISCARD_ANSWER) {
847
            ipc_call_free(call);
848
            goto restart;
3492 rimsky 849
        } else {
850
            /*
851
             * Decrement the counter of active calls only if the
852
             * call is not an answer to IPC_M_PHONE_HUNGUP,
853
             * which doesn't contribute to the counter.
854
             */
855
            atomic_dec(&TASK->active_calls);
1086 palkovsky 856
        }
857
 
858
        STRUCT_TO_USPACE(&calldata->args, &call->data.args);
1027 palkovsky 859
        ipc_call_free(call);
860
 
2471 jermar 861
        return ((unative_t) call) | IPC_CALLID_ANSWERED;
1027 palkovsky 862
    }
1086 palkovsky 863
 
1027 palkovsky 864
    if (process_request(&TASK->answerbox, call))
865
        goto restart;
1086 palkovsky 866
 
1090 palkovsky 867
    /* Include phone address('id') of the caller in the request,
868
     * copy whole call->data, not only call->data.args */
1396 palkovsky 869
    if (STRUCT_TO_USPACE(calldata, &call->data)) {
870
        return 0;
871
    }
1780 jermar 872
    return (unative_t)call;
1027 palkovsky 873
}
1258 palkovsky 874
 
2471 jermar 875
/** Connect an IRQ handler to a task.
1923 jermar 876
 *
2471 jermar 877
 * @param inr       IRQ number.
878
 * @param devno     Device number.
879
 * @param method    Method to be associated with the notification.
880
 * @param ucode     Uspace pointer to the top-half pseudocode.
1923 jermar 881
 *
2471 jermar 882
 * @return      EPERM or a return code returned by ipc_irq_register().
1923 jermar 883
 */
2359 jermar 884
unative_t sys_ipc_register_irq(inr_t inr, devno_t devno, unative_t method,
885
    irq_code_t *ucode)
1258 palkovsky 886
{
1297 jermar 887
    if (!(cap_get(TASK) & CAP_IRQ_REG))
888
        return EPERM;
889
 
1923 jermar 890
    return ipc_irq_register(&TASK->answerbox, inr, devno, method, ucode);
1258 palkovsky 891
}
892
 
2471 jermar 893
/** Disconnect an IRQ handler from a task.
1923 jermar 894
 *
2471 jermar 895
 * @param inr       IRQ number.
896
 * @param devno     Device number.
897
 *
898
 * @return      Zero on success or EPERM on error..
1923 jermar 899
 */
900
unative_t sys_ipc_unregister_irq(inr_t inr, devno_t devno)
1258 palkovsky 901
{
1297 jermar 902
    if (!(cap_get(TASK) & CAP_IRQ_REG))
903
        return EPERM;
904
 
1923 jermar 905
    ipc_irq_unregister(&TASK->answerbox, inr, devno);
1258 palkovsky 906
 
907
    return 0;
908
}
1702 cejka 909
 
3492 rimsky 910
#include <console/console.h>
911
 
912
/**
913
 * Syscall connect to a task by id.
914
 *
915
 * @return      Phone id on success, or negative error code.
916
 */
917
unative_t sys_ipc_connect_kbox(sysarg64_t *uspace_taskid_arg)
918
{
919
#ifdef CONFIG_UDEBUG
920
    sysarg64_t taskid_arg;
921
    int rc;
922
 
923
    rc = copy_from_uspace(&taskid_arg, uspace_taskid_arg, sizeof(sysarg64_t));
924
    if (rc != 0)
925
        return (unative_t) rc;
926
 
927
    LOG("sys_ipc_connect_kbox(%" PRIu64 ")\n", taskid_arg.value);
928
 
929
    return ipc_connect_kbox(taskid_arg.value);
930
#else
931
    return (unative_t) ENOTSUP;
932
#endif
933
}
934
 
1757 jermar 935
/** @}
1702 cejka 936
 */