-/*
- * Copyright (C) 2012, 2013
- * Wolfgang Bumiller
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy of
- * this software and associated documentation files (the "Software"), to deal in
- * the Software without restriction, including without limitation the rights to
- * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
- * of the Software, and to permit persons to whom the Software is furnished to do
- * so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- */
#ifndef GMQCC_IR_HDR
#define GMQCC_IR_HDR
#include "gmqcc.h"
-/* ir_value */
-typedef struct
-{
+/*
+ * Type large enough to hold all the possible IR flags. This should be
+ * changed if the static assertion at the end of this file fails.
+ */
+typedef uint8_t ir_flag_t;
+
+struct ir_value;
+struct ir_instr;
+struct ir_block;
+struct ir_function;
+struct ir_builder;
+
+struct ir_life_entry_t {
/* both inclusive */
size_t start;
size_t end;
-} ir_life_entry_t;
-
-struct ir_function_s;
-typedef struct ir_value_s {
- char *name;
- int vtype;
- int store;
- lex_ctx context;
- /* even the IR knows the subtype of a field */
- int fieldtype;
- /* and the output type of a function */
- int outtype;
- /* 'const' vs 'var' qualifier */
- int cvq;
-
- struct ir_instr_s **reads;
- struct ir_instr_s **writes;
-
- /* constantvalues */
- bool hasvalue;
- union {
- float vfloat;
- int vint;
- vector vvec;
- int32_t ivec[3];
- char *vstring;
- struct ir_value_s *vpointer;
- struct ir_function_s *vfunc;
- } constval;
+};
+
+enum {
+ IR_FLAG_HAS_ARRAYS = 1 << 0,
+ IR_FLAG_HAS_UNINITIALIZED = 1 << 1,
+ IR_FLAG_HAS_GOTO = 1 << 2,
+ IR_FLAG_INCLUDE_DEF = 1 << 3,
+ IR_FLAG_ERASABLE = 1 << 4,
+ IR_FLAG_BLOCK_COVERAGE = 1 << 5,
+ IR_FLAG_NOREF = 1 << 6,
+ IR_FLAG_SPLIT_VECTOR = 1 << 7,
+
+ IR_FLAG_LAST,
+ IR_FLAG_MASK_NO_OVERLAP = (IR_FLAG_HAS_ARRAYS | IR_FLAG_HAS_UNINITIALIZED),
+ IR_FLAG_MASK_NO_LOCAL_TEMPS = (IR_FLAG_HAS_ARRAYS | IR_FLAG_HAS_UNINITIALIZED)
+};
+
+struct ir_value {
+ ir_value(std::string&& name, store_type storetype, qc_type vtype);
+ ir_value(ir_function *owner, std::string&& name, store_type storetype, qc_type vtype);
+ ~ir_value();
+
+ ir_value *vectorMember(unsigned int member);
+
+ bool GMQCC_WARN setFloat(float);
+ bool GMQCC_WARN setFunc(int);
+ bool GMQCC_WARN setString(const char*);
+ bool GMQCC_WARN setVector(vec3_t);
+ bool GMQCC_WARN setField(ir_value*);
+#if 0
+ bool GMQCC_WARN setInt(int);
+#endif
- struct {
- int32_t globaladdr;
- int32_t name;
- /* filled by the local-allocator */
- int32_t local;
- /* added for members */
- int32_t addroffset;
- /* to generate field-addresses early */
- int32_t fieldaddr;
- } code;
-
- /* for acessing vectors */
- struct ir_value_s *members[3];
- struct ir_value_s *memberof;
-
- /* arrays will never overlap with temps */
- bool unique_life;
- /* temps living during a CALL must be locked */
- bool locked;
- bool callparam;
-
- /* For the temp allocator */
- ir_life_entry_t *life;
-} ir_value;
-
-int32_t ir_value_code_addr(const ir_value*);
-
-/* ir_value can be a variable, or created by an operation */
-ir_value* ir_value_var(const char *name, int st, int vtype);
-/* if a result of an operation: the function should store
- * it to remember to delete it / garbage collect it
- */
-ir_value* ir_value_out(struct ir_function_s *owner, const char *name, int st, int vtype);
-void ir_value_delete(ir_value*);
-bool ir_value_set_name(ir_value*, const char *name);
-ir_value* ir_value_vector_member(ir_value*, unsigned int member);
+ bool lives(size_t at);
+ void dumpLife(int (*oprintf)(const char*, ...)) const;
-bool GMQCC_WARN vec_ir_value_find(ir_value **vec, const ir_value *what, size_t *idx);
+ void setCodeAddress(int32_t gaddr);
+ int32_t codeAddress() const;
-bool GMQCC_WARN ir_value_set_float(ir_value*, float f);
-bool GMQCC_WARN ir_value_set_func(ir_value*, int f);
-#if 0
-bool GMQCC_WARN ir_value_set_int(ir_value*, int i);
-#endif
-bool GMQCC_WARN ir_value_set_string(ir_value*, const char *s);
-bool GMQCC_WARN ir_value_set_vector(ir_value*, vector v);
-bool GMQCC_WARN ir_value_set_field(ir_value*, ir_value *fld);
-/*bool ir_value_set_pointer_v(ir_value*, ir_value* p); */
-/*bool ir_value_set_pointer_i(ir_value*, int i); */
-
-/* merge an instruction into the life-range */
-/* returns false if the lifepoint was already known */
-bool ir_value_life_merge(ir_value*, size_t);
-bool ir_value_life_merge_into(ir_value*, const ir_value*);
-/* check if a value lives at a specific point */
-bool ir_value_lives(ir_value*, size_t);
-/* check if the life-range of 2 values overlaps */
-bool ir_values_overlap(const ir_value*, const ir_value*);
-
-void ir_value_dump(ir_value*, int (*oprintf)(const char*,...));
-void ir_value_dump_life(const ir_value *self, int (*oprintf)(const char*,...));
+ bool insertLife(size_t idx, ir_life_entry_t);
+ bool setAlive(size_t position);
+ bool mergeLife(const ir_value *other);
-/* PHI data */
-typedef struct ir_phi_entry_s
-{
- ir_value *value;
- struct ir_block_s *from;
-} ir_phi_entry_t;
+ std::string m_name;
-/* instruction */
-typedef struct ir_instr_s
-{
- int opcode;
- lex_ctx context;
- ir_value* (_ops[3]);
- struct ir_block_s* (bops[2]);
+ qc_type m_vtype;
+ store_type m_store;
+ lex_ctx_t m_context;
+ qc_type m_fieldtype; // even the IR knows the subtype of a field
+ qc_type m_outtype; // and the output type of a function
+ int m_cvq; // 'const' vs 'var' qualifier
+ ir_flag_t m_flags;
- ir_phi_entry_t *phi;
- ir_value **params;
+ std::vector<ir_instr *> m_reads;
+ std::vector<ir_instr *> m_writes;
- /* For the temp-allocation */
- size_t eid;
+ // constant values
+ bool m_hasvalue;
+ union {
+ qcfloat_t vfloat;
+ int vint;
+ vec3_t vvec;
+ int32_t ivec[3];
+ char *vstring;
+ ir_value *vpointer;
+ ir_function *vfunc;
+ } m_constval;
- /* For IFs */
- bool likely;
+ struct {
+ int32_t globaladdr;
+ int32_t name;
+ int32_t local; // filled by the local-allocator
+ int32_t addroffset; // added for members
+ int32_t fieldaddr; // to generate field-addresses early
+ } m_code;
- struct ir_block_s *owner;
-} ir_instr;
+ // for accessing vectors
+ ir_value *m_members[3];
+ ir_value *m_memberof;
-ir_instr* ir_instr_new(lex_ctx ctx, struct ir_block_s *owner, int opcode);
-void ir_instr_delete(ir_instr*);
+ bool m_unique_life; // arrays will never overlap with temps
+ bool m_locked; // temps living during a CALL must be locked
+ bool m_callparam;
-bool GMQCC_WARN vec_ir_instr_find(ir_instr **vec, ir_instr *what, size_t *idx);
+ std::vector<ir_life_entry_t> m_life; // For the temp allocator
-bool ir_instr_op(ir_instr*, int op, ir_value *value, bool writing);
+ size_t size() const;
-void ir_instr_dump(ir_instr* in, char *ind, int (*oprintf)(const char*,...));
+ void dump(int (*oprintf)(const char*, ...)) const;
+};
-/* block */
-typedef struct ir_block_s
-{
- char *label;
- lex_ctx context;
- bool final; /* once a jump is added we're done */
+/* PHI data */
+struct ir_phi_entry_t {
+ ir_value *value;
+ ir_block *from;
+};
- ir_instr **instr;
- struct ir_block_s **entries;
- struct ir_block_s **exits;
- ir_value **living;
+/* instruction */
+struct ir_instr {
+ ir_instr(lex_ctx_t, ir_block *owner, int opcode);
+ ~ir_instr();
- /* For the temp-allocation */
- size_t eid;
- bool is_return;
- size_t run_id;
+ int m_opcode;
+ lex_ctx_t m_context;
+ ir_value *(_m_ops[3]) = { nullptr, nullptr, nullptr };
+ ir_block *(m_bops[2]) = { nullptr, nullptr };
- struct ir_function_s *owner;
+ std::vector<ir_phi_entry_t> m_phi;
+ std::vector<ir_value *> m_params;
- bool generated;
- size_t code_start;
-} ir_block;
+ // For the temp-allocation
+ size_t m_eid = 0;
-ir_block* ir_block_new(struct ir_function_s *owner, const char *label);
-void ir_block_delete(ir_block*);
+ // For IFs
+ bool m_likely = true;
+
+ ir_block *m_owner;
+};
+
+/* block */
+struct ir_block {
+ ir_block(ir_function *owner, const std::string& name);
+ ~ir_block();
-bool ir_block_set_label(ir_block*, const char *label);
+ ir_function *m_owner;
+ std::string m_label;
-ir_value* ir_block_create_binop(ir_block*, lex_ctx, const char *label, int op,
- ir_value *left, ir_value *right);
-ir_value* ir_block_create_unary(ir_block*, lex_ctx, const char *label, int op,
- ir_value *operand);
-bool GMQCC_WARN ir_block_create_store_op(ir_block*, lex_ctx, int op, ir_value *target, ir_value *what);
-bool GMQCC_WARN ir_block_create_store(ir_block*, lex_ctx, ir_value *target, ir_value *what);
-bool GMQCC_WARN ir_block_create_storep(ir_block*, lex_ctx, ir_value *target, ir_value *what);
+ lex_ctx_t m_context;
+ bool m_final = false; /* once a jump is added we're done */
-/* field must be of TYPE_FIELD */
-ir_value* ir_block_create_load_from_ent(ir_block*, lex_ctx, const char *label, ir_value *ent, ir_value *field, int outype);
+ std::vector<ir_instr *> m_instr;
+ std::vector<ir_block *> m_entries;
+ std::vector<ir_block *> m_exits;
+ std::vector<ir_value *> m_living;
-ir_value* ir_block_create_fieldaddress(ir_block*, lex_ctx, const char *label, ir_value *entity, ir_value *field);
+ /* For the temp-allocation */
+ size_t m_entry_id = 0;
+ size_t m_eid = 0;
+ bool m_is_return = false;
+
+ bool m_generated = false;
+ size_t m_code_start = 0;
+};
+
+ir_value* ir_block_create_binop(ir_block*, lex_ctx_t, const char *label, int op, ir_value *left, ir_value *right);
+ir_value* ir_block_create_unary(ir_block*, lex_ctx_t, const char *label, int op, ir_value *operand);
+bool GMQCC_WARN ir_block_create_store_op(ir_block*, lex_ctx_t, int op, ir_value *target, ir_value *what);
+bool GMQCC_WARN ir_block_create_storep(ir_block*, lex_ctx_t, ir_value *target, ir_value *what);
+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);
+ir_value* ir_block_create_fieldaddress(ir_block*, lex_ctx_t, const char *label, ir_value *entity, ir_value *field);
+bool GMQCC_WARN ir_block_create_state_op(ir_block*, lex_ctx_t, ir_value *frame, ir_value *think);
/* This is to create an instruction of the form
* <outtype>%label := opcode a, b
*/
-ir_value* ir_block_create_general_instr(ir_block *self, lex_ctx, const char *label,
- int op, ir_value *a, ir_value *b, int outype);
-
-ir_instr* ir_block_create_phi(ir_block*, lex_ctx, const char *label, int vtype);
+ir_instr* ir_block_create_phi(ir_block*, lex_ctx_t, const char *label, qc_type vtype);
ir_value* ir_phi_value(ir_instr*);
void ir_phi_add(ir_instr*, ir_block *b, ir_value *v);
-ir_instr* ir_block_create_call(ir_block*, lex_ctx, const char *label, ir_value *func, bool noreturn);
+ir_instr* ir_block_create_call(ir_block*, lex_ctx_t, const char *label, ir_value *func, bool noreturn);
ir_value* ir_call_value(ir_instr*);
void ir_call_param(ir_instr*, ir_value*);
-bool GMQCC_WARN ir_block_create_return(ir_block*, lex_ctx, ir_value *opt_value);
+bool GMQCC_WARN ir_block_create_return(ir_block*, lex_ctx_t, ir_value *opt_value);
-bool GMQCC_WARN ir_block_create_if(ir_block*, lex_ctx, ir_value *cond,
+bool GMQCC_WARN ir_block_create_if(ir_block*, lex_ctx_t, ir_value *cond,
ir_block *ontrue, ir_block *onfalse);
-/* A 'goto' is an actual 'goto' coded in QC, whereas
+/*
+ * A 'goto' is an actual 'goto' coded in QC, whereas
* a 'jump' is a virtual construct which simply names the
* next block to go to.
* A goto usually becomes an OP_GOTO in the resulting code,
* whereas a 'jump' usually doesn't add any actual instruction.
*/
-bool GMQCC_WARN ir_block_create_jump(ir_block*, lex_ctx, ir_block *to);
-bool GMQCC_WARN ir_block_create_goto(ir_block*, lex_ctx, ir_block *to);
-
-void ir_block_dump(ir_block*, char *ind, int (*oprintf)(const char*,...));
+bool GMQCC_WARN ir_block_create_jump(ir_block*, lex_ctx_t, ir_block *to);
+bool GMQCC_WARN ir_block_create_goto(ir_block*, lex_ctx_t, ir_block *to);
/* function */
+struct ir_function {
+ ir_function(ir_builder *owner, qc_type returntype);
+ ~ir_function();
-typedef struct ir_function_s
-{
- char *name;
- int outtype;
- int *params;
- ir_block **blocks;
-
- uint32_t flags;
+ ir_builder *m_owner;
- int builtin;
+ std::string m_name;
+ qc_type m_outtype;
+ std::vector<int> m_params;
+ ir_flag_t m_flags = 0;
+ int m_builtin = 0;
- ir_value *value;
+ std::vector<std::unique_ptr<ir_block>> m_blocks;
- /* values generated from operations
+ /*
+ * values generated from operations
* which might get optimized away, so anything
* in there needs to be deleted in the dtor.
*/
- ir_value **values;
+ std::vector<std::unique_ptr<ir_value>> m_values;
+ std::vector<std::unique_ptr<ir_value>> m_locals; /* locally defined variables */
+ ir_value *m_value = nullptr;
- /* locally defined variables */
- ir_value **locals;
+ size_t m_allocated_locals = 0;
+ size_t m_globaltemps = 0;
- size_t allocated_locals;
- size_t globaltemps;
+ ir_block* m_first = nullptr;
+ ir_block* m_last = nullptr;
- ir_block* first;
- ir_block* last;
+ lex_ctx_t m_context;
- lex_ctx context;
-
- /* for prototypes - first we generate all the
+ /*
+ * for prototypes - first we generate all the
* globals, and we remember teh function-defs
* so we can later fill in the entry pos
*
* remember the ID:
*/
- qcint code_function_def;
+ qcint_t m_code_function_def = -1;
/* for temp allocation */
- size_t run_id;
-
- struct ir_builder_s *owner;
-} ir_function;
-#define IR_FLAG_HAS_ARRAYS (1<<1)
-#define IR_FLAG_HAS_UNINITIALIZED (1<<2)
-#define IR_FLAG_HAS_GOTO (1<<3)
-#define IR_FLAG_MASK_NO_OVERLAP (IR_FLAG_HAS_ARRAYS | IR_FLAG_HAS_UNINITIALIZED)
+ size_t m_run_id = 0;
-ir_function* ir_function_new(struct ir_builder_s *owner, int returntype);
-void ir_function_delete(ir_function*);
+ /* vararg support: */
+ size_t m_max_varargs = 0;
+};
-void ir_function_collect_value(ir_function*, ir_value *value);
-bool ir_function_set_name(ir_function*, const char *name);
+ir_value* ir_function_create_local(ir_function *self, const std::string& name, qc_type vtype, bool param);
+bool GMQCC_WARN ir_function_finalize(ir_function*);
+ir_block* ir_function_create_block(lex_ctx_t ctx, ir_function*, const char *label);
-ir_value* ir_function_create_local(ir_function *self, const char *name, int vtype, bool param);
+/* builder */
+#define IR_HT_SIZE 1024
+#define IR_MAX_VINSTR_TEMPS 1
+
+struct ir_builder {
+ ir_builder(const std::string& modulename);
+ ~ir_builder();
+
+ ir_function *createFunction(const std::string &name, qc_type outtype);
+ ir_value *createGlobal(const std::string &name, qc_type vtype);
+ ir_value *createField(const std::string &name, qc_type vtype);
+ ir_value *get_va_count();
+ bool generate(const char *filename);
+ void dump(int (*oprintf)(const char*, ...)) const;
+
+ ir_value *generateExtparamProto();
+ void generateExtparam();
+
+ ir_value *literalFloat(float value, bool add_to_list);
+
+ std::string m_name;
+ std::vector<std::unique_ptr<ir_function>> m_functions;
+ std::vector<std::unique_ptr<ir_value>> m_globals;
+ std::vector<std::unique_ptr<ir_value>> m_fields;
+ // for reusing them in vector-splits, TODO: sort this or use a radix-tree
+ std::vector<ir_value*> m_const_floats;
+
+ ht m_htfunctions;
+ ht m_htglobals;
+ ht m_htfields;
+
+ // extparams' ir_values reference the ones from extparam_protos
+ std::vector<std::unique_ptr<ir_value>> m_extparam_protos;
+ std::vector<ir_value*> m_extparams;
+
+ // the highest func->allocated_locals
+ size_t m_max_locals = 0;
+ size_t m_max_globaltemps = 0;
+ uint32_t m_first_common_local = 0;
+ uint32_t m_first_common_globaltemp = 0;
+
+ std::vector<const char*> m_filenames;
+ std::vector<qcint_t> m_filestrings;
+
+ // we cache the #IMMEDIATE string here
+ qcint_t m_str_immediate = 0;
+
+ // there should just be this one nil
+ ir_value *m_nil;
+ ir_value *m_reserved_va_count = nullptr;
+ ir_value *m_coverage_func = nullptr;
+
+ /* some virtual instructions require temps, and their code is isolated
+ * so that we don't need to keep track of their liveness.
+ */
+ ir_value *m_vinstr_temp[IR_MAX_VINSTR_TEMPS];
-bool GMQCC_WARN ir_function_finalize(ir_function*);
-/*
-bool ir_function_naive_phi(ir_function*);
-bool ir_function_enumerate(ir_function*);
-bool ir_function_calculate_liferanges(ir_function*);
-*/
+ /* code generator */
+ std::unique_ptr<code_t> m_code;
-ir_block* ir_function_create_block(lex_ctx ctx, ir_function*, const char *label);
+private:
+ qcint_t filestring(const char *filename);
+ bool generateGlobal(ir_value*, bool is_local);
+ bool generateGlobalFunction(ir_value*);
+ bool generateGlobalFunctionCode(ir_value*);
+ bool generateFunctionLocals(ir_value*);
+};
-void ir_function_dump(ir_function*, char *ind, int (*oprintf)(const char*,...));
+/*
+ * This code assumes 32 bit floats while generating binary
+ * Blub: don't use extern here, it's annoying and shows up in nm
+ * for some reason :P
+ */
+typedef int static_assert_is_32bit_float [(sizeof(int32_t) == 4) ? 1 : -1];
+typedef int static_assert_is_32bit_integer[(sizeof(qcfloat_t) == 4) ? 1 : -1];
-/* builder */
-#define IR_HT_SIZE 1024
-typedef struct ir_builder_s
-{
- char *name;
- ir_function **functions;
- ir_value **globals;
- ir_value **fields;
-
- ht htfunctions;
- ht htglobals;
- ht htfields;
-
- ir_value **extparams;
- ir_value **extparam_protos;
-
- /* the highest func->allocated_locals */
- size_t max_locals;
- size_t max_globaltemps;
- uint32_t first_common_local;
- uint32_t first_common_globaltemp;
-
- const char **filenames;
- qcint *filestrings;
- /* we cache the #IMMEDIATE string here */
- qcint str_immediate;
- /* there should just be this one nil */
- ir_value *nil;
-} ir_builder;
-
-ir_builder* ir_builder_new(const char *modulename);
-void ir_builder_delete(ir_builder*);
-
-bool ir_builder_set_name(ir_builder *self, const char *name);
-
-ir_function* ir_builder_get_function(ir_builder*, const char *fun);
-ir_function* ir_builder_create_function(ir_builder*, const char *name, int outtype);
-
-ir_value* ir_builder_get_global(ir_builder*, const char *fun);
-ir_value* ir_builder_create_global(ir_builder*, const char *name, int vtype);
-ir_value* ir_builder_get_field(ir_builder*, const char *fun);
-ir_value* ir_builder_create_field(ir_builder*, const char *name, int vtype);
-
-bool ir_builder_generate(ir_builder *self, const char *filename);
-
-void ir_builder_dump(ir_builder*, int (*oprintf)(const char*, ...));
-
-/* This code assumes 32 bit floats while generating binary */
-extern int check_int_and_float_size
-[ (sizeof(int32_t) == sizeof(qcfloat)) ? 1 : -1 ];
+/*
+ * If the condition creates a situation where this becomes -1 size it means there are
+ * more IR_FLAGs than the type ir_flag_t is capable of holding. So either eliminate
+ * the IR flag count or change the ir_flag_t typedef to a type large enough to accomodate
+ * all the flags.
+ */
+typedef int static_assert_is_ir_flag_safe [((IR_FLAG_LAST) <= (ir_flag_t)(-1)) ? 1 : -1];
#endif