Subversion Repositories HelenOS

Rev

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