1 // prims.cc - Code for core of runtime environment.
3 /* Copyright (C) 1998, 1999, 2000, 2001 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
13 #ifdef USE_WIN32_SIGNALLING
15 #endif /* USE_WIN32_SIGNALLING */
18 #undef __INSIDE_CYGWIN__
20 #endif /* USE_WINSOCK */
34 #include <java-signal.h>
35 #include <java-threads.h>
41 #ifndef DISABLE_GETENV_PROPERTIES
43 #include <java-props.h>
44 #define PROCESS_GCJ_PROPERTIES process_gcj_properties()
46 #define PROCESS_GCJ_PROPERTIES
47 #endif // DISABLE_GETENV_PROPERTIES
49 #include <java/lang/Class.h>
50 #include <java/lang/ClassLoader.h>
51 #include <java/lang/Runtime.h>
52 #include <java/lang/String.h>
53 #include <java/lang/Thread.h>
54 #include <java/lang/ThreadGroup.h>
55 #include <gnu/gcj/runtime/FirstThread.h>
56 #include <java/lang/ArrayIndexOutOfBoundsException.h>
57 #include <java/lang/ArithmeticException.h>
58 #include <java/lang/ClassFormatError.h>
59 #include <java/lang/NegativeArraySizeException.h>
60 #include <java/lang/NullPointerException.h>
61 #include <java/lang/OutOfMemoryError.h>
62 #include <java/lang/System.h>
63 #include <java/lang/reflect/Modifier.h>
64 #include <java/io/PrintStream.h>
70 // We allocate a single OutOfMemoryError exception which we keep
71 // around for use if we run out of memory.
72 static java::lang::OutOfMemoryError *no_memory;
74 // Largest representable size_t.
75 #define SIZE_T_MAX ((size_t) (~ (size_t) 0))
77 // Properties set at compile time.
78 const char **_Jv_Compiler_Properties;
80 // The JAR file to add to the beginning of java.class.path.
81 const char *_Jv_Jar_Class_Path;
83 #ifndef DISABLE_GETENV_PROPERTIES
84 // Property key/value pairs.
85 property_pair *_Jv_Environment_Properties;
88 // The name of this executable.
89 static char * _Jv_execName;
91 // Stash the argv pointer to benefit native libraries that need it.
92 const char **_Jv_argv;
96 // Pointer to JVMPI notification functions.
97 void (*_Jv_JVMPI_Notify_OBJECT_ALLOC) (JVMPI_Event *event);
98 void (*_Jv_JVMPI_Notify_THREAD_START) (JVMPI_Event *event);
99 void (*_Jv_JVMPI_Notify_THREAD_END) (JVMPI_Event *event);
103 extern "C" void _Jv_ThrowSignal (void *) __attribute ((noreturn));
105 // Just like _Jv_Throw, but fill in the stack trace first. Although
106 // this is declared extern in order that its name not be mangled, it
107 // is not intended to be used outside this file.
109 _Jv_ThrowSignal (void *e)
111 java::lang::Throwable *throwable = (java::lang::Throwable *)e;
112 throwable->fillInStackTrace ();
113 _Jv_Throw (throwable);
117 static java::lang::NullPointerException *nullp;
119 SIGNAL_HANDLER (catch_segv)
121 MAKE_THROW_FRAME (nullp);
122 _Jv_ThrowSignal (nullp);
126 static java::lang::ArithmeticException *arithexception;
129 SIGNAL_HANDLER (catch_fpe)
131 #ifdef HANDLE_DIVIDE_OVERFLOW
132 HANDLE_DIVIDE_OVERFLOW;
134 MAKE_THROW_FRAME (arithexception);
136 _Jv_ThrowSignal (arithexception);
143 _Jv_equalUtf8Consts (Utf8Const* a, Utf8Const *b)
146 _Jv_ushort *aptr, *bptr;
149 if (a->hash != b->hash)
152 if (b->length != len)
154 aptr = (_Jv_ushort *)a->data;
155 bptr = (_Jv_ushort *)b->data;
156 len = (len + 1) >> 1;
158 if (*aptr++ != *bptr++)
163 /* True iff A is equal to STR.
164 HASH is STR->hashCode().
168 _Jv_equal (Utf8Const* a, jstring str, jint hash)
170 if (a->hash != (_Jv_ushort) hash)
172 jint len = str->length();
174 jchar *sptr = _Jv_GetStringChars (str);
175 unsigned char* ptr = (unsigned char*) a->data;
176 unsigned char* limit = ptr + a->length;
179 int ch = UTF8_GET (ptr, limit);
188 /* Like _Jv_equal, but stop after N characters. */
190 _Jv_equaln (Utf8Const *a, jstring str, jint n)
192 jint len = str->length();
194 jchar *sptr = _Jv_GetStringChars (str);
195 unsigned char* ptr = (unsigned char*) a->data;
196 unsigned char* limit = ptr + a->length;
197 for (; n-- > 0; i++, sptr++)
199 int ch = UTF8_GET (ptr, limit);
208 /* Count the number of Unicode chars encoded in a given Ut8 string. */
210 _Jv_strLengthUtf8(char* str, int len)
213 unsigned char* limit;
216 ptr = (unsigned char*) str;
219 for (; ptr < limit; str_length++) {
220 if (UTF8_GET (ptr, limit) < 0) {
227 /* Calculate a hash value for a string encoded in Utf8 format.
228 * This returns the same hash value as specified or java.lang.String.hashCode.
231 hashUtf8String (char* str, int len)
233 unsigned char* ptr = (unsigned char*) str;
234 unsigned char* limit = ptr + len;
239 int ch = UTF8_GET (ptr, limit);
240 /* Updated specification from
241 http://www.javasoft.com/docs/books/jls/clarify.html. */
242 hash = (31 * hash) + ch;
248 _Jv_makeUtf8Const (char* s, int len)
252 Utf8Const* m = (Utf8Const*) _Jv_AllocBytes (sizeof(Utf8Const) + len + 1);
255 memcpy (m->data, s, len);
258 m->hash = hashUtf8String (s, len) & 0xFFFF;
263 _Jv_makeUtf8Const (jstring string)
265 jint hash = string->hashCode ();
266 jint len = _Jv_GetStringUTFLength (string);
268 Utf8Const* m = (Utf8Const*)
269 _Jv_AllocBytesChecked (sizeof(Utf8Const) + len + 1);
274 _Jv_GetStringUTFRegion (string, 0, string->length (), m->data);
284 _Jv_Abort (const char *function, const char *file, int line,
288 _Jv_Abort (const char *, const char *, int, const char *message)
293 "libgcj failure: %s\n in function %s, file %s, line %d\n",
294 message, function, file, line);
296 java::io::PrintStream *err = java::lang::System::err;
297 err->print(JvNewStringLatin1 ("libgcj failure: "));
298 err->println(JvNewStringLatin1 (message));
305 fail_on_finalization (jobject)
307 JvFail ("object was finalized");
311 _Jv_GCWatch (jobject obj)
313 _Jv_RegisterFinalizer (obj, fail_on_finalization);
317 _Jv_ThrowBadArrayIndex(jint bad_index)
319 JvThrow (new java::lang::ArrayIndexOutOfBoundsException
320 (java::lang::String::valueOf(bad_index)));
324 _Jv_ThrowNullPointerException ()
326 throw new java::lang::NullPointerException ();
329 // Allocate some unscanned memory and throw an exception if no memory.
331 _Jv_AllocBytesChecked (jsize size)
333 void *r = _Jv_AllocBytes (size);
335 _Jv_Throw (no_memory);
339 // Allocate a new object of class KLASS. SIZE is the size of the object
340 // to allocate. You might think this is redundant, but it isn't; some
341 // classes, such as String, aren't of fixed size.
343 _Jv_AllocObject (jclass klass, jint size)
345 _Jv_InitClass (klass);
347 jobject obj = (jobject) _Jv_AllocObj (size, klass);
348 if (__builtin_expect (! obj, false))
351 // If this class has inherited finalize from Object, then don't
352 // bother registering a finalizer. We know that finalize() is the
353 // very first method after the dummy entry. If this turns out to be
354 // unreliable, a more robust implementation can be written. Such an
355 // implementation would look for Object.finalize in Object's method
356 // table at startup, and then use that information to find the
357 // appropriate index in the method vector.
358 if (klass->vtable->get_finalizer()
359 != java::lang::Object::class$.vtable->get_finalizer())
360 _Jv_RegisterFinalizer (obj, _Jv_FinalizeObject);
363 // Service JVMPI request.
365 if (__builtin_expect (_Jv_JVMPI_Notify_OBJECT_ALLOC != 0, false))
369 event.event_type = JVMPI_EVENT_OBJECT_ALLOC;
371 event.u.obj_alloc.arena_id = 0;
372 event.u.obj_alloc.class_id = (jobjectID) klass;
373 event.u.obj_alloc.is_array = 0;
374 event.u.obj_alloc.size = size;
375 event.u.obj_alloc.obj_id = (jobjectID) obj;
378 (*_Jv_JVMPI_Notify_OBJECT_ALLOC) (&event);
386 // Allocate a new array of Java objects. Each object is of type
387 // `elementClass'. `init' is used to initialize each slot in the
390 _Jv_NewObjectArray (jsize count, jclass elementClass, jobject init)
392 if (__builtin_expect (count < 0, false))
393 JvThrow (new java::lang::NegativeArraySizeException);
395 JvAssert (! elementClass->isPrimitive ());
397 // Ensure that elements pointer is properly aligned.
398 jobjectArray obj = NULL;
399 size_t size = (size_t) elements (obj);
400 size += count * sizeof (jobject);
402 // FIXME: second argument should be "current loader"
403 jclass klass = _Jv_GetArrayClass (elementClass, 0);
405 obj = (jobjectArray) _Jv_AllocArray (size, klass);
406 if (__builtin_expect (! obj, false))
409 jsize *lp = const_cast<jsize *> (&obj->length);
411 // We know the allocator returns zeroed memory. So don't bother
415 jobject *ptr = elements(obj);
422 // Allocate a new array of primitives. ELTYPE is the type of the
423 // element, COUNT is the size of the array.
425 _Jv_NewPrimArray (jclass eltype, jint count)
427 int elsize = eltype->size();
428 if (__builtin_expect (count < 0, false))
429 JvThrow (new java::lang::NegativeArraySizeException ());
431 JvAssert (eltype->isPrimitive ());
432 jobject dummy = NULL;
433 size_t size = (size_t) _Jv_GetArrayElementFromElementType (dummy, eltype);
435 // Check for overflow.
436 if (__builtin_expect ((size_t) count >
437 (SIZE_T_MAX - size) / elsize, false))
440 jclass klass = _Jv_GetArrayClass (eltype, 0);
442 __JArray *arr = (__JArray*) _Jv_AllocObj (size + elsize * count, klass);
443 if (__builtin_expect (! arr, false))
446 jsize *lp = const_cast<jsize *> (&arr->length);
448 // Note that we assume we are given zeroed memory by the allocator.
454 _Jv_NewArray (jint type, jint size)
458 case 4: return JvNewBooleanArray (size);
459 case 5: return JvNewCharArray (size);
460 case 6: return JvNewFloatArray (size);
461 case 7: return JvNewDoubleArray (size);
462 case 8: return JvNewByteArray (size);
463 case 9: return JvNewShortArray (size);
464 case 10: return JvNewIntArray (size);
465 case 11: return JvNewLongArray (size);
467 JvFail ("newarray - bad type code");
468 return NULL; // Placate compiler.
472 _Jv_NewMultiArray (jclass type, jint dimensions, jint *sizes)
474 JvAssert (type->isArray());
475 jclass element_type = type->getComponentType();
477 if (element_type->isPrimitive())
478 result = _Jv_NewPrimArray (element_type, sizes[0]);
480 result = _Jv_NewObjectArray (sizes[0], element_type, NULL);
484 JvAssert (! element_type->isPrimitive());
485 JvAssert (element_type->isArray());
486 jobject *contents = elements ((jobjectArray) result);
487 for (int i = 0; i < sizes[0]; ++i)
488 contents[i] = _Jv_NewMultiArray (element_type, dimensions - 1,
496 _Jv_NewMultiArray (jclass array_type, jint dimensions, ...)
499 jint sizes[dimensions];
500 va_start (args, dimensions);
501 for (int i = 0; i < dimensions; ++i)
503 jint size = va_arg (args, jint);
508 return _Jv_NewMultiArray (array_type, dimensions, sizes);
513 #define DECLARE_PRIM_TYPE(NAME, SIG, LEN) \
514 _Jv_ArrayVTable _Jv_##NAME##VTable; \
515 java::lang::Class _Jv_##NAME##Class ((jobject) #NAME, \
516 (jbyte) SIG, (jint) LEN, \
517 (jobject) &_Jv_##NAME##VTable);
519 DECLARE_PRIM_TYPE(byte, 'B', 1);
520 DECLARE_PRIM_TYPE(short, 'S', 2);
521 DECLARE_PRIM_TYPE(int, 'I', 4);
522 DECLARE_PRIM_TYPE(long, 'J', 8);
523 DECLARE_PRIM_TYPE(boolean, 'Z', 1);
524 DECLARE_PRIM_TYPE(char, 'C', 2);
525 DECLARE_PRIM_TYPE(float, 'F', 4);
526 DECLARE_PRIM_TYPE(double, 'D', 8);
527 DECLARE_PRIM_TYPE(void, 'V', 0);
530 _Jv_FindClassFromSignature (char *sig, java::lang::ClassLoader *loader)
535 return JvPrimClass (byte);
537 return JvPrimClass (short);
539 return JvPrimClass (int);
541 return JvPrimClass (long);
543 return JvPrimClass (boolean);
545 return JvPrimClass (char);
547 return JvPrimClass (float);
549 return JvPrimClass (double);
551 return JvPrimClass (void);
555 for (i = 1; sig[i] && sig[i] != ';'; ++i)
557 _Jv_Utf8Const *name = _Jv_makeUtf8Const (&sig[1], i - 1);
558 return _Jv_FindClass (name, loader);
562 return _Jv_GetArrayClass (_Jv_FindClassFromSignature (&sig[1], loader),
565 JvFail ("couldn't understand class signature");
566 return NULL; // Placate compiler.
572 JvConvertArgv (int argc, const char **argv)
576 jobjectArray ar = JvNewObjectArray(argc, &StringClass, NULL);
577 jobject* ptr = elements(ar);
578 for (int i = 0; i < argc; i++)
580 const char *arg = argv[i];
581 // FIXME - should probably use JvNewStringUTF.
582 *ptr++ = JvNewStringLatin1(arg, strlen(arg));
584 return (JArray<jstring>*) ar;
587 // FIXME: These variables are static so that they will be
588 // automatically scanned by the Boehm collector. This is needed
589 // because with qthreads the collector won't scan the initial stack --
590 // it will only scan the qthreads stacks.
592 // Command line arguments.
593 static jobject arg_vec;
595 // The primary thread.
596 static java::lang::Thread *main_thread;
599 _Jv_ThisExecutable (void)
605 _Jv_ThisExecutable (const char *name)
609 _Jv_execName = new char[strlen (name) + 1];
610 strcpy (_Jv_execName, name);
614 #ifdef USE_WIN32_SIGNALLING
616 extern "C" int* win32_get_restart_frame (void *);
619 win32_exception_handler (LPEXCEPTION_POINTERS e)
622 if (e->ExceptionRecord->ExceptionCode == EXCEPTION_ACCESS_VIOLATION)
623 setjmp_buf = win32_get_restart_frame (nullp);
624 else if (e->ExceptionRecord->ExceptionCode == EXCEPTION_INT_DIVIDE_BY_ZERO)
625 setjmp_buf = win32_get_restart_frame (arithexception);
627 return EXCEPTION_CONTINUE_SEARCH;
629 e->ContextRecord->Ebp = setjmp_buf[0];
630 // FIXME: Why does i386-signal.h increment the PC here, do we need to do it?
631 e->ContextRecord->Eip = setjmp_buf[1];
632 // FIXME: Is this the stack pointer? Do we need it?
633 e->ContextRecord->Esp = setjmp_buf[2];
635 return EXCEPTION_CONTINUE_EXECUTION;
643 // Turn stack trace generation off while creating exception objects.
644 _Jv_InitClass (&java::lang::Throwable::class$);
645 java::lang::Throwable::trace_enabled = 0;
651 arithexception = new java::lang::ArithmeticException
652 (JvNewStringLatin1 ("/ by zero"));
655 no_memory = new java::lang::OutOfMemoryError;
657 java::lang::Throwable::trace_enabled = 1;
660 LTDL_SET_PRELOADED_SYMBOLS ();
664 // Initialise winsock for networking
666 if (WSAStartup (MAKEWORD (1, 1), &data))
667 MessageBox (NULL, "Error initialising winsock library.", "Error", MB_OK | MB_ICONEXCLAMATION);
668 #endif /* USE_WINSOCK */
670 #ifdef USE_WIN32_SIGNALLING
671 // Install exception handler
672 SetUnhandledExceptionFilter (win32_exception_handler);
674 // We only want this on POSIX systems.
675 struct sigaction act;
676 act.sa_handler = SIG_IGN;
677 sigemptyset (&act.sa_mask);
679 sigaction (SIGPIPE, &act, NULL);
680 #endif /* USE_WIN32_SIGNALLING */
685 #ifndef DISABLE_GETENV_PROPERTIES
688 next_property_key (char *s, size_t *length)
694 // Skip over whitespace
698 // If we've reached the end, return NULL. Also return NULL if for
699 // some reason we've come across a malformed property string.
705 // Determine the length of the property key.
723 next_property_value (char *s, size_t *length)
739 // If we've reached the end, return NULL.
743 // Determine the length of the property value.
762 process_gcj_properties ()
764 char *props = getenv("GCJ_PROPERTIES");
767 size_t property_count = 0;
772 // Whip through props quickly in order to count the number of
774 while (p && (p = next_property_key (p, &length)))
776 // Skip to the end of the key
779 p = next_property_value (p, &length);
786 // Allocate an array of property value/key pairs.
787 _Jv_Environment_Properties =
788 (property_pair *) malloc (sizeof(property_pair)
789 * (property_count + 1));
791 // Go through the properties again, initializing _Jv_Properties
795 while (p && (p = next_property_key (p, &length)))
797 _Jv_Environment_Properties[property_count].key = p;
798 _Jv_Environment_Properties[property_count].key_length = length;
800 // Skip to the end of the key
803 p = next_property_value (p, &length);
805 _Jv_Environment_Properties[property_count].value = p;
806 _Jv_Environment_Properties[property_count].value_length = length;
813 memset ((void *) &_Jv_Environment_Properties[property_count],
814 0, sizeof (property_pair));
818 // Null terminate the strings.
819 while (_Jv_Environment_Properties[i].key)
821 _Jv_Environment_Properties[i].key[_Jv_Environment_Properties[i].key_length] = 0;
822 _Jv_Environment_Properties[i++].value[_Jv_Environment_Properties[i].value_length] = 0;
826 #endif // DISABLE_GETENV_PROPERTIES
829 JvRunMain (jclass klass, int argc, const char **argv)
831 PROCESS_GCJ_PROPERTIES;
837 #ifdef HAVE_PROC_SELF_EXE
839 sprintf (exec_name, "/proc/%d/exe", getpid ());
840 _Jv_ThisExecutable (exec_name);
842 _Jv_ThisExecutable (argv[0]);
845 arg_vec = JvConvertArgv (argc - 1, argv + 1);
846 main_thread = new gnu::gcj::runtime::FirstThread (klass, arg_vec);
848 main_thread->start();
851 int status = (int) java::lang::ThreadGroup::had_uncaught_exception;
853 java::lang::Runtime::getRuntime ()->_exit (status);
857 _Jv_RunMain (const char *name, int argc, const char **argv, bool is_jar)
860 PROCESS_GCJ_PROPERTIES;
864 #ifdef HAVE_PROC_SELF_EXE
866 sprintf (exec_name, "/proc/%d/exe", getpid ());
867 _Jv_ThisExecutable (exec_name);
872 // name specifies a jar file. We must now extract the
873 // Main-Class attribute from the jar's manifest file. This is
874 // done by gnu.gcj.runtime.FirstThread.main.
875 _Jv_Jar_Class_Path = strdup (name);
876 arg_vec = JvConvertArgv (1, &_Jv_Jar_Class_Path);
879 new gnu::gcj::runtime::FirstThread (&gnu::gcj::runtime::FirstThread::class$,
881 main_thread->start();
884 // FirstThread.main extracts the main class name and stores it
886 class_name = gnu::gcj::runtime::FirstThread::jarMainClassName;
888 // We need a new ClassLoader because the classpath must be the
889 // jar file only. The easiest way to do this is to lose our
890 // reference to the previous classloader.
891 java::lang::ClassLoader::system = NULL;
894 class_name = JvNewStringLatin1 (name);
896 arg_vec = JvConvertArgv (argc - 1, argv + 1);
900 main_thread = new gnu::gcj::runtime::FirstThread (class_name, arg_vec);
901 main_thread->start();
905 int status = (int) java::lang::ThreadGroup::had_uncaught_exception;
907 java::lang::Runtime::getRuntime ()->exit (status);
912 // Parse a string and return a heap size.
914 parse_heap_size (const char *spec)
917 unsigned long val = strtoul (spec, &end, 10);
918 if (*end == 'k' || *end == 'K')
920 else if (*end == 'm' || *end == 'M')
925 // Set the initial heap size. This might be ignored by the GC layer.
926 // This must be called before _Jv_RunMain.
928 _Jv_SetInitialHeapSize (const char *arg)
930 size_t size = parse_heap_size (arg);
931 _Jv_GCSetInitialHeapSize (size);
934 // Set the maximum heap size. This might be ignored by the GC layer.
935 // This must be called before _Jv_RunMain.
937 _Jv_SetMaximumHeapSize (const char *arg)
939 size_t size = parse_heap_size (arg);
940 _Jv_GCSetMaximumHeapSize (size);
946 _Jv_Malloc (jsize size)
948 if (__builtin_expect (size == 0, false))
950 void *ptr = malloc ((size_t) size);
951 if (__builtin_expect (ptr == NULL, false))
957 _Jv_Realloc (void *ptr, jsize size)
959 if (__builtin_expect (size == 0, false))
961 ptr = realloc (ptr, (size_t) size);
962 if (__builtin_expect (ptr == NULL, false))
968 _Jv_MallocUnchecked (jsize size)
970 if (__builtin_expect (size == 0, false))
972 return malloc ((size_t) size);
983 // In theory, these routines can be #ifdef'd away on machines which
984 // support divide overflow signals. However, we never know if some
985 // code might have been compiled with "-fuse-divide-subroutine", so we
986 // always include them in libgcj.
989 _Jv_divI (jint dividend, jint divisor)
991 if (__builtin_expect (divisor == 0, false))
992 _Jv_ThrowSignal (arithexception);
994 if (dividend == (jint) 0x80000000L && divisor == -1)
997 return dividend / divisor;
1001 _Jv_remI (jint dividend, jint divisor)
1003 if (__builtin_expect (divisor == 0, false))
1004 _Jv_ThrowSignal (arithexception);
1006 if (dividend == (jint) 0x80000000L && divisor == -1)
1009 return dividend % divisor;
1013 _Jv_divJ (jlong dividend, jlong divisor)
1015 if (__builtin_expect (divisor == 0, false))
1016 _Jv_ThrowSignal (arithexception);
1018 if (dividend == (jlong) 0x8000000000000000LL && divisor == -1)
1021 return dividend / divisor;
1025 _Jv_remJ (jlong dividend, jlong divisor)
1027 if (__builtin_expect (divisor == 0, false))
1028 _Jv_ThrowSignal (arithexception);
1030 if (dividend == (jlong) 0x8000000000000000LL && divisor == -1)
1033 return dividend % divisor;