]> git.xonotic.org Git - xonotic/gmqcc.git/blobdiff - ir.h
Fix #161
[xonotic/gmqcc.git] / ir.h
diff --git a/ir.h b/ir.h
index d0fd7879c5c20509dd29f25eb11588ebb0ea015a..9fa8ab5ab62d2ee49323af529e7ed2a1e6508410 100644 (file)
--- a/ir.h
+++ b/ir.h
@@ -1,25 +1,3 @@
-/*
- * 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 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;
+struct ir_value;
+struct ir_instr;
+struct ir_block;
+struct ir_function;
+struct ir_builder;
 
-typedef struct {
+struct ir_life_entry_t {
     /* both inclusive */
     size_t start;
     size_t end;
-} ir_life_entry_t;
+};
 
 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_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_s {
-    char      *name;
-    int        vtype;
-    int        store;
-    lex_ctx_t  context;
+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
+
+    bool lives(size_t at);
+    void dumpLife(int (*oprintf)(const char*, ...)) const;
+
+    void setCodeAddress(int32_t gaddr);
+    int32_t codeAddress() const;
+
+    bool insertLife(size_t idx, ir_life_entry_t);
+    bool setAlive(size_t position);
+    bool mergeLife(const ir_value *other);
 
+    std::string m_name;
 
-    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;
+    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_instr **reads;
-    ir_instr **writes;
+    std::vector<ir_instr *> m_reads;
+    std::vector<ir_instr *> m_writes;
 
-    /* constantvalues */
-    bool hasvalue;
+    // constant values
+    bool m_hasvalue;
     union {
-        qcfloat_t   vfloat;
-        int         vint;
-        vec3_t      vvec;
-        int32_t     ivec[3];
+        qcfloat_t    vfloat;
+        int          vint;
+        vec3_t       vvec;
+        int32_t      ivec[3];
         char        *vstring;
         ir_value    *vpointer;
         ir_function *vfunc;
-    } constval;
+    } m_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;
+        int32_t local;         // filled by the local-allocator
+        int32_t addroffset;    // added for members
+        int32_t fieldaddr;     // to generate field-addresses early
+    } m_code;
 
-    /* for acessing vectors */
-    ir_value *members[3];
-    ir_value *memberof;
+    // for accessing vectors
+    ir_value *m_members[3];
+    ir_value *m_memberof;
 
+    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 unique_life;      /* arrays will never overlap with temps      */
-    bool locked;           /* temps living during a CALL must be locked */
-    bool callparam;
+    std::vector<ir_life_entry_t> m_life; // For the temp allocator
 
-    ir_life_entry_t *life; /* For the temp allocator */
-};
+    size_t size() const;
 
-/*
- * 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
- */
-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*,...));
+    void dump(int (*oprintf)(const char*, ...)) const;
+};
 
 /* PHI data */
-typedef struct ir_phi_entry_s {
+struct ir_phi_entry_t {
     ir_value *value;
     ir_block *from;
-} ir_phi_entry_t;
+};
 
 /* instruction */
-struct ir_instr_s {
-    int        opcode;
-    lex_ctx_t  context;
-    ir_value* (_ops[3]);
-    ir_block* (bops[2]);
+struct ir_instr {
+    ir_instr(lex_ctx_t, ir_block *owner, int opcode);
+    ~ir_instr();
 
-    ir_phi_entry_t *phi;
-    ir_value      **params;
+    int m_opcode;
+    lex_ctx_t m_context;
+    ir_value *(_m_ops[3]) = { nullptr, nullptr, nullptr };
+    ir_block *(m_bops[2]) = { nullptr, nullptr };
 
-    /* For the temp-allocation */
-    size_t eid;
+    std::vector<ir_phi_entry_t> m_phi;
+    std::vector<ir_value *> m_params;
+
+    // For the temp-allocation
+    size_t m_eid = 0;
 
-    /* For IFs */
-    bool   likely;
+    // For IFs
+    bool m_likely = true;
 
-    ir_block *owner;
+    ir_block *m_owner;
 };
 
 /* block */
-struct ir_block_s {
-    char      *label;
-    lex_ctx_t  context;
-    bool       final; /* once a jump is added we're done */
+struct ir_block {
+    ir_block(ir_function *owner, const std::string& name);
+    ~ir_block();
 
-    ir_instr **instr;
-    ir_block **entries;
-    ir_block **exits;
-    ir_value **living;
+    ir_function *m_owner;
+    std::string m_label;
 
-    /* For the temp-allocation */
-    size_t entry_id;
-    size_t eid;
-    bool   is_return;
+    lex_ctx_t m_context;
+    bool m_final = false; /* once a jump is added we're done */
 
-    ir_function *owner;
+    ir_instr **m_instr = nullptr;
+    ir_block **m_entries = nullptr;
+    ir_block **m_exits = nullptr;
+    std::vector<ir_value *> m_living;
 
-    bool   generated;
-    size_t code_start;
+    /* 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, int outype);
+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_instr* ir_block_create_phi(ir_block*, lex_ctx_t, 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_t, const char *label, ir_value *func, bool noreturn);
@@ -197,30 +195,36 @@ 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_s {
-    char      *name;
-    int        outtype;
-    int       *params;
-    ir_block **blocks;
-    ir_flag_t  flags;
-    int        builtin;
+struct ir_function {
+    ir_function(ir_builder *owner, qc_type returntype);
+    ~ir_function();
+
+    ir_builder *m_owner;
+
+    std::string m_name;
+    qc_type     m_outtype;
+    int        *m_params  = nullptr;
+    ir_flag_t   m_flags   = 0;
+    int         m_builtin = 0;
+
+    std::vector<std::unique_ptr<ir_block>> m_blocks;
 
     /*
      * 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;
+    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;
 
-    size_t allocated_locals;
-    size_t globaltemps;
+    size_t m_allocated_locals = 0;
+    size_t m_globaltemps      = 0;
 
-    ir_block*  first;
-    ir_block*  last;
+    ir_block*  m_first = nullptr;
+    ir_block*  m_last  = nullptr;
 
-    lex_ctx_t  context;
+    lex_ctx_t  m_context;
 
     /*
      * for prototypes - first we generate all the
@@ -229,19 +233,17 @@ struct ir_function_s {
      *
      * remember the ID:
      */
-    qcint_t code_function_def;
+    qcint_t m_code_function_def = -1;
 
     /* for temp allocation */
-    size_t run_id;
-
-    ir_builder *owner;
+    size_t m_run_id = 0;
 
     /* vararg support: */
-    size_t max_varargs;
+    size_t m_max_varargs = 0;
 };
 
 
-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*);
 ir_block*       ir_function_create_block(lex_ctx_t ctx, ir_function*, const char *label);
 
@@ -249,51 +251,70 @@ ir_block*       ir_function_create_block(lex_ctx_t ctx, ir_function*, const char
 #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;
+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    *vinstr_temp[IR_MAX_VINSTR_TEMPS];
+    ir_value    *m_vinstr_temp[IR_MAX_VINSTR_TEMPS];
 
     /* code generator */
-    code_t      *code;
+    std::unique_ptr<code_t> m_code;
+
+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*);
 };
 
-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*, ...));
-
 /*
  * This code assumes 32 bit floats while generating binary
  * Blub: don't use extern here, it's annoying and shows up in nm