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 const char *prvm_opnames[] =
115 //=============================================================================
122 extern cvar_t prvm_statementprofiling;
123 extern cvar_t prvm_timeprofiling;
124 static void PRVM_PrintStatement(prvm_prog_t *prog, mstatement_t *s)
127 int opnum = (int)(s - prog->statements);
128 char valuebuf[MAX_INPUTLINE];
130 Con_Printf("s%i: ", opnum);
131 if( prog->statement_linenums )
132 Con_Printf( "%s:%i: ", PRVM_GetString( prog, 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->operand[0] >= 0) Con_Printf( "%s", PRVM_GlobalString(prog, s->operand[0], valuebuf, sizeof(valuebuf)));
148 if (s->operand[1] >= 0) Con_Printf(", %s", PRVM_GlobalString(prog, s->operand[1], valuebuf, sizeof(valuebuf)));
149 if (s->operand[2] >= 0) Con_Printf(", %s", PRVM_GlobalString(prog, s->operand[2], valuebuf, sizeof(valuebuf)));
150 if (s->jumpabsolute >= 0) Con_Printf(", statement %i", s->jumpabsolute);
154 void PRVM_PrintFunctionStatements (prvm_prog_t *prog, const char *name)
156 int i, firststatement, endstatement;
158 func = PRVM_ED_FindFunction (prog, name);
161 Con_Printf("%s progs: no function named %s\n", prog->name, name);
164 firststatement = func->first_statement;
165 if (firststatement < 0)
167 Con_Printf("%s progs: function %s is builtin #%i\n", prog->name, name, -firststatement);
171 // find the end statement
172 endstatement = prog->numstatements;
173 for (i = 0;i < prog->numfunctions;i++)
174 if (endstatement > prog->functions[i].first_statement && firststatement < prog->functions[i].first_statement)
175 endstatement = prog->functions[i].first_statement;
177 // now print the range of statements
178 Con_Printf("%s progs: disassembly of function %s (statements %i-%i, locals %i-%i):\n", prog->name, name, firststatement, endstatement, func->parm_start, func->parm_start + func->locals - 1);
179 prog->xfunction = func;
180 for (i = firststatement;i < endstatement;i++)
182 PRVM_PrintStatement(prog, prog->statements + i);
183 prog->statement_profile[i] = 0;
193 void PRVM_PrintFunction_f (void)
198 Con_Printf("usage: prvm_printfunction <program name> <function name>\n");
202 if (!(prog = PRVM_FriendlyProgFromString(Cmd_Argv(1))))
205 PRVM_PrintFunctionStatements(prog, Cmd_Argv(2));
213 void PRVM_StackTrace (prvm_prog_t *prog)
218 prog->stack[prog->depth].s = prog->xstatement;
219 prog->stack[prog->depth].f = prog->xfunction;
220 for (i = prog->depth;i > 0;i--)
222 f = prog->stack[i].f;
225 Con_Print("<NULL FUNCTION>\n");
228 if (prog->statement_linenums)
229 Con_Printf("%12s:%i : %s : statement %i\n", PRVM_GetString(prog, f->s_file), prog->statement_linenums[prog->stack[i].s], PRVM_GetString(prog, f->s_name), prog->stack[i].s - f->first_statement);
231 Con_Printf("%12s : %s : statement %i\n", PRVM_GetString(prog, f->s_file), PRVM_GetString(prog, f->s_name), prog->stack[i].s - f->first_statement);
236 void PRVM_ShortStackTrace(prvm_prog_t *prog, char *buf, size_t bufsize)
244 dpsnprintf(buf, bufsize, "(%s) ", prog->name);
248 strlcpy(buf, "<NO PROG>", bufsize);
252 prog->stack[prog->depth].s = prog->xstatement;
253 prog->stack[prog->depth].f = prog->xfunction;
254 for (i = prog->depth;i > 0;i--)
256 f = prog->stack[i].f;
260 ? va(vabuf, sizeof(vabuf), "%s:%s(%i) ", PRVM_GetString(prog, f->s_file), PRVM_GetString(prog, f->s_name), prog->stack[i].s - f->first_statement)
269 static void PRVM_CallProfile (prvm_prog_t *prog)
271 mfunction_t *f, *best;
275 double newprofiletime;
277 Con_Printf( "%s Call Profile:\n", prog->name );
284 for (i=0 ; i<prog->numfunctions ; i++)
286 f = &prog->functions[i];
287 if (max < f->totaltime)
295 sum += best->totaltime;
296 Con_Printf("%9.4f %s\n", best->totaltime, PRVM_GetString(prog, best->s_name));
301 newprofiletime = Sys_DirtyTime();
302 Con_Printf("Total time since last profile reset: %9.4f\n", newprofiletime - prog->profiletime);
303 Con_Printf(" - used by QC code of this VM: %9.4f\n", sum);
305 prog->profiletime = newprofiletime;
308 void PRVM_Profile (prvm_prog_t *prog, int maxfunctions, double mintime, int sortby)
310 mfunction_t *f, *best;
314 if(!prvm_timeprofiling.integer)
315 mintime *= 10000000; // count each statement as about 0.1µs
317 if(prvm_timeprofiling.integer)
318 Con_Printf( "%s Profile:\n[CallCount] [Time] [BuiltinTm] [Statement] [BuiltinCt] [TimeTotal] [StmtTotal] [BltnTotal] [self]\n", prog->name );
319 // 12345678901 12345678901 12345678901 12345678901 12345678901 12345678901 12345678901 123.45%
321 Con_Printf( "%s Profile:\n[CallCount] [Statement] [BuiltinCt] [StmtTotal] [BltnTotal] [self]\n", prog->name );
322 // 12345678901 12345678901 12345678901 12345678901 12345678901 123.45%
329 for (i=0 ; i<prog->numfunctions ; i++)
331 f = &prog->functions[i];
332 if(prvm_timeprofiling.integer)
336 if(f->first_statement < 0)
338 if (max < f->tprofile)
346 if (max < f->tprofile_total)
348 max = f->tprofile_total;
355 if (max < f->tprofile + f->tbprofile)
357 max = f->tprofile + f->tbprofile;
366 if (max < f->profile_total + f->builtinsprofile_total + f->callcount)
368 max = f->profile_total + f->builtinsprofile_total + f->callcount;
374 if (max < f->profile + f->builtinsprofile + f->callcount)
376 max = f->profile + f->builtinsprofile + f->callcount;
384 if (num < maxfunctions && max > mintime)
386 if(prvm_timeprofiling.integer)
388 if (best->first_statement < 0)
389 Con_Printf("%11.0f %11.6f ------------- builtin ------------- %11.6f ----------- builtin ----------- %s\n", best->callcount, best->tprofile, best->tprofile, PRVM_GetString(prog, best->s_name));
390 // %11.6f 12345678901 12345678901 12345678901 %11.6f 12345678901 12345678901 123.45%
392 Con_Printf("%11.0f %11.6f %11.6f %11.0f %11.0f %11.6f %11.0f %11.0f %6.2f%% %s\n", best->callcount, best->tprofile, best->tbprofile, best->profile, best->builtinsprofile, best->tprofile_total, best->profile_total, best->builtinsprofile_total, (best->tprofile_total > 0) ? ((best->tprofile) * 100.0 / (best->tprofile_total)) : -99.99, PRVM_GetString(prog, best->s_name));
396 if (best->first_statement < 0)
397 Con_Printf("%11.0f ----------------------- builtin ----------------------- %s\n", best->callcount, PRVM_GetString(prog, best->s_name));
398 // 12345678901 12345678901 12345678901 12345678901 123.45%
400 Con_Printf("%11.0f %11.0f %11.0f %11.0f %11.0f %6.2f%% %s\n", best->callcount, best->profile, best->builtinsprofile, best->profile_total, best->builtinsprofile_total, (best->profile + best->builtinsprofile) * 100.0 / (best->profile_total + best->builtinsprofile_total), PRVM_GetString(prog, best->s_name));
407 best->builtinsprofile = 0;
408 best->profile_total = 0;
409 best->tprofile_total = 0;
410 best->builtinsprofile_total = 0;
422 void PRVM_CallProfile_f (void)
427 Con_Print("prvm_callprofile <program name>\n");
431 if (!(prog = PRVM_FriendlyProgFromString(Cmd_Argv(1))))
434 PRVM_CallProfile(prog);
443 void PRVM_Profile_f (void)
450 howmany = atoi(Cmd_Argv(2));
451 else if (Cmd_Argc() != 2)
453 Con_Print("prvm_profile <program name>\n");
457 if (!(prog = PRVM_FriendlyProgFromString(Cmd_Argv(1))))
460 PRVM_Profile(prog, howmany, 0, 0);
463 void PRVM_ChildProfile_f (void)
470 howmany = atoi(Cmd_Argv(2));
471 else if (Cmd_Argc() != 2)
473 Con_Print("prvm_childprofile <program name>\n");
477 if (!(prog = PRVM_FriendlyProgFromString(Cmd_Argv(1))))
480 PRVM_Profile(prog, howmany, 0, 1);
483 void PRVM_PrintState(prvm_prog_t *prog)
486 if (prog->statestring)
488 Con_Printf("Caller-provided information: %s\n", prog->statestring);
492 for (i = -7; i <= 0;i++)
493 if (prog->xstatement + i >= prog->xfunction->first_statement)
494 PRVM_PrintStatement(prog, prog->statements + prog->xstatement + i);
497 Con_Print("null function executing??\n");
498 PRVM_StackTrace(prog);
501 extern cvar_t prvm_errordump;
502 void PRVM_Crash(prvm_prog_t *prog)
510 PRVM_serverfunction(SV_Shutdown) = 0; // don't call SV_Shutdown on crash
512 if( prog->depth > 0 )
514 Con_Printf("QuakeC crash report for %s:\n", prog->name);
515 PRVM_PrintState(prog);
518 if(prvm_errordump.integer)
521 Host_Savegame_to(prog, va(vabuf, sizeof(vabuf), "crash-%s.dmp", prog->name));
524 // dump the stack so host_error can shutdown functions
526 prog->localstack_used = 0;
528 // delete all tempstrings (FIXME: is this safe in VM->engine->VM recursion?)
529 prog->tempstringsbuf.cursize = 0;
531 // reset the prog pointer
536 ============================================================================
539 The interpretation main loop
540 ============================================================================
547 Returns the new program statement counter
550 static int PRVM_EnterFunction (prvm_prog_t *prog, mfunction_t *f)
555 prog->error_cmd("PRVM_EnterFunction: NULL function in %s", prog->name);
557 prog->stack[prog->depth].s = prog->xstatement;
558 prog->stack[prog->depth].f = prog->xfunction;
559 prog->stack[prog->depth].profile_acc = -f->profile;
560 prog->stack[prog->depth].tprofile_acc = -f->tprofile + -f->tbprofile;
561 prog->stack[prog->depth].builtinsprofile_acc = -f->builtinsprofile;
563 if (prog->depth >=PRVM_MAX_STACK_DEPTH)
564 prog->error_cmd("stack overflow");
566 // save off any locals that the new function steps on
568 if (prog->localstack_used + c > PRVM_LOCALSTACK_SIZE)
569 prog->error_cmd("PRVM_ExecuteProgram: locals stack overflow in %s", prog->name);
571 for (i=0 ; i < c ; i++)
572 prog->localstack[prog->localstack_used+i] = prog->globals.ip[f->parm_start + i];
573 prog->localstack_used += c;
577 for (i=0 ; i<f->numparms ; i++)
579 for (j=0 ; j<f->parm_size[i] ; j++)
581 prog->globals.ip[o] = prog->globals.ip[OFS_PARM0+i*3+j];
588 return f->first_statement - 1; // offset the s++
596 static int PRVM_LeaveFunction (prvm_prog_t *prog)
601 if (prog->depth <= 0)
602 prog->error_cmd("prog stack underflow in %s", prog->name);
604 if (!prog->xfunction)
605 prog->error_cmd("PR_LeaveFunction: NULL function in %s", prog->name);
606 // restore locals from the stack
607 c = prog->xfunction->locals;
608 prog->localstack_used -= c;
609 if (prog->localstack_used < 0)
610 prog->error_cmd("PRVM_ExecuteProgram: locals stack underflow in %s", prog->name);
612 for (i=0 ; i < c ; i++)
613 prog->globals.ip[prog->xfunction->parm_start + i] = prog->localstack[prog->localstack_used+i];
619 prog->xfunction = prog->stack[prog->depth].f;
620 prog->stack[prog->depth].profile_acc += f->profile;
621 prog->stack[prog->depth].tprofile_acc += f->tprofile + f->tbprofile;
622 prog->stack[prog->depth].builtinsprofile_acc += f->builtinsprofile;
625 prog->stack[prog->depth-1].profile_acc += prog->stack[prog->depth].profile_acc;
626 prog->stack[prog->depth-1].tprofile_acc += prog->stack[prog->depth].tprofile_acc;
627 prog->stack[prog->depth-1].builtinsprofile_acc += prog->stack[prog->depth].builtinsprofile_acc;
631 // if f is already on the call stack...
632 // we cannot add this profile data to it now
633 // or we would add it more than once
634 // so, let's only add to the function's profile if it is the outermost call
635 f->profile_total += prog->stack[prog->depth].profile_acc;
636 f->tprofile_total += prog->stack[prog->depth].tprofile_acc;
637 f->builtinsprofile_total += prog->stack[prog->depth].builtinsprofile_acc;
640 return prog->stack[prog->depth].s;
643 void PRVM_Init_Exec(prvm_prog_t *prog)
647 prog->localstack_used = 0;
648 // reset the string table
652 #define OPA ((prvm_eval_t *)&prog->globals.fp[st->operand[0]])
653 #define OPB ((prvm_eval_t *)&prog->globals.fp[st->operand[1]])
654 #define OPC ((prvm_eval_t *)&prog->globals.fp[st->operand[2]])
655 extern cvar_t prvm_traceqc;
656 extern cvar_t prvm_statementprofiling;
657 extern qboolean prvm_runawaycheck;
665 void MVM_ExecuteProgram (prvm_prog_t *prog, func_t fnum, const char *errormessage)
667 mstatement_t *st, *startst;
668 mfunction_t *f, *newf;
671 int jumpcount, cachedpr_trace, exitdepth;
672 int restorevm_tempstringsbuf_cursize;
676 calltime = Sys_DirtyTime();
678 if (!fnum || fnum >= (unsigned int)prog->numfunctions)
680 if (PRVM_allglobaledict(self))
681 PRVM_ED_Print(prog, PRVM_PROG_TO_EDICT(PRVM_allglobaledict(self)), NULL);
682 prog->error_cmd("MVM_ExecuteProgram: %s", errormessage);
685 f = &prog->functions[fnum];
687 // after executing this function, delete all tempstrings it created
688 restorevm_tempstringsbuf_cursize = prog->tempstringsbuf.cursize;
690 prog->trace = prvm_traceqc.integer;
692 // we know we're done when pr_depth drops to this
693 exitdepth = prog->depth;
695 // make a stack frame
696 st = &prog->statements[PRVM_EnterFunction(prog, f)];
697 // save the starting statement pointer for profiling
698 // (when the function exits or jumps, the (st - startst) integer value is
699 // added to the function's profile counter)
702 // instead of counting instructions, we count jumps
704 // add one to the callcount of this function because otherwise engine-called functions aren't counted
705 prog->xfunction->callcount++;
708 cachedpr_trace = prog->trace;
709 if (prvm_statementprofiling.integer || prog->trace)
711 #define PRVMSLOWINTERPRETER 1
712 if (prvm_timeprofiling.integer)
714 #define PRVMTIMEPROFILING 1
715 #include "prvm_execprogram.h"
716 #undef PRVMTIMEPROFILING
720 #include "prvm_execprogram.h"
722 #undef PRVMSLOWINTERPRETER
726 if (prvm_timeprofiling.integer)
728 #define PRVMTIMEPROFILING 1
729 #include "prvm_execprogram.h"
730 #undef PRVMTIMEPROFILING
734 #include "prvm_execprogram.h"
739 if (developer_insane.integer && prog->tempstringsbuf.cursize > restorevm_tempstringsbuf_cursize)
740 Con_DPrintf("MVM_ExecuteProgram: %s used %i bytes of tempstrings\n", PRVM_GetString(prog, prog->functions[fnum].s_name), prog->tempstringsbuf.cursize - restorevm_tempstringsbuf_cursize);
741 // delete tempstrings created by this function
742 prog->tempstringsbuf.cursize = restorevm_tempstringsbuf_cursize;
744 tm = Sys_DirtyTime() - calltime;if (tm < 0 || tm >= 1800) tm = 0;
747 if (prog == SVVM_prog)
748 SV_FlushBroadcastMessages();
756 void CLVM_ExecuteProgram (prvm_prog_t *prog, func_t fnum, const char *errormessage)
758 mstatement_t *st, *startst;
759 mfunction_t *f, *newf;
762 int jumpcount, cachedpr_trace, exitdepth;
763 int restorevm_tempstringsbuf_cursize;
767 calltime = Sys_DirtyTime();
769 if (!fnum || fnum >= (unsigned int)prog->numfunctions)
771 if (PRVM_allglobaledict(self))
772 PRVM_ED_Print(prog, PRVM_PROG_TO_EDICT(PRVM_allglobaledict(self)), NULL);
773 prog->error_cmd("CLVM_ExecuteProgram: %s", errormessage);
776 f = &prog->functions[fnum];
778 // after executing this function, delete all tempstrings it created
779 restorevm_tempstringsbuf_cursize = prog->tempstringsbuf.cursize;
781 prog->trace = prvm_traceqc.integer;
783 // we know we're done when pr_depth drops to this
784 exitdepth = prog->depth;
786 // make a stack frame
787 st = &prog->statements[PRVM_EnterFunction(prog, f)];
788 // save the starting statement pointer for profiling
789 // (when the function exits or jumps, the (st - startst) integer value is
790 // added to the function's profile counter)
793 // instead of counting instructions, we count jumps
795 // add one to the callcount of this function because otherwise engine-called functions aren't counted
796 prog->xfunction->callcount++;
799 cachedpr_trace = prog->trace;
800 if (prvm_statementprofiling.integer || prog->trace)
802 #define PRVMSLOWINTERPRETER 1
803 if (prvm_timeprofiling.integer)
805 #define PRVMTIMEPROFILING 1
806 #include "prvm_execprogram.h"
807 #undef PRVMTIMEPROFILING
811 #include "prvm_execprogram.h"
813 #undef PRVMSLOWINTERPRETER
817 if (prvm_timeprofiling.integer)
819 #define PRVMTIMEPROFILING 1
820 #include "prvm_execprogram.h"
821 #undef PRVMTIMEPROFILING
825 #include "prvm_execprogram.h"
830 if (developer_insane.integer && prog->tempstringsbuf.cursize > restorevm_tempstringsbuf_cursize)
831 Con_DPrintf("CLVM_ExecuteProgram: %s used %i bytes of tempstrings\n", PRVM_GetString(prog, prog->functions[fnum].s_name), prog->tempstringsbuf.cursize - restorevm_tempstringsbuf_cursize);
832 // delete tempstrings created by this function
833 prog->tempstringsbuf.cursize = restorevm_tempstringsbuf_cursize;
835 tm = Sys_DirtyTime() - calltime;if (tm < 0 || tm >= 1800) tm = 0;
838 if (prog == SVVM_prog)
839 SV_FlushBroadcastMessages();
849 void SVVM_ExecuteProgram (prvm_prog_t *prog, func_t fnum, const char *errormessage)
851 void PRVM_ExecuteProgram (prvm_prog_t *prog, func_t fnum, const char *errormessage)
854 mstatement_t *st, *startst;
855 mfunction_t *f, *newf;
858 int jumpcount, cachedpr_trace, exitdepth;
859 int restorevm_tempstringsbuf_cursize;
863 calltime = Sys_DirtyTime();
865 if (!fnum || fnum >= (unsigned int)prog->numfunctions)
867 if (PRVM_allglobaledict(self))
868 PRVM_ED_Print(prog, PRVM_PROG_TO_EDICT(PRVM_allglobaledict(self)), NULL);
869 prog->error_cmd("SVVM_ExecuteProgram: %s", errormessage);
872 f = &prog->functions[fnum];
874 // after executing this function, delete all tempstrings it created
875 restorevm_tempstringsbuf_cursize = prog->tempstringsbuf.cursize;
877 prog->trace = prvm_traceqc.integer;
879 // we know we're done when pr_depth drops to this
880 exitdepth = prog->depth;
882 // make a stack frame
883 st = &prog->statements[PRVM_EnterFunction(prog, f)];
884 // save the starting statement pointer for profiling
885 // (when the function exits or jumps, the (st - startst) integer value is
886 // added to the function's profile counter)
889 // instead of counting instructions, we count jumps
891 // add one to the callcount of this function because otherwise engine-called functions aren't counted
892 prog->xfunction->callcount++;
895 cachedpr_trace = prog->trace;
896 if (prvm_statementprofiling.integer || prog->trace)
898 #define PRVMSLOWINTERPRETER 1
899 if (prvm_timeprofiling.integer)
901 #define PRVMTIMEPROFILING 1
902 #include "prvm_execprogram.h"
903 #undef PRVMTIMEPROFILING
907 #include "prvm_execprogram.h"
909 #undef PRVMSLOWINTERPRETER
913 if (prvm_timeprofiling.integer)
915 #define PRVMTIMEPROFILING 1
916 #include "prvm_execprogram.h"
917 #undef PRVMTIMEPROFILING
921 #include "prvm_execprogram.h"
926 if (developer_insane.integer && prog->tempstringsbuf.cursize > restorevm_tempstringsbuf_cursize)
927 Con_DPrintf("SVVM_ExecuteProgram: %s used %i bytes of tempstrings\n", PRVM_GetString(prog, prog->functions[fnum].s_name), prog->tempstringsbuf.cursize - restorevm_tempstringsbuf_cursize);
928 // delete tempstrings created by this function
929 prog->tempstringsbuf.cursize = restorevm_tempstringsbuf_cursize;
931 tm = Sys_DirtyTime() - calltime;if (tm < 0 || tm >= 1800) tm = 0;
934 if (prog == SVVM_prog)
935 SV_FlushBroadcastMessages();