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 "DONE",
  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 "EQ_F",
  42 "EQ_V",
  43 "EQ_S",
  44 "EQ_E",
  45 "EQ_FNC",
  46
  47 "NE_F",
  48 "NE_V",
  49 "NE_S",
  50 "NE_E",
  51 "NE_FNC",
  52
  53 "LE",
  54 "GE",
  55 "LT",
  56 "GT",
  57
  58 "INDIRECT",
  59 "INDIRECT",
  60 "INDIRECT",
  61 "INDIRECT",
  62 "INDIRECT",
  63 "INDIRECT",
  64
  65 "ADDRESS",
  66
  67 "STORE_F",
  68 "STORE_V",
  69 "STORE_S",
  70 "STORE_ENT",
  71 "STORE_FLD",
  72 "STORE_FNC",
  73
  74 "STOREP_F",
  75 "STOREP_V",
  76 "STOREP_S",
  77 "STOREP_ENT",
  78 "STOREP_FLD",
  79 "STOREP_FNC",
  80
  81 "RETURN",
  82
  83 "NOT_F",
  84 "NOT_V",
  85 "NOT_S",
  86 "NOT_ENT",
  87 "NOT_FNC",
  88
  89 "IF",
  90 "IFNOT",
  91
  92 "CALL0",
  93 "CALL1",
  94 "CALL2",
  95 "CALL3",
  96 "CALL4",
  97 "CALL5",
  98 "CALL6",
  99 "CALL7",
 100 "CALL8",
 101
 102 "STATE",
 103
 104 "GOTO",
 105
 106 "AND",
 107 "OR",
 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 void PRVM_PrintStatement (dstatement_t *s)
 125 {
 126         size_t i;
 127
 128         if( prog->statement_linenums ) {
 129                 int opnum;
 130
 131                 opnum = s - prog->statements;
 132                 Con_Printf( "%s:%i: ", PRVM_GetString( prog->xfunction->s_file ), prog->statement_linenums[ opnum ] );
 133         }
 134
 135         if ( (unsigned)s->op < sizeof(prvm_opnames)/sizeof(prvm_opnames[0]))
 136         {
 137                 Con_Printf("%s ",  prvm_opnames[s->op]);
 138                 i = strlen(prvm_opnames[s->op]);
 139                 for ( ; i<10 ; i++)
 140                         Con_Print(" ");
 141         }
 142
 143         if (s->op == OP_IF || s->op == OP_IFNOT)
 144                 Con_Printf("%sbranch %i",PRVM_GlobalString((unsigned short) s->a),s->b);
 145         else if (s->op == OP_GOTO)
 146         {
 147                 Con_Printf("branch %i",s->a);
 148         }
 149         else if ( (unsigned)(s->op - OP_STORE_F) < 6)
 150         {
 151                 Con_Print(PRVM_GlobalString((unsigned short) s->a));
 152                 Con_Print(PRVM_GlobalStringNoContents((unsigned short) s->b));
 153         }
 154         else
 155         {
 156                 if (s->a)
 157                         Con_Print(PRVM_GlobalString((unsigned short) s->a));
 158                 if (s->b)
 159                         Con_Print(PRVM_GlobalString((unsigned short) s->b));
 160                 if (s->c)
 161                         Con_Print(PRVM_GlobalStringNoContents((unsigned short) s->c));
 162         }
 163         Con_Print("\n");
 164 }
 165
 166 /*
 167 ============
 168 PRVM_StackTrace
 169 ============
 170 */
 171 void PRVM_StackTrace (void)
 172 {
 173         mfunction_t     *f;
 174         int                     i;
 175
 176         prog->stack[prog->depth].s = prog->xstatement;
 177         prog->stack[prog->depth].f = prog->xfunction;
 178         for (i = prog->depth;i > 0;i--)
 179         {
 180                 f = prog->stack[i].f;
 181
 182                 if (!f)
 183                         Con_Print("<NULL FUNCTION>\n");
 184                 else
 185                         Con_Printf("%12s : %s : statement %i\n", PRVM_GetString(f->s_file), PRVM_GetString(f->s_name), prog->stack[i].s - f->first_statement);
 186         }
 187 }
 188
 189
 190 /*
 191 ============
 192 PRVM_Profile_f
 193
 194 ============
 195 */
 196 void PRVM_Profile_f (void)
 197 {
 198         mfunction_t *f, *best;
 199         int i, num, max/*, howmany*/;
 200
 201         //howmany = 10;
 202         //if (Cmd_Argc() == 2)
 203         //      howmany = atoi(Cmd_Argv(1));
 204         if(Cmd_Argc() != 2)
 205         {
 206                 Con_Print("prvm_profile <program name>\n");
 207                 return;
 208         }
 209
 210         PRVM_Begin;
 211         if(!PRVM_SetProgFromString(Cmd_Argv(1)))
 212                 return;
 213
 214         Con_Printf( "%s Profile:\n[CallCount] [Statements] [BuiltinCost]\n", PRVM_NAME );
 215
 216         num = 0;
 217         do
 218         {
 219                 max = 0;
 220                 best = NULL;
 221                 for (i=0 ; i<prog->progs->numfunctions ; i++)
 222                 {
 223                         f = &prog->functions[i];
 224                         if (max < f->profile + f->builtinsprofile + f->callcount)
 225                         {
 226                                 max = f->profile + f->builtinsprofile + f->callcount;
 227                                 best = f;
 228                         }
 229                 }
 230                 if (best)
 231                 {
 232                         //if (num < howmany)
 233                         if (best->first_statement < 0)
 234                                 Con_Printf("%7i -- builtin -- %s\n", best->callcount, PRVM_GetString(best->s_name));
 235                         else
 236                                 Con_Printf("%7i%7i%7i %s\n", best->callcount, best->profile, best->builtinsprofile, PRVM_GetString(best->s_name));
 237                         num++;
 238                         best->profile = 0;
 239                         best->builtinsprofile = 0;
 240                         best->callcount = 0;
 241                 }
 242         } while (best);
 243
 244         PRVM_End;
 245 }
 246
 247 void PRVM_CrashAll()
 248 {
 249         int i;
 250         prvm_prog_t *oldprog = prog;
 251
 252         for(i = 0; i < PRVM_MAXPROGS; i++)
 253         {
 254                 if(!PRVM_ProgLoaded(i))
 255                         continue;
 256                 PRVM_SetProg(i);
 257                 PRVM_Crash();
 258         }
 259
 260         prog = oldprog;
 261 }
 262
 263 void PRVM_PrintState(void)
 264 {
 265         int i;
 266         if (prog->xfunction)
 267         {
 268                 for (i = -7; i <= 0;i++)
 269                         if (prog->xstatement + i >= prog->xfunction->first_statement)
 270                                 PRVM_PrintStatement (prog->statements + prog->xstatement + i);
 271         }
 272         else
 273                 Con_Print("null function executing??\n");
 274         PRVM_StackTrace ();
 275 }
 276
 277 void PRVM_Crash()
 278 {
 279         if (prog == NULL)
 280                 return;
 281
 282         if( prog->depth > 0 )
 283         {
 284                 Con_Printf("QuakeC crash report for %s:\n", PRVM_NAME);
 285                 PRVM_PrintState();
 286         }
 287
 288         // dump the stack so host_error can shutdown functions
 289         prog->depth = 0;
 290         prog->localstack_used = 0;
 291
 292         // reset the prog pointer
 293         prog = NULL;
 294 }
 295
 296 /*
 297 ============================================================================
 298 PRVM_ExecuteProgram
 299
 300 The interpretation main loop
 301 ============================================================================
 302 */
 303
 304 /*
 305 ====================
 306 PRVM_EnterFunction
 307
 308 Returns the new program statement counter
 309 ====================
 310 */
 311 int PRVM_EnterFunction (mfunction_t *f)
 312 {
 313         int             i, j, c, o;
 314
 315         if (!f)
 316                 PRVM_ERROR ("PRVM_EnterFunction: NULL function in %s", PRVM_NAME);
 317
 318         prog->stack[prog->depth].s = prog->xstatement;
 319         prog->stack[prog->depth].f = prog->xfunction;
 320         prog->depth++;
 321         if (prog->depth >=PRVM_MAX_STACK_DEPTH)
 322                 PRVM_ERROR ("stack overflow");
 323
 324 // save off any locals that the new function steps on
 325         c = f->locals;
 326         if (prog->localstack_used + c > PRVM_LOCALSTACK_SIZE)
 327                 PRVM_ERROR ("PRVM_ExecuteProgram: locals stack overflow in %s", PRVM_NAME);
 328
 329         for (i=0 ; i < c ; i++)
 330                 prog->localstack[prog->localstack_used+i] = ((int *)prog->globals.generic)[f->parm_start + i];
 331         prog->localstack_used += c;
 332
 333 // copy parameters
 334         o = f->parm_start;
 335         for (i=0 ; i<f->numparms ; i++)
 336         {
 337                 for (j=0 ; j<f->parm_size[i] ; j++)
 338                 {
 339                         ((int *)prog->globals.generic)[o] = ((int *)prog->globals.generic)[OFS_PARM0+i*3+j];
 340                         o++;
 341                 }
 342         }
 343
 344         prog->xfunction = f;
 345         return f->first_statement - 1;  // offset the s++
 346 }
 347
 348 /*
 349 ====================
 350 PRVM_LeaveFunction
 351 ====================
 352 */
 353 int PRVM_LeaveFunction (void)
 354 {
 355         int             i, c;
 356
 357         if (prog->depth <= 0)
 358                 PRVM_ERROR ("prog stack underflow in %s", PRVM_NAME);
 359
 360         if (!prog->xfunction)
 361                 PRVM_ERROR ("PR_LeaveFunction: NULL function in %s", PRVM_NAME);
 362 // restore locals from the stack
 363         c = prog->xfunction->locals;
 364         prog->localstack_used -= c;
 365         if (prog->localstack_used < 0)
 366                 PRVM_ERROR ("PRVM_ExecuteProgram: locals stack underflow in %s", PRVM_NAME);
 367
 368         for (i=0 ; i < c ; i++)
 369                 ((int *)prog->globals.generic)[prog->xfunction->parm_start + i] = prog->localstack[prog->localstack_used+i];
 370
 371 // up stack
 372         prog->depth--;
 373         prog->xfunction = prog->stack[prog->depth].f;
 374         return prog->stack[prog->depth].s;
 375 }
 376
 377 void PRVM_Init_Exec(void)
 378 {
 379         // dump the stack
 380         prog->depth = 0;
 381         prog->localstack_used = 0;
 382         // reset the string table
 383         // nothing here yet
 384 }
 385
 386 /*
 387 ====================
 388 PRVM_ExecuteProgram
 389 ====================
 390 */
 391 // LordHavoc: optimized
 392 #define OPA ((prvm_eval_t *)&prog->globals.generic[(unsigned short) st->a])
 393 #define OPB ((prvm_eval_t *)&prog->globals.generic[(unsigned short) st->b])
 394 #define OPC ((prvm_eval_t *)&prog->globals.generic[(unsigned short) st->c])
 395 extern cvar_t prvm_boundscheck;
 396 extern cvar_t prvm_traceqc;
 397 extern int              PRVM_ED_FindFieldOffset (const char *field);
 398 extern ddef_t*  PRVM_ED_FindGlobal(const char *name);
 399 void PRVM_ExecuteProgram (func_t fnum, const char *errormessage)
 400 {
 401         dstatement_t    *st, *startst;
 402         mfunction_t     *f, *newf;
 403         prvm_edict_t    *ed;
 404         prvm_eval_t     *ptr;
 405         int             jumpcount, cachedpr_trace, exitdepth;
 406
 407         if (!fnum || fnum >= (unsigned int)prog->progs->numfunctions)
 408         {
 409                 if (prog->self && PRVM_G_INT(prog->self->ofs))
 410                         PRVM_ED_Print(PRVM_PROG_TO_EDICT(PRVM_G_INT(prog->self->ofs)));
 411                 PRVM_ERROR ("PRVM_ExecuteProgram: %s", errormessage);
 412         }
 413
 414         f = &prog->functions[fnum];
 415
 416         prog->trace = prvm_traceqc.integer;
 417
 418         // we know we're done when pr_depth drops to this
 419         exitdepth = prog->depth;
 420
 421 // make a stack frame
 422         st = &prog->statements[PRVM_EnterFunction (f)];
 423         // save the starting statement pointer for profiling
 424         // (when the function exits or jumps, the (st - startst) integer value is
 425         // added to the function's profile counter)
 426         startst = st;
 427         // instead of counting instructions, we count jumps
 428         jumpcount = 0;
 429         // add one to the callcount of this function because otherwise engine-called functions aren't counted
 430         prog->xfunction->callcount++;
 431
 432 chooseexecprogram:
 433         cachedpr_trace = prog->trace;
 434         if (prvm_boundscheck.integer)
 435         {
 436 #define PRVMBOUNDSCHECK 1
 437                 if (prog->trace)
 438                 {
 439 #define PRVMTRACE 1
 440 #include "prvm_execprogram.h"
 441                 }
 442                 else
 443                 {
 444 #undef PRVMTRACE
 445 #include "prvm_execprogram.h"
 446                 }
 447         }
 448         else
 449         {
 450 #undef PRVMBOUNDSCHECK
 451                 if (prog->trace)
 452                 {
 453 #define PRVMTRACE 1
 454 #include "prvm_execprogram.h"
 455                 }
 456                 else
 457                 {
 458 #undef PRVMTRACE
 459 #include "prvm_execprogram.h"
 460                 }
 461         }
 462 }