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         int             i;
 127
 128         if ( (unsigned)s->op < sizeof(prvm_opnames)/sizeof(prvm_opnames[0]))
 129         {
 130                 Con_Printf("%s ",  prvm_opnames[s->op]);
 131                 i = strlen(prvm_opnames[s->op]);
 132                 for ( ; i<10 ; i++)
 133                         Con_Print(" ");
 134         }
 135
 136         if (s->op == OP_IF || s->op == OP_IFNOT)
 137                 Con_Printf("%sbranch %i",PRVM_GlobalString((unsigned short) s->a),s->b);
 138         else if (s->op == OP_GOTO)
 139         {
 140                 Con_Printf("branch %i",s->a);
 141         }
 142         else if ( (unsigned)(s->op - OP_STORE_F) < 6)
 143         {
 144                 Con_Print(PRVM_GlobalString((unsigned short) s->a));
 145                 Con_Print(PRVM_GlobalStringNoContents((unsigned short) s->b));
 146         }
 147         else
 148         {
 149                 if (s->a)
 150                         Con_Print(PRVM_GlobalString((unsigned short) s->a));
 151                 if (s->b)
 152                         Con_Print(PRVM_GlobalString((unsigned short) s->b));
 153                 if (s->c)
 154                         Con_Print(PRVM_GlobalStringNoContents((unsigned short) s->c));
 155         }
 156         Con_Print("\n");
 157 }
 158
 159 /*
 160 ============
 161 PRVM_StackTrace
 162 ============
 163 */
 164 void PRVM_StackTrace (void)
 165 {
 166         mfunction_t     *f;
 167         int                     i;
 168
 169         prog->stack[prog->depth].s = prog->xstatement;
 170         prog->stack[prog->depth].f = prog->xfunction;
 171         for (i = prog->depth;i > 0;i--)
 172         {
 173                 f = prog->stack[i].f;
 174
 175                 if (!f)
 176                         Con_Print("<NULL FUNCTION>\n");
 177                 else
 178                         Con_Printf("%12s : %s : statement %i\n", PRVM_GetString(f->s_file), PRVM_GetString(f->s_name), prog->stack[i].s - f->first_statement);
 179         }
 180 }
 181
 182
 183 /*
 184 ============
 185 PRVM_Profile_f
 186
 187 ============
 188 */
 189 void PRVM_Profile_f (void)
 190 {
 191         mfunction_t *f, *best;
 192         int i, num, max/*, howmany*/;
 193
 194         //howmany = 10;
 195         //if (Cmd_Argc() == 2)
 196         //      howmany = atoi(Cmd_Argv(1));
 197         if(Cmd_Argc() != 2)
 198         {
 199                 Con_Print("prvm_profile <program name>\n");
 200                 return;
 201         }
 202
 203         PRVM_Begin;
 204         if(!PRVM_SetProgFromString(Cmd_Argv(1)))
 205                 return;
 206
 207         Con_Printf( "%s Profile:\n[Profile] [BuiltinProfile] [CallCount]\n", PRVM_NAME );
 208
 209         num = 0;
 210         do
 211         {
 212                 max = 0;
 213                 best = NULL;
 214                 for (i=0 ; i<prog->progs->numfunctions ; i++)
 215                 {
 216                         f = &prog->functions[i];
 217                         if (f->profile > max)
 218                         {
 219                                 max = f->profile;
 220                                 best = f;
 221                         }
 222                 }
 223                 if (best)
 224                 {
 225                         //if (num < howmany)
 226                                 Con_Printf("%7i %7i %7i %s\n", best->profile, best->builtinsprofile, best->callcount, PRVM_GetString(best->s_name));
 227                         num++;
 228                         best->profile = 0;
 229                         best->builtinsprofile = 0;
 230                 }
 231         } while (best);
 232
 233         PRVM_End;
 234 }
 235
 236 void PRVM_CrashAll()
 237 {
 238         int i;
 239         prvm_prog_t *oldprog = prog;
 240
 241         for(i = 0; i < PRVM_MAXPROGS; i++)
 242         {
 243                 if(!PRVM_ProgLoaded(i))
 244                         continue;
 245                 PRVM_SetProg(i);
 246                 PRVM_Crash();
 247         }
 248
 249         prog = oldprog;
 250 }
 251
 252 void PRVM_PrintState(void)
 253 {
 254         int i;
 255         if (prog->xfunction)
 256         {
 257                 for (i = -7; i <= 0;i++)
 258                         if (prog->xstatement + i >= prog->xfunction->first_statement)
 259                                 PRVM_PrintStatement (prog->statements + prog->xstatement + i);
 260         }
 261         else
 262                 Con_Print("null function executing??\n");
 263         PRVM_StackTrace ();
 264 }
 265
 266 void PRVM_Crash()
 267 {
 268
 269         //TODO: make this more compilant with PR_Crash
 270         if (prog->depth < 1)
 271         {
 272                 // kill the stack just to be sure
 273                 prog->depth = 0;
 274                 prog->localstack_used = 0;
 275                 return;
 276         }
 277
 278         Con_Printf("QuakeC crash report for %s:\n", PRVM_NAME);
 279         PRVM_PrintState();
 280
 281         // dump the stack so host_error can shutdown functions
 282         prog->depth = 0;
 283         prog->localstack_used = 0;
 284
 285 }
 286
 287 /*
 288 ============================================================================
 289 PRVM_ExecuteProgram
 290
 291 The interpretation main loop
 292 ============================================================================
 293 */
 294
 295 /*
 296 ====================
 297 PRVM_EnterFunction
 298
 299 Returns the new program statement counter
 300 ====================
 301 */
 302 int PRVM_EnterFunction (mfunction_t *f)
 303 {
 304         int             i, j, c, o;
 305
 306         if (!f)
 307                 PRVM_ERROR ("PRVM_EnterFunction: NULL function in %s\n", PRVM_NAME);
 308
 309         prog->stack[prog->depth].s = prog->xstatement;
 310         prog->stack[prog->depth].f = prog->xfunction;
 311         prog->depth++;
 312         if (prog->depth >=PRVM_MAX_STACK_DEPTH)
 313                 PRVM_ERROR ("stack overflow");
 314
 315 // save off any locals that the new function steps on
 316         c = f->locals;
 317         if (prog->localstack_used + c > PRVM_LOCALSTACK_SIZE)
 318                 PRVM_ERROR ("PRVM_ExecuteProgram: locals stack overflow in %s\n", PRVM_NAME);
 319
 320         for (i=0 ; i < c ; i++)
 321                 prog->localstack[prog->localstack_used+i] = ((int *)prog->globals.generic)[f->parm_start + i];
 322         prog->localstack_used += c;
 323
 324 // copy parameters
 325         o = f->parm_start;
 326         for (i=0 ; i<f->numparms ; i++)
 327         {
 328                 for (j=0 ; j<f->parm_size[i] ; j++)
 329                 {
 330                         ((int *)prog->globals.generic)[o] = ((int *)prog->globals.generic)[OFS_PARM0+i*3+j];
 331                         o++;
 332                 }
 333         }
 334
 335         prog->xfunction = f;
 336         return f->first_statement - 1;  // offset the s++
 337 }
 338
 339 /*
 340 ====================
 341 PRVM_LeaveFunction
 342 ====================
 343 */
 344 int PRVM_LeaveFunction (void)
 345 {
 346         int             i, c;
 347
 348         if (prog->depth <= 0)
 349                 PRVM_ERROR ("prog stack underflow in %s", PRVM_NAME);
 350
 351         if (!prog->xfunction)
 352                 PRVM_ERROR ("PR_LeaveFunction: NULL function in %s\n", PRVM_NAME);
 353 // restore locals from the stack
 354         c = prog->xfunction->locals;
 355         prog->localstack_used -= c;
 356         if (prog->localstack_used < 0)
 357                 PRVM_ERROR ("PRVM_ExecuteProgram: locals stack underflow in %s\n", PRVM_NAME);
 358
 359         for (i=0 ; i < c ; i++)
 360                 ((int *)prog->globals.generic)[prog->xfunction->parm_start + i] = prog->localstack[prog->localstack_used+i];
 361
 362 // up stack
 363         prog->depth--;
 364         prog->xfunction = prog->stack[prog->depth].f;
 365         return prog->stack[prog->depth].s;
 366 }
 367
 368 void PRVM_Init_Exec(void)
 369 {
 370         // dump the stack
 371         prog->depth = 0;
 372         prog->localstack_used = 0;
 373         // reset the string table
 374         // nothing here yet
 375 }
 376
 377 /*
 378 ====================
 379 PRVM_ExecuteProgram
 380 ====================
 381 */
 382 // LordHavoc: optimized
 383 #define OPA ((prvm_eval_t *)&prog->globals.generic[(unsigned short) st->a])
 384 #define OPB ((prvm_eval_t *)&prog->globals.generic[(unsigned short) st->b])
 385 #define OPC ((prvm_eval_t *)&prog->globals.generic[(unsigned short) st->c])
 386 extern cvar_t prvm_boundscheck;
 387 extern cvar_t prvm_traceqc;
 388 extern int              PRVM_ED_FindFieldOffset (const char *field);
 389 extern ddef_t*  PRVM_ED_FindGlobal(const char *name);
 390 void PRVM_ExecuteProgram (func_t fnum, const char *errormessage)
 391 {
 392         dstatement_t    *st;
 393         mfunction_t     *f, *newf;
 394         prvm_edict_t    *ed;
 395         prvm_eval_t     *ptr;
 396         int             profile, startprofile, cachedpr_trace, exitdepth;
 397
 398         if (!fnum || fnum >= (unsigned int)prog->progs->numfunctions)
 399         {
 400                 if (prog->self && PRVM_G_INT(prog->self->ofs))
 401                         PRVM_ED_Print(PRVM_PROG_TO_EDICT(PRVM_G_INT(prog->self->ofs)));
 402                 PRVM_ERROR ("PRVM_ExecuteProgram: %s", errormessage);
 403         }
 404
 405         f = &prog->functions[fnum];
 406
 407         prog->trace = prvm_traceqc.integer;
 408
 409         // we know we're done when pr_depth drops to this
 410         exitdepth = prog->depth;
 411
 412 // make a stack frame
 413         st = &prog->statements[PRVM_EnterFunction (f)];
 414         startprofile = profile = 0;
 415
 416 chooseexecprogram:
 417         cachedpr_trace = prog->trace;
 418         if (prvm_boundscheck.integer)
 419         {
 420 #define PRVMBOUNDSCHECK 1
 421                 if (prog->trace)
 422                 {
 423 #define PRVMTRACE 1
 424 #include "prvm_execprogram.h"
 425                 }
 426                 else
 427                 {
 428 #undef PRVMTRACE
 429 #include "prvm_execprogram.h"
 430                 }
 431         }
 432         else
 433         {
 434 #undef PRVMBOUNDSCHECK
 435                 if (prog->trace)
 436                 {
 437 #define PRVMTRACE 1
 438 #include "prvm_execprogram.h"
 439                 }
 440                 else
 441                 {
 442 #undef PRVMTRACE
 443 #include "prvm_execprogram.h"
 444                 }
 445         }
 446 }