-Minor fix in VM_registercvar.
[divverent/darkplaces.git] / 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         num = 0;
208         do
209         {
210                 max = 0;
211                 best = NULL;
212                 for (i=0 ; i<prog->progs->numfunctions ; i++)
213                 {
214                         f = &prog->functions[i];
215                         if (f->profile > max)
216                         {
217                                 max = f->profile;
218                                 best = f;
219                         }
220                 }
221                 if (best)
222                 {
223                         //if (num < howmany)
224                                 Con_Printf("%s: %7i %7i %s\n", PRVM_NAME, best->profile, best->builtinsprofile, PRVM_GetString(best->s_name));
225                         num++;
226                         best->profile = 0;
227                         best->builtinsprofile = 0;
228                 }
229         } while (best);
230
231         PRVM_End;
232 }
233
234 void PRVM_CrashAll()
235 {
236         int i;
237         prvm_prog_t *oldprog = prog;
238
239         for(i = 0; i < PRVM_MAXPROGS; i++)
240         {
241                 if(!PRVM_ProgLoaded(i))
242                         continue;
243                 PRVM_SetProg(i);
244                 PRVM_Crash();
245         }
246         
247         prog = oldprog;
248 }
249
250 void PRVM_PrintState(void)
251 {
252         int i;
253         if (prog->xfunction)
254         {
255                 for (i = -7; i <= 0;i++)
256                         if (prog->xstatement + i >= prog->xfunction->first_statement)
257                                 PRVM_PrintStatement (prog->statements + prog->xstatement + i);
258         }
259         else
260                 Con_Print("null function executing??\n");
261         PRVM_StackTrace ();
262 }
263
264 void PRVM_Crash()
265 {
266         if (prog->depth < 1)
267         {
268                 // kill the stack just to be sure
269                 prog->depth = 0;
270                 prog->localstack_used = 0;
271                 return;
272         }
273
274         Con_Printf("QuakeC crash report for %s:\n", PRVM_NAME);
275         PRVM_PrintState();
276
277         // dump the stack so host_error can shutdown functions
278         prog->depth = 0;
279         prog->localstack_used = 0;
280
281 }
282
283 /*
284 ============================================================================
285 PRVM_ExecuteProgram
286
287 The interpretation main loop
288 ============================================================================
289 */
290
291 /*
292 ====================
293 PRVM_EnterFunction
294
295 Returns the new program statement counter
296 ====================
297 */
298 int PRVM_EnterFunction (mfunction_t *f)
299 {
300         int             i, j, c, o;
301
302         if (!f)
303                 PRVM_ERROR ("PRVM_EnterFunction: NULL function in %s\n", PRVM_NAME);
304
305         prog->stack[prog->depth].s = prog->xstatement;
306         prog->stack[prog->depth].f = prog->xfunction;
307         prog->depth++;
308         if (prog->depth >=PRVM_MAX_STACK_DEPTH)
309                 PRVM_ERROR ("stack overflow");
310
311 // save off any locals that the new function steps on
312         c = f->locals;
313         if (prog->localstack_used + c > PRVM_LOCALSTACK_SIZE)
314                 PRVM_ERROR ("PRVM_ExecuteProgram: locals stack overflow in %s\n", PRVM_NAME);
315
316         for (i=0 ; i < c ; i++)
317                 prog->localstack[prog->localstack_used+i] = ((int *)prog->globals)[f->parm_start + i];
318         prog->localstack_used += c;
319
320 // copy parameters
321         o = f->parm_start;
322         for (i=0 ; i<f->numparms ; i++)
323         {
324                 for (j=0 ; j<f->parm_size[i] ; j++)
325                 {
326                         ((int *)prog->globals)[o] = ((int *)prog->globals)[OFS_PARM0+i*3+j];
327                         o++;
328                 }
329         }
330
331         prog->xfunction = f;
332         return f->first_statement - 1;  // offset the s++
333 }
334
335 /*
336 ====================
337 PRVM_LeaveFunction
338 ====================
339 */
340 int PRVM_LeaveFunction (void)
341 {
342         int             i, c;
343
344         if (prog->depth <= 0)
345                 PRVM_ERROR ("prog stack underflow in %s", PRVM_NAME);
346
347         if (!prog->xfunction)
348                 PRVM_ERROR ("PR_LeaveFunction: NULL function in %s\n", PRVM_NAME);
349 // restore locals from the stack
350         c = prog->xfunction->locals;
351         prog->localstack_used -= c;
352         if (prog->localstack_used < 0)
353                 PRVM_ERROR ("PRVM_ExecuteProgram: locals stack underflow in %s\n", PRVM_NAME);
354
355         for (i=0 ; i < c ; i++)
356                 ((int *)prog->globals)[prog->xfunction->parm_start + i] = prog->localstack[prog->localstack_used+i];
357
358 // up stack
359         prog->depth--;
360         prog->xfunction = prog->stack[prog->depth].f;
361         return prog->stack[prog->depth].s;
362 }
363
364 void PRVM_Init_Exec(void)
365 {
366         // dump the stack
367         prog->depth = 0;
368         prog->localstack_used = 0;
369         // reset the string table
370         // nothing here yet
371 }
372
373 /*
374 ====================
375 PRVM_ExecuteProgram
376 ====================
377 */
378 // LordHavoc: optimized
379 #define OPA ((prvm_eval_t *)&prog->globals[(unsigned short) st->a])
380 #define OPB ((prvm_eval_t *)&prog->globals[(unsigned short) st->b])
381 #define OPC ((prvm_eval_t *)&prog->globals[(unsigned short) st->c])
382 extern cvar_t prvm_boundscheck;
383 extern cvar_t prvm_traceqc;
384 extern int              PRVM_ED_FindFieldOffset (const char *field);
385 extern ddef_t*  PRVM_ED_FindGlobal(const char *name); 
386 void PRVM_ExecuteProgram (func_t fnum, const char *errormessage)
387 {
388         dstatement_t    *st;
389         mfunction_t     *f, *newf;
390         prvm_edict_t    *ed;
391         prvm_eval_t     *ptr;
392         int             profile, startprofile, cachedpr_trace, exitdepth;
393
394         if (!fnum || fnum >= prog->progs->numfunctions)
395         {
396                 if (prog->self && PRVM_G_INT(prog->self->ofs))
397                         PRVM_ED_Print(PRVM_PROG_TO_EDICT(PRVM_G_INT(prog->self->ofs)));
398                 PRVM_ERROR ("PR_ExecuteProgram: %s", errormessage);
399         }
400
401         f = &prog->functions[fnum];
402
403         prog->trace = prvm_traceqc.integer;
404
405         // we know we're done when pr_depth drops to this
406         exitdepth = prog->depth;
407
408 // make a stack frame
409         st = &prog->statements[PRVM_EnterFunction (f)];
410         startprofile = profile = 0;
411
412 chooseexecprogram:
413         cachedpr_trace = prog->trace;
414         if (prvm_boundscheck.integer)
415         {
416 #define PRVMBOUNDSCHECK 1
417                 if (prog->trace)
418                 {
419 #define PRVMTRACE 1
420 #include "prvm_execprogram.h"
421                 }
422                 else
423                 {
424 #undef PRVMTRACE
425 #include "prvm_execprogram.h"
426                 }
427         }
428         else
429         {
430 #undef PRVMBOUNDSCHECK
431                 if (prog->trace)
432                 {
433 #define PRVMTRACE 1
434 #include "prvm_execprogram.h"
435                 }
436                 else
437                 {
438 #undef PRVMTRACE
439 #include "prvm_execprogram.h"
440                 }
441         }
442 }