Subversion Repositories HelenOS

Rev

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

Rev Author Line No. Line
1027 palkovsky 1
/*
2
 * Copyright (C) 2006 Ondrej 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
 
29
#include <arch.h>
30
#include <proc/task.h>
31
 
32
#include <errno.h>
33
#include <mm/page.h>
34
#include <memstr.h>
35
#include <debug.h>
36
#include <ipc/ipc.h>
37
#include <ipc/sysipc.h>
1072 palkovsky 38
#include <ipc/ipcrsc.h>
1258 palkovsky 39
#include <arch/interrupt.h>
1060 palkovsky 40
 
1027 palkovsky 41
#include <print.h>
1060 palkovsky 42
#include <arch.h>
43
#include <proc/thread.h>
1027 palkovsky 44
 
1084 palkovsky 45
#define GET_CHECK_PHONE(phone,phoneid,err) { \
46
      if (phoneid > IPC_MAX_PHONES) { err; } \
47
      phone = &TASK->phones[phoneid]; \
48
}
49
 
1090 palkovsky 50
#define STRUCT_TO_USPACE(dst,src) copy_to_uspace(dst,src,sizeof(*(src)))
1084 palkovsky 51
 
1040 palkovsky 52
/** Return true if the method is a system method */
53
static inline int is_system_method(__native method)
54
{
55
    if (method <= IPC_M_LAST_SYSTEM)
56
        return 1;
57
    return 0;
58
}
59
 
60
/** Return true if the message with this method is forwardable
61
 *
62
 * - some system messages may be forwarded, for some of them
63
 *   it is useless
64
 */
65
static inline int is_forwardable(__native method)
66
{
1086 palkovsky 67
    if (method == IPC_M_PHONE_HUNGUP)
68
        return 0; /* This message is meant only for the receiver */
1040 palkovsky 69
    return 1;
70
}
71
 
1027 palkovsky 72
/****************************************************/
73
/* Functions that preprocess answer before sending
74
 * it to the recepient
75
 */
76
 
77
/** Return true if the caller (ipc_answer) should save
1088 palkovsky 78
 * the old call contents for answer_preprocess
1027 palkovsky 79
 */
1088 palkovsky 80
static inline int answer_need_old(call_t *call)
1027 palkovsky 81
{
1086 palkovsky 82
    if (IPC_GET_METHOD(call->data) == IPC_M_CONNECT_TO_ME)
1027 palkovsky 83
        return 1;
1086 palkovsky 84
    if (IPC_GET_METHOD(call->data) == IPC_M_CONNECT_ME_TO)
1060 palkovsky 85
        return 1;
1027 palkovsky 86
    return 0;
87
}
88
 
89
/** Interpret process answer as control information */
1040 palkovsky 90
static inline void answer_preprocess(call_t *answer, ipc_data_t *olddata)
1027 palkovsky 91
{
92
    int phoneid;
93
 
1088 palkovsky 94
    if (IPC_GET_RETVAL(answer->data) == EHANGUP) {
1141 palkovsky 95
        /* In case of forward, hangup the forwared phone,
96
         * not the originator
97
         */
98
        spinlock_lock(&answer->data.phone->lock);
99
        spinlock_lock(&TASK->answerbox.lock);
100
        if (answer->data.phone->callee) {
101
            list_remove(&answer->data.phone->list);
102
            answer->data.phone->callee = 0;
103
        }
104
        spinlock_unlock(&TASK->answerbox.lock);
105
        spinlock_unlock(&answer->data.phone->lock);
1088 palkovsky 106
    }
107
 
108
    if (!olddata)
109
        return;
110
 
1086 palkovsky 111
    if (IPC_GET_METHOD(*olddata) == IPC_M_CONNECT_TO_ME) {
1040 palkovsky 112
        phoneid = IPC_GET_ARG3(*olddata);
1027 palkovsky 113
        if (IPC_GET_RETVAL(answer->data)) {
114
            /* The connection was not accepted */
115
            phone_dealloc(phoneid);
1040 palkovsky 116
        } else {
1090 palkovsky 117
            /* The connection was accepted */
1040 palkovsky 118
            phone_connect(phoneid,&answer->sender->answerbox);
1090 palkovsky 119
            /* Set 'phone identification' as arg3 of response */
120
            IPC_SET_ARG3(answer->data, (__native)&TASK->phones[phoneid]);
1027 palkovsky 121
        }
1086 palkovsky 122
    } else if (IPC_GET_METHOD(*olddata) == IPC_M_CONNECT_ME_TO) {
1060 palkovsky 123
        /* If the users accepted call, connect */
124
        if (!IPC_GET_RETVAL(answer->data)) {
125
            ipc_phone_connect((phone_t *)IPC_GET_ARG3(*olddata),
126
                      &TASK->answerbox);
127
        }
1027 palkovsky 128
    }
129
}
130
 
1090 palkovsky 131
/** Called before the request is sent
132
 *
133
 * @return 0 - no error, -1 - report error to user
134
 */
135
static int request_preprocess(call_t *call)
136
{
137
    int newphid;
138
 
139
    switch (IPC_GET_METHOD(call->data)) {
140
    case IPC_M_CONNECT_ME_TO:
141
        newphid = phone_alloc();
142
        if (newphid < 0)
143
            return ELIMIT;
144
        /* Set arg3 for server */
145
        IPC_SET_ARG3(call->data, (__native)&TASK->phones[newphid]);
146
        call->flags |= IPC_CALL_CONN_ME_TO;
147
        call->private = newphid;
148
        break;
149
    default:
150
        break;
151
    }
152
    return 0;
153
}
154
 
1027 palkovsky 155
/****************************************************/
156
/* Functions called to process received call/answer
157
 * before passing to uspace
158
 */
159
 
160
/** Do basic kernel processing of received call answer */
1090 palkovsky 161
static void process_answer(call_t *call)
1027 palkovsky 162
{
1088 palkovsky 163
    if (IPC_GET_RETVAL(call->data) == EHANGUP && \
164
        call->flags & IPC_CALL_FORWARDED)
165
        IPC_SET_RETVAL(call->data, EFORWARD);
1090 palkovsky 166
 
167
    if (call->flags & IPC_CALL_CONN_ME_TO) {
168
        if (IPC_GET_RETVAL(call->data))
169
            phone_dealloc(call->private);
170
        else
171
            IPC_SET_ARG3(call->data, call->private);
172
    }
1027 palkovsky 173
}
174
 
175
/** Do basic kernel processing of received call request
176
 *
177
 * @return 0 - the call should be passed to userspace, 1 - ignore call
178
 */
179
static int process_request(answerbox_t *box,call_t *call)
180
{
181
    int phoneid;
182
 
1086 palkovsky 183
    if (IPC_GET_METHOD(call->data) == IPC_M_CONNECT_TO_ME) {
1040 palkovsky 184
        phoneid = phone_alloc();
1027 palkovsky 185
        if (phoneid < 0) { /* Failed to allocate phone */
186
            IPC_SET_RETVAL(call->data, ELIMIT);
187
            ipc_answer(box,call);
188
            return -1;
189
        }
190
        IPC_SET_ARG3(call->data, phoneid);
191
    }
192
    return 0;
193
}
194
 
195
/** Send a call over IPC, wait for reply, return to user
196
 *
197
 * @return Call identification, returns -1 on fatal error,
198
           -2 on 'Too many async request, handle answers first
199
 */
200
__native sys_ipc_call_sync_fast(__native phoneid, __native method,
1086 palkovsky 201
                __native arg1, ipc_data_t *data)
1027 palkovsky 202
{
203
    call_t call;
204
    phone_t *phone;
1090 palkovsky 205
    int res;
1027 palkovsky 206
 
1084 palkovsky 207
    GET_CHECK_PHONE(phone, phoneid, return ENOENT);
1027 palkovsky 208
 
1084 palkovsky 209
    ipc_call_static_init(&call);
1027 palkovsky 210
    IPC_SET_METHOD(call.data, method);
211
    IPC_SET_ARG1(call.data, arg1);
212
 
1090 palkovsky 213
    if (!(res=request_preprocess(&call))) {
214
        ipc_call_sync(phone, &call);
215
        process_answer(&call);
216
    } else
217
        IPC_SET_RETVAL(call.data, res);
1086 palkovsky 218
    STRUCT_TO_USPACE(&data->args, &call.data.args);
1027 palkovsky 219
 
220
    return 0;
221
}
222
 
223
/** Synchronous IPC call allowing to send whole message */
1086 palkovsky 224
__native sys_ipc_call_sync(__native phoneid, ipc_data_t *question,
225
               ipc_data_t *reply)
1027 palkovsky 226
{
227
    call_t call;
228
    phone_t *phone;
1090 palkovsky 229
    int res;
1027 palkovsky 230
 
1084 palkovsky 231
    ipc_call_static_init(&call);
1086 palkovsky 232
    copy_from_uspace(&call.data.args, &question->args, sizeof(call.data.args));
1040 palkovsky 233
 
1084 palkovsky 234
    GET_CHECK_PHONE(phone, phoneid, return ENOENT);
1072 palkovsky 235
 
1090 palkovsky 236
    if (!(res=request_preprocess(&call))) {
237
        ipc_call_sync(phone, &call);
238
        process_answer(&call);
239
    } else
240
        IPC_SET_RETVAL(call.data, res);
1027 palkovsky 241
 
1086 palkovsky 242
    STRUCT_TO_USPACE(&reply->args, &call.data.args);
1027 palkovsky 243
 
244
    return 0;
245
}
246
 
247
/** Check that the task did not exceed allowed limit
248
 *
249
 * @return 0 - Limit OK,   -1 - limit exceeded
250
 */
251
static int check_call_limit(void)
252
{
253
    if (atomic_preinc(&TASK->active_calls) > IPC_MAX_ASYNC_CALLS) {
254
        atomic_dec(&TASK->active_calls);
255
        return -1;
256
    }
257
    return 0;
258
}
259
 
260
/** Send an asynchronous call over ipc
261
 *
262
 * @return Call identification, returns -1 on fatal error,
263
           -2 on 'Too many async request, handle answers first
264
 */
265
__native sys_ipc_call_async_fast(__native phoneid, __native method,
266
                 __native arg1, __native arg2)
267
{
268
    call_t *call;
269
    phone_t *phone;
1090 palkovsky 270
    int res;
1027 palkovsky 271
 
272
    if (check_call_limit())
273
        return IPC_CALLRET_TEMPORARY;
274
 
1090 palkovsky 275
    GET_CHECK_PHONE(phone, phoneid, return IPC_CALLRET_FATAL);
1072 palkovsky 276
 
1258 palkovsky 277
    call = ipc_call_alloc(0);
1027 palkovsky 278
    IPC_SET_METHOD(call->data, method);
279
    IPC_SET_ARG1(call->data, arg1);
280
    IPC_SET_ARG2(call->data, arg2);
281
 
1090 palkovsky 282
    if (!(res=request_preprocess(call)))
283
        ipc_call(phone, call);
284
    else
285
        ipc_backsend_err(phone, call, res);
1027 palkovsky 286
 
287
    return (__native) call;
288
}
289
 
290
/** Synchronous IPC call allowing to send whole message
291
 *
292
 * @return The same as sys_ipc_call_async
293
 */
1086 palkovsky 294
__native sys_ipc_call_async(__native phoneid, ipc_data_t *data)
1027 palkovsky 295
{
296
    call_t *call;
297
    phone_t *phone;
1090 palkovsky 298
    int res;
1027 palkovsky 299
 
1072 palkovsky 300
    if (check_call_limit())
301
        return IPC_CALLRET_TEMPORARY;
302
 
1090 palkovsky 303
    GET_CHECK_PHONE(phone, phoneid, return IPC_CALLRET_FATAL);
1027 palkovsky 304
 
1258 palkovsky 305
    call = ipc_call_alloc(0);
1086 palkovsky 306
    copy_from_uspace(&call->data.args, &data->args, sizeof(call->data.args));
1090 palkovsky 307
    if (!(res=request_preprocess(call)))
308
        ipc_call(phone, call);
309
    else
310
        ipc_backsend_err(phone, call, res);
1040 palkovsky 311
 
1027 palkovsky 312
    return (__native) call;
313
}
314
 
1040 palkovsky 315
/** Forward received call to another destination
316
 *
317
 * The arg1 and arg2 are changed in the forwarded message
1060 palkovsky 318
 *
319
 * Warning: If implementing non-fast version, make sure that
320
 *          arg3 is not rewritten for certain system IPC
1040 palkovsky 321
 */
322
__native sys_ipc_forward_fast(__native callid, __native phoneid,
323
                  __native method, __native arg1)
324
{
325
    call_t *call;
326
    phone_t *phone;
327
 
328
    call = get_call(callid);
329
    if (!call)
330
        return ENOENT;
331
 
1088 palkovsky 332
    call->flags |= IPC_CALL_FORWARDED;
333
 
1084 palkovsky 334
    GET_CHECK_PHONE(phone, phoneid, {
1040 palkovsky 335
        IPC_SET_RETVAL(call->data, EFORWARD);
336
        ipc_answer(&TASK->answerbox, call);
337
        return ENOENT;
1084 palkovsky 338
    });    
1040 palkovsky 339
 
340
    if (!is_forwardable(IPC_GET_METHOD(call->data))) {
341
        IPC_SET_RETVAL(call->data, EFORWARD);
342
        ipc_answer(&TASK->answerbox, call);
343
        return EPERM;
344
    }
345
 
346
    /* Userspace is not allowed to change method of system methods
347
     * on forward, allow changing ARG1 and ARG2 by means of method and arg1
348
     */
349
    if (is_system_method(IPC_GET_METHOD(call->data))) {
1090 palkovsky 350
        if (IPC_GET_METHOD(call->data) == IPC_M_CONNECT_TO_ME)
351
            phone_dealloc(IPC_GET_ARG3(call->data));
352
 
1040 palkovsky 353
        IPC_SET_ARG1(call->data, method);
354
        IPC_SET_ARG2(call->data, arg1);
355
    } else {
356
        IPC_SET_METHOD(call->data, method);
357
        IPC_SET_ARG1(call->data, arg1);
358
    }
359
 
1088 palkovsky 360
    return ipc_forward(call, phone, &TASK->answerbox);
1040 palkovsky 361
}
362
 
1027 palkovsky 363
/** Send IPC answer */
364
__native sys_ipc_answer_fast(__native callid, __native retval,
365
                 __native arg1, __native arg2)
366
{
367
    call_t *call;
1040 palkovsky 368
    ipc_data_t saved_data;
1088 palkovsky 369
    int saveddata = 0;
1027 palkovsky 370
 
1040 palkovsky 371
    call = get_call(callid);
372
    if (!call)
373
        return ENOENT;
1027 palkovsky 374
 
1088 palkovsky 375
    if (answer_need_old(call)) {
1040 palkovsky 376
        memcpy(&saved_data, &call->data, sizeof(call->data));
1088 palkovsky 377
        saveddata = 1;
1027 palkovsky 378
    }
379
 
380
    IPC_SET_RETVAL(call->data, retval);
381
    IPC_SET_ARG1(call->data, arg1);
382
    IPC_SET_ARG2(call->data, arg2);
1088 palkovsky 383
    answer_preprocess(call, saveddata ? &saved_data : NULL);
1040 palkovsky 384
 
1027 palkovsky 385
    ipc_answer(&TASK->answerbox, call);
386
    return 0;
387
}
388
 
389
/** Send IPC answer */
1086 palkovsky 390
__native sys_ipc_answer(__native callid, ipc_data_t *data)
1027 palkovsky 391
{
392
    call_t *call;
1040 palkovsky 393
    ipc_data_t saved_data;
1088 palkovsky 394
    int saveddata = 0;
1027 palkovsky 395
 
1040 palkovsky 396
    call = get_call(callid);
397
    if (!call)
398
        return ENOENT;
1027 palkovsky 399
 
1088 palkovsky 400
    if (answer_need_old(call)) {
1040 palkovsky 401
        memcpy(&saved_data, &call->data, sizeof(call->data));
1088 palkovsky 402
        saveddata = 1;
1027 palkovsky 403
    }
1086 palkovsky 404
    copy_from_uspace(&call->data.args, &data->args,
405
             sizeof(call->data.args));
1027 palkovsky 406
 
1088 palkovsky 407
    answer_preprocess(call, saveddata ? &saved_data : NULL);
1027 palkovsky 408
 
409
    ipc_answer(&TASK->answerbox, call);
410
 
411
    return 0;
412
}
413
 
1086 palkovsky 414
/** Hang up the phone
415
 *
416
 */
417
__native sys_ipc_hangup(int phoneid)
418
{
419
    phone_t *phone;
420
 
421
    GET_CHECK_PHONE(phone, phoneid, return ENOENT);
422
 
423
    if (ipc_phone_hangup(phone))
424
        return -1;
425
 
426
    return 0;
427
}
428
 
1027 palkovsky 429
/** Wait for incoming ipc call or answer
430
 *
1086 palkovsky 431
 * @param calldata Pointer to buffer where the call/answer data is stored
1027 palkovsky 432
 * @param flags
433
 * @return Callid, if callid & 1, then the call is answer
434
 */
1090 palkovsky 435
__native sys_ipc_wait_for_call(ipc_data_t *calldata, __native flags)
1027 palkovsky 436
{
437
    call_t *call;
438
 
439
restart:   
440
    call = ipc_wait_for_call(&TASK->answerbox, flags);
1088 palkovsky 441
    if (!call)
442
        return 0;
1027 palkovsky 443
 
1258 palkovsky 444
    if (call->flags & IPC_CALL_NOTIF) {
445
        ASSERT(! (call->flags & IPC_CALL_STATIC_ALLOC));
446
        STRUCT_TO_USPACE(&calldata->args, &call->data.args);
447
        ipc_call_free(call);
448
 
449
        return ((__native)call) | IPC_CALLID_NOTIFICATION;
450
    }
451
 
1027 palkovsky 452
    if (call->flags & IPC_CALL_ANSWERED) {
1090 palkovsky 453
        process_answer(call);
1027 palkovsky 454
 
1086 palkovsky 455
        ASSERT(! (call->flags & IPC_CALL_STATIC_ALLOC));
456
 
1027 palkovsky 457
        atomic_dec(&TASK->active_calls);
1086 palkovsky 458
 
459
        if (call->flags & IPC_CALL_DISCARD_ANSWER) {
460
            ipc_call_free(call);
461
            goto restart;
462
        }
463
 
464
        STRUCT_TO_USPACE(&calldata->args, &call->data.args);
1027 palkovsky 465
        ipc_call_free(call);
466
 
467
        return ((__native)call) | IPC_CALLID_ANSWERED;
468
    }
1086 palkovsky 469
 
1027 palkovsky 470
    if (process_request(&TASK->answerbox, call))
471
        goto restart;
1086 palkovsky 472
 
1090 palkovsky 473
    /* Include phone address('id') of the caller in the request,
474
     * copy whole call->data, not only call->data.args */
1086 palkovsky 475
    STRUCT_TO_USPACE(calldata, &call->data);
1027 palkovsky 476
    return (__native)call;
477
}
1258 palkovsky 478
 
479
/** Connect irq handler to task */
480
__native sys_ipc_register_irq(__native irq)
481
{
482
    if (irq >= IRQ_COUNT)
483
        return -ELIMIT;
484
 
485
    irq_ipc_bind_arch(irq);
486
    return ipc_irq_register(&TASK->answerbox, irq);
487
}
488
 
489
/* Disconnect irq handler from task */
490
__native sys_ipc_unregister_irq(__native irq)
491
{
492
    if (irq >= IRQ_COUNT)
493
        return -ELIMIT;
494
 
495
    ipc_irq_unregister(&TASK->answerbox, irq);
496
 
497
    return 0;
498
}