L4Re Operating System Framework
Interface and Usage Documentation
All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
task.h
Go to the documentation of this file.
1
5/*
6 * (c) 2008-2009 Adam Lackorzynski <adam@os.inf.tu-dresden.de>,
7 * Alexander Warg <warg@os.inf.tu-dresden.de>,
8 * Björn Döbel <doebel@os.inf.tu-dresden.de>,
9 * Torsten Frenzel <frenzel@os.inf.tu-dresden.de>
10 * economic rights: Technische Universität Dresden (Germany)
11 *
12 * License: see LICENSE.spdx (in this directory or the directories above)
13 */
14#pragma once
15#include <l4/sys/types.h>
16#include <l4/sys/utcb.h>
17
80l4_task_map(l4_cap_idx_t dst_task, l4_cap_idx_t src_task,
81 l4_fpage_t snd_fpage, l4_umword_t snd_base) L4_NOTHROW;
82
87l4_task_map_u(l4_cap_idx_t dst_task, l4_cap_idx_t src_task,
88 l4_fpage_t snd_fpage, l4_umword_t snd_base, l4_utcb_t *utcb) L4_NOTHROW;
89
136 l4_umword_t map_mask) L4_NOTHROW;
137
142l4_task_unmap_u(l4_cap_idx_t task, l4_fpage_t fpage,
143 l4_umword_t map_mask, l4_utcb_t *utcb) L4_NOTHROW;
144
166 unsigned num_fpages, l4_umword_t map_mask) L4_NOTHROW;
167
172l4_task_unmap_batch_u(l4_cap_idx_t task, l4_fpage_t const *fpages,
173 unsigned num_fpages, l4_umword_t map_mask,
175
199
204l4_task_delete_obj_u(l4_cap_idx_t task, l4_cap_idx_t obj,
206
227
232l4_task_release_cap_u(l4_cap_idx_t task, l4_cap_idx_t cap,
234
235
255
260l4_task_cap_valid_u(l4_cap_idx_t task, l4_cap_idx_t cap, l4_utcb_t *utcb) L4_NOTHROW;
261
277
282l4_task_add_ku_mem_u(l4_cap_idx_t task, l4_fpage_t *ku_mem,
284
313
314
319l4_task_cap_equal_u(l4_cap_idx_t task, l4_cap_idx_t cap_a,
320 l4_cap_idx_t cap_b, l4_utcb_t *utcb) L4_NOTHROW;
321
335
336
337/* IMPLEMENTATION -----------------------------------------------------------*/
338
339#include <l4/sys/ipc.h>
340
341
343l4_task_map_u(l4_cap_idx_t dst_task, l4_cap_idx_t src_task,
344 l4_fpage_t snd_fpage, l4_umword_t snd_base, l4_utcb_t *u) L4_NOTHROW
345{
346 l4_msg_regs_t *v = l4_utcb_mr_u(u);
347 v->mr[0] = L4_TASK_MAP_OP;
348 v->mr[3] = l4_map_obj_control(0,0);
349 v->mr[4] = l4_obj_fpage(src_task, 0, L4_CAP_FPAGE_RWS).raw;
350 v->mr[1] = snd_base;
351 v->mr[2] = snd_fpage.raw;
352 return l4_ipc_call(dst_task, u, l4_msgtag(L4_PROTO_TASK, 3, 1, 0), L4_IPC_NEVER);
353}
354
356l4_task_unmap_u(l4_cap_idx_t task, l4_fpage_t fpage,
357 l4_umword_t map_mask, l4_utcb_t *u) L4_NOTHROW
358{
359 l4_msg_regs_t *v = l4_utcb_mr_u(u);
360 v->mr[0] = L4_TASK_UNMAP_OP;
361 v->mr[1] = map_mask;
362 v->mr[2] = fpage.raw;
363 return l4_ipc_call(task, u, l4_msgtag(L4_PROTO_TASK, 3, 0, 0), L4_IPC_NEVER);
364}
365
367l4_task_unmap_batch_u(l4_cap_idx_t task, l4_fpage_t const *fpages,
368 unsigned num_fpages, l4_umword_t map_mask,
370{
371 l4_msg_regs_t *v = l4_utcb_mr_u(u);
372 v->mr[0] = L4_TASK_UNMAP_OP;
373 v->mr[1] = map_mask;
374 __builtin_memcpy(&v->mr[2], fpages, num_fpages * sizeof(l4_fpage_t));
375 return l4_ipc_call(task, u, l4_msgtag(L4_PROTO_TASK, 2 + num_fpages, 0, 0), L4_IPC_NEVER);
376}
377
379l4_task_cap_valid_u(l4_cap_idx_t task, l4_cap_idx_t cap, l4_utcb_t *u) L4_NOTHROW
380{
381 l4_msg_regs_t *v = l4_utcb_mr_u(u);
382 v->mr[0] = L4_TASK_CAP_INFO_OP;
383 v->mr[1] = cap & ~1UL;
384 return l4_ipc_call(task, u, l4_msgtag(L4_PROTO_TASK, 2, 0, 0), L4_IPC_NEVER);
385}
386
388l4_task_cap_equal_u(l4_cap_idx_t task, l4_cap_idx_t cap_a,
390{
391 l4_msg_regs_t *v = l4_utcb_mr_u(u);
392 v->mr[0] = L4_TASK_CAP_INFO_OP;
393 v->mr[1] = cap_a;
394 v->mr[2] = cap_b;
395 return l4_ipc_call(task, u, l4_msgtag(L4_PROTO_TASK, 3, 0, 0), L4_IPC_NEVER);
396}
397
399l4_task_add_ku_mem_u(l4_cap_idx_t task, l4_fpage_t *ku_mem,
401{
402 l4_msg_regs_t *v = l4_utcb_mr_u(u);
403 l4_msgtag_t ret;
405 v->mr[1] = ku_mem->raw;
406 ret = l4_ipc_call(task, u, l4_msgtag(L4_PROTO_TASK, 2, 0, 0), L4_IPC_NEVER);
407 if (!l4_msgtag_has_error(ret))
408 {
409 l4_msg_regs_t *v = l4_utcb_mr_u(u);
410 ku_mem->raw = v->mr[0];
411 }
412 return ret;
413}
414
415
416
419 l4_fpage_t snd_fpage, l4_umword_t snd_base) L4_NOTHROW
420{
421 return l4_task_map_u(dst_task, src_task, snd_fpage, snd_base, l4_utcb());
422}
423
426 l4_umword_t map_mask) L4_NOTHROW
427{
428 return l4_task_unmap_u(task, fpage, map_mask, l4_utcb());
429}
430
433 unsigned num_fpages, l4_umword_t map_mask) L4_NOTHROW
434{
435 return l4_task_unmap_batch_u(task, fpages, num_fpages, map_mask,
436 l4_utcb());
437}
438
440l4_task_delete_obj_u(l4_cap_idx_t task, l4_cap_idx_t obj,
442{
443 return l4_task_unmap_u(task, l4_obj_fpage(obj, 0, L4_CAP_FPAGE_RWSD),
445}
446
449{
450 return l4_task_delete_obj_u(task, obj, l4_utcb());
451}
452
453
455l4_task_release_cap_u(l4_cap_idx_t task, l4_cap_idx_t cap,
457{
458 return l4_task_unmap_u(task, l4_obj_fpage(cap, 0, L4_CAP_FPAGE_RWSD),
460}
461
464{
465 return l4_task_release_cap_u(task, cap, l4_utcb());
466}
467
470{
471 return l4_task_cap_valid_u(task, cap, l4_utcb());
472}
473
477{
478 return l4_task_cap_equal_u(task, cap_a, cap_b, l4_utcb());
479}
480
483{
484 return l4_task_add_ku_mem_u(task, ku_mem, l4_utcb());
485}
unsigned long l4_umword_t
Unsigned machine word.
Definition l4int.h:40
unsigned long l4_cap_idx_t
Capability selector type.
Definition types.h:335
l4_fpage_t l4_obj_fpage(l4_cap_idx_t obj, unsigned int order, unsigned char rights) L4_NOTHROW
Create a kernel-object flexpage.
Definition __l4_fpage.h:715
@ L4_CAP_FPAGE_RWSD
Full rights for capability flexpages.
Definition __l4_fpage.h:212
@ L4_CAP_FPAGE_RWS
Read, interface specific 'W', and 'S' rights for capability flexpages.
Definition __l4_fpage.h:206
l4_msgtag_t l4_ipc_call(l4_cap_idx_t object, l4_utcb_t *utcb, l4_msgtag_t tag, l4_timeout_t timeout) L4_NOTHROW
Object call (usual invocation).
Definition ipc.h:565
l4_umword_t l4_map_obj_control(l4_umword_t spot, unsigned grant) L4_NOTHROW
Create the first word for a map item that is a send item for the object space.
Definition __l4_fpage.h:749
unsigned l4_msgtag_has_error(l4_msgtag_t t) L4_NOTHROW
Test for error indicator flag.
Definition types.h:439
l4_msgtag_t l4_msgtag(long label, unsigned words, unsigned items, unsigned flags) L4_NOTHROW
Create a message tag from the specified values.
Definition types.h:404
@ L4_PROTO_TASK
Protocol for messages to a task object.
Definition types.h:52
L4_task_ops
Operations on task objects.
Definition task.h:327
@ L4_TASK_LDT_SET_X86_OP
x86: LDT set
Definition task.h:332
@ L4_TASK_MAP_VGICC_ARM_OP
Arm: Map virtual GICC area.
Definition task.h:333
@ L4_TASK_ADD_KU_MEM_OP
Add kernel-user memory.
Definition task.h:331
@ L4_TASK_CAP_INFO_OP
Cap info.
Definition task.h:330
@ L4_TASK_MAP_OP
Map.
Definition task.h:328
@ L4_TASK_UNMAP_OP
Unmap.
Definition task.h:329
l4_msgtag_t l4_task_cap_equal(l4_cap_idx_t task, l4_cap_idx_t cap_a, l4_cap_idx_t cap_b) L4_NOTHROW
Test whether two capabilities point to the same object with the same rights.
Definition task.h:475
l4_msgtag_t l4_task_unmap_batch(l4_cap_idx_t task, l4_fpage_t const *fpages, unsigned num_fpages, l4_umword_t map_mask) L4_NOTHROW
Revoke rights from a task.
Definition task.h:432
l4_msgtag_t l4_task_add_ku_mem(l4_cap_idx_t task, l4_fpage_t *ku_mem) L4_NOTHROW
Add kernel-user memory.
Definition task.h:482
l4_msgtag_t l4_task_cap_valid(l4_cap_idx_t task, l4_cap_idx_t cap) L4_NOTHROW
Check whether a capability is present (refers to an object).
Definition task.h:469
l4_msgtag_t l4_task_map(l4_cap_idx_t dst_task, l4_cap_idx_t src_task, l4_fpage_t snd_fpage, l4_umword_t snd_base) L4_NOTHROW
Map resources available in the source task to a destination task.
Definition task.h:418
l4_msgtag_t l4_task_unmap(l4_cap_idx_t task, l4_fpage_t fpage, l4_umword_t map_mask) L4_NOTHROW
Revoke rights from the task.
Definition task.h:425
l4_msgtag_t l4_task_delete_obj(l4_cap_idx_t task, l4_cap_idx_t obj) L4_NOTHROW
Release capability and delete object.
Definition task.h:448
l4_msgtag_t l4_task_release_cap(l4_cap_idx_t task, l4_cap_idx_t cap) L4_NOTHROW
Release object capability.
Definition task.h:463
@ L4_FP_DELETE_OBJ
Flag that indicates that an unmap operation on object capabilities shall try to delete the correspond...
Definition consts.h:197
@ L4_FP_ALL_SPACES
Flag to tell the unmap operation to revoke permissions from all child mappings including the mapping ...
Definition consts.h:183
#define L4_IPC_NEVER
never timeout
Definition __timeout.h:76
struct l4_utcb_t l4_utcb_t
Opaque type for the UTCB.
Definition utcb.h:56
l4_utcb_t * l4_utcb(void) L4_NOTHROW L4_PURE
Get the UTCB address.
Definition utcb.h:346
#define L4_NOTHROW
Mark a function declaration and definition as never throwing an exception.
Definition compiler.h:159
#define L4_INLINE
L4 Inline function attribute.
Definition compiler.h:51
Common L4 ABI Data Types.
Message tag data structure.
Definition types.h:153
L4 flexpage type.
Definition __l4_fpage.h:76
l4_umword_t raw
Raw value.
Definition __l4_fpage.h:78
Encapsulation of the message-register block in the UTCB.
Definition utcb.h:68
l4_umword_t mr[L4_UTCB_GENERIC_DATA_SIZE]
Message registers.
Definition utcb.h:69