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