rm.h

Go to the documentation of this file.

/*
 * (c) 2008-2009 Adam Lackorzynski <adam@os.inf.tu-dresden.de>,
 *               Alexander Warg <warg@os.inf.tu-dresden.de>
 *     economic rights: Technische Universität Dresden (Germany)
 *
 * License: see LICENSE.spdx (in this directory or the directories above)
 */
#pragma once

 
#include <l4/re/env.h>
#include <l4/re/c/dataspace.h>
#include <l4/sys/compiler.h>
 
L4_BEGIN_DECLS

enum l4re_rm_flags_values {
  L4RE_RM_F_R    = L4RE_DS_F_R, 
  L4RE_RM_F_W    = L4RE_DS_F_W,
  L4RE_RM_F_X    = L4RE_DS_F_X,
  L4RE_RM_F_RX   = L4RE_DS_F_RX,
  L4RE_RM_F_RW   = L4RE_DS_F_RW,
  L4RE_RM_F_RWX  = L4RE_DS_F_RWX,
 
  L4RE_RM_F_KERNEL       = 0x100, 
  L4RE_RM_F_DETACH_FREE  = 0x200, 
  L4RE_RM_F_PAGER        = 0x400, 
  L4RE_RM_F_RESERVED     = 0x800, 
 
  L4RE_RM_CACHING_SHIFT    = 4, 

  L4RE_RM_F_CACHING      = L4RE_DS_F_CACHING_MASK,
 
  L4RE_RM_REGION_FLAGS = 0xffff, 

  L4RE_RM_F_CACHE_NORMAL   = L4RE_DS_F_NORMAL,

  L4RE_RM_F_CACHE_BUFFERED = L4RE_DS_F_BUFFERABLE,

  L4RE_RM_F_CACHE_UNCACHED = L4RE_DS_F_UNCACHEABLE,
 
  L4RE_RM_F_SEARCH_ADDR  = 0x020000, 
  L4RE_RM_F_IN_AREA      = 0x040000, 
  L4RE_RM_F_EAGER_MAP    = 0x080000, 
  L4RE_RM_F_NO_EAGER_MAP = 0x100000, 
  L4RE_RM_F_ATTACH_FLAGS = 0x1f0000, 
};
 
typedef l4_uint32_t l4re_rm_flags_t;
typedef l4_uint64_t l4re_rm_offset_t;

L4_CV L4_INLINE int
l4re_rm_reserve_area(l4_addr_t *start, unsigned long size,
                     l4re_rm_flags_t flags, unsigned char align) L4_NOTHROW;

L4_CV L4_INLINE int
l4re_rm_free_area(l4_addr_t addr) L4_NOTHROW;

L4_CV L4_INLINE 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;

L4_CV L4_INLINE int
l4re_rm_attach_w_info(void **start, unsigned long size, l4re_rm_flags_t flags,
                      l4re_ds_t mem, l4re_rm_offset_t offs,
                      unsigned char align,
                      char const *name,
                      l4re_ds_offset_t backing_offset) L4_NOTHROW;
 

L4_CV L4_INLINE int
l4re_rm_detach(void *addr) L4_NOTHROW;

L4_CV L4_INLINE int
l4re_rm_detach_ds(void *addr, l4re_ds_t *ds) L4_NOTHROW;

L4_CV L4_INLINE int
l4re_rm_detach_unmap(l4_addr_t addr, l4_cap_idx_t task) L4_NOTHROW;

L4_CV L4_INLINE int
l4re_rm_detach_ds_unmap(void *addr, l4re_ds_t *ds,
                        l4_cap_idx_t task) L4_NOTHROW;
 

L4_CV L4_INLINE 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;

L4_CV L4_INLINE int
l4re_rm_get_info(l4_addr_t addr,
                 char *name, unsigned int len,
                 l4re_rm_offset_t *backing_offset) L4_NOTHROW;
 

L4_CV L4_INLINE void
l4re_rm_show_lists(void) L4_NOTHROW;
 
 
/*
 * Variants of functions that also take a capability of the region map
 * service.
 */
 

L4_CV 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;

L4_CV int
l4re_rm_free_area_srv(l4_cap_idx_t rm, l4_addr_t addr) L4_NOTHROW;

L4_CV 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;

L4_CV int
l4re_rm_attach_w_info_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,
                          char const *name,
                          l4re_ds_offset_t backing_offset) L4_NOTHROW;
 

L4_CV 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;
 

L4_CV 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;
 

L4_CV 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;

L4_CV void
l4re_rm_show_lists_srv(l4_cap_idx_t rm) L4_NOTHROW;
 
 
/********** Implementations ***************************/
 
L4_CV L4_INLINE int
l4re_rm_reserve_area(l4_addr_t *start, unsigned long size,
                     l4re_rm_flags_t flags, unsigned char align) L4_NOTHROW
{
  return l4re_rm_reserve_area_srv(l4re_global_env->rm, start, size,
                                  flags, align);
}
 
L4_CV L4_INLINE int
l4re_rm_free_area(l4_addr_t addr) L4_NOTHROW
{
  return l4re_rm_free_area_srv(l4re_global_env->rm, addr);
}
 
L4_CV L4_INLINE 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
{
  return l4re_rm_attach_srv(l4re_global_env->rm, start, size,
                            flags, mem, offs, align);
}
 
L4_CV L4_INLINE int
l4re_rm_attach_w_info(void **start, unsigned long size, l4re_rm_flags_t flags,
                      l4re_ds_t mem, l4re_rm_offset_t offs,
                      unsigned char align,
                      char const *name,
                      l4re_ds_offset_t backing_offset) L4_NOTHROW
{
  return l4re_rm_attach_w_info_srv(l4re_global_env->rm, start, size,
                                   flags, mem, offs, align,
                                   name, backing_offset);
}
 
 
L4_CV L4_INLINE int
l4re_rm_detach(void *addr) L4_NOTHROW
{
  return l4re_rm_detach_srv(l4re_global_env->rm,
                            (l4_addr_t)addr, 0, L4_BASE_TASK_CAP);
}
 
L4_CV L4_INLINE int
l4re_rm_detach_unmap(l4_addr_t addr, l4_cap_idx_t task) L4_NOTHROW
{
  return l4re_rm_detach_srv(l4re_global_env->rm, addr, 0, task);
}
 
L4_CV L4_INLINE int
l4re_rm_detach_ds(void *addr, l4re_ds_t *ds) L4_NOTHROW
{
  return l4re_rm_detach_srv(l4re_global_env->rm, (l4_addr_t)addr,
                            ds, L4_BASE_TASK_CAP);
}
 
L4_CV L4_INLINE int
l4re_rm_detach_ds_unmap(void *addr, l4re_ds_t *ds, l4_cap_idx_t task) L4_NOTHROW
{
  return l4re_rm_detach_srv(l4re_global_env->rm, (l4_addr_t)addr,
                            ds, task);
}
 
L4_CV L4_INLINE 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
{
  return l4re_rm_find_srv(l4re_global_env->rm, addr, size, offset, flags, m);
}
 
L4_CV L4_INLINE void
l4re_rm_show_lists(void) L4_NOTHROW
{
  l4re_rm_show_lists_srv(l4re_global_env->rm);
}
 
 
 
L4_CV L4_INLINE int
l4re_rm_get_info(l4_addr_t addr, char *name, unsigned int len,
                 l4re_rm_offset_t *backing_offset) L4_NOTHROW
{
  return l4re_rm_get_info_srv(l4re_global_env->rm, addr, name, len,
                              backing_offset);
}
 
L4_END_DECLS