/* pr_exec.c (description) Copyright (C) 1996-1997 Id Software, Inc. This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to: Free Software Foundation, Inc. 59 Temple Place - Suite 330 Boston, MA 02111-1307, USA $Id$ */ #ifdef HAVE_CONFIG_H # include "config.h" #endif #ifdef HAVE_STRING_H # include #endif #ifdef HAVE_STRINGS_H # include #endif #include #include "QF/console.h" #include "QF/cvar.h" #include "QF/progs.h" #include "QF/sys.h" #include "QF/zone.h" #include "compat.h" //============================================================================= /* PR_PrintStatement */ void PR_PrintStatement (progs_t * pr, dstatement_t *s) { int i; int addr = s - pr->pr_statements; opcode_t *op; if (pr_debug->int_val && pr->debug) { const char *source_line = PR_Get_Source_Line (pr, addr); if (source_line) Con_Printf ("%s\n", source_line); } Con_Printf ("%-7d ", addr); op = PR_Opcode (s->op); if (op) { Con_Printf ("%s ", op->opname); i = strlen (op->opname); for (; i < 10; i++) Con_Printf (" "); } if (s->op == OP_IF || s->op == OP_IFNOT) Con_Printf ("%sbranch %i (%i)", PR_GlobalString (pr, (unsigned short) s->a), s->b, addr + s->b); else if (s->op == OP_GOTO) { Con_Printf ("branch %i (%i)", s->a, addr + s->a); } else if ((unsigned int) (s->op - OP_STORE_F) < 6) { Con_Printf ("%s", PR_GlobalString (pr, (unsigned short) s->a)); Con_Printf ("%s", PR_GlobalStringNoContents (pr, (unsigned short) s->b)); } else { if (s->a) Con_Printf ("%s", PR_GlobalString (pr, (unsigned short) s->a)); if (s->b) Con_Printf ("%s", PR_GlobalString (pr, (unsigned short) s->b)); if (s->c) Con_Printf ("%s", PR_GlobalStringNoContents (pr, (unsigned short) s->c)); } Con_Printf ("\n"); } /* PR_StackTrace */ void PR_StackTrace (progs_t * pr) { dfunction_t *f; int i; if (pr->pr_depth == 0) { Con_Printf ("\n"); return; } pr->pr_stack[pr->pr_depth].f = pr->pr_xfunction; for (i = pr->pr_depth; i >= 0; i--) { f = pr->pr_stack[i].f; if (!f) { Con_Printf ("\n"); } else Con_Printf ("%12s : %s\n", PR_GetString (pr, f->s_file), PR_GetString (pr, f->s_name)); } } /* PR_Profile */ void PR_Profile (progs_t * pr) { dfunction_t *f, *best; int max; int num; int i; num = 0; do { max = 0; best = NULL; for (i = 0; i < pr->progs->numfunctions; i++) { f = &pr->pr_functions[i]; if (f->profile > max) { max = f->profile; best = f; } } if (best) { if (num < 10) Con_Printf ("%7i %s\n", best->profile, PR_GetString (pr, best->s_name)); num++; best->profile = 0; } } while (best); } /* PR_RunError Aborts the currently executing function */ void PR_RunError (progs_t * pr, const char *error, ...) { va_list argptr; char string[1024]; va_start (argptr, error); vsnprintf (string, sizeof (string), error, argptr); va_end (argptr); if (pr_debug->int_val && pr->debug) { int addr = pr->pr_xstatement; while (!PR_Get_Source_Line (pr, addr)) addr--; while (addr != pr->pr_xstatement) PR_PrintStatement (pr, pr->pr_statements + addr++); } PR_PrintStatement (pr, pr->pr_statements + pr->pr_xstatement); PR_StackTrace (pr); Con_Printf ("%s\n", string); pr->pr_depth = 0; // dump the stack so PR_Error can // shutdown functions PR_Error (pr, "Program error"); } /* PR_EnterFunction Returns the new program statement counter */ int PR_EnterFunction (progs_t * pr, dfunction_t *f) { int i, j, c, o; //printf("%s:\n", PR_GetString(pr,f->s_name)); pr->pr_stack[pr->pr_depth].s = pr->pr_xstatement; pr->pr_stack[pr->pr_depth].f = pr->pr_xfunction; pr->pr_depth++; if (pr->pr_depth >= MAX_STACK_DEPTH) PR_RunError (pr, "stack overflow"); // save off any locals that the new function steps on c = f->locals; if (pr->localstack_used + c > LOCALSTACK_SIZE) PR_RunError (pr, "PR_ExecuteProgram: locals stack overflow\n"); memcpy (&pr->localstack[pr->localstack_used], &pr->pr_globals[f->parm_start], sizeof (pr_type_t) * c); pr->localstack_used += c; // copy parameters o = f->parm_start; for (i = 0; i < f->numparms; i++) { for (j = 0; j < f->parm_size[i]; j++) { memcpy (&pr->pr_globals[o], &pr->pr_globals[OFS_PARM0 + i * 3 + j], sizeof (pr_type_t)); o++; } } pr->pr_xfunction = f; return f->first_statement - 1; // offset the s++ } /* PR_LeaveFunction */ int PR_LeaveFunction (progs_t * pr) { int c; if (pr->pr_depth <= 0) PR_Error (pr, "prog stack underflow"); // restore locals from the stack c = pr->pr_xfunction->locals; pr->localstack_used -= c; if (pr->localstack_used < 0) PR_RunError (pr, "PR_ExecuteProgram: locals stack underflow\n"); memcpy (&pr->pr_globals[pr->pr_xfunction->parm_start], &pr->localstack[pr->localstack_used], sizeof (pr_type_t) * c); // up stack pr->pr_depth--; pr->pr_xfunction = pr->pr_stack[pr->pr_depth].f; return pr->pr_stack[pr->pr_depth].s; } /* PR_ExecuteProgram The interpretation main loop */ #define OPA (pr->pr_globals[(unsigned short) st->a]) #define OPB (pr->pr_globals[(unsigned short) st->b]) #define OPC (pr->pr_globals[(unsigned short) st->c]) extern cvar_t *pr_boundscheck; void PR_ExecuteProgram (progs_t * pr, func_t fnum) { dstatement_t *st; dfunction_t *f, *newf; edict_t *ed; int exitdepth; pr_type_t *ptr; int profile, startprofile; if (!fnum || fnum >= pr->progs->numfunctions) { if (*pr->globals.self) ED_Print (pr, PROG_TO_EDICT (pr, *pr->globals.self)); PR_Error (pr, "PR_ExecuteProgram: NULL function"); } f = &pr->pr_functions[fnum]; //printf("%s:\n", PR_GetString(pr,f->s_name)); pr->pr_trace = false; // make a stack frame exitdepth = pr->pr_depth; st = &pr->pr_statements[PR_EnterFunction (pr, f)]; startprofile = profile = 0; while (1) { st++; if (!pr->no_exec_limit && ++profile > 1000000) { pr->pr_xstatement = st - pr->pr_statements; PR_RunError (pr, "runaway loop error"); } if (pr->pr_trace) PR_PrintStatement (pr, st); switch (st->op) { case OP_ADD_F: OPC.float_var = OPA.float_var + OPB.float_var; break; case OP_ADD_V: OPC.vector_var[0] = OPA.vector_var[0] + OPB.vector_var[0]; OPC.vector_var[1] = OPA.vector_var[1] + OPB.vector_var[1]; OPC.vector_var[2] = OPA.vector_var[2] + OPB.vector_var[2]; break; case OP_ADD_S: { char *a = PR_GetString (pr, OPA.string_var); char *b = PR_GetString (pr, OPB.string_var); int lena = strlen (a); int size = lena + strlen (b) + 1; char *c = Hunk_TempAlloc (size); strcpy (c, a); strcpy (c + lena, b); OPC.string_var = PR_SetString (pr, c); } break; case OP_SUB_F: OPC.float_var = OPA.float_var - OPB.float_var; break; case OP_SUB_V: OPC.vector_var[0] = OPA.vector_var[0] - OPB.vector_var[0]; OPC.vector_var[1] = OPA.vector_var[1] - OPB.vector_var[1]; OPC.vector_var[2] = OPA.vector_var[2] - OPB.vector_var[2]; break; case OP_MUL_F: OPC.float_var = OPA.float_var * OPB.float_var; break; case OP_MUL_V: OPC.float_var = OPA.vector_var[0] * OPB.vector_var[0] + OPA.vector_var[1] * OPB.vector_var[1] + OPA.vector_var[2] * OPB.vector_var[2]; break; case OP_MUL_FV: OPC.vector_var[0] = OPA.float_var * OPB.vector_var[0]; OPC.vector_var[1] = OPA.float_var * OPB.vector_var[1]; OPC.vector_var[2] = OPA.float_var * OPB.vector_var[2]; break; case OP_MUL_VF: OPC.vector_var[0] = OPB.float_var * OPA.vector_var[0]; OPC.vector_var[1] = OPB.float_var * OPA.vector_var[1]; OPC.vector_var[2] = OPB.float_var * OPA.vector_var[2]; break; case OP_DIV_F: OPC.float_var = OPA.float_var / OPB.float_var; break; case OP_BITAND: OPC.float_var = (int) OPA.float_var & (int) OPB.float_var; break; case OP_BITOR: OPC.float_var = (int) OPA.float_var | (int) OPB.float_var; break; case OP_GE: OPC.float_var = OPA.float_var >= OPB.float_var; break; case OP_LE: OPC.float_var = OPA.float_var <= OPB.float_var; break; case OP_GT: OPC.float_var = OPA.float_var > OPB.float_var; break; case OP_LT: OPC.float_var = OPA.float_var < OPB.float_var; break; case OP_AND: // OPA and OPB have to be float for -0.0 OPC.integer_var = OPA.float_var && OPB.float_var; break; case OP_OR: // OPA and OPB have to be float for -0.0 OPC.integer_var = OPA.float_var || OPB.float_var; break; case OP_NOT_F: OPC.integer_var = !OPA.float_var; break; case OP_NOT_V: OPC.integer_var = !OPA.vector_var[0] && !OPA.vector_var[1] && !OPA.vector_var[2]; break; case OP_NOT_S: OPC.integer_var = !OPA.string_var || !*PR_GetString (pr, OPA.string_var); break; case OP_NOT_FNC: OPC.integer_var = !OPA.func_var; break; case OP_NOT_ENT: OPC.integer_var = !OPA.entity_var; break; case OP_EQ_F: OPC.integer_var = OPA.float_var == OPB.float_var; break; case OP_EQ_V: OPC.integer_var = (OPA.vector_var[0] == OPB.vector_var[0]) && (OPA.vector_var[1] == OPB.vector_var[1]) && (OPA.vector_var[2] == OPB.vector_var[2]); break; case OP_EQ_E: OPC.integer_var = OPA.integer_var == OPB.integer_var; break; case OP_EQ_FNC: OPC.integer_var = OPA.func_var == OPB.func_var; break; case OP_NE_F: OPC.integer_var = OPA.float_var != OPB.float_var; break; case OP_NE_V: OPC.integer_var = (OPA.vector_var[0] != OPB.vector_var[0]) || (OPA.vector_var[1] != OPB.vector_var[1]) || (OPA.vector_var[2] != OPB.vector_var[2]); break; case OP_LE_S: case OP_GE_S: case OP_LT_S: case OP_GT_S: case OP_NE_S: case OP_EQ_S: { int cmp = strcmp (PR_GetString (pr, OPA.string_var), PR_GetString (pr, OPB.string_var)); switch (st->op) { case OP_LE_S: cmp = (cmp <= 0); break; case OP_GE_S: cmp = (cmp >= 0); break; case OP_LT_S: cmp = (cmp < 0); break; case OP_GT_S: cmp = (cmp > 0); break; case OP_NE_S: break; case OP_EQ_S: cmp = !cmp; break; } OPC.integer_var = cmp; } break; case OP_NE_E: OPC.integer_var = OPA.integer_var != OPB.integer_var; break; case OP_NE_FNC: OPC.integer_var = OPA.func_var != OPB.func_var; break; // ================== case OP_STORE_F: case OP_STORE_ENT: case OP_STORE_FLD: // integers case OP_STORE_S: case OP_STORE_FNC: // pointers OPB.integer_var = OPA.integer_var; break; case OP_STORE_V: OPB.vector_var[0] = OPA.vector_var[0]; OPB.vector_var[1] = OPA.vector_var[1]; OPB.vector_var[2] = OPA.vector_var[2]; break; case OP_STOREP_F: case OP_STOREP_ENT: case OP_STOREP_FLD: // integers case OP_STOREP_S: case OP_STOREP_FNC: // pointers if (pr_boundscheck->int_val && (OPB.integer_var < 0 || OPB.integer_var + 4 > pr->pr_edictareasize)) { pr->pr_xstatement = st - pr->pr_statements; PR_RunError (pr, "Progs attempted to write to an out of bounds edict\n"); return; } if (pr_boundscheck->int_val && (OPB.integer_var % pr->pr_edict_size < ((byte *) & (*pr->edicts)->v - (byte *) * pr->edicts))) { pr->pr_xstatement = st - pr->pr_statements; PR_RunError (pr, "Progs attempted to write to an engine edict field\n"); return; } ptr = (pr_type_t*)((int)*pr->edicts + OPB.integer_var); ptr->integer_var = OPA.integer_var; break; case OP_STOREP_V: if (pr_boundscheck->int_val && (OPB.integer_var < 0 || OPB.integer_var + 12 > pr->pr_edictareasize)) { pr->pr_xstatement = st - pr->pr_statements; PR_RunError (pr, "Progs attempted to write to an out of bounds edict\n"); return; } ptr = (pr_type_t*)((int)*pr->edicts + OPB.integer_var); ptr->vector_var[0] = OPA.vector_var[0]; ptr->vector_var[1] = OPA.vector_var[1]; ptr->vector_var[2] = OPA.vector_var[2]; break; case OP_ADDRESS: if (pr_boundscheck->int_val && (OPA.entity_var < 0 || OPA.entity_var >= pr->pr_edictareasize)) { pr->pr_xstatement = st - pr->pr_statements; PR_RunError (pr, "Progs attempted to address an out of bounds edict\n"); return; } if (pr_boundscheck->int_val && (OPA.entity_var == 0 && pr->null_bad)) { pr->pr_xstatement = st - pr->pr_statements; PR_RunError (pr, "assignment to world entity"); return; } if (pr_boundscheck->int_val && (OPB.integer_var < 0 || OPB.integer_var >= pr->progs->entityfields)) { pr->pr_xstatement = st - pr->pr_statements; PR_RunError (pr, "Progs attempted to address an invalid field in an edict\n"); return; } ed = PROG_TO_EDICT (pr, OPA.entity_var); OPC.integer_var = (int)&ed->v[OPB.integer_var] - (int)*pr->edicts; break; case OP_LOAD_F: case OP_LOAD_FLD: case OP_LOAD_ENT: case OP_LOAD_S: case OP_LOAD_FNC: if (pr_boundscheck->int_val && (OPA.entity_var < 0 || OPA.entity_var >= pr->pr_edictareasize)) { pr->pr_xstatement = st - pr->pr_statements; PR_RunError (pr, "Progs attempted to read an out of bounds edict number\n"); return; } if (pr_boundscheck->int_val && (OPB.integer_var < 0 || OPB.integer_var >= pr->progs->entityfields)) { pr->pr_xstatement = st - pr->pr_statements; PR_RunError (pr, "Progs attempted to read an invalid field in an edict\n"); return; } ed = PROG_TO_EDICT (pr, OPA.entity_var); OPC.integer_var = ed->v[OPB.integer_var].integer_var; break; case OP_LOAD_V: if (pr_boundscheck->int_val && (OPA.entity_var < 0 || OPA.entity_var >= pr->pr_edictareasize)) { pr->pr_xstatement = st - pr->pr_statements; PR_RunError (pr, "Progs attempted to read an out of bounds edict number\n"); return; } if (pr_boundscheck->int_val && (OPB.integer_var < 0 || OPB.integer_var + 2 >= pr->progs->entityfields)) { pr->pr_xstatement = st - pr->pr_statements; PR_RunError (pr, "Progs attempted to read an invalid field in an edict\n"); return; } ed = PROG_TO_EDICT (pr, OPA.entity_var); memcpy (&OPC, &ed->v[OPB.integer_var], 3 * sizeof (OPC)); break; // ================== case OP_IFNOT: if (!OPA.integer_var) st += st->b - 1; // offset the s++ break; case OP_IF: if (OPA.integer_var) st += st->b - 1; // offset the s++ break; case OP_GOTO: st += st->a - 1; // offset the s++ break; case OP_CALL0: case OP_CALL1: case OP_CALL2: case OP_CALL3: case OP_CALL4: case OP_CALL5: case OP_CALL6: case OP_CALL7: case OP_CALL8: pr->pr_xfunction->profile += profile - startprofile; startprofile = profile; pr->pr_xstatement = st - pr->pr_statements; pr->pr_argc = st->op - OP_CALL0; if (!OPA.func_var) PR_RunError (pr, "NULL function"); newf = &pr->pr_functions[OPA.func_var]; if (newf->first_statement < 0) { // negative statements are built in functions int i = -newf->first_statement; if (i >= pr->numbuiltins) PR_RunError (pr, "Bad builtin call number"); pr->builtins[i] (pr); break; } st = &pr->pr_statements[PR_EnterFunction (pr, newf)]; break; case OP_DONE: case OP_RETURN: memcpy (&pr->pr_globals[OFS_RETURN], &OPA, 3 * sizeof (OPA)); st = &pr->pr_statements[PR_LeaveFunction (pr)]; if (pr->pr_depth == exitdepth) return; // all done break; case OP_STATE: ed = PROG_TO_EDICT (pr, *pr->globals.self); ed->v[pr->fields.nextthink].float_var = *pr->globals.time + 0.1; ed->v[pr->fields.frame].float_var = OPA.float_var; ed->v[pr->fields.think].func_var = OPB.func_var; break; case OP_ADD_I: OPC.integer_var = OPA.integer_var + OPB.integer_var; break; case OP_SUB_I: OPC.integer_var = OPA.integer_var - OPB.integer_var; break; case OP_MUL_I: OPC.integer_var = OPA.integer_var * OPB.integer_var; break; /* case OP_DIV_VF: { float temp = 1.0f / OPB.float_var; OPC.vector_var[0] = temp * OPA.vector_var[0]; OPC.vector_var[1] = temp * OPA.vector_var[1]; OPC.vector_var[2] = temp * OPA.vector_var[2]; } break; */ case OP_DIV_I: OPC.integer_var = OPA.integer_var / OPB.integer_var; break; case OP_CONV_IF: OPC.float_var = OPA.integer_var; break; case OP_CONV_FI: OPC.integer_var = OPA.float_var; break; case OP_BITAND_I: OPC.integer_var = OPA.integer_var & OPB.integer_var; break; case OP_BITOR_I: OPC.integer_var = OPA.integer_var | OPB.integer_var; break; case OP_GE_I: OPC.integer_var = OPA.integer_var >= OPB.integer_var; break; case OP_LE_I: OPC.integer_var = OPA.integer_var <= OPB.integer_var; break; case OP_GT_I: OPC.integer_var = OPA.integer_var > OPB.integer_var; break; case OP_LT_I: OPC.integer_var = OPA.integer_var < OPB.integer_var; break; case OP_AND_I: OPC.integer_var = OPA.integer_var && OPB.integer_var; break; case OP_OR_I: OPC.integer_var = OPA.integer_var || OPB.integer_var; break; case OP_NOT_I: OPC.integer_var = !OPA.integer_var; break; case OP_EQ_I: OPC.integer_var = OPA.integer_var == OPB.integer_var; break; case OP_NE_I: OPC.integer_var = OPA.integer_var != OPB.integer_var; break; case OP_STORE_I: OPB.integer_var = OPA.integer_var; break; case OP_STOREP_I: if (pr_boundscheck->int_val && (OPB.integer_var < 0 || OPB.integer_var + 4 > pr->pr_edictareasize)) { pr->pr_xstatement = st - pr->pr_statements; PR_RunError (pr, "Progs attempted to write to an out of bounds edict\n"); return; } if (pr_boundscheck->int_val && (OPB.integer_var % pr->pr_edict_size < ((byte *) & (*pr->edicts)->v - (byte *) *pr->edicts))) { pr->pr_xstatement = st - pr->pr_statements; PR_RunError (pr, "Progs attempted to write to an engine edict field\n"); return; } ptr = (pr_type_t*)((int)*pr->edicts + OPB.integer_var); ptr->integer_var = OPA.integer_var; break; case OP_LOAD_I: if (pr_boundscheck->int_val && (OPA.entity_var < 0 || OPA.entity_var >= pr->pr_edictareasize)) { pr->pr_xstatement = st - pr->pr_statements; PR_RunError (pr, "Progs attempted to read an out of bounds edict number\n"); return; } if (pr_boundscheck->int_val && (OPB.integer_var < 0 || OPB.integer_var >= pr->progs->entityfields)) { pr->pr_xstatement = st - pr->pr_statements; PR_RunError (pr, "Progs attempted to read an invalid field in an entity_var\n"); return; } ed = PROG_TO_EDICT (pr, OPA.entity_var); OPC.integer_var = ed->v[OPB.integer_var].integer_var; break; // LordHavoc: to be enabled when Progs version 7 (or whatever it will be numbered) is finalized /* case OP_GSTOREP_I: case OP_GSTOREP_F: case OP_GSTOREP_ENT: case OP_GSTOREP_FLD: // integers case OP_GSTOREP_S: case OP_GSTOREP_FNC: // pointers if (pr_boundscheck->int_val && (OPB.integer_var < 0 || OPB.integer_var >= pr->pr_globaldefs)) { pr->pr_xstatement = st - pr->pr_statements; PR_RunError (pr, "Progs attempted to write to an invalid indexed global\n"); return; } pr->pr_globals[OPB.integer_var] = OPA.float_var; break; case OP_GSTOREP_V: if (pr_boundscheck->int_val && (OPB.integer_var < 0 || OPB.integer_var + 2 >= pr->pr_globaldefs)) { pr->pr_xstatement = st - pr->pr_statements; PR_RunError (pr, "Progs attempted to write to an invalid indexed global\n"); return; } pr->pr_globals[OPB.integer_var] = OPA.vector_var[0]; pr->pr_globals[OPB.integer_var + 1] = OPA.vector_var[1]; pr->pr_globals[OPB.integer_var + 2] = OPA.vector_var[2]; break; case OP_GADDRESS: i = OPA.integer_var + (int) OPB.float_var; if (pr_boundscheck->int_val && (i < 0 || i >= pr->pr_globaldefs)) { pr->pr_xstatement = st - pr->pr_statements; PR_RunError (pr, "Progs attempted to address an out of bounds global\n"); return; } OPC.float_var = pr->pr_globals[i]; break; case OP_GLOAD_I: case OP_GLOAD_F: case OP_GLOAD_FLD: case OP_GLOAD_ENT: case OP_GLOAD_S: case OP_GLOAD_FNC: if (pr_boundscheck->int_val && (OPA.integer_var < 0 || OPA.integer_var >= pr->pr_globaldefs)) { pr->pr_xstatement = st - pr->pr_statements; PR_RunError (pr, "Progs attempted to read an invalid indexed global\n"); return; } OPC.float_var = pr->pr_globals[OPA.integer_var]; break; case OP_GLOAD_V: if (pr_boundscheck->int_val && (OPA.integer_var < 0 || OPA.integer_var + 2 >= pr->pr_globaldefs)) { pr->pr_xstatement = st - pr->pr_statements; PR_RunError (pr, "Progs attempted to read an invalid indexed global\n"); return; } OPC.vector_var[0] = pr->pr_globals[OPA.integer_var]; OPC.vector_var[1] = pr->pr_globals[OPA.integer_var + 1]; OPC.vector_var[2] = pr->pr_globals[OPA.integer_var + 2]; break; case OP_BOUNDCHECK: if (OPA.integer_var < 0 || OPA.integer_var >= st->b) { pr->pr_xstatement = st - pr->pr_statements; PR_RunError (pr, "Progs boundcheck failed at line number %d, value is < 0 or >= %d\n", st->b, st->c); return; } break; */ default: pr->pr_xstatement = st - pr->pr_statements; PR_RunError (pr, "Bad opcode %i", st->op); } } }