- moved architecture stuff into arch.h
[cacao.git] / 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 1565 2004-11-23 15:56:37Z 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 "global.h"
51 #include "jit/inline.h"
52 #include "jit/reg.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         u1 *mcodeptr;                   /* code generation pointer                */
81
82         u1 *dsegtop;                    /* pointer to top (end) of data area      */
83         s4  dsegsize;                   /* complete size of data area (bytes)     */
84         s4  dseglen;                    /* used size of data area (bytes)         */
85                                     /* data area grows from top to bottom     */
86
87         jumpref   *jumpreferences;      /* list of jumptable target addresses     */
88         dataref   *datareferences;      /* list of data segment references        */
89         branchref *xboundrefs;          /* list of bound check branches           */
90         branchref *xcheckarefs;         /* list of array size check branches      */
91         branchref *xnullrefs;           /* list of null check branches            */
92         branchref *xcastrefs;           /* list of cast check branches            */
93         branchref *xdivrefs;            /* list of divide by zero branches        */
94         branchref *xexceptionrefs;      /* list of exception branches             */
95         clinitref *clinitrefs;
96
97         linenumberref *linenumberreferences; /* list of line numbers and the      */
98                                         /* program counters of their first        */
99                                         /* instruction                            */
100         s4 linenumbertablesizepos;
101         s4 linenumbertablestartpos;
102         s4 linenumbertab;
103
104         methodinfo *method;
105         s4  exceptiontablelength;/* exceptiontable length                  */
106         exceptiontable *exceptiontable; /* the exceptiontable                     */
107
108         threadcritnodetemp *threadcrit; /* List of critical code regions          */
109         threadcritnodetemp threadcritcurrent;
110         s4 threadcritcount;             /* Number of critical regions             */
111         int maxstack;
112         int maxlocals;
113 };
114
115
116 /***************** forward references in branch instructions ******************/
117
118 struct branchref {
119         s4 branchpos;               /* patching position in code segment          */
120         s4 reg;                     /* used for ArrayIndexOutOfBounds index reg   */
121         branchref *next;            /* next element in branchref list             */
122 };
123
124
125 /******************** forward references in tables  ***************************/
126
127 struct jumpref {
128         s4 tablepos;                /* patching position in data segment          */
129         struct basicblock *target;  /* target basic block                         */
130         jumpref *next;              /* next element in jumpref list               */
131 };
132
133
134 struct dataref {
135         u1 *pos;                    /* patching position in generated code        */
136         dataref *next;              /* next element in dataref list               */
137 };
138
139
140 struct clinitref {
141         s4         branchpos;
142         classinfo *class;
143         u4         mcode;
144 #if defined(__I386__) || defined(__X86_64__)
145         u1         xmcode;
146         u1        *mcodeptr;        /* codegendata dummy pointer to generate code */
147 #endif
148         clinitref *next;
149 };
150
151
152 struct linenumberref {
153         s4 tablepos;                /* patching position in data segment          */
154         int targetmpc;              /* machine code program counter of first      */
155                                     /* instruction for given line                 */
156         u2 linenumber;              /* line number, used for inserting into the   */
157                                     /* table and for validty checking             */
158         linenumberref *next;        /* next element in linenumberref list         */
159 };
160
161
162 #if defined(__I386__) || defined(__X86_64__)
163 typedef struct _methodtree_element methodtree_element;
164
165 struct _methodtree_element {
166         functionptr startpc;
167         functionptr endpc;
168 };
169 #endif
170
171
172 /* function prototypes */
173
174 void codegen_init();
175 void codegen_setup(methodinfo *m, codegendata *cd, t_inlining_globals *e);
176 void codegen(methodinfo *m, codegendata *cd, registerdata *rd);
177 void codegen_free(methodinfo *m, codegendata *cd);
178 void codegen_close();
179 void codegen_insertmethod(functionptr startpc, functionptr endpc);
180
181 #if defined(__I386__) || defined(__X86_64__)
182 void codegen_addreference(codegendata *cd, struct basicblock *target, void *branchptr);
183 #endif
184
185 void dseg_display(methodinfo *m, codegendata *cd);
186
187 void init_exceptions();
188
189 #endif /* _CODEGEN_INC_H */
190
191
192 /*
193  * These are local overrides for various environment variables in Emacs.
194  * Please do not remove this and leave it at the end of the file, where
195  * Emacs will automagically detect them.
196  * ---------------------------------------------------------------------
197  * Local variables:
198  * mode: c
199  * indent-tabs-mode: t
200  * c-basic-offset: 4
201  * tab-width: 4
202  * End:
203  */