exec.c

   1 /*
   2  * Copyright (C) 2012
   3  *     Wolfgang Bumiller
   4  *     Dale Weiler
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a copy of
   7  * this software and associated documentation files (the "Software"), to deal in
   8  * the Software without restriction, including without limitation the rights to
   9  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
  10  * of the Software, and to permit persons to whom the Software is furnished to do
  11  * so, subject to the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be included in all
  14  * copies or substantial portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  22  * SOFTWARE.
  23  */
  24 #ifndef QCVM_LOOP
  25 #include <errno.h>
  26 #include <stdio.h>
  27 #include <string.h>
  28 #include <stdarg.h>
  29
  30 #include "gmqcc.h"
  31
  32 /*
  33 (prog_section_statement, code)
  34 (prog_section_def,       defs)
  35 (prog_section_def,       fields)
  36 (prog_section_function,  functions)
  37 (char,                   strings)
  38 (qcint,                  globals)
  39 (qcint,                  entitydata)
  40 (bool,                   entitypool)
  41 (qcint,         localstack)
  42 (qc_exec_stack, stack)
  43 (size_t, profile)
  44 (prog_builtin, builtins)
  45 (const char*, function_stack)
  46 */
  47
  48 static void loaderror(const char *fmt, ...)
  49 {
  50     int     err = errno;
  51     va_list ap;
  52     va_start(ap, fmt);
  53     vprintf(fmt, ap);
  54     va_end(ap);
  55     printf(": %s\n", strerror(err));
  56 }
  57
  58 static void qcvmerror(qc_program *prog, const char *fmt, ...)
  59 {
  60     va_list ap;
  61
  62     prog->vmerror++;
  63
  64     va_start(ap, fmt);
  65     vprintf(fmt, ap);
  66     va_end(ap);
  67     putchar('\n');
  68 }
  69
  70 qc_program* prog_load(const char *filename)
  71 {
  72     qc_program *prog;
  73     prog_header header;
  74     FILE *file;
  75
  76     file = util_fopen(filename, "rb");
  77     if (!file)
  78         return NULL;
  79
  80     if (fread(&header, sizeof(header), 1, file) != 1) {
  81         loaderror("failed to read header from '%s'", filename);
  82         fclose(file);
  83         return NULL;
  84     }
  85
  86     if (header.version != 6) {
  87         loaderror("header says this is a version %i progs, we need version 6\n", header.version);
  88         fclose(file);
  89         return NULL;
  90     }
  91
  92     prog = (qc_program*)mem_a(sizeof(qc_program));
  93     if (!prog) {
  94         fclose(file);
  95         printf("failed to allocate program data\n");
  96         return NULL;
  97     }
  98     memset(prog, 0, sizeof(*prog));
  99
 100     prog->entityfields = header.entfield;
 101     prog->crc16 = header.crc16;
 102
 103     prog->filename = util_strdup(filename);
 104     if (!prog->filename) {
 105         loaderror("failed to store program name");
 106         goto error;
 107     }
 108
 109 #define read_data(hdrvar, progvar, reserved)                           \
 110     if (fseek(file, header.hdrvar.offset, SEEK_SET) != 0) {            \
 111         loaderror("seek failed");                                      \
 112         goto error;                                                    \
 113     }                                                                  \
 114     if (fread(vec_add(prog->progvar, header.hdrvar.length + reserved), \
 115               sizeof(*prog->progvar),                                  \
 116               header.hdrvar.length, file)                              \
 117         != header.hdrvar.length)                                       \
 118     {                                                                  \
 119         loaderror("read failed");                                      \
 120         goto error;                                                    \
 121     }
 122 #define read_data1(x)    read_data(x, x, 0)
 123 #define read_data2(x, y) read_data(x, x, y)
 124
 125     read_data (statements, code, 0);
 126     read_data1(defs);
 127     read_data1(fields);
 128     read_data1(functions);
 129     read_data1(strings);
 130     read_data2(globals, 2); /* reserve more in case a RETURN using with the global at "the end" exists */
 131
 132     fclose(file);
 133
 134     /* profile counters */
 135     memset(vec_add(prog->profile, vec_size(prog->code)), 0, sizeof(prog->profile[0]) * vec_size(prog->code));
 136
 137     /* Add tempstring area */
 138     prog->tempstring_start = vec_size(prog->strings);
 139     prog->tempstring_at    = vec_size(prog->strings);
 140     memset(vec_add(prog->strings, 16*1024), 0, 16*1024);
 141
 142     /* spawn the world entity */
 143     vec_push(prog->entitypool, true);
 144     memset(vec_add(prog->entitydata, prog->entityfields), 0, prog->entityfields * sizeof(prog->entitydata[0]));
 145     prog->entities = 1;
 146
 147     return prog;
 148
 149 error:
 150     if (prog->filename)
 151         mem_d(prog->filename);
 152     vec_free(prog->code);
 153     vec_free(prog->defs);
 154     vec_free(prog->fields);
 155     vec_free(prog->functions);
 156     vec_free(prog->strings);
 157     vec_free(prog->globals);
 158     vec_free(prog->entitydata);
 159     vec_free(prog->entitypool);
 160     mem_d(prog);
 161     return NULL;
 162 }
 163
 164 void prog_delete(qc_program *prog)
 165 {
 166     if (prog->filename) mem_d(prog->filename);
 167     vec_free(prog->code);
 168     vec_free(prog->defs);
 169     vec_free(prog->fields);
 170     vec_free(prog->functions);
 171     vec_free(prog->strings);
 172     vec_free(prog->globals);
 173     vec_free(prog->entitydata);
 174     vec_free(prog->entitypool);
 175     vec_free(prog->localstack);
 176     vec_free(prog->stack);
 177     vec_free(prog->profile);
 178     mem_d(prog);
 179 }
 180
 181 /***********************************************************************
 182  * VM code
 183  */
 184
 185 char* prog_getstring(qc_program *prog, qcint str)
 186 {
 187     if (str < 0 || str >= (qcint)vec_size(prog->strings))
 188         return "<<<invalid string>>>";
 189     return prog->strings + str;
 190 }
 191
 192 prog_section_def* prog_entfield(qc_program *prog, qcint off)
 193 {
 194     size_t i;
 195     for (i = 0; i < vec_size(prog->fields); ++i) {
 196         if (prog->fields[i].offset == off)
 197             return (prog->fields + i);
 198     }
 199     return NULL;
 200 }
 201
 202 prog_section_def* prog_getdef(qc_program *prog, qcint off)
 203 {
 204     size_t i;
 205     for (i = 0; i < vec_size(prog->defs); ++i) {
 206         if (prog->defs[i].offset == off)
 207             return (prog->defs + i);
 208     }
 209     return NULL;
 210 }
 211
 212 qcany* prog_getedict(qc_program *prog, qcint e)
 213 {
 214     if (e >= (qcint)vec_size(prog->entitypool)) {
 215         prog->vmerror++;
 216         printf("Accessing out of bounds edict %i\n", (int)e);
 217         e = 0;
 218     }
 219     return (qcany*)(prog->entitydata + (prog->entityfields * e));
 220 }
 221
 222 qcint prog_spawn_entity(qc_program *prog)
 223 {
 224     char  *data;
 225     qcint  e;
 226     for (e = 0; e < (qcint)vec_size(prog->entitypool); ++e) {
 227         if (!prog->entitypool[e]) {
 228             data = (char*)(prog->entitydata + (prog->entityfields * e));
 229             memset(data, 0, prog->entityfields * sizeof(qcint));
 230             return e;
 231         }
 232     }
 233     vec_push(prog->entitypool, true);
 234     prog->entities++;
 235     data = (char*)vec_add(prog->entitydata, prog->entityfields);
 236     memset(data, 0, prog->entityfields * sizeof(qcint));
 237     return e;
 238 }
 239
 240 void prog_free_entity(qc_program *prog, qcint e)
 241 {
 242     if (!e) {
 243         prog->vmerror++;
 244         printf("Trying to free world entity\n");
 245         return;
 246     }
 247     if (e >= (qcint)vec_size(prog->entitypool)) {
 248         prog->vmerror++;
 249         printf("Trying to free out of bounds entity\n");
 250         return;
 251     }
 252     if (!prog->entitypool[e]) {
 253         prog->vmerror++;
 254         printf("Double free on entity\n");
 255         return;
 256     }
 257     prog->entitypool[e] = false;
 258 }
 259
 260 qcint prog_tempstring(qc_program *prog, const char *_str)
 261 {
 262     /* we don't access it, but the macro-generated functions don't use
 263      * const
 264      */
 265     char *str = (char*)_str;
 266
 267     size_t len = strlen(str);
 268     size_t at = prog->tempstring_at;
 269
 270     /* when we reach the end we start over */
 271     if (at + len >= vec_size(prog->strings))
 272         at = prog->tempstring_start;
 273
 274     /* when it doesn't fit, reallocate */
 275     if (at + len >= vec_size(prog->strings))
 276     {
 277         (void)vec_add(prog->strings, len+1);
 278         memcpy(prog->strings + at, str, len+1);
 279         return at;
 280     }
 281
 282     /* when it fits, just copy */
 283     memcpy(prog->strings + at, str, len+1);
 284     prog->tempstring_at += len+1;
 285     return at;
 286 }
 287
 288 static size_t print_escaped_string(const char *str, size_t maxlen)
 289 {
 290     size_t len = 2;
 291     putchar('"');
 292     --maxlen; /* because we're lazy and have escape sequences */
 293     while (*str) {
 294         if (len >= maxlen) {
 295             putchar('.');
 296             putchar('.');
 297             putchar('.');
 298             len += 3;
 299             break;
 300         }
 301         switch (*str) {
 302             case '\a': len += 2; putchar('\\'); putchar('a'); break;
 303             case '\b': len += 2; putchar('\\'); putchar('b'); break;
 304             case '\r': len += 2; putchar('\\'); putchar('r'); break;
 305             case '\n': len += 2; putchar('\\'); putchar('n'); break;
 306             case '\t': len += 2; putchar('\\'); putchar('t'); break;
 307             case '\f': len += 2; putchar('\\'); putchar('f'); break;
 308             case '\v': len += 2; putchar('\\'); putchar('v'); break;
 309             case '\\': len += 2; putchar('\\'); putchar('\\'); break;
 310             case '"':  len += 2; putchar('\\'); putchar('"'); break;
 311             default:
 312                 ++len;
 313                 putchar(*str);
 314                 break;
 315         }
 316         ++str;
 317     }
 318     putchar('"');
 319     return len;
 320 }
 321
 322 static void trace_print_global(qc_program *prog, unsigned int glob, int vtype)
 323 {
 324     static char spaces[28+1] = "                            ";
 325     prog_section_def *def;
 326     qcany    *value;
 327     int       len;
 328
 329     if (!glob) {
 330         len = printf("<null>,");
 331         goto done;
 332     }
 333
 334     def = prog_getdef(prog, glob);
 335     value = (qcany*)(&prog->globals[glob]);
 336
 337     len = printf("[@%u] ", glob);
 338     if (def) {
 339         const char *name = prog_getstring(prog, def->name);
 340         if (name[0] == '#')
 341             len += printf("$");
 342         else
 343             len += printf("%s ", name);
 344         vtype = def->type & DEF_TYPEMASK;
 345     }
 346
 347     switch (vtype) {
 348         case TYPE_VOID:
 349         case TYPE_ENTITY:
 350         case TYPE_FIELD:
 351         case TYPE_FUNCTION:
 352         case TYPE_POINTER:
 353             len += printf("(%i),", value->_int);
 354             break;
 355         case TYPE_VECTOR:
 356             len += printf("'%g %g %g',", value->vector[0],
 357                                          value->vector[1],
 358                                          value->vector[2]);
 359             break;
 360         case TYPE_STRING:
 361             len += print_escaped_string(prog_getstring(prog, value->string), sizeof(spaces)-len-5);
 362             len += printf(",");
 363             /* len += printf("\"%s\",", prog_getstring(prog, value->string)); */
 364             break;
 365         case TYPE_FLOAT:
 366         default:
 367             len += printf("%g,", value->_float);
 368             break;
 369     }
 370 done:
 371     if (len < (int)sizeof(spaces)-1) {
 372         spaces[sizeof(spaces)-1-len] = 0;
 373         printf(spaces);
 374         spaces[sizeof(spaces)-1-len] = ' ';
 375     }
 376 }
 377
 378 static void prog_print_statement(qc_program *prog, prog_section_statement *st)
 379 {
 380     if (st->opcode >= (sizeof(asm_instr)/sizeof(asm_instr[0]))) {
 381         printf("<illegal instruction %d>\n", st->opcode);
 382         return;
 383     }
 384     if ((prog->xflags & VMXF_TRACE) && vec_size(prog->function_stack)) {
 385         size_t i;
 386         for (i = 0; i < vec_size(prog->function_stack); ++i)
 387             printf("->");
 388         printf("%s:", vec_last(prog->function_stack));
 389     }
 390     printf(" <> %-12s", asm_instr[st->opcode].m);
 391     if (st->opcode >= INSTR_IF &&
 392         st->opcode <= INSTR_IFNOT)
 393     {
 394         trace_print_global(prog, st->o1.u1, TYPE_FLOAT);
 395         printf("%d\n", st->o2.s1);
 396     }
 397     else if (st->opcode >= INSTR_CALL0 &&
 398              st->opcode <= INSTR_CALL8)
 399     {
 400         trace_print_global(prog, st->o1.u1, TYPE_FUNCTION);
 401         printf("\n");
 402     }
 403     else if (st->opcode == INSTR_GOTO)
 404     {
 405         printf("%i\n", st->o1.s1);
 406     }
 407     else
 408     {
 409         int t[3] = { TYPE_FLOAT, TYPE_FLOAT, TYPE_FLOAT };
 410         switch (st->opcode)
 411         {
 412             case INSTR_MUL_FV:
 413                 t[1] = t[2] = TYPE_VECTOR;
 414                 break;
 415             case INSTR_MUL_VF:
 416                 t[0] = t[2] = TYPE_VECTOR;
 417                 break;
 418             case INSTR_MUL_V:
 419                 t[0] = t[1] = TYPE_VECTOR;
 420                 break;
 421             case INSTR_ADD_V:
 422             case INSTR_SUB_V:
 423             case INSTR_EQ_V:
 424             case INSTR_NE_V:
 425                 t[0] = t[1] = t[2] = TYPE_VECTOR;
 426                 break;
 427             case INSTR_EQ_S:
 428             case INSTR_NE_S:
 429                 t[0] = t[1] = TYPE_STRING;
 430                 break;
 431             case INSTR_STORE_F:
 432             case INSTR_STOREP_F:
 433                 t[2] = -1;
 434                 break;
 435             case INSTR_STORE_V:
 436                 t[0] = t[1] = TYPE_VECTOR; t[2] = -1;
 437                 break;
 438             case INSTR_STORE_S:
 439                 t[0] = t[1] = TYPE_STRING; t[2] = -1;
 440                 break;
 441             case INSTR_STORE_ENT:
 442                 t[0] = t[1] = TYPE_ENTITY; t[2] = -1;
 443                 break;
 444             case INSTR_STORE_FLD:
 445                 t[0] = t[1] = TYPE_FIELD; t[2] = -1;
 446                 break;
 447             case INSTR_STORE_FNC:
 448                 t[0] = t[1] = TYPE_FUNCTION; t[2] = -1;
 449                 break;
 450             case INSTR_STOREP_V:
 451                 t[0] = TYPE_VECTOR; t[1] = TYPE_ENTITY; t[2] = -1;
 452                 break;
 453             case INSTR_STOREP_S:
 454                 t[0] = TYPE_STRING; t[1] = TYPE_ENTITY; t[2] = -1;
 455                 break;
 456             case INSTR_STOREP_ENT:
 457                 t[0] = TYPE_ENTITY; t[1] = TYPE_ENTITY; t[2] = -1;
 458                 break;
 459             case INSTR_STOREP_FLD:
 460                 t[0] = TYPE_FIELD; t[1] = TYPE_ENTITY; t[2] = -1;
 461                 break;
 462             case INSTR_STOREP_FNC:
 463                 t[0] = TYPE_FUNCTION; t[1] = TYPE_ENTITY; t[2] = -1;
 464                 break;
 465         }
 466         if (t[0] >= 0) trace_print_global(prog, st->o1.u1, t[0]);
 467         else           printf("(none),          ");
 468         if (t[1] >= 0) trace_print_global(prog, st->o2.u1, t[1]);
 469         else           printf("(none),          ");
 470         if (t[2] >= 0) trace_print_global(prog, st->o3.u1, t[2]);
 471         else           printf("(none)");
 472         printf("\n");
 473     }
 474     fflush(stdout);
 475 }
 476
 477 static qcint prog_enterfunction(qc_program *prog, prog_section_function *func)
 478 {
 479     qc_exec_stack st;
 480     size_t p, parampos;
 481
 482     /* back up locals */
 483     st.localsp  = vec_size(prog->localstack);
 484     st.stmt     = prog->statement;
 485     st.function = func;
 486
 487     if (prog->xflags & VMXF_TRACE) {
 488         vec_push(prog->function_stack, prog_getstring(prog, func->name));
 489     }
 490
 491 #ifdef QCVM_BACKUP_STRATEGY_CALLER_VARS
 492     if (vec_size(prog->stack))
 493     {
 494         prog_section_function *cur;
 495         cur = prog->stack[vec_size(prog->stack)-1].function;
 496         if (cur)
 497         {
 498             qcint *globals = prog->globals + cur->firstlocal;
 499             vec_append(prog->localstack, cur->locals, globals);
 500         }
 501     }
 502 #else
 503     {
 504         qcint *globals = prog->globals + func->firstlocal;
 505         vec_append(prog->localstack, func->locals, globals);
 506     }
 507 #endif
 508
 509     /* copy parameters */
 510     parampos = func->firstlocal;
 511     for (p = 0; p < func->nargs; ++p)
 512     {
 513         size_t s;
 514         for (s = 0; s < func->argsize[p]; ++s) {
 515             prog->globals[parampos] = prog->globals[OFS_PARM0 + 3*p + s];
 516             ++parampos;
 517         }
 518     }
 519
 520     vec_push(prog->stack, st);
 521
 522     return func->entry;
 523 }
 524
 525 static qcint prog_leavefunction(qc_program *prog)
 526 {
 527     prog_section_function *prev = NULL;
 528     size_t oldsp;
 529
 530     qc_exec_stack st = vec_last(prog->stack);
 531
 532     if (prog->xflags & VMXF_TRACE) {
 533         if (vec_size(prog->function_stack))
 534             vec_pop(prog->function_stack);
 535     }
 536
 537 #ifdef QCVM_BACKUP_STRATEGY_CALLER_VARS
 538     if (vec_size(prog->stack) > 1) {
 539         prev  = prog->stack[vec_size(prog->stack)-2].function;
 540         oldsp = prog->stack[vec_size(prog->stack)-2].localsp;
 541     }
 542 #else
 543     prev  = prog->stack[vec_size(prog->stack)-1].function;
 544     oldsp = prog->stack[vec_size(prog->stack)-1].localsp;
 545 #endif
 546     if (prev) {
 547         qcint *globals = prog->globals + prev->firstlocal;
 548         memcpy(globals, prog->localstack + oldsp, prev->locals);
 549         /* vec_remove(prog->localstack, oldsp, vec_size(prog->localstack)-oldsp); */
 550         vec_shrinkto(prog->localstack, oldsp);
 551     }
 552
 553     vec_pop(prog->stack);
 554
 555     return st.stmt - 1; /* offset the ++st */
 556 }
 557
 558 bool prog_exec(qc_program *prog, prog_section_function *func, size_t flags, long maxjumps)
 559 {
 560     long jumpcount = 0;
 561     size_t oldxflags = prog->xflags;
 562     prog_section_statement *st;
 563
 564     prog->vmerror = 0;
 565     prog->xflags = flags;
 566
 567     st = prog->code + prog_enterfunction(prog, func);
 568     --st;
 569     switch (flags)
 570     {
 571         default:
 572         case 0:
 573         {
 574 #define QCVM_LOOP    1
 575 #define QCVM_PROFILE 0
 576 #define QCVM_TRACE   0
 577 #           include __FILE__
 578             break;
 579         }
 580         case (VMXF_TRACE):
 581         {
 582 #define QCVM_PROFILE 0
 583 #define QCVM_TRACE   1
 584 #           include __FILE__
 585             break;
 586         }
 587         case (VMXF_PROFILE):
 588         {
 589 #define QCVM_PROFILE 1
 590 #define QCVM_TRACE   0
 591 #           include __FILE__
 592             break;
 593         }
 594         case (VMXF_TRACE|VMXF_PROFILE):
 595         {
 596 #define QCVM_PROFILE 1
 597 #define QCVM_TRACE   1
 598 #           include __FILE__
 599             break;
 600         }
 601     };
 602
 603 cleanup:
 604     prog->xflags = oldxflags;
 605     vec_free(prog->localstack);
 606     vec_free(prog->stack);
 607     if (prog->vmerror)
 608         return false;
 609     return true;
 610 }
 611
 612 /***********************************************************************
 613  * main for when building the standalone executor
 614  */
 615
 616 #if defined(QCVM_EXECUTOR)
 617 #include <math.h>
 618
 619 const char *type_name[TYPE_COUNT] = {
 620     "void",
 621     "string",
 622     "float",
 623     "vector",
 624     "entity",
 625     "field",
 626     "function",
 627     "pointer",
 628 #if 0
 629     "integer",
 630 #endif
 631     "variant"
 632 };
 633
 634 bool        opts_debug    = false;
 635 bool        opts_memchk   = false;
 636 uint32_t    opts_warn [1 + (COUNT_WARNINGS / 32)];
 637 bool        opts_werror   = false;
 638
 639 typedef struct {
 640     int         vtype;
 641     const char *value;
 642 } qcvm_parameter;
 643
 644 qcvm_parameter *main_params = NULL;
 645
 646 #define CheckArgs(num) do {                                                    \
 647     if (prog->argc != (num)) {                                                 \
 648         prog->vmerror++;                                                       \
 649         printf("ERROR: invalid number of arguments for %s: %i, expected %i\n", \
 650         __FUNCTION__, prog->argc, (num));                                      \
 651         return -1;                                                             \
 652     }                                                                          \
 653 } while (0)
 654
 655 #define GetGlobal(idx) ((qcany*)(prog->globals + (idx)))
 656 #define GetArg(num) GetGlobal(OFS_PARM0 + 3*(num))
 657 #define Return(any) *(GetGlobal(OFS_RETURN)) = (any)
 658
 659 static int qc_print(qc_program *prog)
 660 {
 661     size_t i;
 662     const char *laststr = NULL;
 663     for (i = 0; i < (size_t)prog->argc; ++i) {
 664         qcany *str = (qcany*)(prog->globals + OFS_PARM0 + 3*i);
 665         printf("%s", (laststr = prog_getstring(prog, str->string)));
 666     }
 667     if (laststr && (prog->xflags & VMXF_TRACE)) {
 668         size_t len = strlen(laststr);
 669         if (!len || laststr[len-1] != '\n')
 670             printf("\n");
 671     }
 672     return 0;
 673 }
 674
 675 static int qc_error(qc_program *prog)
 676 {
 677     printf("*** VM raised an error:\n");
 678     qc_print(prog);
 679     prog->vmerror++;
 680     return -1;
 681 }
 682
 683 static int qc_ftos(qc_program *prog)
 684 {
 685     char buffer[512];
 686     qcany *num;
 687     qcany str;
 688     CheckArgs(1);
 689     num = GetArg(0);
 690     snprintf(buffer, sizeof(buffer), "%g", num->_float);
 691     str.string = prog_tempstring(prog, buffer);
 692     Return(str);
 693     return 0;
 694 }
 695
 696 static int qc_vtos(qc_program *prog)
 697 {
 698     char buffer[512];
 699     qcany *num;
 700     qcany str;
 701     CheckArgs(1);
 702     num = GetArg(0);
 703     snprintf(buffer, sizeof(buffer), "'%g %g %g'", num->vector[0], num->vector[1], num->vector[2]);
 704     str.string = prog_tempstring(prog, buffer);
 705     Return(str);
 706     return 0;
 707 }
 708
 709 static int qc_etos(qc_program *prog)
 710 {
 711     char buffer[512];
 712     qcany *num;
 713     qcany str;
 714     CheckArgs(1);
 715     num = GetArg(0);
 716     snprintf(buffer, sizeof(buffer), "%i", num->_int);
 717     str.string = prog_tempstring(prog, buffer);
 718     Return(str);
 719     return 0;
 720 }
 721
 722 static int qc_spawn(qc_program *prog)
 723 {
 724     qcany ent;
 725     CheckArgs(0);
 726     ent.edict = prog_spawn_entity(prog);
 727     Return(ent);
 728     return (ent.edict ? 0 : -1);
 729 }
 730
 731 static int qc_kill(qc_program *prog)
 732 {
 733     qcany *ent;
 734     CheckArgs(1);
 735     ent = GetArg(0);
 736     prog_free_entity(prog, ent->edict);
 737     return 0;
 738 }
 739
 740 static int qc_vlen(qc_program *prog)
 741 {
 742     qcany *vec, len;
 743     CheckArgs(1);
 744     vec = GetArg(0);
 745     len._float = sqrt(vec->vector[0] * vec->vector[0] +
 746                       vec->vector[1] * vec->vector[1] +
 747                       vec->vector[2] * vec->vector[2]);
 748     Return(len);
 749     return 0;
 750 }
 751
 752 static prog_builtin qc_builtins[] = {
 753     NULL,
 754     &qc_print, /*   1   */
 755     &qc_ftos,  /*   2   */
 756     &qc_spawn, /*   3   */
 757     &qc_kill,  /*   4   */
 758     &qc_vtos,  /*   5   */
 759     &qc_error, /*   6   */
 760     &qc_vlen,  /*   7   */
 761     &qc_etos   /*   8   */
 762 };
 763 static size_t qc_builtins_count = sizeof(qc_builtins) / sizeof(qc_builtins[0]);
 764
 765 static const char *arg0 = NULL;
 766
 767 void usage()
 768 {
 769     printf("usage: [-debug] %s file\n", arg0);
 770     exit(1);
 771 }
 772
 773 static void prog_main_setparams(qc_program *prog)
 774 {
 775     size_t i;
 776     qcany *arg;
 777
 778     for (i = 0; i < vec_size(main_params); ++i) {
 779         arg = GetGlobal(OFS_PARM0 + 3*i);
 780         arg->vector[0] = 0;
 781         arg->vector[1] = 0;
 782         arg->vector[2] = 0;
 783         switch (main_params[i].vtype) {
 784             case TYPE_VECTOR:
 785 #ifdef WIN32
 786                 (void)sscanf_s(main_params[i].value, " %f %f %f ",
 787                                &arg->vector[0],
 788                                &arg->vector[1],
 789                                &arg->vector[2]);
 790 #else
 791                 (void)sscanf(main_params[i].value, " %f %f %f ",
 792                              &arg->vector[0],
 793                              &arg->vector[1],
 794                              &arg->vector[2]);
 795 #endif
 796                 break;
 797             case TYPE_FLOAT:
 798                 arg->_float = atof(main_params[i].value);
 799                 break;
 800             case TYPE_STRING:
 801                 arg->string = prog_tempstring(prog, main_params[i].value);
 802                 break;
 803             default:
 804                 printf("error: unhandled parameter type: %i\n", main_params[i].vtype);
 805                 break;
 806         }
 807     }
 808 }
 809
 810 void prog_disasm_function(qc_program *prog, size_t id);
 811 int main(int argc, char **argv)
 812 {
 813     size_t      i;
 814     qcint       fnmain = -1;
 815     qc_program *prog;
 816     size_t      xflags = VMXF_DEFAULT;
 817     bool        opts_printfields = false;
 818     bool        opts_printdefs   = false;
 819     bool        opts_disasm      = false;
 820     bool        opts_info  = false;
 821
 822     arg0 = argv[0];
 823
 824     if (argc < 2)
 825         usage();
 826
 827     while (argc > 2) {
 828         if (!strcmp(argv[1], "-trace")) {
 829             --argc;
 830             ++argv;
 831             xflags |= VMXF_TRACE;
 832         }
 833         else if (!strcmp(argv[1], "-profile")) {
 834             --argc;
 835             ++argv;
 836             xflags |= VMXF_PROFILE;
 837         }
 838         else if (!strcmp(argv[1], "-info")) {
 839             --argc;
 840             ++argv;
 841             opts_info = true;
 842         }
 843         else if (!strcmp(argv[1], "-disasm")) {
 844             --argc;
 845             ++argv;
 846             opts_disasm = true;
 847         }
 848         else if (!strcmp(argv[1], "-printdefs")) {
 849             --argc;
 850             ++argv;
 851             opts_printdefs = true;
 852         }
 853         else if (!strcmp(argv[1], "-printfields")) {
 854             --argc;
 855             ++argv;
 856             opts_printfields = true;
 857         }
 858         else if (!strcmp(argv[1], "-vector") ||
 859                  !strcmp(argv[1], "-string") ||
 860                  !strcmp(argv[1], "-float") )
 861         {
 862             qcvm_parameter p;
 863             if (argv[1][1] == 'f')
 864                 p.vtype = TYPE_FLOAT;
 865             else if (argv[1][1] == 's')
 866                 p.vtype = TYPE_STRING;
 867             else if (argv[1][1] == 'v')
 868                 p.vtype = TYPE_VECTOR;
 869
 870             --argc;
 871             ++argv;
 872             if (argc < 3)
 873                 usage();
 874             p.value = argv[1];
 875
 876             vec_push(main_params, p);
 877             --argc;
 878             ++argv;
 879         }
 880         else
 881             usage();
 882     }
 883
 884
 885     prog = prog_load(argv[1]);
 886     if (!prog) {
 887         printf("failed to load program '%s'\n", argv[1]);
 888         exit(1);
 889     }
 890
 891     prog->builtins       = qc_builtins;
 892     prog->builtins_count = qc_builtins_count;
 893
 894     if (opts_info) {
 895         printf("Program's system-checksum = 0x%04x\n", (unsigned int)prog->crc16);
 896         printf("Entity field space: %u\n", (unsigned int)prog->entityfields);
 897         printf("Globals: %u\n", (unsigned int)vec_size(prog->globals));
 898     }
 899
 900     for (i = 1; i < vec_size(prog->functions); ++i) {
 901         const char *name = prog_getstring(prog, prog->functions[i].name);
 902         /* printf("Found function: %s\n", name); */
 903         if (!strcmp(name, "main"))
 904             fnmain = (qcint)i;
 905     }
 906     if (opts_info) {
 907         prog_delete(prog);
 908         return 0;
 909     }
 910     if (opts_disasm) {
 911         for (i = 1; i < vec_size(prog->functions); ++i)
 912             prog_disasm_function(prog, i);
 913         return 0;
 914     }
 915     if (opts_printdefs) {
 916         for (i = 0; i < vec_size(prog->defs); ++i) {
 917             printf("Global: %8s %-16s at %u\n",
 918                    type_name[prog->defs[i].type & DEF_TYPEMASK],
 919                    prog_getstring(prog, prog->defs[i].name),
 920                    (unsigned int)prog->defs[i].offset);
 921         }
 922     }
 923     else if (opts_printfields) {
 924         for (i = 0; i < vec_size(prog->fields); ++i) {
 925             printf("Field: %8s %-16s at %u\n",
 926                    type_name[prog->fields[i].type],
 927                    prog_getstring(prog, prog->fields[i].name),
 928                    (unsigned int)prog->fields[i].offset);
 929         }
 930     }
 931     else
 932     {
 933         if (fnmain > 0)
 934         {
 935             prog_main_setparams(prog);
 936             prog_exec(prog, &prog->functions[fnmain], xflags, VM_JUMPS_DEFAULT);
 937         }
 938         else
 939             printf("No main function found\n");
 940     }
 941
 942     prog_delete(prog);
 943     return 0;
 944 }
 945
 946 void prog_disasm_function(qc_program *prog, size_t id)
 947 {
 948     prog_section_function *fdef = prog->functions + id;
 949     prog_section_statement *st;
 950
 951     if (fdef->entry < 0) {
 952         printf("FUNCTION \"%s\" = builtin #%i\n", prog_getstring(prog, fdef->name), (int)-fdef->entry);
 953         return;
 954     }
 955     else
 956         printf("FUNCTION \"%s\"\n", prog_getstring(prog, fdef->name));
 957
 958     st = prog->code + fdef->entry;
 959     while (st->opcode != AINSTR_END) {
 960         prog_print_statement(prog, st);
 961         ++st;
 962     }
 963 }
 964 #endif
 965 #else /* !QCVM_LOOP */
 966 /*
 967  * Everything from here on is not including into the compilation of the
 968  * executor.  This is simply code that is #included via #include __FILE__
 969  * see when QCVM_LOOP is defined, the rest of the code above do not get
 970  * re-included.  So this really just acts like one large macro, but it
 971  * sort of isn't, which makes it nicer looking.
 972  */
 973
 974 #define OPA ( (qcany*) (prog->globals + st->o1.u1) )
 975 #define OPB ( (qcany*) (prog->globals + st->o2.u1) )
 976 #define OPC ( (qcany*) (prog->globals + st->o3.u1) )
 977
 978 #define GLOBAL(x) ( (qcany*) (prog->globals + (x)) )
 979
 980 /* to be consistent with current darkplaces behaviour */
 981 #if !defined(FLOAT_IS_TRUE_FOR_INT)
 982 #   define FLOAT_IS_TRUE_FOR_INT(x) ( (x) & 0x7FFFFFFF )
 983 #endif
 984
 985 while (1) {
 986     prog_section_function  *newf;
 987     qcany          *ed;
 988     qcany          *ptr;
 989
 990     ++st;
 991
 992 #if QCVM_PROFILE
 993     prog->profile[st - prog->code]++;
 994 #endif
 995
 996 #if QCVM_TRACE
 997     prog_print_statement(prog, st);
 998 #endif
 999
1000     switch (st->opcode)
1001     {
1002         default:
1003             qcvmerror(prog, "Illegal instruction in %s\n", prog->filename);
1004             goto cleanup;
1005
1006         case INSTR_DONE:
1007         case INSTR_RETURN:
1008             /* TODO: add instruction count to function profile count */
1009             GLOBAL(OFS_RETURN)->ivector[0] = OPA->ivector[0];
1010             GLOBAL(OFS_RETURN)->ivector[1] = OPA->ivector[1];
1011             GLOBAL(OFS_RETURN)->ivector[2] = OPA->ivector[2];
1012
1013             st = prog->code + prog_leavefunction(prog);
1014             if (!vec_size(prog->stack))
1015                 goto cleanup;
1016
1017             break;
1018
1019         case INSTR_MUL_F:
1020             OPC->_float = OPA->_float * OPB->_float;
1021             break;
1022         case INSTR_MUL_V:
1023             OPC->_float = OPA->vector[0]*OPB->vector[0] +
1024                           OPA->vector[1]*OPB->vector[1] +
1025                           OPA->vector[2]*OPB->vector[2];
1026             break;
1027         case INSTR_MUL_FV:
1028             OPC->vector[0] = OPA->_float * OPB->vector[0];
1029             OPC->vector[1] = OPA->_float * OPB->vector[1];
1030             OPC->vector[2] = OPA->_float * OPB->vector[2];
1031             break;
1032         case INSTR_MUL_VF:
1033             OPC->vector[0] = OPB->_float * OPA->vector[0];
1034             OPC->vector[1] = OPB->_float * OPA->vector[1];
1035             OPC->vector[2] = OPB->_float * OPA->vector[2];
1036             break;
1037         case INSTR_DIV_F:
1038             if (OPB->_float != 0.0f)
1039                 OPC->_float = OPA->_float / OPB->_float;
1040             else
1041                 OPC->_float = 0;
1042             break;
1043
1044         case INSTR_ADD_F:
1045             OPC->_float = OPA->_float + OPB->_float;
1046             break;
1047         case INSTR_ADD_V:
1048             OPC->vector[0] = OPA->vector[0] + OPB->vector[0];
1049             OPC->vector[1] = OPA->vector[1] + OPB->vector[1];
1050             OPC->vector[2] = OPA->vector[2] + OPB->vector[2];
1051             break;
1052         case INSTR_SUB_F:
1053             OPC->_float = OPA->_float - OPB->_float;
1054             break;
1055         case INSTR_SUB_V:
1056             OPC->vector[0] = OPA->vector[0] - OPB->vector[0];
1057             OPC->vector[1] = OPA->vector[1] - OPB->vector[1];
1058             OPC->vector[2] = OPA->vector[2] - OPB->vector[2];
1059             break;
1060
1061         case INSTR_EQ_F:
1062             OPC->_float = (OPA->_float == OPB->_float);
1063             break;
1064         case INSTR_EQ_V:
1065             OPC->_float = ((OPA->vector[0] == OPB->vector[0]) &&
1066                            (OPA->vector[1] == OPB->vector[1]) &&
1067                            (OPA->vector[2] == OPB->vector[2]) );
1068             break;
1069         case INSTR_EQ_S:
1070             OPC->_float = !strcmp(prog_getstring(prog, OPA->string),
1071                                   prog_getstring(prog, OPB->string));
1072             break;
1073         case INSTR_EQ_E:
1074             OPC->_float = (OPA->_int == OPB->_int);
1075             break;
1076         case INSTR_EQ_FNC:
1077             OPC->_float = (OPA->function == OPB->function);
1078             break;
1079         case INSTR_NE_F:
1080             OPC->_float = (OPA->_float != OPB->_float);
1081             break;
1082         case INSTR_NE_V:
1083             OPC->_float = ((OPA->vector[0] != OPB->vector[0]) ||
1084                            (OPA->vector[1] != OPB->vector[1]) ||
1085                            (OPA->vector[2] != OPB->vector[2]) );
1086             break;
1087         case INSTR_NE_S:
1088             OPC->_float = !!strcmp(prog_getstring(prog, OPA->string),
1089                                    prog_getstring(prog, OPB->string));
1090             break;
1091         case INSTR_NE_E:
1092             OPC->_float = (OPA->_int != OPB->_int);
1093             break;
1094         case INSTR_NE_FNC:
1095             OPC->_float = (OPA->function != OPB->function);
1096             break;
1097
1098         case INSTR_LE:
1099             OPC->_float = (OPA->_float <= OPB->_float);
1100             break;
1101         case INSTR_GE:
1102             OPC->_float = (OPA->_float >= OPB->_float);
1103             break;
1104         case INSTR_LT:
1105             OPC->_float = (OPA->_float < OPB->_float);
1106             break;
1107         case INSTR_GT:
1108             OPC->_float = (OPA->_float > OPB->_float);
1109             break;
1110
1111         case INSTR_LOAD_F:
1112         case INSTR_LOAD_S:
1113         case INSTR_LOAD_FLD:
1114         case INSTR_LOAD_ENT:
1115         case INSTR_LOAD_FNC:
1116             if (OPA->edict < 0 || OPA->edict >= prog->entities) {
1117                 qcvmerror(prog, "progs `%s` attempted to read an out of bounds entity", prog->filename);
1118                 goto cleanup;
1119             }
1120             if ((unsigned int)(OPB->_int) >= (unsigned int)(prog->entityfields)) {
1121                 qcvmerror(prog, "prog `%s` attempted to read an invalid field from entity (%i)",
1122                           prog->filename,
1123                           OPB->_int);
1124                 goto cleanup;
1125             }
1126             ed = prog_getedict(prog, OPA->edict);
1127             OPC->_int = ((qcany*)( ((qcint*)ed) + OPB->_int ))->_int;
1128             break;
1129         case INSTR_LOAD_V:
1130             if (OPA->edict < 0 || OPA->edict >= prog->entities) {
1131                 qcvmerror(prog, "progs `%s` attempted to read an out of bounds entity", prog->filename);
1132                 goto cleanup;
1133             }
1134             if (OPB->_int < 0 || OPB->_int + 3 > (qcint)prog->entityfields)
1135             {
1136                 qcvmerror(prog, "prog `%s` attempted to read an invalid field from entity (%i)",
1137                           prog->filename,
1138                           OPB->_int + 2);
1139                 goto cleanup;
1140             }
1141             ed = prog_getedict(prog, OPA->edict);
1142             OPC->ivector[0] = ((qcany*)( ((qcint*)ed) + OPB->_int ))->ivector[0];
1143             OPC->ivector[1] = ((qcany*)( ((qcint*)ed) + OPB->_int ))->ivector[1];
1144             OPC->ivector[2] = ((qcany*)( ((qcint*)ed) + OPB->_int ))->ivector[2];
1145             break;
1146
1147         case INSTR_ADDRESS:
1148             if (OPA->edict < 0 || OPA->edict >= prog->entities) {
1149                 qcvmerror(prog, "prog `%s` attempted to address an out of bounds entity %i", prog->filename, OPA->edict);
1150                 goto cleanup;
1151             }
1152             if ((unsigned int)(OPB->_int) >= (unsigned int)(prog->entityfields))
1153             {
1154                 qcvmerror(prog, "prog `%s` attempted to read an invalid field from entity (%i)",
1155                           prog->filename,
1156                           OPB->_int);
1157                 goto cleanup;
1158             }
1159
1160             ed = prog_getedict(prog, OPA->edict);
1161             OPC->_int = ((qcint*)ed) - prog->entitydata + OPB->_int;
1162             break;
1163
1164         case INSTR_STORE_F:
1165         case INSTR_STORE_S:
1166         case INSTR_STORE_ENT:
1167         case INSTR_STORE_FLD:
1168         case INSTR_STORE_FNC:
1169             OPB->_int = OPA->_int;
1170             break;
1171         case INSTR_STORE_V:
1172             OPB->ivector[0] = OPA->ivector[0];
1173             OPB->ivector[1] = OPA->ivector[1];
1174             OPB->ivector[2] = OPA->ivector[2];
1175             break;
1176
1177         case INSTR_STOREP_F:
1178         case INSTR_STOREP_S:
1179         case INSTR_STOREP_ENT:
1180         case INSTR_STOREP_FLD:
1181         case INSTR_STOREP_FNC:
1182             if (OPB->_int < 0 || OPB->_int >= (qcint)vec_size(prog->entitydata)) {
1183                 qcvmerror(prog, "`%s` attempted to write to an out of bounds edict (%i)", prog->filename, OPB->_int);
1184                 goto cleanup;
1185             }
1186             if (OPB->_int < (qcint)prog->entityfields && !prog->allowworldwrites)
1187                 qcvmerror(prog, "`%s` tried to assign to world.%s (field %i)\n",
1188                           prog->filename,
1189                           prog_getstring(prog, prog_entfield(prog, OPB->_int)->name),
1190                           OPB->_int);
1191             ptr = (qcany*)(prog->entitydata + OPB->_int);
1192             ptr->_int = OPA->_int;
1193             break;
1194         case INSTR_STOREP_V:
1195             if (OPB->_int < 0 || OPB->_int + 2 >= (qcint)vec_size(prog->entitydata)) {
1196                 qcvmerror(prog, "`%s` attempted to write to an out of bounds edict (%i)", prog->filename, OPB->_int);
1197                 goto cleanup;
1198             }
1199             if (OPB->_int < (qcint)prog->entityfields && !prog->allowworldwrites)
1200                 qcvmerror(prog, "`%s` tried to assign to world.%s (field %i)\n",
1201                           prog->filename,
1202                           prog_getstring(prog, prog_entfield(prog, OPB->_int)->name),
1203                           OPB->_int);
1204             ptr = (qcany*)(prog->entitydata + OPB->_int);
1205             ptr->ivector[0] = OPA->ivector[0];
1206             ptr->ivector[1] = OPA->ivector[1];
1207             ptr->ivector[2] = OPA->ivector[2];
1208             break;
1209
1210         case INSTR_NOT_F:
1211             OPC->_float = !FLOAT_IS_TRUE_FOR_INT(OPA->_int);
1212             break;
1213         case INSTR_NOT_V:
1214             OPC->_float = !OPA->vector[0] &&
1215                           !OPA->vector[1] &&
1216                           !OPA->vector[2];
1217             break;
1218         case INSTR_NOT_S:
1219             OPC->_float = !OPA->string ||
1220                           !*prog_getstring(prog, OPA->string);
1221             break;
1222         case INSTR_NOT_ENT:
1223             OPC->_float = (OPA->edict == 0);
1224             break;
1225         case INSTR_NOT_FNC:
1226             OPC->_float = !OPA->function;
1227             break;
1228
1229         case INSTR_IF:
1230             /* this is consistent with darkplaces' behaviour */
1231             if(FLOAT_IS_TRUE_FOR_INT(OPA->_int))
1232             {
1233                 st += st->o2.s1 - 1;    /* offset the s++ */
1234                 if (++jumpcount >= maxjumps)
1235                     qcvmerror(prog, "`%s` hit the runaway loop counter limit of %li jumps", prog->filename, jumpcount);
1236             }
1237             break;
1238         case INSTR_IFNOT:
1239             if(!FLOAT_IS_TRUE_FOR_INT(OPA->_int))
1240             {
1241                 st += st->o2.s1 - 1;    /* offset the s++ */
1242                 if (++jumpcount >= maxjumps)
1243                     qcvmerror(prog, "`%s` hit the runaway loop counter limit of %li jumps", prog->filename, jumpcount);
1244             }
1245             break;
1246
1247         case INSTR_CALL0:
1248         case INSTR_CALL1:
1249         case INSTR_CALL2:
1250         case INSTR_CALL3:
1251         case INSTR_CALL4:
1252         case INSTR_CALL5:
1253         case INSTR_CALL6:
1254         case INSTR_CALL7:
1255         case INSTR_CALL8:
1256             prog->argc = st->opcode - INSTR_CALL0;
1257             if (!OPA->function)
1258                 qcvmerror(prog, "NULL function in `%s`", prog->filename);
1259
1260             if(!OPA->function || OPA->function >= (qcint)vec_size(prog->functions))
1261             {
1262                 qcvmerror(prog, "CALL outside the program in `%s`", prog->filename);
1263                 goto cleanup;
1264             }
1265
1266             newf = &prog->functions[OPA->function];
1267             newf->profile++;
1268
1269             prog->statement = (st - prog->code) + 1;
1270
1271             if (newf->entry < 0)
1272             {
1273                 /* negative statements are built in functions */
1274                 qcint builtinnumber = -newf->entry;
1275                 if (builtinnumber < (qcint)prog->builtins_count && prog->builtins[builtinnumber])
1276                     prog->builtins[builtinnumber](prog);
1277                 else
1278                     qcvmerror(prog, "No such builtin #%i in %s! Try updating your gmqcc sources",
1279                               builtinnumber, prog->filename);
1280             }
1281             else
1282                 st = prog->code + prog_enterfunction(prog, newf) - 1; /* offset st++ */
1283             if (prog->vmerror)
1284                 goto cleanup;
1285             break;
1286
1287         case INSTR_STATE:
1288             qcvmerror(prog, "`%s` tried to execute a STATE operation", prog->filename);
1289             break;
1290
1291         case INSTR_GOTO:
1292             st += st->o1.s1 - 1;    /* offset the s++ */
1293             if (++jumpcount == 10000000)
1294                 qcvmerror(prog, "`%s` hit the runaway loop counter limit of %li jumps", prog->filename, jumpcount);
1295             break;
1296
1297         case INSTR_AND:
1298             OPC->_float = FLOAT_IS_TRUE_FOR_INT(OPA->_int) &&
1299                           FLOAT_IS_TRUE_FOR_INT(OPB->_int);
1300             break;
1301         case INSTR_OR:
1302             OPC->_float = FLOAT_IS_TRUE_FOR_INT(OPA->_int) ||
1303                           FLOAT_IS_TRUE_FOR_INT(OPB->_int);
1304             break;
1305
1306         case INSTR_BITAND:
1307             OPC->_float = ((int)OPA->_float) & ((int)OPB->_float);
1308             break;
1309         case INSTR_BITOR:
1310             OPC->_float = ((int)OPA->_float) | ((int)OPB->_float);
1311             break;
1312     }
1313 }
1314
1315 #undef QCVM_PROFILE
1316 #undef QCVM_TRACE
1317 #endif /* !QCVM_LOOP */