]> git.xonotic.org Git - xonotic/gmqcc.git/blobdiff - ir.h
Update doc/specification.tex
[xonotic/gmqcc.git] / ir.h
diff --git a/ir.h b/ir.h
index 6fdeb898082ed884c3028e1ecbc8532727ab6f05..a15607c3ac0a72ec7427e2b3cc79edc63104af97 100644 (file)
--- a/ir.h
+++ b/ir.h
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2012
+ * Copyright (C) 2012, 2013
  *     Wolfgang Bumiller
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy of
@@ -22,7 +22,7 @@
  */
 #ifndef GMQCC_IR_HDR
 #define GMQCC_IR_HDR
-
+#include "gmqcc.h"
 /* ir_value */
 
 typedef struct
@@ -42,21 +42,23 @@ typedef struct ir_value_s {
     int       fieldtype;
     /* and the output type of a function */
     int       outtype;
+    /* 'const' vs 'var' qualifier */
+    int       cvq;
+    uint32_t  flags;
 
-    MEM_VECTOR_MAKE(struct ir_instr_s*, reads);
-    MEM_VECTOR_MAKE(struct ir_instr_s*, writes);
+    struct ir_instr_s **reads;
+    struct ir_instr_s **writes;
 
     /* constantvalues */
-    bool isconst;
+    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;
-        quaternion vquat;
-        matrix     vmat;
     } constval;
 
     struct {
@@ -64,12 +66,28 @@ typedef struct ir_value_s {
         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 */
-    MEM_VECTOR_MAKE(ir_life_entry_t, life);
+    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
@@ -77,10 +95,10 @@ ir_value* ir_value_var(const char *name, int st, int vtype);
  */
 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      ir_value_set_name(ir_value*, const char *name);
+ir_value* ir_value_vector_member(ir_value*, unsigned int member);
 
-MEM_VECTOR_PROTO_ALL(ir_value, struct ir_instr_s*, reads);
-MEM_VECTOR_PROTO_ALL(ir_value, struct ir_instr_s*, writes);
+bool GMQCC_WARN vec_ir_value_find(ir_value **vec, const ir_value *what, size_t *idx);
 
 bool GMQCC_WARN ir_value_set_float(ir_value*, float f);
 bool GMQCC_WARN ir_value_set_func(ir_value*, int f);
@@ -89,12 +107,10 @@ 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);       */
-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);
@@ -105,13 +121,7 @@ bool ir_value_lives(ir_value*, size_t);
 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);
+void ir_value_dump_life(const ir_value *self, int (*oprintf)(const char*,...));
 
 /* PHI data */
 typedef struct ir_phi_entry_s
@@ -128,22 +138,24 @@ typedef struct ir_instr_s
     ir_value* (_ops[3]);
     struct ir_block_s* (bops[2]);
 
-    MEM_VECTOR_MAKE(ir_phi_entry_t, phi);
-    MEM_VECTOR_MAKE(ir_value*, params);
+    ir_phi_entry_t *phi;
+    ir_value      **params;
 
     /* For the temp-allocation */
     size_t eid;
 
+    /* For IFs */
+    bool   likely;
+
     struct ir_block_s *owner;
 } ir_instr;
 
-ir_instr* ir_instr_new(struct ir_block_s *owner, int opcode);
+ir_instr* ir_instr_new(lex_ctx ctx, 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);
+bool GMQCC_WARN vec_ir_instr_find(ir_instr **vec, ir_instr *what, size_t *idx);
 
-MEM_VECTOR_PROTO(ir_value, ir_value*, params);
+bool ir_instr_op(ir_instr*, int op, ir_value *value, bool writing);
 
 void ir_instr_dump(ir_instr* in, char *ind, int (*oprintf)(const char*,...));
 
@@ -154,12 +166,13 @@ typedef struct ir_block_s
     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);
+    ir_instr          **instr;
+    struct ir_block_s **entries;
+    struct ir_block_s **exits;
+    ir_value          **living;
 
     /* For the temp-allocation */
+    size_t entry_id;
     size_t eid;
     bool   is_return;
     size_t run_id;
@@ -175,41 +188,35 @@ void      ir_block_delete(ir_block*);
 
 bool      ir_block_set_label(ir_block*, const char *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);
-
-ir_value* ir_block_create_binop(ir_block*, const char *label, int op,
+ir_value* ir_block_create_binop(ir_block*, lex_ctx, const char *label, int op,
                                 ir_value *left, ir_value *right);
-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_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);
 
 /* 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_load_from_ent(ir_block*, lex_ctx, 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);
+ir_value* ir_block_create_fieldaddress(ir_block*, lex_ctx, const char *label, ir_value *entity, ir_value *field);
 
 /* This is to create an instruction of the form
  * <outtype>%label := opcode a, b
  */
-ir_value* ir_block_create_general_instr(ir_block *self, const char *label,
+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_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, const char *label, int 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, 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, 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, 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
@@ -217,10 +224,8 @@ bool GMQCC_WARN ir_block_create_if(ir_block*, ir_value *cond,
  * 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);
+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*,...));
 
@@ -228,10 +233,12 @@ void ir_block_dump(ir_block*, char *ind, int (*oprintf)(const char*,...));
 
 typedef struct ir_function_s
 {
-    char *name;
-    int   outtype;
-    MEM_VECTOR_MAKE(int, params);
-    MEM_VECTOR_MAKE(ir_block*, blocks);
+    char      *name;
+    int        outtype;
+    int       *params;
+    ir_block **blocks;
+
+    uint32_t   flags;
 
     int builtin;
 
@@ -241,34 +248,49 @@ typedef struct ir_function_s
      * which might get optimized away, so anything
      * in there needs to be deleted in the dtor.
      */
-    MEM_VECTOR_MAKE(ir_value*, values);
+    ir_value **values;
 
     /* locally defined variables */
-    MEM_VECTOR_MAKE(ir_value*, locals);
+    ir_value **locals;
 
     size_t allocated_locals;
+    size_t globaltemps;
 
     ir_block*     first;
     ir_block*     last;
 
     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 code_function_def;
+
     /* for temp allocation */
     size_t run_id;
 
     struct ir_builder_s *owner;
+
+    /* vararg support: */
+    size_t max_varargs;
 } 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_INCLUDE_DEF       (1<<4)
+#define IR_FLAG_MASK_NO_OVERLAP     (IR_FLAG_HAS_ARRAYS | IR_FLAG_HAS_UNINITIALIZED)
+#define IR_FLAG_MASK_NO_LOCAL_TEMPS (IR_FLAG_HAS_ARRAYS | IR_FLAG_HAS_UNINITIALIZED)
 
 ir_function* ir_function_new(struct ir_builder_s *owner, int returntype);
 void         ir_function_delete(ir_function*);
 
-bool GMQCC_WARN ir_function_collect_value(ir_function*, ir_value *value);
+void ir_function_collect_value(ir_function*, ir_value *value);
 
 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);
 
 bool GMQCC_WARN ir_function_finalize(ir_function*);
@@ -278,16 +300,39 @@ bool ir_function_enumerate(ir_function*);
 bool ir_function_calculate_liferanges(ir_function*);
 */
 
-ir_block* ir_function_create_block(ir_function*, const char *label);
+ir_block* ir_function_create_block(lex_ctx ctx, ir_function*, const char *label);
 
 void ir_function_dump(ir_function*, char *ind, int (*oprintf)(const char*,...));
 
 /* builder */
+#define IR_HT_SIZE 1024
 typedef struct ir_builder_s
 {
     char *name;
-    MEM_VECTOR_MAKE(ir_function*, functions);
-    MEM_VECTOR_MAKE(ir_value*, globals);
+    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_value    *reserved_va_count;
 } ir_builder;
 
 ir_builder* ir_builder_new(const char *modulename);
@@ -295,14 +340,15 @@ 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);
-
 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);
+
+ir_value* ir_builder_get_va_count(ir_builder*);
 
 bool ir_builder_generate(ir_builder *self, const char *filename);
 
@@ -310,6 +356,6 @@ 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(( (ir_value*)(NULL) )->constval.vvec.x)) ? 1 : -1 ];
+[ (sizeof(int32_t) == sizeof(qcfloat)) ? 1 : -1 ];
 
 #endif