1 /* src/native/llni.h - low level native interfarce (LLNI)
3 Copyright (C) 2007 R. Grafl, A. Krall, C. Kruegel,
4 C. Oates, R. Obermaisser, M. Platter, M. Probst, S. Ring,
5 E. Steiner, C. Thalinger, D. Thuernbeck, P. Tomsich, C. Ullrich,
6 J. Wenninger, Institut f. Computersprachen - TU Wien
8 This file is part of CACAO.
10 This program is free software; you can redistribute it and/or
11 modify it under the terms of the GNU General Public License as
12 published by the Free Software Foundation; either version 2, or (at
13 your option) any later version.
15 This program is distributed in the hope that it will be useful, but
16 WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 General Public License for more details.
20 You should have received a copy of the GNU General Public License
21 along with this program; if not, write to the Free Software
22 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
33 #include "native/localref.h"
36 /* LLNI macros *****************************************************************
38 The following macros should be used whenever a Java Object is
39 accessed in native code without the use of an JNI function.
41 LLNI_field_set_val, LLNI_field_get_val:
42 Deal with primitive values like integer and float values. Do
43 not use these macros to access pointers or references!
45 LLNI_field_set_ref, LLNI_field_get_ref:
46 Deal with references to other objects.
48 LLNI_field_set_cls, LLNI_field_get_cls:
49 Deal with references to Java Classes which are internally
50 represented by classinfo or java_lang_Class.
52 *******************************************************************************/
54 #define LLNI_field_set_val(obj, field, value) \
55 LLNI_field_direct(obj, field) = (value)
57 #define LLNI_field_set_ref(obj, field, reference) \
58 LLNI_field_direct(obj, field) = LLNI_DIRECT(reference)
60 #define LLNI_field_set_cls(obj, field, value) \
61 LLNI_field_direct(obj, field) = (java_lang_Class *) (value)
63 #define LLNI_field_get_val(obj, field, variable) \
64 (variable) = LLNI_field_direct(obj, field)
66 #define LLNI_field_get_ref(obj, field, variable) \
67 (variable) = LLNI_WRAP(LLNI_field_direct(obj, field))
69 #define LLNI_field_get_cls(obj, field, variable) \
70 (variable) = (classinfo *) LLNI_field_direct(obj, field)
72 #define LLNI_class_get(obj, variable) \
73 (variable) = LLNI_field_direct((java_handle_t *) obj, vftbl->class)
76 /* LLNI_classinfo_field_get ***************************************************
78 Get a field from classinfo that is a java object.
80 ******************************************************************************/
82 #define LLNI_classinfo_field_get(cls, field, variable) \
83 LLNI_CRITICAL_START; \
84 (variable) = LLNI_WRAP((cls)->field); \
88 /* LLNI_classinfo_field_set ***************************************************
90 Set a field from classinfo that is a java object.
92 ******************************************************************************/
94 #define LLNI_classinfo_field_set(cls, field, variable) \
95 LLNI_CRITICAL_START; \
96 (cls)->field = LLNI_UNWRAP(variable); \
100 /* LLNI classinfo wrapping / unwrapping macros *********************************
102 The following macros are used to wrap or unwrap a classinfo from
103 or into a handle (typically java_lang_Class). No critical sections
104 are needed here, because classinfos are not placed on the GC heap.
106 XXX This might change once we implement Class Unloading!
108 *******************************************************************************/
110 #define LLNI_classinfo_wrap(classinfo) \
111 ((java_lang_Class *) LLNI_WRAP(classinfo))
113 #define LLNI_classinfo_unwrap(clazz) \
114 ((classinfo *) LLNI_UNWRAP((java_handle_t *) (clazz)))
117 /* XXX the direct macros have to be used inside a critical section!!! */
119 #define LLNI_field_direct(obj, field) (LLNI_DIRECT(obj)->field)
120 #define LLNI_vftbl_direct(obj) (LLNI_DIRECT((java_handle_t *) (obj))->vftbl)
121 #define LLNI_array_direct(arr, index) (LLNI_DIRECT(arr)->data[(index)])
122 #define LLNI_array_data(arr) (LLNI_DIRECT(arr)->data)
123 #define LLNI_array_size(arr) (LLNI_DIRECT((java_handle_objectarray_t *) (arr))->header.size)
126 /* XXX document me */
128 #define LLNI_objectarray_element_set(arr, index, reference) \
129 LLNI_array_direct(arr, index) = (java_object_t *) LLNI_DIRECT(reference)
131 #define LLNI_objectarray_element_get(arr, index, variable) \
132 (variable) = LLNI_WRAP(LLNI_array_direct(arr, index))
135 /* LLNI wrapping / unwrapping macros *******************************************
137 ATTENTION: Only use these macros inside a LLNI critical section!
138 Once the ciritical section ends, all pointers onto the GC heap
139 retrieved through these macros are void!
141 *******************************************************************************/
143 #if defined(ENABLE_HANDLES)
144 # define LLNI_WRAP(obj) ((obj) == NULL ? NULL : localref_add(obj))
145 # define LLNI_UNWRAP(hdl) ((hdl) == NULL ? NULL : (hdl)->heap_object)
146 # define LLNI_DIRECT(obj) ((obj)->heap_object)
148 # define LLNI_WRAP(obj) (obj)
149 # define LLNI_UNWRAP(hdl) (hdl)
150 # define LLNI_DIRECT(obj) (obj)
154 /* LLNI critical sections ******************************************************
156 These macros handle the LLNI critical sections. While a critical
157 section is active, the absolute position of objects on the GC heap
158 is not allowed to change (no moving Garbage Collection).
160 ATTENTION: Use a critical section whenever you have a direct
161 pointer onto the GC heap!
163 *******************************************************************************/
165 #if defined(ENABLE_THREADS) && defined(ENABLE_GC_CACAO)
166 void llni_critical_start(void);
167 void llni_critical_end(void);
168 # define LLNI_CRITICAL_START llni_critical_start()
169 # define LLNI_CRITICAL_END llni_critical_end()
171 # define LLNI_CRITICAL_START
172 # define LLNI_CRITICAL_END
180 * These are local overrides for various environment variables in Emacs.
181 * Please do not remove this and leave it at the end of the file, where
182 * Emacs will automagically detect them.
183 * ---------------------------------------------------------------------
186 * indent-tabs-mode: t