tok: ignore "\\\n"
[neatcc/cc.git] / gen.h
blobdf4605bd8b1ac0687191060a9471d7f67f0869d0
1 #define SECSIZE (1 << 18)
2 #define MAXTMP (1 << 12)
4 /* basic types */
5 #define BT_SZMASK 0x00ff
6 #define BT_SIGNED 0x0100
7 #define BT_SZ(bt) ((bt) & BT_SZMASK)
9 #define O_SIGNED 0x100
10 /* binary instructions for o_bop() */
11 #define O_ADD 0x00
12 #define O_SUB 0x01
13 #define O_AND 0x02
14 #define O_OR 0x03
15 #define O_XOR 0x04
16 #define O_SHL 0x10
17 #define O_SHR 0x11
18 #define O_MUL 0x20
19 #define O_DIV 0x21
20 #define O_MOD 0x22
21 #define O_LT 0x30
22 #define O_GT 0x31
23 #define O_LE 0x32
24 #define O_GE 0x33
25 #define O_EQ 0x34
26 #define O_NEQ 0x35
27 /* unary instructions for o_uop() */
28 #define O_NEG 0x40
29 #define O_NOT 0x41
30 #define O_LNOT 0x42
32 /* operations */
33 void o_bop(int op);
34 void o_uop(int op);
35 void o_cast(unsigned bt);
36 void o_memcpy(void);
37 void o_memset(void);
38 void o_call(int argc, int ret);
39 void o_ret(int ret);
40 void o_assign(unsigned bt);
41 void o_deref(unsigned bt);
42 void o_load(void);
43 int o_popnum(long *c);
44 /* pushing values */
45 void o_num(long n);
46 void o_local(long addr);
47 void o_sym(char *sym);
48 void o_tmpdrop(int n);
49 void o_tmpswap(void);
50 void o_tmpcopy(void);
51 /* handling locals */
52 long o_mklocal(int size);
53 void o_rmlocal(long addr, int sz);
54 long o_arg2loc(int i);
55 /* branches */
56 void o_label(int id);
57 void o_jmp(int id);
58 void o_jz(int id);
59 void o_jnz(int id);
60 /* conditional instructions */
61 void o_fork(void);
62 void o_forkpush(void);
63 void o_forkjoin(void);
64 /* data/bss sections */
65 void o_mkbss(char *name, int size, int global);
66 void *o_mkdat(char *name, int size, int global);
67 void o_datset(char *name, int off, unsigned bt);
68 /* functions */
69 void o_func_beg(char *name, int argc, int global, int vararg);
70 void o_func_end(void);
71 /* output */
72 void o_write(int fd);
73 /* passes */
74 void o_pass1(void);
75 void o_pass2(void);
78 * neatcc architecture-dependent code-generation interface
80 * To make maintaining three different architectures easier and unifying the
81 * optimization patch, I've extracted gen.c from x86.c and arm.c. The i_*()
82 * functions are now the low level architecture-specific code generation
83 * entry points. The differences between RISC and CISC architectures,
84 * actually the annoying asymmetry in CISC architecture, made this interface
85 * a bit more complex than it could have ideally been. Nevertheless, the
86 * benefits of extracting gen.c and the cleaner design, specially with the
87 * presence of the optimization patch, is worth the added complexity.
89 * I tried to make the interface as small as possible. I'll describe the
90 * key functions and macros here. Overall, there were many challenges for
91 * extracting gen.c including:
92 * + Different register sets; caller/callee saved and argument registers
93 * + CISC-style instructions that work on limited registers and parameters
94 * + Different instruction formats and immediate value limitations
95 * + Producing epilog, prolog, and local variable addresses when optimizing
97 * Instructions:
98 * + i_reg(): The mask of allowed registers for each operand of an instruction.
99 * If md is zero, we assume the destination register should be equal to the
100 * first register, as in CISC architectures. m2 can be zero which means
101 * the instruction doesn't have three operands. mt denotes the mask of
102 * registers that may lose their contents after the instruction.
103 * + i_load(), i_save(), i_mov(), i_num(), i_sym(): The name is clear.
104 * + i_imm(): Specifies if the given immediate can be encoded for the given
105 * instruction.
106 * + i_jmp(), i_fill(): Branching instructions. If rn >= 0, the branch is
107 * a conditional branch: jump only the register rn is zero (or nonzero if
108 * jc is nonzero). nbytes specifies the number of bytes necessary for
109 * holding the jump distance; useful if the architecture supports short
110 * branching instructions. i_fill() actually fills the jump at src in
111 * code segment. It returns the amount of bytes jumped.
112 * + i_args(): The offset of the first argument from the frame pointer.
113 * It is probably positive.
114 * + i_args(): The offset of the first local from the frame pointer.
115 * It is probably negative
116 * + tmpregs: Register that can be used for holding temporaries.
117 * + argregs: Register for holding the first N_ARGS arguments.
119 * There are a few other macros defined in arch headers. See x64.h as
120 * an example.
123 #ifdef NEATCC_ARM
124 #include "arm.h"
125 #endif
126 #ifdef NEATCC_X64
127 #include "x64.h"
128 #endif
129 #ifdef NEATCC_X86
130 #include "x86.h"
131 #endif
133 /* intermediate instructions */
134 #define O_IMM 0x200 /* mask for immediate instructions */
135 #define O_MSET 0x51 /* memset() */
136 #define O_MCPY 0x52 /* memcpy() */
137 #define O_MOV 0x53 /* mov */
138 #define O_SX 0x54 /* sign extend */
139 #define O_ZX 0x55 /* zero extend */
141 void i_load(int rd, int rn, int off, int bt);
142 void i_save(int rd, int rn, int off, int bt);
143 void i_mov(int rd, int rn);
144 void i_reg(int op, int *md, int *m1, int *m2, int *mt);
145 void i_op(int op, int rd, int r1, int r2);
146 int i_imm(int op, long imm);
147 void i_op_imm(int op, int rd, int r1, long n);
149 void i_num(int rd, long n);
150 void i_sym(int rd, char *sym, int off);
152 void i_jmp(int rn, int jc, int nbytes);
153 long i_fill(long src, long dst, int nbytes);
155 void i_call(char *sym, int off);
156 void i_call_reg(int rd);
157 void i_memset(int r0, int r1, int r2);
158 void i_memcpy(int r0, int r1, int r2);
160 int i_args(void); /* the address of the first arg relative to fp */
161 int i_sp(void); /* the address of the first local relative to fp */
163 void i_prolog(int argc, int varg, int sargs, int sregs, int initfp, int subsp);
164 void i_epilog(int sp_max);
165 void i_done(void);
167 extern int tmpregs[];
168 extern int argregs[];
170 /* code segment text */
171 extern char cs[]; /* code segment */
172 extern int cslen; /* code segment length */
173 extern int pass1; /* first pass */
175 void os(void *s, int n);
176 void oi(long n, int l);