]> git.xonotic.org Git - xonotic/gmqcc.git/blobdiff - exec.c
Fix a very stupid bug in the executor which prevented ADDRESS to have the same global...
[xonotic/gmqcc.git] / exec.c
diff --git a/exec.c b/exec.c
index e30e2fa6905727c4d5a7e2f724f072073ff6c80b..71b8eba2c1486f5ffe40f5f465362826333822b1 100644 (file)
--- a/exec.c
+++ b/exec.c
@@ -1,3 +1,27 @@
+/*
+ * Copyright (C) 2012
+ *     Wolfgang Bumiller
+ *     Dale Weiler
+ *
+ * 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 QCVM_LOOP
 #include <errno.h>
 #include <stdio.h>
 #include <string.h>
@@ -26,6 +50,8 @@ MEM_VEC_FUN_RESIZE(qc_program,  size_t, profile)
 
 MEM_VEC_FUNCTIONS(qc_program,   prog_builtin, builtins)
 
+MEM_VEC_FUNCTIONS(qc_program,   const char*, function_stack)
+
 static void loaderror(const char *fmt, ...)
 {
     int     err = errno;
@@ -351,7 +377,7 @@ static void trace_print_global(qc_program *prog, unsigned int glob, int vtype)
             len = printf("$");
         else
             len = printf("%s ", name);
-        vtype = def->type;
+        vtype = def->type & DEF_TYPEMASK;
     }
     else
         len = printf("[@%u] ", glob);
@@ -393,6 +419,12 @@ static void prog_print_statement(qc_program *prog, prog_section_statement *st)
         printf("<illegal instruction %d>\n", st->opcode);
         return;
     }
+    if ((prog->xflags & VMXF_TRACE) && prog->function_stack_count) {
+        size_t i;
+        for (i = 0; i < prog->function_stack_count; ++i)
+            printf("->");
+        printf("%s:", prog->function_stack[prog->function_stack_count-1]);
+    }
     printf(" <> %-12s", asm_instr[st->opcode].m);
     if (st->opcode >= INSTR_IF &&
         st->opcode <= INSTR_IFNOT)
@@ -403,6 +435,7 @@ static void prog_print_statement(qc_program *prog, prog_section_statement *st)
     else if (st->opcode >= INSTR_CALL0 &&
              st->opcode <= INSTR_CALL8)
     {
+        trace_print_global(prog, st->o1.u1, TYPE_FUNCTION);
         printf("\n");
     }
     else if (st->opcode == INSTR_GOTO)
@@ -489,6 +522,10 @@ static qcint prog_enterfunction(qc_program *prog, prog_section_function *func)
     st.stmt     = prog->statement;
     st.function = func;
 
+    if (prog->xflags & VMXF_TRACE) {
+        (void)!qc_program_function_stack_add(prog, prog_getstring(prog, func->name));
+    }
+
 #ifdef QCVM_BACKUP_STRATEGY_CALLER_VARS
     if (prog->stack_count)
     {
@@ -541,6 +578,11 @@ static qcint prog_leavefunction(qc_program *prog)
 
     qc_exec_stack st = prog->stack[prog->stack_count-1];
 
+    if (prog->xflags & VMXF_TRACE) {
+        if (prog->function_stack_count)
+            prog->function_stack_count--;
+    }
+
 #ifdef QCVM_BACKUP_STRATEGY_CALLER_VARS
     if (prog->stack_count > 1) {
         prev  = prog->stack[prog->stack_count-2].function;
@@ -583,30 +625,31 @@ bool prog_exec(qc_program *prog, prog_section_function *func, size_t flags, long
         default:
         case 0:
         {
+#define QCVM_LOOP    1
 #define QCVM_PROFILE 0
 #define QCVM_TRACE   0
-#           include "execloop.h"
+#           include __FILE__
             break;
         }
         case (VMXF_TRACE):
         {
 #define QCVM_PROFILE 0
 #define QCVM_TRACE   1
-#           include "execloop.h"
+#           include __FILE__
             break;
         }
         case (VMXF_PROFILE):
         {
 #define QCVM_PROFILE 1
 #define QCVM_TRACE   0
-#           include "execloop.h"
+#           include __FILE__
             break;
         }
         case (VMXF_TRACE|VMXF_PROFILE):
         {
 #define QCVM_PROFILE 1
 #define QCVM_TRACE   1
-#           include "execloop.h"
+#           include __FILE__
             break;
         }
     };
@@ -715,6 +758,19 @@ static int qc_vtos(qc_program *prog)
     return 0;
 }
 
+static int qc_etos(qc_program *prog)
+{
+    char buffer[512];
+    qcany *num;
+    qcany str;
+    CheckArgs(1);
+    num = GetArg(0);
+    snprintf(buffer, sizeof(buffer), "%i", num->_int);
+    str.string = prog_tempstring(prog, buffer);
+    Return(str);
+    return 0;
+}
+
 static int qc_spawn(qc_program *prog)
 {
     qcany ent;
@@ -753,7 +809,8 @@ static prog_builtin qc_builtins[] = {
     &qc_kill,  /*   4   */
     &qc_vtos,  /*   5   */
     &qc_error, /*   6   */
-    &qc_vlen   /*   7   */
+    &qc_vlen,  /*   7   */
+    &qc_etos   /*   8   */
 };
 static size_t qc_builtins_count = sizeof(qc_builtins) / sizeof(qc_builtins[0]);
 
@@ -802,6 +859,7 @@ static void prog_main_setparams(qc_program *prog)
     }
 }
 
+void prog_disasm_function(qc_program *prog, size_t id);
 int main(int argc, char **argv)
 {
     size_t      i;
@@ -810,6 +868,7 @@ int main(int argc, char **argv)
     size_t      xflags = VMXF_DEFAULT;
     bool        opts_printfields = false;
     bool        opts_printdefs   = false;
+    bool        opts_disasm      = false;
     bool        opts_info  = false;
 
     arg0 = argv[0];
@@ -833,6 +892,11 @@ int main(int argc, char **argv)
             ++argv;
             opts_info = true;
         }
+        else if (!strcmp(argv[1], "-disasm")) {
+            --argc;
+            ++argv;
+            opts_disasm = true;
+        }
         else if (!strcmp(argv[1], "-printdefs")) {
             --argc;
             ++argv;
@@ -885,7 +949,10 @@ int main(int argc, char **argv)
     prog->builtins_count = qc_builtins_count;
     prog->builtins_alloc = 0;
 
-    printf("Program's system-checksum = 0x%04x\n", (int)prog->crc16);
+    if (opts_info) {
+        printf("Program's system-checksum = 0x%04x\n", (int)prog->crc16);
+        printf("Entity field space: %i\n", (int)prog->entityfields);
+    }
 
     for (i = 1; i < prog->functions_count; ++i) {
         const char *name = prog_getstring(prog, prog->functions[i].name);
@@ -893,15 +960,19 @@ int main(int argc, char **argv)
         if (!strcmp(name, "main"))
             fnmain = (qcint)i;
     }
-    printf("Entity field space: %i\n", (int)prog->entityfields);
     if (opts_info) {
         prog_delete(prog);
         return 0;
     }
+    if (opts_disasm) {
+        for (i = 1; i < prog->functions_count; ++i)
+            prog_disasm_function(prog, i);
+        return 0;
+    }
     if (opts_printdefs) {
         for (i = 0; i < prog->defs_count; ++i) {
             printf("Global: %8s %-16s at %u\n",
-                   type_name[prog->defs[i].type],
+                   type_name[prog->defs[i].type & DEF_TYPEMASK],
                    prog_getstring(prog, prog->defs[i].name),
                    (unsigned int)prog->defs[i].offset);
         }
@@ -928,4 +999,376 @@ int main(int argc, char **argv)
     prog_delete(prog);
     return 0;
 }
+
+void prog_disasm_function(qc_program *prog, size_t id)
+{
+    prog_section_function *fdef = prog->functions + id;
+    prog_section_statement *st;
+
+    if (fdef->entry < 0) {
+        printf("FUNCTION \"%s\" = builtin #%i\n", prog_getstring(prog, fdef->name), (int)-fdef->entry);
+        return;
+    }
+    else
+        printf("FUNCTION \"%s\"\n", prog_getstring(prog, fdef->name));
+
+    st = prog->code + fdef->entry;
+    while (st->opcode != AINSTR_END) {
+        prog_print_statement(prog, st);
+        ++st;
+    }
+}
+#endif
+#else /* !QCVM_LOOP */
+/*
+ * Everything from here on is not including into the compilation of the
+ * executor.  This is simply code that is #included via #include __FILE__
+ * see when QCVM_LOOP is defined, the rest of the code above do not get
+ * re-included.  So this really just acts like one large macro, but it
+ * sort of isn't, which makes it nicer looking.
+ */
+
+#define OPA ( (qcany*) (prog->globals + st->o1.u1) )
+#define OPB ( (qcany*) (prog->globals + st->o2.u1) )
+#define OPC ( (qcany*) (prog->globals + st->o3.u1) )
+
+#define GLOBAL(x) ( (qcany*) (prog->globals + (x)) )
+
+/* to be consistent with current darkplaces behaviour */
+#if !defined(FLOAT_IS_TRUE_FOR_INT)
+#   define FLOAT_IS_TRUE_FOR_INT(x) ( (x) & 0x7FFFFFFF )
+#endif
+
+while (1) {
+       prog_section_function  *newf;
+       qcany          *ed;
+       qcany          *ptr;
+
+    ++st;
+
+#if QCVM_PROFILE
+    prog->profile[st - prog->code]++;
+#endif
+
+#if QCVM_TRACE
+    prog_print_statement(prog, st);
 #endif
+
+    switch (st->opcode)
+    {
+        default:
+            qcvmerror(prog, "Illegal instruction in %s\n", prog->filename);
+            goto cleanup;
+
+               case INSTR_DONE:
+               case INSTR_RETURN:
+                       /* TODO: add instruction count to function profile count */
+                       GLOBAL(OFS_RETURN)->ivector[0] = OPA->ivector[0];
+                       GLOBAL(OFS_RETURN)->ivector[1] = OPA->ivector[1];
+                       GLOBAL(OFS_RETURN)->ivector[2] = OPA->ivector[2];
+
+            st = prog->code + prog_leavefunction(prog);
+            if (!prog->stack_count)
+                goto cleanup;
+
+            break;
+
+               case INSTR_MUL_F:
+                       OPC->_float = OPA->_float * OPB->_float;
+                       break;
+               case INSTR_MUL_V:
+                       OPC->_float = OPA->vector[0]*OPB->vector[0] +
+                                     OPA->vector[1]*OPB->vector[1] +
+                                     OPA->vector[2]*OPB->vector[2];
+                       break;
+               case INSTR_MUL_FV:
+                       OPC->vector[0] = OPA->_float * OPB->vector[0];
+                       OPC->vector[1] = OPA->_float * OPB->vector[1];
+                       OPC->vector[2] = OPA->_float * OPB->vector[2];
+                       break;
+               case INSTR_MUL_VF:
+                       OPC->vector[0] = OPB->_float * OPA->vector[0];
+                       OPC->vector[1] = OPB->_float * OPA->vector[1];
+                       OPC->vector[2] = OPB->_float * OPA->vector[2];
+                       break;
+               case INSTR_DIV_F:
+                       if (OPB->_float != 0.0f)
+                               OPC->_float = OPA->_float / OPB->_float;
+                       else
+                               OPC->_float = 0;
+                       break;
+
+               case INSTR_ADD_F:
+                       OPC->_float = OPA->_float + OPB->_float;
+                       break;
+               case INSTR_ADD_V:
+                       OPC->vector[0] = OPA->vector[0] + OPB->vector[0];
+                       OPC->vector[1] = OPA->vector[1] + OPB->vector[1];
+                       OPC->vector[2] = OPA->vector[2] + OPB->vector[2];
+                       break;
+               case INSTR_SUB_F:
+                       OPC->_float = OPA->_float - OPB->_float;
+                       break;
+               case INSTR_SUB_V:
+                       OPC->vector[0] = OPA->vector[0] - OPB->vector[0];
+                       OPC->vector[1] = OPA->vector[1] - OPB->vector[1];
+                       OPC->vector[2] = OPA->vector[2] - OPB->vector[2];
+                       break;
+
+               case INSTR_EQ_F:
+                       OPC->_float = (OPA->_float == OPB->_float);
+                       break;
+               case INSTR_EQ_V:
+                       OPC->_float = ((OPA->vector[0] == OPB->vector[0]) &&
+                                          (OPA->vector[1] == OPB->vector[1]) &&
+                                          (OPA->vector[2] == OPB->vector[2]) );
+                       break;
+               case INSTR_EQ_S:
+                       OPC->_float = !strcmp(prog_getstring(prog, OPA->string),
+                                             prog_getstring(prog, OPB->string));
+                       break;
+               case INSTR_EQ_E:
+                       OPC->_float = (OPA->_int == OPB->_int);
+                       break;
+               case INSTR_EQ_FNC:
+                       OPC->_float = (OPA->function == OPB->function);
+                       break;
+               case INSTR_NE_F:
+                       OPC->_float = (OPA->_float != OPB->_float);
+                       break;
+               case INSTR_NE_V:
+                       OPC->_float = ((OPA->vector[0] != OPB->vector[0]) ||
+                                      (OPA->vector[1] != OPB->vector[1]) ||
+                                      (OPA->vector[2] != OPB->vector[2]) );
+                       break;
+               case INSTR_NE_S:
+                       OPC->_float = !!strcmp(prog_getstring(prog, OPA->string),
+                                              prog_getstring(prog, OPB->string));
+                       break;
+               case INSTR_NE_E:
+                       OPC->_float = (OPA->_int != OPB->_int);
+                       break;
+               case INSTR_NE_FNC:
+                       OPC->_float = (OPA->function != OPB->function);
+                       break;
+
+               case INSTR_LE:
+                       OPC->_float = (OPA->_float <= OPB->_float);
+                       break;
+               case INSTR_GE:
+                       OPC->_float = (OPA->_float >= OPB->_float);
+                       break;
+               case INSTR_LT:
+                       OPC->_float = (OPA->_float < OPB->_float);
+                       break;
+               case INSTR_GT:
+                       OPC->_float = (OPA->_float > OPB->_float);
+                       break;
+
+               case INSTR_LOAD_F:
+               case INSTR_LOAD_S:
+               case INSTR_LOAD_FLD:
+               case INSTR_LOAD_ENT:
+               case INSTR_LOAD_FNC:
+                       if (OPA->edict < 0 || OPA->edict >= prog->entities) {
+                           qcvmerror(prog, "progs `%s` attempted to read an out of bounds entity", prog->filename);
+                               goto cleanup;
+                       }
+                       if ((unsigned int)(OPB->_int) >= (unsigned int)(prog->entityfields)) {
+                               qcvmerror(prog, "prog `%s` attempted to read an invalid field from entity (%i)",
+                                         prog->filename,
+                                         OPB->_int);
+                               goto cleanup;
+                       }
+                       ed = prog_getedict(prog, OPA->edict);
+                       OPC->_int = ((qcany*)( ((qcint*)ed) + OPB->_int ))->_int;
+                       break;
+               case INSTR_LOAD_V:
+                       if (OPA->edict < 0 || OPA->edict >= prog->entities) {
+                           qcvmerror(prog, "progs `%s` attempted to read an out of bounds entity", prog->filename);
+                               goto cleanup;
+                       }
+                       if (OPB->_int < 0 || OPB->_int + 3 > prog->entityfields)
+                       {
+                               qcvmerror(prog, "prog `%s` attempted to read an invalid field from entity (%i)",
+                                         prog->filename,
+                                         OPB->_int + 2);
+                               goto cleanup;
+                       }
+                       ed = prog_getedict(prog, OPA->edict);
+                       OPC->ivector[0] = ((qcany*)( ((qcint*)ed) + OPB->_int ))->ivector[0];
+                       OPC->ivector[1] = ((qcany*)( ((qcint*)ed) + OPB->_int ))->ivector[1];
+                       OPC->ivector[2] = ((qcany*)( ((qcint*)ed) + OPB->_int ))->ivector[2];
+                       break;
+
+               case INSTR_ADDRESS:
+                       if (OPA->edict < 0 || OPA->edict >= prog->entities) {
+                               qcvmerror(prog, "prog `%s` attempted to address an out of bounds entity %i", prog->filename, OPA->edict);
+                               goto cleanup;
+                       }
+                       if ((unsigned int)(OPB->_int) >= (unsigned int)(prog->entityfields))
+                       {
+                               qcvmerror(prog, "prog `%s` attempted to read an invalid field from entity (%i)",
+                                         prog->filename,
+                                         OPB->_int);
+                               goto cleanup;
+                       }
+
+                       ed = prog_getedict(prog, OPA->edict);
+                       OPC->_int = ((qcint*)ed) - prog->entitydata + OPB->_int;
+                       break;
+
+               case INSTR_STORE_F:
+               case INSTR_STORE_S:
+               case INSTR_STORE_ENT:
+               case INSTR_STORE_FLD:
+               case INSTR_STORE_FNC:
+                       OPB->_int = OPA->_int;
+                       break;
+               case INSTR_STORE_V:
+                       OPB->ivector[0] = OPA->ivector[0];
+                       OPB->ivector[1] = OPA->ivector[1];
+                       OPB->ivector[2] = OPA->ivector[2];
+                       break;
+
+               case INSTR_STOREP_F:
+               case INSTR_STOREP_S:
+               case INSTR_STOREP_ENT:
+               case INSTR_STOREP_FLD:
+               case INSTR_STOREP_FNC:
+                       if (OPB->_int < 0 || OPB->_int >= prog->entitydata_count) {
+                               qcvmerror(prog, "`%s` attempted to write to an out of bounds edict (%i)", prog->filename, OPB->_int);
+                               goto cleanup;
+                       }
+                       if (OPB->_int < prog->entityfields && !prog->allowworldwrites)
+                               qcvmerror(prog, "`%s` tried to assign to world.%s (field %i)\n",
+                                         prog->filename,
+                                         prog_getstring(prog, prog_entfield(prog, OPB->_int)->name),
+                                         OPB->_int);
+                       ptr = (qcany*)(prog->entitydata + OPB->_int);
+                       ptr->_int = OPA->_int;
+                       break;
+               case INSTR_STOREP_V:
+                       if (OPB->_int < 0 || OPB->_int + 2 >= prog->entitydata_count) {
+                               qcvmerror(prog, "`%s` attempted to write to an out of bounds edict (%i)", prog->filename, OPB->_int);
+                               goto cleanup;
+                       }
+                       if (OPB->_int < prog->entityfields && !prog->allowworldwrites)
+                               qcvmerror(prog, "`%s` tried to assign to world.%s (field %i)\n",
+                                         prog->filename,
+                                         prog_getstring(prog, prog_entfield(prog, OPB->_int)->name),
+                                         OPB->_int);
+                       ptr = (qcany*)(prog->entitydata + OPB->_int);
+                       ptr->ivector[0] = OPA->ivector[0];
+                       ptr->ivector[1] = OPA->ivector[1];
+                       ptr->ivector[2] = OPA->ivector[2];
+                       break;
+
+               case INSTR_NOT_F:
+                       OPC->_float = !FLOAT_IS_TRUE_FOR_INT(OPA->_int);
+                       break;
+               case INSTR_NOT_V:
+                       OPC->_float = !OPA->vector[0] &&
+                                     !OPA->vector[1] &&
+                                     !OPA->vector[2];
+                       break;
+               case INSTR_NOT_S:
+                       OPC->_float = !OPA->string ||
+                                     !*prog_getstring(prog, OPA->string);
+                       break;
+               case INSTR_NOT_ENT:
+                       OPC->_float = (OPA->edict == 0);
+                       break;
+               case INSTR_NOT_FNC:
+                       OPC->_float = !OPA->function;
+                       break;
+
+               case INSTR_IF:
+                   /* this is consistent with darkplaces' behaviour */
+                       if(FLOAT_IS_TRUE_FOR_INT(OPA->_int))
+                       {
+                               st += st->o2.s1 - 1;    /* offset the s++ */
+                               if (++jumpcount >= maxjumps)
+                                       qcvmerror(prog, "`%s` hit the runaway loop counter limit of %li jumps", prog->filename, jumpcount);
+                       }
+                       break;
+               case INSTR_IFNOT:
+                       if(!FLOAT_IS_TRUE_FOR_INT(OPA->_int))
+                       {
+                               st += st->o2.s1 - 1;    /* offset the s++ */
+                               if (++jumpcount >= maxjumps)
+                                       qcvmerror(prog, "`%s` hit the runaway loop counter limit of %li jumps", prog->filename, jumpcount);
+                       }
+                       break;
+
+               case INSTR_CALL0:
+               case INSTR_CALL1:
+               case INSTR_CALL2:
+               case INSTR_CALL3:
+               case INSTR_CALL4:
+               case INSTR_CALL5:
+               case INSTR_CALL6:
+               case INSTR_CALL7:
+               case INSTR_CALL8:
+                       prog->argc = st->opcode - INSTR_CALL0;
+                       if (!OPA->function)
+                               qcvmerror(prog, "NULL function in `%s`", prog->filename);
+
+                       if(!OPA->function || OPA->function >= (unsigned int)prog->functions_count)
+                       {
+                               qcvmerror(prog, "CALL outside the program in `%s` (%i)", prog->filename, (int)OPA->function);
+                               goto cleanup;
+                       }
+
+                       newf = &prog->functions[OPA->function];
+                       newf->profile++;
+
+                       prog->statement = (st - prog->code) + 1;
+
+                       if (newf->entry < 0)
+                       {
+                               /* negative statements are built in functions */
+                               int builtinnumber = -newf->entry;
+                               if (builtinnumber < prog->builtins_count && prog->builtins[builtinnumber])
+                                       prog->builtins[builtinnumber](prog);
+                               else
+                                       qcvmerror(prog, "No such builtin #%i in %s! Try updating your gmqcc sources",
+                                                 builtinnumber, prog->filename);
+                       }
+                       else
+                               st = prog->code + prog_enterfunction(prog, newf) - 1; /* offset st++ */
+                       if (prog->vmerror)
+                               goto cleanup;
+                       break;
+
+               case INSTR_STATE:
+                   qcvmerror(prog, "`%s` tried to execute a STATE operation", prog->filename);
+                       break;
+
+               case INSTR_GOTO:
+                       st += st->o1.s1 - 1;    /* offset the s++ */
+                       if (++jumpcount == 10000000)
+                                       qcvmerror(prog, "`%s` hit the runaway loop counter limit of %li jumps", prog->filename, jumpcount);
+                       break;
+
+               case INSTR_AND:
+                       OPC->_float = FLOAT_IS_TRUE_FOR_INT(OPA->_int) &&
+                                     FLOAT_IS_TRUE_FOR_INT(OPB->_int);
+                       break;
+               case INSTR_OR:
+                       OPC->_float = FLOAT_IS_TRUE_FOR_INT(OPA->_int) ||
+                                     FLOAT_IS_TRUE_FOR_INT(OPB->_int);
+                       break;
+
+               case INSTR_BITAND:
+                       OPC->_float = ((int)OPA->_float) & ((int)OPB->_float);
+                       break;
+               case INSTR_BITOR:
+                       OPC->_float = ((int)OPA->_float) | ((int)OPB->_float);
+                       break;
+    }
+}
+
+#undef QCVM_PROFILE
+#undef QCVM_TRACE
+#endif /* !QCVM_LOOP */