1 /*
2  * Copyright (c) 2012 The Native Client Authors. All rights reserved.
3  * Use of this source code is governed by a BSD-style license that can be
4  * found in the LICENSE file.
5  */
6 
7 /*
8  * NaCl Secure Runtime
9  */
10 
11 #ifndef __NATIVE_CLIENT_SERVICE_RUNTIME_ARCH_MIPS_SEL_RT_H__
12 #define __NATIVE_CLIENT_SERVICE_RUNTIME_ARCH_MIPS_SEL_RT_H__ 1
13 
14 #if !defined(__ASSEMBLER__)
15 
16 #include <stddef.h>
17 
18 #include "native_client/src/include/nacl_base.h"
19 #include "native_client/src/include/nacl_macros.h"
20 #include "native_client/src/include/portability.h"
21 #include "native_client/src/shared/platform/nacl_check.h"
22 
23 EXTERN_C_BEGIN
24 
25 uint32_t NaClGetStackPtr(void);
26 
27 typedef uint32_t nacl_reg_t;
28 
29 #define NACL_PRIdNACL_REG NACL_PRId32
30 #define NACL_PRIiNACL_REG NACL_PRIi32
31 #define NACL_PRIoNACL_REG NACL_PRIo32
32 #define NACL_PRIuNACL_REG NACL_PRIu32
33 #define NACL_PRIxNACL_REG NACL_PRIx32
34 #define NACL_PRIXNACL_REG NACL_PRIX32
35 
36 /*
37  * NOTE: This struct needs to be synchronized with NACL_CALLEE_SAVE_LIST
38  */
39 
40 struct NaClThreadContext {
41   nacl_reg_t  s0, s1, s2, s3, s4, s5, s6, s7, t8;
42   /*           0   4   8   c  10  14  18  1c  20 */
43 
44   nacl_reg_t  stack_ptr, frame_ptr, prog_ctr;
45   /*                 24         28        2c */
46 
47   /*
48    * sys_ret and new_prog_ctr are not a part of the thread's register set,
49    * but are needed by NaClSwitch. By including them here, the two
50    * use the same interface.
51    */
52   uint32_t  sysret;
53   /*            30 */
54   uint32_t  new_prog_ctr;
55   /*            34 */
56   uint32_t  trusted_stack_ptr;
57   /*            38 */
58   uint32_t  tls_idx;
59   /*            3c */
60   uint32_t  tls_value1;
61   /*            40 */
62   uint32_t  tls_value2;
63   /*            44 */
64   uint32_t  guard_token;
65   /*            48 */
66 };
67 
NaClGetThreadCtxSp(struct NaClThreadContext * th_ctx)68 static INLINE uintptr_t NaClGetThreadCtxSp(struct NaClThreadContext *th_ctx) {
69   return th_ctx->stack_ptr;
70 }
71 
72 NORETURN void NaClStartSwitch(struct NaClThreadContext *);
73 
74 #endif /* !defined(__ASSEMBLER__) */
75 
76 #define NACL_THREAD_CONTEXT_OFFSET_S0                  0x00
77 #define NACL_THREAD_CONTEXT_OFFSET_S1                  0x04
78 #define NACL_THREAD_CONTEXT_OFFSET_S2                  0x08
79 #define NACL_THREAD_CONTEXT_OFFSET_S3                  0x0c
80 #define NACL_THREAD_CONTEXT_OFFSET_S4                  0x10
81 #define NACL_THREAD_CONTEXT_OFFSET_S5                  0x14
82 #define NACL_THREAD_CONTEXT_OFFSET_S6                  0x18
83 #define NACL_THREAD_CONTEXT_OFFSET_S7                  0x1c
84 #define NACL_THREAD_CONTEXT_OFFSET_T8                  0x20
85 #define NACL_THREAD_CONTEXT_OFFSET_STACK_PTR           0x24
86 #define NACL_THREAD_CONTEXT_OFFSET_FRAME_PTR           0x28
87 #define NACL_THREAD_CONTEXT_OFFSET_PROG_CTR            0x2c
88 #define NACL_THREAD_CONTEXT_OFFSET_SYSRET              0x30
89 #define NACL_THREAD_CONTEXT_OFFSET_NEW_PROG_CTR        0x34
90 #define NACL_THREAD_CONTEXT_OFFSET_TRUSTED_STACK_PTR   0x38
91 #define NACL_THREAD_CONTEXT_OFFSET_TLS_IDX             0x3c
92 #define NACL_THREAD_CONTEXT_OFFSET_TLS_VALUE1          0x40
93 #define NACL_THREAD_CONTEXT_OFFSET_TLS_VALUE2          0x44
94 #define NACL_THREAD_CONTEXT_OFFSET_GUARD_TOKEN         0x48
95 
96 #if !defined(__ASSEMBLER__)
97 
98 /*
99  * This function exists as a function only because compile-time
100  * assertions need to be inside a function.  This function does not
101  * need to be called for the assertions to be checked.
102  */
NaClThreadContextOffsetCheck(void)103 static INLINE void NaClThreadContextOffsetCheck(void) {
104   int offset = 0;
105 
106 #define NACL_CHECK_FIELD(offset_name, field) \
107     NACL_COMPILE_TIME_ASSERT(offset_name == \
108                              offsetof(struct NaClThreadContext, field)); \
109     CHECK(offset == offset_name); \
110     offset += sizeof(((struct NaClThreadContext *) NULL)->field);
111 
112   NACL_CHECK_FIELD(NACL_THREAD_CONTEXT_OFFSET_S0, s0);
113   NACL_CHECK_FIELD(NACL_THREAD_CONTEXT_OFFSET_S1, s1);
114   NACL_CHECK_FIELD(NACL_THREAD_CONTEXT_OFFSET_S2, s2);
115   NACL_CHECK_FIELD(NACL_THREAD_CONTEXT_OFFSET_S3, s3);
116   NACL_CHECK_FIELD(NACL_THREAD_CONTEXT_OFFSET_S4, s4);
117   NACL_CHECK_FIELD(NACL_THREAD_CONTEXT_OFFSET_S5, s5);
118   NACL_CHECK_FIELD(NACL_THREAD_CONTEXT_OFFSET_S6, s6);
119   NACL_CHECK_FIELD(NACL_THREAD_CONTEXT_OFFSET_S7, s7);
120   NACL_CHECK_FIELD(NACL_THREAD_CONTEXT_OFFSET_T8, t8);
121   NACL_CHECK_FIELD(NACL_THREAD_CONTEXT_OFFSET_STACK_PTR, stack_ptr);
122   NACL_CHECK_FIELD(NACL_THREAD_CONTEXT_OFFSET_FRAME_PTR, frame_ptr);
123   NACL_CHECK_FIELD(NACL_THREAD_CONTEXT_OFFSET_PROG_CTR, prog_ctr);
124   NACL_CHECK_FIELD(NACL_THREAD_CONTEXT_OFFSET_SYSRET, sysret);
125   NACL_CHECK_FIELD(NACL_THREAD_CONTEXT_OFFSET_NEW_PROG_CTR, new_prog_ctr);
126   NACL_CHECK_FIELD(NACL_THREAD_CONTEXT_OFFSET_TRUSTED_STACK_PTR,
127                    trusted_stack_ptr);
128   NACL_CHECK_FIELD(NACL_THREAD_CONTEXT_OFFSET_TLS_IDX, tls_idx);
129   NACL_CHECK_FIELD(NACL_THREAD_CONTEXT_OFFSET_TLS_VALUE1, tls_value1);
130   NACL_CHECK_FIELD(NACL_THREAD_CONTEXT_OFFSET_TLS_VALUE2, tls_value2);
131   NACL_CHECK_FIELD(NACL_THREAD_CONTEXT_OFFSET_GUARD_TOKEN, guard_token);
132   CHECK(offset == sizeof(struct NaClThreadContext));
133 
134 #undef NACL_CHECK_FIELD
135 }
136 
137 EXTERN_C_END
138 
139 #endif /* !defined(__ASSEMBLER__) */
140 
141 #endif /* __NATIVE_CLIENT_SERVICE_RUNTIME_ARCH_MIPS_SEL_RT_H___ */
142