1 // java-interp.h - Header file for the bytecode interpreter. -*- c++ -*-
3 /* Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007 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
11 #ifndef __JAVA_INTERP_H__
12 #define __JAVA_INTERP_H__
15 #include <java-cpool.h>
16 #include <gnu/gcj/runtime/NameFinder.h>
29 #include <java/lang/Class.h>
30 #include <java/lang/ClassLoader.h>
31 #include <java/lang/reflect/Modifier.h>
32 #include <java/lang/Thread.h>
33 #include <gnu/gcj/RawData.h>
35 // Define this to get the direct-threaded interpreter. If undefined,
36 // we revert to a basic bytecode interpreter. The former is faster
37 // but uses more memory.
38 #define DIRECT_THREADED
42 struct _Jv_ResolvedMethod
;
44 void _Jv_InitInterpreter ();
45 void _Jv_DefineClass (jclass
, jbyteArray
, jint
, jint
,
46 java::security::ProtectionDomain
*,
49 void _Jv_InitField (jobject
, jclass
, int);
50 void * _Jv_AllocMethodInvocation (jsize size
);
51 int _Jv_count_arguments (_Jv_Utf8Const
*signature
,
52 jboolean staticp
= true);
53 void _Jv_VerifyMethod (_Jv_InterpMethod
*method
);
54 void _Jv_CompileMethod (_Jv_InterpMethod
* method
);
55 int _Jv_init_cif (_Jv_Utf8Const
* signature
,
62 /* the interpreter is written in C++, primarily because it makes it easy for
63 * the entire thing to be "friend" with class Class. */
65 class _Jv_InterpClass
;
66 class _Jv_InterpMethod
;
68 // Before a method is "compiled" we store values as the bytecode PC,
69 // an int. Afterwards we store them as pointers into the prepared
77 class _Jv_InterpException
79 _Jv_InterpPC start_pc
;
81 _Jv_InterpPC handler_pc
;
82 _Jv_InterpPC handler_type
;
84 friend class _Jv_ClassReader
;
85 friend class _Jv_InterpMethod
;
86 friend class _Jv_BytecodeVerifier
;
89 // Base class for method representations. Subclasses are interpreted
94 // The class which defined this method.
95 jclass defining_class
;
97 // The method description.
100 // Size of raw arguments.
101 _Jv_ushort args_raw_size
;
103 friend class _Jv_InterpreterEngine
;
106 _Jv_Method
*get_method ()
112 // The type of the PC depends on whether we're doing direct threading
113 // or a more ordinary bytecode interpreter.
114 #ifdef DIRECT_THREADED
115 // Slot in the "compiled" form of the bytecode.
120 // An integer value used by an instruction.
122 // A pointer value used by an instruction.
126 typedef insn_slot
*pc_t
;
128 typedef unsigned char *pc_t
;
132 // This structure holds the bytecode pc and corresponding source code
133 // line number. An array (plus length field) of this structure is put
134 // in each _Jv_InterpMethod and used to resolve the (internal) program
135 // counter of the interpreted method to an actual java source file
137 struct _Jv_LineTableEntry
147 // This structure holds local variable information.
148 // Like _Jv_LineTableEntry above, it is remapped when the method is
149 // compiled for direct threading.
150 struct _Jv_LocalVarTableEntry
152 // First PC value at which variable is live
159 // length of visibility of variable
168 // stack slot number (long and double occupy slot and slot + 1)
172 class _Jv_InterpMethod
: public _Jv_MethodBase
174 // Breakpoint instruction
175 static pc_t breakpoint_insn
;
176 #ifdef DIRECT_THREADED
177 static insn_slot bp_insn_slot
;
179 static unsigned char bp_insn_opcode
;
182 _Jv_ushort max_stack
;
183 _Jv_ushort max_locals
;
186 _Jv_ushort exc_count
;
189 // Length of the line_table - when this is zero then line_table is NULL.
191 _Jv_LineTableEntry
*line_table
;
193 // The local variable table length and the table itself
194 int local_var_table_len
;
195 _Jv_LocalVarTableEntry
*local_var_table
;
198 int number_insn_slots
;
200 unsigned char* bytecode ()
203 ((unsigned char*)this)
204 + ROUND((sizeof (_Jv_InterpMethod
)
205 + exc_count
*sizeof (_Jv_InterpException
)), 4);
208 _Jv_InterpException
* exceptions ()
210 return (_Jv_InterpException
*) (this+1);
213 static size_t size (int exc_count
, int code_length
)
216 ROUND ((sizeof (_Jv_InterpMethod
)
217 + (exc_count
* sizeof (_Jv_InterpException
))), 4)
221 // return the method's invocation pointer (a stub).
222 void *ncode (jclass
);
223 void compile (const void * const *);
225 #if FFI_NATIVE_RAW_API
226 # define INTERP_FFI_RAW_TYPE ffi_raw
228 # define INTERP_FFI_RAW_TYPE ffi_java_raw
231 static void run_normal (ffi_cif
*, void*, INTERP_FFI_RAW_TYPE
*, void*);
232 static void run_synch_object (ffi_cif
*, void*, INTERP_FFI_RAW_TYPE
*, void*);
233 static void run_class (ffi_cif
*, void*, INTERP_FFI_RAW_TYPE
*, void*);
234 static void run_synch_class (ffi_cif
*, void*, INTERP_FFI_RAW_TYPE
*, void*);
236 static void run_normal_debug (ffi_cif
*, void*, INTERP_FFI_RAW_TYPE
*, void*);
237 static void run_synch_object_debug (ffi_cif
*, void*, INTERP_FFI_RAW_TYPE
*,
239 static void run_class_debug (ffi_cif
*, void*, INTERP_FFI_RAW_TYPE
*, void*);
240 static void run_synch_class_debug (ffi_cif
*, void*, INTERP_FFI_RAW_TYPE
*,
243 static void run (void *, INTERP_FFI_RAW_TYPE
*, _Jv_InterpMethod
*);
244 static void run_debug (void *, INTERP_FFI_RAW_TYPE
*, _Jv_InterpMethod
*);
248 // Returns source file line number for given PC value, or -1 if line
249 // number info is unavailable.
250 int get_source_line(pc_t mpc
);
254 // Convenience function for indexing bytecode PC/insn slots in
255 // line tables for JDWP
256 jlong
insn_index (pc_t pc
);
258 // Helper function used to check if there is a handler for an exception
259 // present at this code index
260 jboolean
check_handler (pc_t
*pc
, _Jv_InterpMethod
*meth
,
261 java::lang::Throwable
*ex
);
263 /* Get the line table for this method.
264 * start is the lowest index in the method
265 * end is the highest index in the method
266 * line_numbers is an array to hold the list of source line numbers
267 * code_indices is an array to hold the corresponding list of code indices
269 void get_line_table (jlong
& start
, jlong
& end
, jintArray
& line_numbers
,
270 jlongArray
& code_indices
);
272 int get_max_locals ()
274 return static_cast<int> (max_locals
);
277 /* Get info for a local variable of this method.
278 * If there is no loca_var_table for this method it will return -1.
279 * table_slot indicates which slot in the local_var_table to get, if there is
280 * no variable at this location it will return 0.
281 * Otherwise, it will return the number of table slots after the selected
282 * slot, indexed from 0.
284 * Example: there are 5 slots in the table, you request slot 0 so it will
287 int get_local_var_table (char **name
, char **sig
, char **generic_sig
,
288 jlong
*startloc
, jint
*length
, jint
*slot
,
291 /* Installs a break instruction at the given code index. Returns
292 the pc_t of the breakpoint or NULL if index is invalid. */
293 pc_t
install_break (jlong index
);
295 // Gets the instruction at the given index
296 pc_t
get_insn (jlong index
);
298 /* Writes the given instruction at the given code index. Returns
299 the insn or NULL if index is invalid. */
300 pc_t
set_insn (jlong index
, pc_t insn
);
302 // Is the given location in this method a breakpoint?
303 bool breakpoint_at (jlong index
);
305 #ifdef DIRECT_THREADED
306 friend void _Jv_CompileMethod (_Jv_InterpMethod
*);
309 friend class _Jv_ClassReader
;
310 friend class _Jv_BytecodeVerifier
;
311 friend class _Jv_StackTrace
;
312 friend class _Jv_InterpreterEngine
;
314 #ifdef JV_MARKOBJ_DECL
315 friend JV_MARKOBJ_DECL
;
319 class _Jv_InterpClass
321 _Jv_MethodBase
**interpreted_methods
;
322 _Jv_ushort
*field_initializers
;
323 jstring source_file_name
;
324 _Jv_ClosureList
**closures
;
326 friend class _Jv_ClassReader
;
327 friend class _Jv_InterpMethod
;
328 friend class _Jv_StackTrace
;
329 friend class _Jv_InterpreterEngine
;
331 friend void _Jv_InitField (jobject
, jclass
, int);
332 #ifdef JV_MARKOBJ_DECL
333 friend JV_MARKOBJ_DECL
;
336 friend _Jv_MethodBase
** _Jv_GetFirstMethod (_Jv_InterpClass
*klass
);
337 friend jstring
_Jv_GetInterpClassSourceFile (jclass
);
340 extern inline _Jv_MethodBase
**
341 _Jv_GetFirstMethod (_Jv_InterpClass
*klass
)
343 return klass
->interpreted_methods
;
346 struct _Jv_ResolvedMethod
348 jint stack_item_count
;
352 // a resolved method holds the cif in-line, so that _Jv_MarkObj just needs
353 // to mark the resolved method to hold on to the cif. Some memory could be
354 // saved by keeping a cache of cif's, since many will be the same.
356 ffi_type
* arg_types
[0];
359 class _Jv_JNIMethod
: public _Jv_MethodBase
361 // The underlying function. If NULL we have to look for the
365 // This is the CIF used by the JNI function.
368 // These are the argument types used by the JNI function.
369 ffi_type
**jni_arg_types
;
371 // This function is used when making a JNI call from the interpreter.
372 static void call (ffi_cif
*, void *, INTERP_FFI_RAW_TYPE
*, void *);
374 void *ncode (jclass
);
376 friend class _Jv_ClassReader
;
377 friend class _Jv_InterpreterEngine
;
379 #ifdef JV_MARKOBJ_DECL
380 friend JV_MARKOBJ_DECL
;
384 // FIXME: this is ugly.
385 void set_function (void *f
)
391 // The composite call stack as represented by a linked list of frames
395 java::lang::Thread
*thread
;
399 _Jv_MethodBase
*self
;
401 _Jv_Method
*proxyMethod
;
404 //The full list of frames, JNI and interpreted
406 _Jv_FrameType frame_type
;
408 _Jv_Frame (_Jv_MethodBase
*s
, java::lang::Thread
*thr
, _Jv_FrameType type
)
412 next
= (_Jv_Frame
*) thr
->frame
;
413 thr
->frame
= (gnu::gcj::RawData
*) this;
419 thread
->frame
= (gnu::gcj::RawData
*) next
;
426 for (f
= this; f
!= NULL
; f
= f
->next
)
433 // An interpreted frame in the call stack
434 class _Jv_InterpFrame
: public _Jv_Frame
438 // Keep the purely interpreted list around so as not to break backtraces
439 _Jv_InterpFrame
*next_interp
;
447 // Pointer to the actual pc value.
450 //Debug info for local variables.
454 // Object pointer for this frame ("this")
457 _Jv_InterpFrame (void *meth
, java::lang::Thread
*thr
, jclass proxyCls
= NULL
,
459 : _Jv_Frame (reinterpret_cast<_Jv_MethodBase
*> (meth
), thr
,
462 next_interp
= (_Jv_InterpFrame
*) thr
->interp_frame
;
463 proxyClass
= proxyCls
;
464 thr
->interp_frame
= (gnu::gcj::RawData
*) this;
471 thread
->interp_frame
= (gnu::gcj::RawData
*) next_interp
;
474 jobject
get_this_ptr ()
483 // If the PC_PTR is NULL, we are not debugging.
493 // A native frame in the call stack really just a placeholder
494 class _Jv_NativeFrame
: public _Jv_Frame
498 _Jv_NativeFrame (_Jv_JNIMethod
*s
, java::lang::Thread
*thr
)
499 : _Jv_Frame (s
, thr
, frame_native
)
504 #endif /* INTERPRETER */
506 #endif /* __JAVA_INTERP_H__ */