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  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 #ifdef INTERPRETER
  19
  20 #pragma interface
  21
  22 #include <java/lang/Class.h>
  23 #include <java/lang/ClassLoader.h>
  24 #include <java/lang/reflect/Modifier.h>
  25 #include <gnu/gcj/runtime/StackTrace.h>
  26
  27 extern "C" {
  28 #include <ffi.h>
  29 }
  30
  31 extern inline jboolean
  32 _Jv_IsInterpretedClass (jclass c)
  33 {
  34   return (c->accflags & java::lang::reflect::Modifier::INTERPRETED) != 0;
  35 }
  36
  37 struct _Jv_ResolvedMethod;
  38
  39 void _Jv_DefineClass (jclass, jbyteArray, jint, jint);
  40
  41 void _Jv_InitField (jobject, jclass, int);
  42 void * _Jv_AllocMethodInvocation (jsize size);
  43 int  _Jv_count_arguments (_Jv_Utf8Const *signature,
  44                           jboolean staticp = true);
  45 void _Jv_VerifyMethod (_Jv_InterpMethod *method);
  46
  47 /* FIXME: this should really be defined in some more generic place */
  48 #define ROUND(V, A) (((((unsigned) (V))-1) | ((A)-1))+1)
  49
  50 /* the interpreter is written in C++, primarily because it makes it easy for
  51  * the entire thing to be "friend" with class Class. */
  52
  53 class _Jv_InterpClass;
  54 class _Jv_InterpMethod;
  55
  56 // Before a method is "compiled" we store values as the bytecode PC,
  57 // an int.  Afterwards we store them as pointers into the prepared
  58 // code itself.
  59 union _Jv_InterpPC
  60 {
  61   int i;
  62   void *p;
  63 };
  64
  65 class _Jv_InterpException
  66 {
  67   _Jv_InterpPC start_pc;
  68   _Jv_InterpPC end_pc;
  69   _Jv_InterpPC handler_pc;
  70   _Jv_InterpPC handler_type;
  71
  72   friend class _Jv_ClassReader;
  73   friend class _Jv_InterpMethod;
  74   friend class _Jv_BytecodeVerifier;
  75 };
  76
  77 // Base class for method representations.  Subclasses are interpreted
  78 // and JNI methods.
  79 class _Jv_MethodBase
  80 {
  81 protected:
  82   // The class which defined this method.
  83   _Jv_InterpClass *defining_class;
  84
  85   // The method description.
  86   _Jv_Method *self;
  87
  88   // Size of raw arguments.
  89   _Jv_ushort args_raw_size;
  90
  91 public:
  92   _Jv_Method *get_method ()
  93   {
  94     return self;
  95   }
  96 };
  97
  98 class _Jv_InterpMethod : public _Jv_MethodBase
  99 {
 100   _Jv_ushort       max_stack;
 101   _Jv_ushort       max_locals;
 102   int              code_length;
 103
 104   _Jv_ushort       exc_count;
 105
 106   void *prepared;
 107
 108   unsigned char* bytecode ()
 109   {
 110     return
 111       ((unsigned char*)this)
 112       + ROUND((sizeof (_Jv_InterpMethod)
 113                + exc_count*sizeof (_Jv_InterpException)), 4);
 114   }
 115
 116   _Jv_InterpException * exceptions ()
 117   {
 118     return (_Jv_InterpException*) (this+1);
 119   }
 120
 121   static size_t size (int exc_count, int code_length)
 122   {
 123     return
 124       ROUND ((sizeof (_Jv_InterpMethod)
 125               + (exc_count * sizeof (_Jv_InterpException))), 4)
 126       + code_length;
 127   }
 128
 129   // return the method's invocation pointer (a stub).
 130   void *ncode ();
 131   void compile (const void * const *);
 132
 133   static void run_normal (ffi_cif*, void*, ffi_raw*, void*);
 134   static void run_synch_object (ffi_cif*, void*, ffi_raw*, void*);
 135   static void run_class (ffi_cif*, void*, ffi_raw*, void*);
 136   static void run_synch_class (ffi_cif*, void*, ffi_raw*, void*);
 137
 138   void run (void*, ffi_raw *);
 139
 140  public:
 141   static void dump_object(jobject o);
 142
 143   friend class _Jv_ClassReader;
 144   friend class _Jv_BytecodeVerifier;
 145   friend class gnu::gcj::runtime::NameFinder;
 146   friend class gnu::gcj::runtime::StackTrace;
 147
 148   friend void _Jv_PrepareClass(jclass);
 149
 150 #ifdef JV_MARKOBJ_DECL
 151   friend JV_MARKOBJ_DECL;
 152 #endif
 153 };
 154
 155 class _Jv_InterpClass : public java::lang::Class
 156 {
 157   _Jv_MethodBase **interpreted_methods;
 158   _Jv_ushort        *field_initializers;
 159
 160   friend class _Jv_ClassReader;
 161   friend class _Jv_InterpMethod;
 162   friend void  _Jv_PrepareClass(jclass);
 163   friend void  _Jv_PrepareMissingMethods (jclass base2, jclass iface_class);
 164   friend void  _Jv_InitField (jobject, jclass, int);
 165 #ifdef JV_MARKOBJ_DECL
 166   friend JV_MARKOBJ_DECL;
 167 #endif
 168
 169   friend _Jv_MethodBase ** _Jv_GetFirstMethod (_Jv_InterpClass *klass);
 170 };
 171
 172 extern inline _Jv_MethodBase **
 173 _Jv_GetFirstMethod (_Jv_InterpClass *klass)
 174 {
 175   return klass->interpreted_methods;
 176 }
 177
 178 struct _Jv_ResolvedMethod {
 179   jint            stack_item_count;
 180   jint            vtable_index;
 181   jclass          klass;
 182   _Jv_Method*     method;
 183
 184   // a resolved method holds the cif in-line, so that _Jv_MarkObj just needs
 185   // to mark the resolved method to hold on to the cif.  Some memory could be
 186   // saved by keeping a cache of cif's, since many will be the same.
 187   ffi_cif         cif;
 188   ffi_type *      arg_types[0];
 189 };
 190
 191 class _Jv_JNIMethod : public _Jv_MethodBase
 192 {
 193   // The underlying function.  If NULL we have to look for the
 194   // function.
 195   void *function;
 196
 197   // This is the CIF used by the JNI function.
 198   ffi_cif jni_cif;
 199
 200   // These are the argument types used by the JNI function.
 201   ffi_type **jni_arg_types;
 202
 203   // This function is used when making a JNI call from the interpreter.
 204   static void call (ffi_cif *, void *, ffi_raw *, void *);
 205
 206   void *ncode ();
 207
 208   friend class _Jv_ClassReader;
 209   friend void _Jv_PrepareClass(jclass);
 210
 211 public:
 212   // FIXME: this is ugly.
 213   void set_function (void *f)
 214   {
 215     function = f;
 216   }
 217 };
 218
 219 // A structure of this type is used to link together interpreter
 220 // invocations on the stack.
 221 struct _Jv_MethodChain
 222 {
 223   const _Jv_InterpMethod *self;
 224   _Jv_MethodChain **ptr;
 225   _Jv_MethodChain *next;
 226
 227   _Jv_MethodChain (const _Jv_InterpMethod *s, _Jv_MethodChain **n)
 228   {
 229     self = s;
 230     ptr = n;
 231     next = *n;
 232     *n = this;
 233   }
 234
 235   ~_Jv_MethodChain ()
 236   {
 237     *ptr = next;
 238   }
 239 };
 240
 241 #endif /* INTERPRETER */
 242
 243 #endif /* __JAVA_INTERP_H__ */