OSDN Git Service

2005-03-10 Bryce McKinlay <mckinlay@redhat.com>
[pf3gnuchains/gcc-fork.git] / libjava / include / jvm.h
1 // jvm.h - Header file for private implementation information. -*- c++ -*-
2
3 /* Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005  Free Software Foundation
4
5    This file is part of libgcj.
6
7 This software is copyrighted work licensed under the terms of the
8 Libgcj License.  Please consult the file "LIBGCJ_LICENSE" for
9 details.  */
10
11 #ifndef __JAVA_JVM_H__
12 #define __JAVA_JVM_H__
13
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__
19
20 #include <gcj/javaprims.h>
21
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>
26
27 #include <java/lang/Object.h>
28
29 // Include cni.h before field.h to enable all definitions.  FIXME.
30 #include <gcj/cni.h>
31 #include <gcj/field.h>
32
33 /* Macro for possible unused arguments.  */
34 #define MAYBE_UNUSED __attribute__((__unused__))
35
36 /* Structure of the virtual table.  */
37 struct _Jv_VTable
38 {
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;
46
47   // This must be last, as derived classes "extend" this by
48   // adding new data members.
49   vtable_elt method[1];
50
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()
55   {
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;
61   }
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
67
68   static size_t vtable_elt_size() { return sizeof(vtable_elt); }
69
70   // Given a method index, return byte offset from the vtable pointer.
71   static jint idx_to_offset (int index)
72   {
73     return (2 * sizeof (void *)) + (index * vtable_elt_size ());
74   }
75   static _Jv_VTable *new_vtable (int count);
76 };
77
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
81
82 union _Jv_word
83 {
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;
89
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
96
97   jclass                     clazz;
98   jstring                    string;
99   struct _Jv_Field          *field;
100   struct _Jv_Utf8Const      *utf8;
101   struct _Jv_ResolvedMethod *rmethod;
102 };
103
104 union _Jv_word2
105 {
106   jint ia[2];
107   jlong l;
108   jdouble d;
109 };                              
110
111 union _Jv_value
112 {
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;
121 };
122
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))
137
138 extern int _Jv_strLengthUtf8(char* str, int len);
139
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);
146
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
153 {
154 public:
155   _Jv_TempUTFString(jstring jstr, char* buf=0);
156   ~_Jv_TempUTFString();
157
158 // Accessors
159   operator const char*() const
160   {
161     return buf_;
162   }
163   const char* buf() const
164   {
165     return buf_;
166   }
167   char* buf()
168   {
169     return buf_;
170   }
171
172 private:
173   char* buf_;
174   bool heapAllocated_;
175 };
176
177 inline _Jv_TempUTFString::_Jv_TempUTFString (jstring jstr, char* buf)
178   : buf_(0), heapAllocated_(false)
179 {
180   if (!jstr) return;
181   jsize len = JvGetStringUTFLength (jstr);
182   if (buf)
183     buf_ = buf;
184   else
185     {
186       buf_ = (char*) _Jv_Malloc (len+1);
187       heapAllocated_ = true;
188     }
189
190   JvGetStringUTFRegion (jstr, 0, jstr->length(), buf_);
191   buf_[len] = '\0';
192 }
193
194 inline _Jv_TempUTFString::~_Jv_TempUTFString ()
195 {
196   if (heapAllocated_)
197     _Jv_Free (buf_);
198 }
199
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.
206    
207    Sample Usage:
208    
209    jstring jstr = getAJString();
210    JV_TEMP_UTF_STRING(utfstr, jstr);
211    printf("The string is: %s\n", utfstr.buf());
212    
213  */
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)
219
220 namespace gcj
221 {
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$", */
227   
228   /* Set to true by _Jv_CreateJavaVM. */
229   extern bool runtimeInitialized;
230
231   /* Print out class names as they are initialized. */
232   extern bool verbose_class_flag;
233 }
234
235 // This class handles all aspects of class preparation and linking.
236 class _Jv_Linker
237 {
238 private:
239   static _Jv_Field *find_field_helper(jclass, _Jv_Utf8Const *, _Jv_Utf8Const *,
240                                       jclass *);
241   static _Jv_Field *find_field(jclass, jclass, _Jv_Utf8Const *,
242                                _Jv_Utf8Const *);
243   static void prepare_constant_time_tables(jclass);
244   static jshort get_interfaces(jclass, _Jv_ifaces *);
245   static void link_symbol_table(jclass);
246   static void link_exception_table(jclass);
247   static void layout_interface_methods(jclass);
248   static void layout_vtable_methods(jclass);
249   static void set_vtable_entries(jclass, _Jv_VTable *);
250   static void make_vtable(jclass);
251   static void ensure_fields_laid_out(jclass);
252   static void ensure_class_linked(jclass);
253   static void ensure_supers_installed(jclass);
254   static void add_miranda_methods(jclass, jclass);
255   static void ensure_method_table_complete(jclass);
256   static void verify_class(jclass);
257   static jshort find_iindex(jclass *, jshort *, jshort);
258   static jshort indexof(void *, void **, jshort);
259   static int get_alignment_from_class(jclass);
260   static void generate_itable(jclass, _Jv_ifaces *, jshort *);
261   static jshort append_partial_itable(jclass, jclass, void **, jshort);
262   static _Jv_Method *search_method_in_class (jclass, jclass,
263                                              _Jv_Utf8Const *,
264                                              _Jv_Utf8Const *);
265
266 public:
267
268   static bool has_field_p (jclass, _Jv_Utf8Const *);
269   static void print_class_loaded (jclass);
270   static void resolve_class_ref (jclass, jclass *);
271   static void wait_for_state(jclass, int);
272   static _Jv_word resolve_pool_entry (jclass, int);
273   static void resolve_field (_Jv_Field *, java::lang::ClassLoader *);
274   static void verify_type_assertions (jclass);
275 };
276
277 /* Type of pointer used as finalizer.  */
278 typedef void _Jv_FinalizerFunc (jobject);
279
280 /* Allocate space for a new Java object.  */
281 void *_Jv_AllocObj (jsize size, jclass cl) __attribute__((__malloc__));
282 /* Allocate space for a potentially uninitialized pointer-free object.
283    Interesting only with JV_HASH_SYNCHRONIZATION.  */
284 void *_Jv_AllocPtrFreeObj (jsize size, jclass cl) __attribute__((__malloc__));
285 /* Allocate space for an array of Java objects.  */
286 void *_Jv_AllocArray (jsize size, jclass cl) __attribute__((__malloc__));
287 /* Allocate space that is known to be pointer-free.  */
288 void *_Jv_AllocBytes (jsize size) __attribute__((__malloc__));
289 /* Allocate space for a new non-Java object, which does not have the usual 
290    Java object header but may contain pointers to other GC'ed objects.  */
291 void *_Jv_AllocRawObj (jsize size) __attribute__((__malloc__));
292 /* Explicitly throw an out-of-memory exception. */
293 void _Jv_ThrowNoMemory() __attribute__((__noreturn__));
294 /* Allocate an object with a single pointer.  The first word is reserved
295    for the GC, and the second word is the traced pointer.  */
296 void *_Jv_AllocTraceOne (jsize size /* incl. reserved slot */);
297 /* Ditto, but for two traced pointers.                     */
298 void *_Jv_AllocTraceTwo (jsize size /* incl. reserved slot */);
299 /* Initialize the GC.  */
300 void _Jv_InitGC (void);
301 /* Register a finalizer.  */
302 void _Jv_RegisterFinalizer (void *object, _Jv_FinalizerFunc *method);
303 /* Compute the GC descriptor for a class */
304 void * _Jv_BuildGCDescr(jclass);
305
306 /* Allocate some unscanned, unmoveable memory.  Return NULL if out of
307    memory.  */
308 void *_Jv_MallocUnchecked (jsize size) __attribute__((__malloc__));
309
310 /* Initialize finalizers.  The argument is a function to be called
311    when a finalizer is ready to be run.  */
312 void _Jv_GCInitializeFinalizers (void (*notifier) (void));
313 /* Run finalizers for objects ready to be finalized..  */
314 void _Jv_RunFinalizers (void);
315 /* Run all finalizers.  Should be called only before exit.  */
316 void _Jv_RunAllFinalizers (void);
317 /* Perform a GC.  */
318 void _Jv_RunGC (void);
319 /* Disable and enable GC.  */
320 void _Jv_DisableGC (void);
321 void _Jv_EnableGC (void);
322 /* Register a disappearing link.  This is a field F which should be
323    cleared when *F is found to be inaccessible.  This is used in the
324    implementation of java.lang.ref.Reference.  */
325 void _Jv_GCRegisterDisappearingLink (jobject *objp);
326 /* Return true if OBJECT should be reclaimed.  This is used to
327    implement soft references.  */
328 jboolean _Jv_GCCanReclaimSoftReference (jobject obj);
329
330 /* Register a finalizer for a String object.  This is only used by
331    the intern() implementation.  */
332 void _Jv_RegisterStringFinalizer (jobject str);
333 /* This is called to actually finalize a possibly-intern()d String.  */
334 void _Jv_FinalizeString (jobject str);
335
336 /* Return approximation of total size of heap.  */
337 long _Jv_GCTotalMemory (void);
338 /* Return approximation of total free memory.  */
339 long _Jv_GCFreeMemory (void);
340
341 /* Set initial heap size.  If SIZE==0, ignore.  Should be run before
342    _Jv_InitGC.  Not required to have any actual effect.  */
343 void _Jv_GCSetInitialHeapSize (size_t size);
344
345 /* Set maximum heap size.  If SIZE==0, unbounded.  Should be run
346    before _Jv_InitGC.  Not required to have any actual effect.  */
347 void _Jv_GCSetMaximumHeapSize (size_t size);
348
349 /* External interface to setting the heap size.  Parses ARG (a number
350    which can optionally have "k" or "m" appended and calls
351    _Jv_GCSetInitialHeapSize.  */
352 void _Jv_SetInitialHeapSize (const char *arg);
353
354 /* External interface to setting the maximum heap size.  Parses ARG (a
355    number which can optionally have "k" or "m" appended and calls
356    _Jv_GCSetMaximumHeapSize.  */
357 void _Jv_SetMaximumHeapSize (const char *arg);
358
359 extern "C" void JvRunMain (jclass klass, int argc, const char **argv);
360 void _Jv_RunMain (jclass klass, const char *name, int argc, const char **argv, 
361                   bool is_jar);
362
363 // Delayed until after _Jv_AllocBytes is declared.
364 //
365 // Note that we allocate this as unscanned memory -- the vtables
366 // are handled specially by the GC.
367
368 inline _Jv_VTable *
369 _Jv_VTable::new_vtable (int count)
370 {
371   size_t size = sizeof(_Jv_VTable) + (count - 1) * vtable_elt_size ();
372   return (_Jv_VTable *) _Jv_AllocBytes (size);
373 }
374
375 // Determine if METH gets an entry in a VTable.
376 static inline jboolean _Jv_isVirtualMethod (_Jv_Method *meth)
377 {
378   using namespace java::lang::reflect;
379   return (((meth->accflags & (Modifier::STATIC | Modifier::PRIVATE)) == 0)
380           && meth->name->first() != '<');
381 }
382
383 // This function is used to determine the hash code of an object.
384 inline jint
385 _Jv_HashCode (jobject obj)
386 {
387   // This was chosen to yield relatively well distributed results on
388   // both 32- and 64-bit architectures.  Note 0x7fffffff is prime.
389   // FIXME: we assume sizeof(long) == sizeof(void *).
390   return (jint) ((unsigned long) obj % 0x7fffffff);
391 }
392
393 // Return a raw pointer to the elements of an array given the array
394 // and its element type.  You might think we could just pick a single
395 // array type and use elements() on it, but we can't because we must
396 // account for alignment of the element type.  When ARRAY is null, we
397 // obtain the number of bytes taken by the base part of the array.
398 inline char *
399 _Jv_GetArrayElementFromElementType (jobject array,
400                                     jclass element_type)
401 {
402   char *elts;
403   if (element_type == JvPrimClass (byte))
404     elts = (char *) elements ((jbyteArray) array);
405   else if (element_type == JvPrimClass (short))
406     elts = (char *) elements ((jshortArray) array);
407   else if (element_type == JvPrimClass (int))
408     elts = (char *) elements ((jintArray) array);
409   else if (element_type == JvPrimClass (long))
410     elts = (char *) elements ((jlongArray) array);
411   else if (element_type == JvPrimClass (boolean))
412     elts = (char *) elements ((jbooleanArray) array);
413   else if (element_type == JvPrimClass (char))
414     elts = (char *) elements ((jcharArray) array);
415   else if (element_type == JvPrimClass (float))
416     elts = (char *) elements ((jfloatArray) array);
417   else if (element_type == JvPrimClass (double))
418     elts = (char *) elements ((jdoubleArray) array);
419   else
420     elts = (char *) elements ((jobjectArray) array);
421   return elts;
422 }
423
424 extern "C" void _Jv_ThrowBadArrayIndex (jint bad_index)
425   __attribute__((noreturn));
426 extern "C" void _Jv_ThrowNullPointerException (void)
427   __attribute__((noreturn));
428 extern "C" jobject _Jv_NewArray (jint type, jint size)
429   __attribute__((__malloc__));
430 extern "C" jobject _Jv_NewMultiArray (jclass klass, jint dims, ...)
431   __attribute__((__malloc__));
432 extern "C" void *_Jv_CheckCast (jclass klass, jobject obj);
433 extern "C" void *_Jv_LookupInterfaceMethod (jclass klass, Utf8Const *name,
434                                            Utf8Const *signature);
435 extern "C" void *_Jv_LookupInterfaceMethodIdx (jclass klass, jclass iface, 
436                                                int meth_idx);
437 extern "C" void _Jv_CheckArrayStore (jobject array, jobject obj);
438 extern "C" void _Jv_RegisterClass (jclass klass);
439 extern "C" void _Jv_RegisterClasses (const jclass *classes);
440 extern "C" void _Jv_RegisterClasses_Counted (const jclass *classes,
441                                              size_t count);
442 extern "C" void _Jv_RegisterResource (void *vptr);
443 extern void _Jv_UnregisterClass (_Jv_Utf8Const*, java::lang::ClassLoader*);
444
445 extern jclass _Jv_FindClass (_Jv_Utf8Const *name,
446                              java::lang::ClassLoader *loader);
447 extern jclass _Jv_FindClassFromSignature (char *,
448                                           java::lang::ClassLoader *loader);
449 extern void _Jv_GetTypesFromSignature (jmethodID method,
450                                        jclass declaringClass,
451                                        JArray<jclass> **arg_types_out,
452                                        jclass *return_type_out);
453
454 extern jboolean _Jv_CheckAccess (jclass self_klass, jclass other_klass,
455                                  jint flags);
456
457 extern jobject _Jv_CallAnyMethodA (jobject obj, jclass return_type,
458                                    jmethodID meth, jboolean is_constructor,
459                                    JArray<jclass> *parameter_types,
460                                    jobjectArray args,
461                                    jclass iface = NULL);
462
463 union jvalue;
464 extern void _Jv_CallAnyMethodA (jobject obj,
465                                 jclass return_type,
466                                 jmethodID meth,
467                                 jboolean is_constructor,
468                                 jboolean is_virtual_call,
469                                 JArray<jclass> *parameter_types,
470                                 jvalue *args,
471                                 jvalue *result,
472                                 jboolean is_jni_call = true,
473                                 jclass iface = NULL);
474
475 extern jobject _Jv_NewMultiArray (jclass, jint ndims, jint* dims)
476   __attribute__((__malloc__));
477
478 /* Checked divide subroutines. */
479 extern "C"
480 {
481   jint _Jv_divI (jint, jint);
482   jint _Jv_remI (jint, jint);
483   jlong _Jv_divJ (jlong, jlong);
484   jlong _Jv_remJ (jlong, jlong);
485 }
486
487 /* Get the number of arguments (cf. argc) or 0 if our argument
488    list was never initialized.  */
489 extern int _Jv_GetNbArgs (void);
490
491 /* Get the specified argument (cf. argv[index]) or "" if either
492    our argument list was never initialized or the specified index
493    is out of bounds.  */
494 extern const char * _Jv_GetSafeArg (int index);
495
496 /* Sets our argument list. Can be used by programs with non-standard
497    entry points.  */
498 extern void _Jv_SetArgs (int argc, const char **argv);
499
500 /* Get the name of the running executable.  */
501 extern const char *_Jv_ThisExecutable (void);
502
503 /* Return a pointer to a symbol in executable or loaded library.  */
504 void *_Jv_FindSymbolInExecutable (const char *);
505
506 /* Initialize JNI.  */
507 extern void _Jv_JNI_Init (void);
508
509 /* Get or set the per-thread JNIEnv used by the invocation API.  */
510 _Jv_JNIEnv *_Jv_GetCurrentJNIEnv ();
511 void _Jv_SetCurrentJNIEnv (_Jv_JNIEnv *);
512
513 /* Free a JNIEnv. */
514 void _Jv_FreeJNIEnv (_Jv_JNIEnv *);
515
516 /* Free a JNIEnv. */
517 void _Jv_FreeJNIEnv (_Jv_JNIEnv *);
518
519 struct _Jv_JavaVM;
520 _Jv_JavaVM *_Jv_GetJavaVM (); 
521
522 // Some verification functions from defineclass.cc.
523 bool _Jv_VerifyFieldSignature (_Jv_Utf8Const*sig);
524 bool _Jv_VerifyMethodSignature (_Jv_Utf8Const*sig);
525 bool _Jv_VerifyClassName (unsigned char* ptr, _Jv_ushort length);
526 bool _Jv_VerifyClassName (_Jv_Utf8Const *name);
527 bool _Jv_VerifyIdentifier (_Jv_Utf8Const *);
528 bool _Jv_ClassNameSamePackage (_Jv_Utf8Const *name1, _Jv_Utf8Const *name2);
529
530 struct _Jv_core_chain
531 {
532   int name_length;
533   const char *name;
534   int data_length;
535   const void *data;
536
537   struct _Jv_core_chain *next;
538 };
539
540 // This is called when new core data is loaded.
541 extern void (*_Jv_RegisterCoreHook) (_Jv_core_chain *);
542
543 _Jv_core_chain *_Jv_FindCore (_Jv_core_chain *node, jstring name);
544 void _Jv_FreeCoreChain (_Jv_core_chain *chain);
545
546 #ifdef ENABLE_JVMPI
547
548 #include "jvmpi.h"
549
550 extern void (*_Jv_JVMPI_Notify_OBJECT_ALLOC) (JVMPI_Event *event);
551 extern void (*_Jv_JVMPI_Notify_THREAD_START) (JVMPI_Event *event);
552 extern void (*_Jv_JVMPI_Notify_THREAD_END) (JVMPI_Event *event);
553 #endif
554
555 /* FIXME: this should really be defined in some more generic place */
556 #define ROUND(V, A) (((((unsigned) (V))-1) | ((A)-1))+1)
557
558 extern void _Jv_RegisterBootstrapPackages ();
559
560
561 // This is used to find ABI versions we recognize.
562 #define GCJ_VERSION (__GNUC__ * 10000 + __GNUC_MINOR__ * 10)
563 #define GCJ_BINARYCOMPAT_ADDITION 5
564
565 inline bool
566 _Jv_CheckABIVersion (unsigned long value)
567 {
568   // For this release, recognize just our defined C++ ABI and our
569   // defined BC ABI.  (In the future we may recognize past BC ABIs as
570   // well.)
571   return (value == GCJ_VERSION
572           || value == (GCJ_VERSION + GCJ_BINARYCOMPAT_ADDITION));
573 }
574
575 #endif /* __JAVA_JVM_H__ */