Subversion Repositories HelenOS

Rev

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