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);
268 void PRVM_ShortStackTrace(char *buf, size_t bufsize)
275 dpsnprintf(buf, bufsize, "(%s) ", prog->name);
279 strlcpy(buf, "<NO PROG>", sizeof(buf));
283 prog->stack[prog->depth].s = prog->xstatement;
284 prog->stack[prog->depth].f = prog->xfunction;
285 for (i = prog->depth;i > 0;i--)
287 f = prog->stack[i].f;
291 ? va("%s:%s(%i) ", PRVM_GetString(f->s_file), PRVM_GetString(f->s_name), prog->stack[i].s - f->first_statement)
300 void PRVM_CallProfile ()
302 mfunction_t *f, *best;
307 Con_Printf( "%s Call Profile:\n", PRVM_NAME );
314 for (i=0 ; i<prog->progs->numfunctions ; i++)
316 f = &prog->functions[i];
317 if (max < f->totaltime)
325 sum += best->totaltime;
326 Con_Printf("%9.4f %s\n", best->totaltime, PRVM_GetString(best->s_name));
331 Con_Printf("Total time since last profile reset: %9.4f\n", Sys_DoubleTime() - prog->starttime);
332 Con_Printf(" - used by QC code of this VM: %9.4f\n", sum);
334 prog->starttime = Sys_DoubleTime();
337 void PRVM_Profile (int maxfunctions, int mininstructions)
339 mfunction_t *f, *best;
343 Con_Printf( "%s Profile:\n[CallCount] [Statements] [BuiltinCost]\n", PRVM_NAME );
350 for (i=0 ; i<prog->progs->numfunctions ; i++)
352 f = &prog->functions[i];
353 if (max < f->profile + f->builtinsprofile + f->callcount)
355 max = f->profile + f->builtinsprofile + f->callcount;
361 if (num < maxfunctions && max >= mininstructions)
363 if (best->first_statement < 0)
364 Con_Printf("%9.0f ----- builtin ----- %s\n", best->callcount, PRVM_GetString(best->s_name));
366 Con_Printf("%9.0f %9.0f %9.0f %s\n", best->callcount, best->profile, best->builtinsprofile, PRVM_GetString(best->s_name));
370 best->builtinsprofile = 0;
382 void PRVM_CallProfile_f (void)
386 Con_Print("prvm_callprofile <program name>\n");
391 if(!PRVM_SetProgFromString(Cmd_Argv(1)))
405 void PRVM_Profile_f (void)
411 howmany = atoi(Cmd_Argv(2));
412 else if (Cmd_Argc() != 2)
414 Con_Print("prvm_profile <program name>\n");
419 if(!PRVM_SetProgFromString(Cmd_Argv(1)))
422 PRVM_Profile(howmany, 1);
430 prvm_prog_t *oldprog = prog;
432 for(i = 0; i < PRVM_MAXPROGS; i++)
434 if(!PRVM_ProgLoaded(i))
443 void PRVM_PrintState(void)
446 if(prog->statestring)
448 Con_Printf("Caller-provided information: %s\n", prog->statestring);
452 for (i = -7; i <= 0;i++)
453 if (prog->xstatement + i >= prog->xfunction->first_statement)
454 PRVM_PrintStatement (prog->statements + prog->xstatement + i);
457 Con_Print("null function executing??\n");
461 extern sizebuf_t vm_tempstringsbuf;
462 extern cvar_t prvm_errordump;
463 void Host_Savegame_to (const char *name);
464 void PRVM_Crash(void)
469 prog->funcoffsets.SV_Shutdown = 0; // don't call SV_Shutdown on crash
471 if( prog->depth > 0 )
473 Con_Printf("QuakeC crash report for %s:\n", PRVM_NAME);
477 if(prvm_errordump.integer)
480 Host_Savegame_to(va("crash-%s.dmp", PRVM_NAME));
483 // dump the stack so host_error can shutdown functions
485 prog->localstack_used = 0;
487 // delete all tempstrings (FIXME: is this safe in VM->engine->VM recursion?)
488 vm_tempstringsbuf.cursize = 0;
490 // reset the prog pointer
495 ============================================================================
498 The interpretation main loop
499 ============================================================================
506 Returns the new program statement counter
509 int PRVM_EnterFunction (mfunction_t *f)
514 PRVM_ERROR ("PRVM_EnterFunction: NULL function in %s", PRVM_NAME);
516 prog->stack[prog->depth].s = prog->xstatement;
517 prog->stack[prog->depth].f = prog->xfunction;
519 if (prog->depth >=PRVM_MAX_STACK_DEPTH)
520 PRVM_ERROR ("stack overflow");
522 // save off any locals that the new function steps on
524 if (prog->localstack_used + c > PRVM_LOCALSTACK_SIZE)
525 PRVM_ERROR ("PRVM_ExecuteProgram: locals stack overflow in %s", PRVM_NAME);
527 for (i=0 ; i < c ; i++)
528 prog->localstack[prog->localstack_used+i] = ((int *)prog->globals.generic)[f->parm_start + i];
529 prog->localstack_used += c;
533 for (i=0 ; i<f->numparms ; i++)
535 for (j=0 ; j<f->parm_size[i] ; j++)
537 ((int *)prog->globals.generic)[o] = ((int *)prog->globals.generic)[OFS_PARM0+i*3+j];
543 return f->first_statement - 1; // offset the s++
551 int PRVM_LeaveFunction (void)
555 if (prog->depth <= 0)
556 PRVM_ERROR ("prog stack underflow in %s", PRVM_NAME);
558 if (!prog->xfunction)
559 PRVM_ERROR ("PR_LeaveFunction: NULL function in %s", PRVM_NAME);
560 // restore locals from the stack
561 c = prog->xfunction->locals;
562 prog->localstack_used -= c;
563 if (prog->localstack_used < 0)
564 PRVM_ERROR ("PRVM_ExecuteProgram: locals stack underflow in %s", PRVM_NAME);
566 for (i=0 ; i < c ; i++)
567 ((int *)prog->globals.generic)[prog->xfunction->parm_start + i] = prog->localstack[prog->localstack_used+i];
571 prog->xfunction = prog->stack[prog->depth].f;
572 return prog->stack[prog->depth].s;
575 void PRVM_Init_Exec(void)
579 prog->localstack_used = 0;
580 // reset the string table
589 // LordHavoc: optimized
590 #define OPA ((prvm_eval_t *)&prog->globals.generic[(unsigned short) st->a])
591 #define OPB ((prvm_eval_t *)&prog->globals.generic[(unsigned short) st->b])
592 #define OPC ((prvm_eval_t *)&prog->globals.generic[(unsigned short) st->c])
593 extern cvar_t prvm_traceqc;
594 extern cvar_t prvm_statementprofiling;
595 extern sizebuf_t vm_tempstringsbuf;
596 extern qboolean prvm_runawaycheck;
597 extern qboolean prvm_boundscheck;
598 void PRVM_ExecuteProgram (func_t fnum, const char *errormessage)
600 dstatement_t *st, *startst;
601 mfunction_t *f, *newf;
604 int jumpcount, cachedpr_trace, exitdepth;
605 int restorevm_tempstringsbuf_cursize;
608 calltime = Sys_DoubleTime();
610 if (!fnum || fnum >= (unsigned int)prog->progs->numfunctions)
612 if (prog->globaloffsets.self >= 0 && PRVM_GLOBALFIELDVALUE(prog->globaloffsets.self)->edict)
613 PRVM_ED_Print(PRVM_PROG_TO_EDICT(PRVM_GLOBALFIELDVALUE(prog->globaloffsets.self)->edict), NULL);
614 PRVM_ERROR ("PRVM_ExecuteProgram: %s", errormessage);
617 f = &prog->functions[fnum];
619 // after executing this function, delete all tempstrings it created
620 restorevm_tempstringsbuf_cursize = vm_tempstringsbuf.cursize;
622 prog->trace = prvm_traceqc.integer;
624 // we know we're done when pr_depth drops to this
625 exitdepth = prog->depth;
627 // make a stack frame
628 st = &prog->statements[PRVM_EnterFunction (f)];
629 // save the starting statement pointer for profiling
630 // (when the function exits or jumps, the (st - startst) integer value is
631 // added to the function's profile counter)
633 // instead of counting instructions, we count jumps
635 // add one to the callcount of this function because otherwise engine-called functions aren't counted
636 prog->xfunction->callcount++;
639 cachedpr_trace = prog->trace;
640 if (prvm_runawaycheck)
642 #define PRVMRUNAWAYCHECK 1
643 if (prvm_statementprofiling.integer)
645 #define PRVMSTATEMENTPROFILING 1
646 if (prvm_boundscheck)
648 #define PRVMBOUNDSCHECK 1
652 #include "prvm_execprogram.h"
657 #include "prvm_execprogram.h"
659 #undef PRVMBOUNDSCHECK
666 #include "prvm_execprogram.h"
671 #include "prvm_execprogram.h"
674 #undef PRVMSTATEMENTPROFILING
678 if (prvm_boundscheck)
680 #define PRVMBOUNDSCHECK 1
684 #include "prvm_execprogram.h"
689 #include "prvm_execprogram.h"
691 #undef PRVMBOUNDSCHECK
698 #include "prvm_execprogram.h"
703 #include "prvm_execprogram.h"
707 #undef PRVMRUNAWAYCHECK
711 if (prvm_statementprofiling.integer)
713 #define PRVMSTATEMENTPROFILING 1
714 if (prvm_boundscheck)
716 #define PRVMBOUNDSCHECK 1
720 #include "prvm_execprogram.h"
725 #include "prvm_execprogram.h"
727 #undef PRVMBOUNDSCHECK
734 #include "prvm_execprogram.h"
739 #include "prvm_execprogram.h"
742 #undef PRVMSTATEMENTPROFILING
746 if (prvm_boundscheck)
748 #define PRVMBOUNDSCHECK 1
752 #include "prvm_execprogram.h"
757 #include "prvm_execprogram.h"
759 #undef PRVMBOUNDSCHECK
766 #include "prvm_execprogram.h"
771 #include "prvm_execprogram.h"
778 if (developer.integer >= 200 && vm_tempstringsbuf.cursize > restorevm_tempstringsbuf_cursize)
779 Con_Printf("PRVM_ExecuteProgram: %s used %i bytes of tempstrings\n", PRVM_GetString(prog->functions[fnum].s_name), vm_tempstringsbuf.cursize - restorevm_tempstringsbuf_cursize);
780 // delete tempstrings created by this function
781 vm_tempstringsbuf.cursize = restorevm_tempstringsbuf_cursize;
783 prog->functions[fnum].totaltime += (Sys_DoubleTime() - calltime);
785 SV_FlushBroadcastMessages();