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