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.
20 // host.c -- coordinates spawning and killing of local servers
26 #include "taskqueue.h"
31 A server can always be started, even if the system started out as a client
34 A client can NOT be started if the system started as a dedicated server.
36 Memory is cleared / released when a server or client begins, not when they end.
42 // pretend frames take this amount of time (in seconds), 0 = realtime
43 cvar_t host_framerate = {CF_CLIENT | CF_SERVER, "host_framerate","0", "locks frame timing to this value in seconds, 0.05 is 20fps for example, note that this can easily run too fast, use cl_maxfps if you want to limit your framerate instead, or sys_ticrate to limit server speed"};
44 cvar_t cl_maxphysicsframesperserverframe = {CF_CLIENT, "cl_maxphysicsframesperserverframe","10", "maximum number of physics frames per server frame"};
45 // shows time used by certain subsystems
46 cvar_t host_speeds = {CF_CLIENT | CF_SERVER, "host_speeds","0", "reports how much time is used in server/graphics/sound"};
47 cvar_t host_maxwait = {CF_CLIENT | CF_SERVER, "host_maxwait","1000", "maximum sleep time requested from the operating system in millisecond. Larger sleeps will be done using multiple host_maxwait length sleeps. Lowering this value will increase CPU load, but may help working around problems with accuracy of sleep times."};
49 cvar_t developer = {CF_CLIENT | CF_SERVER | CF_ARCHIVE, "developer","0", "shows debugging messages and information (recommended for all developers and level designers); the value -1 also suppresses buffering and logging these messages"};
50 cvar_t developer_extra = {CF_CLIENT | CF_SERVER, "developer_extra", "0", "prints additional debugging messages, often very verbose!"};
51 cvar_t developer_insane = {CF_CLIENT | CF_SERVER, "developer_insane", "0", "prints huge streams of information about internal workings, entire contents of files being read/written, etc. Not recommended!"};
52 cvar_t developer_loadfile = {CF_CLIENT | CF_SERVER, "developer_loadfile","0", "prints name and size of every file loaded via the FS_LoadFile function (which is almost everything)"};
53 cvar_t developer_loading = {CF_CLIENT | CF_SERVER, "developer_loading","0", "prints information about files as they are loaded or unloaded successfully"};
54 cvar_t developer_entityparsing = {CF_CLIENT, "developer_entityparsing", "0", "prints detailed network entities information each time a packet is received"};
56 cvar_t timestamps = {CF_CLIENT | CF_SERVER | CF_ARCHIVE, "timestamps", "0", "prints timestamps on console messages"};
57 cvar_t timeformat = {CF_CLIENT | CF_SERVER | CF_ARCHIVE, "timeformat", "[%Y-%m-%d %H:%M:%S] ", "time format to use on timestamped console messages"};
59 cvar_t sessionid = {CF_CLIENT | CF_SERVER | CF_READONLY, "sessionid", "", "ID of the current session (use the -sessionid parameter to set it); this is always either empty or begins with a dot (.)"};
60 cvar_t locksession = {CF_CLIENT | CF_SERVER, "locksession", "0", "Lock the session? 0 = no, 1 = yes and abort on failure, 2 = yes and continue on failure"};
62 cvar_t host_isclient = {CF_SHARED | CF_READONLY, "_host_isclient", "0", "If 1, clientside is active."};
66 Host_AbortCurrentFrame
68 aborts the current host frame and goes on with the next one
71 void Host_AbortCurrentFrame(void) DP_FUNC_NORETURN;
72 void Host_AbortCurrentFrame(void)
74 // in case we were previously nice, make us mean again
75 Sys_MakeProcessMean();
77 longjmp (host.abortframe, 1);
84 This shuts down both the client and server
87 void Host_Error (const char *error, ...)
89 static char hosterrorstring1[MAX_INPUTLINE]; // THREAD UNSAFE
90 static char hosterrorstring2[MAX_INPUTLINE]; // THREAD UNSAFE
91 static qbool hosterror = false;
94 // turn off rcon redirect if it was active when the crash occurred
95 // to prevent loops when it is a networking problem
96 Con_Rcon_Redirect_Abort();
98 va_start (argptr,error);
99 dpvsnprintf (hosterrorstring1,sizeof(hosterrorstring1),error,argptr);
102 Con_Printf(CON_ERROR "Host_Error: %s\n", hosterrorstring1);
104 // LadyHavoc: if crashing very early, or currently shutting down, do
106 if (host.framecount < 3 || host.state == host_shutdown)
107 Sys_Error ("Host_Error: %s", hosterrorstring1);
110 Sys_Error ("Host_Error: recursively entered (original error was: %s new error is: %s)", hosterrorstring2, hosterrorstring1);
113 strlcpy(hosterrorstring2, hosterrorstring1, sizeof(hosterrorstring2));
115 CL_Parse_DumpPacket();
117 CL_Parse_ErrorCleanUp();
121 // print out where the crash happened, if it was caused by QC (and do a cleanup)
122 PRVM_Crash(SVVM_prog);
123 PRVM_Crash(CLVM_prog);
125 PRVM_Crash(MVM_prog);
128 Cvar_SetValueQuick(&csqc_progcrc, -1);
129 Cvar_SetValueQuick(&csqc_progsize, -1);
131 SV_LockThreadMutex();
133 SV_UnlockThreadMutex();
135 if (cls.state == ca_dedicated)
136 Sys_Error ("Host_Error: %s",hosterrorstring2); // dedicated servers exit
143 Host_AbortCurrentFrame();
151 static void Host_Quit_f(cmd_state_t *cmd)
153 if(host.state == host_shutdown)
154 Con_Printf("shutting down already!\n");
156 host.state = host_shutdown;
159 static void Host_Version_f(cmd_state_t *cmd)
161 Con_Printf("Version: %s build %s\n", gamename, buildstring);
164 static void Host_Framerate_c(cvar_t *var)
166 if (var->value < 0.00001 && var->value != 0)
167 Cvar_SetValueQuick(var, 0);
171 =======================
173 ======================
175 void Host_SaveConfig_f(cmd_state_t *cmd);
176 void Host_LoadConfig_f(cmd_state_t *cmd);
177 extern cvar_t sv_writepicture_quality;
178 extern cvar_t r_texture_jpeg_fastpicmip;
179 static void Host_InitLocal (void)
181 Cmd_AddCommand(CF_SHARED, "quit", Host_Quit_f, "quit the game");
182 Cmd_AddCommand(CF_SHARED, "version", Host_Version_f, "print engine version");
183 Cmd_AddCommand(CF_SHARED, "saveconfig", Host_SaveConfig_f, "save settings to config.cfg (or a specified filename) immediately (also automatic when quitting)");
184 Cmd_AddCommand(CF_SHARED, "loadconfig", Host_LoadConfig_f, "reset everything and reload configs");
185 Cvar_RegisterVariable (&cl_maxphysicsframesperserverframe);
186 Cvar_RegisterVariable (&host_framerate);
187 Cvar_RegisterCallback (&host_framerate, Host_Framerate_c);
188 Cvar_RegisterVariable (&host_speeds);
189 Cvar_RegisterVariable (&host_maxwait);
190 Cvar_RegisterVariable (&host_isclient);
192 Cvar_RegisterVariable (&developer);
193 Cvar_RegisterVariable (&developer_extra);
194 Cvar_RegisterVariable (&developer_insane);
195 Cvar_RegisterVariable (&developer_loadfile);
196 Cvar_RegisterVariable (&developer_loading);
197 Cvar_RegisterVariable (&developer_entityparsing);
199 Cvar_RegisterVariable (×tamps);
200 Cvar_RegisterVariable (&timeformat);
202 Cvar_RegisterVariable (&sv_writepicture_quality);
203 Cvar_RegisterVariable (&r_texture_jpeg_fastpicmip);
211 Writes key bindings and archived cvars to config.cfg
214 static void Host_SaveConfig_to(const char *file)
218 // dedicated servers initialize the host but don't parse and set the
220 // LadyHavoc: don't save a config if it crashed in startup
221 if (host.framecount >= 3 && cls.state != ca_dedicated && !Sys_CheckParm("-benchmark") && !Sys_CheckParm("-capturedemo"))
223 f = FS_OpenRealFile(file, "wb", false);
226 Con_Printf(CON_ERROR "Couldn't write %s.\n", file);
230 Key_WriteBindings (f);
231 Cvar_WriteVariables (&cvars_all, f);
236 void Host_SaveConfig(void)
238 Host_SaveConfig_to(CONFIGFILENAME);
240 void Host_SaveConfig_f(cmd_state_t *cmd)
242 const char *file = CONFIGFILENAME;
244 if(Cmd_Argc(cmd) >= 2) {
245 file = Cmd_Argv(cmd, 1);
246 Con_Printf("Saving to %s\n", file);
249 Host_SaveConfig_to(file);
252 static void Host_AddConfigText(cmd_state_t *cmd)
254 // set up the default startmap_sp and startmap_dm aliases (mods can
255 // override these) and then execute the quake.rc startup script
256 if (gamemode == GAME_NEHAHRA)
257 Cbuf_InsertText(cmd, "alias startmap_sp \"map nehstart\"\nalias startmap_dm \"map nehstart\"\nexec " STARTCONFIGFILENAME "\n");
258 else if (gamemode == GAME_TRANSFUSION)
259 Cbuf_InsertText(cmd, "alias startmap_sp \"map e1m1\"\n""alias startmap_dm \"map bb1\"\nexec " STARTCONFIGFILENAME "\n");
260 else if (gamemode == GAME_TEU)
261 Cbuf_InsertText(cmd, "alias startmap_sp \"map start\"\nalias startmap_dm \"map start\"\nexec teu.rc\n");
263 Cbuf_InsertText(cmd, "alias startmap_sp \"map start\"\nalias startmap_dm \"map start\"\nexec " STARTCONFIGFILENAME "\n");
264 Cbuf_Execute(cmd->cbuf);
271 Resets key bindings and cvars to defaults and then reloads scripts
274 void Host_LoadConfig_f(cmd_state_t *cmd)
276 // reset all cvars, commands and aliases to init values
277 Cmd_RestoreInitState();
279 // prepend a menu restart command to execute after the config
280 Cbuf_InsertText(&cmd_client, "\nmenu_restart\n");
282 // reset cvars to their defaults, and then exec startup scripts again
283 Host_AddConfigText(&cmd_client);
286 //============================================================================
290 Host_GetConsoleCommands
292 Add them exactly as if they had been typed at the console
295 static void Host_GetConsoleCommands (void)
299 while ((line = Sys_ConsoleInput()))
301 if (cls.state == ca_dedicated)
302 Cbuf_AddText(&cmd_server, line);
304 Cbuf_AddText(&cmd_client, line);
312 Returns a time report string, for example for
315 const char *Host_TimingReport(char *buf, size_t buflen)
317 return va(buf, buflen, "%.1f%% CPU, %.2f%% lost, offset avg %.1fms, max %.1fms, sdev %.1fms", svs.perf_cpuload * 100, svs.perf_lost * 100, svs.perf_offset_avg * 1000, svs.perf_offset_max * 1000, svs.perf_offset_sdev * 1000);
324 Runs all active servers
327 static void Host_Init(void);
328 double Host_Frame(double time)
334 TaskQueue_Frame(false);
336 // keep the random time dependent, but not when playing demos/benchmarking
337 if(!*sv_random_seed.string && !host.restless)
340 NetConn_UpdateSockets();
342 Log_DestBuffer_Flush();
346 // check for commands typed to the host
347 Host_GetConsoleCommands();
349 // process console commands
350 // R_TimeReport("preconsole");
352 Cbuf_Frame(host.cbuf);
354 // R_TimeReport("console");
356 //Con_Printf("%6.0f %6.0f\n", cl_timer * 1000000.0, sv_timer * 1000000.0);
360 sv_timer = SV_Frame(time);
361 cl_timer = CL_Frame(time);
363 Mem_CheckSentinelsGlobal();
365 // if the accumulators haven't become positive yet, wait a while
366 if(!sv_timer || !cl_timer)
367 wait = min(cl_timer, sv_timer) * -1000000.0;
369 wait = max(cl_timer, sv_timer) * -1000000.0;
371 if (!host.restless && wait >= 1)
377 static inline void Host_Sleep(double time)
382 if(host_maxwait.value <= 0)
383 time = min(time, 1000000.0);
385 time = min(time, host_maxwait.value * 1000.0);
387 time = 1; // because we cast to int
389 time0 = Sys_DirtyTime();
390 if (sv_checkforpacketsduringsleep.integer && !sys_usenoclockbutbenchmark.integer && !svs.threaded)
392 NetConn_SleepMicroseconds((int)time);
393 if (cls.state != ca_dedicated)
394 NetConn_ClientFrame(); // helps server browser get good ping values
395 // TODO can we do the same for ServerFrame? Probably not.
398 Sys_Sleep((int)time);
399 delta = Sys_DirtyTime() - time0;
400 if (delta < 0 || delta >= 1800)
402 host.sleeptime += delta;
403 // R_TimeReport("sleep");
407 // Cloudwalk: Most overpowered function declaration...
408 static inline double Host_UpdateTime (double newtime, double oldtime)
410 double time = newtime - oldtime;
414 // warn if it's significant
416 Con_Printf(CON_WARN "Host_UpdateTime: time stepped backwards (went from %f to %f, difference %f)\n", oldtime, newtime, time);
419 else if (time >= 1800)
421 Con_Printf(CON_WARN "Host_UpdateTime: time stepped forward (went from %f to %f, difference %f)\n", oldtime, newtime, time);
430 double time, newtime, oldtime, sleeptime;
432 Host_Init(); // Start!
435 oldtime = Sys_DirtyTime();
438 while(host.state != host_shutdown)
440 // Something bad happened, or the server disconnected
441 if (setjmp(host.abortframe))
443 host.state = host_active; // In case we were loading
447 newtime = host.dirtytime = Sys_DirtyTime();
448 host.realtime += time = Host_UpdateTime(newtime, oldtime);
450 sleeptime = Host_Frame(time);
455 Host_Sleep(sleeptime);
465 //============================================================================
467 char engineversion[128];
469 qbool sys_nostdout = false;
471 static qfile_t *locksession_fh = NULL;
472 static qbool locksession_run = false;
473 static void Host_InitSession(void)
477 Cvar_RegisterVariable(&sessionid);
478 Cvar_RegisterVariable(&locksession);
480 // load the session ID into the read-only cvar
481 if ((i = Sys_CheckParm("-sessionid")) && (i + 1 < sys.argc))
483 if(sys.argv[i+1][0] == '.')
484 Cvar_SetQuick(&sessionid, sys.argv[i+1]);
487 buf = (char *)Z_Malloc(strlen(sys.argv[i+1]) + 2);
488 dpsnprintf(buf, sizeof(buf), ".%s", sys.argv[i+1]);
489 Cvar_SetQuick(&sessionid, buf);
493 void Host_LockSession(void)
497 locksession_run = true;
498 if(locksession.integer != 0 && !Sys_CheckParm("-readonly"))
501 char *p = va(vabuf, sizeof(vabuf), "%slock%s", *fs_userdir ? fs_userdir : fs_basedir, sessionid.string);
503 locksession_fh = FS_SysOpen(p, "wl", false);
504 // TODO maybe write the pid into the lockfile, while we are at it? may help server management tools
507 if(locksession.integer == 2)
509 Con_Printf(CON_WARN "WARNING: session lock %s could not be acquired. Please run with -sessionid and an unique session name. Continuing anyway.\n", p);
513 Sys_Error("session lock %s could not be acquired. Please run with -sessionid and an unique session name.\n", p);
518 void Host_UnlockSession(void)
522 locksession_run = false;
526 FS_Close(locksession_fh);
527 // NOTE: we can NOT unlink the lock here, as doing so would
528 // create a race condition if another process created it
529 // between our close and our unlink
530 locksession_fh = NULL;
539 static void Host_Init (void)
544 cmd_state_t *cmd = &cmd_client;
546 host.hook.ConnectLocal = NULL;
547 host.hook.Disconnect = NULL;
548 host.hook.ToggleMenu = NULL;
549 host.hook.CL_Intermission = NULL;
550 host.hook.SV_CanSave = NULL;
552 host.state = host_init;
554 if (setjmp(host.abortframe)) // Huh?!
555 Sys_Error("Engine initialization failed. Check the console (if available) for additional information.\n");
557 if (Sys_CheckParm("-profilegameonly"))
558 Sys_AllowProfiling(false);
560 // LadyHavoc: quake never seeded the random number generator before... heh
561 if (Sys_CheckParm("-benchmark"))
562 srand(0); // predictable random sequence for -benchmark
564 srand((unsigned int)time(NULL));
566 // FIXME: this is evil, but possibly temporary
567 // LadyHavoc: doesn't seem very temporary...
568 // LadyHavoc: made this a saved cvar
569 // COMMANDLINEOPTION: Console: -developer enables warnings and other notices (RECOMMENDED for mod developers)
570 if (Sys_CheckParm("-developer"))
572 developer.value = developer.integer = 1;
573 developer.string = "1";
576 if (Sys_CheckParm("-developer2") || Sys_CheckParm("-developer3"))
578 developer.value = developer.integer = 1;
579 developer.string = "1";
580 developer_extra.value = developer_extra.integer = 1;
581 developer_extra.string = "1";
582 developer_insane.value = developer_insane.integer = 1;
583 developer_insane.string = "1";
584 developer_memory.value = developer_memory.integer = 1;
585 developer_memory.string = "1";
586 developer_memorydebug.value = developer_memorydebug.integer = 1;
587 developer_memorydebug.string = "1";
590 if (Sys_CheckParm("-developer3"))
592 gl_paranoid.integer = 1;gl_paranoid.string = "1";
593 gl_printcheckerror.integer = 1;gl_printcheckerror.string = "1";
596 // COMMANDLINEOPTION: Console: -nostdout disables text output to the terminal the game was launched from
597 if (Sys_CheckParm("-nostdout"))
600 // initialize console command/cvar/alias/command execution systems
603 // initialize memory subsystem cvars/commands
604 Memory_Init_Commands();
606 // initialize console and logging and its cvars/commands
609 // initialize various cvars that could not be initialized earlier
611 Curl_Init_Commands();
615 // initialize filesystem (including fs_basedir, fs_gamedir, -game, scr_screenshot_name)
618 // construct a version string for the corner of the console
620 dpsnprintf (engineversion, sizeof (engineversion), "%s %s %s", gamename, os, buildstring);
621 Con_Printf("%s\n", engineversion);
623 // initialize process nice level
624 Sys_InitProcessNice();
626 // initialize ixtable
629 // register the cvars for session locking
632 // must be after FS_Init
634 Crypto_Init_Commands();
649 // save off current state of aliases, commands and cvars for later restore if FS_GameDir_f is called
650 // NOTE: menu commands are freed by Cmd_RestoreInitState
653 // FIXME: put this into some neat design, but the menu should be allowed to crash
654 // without crashing the whole game, so this should just be a short-time solution
656 // here comes the not so critical stuff
658 Host_AddConfigText(cmd);
660 // if quake.rc is missing, use default
661 if (!FS_FileExists("quake.rc"))
663 Cbuf_AddText(cmd, "exec default.cfg\nexec " CONFIGFILENAME "\nexec autoexec.cfg\n");
664 Cbuf_Execute(cmd->cbuf);
667 host.state = host_active;
673 // put up the loading image so the user doesn't stare at a black screen...
674 SCR_BeginLoadingPlaque(true);
676 if (cls.state != ca_dedicated)
679 // check for special benchmark mode
680 // COMMANDLINEOPTION: Client: -benchmark <demoname> runs a timedemo and quits, results of any timedemo can be found in gamedir/benchmark.log (for example id1/benchmark.log)
681 i = Sys_CheckParm("-benchmark");
682 if (i && i + 1 < sys.argc)
683 if (!sv.active && !cls.demoplayback && !cls.connect_trying)
685 Cbuf_AddText(&cmd_client, va(vabuf, sizeof(vabuf), "timedemo %s\n", sys.argv[i + 1]));
686 Cbuf_Execute((&cmd_client)->cbuf);
689 // check for special demo mode
690 // COMMANDLINEOPTION: Client: -demo <demoname> runs a playdemo and quits
691 i = Sys_CheckParm("-demo");
692 if (i && i + 1 < sys.argc)
693 if (!sv.active && !cls.demoplayback && !cls.connect_trying)
695 Cbuf_AddText(&cmd_client, va(vabuf, sizeof(vabuf), "playdemo %s\n", sys.argv[i + 1]));
696 Cbuf_Execute((&cmd_client)->cbuf);
699 #ifdef CONFIG_VIDEO_CAPTURE
700 // COMMANDLINEOPTION: Client: -capturedemo <demoname> captures a playdemo and quits
701 i = Sys_CheckParm("-capturedemo");
702 if (i && i + 1 < sys.argc)
703 if (!sv.active && !cls.demoplayback && !cls.connect_trying)
705 Cbuf_AddText(&cmd_client, va(vabuf, sizeof(vabuf), "playdemo %s\ncl_capturevideo 1\n", sys.argv[i + 1]));
706 Cbuf_Execute((&cmd_client)->cbuf);
710 if (cls.state == ca_dedicated || Sys_CheckParm("-listen"))
711 if (!sv.active && !cls.demoplayback && !cls.connect_trying)
713 Cbuf_AddText(&cmd_client, "startmap_dm\n");
714 Cbuf_Execute((&cmd_client)->cbuf);
717 if (!sv.active && !cls.demoplayback && !cls.connect_trying)
720 Cbuf_AddText(&cmd_client, "togglemenu 1\n");
722 Cbuf_Execute((&cmd_client)->cbuf);
725 Con_DPrint("========Initialized=========\n");
727 if (cls.state != ca_dedicated)
736 FIXME: this is a callback from Sys_Quit and Sys_Error. It would be better
737 to run quit through here before the final handoff to the sys code.
740 void Host_Shutdown(void)
742 static qbool isdown = false;
746 Con_Print("recursive shutdown\n");
749 if (setjmp(host.abortframe))
751 Con_Print("aborted the quitting frame?!?\n");
756 if(cls.state != ca_dedicated)
759 // end the server thread
763 // shut down local server if active
764 SV_LockThreadMutex();
766 SV_UnlockThreadMutex();
769 // AK hmm, no PRVM_Shutdown(); yet
777 TaskQueue_Shutdown();
784 Host_UnlockSession();
790 void Host_NoOperation_f(cmd_state_t *cmd)