* src/vm/class.c (vm/suck.h): Added.
[cacao.git] / src / vm / method.h
1 /* src/vm/method.h - method functions header
2
3    Copyright (C) 1996-2005, 2006 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    Contact: cacao@cacaojvm.org
26
27    Authors: Reinhard Grafl
28             Christian Thalinger
29             Edwin Steiner
30
31    $Id: method.h 6216 2006-12-18 18:21:37Z twisti $
32 */
33
34
35 #ifndef _METHOD_H
36 #define _METHOD_H
37
38 /* forward typedefs ***********************************************************/
39
40 typedef struct methodinfo          methodinfo; 
41 typedef struct raw_exception_entry raw_exception_entry;
42 typedef struct lineinfo            lineinfo; 
43 typedef struct method_assumption   method_assumption;
44 typedef struct method_worklist     method_worklist;
45
46 #include "config.h"
47 #include "vm/types.h"
48
49 #include "vm/descriptor.h"
50 #include "vm/global.h"
51 #include "vm/linker.h"
52 #include "vm/references.h"
53
54 #if defined(ENABLE_JAVASE)
55 # include "vm/stackmap.h"
56 #endif
57
58 #include "vm/utf8.h"
59 #include "vm/jit/code.h"
60 #include "vm/jit/jit.h"
61
62
63 /* methodinfo *****************************************************************/
64
65 struct methodinfo {                 /* method structure                       */
66         java_objectheader header;       /* we need this in jit's monitorenter     */
67         s4            flags;            /* ACC flags                              */
68         utf          *name;             /* name of method                         */
69         utf          *descriptor;       /* JavaVM descriptor string of method     */
70 #if defined(ENABLE_JAVASE)
71         utf          *signature;        /* Signature attribute                    */
72         stack_map_t  *stack_map;        /* StackMapTable attribute                */
73 #endif
74
75         methoddesc   *parseddesc;       /* parsed descriptor                      */
76                              
77         classinfo    *class;            /* class, the method belongs to           */
78         s4            vftblindex;       /* index of method in virtual function    */
79                                         /* table (if it is a virtual method)      */
80         s4            maxstack;         /* maximum stack depth of method          */
81         s4            maxlocals;        /* maximum number of local variables      */
82         s4            jcodelength;      /* length of JavaVM code                  */
83         u1           *jcode;            /* pointer to JavaVM code                 */
84
85         s4            rawexceptiontablelength;  /* exceptiontable length          */
86         raw_exception_entry *rawexceptiontable; /* the exceptiontable             */
87
88         u2            thrownexceptionscount; /* number of exceptions attribute    */
89         classref_or_classinfo *thrownexceptions; /* except. a method may throw    */
90
91         u2            linenumbercount;  /* number of linenumber attributes        */
92         lineinfo     *linenumbers;      /* array of lineinfo items                */
93
94         u1           *stubroutine;      /* stub for compiling or calling natives  */
95         codeinfo     *code;             /* current code of this method            */
96
97 #if defined(ENABLE_LSRA)
98         s4            maxlifetimes;     /* helper for lsra                        */
99 #endif
100
101         methodinfo   *overwrites;       /* method that is directly overwritten    */
102         method_assumption *assumptions; /* list of assumptions about this method  */
103 };
104
105
106 /* method_assumption ***********************************************************
107
108    This struct is used for registering assumptions about methods.
109
110 *******************************************************************************/
111
112 struct method_assumption {
113         method_assumption *next;
114         methodinfo        *context;
115 };
116
117
118 /* method_worklist *************************************************************
119
120    List node used for method worklists.
121
122 *******************************************************************************/
123
124 struct method_worklist {
125         method_worklist *next;
126         methodinfo      *m;
127 };
128
129
130 /* raw_exception_entry ********************************************************/
131
132 /* exception table entry read by the loader */
133
134 struct raw_exception_entry {    /* exceptiontable entry in a method           */
135         classref_or_classinfo catchtype; /* catchtype of exc. (0 == catchall)     */
136         u2              startpc;    /* start pc of guarded area (inclusive)       */
137         u2              endpc;      /* end pc of guarded area (exklusive)         */
138         u2              handlerpc;  /* pc of exception handler                    */
139 };
140
141
142 /* lineinfo *******************************************************************/
143
144 struct lineinfo {
145         u2 start_pc;
146         u2 line_number;
147 };
148
149
150 /* function prototypes ********************************************************/
151
152 void method_free(methodinfo *m);
153 bool method_canoverwrite(methodinfo *m, methodinfo *old);
154
155 methodinfo *method_vftbl_lookup(vftbl_t *vftbl, methodinfo* m);
156
157 void method_add_assumption_monomorphic(methodinfo *m, methodinfo *caller);
158 void method_break_assumption_monomorphic(methodinfo *m, method_worklist **wl);
159
160 #if !defined(NDEBUG)
161 void method_printflags(methodinfo *m);
162 void method_print(methodinfo *m);
163 void method_println(methodinfo *m);
164 void method_methodref_print(constant_FMIref *mr);
165 void method_methodref_println(constant_FMIref *mr);
166 #endif
167
168 #endif /* _METHOD_H */
169
170
171 /*
172  * These are local overrides for various environment variables in Emacs.
173  * Please do not remove this and leave it at the end of the file, where
174  * Emacs will automagically detect them.
175  * ---------------------------------------------------------------------
176  * Local variables:
177  * mode: c
178  * indent-tabs-mode: t
179  * c-basic-offset: 4
180  * tab-width: 4
181  * End:
182  * vim:noexpandtab:sw=4:ts=4:
183  */