2005-05-13 Adrian Straetling <straetling@de.ibm.com>
[official-gcc.git] / libjava / include / jvm.h
blobbceb291fb581967bdc3587b517817fc9c4846929
1 // jvm.h - Header file for private implementation information. -*- c++ -*-
3 /* Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005 Free Software Foundation
5 This file is part of libgcj.
7 This software is copyrighted work licensed under the terms of the
8 Libgcj License. Please consult the file "LIBGCJ_LICENSE" for
9 details. */
11 #ifndef __JAVA_JVM_H__
12 #define __JAVA_JVM_H__
14 // Define this before including jni.h.
15 // jni.h is included by jvmpi.h, which might be included. We define
16 // this unconditionally because it is convenient and it lets other
17 // files include jni.h without difficulty.
18 #define __GCJ_JNI_IMPL__
20 #include <gcj/javaprims.h>
22 #include <java-assert.h>
23 #include <java-threads.h>
24 // Must include java-gc.h before Object.h for the implementation.
25 #include <java-gc.h>
27 #include <java/lang/Object.h>
29 // Include cni.h before field.h to enable all definitions. FIXME.
30 #include <gcj/cni.h>
31 #include <gcj/field.h>
33 /* Macro for possible unused arguments. */
34 #define MAYBE_UNUSED __attribute__((__unused__))
36 /* Structure of the virtual table. */
37 struct _Jv_VTable
39 #ifdef __ia64__
40 typedef struct { void *pc, *gp; } vtable_elt;
41 #else
42 typedef void *vtable_elt;
43 #endif
44 jclass clas;
45 void *gc_descr;
47 // This must be last, as derived classes "extend" this by
48 // adding new data members.
49 vtable_elt method[1];
51 #ifdef __ia64__
52 void *get_method(int i) { return &method[i]; }
53 void set_method(int i, void *fptr) { method[i] = *(vtable_elt *)fptr; }
54 void *get_finalizer()
56 // We know that get_finalizer is only used for checking whether
57 // this object needs to have a finalizer registered. So it is
58 // safe to simply return just the PC component of the vtable
59 // slot.
60 return ((vtable_elt *)(get_method(0)))->pc;
62 #else
63 void *get_method(int i) { return method[i]; }
64 void set_method(int i, void *fptr) { method[i] = fptr; }
65 void *get_finalizer() { return get_method(0); }
66 #endif
68 static size_t vtable_elt_size() { return sizeof(vtable_elt); }
70 // Given a method index, return byte offset from the vtable pointer.
71 static jint idx_to_offset (int index)
73 return (2 * sizeof (void *)) + (index * vtable_elt_size ());
75 static _Jv_VTable *new_vtable (int count);
78 // Number of virtual methods on object. FIXME: it sucks that we have
79 // to keep this up to date by hand.
80 #define NUM_OBJECT_METHODS 5
82 union _Jv_word
84 jobject o;
85 jint i; // Also stores smaller integral types.
86 jfloat f;
87 jint ia[1]; // Half of _Jv_word2.
88 void* p;
90 #if SIZEOF_VOID_P == 8
91 // We can safely put a long or a double in here without increasing
92 // the size of _Jv_Word; we take advantage of this in the interpreter.
93 jlong l;
94 jdouble d;
95 #endif
97 jclass clazz;
98 jstring string;
99 struct _Jv_Field *field;
100 struct _Jv_Utf8Const *utf8;
101 struct _Jv_ResolvedMethod *rmethod;
104 union _Jv_word2
106 jint ia[2];
107 jlong l;
108 jdouble d;
111 union _Jv_value
113 jbyte byte_value;
114 jshort short_value;
115 jchar char_value;
116 jint int_value;
117 jlong long_value;
118 jfloat float_value;
119 jdouble double_value;
120 jobject object_value;
123 /* Extract a character from a Java-style Utf8 string.
124 * PTR points to the current character.
125 * LIMIT points to the end of the Utf8 string.
126 * PTR is incremented to point after the character thta gets returns.
127 * On an error, -1 is returned. */
128 #define UTF8_GET(PTR, LIMIT) \
129 ((PTR) >= (LIMIT) ? -1 \
130 : *(PTR) < 128 ? *(PTR)++ \
131 : (*(PTR)&0xE0) == 0xC0 && ((PTR)+=2)<=(LIMIT) && ((PTR)[-1]&0xC0) == 0x80 \
132 ? (((PTR)[-2] & 0x1F) << 6) + ((PTR)[-1] & 0x3F) \
133 : (*(PTR) & 0xF0) == 0xE0 && ((PTR) += 3) <= (LIMIT) \
134 && ((PTR)[-2] & 0xC0) == 0x80 && ((PTR)[-1] & 0xC0) == 0x80 \
135 ? (((PTR)[-3]&0x0F) << 12) + (((PTR)[-2]&0x3F) << 6) + ((PTR)[-1]&0x3F) \
136 : ((PTR)++, -1))
138 extern int _Jv_strLengthUtf8(char* str, int len);
140 typedef struct _Jv_Utf8Const Utf8Const;
141 _Jv_Utf8Const *_Jv_makeUtf8Const (char *s, int len);
142 _Jv_Utf8Const *_Jv_makeUtf8Const (jstring string);
143 extern jboolean _Jv_equalUtf8Consts (const _Jv_Utf8Const *, const _Jv_Utf8Const *);
144 extern jboolean _Jv_equal (_Jv_Utf8Const *, jstring, jint);
145 extern jboolean _Jv_equaln (_Jv_Utf8Const *, jstring, jint);
147 /* Helper class which converts a jstring to a temporary char*.
148 Uses the supplied buffer, if non-null. Otherwise, allocates
149 the buffer on the heap. Use the JV_TEMP_UTF_STRING macro,
150 which follows, to automatically allocate a stack buffer if
151 the string is small enough. */
152 class _Jv_TempUTFString
154 public:
155 _Jv_TempUTFString(jstring jstr, char* buf=0);
156 ~_Jv_TempUTFString();
158 // Accessors
159 operator const char*() const
161 return buf_;
163 const char* buf() const
165 return buf_;
167 char* buf()
169 return buf_;
172 private:
173 char* buf_;
174 bool heapAllocated_;
177 inline _Jv_TempUTFString::_Jv_TempUTFString (jstring jstr, char* buf)
178 : buf_(0), heapAllocated_(false)
180 if (!jstr) return;
181 jsize len = JvGetStringUTFLength (jstr);
182 if (buf)
183 buf_ = buf;
184 else
186 buf_ = (char*) _Jv_Malloc (len+1);
187 heapAllocated_ = true;
190 JvGetStringUTFRegion (jstr, 0, jstr->length(), buf_);
191 buf_[len] = '\0';
194 inline _Jv_TempUTFString::~_Jv_TempUTFString ()
196 if (heapAllocated_)
197 _Jv_Free (buf_);
200 /* Macro which uses _Jv_TempUTFString. Allocates a stack-based
201 buffer if the string and its null terminator are <= 256
202 characters in length. Otherwise, a heap-based buffer is
203 used. The parameters to this macro are the variable name
204 which is an instance of _Jv_TempUTFString (above) and a
205 jstring.
207 Sample Usage:
209 jstring jstr = getAJString();
210 JV_TEMP_UTF_STRING(utfstr, jstr);
211 printf("The string is: %s\n", utfstr.buf());
214 #define JV_TEMP_UTF_STRING(utfstr, jstr) \
215 jstring utfstr##thejstr = (jstr); \
216 jsize utfstr##_len = utfstr##thejstr ? JvGetStringUTFLength (utfstr##thejstr) + 1 : 0; \
217 char utfstr##_buf[utfstr##_len <= 256 ? utfstr##_len : 0]; \
218 _Jv_TempUTFString utfstr(utfstr##thejstr, sizeof(utfstr##_buf)==0 ? 0 : utfstr##_buf)
220 namespace gcj
222 /* Some constants used during lookup of special class methods. */
223 extern _Jv_Utf8Const *void_signature; /* "()V" */
224 extern _Jv_Utf8Const *clinit_name; /* "<clinit>" */
225 extern _Jv_Utf8Const *init_name; /* "<init>" */
226 extern _Jv_Utf8Const *finit_name; /* "finit$", */
228 /* Set to true by _Jv_CreateJavaVM. */
229 extern bool runtimeInitialized;
231 /* Print out class names as they are initialized. */
232 extern bool verbose_class_flag;
234 /* When true, enable the bytecode verifier and BC-ABI verification. */
235 extern bool verifyClasses;
238 // This class handles all aspects of class preparation and linking.
239 class _Jv_Linker
241 private:
242 static _Jv_Field *find_field_helper(jclass, _Jv_Utf8Const *, _Jv_Utf8Const *,
243 jclass *);
244 static _Jv_Field *find_field(jclass, jclass, jclass *, _Jv_Utf8Const *,
245 _Jv_Utf8Const *);
246 static void prepare_constant_time_tables(jclass);
247 static jshort get_interfaces(jclass, _Jv_ifaces *);
248 static void link_symbol_table(jclass);
249 static void link_exception_table(jclass);
250 static void layout_interface_methods(jclass);
251 static void layout_vtable_methods(jclass);
252 static void set_vtable_entries(jclass, _Jv_VTable *);
253 static void make_vtable(jclass);
254 static void ensure_fields_laid_out(jclass);
255 static void ensure_class_linked(jclass);
256 static void ensure_supers_installed(jclass);
257 static void add_miranda_methods(jclass, jclass);
258 static void ensure_method_table_complete(jclass);
259 static void verify_class(jclass);
260 static jshort find_iindex(jclass *, jshort *, jshort);
261 static jshort indexof(void *, void **, jshort);
262 static int get_alignment_from_class(jclass);
263 static void generate_itable(jclass, _Jv_ifaces *, jshort *);
264 static jshort append_partial_itable(jclass, jclass, void **, jshort);
265 static _Jv_Method *search_method_in_class (jclass, jclass,
266 _Jv_Utf8Const *,
267 _Jv_Utf8Const *);
269 public:
271 static bool has_field_p (jclass, _Jv_Utf8Const *);
272 static void print_class_loaded (jclass);
273 static void resolve_class_ref (jclass, jclass *);
274 static void wait_for_state(jclass, int);
275 static _Jv_word resolve_pool_entry (jclass, int);
276 static void resolve_field (_Jv_Field *, java::lang::ClassLoader *);
277 static void verify_type_assertions (jclass);
280 /* Type of pointer used as finalizer. */
281 typedef void _Jv_FinalizerFunc (jobject);
283 /* Allocate space for a new Java object. */
284 void *_Jv_AllocObj (jsize size, jclass cl) __attribute__((__malloc__));
285 /* Allocate space for a potentially uninitialized pointer-free object.
286 Interesting only with JV_HASH_SYNCHRONIZATION. */
287 void *_Jv_AllocPtrFreeObj (jsize size, jclass cl) __attribute__((__malloc__));
288 /* Allocate space for an array of Java objects. */
289 void *_Jv_AllocArray (jsize size, jclass cl) __attribute__((__malloc__));
290 /* Allocate space that is known to be pointer-free. */
291 void *_Jv_AllocBytes (jsize size) __attribute__((__malloc__));
292 /* Allocate space for a new non-Java object, which does not have the usual
293 Java object header but may contain pointers to other GC'ed objects. */
294 void *_Jv_AllocRawObj (jsize size) __attribute__((__malloc__));
295 /* Explicitly throw an out-of-memory exception. */
296 void _Jv_ThrowNoMemory() __attribute__((__noreturn__));
297 /* Allocate an object with a single pointer. The first word is reserved
298 for the GC, and the second word is the traced pointer. */
299 void *_Jv_AllocTraceOne (jsize size /* incl. reserved slot */);
300 /* Ditto, but for two traced pointers. */
301 void *_Jv_AllocTraceTwo (jsize size /* incl. reserved slot */);
302 /* Initialize the GC. */
303 void _Jv_InitGC (void);
304 /* Register a finalizer. */
305 void _Jv_RegisterFinalizer (void *object, _Jv_FinalizerFunc *method);
306 /* Compute the GC descriptor for a class */
307 void * _Jv_BuildGCDescr(jclass);
309 /* Allocate some unscanned, unmoveable memory. Return NULL if out of
310 memory. */
311 void *_Jv_MallocUnchecked (jsize size) __attribute__((__malloc__));
313 /* Initialize finalizers. The argument is a function to be called
314 when a finalizer is ready to be run. */
315 void _Jv_GCInitializeFinalizers (void (*notifier) (void));
316 /* Run finalizers for objects ready to be finalized.. */
317 void _Jv_RunFinalizers (void);
318 /* Run all finalizers. Should be called only before exit. */
319 void _Jv_RunAllFinalizers (void);
320 /* Perform a GC. */
321 void _Jv_RunGC (void);
322 /* Disable and enable GC. */
323 void _Jv_DisableGC (void);
324 void _Jv_EnableGC (void);
325 /* Register a disappearing link. This is a field F which should be
326 cleared when *F is found to be inaccessible. This is used in the
327 implementation of java.lang.ref.Reference. */
328 void _Jv_GCRegisterDisappearingLink (jobject *objp);
329 /* Return true if OBJECT should be reclaimed. This is used to
330 implement soft references. */
331 jboolean _Jv_GCCanReclaimSoftReference (jobject obj);
333 /* Register a finalizer for a String object. This is only used by
334 the intern() implementation. */
335 void _Jv_RegisterStringFinalizer (jobject str);
336 /* This is called to actually finalize a possibly-intern()d String. */
337 void _Jv_FinalizeString (jobject str);
339 /* Return approximation of total size of heap. */
340 long _Jv_GCTotalMemory (void);
341 /* Return approximation of total free memory. */
342 long _Jv_GCFreeMemory (void);
344 /* Set initial heap size. If SIZE==0, ignore. Should be run before
345 _Jv_InitGC. Not required to have any actual effect. */
346 void _Jv_GCSetInitialHeapSize (size_t size);
348 /* Set maximum heap size. If SIZE==0, unbounded. Should be run
349 before _Jv_InitGC. Not required to have any actual effect. */
350 void _Jv_GCSetMaximumHeapSize (size_t size);
352 /* External interface to setting the heap size. Parses ARG (a number
353 which can optionally have "k" or "m" appended and calls
354 _Jv_GCSetInitialHeapSize. */
355 void _Jv_SetInitialHeapSize (const char *arg);
357 /* External interface to setting the maximum heap size. Parses ARG (a
358 number which can optionally have "k" or "m" appended and calls
359 _Jv_GCSetMaximumHeapSize. */
360 void _Jv_SetMaximumHeapSize (const char *arg);
362 extern "C" void JvRunMain (jclass klass, int argc, const char **argv);
363 void _Jv_RunMain (jclass klass, const char *name, int argc, const char **argv,
364 bool is_jar);
366 void _Jv_RunMain (struct _Jv_VMInitArgs *vm_args, jclass klass,
367 const char *name, int argc, const char **argv, bool is_jar);
369 // Delayed until after _Jv_AllocBytes is declared.
371 // Note that we allocate this as unscanned memory -- the vtables
372 // are handled specially by the GC.
374 inline _Jv_VTable *
375 _Jv_VTable::new_vtable (int count)
377 size_t size = sizeof(_Jv_VTable) + (count - 1) * vtable_elt_size ();
378 return (_Jv_VTable *) _Jv_AllocBytes (size);
381 // Determine if METH gets an entry in a VTable.
382 static inline jboolean _Jv_isVirtualMethod (_Jv_Method *meth)
384 using namespace java::lang::reflect;
385 return (((meth->accflags & (Modifier::STATIC | Modifier::PRIVATE)) == 0)
386 && meth->name->first() != '<');
389 // This function is used to determine the hash code of an object.
390 inline jint
391 _Jv_HashCode (jobject obj)
393 // This was chosen to yield relatively well distributed results on
394 // both 32- and 64-bit architectures. Note 0x7fffffff is prime.
395 // FIXME: we assume sizeof(long) == sizeof(void *).
396 return (jint) ((unsigned long) obj % 0x7fffffff);
399 // Return a raw pointer to the elements of an array given the array
400 // and its element type. You might think we could just pick a single
401 // array type and use elements() on it, but we can't because we must
402 // account for alignment of the element type. When ARRAY is null, we
403 // obtain the number of bytes taken by the base part of the array.
404 inline char *
405 _Jv_GetArrayElementFromElementType (jobject array,
406 jclass element_type)
408 char *elts;
409 if (element_type == JvPrimClass (byte))
410 elts = (char *) elements ((jbyteArray) array);
411 else if (element_type == JvPrimClass (short))
412 elts = (char *) elements ((jshortArray) array);
413 else if (element_type == JvPrimClass (int))
414 elts = (char *) elements ((jintArray) array);
415 else if (element_type == JvPrimClass (long))
416 elts = (char *) elements ((jlongArray) array);
417 else if (element_type == JvPrimClass (boolean))
418 elts = (char *) elements ((jbooleanArray) array);
419 else if (element_type == JvPrimClass (char))
420 elts = (char *) elements ((jcharArray) array);
421 else if (element_type == JvPrimClass (float))
422 elts = (char *) elements ((jfloatArray) array);
423 else if (element_type == JvPrimClass (double))
424 elts = (char *) elements ((jdoubleArray) array);
425 else
426 elts = (char *) elements ((jobjectArray) array);
427 return elts;
430 extern "C" void _Jv_ThrowBadArrayIndex (jint bad_index)
431 __attribute__((noreturn));
432 extern "C" void _Jv_ThrowNullPointerException (void)
433 __attribute__((noreturn));
434 extern "C" jobject _Jv_NewArray (jint type, jint size)
435 __attribute__((__malloc__));
436 extern "C" jobject _Jv_NewMultiArray (jclass klass, jint dims, ...)
437 __attribute__((__malloc__));
438 extern "C" void *_Jv_CheckCast (jclass klass, jobject obj);
439 extern "C" void *_Jv_LookupInterfaceMethod (jclass klass, Utf8Const *name,
440 Utf8Const *signature);
441 extern "C" void *_Jv_LookupInterfaceMethodIdx (jclass klass, jclass iface,
442 int meth_idx);
443 extern "C" void _Jv_CheckArrayStore (jobject array, jobject obj);
444 extern "C" void _Jv_RegisterClass (jclass klass);
445 extern "C" void _Jv_RegisterClasses (const jclass *classes);
446 extern "C" void _Jv_RegisterClasses_Counted (const jclass *classes,
447 size_t count);
448 extern "C" void _Jv_RegisterResource (void *vptr);
449 extern void _Jv_UnregisterClass (_Jv_Utf8Const*, java::lang::ClassLoader*);
451 extern jclass _Jv_FindClass (_Jv_Utf8Const *name,
452 java::lang::ClassLoader *loader);
453 extern jclass _Jv_FindClassFromSignature (char *,
454 java::lang::ClassLoader *loader,
455 char ** = NULL);
456 extern void _Jv_GetTypesFromSignature (jmethodID method,
457 jclass declaringClass,
458 JArray<jclass> **arg_types_out,
459 jclass *return_type_out);
461 extern jboolean _Jv_CheckAccess (jclass self_klass, jclass other_klass,
462 jint flags);
464 extern jobject _Jv_CallAnyMethodA (jobject obj, jclass return_type,
465 jmethodID meth, jboolean is_constructor,
466 JArray<jclass> *parameter_types,
467 jobjectArray args,
468 jclass iface = NULL);
470 union jvalue;
471 extern void _Jv_CallAnyMethodA (jobject obj,
472 jclass return_type,
473 jmethodID meth,
474 jboolean is_constructor,
475 jboolean is_virtual_call,
476 JArray<jclass> *parameter_types,
477 jvalue *args,
478 jvalue *result,
479 jboolean is_jni_call = true,
480 jclass iface = NULL);
482 extern jobject _Jv_NewMultiArray (jclass, jint ndims, jint* dims)
483 __attribute__((__malloc__));
485 /* Checked divide subroutines. */
486 extern "C"
488 jint _Jv_divI (jint, jint);
489 jint _Jv_remI (jint, jint);
490 jlong _Jv_divJ (jlong, jlong);
491 jlong _Jv_remJ (jlong, jlong);
494 /* Get the number of arguments (cf. argc) or 0 if our argument
495 list was never initialized. */
496 extern int _Jv_GetNbArgs (void);
498 /* Get the specified argument (cf. argv[index]) or "" if either
499 our argument list was never initialized or the specified index
500 is out of bounds. */
501 extern const char * _Jv_GetSafeArg (int index);
503 /* Sets our argument list. Can be used by programs with non-standard
504 entry points. */
505 extern void _Jv_SetArgs (int argc, const char **argv);
507 /* Get the name of the running executable. */
508 extern const char *_Jv_ThisExecutable (void);
510 /* Return a pointer to a symbol in executable or loaded library. */
511 void *_Jv_FindSymbolInExecutable (const char *);
513 /* Initialize JNI. */
514 extern void _Jv_JNI_Init (void);
516 /* Get or set the per-thread JNIEnv used by the invocation API. */
517 _Jv_JNIEnv *_Jv_GetCurrentJNIEnv ();
518 void _Jv_SetCurrentJNIEnv (_Jv_JNIEnv *);
520 /* Free a JNIEnv. */
521 void _Jv_FreeJNIEnv (_Jv_JNIEnv *);
523 /* Free a JNIEnv. */
524 void _Jv_FreeJNIEnv (_Jv_JNIEnv *);
526 struct _Jv_JavaVM;
527 _Jv_JavaVM *_Jv_GetJavaVM ();
529 // Some verification functions from defineclass.cc.
530 bool _Jv_VerifyFieldSignature (_Jv_Utf8Const*sig);
531 bool _Jv_VerifyMethodSignature (_Jv_Utf8Const*sig);
532 bool _Jv_VerifyClassName (unsigned char* ptr, _Jv_ushort length);
533 bool _Jv_VerifyClassName (_Jv_Utf8Const *name);
534 bool _Jv_VerifyIdentifier (_Jv_Utf8Const *);
535 bool _Jv_ClassNameSamePackage (_Jv_Utf8Const *name1, _Jv_Utf8Const *name2);
537 struct _Jv_core_chain
539 int name_length;
540 const char *name;
541 int data_length;
542 const void *data;
544 struct _Jv_core_chain *next;
547 // This is called when new core data is loaded.
548 extern void (*_Jv_RegisterCoreHook) (_Jv_core_chain *);
550 _Jv_core_chain *_Jv_FindCore (_Jv_core_chain *node, jstring name);
551 void _Jv_FreeCoreChain (_Jv_core_chain *chain);
553 #ifdef ENABLE_JVMPI
555 #include "jvmpi.h"
557 extern void (*_Jv_JVMPI_Notify_OBJECT_ALLOC) (JVMPI_Event *event);
558 extern void (*_Jv_JVMPI_Notify_THREAD_START) (JVMPI_Event *event);
559 extern void (*_Jv_JVMPI_Notify_THREAD_END) (JVMPI_Event *event);
560 #endif
562 /* FIXME: this should really be defined in some more generic place */
563 #define ROUND(V, A) (((((unsigned) (V))-1) | ((A)-1))+1)
565 extern void _Jv_RegisterBootstrapPackages ();
568 // This is used to find ABI versions we recognize.
569 #define GCJ_VERSION (__GNUC__ * 10000 + __GNUC_MINOR__ * 10)
570 #define GCJ_BINARYCOMPAT_ADDITION 5
571 #define GCJ_BOOTSTRAP_LOADER_ADDITION 1
573 // At present we know we are compatible with the BC ABI as used in GCC
574 // 4.0.
575 #define GCJ_40_BC_ABI_VERSION (4 * 10000 + 0 * 10 + GCJ_BINARYCOMPAT_ADDITION)
577 inline bool
578 _Jv_CheckABIVersion (unsigned long value)
580 // Recognize our defined C++ ABIs.
581 return (value == GCJ_VERSION
582 || value == (GCJ_VERSION + GCJ_BOOTSTRAP_LOADER_ADDITION)
583 || value == GCJ_40_BC_ABI_VERSION
584 || value == (GCJ_40_BC_ABI_VERSION + GCJ_BOOTSTRAP_LOADER_ADDITION));
587 inline bool
588 _Jv_ClassForBootstrapLoader (unsigned long value)
590 return (value == (GCJ_VERSION + GCJ_BOOTSTRAP_LOADER_ADDITION)
591 || value == (GCJ_40_BC_ABI_VERSION + GCJ_BOOTSTRAP_LOADER_ADDITION));
594 // It makes the source cleaner if we simply always define this
595 // function. If the interpreter is not built, it will never return
596 // 'true'.
597 extern inline jboolean
598 _Jv_IsInterpretedClass (jclass c)
600 return (c->accflags & java::lang::reflect::Modifier::INTERPRETED) != 0;
603 #endif /* __JAVA_JVM_H__ */