-#ifndef QCIR_H__
-#define QCIR_H__
-
-#include "astir.h"
-
-/* ir_value */
+/*
+ * Copyright (C) 2012, 2013, 2014
+ * 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"
-typedef struct
-{
- /* both inclusive */
- size_t start;
- size_t end;
+/*
+ * 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;
+
+typedef struct ir_value_s ir_value;
+typedef struct ir_instr_s ir_instr;
+typedef struct ir_block_s ir_block;
+typedef struct ir_function_s ir_function;
+typedef struct ir_builder_s ir_builder;
+
+typedef struct {
+ /* both inclusive */
+ size_t start;
+ size_t end;
} ir_life_entry_t;
-struct ir_function_s;
-typedef struct ir_value_s {
- const char *_name;
- ir_type_t vtype;
- ir_store_t store;
- filecontext_t context;
-
- /*
- size_t read_use;
- size_t write_use;
- */
- MAKE_VEC(struct ir_instr_s*, reads);
- MAKE_VEC(struct ir_instr_s*, writes);
-
- /* constantvalues */
- union {
- float vfloat;
- int vint;
- qc_vec_t vvec;
- struct ir_value_s *vpointer;
- const char *vstring;
- } cvalue;
- ir_bool has_constval;
-
- /* For the temp allocator */
- MAKE_VEC(ir_life_entry_t, life);
-} ir_value;
-
-/* ir_value can be a variable, or created by an operation */
-ir_value* ir_value_var(const char *name, ir_store_t st, ir_type_t vtype);
-/* if a result of an operation: the function should store
+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_ERASEABLE = 1 << 4,
+ IR_FLAG_BLOCK_COVERAGE = 1 << 5,
+
+ 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_s {
+ char *name;
+ int vtype;
+ int store;
+ lex_ctx_t context;
+
+
+ int fieldtype; /* even the IR knows the subtype of a field */
+ int outtype; /* and the output type of a function */
+ int cvq; /* 'const' vs 'var' qualifier */
+ ir_flag_t flags;
+
+ ir_instr **reads;
+ ir_instr **writes;
+
+ /* constantvalues */
+ bool hasvalue;
+ union {
+ qcfloat_t vfloat;
+ int vint;
+ vec3_t vvec;
+ int32_t ivec[3];
+ char *vstring;
+ ir_value *vpointer;
+ ir_function *vfunc;
+ } constval;
+
+ 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 */
+ } code;
+
+ /* for acessing vectors */
+ ir_value *members[3];
+ ir_value *memberof;
+
+
+ bool unique_life; /* arrays will never overlap with temps */
+ bool locked; /* temps living during a CALL must be locked */
+ bool callparam;
+
+ ir_life_entry_t *life; /* For the temp allocator */
+};
+
+/*
+ * ir_value can be a variable, or created by an operation
+ * 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, ir_store_t st, ir_type_t vtype);
-void ir_value_delete(ir_value*);
-void ir_value_set_name(ir_value*, const char *name);
-
-void ir_value_reads_add(ir_value*, struct ir_instr_s*);
-void ir_value_writes_add(ir_value*, struct ir_instr_s*);
-
-ir_bool ir_value_set_float(ir_value*, float f);
-ir_bool ir_value_set_int(ir_value*, int i);
-ir_bool ir_value_set_string(ir_value*, const char *s);
-ir_bool ir_value_set_vector(ir_value*, qc_vec_t v);
-/*ir_bool ir_value_set_pointer_v(ir_value*, ir_value* p); */
-/*ir_bool ir_value_set_pointer_i(ir_value*, int i); */
-
-void ir_value_life_add(ir_value*, ir_life_entry_t e);
-/* merge an instruction into the life-range */
-/* returns false if the lifepoint was already known */
-ir_bool ir_value_life_merge(ir_value*, size_t);
-/* check if a value lives at a specific point */
-ir_bool ir_value_lives(ir_value*, size_t);
-
-void ir_value_dump(ir_value*, int (*oprintf)(const char*,...));
-void ir_value_dump_life(ir_value *self, int (*oprintf)(const char*,...));
-
-typedef struct ir_phi_entry_s
-{
- ir_value *value;
- struct ir_block_s *from;
+void ir_value_delete(ir_value*);
+ir_value* ir_value_vector_member(ir_value*, unsigned int member);
+bool GMQCC_WARN ir_value_set_float(ir_value*, float f);
+bool GMQCC_WARN ir_value_set_func(ir_value*, int f);
+bool GMQCC_WARN ir_value_set_string(ir_value*, const char *s);
+bool GMQCC_WARN ir_value_set_vector(ir_value*, vec3_t v);
+bool GMQCC_WARN ir_value_set_field(ir_value*, ir_value *fld);
+bool ir_value_lives(ir_value*, size_t);
+void ir_value_dump_life(const ir_value *self, int (*oprintf)(const char*,...));
+
+/* PHI data */
+typedef struct ir_phi_entry_s {
+ ir_value *value;
+ ir_block *from;
} ir_phi_entry_t;
/* instruction */
-typedef struct ir_instr_s
-{
- ir_op_t opcode;
- filecontext_t context;
- ir_value* (_ops[3]);
- struct ir_block_s* (bops[2]);
-
- MAKE_VEC(ir_phi_entry_t, phi);
-
- /* For the temp-allocation */
- size_t eid;
+struct ir_instr_s {
+ int opcode;
+ lex_ctx_t context;
+ ir_value* (_ops[3]);
+ ir_block* (bops[2]);
- struct ir_block_s *owner;
-} ir_instr;
+ ir_phi_entry_t *phi;
+ ir_value **params;
-ir_instr* ir_instr_new(struct ir_block_s *owner, ir_op_t opcode);
-void ir_instr_delete(ir_instr*);
+ /* For the temp-allocation */
+ size_t eid;
-void ir_instr_phi_add(ir_instr*, ir_phi_entry_t e);
-void ir_instr_op(ir_instr*, int op, ir_value *value, ir_bool writing);
+ /* For IFs */
+ bool likely;
-void ir_instr_dump(ir_instr* in, char *ind, int (*oprintf)(const char*,...));
+ ir_block *owner;
+};
/* block */
-typedef struct ir_block_s
-{
- const char *_label;
- filecontext_t context;
- ir_bool final; /* once a jump is added we're done */
-
- MAKE_VEC(ir_instr*, instr);
- MAKE_VEC(struct ir_block_s*, entries);
- MAKE_VEC(struct ir_block_s*, exits);
- MAKE_VEC(ir_value*, living);
-
- /* For the temp-allocation */
- size_t eid;
- ir_bool is_return;
- size_t run_id;
-
- struct ir_function_s *owner;
-} ir_block;
-
-ir_block* ir_block_new(struct ir_function_s *owner, const char *label);
-void ir_block_delete(ir_block*);
-
-void ir_block_set_label(ir_block*, const char *label);
-
-void ir_block_instr_add(ir_block*, ir_instr *instr);
-void ir_block_instr_remove(ir_block*, size_t idx);
-void ir_block_exits_add(ir_block*, ir_block *b);
-void ir_block_entries_add(ir_block*, ir_block *b);
-ir_bool ir_block_entries_find(ir_block*, ir_block *b, size_t *idx);
-
-ir_value* ir_block_create_binop(ir_block*, const char *label, ir_op_t op,
- ir_value *left, ir_value *right);
-ir_bool ir_block_create_store_op(ir_block*, ir_op_t op, ir_value *target, ir_value *what);
-ir_bool ir_block_create_store(ir_block*, ir_value *target, ir_value *what);
-
-ir_value* ir_block_create_add(ir_block*, const char *label, ir_value *l, ir_value *r);
-ir_value* ir_block_create_sub(ir_block*, const char *label, ir_value *l, ir_value *r);
-ir_value* ir_block_create_mul(ir_block*, const char *label, ir_value *l, ir_value *r);
-ir_value* ir_block_create_div(ir_block*, const char *label, ir_value *l, ir_value *r);
-ir_instr* ir_block_create_phi(ir_block*, const char *label, ir_type_t vtype);
+struct ir_block_s {
+ char *label;
+ lex_ctx_t context;
+ bool final; /* once a jump is added we're done */
+
+ ir_instr **instr;
+ ir_block **entries;
+ ir_block **exits;
+ ir_value **living;
+
+ /* For the temp-allocation */
+ size_t entry_id;
+ size_t eid;
+ bool is_return;
+
+ ir_function *owner;
+
+ bool generated;
+ size_t code_start;
+};
+
+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, int 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_instr* ir_block_create_phi(ir_block*, lex_ctx_t, const char *label, int vtype);
ir_value* ir_phi_value(ir_instr*);
-void ir_phi_add(ir_instr*, ir_block *b, ir_value *v);
+void ir_phi_add(ir_instr*, ir_block *b, ir_value *v);
+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*);
-void ir_block_create_return(ir_block*, ir_value *opt_value);
+bool GMQCC_WARN ir_block_create_return(ir_block*, lex_ctx_t, ir_value *opt_value);
-void ir_block_create_if(ir_block*, ir_value *cond,
- ir_block *ontrue, ir_block *onfalse);
-/* A 'goto' is an actual 'goto' coded in QC, whereas
+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 '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.
*/
-void ir_block_create_jump(ir_block*, ir_block *to);
-void ir_block_create_goto(ir_block*, ir_block *to);
-
-void ir_block_living_add(ir_block*, ir_value*);
-void ir_block_living_remove(ir_block*, size_t idx);
-ir_bool ir_block_living_find(ir_block*, ir_value*, size_t *idx);
-
-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 */
-
-typedef struct ir_function_s
-{
- const char *_name;
- ir_type_t retype;
- MAKE_VEC(ir_type_t, params);
- MAKE_VEC(ir_block*, blocks);
-
- /* values generated from operations
- * which might get optimized away, so anything
- * in there needs to be deleted in the dtor.
- */
- MAKE_VEC(ir_value*, values);
-
- /* locally defined variables */
- MAKE_VEC(ir_value*, locals);
-
- ir_block* first;
- ir_block* last;
-
- filecontext_t context;
-
- /* for temp allocation */
- size_t run_id;
-
- struct ir_builder_s *owner;
-} ir_function;
-
-ir_function* ir_function_new(struct ir_builder_s *owner);
-void ir_function_delete(ir_function*);
-
-void ir_function_collect_value(ir_function*, ir_value *value);
-
-void ir_function_set_name(ir_function*, const char *name);
-void ir_function_params_add(ir_function*, ir_type_t p);
-void ir_function_blocks_add(ir_function*, ir_block *b);
-
-ir_value* ir_function_get_local(ir_function *self, const char *name);
-ir_value* ir_function_create_local(ir_function *self, const char *name, ir_type_t vtype);
-
-void ir_function_finalize(ir_function*);
-/*
-void ir_function_naive_phi(ir_function*);
-void ir_function_enumerate(ir_function*);
-void ir_function_calculate_liferanges(ir_function*);
-*/
-
-ir_block* ir_function_create_block(ir_function*, const char *label);
-
-void ir_function_dump(ir_function*, char *ind, int (*oprintf)(const char*,...));
+struct ir_function_s {
+ char *name;
+ int outtype;
+ int *params;
+ ir_block **blocks;
+ ir_flag_t flags;
+ int builtin;
+
+ /*
+ * values generated from operations
+ * which might get optimized away, so anything
+ * in there needs to be deleted in the dtor.
+ */
+ ir_value **values;
+ ir_value **locals; /* locally defined variables */
+ ir_value *value;
+
+ size_t allocated_locals;
+ size_t globaltemps;
+
+ ir_block* first;
+ ir_block* last;
+
+ lex_ctx_t context;
+
+ /*
+ * 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_t code_function_def;
+
+ /* for temp allocation */
+ size_t run_id;
+
+ ir_builder *owner;
+
+ /* vararg support: */
+ size_t max_varargs;
+};
+
+
+ir_value* ir_function_create_local(ir_function *self, const char *name, int 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);
/* builder */
-typedef struct ir_builder_s
-{
- const char *_name;
- MAKE_VEC(ir_function*, functions);
- MAKE_VEC(ir_value*, globals);
-} ir_builder;
-
-ir_builder* ir_builder_new(const char *modulename);
-void ir_builder_delete(ir_builder*);
-
-void ir_builder_set_name(ir_builder *self, const char *name);
-
-void ir_builder_functions_add(ir_builder* b, ir_function* f);
-void ir_builder_globals_add(ir_builder* b, ir_value* f);
-
-ir_function* ir_builder_get_function(ir_builder*, const char *fun);
-ir_function* ir_builder_create_function(ir_builder*, const char *name);
+#define IR_HT_SIZE 1024
+#define IR_MAX_VINSTR_TEMPS 1
+
+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_t *filestrings;
+ /* we cache the #IMMEDIATE string here */
+ qcint_t str_immediate;
+ /* there should just be this one nil */
+ ir_value *nil;
+ ir_value *reserved_va_count;
+ ir_value *coverage_func;
+ /* some virtual instructions require temps, and their code is isolated
+ * so that we don't need to keep track of their liveness.
+ */
+ ir_value *vinstr_temp[IR_MAX_VINSTR_TEMPS];
+
+ /* code generator */
+ code_t *code;
+};
+
+ir_builder* ir_builder_new(const char *modulename);
+void ir_builder_delete(ir_builder*);
+ir_function* ir_builder_create_function(ir_builder*, const char *name, int outtype);
+ir_value* ir_builder_create_global(ir_builder*, const char *name, int vtype);
+ir_value* ir_builder_create_field(ir_builder*, const char *name, int vtype);
+ir_value* ir_builder_get_va_count(ir_builder*);
+bool ir_builder_generate(ir_builder *self, const char *filename);
+void ir_builder_dump(ir_builder*, int (*oprintf)(const char*, ...));
-ir_value* ir_builder_get_global(ir_builder*, const char *fun);
-ir_value* ir_builder_create_global(ir_builder*, const char *name, ir_type_t vtype);
+/*
+ * 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];
-void ir_builder_dump(ir_builder*, int (*oprintf)(const char*, ...));
+/*
+ * 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
projects / xonotic / gmqcc.git / blobdiff