Subversion Repositories HelenOS

Rev

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