asm-constants.h revision cb3081f675109049e63380170b60871e8275f9a8 
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/* MterpGlue fields */
85MTERP_OFFSET(offGlue_pc,                MterpGlue, pc, 0)
86MTERP_OFFSET(offGlue_fp,                MterpGlue, fp, 4)
87MTERP_OFFSET(offGlue_retval,            MterpGlue, retval, 8)
88MTERP_OFFSET(offGlue_method,            MterpGlue, method, 16)
89MTERP_OFFSET(offGlue_methodClassDex,    MterpGlue, methodClassDex, 20)
90MTERP_OFFSET(offGlue_self,              MterpGlue, self, 24)
91MTERP_OFFSET(offGlue_bailPtr,           MterpGlue, bailPtr, 28)
92MTERP_OFFSET(offGlue_interpStackEnd,    MterpGlue, interpStackEnd, 32)
93MTERP_OFFSET(offGlue_pSelfSuspendCount, MterpGlue, pSelfSuspendCount, 36)
94MTERP_OFFSET(offGlue_cardTable,         MterpGlue, cardTable, 40)
95MTERP_OFFSET(offGlue_pInterpBreak,      MterpGlue, pInterpBreak, 44)
96MTERP_OFFSET(offGlue_entryPoint,        MterpGlue, entryPoint, 48)
97#if defined(WITH_JIT)
98MTERP_OFFSET(offGlue_pJitProfTable,     MterpGlue, pJitProfTable, 56)
99MTERP_OFFSET(offGlue_jitState,          MterpGlue, jitState, 60)
100MTERP_OFFSET(offGlue_jitResumeNPC,      MterpGlue, jitResumeNPC, 64)
101MTERP_OFFSET(offGlue_jitResumeDPC,      MterpGlue, jitResumeDPC, 68)
102MTERP_OFFSET(offGlue_jitThreshold,      MterpGlue, jitThreshold, 72)
103MTERP_OFFSET(offGlue_ppJitProfTable,    MterpGlue, ppJitProfTable, 76)
104MTERP_OFFSET(offGlue_icRechainCount,    MterpGlue, icRechainCount, 80)
105MTERP_OFFSET(offGlue_pProfileCountdown, MterpGlue, pProfileCountdown, 84)
106#if defined(WITH_SELF_VERIFICATION)
107MTERP_OFFSET(offGlue_jitCacheStart,     MterpGlue, jitCacheStart, 112)
108MTERP_OFFSET(offGlue_jitCacheEnd,       MterpGlue, jitCacheEnd, 116)
109#else
110MTERP_OFFSET(offGlue_jitCacheStart,     MterpGlue, jitCacheStart, 108)
111MTERP_OFFSET(offGlue_jitCacheEnd,       MterpGlue, jitCacheEnd, 112)
112#endif
113#endif
114/* make sure all JValue union members are stored at the same offset */
115MTERP_OFFSET(offGlue_retval_z,          MterpGlue, retval.z, 8)
116MTERP_OFFSET(offGlue_retval_i,          MterpGlue, retval.i, 8)
117MTERP_OFFSET(offGlue_retval_j,          MterpGlue, retval.j, 8)
118MTERP_OFFSET(offGlue_retval_l,          MterpGlue, retval.l, 8)
119
120/* DvmDex fields */
121MTERP_OFFSET(offDvmDex_pResStrings,     DvmDex, pResStrings, 8)
122MTERP_OFFSET(offDvmDex_pResClasses,     DvmDex, pResClasses, 12)
123MTERP_OFFSET(offDvmDex_pResMethods,     DvmDex, pResMethods, 16)
124MTERP_OFFSET(offDvmDex_pResFields,      DvmDex, pResFields, 20)
125MTERP_OFFSET(offDvmDex_pInterfaceCache, DvmDex, pInterfaceCache, 24)
126
127/* StackSaveArea fields */
128#ifdef EASY_GDB
129MTERP_OFFSET(offStackSaveArea_prevSave, StackSaveArea, prevSave, 0)
130MTERP_OFFSET(offStackSaveArea_prevFrame, StackSaveArea, prevFrame, 4)
131MTERP_OFFSET(offStackSaveArea_savedPc,  StackSaveArea, savedPc, 8)
132MTERP_OFFSET(offStackSaveArea_method,   StackSaveArea, method, 12)
133MTERP_OFFSET(offStackSaveArea_currentPc, StackSaveArea, xtra.currentPc, 16)
134MTERP_OFFSET(offStackSaveArea_localRefCookie, \
135                                        StackSaveArea, xtra.localRefCookie, 16)
136MTERP_OFFSET(offStackSaveArea_returnAddr, StackSaveArea, returnAddr, 20)
137MTERP_SIZEOF(sizeofStackSaveArea,       StackSaveArea, 24)
138#else
139MTERP_OFFSET(offStackSaveArea_prevFrame, StackSaveArea, prevFrame, 0)
140MTERP_OFFSET(offStackSaveArea_savedPc,  StackSaveArea, savedPc, 4)
141MTERP_OFFSET(offStackSaveArea_method,   StackSaveArea, method, 8)
142MTERP_OFFSET(offStackSaveArea_currentPc, StackSaveArea, xtra.currentPc, 12)
143MTERP_OFFSET(offStackSaveArea_localRefCookie, \
144                                        StackSaveArea, xtra.localRefCookie, 12)
145MTERP_OFFSET(offStackSaveArea_returnAddr, StackSaveArea, returnAddr, 16)
146MTERP_SIZEOF(sizeofStackSaveArea,       StackSaveArea, 20)
147#endif
148
149  /* ShadowSpace fields */
150#if defined(WITH_JIT) && defined(WITH_SELF_VERIFICATION)
151MTERP_OFFSET(offShadowSpace_startPC,     ShadowSpace, startPC, 0)
152MTERP_OFFSET(offShadowSpace_fp,          ShadowSpace, fp, 4)
153MTERP_OFFSET(offShadowSpace_glue,        ShadowSpace, glue, 8)
154MTERP_OFFSET(offShadowSpace_jitExitState,ShadowSpace, jitExitState, 12)
155MTERP_OFFSET(offShadowSpace_svState,     ShadowSpace, selfVerificationState, 16)
156MTERP_OFFSET(offShadowSpace_shadowFP,    ShadowSpace, shadowFP, 24)
157MTERP_OFFSET(offShadowSpace_interpState, ShadowSpace, interpState, 32)
158#endif
159
160/* InstField fields */
161#ifdef PROFILE_FIELD_ACCESS
162MTERP_OFFSET(offInstField_byteOffset,   InstField, byteOffset, 24)
163#else
164MTERP_OFFSET(offInstField_byteOffset,   InstField, byteOffset, 16)
165#endif
166
167/* Field fields */
168MTERP_OFFSET(offField_clazz,            Field, clazz, 0)
169
170/* StaticField fields */
171#ifdef PROFILE_FIELD_ACCESS
172MTERP_OFFSET(offStaticField_value,      StaticField, value, 24)
173#else
174MTERP_OFFSET(offStaticField_value,      StaticField, value, 16)
175#endif
176
177/* Method fields */
178MTERP_OFFSET(offMethod_clazz,           Method, clazz, 0)
179MTERP_OFFSET(offMethod_accessFlags,     Method, accessFlags, 4)
180MTERP_OFFSET(offMethod_methodIndex,     Method, methodIndex, 8)
181MTERP_OFFSET(offMethod_registersSize,   Method, registersSize, 10)
182MTERP_OFFSET(offMethod_outsSize,        Method, outsSize, 12)
183MTERP_OFFSET(offMethod_name,            Method, name, 16)
184MTERP_OFFSET(offMethod_insns,           Method, insns, 32)
185MTERP_OFFSET(offMethod_nativeFunc,      Method, nativeFunc, 40)
186
187/* InlineOperation fields -- code assumes "func" offset is zero, do not alter */
188MTERP_OFFSET(offInlineOperation_func,   InlineOperation, func, 0)
189
190/* Thread fields */
191MTERP_OFFSET(offThread_stackOverflowed, Thread, stackOverflowed, 36)
192MTERP_OFFSET(offThread_curFrame,        Thread, curFrame, 40)
193MTERP_OFFSET(offThread_exception,       Thread, exception, 44)
194
195#if defined(WITH_JIT)
196MTERP_OFFSET(offThread_inJitCodeCache,  Thread, inJitCodeCache, 72)
197#if defined(WITH_SELF_VERIFICATION)
198MTERP_OFFSET(offThread_shadowSpace,     Thread, shadowSpace, 76)
199#ifdef USE_INDIRECT_REF
200MTERP_OFFSET(offThread_jniLocal_topCookie, \
201                                Thread, jniLocalRefTable.segmentState.all, 80)
202#else
203MTERP_OFFSET(offThread_jniLocal_topCookie, \
204                                Thread, jniLocalRefTable.nextEntry, 80)
205#endif
206#else
207#ifdef USE_INDIRECT_REF
208MTERP_OFFSET(offThread_jniLocal_topCookie, \
209                                Thread, jniLocalRefTable.segmentState.all, 76)
210#else
211MTERP_OFFSET(offThread_jniLocal_topCookie, \
212                                Thread, jniLocalRefTable.nextEntry, 76)
213#endif
214#endif
215#else
216#ifdef USE_INDIRECT_REF
217MTERP_OFFSET(offThread_jniLocal_topCookie, \
218                                Thread, jniLocalRefTable.segmentState.all, 72)
219#else
220MTERP_OFFSET(offThread_jniLocal_topCookie, \
221                                Thread, jniLocalRefTable.nextEntry, 72)
222#endif
223#endif
224
225/* Object fields */
226MTERP_OFFSET(offObject_clazz,           Object, clazz, 0)
227MTERP_OFFSET(offObject_lock,            Object, lock, 4)
228
229/* Lock shape */
230MTERP_CONSTANT(LW_LOCK_OWNER_SHIFT, 3)
231MTERP_CONSTANT(LW_HASH_STATE_SHIFT, 1)
232
233/* ArrayObject fields */
234MTERP_OFFSET(offArrayObject_length,     ArrayObject, length, 8)
235#ifdef MTERP_NO_UNALIGN_64
236MTERP_OFFSET(offArrayObject_contents,   ArrayObject, contents, 16)
237#else
238MTERP_OFFSET(offArrayObject_contents,   ArrayObject, contents, 12)
239#endif
240
241/* String fields */
242MTERP_CONSTANT(STRING_FIELDOFF_VALUE,     8)
243MTERP_CONSTANT(STRING_FIELDOFF_HASHCODE, 12)
244MTERP_CONSTANT(STRING_FIELDOFF_OFFSET,   16)
245MTERP_CONSTANT(STRING_FIELDOFF_COUNT,    20)
246
247#if defined(WITH_JIT)
248/*
249 * Reasons for the non-chaining interpreter entry points
250 * Enums defined in vm/Globals.h
251 */
252MTERP_CONSTANT(kInlineCacheMiss,        0)
253MTERP_CONSTANT(kCallsiteInterpreted,    1)
254MTERP_CONSTANT(kSwitchOverflow,         2)
255MTERP_CONSTANT(kHeavyweightMonitor,     3)
256
257/* Size of callee save area */
258MTERP_CONSTANT(JIT_CALLEE_SAVE_DOUBLE_COUNT,   8)
259#endif
260
261/* ClassObject fields */
262MTERP_OFFSET(offClassObject_descriptor, ClassObject, descriptor, 24)
263MTERP_OFFSET(offClassObject_accessFlags, ClassObject, accessFlags, 32)
264MTERP_OFFSET(offClassObject_pDvmDex,    ClassObject, pDvmDex, 40)
265MTERP_OFFSET(offClassObject_status,     ClassObject, status, 44)
266MTERP_OFFSET(offClassObject_super,      ClassObject, super, 72)
267MTERP_OFFSET(offClassObject_vtableCount, ClassObject, vtableCount, 112)
268MTERP_OFFSET(offClassObject_vtable,     ClassObject, vtable, 116)
269
270/* InterpEntry enumeration */
271MTERP_SIZEOF(sizeofClassStatus,         InterpEntry, MTERP_SMALL_ENUM)
272MTERP_CONSTANT(kInterpEntryInstr,   0)
273MTERP_CONSTANT(kInterpEntryReturn,  1)
274MTERP_CONSTANT(kInterpEntryThrow,   2)
275#if defined(WITH_JIT)
276MTERP_CONSTANT(kInterpEntryResume,  3)
277#endif
278
279#if defined(WITH_JIT)
280MTERP_CONSTANT(kJitNot,                 0)
281MTERP_CONSTANT(kJitTSelectRequest,      1)
282MTERP_CONSTANT(kJitTSelectRequestHot,   2)
283MTERP_CONSTANT(kJitSelfVerification,    3)
284MTERP_CONSTANT(kJitTSelect,             4)
285MTERP_CONSTANT(kJitTSelectEnd,          5)
286MTERP_CONSTANT(kJitSingleStep,          6)
287MTERP_CONSTANT(kJitSingleStepEnd,       7)
288MTERP_CONSTANT(kJitDone,                8)
289
290#if defined(WITH_SELF_VERIFICATION)
291MTERP_CONSTANT(kSVSIdle, 0)
292MTERP_CONSTANT(kSVSStart, 1)
293MTERP_CONSTANT(kSVSPunt, 2)
294MTERP_CONSTANT(kSVSSingleStep, 3)
295MTERP_CONSTANT(kSVSNoProfile, 4)
296MTERP_CONSTANT(kSVSTraceSelect, 5)
297MTERP_CONSTANT(kSVSNormal, 6)
298MTERP_CONSTANT(kSVSNoChain, 7)
299MTERP_CONSTANT(kSVSBackwardBranch, 8)
300MTERP_CONSTANT(kSVSDebugInterp, 9)
301#endif
302#endif
303
304/* ClassStatus enumeration */
305MTERP_SIZEOF(sizeofClassStatus,         ClassStatus, MTERP_SMALL_ENUM)
306MTERP_CONSTANT(CLASS_INITIALIZED,   7)
307
308/* MethodType enumeration */
309MTERP_SIZEOF(sizeofMethodType,          MethodType, MTERP_SMALL_ENUM)
310MTERP_CONSTANT(METHOD_DIRECT,       1)
311MTERP_CONSTANT(METHOD_STATIC,       2)
312MTERP_CONSTANT(METHOD_VIRTUAL,      3)
313MTERP_CONSTANT(METHOD_INTERFACE,    4)
314
315/* ClassObject constants */
316MTERP_CONSTANT(ACC_PRIVATE,         0x0002)
317MTERP_CONSTANT(ACC_STATIC,          0x0008)
318MTERP_CONSTANT(ACC_NATIVE,          0x0100)
319MTERP_CONSTANT(ACC_INTERFACE,       0x0200)
320MTERP_CONSTANT(ACC_ABSTRACT,        0x0400)
321
322/* flags for dvmMalloc */
323MTERP_CONSTANT(ALLOC_DONT_TRACK,    0x01)
324
325/* for GC */
326MTERP_CONSTANT(GC_CARD_SHIFT, 7)
327
328/* opcode number */
329MTERP_CONSTANT(OP_MOVE_EXCEPTION,   0x0d)
330
331/* flags for interpBreak */
332MTERP_CONSTANT(kSubModeNormal,         0x0000)
333MTERP_CONSTANT(kSubModeMethodTrace,    0x0001)
334MTERP_CONSTANT(kSubModeEmulatorTrace,  0x0002)
335MTERP_CONSTANT(kSubModeInstCounting,   0x0004)
336MTERP_CONSTANT(kSubModeDebuggerActive, 0x0008)
337MTERP_CONSTANT(kSubModeSuspendRequest, 0x0010)
338