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.
21 This is a try to make the vm more generic, it is mainly based on the progs.h file.
22 For the license refer to progs.h.
24 Generic means, less as possible hard-coded links with the other parts of the engine.
25 This means no edict_engineprivate struct usage, etc.
26 The code uses void pointers instead.
32 #include "pr_comp.h" // defs shared with qcc
33 #include "progdefs.h" // generated by program cdefs
34 #include "clprogdefs.h" // generated by program cdefs
36 // forward declaration of clgecko_t
39 typedef struct prvm_stack_s
46 typedef union prvm_eval_s
57 typedef struct prvm_required_field_s
61 } prvm_required_field_t;
64 // AK: I dont call it engine private cause it doesnt really belongs to the engine
65 // it belongs to prvm.
66 typedef struct prvm_edict_private_s
71 const char *allocation_origin;
72 } prvm_edict_private_t;
74 typedef struct prvm_edict_s
76 // engine-private fields (stored in dynamically resized array)
77 //edict_engineprivate_t *e;
80 prvm_edict_private_t *required;
82 // FIXME: this server pointer really means world, not server
83 // (it is used by both server qc and client qc, but not menu qc)
84 edict_engineprivate_t *server;
85 // add other private structs as you desire
86 // new structs have to start with the elements of prvm_edit_private_t
87 // e.g. a new struct has to either look like this:
88 // typedef struct server_edict_private_s {
89 // prvm_edict_private_t base;
91 // vec3_t moved_fromangles;
92 // ... } server_edict_private_t;
94 // typedef struct server_edict_private_s {
98 // vec3_t moved_fromangles;
99 // ... } server_edict_private_t;
100 // However, the first one should be preferred.
102 // QuakeC fields (stored in dynamically resized array)
107 cl_entvars_t *client;
111 #define PRVM_EDICTFIELDVALUE(ed, fieldoffset) (fieldoffset >= 0 ? (prvm_eval_t *)((int *)ed->fields.vp + fieldoffset) : NULL)
112 #define PRVM_GLOBALFIELDVALUE(fieldoffset) (fieldoffset >= 0 ? (prvm_eval_t *)((int *)prog->globals.generic + fieldoffset) : NULL)
114 //============================================================================
115 #define PRVM_OP_STATE 1
117 #define PRVM_MAX_STACK_DEPTH 1024
118 #define PRVM_LOCALSTACK_SIZE 16384
120 #define PRVM_MAX_OPENFILES 256
121 #define PRVM_MAX_OPENSEARCHES 128
122 #define PRVM_MAX_GECKOINSTANCES 32
124 typedef void (*prvm_builtin_t) (void);
126 // NOTE: field offsets use -1 for NULL
127 typedef struct prvm_prog_fieldoffsets_s
129 // server and client use a lot of similar fields, so this is combined
130 int SendEntity; // ssqc
131 int SendFlags; // ssqc
132 int Version; // ssqc (legacy)
133 int alpha; // ssqc / csqc
134 int ammo_cells1; // ssqc - Dissolution of Eternity mission pack
135 int ammo_lava_nails; // ssqc - Dissolution of Eternity mission pack
136 int ammo_multi_rockets; // ssqc - Dissolution of Eternity mission pack
137 int ammo_nails1; // ssqc - Dissolution of Eternity mission pack
138 int ammo_plasma; // ssqc - Dissolution of Eternity mission pack
139 int ammo_rockets1; // ssqc - Dissolution of Eternity mission pack
140 int ammo_shells1; // ssqc - Dissolution of Eternity mission pack
141 int angles; // common - used by changeyaw/changepitch
149 int button10; // ssqc
150 int button11; // ssqc
151 int button12; // ssqc
152 int button13; // ssqc
153 int button14; // ssqc
154 int button15; // ssqc
155 int button16; // ssqc
156 int buttonchat; // ssqc
157 int buttonuse; // ssqc
158 int chain; // common - used by find builtins
159 int classname; // common
160 int clientcolors; // ssqc
162 int colormod; // ssqc / csqc
163 int contentstransition; // ssqc
164 int cursor_active; // ssqc
165 int cursor_screen; // ssqc
166 int cursor_trace_endpos; // ssqc
167 int cursor_trace_ent; // ssqc
168 int cursor_trace_start; // ssqc
169 int customizeentityforclient; // ssqc
170 int dimension_hit; // ssqc / csqc
171 int dimension_solid; // ssqc / csqc
172 int disableclientprediction; // ssqc
173 int dphitcontentsmask; // ssqc / csqc
174 int drawonlytoclient; // ssqc
175 int effects; // ssqc / csqc
176 int exteriormodeltoclient; // ssqc
177 int fatness; // ssqc / csqc
178 int forceshader; // csqc
179 int frame1time; // csqc
181 int frame2time; // csqc
182 int frame; // common - used by OP_STATE
183 int fullbright; // ssqc - Nehahra support
184 int glow_color; // ssqc
185 int glow_size; // ssqc
186 int glow_trail; // ssqc
188 int groundentity; // ssqc / csqc
189 int hull; // ssqc / csqc
190 int ideal_yaw; // ssqc / csqc
191 int idealpitch; // ssqc / csqc
193 int lerpfrac; // csqc
194 int light_lev; // ssqc
196 int modelflags; // ssqc
197 int movement; // ssqc
198 int movetypesteplandevent; // ssqc
199 int netaddress; // ssqc
200 int nextthink; // common - used by OP_STATE
201 int nodrawtoclient; // ssqc
204 int pitch_speed; // ssqc / csqc
205 int playermodel; // ssqc
206 int playerskin; // ssqc
208 int punchvector; // ssqc
209 int renderamt; // ssqc - HalfLife support
210 int renderflags; // csqc
211 int rendermode; // ssqc - HalfLife support
212 int scale; // ssqc / csqc
214 int tag_entity; // ssqc / csqc
215 int tag_index; // ssqc / csqc
216 int think; // common - used by OP_STATE
217 int viewmodelforclient; // ssqc
218 int viewzoom; // ssqc
219 int yaw_speed; // ssqc / csqc
220 int clientcamera; // ssqc
221 int clientstatus; // ssqc
223 prvm_prog_fieldoffsets_t;
225 // NOTE: global offsets use -1 for NULL
226 typedef struct prvm_prog_globaloffsets_s
228 // server and client use a lot of similar globals, so this is combined
229 int SV_InitCmd; // ssqc
231 int time; // ssqc / csqc
232 int v_forward; // ssqc / csqc
233 int v_right; // ssqc / csqc
234 int v_up; // ssqc / csqc
235 int view_angles; // csqc
236 int trace_allsolid; // ssqc / csqc
237 int trace_startsolid; // ssqc / csqc
238 int trace_fraction; // ssqc / csqc
239 int trace_inwater; // ssqc / csqc
240 int trace_inopen; // ssqc / csqc
241 int trace_endpos; // ssqc / csqc
242 int trace_plane_normal; // ssqc / csqc
243 int trace_plane_dist; // ssqc / csqc
244 int trace_ent; // ssqc / csqc
245 int trace_dphitcontents; // ssqc / csqc
246 int trace_dphitq3surfaceflags; // ssqc / csqc
247 int trace_dphittexturename; // ssqc / csqc
248 int trace_dpstartcontents; // ssqc / csqc
249 int intermission; // csqc
251 int deathmatch; // csqc
252 int dmg_take; // csqc
253 int dmg_save; // csqc
254 int dmg_origin; // csqc
255 int sb_showscores; // csqc
256 int drawfont; // csqc / menu
257 int require_spawnfunc_prefix; // ssqc
258 int worldstatus; // ssqc
260 prvm_prog_globaloffsets_t;
262 // these are initialized using PRVM_ED_FindFunction
263 // NOTE: function offsets use 0 for NULL
264 typedef struct prvm_prog_funcoffsets_s
266 func_t CSQC_ConsoleCommand; // csqc
267 func_t CSQC_Ent_Remove; // csqc
268 func_t CSQC_Ent_Spawn; // csqc DP_CSQC_ENT_SPAWN extension (BlackHC - TODO: needs to be added to dpextensions.qc)
269 func_t CSQC_Ent_Update; // csqc
270 func_t CSQC_Event; // csqc [515]: engine call this for its own needs so csqc can do some things according to what engine it's running on. example: to say about edicts increase, whatever...
271 func_t CSQC_Event_Sound; // csqc : called by engine when an incoming sound packet arrives so CSQC can act on it
272 func_t CSQC_Init; // csqc
273 func_t CSQC_InputEvent; // csqc
274 func_t CSQC_Parse_CenterPrint; // csqc
275 func_t CSQC_Parse_Print; // csqc
276 func_t CSQC_Parse_StuffCmd; // csqc
277 func_t CSQC_Parse_TempEntity; // csqc [515]: very helpfull when you want to create your own particles/decals/etc for effects that already exist
278 func_t CSQC_Shutdown; // csqc
279 func_t CSQC_UpdateView; // csqc
280 func_t Gecko_Query; // csqc, mqc
281 func_t EndFrame; // ssqc
282 func_t RestoreGame; // ssqc
283 func_t SV_ChangeTeam; // ssqc
284 func_t SV_ParseClientCommand; // ssqc
285 func_t SV_PlayerPhysics; // ssqc
286 func_t SV_OnEntityNoSpawnFunction; // ssqc
287 func_t GameCommand; // any
288 func_t SV_Shutdown; // ssqc
289 func_t URI_Get_Callback; // any
291 // menu qc only uses some functions, nothing else
292 func_t m_draw; // mqc
293 func_t m_init; // mqc
294 func_t m_keydown; // mqc
295 func_t m_keyup; // mqc
296 func_t m_shutdown; // mqc
297 func_t m_toggle; // mqc
299 prvm_prog_funcoffsets_t;
301 typedef struct prvm_stringbuffer_s
310 // [INIT] variables flagged with this token can be initialized by 'you'
311 // NOTE: external code has to create and free the mempools but everything else is done by prvm !
312 typedef struct prvm_prog_s
316 mfunction_t *functions;
321 dstatement_t *statements;
322 int edict_size; // in bytes
323 int edictareasize; // LordHavoc: in bytes (for bound checking)
325 int *statement_linenums; // NULL if not available
327 double *statement_profile; // only incremented if prvm_statementprofiling is on
331 globalvars_t *server;
332 cl_globalvars_t *client;
337 // this is updated whenever a string is removed or added
338 // (simple optimization of the free string search)
339 int firstfreeknownstring;
340 const char **knownstrings;
341 unsigned char *knownstrings_freeable;
342 const char **knownstrings_origin;
343 const char ***stringshash;
345 memexpandablearray_t stringbuffersarray;
347 // all memory allocations related to this vm_prog (code, edicts, strings)
348 mempool_t *progs_mempool; // [INIT]
350 prvm_builtin_t *builtins; // [INIT]
351 int numbuiltins; // [INIT]
356 mfunction_t *xfunction;
359 // stacktrace writes into stack[MAX_STACK_DEPTH]
360 // thus increase the array, so depth wont be overwritten
361 prvm_stack_t stack[PRVM_MAX_STACK_DEPTH+1];
364 int localstack[PRVM_LOCALSTACK_SIZE];
367 unsigned short headercrc; // [INIT]
368 unsigned short headercrc2; // [INIT] alternate CRC for tenebrae progs.dat
370 unsigned short filecrc;
372 //============================================================================
373 // until this point everything also exists (with the pr_ prefix) in the old vm
375 qfile_t *openfiles[PRVM_MAX_OPENFILES];
376 const char * openfiles_origin[PRVM_MAX_OPENFILES];
377 fssearch_t *opensearches[PRVM_MAX_OPENSEARCHES];
378 const char * opensearches_origin[PRVM_MAX_OPENSEARCHES];
379 struct clgecko_s *opengeckoinstances[PRVM_MAX_GECKOINSTANCES];
381 // copies of some vars that were former read from sv
383 // number of edicts for which space has been (should be) allocated
384 int max_edicts; // [INIT]
385 // used instead of the constant MAX_EDICTS
386 int limit_edicts; // [INIT]
388 // number of reserved edicts (allocated from 1)
389 int reserved_edicts; // [INIT]
391 prvm_edict_t *edicts;
395 // size of the engine private struct
396 int edictprivate_size; // [INIT]
398 prvm_prog_fieldoffsets_t fieldoffsets;
399 prvm_prog_globaloffsets_t globaloffsets;
400 prvm_prog_funcoffsets_t funcoffsets;
402 // allow writing to world entity fields, this is set by server init and
403 // cleared before first server frame
404 qboolean allowworldwrites;
406 // name of the prog, e.g. "Server", "Client" or "Menu" (used for text output)
407 char *name; // [INIT]
409 // flag - used to store general flags like PRVM_GE_SELF, etc.
412 char *extensionstring; // [INIT]
414 qboolean loadintoworld; // [INIT]
416 // used to indicate whether a prog is loaded
418 qboolean leaktest_active;
420 // prvm_builtin_mem_t *mem_list;
422 // now passed as parameter of PRVM_LoadProgs
423 // char **required_func;
424 // int numrequiredfunc;
426 //============================================================================
428 ddef_t *self; // if self != 0 then there is a global self
430 //============================================================================
433 void (*begin_increase_edicts)(void); // [INIT] used by PRVM_MEM_Increase_Edicts
434 void (*end_increase_edicts)(void); // [INIT]
436 void (*init_edict)(prvm_edict_t *edict); // [INIT] used by PRVM_ED_ClearEdict
437 void (*free_edict)(prvm_edict_t *ed); // [INIT] used by PRVM_ED_Free
439 void (*count_edicts)(void); // [INIT] used by PRVM_ED_Count_f
441 qboolean (*load_edict)(prvm_edict_t *ent); // [INIT] used by PRVM_ED_LoadFromFile
443 void (*init_cmd)(void); // [INIT] used by PRVM_InitProg
444 void (*reset_cmd)(void); // [INIT] used by PRVM_ResetProg
446 void (*error_cmd)(const char *format, ...) DP_FUNC_PRINTF(1); // [INIT]
450 extern prvm_prog_t * prog;
452 #define PRVM_MAXPROGS 3
453 #define PRVM_SERVERPROG 0 // actually not used at the moment
454 #define PRVM_CLIENTPROG 1
455 #define PRVM_MENUPROG 2
457 extern prvm_prog_t prvm_prog_list[PRVM_MAXPROGS];
459 //============================================================================
462 extern prvm_builtin_t vm_sv_builtins[];
463 extern prvm_builtin_t vm_cl_builtins[];
464 extern prvm_builtin_t vm_m_builtins[];
466 extern const int vm_sv_numbuiltins;
467 extern const int vm_cl_numbuiltins;
468 extern const int vm_m_numbuiltins;
470 extern char * vm_sv_extensions; // client also uses this
471 extern char * vm_m_extensions;
473 void VM_SV_Cmd_Init(void);
474 void VM_SV_Cmd_Reset(void);
476 void VM_CL_Cmd_Init(void);
477 void VM_CL_Cmd_Reset(void);
479 void VM_M_Cmd_Init(void);
480 void VM_M_Cmd_Reset(void);
482 void VM_Cmd_Init(void);
483 void VM_Cmd_Reset(void);
484 //============================================================================
486 void PRVM_Init (void);
488 void PRVM_ExecuteProgram (func_t fnum, const char *errormessage);
490 #define PRVM_Alloc(buffersize) _PRVM_Alloc(buffersize, __FILE__, __LINE__)
491 #define PRVM_Free(buffer) _PRVM_Free(buffer, __FILE__, __LINE__)
492 #define PRVM_FreeAll() _PRVM_FreeAll(__FILE__, __LINE__)
493 void *_PRVM_Alloc (size_t buffersize, const char *filename, int fileline);
494 void _PRVM_Free (void *buffer, const char *filename, int fileline);
495 void _PRVM_FreeAll (const char *filename, int fileline);
497 void PRVM_Profile (int maxfunctions, int mininstructions);
498 void PRVM_Profile_f (void);
499 void PRVM_CallProfile_f (void);
500 void PRVM_PrintFunction_f (void);
502 void PRVM_PrintState(void);
503 void PRVM_CrashAll (void);
504 void PRVM_Crash (void);
505 void PRVM_ShortStackTrace(char *buf, size_t bufsize);
506 const char *PRVM_AllocationOrigin();
508 ddef_t *PRVM_ED_FindField(const char *name);
509 ddef_t *PRVM_ED_FindGlobal(const char *name);
510 mfunction_t *PRVM_ED_FindFunction(const char *name);
512 int PRVM_ED_FindFieldOffset(const char *name);
513 int PRVM_ED_FindGlobalOffset(const char *name);
514 func_t PRVM_ED_FindFunctionOffset(const char *name);
515 #define PRVM_ED_FindFieldOffset_FromStruct(st, field) prog->fieldoffsets . field = ((int *)(&((st *)NULL)-> field ) - ((int *)NULL))
516 #define PRVM_ED_FindGlobalOffset_FromStruct(st, field) prog->globaloffsets . field = ((int *)(&((st *)NULL)-> field ) - ((int *)NULL))
518 void PRVM_MEM_IncreaseEdicts(void);
520 prvm_edict_t *PRVM_ED_Alloc (void);
521 void PRVM_ED_Free (prvm_edict_t *ed);
522 void PRVM_ED_ClearEdict (prvm_edict_t *e);
524 void PRVM_PrintFunctionStatements (const char *name);
525 void PRVM_ED_Print(prvm_edict_t *ed, const char *wildcard_fieldname);
526 void PRVM_ED_Write (qfile_t *f, prvm_edict_t *ed);
527 const char *PRVM_ED_ParseEdict (const char *data, prvm_edict_t *ent);
529 void PRVM_ED_WriteGlobals (qfile_t *f);
530 void PRVM_ED_ParseGlobals (const char *data);
532 void PRVM_ED_LoadFromFile (const char *data);
534 unsigned int PRVM_EDICT_NUM_ERROR(unsigned int n, char *filename, int fileline);
535 #define PRVM_EDICT(n) (((unsigned)(n) < (unsigned int)prog->max_edicts) ? (unsigned int)(n) : PRVM_EDICT_NUM_ERROR((unsigned int)(n), __FILE__, __LINE__))
536 #define PRVM_EDICT_NUM(n) (prog->edicts + PRVM_EDICT(n))
538 //int NUM_FOR_EDICT_ERROR(prvm_edict_t *e);
539 #define PRVM_NUM_FOR_EDICT(e) ((int)((prvm_edict_t *)(e) - prog->edicts))
540 //int PRVM_NUM_FOR_EDICT(prvm_edict_t *e);
542 #define PRVM_NEXT_EDICT(e) ((e) + 1)
544 #define PRVM_EDICT_TO_PROG(e) (PRVM_NUM_FOR_EDICT(e))
545 //int PRVM_EDICT_TO_PROG(prvm_edict_t *e);
546 #define PRVM_PROG_TO_EDICT(n) (PRVM_EDICT_NUM(n))
547 //prvm_edict_t *PRVM_PROG_TO_EDICT(int n);
549 //============================================================================
551 #define PRVM_G_FLOAT(o) (prog->globals.generic[o])
552 #define PRVM_G_INT(o) (*(int *)&prog->globals.generic[o])
553 #define PRVM_G_EDICT(o) (PRVM_PROG_TO_EDICT(*(int *)&prog->globals.generic[o]))
554 #define PRVM_G_EDICTNUM(o) PRVM_NUM_FOR_EDICT(PRVM_G_EDICT(o))
555 #define PRVM_G_VECTOR(o) (&prog->globals.generic[o])
556 #define PRVM_G_STRING(o) (PRVM_GetString(*(string_t *)&prog->globals.generic[o]))
557 //#define PRVM_G_FUNCTION(o) (*(func_t *)&prog->globals.generic[o])
559 // FIXME: make these go away?
560 #define PRVM_E_FLOAT(e,o) (((float*)e->fields.vp)[o])
561 #define PRVM_E_INT(e,o) (((int*)e->fields.vp)[o])
562 //#define PRVM_E_VECTOR(e,o) (&((float*)e->fields.vp)[o])
563 #define PRVM_E_STRING(e,o) (PRVM_GetString(*(string_t *)&((float*)e->fields.vp)[o]))
565 extern int prvm_type_size[8]; // for consistency : I think a goal of this sub-project is to
566 // make the new vm mostly independent from the old one, thus if it's necessary, I copy everything
568 void PRVM_Init_Exec(void);
570 void PRVM_ED_PrintEdicts_f (void);
571 void PRVM_ED_PrintNum (int ent, const char *wildcard_fieldname);
573 const char *PRVM_GetString(int num);
574 int PRVM_SetEngineString(const char *s);
575 int PRVM_SetTempString(const char *s);
576 int PRVM_AllocString(size_t bufferlength, char **pointer);
577 void PRVM_FreeString(int num);
579 //============================================================================
581 // used as replacement for a prog stack
582 //#define PRVM_DEBUGPRSTACK
584 #ifdef PRVM_DEBUGPRSTACK
585 #define PRVM_Begin if(prog != 0) Con_Printf("prog not 0(prog = %i) in file: %s line: %i!\n", PRVM_GetProgNr(), __FILE__, __LINE__)
586 #define PRVM_End prog = 0
589 #define PRVM_End prog = 0
592 //#define PRVM_SAFENAME
593 #ifndef PRVM_SAFENAME
594 # define PRVM_NAME (prog->name)
596 # define PRVM_NAME (prog->name ? prog->name : "Unknown prog name")
599 // helper macro to make function pointer calls easier
600 #define PRVM_GCALL(func) if(prog->func) prog->func
602 #define PRVM_ERROR prog->error_cmd
604 // other prog handling functions
605 qboolean PRVM_SetProgFromString(const char *str);
606 void PRVM_SetProg(int prognr);
610 Call InitProg with the num
611 Set up the fields marked with [INIT] in the prog struct
612 Load a program with LoadProgs
614 void PRVM_InitProg(int prognr);
615 // LoadProgs expects to be called right after InitProg
616 void PRVM_LoadProgs (const char *filename, int numrequiredfunc, char **required_func, int numrequiredfields, prvm_required_field_t *required_field, int numrequiredglobals, char **required_global);
617 void PRVM_ResetProg(void);
619 qboolean PRVM_ProgLoaded(int prognr);
621 int PRVM_GetProgNr(void);
623 void VM_Warning(const char *fmt, ...) DP_FUNC_PRINTF(1);
625 // TODO: fill in the params
626 //void PRVM_Create();