New source tree.
[cacao.git] / src / vm / jit / codegen.inc.h
1 /* jit/codegen.inc.h - code generation header
2
3    Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003
4    R. Grafl, A. Krall, C. Kruegel, C. Oates, R. Obermaisser,
5    M. Probst, S. Ring, E. Steiner, C. Thalinger, D. Thuernbeck,
6    P. Tomsich, J. Wenninger
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., 59 Temple Place - Suite 330, Boston, MA
23    02111-1307, USA.
24
25    Contact: cacao@complang.tuwien.ac.at
26
27    Authors: Christian Thalinger
28
29    $Id: codegen.inc.h 1621 2004-11-30 13:06:55Z twisti $
30
31 */
32
33
34 #ifndef _CODEGEN_INC_H
35 #define _CODEGEN_INC_H
36
37 /* We typedef these structures before #includes to resolve circular           */
38 /* dependencies.                                                              */
39
40 typedef struct codegendata codegendata;
41 typedef struct branchref branchref;
42 typedef struct jumpref jumpref;
43 typedef struct dataref dataref;
44 typedef struct clinitref clinitref;
45 typedef struct linenumberref linenumberref;
46 typedef struct threadcritnodetemp threadcritnodetemp;
47
48
49 #include "types.h"
50 #include "vm/global.h"
51 #include "vm/jit/reg.h"
52 #include "vm/jit/inline/inline.h"
53
54
55 #define MCODEINITSIZE (1<<15)       /* 32 Kbyte code area initialization size */
56 #define DSEGINITSIZE  (1<<12)       /*  4 Kbyte data area initialization size */
57
58 #if POINTERSIZE == 8
59 #define dseg_addaddress(cd,value)    dseg_adds8((cd), (s8) (value))
60 #else
61 #define dseg_addaddress(cd,value)    dseg_adds4((cd), (s4) (value))
62 #endif
63
64
65 /************************* critical sections  *********************************/
66
67 struct threadcritnodetemp {
68         threadcritnodetemp *next;
69         s4                  mcodebegin;
70         s4                  mcodeend;
71         s4                  mcoderestart;
72 };
73
74
75 struct codegendata {
76         u1             *mcodebase;      /* base pointer of code area              */
77         s4             *mcodeend;       /* pointer to end of code area            */
78         s4              mcodesize;      /* complete size of code area (bytes)     */
79
80 #if defined(__I386__) || defined(__X86_64__)
81         u1             *mcodeptr;       /* code generation pointer                */
82 #endif
83
84         u1             *dsegtop;        /* pointer to top (end) of data area      */
85         s4              dsegsize;       /* complete size of data area (bytes)     */
86         s4              dseglen;        /* used size of data area (bytes)         */
87                                     /* data area grows from top to bottom     */
88
89         jumpref        *jumpreferences; /* list of jumptable target addresses     */
90         dataref        *datareferences; /* list of data segment references        */
91         branchref      *xboundrefs;     /* list of bound check branches           */
92         branchref      *xcheckarefs;    /* list of array size check branches      */
93         branchref      *xnullrefs;      /* list of null check branches            */
94         branchref      *xcastrefs;      /* list of cast check branches            */
95         branchref      *xdivrefs;       /* list of divide by zero branches        */
96         branchref      *xexceptionrefs; /* list of exception branches             */
97         clinitref      *clinitrefs;
98
99         linenumberref  *linenumberreferences; /* list of line numbers and the     */
100                                         /* program counters of their first        */
101                                         /* instruction                            */
102         s4              linenumbertablesizepos;
103         s4              linenumbertablestartpos;
104         s4              linenumbertab;
105
106         methodinfo     *method;
107         s4              exceptiontablelength; /* exceptiontable length            */
108         exceptiontable *exceptiontable; /* the exceptiontable                     */
109
110         threadcritnodetemp *threadcrit; /* List of critical code regions          */
111         threadcritnodetemp threadcritcurrent;
112         s4                 threadcritcount; /* Number of critical regions         */
113
114         s4              maxstack;
115         s4              maxlocals;
116 };
117
118
119 /***************** forward references in branch instructions ******************/
120
121 struct branchref {
122         s4         branchpos;       /* patching position in code segment          */
123         s4         reg;             /* used for ArrayIndexOutOfBounds index reg   */
124         branchref *next;            /* next element in branchref list             */
125 };
126
127
128 /******************** forward references in tables  ***************************/
129
130 struct jumpref {
131         s4          tablepos;       /* patching position in data segment          */
132         basicblock *target;         /* target basic block                         */
133         jumpref    *next;           /* next element in jumpref list               */
134 };
135
136
137 struct dataref {
138         u1      *pos;               /* patching position in generated code        */
139         dataref *next;              /* next element in dataref list               */
140 };
141
142
143 struct clinitref {
144         s4         branchpos;
145         classinfo *class;
146         clinitref *next;
147 };
148
149
150 struct linenumberref {
151         s4             tablepos;    /* patching position in data segment          */
152         s4             targetmpc;   /* machine code program counter of first      */
153                                     /* instruction for given line                 */
154         u2             linenumber;  /* line number, used for inserting into the   */
155                                     /* table and for validty checking             */
156         linenumberref *next;        /* next element in linenumberref list         */
157 };
158
159
160 #if defined(__I386__) || defined(__X86_64__)
161 typedef struct _methodtree_element methodtree_element;
162
163 struct _methodtree_element {
164         functionptr startpc;
165         functionptr endpc;
166 };
167 #endif
168
169
170 /* function prototypes ********************************************************/
171
172 void codegen_init();
173 void codegen_setup(methodinfo *m, codegendata *cd, t_inlining_globals *e);
174 void codegen(methodinfo *m, codegendata *cd, registerdata *rd);
175 void codegen_free(methodinfo *m, codegendata *cd);
176 void codegen_close();
177 void codegen_insertmethod(functionptr startpc, functionptr endpc);
178
179 #if defined(__I386__) || defined(__X86_64__)
180 void codegen_addreference(codegendata *cd, struct basicblock *target, void *branchptr);
181 #endif
182
183 void dseg_display(methodinfo *m, codegendata *cd);
184
185 void init_exceptions();
186
187 #endif /* _CODEGEN_INC_H */
188
189
190 /*
191  * These are local overrides for various environment variables in Emacs.
192  * Please do not remove this and leave it at the end of the file, where
193  * Emacs will automagically detect them.
194  * ---------------------------------------------------------------------
195  * Local variables:
196  * mode: c
197  * indent-tabs-mode: t
198  * c-basic-offset: 4
199  * tab-width: 4
200  * End:
201  */