src/vmcore/method.h

   1 /* src/vmcore/method.h - method functions header
   2
   3    Copyright (C) 1996-2005, 2006, 2007 R. Grafl, A. Krall, C. Kruegel,
   4    C. Oates, R. Obermaisser, M. Platter, M. Probst, S. Ring,
   5    E. Steiner, C. Thalinger, D. Thuernbeck, P. Tomsich, C. Ullrich,
   6    J. Wenninger, Institut f. Computersprachen - TU Wien
   7
   8    This file is part of CACAO.
   9
  10    This program is free software; you can redistribute it and/or
  11    modify it under the terms of the GNU General Public License as
  12    published by the Free Software Foundation; either version 2, or (at
  13    your option) any later version.
  14
  15    This program is distributed in the hope that it will be useful, but
  16    WITHOUT ANY WARRANTY; without even the implied warranty of
  17    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18    General Public License for more details.
  19
  20    You should have received a copy of the GNU General Public License
  21    along with this program; if not, write to the Free Software
  22    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  23    02110-1301, USA.
  24
  25    $Id: method.h 7483 2007-03-08 13:17:40Z michi $
  26 */
  27
  28
  29 #ifndef _METHOD_H
  30 #define _METHOD_H
  31
  32 /* forward typedefs ***********************************************************/
  33
  34 typedef struct methodinfo          methodinfo;
  35 typedef struct raw_exception_entry raw_exception_entry;
  36 typedef struct lineinfo            lineinfo;
  37 typedef struct method_assumption   method_assumption;
  38 typedef struct method_worklist     method_worklist;
  39 typedef struct codeinfo            codeinfo;
  40
  41 #include "config.h"
  42 #include "vm/types.h"
  43
  44 #include "vm/global.h"
  45
  46 #include "vmcore/descriptor.h"
  47 #include "vmcore/references.h"
  48 #include "vmcore/linker.h"
  49
  50 #if defined(ENABLE_JAVASE)
  51 # include "vmcore/stackmap.h"
  52 #endif
  53
  54 #include "vmcore/utf8.h"
  55
  56
  57 #if defined(ENABLE_REPLACEMENT)
  58 /* Initial value for the hit countdown field of each method. */
  59 #define METHOD_INITIAL_HIT_COUNTDOWN  1000
  60 #endif
  61
  62
  63 /* methodinfo *****************************************************************/
  64
  65 struct methodinfo {                 /* method structure                       */
  66         s4            flags;            /* ACC flags                              */
  67         utf          *name;             /* name of method                         */
  68         utf          *descriptor;       /* JavaVM descriptor string of method     */
  69 #if defined(ENABLE_JAVASE)
  70         utf          *signature;        /* Signature attribute                    */
  71         stack_map_t  *stack_map;        /* StackMapTable attribute                */
  72 #endif
  73
  74         methoddesc   *parseddesc;       /* parsed descriptor                      */
  75
  76         classinfo    *class;            /* class, the method belongs to           */
  77         s4            vftblindex;       /* index of method in virtual function    */
  78                                         /* table (if it is a virtual method)      */
  79         s4            maxstack;         /* maximum stack depth of method          */
  80         s4            maxlocals;        /* maximum number of local variables      */
  81         s4            jcodelength;      /* length of JavaVM code                  */
  82         u1           *jcode;            /* pointer to JavaVM code                 */
  83
  84         s4            rawexceptiontablelength;  /* exceptiontable length          */
  85         raw_exception_entry *rawexceptiontable; /* the exceptiontable             */
  86
  87         u2            thrownexceptionscount; /* number of exceptions attribute    */
  88         classref_or_classinfo *thrownexceptions; /* except. a method may throw    */
  89
  90         u2            linenumbercount;  /* number of linenumber attributes        */
  91         lineinfo     *linenumbers;      /* array of lineinfo items                */
  92
  93         u1           *stubroutine;      /* stub for compiling or calling natives  */
  94         codeinfo     *code;             /* current code of this method            */
  95
  96 #if defined(ENABLE_LSRA)
  97         s4            maxlifetimes;     /* helper for lsra                        */
  98 #endif
  99
 100         methodinfo   *overwrites;       /* method that is directly overwritten    */
 101         method_assumption *assumptions; /* list of assumptions about this method  */
 102
 103 #if defined(ENABLE_REPLACEMENT)
 104         s4            hitcountdown;     /* decreased for each hit                 */
 105 #endif
 106 };
 107
 108
 109 /* method_assumption ***********************************************************
 110
 111    This struct is used for registering assumptions about methods.
 112
 113 *******************************************************************************/
 114
 115 struct method_assumption {
 116         method_assumption *next;
 117         methodinfo        *context;
 118 };
 119
 120
 121 /* method_worklist *************************************************************
 122
 123    List node used for method worklists.
 124
 125 *******************************************************************************/
 126
 127 struct method_worklist {
 128         method_worklist *next;
 129         methodinfo      *m;
 130 };
 131
 132
 133 /* raw_exception_entry ********************************************************/
 134
 135 /* exception table entry read by the loader */
 136
 137 struct raw_exception_entry {    /* exceptiontable entry in a method           */
 138         classref_or_classinfo catchtype; /* catchtype of exc. (0 == catchall)     */
 139         u2              startpc;    /* start pc of guarded area (inclusive)       */
 140         u2              endpc;      /* end pc of guarded area (exklusive)         */
 141         u2              handlerpc;  /* pc of exception handler                    */
 142 };
 143
 144
 145 /* lineinfo *******************************************************************/
 146
 147 struct lineinfo {
 148         u2 start_pc;
 149         u2 line_number;
 150 };
 151
 152
 153 /* function prototypes ********************************************************/
 154
 155 void method_free(methodinfo *m);
 156 bool method_canoverwrite(methodinfo *m, methodinfo *old);
 157
 158 methodinfo *method_vftbl_lookup(vftbl_t *vftbl, methodinfo* m);
 159
 160 void method_add_assumption_monomorphic(methodinfo *m, methodinfo *caller);
 161 void method_break_assumption_monomorphic(methodinfo *m, method_worklist **wl);
 162
 163 s4   method_count_implementations(methodinfo *m, classinfo *c, methodinfo **found);
 164
 165 #if !defined(NDEBUG)
 166 void method_printflags(methodinfo *m);
 167 void method_print(methodinfo *m);
 168 void method_println(methodinfo *m);
 169 void method_methodref_print(constant_FMIref *mr);
 170 void method_methodref_println(constant_FMIref *mr);
 171 #endif
 172
 173 #endif /* _METHOD_H */
 174
 175
 176 /*
 177  * These are local overrides for various environment variables in Emacs.
 178  * Please do not remove this and leave it at the end of the file, where
 179  * Emacs will automagically detect them.
 180  * ---------------------------------------------------------------------
 181  * Local variables:
 182  * mode: c
 183  * indent-tabs-mode: t
 184  * c-basic-offset: 4
 185  * tab-width: 4
 186  * End:
 187  * vim:noexpandtab:sw=4:ts=4:
 188  */