L4Re Operating System Framework
Interface and Usage Documentation
Loading...
Searching...
No Matches
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
78l4_task_map(l4_cap_idx_t dst_task, l4_cap_idx_t src_task,
79 l4_fpage_t snd_fpage, l4_umword_t snd_base) L4_NOTHROW;
80
85l4_task_map_u(l4_cap_idx_t dst_task, l4_cap_idx_t src_task,
86 l4_fpage_t snd_fpage, l4_umword_t snd_base, l4_utcb_t *utcb) L4_NOTHROW;
87
134 l4_umword_t map_mask) L4_NOTHROW;
135
140l4_task_unmap_u(l4_cap_idx_t task, l4_fpage_t fpage,
141 l4_umword_t map_mask, l4_utcb_t *utcb) L4_NOTHROW;
142
164 unsigned num_fpages, l4_umword_t map_mask) L4_NOTHROW;
165
170l4_task_unmap_batch_u(l4_cap_idx_t task, l4_fpage_t const *fpages,
171 unsigned num_fpages, l4_umword_t map_mask,
173
197
202l4_task_delete_obj_u(l4_cap_idx_t task, l4_cap_idx_t obj,
204
225
230l4_task_release_cap_u(l4_cap_idx_t task, l4_cap_idx_t cap,
232
233
253
258l4_task_cap_valid_u(l4_cap_idx_t task, l4_cap_idx_t cap, l4_utcb_t *utcb) L4_NOTHROW;
259
275
280l4_task_add_ku_mem_u(l4_cap_idx_t task, l4_fpage_t *ku_mem,
282
311
312
317l4_task_cap_equal_u(l4_cap_idx_t task, l4_cap_idx_t cap_a,
318 l4_cap_idx_t cap_b, l4_utcb_t *utcb) L4_NOTHROW;
319
333
334
335/* IMPLEMENTATION -----------------------------------------------------------*/
336
337#include <l4/sys/ipc.h>
338
339
341l4_task_map_u(l4_cap_idx_t dst_task, l4_cap_idx_t src_task,
342 l4_fpage_t snd_fpage, l4_umword_t snd_base, l4_utcb_t *u) L4_NOTHROW
343{
344 l4_msg_regs_t *v = l4_utcb_mr_u(u);
345 v->mr[0] = L4_TASK_MAP_OP;
346 v->mr[3] = l4_map_obj_control(0,0);
347 v->mr[4] = l4_obj_fpage(src_task, 0, L4_CAP_FPAGE_RWS).raw;
348 v->mr[1] = snd_base;
349 v->mr[2] = snd_fpage.raw;
350 return l4_ipc_call(dst_task, u, l4_msgtag(L4_PROTO_TASK, 3, 1, 0), L4_IPC_NEVER);
351}
352
354l4_task_unmap_u(l4_cap_idx_t task, l4_fpage_t fpage,
355 l4_umword_t map_mask, l4_utcb_t *u) L4_NOTHROW
356{
357 l4_msg_regs_t *v = l4_utcb_mr_u(u);
358 v->mr[0] = L4_TASK_UNMAP_OP;
359 v->mr[1] = map_mask;
360 v->mr[2] = fpage.raw;
361 return l4_ipc_call(task, u, l4_msgtag(L4_PROTO_TASK, 3, 0, 0), L4_IPC_NEVER);
362}
363
365l4_task_unmap_batch_u(l4_cap_idx_t task, l4_fpage_t const *fpages,
366 unsigned num_fpages, l4_umword_t map_mask,
368{
369 l4_msg_regs_t *v = l4_utcb_mr_u(u);
370 v->mr[0] = L4_TASK_UNMAP_OP;
371 v->mr[1] = map_mask;
372 __builtin_memcpy(&v->mr[2], fpages, num_fpages * sizeof(l4_fpage_t));
373 return l4_ipc_call(task, u, l4_msgtag(L4_PROTO_TASK, 2 + num_fpages, 0, 0), L4_IPC_NEVER);
374}
375
377l4_task_cap_valid_u(l4_cap_idx_t task, l4_cap_idx_t cap, l4_utcb_t *u) L4_NOTHROW
378{
379 l4_msg_regs_t *v = l4_utcb_mr_u(u);
380 v->mr[0] = L4_TASK_CAP_INFO_OP;
381 v->mr[1] = cap & ~1UL;
382 return l4_ipc_call(task, u, l4_msgtag(L4_PROTO_TASK, 2, 0, 0), L4_IPC_NEVER);
383}
384
386l4_task_cap_equal_u(l4_cap_idx_t task, l4_cap_idx_t cap_a,
388{
389 l4_msg_regs_t *v = l4_utcb_mr_u(u);
390 v->mr[0] = L4_TASK_CAP_INFO_OP;
391 v->mr[1] = cap_a;
392 v->mr[2] = cap_b;
393 return l4_ipc_call(task, u, l4_msgtag(L4_PROTO_TASK, 3, 0, 0), L4_IPC_NEVER);
394}
395
397l4_task_add_ku_mem_u(l4_cap_idx_t task, l4_fpage_t *ku_mem,
399{
400 l4_msg_regs_t *v = l4_utcb_mr_u(u);
401 l4_msgtag_t ret;
403 v->mr[1] = ku_mem->raw;
404 ret = l4_ipc_call(task, u, l4_msgtag(L4_PROTO_TASK, 2, 0, 0), L4_IPC_NEVER);
405 if (!l4_msgtag_has_error(ret))
406 {
407 l4_msg_regs_t *v = l4_utcb_mr_u(u);
408 ku_mem->raw = v->mr[0];
409 }
410 return ret;
411}
412
413
414
417 l4_fpage_t snd_fpage, l4_umword_t snd_base) L4_NOTHROW
418{
419 return l4_task_map_u(dst_task, src_task, snd_fpage, snd_base, l4_utcb());
420}
421
424 l4_umword_t map_mask) L4_NOTHROW
425{
426 return l4_task_unmap_u(task, fpage, map_mask, l4_utcb());
427}
428
431 unsigned num_fpages, l4_umword_t map_mask) L4_NOTHROW
432{
433 return l4_task_unmap_batch_u(task, fpages, num_fpages, map_mask,
434 l4_utcb());
435}
436
438l4_task_delete_obj_u(l4_cap_idx_t task, l4_cap_idx_t obj,
440{
441 return l4_task_unmap_u(task, l4_obj_fpage(obj, 0, L4_CAP_FPAGE_RWSD),
443}
444
447{
448 return l4_task_delete_obj_u(task, obj, l4_utcb());
449}
450
451
453l4_task_release_cap_u(l4_cap_idx_t task, l4_cap_idx_t cap,
455{
456 return l4_task_unmap_u(task, l4_obj_fpage(cap, 0, L4_CAP_FPAGE_RWSD),
458}
459
462{
463 return l4_task_release_cap_u(task, cap, l4_utcb());
464}
465
468{
469 return l4_task_cap_valid_u(task, cap, l4_utcb());
470}
471
475{
476 return l4_task_cap_equal_u(task, cap_a, cap_b, l4_utcb());
477}
478
481{
482 return l4_task_add_ku_mem_u(task, ku_mem, l4_utcb());
483}
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:696
@ 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:730
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:325
@ L4_TASK_LDT_SET_X86_OP
x86: LDT set
Definition task.h:330
@ L4_TASK_MAP_VGICC_ARM_OP
Arm: Map virtual GICC area.
Definition task.h:331
@ L4_TASK_ADD_KU_MEM_OP
Add kernel-user memory.
Definition task.h:329
@ L4_TASK_CAP_INFO_OP
Cap info.
Definition task.h:328
@ L4_TASK_MAP_OP
Map.
Definition task.h:326
@ L4_TASK_UNMAP_OP
Unmap.
Definition task.h:327
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:473
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:430
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:480
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:467
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:416
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:423
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:446
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:461
@ L4_FP_DELETE_OBJ
Flag that indicates that an unmap operation on object capabilities shall try to delete the correspond...
Definition consts.h:201
@ L4_FP_ALL_SPACES
Flag to tell the unmap operation to revoke permissions from all child mappings including the mapping ...
Definition consts.h:187
#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