* Merged with default branch at rev 16f3633aaa5a.
[cacao.git] / src / vm / jit / code.h
1 /* src/vm/jit/code.h - codeinfo struct for representing compiled code
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 */
26
27
28 #ifndef _CODE_H
29 #define _CODE_H
30
31 /* forward typedefs ***********************************************************/
32
33 #include "config.h"
34 #include "vm/types.h"
35
36 #include "toolbox/list.h"
37
38 #include "vm/global.h"
39
40 #include "vm/jit/replace.h"
41
42 #include "vmcore/method.h"
43
44
45 /* constants ******************************************************************/
46
47 #define CODE_FLAG_INVALID     0x0001
48 #define CODE_FLAG_LEAFMETHOD  0x0002
49
50
51 /* codeinfo *******************************************************************
52
53    A codeinfo represents a particular realization of a method in
54    machine code.
55
56    ATTENTION: The methodinfo entry in the code-structure MUST have the
57    offset 0, otherwise we have a problem in our compiler stub. This is
58    checked with an assert in code_init().
59
60 *******************************************************************************/
61
62 struct codeinfo {
63         methodinfo   *m;                    /* method this is a realization of    */
64         codeinfo     *prev;                 /* previous codeinfo of this method   */
65
66         u4            codeflags;            /* or of CODE_FLAG_ constants         */
67
68         u1            optlevel;             /* optimization level of this code    */
69         s4            basicblockcount;      /* number of basic blocks             */
70
71         /* machine code */
72         u1           *mcode;                /* pointer to machine code            */
73         u1           *entrypoint;           /* machine code entry point           */
74         s4            mcodelength;          /* length of generated machine code   */
75
76         /* patcher list */
77         list_t       *patchers;
78
79         /* replacement */                                   
80 #if defined(ENABLE_REPLACEMENT)
81         rplpoint     *rplpoints;            /* replacement points                 */
82         rplalloc     *regalloc;             /* register allocation info           */
83         s4            rplpointcount;        /* number of replacement points       */
84         s4            globalcount;          /* number of global allocations       */
85         s4            regalloccount;        /* number of total allocations        */
86         s4            memuse;               /* number of arg + local slots        */
87         s4            stackframesize;       /* size of the stackframe in slots    */
88         u1            savedintcount;        /* number of callee saved int regs    */
89         u1            savedfltcount;        /* number of callee saved flt regs    */
90 # if defined(HAS_ADDRESS_REGISTER_FILE)
91         u1            savedadrcount;        /* number of callee saved adr regs    */
92 # endif
93         u1           *savedmcode;           /* saved code under patches           */
94 #endif
95
96 #if defined(ENABLE_PROFILING)
97         u4            frequency;            /* number of method invocations       */
98         u4           *bbfrequency;                  
99         s8            cycles;               /* number of cpu cycles               */
100 #endif
101 };
102
103
104 /* macros *********************************************************************/
105
106 #define CODE_IS_VALID(code)       (!((code)->codeflags & CODE_FLAG_INVALID))
107 #define CODE_IS_INVALID(code)     ((code)->codeflags & CODE_FLAG_INVALID)
108 #define CODE_IS_LEAFMETHOD(code)  ((code)->codeflags & CODE_FLAG_LEAFMETHOD)
109
110 #define CODE_SETFLAG_INVALID(code)                                   \
111             ((code)->codeflags |= CODE_FLAG_INVALID)
112 #define CODE_SETFLAG_LEAFMETHOD(code)                                \
113             ((code)->codeflags |= CODE_FLAG_LEAFMETHOD)
114
115
116 /* function prototypes ********************************************************/
117
118 bool code_init(void);
119
120 codeinfo *code_codeinfo_new(methodinfo *m);
121 void code_codeinfo_free(codeinfo *code);
122
123 codeinfo *code_find_codeinfo_for_pc(u1 *pc);
124 codeinfo *code_find_codeinfo_for_pc_nocheck(u1 *pc);
125
126 methodinfo *code_get_methodinfo_for_pv(u1 *pv);
127
128 #if defined(ENABLE_REPLACEMENT)
129 int code_get_sync_slot_count(codeinfo *code);
130 #endif /* defined(ENABLE_REPLACEMENT) */
131
132 void code_free_code_of_method(methodinfo *m);
133
134 #endif /* _CODE_H */
135
136
137 /*
138  * These are local overrides for various environment variables in Emacs.
139  * Please do not remove this and leave it at the end of the file, where
140  * Emacs will automagically detect them.
141  * ---------------------------------------------------------------------
142  * Local variables:
143  * mode: c
144  * indent-tabs-mode: t
145  * c-basic-offset: 4
146  * tab-width: 4
147  * End:
148  * vim:noexpandtab:sw=4:ts=4:
149  */