L4Re Operating System Framework
Interface and Usage Documentation
All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
rm.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 * economic rights: Technische Universität Dresden (Germany)
9 *
10 * License: see LICENSE.spdx (in this directory or the directories above)
11 */
12#pragma once
13
20#include <l4/re/env.h>
21#include <l4/re/c/dataspace.h>
22#include <l4/sys/compiler.h>
23
25
31 L4RE_RM_F_R = L4RE_DS_F_R,
32 L4RE_RM_F_W = L4RE_DS_F_W,
33 L4RE_RM_F_X = L4RE_DS_F_X,
34 L4RE_RM_F_RX = L4RE_DS_F_RX,
35 L4RE_RM_F_RW = L4RE_DS_F_RW,
36 L4RE_RM_F_RWX = L4RE_DS_F_RWX,
37
46
51
54
57
59 L4RE_RM_F_IN_AREA = 0x040000,
63};
64
65typedef l4_uint32_t l4re_rm_flags_t;
66typedef l4_uint64_t l4re_rm_offset_t;
67
77l4re_rm_reserve_area(l4_addr_t *start, unsigned long size,
78 l4re_rm_flags_t flags, unsigned char align) L4_NOTHROW;
79
90
142l4re_rm_attach(void **start, unsigned long size, l4re_rm_flags_t flags,
143 l4re_ds_t mem, l4re_rm_offset_t offs,
144 unsigned char align) L4_NOTHROW;
145
146
165l4re_rm_detach(void *addr) L4_NOTHROW;
166
187l4re_rm_detach_ds(void *addr, l4re_ds_t *ds) L4_NOTHROW;
188
202
218l4re_rm_detach_ds_unmap(void *addr, l4re_ds_t *ds,
220
221
229l4re_rm_find(l4_addr_t *addr, unsigned long *size,
230 l4re_rm_offset_t *offset,
231 l4re_rm_flags_t *flags, l4re_ds_t *m) L4_NOTHROW;
232
242 char *name, unsigned int len,
243 l4re_rm_offset_t *backing_offset) L4_NOTHROW;
244
245
252L4_CV L4_INLINE void
254
255
256/*
257 * Variants of functions that also take a capability of the region map
258 * service.
259 */
260
261
266L4_CV int
267l4re_rm_reserve_area_srv(l4_cap_idx_t rm, l4_addr_t *start, unsigned long size,
268 l4re_rm_flags_t flags, unsigned char align) L4_NOTHROW;
269
274L4_CV int
276
281L4_CV int
282l4re_rm_attach_srv(l4_cap_idx_t rm, void **start, unsigned long size,
283 l4re_rm_flags_t flags, l4re_ds_t mem,
284 l4re_rm_offset_t offs,
285 unsigned char align) L4_NOTHROW;
286
287
292L4_CV int
295
296
301L4_CV int
303 unsigned long *size, l4re_rm_offset_t *offset,
304 l4re_rm_flags_t *flags, l4re_ds_t *m) L4_NOTHROW;
305
306
311L4_CV int
313 char *name, unsigned int len,
314 l4re_rm_offset_t *backing_offset) L4_NOTHROW;
315
320L4_CV void
322
323
324/********** Implementations ***************************/
325
327l4re_rm_reserve_area(l4_addr_t *start, unsigned long size,
328 l4re_rm_flags_t flags, unsigned char align) L4_NOTHROW
329{
330 return l4re_rm_reserve_area_srv(l4re_global_env->rm, start, size,
331 flags, align);
332}
333
336{
337 return l4re_rm_free_area_srv(l4re_global_env->rm, addr);
338}
339
341l4re_rm_attach(void **start, unsigned long size, l4re_rm_flags_t flags,
342 l4re_ds_t mem, l4re_rm_offset_t offs,
343 unsigned char align) L4_NOTHROW
344{
345 return l4re_rm_attach_srv(l4re_global_env->rm, start, size,
346 flags, mem, offs, align);
347}
348
349
352{
353 return l4re_rm_detach_srv(l4re_global_env->rm,
354 (l4_addr_t)addr, 0, L4_BASE_TASK_CAP);
355}
356
359{
360 return l4re_rm_detach_srv(l4re_global_env->rm, addr, 0, task);
361}
362
365{
366 return l4re_rm_detach_srv(l4re_global_env->rm, (l4_addr_t)addr,
367 ds, L4_BASE_TASK_CAP);
368}
369
372{
373 return l4re_rm_detach_srv(l4re_global_env->rm, (l4_addr_t)addr,
374 ds, task);
375}
376
378l4re_rm_find(l4_addr_t *addr, unsigned long *size,
379 l4re_rm_offset_t *offset,
380 l4re_rm_flags_t *flags, l4re_ds_t *m) L4_NOTHROW
381{
382 return l4re_rm_find_srv(l4re_global_env->rm, addr, size, offset, flags, m);
383}
384
385L4_CV L4_INLINE void
387{
388 l4re_rm_show_lists_srv(l4re_global_env->rm);
389}
390
391
392
394l4re_rm_get_info(l4_addr_t addr, char *name, unsigned int len,
395 l4re_rm_offset_t *backing_offset) L4_NOTHROW
396{
397 return l4re_rm_get_info_srv(l4re_global_env->rm, addr, name, len,
398 backing_offset);
399}
400
L4 compiler related defines.
Data space C interface.
Environment interface.
L4_BEGIN_DECLS typedef l4_cap_idx_t l4re_ds_t
Dataspace type.
Definition dataspace.h:29
@ L4RE_DS_F_BUFFERABLE
request bufferable (write buffered) mappings
Definition dataspace.h:60
@ L4RE_DS_F_NORMAL
request normal memory mapping
Definition dataspace.h:58
@ L4RE_DS_F_CACHING_MASK
mask for caching flags
Definition dataspace.h:62
@ L4RE_DS_F_UNCACHEABLE
request uncacheable memory mappings
Definition dataspace.h:61
int l4re_rm_attach(void **start, unsigned long size, l4re_rm_flags_t flags, l4re_ds_t mem, l4re_rm_offset_t offs, unsigned char align) L4_NOTHROW
Attach a data space to a region.
Definition rm.h:341
int l4re_rm_detach(void *addr) L4_NOTHROW
Detach and unmap a region from the address space in the current task.
Definition rm.h:351
void l4re_rm_show_lists_srv(l4_cap_idx_t rm) L4_NOTHROW
Dump region map internal data structures.
int l4re_rm_attach_srv(l4_cap_idx_t rm, void **start, unsigned long size, l4re_rm_flags_t flags, l4re_ds_t mem, l4re_rm_offset_t offs, unsigned char align) L4_NOTHROW
int l4re_rm_reserve_area_srv(l4_cap_idx_t rm, l4_addr_t *start, unsigned long size, l4re_rm_flags_t flags, unsigned char align) L4_NOTHROW
void l4re_rm_show_lists(void) L4_NOTHROW
Dump region map internal data structures.
Definition rm.h:386
int l4re_rm_find(l4_addr_t *addr, unsigned long *size, l4re_rm_offset_t *offset, l4re_rm_flags_t *flags, l4re_ds_t *m) L4_NOTHROW
Find a region given an address and size.
Definition rm.h:378
int l4re_rm_get_info(l4_addr_t addr, char *name, unsigned int len, l4re_rm_offset_t *backing_offset) L4_NOTHROW
Return auxiliary information of a region.
Definition rm.h:394
int l4re_rm_detach_ds(void *addr, l4re_ds_t *ds) L4_NOTHROW
Detach and unmap a region and return affected dataspace in the current task.
Definition rm.h:364
int l4re_rm_detach_srv(l4_cap_idx_t rm, l4_addr_t addr, l4re_ds_t *ds, l4_cap_idx_t task) L4_NOTHROW
int l4re_rm_detach_unmap(l4_addr_t addr, l4_cap_idx_t task) L4_NOTHROW
Detach and unmap in specified task.
Definition rm.h:358
l4re_rm_flags_values
Flags for region operations.
Definition rm.h:30
int l4re_rm_find_srv(l4_cap_idx_t rm, l4_addr_t *addr, unsigned long *size, l4re_rm_offset_t *offset, l4re_rm_flags_t *flags, l4re_ds_t *m) L4_NOTHROW
int l4re_rm_free_area_srv(l4_cap_idx_t rm, l4_addr_t addr) L4_NOTHROW
int l4re_rm_reserve_area(l4_addr_t *start, unsigned long size, l4re_rm_flags_t flags, unsigned char align) L4_NOTHROW
Reserve the given area in the region map.
Definition rm.h:327
int l4re_rm_detach_ds_unmap(void *addr, l4re_ds_t *ds, l4_cap_idx_t task) L4_NOTHROW
Detach and unmap in specified task.
Definition rm.h:371
int l4re_rm_free_area(l4_addr_t addr) L4_NOTHROW
Free an area from the region map.
Definition rm.h:335
int l4re_rm_get_info_srv(l4_cap_idx_t rm, l4_addr_t addr, char *name, unsigned int len, l4re_rm_offset_t *backing_offset) L4_NOTHROW
@ L4RE_RM_F_CACHE_BUFFERED
Cache bits for buffered (write combining) memory.
Definition rm.h:53
@ L4RE_RM_REGION_FLAGS
Mask of all region flags.
Definition rm.h:47
@ L4RE_RM_F_CACHE_UNCACHED
Cache bits for uncached memory.
Definition rm.h:56
@ L4RE_RM_CACHING_SHIFT
Start of region mapper cache bits.
Definition rm.h:42
@ L4RE_RM_F_NO_EAGER_MAP
Prevent eager mapping of the attached data space.
Definition rm.h:61
@ L4RE_RM_F_SEARCH_ADDR
Search for a suitable address range.
Definition rm.h:58
@ L4RE_RM_F_PAGER
Region has a pager.
Definition rm.h:39
@ L4RE_RM_F_R
Region is read-only.
Definition rm.h:31
@ L4RE_RM_F_IN_AREA
Search only in area, or map into area.
Definition rm.h:59
@ L4RE_RM_F_CACHE_NORMAL
Cache bits for normal cacheable memory.
Definition rm.h:50
@ L4RE_RM_F_ATTACH_FLAGS
Mask of all attach flags.
Definition rm.h:62
@ L4RE_RM_F_RESERVED
Region is reserved (blocked)
Definition rm.h:40
@ L4RE_RM_F_EAGER_MAP
Eagerly map the attached data space in.
Definition rm.h:60
@ L4RE_RM_F_NO_ALIAS
The region contains exclusive memory that is not mapped anywhere else.
Definition rm.h:38
@ L4RE_RM_F_CACHING
Mask of all region manager cache bits.
Definition rm.h:45
unsigned long l4_addr_t
Address type.
Definition l4int.h:34
unsigned int l4_uint32_t
Unsigned 32bit value.
Definition l4int.h:29
unsigned long long l4_uint64_t
Unsigned 64bit value.
Definition l4int.h:31
unsigned long l4_cap_idx_t
Capability selector type.
Definition types.h:336
@ L4_BASE_TASK_CAP
Capability selector for the current task.
Definition consts.h:327
#define L4_CV
Define calling convention.
Definition linkage.h:33
#define L4_NOTHROW
Mark a function declaration and definition as never throwing an exception.
Definition compiler.h:161
#define L4_INLINE
L4 Inline function attribute.
Definition compiler.h:51
#define L4_BEGIN_DECLS
Start section with C types and functions.
Definition compiler.h:165
#define L4_END_DECLS
End section with C types and functions.
Definition compiler.h:166
l4_cap_idx_t rm
Region map object-capability.
Definition env.h:101