L4Re Operating System Framework
Interface and Usage Documentation
Loading...
Searching...
No Matches
types.h
Go to the documentation of this file.
1/*****************************************************************************/
7/*
8 * (c) 2008-2013 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 * Torsten Frenzel <frenzel@os.inf.tu-dresden.de>
12 * economic rights: Technische Universität Dresden (Germany)
13 *
14 * License: see LICENSE.spdx (in this directory or the directories above)
15 */
16/*****************************************************************************/
17#pragma once
18
19#include <l4/sys/l4int.h>
20#include <l4/sys/compiler.h>
21#include <l4/sys/consts.h>
22
23
69
70enum L4_varg_type
71{
72 L4_VARG_TYPE_NIL = 0x00,
73 L4_VARG_TYPE_UMWORD = 0x01,
74 L4_VARG_TYPE_MWORD = 0x81,
75 L4_VARG_TYPE_STRING = 0x02,
76 L4_VARG_TYPE_FPAGE = 0x03,
77
78 L4_VARG_TYPE_SIGN = 0x80,
79};
80
81
87{
88 // flags for received IPC
94
95 // flags for sending IPC
127 L4_MSGTAG_PROPAGATE = 0x4000,
128
134};
135
136
153typedef struct l4_msgtag_t
154{
156#ifdef __cplusplus
158 long label() const L4_NOTHROW
159 {
160#if defined(__cplusplus) && (__cplusplus >= 202002L)
161 return raw >> 16;
162#else
163 return raw < 0 ? ~(~raw >> 16) : raw >> 16;
164#endif
165 }
167 void label(long v) L4_NOTHROW { raw = (raw & 0x0ffff) | ((l4_umword_t)v << 16); }
169 unsigned words() const L4_NOTHROW { return raw & 0x3f; }
171 unsigned items() const L4_NOTHROW { return (raw >> 6) & 0x3f; }
178 unsigned flags() const L4_NOTHROW { return raw & 0xf000; }
180 bool is_page_fault() const L4_NOTHROW { return label() == L4_PROTO_PAGE_FAULT; }
182 bool is_exception() const L4_NOTHROW { return label() == L4_PROTO_EXCEPTION; }
184 bool is_sigma0() const L4_NOTHROW { return label() == L4_PROTO_SIGMA0; }
191 bool has_error() const L4_NOTHROW { return raw & L4_MSGTAG_ERROR; }
192#endif
194
195
196
208L4_INLINE l4_msgtag_t l4_msgtag(long label, unsigned words, unsigned items,
209 unsigned flags) L4_NOTHROW;
210
220
230
240
252
266
276
286
296
306
336typedef unsigned long l4_cap_idx_t;
337
348
359
374
384
385/* ************************************************************************* */
386/* Implementation */
387
388L4_INLINE unsigned
390{ return c & L4_INVALID_CAP_BIT; }
391
392L4_INLINE unsigned
394{ return !(c & L4_INVALID_CAP_BIT); }
395
396L4_INLINE unsigned
399
400
405l4_msgtag_t l4_msgtag(long label, unsigned words, unsigned items,
406 unsigned flags) L4_NOTHROW
407{
408 return (l4_msgtag_t){ (l4_mword_t)((l4_umword_t)label << 16)
409 | (l4_mword_t)(words & 0x3f)
410 | (l4_mword_t)((items & 0x3f) << 6)
411 | (l4_mword_t)(flags & 0xf000)};
412}
413
414
415
418{
419#if defined(__cplusplus) && (__cplusplus >= 202002L)
420 return t.raw >> 16;
421#else
422 return t.raw < 0 ? ~(~t.raw >> 16) : t.raw >> 16;
423#endif
424}
425
428{ return t.raw & 0x3f; }
429
432{ return (t.raw >> 6) & 0x3f; }
433
436{ return t.raw & 0xf000; }
437
438
442
443
444
447
450
453
456
459
460#include <l4/sys/__l4_fpage.h>
461#include <l4/sys/__timeout.h>
L4 compiler related defines.
unsigned long l4_umword_t
Unsigned machine word.
Definition l4int.h:40
signed long l4_mword_t
Signed machine word.
Definition l4int.h:37
unsigned long l4_cap_idx_t
Capability selector type.
Definition types.h:336
unsigned l4_is_invalid_cap(l4_cap_idx_t c) L4_NOTHROW
Test if a capability selector is the invalid capability.
Definition types.h:389
unsigned l4_capability_equal(l4_cap_idx_t c1, l4_cap_idx_t c2) L4_NOTHROW
Test if the capability indices of two capability selectors are equal.
Definition types.h:397
unsigned l4_is_valid_cap(l4_cap_idx_t c) L4_NOTHROW
Test if a capability selector is a valid selector.
Definition types.h:393
@ L4_CAP_OFFSET
Offset of two consecutive capability selectors.
Definition consts.h:146
@ L4_CAP_SHIFT
Capability index shift.
Definition consts.h:142
unsigned l4_msgtag_is_sigma0(l4_msgtag_t t) L4_NOTHROW
Test for sigma0 protocol.
Definition types.h:451
unsigned l4_msgtag_is_exception(l4_msgtag_t t) L4_NOTHROW
Test for exception protocol.
Definition types.h:448
L4_msgtag_flags
Flags for message tags.
Definition types.h:87
unsigned l4_msgtag_items(l4_msgtag_t t) L4_NOTHROW
Get the number of typed items.
Definition types.h:431
unsigned l4_msgtag_is_io_page_fault(l4_msgtag_t t) L4_NOTHROW
Test for IO-page-fault protocol.
Definition types.h:454
unsigned l4_msgtag_has_error(l4_msgtag_t t) L4_NOTHROW
Test for error indicator flag.
Definition types.h:440
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:405
unsigned l4_msgtag_words(l4_msgtag_t t) L4_NOTHROW
Get the number of untyped words.
Definition types.h:427
L4_msgtag_protocol
Message tag for IPC operations.
Definition types.h:39
unsigned l4_msgtag_flags(l4_msgtag_t t) L4_NOTHROW
Get the flags.
Definition types.h:435
long l4_msgtag_label(l4_msgtag_t t) L4_NOTHROW
Get the protocol of tag.
Definition types.h:417
unsigned l4_msgtag_is_page_fault(l4_msgtag_t t) L4_NOTHROW
Test for page-fault protocol.
Definition types.h:445
@ L4_MSGTAG_FLAGS
Mask for all flags.
Definition types.h:133
@ L4_MSGTAG_ERROR
Error indicator flag.
Definition types.h:93
@ L4_MSGTAG_SCHEDULE
Enable schedule in IPC flag.
Definition types.h:114
@ L4_MSGTAG_TRANSFER_FPU
Enable FPU transfer flag for IPC.
Definition types.h:105
@ L4_PROTO_IRQ
IRQ message.
Definition types.h:44
@ L4_PROTO_FACTORY
Protocol for messages to a factory object.
Definition types.h:57
@ L4_PROTO_DMA_SPACE
Protocol for (creating) kernel DMA space objects.
Definition types.h:59
@ L4_PROTO_SCHEDULER
Protocol for messages to a scheduler object.
Definition types.h:56
@ L4_PROTO_EXCEPTION
Exception.
Definition types.h:48
@ L4_PROTO_IRQ_SENDER
Protocol for IRQ senders (IRQ -> IPC)
Definition types.h:60
@ L4_PROTO_KOBJECT
Protocol for messages to a generic kobject.
Definition types.h:52
@ L4_PROTO_TASK
Protocol for messages to a task object.
Definition types.h:53
@ L4_PROTO_IO_PAGE_FAULT
I/O page fault message.
Definition types.h:50
@ L4_PROTO_NONE
Default protocol tag to reply to kernel.
Definition types.h:40
@ L4_PROTO_VM
Protocol for messages to a virtual machine object.
Definition types.h:58
@ L4_PROTO_SIGMA0
Sigma0 protocol.
Definition types.h:49
@ L4_PROTO_THREAD_GROUP
Protocol for messages to a thread group obj.
Definition types.h:51
@ L4_PROTO_THREAD
Protocol for messages to a thread object.
Definition types.h:54
@ L4_PROTO_PF_EXCEPTION
Make an exception out of a page fault.
Definition types.h:42
@ L4_PROTO_META
Meta information protocol.
Definition types.h:63
@ L4_PROTO_PAGE_FAULT
Page fault message.
Definition types.h:45
@ L4_PROTO_IOMMU
Protocol ID for IO-MMUs.
Definition types.h:64
@ L4_PROTO_ALLOW_SYSCALL
Allow an alien the system call.
Definition types.h:41
@ L4_PROTO_SEMAPHORE
Protocol for semaphore objects.
Definition types.h:62
@ L4_PROTO_LOG
Protocol for messages to a log object.
Definition types.h:55
@ L4_PROTO_DEBUGGER
Protocol ID for the debugger.
Definition types.h:65
@ L4_PROTO_VCPU_CONTEXT
Protocol for hardware vCPU contexts.
Definition types.h:67
@ L4_PROTO_SMCCC
Protocol ID for ARM SMCCC calls.
Definition types.h:66
#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
l4_cap_idx_t l4_capability_next(l4_cap_idx_t c) L4_NOTHROW
Get the next capability selector after c.
Definition types.h:457
Message tag data structure.
Definition types.h:154
long label() const L4_NOTHROW
Get the protocol value.
Definition types.h:158
bool is_page_fault() const L4_NOTHROW
Test if protocol indicates page-fault protocol.
Definition types.h:180
bool is_sigma0() const L4_NOTHROW
Test if protocol indicates sigma0 protocol.
Definition types.h:184
bool has_error() const L4_NOTHROW
Test if flags indicate an error.
Definition types.h:191
void label(long v) L4_NOTHROW
Set the protocol value.
Definition types.h:167
bool is_exception() const L4_NOTHROW
Test if protocol indicates exception protocol.
Definition types.h:182
unsigned words() const L4_NOTHROW
Get the number of untyped words.
Definition types.h:169
bool is_io_page_fault() const L4_NOTHROW
Test if protocol indicates IO-page-fault protocol.
Definition types.h:186
unsigned items() const L4_NOTHROW
Get the number of typed items.
Definition types.h:171
l4_mword_t raw
raw value
Definition types.h:155
unsigned flags() const L4_NOTHROW
Get the flags value.
Definition types.h:178