6 * Type large enough to hold all the possible IR flags. This should be
7 * changed if the static assertion at the end of this file fails.
9 typedef uint8_t ir_flag_t;
17 struct ir_life_entry_t {
24 IR_FLAG_HAS_ARRAYS = 1 << 0,
25 IR_FLAG_HAS_UNINITIALIZED = 1 << 1,
26 IR_FLAG_HAS_GOTO = 1 << 2,
27 IR_FLAG_INCLUDE_DEF = 1 << 3,
28 IR_FLAG_ERASABLE = 1 << 4,
29 IR_FLAG_BLOCK_COVERAGE = 1 << 5,
30 IR_FLAG_NOREF = 1 << 6,
31 IR_FLAG_SPLIT_VECTOR = 1 << 7,
34 IR_FLAG_MASK_NO_OVERLAP = (IR_FLAG_HAS_ARRAYS | IR_FLAG_HAS_UNINITIALIZED),
35 IR_FLAG_MASK_NO_LOCAL_TEMPS = (IR_FLAG_HAS_ARRAYS | IR_FLAG_HAS_UNINITIALIZED)
39 ir_value(std::string&& name, store_type storetype, qc_type vtype);
40 ir_value(ir_function *owner, std::string&& name, store_type storetype, qc_type vtype);
43 ir_value *vectorMember(unsigned int member);
45 bool GMQCC_WARN setFloat(float);
46 bool GMQCC_WARN setFunc(int);
47 bool GMQCC_WARN setString(const char*);
48 bool GMQCC_WARN setVector(vec3_t);
49 bool GMQCC_WARN setField(ir_value*);
51 bool GMQCC_WARN setInt(int);
54 bool lives(size_t at);
55 void dumpLife(int (*oprintf)(const char*, ...)) const;
57 void setCodeAddress(int32_t gaddr);
58 int32_t codeAddress() const;
60 bool insertLife(size_t idx, ir_life_entry_t);
61 bool setAlive(size_t position);
62 bool mergeLife(const ir_value *other);
69 qc_type m_fieldtype; // even the IR knows the subtype of a field
70 qc_type m_outtype; // and the output type of a function
71 int m_cvq; // 'const' vs 'var' qualifier
74 std::vector<ir_instr *> m_reads;
75 std::vector<ir_instr *> m_writes;
92 int32_t local; // filled by the local-allocator
93 int32_t addroffset; // added for members
94 int32_t fieldaddr; // to generate field-addresses early
97 // for accessing vectors
98 ir_value *m_members[3];
101 bool m_unique_life; // arrays will never overlap with temps
102 bool m_locked; // temps living during a CALL must be locked
105 std::vector<ir_life_entry_t> m_life; // For the temp allocator
109 void dump(int (*oprintf)(const char*, ...)) const;
113 struct ir_phi_entry_t {
120 ir_instr(lex_ctx_t, ir_block *owner, int opcode);
125 ir_value *(_m_ops[3]) = { nullptr, nullptr, nullptr };
126 ir_block *(m_bops[2]) = { nullptr, nullptr };
128 std::vector<ir_phi_entry_t> m_phi;
129 std::vector<ir_value *> m_params;
131 // For the temp-allocation
135 bool m_likely = true;
142 ir_block(ir_function *owner, const std::string& name);
145 ir_function *m_owner;
149 bool m_final = false; /* once a jump is added we're done */
151 std::vector<ir_instr *> m_instr;
152 std::vector<ir_block *> m_entries;
153 std::vector<ir_block *> m_exits;
154 std::vector<ir_value *> m_living;
156 /* For the temp-allocation */
157 size_t m_entry_id = 0;
159 bool m_is_return = false;
161 bool m_generated = false;
162 size_t m_code_start = 0;
165 ir_value* ir_block_create_binop(ir_block*, lex_ctx_t, const char *label, int op, ir_value *left, ir_value *right);
166 ir_value* ir_block_create_unary(ir_block*, lex_ctx_t, const char *label, int op, ir_value *operand);
167 bool GMQCC_WARN ir_block_create_store_op(ir_block*, lex_ctx_t, int op, ir_value *target, ir_value *what);
168 bool GMQCC_WARN ir_block_create_storep(ir_block*, lex_ctx_t, ir_value *target, ir_value *what);
169 ir_value* ir_block_create_load_from_ent(ir_block*, lex_ctx_t, const char *label, ir_value *ent, ir_value *field, qc_type outype);
170 ir_value* ir_block_create_fieldaddress(ir_block*, lex_ctx_t, const char *label, ir_value *entity, ir_value *field);
171 bool GMQCC_WARN ir_block_create_state_op(ir_block*, lex_ctx_t, ir_value *frame, ir_value *think);
173 /* This is to create an instruction of the form
174 * <outtype>%label := opcode a, b
176 ir_instr* ir_block_create_phi(ir_block*, lex_ctx_t, const char *label, qc_type vtype);
177 ir_value* ir_phi_value(ir_instr*);
178 void ir_phi_add(ir_instr*, ir_block *b, ir_value *v);
179 ir_instr* ir_block_create_call(ir_block*, lex_ctx_t, const char *label, ir_value *func, bool noreturn);
180 ir_value* ir_call_value(ir_instr*);
181 void ir_call_param(ir_instr*, ir_value*);
183 bool GMQCC_WARN ir_block_create_return(ir_block*, lex_ctx_t, ir_value *opt_value);
185 bool GMQCC_WARN ir_block_create_if(ir_block*, lex_ctx_t, ir_value *cond,
186 ir_block *ontrue, ir_block *onfalse);
188 * A 'goto' is an actual 'goto' coded in QC, whereas
189 * a 'jump' is a virtual construct which simply names the
190 * next block to go to.
191 * A goto usually becomes an OP_GOTO in the resulting code,
192 * whereas a 'jump' usually doesn't add any actual instruction.
194 bool GMQCC_WARN ir_block_create_jump(ir_block*, lex_ctx_t, ir_block *to);
195 bool GMQCC_WARN ir_block_create_goto(ir_block*, lex_ctx_t, ir_block *to);
199 ir_function(ir_builder *owner, qc_type returntype);
206 std::vector<int> m_params;
207 ir_flag_t m_flags = 0;
210 std::vector<std::unique_ptr<ir_block>> m_blocks;
213 * values generated from operations
214 * which might get optimized away, so anything
215 * in there needs to be deleted in the dtor.
217 std::vector<std::unique_ptr<ir_value>> m_values;
218 std::vector<std::unique_ptr<ir_value>> m_locals; /* locally defined variables */
219 ir_value *m_value = nullptr;
221 size_t m_allocated_locals = 0;
222 size_t m_globaltemps = 0;
224 ir_block* m_first = nullptr;
225 ir_block* m_last = nullptr;
230 * for prototypes - first we generate all the
231 * globals, and we remember teh function-defs
232 * so we can later fill in the entry pos
236 qcint_t m_code_function_def = -1;
238 /* for temp allocation */
241 /* vararg support: */
242 size_t m_max_varargs = 0;
246 ir_value* ir_function_create_local(ir_function *self, const std::string& name, qc_type vtype, bool param);
247 bool GMQCC_WARN ir_function_finalize(ir_function*);
248 ir_block* ir_function_create_block(lex_ctx_t ctx, ir_function*, const char *label);
251 #define IR_HT_SIZE 1024
252 #define IR_MAX_VINSTR_TEMPS 2
255 ir_builder(const std::string& modulename);
258 ir_function *createFunction(const std::string &name, qc_type outtype);
259 ir_value *createGlobal(const std::string &name, qc_type vtype);
260 ir_value *createField(const std::string &name, qc_type vtype);
261 ir_value *get_va_count();
262 bool generate(const char *filename);
263 void dump(int (*oprintf)(const char*, ...)) const;
265 ir_value *generateExtparamProto();
266 void generateExtparam();
268 ir_value *literalFloat(float value, bool add_to_list);
271 std::vector<std::unique_ptr<ir_function>> m_functions;
272 std::vector<std::unique_ptr<ir_value>> m_globals;
273 std::vector<std::unique_ptr<ir_value>> m_fields;
274 // for reusing them in vector-splits, TODO: sort this or use a radix-tree
275 std::vector<ir_value*> m_const_floats;
281 // extparams' ir_values reference the ones from extparam_protos
282 std::vector<std::unique_ptr<ir_value>> m_extparam_protos;
283 std::vector<ir_value*> m_extparams;
285 // the highest func->allocated_locals
286 size_t m_max_locals = 0;
287 size_t m_max_globaltemps = 0;
288 uint32_t m_first_common_local = 0;
289 uint32_t m_first_common_globaltemp = 0;
291 std::vector<const char*> m_filenames;
292 std::vector<qcint_t> m_filestrings;
294 // we cache the #IMMEDIATE string here
295 qcint_t m_str_immediate = 0;
297 // there should just be this one nil
299 ir_value *m_reserved_va_count = nullptr;
300 ir_value *m_coverage_func = nullptr;
302 /* some virtual instructions require temps, and their code is isolated
303 * so that we don't need to keep track of their liveness.
305 ir_value *m_vinstr_temp[IR_MAX_VINSTR_TEMPS];
308 std::unique_ptr<code_t> m_code;
311 qcint_t filestring(const char *filename);
312 bool generateGlobal(ir_value*, bool is_local);
313 bool generateGlobalFunction(ir_value*);
314 bool generateGlobalFunctionCode(ir_value*);
315 bool generateFunctionLocals(ir_value*);
319 * This code assumes 32 bit floats while generating binary
320 * Blub: don't use extern here, it's annoying and shows up in nm
323 typedef int static_assert_is_32bit_float [(sizeof(int32_t) == 4) ? 1 : -1];
324 typedef int static_assert_is_32bit_integer[(sizeof(qcfloat_t) == 4) ? 1 : -1];
327 * If the condition creates a situation where this becomes -1 size it means there are
328 * more IR_FLAGs than the type ir_flag_t is capable of holding. So either eliminate
329 * the IR flag count or change the ir_flag_t typedef to a type large enough to accomodate
332 typedef int static_assert_is_ir_flag_safe [((IR_FLAG_LAST) <= (ir_flag_t)(-1)) ? 1 : -1];