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
24
30 L4RE_RM_F_R = L4RE_DS_F_R,
31 L4RE_RM_F_W = L4RE_DS_F_W,
32 L4RE_RM_F_X = L4RE_DS_F_X,
33 L4RE_RM_F_RX = L4RE_DS_F_RX,
34 L4RE_RM_F_RW = L4RE_DS_F_RW,
35 L4RE_RM_F_RWX = L4RE_DS_F_RWX,
36
45
50
53
56
58 L4RE_RM_F_IN_AREA = 0x040000,
62};
63
64typedef l4_uint32_t l4re_rm_flags_t;
65typedef l4_uint64_t l4re_rm_offset_t;
66
76l4re_rm_reserve_area(l4_addr_t *start, unsigned long size,
77 l4re_rm_flags_t flags, unsigned char align) L4_NOTHROW;
78
89
99l4re_rm_attach(void **start, unsigned long size, l4re_rm_flags_t flags,
100 l4re_ds_t mem,
101 l4re_rm_offset_t offs,
102 unsigned char align) L4_NOTHROW;
103
104
123l4re_rm_detach(void *addr) L4_NOTHROW;
124
145l4re_rm_detach_ds(void *addr, l4re_ds_t *ds) L4_NOTHROW;
146
160
176l4re_rm_detach_ds_unmap(void *addr, l4re_ds_t *ds,
178
179
187l4re_rm_find(l4_addr_t *addr, unsigned long *size,
188 l4re_rm_offset_t *offset,
189 l4re_rm_flags_t *flags, l4re_ds_t *m) L4_NOTHROW;
190
197L4_CV L4_INLINE void
199
200
201/*
202 * Variants of functions that also take a capability of the region map
203 * service.
204 */
205
206
211L4_CV int
212l4re_rm_reserve_area_srv(l4_cap_idx_t rm, l4_addr_t *start, unsigned long size,
213 l4re_rm_flags_t flags, unsigned char align) L4_NOTHROW;
214
219L4_CV int
221
226L4_CV int
227l4re_rm_attach_srv(l4_cap_idx_t rm, void **start, unsigned long size,
228 l4re_rm_flags_t flags, l4re_ds_t mem,
229 l4re_rm_offset_t offs,
230 unsigned char align) L4_NOTHROW;
231
232
237L4_CV int
240
241
246L4_CV int
248 unsigned long *size, l4re_rm_offset_t *offset,
249 l4re_rm_flags_t *flags, l4re_ds_t *m) L4_NOTHROW;
250
255L4_CV void
257
258
259/********** Implementations ***************************/
260
262l4re_rm_reserve_area(l4_addr_t *start, unsigned long size,
263 l4re_rm_flags_t flags, unsigned char align) L4_NOTHROW
264{
265 return l4re_rm_reserve_area_srv(l4re_global_env->rm, start, size,
266 flags, align);
267}
268
271{
272 return l4re_rm_free_area_srv(l4re_global_env->rm, addr);
273}
274
276l4re_rm_attach(void **start, unsigned long size, l4re_rm_flags_t flags,
277 l4re_ds_t mem, l4re_rm_offset_t offs,
278 unsigned char align) L4_NOTHROW
279{
280 return l4re_rm_attach_srv(l4re_global_env->rm, start, size,
281 flags, mem, offs, align);
282}
283
284
287{
288 return l4re_rm_detach_srv(l4re_global_env->rm,
289 (l4_addr_t)addr, 0, L4_BASE_TASK_CAP);
290}
291
294{
295 return l4re_rm_detach_srv(l4re_global_env->rm, addr, 0, task);
296}
297
300{
301 return l4re_rm_detach_srv(l4re_global_env->rm, (l4_addr_t)addr,
302 ds, L4_BASE_TASK_CAP);
303}
304
307{
308 return l4re_rm_detach_srv(l4re_global_env->rm, (l4_addr_t)addr,
309 ds, task);
310}
311
313l4re_rm_find(l4_addr_t *addr, unsigned long *size,
314 l4re_rm_offset_t *offset,
315 l4re_rm_flags_t *flags, l4re_ds_t *m) L4_NOTHROW
316{
317 return l4re_rm_find_srv(l4re_global_env->rm, addr, size, offset, flags, m);
318}
319
320L4_CV L4_INLINE void
322{
323 l4re_rm_show_lists_srv(l4re_global_env->rm);
324}
325
Data space C interface.
Environment interface.
l4_cap_idx_t l4re_ds_t
Dataspace type.
Definition dataspace.h:28
@ L4RE_DS_F_BUFFERABLE
request bufferable (write buffered) mappings
Definition dataspace.h:59
@ L4RE_DS_F_NORMAL
request normal memory mapping
Definition dataspace.h:57
@ L4RE_DS_F_CACHING_MASK
mask for caching flags
Definition dataspace.h:61
@ L4RE_DS_F_UNCACHEABLE
request uncacheable memory mappings
Definition dataspace.h:60
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:276
int l4re_rm_detach(void *addr) L4_NOTHROW
Detach and unmap a region from the address space in the current task.
Definition rm.h:286
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:321
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:313
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:299
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:293
l4re_rm_flags_values
Flags for region operations.
Definition rm.h:29
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:262
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:306
int l4re_rm_free_area(l4_addr_t addr) L4_NOTHROW
Free an area from the region map.
Definition rm.h:270
@ L4RE_RM_F_CACHE_BUFFERED
Cache bits for buffered (write combining) memory.
Definition rm.h:52
@ L4RE_RM_REGION_FLAGS
Mask of all region flags.
Definition rm.h:46
@ L4RE_RM_F_CACHE_UNCACHED
Cache bits for uncached memory.
Definition rm.h:55
@ L4RE_RM_CACHING_SHIFT
Start of region mapper cache bits.
Definition rm.h:41
@ L4RE_RM_F_NO_EAGER_MAP
Prevent eager mapping of the attached data space.
Definition rm.h:60
@ L4RE_RM_F_SEARCH_ADDR
Search for a suitable address range.
Definition rm.h:57
@ L4RE_RM_F_PAGER
Region has a pager.
Definition rm.h:38
@ L4RE_RM_F_R
Region is read-only.
Definition rm.h:30
@ L4RE_RM_F_IN_AREA
Search only in area, or map into area.
Definition rm.h:58
@ L4RE_RM_F_CACHE_NORMAL
Cache bits for normal cacheable memory.
Definition rm.h:49
@ L4RE_RM_F_ATTACH_FLAGS
Mask of all attach flags.
Definition rm.h:61
@ L4RE_RM_F_RESERVED
Region is reserved (blocked)
Definition rm.h:39
@ L4RE_RM_F_EAGER_MAP
Eagerly map the attached data space in.
Definition rm.h:59
@ L4RE_RM_F_NO_ALIAS
The region contains exclusive memory that is not mapped anywhere else.
Definition rm.h:37
@ L4RE_RM_F_CACHING
Mask of all region manager cache bits.
Definition rm.h:44
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:335
@ L4_BASE_TASK_CAP
Capability selector for the current task.
Definition consts.h:331
#define __END_DECLS
End section with C types and functions.
Definition compiler.h:167
#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:159
#define L4_INLINE
L4 Inline function attribute.
Definition compiler.h:51
#define __BEGIN_DECLS
Start section with C types and functions.
Definition compiler.h:164
l4_cap_idx_t rm
Region map object-capability.
Definition env.h:101