-/* src/native/llni.h - low level native interfarce (LLNI) macros
+/* src/native/llni.h - low level native interfarce (LLNI)
- Copyright (C) 2007 R. Grafl, A. Krall, C. Kruegel,
- C. Oates, R. Obermaisser, M. Platter, M. Probst, S. Ring,
- E. Steiner, C. Thalinger, D. Thuernbeck, P. Tomsich, C. Ullrich,
- J. Wenninger, Institut f. Computersprachen - TU Wien
+ Copyright (C) 2007, 2008
+ CACAOVM - Verein zur Foerderung der freien virtuellen Maschine CACAO
This file is part of CACAO.
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301, USA.
- $Id: llni.h 8321 2007-08-16 11:37:25Z michi $
-
*/
#ifndef _LLNI_H
#define _LLNI_H
+#ifdef __cplusplus
+extern "C" {
+#endif
+
#include "config.h"
+/* forward defines ************************************************************/
-/* LLNI macros *****************************************************************
+/* LLNI wrapping / unwrapping macros *******************************************
- The following macros should be used whenever a Java Object is
- accessed in native code without the use of an JNI function.
+ ATTENTION: Only use these macros inside a LLNI critical section!
+ Once the ciritical section ends, all pointers onto the GC heap
+ retrieved through these macros are void!
- LLNI_field_set_val, LLNI_field_get_val:
- Deal with primitive values like integer and float values. Do
- not use these macros to access pointers or references!
+*******************************************************************************/
- LLNI_field_set_ref, LLNI_field_get_ref:
- Deal with references to other objects.
+#if defined(ENABLE_HANDLES)
+# define LLNI_WRAP(obj) ((obj) == NULL ? NULL : localref_add(obj))
+# define LLNI_UNWRAP(hdl) ((hdl) == NULL ? NULL : (hdl)->heap_object)
+# define LLNI_QUICKWRAP(obj) ((obj) == NULL ? NULL : &(obj))
+# define LLNI_DIRECT(hdl) ((hdl)->heap_object)
+#else
+# define LLNI_WRAP(obj) (obj)
+# define LLNI_UNWRAP(hdl) (hdl)
+# define LLNI_QUICKWRAP(obj) (obj)
+# define LLNI_DIRECT(hdl) (hdl)
+#endif
- LLNI_field_set_cls, LLNI_field_get_cls:
- Deal with references to Java Classes which are internally
- represented by classinfo or java_lang_Class.
-*******************************************************************************/
+#include "native/localref.h"
-#define LLNI_field_set_val(obj, field, value) \
- LLNI_field_direct(obj, field) = (value)
+#include "threads/thread.hpp"
-#define LLNI_field_set_ref(obj, field, reference) \
- LLNI_field_set_val(obj, field, reference)
-#define LLNI_field_set_cls(obj, field, value) \
- LLNI_field_direct(obj, field) = (java_lang_Class *) (value)
+#define LLNI_class_get(obj, variable) \
+ (variable) = LLNI_field_direct((java_handle_t *) obj, vftbl->clazz)
-#define LLNI_field_get_val(obj, field, variable) \
- (variable) = LLNI_field_direct(obj, field)
-#define LLNI_field_get_ref(obj, field, variable) \
- LLNI_field_get_val(obj, field, variable)
+/* LLNI_equals ****************************************************************
+
+ Test if two java_handle_t* point to the same java_object_t*.
-#define LLNI_field_get_cls(obj, field, variable) \
- (variable) = (classinfo *) LLNI_field_direct(obj, field)
+******************************************************************************/
-#define LLNI_class_get(obj, variable) \
- (variable) = LLNI_field_direct(obj, header.vftbl->class)
+#define LLNI_equals(obj1, obj2, result) \
+ LLNI_CRITICAL_START; \
+ (result) = LLNI_UNWRAP(obj1) == LLNI_UNWRAP(obj2); \
+ LLNI_CRITICAL_END
+
-/* XXX the direct macros have to be used inside a critical section!!! */
+/* LLNI_classinfo_field_get ***************************************************
+
+ Get a field from classinfo that is a java object.
+
+******************************************************************************/
+
+#define LLNI_classinfo_field_get(cls, field, variable) \
+ LLNI_CRITICAL_START; \
+ (variable) = LLNI_WRAP((cls)->field); \
+ LLNI_CRITICAL_END
+
+
+/* LLNI_classinfo_field_set ***************************************************
+
+ Set a field from classinfo that is a java object.
-#define LLNI_field_direct(obj, field) ((obj)->field)
+******************************************************************************/
-#define LLNI_vftbl_direct(obj) (((java_handle_t *) (obj))->vftbl)
+#define LLNI_classinfo_field_set(cls, field, variable) \
+ LLNI_CRITICAL_START; \
+ (cls)->field = LLNI_UNWRAP(variable); \
+ LLNI_CRITICAL_END
-#define LLNI_array_direct(arr, index) ((arr)->data[(index)])
-#define LLNI_array_data(arr) ((arr)->data)
+/* LLNI classinfo wrapping / unwrapping macros *********************************
-#define LLNI_array_size(arr) ((java_array_t *) (arr))->size
+ The following macros are used to wrap or unwrap a classinfo from
+ or into a handle (typically java_lang_Class). No critical sections
+ are needed here, because classinfos are not placed on the GC heap.
-/* XXX document me */
+ XXX This might change once we implement Class Unloading!
-#define LLNI_objectarray_element_set(arr, index, reference) \
- LLNI_array_direct(arr, index) = reference
+*******************************************************************************/
+
+#define LLNI_classinfo_wrap(classinfo) \
+ ((java_handle_t*) LLNI_WRAP(classinfo))
+
+#define LLNI_classinfo_unwrap(clazz) \
+ ((classinfo *) LLNI_UNWRAP((java_handle_t *) (clazz)))
+
+
+/* XXX the direct macros have to be used inside a critical section!!! */
-#define LLNI_objectarray_element_get(arr, index, variable) \
- (variable) = (java_handle_t *) LLNI_array_direct(arr, index)
+#define LLNI_field_direct(obj, field) (LLNI_DIRECT(obj)->field)
+#define LLNI_vftbl_direct(obj) (LLNI_DIRECT((java_handle_t *) (obj))->vftbl)
+#define LLNI_array_direct(arr, index) (LLNI_DIRECT(arr)->data[(index)])
+#define LLNI_array_data(arr) (LLNI_DIRECT(arr)->data)
+#define LLNI_array_size(arr) (LLNI_DIRECT((java_handle_objectarray_t *) (arr))->header.size)
+/* LLNI critical sections ******************************************************
+
+ These macros handle the LLNI critical sections. While a critical
+ section is active, the absolute position of objects on the GC heap
+ is not allowed to change (no moving Garbage Collection).
+
+ ATTENTION: Use a critical section whenever you have a direct
+ pointer onto the GC heap!
+
+*******************************************************************************/
+
+#if defined(ENABLE_THREADS) && defined(ENABLE_GC_CACAO)
+# define LLNI_CRITICAL_START llni_critical_start()
+# define LLNI_CRITICAL_END llni_critical_end()
+# define LLNI_CRITICAL_START_THREAD(t) llni_critical_start_thread(t)
+# define LLNI_CRITICAL_END_THREAD(t) llni_critical_end_thread(t)
+#else
+# define LLNI_CRITICAL_START
+# define LLNI_CRITICAL_END
+# define LLNI_CRITICAL_START_THREAD(t)
+# define LLNI_CRITICAL_END_THREAD(t)
+#endif
+
+void llni_critical_start();
+void llni_critical_end();
+void llni_critical_start_thread(threadobject *t);
+void llni_critical_end_thread(threadobject *t);
+
+#ifdef __cplusplus
+}
+#endif
#endif /* _LLNI_H */