prvm_exec.c

   1 /*
   2 Copyright (C) 1996-1997 Id Software, Inc.
   3
   4 This program is free software; you can redistribute it and/or
   5 modify it under the terms of the GNU General Public License
   6 as published by the Free Software Foundation; either version 2
   7 of the License, or (at your option) any later version.
   8
   9 This program is distributed in the hope that it will be useful,
  10 but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  12
  13 See the GNU General Public License for more details.
  14
  15 You should have received a copy of the GNU General Public License
  16 along with this program; if not, write to the Free Software
  17 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  18
  19 */
  20
  21 #include "quakedef.h"
  22 #include "progsvm.h"
  23
  24 char *prvm_opnames[] =
  25 {
  26 "^5DONE",
  27
  28 "MUL_F",
  29 "MUL_V",
  30 "MUL_FV",
  31 "MUL_VF",
  32
  33 "DIV",
  34
  35 "ADD_F",
  36 "ADD_V",
  37
  38 "SUB_F",
  39 "SUB_V",
  40
  41 "^2EQ_F",
  42 "^2EQ_V",
  43 "^2EQ_S",
  44 "^2EQ_E",
  45 "^2EQ_FNC",
  46
  47 "^2NE_F",
  48 "^2NE_V",
  49 "^2NE_S",
  50 "^2NE_E",
  51 "^2NE_FNC",
  52
  53 "^2LE",
  54 "^2GE",
  55 "^2LT",
  56 "^2GT",
  57
  58 "^6FIELD_F",
  59 "^6FIELD_V",
  60 "^6FIELD_S",
  61 "^6FIELD_ENT",
  62 "^6FIELD_FLD",
  63 "^6FIELD_FNC",
  64
  65 "^1ADDRESS",
  66
  67 "STORE_F",
  68 "STORE_V",
  69 "STORE_S",
  70 "STORE_ENT",
  71 "STORE_FLD",
  72 "STORE_FNC",
  73
  74 "^1STOREP_F",
  75 "^1STOREP_V",
  76 "^1STOREP_S",
  77 "^1STOREP_ENT",
  78 "^1STOREP_FLD",
  79 "^1STOREP_FNC",
  80
  81 "^5RETURN",
  82
  83 "^2NOT_F",
  84 "^2NOT_V",
  85 "^2NOT_S",
  86 "^2NOT_ENT",
  87 "^2NOT_FNC",
  88
  89 "^5IF",
  90 "^5IFNOT",
  91
  92 "^3CALL0",
  93 "^3CALL1",
  94 "^3CALL2",
  95 "^3CALL3",
  96 "^3CALL4",
  97 "^3CALL5",
  98 "^3CALL6",
  99 "^3CALL7",
 100 "^3CALL8",
 101
 102 "^1STATE",
 103
 104 "^5GOTO",
 105
 106 "^2AND",
 107 "^2OR",
 108
 109 "BITAND",
 110 "BITOR"
 111 };
 112
 113 char *PRVM_GlobalString (int ofs);
 114 char *PRVM_GlobalStringNoContents (int ofs);
 115
 116
 117 //=============================================================================
 118
 119 /*
 120 =================
 121 PRVM_PrintStatement
 122 =================
 123 */
 124 extern cvar_t prvm_statementprofiling;
 125 void PRVM_PrintStatement (dstatement_t *s)
 126 {
 127         size_t i;
 128         int opnum = (int)(s - prog->statements);
 129
 130         Con_Printf("s%i: ", opnum);
 131         if( prog->statement_linenums )
 132                 Con_Printf( "%s:%i: ", PRVM_GetString( prog->xfunction->s_file ), prog->statement_linenums[ opnum ] );
 133
 134         if (prvm_statementprofiling.integer)
 135                 Con_Printf("%7.0f ", prog->statement_profile[s - prog->statements]);
 136
 137         if ( (unsigned)s->op < sizeof(prvm_opnames)/sizeof(prvm_opnames[0]))
 138         {
 139                 Con_Printf("%s ",  prvm_opnames[s->op]);
 140                 i = strlen(prvm_opnames[s->op]);
 141                 // don't count a preceding color tag when padding the name
 142                 if (prvm_opnames[s->op][0] == STRING_COLOR_TAG)
 143                         i -= 2;
 144                 for ( ; i<10 ; i++)
 145                         Con_Print(" ");
 146         }
 147         if (s->op == OP_IF || s->op == OP_IFNOT)
 148                 Con_Printf("%s, s%i",PRVM_GlobalString((unsigned short) s->a),(signed short)s->b + opnum);
 149         else if (s->op == OP_GOTO)
 150                 Con_Printf("s%i",(signed short)s->a + opnum);
 151         else if ( (unsigned)(s->op - OP_STORE_F) < 6)
 152         {
 153                 Con_Print(PRVM_GlobalString((unsigned short) s->a));
 154                 Con_Print(", ");
 155                 Con_Print(PRVM_GlobalStringNoContents((unsigned short) s->b));
 156         }
 157         else if (s->op == OP_ADDRESS || (unsigned)(s->op - OP_LOAD_F) < 6)
 158         {
 159                 if (s->a)
 160                         Con_Print(PRVM_GlobalString((unsigned short) s->a));
 161                 if (s->b)
 162                 {
 163                         Con_Print(", ");
 164                         Con_Print(PRVM_GlobalStringNoContents((unsigned short) s->b));
 165                 }
 166                 if (s->c)
 167                 {
 168                         Con_Print(", ");
 169                         Con_Print(PRVM_GlobalStringNoContents((unsigned short) s->c));
 170                 }
 171         }
 172         else
 173         {
 174                 if (s->a)
 175                         Con_Print(PRVM_GlobalString((unsigned short) s->a));
 176                 if (s->b)
 177                 {
 178                         Con_Print(", ");
 179                         Con_Print(PRVM_GlobalString((unsigned short) s->b));
 180                 }
 181                 if (s->c)
 182                 {
 183                         Con_Print(", ");
 184                         Con_Print(PRVM_GlobalStringNoContents((unsigned short) s->c));
 185                 }
 186         }
 187         Con_Print("\n");
 188 }
 189
 190 void PRVM_PrintFunctionStatements (const char *name)
 191 {
 192         int i, firststatement, endstatement;
 193         mfunction_t *func;
 194         func = PRVM_ED_FindFunction (name);
 195         if (!func)
 196         {
 197                 Con_Printf("%s progs: no function named %s\n", PRVM_NAME, name);
 198                 return;
 199         }
 200         firststatement = func->first_statement;
 201         if (firststatement < 0)
 202         {
 203                 Con_Printf("%s progs: function %s is builtin #%i\n", PRVM_NAME, name, -firststatement);
 204                 return;
 205         }
 206
 207         // find the end statement
 208         endstatement = prog->progs->numstatements;
 209         for (i = 0;i < prog->progs->numfunctions;i++)
 210                 if (endstatement > prog->functions[i].first_statement && firststatement < prog->functions[i].first_statement)
 211                         endstatement = prog->functions[i].first_statement;
 212
 213         // now print the range of statements
 214         Con_Printf("%s progs: disassembly of function %s (statements %i-%i):\n", PRVM_NAME, name, firststatement, endstatement);
 215         for (i = firststatement;i < endstatement;i++)
 216         {
 217                 PRVM_PrintStatement(prog->statements + i);
 218                 prog->statement_profile[i] = 0;
 219         }
 220 }
 221
 222 /*
 223 ============
 224 PRVM_PrintFunction_f
 225
 226 ============
 227 */
 228 void PRVM_PrintFunction_f (void)
 229 {
 230         if (Cmd_Argc() != 3)
 231         {
 232                 Con_Printf("usage: prvm_printfunction <program name> <function name>\n");
 233                 return;
 234         }
 235
 236         PRVM_Begin;
 237         if(!PRVM_SetProgFromString(Cmd_Argv(1)))
 238                 return;
 239
 240         PRVM_PrintFunctionStatements(Cmd_Argv(2));
 241
 242         PRVM_End;
 243 }
 244
 245 /*
 246 ============
 247 PRVM_StackTrace
 248 ============
 249 */
 250 void PRVM_StackTrace (void)
 251 {
 252         mfunction_t     *f;
 253         int                     i;
 254
 255         prog->stack[prog->depth].s = prog->xstatement;
 256         prog->stack[prog->depth].f = prog->xfunction;
 257         for (i = prog->depth;i > 0;i--)
 258         {
 259                 f = prog->stack[i].f;
 260
 261                 if (!f)
 262                         Con_Print("<NULL FUNCTION>\n");
 263                 else
 264                         Con_Printf("%12s : %s : statement %i\n", PRVM_GetString(f->s_file), PRVM_GetString(f->s_name), prog->stack[i].s - f->first_statement);
 265         }
 266 }
 267
 268
 269 void PRVM_Profile (int maxfunctions, int mininstructions)
 270 {
 271         mfunction_t *f, *best;
 272         int i, num;
 273         double max;
 274
 275         Con_Printf( "%s Profile:\n[CallCount] [Statements] [BuiltinCost]\n", PRVM_NAME );
 276
 277         num = 0;
 278         do
 279         {
 280                 max = 0;
 281                 best = NULL;
 282                 for (i=0 ; i<prog->progs->numfunctions ; i++)
 283                 {
 284                         f = &prog->functions[i];
 285                         if (max < f->profile + f->builtinsprofile + f->callcount)
 286                         {
 287                                 max = f->profile + f->builtinsprofile + f->callcount;
 288                                 best = f;
 289                         }
 290                 }
 291                 if (best)
 292                 {
 293                         if (num < maxfunctions && max >= mininstructions)
 294                         {
 295                                 if (best->first_statement < 0)
 296                                         Con_Printf("%9.0f ----- builtin ----- %s\n", best->callcount, PRVM_GetString(best->s_name));
 297                                 else
 298                                         Con_Printf("%9.0f %9.0f %9.0f %s\n", best->callcount, best->profile, best->builtinsprofile, PRVM_GetString(best->s_name));
 299                         }
 300                         num++;
 301                         best->profile = 0;
 302                         best->builtinsprofile = 0;
 303                         best->callcount = 0;
 304                 }
 305         } while (best);
 306 }
 307
 308 /*
 309 ============
 310 PRVM_Profile_f
 311
 312 ============
 313 */
 314 void PRVM_Profile_f (void)
 315 {
 316         int howmany;
 317
 318         howmany = 1<<30;
 319         if (Cmd_Argc() == 3)
 320                 howmany = atoi(Cmd_Argv(2));
 321         else if (Cmd_Argc() != 2)
 322         {
 323                 Con_Print("prvm_profile <program name>\n");
 324                 return;
 325         }
 326
 327         PRVM_Begin;
 328         if(!PRVM_SetProgFromString(Cmd_Argv(1)))
 329                 return;
 330
 331         PRVM_Profile(howmany, 1);
 332
 333         PRVM_End;
 334 }
 335
 336 void PRVM_CrashAll()
 337 {
 338         int i;
 339         prvm_prog_t *oldprog = prog;
 340
 341         for(i = 0; i < PRVM_MAXPROGS; i++)
 342         {
 343                 if(!PRVM_ProgLoaded(i))
 344                         continue;
 345                 PRVM_SetProg(i);
 346                 PRVM_Crash();
 347         }
 348
 349         prog = oldprog;
 350 }
 351
 352 void PRVM_PrintState(void)
 353 {
 354         int i;
 355         if (prog->xfunction)
 356         {
 357                 for (i = -7; i <= 0;i++)
 358                         if (prog->xstatement + i >= prog->xfunction->first_statement)
 359                                 PRVM_PrintStatement (prog->statements + prog->xstatement + i);
 360         }
 361         else
 362                 Con_Print("null function executing??\n");
 363         PRVM_StackTrace ();
 364 }
 365
 366 extern sizebuf_t vm_tempstringsbuf;
 367 void PRVM_Crash(void)
 368 {
 369         if (prog == NULL)
 370                 return;
 371
 372         if( prog->depth > 0 )
 373         {
 374                 Con_Printf("QuakeC crash report for %s:\n", PRVM_NAME);
 375                 PRVM_PrintState();
 376         }
 377
 378         // dump the stack so host_error can shutdown functions
 379         prog->depth = 0;
 380         prog->localstack_used = 0;
 381
 382         // delete all tempstrings (FIXME: is this safe in VM->engine->VM recursion?)
 383         vm_tempstringsbuf.cursize = 0;
 384
 385         // reset the prog pointer
 386         prog = NULL;
 387 }
 388
 389 /*
 390 ============================================================================
 391 PRVM_ExecuteProgram
 392
 393 The interpretation main loop
 394 ============================================================================
 395 */
 396
 397 /*
 398 ====================
 399 PRVM_EnterFunction
 400
 401 Returns the new program statement counter
 402 ====================
 403 */
 404 int PRVM_EnterFunction (mfunction_t *f)
 405 {
 406         int             i, j, c, o;
 407
 408         if (!f)
 409                 PRVM_ERROR ("PRVM_EnterFunction: NULL function in %s", PRVM_NAME);
 410
 411         prog->stack[prog->depth].s = prog->xstatement;
 412         prog->stack[prog->depth].f = prog->xfunction;
 413         prog->depth++;
 414         if (prog->depth >=PRVM_MAX_STACK_DEPTH)
 415                 PRVM_ERROR ("stack overflow");
 416
 417 // save off any locals that the new function steps on
 418         c = f->locals;
 419         if (prog->localstack_used + c > PRVM_LOCALSTACK_SIZE)
 420                 PRVM_ERROR ("PRVM_ExecuteProgram: locals stack overflow in %s", PRVM_NAME);
 421
 422         for (i=0 ; i < c ; i++)
 423                 prog->localstack[prog->localstack_used+i] = ((int *)prog->globals.generic)[f->parm_start + i];
 424         prog->localstack_used += c;
 425
 426 // copy parameters
 427         o = f->parm_start;
 428         for (i=0 ; i<f->numparms ; i++)
 429         {
 430                 for (j=0 ; j<f->parm_size[i] ; j++)
 431                 {
 432                         ((int *)prog->globals.generic)[o] = ((int *)prog->globals.generic)[OFS_PARM0+i*3+j];
 433                         o++;
 434                 }
 435         }
 436
 437         prog->xfunction = f;
 438         return f->first_statement - 1;  // offset the s++
 439 }
 440
 441 /*
 442 ====================
 443 PRVM_LeaveFunction
 444 ====================
 445 */
 446 int PRVM_LeaveFunction (void)
 447 {
 448         int             i, c;
 449
 450         if (prog->depth <= 0)
 451                 PRVM_ERROR ("prog stack underflow in %s", PRVM_NAME);
 452
 453         if (!prog->xfunction)
 454                 PRVM_ERROR ("PR_LeaveFunction: NULL function in %s", PRVM_NAME);
 455 // restore locals from the stack
 456         c = prog->xfunction->locals;
 457         prog->localstack_used -= c;
 458         if (prog->localstack_used < 0)
 459                 PRVM_ERROR ("PRVM_ExecuteProgram: locals stack underflow in %s", PRVM_NAME);
 460
 461         for (i=0 ; i < c ; i++)
 462                 ((int *)prog->globals.generic)[prog->xfunction->parm_start + i] = prog->localstack[prog->localstack_used+i];
 463
 464 // up stack
 465         prog->depth--;
 466         prog->xfunction = prog->stack[prog->depth].f;
 467         return prog->stack[prog->depth].s;
 468 }
 469
 470 void PRVM_Init_Exec(void)
 471 {
 472         // dump the stack
 473         prog->depth = 0;
 474         prog->localstack_used = 0;
 475         // reset the string table
 476         // nothing here yet
 477 }
 478
 479 /*
 480 ====================
 481 PRVM_ExecuteProgram
 482 ====================
 483 */
 484 // LordHavoc: optimized
 485 #define OPA ((prvm_eval_t *)&prog->globals.generic[(unsigned short) st->a])
 486 #define OPB ((prvm_eval_t *)&prog->globals.generic[(unsigned short) st->b])
 487 #define OPC ((prvm_eval_t *)&prog->globals.generic[(unsigned short) st->c])
 488 extern cvar_t prvm_boundscheck;
 489 extern cvar_t prvm_traceqc;
 490 extern cvar_t prvm_statementprofiling;
 491 extern sizebuf_t vm_tempstringsbuf;
 492 void PRVM_ExecuteProgram (func_t fnum, const char *errormessage)
 493 {
 494         dstatement_t    *st, *startst;
 495         mfunction_t     *f, *newf;
 496         prvm_edict_t    *ed;
 497         prvm_eval_t     *ptr;
 498         int             jumpcount, cachedpr_trace, exitdepth;
 499         int             restorevm_tempstringsbuf_cursize;
 500
 501         if (!fnum || fnum >= (unsigned int)prog->progs->numfunctions)
 502         {
 503                 if (prog->globaloffsets.self >= 0 && PRVM_GLOBALFIELDVALUE(prog->globaloffsets.self)->edict)
 504                         PRVM_ED_Print(PRVM_PROG_TO_EDICT(PRVM_GLOBALFIELDVALUE(prog->globaloffsets.self)->edict));
 505                 PRVM_ERROR ("PRVM_ExecuteProgram: %s", errormessage);
 506         }
 507
 508         f = &prog->functions[fnum];
 509
 510         // after executing this function, delete all tempstrings it created
 511         restorevm_tempstringsbuf_cursize = vm_tempstringsbuf.cursize;
 512
 513         prog->trace = prvm_traceqc.integer;
 514
 515         // we know we're done when pr_depth drops to this
 516         exitdepth = prog->depth;
 517
 518 // make a stack frame
 519         st = &prog->statements[PRVM_EnterFunction (f)];
 520         // save the starting statement pointer for profiling
 521         // (when the function exits or jumps, the (st - startst) integer value is
 522         // added to the function's profile counter)
 523         startst = st;
 524         // instead of counting instructions, we count jumps
 525         jumpcount = 0;
 526         // add one to the callcount of this function because otherwise engine-called functions aren't counted
 527         prog->xfunction->callcount++;
 528
 529 chooseexecprogram:
 530         cachedpr_trace = prog->trace;
 531         if (prvm_statementprofiling.integer)
 532         {
 533 #define PRVMSTATEMENTPROFILING 1
 534                 if (prvm_boundscheck.integer)
 535                 {
 536 #define PRVMBOUNDSCHECK 1
 537                         if (prog->trace)
 538                         {
 539 #define PRVMTRACE 1
 540 #include "prvm_execprogram.h"
 541 #undef PRVMTRACE
 542                         }
 543                         else
 544                         {
 545 #include "prvm_execprogram.h"
 546                         }
 547 #undef PRVMBOUNDSCHECK
 548                 }
 549                 else
 550                 {
 551                         if (prog->trace)
 552                         {
 553 #define PRVMTRACE 1
 554 #include "prvm_execprogram.h"
 555 #undef PRVMTRACE
 556                         }
 557                         else
 558                         {
 559 #include "prvm_execprogram.h"
 560                         }
 561                 }
 562 #undef PRVMSTATEMENTPROFILING
 563         }
 564         else
 565         {
 566                 if (prvm_boundscheck.integer)
 567                 {
 568 #define PRVMBOUNDSCHECK 1
 569                         if (prog->trace)
 570                         {
 571 #define PRVMTRACE 1
 572 #include "prvm_execprogram.h"
 573 #undef PRVMTRACE
 574                         }
 575                         else
 576                         {
 577 #include "prvm_execprogram.h"
 578                         }
 579 #undef PRVMBOUNDSCHECK
 580                 }
 581                 else
 582                 {
 583                         if (prog->trace)
 584                         {
 585 #define PRVMTRACE 1
 586 #include "prvm_execprogram.h"
 587 #undef PRVMTRACE
 588                         }
 589                         else
 590                         {
 591 #include "prvm_execprogram.h"
 592                         }
 593                 }
 594         }
 595
 596 cleanup:
 597         if (developer.integer >= 200 && vm_tempstringsbuf.cursize > restorevm_tempstringsbuf_cursize)
 598                 Con_Printf("PRVM_ExecuteProgram: %s used %i bytes of tempstrings\n", PRVM_GetString(prog->functions[fnum].s_name), vm_tempstringsbuf.cursize - restorevm_tempstringsbuf_cursize);
 599         // delete tempstrings created by this function
 600         vm_tempstringsbuf.cursize = restorevm_tempstringsbuf_cursize;
 601 }