]> de.git.xonotic.org Git - xonotic/darkplaces.git/blobdiff - prvm_edict.c
replaced prvm_tempstringmemory cvar with automatic buffer growth (with a limit of...
[xonotic/darkplaces.git] / prvm_edict.c
index c9a3a5d28bc77d8a50ed30cba95a263b20472e68..c7c6e61fb9a8f44dff385bcde0d062c30624aae0 100644 (file)
@@ -35,6 +35,8 @@ qboolean PRVM_ED_ParseEpair(prvm_edict_t *ent, ddef_t *key, const char *s);
 cvar_t prvm_boundscheck = {0, "prvm_boundscheck", "1", "enables detection of out of bounds memory access in the QuakeC code being run (in other words, prevents really exceedingly bad QuakeC code from doing nasty things to your computer)"};
 // LordHavoc: prints every opcode as it executes - warning: this is significant spew
 cvar_t prvm_traceqc = {0, "prvm_traceqc", "0", "prints every QuakeC statement as it is executed (only for really thorough debugging!)"};
+// LordHavoc: counts usage of each QuakeC statement
+cvar_t prvm_statementprofiling = {0, "prvm_statementprofiling", "0", "counts how many times each QuakeC statement has been executed, these counts are displayed in prvm_printfunction output (if enabled)"};
 
 //============================================================================
 // mempool handling
@@ -420,7 +422,7 @@ char *PRVM_ValueString (etype_t type, prvm_eval_t *val)
                sprintf (line, "pointer");
                break;
        default:
-               sprintf (line, "bad type %i", type);
+               sprintf (line, "bad type %i", (int) type);
                break;
        }
 
@@ -509,7 +511,7 @@ padded to 20 field width
 char *PRVM_GlobalString (int ofs)
 {
        char    *s;
-       size_t  i;
+       //size_t        i;
        ddef_t  *def;
        void    *val;
        static char     line[128];
@@ -517,37 +519,37 @@ char *PRVM_GlobalString (int ofs)
        val = (void *)&prog->globals.generic[ofs];
        def = PRVM_ED_GlobalAtOfs(ofs);
        if (!def)
-               sprintf (line,"%i(?)", ofs);
+               sprintf (line,"GLOBAL%i", ofs);
        else
        {
                s = PRVM_ValueString ((etype_t)def->type, (prvm_eval_t *)val);
-               sprintf (line,"%i(%s)%s", ofs, PRVM_GetString(def->s_name), s);
+               sprintf (line,"%s (=%s)", PRVM_GetString(def->s_name), s);
        }
 
-       i = strlen(line);
-       for ( ; i<20 ; i++)
-               strcat (line," ");
-       strcat (line," ");
+       //i = strlen(line);
+       //for ( ; i<20 ; i++)
+       //      strcat (line," ");
+       //strcat (line," ");
 
        return line;
 }
 
 char *PRVM_GlobalStringNoContents (int ofs)
 {
-       size_t  i;
+       //size_t        i;
        ddef_t  *def;
        static char     line[128];
 
        def = PRVM_ED_GlobalAtOfs(ofs);
        if (!def)
-               sprintf (line,"%i(?)", ofs);
+               sprintf (line,"GLOBAL%i", ofs);
        else
-               sprintf (line,"%i(%s)", ofs, PRVM_GetString(def->s_name));
+               sprintf (line,"%s", PRVM_GetString(def->s_name));
 
-       i = strlen(line);
-       for ( ; i<20 ; i++)
-               strcat (line," ");
-       strcat (line," ");
+       //i = strlen(line);
+       //for ( ; i<20 ; i++)
+       //      strcat (line," ");
+       //strcat (line," ");
 
        return line;
 }
@@ -605,10 +607,10 @@ void PRVM_ED_Print(prvm_edict_t *ed)
                        tempstring2[sizeof(tempstring2)-1] = 0;
                        name = tempstring2;
                }
-               strcat(tempstring, name);
+               strlcat(tempstring, name, sizeof(tempstring));
                for (l = strlen(name);l < 14;l++)
-                       strcat(tempstring, " ");
-               strcat(tempstring, " ");
+                       strlcat(tempstring, " ", sizeof(tempstring));
+               strlcat(tempstring, " ", sizeof(tempstring));
 
                name = PRVM_ValueString((etype_t)d->type, (prvm_eval_t *)v);
                if (strlen(name) > sizeof(tempstring2)-4)
@@ -618,8 +620,8 @@ void PRVM_ED_Print(prvm_edict_t *ed)
                        tempstring2[sizeof(tempstring2)-1] = 0;
                        name = tempstring2;
                }
-               strcat(tempstring, name);
-               strcat(tempstring, "\n");
+               strlcat(tempstring, name, sizeof(tempstring));
+               strlcat(tempstring, "\n", sizeof(tempstring));
                if (strlen(tempstring) >= sizeof(tempstring)/2)
                {
                        Con_Print(tempstring);
@@ -841,15 +843,15 @@ void PRVM_ED_ParseGlobals (const char *data)
        while (1)
        {
                // parse key
-               if (!COM_ParseToken(&data, false))
+               if (!COM_ParseTokenConsole(&data))
                        PRVM_ERROR ("PRVM_ED_ParseGlobals: EOF without closing brace");
                if (com_token[0] == '}')
                        break;
 
-               strcpy (keyname, com_token);
+               strlcpy (keyname, com_token, sizeof(keyname));
 
                // parse value
-               if (!COM_ParseToken(&data, false))
+               if (!COM_ParseTokenConsole(&data))
                        PRVM_ERROR ("PRVM_ED_ParseGlobals: EOF without closing brace");
 
                if (com_token[0] == '}')
@@ -1034,7 +1036,7 @@ const char *PRVM_ED_ParseEdict (const char *data, prvm_edict_t *ent)
        while (1)
        {
        // parse key
-               if (!COM_ParseToken(&data, false))
+               if (!COM_ParseTokenConsole(&data))
                        PRVM_ERROR ("PRVM_ED_ParseEdict: EOF without closing brace");
                if (developer_entityparsing.integer)
                        Con_Printf("Key: \"%s\"", com_token);
@@ -1045,7 +1047,7 @@ const char *PRVM_ED_ParseEdict (const char *data, prvm_edict_t *ent)
                // and allow them to be turned into vectors. (FIXME...)
                if (!strcmp(com_token, "angle"))
                {
-                       strcpy (com_token, "angles");
+                       strlcpy (com_token, "angles", sizeof(com_token));
                        anglehack = true;
                }
                else
@@ -1053,9 +1055,9 @@ const char *PRVM_ED_ParseEdict (const char *data, prvm_edict_t *ent)
 
                // FIXME: change light to _light to get rid of this hack
                if (!strcmp(com_token, "light"))
-                       strcpy (com_token, "light_lev");        // hack for single light def
+                       strlcpy (com_token, "light_lev", sizeof(com_token));    // hack for single light def
 
-               strcpy (keyname, com_token);
+               strlcpy (keyname, com_token, sizeof(keyname));
 
                // another hack to fix keynames with trailing spaces
                n = strlen(keyname);
@@ -1066,7 +1068,7 @@ const char *PRVM_ED_ParseEdict (const char *data, prvm_edict_t *ent)
                }
 
        // parse value
-               if (!COM_ParseToken(&data, false))
+               if (!COM_ParseTokenConsole(&data))
                        PRVM_ERROR ("PRVM_ED_ParseEdict: EOF without closing brace");
                if (developer_entityparsing.integer)
                        Con_Printf(" \"%s\"\n", com_token);
@@ -1095,7 +1097,7 @@ const char *PRVM_ED_ParseEdict (const char *data, prvm_edict_t *ent)
                if (anglehack)
                {
                        char    temp[32];
-                       strcpy (temp, com_token);
+                       strlcpy (temp, com_token, sizeof(temp));
                        sprintf (com_token, "0 %s 0", temp);
                }
 
@@ -1141,7 +1143,7 @@ void PRVM_ED_LoadFromFile (const char *data)
        while (1)
        {
 // parse the opening brace
-               if (!COM_ParseToken(&data, false))
+               if (!COM_ParseTokenConsole(&data))
                        break;
                if (com_token[0] != '{')
                        PRVM_ERROR ("PRVM_ED_LoadFromFile: %s: found %s when expecting {", PRVM_NAME, com_token);
@@ -1308,7 +1310,7 @@ void PRVM_LoadProgs (const char * filename, int numrequiredfunc, char **required
        if (prog->progs == NULL || filesize < (fs_offset_t)sizeof(dprograms_t))
                PRVM_ERROR ("PRVM_LoadProgs: couldn't load %s for %s", filename, PRVM_NAME);
 
-       Con_DPrintf("%s programs occupy %iK.\n", PRVM_NAME, filesize/1024);
+       Con_DPrintf("%s programs occupy %iK.\n", PRVM_NAME, (int)(filesize/1024));
 
        prog->filecrc = CRC_Block((unsigned char *)prog->progs, filesize);
 
@@ -1347,6 +1349,8 @@ void PRVM_LoadProgs (const char * filename, int numrequiredfunc, char **required
 
        prog->statements = (dstatement_t *)((unsigned char *)prog->progs + prog->progs->ofs_statements);
 
+       prog->statement_profile = (double *)Mem_Alloc(prog->progs_mempool, prog->progs->numstatements * sizeof(*prog->statement_profile));
+
        // moved edict_size calculation down below field adding code
 
        //pr_global_struct = (globalvars_t *)((unsigned char *)progs + progs->ofs_globals);
@@ -1510,7 +1514,7 @@ void PRVM_LoadProgs (const char * filename, int numrequiredfunc, char **required
                                PRVM_ERROR("PRVM_LoadProgs: out of bounds global index (statement %d) in %s", i, PRVM_NAME);
                        break;
                default:
-                       Con_DPrintf("PRVM_LoadProgs: unknown opcode %d at statement %d in %s", st->op, i, PRVM_NAME);
+                       Con_DPrintf("PRVM_LoadProgs: unknown opcode %d at statement %d in %s\n", st->op, i, PRVM_NAME);
                        break;
                }
        }
@@ -1612,32 +1616,32 @@ void PRVM_Fields_f (void)
                switch(d->type & ~DEF_SAVEGLOBAL)
                {
                case ev_string:
-                       strcat(tempstring, "string   ");
+                       strlcat(tempstring, "string   ", sizeof(tempstring));
                        break;
                case ev_entity:
-                       strcat(tempstring, "entity   ");
+                       strlcat(tempstring, "entity   ", sizeof(tempstring));
                        break;
                case ev_function:
-                       strcat(tempstring, "function ");
+                       strlcat(tempstring, "function ", sizeof(tempstring));
                        break;
                case ev_field:
-                       strcat(tempstring, "field    ");
+                       strlcat(tempstring, "field    ", sizeof(tempstring));
                        break;
                case ev_void:
-                       strcat(tempstring, "void     ");
+                       strlcat(tempstring, "void     ", sizeof(tempstring));
                        break;
                case ev_float:
-                       strcat(tempstring, "float    ");
+                       strlcat(tempstring, "float    ", sizeof(tempstring));
                        break;
                case ev_vector:
-                       strcat(tempstring, "vector   ");
+                       strlcat(tempstring, "vector   ", sizeof(tempstring));
                        break;
                case ev_pointer:
-                       strcat(tempstring, "pointer  ");
+                       strlcat(tempstring, "pointer  ", sizeof(tempstring));
                        break;
                default:
                        sprintf (tempstring2, "bad type %i ", d->type & ~DEF_SAVEGLOBAL);
-                       strcat(tempstring, tempstring2);
+                       strlcat(tempstring, tempstring2, sizeof(tempstring));
                        break;
                }
                if (strlen(name) > sizeof(tempstring2)-4)
@@ -1647,12 +1651,12 @@ void PRVM_Fields_f (void)
                        tempstring2[sizeof(tempstring2)-1] = 0;
                        name = tempstring2;
                }
-               strcat(tempstring, name);
+               strlcat(tempstring, name, sizeof(tempstring));
                for (j = (int)strlen(name);j < 25;j++)
-                       strcat(tempstring, " ");
+                       strlcat(tempstring, " ", sizeof(tempstring));
                sprintf(tempstring2, "%5d", counts[i]);
-               strcat(tempstring, tempstring2);
-               strcat(tempstring, "\n");
+               strlcat(tempstring, tempstring2, sizeof(tempstring));
+               strlcat(tempstring, "\n", sizeof(tempstring));
                if (strlen(tempstring) >= sizeof(tempstring)/2)
                {
                        Con_Print(tempstring);
@@ -1764,9 +1768,11 @@ void PRVM_Init (void)
        Cmd_AddCommand ("prvm_global", PRVM_Global_f, "prints value of a specified global variable in the selected VM (server, client, menu)");
        Cmd_AddCommand ("prvm_globalset", PRVM_GlobalSet_f, "sets value of a specified global variable in the selected VM (server, client, menu)");
        Cmd_AddCommand ("prvm_edictset", PRVM_ED_EdictSet_f, "changes value of a specified property of a specified entity in the selected VM (server, client, menu)");
+       Cmd_AddCommand ("prvm_printfunction", PRVM_PrintFunction_f, "prints a disassembly (QuakeC instructions) of the specified function in the selected VM (server, client, menu)");
        // LordHavoc: optional runtime bounds checking (speed drain, but worth it for security, on by default - breaks most QCCX features (used by CRMod and others))
        Cvar_RegisterVariable (&prvm_boundscheck);
        Cvar_RegisterVariable (&prvm_traceqc);
+       Cvar_RegisterVariable (&prvm_statementprofiling);
 
        //VM_Cmd_Init();
 }
@@ -1864,21 +1870,63 @@ prvm_edict_t *PRVM_PROG_TO_EDICT(int n)
 */
 
 
+sizebuf_t vm_tempstringsbuf;
+
 const char *PRVM_GetString(int num)
 {
-       if (num >= 0 && num < prog->stringssize)
-               return prog->strings + num;
-       else if (num < 0 && num >= -prog->numknownstrings)
+       if (num >= 0)
        {
-               num = -1 - num;
-               if (!prog->knownstrings[num])
-                       PRVM_ERROR("PRVM_GetString: attempt to get string that is already freed");
-               return prog->knownstrings[num];
+               if (num < prog->stringssize)
+                       return prog->strings + num;
+               else
+#if 1
+               if (num <= prog->stringssize + vm_tempstringsbuf.maxsize)
+               {
+                       num -= prog->stringssize;
+                       if (num < vm_tempstringsbuf.cursize)
+                               return (char *)vm_tempstringsbuf.data + num;
+                       else
+                       {
+                               VM_Warning("PRVM_GetString: Invalid temp-string offset (%i >= %i vm_tempstringsbuf.cursize)", num, vm_tempstringsbuf.cursize);
+                               return "";
+                       }
+               }
+               else
+#endif
+               {
+                       VM_Warning("PRVM_GetString: Invalid constant-string offset (%i >= %i prog->stringssize)", num, prog->stringssize);
+                       return "";
+               }
        }
        else
        {
-               PRVM_ERROR("PRVM_GetString: invalid string offset %i", num);
-               return "";
+               num = -1 - num;
+#if 0
+               if (num >= (1<<30))
+               {
+                       // special range reserved for tempstrings
+                       num -= (1<<30);
+                       if (num < vm_tempstringsbuf.cursize)
+                               return (char *)vm_tempstringsbuf.data + num;
+                       else
+                       {
+                               VM_Warning("PRVM_GetString: Invalid temp-string offset (%i >= %i vm_tempstringsbuf.cursize)", num, vm_tempstringsbuf.cursize);
+                               return "";
+                       }
+               }
+               else
+#endif
+               if (num < prog->numknownstrings)
+               {
+                       if (!prog->knownstrings[num])
+                               VM_Warning("PRVM_GetString: Invalid zone-string offset (%i has been freed)", num);
+                       return prog->knownstrings[num];
+               }
+               else
+               {
+                       VM_Warning("PRVM_GetString: Invalid zone-string offset (%i >= %i)", num, prog->numknownstrings);
+                       return "";
+               }
        }
 }
 
@@ -1889,6 +1937,15 @@ int PRVM_SetEngineString(const char *s)
                return 0;
        if (s >= prog->strings && s <= prog->strings + prog->stringssize)
                PRVM_ERROR("PRVM_SetEngineString: s in prog->strings area");
+       // if it's in the tempstrings area, use a reserved range
+       // (otherwise we'd get millions of useless string offsets cluttering the database)
+       if (s >= (char *)vm_tempstringsbuf.data && s < (char *)vm_tempstringsbuf.data + vm_tempstringsbuf.maxsize)
+#if 1
+               return prog->stringssize + (s - (char *)vm_tempstringsbuf.data);
+#else
+               return -1 - ((1<<30) + (s - (char *)vm_tempstringsbuf.data));
+#endif
+       // see if it's a known string address
        for (i = 0;i < prog->numknownstrings;i++)
                if (prog->knownstrings[i] == s)
                        return -1 - i;
@@ -1920,6 +1977,49 @@ int PRVM_SetEngineString(const char *s)
        return -1 - i;
 }
 
+// temp string handling
+
+// all tempstrings go into this buffer consecutively, and it is reset
+// whenever PRVM_ExecuteProgram returns to the engine
+// (technically each PRVM_ExecuteProgram call saves the cursize value and
+//  restores it on return, so multiple recursive calls can share the same
+//  buffer)
+// the buffer size is automatically grown as needed
+
+int PRVM_SetTempString(const char *s)
+{
+       int size;
+       char *t;
+       if (!s)
+               return 0;
+       size = (int)strlen(s) + 1;
+       if (developer.integer >= 300)
+               Con_Printf("PRVM_SetTempString: cursize %i, size %i\n", vm_tempstringsbuf.cursize, size);
+       if (vm_tempstringsbuf.maxsize < vm_tempstringsbuf.cursize + size)
+       {
+               sizebuf_t old = vm_tempstringsbuf;
+               if (vm_tempstringsbuf.cursize + size >= 1<<28)
+                       PRVM_ERROR("PRVM_SetTempString: ran out of tempstring memory!  (refusing to grow tempstring buffer over 256MB, cursize %i, size %i)\n", vm_tempstringsbuf.cursize, size);
+               vm_tempstringsbuf.maxsize = max(vm_tempstringsbuf.maxsize, 65536);
+               while (vm_tempstringsbuf.maxsize < vm_tempstringsbuf.cursize + size)
+                       vm_tempstringsbuf.maxsize *= 2;
+               if (vm_tempstringsbuf.maxsize != old.maxsize || vm_tempstringsbuf.data == NULL)
+               {
+                       if (developer.integer >= 100)
+                               Con_Printf("PRVM_SetTempString: enlarging tempstrings buffer (%iKB -> %iKB)\n", old.maxsize/1024, vm_tempstringsbuf.maxsize/1024);
+                       vm_tempstringsbuf.data = Mem_Alloc(sv_mempool, vm_tempstringsbuf.maxsize);
+                       if (old.cursize)
+                               memcpy(vm_tempstringsbuf.data, old.data, old.cursize);
+                       if (old.data)
+                               Mem_Free(old.data);
+               }
+       }
+       t = (char *)vm_tempstringsbuf.data + vm_tempstringsbuf.cursize;
+       memcpy(t, s, size);
+       vm_tempstringsbuf.cursize += size;
+       return PRVM_SetEngineString(t);
+}
+
 int PRVM_AllocString(size_t bufferlength, char **pointer)
 {
        int i;