libjava/include/java-interp.h

   1 // java-interp.h - Header file for the bytecode interpreter.  -*- c++ -*-
   2
   3 /* Copyright (C) 1999, 2000  Red Hat, Inc.
   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
  17 #ifdef INTERPRETER
  18
  19 #pragma interface
  20
  21 #include <java/lang/Class.h>
  22 #include <java/lang/ClassLoader.h>
  23 #include <gnu/gcj/runtime/MethodInvocation.h>
  24
  25 extern "C" {
  26 #include <ffi.h>
  27 }
  28
  29 extern inline jboolean
  30 _Jv_IsInterpretedClass (jclass c)
  31 {
  32   return (c->loader != 0);
  33 }
  34
  35 struct _Jv_ResolvedMethod;
  36
  37 void _Jv_VerifyFieldSignature (_Jv_Utf8Const*sig);
  38 void _Jv_VerifyMethodSignature (_Jv_Utf8Const*sig);
  39 void _Jv_VerifyClassName (unsigned char* ptr, _Jv_ushort length);
  40 void _Jv_VerifyClassName (_Jv_Utf8Const *name);
  41 void _Jv_VerifyIdentifier (_Jv_Utf8Const *);
  42 bool _Jv_ClassNameSamePackage (_Jv_Utf8Const *name1, _Jv_Utf8Const *name2);
  43 void _Jv_DefineClass (jclass, jbyteArray, jint, jint);
  44 void _Jv_ResolveField (_Jv_Field *, java::lang::ClassLoader*);
  45
  46 void _Jv_InitField (jobject, jclass, int);
  47 void * _Jv_AllocMethodInvocation (jsize size);
  48
  49 /* FIXME: this should really be defined in some more generic place */
  50 #define ROUND(V, A) (((((unsigned) (V))-1) | ((A)-1))+1)
  51
  52 /* the interpreter is written in C++, primarily because it makes it easy for
  53  * the entire thing to be "friend" with class Class. */
  54
  55 class _Jv_InterpClass;
  56 class _Jv_InterpMethod;
  57 class _Jv_InterpMethodInvocation;
  58
  59 class _Jv_InterpException {
  60   int  start_pc;
  61   int  end_pc;
  62   int  handler_pc;
  63   int  handler_type;
  64
  65   friend class _Jv_ClassReader;
  66   friend class _Jv_InterpMethod;
  67 };
  68
  69 // Base class for method representations.  Subclasses are interpreted
  70 // and JNI methods.
  71 class _Jv_MethodBase
  72 {
  73 protected:
  74   // The class which defined this method.
  75   _Jv_InterpClass *defining_class;
  76
  77   // The method description.
  78   _Jv_Method *self;
  79
  80   // Size of raw arguments.
  81   _Jv_ushort args_raw_size;
  82 };
  83
  84 class _Jv_InterpMethod : public _Jv_MethodBase
  85 {
  86   _Jv_ushort       max_stack;
  87   _Jv_ushort       max_locals;
  88   int              code_length;
  89
  90   _Jv_ushort       exc_count;
  91
  92   unsigned char* bytecode ()
  93   {
  94     return
  95       ((unsigned char*)this)
  96       + ROUND((sizeof (_Jv_InterpMethod)
  97                + exc_count*sizeof (_Jv_InterpException)), 4);
  98   }
  99
 100   _Jv_InterpException * exceptions ()
 101   {
 102     return (_Jv_InterpException*) (this+1);
 103   }
 104
 105   static size_t size (int exc_count, int code_length)
 106   {
 107     return
 108       ROUND ((sizeof (_Jv_InterpMethod)
 109               + (exc_count * sizeof (_Jv_InterpException))), 4)
 110       + code_length;
 111   }
 112
 113   // return the method's invocation pointer (a stub).
 114   void *ncode ();
 115   void continue1 (_Jv_InterpMethodInvocation *inv);
 116
 117   static void run_normal (ffi_cif*, void*, ffi_raw*, void*);
 118   static void run_synch_object (ffi_cif*, void*, ffi_raw*, void*);
 119   static void run_synch_class (ffi_cif*, void*, ffi_raw*, void*);
 120
 121   inline jobject run (ffi_cif*, void*, ffi_raw*,
 122                       _Jv_InterpMethodInvocation*);
 123
 124   bool find_exception (jobject ex,
 125                        _Jv_InterpMethodInvocation *inv);
 126
 127  public:
 128   static void dump_object(jobject o);
 129
 130   friend class _Jv_ClassReader;
 131   friend class _Jv_InterpMethodInvocation;
 132   friend class gnu::gcj::runtime::MethodInvocation;
 133
 134   friend void _Jv_PrepareClass(jclass);
 135 };
 136
 137 class _Jv_InterpMethodInvocation {
 138   _Jv_InterpMethod *running;
 139   _Jv_word         *sp;
 140   unsigned char    *pc;
 141   _Jv_word          state[0];
 142
 143   _Jv_word*         stack_base () { return &state[0]; }
 144   _Jv_word*         local_base () { return &state[running->max_stack]; }
 145
 146   friend class _Jv_InterpMethod;
 147 };
 148
 149 class _Jv_InterpClass : public java::lang::Class
 150 {
 151   _Jv_MethodBase **interpreted_methods;
 152   _Jv_ushort        *field_initializers;
 153
 154   friend class _Jv_ClassReader;
 155   friend class _Jv_InterpMethod;
 156   friend void  _Jv_PrepareClass(jclass);
 157   friend void  _Jv_InitField (jobject, jclass, int);
 158   friend void* _Jv_MarkObj (void *, void *, void *, void *);
 159 };
 160
 161 struct _Jv_ResolvedMethod {
 162   jint            stack_item_count;
 163   jint            vtable_index;
 164   jclass          klass;
 165   _Jv_Method*     method;
 166
 167   // a resolved method holds the cif in-line, so that _Jv_MarkObj just needs
 168   // to mark the resolved method to hold on to the cif.  Some memory could be
 169   // saved by keeping a cache of cif's, since many will be the same.
 170   ffi_cif         cif;
 171   ffi_type *      arg_types[0];
 172 };
 173
 174 class _Jv_JNIMethod : public _Jv_MethodBase
 175 {
 176   // The underlying function.  If NULL we have to look for the
 177   // function.
 178   void *function;
 179
 180   // This is the CIF used by the JNI function.
 181   ffi_cif jni_cif;
 182
 183   // These are the argument types used by the JNI function.
 184   ffi_type **jni_arg_types;
 185
 186   // This function is used when making a JNI call from the interpreter.
 187   static void call (ffi_cif *, void *, ffi_raw *, void *);
 188
 189   void *ncode ();
 190
 191   friend class _Jv_ClassReader;
 192   friend void _Jv_PrepareClass(jclass);
 193 };
 194
 195 #endif /* INTERPRETER */
 196
 197 #endif /* __JAVA_INTERP_H__ */