2 Copyright (C) 1996-1997 Id Software, Inc.
3 Copyright (C) 2000-2021 DarkPlaces contributors
5 This program is free software; you can redistribute it and/or
6 modify it under the terms of the GNU General Public License
7 as published by the Free Software Foundation; either version 2
8 of the License, or (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
14 See the GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with this program; if not, write to the Free Software
18 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
21 // host.c -- coordinates spawning and killing of local servers
27 #include "taskqueue.h"
32 A server can always be started, even if the system started out as a client
35 A client can NOT be started if the system started as a dedicated server.
37 Memory is cleared / released when a server or client begins, not when they end.
43 // pretend frames take this amount of time (in seconds), 0 = realtime
44 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"};
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)
73 // in case we were previously nice, make us mean again
74 Sys_MakeProcessMean();
76 longjmp (host.abortframe, 1);
83 This shuts down both the client and server
86 void Host_Error (const char *error, ...)
88 static char hosterrorstring1[MAX_INPUTLINE]; // THREAD UNSAFE
89 static char hosterrorstring2[MAX_INPUTLINE]; // THREAD UNSAFE
90 static qbool hosterror = false;
93 // turn off rcon redirect if it was active when the crash occurred
94 // to prevent loops when it is a networking problem
95 Con_Rcon_Redirect_Abort();
97 va_start (argptr,error);
98 dpvsnprintf (hosterrorstring1,sizeof(hosterrorstring1),error,argptr);
101 Con_Printf(CON_ERROR "Host_Error: %s\n", hosterrorstring1);
103 // LadyHavoc: if crashing very early, or currently shutting down, do
105 if (host.framecount < 3 || host.state == host_shutdown)
106 Sys_Error ("Host_Error: %s", hosterrorstring1);
109 Sys_Error ("Host_Error: recursively entered (original error was: %s new error is: %s)", hosterrorstring2, hosterrorstring1);
112 strlcpy(hosterrorstring2, hosterrorstring1, sizeof(hosterrorstring2));
114 CL_Parse_DumpPacket();
116 CL_Parse_ErrorCleanUp();
120 // print out where the crash happened, if it was caused by QC (and do a cleanup)
121 PRVM_Crash(SVVM_prog);
122 PRVM_Crash(CLVM_prog);
124 PRVM_Crash(MVM_prog);
127 Cvar_SetValueQuick(&csqc_progcrc, -1);
128 Cvar_SetValueQuick(&csqc_progsize, -1);
130 if(host.hook.SV_Shutdown)
131 host.hook.SV_Shutdown();
133 if (cls.state == ca_dedicated)
134 Sys_Error ("Host_Error: %s",hosterrorstring2); // dedicated servers exit
141 Host_AbortCurrentFrame();
149 static void Host_Quit_f(cmd_state_t *cmd)
151 if(host.state == host_shutdown)
152 Con_Printf("shutting down already!\n");
154 host.state = host_shutdown;
157 static void Host_Version_f(cmd_state_t *cmd)
159 Con_Printf("Version: %s\n", engineversion);
162 static void Host_Framerate_c(cvar_t *var)
164 if (var->value < 0.00001 && var->value != 0)
165 Cvar_SetValueQuick(var, 0);
168 // TODO: Find a better home for this.
169 static void SendCvar_f(cmd_state_t *cmd)
171 if(cmd->source == src_local && host.hook.SV_SendCvar)
173 host.hook.SV_SendCvar(cmd);
176 if(cmd->source == src_client && host.hook.CL_SendCvar)
178 host.hook.CL_SendCvar(cmd);
187 Writes key bindings and archived cvars to config.cfg
190 void Host_SaveConfig(const char *file)
194 // dedicated servers initialize the host but don't parse and set the
196 // LadyHavoc: don't save a config if it crashed in startup
197 if (host.framecount >= 3 && cls.state != ca_dedicated && !Sys_CheckParm("-benchmark") && !Sys_CheckParm("-capturedemo"))
199 f = FS_OpenRealFile(file, "wb", false);
202 Con_Printf(CON_ERROR "Couldn't write %s.\n", file);
206 Key_WriteBindings (f);
207 Cvar_WriteVariables (&cvars_all, f);
213 static void Host_SaveConfig_f(cmd_state_t *cmd)
215 const char *file = CONFIGFILENAME;
217 if(Cmd_Argc(cmd) >= 2) {
218 file = Cmd_Argv(cmd, 1);
219 Con_Printf("Saving to %s\n", file);
222 Host_SaveConfig(file);
225 static void Host_AddConfigText(cmd_state_t *cmd)
227 // set up the default startmap_sp and startmap_dm aliases (mods can
228 // override these) and then execute the quake.rc startup script
229 if (gamemode == GAME_NEHAHRA)
230 Cbuf_InsertText(cmd, "alias startmap_sp \"map nehstart\"\nalias startmap_dm \"map nehstart\"\nexec " STARTCONFIGFILENAME "\n");
231 else if (gamemode == GAME_TRANSFUSION)
232 Cbuf_InsertText(cmd, "alias startmap_sp \"map e1m1\"\n""alias startmap_dm \"map bb1\"\nexec " STARTCONFIGFILENAME "\n");
233 else if (gamemode == GAME_TEU)
234 Cbuf_InsertText(cmd, "alias startmap_sp \"map start\"\nalias startmap_dm \"map start\"\nexec teu.rc\n");
236 Cbuf_InsertText(cmd, "alias startmap_sp \"map start\"\nalias startmap_dm \"map start\"\nexec " STARTCONFIGFILENAME "\n");
237 Cbuf_Execute(cmd->cbuf);
244 Resets key bindings and cvars to defaults and then reloads scripts
247 static void Host_LoadConfig_f(cmd_state_t *cmd)
249 // reset all cvars, commands and aliases to init values
250 Cmd_RestoreInitState();
252 // prepend a menu restart command to execute after the config
253 Cbuf_InsertText(cmd_local, "\nmenu_restart\n");
255 // reset cvars to their defaults, and then exec startup scripts again
256 Host_AddConfigText(cmd_local);
260 =======================
262 ======================
264 extern cvar_t r_texture_jpeg_fastpicmip;
265 static void Host_InitLocal (void)
267 Cmd_AddCommand(CF_SHARED, "quit", Host_Quit_f, "quit the game");
268 Cmd_AddCommand(CF_SHARED, "version", Host_Version_f, "print engine version");
269 Cmd_AddCommand(CF_SHARED, "saveconfig", Host_SaveConfig_f, "save settings to config.cfg (or a specified filename) immediately (also automatic when quitting)");
270 Cmd_AddCommand(CF_SHARED, "loadconfig", Host_LoadConfig_f, "reset everything and reload configs");
271 Cmd_AddCommand(CF_SHARED, "sendcvar", SendCvar_f, "sends the value of a cvar to the server as a sentcvar command, for use by QuakeC");
272 Cvar_RegisterVariable (&host_framerate);
273 Cvar_RegisterCallback (&host_framerate, Host_Framerate_c);
274 Cvar_RegisterVariable (&host_speeds);
275 Cvar_RegisterVariable (&host_maxwait);
276 Cvar_RegisterVariable (&host_isclient);
278 Cvar_RegisterVariable (&developer);
279 Cvar_RegisterVariable (&developer_extra);
280 Cvar_RegisterVariable (&developer_insane);
281 Cvar_RegisterVariable (&developer_loadfile);
282 Cvar_RegisterVariable (&developer_loading);
283 Cvar_RegisterVariable (&developer_entityparsing);
285 Cvar_RegisterVariable (×tamps);
286 Cvar_RegisterVariable (&timeformat);
288 Cvar_RegisterVariable (&r_texture_jpeg_fastpicmip);
291 char engineversion[128];
293 qbool sys_nostdout = false;
295 static qfile_t *locksession_fh = NULL;
296 static qbool locksession_run = false;
297 static void Host_InitSession(void)
301 Cvar_RegisterVariable(&sessionid);
302 Cvar_RegisterVariable(&locksession);
304 // load the session ID into the read-only cvar
305 if ((i = Sys_CheckParm("-sessionid")) && (i + 1 < sys.argc))
307 if(sys.argv[i+1][0] == '.')
308 Cvar_SetQuick(&sessionid, sys.argv[i+1]);
311 buf = (char *)Z_Malloc(strlen(sys.argv[i+1]) + 2);
312 dpsnprintf(buf, sizeof(buf), ".%s", sys.argv[i+1]);
313 Cvar_SetQuick(&sessionid, buf);
318 void Host_LockSession(void)
322 locksession_run = true;
323 if(locksession.integer != 0 && !Sys_CheckParm("-readonly"))
326 char *p = va(vabuf, sizeof(vabuf), "%slock%s", *fs_userdir ? fs_userdir : fs_basedir, sessionid.string);
328 locksession_fh = FS_SysOpen(p, "wl", false);
329 // TODO maybe write the pid into the lockfile, while we are at it? may help server management tools
332 if(locksession.integer == 2)
334 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);
338 Sys_Error("session lock %s could not be acquired. Please run with -sessionid and an unique session name.\n", p);
344 void Host_UnlockSession(void)
348 locksession_run = false;
352 FS_Close(locksession_fh);
353 // NOTE: we can NOT unlink the lock here, as doing so would
354 // create a race condition if another process created it
355 // between our close and our unlink
356 locksession_fh = NULL;
365 static void Host_Init (void)
370 host.hook.ConnectLocal = NULL;
371 host.hook.Disconnect = NULL;
372 host.hook.ToggleMenu = NULL;
373 host.hook.CL_Intermission = NULL;
374 host.hook.SV_Shutdown = NULL;
376 host.state = host_init;
378 if (setjmp(host.abortframe)) // Huh?!
379 Sys_Error("Engine initialization failed. Check the console (if available) for additional information.\n");
381 if (Sys_CheckParm("-profilegameonly"))
382 Sys_AllowProfiling(false);
384 // LadyHavoc: quake never seeded the random number generator before... heh
385 if (Sys_CheckParm("-benchmark"))
386 srand(0); // predictable random sequence for -benchmark
388 srand((unsigned int)time(NULL));
390 // FIXME: this is evil, but possibly temporary
391 // LadyHavoc: doesn't seem very temporary...
392 // LadyHavoc: made this a saved cvar
393 // COMMANDLINEOPTION: Console: -developer enables warnings and other notices (RECOMMENDED for mod developers)
394 if (Sys_CheckParm("-developer"))
396 developer.value = developer.integer = 1;
397 developer.string = "1";
400 if (Sys_CheckParm("-developer2") || Sys_CheckParm("-developer3"))
402 developer.value = developer.integer = 1;
403 developer.string = "1";
404 developer_extra.value = developer_extra.integer = 1;
405 developer_extra.string = "1";
406 developer_insane.value = developer_insane.integer = 1;
407 developer_insane.string = "1";
408 developer_memory.value = developer_memory.integer = 1;
409 developer_memory.string = "1";
410 developer_memorydebug.value = developer_memorydebug.integer = 1;
411 developer_memorydebug.string = "1";
414 if (Sys_CheckParm("-developer3"))
416 gl_paranoid.integer = 1;gl_paranoid.string = "1";
417 gl_printcheckerror.integer = 1;gl_printcheckerror.string = "1";
420 // COMMANDLINEOPTION: Console: -nostdout disables text output to the terminal the game was launched from
421 if (Sys_CheckParm("-nostdout"))
424 // -dedicated is checked in SV_ServerOptions() but that's too late for Cvar_RegisterVariable() to skip all the client-only cvars
425 if (Sys_CheckParm ("-dedicated") || !cl_available)
426 cls.state = ca_dedicated;
428 // initialize console command/cvar/alias/command execution systems
431 // initialize memory subsystem cvars/commands
432 Memory_Init_Commands();
434 // initialize console and logging and its cvars/commands
437 // initialize various cvars that could not be initialized earlier
439 Curl_Init_Commands();
443 // initialize filesystem (including fs_basedir, fs_gamedir, -game, scr_screenshot_name)
446 // construct a version string for the corner of the console
447 dpsnprintf (engineversion, sizeof (engineversion), "%s %s%s, buildstring: %s", gamename, DP_OS_NAME, cls.state == ca_dedicated ? " dedicated" : "", buildstring);
448 Con_Printf("%s\n", engineversion);
450 // initialize process nice level
451 Sys_InitProcessNice();
453 // initialize ixtable
456 // register the cvars for session locking
459 // must be after FS_Init
461 Crypto_Init_Commands();
476 // save off current state of aliases, commands and cvars for later restore if FS_GameDir_f is called
477 // NOTE: menu commands are freed by Cmd_RestoreInitState
480 // FIXME: put this into some neat design, but the menu should be allowed to crash
481 // without crashing the whole game, so this should just be a short-time solution
483 // here comes the not so critical stuff
485 Host_AddConfigText(cmd_local);
487 // if quake.rc is missing, use default
488 if (!FS_FileExists("quake.rc"))
490 Cbuf_AddText(cmd_local, "exec default.cfg\nexec " CONFIGFILENAME "\nexec autoexec.cfg\n");
491 Cbuf_Execute(cmd_local->cbuf);
494 host.state = host_active;
500 if (cls.state != ca_dedicated)
502 // put up the loading image so the user doesn't stare at a black screen...
503 SCR_BeginLoadingPlaque(true);
510 // check for special benchmark mode
511 // 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)
512 i = Sys_CheckParm("-benchmark");
513 if (i && i + 1 < sys.argc)
514 if (!sv.active && !cls.demoplayback && !cls.connect_trying)
516 Cbuf_AddText(cmd_local, va(vabuf, sizeof(vabuf), "timedemo %s\n", sys.argv[i + 1]));
517 Cbuf_Execute(cmd_local->cbuf);
520 // check for special demo mode
521 // COMMANDLINEOPTION: Client: -demo <demoname> runs a playdemo and quits
522 i = Sys_CheckParm("-demo");
523 if (i && i + 1 < sys.argc)
524 if (!sv.active && !cls.demoplayback && !cls.connect_trying)
526 Cbuf_AddText(cmd_local, va(vabuf, sizeof(vabuf), "playdemo %s\n", sys.argv[i + 1]));
527 Cbuf_Execute(cmd_local->cbuf);
530 #ifdef CONFIG_VIDEO_CAPTURE
531 // COMMANDLINEOPTION: Client: -capturedemo <demoname> captures a playdemo and quits
532 i = Sys_CheckParm("-capturedemo");
533 if (i && i + 1 < sys.argc)
534 if (!sv.active && !cls.demoplayback && !cls.connect_trying)
536 Cbuf_AddText(cmd_local, va(vabuf, sizeof(vabuf), "playdemo %s\ncl_capturevideo 1\n", sys.argv[i + 1]));
537 Cbuf_Execute((cmd_local)->cbuf);
541 if (cls.state == ca_dedicated || Sys_CheckParm("-listen"))
542 if (!sv.active && !cls.demoplayback && !cls.connect_trying)
544 Cbuf_AddText(cmd_local, "startmap_dm\n");
545 Cbuf_Execute(cmd_local->cbuf);
548 if (!sv.active && !cls.demoplayback && !cls.connect_trying)
551 Cbuf_AddText(cmd_local, "togglemenu 1\n");
553 Cbuf_Execute(cmd_local->cbuf);
556 Con_DPrint("========Initialized=========\n");
558 if (cls.state != ca_dedicated)
566 FIXME: this is a callback from Sys_Quit and Sys_Error. It would be better
567 to run quit through here before the final handoff to the sys code.
570 void Host_Shutdown(void)
572 static qbool isdown = false;
576 Con_Print("recursive shutdown\n");
579 if (setjmp(host.abortframe))
581 Con_Print("aborted the quitting frame?!?\n");
586 if(cls.state != ca_dedicated)
589 // end the server thread
593 // shut down local server if active
594 if(host.hook.SV_Shutdown)
595 host.hook.SV_Shutdown();
598 // AK hmm, no PRVM_Shutdown(); yet
600 Host_SaveConfig(CONFIGFILENAME);
606 TaskQueue_Shutdown();
613 Host_UnlockSession();
619 //============================================================================
625 Runs all active servers
628 static double Host_Frame(double time)
630 double cl_wait, sv_wait;
632 TaskQueue_Frame(false);
634 // keep the random time dependent, but not when playing demos/benchmarking
635 if(!*sv_random_seed.string && !host.restless)
638 NetConn_UpdateSockets();
640 Log_DestBuffer_Flush();
645 // get new SDL events and add commands from keybindings to the cbuf
646 Sys_SDL_HandleEvents();
648 // process console commands
649 Cbuf_Frame(host.cbuf);
653 // if the accumulators haven't become positive yet, wait a while
654 sv_wait = - SV_Frame(time);
655 cl_wait = - CL_Frame(time);
657 Mem_CheckSentinelsGlobal();
659 if (cls.state == ca_dedicated)
660 return sv_wait; // dedicated
661 else if (!sv.active || svs.threaded)
662 return cl_wait; // connected to server, main menu, or server is on different thread
664 return min(cl_wait, sv_wait); // listen server or singleplayer
667 static inline double Host_Sleep(double time)
671 // convert to microseconds
674 if (time < 1 || host.restless)
675 return 0; // not sleeping this frame
677 if(host_maxwait.value <= 0)
678 time = min(time, 1000000.0);
680 time = min(time, host_maxwait.value * 1000.0);
682 time0 = Sys_DirtyTime();
683 if (sv_checkforpacketsduringsleep.integer && !sys_usenoclockbutbenchmark.integer && !svs.threaded) {
684 NetConn_SleepMicroseconds((int)time);
685 if (cls.state != ca_dedicated)
686 NetConn_ClientFrame(); // helps server browser get good ping values
687 // TODO can we do the same for ServerFrame? Probably not.
691 if (cls.state != ca_dedicated)
693 Sys_Sleep((int)time);
696 delta = Sys_DirtyTime() - time0;
697 if (delta < 0 || delta >= 1800)
700 // R_TimeReport("sleep");
704 // Cloudwalk: Most overpowered function declaration...
705 static inline double Host_UpdateTime (double newtime, double oldtime)
707 double time = newtime - oldtime;
711 // warn if it's significant
713 Con_Printf(CON_WARN "Host_UpdateTime: time stepped backwards (went from %f to %f, difference %f)\n", oldtime, newtime, time);
716 else if (time >= 1800)
718 Con_Printf(CON_WARN "Host_UpdateTime: time stepped forward (went from %f to %f, difference %f)\n", oldtime, newtime, time);
727 double time, oldtime, sleeptime;
729 Host_Init(); // Start!
732 oldtime = Sys_DirtyTime();
735 while(host.state != host_shutdown)
737 // Something bad happened, or the server disconnected
738 if (setjmp(host.abortframe))
740 host.state = host_active; // In case we were loading
744 host.dirtytime = Sys_DirtyTime();
745 host.realtime += time = Host_UpdateTime(host.dirtytime, oldtime);
747 sleeptime = Host_Frame(time);
748 oldtime = host.dirtytime;
751 sleeptime -= Sys_DirtyTime() - host.dirtytime; // execution time
752 host.sleeptime = Host_Sleep(sleeptime);