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
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.
27 #include <java/lang/Object.h>
29 // Include cni.h before field.h to enable all definitions. FIXME.
31 #include <gcj/field.h>
33 /* Macro for possible unused arguments. */
34 #define MAYBE_UNUSED __attribute__((__unused__))
36 /* Structure of the virtual table. */
40 typedef struct { void *pc
, *gp
; } vtable_elt
;
42 typedef void *vtable_elt
;
47 // This must be last, as derived classes "extend" this by
48 // adding new data members.
52 void *get_method(int i
) { return &method
[i
]; }
53 void set_method(int i
, void *fptr
) { method
[i
] = *(vtable_elt
*)fptr
; }
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
60 return ((vtable_elt
*)(get_method(0)))->pc
;
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); }
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
85 jint i
; // Also stores smaller integral types.
87 jint ia
[1]; // Half of _Jv_word2.
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.
99 struct _Jv_Field
*field
;
100 struct _Jv_Utf8Const
*utf8
;
101 struct _Jv_ResolvedMethod
*rmethod
;
119 jdouble double_value
;
120 jobject object_value
;
123 // An instance of this type is used to represent a single frame in a
124 // backtrace. If the interpreter has been built, we also include
125 // information about the interpreted method.
126 struct _Jv_frame_info
131 // Actually a _Jv_InterpMethod, but we don't want to include
132 // java-interp.h everywhere.
134 #endif // INTERPRETER
137 /* Extract a character from a Java-style Utf8 string.
138 * PTR points to the current character.
139 * LIMIT points to the end of the Utf8 string.
140 * PTR is incremented to point after the character thta gets returns.
141 * On an error, -1 is returned. */
142 #define UTF8_GET(PTR, LIMIT) \
143 ((PTR) >= (LIMIT) ? -1 \
144 : *(PTR) < 128 ? *(PTR)++ \
145 : (*(PTR)&0xE0) == 0xC0 && ((PTR)+=2)<=(LIMIT) && ((PTR)[-1]&0xC0) == 0x80 \
146 ? (((PTR)[-2] & 0x1F) << 6) + ((PTR)[-1] & 0x3F) \
147 : (*(PTR) & 0xF0) == 0xE0 && ((PTR) += 3) <= (LIMIT) \
148 && ((PTR)[-2] & 0xC0) == 0x80 && ((PTR)[-1] & 0xC0) == 0x80 \
149 ? (((PTR)[-3]&0x0F) << 12) + (((PTR)[-2]&0x3F) << 6) + ((PTR)[-1]&0x3F) \
152 extern int _Jv_strLengthUtf8(char* str
, int len
);
154 typedef struct _Jv_Utf8Const Utf8Const
;
155 _Jv_Utf8Const
*_Jv_makeUtf8Const (char *s
, int len
);
156 _Jv_Utf8Const
*_Jv_makeUtf8Const (jstring string
);
157 extern jboolean
_Jv_equalUtf8Consts (const _Jv_Utf8Const
*, const _Jv_Utf8Const
*);
158 extern jboolean
_Jv_equal (_Jv_Utf8Const
*, jstring
, jint
);
159 extern jboolean
_Jv_equaln (_Jv_Utf8Const
*, jstring
, jint
);
161 /* Helper class which converts a jstring to a temporary char*.
162 Uses the supplied buffer, if non-null. Otherwise, allocates
163 the buffer on the heap. Use the JV_TEMP_UTF_STRING macro,
164 which follows, to automatically allocate a stack buffer if
165 the string is small enough. */
166 class _Jv_TempUTFString
169 _Jv_TempUTFString(jstring jstr
, char* buf
=0);
170 ~_Jv_TempUTFString();
173 operator const char*() const
177 const char* buf() const
191 inline _Jv_TempUTFString::_Jv_TempUTFString (jstring jstr
, char* buf
)
192 : buf_(0), heapAllocated_(false)
195 jsize len
= JvGetStringUTFLength (jstr
);
200 buf_
= (char*) _Jv_Malloc (len
+1);
201 heapAllocated_
= true;
204 JvGetStringUTFRegion (jstr
, 0, jstr
->length(), buf_
);
208 inline _Jv_TempUTFString::~_Jv_TempUTFString ()
214 /* Macro which uses _Jv_TempUTFString. Allocates a stack-based
215 buffer if the string and its null terminator are <= 256
216 characters in length. Otherwise, a heap-based buffer is
217 used. The parameters to this macro are the variable name
218 which is an instance of _Jv_TempUTFString (above) and a
223 jstring jstr = getAJString();
224 JV_TEMP_UTF_STRING(utfstr, jstr);
225 printf("The string is: %s\n", utfstr.buf());
228 #define JV_TEMP_UTF_STRING(utfstr, jstr) \
229 jstring utfstr##thejstr = (jstr); \
230 jsize utfstr##_len = utfstr##thejstr ? JvGetStringUTFLength (utfstr##thejstr) + 1 : 0; \
231 char utfstr##_buf[utfstr##_len <= 256 ? utfstr##_len : 0]; \
232 _Jv_TempUTFString utfstr(utfstr##thejstr, sizeof(utfstr##_buf)==0 ? 0 : utfstr##_buf)
236 /* Some constants used during lookup of special class methods. */
237 extern _Jv_Utf8Const
*void_signature
; /* "()V" */
238 extern _Jv_Utf8Const
*clinit_name
; /* "<clinit>" */
239 extern _Jv_Utf8Const
*init_name
; /* "<init>" */
240 extern _Jv_Utf8Const
*finit_name
; /* "finit$", */
242 /* Set to true by _Jv_CreateJavaVM. */
243 extern bool runtimeInitialized
;
245 /* Print out class names as they are initialized. */
246 extern bool verbose_class_flag
;
249 // This class handles all aspects of class preparation and linking.
253 static _Jv_Field
*find_field_helper(jclass
, _Jv_Utf8Const
*, jclass
*);
254 static _Jv_Field
*find_field(jclass
, jclass
, _Jv_Utf8Const
*,
256 static void prepare_constant_time_tables(jclass
);
257 static jshort
get_interfaces(jclass
, _Jv_ifaces
*);
258 static void link_symbol_table(jclass
);
259 static void link_exception_table(jclass
);
260 static void layout_interface_methods(jclass
);
261 static void layout_vtable_methods(jclass
);
262 static void set_vtable_entries(jclass
, _Jv_VTable
*);
263 static void make_vtable(jclass
);
264 static void ensure_fields_laid_out(jclass
);
265 static void ensure_class_linked(jclass
);
266 static void ensure_supers_installed(jclass
);
267 static void add_miranda_methods(jclass
, jclass
);
268 static void ensure_method_table_complete(jclass
);
269 static void verify_class(jclass
);
270 static jshort
find_iindex(jclass
*, jshort
*, jshort
);
271 static jshort
indexof(void *, void **, jshort
);
272 static int get_alignment_from_class(jclass
);
273 static void generate_itable(jclass
, _Jv_ifaces
*, jshort
*);
274 static jshort
append_partial_itable(jclass
, jclass
, void **, jshort
);
275 static _Jv_Method
*search_method_in_class (jclass
, jclass
,
281 static bool has_field_p (jclass
, _Jv_Utf8Const
*);
282 static void print_class_loaded (jclass
);
283 static void resolve_class_ref (jclass
, jclass
*);
284 static void wait_for_state(jclass
, int);
285 static _Jv_word
resolve_pool_entry (jclass
, int);
286 static void resolve_field (_Jv_Field
*, java::lang::ClassLoader
*);
287 static void verify_type_assertions (jclass
);
290 /* Type of pointer used as finalizer. */
291 typedef void _Jv_FinalizerFunc (jobject
);
293 /* Allocate space for a new Java object. */
294 void *_Jv_AllocObj (jsize size
, jclass cl
) __attribute__((__malloc__
));
295 /* Allocate space for a potentially uninitialized pointer-free object.
296 Interesting only with JV_HASH_SYNCHRONIZATION. */
297 void *_Jv_AllocPtrFreeObj (jsize size
, jclass cl
) __attribute__((__malloc__
));
298 /* Allocate space for an array of Java objects. */
299 void *_Jv_AllocArray (jsize size
, jclass cl
) __attribute__((__malloc__
));
300 /* Allocate space that is known to be pointer-free. */
301 void *_Jv_AllocBytes (jsize size
) __attribute__((__malloc__
));
302 /* Allocate space for a new non-Java object, which does not have the usual
303 Java object header but may contain pointers to other GC'ed objects. */
304 void *_Jv_AllocRawObj (jsize size
) __attribute__((__malloc__
));
305 /* Explicitly throw an out-of-memory exception. */
306 void _Jv_ThrowNoMemory() __attribute__((__noreturn__
));
307 /* Allocate an object with a single pointer. The first word is reserved
308 for the GC, and the second word is the traced pointer. */
309 void *_Jv_AllocTraceOne (jsize size
/* incl. reserved slot */);
310 /* Ditto, but for two traced pointers. */
311 void *_Jv_AllocTraceTwo (jsize size
/* incl. reserved slot */);
312 /* Initialize the GC. */
313 void _Jv_InitGC (void);
314 /* Register a finalizer. */
315 void _Jv_RegisterFinalizer (void *object
, _Jv_FinalizerFunc
*method
);
316 /* Compute the GC descriptor for a class */
317 void * _Jv_BuildGCDescr(jclass
);
319 /* Allocate some unscanned, unmoveable memory. Return NULL if out of
321 void *_Jv_MallocUnchecked (jsize size
) __attribute__((__malloc__
));
323 /* Initialize finalizers. The argument is a function to be called
324 when a finalizer is ready to be run. */
325 void _Jv_GCInitializeFinalizers (void (*notifier
) (void));
326 /* Run finalizers for objects ready to be finalized.. */
327 void _Jv_RunFinalizers (void);
328 /* Run all finalizers. Should be called only before exit. */
329 void _Jv_RunAllFinalizers (void);
331 void _Jv_RunGC (void);
332 /* Disable and enable GC. */
333 void _Jv_DisableGC (void);
334 void _Jv_EnableGC (void);
335 /* Register a disappearing link. This is a field F which should be
336 cleared when *F is found to be inaccessible. This is used in the
337 implementation of java.lang.ref.Reference. */
338 void _Jv_GCRegisterDisappearingLink (jobject
*objp
);
339 /* Return true if OBJECT should be reclaimed. This is used to
340 implement soft references. */
341 jboolean
_Jv_GCCanReclaimSoftReference (jobject obj
);
343 /* Register a finalizer for a String object. This is only used by
344 the intern() implementation. */
345 void _Jv_RegisterStringFinalizer (jobject str
);
346 /* This is called to actually finalize a possibly-intern()d String. */
347 void _Jv_FinalizeString (jobject str
);
349 /* Return approximation of total size of heap. */
350 long _Jv_GCTotalMemory (void);
351 /* Return approximation of total free memory. */
352 long _Jv_GCFreeMemory (void);
354 /* Set initial heap size. If SIZE==0, ignore. Should be run before
355 _Jv_InitGC. Not required to have any actual effect. */
356 void _Jv_GCSetInitialHeapSize (size_t size
);
358 /* Set maximum heap size. If SIZE==0, unbounded. Should be run
359 before _Jv_InitGC. Not required to have any actual effect. */
360 void _Jv_GCSetMaximumHeapSize (size_t size
);
362 /* External interface to setting the heap size. Parses ARG (a number
363 which can optionally have "k" or "m" appended and calls
364 _Jv_GCSetInitialHeapSize. */
365 void _Jv_SetInitialHeapSize (const char *arg
);
367 /* External interface to setting the maximum heap size. Parses ARG (a
368 number which can optionally have "k" or "m" appended and calls
369 _Jv_GCSetMaximumHeapSize. */
370 void _Jv_SetMaximumHeapSize (const char *arg
);
372 extern "C" void JvRunMain (jclass klass
, int argc
, const char **argv
);
373 void _Jv_RunMain (jclass klass
, const char *name
, int argc
, const char **argv
,
376 // Delayed until after _Jv_AllocBytes is declared.
378 // Note that we allocate this as unscanned memory -- the vtables
379 // are handled specially by the GC.
382 _Jv_VTable::new_vtable (int count
)
384 size_t size
= sizeof(_Jv_VTable
) + (count
- 1) * vtable_elt_size ();
385 return (_Jv_VTable
*) _Jv_AllocBytes (size
);
388 // Determine if METH gets an entry in a VTable.
389 static inline jboolean
_Jv_isVirtualMethod (_Jv_Method
*meth
)
391 using namespace java::lang::reflect
;
392 return (((meth
->accflags
& (Modifier::STATIC
| Modifier::PRIVATE
)) == 0)
393 && meth
->name
->first() != '<');
396 // This function is used to determine the hash code of an object.
398 _Jv_HashCode (jobject obj
)
400 // This was chosen to yield relatively well distributed results on
401 // both 32- and 64-bit architectures. Note 0x7fffffff is prime.
402 // FIXME: we assume sizeof(long) == sizeof(void *).
403 return (jint
) ((unsigned long) obj
% 0x7fffffff);
406 // Return a raw pointer to the elements of an array given the array
407 // and its element type. You might think we could just pick a single
408 // array type and use elements() on it, but we can't because we must
409 // account for alignment of the element type. When ARRAY is null, we
410 // obtain the number of bytes taken by the base part of the array.
412 _Jv_GetArrayElementFromElementType (jobject array
,
416 if (element_type
== JvPrimClass (byte
))
417 elts
= (char *) elements ((jbyteArray
) array
);
418 else if (element_type
== JvPrimClass (short))
419 elts
= (char *) elements ((jshortArray
) array
);
420 else if (element_type
== JvPrimClass (int))
421 elts
= (char *) elements ((jintArray
) array
);
422 else if (element_type
== JvPrimClass (long))
423 elts
= (char *) elements ((jlongArray
) array
);
424 else if (element_type
== JvPrimClass (boolean
))
425 elts
= (char *) elements ((jbooleanArray
) array
);
426 else if (element_type
== JvPrimClass (char))
427 elts
= (char *) elements ((jcharArray
) array
);
428 else if (element_type
== JvPrimClass (float))
429 elts
= (char *) elements ((jfloatArray
) array
);
430 else if (element_type
== JvPrimClass (double))
431 elts
= (char *) elements ((jdoubleArray
) array
);
433 elts
= (char *) elements ((jobjectArray
) array
);
437 extern "C" void _Jv_ThrowBadArrayIndex (jint bad_index
)
438 __attribute__((noreturn
));
439 extern "C" void _Jv_ThrowNullPointerException (void)
440 __attribute__((noreturn
));
441 extern "C" jobject
_Jv_NewArray (jint type
, jint size
)
442 __attribute__((__malloc__
));
443 extern "C" jobject
_Jv_NewMultiArray (jclass klass
, jint dims
, ...)
444 __attribute__((__malloc__
));
445 extern "C" void *_Jv_CheckCast (jclass klass
, jobject obj
);
446 extern "C" void *_Jv_LookupInterfaceMethod (jclass klass
, Utf8Const
*name
,
447 Utf8Const
*signature
);
448 extern "C" void *_Jv_LookupInterfaceMethodIdx (jclass klass
, jclass iface
,
450 extern "C" void _Jv_CheckArrayStore (jobject array
, jobject obj
);
451 extern "C" void _Jv_RegisterClass (jclass klass
);
452 extern "C" void _Jv_RegisterClasses (const jclass
*classes
);
453 extern "C" void _Jv_RegisterClasses_Counted (const jclass
*classes
,
455 extern "C" void _Jv_RegisterResource (void *vptr
);
456 extern void _Jv_UnregisterClass (_Jv_Utf8Const
*, java::lang::ClassLoader
*);
458 extern jclass
_Jv_FindClass (_Jv_Utf8Const
*name
,
459 java::lang::ClassLoader
*loader
);
460 extern jclass
_Jv_FindClassFromSignature (char *,
461 java::lang::ClassLoader
*loader
);
462 extern void _Jv_GetTypesFromSignature (jmethodID method
,
463 jclass declaringClass
,
464 JArray
<jclass
> **arg_types_out
,
465 jclass
*return_type_out
);
467 extern jboolean
_Jv_CheckAccess (jclass self_klass
, jclass other_klass
,
470 extern jobject
_Jv_CallAnyMethodA (jobject obj
, jclass return_type
,
471 jmethodID meth
, jboolean is_constructor
,
472 JArray
<jclass
> *parameter_types
,
474 jclass iface
= NULL
);
477 extern void _Jv_CallAnyMethodA (jobject obj
,
480 jboolean is_constructor
,
481 jboolean is_virtual_call
,
482 JArray
<jclass
> *parameter_types
,
485 jboolean is_jni_call
= true,
486 jclass iface
= NULL
);
488 extern jobject
_Jv_NewMultiArray (jclass
, jint ndims
, jint
* dims
)
489 __attribute__((__malloc__
));
491 /* Checked divide subroutines. */
494 jint
_Jv_divI (jint
, jint
);
495 jint
_Jv_remI (jint
, jint
);
496 jlong
_Jv_divJ (jlong
, jlong
);
497 jlong
_Jv_remJ (jlong
, jlong
);
500 /* Get the number of arguments (cf. argc) or 0 if our argument
501 list was never initialized. */
502 extern int _Jv_GetNbArgs (void);
504 /* Get the specified argument (cf. argv[index]) or "" if either
505 our argument list was never initialized or the specified index
507 extern const char * _Jv_GetSafeArg (int index
);
509 /* Sets our argument list. Can be used by programs with non-standard
511 extern void _Jv_SetArgs (int argc
, const char **argv
);
513 /* Get the name of the running executable. */
514 extern const char *_Jv_ThisExecutable (void);
516 /* Return a pointer to a symbol in executable or loaded library. */
517 void *_Jv_FindSymbolInExecutable (const char *);
519 /* Initialize JNI. */
520 extern void _Jv_JNI_Init (void);
522 /* Get or set the per-thread JNIEnv used by the invocation API. */
523 _Jv_JNIEnv
*_Jv_GetCurrentJNIEnv ();
524 void _Jv_SetCurrentJNIEnv (_Jv_JNIEnv
*);
527 void _Jv_FreeJNIEnv (_Jv_JNIEnv
*);
530 void _Jv_FreeJNIEnv (_Jv_JNIEnv
*);
533 _Jv_JavaVM
*_Jv_GetJavaVM ();
535 // Some verification functions from defineclass.cc.
536 bool _Jv_VerifyFieldSignature (_Jv_Utf8Const
*sig
);
537 bool _Jv_VerifyMethodSignature (_Jv_Utf8Const
*sig
);
538 bool _Jv_VerifyClassName (unsigned char* ptr
, _Jv_ushort length
);
539 bool _Jv_VerifyClassName (_Jv_Utf8Const
*name
);
540 bool _Jv_VerifyIdentifier (_Jv_Utf8Const
*);
541 bool _Jv_ClassNameSamePackage (_Jv_Utf8Const
*name1
, _Jv_Utf8Const
*name2
);
543 struct _Jv_core_chain
550 struct _Jv_core_chain
*next
;
553 // This is called when new core data is loaded.
554 extern void (*_Jv_RegisterCoreHook
) (_Jv_core_chain
*);
556 _Jv_core_chain
*_Jv_FindCore (_Jv_core_chain
*node
, jstring name
);
557 void _Jv_FreeCoreChain (_Jv_core_chain
*chain
);
563 extern void (*_Jv_JVMPI_Notify_OBJECT_ALLOC
) (JVMPI_Event
*event
);
564 extern void (*_Jv_JVMPI_Notify_THREAD_START
) (JVMPI_Event
*event
);
565 extern void (*_Jv_JVMPI_Notify_THREAD_END
) (JVMPI_Event
*event
);
568 /* FIXME: this should really be defined in some more generic place */
569 #define ROUND(V, A) (((((unsigned) (V))-1) | ((A)-1))+1)
571 extern void _Jv_RegisterBootstrapPackages ();
574 // This is used to find ABI versions we recognize.
575 #define GCJ_VERSION (__GNUC__ * 10000 + __GNUC_MINOR__ * 10)
576 #define GCJ_BINARYCOMPAT_ADDITION 5
579 _Jv_CheckABIVersion (unsigned long value
)
581 // For this release, recognize just our defined C++ ABI and our
582 // defined BC ABI. (In the future we may recognize past BC ABIs as
584 return (value
== GCJ_VERSION
585 || value
== (GCJ_VERSION
+ GCJ_BINARYCOMPAT_ADDITION
));
588 #endif /* __JAVA_JVM_H__ */