• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright 2008 The Android Open Source Project
3  *
4  * Constants used by the assembler and verified by the C compiler.
5  */
6 
7 #if defined(ASM_DEF_VERIFY)
8   /*
9    * Generate C fragments that verify values; assumes "bool failed" exists.
10    * These are all constant expressions, so on success these will compile
11    * down to nothing.
12    */
13 # define MTERP_OFFSET(_name, _type, _field, _offset)                        \
14     if (offsetof(_type, _field) != _offset) {                               \
15         LOGE("Bad asm offset %s (%d), should be %d\n",                      \
16             #_name, _offset, offsetof(_type, _field));                      \
17         failed = true;                                                      \
18     }
19 # define MTERP_SIZEOF(_name, _type, _size)                                  \
20     if (sizeof(_type) != (_size)) {                                         \
21         LOGE("Bad asm sizeof %s (%d), should be %d\n",                      \
22             #_name, (_size), sizeof(_type));                                \
23         failed = true;                                                      \
24     }
25 # define MTERP_CONSTANT(_name, _value)                                      \
26     if ((_name) != (_value)) {                                              \
27         LOGE("Bad asm constant %s (%d), should be %d\n",                    \
28             #_name, (_value), (_name));                                     \
29         failed = true;                                                      \
30     }
31 #else
32   /* generate constant labels for the assembly output */
33 # define MTERP_OFFSET(name, type, field, offset)    name = offset
34 # define MTERP_SIZEOF(name, type, size)             name = size
35 # define MTERP_CONSTANT(name, value)                name = value
36 #endif
37 
38 /*
39  * Platform dependencies.  Some platforms require 64-bit alignment of 64-bit
40  * data structures.  Some versions of gcc will hold small enumerated types
41  * in a char instead of an int.
42  */
43 #if defined(__ARM_EABI__)
44 # define MTERP_NO_UNALIGN_64
45 #endif
46 #if defined(HAVE_SHORT_ENUMS)
47 # define MTERP_SMALL_ENUM   1
48 #else
49 # define MTERP_SMALL_ENUM   4
50 #endif
51 
52 /*
53  * This file must only contain the following kinds of statements:
54  *
55  *  MTERP_OFFSET(name, StructType, fieldname, offset)
56  *
57  *   Declares that the expected offset of StructType.fieldname is "offset".
58  *   This will break whenever the contents of StructType are rearranged.
59  *
60  *  MTERP_SIZEOF(name, Type, size)
61  *
62  *   Declares that the expected size of Type is "size".
63  *
64  *  MTERP_CONSTANT(name, value)
65  *
66  *   Declares that the expected value of "name" is "value".  Useful for
67  *   enumerations and defined constants that are inaccessible to the
68  *   assembly source.  (Note this assumes you will use the same name in
69  *   both C and assembly, which is good practice.)
70  *
71  * In all cases the "name" field is the label you will use in the assembler.
72  *
73  * The "value" field must always be an actual number, not a symbol, unless
74  * you are sure that the symbol's value will be visible to both C and
75  * assembly sources.  There may be restrictions on the possible range of
76  * values (which are usually provided as immediate operands), so it's best
77  * to restrict numbers assuming a signed 8-bit field.
78  *
79  * On the assembly side, these just become "name=value" constants.  On the
80  * C side, these turn into assertions that cause the VM to abort if the
81  * values are incorrect.
82  */
83 
84 /* globals (sanity check for LDR vs LDRB) */
85 MTERP_SIZEOF(sizeofGlobal_debuggerActive, gDvm.debuggerActive, 1)
86 MTERP_SIZEOF(sizeofGlobal_activeProfilers, gDvm.activeProfilers, 4)
87 
88 /* MterpGlue fields */
89 MTERP_OFFSET(offGlue_pc,                MterpGlue, pc, 0)
90 MTERP_OFFSET(offGlue_fp,                MterpGlue, fp, 4)
91 MTERP_OFFSET(offGlue_retval,            MterpGlue, retval, 8)
92 MTERP_OFFSET(offGlue_method,            MterpGlue, method, 16)
93 MTERP_OFFSET(offGlue_methodClassDex,    MterpGlue, methodClassDex, 20)
94 MTERP_OFFSET(offGlue_self,              MterpGlue, self, 24)
95 MTERP_OFFSET(offGlue_bailPtr,           MterpGlue, bailPtr, 28)
96 MTERP_OFFSET(offGlue_interpStackEnd,    MterpGlue, interpStackEnd, 32)
97 MTERP_OFFSET(offGlue_pSelfSuspendCount, MterpGlue, pSelfSuspendCount, 36)
98 MTERP_OFFSET(offGlue_cardTable,         MterpGlue, cardTable, 40)
99 MTERP_OFFSET(offGlue_pDebuggerActive,   MterpGlue, pDebuggerActive, 44)
100 MTERP_OFFSET(offGlue_pActiveProfilers,  MterpGlue, pActiveProfilers, 48)
101 MTERP_OFFSET(offGlue_entryPoint,        MterpGlue, entryPoint, 52)
102 #if defined(WITH_JIT)
103 MTERP_OFFSET(offGlue_pJitProfTable,     MterpGlue, pJitProfTable, 60)
104 MTERP_OFFSET(offGlue_jitState,          MterpGlue, jitState, 64)
105 MTERP_OFFSET(offGlue_jitResumeNPC,      MterpGlue, jitResumeNPC, 68)
106 MTERP_OFFSET(offGlue_jitResumeDPC,      MterpGlue, jitResumeDPC, 72)
107 MTERP_OFFSET(offGlue_jitThreshold,      MterpGlue, jitThreshold, 76)
108 MTERP_OFFSET(offGlue_ppJitProfTable,    MterpGlue, ppJitProfTable, 80)
109 MTERP_OFFSET(offGlue_icRechainCount,    MterpGlue, icRechainCount, 84)
110 #endif
111 /* make sure all JValue union members are stored at the same offset */
112 MTERP_OFFSET(offGlue_retval_z,          MterpGlue, retval.z, 8)
113 MTERP_OFFSET(offGlue_retval_i,          MterpGlue, retval.i, 8)
114 MTERP_OFFSET(offGlue_retval_j,          MterpGlue, retval.j, 8)
115 MTERP_OFFSET(offGlue_retval_l,          MterpGlue, retval.l, 8)
116 
117 /* DvmDex fields */
118 MTERP_OFFSET(offDvmDex_pResStrings,     DvmDex, pResStrings, 8)
119 MTERP_OFFSET(offDvmDex_pResClasses,     DvmDex, pResClasses, 12)
120 MTERP_OFFSET(offDvmDex_pResMethods,     DvmDex, pResMethods, 16)
121 MTERP_OFFSET(offDvmDex_pResFields,      DvmDex, pResFields, 20)
122 MTERP_OFFSET(offDvmDex_pInterfaceCache, DvmDex, pInterfaceCache, 24)
123 
124 /* StackSaveArea fields */
125 #ifdef EASY_GDB
126 MTERP_OFFSET(offStackSaveArea_prevSave, StackSaveArea, prevSave, 0)
127 MTERP_OFFSET(offStackSaveArea_prevFrame, StackSaveArea, prevFrame, 4)
128 MTERP_OFFSET(offStackSaveArea_savedPc,  StackSaveArea, savedPc, 8)
129 MTERP_OFFSET(offStackSaveArea_method,   StackSaveArea, method, 12)
130 MTERP_OFFSET(offStackSaveArea_currentPc, StackSaveArea, xtra.currentPc, 16)
131 MTERP_OFFSET(offStackSaveArea_localRefCookie, \
132                                         StackSaveArea, xtra.localRefCookie, 16)
133 MTERP_OFFSET(offStackSaveArea_returnAddr, StackSaveArea, returnAddr, 20)
134 MTERP_SIZEOF(sizeofStackSaveArea,       StackSaveArea, 24)
135 #else
136 MTERP_OFFSET(offStackSaveArea_prevFrame, StackSaveArea, prevFrame, 0)
137 MTERP_OFFSET(offStackSaveArea_savedPc,  StackSaveArea, savedPc, 4)
138 MTERP_OFFSET(offStackSaveArea_method,   StackSaveArea, method, 8)
139 MTERP_OFFSET(offStackSaveArea_currentPc, StackSaveArea, xtra.currentPc, 12)
140 MTERP_OFFSET(offStackSaveArea_localRefCookie, \
141                                         StackSaveArea, xtra.localRefCookie, 12)
142 MTERP_OFFSET(offStackSaveArea_returnAddr, StackSaveArea, returnAddr, 16)
143 MTERP_SIZEOF(sizeofStackSaveArea,       StackSaveArea, 20)
144 #endif
145 
146   /* ShadowSpace fields */
147 #if defined(WITH_JIT) && defined(WITH_SELF_VERIFICATION)
148 MTERP_OFFSET(offShadowSpace_startPC,     ShadowSpace, startPC, 0)
149 MTERP_OFFSET(offShadowSpace_fp,          ShadowSpace, fp, 4)
150 MTERP_OFFSET(offShadowSpace_glue,        ShadowSpace, glue, 8)
151 MTERP_OFFSET(offShadowSpace_jitExitState,ShadowSpace, jitExitState, 12)
152 MTERP_OFFSET(offShadowSpace_svState,     ShadowSpace, selfVerificationState, 16)
153 MTERP_OFFSET(offShadowSpace_shadowFP,    ShadowSpace, shadowFP, 24)
154 MTERP_OFFSET(offShadowSpace_interpState, ShadowSpace, interpState, 32)
155 #endif
156 
157 /* InstField fields */
158 #ifdef PROFILE_FIELD_ACCESS
159 MTERP_OFFSET(offInstField_byteOffset,   InstField, byteOffset, 24)
160 #else
161 MTERP_OFFSET(offInstField_byteOffset,   InstField, byteOffset, 16)
162 #endif
163 
164 /* Field fields */
165 MTERP_OFFSET(offField_clazz,            Field, clazz, 0)
166 
167 /* StaticField fields */
168 #ifdef PROFILE_FIELD_ACCESS
169 MTERP_OFFSET(offStaticField_value,      StaticField, value, 24)
170 #else
171 MTERP_OFFSET(offStaticField_value,      StaticField, value, 16)
172 #endif
173 
174 /* Method fields */
175 MTERP_OFFSET(offMethod_clazz,           Method, clazz, 0)
176 MTERP_OFFSET(offMethod_accessFlags,     Method, accessFlags, 4)
177 MTERP_OFFSET(offMethod_methodIndex,     Method, methodIndex, 8)
178 MTERP_OFFSET(offMethod_registersSize,   Method, registersSize, 10)
179 MTERP_OFFSET(offMethod_outsSize,        Method, outsSize, 12)
180 MTERP_OFFSET(offMethod_name,            Method, name, 16)
181 MTERP_OFFSET(offMethod_insns,           Method, insns, 32)
182 MTERP_OFFSET(offMethod_nativeFunc,      Method, nativeFunc, 40)
183 
184 /* InlineOperation fields -- code assumes "func" offset is zero, do not alter */
185 MTERP_OFFSET(offInlineOperation_func,   InlineOperation, func, 0)
186 
187 /* Thread fields */
188 MTERP_OFFSET(offThread_stackOverflowed, Thread, stackOverflowed, 36)
189 MTERP_OFFSET(offThread_curFrame,        Thread, curFrame, 40)
190 MTERP_OFFSET(offThread_exception,       Thread, exception, 44)
191 
192 #if defined(WITH_JIT)
193 MTERP_OFFSET(offThread_inJitCodeCache,  Thread, inJitCodeCache, 72)
194 #if defined(WITH_SELF_VERIFICATION)
195 MTERP_OFFSET(offThread_shadowSpace,     Thread, shadowSpace, 76)
196 #ifdef USE_INDIRECT_REF
197 MTERP_OFFSET(offThread_jniLocal_topCookie, \
198                                 Thread, jniLocalRefTable.segmentState.all, 80)
199 #else
200 MTERP_OFFSET(offThread_jniLocal_topCookie, \
201                                 Thread, jniLocalRefTable.nextEntry, 80)
202 #endif
203 #else
204 #ifdef USE_INDIRECT_REF
205 MTERP_OFFSET(offThread_jniLocal_topCookie, \
206                                 Thread, jniLocalRefTable.segmentState.all, 76)
207 #else
208 MTERP_OFFSET(offThread_jniLocal_topCookie, \
209                                 Thread, jniLocalRefTable.nextEntry, 76)
210 #endif
211 #endif
212 #else
213 #ifdef USE_INDIRECT_REF
214 MTERP_OFFSET(offThread_jniLocal_topCookie, \
215                                 Thread, jniLocalRefTable.segmentState.all, 72)
216 #else
217 MTERP_OFFSET(offThread_jniLocal_topCookie, \
218                                 Thread, jniLocalRefTable.nextEntry, 72)
219 #endif
220 #endif
221 
222 /* Object fields */
223 MTERP_OFFSET(offObject_clazz,           Object, clazz, 0)
224 MTERP_OFFSET(offObject_lock,            Object, lock, 4)
225 
226 /* Lock shape */
227 MTERP_CONSTANT(LW_LOCK_OWNER_SHIFT, 3)
228 MTERP_CONSTANT(LW_HASH_STATE_SHIFT, 1)
229 
230 /* ArrayObject fields */
231 MTERP_OFFSET(offArrayObject_length,     ArrayObject, length, 8)
232 #ifdef MTERP_NO_UNALIGN_64
233 MTERP_OFFSET(offArrayObject_contents,   ArrayObject, contents, 16)
234 #else
235 MTERP_OFFSET(offArrayObject_contents,   ArrayObject, contents, 12)
236 #endif
237 
238 /* String fields */
239 MTERP_CONSTANT(STRING_FIELDOFF_VALUE,     8)
240 MTERP_CONSTANT(STRING_FIELDOFF_HASHCODE, 12)
241 MTERP_CONSTANT(STRING_FIELDOFF_OFFSET,   16)
242 MTERP_CONSTANT(STRING_FIELDOFF_COUNT,    20)
243 
244 #if defined(WITH_JIT)
245 /*
246  * Reasons for the non-chaining interpreter entry points
247  * Enums defined in vm/Globals.h
248  */
249 MTERP_CONSTANT(kInlineCacheMiss,        0)
250 MTERP_CONSTANT(kCallsiteInterpreted,    1)
251 MTERP_CONSTANT(kSwitchOverflow,         2)
252 MTERP_CONSTANT(kHeavyweightMonitor,     3)
253 
254 /* Size of callee save area */
255 MTERP_CONSTANT(JIT_CALLEE_SAVE_DOUBLE_COUNT,   8)
256 #endif
257 
258 /* ClassObject fields */
259 MTERP_OFFSET(offClassObject_descriptor, ClassObject, descriptor, 24)
260 MTERP_OFFSET(offClassObject_accessFlags, ClassObject, accessFlags, 32)
261 MTERP_OFFSET(offClassObject_pDvmDex,    ClassObject, pDvmDex, 40)
262 MTERP_OFFSET(offClassObject_status,     ClassObject, status, 44)
263 MTERP_OFFSET(offClassObject_super,      ClassObject, super, 72)
264 MTERP_OFFSET(offClassObject_vtableCount, ClassObject, vtableCount, 112)
265 MTERP_OFFSET(offClassObject_vtable,     ClassObject, vtable, 116)
266 
267 /* InterpEntry enumeration */
268 MTERP_SIZEOF(sizeofClassStatus,         InterpEntry, MTERP_SMALL_ENUM)
269 MTERP_CONSTANT(kInterpEntryInstr,   0)
270 MTERP_CONSTANT(kInterpEntryReturn,  1)
271 MTERP_CONSTANT(kInterpEntryThrow,   2)
272 #if defined(WITH_JIT)
273 MTERP_CONSTANT(kInterpEntryResume,  3)
274 #endif
275 
276 #if defined(WITH_JIT)
277 MTERP_CONSTANT(kJitNot,                 0)
278 MTERP_CONSTANT(kJitTSelectRequest,      1)
279 MTERP_CONSTANT(kJitTSelectRequestHot,   2)
280 MTERP_CONSTANT(kJitSelfVerification,    3)
281 MTERP_CONSTANT(kJitTSelect,             4)
282 MTERP_CONSTANT(kJitTSelectEnd,          5)
283 MTERP_CONSTANT(kJitSingleStep,          6)
284 MTERP_CONSTANT(kJitSingleStepEnd,       7)
285 MTERP_CONSTANT(kJitDone,                8)
286 
287 #if defined(WITH_SELF_VERIFICATION)
288 MTERP_CONSTANT(kSVSIdle, 0)
289 MTERP_CONSTANT(kSVSStart, 1)
290 MTERP_CONSTANT(kSVSPunt, 2)
291 MTERP_CONSTANT(kSVSSingleStep, 3)
292 MTERP_CONSTANT(kSVSNoProfile, 4)
293 MTERP_CONSTANT(kSVSTraceSelect, 5)
294 MTERP_CONSTANT(kSVSNormal, 6)
295 MTERP_CONSTANT(kSVSNoChain, 7)
296 MTERP_CONSTANT(kSVSBackwardBranch, 8)
297 MTERP_CONSTANT(kSVSDebugInterp, 9)
298 #endif
299 #endif
300 
301 /* ClassStatus enumeration */
302 MTERP_SIZEOF(sizeofClassStatus,         ClassStatus, MTERP_SMALL_ENUM)
303 MTERP_CONSTANT(CLASS_INITIALIZED,   7)
304 
305 /* MethodType enumeration */
306 MTERP_SIZEOF(sizeofMethodType,          MethodType, MTERP_SMALL_ENUM)
307 MTERP_CONSTANT(METHOD_DIRECT,       1)
308 MTERP_CONSTANT(METHOD_STATIC,       2)
309 MTERP_CONSTANT(METHOD_VIRTUAL,      3)
310 MTERP_CONSTANT(METHOD_INTERFACE,    4)
311 
312 /* ClassObject constants */
313 MTERP_CONSTANT(ACC_PRIVATE,         0x0002)
314 MTERP_CONSTANT(ACC_STATIC,          0x0008)
315 MTERP_CONSTANT(ACC_NATIVE,          0x0100)
316 MTERP_CONSTANT(ACC_INTERFACE,       0x0200)
317 MTERP_CONSTANT(ACC_ABSTRACT,        0x0400)
318 
319 /* flags for dvmMalloc */
320 MTERP_CONSTANT(ALLOC_DONT_TRACK,    0x01)
321 
322 /* for GC */
323 MTERP_CONSTANT(GC_CARD_SHIFT, 7)
324 
325 /* opcode number */
326 MTERP_CONSTANT(OP_MOVE_EXCEPTION,   0x0d)
327