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  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
  26 extern "C" {
  27 #include <ffi.h>
  28 }
  29
  30 extern inline jboolean
  31 _Jv_IsInterpretedClass (jclass c)
  32 {
  33   return (c->accflags & java::lang::reflect::Modifier::INTERPRETED) != 0;
  34 }
  35
  36 struct _Jv_ResolvedMethod;
  37
  38 void _Jv_InitInterpreter ();
  39 void _Jv_DefineClass (jclass, jbyteArray, jint, jint,
  40                       java::security::ProtectionDomain *);
  41
  42 void _Jv_InitField (jobject, jclass, int);
  43 void * _Jv_AllocMethodInvocation (jsize size);
  44 int  _Jv_count_arguments (_Jv_Utf8Const *signature,
  45                           jboolean staticp = true);
  46 void _Jv_VerifyMethod (_Jv_InterpMethod *method);
  47
  48 /* the interpreter is written in C++, primarily because it makes it easy for
  49  * the entire thing to be "friend" with class Class. */
  50
  51 class _Jv_InterpClass;
  52 class _Jv_InterpMethod;
  53
  54 // Before a method is "compiled" we store values as the bytecode PC,
  55 // an int.  Afterwards we store them as pointers into the prepared
  56 // code itself.
  57 union _Jv_InterpPC
  58 {
  59   int i;
  60   void *p;
  61 };
  62
  63 class _Jv_InterpException
  64 {
  65   _Jv_InterpPC start_pc;
  66   _Jv_InterpPC end_pc;
  67   _Jv_InterpPC handler_pc;
  68   _Jv_InterpPC handler_type;
  69
  70   friend class _Jv_ClassReader;
  71   friend class _Jv_InterpMethod;
  72   friend class _Jv_BytecodeVerifier;
  73 };
  74
  75 // Base class for method representations.  Subclasses are interpreted
  76 // and JNI methods.
  77 class _Jv_MethodBase
  78 {
  79 protected:
  80   // The class which defined this method.
  81   jclass defining_class;
  82
  83   // The method description.
  84   _Jv_Method *self;
  85
  86   // Size of raw arguments.
  87   _Jv_ushort args_raw_size;
  88
  89   friend class _Jv_InterpreterEngine;
  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   friend class _Jv_InterpreterEngine;
 148
 149
 150 #ifdef JV_MARKOBJ_DECL
 151   friend JV_MARKOBJ_DECL;
 152 #endif
 153 };
 154
 155 class _Jv_InterpClass
 156 {
 157   _Jv_MethodBase **interpreted_methods;
 158   _Jv_ushort        *field_initializers;
 159
 160   friend class _Jv_ClassReader;
 161   friend class _Jv_InterpMethod;
 162   friend class _Jv_InterpreterEngine;
 163   friend void  _Jv_InitField (jobject, jclass, int);
 164 #ifdef JV_MARKOBJ_DECL
 165   friend JV_MARKOBJ_DECL;
 166 #endif
 167
 168   friend _Jv_MethodBase ** _Jv_GetFirstMethod (_Jv_InterpClass *klass);
 169 };
 170
 171 extern inline _Jv_MethodBase **
 172 _Jv_GetFirstMethod (_Jv_InterpClass *klass)
 173 {
 174   return klass->interpreted_methods;
 175 }
 176
 177 struct _Jv_ResolvedMethod {
 178   jint            stack_item_count;
 179   jint            vtable_index;
 180   jclass          klass;
 181   _Jv_Method*     method;
 182
 183   // a resolved method holds the cif in-line, so that _Jv_MarkObj just needs
 184   // to mark the resolved method to hold on to the cif.  Some memory could be
 185   // saved by keeping a cache of cif's, since many will be the same.
 186   ffi_cif         cif;
 187   ffi_type *      arg_types[0];
 188 };
 189
 190 class _Jv_JNIMethod : public _Jv_MethodBase
 191 {
 192   // The underlying function.  If NULL we have to look for the
 193   // function.
 194   void *function;
 195
 196   // This is the CIF used by the JNI function.
 197   ffi_cif jni_cif;
 198
 199   // These are the argument types used by the JNI function.
 200   ffi_type **jni_arg_types;
 201
 202   // This function is used when making a JNI call from the interpreter.
 203   static void call (ffi_cif *, void *, ffi_raw *, void *);
 204
 205   void *ncode ();
 206
 207   friend class _Jv_ClassReader;
 208   friend class _Jv_InterpreterEngine;
 209
 210 #ifdef JV_MARKOBJ_DECL
 211   friend JV_MARKOBJ_DECL;
 212 #endif
 213
 214 public:
 215   // FIXME: this is ugly.
 216   void set_function (void *f)
 217   {
 218     function = f;
 219   }
 220 };
 221
 222 // A structure of this type is used to link together interpreter
 223 // invocations on the stack.
 224 struct _Jv_MethodChain
 225 {
 226   const _Jv_InterpMethod *self;
 227   _Jv_MethodChain **ptr;
 228   _Jv_MethodChain *next;
 229
 230   _Jv_MethodChain (const _Jv_InterpMethod *s, _Jv_MethodChain **n)
 231   {
 232     self = s;
 233     ptr = n;
 234     next = *n;
 235     *n = this;
 236   }
 237
 238   ~_Jv_MethodChain ()
 239   {
 240     *ptr = next;
 241   }
 242 };
 243
 244 #endif /* INTERPRETER */
 245
 246 #endif /* __JAVA_INTERP_H__ */