5 * Permission is hereby granted, free of charge, to any person obtaining a copy of
6 * this software and associated documentation files (the "Software"), to deal in
7 * the Software without restriction, including without limitation the rights to
8 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
9 * of the Software, and to permit persons to whom the Software is furnished to do
10 * so, subject to the following conditions:
12 * The above copyright notice and this permission notice shall be included in all
13 * copies or substantial portions of the Software.
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
38 typedef struct ir_value_s {
44 MEM_VECTOR_MAKE(struct ir_instr_s*, reads);
45 MEM_VECTOR_MAKE(struct ir_instr_s*, writes);
54 struct ir_value_s *vpointer;
57 /* For the temp allocator */
58 MEM_VECTOR_MAKE(ir_life_entry_t, life);
61 /* ir_value can be a variable, or created by an operation */
62 ir_value* ir_value_var(const char *name, int st, int vtype);
63 /* if a result of an operation: the function should store
64 * it to remember to delete it / garbage collect it
66 ir_value* ir_value_out(struct ir_function_s *owner, const char *name, int st, int vtype);
67 void ir_value_delete(ir_value*);
68 void ir_value_set_name(ir_value*, const char *name);
70 MEM_VECTOR_PROTO_ALL(ir_value, struct ir_instr_s*, reads)
71 MEM_VECTOR_PROTO_ALL(ir_value, struct ir_instr_s*, writes)
73 bool GMQCC_WARN ir_value_set_float(ir_value*, float f);
75 bool GMQCC_WARN ir_value_set_int(ir_value*, int i);
77 bool GMQCC_WARN ir_value_set_string(ir_value*, const char *s);
78 bool GMQCC_WARN ir_value_set_vector(ir_value*, vector_t v);
79 /*bool ir_value_set_pointer_v(ir_value*, ir_value* p); */
80 /*bool ir_value_set_pointer_i(ir_value*, int i); */
82 MEM_VECTOR_PROTO(ir_value, ir_life_entry_t, life)
83 /* merge an instruction into the life-range */
84 /* returns false if the lifepoint was already known */
85 bool ir_value_life_merge(ir_value*, size_t);
86 /* check if a value lives at a specific point */
87 bool ir_value_lives(ir_value*, size_t);
89 void ir_value_dump(ir_value*, int (*oprintf)(const char*,...));
90 void ir_value_dump_life(ir_value *self, int (*oprintf)(const char*,...));
92 typedef struct ir_phi_entry_s
95 struct ir_block_s *from;
99 typedef struct ir_instr_s
104 struct ir_block_s* (bops[2]);
106 MEM_VECTOR_MAKE(ir_phi_entry_t, phi);
108 /* For the temp-allocation */
111 struct ir_block_s *owner;
114 ir_instr* ir_instr_new(struct ir_block_s *owner, int opcode);
115 void ir_instr_delete(ir_instr*);
117 MEM_VECTOR_PROTO(ir_value, ir_phi_entry_t, phi)
118 bool GMQCC_WARN ir_instr_op(ir_instr*, int op, ir_value *value, bool writing);
120 void ir_instr_dump(ir_instr* in, char *ind, int (*oprintf)(const char*,...));
123 typedef struct ir_block_s
127 bool final; /* once a jump is added we're done */
129 MEM_VECTOR_MAKE(ir_instr*, instr);
130 MEM_VECTOR_MAKE(struct ir_block_s*, entries);
131 MEM_VECTOR_MAKE(struct ir_block_s*, exits);
132 MEM_VECTOR_MAKE(ir_value*, living);
134 /* For the temp-allocation */
139 struct ir_function_s *owner;
142 ir_block* ir_block_new(struct ir_function_s *owner, const char *label);
143 void ir_block_delete(ir_block*);
145 bool ir_block_set_label(ir_block*, const char *label);
147 MEM_VECTOR_PROTO(ir_block, ir_instr*, instr)
148 MEM_VECTOR_PROTO_ALL(ir_block, ir_block*, exits)
149 MEM_VECTOR_PROTO_ALL(ir_block, ir_block*, entries)
151 ir_value* ir_block_create_binop(ir_block*, const char *label, int op,
152 ir_value *left, ir_value *right);
153 bool GMQCC_WARN ir_block_create_store_op(ir_block*, int op, ir_value *target, ir_value *what);
154 bool GMQCC_WARN ir_block_create_store(ir_block*, ir_value *target, ir_value *what);
156 ir_value* ir_block_create_add(ir_block*, const char *label, ir_value *l, ir_value *r);
157 ir_value* ir_block_create_sub(ir_block*, const char *label, ir_value *l, ir_value *r);
158 ir_value* ir_block_create_mul(ir_block*, const char *label, ir_value *l, ir_value *r);
159 ir_value* ir_block_create_div(ir_block*, const char *label, ir_value *l, ir_value *r);
160 ir_instr* ir_block_create_phi(ir_block*, const char *label, int vtype);
161 ir_value* ir_phi_value(ir_instr*);
162 bool GMQCC_WARN ir_phi_add(ir_instr*, ir_block *b, ir_value *v);
164 bool GMQCC_WARN ir_block_create_return(ir_block*, ir_value *opt_value);
166 bool GMQCC_WARN ir_block_create_if(ir_block*, ir_value *cond,
167 ir_block *ontrue, ir_block *onfalse);
168 /* A 'goto' is an actual 'goto' coded in QC, whereas
169 * a 'jump' is a virtual construct which simply names the
170 * next block to go to.
171 * A goto usually becomes an OP_GOTO in the resulting code,
172 * whereas a 'jump' usually doesn't add any actual instruction.
174 bool GMQCC_WARN ir_block_create_jump(ir_block*, ir_block *to);
175 bool GMQCC_WARN ir_block_create_goto(ir_block*, ir_block *to);
177 MEM_VECTOR_PROTO_ALL(ir_block, ir_value*, living)
179 void ir_block_dump(ir_block*, char *ind, int (*oprintf)(const char*,...));
183 typedef struct ir_function_s
187 MEM_VECTOR_MAKE(int, params);
188 MEM_VECTOR_MAKE(ir_block*, blocks);
190 /* values generated from operations
191 * which might get optimized away, so anything
192 * in there needs to be deleted in the dtor.
194 MEM_VECTOR_MAKE(ir_value*, values);
196 /* locally defined variables */
197 MEM_VECTOR_MAKE(ir_value*, locals);
204 /* for temp allocation */
207 struct ir_builder_s *owner;
210 ir_function* ir_function_new(struct ir_builder_s *owner);
211 void ir_function_delete(ir_function*);
213 bool GMQCC_WARN ir_function_collect_value(ir_function*, ir_value *value);
215 bool ir_function_set_name(ir_function*, const char *name);
216 MEM_VECTOR_PROTO(ir_function, int, params)
217 MEM_VECTOR_PROTO(ir_function, ir_block*, blocks)
219 ir_value* ir_function_get_local(ir_function *self, const char *name);
220 ir_value* ir_function_create_local(ir_function *self, const char *name, int vtype);
222 bool GMQCC_WARN ir_function_finalize(ir_function*);
224 bool ir_function_naive_phi(ir_function*);
225 bool ir_function_enumerate(ir_function*);
226 bool ir_function_calculate_liferanges(ir_function*);
229 ir_block* ir_function_create_block(ir_function*, const char *label);
231 void ir_function_dump(ir_function*, char *ind, int (*oprintf)(const char*,...));
234 typedef struct ir_builder_s
237 MEM_VECTOR_MAKE(ir_function*, functions);
238 MEM_VECTOR_MAKE(ir_value*, globals);
241 ir_builder* ir_builder_new(const char *modulename);
242 void ir_builder_delete(ir_builder*);
244 bool ir_builder_set_name(ir_builder *self, const char *name);
246 MEM_VECTOR_PROTO(ir_builder, ir_function*, functions)
247 MEM_VECTOR_PROTO(ir_builder, ir_value*, globals)
249 ir_function* ir_builder_get_function(ir_builder*, const char *fun);
250 ir_function* ir_builder_create_function(ir_builder*, const char *name);
252 ir_value* ir_builder_get_global(ir_builder*, const char *fun);
253 ir_value* ir_builder_create_global(ir_builder*, const char *name, int vtype);
255 void ir_builder_dump(ir_builder*, int (*oprintf)(const char*, ...));