types.h

Go to the documentation of this file.

/*****************************************************************************/
/*
 * (c) 2008-2013 Adam Lackorzynski <adam@os.inf.tu-dresden.de>,
 *               Alexander Warg <warg@os.inf.tu-dresden.de>,
 *               Björn Döbel <doebel@os.inf.tu-dresden.de>,
 *               Torsten Frenzel <frenzel@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/sys/l4int.h>
#include <l4/sys/compiler.h>
#include <l4/sys/consts.h>

typedef l4_int16_t l4_ret_t;

typedef l4_int16_t l4_proto_t;
 


enum L4_msgtag_protocol
{
  L4_PROTO_NONE          = 0,   
  L4_PROTO_ALLOW_SYSCALL = 1,   
  L4_PROTO_PF_EXCEPTION  = 1,   
 
  L4_PROTO_PLATFORM_CTL  =   0L, 
  L4_PROTO_IRQ           =  -1L, 
  L4_PROTO_PAGE_FAULT    =  -2L, 
  // -3L unused
  // -4L unused
  L4_PROTO_EXCEPTION     =  -5L, 
  L4_PROTO_SIGMA0        =  -6L, 
  L4_PROTO_IO_PAGE_FAULT =  -8L, 
  L4_PROTO_THREAD_GROUP  =  -9L, 
  L4_PROTO_KOBJECT       = -10L, 
  L4_PROTO_TASK          = -11L, 
  L4_PROTO_THREAD        = -12L, 
  L4_PROTO_LOG           = -13L, 
  L4_PROTO_SCHEDULER     = -14L, 
  L4_PROTO_FACTORY       = -15L, 
  L4_PROTO_VM            = -16L, 
  L4_PROTO_DMA_SPACE     = -17L, 
  L4_PROTO_IRQ_SENDER    = -18L, 
  // -19L unusable, used for L4::PROTO_EMPTY
  L4_PROTO_SEMAPHORE     = -20L, 
  L4_PROTO_META          = -21L, 
  L4_PROTO_IOMMU         = -22L, 
  L4_PROTO_DEBUGGER      = -23L, 
  L4_PROTO_SMCCC         = -24L, 
  L4_PROTO_VCPU_CONTEXT  = -25L, 
  L4_PROTO_PI_MUTEX      = -26L, 
};
 
enum L4_varg_type
{
  L4_VARG_TYPE_NIL    = 0x00,
  L4_VARG_TYPE_UMWORD = 0x01,
  L4_VARG_TYPE_MWORD  = 0x81,
  L4_VARG_TYPE_STRING = 0x02,
  L4_VARG_TYPE_FPAGE  = 0x03,
 
  L4_VARG_TYPE_SIGN   = 0x80,
};
 

enum L4_msgtag_flags
{
  // flags for received IPC
  L4_MSGTAG_ERROR        = 0x8000,
 
  // flags for sending IPC
  L4_MSGTAG_TRANSFER_FPU = 0x1000,
  L4_MSGTAG_SCHEDULE     = 0x2000,
  L4_MSGTAG_PROPAGATE    = 0x4000,

  L4_MSGTAG_FLAGS        = 0xf000,
};
 
typedef struct l4_msgtag_t l4_msgtag_t;

L4_INLINE long l4_msgtag_label(l4_msgtag_t t) L4_NOTHROW;

L4_INLINE unsigned l4_msgtag_words(l4_msgtag_t t) L4_NOTHROW;

L4_INLINE unsigned l4_msgtag_items(l4_msgtag_t t) L4_NOTHROW;

L4_INLINE unsigned l4_msgtag_flags(l4_msgtag_t t) L4_NOTHROW;

L4_INLINE unsigned l4_msgtag_has_error(l4_msgtag_t t) L4_NOTHROW;

L4_INLINE unsigned l4_msgtag_is_page_fault(l4_msgtag_t t) L4_NOTHROW;

L4_INLINE unsigned l4_msgtag_is_exception(l4_msgtag_t t) L4_NOTHROW;

L4_INLINE unsigned l4_msgtag_is_sigma0(l4_msgtag_t t) L4_NOTHROW;

L4_INLINE unsigned l4_msgtag_is_io_page_fault(l4_msgtag_t t) L4_NOTHROW;
 

struct l4_msgtag_t
{
  l4_mword_t raw;   
#ifdef __cplusplus
  long label() const L4_NOTHROW { return l4_msgtag_label(*this); }
  void label(long v) L4_NOTHROW { raw = (raw & 0x0ffff) | ((l4_umword_t)v << 16); }
  unsigned words() const L4_NOTHROW { return l4_msgtag_words(*this); }
  unsigned items() const L4_NOTHROW { return l4_msgtag_items(*this); }
  unsigned flags() const L4_NOTHROW { return l4_msgtag_flags(*this); }
  bool is_page_fault() const L4_NOTHROW
  { return l4_msgtag_is_page_fault(*this); }

  bool is_exception() const L4_NOTHROW
  { return l4_msgtag_is_exception(*this); }

  bool is_sigma0() const L4_NOTHROW { return l4_msgtag_is_sigma0(*this); }
  bool is_io_page_fault() const L4_NOTHROW
  { return l4_msgtag_is_io_page_fault(*this); }

  bool has_error() const L4_NOTHROW { return l4_msgtag_has_error(*this); }
#endif
};
 
// The following declaration should be _after_ the definition of struct
// l4_msgtag_t. Circumvents a clang warning about a *potentially*
// incompatibility with C if the type is incomplete when the function is
// declared.

L4_INLINE l4_msgtag_t l4_msgtag(long label, unsigned words, unsigned items,
                                unsigned flags) L4_NOTHROW;
 


typedef unsigned long l4_cap_idx_t;

L4_INLINE unsigned l4_is_invalid_cap(l4_cap_idx_t c) L4_NOTHROW;

L4_INLINE unsigned l4_is_valid_cap(l4_cap_idx_t c) L4_NOTHROW;

L4_INLINE unsigned l4_capability_equal(l4_cap_idx_t c1, l4_cap_idx_t c2) L4_NOTHROW;

L4_INLINE l4_cap_idx_t l4_capability_next(l4_cap_idx_t c) L4_NOTHROW;
 
/* ************************************************************************* */
/* Implementation */
 
L4_INLINE unsigned
l4_is_invalid_cap(l4_cap_idx_t c) L4_NOTHROW
{ return c & L4_INVALID_CAP_BIT; }
 
L4_INLINE unsigned
l4_is_valid_cap(l4_cap_idx_t c) L4_NOTHROW
{ return !(c & L4_INVALID_CAP_BIT); }
 
L4_INLINE unsigned
l4_capability_equal(l4_cap_idx_t c1, l4_cap_idx_t c2) L4_NOTHROW
{ return (c1 >> L4_CAP_SHIFT) == (c2 >> L4_CAP_SHIFT); }
 

L4_INLINE
l4_msgtag_t l4_msgtag(long label, unsigned words, unsigned items,
                      unsigned flags) L4_NOTHROW
{
  return (l4_msgtag_t){  (l4_mword_t)((l4_umword_t)label << 16)
                       | (l4_mword_t)(words & 0x3f)
                       | (l4_mword_t)((items & 0x3f) << 6)
                       | (l4_mword_t)(flags & 0xf000)};
}
 
 
 
L4_INLINE
long l4_msgtag_label(l4_msgtag_t t) L4_NOTHROW
{
#if defined(__cplusplus) && (__cplusplus >= 202002L)
  return t.raw >> 16;
#else
  return t.raw < 0 ? ~(~t.raw >> 16) : t.raw >> 16;
#endif
}
 
L4_INLINE
unsigned l4_msgtag_words(l4_msgtag_t t) L4_NOTHROW
{ return t.raw & 0x3f; }
 
L4_INLINE
unsigned l4_msgtag_items(l4_msgtag_t t) L4_NOTHROW
{ return (t.raw >> 6) & 0x3f; }
 
L4_INLINE
unsigned l4_msgtag_flags(l4_msgtag_t t) L4_NOTHROW
{ return t.raw & 0xf000; }
 
 
L4_INLINE
unsigned l4_msgtag_has_error(l4_msgtag_t t) L4_NOTHROW
{ return t.raw & L4_MSGTAG_ERROR; }
 
 
 
L4_INLINE unsigned l4_msgtag_is_page_fault(l4_msgtag_t t) L4_NOTHROW
{ return l4_msgtag_label(t) == L4_PROTO_PAGE_FAULT; }
 
L4_INLINE unsigned l4_msgtag_is_exception(l4_msgtag_t t) L4_NOTHROW
{ return l4_msgtag_label(t) == L4_PROTO_EXCEPTION; }
 
L4_INLINE unsigned l4_msgtag_is_sigma0(l4_msgtag_t t) L4_NOTHROW
{ return l4_msgtag_label(t) == L4_PROTO_SIGMA0; }
 
L4_INLINE unsigned l4_msgtag_is_io_page_fault(l4_msgtag_t t) L4_NOTHROW
{ return l4_msgtag_label(t) == L4_PROTO_IO_PAGE_FAULT; }
 
L4_INLINE l4_cap_idx_t l4_capability_next(l4_cap_idx_t c) L4_NOTHROW
{ return c + L4_CAP_OFFSET; }
 
#include <l4/sys/__l4_fpage.h>
#include <l4/sys/__timeout.h>