L4Re Operating System Framework
Interface and Usage Documentation
All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
env
Go to the documentation of this file.
1// -*- Mode: C++ -*-
2// vim:ft=cpp
7/*
8 * (c) 2008-2009 Adam Lackorzynski <adam@os.inf.tu-dresden.de>,
9 * Alexander Warg <warg@os.inf.tu-dresden.de>,
10 * Björn Döbel <doebel@os.inf.tu-dresden.de>
11 * economic rights: Technische Universität Dresden (Germany)
12 *
13 * License: see LICENSE.spdx (in this directory or the directories above)
14 */
15#pragma once
16
17#include <l4/sys/types.h>
18
19#include <l4/re/rm>
20#include <l4/re/parent>
21#include <l4/re/mem_alloc>
22#include <l4/re/log>
23#include <l4/re/consts>
24
25#include <l4/re/env.h>
26
27namespace L4 {
28class Scheduler;
29}
30
34namespace L4Re
35{
36 class Itas;
37 class Dbg_events;
38
79 {
80 private:
81 l4re_env_t _env;
82 public:
83
88
96 static Env const *env() noexcept
97 { return reinterpret_cast<Env*>(l4re_global_env); }
98
103 L4::Cap<Parent> parent() const noexcept
104 { return L4::Cap<Parent>(_env.parent); }
110 { return L4::Cap<Mem_alloc>(_env.mem_alloc); }
115 { return L4::Cap<L4::Factory>(_env.mem_alloc); }
120 L4::Cap<Rm> rm() const noexcept
121 { return L4::Cap<Rm>(_env.rm); }
126 L4::Cap<Log> log() const noexcept
127 { return L4::Cap<Log>(_env.log); }
133 { return L4::Cap<L4::Thread>(_env.main_thread); }
138 L4::Cap<L4::Task> task() const noexcept
139 { return L4::Cap<L4::Task>(L4RE_THIS_TASK_CAP); }
145 { return L4::Cap<L4::Factory>(_env.factory); }
153 { return _env.first_free_cap; }
158 l4_fpage_t utcb_area() const noexcept
159 { return _env.utcb_area; }
167 l4_addr_t first_free_utcb() const noexcept
168 { return _env.first_free_utcb; }
169
174 Cap_entry const *initial_caps() const noexcept
175 { return _env.caps; }
176
185 Cap_entry const *get(char const *name, unsigned l) const noexcept
186 { return l4re_env_get_cap_l(name, l, &_env); }
187
196 template< typename T >
197 L4::Cap<T> get_cap(char const *name, unsigned l) const noexcept
198 {
199 if (Cap_entry const *e = get(name, l))
200 return L4::Cap<T>(e->cap);
201
202 return L4::Cap<T>(-L4_ENOENT);
203 }
204
211 template< typename T >
212 L4::Cap<T> get_cap(char const *name) const noexcept
213 { return get_cap<T>(name, __builtin_strlen(name)); }
214
219 void parent(L4::Cap<Parent> const &c) noexcept
220 { _env.parent = c.cap(); }
225 void mem_alloc(L4::Cap<Mem_alloc> const &c) noexcept
226 { _env.mem_alloc = c.cap(); }
231 void rm(L4::Cap<Rm> const &c) noexcept
232 { _env.rm = c.cap(); }
237 void log(L4::Cap<Log> const &c) noexcept
238 { _env.log = c.cap(); }
243 void main_thread(L4::Cap<L4::Thread> const &c) noexcept
244 { _env.main_thread = c.cap(); }
249 void factory(L4::Cap<L4::Factory> const &c) noexcept
250 { _env.factory = c.cap(); }
256 { _env.first_free_cap = c; }
261 void utcb_area(l4_fpage_t utcbs) noexcept
262 { _env.utcb_area = utcbs; }
267 void first_free_utcb(l4_addr_t u) noexcept
268 { _env.first_free_utcb = u; }
269
276 { return L4::Cap<L4::Scheduler>(_env.scheduler); }
277
282 void scheduler(L4::Cap<L4::Scheduler> const &c) noexcept
283 { _env.scheduler = c.cap(); }
284
294 L4::Cap<Itas> itas() const noexcept
295 { return L4::Cap<Itas>(_env.itas); }
296
301 void itas(L4::Cap<Itas> const &c) noexcept
302 { _env.itas = c.cap(); }
303
311 { return L4::Cap<Dbg_events>(_env.dbg_events); }
312
320 void dbg_events(L4::Cap<Dbg_events> const &dbg_events) noexcept
321 { _env.dbg_events = dbg_events.cap(); }
322
327 void initial_caps(Cap_entry *first) noexcept
328 { _env.caps = first; }
329 };
330};
C++ interface of the initial environment that is provided to an L4 task.
Definition env:79
L4::Cap< L4::Scheduler > scheduler() const noexcept
Get the scheduler capability for the task.
Definition env:275
void first_free_cap(l4_cap_idx_t c) noexcept
Set first available capability selector.
Definition env:255
Cap_entry const * get(char const *name, unsigned l) const noexcept
Get the Cap_entry for the object named name.
Definition env:185
static Env const * env() noexcept
Returns the initial environment for the current task.
Definition env:96
l4_cap_idx_t first_free_cap() const noexcept
First available capability selector.
Definition env:152
void scheduler(L4::Cap< L4::Scheduler > const &c) noexcept
Set the scheduler capability.
Definition env:282
L4::Cap< L4::Factory > factory() const noexcept
Object-capability to the factory object available to the task.
Definition env:144
L4::Cap< Mem_alloc > mem_alloc() const noexcept
Object-capability to the memory allocator.
Definition env:109
L4::Cap< L4::Factory > user_factory() const noexcept
Object-capability to the user-level object factory.
Definition env:114
void log(L4::Cap< Log > const &c) noexcept
Set log object-capability.
Definition env:237
L4::Cap< L4::Thread > main_thread() const noexcept
Object-capability of the first user thread.
Definition env:132
void mem_alloc(L4::Cap< Mem_alloc > const &c) noexcept
Set memory allocator object-capability.
Definition env:225
void factory(L4::Cap< L4::Factory > const &c) noexcept
Set factory object-capability.
Definition env:249
L4::Cap< T > get_cap(char const *name) const noexcept
Get the capability selector for the object named name.
Definition env:212
l4re_env_cap_entry_t Cap_entry
C++ type for an entry in the initial objects array.
Definition env:87
Cap_entry const * initial_caps() const noexcept
Get a pointer to the first entry in the initial objects array.
Definition env:174
L4::Cap< Log > log() const noexcept
Object-capability to the logging service.
Definition env:126
L4::Cap< Dbg_events > dbg_events() const noexcept
Object-capability to a debugger events service.
Definition env:310
void utcb_area(l4_fpage_t utcbs) noexcept
Set UTCB area of the task.
Definition env:261
void first_free_utcb(l4_addr_t u) noexcept
Set first free UTCB.
Definition env:267
L4::Cap< Rm > rm() const noexcept
Object-capability to the region map.
Definition env:120
void initial_caps(Cap_entry *first) noexcept
Set the pointer to the first Cap_entry in the initial objects array.
Definition env:327
L4::Cap< T > get_cap(char const *name, unsigned l) const noexcept
Get the capability selector for the object named name.
Definition env:197
L4::Cap< Itas > itas() const noexcept
Object-capability to the ITAS services.
Definition env:294
void rm(L4::Cap< Rm > const &c) noexcept
Set region map object-capability.
Definition env:231
void dbg_events(L4::Cap< Dbg_events > const &dbg_events) noexcept
Set the dbg_events capability.
Definition env:320
l4_addr_t first_free_utcb() const noexcept
First free UTCB.
Definition env:167
L4::Cap< Parent > parent() const noexcept
Object-capability to the parent.
Definition env:103
void itas(L4::Cap< Itas > const &c) noexcept
Set the ITAS capability.
Definition env:301
l4_fpage_t utcb_area() const noexcept
UTCB area of the task.
Definition env:158
void main_thread(L4::Cap< L4::Thread > const &c) noexcept
Set object-capability of first user thread.
Definition env:243
void parent(L4::Cap< Parent > const &c) noexcept
Set parent object-capability.
Definition env:219
L4::Cap< L4::Task > task() const noexcept
Object-capability of the user task.
Definition env:138
C++ interface for capabilities.
Definition capability.h:224
Environment interface.
l4re_env_cap_entry_t const * l4re_env_get_cap_l(char const *name, unsigned l, l4re_env_t const *e) L4_NOTHROW
Get the full l4re_env_cap_entry_t for the object named name.
Definition env.h:189
unsigned long l4_addr_t
Address type.
Definition l4int.h:34
unsigned long l4_cap_idx_t
Capability selector type.
Definition types.h:335
@ L4_ENOENT
No such entity.
Definition err.h:34
#define L4_EXPORT
Attribute to mark functions, variables, and data types as being exported from a library.
Definition compiler.h:210
Common L4 ABI Data Types.
Log interface.
Memory allocator interface.
L4Re C++ Interfaces.
Definition cmd_control:14
L4 low-level kernel interface.
Parent interface.
Constants.
Region mapper interface.
Entry in the L4Re environment array for the named initial objects.
Definition env.h:40
Initial environment data structure.
Definition env.h:99
l4_cap_idx_t factory
Object-capability of the factory available to the task.
Definition env.h:105
l4_cap_idx_t mem_alloc
Memory allocator object-capability.
Definition env.h:102
l4_cap_idx_t scheduler
Object capability for the scheduler set to use.
Definition env.h:106
l4_cap_idx_t rm
Region map object-capability.
Definition env.h:101
l4_addr_t first_free_utcb
First UTCB within the UTCB area available to the application.
Definition env.h:111
l4_cap_idx_t first_free_cap
First capability index available to the application.
Definition env.h:109
l4_cap_idx_t itas
ITAS services object-capability.
Definition env.h:107
l4_cap_idx_t dbg_events
Object-capability of the debug events service.
Definition env.h:108
l4re_env_cap_entry_t * caps
Pointer to the first entry in the initial objects array which contains l4re_env_cap_entry_t elements.
Definition env.h:117
l4_cap_idx_t main_thread
Object-capability of the first user thread.
Definition env.h:104
l4_fpage_t utcb_area
UTCB area of the task.
Definition env.h:110
l4_cap_idx_t parent
Parent object-capability.
Definition env.h:100
l4_cap_idx_t log
Logging object-capability.
Definition env.h:103
L4 flexpage type.
Definition __l4_fpage.h:76