X-Git-Url: https://git.xonotic.org/?p=xonotic%2Fgmqcc.git;a=blobdiff_plain;f=ir.h;h=44ceccfcc25acacb1bf2c461b6dc3b5a699298ba;hp=bfba8faace49f1c4708369f56b6dd1fd431cfe1c;hb=f09c6a5d63faaad1b915868c461b658efd374a34;hpb=0bee75940616ea487cf52d1ea82c9f7a90c8d4e6 diff --git a/ir.h b/ir.h index bfba8fa..44ceccf 100644 --- a/ir.h +++ b/ir.h @@ -1,321 +1,317 @@ -/* - * Copyright (C) 2012 - * 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 */ +/* + * 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 -{ +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; - - MEM_VECTOR_MAKE(struct ir_instr_s*, reads); - MEM_VECTOR_MAKE(struct ir_instr_s*, writes); - - /* constantvalues */ - bool isconst; +}; + +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_SPLIT_VECTOR = 1 << 6, + + 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(); + + void* operator new(std::size_t); // to use mem_a + void operator delete(void*); // to use mem_d + + std::string name; + + qc_type vtype; + store_type store; + lex_ctx_t context; + qc_type fieldtype; // even the IR knows the subtype of a field + qc_type outtype; // and the output type of a function + int cvq; // 'const' vs 'var' qualifier + ir_flag_t flags; + + std::vector reads; + std::vector writes; + + // constant values + bool hasvalue; union { - float vfloat; - int vint; - vector vvec; - char *vstring; - struct ir_value_s *vpointer; - struct ir_function_s *vfunc; - quaternion vquat; - matrix vmat; + 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; - /* filled by the local-allocator */ - int32_t local; + int32_t local; // filled by the local-allocator + int32_t addroffset; // added for members + int32_t fieldaddr; // to generate field-addresses early } code; - /* For the temp allocator */ - MEM_VECTOR_MAKE(ir_life_entry_t, life); -} ir_value; + // for accessing vectors + ir_value *members[3]; + ir_value *memberof; -/* 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*); -void ir_value_set_name(ir_value*, const char *name); + bool unique_life; // arrays will never overlap with temps + bool locked; // temps living during a CALL must be locked + bool callparam; -MEM_VECTOR_PROTO_ALL(ir_value, struct ir_instr_s*, reads); -MEM_VECTOR_PROTO_ALL(ir_value, struct ir_instr_s*, writes); + std::vector 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_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); -#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 ir_value_set_pointer_v(ir_value*, ir_value* p); */ -/*bool ir_value_set_pointer_i(ir_value*, int i); */ -bool GMQCC_WARN ir_value_set_quaternion(ir_value*, quaternion v); -bool GMQCC_WARN ir_value_set_matrix(ir_value*, matrix v); - -MEM_VECTOR_PROTO(ir_value, ir_life_entry_t, life); -/* 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(ir_value *self, int (*oprintf)(const char*,...)); - -/* A vector of IR values */ -typedef struct { - MEM_VECTOR_MAKE(ir_value*, v); -} ir_value_vector; -MEM_VECTOR_PROTO(ir_value_vector, ir_value*, v); +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; - struct ir_block_s *from; -} ir_phi_entry_t; +struct ir_phi_entry_t { + ir_value *value; + ir_block *from; +}; /* instruction */ -typedef struct ir_instr_s -{ - int opcode; - lex_ctx context; - ir_value* (_ops[3]); - struct ir_block_s* (bops[2]); +struct ir_instr { + int opcode; + lex_ctx_t context; + ir_value *(_ops[3]); + ir_block *(bops[2]); - MEM_VECTOR_MAKE(ir_phi_entry_t, phi); - MEM_VECTOR_MAKE(ir_value*, params); + std::vector phi; + std::vector params; - /* For the temp-allocation */ + // For the temp-allocation size_t eid; - struct ir_block_s *owner; -} ir_instr; - -ir_instr* ir_instr_new(struct ir_block_s *owner, int opcode); -void ir_instr_delete(ir_instr*); - -MEM_VECTOR_PROTO(ir_value, ir_phi_entry_t, phi); -bool GMQCC_WARN ir_instr_op(ir_instr*, int op, ir_value *value, bool writing); + // For IFs + bool likely; -MEM_VECTOR_PROTO(ir_value, ir_value*, params); - -void ir_instr_dump(ir_instr* in, char *ind, int (*oprintf)(const char*,...)); + ir_block *owner; +}; /* block */ -typedef struct ir_block_s -{ - char *label; - lex_ctx context; - bool final; /* once a jump is added we're done */ - - MEM_VECTOR_MAKE(ir_instr*, instr); - MEM_VECTOR_MAKE(struct ir_block_s*, entries); - MEM_VECTOR_MAKE(struct ir_block_s*, exits); - MEM_VECTOR_MAKE(ir_value*, living); - - /* For the temp-allocation */ - size_t eid; - bool is_return; - size_t run_id; - - struct ir_function_s *owner; - - bool generated; - size_t code_start; -} ir_block; +struct ir_block { + void* operator new(std::size_t); + void operator delete(void*); -ir_block* ir_block_new(struct ir_function_s *owner, const char *label); -void ir_block_delete(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 *owner; + std::string label; -MEM_VECTOR_PROTO(ir_block, ir_instr*, instr); -MEM_VECTOR_PROTO_ALL(ir_block, ir_block*, exits); -MEM_VECTOR_PROTO_ALL(ir_block, ir_block*, entries); + lex_ctx_t context; + bool final = false; /* once a jump is added we're done */ -ir_value* ir_block_create_binop(ir_block*, const char *label, int op, - ir_value *left, ir_value *right); -ir_value* ir_block_create_unary(ir_block*, const char *label, int op, - ir_value *operand); -bool GMQCC_WARN ir_block_create_store_op(ir_block*, int op, ir_value *target, ir_value *what); -bool GMQCC_WARN ir_block_create_store(ir_block*, ir_value *target, ir_value *what); -bool GMQCC_WARN ir_block_create_storep(ir_block*, ir_value *target, ir_value *what); + ir_instr **instr = nullptr; + ir_block **entries = nullptr; + ir_block **exits = nullptr; + std::vector living; -/* field must be of TYPE_FIELD */ -ir_value* ir_block_create_load_from_ent(ir_block*, const char *label, ir_value *ent, ir_value *field, int outype); - -ir_value* ir_block_create_fieldaddress(ir_block*, const char *label, ir_value *entity, ir_value *field); + /* For the temp-allocation */ + size_t entry_id = 0; + size_t eid = 0; + bool is_return = false; + + bool generated = false; + size_t 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 * %label := opcode a, b */ -ir_value* ir_block_create_general_instr(ir_block *self, const char *label, - int op, ir_value *a, ir_value *b, int outype); - -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, 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*); -bool GMQCC_WARN ir_phi_add(ir_instr*, ir_block *b, ir_value *v); -ir_instr* ir_block_create_call(ir_block*, const char *label, ir_value *func); +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*); -bool GMQCC_WARN ir_call_param(ir_instr*, ir_value*); +void ir_call_param(ir_instr*, ir_value*); -bool GMQCC_WARN 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); -bool GMQCC_WARN ir_block_create_if(ir_block*, 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*, ir_block *to); -bool GMQCC_WARN ir_block_create_goto(ir_block*, ir_block *to); - -MEM_VECTOR_PROTO_ALL(ir_block, ir_value*, living); - -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 { + void* operator new(std::size_t); + void operator delete(void*); -typedef struct ir_function_s -{ - char *name; - int outtype; - MEM_VECTOR_MAKE(int, params); - MEM_VECTOR_MAKE(ir_block*, blocks); + ir_function(ir_builder *owner, qc_type returntype); + ~ir_function(); - int builtin; + ir_builder *owner; - ir_value *value; + std::string name; + qc_type outtype; + int *params = nullptr; + ir_flag_t flags = 0; + int builtin = 0; + + std::vector> 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. */ - MEM_VECTOR_MAKE(ir_value*, values); + std::vector> values; + std::vector> locals; /* locally defined variables */ + ir_value *value = nullptr; - /* locally defined variables */ - MEM_VECTOR_MAKE(ir_value*, locals); + size_t allocated_locals = 0; + size_t globaltemps = 0; - size_t allocated_locals; + ir_block* first = nullptr; + ir_block* last = nullptr; - ir_block* first; - ir_block* last; + lex_ctx_t context; - lex_ctx 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 = -1; /* for temp allocation */ - size_t run_id; - - struct ir_builder_s *owner; -} ir_function; - -ir_function* ir_function_new(struct ir_builder_s *owner, int returntype); -void ir_function_delete(ir_function*); + size_t run_id = 0; -bool GMQCC_WARN ir_function_collect_value(ir_function*, ir_value *value); + /* vararg support: */ + size_t max_varargs = 0; +}; -bool ir_function_set_name(ir_function*, const char *name); -MEM_VECTOR_PROTO(ir_function, int, params); -MEM_VECTOR_PROTO(ir_function, ir_block*, blocks); - -ir_value* ir_function_get_local(ir_function *self, const char *name); -ir_value* ir_function_create_local(ir_function *self, const char *name, int vtype, bool param); +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*); -/* -bool ir_function_naive_phi(ir_function*); -bool ir_function_enumerate(ir_function*); -bool 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*,...)); +ir_block* ir_function_create_block(lex_ctx_t ctx, ir_function*, const char *label); /* builder */ -typedef struct ir_builder_s -{ - char *name; - MEM_VECTOR_MAKE(ir_function*, functions); - MEM_VECTOR_MAKE(ir_value*, globals); - MEM_VECTOR_MAKE(ir_value*, fields); -} 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); - -MEM_VECTOR_PROTO(ir_builder, ir_function*, functions); -MEM_VECTOR_PROTO(ir_builder, ir_value*, globals); -MEM_VECTOR_PROTO(ir_builder, ir_value*, fields); - -ir_function* ir_builder_get_function(ir_builder*, const char *fun); -ir_function* ir_builder_create_function(ir_builder*, const char *name, int outtype); +#define IR_HT_SIZE 1024 +#define IR_MAX_VINSTR_TEMPS 1 + +struct ir_builder { + void* operator new(std::size_t); + void operator delete(void*); + ir_builder(const std::string& modulename); + ~ir_builder(); + + std::string name; + std::vector> functions; + std::vector> globals; + std::vector> fields; + // for reusing them in vector-splits, TODO: sort this or use a radix-tree + std::vector const_floats; + + ht htfunctions; + ht htglobals; + ht htfields; + + std::vector> extparams; + std::vector> extparam_protos; + + // the highest func->allocated_locals + size_t max_locals = 0; + size_t max_globaltemps = 0; + uint32_t first_common_local = 0; + uint32_t first_common_globaltemp = 0; + + std::vector filenames; + std::vector filestrings; + + // we cache the #IMMEDIATE string here + qcint_t str_immediate = 0; + + // there should just be this one nil + ir_value *nil; + ir_value *reserved_va_count = nullptr; + ir_value *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 *vinstr_temp[IR_MAX_VINSTR_TEMPS]; -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); + /* code generator */ + code_t *code; +}; -bool ir_builder_generate(ir_builder *self, const char *filename); +ir_function* ir_builder_create_function(ir_builder*, const std::string& name, qc_type outtype); +ir_value* ir_builder_create_global(ir_builder*, const std::string& name, qc_type vtype); +ir_value* ir_builder_create_field(ir_builder*, const std::string& name, qc_type 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*, ...)); -void ir_builder_dump(ir_builder*, 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]; -/* This code assumes 32 bit floats while generating binary */ -extern int check_int_and_float_size -[ (sizeof(int32_t) == sizeof(( (ir_value*)(NULL) )->constval.vvec.x)) ? 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