kip.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>
 *     economic rights: Technische Universität Dresden (Germany)
 *
 * License: see LICENSE.spdx (in this directory or the directories above)
 */
#pragma once
 
#include <l4/sys/compiler.h>
#include <l4/sys/l4int.h>
 
#include <l4/sys/__kip-arch.h>
 
struct l4_kip_platform_info
{
  char                             name[16];
  l4_uint32_t                      is_mp;
  struct l4_kip_platform_info_arch arch;
};
 
typedef struct l4_kernel_info_t
{
  /* offset 0x00 */
  l4_uint32_t            magic;               
  l4_uint32_t            version;             
  l4_uint8_t             offset_version_strings; 
  l4_uint8_t             _fill0[3];            
  l4_uint8_t             kip_sys_calls;       
  l4_uint8_t             node;
  l4_uint8_t             _fill1[2];            
 
  /* offset 0x10 */
  l4_uint64_t            sigma0_ip;           
  l4_uint64_t            root_ip;             
 
  /* offset 0x20 */
  volatile l4_cpu_time_t _clock_val;          
  l4_uint64_t            frequency_cpu;       
 
  /* offset 0x30 */
  l4_uint64_t            acpi_rsdp_addr;      
  l4_uint64_t            dt_addr;             
 
  /* offset 0x40 */
  l4_uint64_t            user_ptr;            
  l4_uint64_t            _res0[1];            
 
  /* offset 0x50 */
  l4_uint32_t            scheduler_granularity; 
  l4_uint32_t            mem_descs;           
  l4_uint32_t            mem_descs_num;       
  l4_uint32_t            _res1[1];            
 
  /* offset 0x60 */
  l4_uint64_t            _res2[2];             
 
  /* offset 0x70 */
  struct l4_kip_platform_info    platform_info;
} l4_kernel_info_t;
typedef struct l4_kernel_info_t {…};
 
enum l4_kernel_info_consts_t
{
  L4_KIP_VERSION_FIASCO      = 0x87004444,
  L4_KIP_VERSION_FIASCO_MASK = 0xff00ffff,
};
 
enum
{
  L4_KIP_OFFS_READ_US        = 0x900,
 
  L4_KIP_OFFS_READ_NS        = 0x980,
};
 
extern l4_kernel_info_t const *l4_global_kip;
 
#define L4_KERNEL_INFO_MAGIC (0x4BE6344CL) /* "L4µK" */
 
 
L4_INLINE l4_kernel_info_t const *l4_kip(void) L4_NOTHROW;
 
 
L4_INLINE l4_umword_t l4_kip_version(l4_kernel_info_t const *kip) L4_NOTHROW;
 
L4_INLINE const char *l4_kip_version_string(l4_kernel_info_t const *kip) L4_NOTHROW;
 
L4_INLINE int
l4_kernel_info_version_offset(l4_kernel_info_t const *kip) L4_NOTHROW;
 
L4_INLINE l4_cpu_time_t
l4_kip_clock(l4_kernel_info_t const *kip) L4_NOTHROW;
 
L4_INLINE l4_umword_t
l4_kip_clock_lw(l4_kernel_info_t const *kip) L4_NOTHROW
  L4_DEPRECATED("Use l4_kip_clock() instead");
 
L4_INLINE l4_uint64_t
l4_kip_clock_ns(l4_kernel_info_t const *kip) L4_NOTHROW;
 
/*************************************************************************
 * Implementations
 *************************************************************************/
 
L4_INLINE l4_kernel_info_t const*
l4_kip(void) L4_NOTHROW
{ return l4_global_kip; }
l4_kip(void) L4_NOTHROW {…}
 
L4_INLINE l4_umword_t
l4_kip_version(l4_kernel_info_t const *kip) L4_NOTHROW
{ return kip->version & L4_KIP_VERSION_FIASCO_MASK; }
l4_kip_version(l4_kernel_info_t const *kip) L4_NOTHROW {…}
 
L4_INLINE const char*
l4_kip_version_string(l4_kernel_info_t const *k) L4_NOTHROW
{ return (const char *)k + l4_kernel_info_version_offset(k); }
l4_kip_version_string(l4_kernel_info_t const *k) L4_NOTHROW {…}
 
L4_INLINE int
l4_kernel_info_version_offset(l4_kernel_info_t const *kip) L4_NOTHROW
{ return kip->offset_version_strings << 4; }
l4_kernel_info_version_offset(l4_kernel_info_t const *kip) L4_NOTHROW {…}
 
L4_INLINE l4_cpu_time_t
l4_kip_clock(l4_kernel_info_t const *kip) L4_NOTHROW
{
  // Use kernel-provided code to determine the current clock.
  typedef l4_uint64_t (*kip_time_fn_read_us)(void);
  kip_time_fn_read_us read_us =
    (kip_time_fn_read_us)((l4_uint8_t const*)kip + L4_KIP_OFFS_READ_US);
  return read_us();
}
l4_kip_clock(l4_kernel_info_t const *kip) L4_NOTHROW {…}
 
L4_INLINE l4_cpu_time_t
l4_kip_clock_ns(l4_kernel_info_t const *kip) L4_NOTHROW
{
  typedef l4_uint64_t (*kip_time_fn_read_ns)(void);
  kip_time_fn_read_ns read_ns =
    (kip_time_fn_read_ns)((l4_uint8_t const*)kip + L4_KIP_OFFS_READ_NS);
  return read_ns();
}
l4_kip_clock_ns(l4_kernel_info_t const *kip) L4_NOTHROW {…}
 
L4_INLINE l4_umword_t
l4_kip_clock_lw(l4_kernel_info_t const *kip) L4_NOTHROW
{
  return l4_kip_clock(kip);
}
l4_kip_clock_lw(l4_kernel_info_t const *kip) L4_NOTHROW {…}
 
#define l4_kip_for_each_feature(s) \
        for (s += __builtin_strlen(s) + 1; *s; s += __builtin_strlen(s) + 1)
#define l4_kip_for_each_feature(s) \ …
 
L4_INLINE int
l4_kip_kernel_has_feature(l4_kernel_info_t const *kip, char const *str)
{
  const char *s = l4_kip_version_string(kip);
  if (!s)
    return 0;
 
  l4_kip_for_each_feature(s)
    {
      if (__builtin_strcmp(s, str) == 0)
        return 1;
    }
 
  return 0;
}
l4_kip_kernel_has_feature(l4_kernel_info_t const *kip, char const *str) {…}