fd46f72c6748c03298567e3ae43d3cbb26b1ba91
[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    $Id$
26
27 */
28
29
30 #ifndef _CODE_H
31 #define _CODE_H
32
33 /* forward typedefs ***********************************************************/
34
35 #include "config.h"
36 #include "vm/types.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         /* replacement */                                   
77 #if defined(ENABLE_REPLACEMENT)
78         rplpoint     *rplpoints;            /* replacement points                 */
79         rplalloc     *regalloc;             /* register allocation info           */
80         u1           *replacementstubs;     /* beginning of replacement stubs     */
81         s4            rplpointcount;        /* number of replacement points       */
82         s4            globalcount;          /* number of global allocations       */
83         s4            regalloccount;        /* number of total allocations        */
84         s4            memuse;               /* number of arg + local slots        */
85         s4            stackframesize;       /* size of the stackframe in slots    */
86         u1            savedintcount;        /* number of callee saved int regs    */
87         u1            savedfltcount;        /* number of callee saved flt regs    */
88         u1           *savedmcode;           /* saved code under patches           */
89 #endif
90
91 #if defined(ENABLE_PROFILING)
92         u4            frequency;            /* number of method invocations       */
93         u4           *bbfrequency;                  
94         s8            cycles;               /* number of cpu cycles               */
95 #endif
96 };
97
98
99 /* macros *********************************************************************/
100
101 #define CODE_IS_VALID(code)       (!((code)->codeflags & CODE_FLAG_INVALID))
102 #define CODE_IS_INVALID(code)     ((code)->codeflags & CODE_FLAG_INVALID)
103 #define CODE_IS_LEAFMETHOD(code)  ((code)->codeflags & CODE_FLAG_LEAFMETHOD)
104
105 #define CODE_SETFLAG_INVALID(code)                                   \
106             ((code)->codeflags |= CODE_FLAG_INVALID)
107 #define CODE_SETFLAG_LEAFMETHOD(code)                                \
108             ((code)->codeflags |= CODE_FLAG_LEAFMETHOD)
109
110
111 /* function prototypes ********************************************************/
112
113 bool code_init(void);
114
115 codeinfo *code_codeinfo_new(methodinfo *m);
116 void code_codeinfo_free(codeinfo *code);
117
118 codeinfo *code_find_codeinfo_for_pc(u1 *pc);
119 codeinfo *code_find_codeinfo_for_pc_nocheck(u1 *pc);
120
121 methodinfo *code_get_methodinfo_for_pv(u1 *pv);
122
123 #if defined(ENABLE_REPLACEMENT)
124 int code_get_sync_slot_count(codeinfo *code);
125 int code_get_stack_frame_size(codeinfo *code);
126 #endif /* defined(ENABLE_REPLACEMENT) */
127
128 void code_free_code_of_method(methodinfo *m);
129
130 #endif /* _CODE_H */
131
132
133 /*
134  * These are local overrides for various environment variables in Emacs.
135  * Please do not remove this and leave it at the end of the file, where
136  * Emacs will automagically detect them.
137  * ---------------------------------------------------------------------
138  * Local variables:
139  * mode: c
140  * indent-tabs-mode: t
141  * c-basic-offset: 4
142  * tab-width: 4
143  * End:
144  * vim:noexpandtab:sw=4:ts=4:
145  */