libjava/include/java-interp.h

   1 // java-interp.h - Header file for the bytecode interpreter.  -*- c++ -*-
   2
   3 /* Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007  Free Software Foundation
   4
   5    This file is part of libgcj.
   6
   7 This software is copyrighted work licensed under the terms of the
   8 Libgcj License.  Please consult the file "LIBGCJ_LICENSE" for
   9 details.  */
  10
  11 #ifndef __JAVA_INTERP_H__
  12 #define __JAVA_INTERP_H__
  13
  14 #include <jvm.h>
  15 #include <java-cpool.h>
  16 #include <gnu/gcj/runtime/NameFinder.h>
  17
  18 enum _Jv_FrameType
  19 {
  20   frame_native,
  21   frame_interpreter,
  22   frame_proxy
  23 };
  24
  25 #ifdef INTERPRETER
  26
  27 #pragma interface
  28
  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>
  34
  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
  39
  40 #include <ffi.h>
  41
  42 struct _Jv_ResolvedMethod;
  43
  44 void _Jv_InitInterpreter ();
  45 void _Jv_DefineClass (jclass, jbyteArray, jint, jint,
  46                       java::security::ProtectionDomain *,
  47                       _Jv_Utf8Const **);
  48
  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,
  56                   int arg_count,
  57                   jboolean staticp,
  58                   ffi_cif *cif,
  59                   ffi_type **arg_types,
  60                   ffi_type **rtype_p);
  61
  62 /* the interpreter is written in C++, primarily because it makes it easy for
  63  * the entire thing to be "friend" with class Class. */
  64
  65 class _Jv_InterpClass;
  66 class _Jv_InterpMethod;
  67
  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
  70 // code itself.
  71 union _Jv_InterpPC
  72 {
  73   int i;
  74   void *p;
  75 };
  76
  77 class _Jv_InterpException
  78 {
  79   _Jv_InterpPC start_pc;
  80   _Jv_InterpPC end_pc;
  81   _Jv_InterpPC handler_pc;
  82   _Jv_InterpPC handler_type;
  83
  84   friend class _Jv_ClassReader;
  85   friend class _Jv_InterpMethod;
  86   friend class _Jv_BytecodeVerifier;
  87 };
  88
  89 // Base class for method representations.  Subclasses are interpreted
  90 // and JNI methods.
  91 class _Jv_MethodBase
  92 {
  93 protected:
  94   // The class which defined this method.
  95   jclass defining_class;
  96
  97   // The method description.
  98   _Jv_Method *self;
  99
 100   // Size of raw arguments.
 101   _Jv_ushort args_raw_size;
 102
 103   friend class _Jv_InterpreterEngine;
 104
 105 public:
 106   _Jv_Method *get_method ()
 107   {
 108     return self;
 109   }
 110 };
 111
 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.
 116 union insn_slot
 117 {
 118   // Address of code.
 119   void *insn;
 120   // An integer value used by an instruction.
 121   jint int_val;
 122   // A pointer value used by an instruction.
 123   void *datum;
 124 };
 125
 126 typedef insn_slot *pc_t;
 127 #else
 128 typedef unsigned char *pc_t;
 129 #endif
 130
 131
 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
 136 // line.
 137 struct  _Jv_LineTableEntry
 138 {
 139   union
 140   {
 141     pc_t pc;
 142     int bytecode_pc;
 143   };
 144   int line;
 145 };
 146
 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
 151 {
 152   // First PC value at which variable is live
 153   union
 154   {
 155     pc_t pc;
 156     int bytecode_pc;
 157   };
 158
 159   // length of visibility of variable
 160   int length;
 161
 162   // variable name
 163   char *name;
 164
 165   // type description
 166   char *descriptor;
 167
 168   // stack slot number (long and double occupy slot and slot + 1)
 169   int slot;
 170 };
 171
 172 class _Jv_InterpMethod : public _Jv_MethodBase
 173 {
 174   // Breakpoint instruction
 175   static pc_t breakpoint_insn;
 176 #ifdef DIRECT_THREADED
 177   static insn_slot bp_insn_slot;
 178 #else
 179   static unsigned char bp_insn_opcode;
 180 #endif
 181
 182   _Jv_ushort       max_stack;
 183   _Jv_ushort       max_locals;
 184   int              code_length;
 185
 186   _Jv_ushort       exc_count;
 187   bool             is_15;
 188
 189   // Length of the line_table - when this is zero then line_table is NULL.
 190   int line_table_len;
 191   _Jv_LineTableEntry *line_table;
 192
 193   // The local variable table length and the table itself
 194   int local_var_table_len;
 195   _Jv_LocalVarTableEntry *local_var_table;
 196
 197   pc_t prepared;
 198   int number_insn_slots;
 199
 200   unsigned char* bytecode ()
 201   {
 202     return
 203       ((unsigned char*)this)
 204       + ROUND((sizeof (_Jv_InterpMethod)
 205                + exc_count*sizeof (_Jv_InterpException)), 4);
 206   }
 207
 208   _Jv_InterpException * exceptions ()
 209   {
 210     return (_Jv_InterpException*) (this+1);
 211   }
 212
 213   static size_t size (int exc_count, int code_length)
 214   {
 215     return
 216       ROUND ((sizeof (_Jv_InterpMethod)
 217               + (exc_count * sizeof (_Jv_InterpException))), 4)
 218       + code_length;
 219   }
 220
 221   // return the method's invocation pointer (a stub).
 222   void *ncode (jclass);
 223   void compile (const void * const *);
 224
 225   static void run_normal (ffi_cif*, void*, ffi_raw*, void*);
 226   static void run_synch_object (ffi_cif*, void*, ffi_raw*, void*);
 227   static void run_class (ffi_cif*, void*, ffi_raw*, void*);
 228   static void run_synch_class (ffi_cif*, void*, ffi_raw*, void*);
 229
 230   static void run_normal_debug (ffi_cif*, void*, ffi_raw*, void*);
 231   static void run_synch_object_debug (ffi_cif*, void*, ffi_raw*, void*);
 232   static void run_class_debug (ffi_cif*, void*, ffi_raw*, void*);
 233   static void run_synch_class_debug (ffi_cif*, void*, ffi_raw*, void*);
 234
 235   static void run (void *, ffi_raw *, _Jv_InterpMethod *);
 236   static void run_debug (void *, ffi_raw *, _Jv_InterpMethod *);
 237
 238
 239
 240   // Returns source file line number for given PC value, or -1 if line
 241   // number info is unavailable.
 242   int get_source_line(pc_t mpc);
 243
 244    public:
 245
 246   // Convenience function for indexing bytecode PC/insn slots in
 247   // line tables for JDWP
 248   jlong insn_index (pc_t pc);
 249
 250   // Helper function used to check if there is a handler for an exception
 251   // present at this code index
 252   jboolean check_handler (pc_t *pc, _Jv_InterpMethod *meth,
 253                      java::lang::Throwable *ex);
 254
 255   /* Get the line table for this method.
 256    * start  is the lowest index in the method
 257    * end    is the  highest index in the method
 258    * line_numbers is an array to hold the list of source line numbers
 259    * code_indices is an array to hold the corresponding list of code indices
 260    */
 261   void get_line_table (jlong& start, jlong& end, jintArray& line_numbers,
 262                        jlongArray& code_indices);
 263
 264   int get_max_locals ()
 265   {
 266     return static_cast<int> (max_locals);
 267   }
 268
 269   /* Get info for a local variable of this method.
 270    * If there is no loca_var_table for this method it will return -1.
 271    * table_slot  indicates which slot in the local_var_table to get, if there is
 272    * no variable at this location it will return 0.
 273    * Otherwise, it will return the number of table slots after the selected
 274    * slot, indexed from 0.
 275    *
 276    * Example: there are 5 slots in the table, you request slot 0 so it will
 277    * return 4.
 278    */
 279   int get_local_var_table (char **name, char **sig, char **generic_sig,
 280                            jlong *startloc, jint *length, jint *slot,
 281                            int table_slot);
 282
 283   /* Installs a break instruction at the given code index. Returns
 284      the pc_t of the breakpoint or NULL if index is invalid. */
 285   pc_t install_break (jlong index);
 286
 287   // Gets the instruction at the given index
 288   pc_t get_insn (jlong index);
 289
 290   /* Writes the given instruction at the given code index. Returns
 291      the insn or NULL if index is invalid. */
 292   pc_t set_insn (jlong index, pc_t insn);
 293
 294   // Is the given location in this method a breakpoint?
 295   bool breakpoint_at (jlong index);
 296
 297 #ifdef DIRECT_THREADED
 298   friend void _Jv_CompileMethod (_Jv_InterpMethod*);
 299 #endif
 300
 301   friend class _Jv_ClassReader;
 302   friend class _Jv_BytecodeVerifier;
 303   friend class _Jv_StackTrace;
 304   friend class _Jv_InterpreterEngine;
 305
 306 #ifdef JV_MARKOBJ_DECL
 307   friend JV_MARKOBJ_DECL;
 308 #endif
 309 };
 310
 311 class _Jv_InterpClass
 312 {
 313   _Jv_MethodBase **interpreted_methods;
 314   _Jv_ushort     *field_initializers;
 315   jstring source_file_name;
 316   _Jv_ClosureList **closures;
 317
 318   friend class _Jv_ClassReader;
 319   friend class _Jv_InterpMethod;
 320   friend class _Jv_StackTrace;
 321   friend class _Jv_InterpreterEngine;
 322
 323   friend void  _Jv_InitField (jobject, jclass, int);
 324 #ifdef JV_MARKOBJ_DECL
 325   friend JV_MARKOBJ_DECL;
 326 #endif
 327
 328   friend _Jv_MethodBase ** _Jv_GetFirstMethod (_Jv_InterpClass *klass);
 329   friend jstring _Jv_GetInterpClassSourceFile (jclass);
 330 };
 331
 332 extern inline _Jv_MethodBase **
 333 _Jv_GetFirstMethod (_Jv_InterpClass *klass)
 334 {
 335   return klass->interpreted_methods;
 336 }
 337
 338 struct _Jv_ResolvedMethod
 339 {
 340   jint            stack_item_count;
 341   jclass          klass;
 342   _Jv_Method*     method;
 343
 344   // a resolved method holds the cif in-line, so that _Jv_MarkObj just needs
 345   // to mark the resolved method to hold on to the cif.  Some memory could be
 346   // saved by keeping a cache of cif's, since many will be the same.
 347   ffi_cif         cif;
 348   ffi_type *      arg_types[0];
 349 };
 350
 351 class _Jv_JNIMethod : public _Jv_MethodBase
 352 {
 353   // The underlying function.  If NULL we have to look for the
 354   // function.
 355   void *function;
 356
 357   // This is the CIF used by the JNI function.
 358   ffi_cif jni_cif;
 359
 360   // These are the argument types used by the JNI function.
 361   ffi_type **jni_arg_types;
 362
 363   // This function is used when making a JNI call from the interpreter.
 364   static void call (ffi_cif *, void *, ffi_raw *, void *);
 365
 366   void *ncode (jclass);
 367
 368   friend class _Jv_ClassReader;
 369   friend class _Jv_InterpreterEngine;
 370
 371 #ifdef JV_MARKOBJ_DECL
 372   friend JV_MARKOBJ_DECL;
 373 #endif
 374
 375 public:
 376   // FIXME: this is ugly.
 377   void set_function (void *f)
 378   {
 379     function = f;
 380   }
 381 };
 382
 383 //  The composite call stack as represented by a linked list of frames
 384 class _Jv_Frame
 385 {
 386 public:
 387   java::lang::Thread *thread;
 388
 389   union
 390   {
 391     _Jv_MethodBase *self;
 392     void *meth;
 393     _Jv_Method *proxyMethod;
 394   };
 395
 396   //The full list of frames, JNI and interpreted
 397   _Jv_Frame *next;
 398   _Jv_FrameType frame_type;
 399
 400   _Jv_Frame (_Jv_MethodBase *s, java::lang::Thread *thr, _Jv_FrameType type)
 401   {
 402     self = s;
 403     frame_type = type;
 404     next = (_Jv_Frame *) thr->frame;
 405     thr->frame = (gnu::gcj::RawData *) this;
 406     thread = thr;
 407   }
 408
 409   ~_Jv_Frame ()
 410   {
 411     thread->frame = (gnu::gcj::RawData *) next;
 412   }
 413
 414   int depth ()
 415   {
 416     int depth = 0;
 417     struct _Jv_Frame *f;
 418     for (f = this; f != NULL; f = f->next)
 419       ++depth;
 420
 421     return depth;
 422   }
 423 };
 424
 425 // An interpreted frame in the call stack
 426 class _Jv_InterpFrame : public _Jv_Frame
 427 {
 428 public:
 429
 430   // Keep the purely interpreted list around so as not to break backtraces
 431   _Jv_InterpFrame *next_interp;
 432
 433   union
 434   {
 435     pc_t pc;
 436     jclass proxyClass;
 437   };
 438
 439   // Pointer to the actual pc value.
 440   pc_t *pc_ptr;
 441
 442   //Debug info for local variables.
 443   _Jv_word *locals;
 444   char *locals_type;
 445
 446   // Object pointer for this frame ("this")
 447   jobject obj_ptr;
 448
 449   _Jv_InterpFrame (void *meth, java::lang::Thread *thr, jclass proxyCls = NULL,
 450                    pc_t *pc = NULL)
 451   : _Jv_Frame (reinterpret_cast<_Jv_MethodBase *> (meth), thr,
 452                      frame_interpreter)
 453   {
 454     next_interp = (_Jv_InterpFrame *) thr->interp_frame;
 455     proxyClass = proxyCls;
 456     thr->interp_frame = (gnu::gcj::RawData *) this;
 457     obj_ptr = NULL;
 458     pc_ptr = pc;
 459   }
 460
 461   ~_Jv_InterpFrame ()
 462   {
 463     thread->interp_frame = (gnu::gcj::RawData *) next_interp;
 464   }
 465
 466   jobject get_this_ptr ()
 467   {
 468     return obj_ptr;
 469   }
 470
 471   pc_t get_pc ()
 472   {
 473     pc_t pc;
 474
 475     // If the PC_PTR is NULL, we are not debugging.
 476     if (pc_ptr == NULL)
 477       pc = 0;
 478     else
 479       pc = *pc_ptr - 1;
 480
 481     return pc;
 482   }
 483 };
 484
 485 // A native frame in the call stack really just a placeholder
 486 class _Jv_NativeFrame : public _Jv_Frame
 487 {
 488 public:
 489
 490   _Jv_NativeFrame (_Jv_JNIMethod *s, java::lang::Thread *thr)
 491   : _Jv_Frame (s, thr, frame_native)
 492   {
 493   }
 494 };
 495
 496 #endif /* INTERPRETER */
 497
 498 #endif /* __JAVA_INTERP_H__ */