1 /* src/native/llni.h - low level native interfarce (LLNI)
3 Copyright (C) 2007, 2008
4 CACAOVM - Verein zur Foerderung der freien virtuellen Maschine CACAO
6 This file is part of CACAO.
8 This program is free software; you can redistribute it and/or
9 modify it under the terms of the GNU General Public License as
10 published by the Free Software Foundation; either version 2, or (at
11 your option) any later version.
13 This program is distributed in the hope that it will be useful, but
14 WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program; if not, write to the Free Software
20 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
35 /* forward defines ************************************************************/
37 /* LLNI wrapping / unwrapping macros *******************************************
39 ATTENTION: Only use these macros inside a LLNI critical section!
40 Once the ciritical section ends, all pointers onto the GC heap
41 retrieved through these macros are void!
43 *******************************************************************************/
45 #if defined(ENABLE_HANDLES)
46 # define LLNI_WRAP(obj) ((obj) == NULL ? NULL : localref_add(obj))
47 # define LLNI_UNWRAP(hdl) ((hdl) == NULL ? NULL : (hdl)->heap_object)
48 # define LLNI_QUICKWRAP(obj) ((obj) == NULL ? NULL : &(obj))
49 # define LLNI_DIRECT(hdl) ((hdl)->heap_object)
51 # define LLNI_WRAP(obj) (obj)
52 # define LLNI_UNWRAP(hdl) (hdl)
53 # define LLNI_QUICKWRAP(obj) (obj)
54 # define LLNI_DIRECT(hdl) (hdl)
58 #include "native/localref.h"
60 #include "threads/thread.h"
63 /* LLNI macros *****************************************************************
65 The following macros should be used whenever a Java Object is
66 accessed in native code without the use of an JNI function.
68 LLNI_field_set_val, LLNI_field_get_val:
69 Deal with primitive values like integer and float values. Do
70 not use these macros to access pointers or references!
72 LLNI_field_set_ref, LLNI_field_get_ref:
73 Deal with references to other objects.
75 LLNI_field_set_cls, LLNI_field_get_cls:
76 Deal with references to Java Classes which are internally
77 represented by classinfo or java_lang_Class.
79 *******************************************************************************/
81 #define LLNI_field_set_val(obj, field, value) \
82 LLNI_field_direct(obj, field) = (value)
84 #define LLNI_field_set_ref(obj, field, reference) \
85 LLNI_field_direct(obj, field) = LLNI_UNWRAP(reference)
87 #define LLNI_field_set_cls(obj, field, value) \
88 LLNI_field_direct(obj, field) = (java_lang_Class *) (value)
90 #define LLNI_field_get_val(obj, field, variable) \
91 (variable) = LLNI_field_direct(obj, field)
93 #define LLNI_field_get_ref(obj, field, variable) \
94 (variable) = LLNI_WRAP(LLNI_field_direct(obj, field))
96 #define LLNI_field_get_cls(obj, field, variable) \
97 (variable) = (classinfo *) LLNI_field_direct(obj, field)
99 #define LLNI_class_get(obj, variable) \
100 (variable) = LLNI_field_direct((java_handle_t *) obj, vftbl->clazz)
103 /* LLNI_equals ****************************************************************
105 Test if two java_handle_t* point to the same java_object_t*.
107 ******************************************************************************/
109 #define LLNI_equals(obj1, obj2, result) \
110 LLNI_CRITICAL_START; \
111 (result) = LLNI_UNWRAP(obj1) == LLNI_UNWRAP(obj2); \
115 /* LLNI_classinfo_field_get ***************************************************
117 Get a field from classinfo that is a java object.
119 ******************************************************************************/
121 #define LLNI_classinfo_field_get(cls, field, variable) \
122 LLNI_CRITICAL_START; \
123 (variable) = LLNI_WRAP((cls)->field); \
127 /* LLNI_classinfo_field_set ***************************************************
129 Set a field from classinfo that is a java object.
131 ******************************************************************************/
133 #define LLNI_classinfo_field_set(cls, field, variable) \
134 LLNI_CRITICAL_START; \
135 (cls)->field = LLNI_UNWRAP(variable); \
139 /* LLNI classinfo wrapping / unwrapping macros *********************************
141 The following macros are used to wrap or unwrap a classinfo from
142 or into a handle (typically java_lang_Class). No critical sections
143 are needed here, because classinfos are not placed on the GC heap.
145 XXX This might change once we implement Class Unloading!
147 *******************************************************************************/
149 #define LLNI_classinfo_wrap(classinfo) \
150 ((java_lang_Class *) LLNI_WRAP(classinfo))
152 #define LLNI_classinfo_unwrap(clazz) \
153 ((classinfo *) LLNI_UNWRAP((java_handle_t *) (clazz)))
156 /* XXX the direct macros have to be used inside a critical section!!! */
158 #define LLNI_field_direct(obj, field) (LLNI_DIRECT(obj)->field)
159 #define LLNI_vftbl_direct(obj) (LLNI_DIRECT((java_handle_t *) (obj))->vftbl)
160 #define LLNI_array_direct(arr, index) (LLNI_DIRECT(arr)->data[(index)])
161 #define LLNI_array_data(arr) (LLNI_DIRECT(arr)->data)
162 #define LLNI_array_size(arr) (LLNI_DIRECT((java_handle_objectarray_t *) (arr))->header.size)
165 /* LLNI critical sections ******************************************************
167 These macros handle the LLNI critical sections. While a critical
168 section is active, the absolute position of objects on the GC heap
169 is not allowed to change (no moving Garbage Collection).
171 ATTENTION: Use a critical section whenever you have a direct
172 pointer onto the GC heap!
174 *******************************************************************************/
176 #if defined(ENABLE_THREADS) && defined(ENABLE_GC_CACAO)
177 # define LLNI_CRITICAL_START llni_critical_start()
178 # define LLNI_CRITICAL_END llni_critical_end()
179 # define LLNI_CRITICAL_START_THREAD(t) llni_critical_start_thread(t)
180 # define LLNI_CRITICAL_END_THREAD(t) llni_critical_end_thread(t)
182 # define LLNI_CRITICAL_START
183 # define LLNI_CRITICAL_END
184 # define LLNI_CRITICAL_START_THREAD(t)
185 # define LLNI_CRITICAL_END_THREAD(t)
188 void llni_critical_start();
189 void llni_critical_end();
190 void llni_critical_start_thread(threadobject *t);
191 void llni_critical_end_thread(threadobject *t);
201 * These are local overrides for various environment variables in Emacs.
202 * Please do not remove this and leave it at the end of the file, where
203 * Emacs will automagically detect them.
204 * ---------------------------------------------------------------------
207 * indent-tabs-mode: t