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 * This file is part of TUD:OS and distributed under the terms of the
13 * GNU General Public License 2.
14 * Please see the COPYING-GPL-2 file for details.
15 *
16 * As a special exception, you may use this file as part of a free software
17 * library without restriction. Specifically, if other files instantiate
18 * templates or use macros or inline functions from this file, or you compile
19 * this file and link it with other files to produce an executable, this
20 * file does not by itself cause the resulting executable to be covered by
21 * the GNU General Public License. This exception does not however
22 * invalidate any other reasons why the executable file might be covered by
23 * the GNU General Public License.
24 */
25#pragma once
26#include <l4/sys/types.h>
27#include <l4/sys/utcb.h>
28
89l4_task_map(l4_cap_idx_t dst_task, l4_cap_idx_t src_task,
90 l4_fpage_t snd_fpage, l4_umword_t snd_base) L4_NOTHROW;
91
96l4_task_map_u(l4_cap_idx_t dst_task, l4_cap_idx_t src_task,
97 l4_fpage_t snd_fpage, l4_umword_t snd_base, l4_utcb_t *utcb) L4_NOTHROW;
98
124 l4_umword_t map_mask) L4_NOTHROW;
125
130l4_task_unmap_u(l4_cap_idx_t task, l4_fpage_t fpage,
131 l4_umword_t map_mask, l4_utcb_t *utcb) L4_NOTHROW;
132
154 unsigned num_fpages, l4_umword_t map_mask) L4_NOTHROW;
155
160l4_task_unmap_batch_u(l4_cap_idx_t task, l4_fpage_t const *fpages,
161 unsigned num_fpages, l4_umword_t map_mask,
163
187
192l4_task_delete_obj_u(l4_cap_idx_t task, l4_cap_idx_t obj,
194
213
218l4_task_release_cap_u(l4_cap_idx_t task, l4_cap_idx_t cap,
220
221
241
246l4_task_cap_valid_u(l4_cap_idx_t task, l4_cap_idx_t cap, l4_utcb_t *utcb) L4_NOTHROW;
247
263
268l4_task_add_ku_mem_u(l4_cap_idx_t task, l4_fpage_t ku_mem,
270
297
298
303l4_task_cap_equal_u(l4_cap_idx_t task, l4_cap_idx_t cap_a,
304 l4_cap_idx_t cap_b, l4_utcb_t *utcb) L4_NOTHROW;
305
319
320
321/* IMPLEMENTATION -----------------------------------------------------------*/
322
323#include <l4/sys/ipc.h>
324
325
327l4_task_map_u(l4_cap_idx_t dst_task, l4_cap_idx_t src_task,
328 l4_fpage_t snd_fpage, l4_umword_t snd_base, l4_utcb_t *u) L4_NOTHROW
329{
330 l4_msg_regs_t *v = l4_utcb_mr_u(u);
331 v->mr[0] = L4_TASK_MAP_OP;
332 v->mr[3] = l4_map_obj_control(0,0);
333 v->mr[4] = l4_obj_fpage(src_task, 0, L4_CAP_FPAGE_RWS).raw;
334 v->mr[1] = snd_base;
335 v->mr[2] = snd_fpage.raw;
336 return l4_ipc_call(dst_task, u, l4_msgtag(L4_PROTO_TASK, 3, 1, 0), L4_IPC_NEVER);
337}
338
340l4_task_unmap_u(l4_cap_idx_t task, l4_fpage_t fpage,
341 l4_umword_t map_mask, l4_utcb_t *u) L4_NOTHROW
342{
343 l4_msg_regs_t *v = l4_utcb_mr_u(u);
344 v->mr[0] = L4_TASK_UNMAP_OP;
345 v->mr[1] = map_mask;
346 v->mr[2] = fpage.raw;
347 return l4_ipc_call(task, u, l4_msgtag(L4_PROTO_TASK, 3, 0, 0), L4_IPC_NEVER);
348}
349
351l4_task_unmap_batch_u(l4_cap_idx_t task, l4_fpage_t const *fpages,
352 unsigned num_fpages, l4_umword_t map_mask,
354{
355 l4_msg_regs_t *v = l4_utcb_mr_u(u);
356 v->mr[0] = L4_TASK_UNMAP_OP;
357 v->mr[1] = map_mask;
358 __builtin_memcpy(&v->mr[2], fpages, num_fpages * sizeof(l4_fpage_t));
359 return l4_ipc_call(task, u, l4_msgtag(L4_PROTO_TASK, 2 + num_fpages, 0, 0), L4_IPC_NEVER);
360}
361
363l4_task_cap_valid_u(l4_cap_idx_t task, l4_cap_idx_t cap, l4_utcb_t *u) L4_NOTHROW
364{
365 l4_msg_regs_t *v = l4_utcb_mr_u(u);
366 v->mr[0] = L4_TASK_CAP_INFO_OP;
367 v->mr[1] = cap & ~1UL;
368 return l4_ipc_call(task, u, l4_msgtag(L4_PROTO_TASK, 2, 0, 0), L4_IPC_NEVER);
369}
370
372l4_task_cap_equal_u(l4_cap_idx_t task, l4_cap_idx_t cap_a,
374{
375 l4_msg_regs_t *v = l4_utcb_mr_u(u);
376 v->mr[0] = L4_TASK_CAP_INFO_OP;
377 v->mr[1] = cap_a;
378 v->mr[2] = cap_b;
379 return l4_ipc_call(task, u, l4_msgtag(L4_PROTO_TASK, 3, 0, 0), L4_IPC_NEVER);
380}
381
383l4_task_add_ku_mem_u(l4_cap_idx_t task, l4_fpage_t ku_mem,
385{
386 l4_msg_regs_t *v = l4_utcb_mr_u(u);
388 v->mr[1] = ku_mem.raw;
389 return l4_ipc_call(task, u, l4_msgtag(L4_PROTO_TASK, 2, 0, 0), L4_IPC_NEVER);
390}
391
392
393
396 l4_fpage_t snd_fpage, l4_umword_t snd_base) L4_NOTHROW
397{
398 return l4_task_map_u(dst_task, src_task, snd_fpage, snd_base, l4_utcb());
399}
400
403 l4_umword_t map_mask) L4_NOTHROW
404{
405 return l4_task_unmap_u(task, fpage, map_mask, l4_utcb());
406}
407
410 unsigned num_fpages, l4_umword_t map_mask) L4_NOTHROW
411{
412 return l4_task_unmap_batch_u(task, fpages, num_fpages, map_mask,
413 l4_utcb());
414}
415
417l4_task_delete_obj_u(l4_cap_idx_t task, l4_cap_idx_t obj,
419{
420 return l4_task_unmap_u(task, l4_obj_fpage(obj, 0, L4_CAP_FPAGE_RWSD),
422}
423
426{
427 return l4_task_delete_obj_u(task, obj, l4_utcb());
428}
429
430
432l4_task_release_cap_u(l4_cap_idx_t task, l4_cap_idx_t cap,
434{
435 return l4_task_unmap_u(task, l4_obj_fpage(cap, 0, L4_CAP_FPAGE_RWSD),
437}
438
441{
442 return l4_task_release_cap_u(task, cap, l4_utcb());
443}
444
447{
448 return l4_task_cap_valid_u(task, cap, l4_utcb());
449}
450
454{
455 return l4_task_cap_equal_u(task, cap_a, cap_b, l4_utcb());
456}
457
460{
461 return l4_task_add_ku_mem_u(task, ku_mem, l4_utcb());
462}
unsigned long l4_umword_t
Unsigned machine word.
Definition l4int.h:51
unsigned long l4_cap_idx_t
Capability selector type.
Definition types.h:358
l4_fpage_t l4_obj_fpage(l4_cap_idx_t obj, unsigned int order, unsigned char rights) L4_NOTHROW
Create a kernel-object flex page.
Definition __l4_fpage.h:680
@ L4_CAP_FPAGE_RWSD
Full rights for capability flex-pages.
Definition __l4_fpage.h:215
@ L4_CAP_FPAGE_RWS
Read, interface specific 'W', and 'S' rights for capability flex-pages.
Definition __l4_fpage.h:209
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:550
l4_umword_t l4_map_obj_control(l4_umword_t spot, unsigned grant) L4_NOTHROW
Create the first word for a map item for the object space.
Definition __l4_fpage.h:714
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:427
@ L4_PROTO_TASK
Protocol for messages to a task object.
Definition types.h:63
L4_task_ops
Operations on task objects.
Definition task.h:311
@ L4_TASK_LDT_SET_X86_OP
x86: LDT set
Definition task.h:316
@ L4_TASK_MAP_VGICC_ARM_OP
Arm: Map virtual GICC area.
Definition task.h:317
@ L4_TASK_ADD_KU_MEM_OP
Add kernel-user memory.
Definition task.h:315
@ L4_TASK_CAP_INFO_OP
Cap info.
Definition task.h:314
@ L4_TASK_MAP_OP
Map.
Definition task.h:312
@ L4_TASK_UNMAP_OP
Unmap.
Definition task.h:313
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:452
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:409
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:459
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:446
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:395
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:402
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:425
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:440
@ L4_FP_DELETE_OBJ
Flag that indicates that an unmap operation on object capabilities shall try to delete the correspond...
Definition consts.h:209
@ L4_FP_ALL_SPACES
Flag to tell the unmap operation to revoke permissions from all child mappings including the mapping ...
Definition consts.h:198
#define L4_IPC_NEVER
never timeout
Definition __timeout.h:82
struct l4_utcb_t l4_utcb_t
Opaque type for the UTCB.
Definition utcb.h:67
l4_utcb_t * l4_utcb(void) L4_NOTHROW L4_PURE
Get the UTCB address.
Definition utcb.h:340
#define L4_NOTHROW
Mark a function declaration and definition as never throwing an exception.
Definition compiler.h:188
#define L4_INLINE
L4 Inline function attribute.
Definition compiler.h:62
Common L4 ABI Data Types.
Message tag data structure.
Definition types.h:163
L4 flexpage type.
Definition __l4_fpage.h:85
l4_umword_t raw
Raw value.
Definition __l4_fpage.h:87
Encapsulation of the message-register block in the UTCB.
Definition utcb.h:79
l4_umword_t mr[L4_UTCB_GENERIC_DATA_SIZE]
Message registers.
Definition utcb.h:80