blob: ba2d9bb635e4bc81c75d8ee10692fb7640eed8b6 [file] [log] [blame]
The Android Open Source Projectf6c38712009-03-03 19:28:47 -08001/*
2 * Copyright (C) 2008 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
Andy McFaddenb51ea112009-05-08 16:50:17 -070016
The Android Open Source Projectf6c38712009-03-03 19:28:47 -080017/*
18 * Declaration of the fundamental Object type and refinements thereof, plus
19 * some functions for manipulating them.
20 */
21#ifndef _DALVIK_OO_OBJECT
22#define _DALVIK_OO_OBJECT
23
24#include <stddef.h>
25
26/* fwd decl */
27struct DataObject;
Barry Hayes2c987472009-04-06 10:03:48 -070028struct InitiatingLoaderList;
The Android Open Source Projectf6c38712009-03-03 19:28:47 -080029struct ClassObject;
30struct StringObject;
31struct ArrayObject;
32struct Method;
33struct ExceptionEntry;
34struct LineNumEntry;
35struct StaticField;
36struct InstField;
37struct Field;
38struct RegisterMap;
39typedef struct DataObject DataObject;
Barry Hayes2c987472009-04-06 10:03:48 -070040typedef struct InitiatingLoaderList InitiatingLoaderList;
The Android Open Source Projectf6c38712009-03-03 19:28:47 -080041typedef struct ClassObject ClassObject;
42typedef struct StringObject StringObject;
43typedef struct ArrayObject ArrayObject;
44typedef struct Method Method;
45typedef struct ExceptionEntry ExceptionEntry;
46typedef struct LineNumEntry LineNumEntry;
47typedef struct StaticField StaticField;
48typedef struct InstField InstField;
49typedef struct Field Field;
50typedef struct RegisterMap RegisterMap;
51
52/*
53 * Native function pointer type.
54 *
55 * "args[0]" holds the "this" pointer for virtual methods.
56 *
57 * The "Bridge" form is a super-set of the "Native" form; in many places
58 * they are used interchangeably. Currently, all functions have all
59 * arguments passed in, but some functions only care about the first two.
60 * Passing extra arguments to a C function is (mostly) harmless.
61 */
62typedef void (*DalvikBridgeFunc)(const u4* args, JValue* pResult,
63 const Method* method, struct Thread* self);
64typedef void (*DalvikNativeFunc)(const u4* args, JValue* pResult);
65
66
67/* vm-internal access flags and related definitions */
68typedef enum AccessFlags {
69 ACC_MIRANDA = 0x8000, // method (internal to VM)
70 JAVA_FLAGS_MASK = 0xffff, // bits set from Java sources (low 16)
71} AccessFlags;
72
73/* Use the top 16 bits of the access flags field for
74 * other class flags. Code should use the *CLASS_FLAG*()
75 * macros to set/get these flags.
76 */
77typedef enum ClassFlags {
78 CLASS_ISFINALIZABLE = (1<<31), // class/ancestor overrides finalize()
79 CLASS_ISARRAY = (1<<30), // class is a "[*"
80 CLASS_ISOBJECTARRAY = (1<<29), // class is a "[L*" or "[[*"
81 CLASS_ISREFERENCE = (1<<28), // class is a soft/weak/phantom ref
82 // only ISREFERENCE is set --> soft
83 CLASS_ISWEAKREFERENCE = (1<<27), // class is a weak reference
84 CLASS_ISPHANTOMREFERENCE = (1<<26), // class is a phantom reference
85
86 CLASS_MULTIPLE_DEFS = (1<<25), // DEX verifier: defs in multiple DEXs
87
88 /* unlike the others, these can be present in the optimized DEX file */
89 CLASS_ISOPTIMIZED = (1<<17), // class may contain opt instrs
90 CLASS_ISPREVERIFIED = (1<<16), // class has been pre-verified
91} ClassFlags;
92
93/* bits we can reasonably expect to see set in a DEX access flags field */
94#define EXPECTED_FILE_FLAGS \
95 (ACC_CLASS_MASK | CLASS_ISPREVERIFIED | CLASS_ISOPTIMIZED)
96
Andy McFaddenb51ea112009-05-08 16:50:17 -070097/*
98 * Get/set class flags.
99 */
100#define SET_CLASS_FLAG(clazz, flag) \
101 do { (clazz)->accessFlags |= (flag); } while (0)
102
103#define CLEAR_CLASS_FLAG(clazz, flag) \
104 do { (clazz)->accessFlags &= ~(flag); } while (0)
105
106#define IS_CLASS_FLAG_SET(clazz, flag) \
107 (((clazz)->accessFlags & (flag)) != 0)
108
109#define GET_CLASS_FLAG_GROUP(clazz, flags) \
110 ((u4)((clazz)->accessFlags & (flags)))
111
112/*
113 * Use the top 16 bits of the access flags field for other method flags.
114 * Code should use the *METHOD_FLAG*() macros to set/get these flags.
115 */
116typedef enum MethodFlags {
117 METHOD_ISWRITABLE = (1<<31), // the method's code is writable
118} MethodFlags;
119
120/*
121 * Get/set method flags.
122 */
123#define SET_METHOD_FLAG(method, flag) \
124 do { (method)->accessFlags |= (flag); } while (0)
125
126#define CLEAR_METHOD_FLAG(method, flag) \
127 do { (method)->accessFlags &= ~(flag); } while (0)
128
129#define IS_METHOD_FLAG_SET(method, flag) \
130 (((method)->accessFlags & (flag)) != 0)
131
132#define GET_METHOD_FLAG_GROUP(method, flags) \
133 ((u4)((method)->accessFlags & (flags)))
134
The Android Open Source Projectf6c38712009-03-03 19:28:47 -0800135/* current state of the class, increasing as we progress */
136typedef enum ClassStatus {
137 CLASS_ERROR = -1,
138
139 CLASS_NOTREADY = 0,
140 CLASS_LOADED = 1,
141 CLASS_PREPARED = 2, /* part of linking */
142 CLASS_RESOLVED = 3, /* part of linking */
143 CLASS_VERIFYING = 4, /* in the process of being verified */
144 CLASS_VERIFIED = 5, /* logically part of linking; done pre-init */
145 CLASS_INITIALIZING = 6, /* class init in progress */
146 CLASS_INITIALIZED = 7, /* ready to go */
147} ClassStatus;
148
149
150/*
151 * Primitive type identifiers. We use these values as indexes into an
152 * array of synthesized classes, so these start at zero and count up.
153 * The order is arbitrary (mimics table in doc for newarray opcode),
154 * but can't be changed without shuffling some reflection tables.
155 *
156 * PRIM_VOID can't be used as an array type, but we include it here for
157 * other uses (e.g. Void.TYPE).
158 */
159typedef enum PrimitiveType {
160 PRIM_NOT = -1, /* value is not a primitive type */
161 PRIM_BOOLEAN = 0,
162 PRIM_CHAR = 1,
163 PRIM_FLOAT = 2,
164 PRIM_DOUBLE = 3,
165 PRIM_BYTE = 4,
166 PRIM_SHORT = 5,
167 PRIM_INT = 6,
168 PRIM_LONG = 7,
169 PRIM_VOID = 8,
170
171 PRIM_MAX
172} PrimitiveType;
173#define PRIM_TYPE_TO_LETTER "ZCFDBSIJV" /* must match order in enum */
174
175/*
Barry Hayeseac47ed2009-06-22 11:45:20 -0700176 * Definitions for packing refOffsets in ClassObject.
177 */
178/*
179 * A magic value for refOffsets. Ignore the bits and walk the super
180 * chain when this is the value.
181 * [This is an unlikely "natural" value, since it would be 30 non-ref instance
182 * fields followed by 2 ref instance fields.]
183 */
184#define CLASS_WALK_SUPER ((unsigned int)(3))
185#define CLASS_SMALLEST_OFFSET (sizeof(struct Object))
186#define CLASS_BITS_PER_WORD (sizeof(unsigned long int) * 8)
187#define CLASS_OFFSET_ALIGNMENT 4
188#define CLASS_HIGH_BIT ((unsigned int)1 << (CLASS_BITS_PER_WORD - 1))
189/*
Barry Hayes6daaac12009-07-08 10:01:56 -0700190 * Given an offset, return the bit number which would encode that offset.
191 * Local use only.
192 */
193#define _CLASS_BIT_NUMBER_FROM_OFFSET(byteOffset) \
194 (((unsigned int)(byteOffset) - CLASS_SMALLEST_OFFSET) / \
195 CLASS_OFFSET_ALIGNMENT)
196/*
197 * Is the given offset too large to be encoded?
198 */
199#define CLASS_CAN_ENCODE_OFFSET(byteOffset) \
200 (_CLASS_BIT_NUMBER_FROM_OFFSET(byteOffset) < CLASS_BITS_PER_WORD)
201/*
202 * Return a single bit, encoding the offset.
203 * Undefined if the offset is too large, as defined above.
Barry Hayeseac47ed2009-06-22 11:45:20 -0700204 */
205#define CLASS_BIT_FROM_OFFSET(byteOffset) \
Barry Hayes6daaac12009-07-08 10:01:56 -0700206 (CLASS_HIGH_BIT >> _CLASS_BIT_NUMBER_FROM_OFFSET(byteOffset))
Barry Hayeseac47ed2009-06-22 11:45:20 -0700207/*
208 * Return an offset, given a bit number as returned from CLZ.
209 */
210#define CLASS_OFFSET_FROM_CLZ(rshift) \
211 (((int)(rshift) * CLASS_OFFSET_ALIGNMENT) + CLASS_SMALLEST_OFFSET)
212
The Android Open Source Projectf6c38712009-03-03 19:28:47 -0800213
214/*
215 * Used for iftable in ClassObject.
216 */
217typedef struct InterfaceEntry {
218 /* pointer to interface class */
219 ClassObject* clazz;
220
221 /*
222 * Index into array of vtable offsets. This points into the ifviPool,
223 * which holds the vtables for all interfaces declared by this class.
224 */
225 int* methodIndexArray;
226} InterfaceEntry;
227
228
229
230/*
231 * There are three types of objects:
232 * Class objects - an instance of java.lang.Class
233 * Array objects - an object created with a "new array" instruction
234 * Data objects - an object that is neither of the above
235 *
236 * We also define String objects. At present they're equivalent to
237 * DataObject, but that may change. (Either way, they make some of the
238 * code more obvious.)
239 *
240 * All objects have an Object header followed by type-specific data.
241 */
242typedef struct Object {
243 /* ptr to class object */
244 ClassObject* clazz;
245
246 /* thin lock or "fat" monitor */
247 Lock lock;
248} Object;
249
250/*
251 * Properly initialize an Object.
252 * void DVM_OBJECT_INIT(Object *obj, ClassObject *clazz_)
253 */
254#define DVM_OBJECT_INIT(obj, clazz_) \
255 do { (obj)->clazz = (clazz_); DVM_LOCK_INIT(&(obj)->lock); } while (0)
256
257/*
The Android Open Source Projectf6c38712009-03-03 19:28:47 -0800258 * Data objects have an Object header followed by their instance data.
259 */
260struct DataObject {
261 Object obj; /* MUST be first item */
262
263 /* variable #of u4 slots; u8 uses 2 slots */
264 u4 instanceData[1];
265};
266
267/*
268 * Strings are used frequently enough that we may want to give them their
269 * own unique type.
270 *
271 * Using a dedicated type object to access the instance data provides a
272 * performance advantage but makes the java/lang/String.java implementation
273 * fragile.
274 *
275 * Currently this is just equal to DataObject, and we pull the fields out
276 * like we do for any other object.
277 */
278struct StringObject {
279 Object obj; /* MUST be first item */
280
281 /* variable #of u4 slots; u8 uses 2 slots */
282 u4 instanceData[1];
283};
284
285
286/*
287 * Array objects have these additional fields.
288 *
289 * We don't currently store the size of each element. Usually it's implied
290 * by the instruction. If necessary, the width can be derived from
Elliott Hughesbeea0b72009-11-13 11:20:15 -0800291 * the first char of obj->clazz->descriptor.
The Android Open Source Projectf6c38712009-03-03 19:28:47 -0800292 */
293struct ArrayObject {
294 Object obj; /* MUST be first item */
295
296 /* number of elements; immutable after init */
297 u4 length;
298
299 /*
300 * Array contents; actual size is (length * sizeof(type)). This is
301 * declared as u8 so that the compiler inserts any necessary padding
302 * (e.g. for EABI); the actual allocation may be smaller than 8 bytes.
303 */
304 u8 contents[1];
305};
306
307/*
Barry Hayes2c987472009-04-06 10:03:48 -0700308 * For classes created early and thus probably in the zygote, the
309 * InitiatingLoaderList is kept in gDvm. Later classes use the structure in
310 * Object Class. This helps keep zygote pages shared.
311 */
312struct InitiatingLoaderList {
313 /* a list of initiating loader Objects; grown and initialized on demand */
314 Object** initiatingLoaders;
315 /* count of loaders in the above list */
316 int initiatingLoaderCount;
317};
318
319/*
Andy McFaddenb51ea112009-05-08 16:50:17 -0700320 * This defines the amount of space we leave for field slots in the
321 * java.lang.Class definition. If we alter the class to have more than
322 * this many fields, the VM will abort at startup.
323 */
324#define CLASS_FIELD_SLOTS 4
325
326/*
The Android Open Source Projectf6c38712009-03-03 19:28:47 -0800327 * Class objects have many additional fields. This is used for both
328 * classes and interfaces, including synthesized classes (arrays and
329 * primitive types).
330 *
331 * Class objects are unusual in that they have some fields allocated with
332 * the system malloc (or LinearAlloc), rather than on the GC heap. This is
333 * handy during initialization, but does require special handling when
334 * discarding java.lang.Class objects.
335 *
336 * The separation of methods (direct vs. virtual) and fields (class vs.
337 * instance) used in Dalvik works out pretty well. The only time it's
338 * annoying is when enumerating or searching for things with reflection.
339 */
340struct ClassObject {
341 Object obj; /* MUST be first item */
342
343 /* leave space for instance data; we could access fields directly if we
344 freeze the definition of java/lang/Class */
345 u4 instanceData[CLASS_FIELD_SLOTS];
346
347 /* UTF-8 descriptor for the class; from constant pool, or on heap
348 if generated ("[C") */
349 const char* descriptor;
350 char* descriptorAlloc;
351
352 /* access flags; low 16 bits are defined by VM spec */
353 u4 accessFlags;
354
355 /* VM-unique class serial number, nonzero, set very early */
356 u4 serialNumber;
357
358 /* DexFile from which we came; needed to resolve constant pool entries */
359 /* (will be NULL for VM-generated, e.g. arrays and primitive classes) */
360 DvmDex* pDvmDex;
361
362 /* state of class initialization */
363 ClassStatus status;
364
365 /* if class verify fails, we must return same error on subsequent tries */
366 ClassObject* verifyErrorClass;
367
368 /* threadId, used to check for recursive <clinit> invocation */
369 u4 initThreadId;
370
371 /*
372 * Total object size; used when allocating storage on gc heap. (For
373 * interfaces and abstract classes this will be zero.)
374 */
375 size_t objectSize;
376
377 /* arrays only: class object for base element, for instanceof/checkcast
378 (for String[][][], this will be String) */
379 ClassObject* elementClass;
380
The Android Open Source Projectf6c38712009-03-03 19:28:47 -0800381 /* arrays only: number of dimensions, e.g. int[][] is 2 */
382 int arrayDim;
383
384 /* primitive type index, or PRIM_NOT (-1); set for generated prim classes */
385 PrimitiveType primitiveType;
386
387 /* superclass, or NULL if this is java.lang.Object */
388 ClassObject* super;
389
390 /* defining class loader, or NULL for the "bootstrap" system loader */
391 Object* classLoader;
392
393 /* initiating class loader list */
Barry Hayes2c987472009-04-06 10:03:48 -0700394 /* NOTE: for classes with low serialNumber, these are unused, and the
395 values are kept in a table in gDvm. */
396 InitiatingLoaderList initiatingLoaderList;
The Android Open Source Projectf6c38712009-03-03 19:28:47 -0800397
398 /* array of interfaces this class implements directly */
399 int interfaceCount;
400 ClassObject** interfaces;
401
402 /* static, private, and <init> methods */
403 int directMethodCount;
404 Method* directMethods;
405
406 /* virtual methods defined in this class; invoked through vtable */
407 int virtualMethodCount;
408 Method* virtualMethods;
409
410 /*
411 * Virtual method table (vtable), for use by "invoke-virtual". The
412 * vtable from the superclass is copied in, and virtual methods from
413 * our class either replace those from the super or are appended.
414 */
415 int vtableCount;
416 Method** vtable;
417
418 /*
419 * Interface table (iftable), one entry per interface supported by
420 * this class. That means one entry for each interface we support
421 * directly, indirectly via superclass, or indirectly via
422 * superinterface. This will be null if neither we nor our superclass
423 * implement any interfaces.
424 *
425 * Why we need this: given "class Foo implements Face", declare
426 * "Face faceObj = new Foo()". Invoke faceObj.blah(), where "blah" is
427 * part of the Face interface. We can't easily use a single vtable.
428 *
429 * For every interface a concrete class implements, we create a list of
430 * virtualMethod indices for the methods in the interface.
431 */
432 int iftableCount;
433 InterfaceEntry* iftable;
434
435 /*
436 * The interface vtable indices for iftable get stored here. By placing
437 * them all in a single pool for each class that implements interfaces,
438 * we decrease the number of allocations.
439 */
440 int ifviPoolCount;
441 int* ifviPool;
442
443 /* static fields */
444 int sfieldCount;
445 StaticField* sfields;
446
447 /* instance fields
448 *
449 * These describe the layout of the contents of a DataObject-compatible
450 * Object. Note that only the fields directly defined by this class
451 * are listed in ifields; fields defined by a superclass are listed
452 * in the superclass's ClassObject.ifields.
453 *
454 * All instance fields that refer to objects are guaranteed to be
455 * at the beginning of the field list. ifieldRefCount specifies
456 * the number of reference fields.
457 */
458 int ifieldCount;
459 int ifieldRefCount; // number of fields that are object refs
460 InstField* ifields;
461
Barry Hayeseac47ed2009-06-22 11:45:20 -0700462 /* bitmap of offsets of ifields */
463 u4 refOffsets;
464
The Android Open Source Projectf6c38712009-03-03 19:28:47 -0800465 /* source file name, if known */
466 const char* sourceFile;
467};
468
469/*
470 * A method. We create one of these for every method in every class
471 * we load, so try to keep the size to a minimum.
472 *
473 * Much of this comes from and could be accessed in the data held in shared
474 * memory. We hold it all together here for speed. Everything but the
475 * pointers could be held in a shared table generated by the optimizer;
476 * if we're willing to convert them to offsets and take the performance
477 * hit (e.g. "meth->insns" becomes "baseAddr + meth->insnsOffset") we
478 * could move everything but "nativeFunc".
479 */
480struct Method {
481 /* the class we are a part of */
482 ClassObject* clazz;
483
484 /* access flags; low 16 bits are defined by spec (could be u2?) */
485 u4 accessFlags;
486
487 /*
488 * For concrete virtual methods, this is the offset of the method
489 * in "vtable".
490 *
491 * For abstract methods in an interface class, this is the offset
492 * of the method in "iftable[n]->methodIndexArray".
493 */
494 u2 methodIndex;
495
496 /*
497 * Method bounds; not needed for an abstract method.
498 *
499 * For a native method, we compute the size of the argument list, and
500 * set "insSize" and "registerSize" equal to it.
501 */
502 u2 registersSize; /* ins + locals */
503 u2 outsSize;
504 u2 insSize;
505
506 /* method name, e.g. "<init>" or "eatLunch" */
507 const char* name;
508
509 /*
510 * Method prototype descriptor string (return and argument types).
511 *
512 * TODO: This currently must specify the DexFile as well as the proto_ids
513 * index, because generated Proxy classes don't have a DexFile. We can
514 * remove the DexFile* and reduce the size of this struct if we generate
515 * a DEX for proxies.
516 */
517 DexProto prototype;
518
519 /* short-form method descriptor string */
520 const char* shorty;
521
522 /*
523 * The remaining items are not used for abstract or native methods.
524 * (JNI is currently hijacking "insns" as a function pointer, set
525 * after the first call. For internal-native this stays null.)
526 */
527
528 /* the actual code */
529 const u2* insns; /* instructions, in memory-mapped .dex */
530
531 /* cached JNI argument and return-type hints */
532 int jniArgInfo;
533
534 /*
535 * Native method ptr; could be actual function or a JNI bridge. We
536 * don't currently discriminate between DalvikBridgeFunc and
537 * DalvikNativeFunc; the former takes an argument superset (i.e. two
538 * extra args) which will be ignored. If necessary we can use
539 * insns==NULL to detect JNI bridge vs. internal native.
540 */
541 DalvikBridgeFunc nativeFunc;
542
543 /*
544 * Register map data, if available. This will point into the DEX file
545 * if the data was computed during pre-verification, or into the
546 * linear alloc area if not.
547 */
548 const RegisterMap* registerMap;
549
550#ifdef WITH_PROFILER
551 bool inProfile;
552#endif
The Android Open Source Projectf6c38712009-03-03 19:28:47 -0800553};
554
555/*
556 * Generic field header. We pass this around when we want a generic Field
557 * pointer (e.g. for reflection stuff). Testing the accessFlags for
558 * ACC_STATIC allows a proper up-cast.
559 */
560struct Field {
561 ClassObject* clazz; /* class in which the field is declared */
562 const char* name;
563 const char* signature; /* e.g. "I", "[C", "Landroid/os/Debug;" */
564 u4 accessFlags;
565#ifdef PROFILE_FIELD_ACCESS
566 u4 gets;
567 u4 puts;
568#endif
569};
570
571/*
572 * Static field.
573 */
574struct StaticField {
575 Field field; /* MUST be first item */
576 JValue value; /* initially set from DEX for primitives */
577};
578
579/*
580 * Instance field.
581 */
582struct InstField {
583 Field field; /* MUST be first item */
584
585 /*
586 * This field indicates the byte offset from the beginning of the
587 * (Object *) to the actual instance data; e.g., byteOffset==0 is
588 * the same as the object pointer (bug!), and byteOffset==4 is 4
589 * bytes farther.
590 */
591 int byteOffset;
592};
593
594
595/*
596 * Find a method within a class. The superclass is not searched.
597 */
598Method* dvmFindDirectMethodByDescriptor(const ClassObject* clazz,
599 const char* methodName, const char* signature);
600Method* dvmFindVirtualMethodByDescriptor(const ClassObject* clazz,
601 const char* methodName, const char* signature);
602Method* dvmFindVirtualMethodByName(const ClassObject* clazz,
603 const char* methodName);
604Method* dvmFindDirectMethod(const ClassObject* clazz, const char* methodName,
605 const DexProto* proto);
606Method* dvmFindVirtualMethod(const ClassObject* clazz, const char* methodName,
607 const DexProto* proto);
608
609
610/*
611 * Find a method within a class hierarchy.
612 */
613Method* dvmFindDirectMethodHierByDescriptor(const ClassObject* clazz,
614 const char* methodName, const char* descriptor);
615Method* dvmFindVirtualMethodHierByDescriptor(const ClassObject* clazz,
616 const char* methodName, const char* signature);
617Method* dvmFindDirectMethodHier(const ClassObject* clazz,
618 const char* methodName, const DexProto* proto);
619Method* dvmFindVirtualMethodHier(const ClassObject* clazz,
620 const char* methodName, const DexProto* proto);
Andy McFadden1d9206d2009-07-15 14:34:49 -0700621Method* dvmFindMethodHier(const ClassObject* clazz, const char* methodName,
622 const DexProto* proto);
The Android Open Source Projectf6c38712009-03-03 19:28:47 -0800623
624/*
625 * Find the implementation of "meth" in "clazz".
626 *
627 * Returns NULL and throws an exception if not found.
628 */
629const Method* dvmGetVirtualizedMethod(const ClassObject* clazz,
630 const Method* meth);
631
632/*
633 * Get the source file associated with a method.
634 */
635const char* dvmGetMethodSourceFile(const Method* meth);
636
637/*
638 * Find a field within a class. The superclass is not searched.
639 */
640InstField* dvmFindInstanceField(const ClassObject* clazz,
641 const char* fieldName, const char* signature);
642StaticField* dvmFindStaticField(const ClassObject* clazz,
643 const char* fieldName, const char* signature);
644
645/*
646 * Find a field in a class/interface hierarchy.
647 */
648InstField* dvmFindInstanceFieldHier(const ClassObject* clazz,
649 const char* fieldName, const char* signature);
650StaticField* dvmFindStaticFieldHier(const ClassObject* clazz,
651 const char* fieldName, const char* signature);
Andy McFadden1d9206d2009-07-15 14:34:49 -0700652Field* dvmFindFieldHier(const ClassObject* clazz, const char* fieldName,
653 const char* signature);
The Android Open Source Projectf6c38712009-03-03 19:28:47 -0800654
655/*
656 * Find a field and return the byte offset from the object pointer. Only
657 * searches the specified class, not the superclass.
658 *
659 * Returns -1 on failure.
660 */
661INLINE int dvmFindFieldOffset(const ClassObject* clazz,
662 const char* fieldName, const char* signature)
663{
664 InstField* pField = dvmFindInstanceField(clazz, fieldName, signature);
665 if (pField == NULL)
666 return -1;
667 else
668 return pField->byteOffset;
669}
670
671/*
672 * Field access functions. Pass in the word offset from Field->byteOffset.
673 *
674 * We guarantee that long/double field data is 64-bit aligned, so it's safe
675 * to access them with ldrd/strd on ARM.
676 *
677 * The VM treats all fields as 32 or 64 bits, so the field set functions
678 * write 32 bits even if the underlying type is smaller.
679 */
680#define BYTE_OFFSET(_ptr, _offset) ((void*) (((u1*)(_ptr)) + (_offset)))
681
682INLINE JValue* dvmFieldPtr(const Object* obj, int offset) {
683 return ((JValue*)BYTE_OFFSET(obj, offset));
684}
685
686INLINE bool dvmGetFieldBoolean(const Object* obj, int offset) {
687 return ((JValue*)BYTE_OFFSET(obj, offset))->z;
688}
689INLINE s1 dvmGetFieldByte(const Object* obj, int offset) {
690 return ((JValue*)BYTE_OFFSET(obj, offset))->b;
691}
692INLINE s2 dvmGetFieldShort(const Object* obj, int offset) {
693 return ((JValue*)BYTE_OFFSET(obj, offset))->s;
694}
695INLINE u2 dvmGetFieldChar(const Object* obj, int offset) {
696 return ((JValue*)BYTE_OFFSET(obj, offset))->c;
697}
698INLINE s4 dvmGetFieldInt(const Object* obj, int offset) {
699 return ((JValue*)BYTE_OFFSET(obj, offset))->i;
700}
701INLINE s8 dvmGetFieldLong(const Object* obj, int offset) {
702 return ((JValue*)BYTE_OFFSET(obj, offset))->j;
703}
704INLINE float dvmGetFieldFloat(const Object* obj, int offset) {
705 return ((JValue*)BYTE_OFFSET(obj, offset))->f;
706}
707INLINE double dvmGetFieldDouble(const Object* obj, int offset) {
708 return ((JValue*)BYTE_OFFSET(obj, offset))->d;
709}
710INLINE Object* dvmGetFieldObject(const Object* obj, int offset) {
711 return ((JValue*)BYTE_OFFSET(obj, offset))->l;
712}
713
714INLINE void dvmSetFieldBoolean(Object* obj, int offset, bool val) {
715 ((JValue*)BYTE_OFFSET(obj, offset))->i = val;
716}
717INLINE void dvmSetFieldByte(Object* obj, int offset, s1 val) {
718 ((JValue*)BYTE_OFFSET(obj, offset))->i = val;
719}
720INLINE void dvmSetFieldShort(Object* obj, int offset, s2 val) {
721 ((JValue*)BYTE_OFFSET(obj, offset))->i = val;
722}
723INLINE void dvmSetFieldChar(Object* obj, int offset, u2 val) {
724 ((JValue*)BYTE_OFFSET(obj, offset))->i = val;
725}
726INLINE void dvmSetFieldInt(Object* obj, int offset, s4 val) {
727 ((JValue*)BYTE_OFFSET(obj, offset))->i = val;
728}
729INLINE void dvmSetFieldLong(Object* obj, int offset, s8 val) {
730 ((JValue*)BYTE_OFFSET(obj, offset))->j = val;
731}
732INLINE void dvmSetFieldFloat(Object* obj, int offset, float val) {
733 ((JValue*)BYTE_OFFSET(obj, offset))->f = val;
734}
735INLINE void dvmSetFieldDouble(Object* obj, int offset, double val) {
736 ((JValue*)BYTE_OFFSET(obj, offset))->d = val;
737}
738INLINE void dvmSetFieldObject(Object* obj, int offset, Object* val) {
739 ((JValue*)BYTE_OFFSET(obj, offset))->l = val;
740}
741
742/*
743 * Static field access functions.
744 */
745INLINE JValue* dvmStaticFieldPtr(const StaticField* sfield) {
746 return (JValue*)&sfield->value;
747}
748
749INLINE bool dvmGetStaticFieldBoolean(const StaticField* sfield) {
750 return sfield->value.z;
751}
752INLINE s1 dvmGetStaticFieldByte(const StaticField* sfield) {
753 return sfield->value.b;
754}
755INLINE s2 dvmGetStaticFieldShort(const StaticField* sfield) {
756 return sfield->value.s;
757}
758INLINE u2 dvmGetStaticFieldChar(const StaticField* sfield) {
759 return sfield->value.c;
760}
761INLINE s4 dvmGetStaticFieldInt(const StaticField* sfield) {
762 return sfield->value.i;
763}
764INLINE s8 dvmGetStaticFieldLong(const StaticField* sfield) {
765 return sfield->value.j;
766}
767INLINE float dvmGetStaticFieldFloat(const StaticField* sfield) {
768 return sfield->value.f;
769}
770INLINE double dvmGetStaticFieldDouble(const StaticField* sfield) {
771 return sfield->value.d;
772}
773INLINE Object* dvmGetStaticFieldObject(const StaticField* sfield) {
774 return sfield->value.l;
775}
776
777INLINE void dvmSetStaticFieldBoolean(StaticField* sfield, bool val) {
778 sfield->value.i = val;
779}
780INLINE void dvmSetStaticFieldByte(StaticField* sfield, s1 val) {
781 sfield->value.i = val;
782}
783INLINE void dvmSetStaticFieldShort(StaticField* sfield, s2 val) {
784 sfield->value.i = val;
785}
786INLINE void dvmSetStaticFieldChar(StaticField* sfield, u2 val) {
787 sfield->value.i = val;
788}
789INLINE void dvmSetStaticFieldInt(StaticField* sfield, s4 val) {
790 sfield->value.i = val;
791}
792INLINE void dvmSetStaticFieldLong(StaticField* sfield, s8 val) {
793 sfield->value.j = val;
794}
795INLINE void dvmSetStaticFieldFloat(StaticField* sfield, float val) {
796 sfield->value.f = val;
797}
798INLINE void dvmSetStaticFieldDouble(StaticField* sfield, double val) {
799 sfield->value.d = val;
800}
801INLINE void dvmSetStaticFieldObject(StaticField* sfield, Object* val) {
802 sfield->value.l = val;
803}
804
805/*
806 * Helpers.
807 */
808INLINE bool dvmIsPublicMethod(const Method* method) {
809 return (method->accessFlags & ACC_PUBLIC) != 0;
810}
811INLINE bool dvmIsPrivateMethod(const Method* method) {
812 return (method->accessFlags & ACC_PRIVATE) != 0;
813}
814INLINE bool dvmIsStaticMethod(const Method* method) {
815 return (method->accessFlags & ACC_STATIC) != 0;
816}
817INLINE bool dvmIsSynchronizedMethod(const Method* method) {
818 return (method->accessFlags & ACC_SYNCHRONIZED) != 0;
819}
820INLINE bool dvmIsDeclaredSynchronizedMethod(const Method* method) {
821 return (method->accessFlags & ACC_DECLARED_SYNCHRONIZED) != 0;
822}
823INLINE bool dvmIsFinalMethod(const Method* method) {
824 return (method->accessFlags & ACC_FINAL) != 0;
825}
826INLINE bool dvmIsNativeMethod(const Method* method) {
827 return (method->accessFlags & ACC_NATIVE) != 0;
828}
829INLINE bool dvmIsAbstractMethod(const Method* method) {
830 return (method->accessFlags & ACC_ABSTRACT) != 0;
831}
832INLINE bool dvmIsMirandaMethod(const Method* method) {
833 return (method->accessFlags & ACC_MIRANDA) != 0;
834}
835INLINE bool dvmIsConstructorMethod(const Method* method) {
836 return *method->name == '<';
837}
838/* Dalvik puts private, static, and constructors into non-virtual table */
839INLINE bool dvmIsDirectMethod(const Method* method) {
840 return dvmIsPrivateMethod(method) ||
841 dvmIsStaticMethod(method) ||
842 dvmIsConstructorMethod(method);
843}
844/* Get whether the given method has associated bytecode. This is the
845 * case for methods which are neither native nor abstract. */
846INLINE bool dvmIsBytecodeMethod(const Method* method) {
847 return (method->accessFlags & (ACC_NATIVE | ACC_ABSTRACT)) == 0;
848}
849
850INLINE bool dvmIsProtectedField(const Field* field) {
851 return (field->accessFlags & ACC_PROTECTED) != 0;
852}
853INLINE bool dvmIsStaticField(const Field* field) {
854 return (field->accessFlags & ACC_STATIC) != 0;
855}
856INLINE bool dvmIsFinalField(const Field* field) {
857 return (field->accessFlags & ACC_FINAL) != 0;
858}
859
860INLINE bool dvmIsInterfaceClass(const ClassObject* clazz) {
861 return (clazz->accessFlags & ACC_INTERFACE) != 0;
862}
863INLINE bool dvmIsPublicClass(const ClassObject* clazz) {
864 return (clazz->accessFlags & ACC_PUBLIC) != 0;
865}
866INLINE bool dvmIsFinalClass(const ClassObject* clazz) {
867 return (clazz->accessFlags & ACC_FINAL) != 0;
868}
869INLINE bool dvmIsAbstractClass(const ClassObject* clazz) {
870 return (clazz->accessFlags & ACC_ABSTRACT) != 0;
871}
872INLINE bool dvmIsAnnotationClass(const ClassObject* clazz) {
873 return (clazz->accessFlags & ACC_ANNOTATION) != 0;
874}
875INLINE bool dvmIsPrimitiveClass(const ClassObject* clazz) {
876 return clazz->primitiveType != PRIM_NOT;
877}
878
879/* linked, here meaning prepared and resolved */
880INLINE bool dvmIsClassLinked(const ClassObject* clazz) {
881 return clazz->status >= CLASS_RESOLVED;
882}
883/* has class been verified? */
884INLINE bool dvmIsClassVerified(const ClassObject* clazz) {
885 return clazz->status >= CLASS_VERIFIED;
886}
887
888/*
889 * Get the associated code struct for a method. This returns NULL
890 * for non-bytecode methods.
891 */
892INLINE const DexCode* dvmGetMethodCode(const Method* meth) {
893 if (dvmIsBytecodeMethod(meth)) {
894 /*
895 * The insns field for a bytecode method actually points at
896 * &(DexCode.insns), so we can subtract back to get at the
897 * DexCode in front.
898 */
899 return (const DexCode*)
900 (((const u1*) meth->insns) - offsetof(DexCode, insns));
901 } else {
902 return NULL;
903 }
904}
905
906/*
907 * Get the size of the insns associated with a method. This returns 0
908 * for non-bytecode methods.
909 */
910INLINE u4 dvmGetMethodInsnsSize(const Method* meth) {
911 const DexCode* pCode = dvmGetMethodCode(meth);
912 return (pCode == NULL) ? 0 : pCode->insnsSize;
913}
914
915/* debugging */
916void dvmDumpObject(const Object* obj);
917
918#endif /*_DALVIK_OO_OBJECT*/