2 Copyright (C) 1996-1997 Id Software, Inc.
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.
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.
13 See the GNU General Public License for more details.
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.
24 char *prvm_opnames[] =
113 char *PRVM_GlobalString (int ofs);
114 char *PRVM_GlobalStringNoContents (int ofs);
117 //=============================================================================
124 extern cvar_t prvm_statementprofiling;
125 void PRVM_PrintStatement (dstatement_t *s)
128 int opnum = (int)(s - prog->statements);
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 ] );
134 if (prvm_statementprofiling.integer)
135 Con_Printf("%7.0f ", prog->statement_profile[s - prog->statements]);
137 if ( (unsigned)s->op < sizeof(prvm_opnames)/sizeof(prvm_opnames[0]))
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)
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)
153 Con_Print(PRVM_GlobalString((unsigned short) s->a));
155 Con_Print(PRVM_GlobalStringNoContents((unsigned short) s->b));
157 else if (s->op == OP_ADDRESS || (unsigned)(s->op - OP_LOAD_F) < 6)
160 Con_Print(PRVM_GlobalString((unsigned short) s->a));
164 Con_Print(PRVM_GlobalStringNoContents((unsigned short) s->b));
169 Con_Print(PRVM_GlobalStringNoContents((unsigned short) s->c));
175 Con_Print(PRVM_GlobalString((unsigned short) s->a));
179 Con_Print(PRVM_GlobalString((unsigned short) s->b));
184 Con_Print(PRVM_GlobalStringNoContents((unsigned short) s->c));
190 void PRVM_PrintFunctionStatements (const char *name)
192 int i, firststatement, endstatement;
194 func = PRVM_ED_FindFunction (name);
197 Con_Printf("%s progs: no function named %s\n", PRVM_NAME, name);
200 firststatement = func->first_statement;
201 if (firststatement < 0)
203 Con_Printf("%s progs: function %s is builtin #%i\n", PRVM_NAME, name, -firststatement);
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;
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++)
217 PRVM_PrintStatement(prog->statements + i);
218 prog->statement_profile[i] = 0;
228 void PRVM_PrintFunction_f (void)
232 Con_Printf("usage: prvm_printfunction <program name> <function name>\n");
237 if(!PRVM_SetProgFromString(Cmd_Argv(1)))
240 PRVM_PrintFunctionStatements(Cmd_Argv(2));
250 void PRVM_StackTrace (void)
255 prog->stack[prog->depth].s = prog->xstatement;
256 prog->stack[prog->depth].f = prog->xfunction;
257 for (i = prog->depth;i > 0;i--)
259 f = prog->stack[i].f;
262 Con_Print("<NULL FUNCTION>\n");
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);
269 void PRVM_CallProfile ()
271 mfunction_t *f, *best;
276 Con_Printf( "%s Call Profile:\n", PRVM_NAME );
283 for (i=0 ; i<prog->progs->numfunctions ; i++)
285 f = &prog->functions[i];
286 if (max < f->totaltime)
294 sum += best->totaltime;
295 Con_Printf("%9.4f %s\n", best->totaltime, PRVM_GetString(best->s_name));
300 Con_Printf("Total time since last profile reset: %9.4f\n", Sys_DoubleTime() - prog->starttime);
301 Con_Printf(" - used by QC code of this VM: %9.4f\n", sum);
303 prog->starttime = Sys_DoubleTime();
306 void PRVM_Profile (int maxfunctions, int mininstructions)
308 mfunction_t *f, *best;
312 Con_Printf( "%s Profile:\n[CallCount] [Statements] [BuiltinCost]\n", PRVM_NAME );
319 for (i=0 ; i<prog->progs->numfunctions ; i++)
321 f = &prog->functions[i];
322 if (max < f->profile + f->builtinsprofile + f->callcount)
324 max = f->profile + f->builtinsprofile + f->callcount;
330 if (num < maxfunctions && max >= mininstructions)
332 if (best->first_statement < 0)
333 Con_Printf("%9.0f ----- builtin ----- %s\n", best->callcount, PRVM_GetString(best->s_name));
335 Con_Printf("%9.0f %9.0f %9.0f %s\n", best->callcount, best->profile, best->builtinsprofile, PRVM_GetString(best->s_name));
339 best->builtinsprofile = 0;
351 void PRVM_CallProfile_f (void)
355 Con_Print("prvm_callprofile <program name>\n");
360 if(!PRVM_SetProgFromString(Cmd_Argv(1)))
374 void PRVM_Profile_f (void)
380 howmany = atoi(Cmd_Argv(2));
381 else if (Cmd_Argc() != 2)
383 Con_Print("prvm_profile <program name>\n");
388 if(!PRVM_SetProgFromString(Cmd_Argv(1)))
391 PRVM_Profile(howmany, 1);
399 prvm_prog_t *oldprog = prog;
401 for(i = 0; i < PRVM_MAXPROGS; i++)
403 if(!PRVM_ProgLoaded(i))
412 void PRVM_PrintState(void)
417 for (i = -7; i <= 0;i++)
418 if (prog->xstatement + i >= prog->xfunction->first_statement)
419 PRVM_PrintStatement (prog->statements + prog->xstatement + i);
422 Con_Print("null function executing??\n");
426 extern sizebuf_t vm_tempstringsbuf;
427 void PRVM_Crash(void)
432 prog->funcoffsets.SV_Shutdown = 0; // don't call SV_Shutdown on crash
434 if( prog->depth > 0 )
436 Con_Printf("QuakeC crash report for %s:\n", PRVM_NAME);
440 // dump the stack so host_error can shutdown functions
442 prog->localstack_used = 0;
444 // delete all tempstrings (FIXME: is this safe in VM->engine->VM recursion?)
445 vm_tempstringsbuf.cursize = 0;
447 // reset the prog pointer
452 ============================================================================
455 The interpretation main loop
456 ============================================================================
463 Returns the new program statement counter
466 int PRVM_EnterFunction (mfunction_t *f)
471 PRVM_ERROR ("PRVM_EnterFunction: NULL function in %s", PRVM_NAME);
473 prog->stack[prog->depth].s = prog->xstatement;
474 prog->stack[prog->depth].f = prog->xfunction;
476 if (prog->depth >=PRVM_MAX_STACK_DEPTH)
477 PRVM_ERROR ("stack overflow");
479 // save off any locals that the new function steps on
481 if (prog->localstack_used + c > PRVM_LOCALSTACK_SIZE)
482 PRVM_ERROR ("PRVM_ExecuteProgram: locals stack overflow in %s", PRVM_NAME);
484 for (i=0 ; i < c ; i++)
485 prog->localstack[prog->localstack_used+i] = ((int *)prog->globals.generic)[f->parm_start + i];
486 prog->localstack_used += c;
490 for (i=0 ; i<f->numparms ; i++)
492 for (j=0 ; j<f->parm_size[i] ; j++)
494 ((int *)prog->globals.generic)[o] = ((int *)prog->globals.generic)[OFS_PARM0+i*3+j];
500 return f->first_statement - 1; // offset the s++
508 int PRVM_LeaveFunction (void)
512 if (prog->depth <= 0)
513 PRVM_ERROR ("prog stack underflow in %s", PRVM_NAME);
515 if (!prog->xfunction)
516 PRVM_ERROR ("PR_LeaveFunction: NULL function in %s", PRVM_NAME);
517 // restore locals from the stack
518 c = prog->xfunction->locals;
519 prog->localstack_used -= c;
520 if (prog->localstack_used < 0)
521 PRVM_ERROR ("PRVM_ExecuteProgram: locals stack underflow in %s", PRVM_NAME);
523 for (i=0 ; i < c ; i++)
524 ((int *)prog->globals.generic)[prog->xfunction->parm_start + i] = prog->localstack[prog->localstack_used+i];
528 prog->xfunction = prog->stack[prog->depth].f;
529 return prog->stack[prog->depth].s;
532 void PRVM_Init_Exec(void)
536 prog->localstack_used = 0;
537 // reset the string table
546 // LordHavoc: optimized
547 #define OPA ((prvm_eval_t *)&prog->globals.generic[(unsigned short) st->a])
548 #define OPB ((prvm_eval_t *)&prog->globals.generic[(unsigned short) st->b])
549 #define OPC ((prvm_eval_t *)&prog->globals.generic[(unsigned short) st->c])
550 #ifdef PRVM_BOUNDSCHECK_CVAR
551 extern cvar_t prvm_boundscheck;
553 extern cvar_t prvm_traceqc;
554 extern cvar_t prvm_statementprofiling;
555 extern sizebuf_t vm_tempstringsbuf;
556 void PRVM_ExecuteProgram (func_t fnum, const char *errormessage)
558 dstatement_t *st, *startst;
559 mfunction_t *f, *newf;
562 int jumpcount, cachedpr_trace, exitdepth;
563 int restorevm_tempstringsbuf_cursize;
566 calltime = Sys_DoubleTime();
568 if (!fnum || fnum >= (unsigned int)prog->progs->numfunctions)
570 if (prog->globaloffsets.self >= 0 && PRVM_GLOBALFIELDVALUE(prog->globaloffsets.self)->edict)
571 PRVM_ED_Print(PRVM_PROG_TO_EDICT(PRVM_GLOBALFIELDVALUE(prog->globaloffsets.self)->edict), NULL);
572 PRVM_ERROR ("PRVM_ExecuteProgram: %s", errormessage);
575 f = &prog->functions[fnum];
577 // after executing this function, delete all tempstrings it created
578 restorevm_tempstringsbuf_cursize = vm_tempstringsbuf.cursize;
580 prog->trace = prvm_traceqc.integer;
582 // we know we're done when pr_depth drops to this
583 exitdepth = prog->depth;
585 // make a stack frame
586 st = &prog->statements[PRVM_EnterFunction (f)];
587 // save the starting statement pointer for profiling
588 // (when the function exits or jumps, the (st - startst) integer value is
589 // added to the function's profile counter)
591 // instead of counting instructions, we count jumps
593 // add one to the callcount of this function because otherwise engine-called functions aren't counted
594 prog->xfunction->callcount++;
597 cachedpr_trace = prog->trace;
598 if (prvm_statementprofiling.integer)
600 #define PRVMSTATEMENTPROFILING 1
601 #ifdef PRVM_BOUNDSCHECK_CVAR
602 if (prvm_boundscheck.integer)
605 #define PRVMBOUNDSCHECK 1
609 #include "prvm_execprogram.h"
614 #include "prvm_execprogram.h"
616 #undef PRVMBOUNDSCHECK
618 #ifdef PRVM_BOUNDSCHECK_CVAR
624 #include "prvm_execprogram.h"
629 #include "prvm_execprogram.h"
633 #undef PRVMSTATEMENTPROFILING
637 #ifdef PRVM_BOUNDSCHECK_CVAR
638 if (prvm_boundscheck.integer)
641 #define PRVMBOUNDSCHECK 1
645 #include "prvm_execprogram.h"
650 #include "prvm_execprogram.h"
652 #undef PRVMBOUNDSCHECK
654 #ifdef PRVM_BOUNDSCHECK_CVAR
660 #include "prvm_execprogram.h"
665 #include "prvm_execprogram.h"
672 if (developer.integer >= 200 && vm_tempstringsbuf.cursize > restorevm_tempstringsbuf_cursize)
673 Con_Printf("PRVM_ExecuteProgram: %s used %i bytes of tempstrings\n", PRVM_GetString(prog->functions[fnum].s_name), vm_tempstringsbuf.cursize - restorevm_tempstringsbuf_cursize);
674 // delete tempstrings created by this function
675 vm_tempstringsbuf.cursize = restorevm_tempstringsbuf_cursize;
677 prog->functions[fnum].totaltime += (Sys_DoubleTime() - calltime);
679 SV_FlushBroadcastMessages();