l4/pkg/l4sys/include/ARCH-x86/utcb.h

   1 /*****************************************************************************/
   2 /**
   3  * \file
   4  * \brief   UTCB definitions for X86.
   5  * \ingroup  l4_utcb_api
   6  */
   7 /*
   8  * (c) 2008-2009 Adam Lackorzynski <adam@os.inf.tu-dresden.de>,
   9  *               Alexander Warg <warg@os.inf.tu-dresden.de>
  10  *     economic rights: Technische Universität Dresden (Germany)
  11  *
  12  * This file is part of TUD:OS and distributed under the terms of the
  13  * GNU General Public License 2.
  14  * Please see the COPYING-GPL-2 file for details.
  15  *
  16  * As a special exception, you may use this file as part of a free software
  17  * library without restriction.  Specifically, if other files instantiate
  18  * templates or use macros or inline functions from this file, or you compile
  19  * this file and link it with other files to produce an executable, this
  20  * file does not by itself cause the resulting executable to be covered by
  21  * the GNU General Public License.  This exception does not however
  22  * invalidate any other reasons why the executable file might be covered by
  23  * the GNU General Public License.
  24  */
  25 /*****************************************************************************/
  26 #ifndef __L4_SYS__INCLUDE__ARCH_X86__UTCB_H__
  27 #define __L4_SYS__INCLUDE__ARCH_X86__UTCB_H__
  28
  29 #include <l4/sys/types.h>
  30
  31 /**
  32  * \defgroup l4_utcb_api_x86 x86 Virtual Registers (UTCB)
  33  * \ingroup  l4_utcb_api
  34  */
  35
  36 /**
  37  * \brief UTCB constants for x86
  38  * \ingroup l4_utcb_api_x86
  39  * \hideinitializer
  40  */
  41 enum L4_utcb_consts_x86
  42 {
  43   /// Number if message registers used for exception IPC
  44   L4_UTCB_EXCEPTION_REGS_SIZE    = 16,
  45
  46   /// Total number of message register (MRs) available
  47   L4_UTCB_GENERIC_DATA_SIZE      = 63,
  48
  49   /// Total number of buffer registers (BRs) available
  50   L4_UTCB_GENERIC_BUFFERS_SIZE   = 58,
  51
  52   /// Offset of MR[0] relative to the UTCB pointer
  53   L4_UTCB_MSG_REGS_OFFSET        = 0,
  54
  55   /// Offset of BR[0] relative to the UTCB pointer
  56   L4_UTCB_BUF_REGS_OFFSET        = 64 * sizeof(l4_umword_t),
  57
  58   /// Offset of TCR[0] relative to the UTCB pointer
  59   L4_UTCB_THREAD_REGS_OFFSET     = 123 * sizeof(l4_umword_t),
  60
  61   /// BDR flag to accept reception of FPU state
  62   L4_UTCB_INHERIT_FPU            = 1UL << 24,
  63
  64   /// Offset of two consecutive UTCBs
  65   L4_UTCB_OFFSET                 = 512,
  66 };
  67
  68 /**
  69  * \brief UTCB structure for exceptions.
  70  * \ingroup l4_utcb_api_x86
  71  */
  72 typedef struct l4_exc_regs_t
  73 {
  74   l4_umword_t gs;      /**< gs register */
  75   l4_umword_t fs;      /**< fs register */
  76
  77   l4_umword_t edi;     /**< edi register */
  78   l4_umword_t esi;     /**< esi register */
  79   l4_umword_t ebp;     /**< ebp register */
  80   l4_umword_t pfa;     /**< page fault address */
  81   l4_umword_t ebx;     /**< ebx register */
  82   l4_umword_t edx;     /**< edx register */
  83   l4_umword_t ecx;     /**< ecx register */
  84   l4_umword_t eax;     /**< eax register */
  85
  86   l4_umword_t trapno;  /**< trap number */
  87   l4_umword_t err;     /**< error code */
  88
  89   l4_umword_t ip;     /**< instruction pointer */
  90   l4_umword_t dummy1;  /**< dummy \internal */
  91   l4_umword_t flags;  /**< eflags */
  92   l4_umword_t sp;     /**< stack pointer */
  93 } l4_exc_regs_t;
  94
  95 #include_next <l4/sys/utcb.h>
  96
  97 /*
  98  * ==================================================================
  99  * Implementations.
 100  */
 101
 102 L4_INLINE l4_utcb_t *l4_utcb_direct(void) L4_NOTHROW
 103 {
 104   l4_utcb_t *utcb;
 105   __asm__ ("mov %%fs:0, %0" : "=r" (utcb));
 106   return utcb;
 107 }
 108
 109 L4_INLINE l4_umword_t l4_utcb_exc_pc(l4_exc_regs_t *u) L4_NOTHROW
 110 {
 111   return u->ip;
 112 }
 113
 114 L4_INLINE void l4_utcb_exc_pc_set(l4_exc_regs_t *u, l4_addr_t pc) L4_NOTHROW
 115 {
 116   u->ip = pc;
 117 }
 118
 119 L4_INLINE l4_umword_t l4_utcb_exc_typeval(l4_exc_regs_t *u) L4_NOTHROW
 120 {
 121   return u->trapno;
 122 }
 123
 124 L4_INLINE int l4_utcb_exc_is_pf(l4_exc_regs_t *u) L4_NOTHROW
 125 {
 126   return u->trapno == 14;
 127 }
 128
 129 L4_INLINE l4_addr_t l4_utcb_exc_pfa(l4_exc_regs_t *u) L4_NOTHROW
 130 {
 131   return (u->pfa & ~3) | (u->err & 2);
 132 }
 133
 134 #endif /* ! __L4_SYS__INCLUDE__ARCH_X86__UTCB_H__ */