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"};
48 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"};
49 cvar_t developer_extra = {CF_CLIENT | CF_SERVER, "developer_extra", "0", "prints additional debugging messages, often very verbose!"};
50 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!"};
51 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)"};
52 cvar_t developer_loading = {CF_CLIENT | CF_SERVER, "developer_loading","0", "prints information about files as they are loaded or unloaded successfully"};
53 cvar_t developer_entityparsing = {CF_CLIENT, "developer_entityparsing", "0", "prints detailed network entities information each time a packet is received"};
55 cvar_t timestamps = {CF_CLIENT | CF_SERVER | CF_ARCHIVE, "timestamps", "0", "prints timestamps on console messages"};
56 cvar_t timeformat = {CF_CLIENT | CF_SERVER | CF_ARCHIVE, "timeformat", "[%Y-%m-%d %H:%M:%S] ", "time format to use on timestamped console messages"};
58 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 (.)"};
59 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"};
61 cvar_t host_isclient = {CF_SHARED | CF_READONLY, "_host_isclient", "0", "If 1, clientside is active."};
65 Host_AbortCurrentFrame
67 aborts the current host frame and goes on with the next one
70 void Host_AbortCurrentFrame(void)
72 // in case we were previously nice, make us mean again
73 Sys_MakeProcessMean();
75 longjmp (host.abortframe, 1);
82 This shuts down both the client and server
85 void Host_Error (const char *error, ...)
87 static char hosterrorstring1[MAX_INPUTLINE]; // THREAD UNSAFE
88 static char hosterrorstring2[MAX_INPUTLINE]; // THREAD UNSAFE
89 static qbool hosterror = false;
91 int outfd = sys.outfd;
93 // set output to stderr
94 sys.outfd = fileno(stderr);
96 // turn off rcon redirect if it was active when the crash occurred
97 // to prevent loops when it is a networking problem
98 Con_Rcon_Redirect_Abort();
100 va_start (argptr,error);
101 dpvsnprintf (hosterrorstring1,sizeof(hosterrorstring1),error,argptr);
104 Con_Printf(CON_ERROR "Host_Error: %s\n", hosterrorstring1);
106 // LadyHavoc: if crashing very early, or currently shutting down, do
108 if (host.framecount < 3 || host.state == host_shutdown)
109 Sys_Error ("Host_Error during %s: %s", host.framecount < 3 ? "startup" : "shutdown", hosterrorstring1);
112 Sys_Error ("Host_Error: recursively entered (original error was: %s new error is: %s)", hosterrorstring2, hosterrorstring1);
115 dp_strlcpy(hosterrorstring2, hosterrorstring1, sizeof(hosterrorstring2));
117 CL_Parse_DumpPacket();
118 CL_Parse_ErrorCleanUp();
120 // print out where the crash happened, if it was caused by QC (and do a cleanup)
123 if(host.hook.SV_Shutdown)
124 host.hook.SV_Shutdown();
126 if (cls.state == ca_dedicated)
127 Sys_Error("Host_Error: %s", hosterrorstring1); // dedicated servers exit
129 // prevent an endless loop if the error was triggered by a command
130 Cbuf_Clear(cmd_local->cbuf);
132 CL_DisconnectEx(false, "Host_Error: %s", hosterrorstring1);
133 cls.demonum = -1; // stop demo loop
137 // restore configured outfd
140 Host_AbortCurrentFrame();
148 static void Host_Quit_f(cmd_state_t *cmd)
150 if(host.state == host_shutdown)
151 Con_Printf("shutting down already!\n");
153 host.state = host_shutdown;
156 static void Host_Version_f(cmd_state_t *cmd)
158 Con_Printf("Version: %s\n", engineversion);
161 static void Host_Framerate_c(cvar_t *var)
163 if (var->value < 0.00001 && var->value != 0)
164 Cvar_SetValueQuick(var, 0);
167 // TODO: Find a better home for this.
168 static void SendCvar_f(cmd_state_t *cmd)
170 if(cmd->source == src_local && host.hook.SV_SendCvar)
172 host.hook.SV_SendCvar(cmd);
175 if(cmd->source == src_client && host.hook.CL_SendCvar)
177 host.hook.CL_SendCvar(cmd);
186 Writes key bindings and archived cvars to config.cfg
189 void Host_SaveConfig(const char *file)
193 // dedicated servers initialize the host but don't parse and set the
195 // LadyHavoc: don't save a config if it crashed in startup
196 if (host.framecount >= 3 && cls.state != ca_dedicated && !Sys_CheckParm("-benchmark") && !Sys_CheckParm("-capturedemo"))
198 f = FS_OpenRealFile(file, "wb", false);
201 Con_Printf(CON_ERROR "Couldn't write %s\n", file);
205 Con_Printf("Saving config to %s ...\n", file);
207 Key_WriteBindings (f);
208 Cvar_WriteVariables (&cvars_all, f);
214 static void Host_SaveConfig_f(cmd_state_t *cmd)
216 const char *file = CONFIGFILENAME;
218 if(Cmd_Argc(cmd) >= 2)
219 file = Cmd_Argv(cmd, 1);
221 Host_SaveConfig(file);
224 static void Host_AddConfigText(cmd_state_t *cmd)
226 // set up the default startmap_sp and startmap_dm aliases (mods can
227 // override these) and then execute the quake.rc startup script
228 if (gamemode == GAME_NEHAHRA)
229 Cbuf_InsertText(cmd, "alias startmap_sp \"map nehstart\"\nalias startmap_dm \"map nehstart\"\nexec " STARTCONFIGFILENAME "\n");
230 else if (gamemode == GAME_TRANSFUSION)
231 Cbuf_InsertText(cmd, "alias startmap_sp \"map e1m1\"\n""alias startmap_dm \"map bb1\"\nexec " STARTCONFIGFILENAME "\n");
232 else if (gamemode == GAME_TEU)
233 Cbuf_InsertText(cmd, "alias startmap_sp \"map start\"\nalias startmap_dm \"map start\"\nexec teu.rc\n");
235 Cbuf_InsertText(cmd, "alias startmap_sp \"map start\"\nalias startmap_dm \"map start\"\nexec " STARTCONFIGFILENAME "\n");
237 // if quake.rc is missing, use default
238 if (!FS_FileExists(STARTCONFIGFILENAME))
239 Cbuf_InsertText(cmd, "exec default.cfg\nexec " CONFIGFILENAME "\nexec autoexec.cfg\n");
246 Resets key bindings and cvars to defaults and then reloads scripts
249 static void Host_LoadConfig_f(cmd_state_t *cmd)
252 // Xonotic QC complains/breaks if its cvars are deleted before its m_shutdown() is called
256 Cmd_RestoreInitState();
258 // Must re-add menu.c commands or load menu.dat before executing quake.rc or handling events
261 // exec startup scripts again
262 Host_AddConfigText(cmd);
266 =======================
268 ======================
270 extern cvar_t r_texture_jpeg_fastpicmip;
271 static void Host_InitLocal (void)
273 Cmd_AddCommand(CF_SHARED, "quit", Host_Quit_f, "quit the game");
274 Cmd_AddCommand(CF_SHARED, "version", Host_Version_f, "print engine version");
275 Cmd_AddCommand(CF_SHARED, "saveconfig", Host_SaveConfig_f, "save settings to config.cfg (or a specified filename) immediately (also automatic when quitting)");
276 Cmd_AddCommand(CF_SHARED, "loadconfig", Host_LoadConfig_f, "reset everything and reload configs");
277 Cmd_AddCommand(CF_SHARED, "sendcvar", SendCvar_f, "sends the value of a cvar to the server as a sentcvar command, for use by QuakeC");
278 Cvar_RegisterVariable (&host_framerate);
279 Cvar_RegisterCallback (&host_framerate, Host_Framerate_c);
280 Cvar_RegisterVariable (&host_speeds);
281 Cvar_RegisterVariable (&host_isclient);
283 Cvar_RegisterVariable (&developer);
284 Cvar_RegisterVariable (&developer_extra);
285 Cvar_RegisterVariable (&developer_insane);
286 Cvar_RegisterVariable (&developer_loadfile);
287 Cvar_RegisterVariable (&developer_loading);
288 Cvar_RegisterVariable (&developer_entityparsing);
290 Cvar_RegisterVariable (×tamps);
291 Cvar_RegisterVariable (&timeformat);
293 Cvar_RegisterVariable (&r_texture_jpeg_fastpicmip);
296 char engineversion[128];
299 static qfile_t *locksession_fh = NULL;
300 static qbool locksession_run = false;
301 static void Host_InitSession(void)
305 Cvar_RegisterVariable(&sessionid);
306 Cvar_RegisterVariable(&locksession);
308 // load the session ID into the read-only cvar
309 if ((i = Sys_CheckParm("-sessionid")) && (i + 1 < sys.argc))
311 if(sys.argv[i+1][0] == '.')
312 Cvar_SetQuick(&sessionid, sys.argv[i+1]);
315 buf = (char *)Z_Malloc(strlen(sys.argv[i+1]) + 2);
316 dpsnprintf(buf, sizeof(buf), ".%s", sys.argv[i+1]);
317 Cvar_SetQuick(&sessionid, buf);
322 void Host_LockSession(void)
326 locksession_run = true;
327 if(locksession.integer != 0 && !Sys_CheckParm("-readonly"))
330 char *p = va(vabuf, sizeof(vabuf), "%slock%s", *fs_userdir ? fs_userdir : fs_basedir, sessionid.string);
332 locksession_fh = FS_SysOpen(p, "wl", false);
333 // TODO maybe write the pid into the lockfile, while we are at it? may help server management tools
336 if(locksession.integer == 2)
338 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);
342 Sys_Error("session lock %s could not be acquired. Please run with -sessionid and an unique session name.\n", p);
348 void Host_UnlockSession(void)
352 locksession_run = false;
356 FS_Close(locksession_fh);
357 // NOTE: we can NOT unlink the lock here, as doing so would
358 // create a race condition if another process created it
359 // between our close and our unlink
360 locksession_fh = NULL;
369 static void Host_Init (void)
378 host.hook.ConnectLocal = NULL;
379 host.hook.Disconnect = NULL;
380 host.hook.ToggleMenu = NULL;
381 host.hook.CL_Intermission = NULL;
382 host.hook.SV_Shutdown = NULL;
384 host.state = host_init;
386 if (setjmp(host.abortframe)) // Huh?!
387 Sys_Error("Engine initialization failed. Check the console (if available) for additional information.\n");
389 if (Sys_CheckParm("-profilegameonly"))
390 Sys_AllowProfiling(false);
392 // LadyHavoc: quake never seeded the random number generator before... heh
393 if (Sys_CheckParm("-benchmark"))
394 srand(0); // predictable random sequence for -benchmark
396 srand((unsigned int)time(NULL));
398 // FIXME: this is evil, but possibly temporary
399 // LadyHavoc: doesn't seem very temporary...
400 // LadyHavoc: made this a saved cvar
401 // COMMANDLINEOPTION: Console: -developer enables warnings and other notices (RECOMMENDED for mod developers)
402 if (Sys_CheckParm("-developer"))
404 developer.value = developer.integer = 1;
405 developer.string = "1";
408 if (Sys_CheckParm("-developer2") || Sys_CheckParm("-developer3"))
410 developer.value = developer.integer = 1;
411 developer.string = "1";
412 developer_extra.value = developer_extra.integer = 1;
413 developer_extra.string = "1";
414 developer_insane.value = developer_insane.integer = 1;
415 developer_insane.string = "1";
416 developer_memory.value = developer_memory.integer = 1;
417 developer_memory.string = "1";
418 developer_memorydebug.value = developer_memorydebug.integer = 1;
419 developer_memorydebug.string = "1";
422 if (Sys_CheckParm("-developer3"))
424 gl_paranoid.integer = 1;gl_paranoid.string = "1";
425 gl_printcheckerror.integer = 1;gl_printcheckerror.string = "1";
428 // -dedicated is checked in SV_ServerOptions() but that's too late for Cvar_RegisterVariable() to skip all the client-only cvars
429 if (Sys_CheckParm ("-dedicated") || !cl_available)
430 cls.state = ca_dedicated;
432 // initialize console command/cvar/alias/command execution systems
435 // initialize memory subsystem cvars/commands
436 Memory_Init_Commands();
438 // initialize console and logging and its cvars/commands
439 // this enables Con_Printf() messages to be coloured
442 // initialize various cvars that could not be initialized earlier
444 Curl_Init_Commands();
448 // initialize filesystem (including fs_basedir, fs_gamedir, -game, scr_screenshot_name, gamename)
451 // ASAP! construct a version string for the corner of the console and for crash messages
452 dpsnprintf (engineversion, sizeof (engineversion), "%s %s%s, buildstring: %s", gamename, DP_OS_NAME, cls.state == ca_dedicated ? " dedicated" : "", buildstring);
453 Con_Printf("%s\n", engineversion);
455 // initialize process nice level
456 Sys_InitProcessNice();
458 // initialize ixtable
461 // register the cvars for session locking
464 // must be after FS_Init
466 Crypto_Init_Commands();
481 // save off current state of aliases, commands and cvars for later restore if FS_GameDir_f is called
482 // NOTE: menu commands are freed by Cmd_RestoreInitState
485 // FIXME: put this into some neat design, but the menu should be allowed to crash
486 // without crashing the whole game, so this should just be a short-time solution
488 // here comes the not so critical stuff
490 Host_AddConfigText(cmd_local);
491 Cbuf_Execute(cmd_local->cbuf); // cannot be in Host_AddConfigText as that would cause Host_LoadConfig_f to loop!
493 host.state = host_active;
499 if (cls.state != ca_dedicated)
501 // put up the loading image so the user doesn't stare at a black screen...
502 SCR_BeginLoadingPlaque(true);
509 // check for special benchmark mode
510 // 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)
511 i = Sys_CheckParm("-benchmark");
512 if (i && i + 1 < sys.argc)
513 if (!sv.active && !cls.demoplayback && !cls.connect_trying)
515 Cbuf_AddText(cmd_local, va(vabuf, sizeof(vabuf), "timedemo %s\n", sys.argv[i + 1]));
516 Cbuf_Execute(cmd_local->cbuf);
519 // check for special demo mode
520 // COMMANDLINEOPTION: Client: -demo <demoname> runs a playdemo and quits
521 i = Sys_CheckParm("-demo");
522 if (i && i + 1 < sys.argc)
523 if (!sv.active && !cls.demoplayback && !cls.connect_trying)
525 Cbuf_AddText(cmd_local, va(vabuf, sizeof(vabuf), "playdemo %s\n", sys.argv[i + 1]));
526 Cbuf_Execute(cmd_local->cbuf);
529 #ifdef CONFIG_VIDEO_CAPTURE
530 // COMMANDLINEOPTION: Client: -capturedemo <demoname> captures a playdemo and quits
531 i = Sys_CheckParm("-capturedemo");
532 if (i && i + 1 < sys.argc)
533 if (!sv.active && !cls.demoplayback && !cls.connect_trying)
535 Cbuf_AddText(cmd_local, va(vabuf, sizeof(vabuf), "playdemo %s\ncl_capturevideo 1\n", sys.argv[i + 1]));
536 Cbuf_Execute((cmd_local)->cbuf);
540 if (cls.state == ca_dedicated || Sys_CheckParm("-listen"))
541 if (!sv.active && !cls.demoplayback && !cls.connect_trying)
543 Cbuf_AddText(cmd_local, "startmap_dm\n");
544 Cbuf_Execute(cmd_local->cbuf);
547 if (!sv.active && !cls.demoplayback && !cls.connect_trying)
550 Cbuf_AddText(cmd_local, "togglemenu 1\n");
552 Cbuf_Execute(cmd_local->cbuf);
555 Con_DPrint("========Initialized=========\n");
557 if (cls.state != ca_dedicated)
565 Cleanly shuts down after the main loop exits.
568 static void Host_Shutdown(void)
570 if (Sys_CheckParm("-profilegameonly"))
571 Sys_AllowProfiling(false);
573 if(cls.state != ca_dedicated)
576 // end the server thread
580 // shut down local server if active
581 if(host.hook.SV_Shutdown)
582 host.hook.SV_Shutdown();
585 // AK hmm, no PRVM_Shutdown(); yet
587 Host_SaveConfig(CONFIGFILENAME);
593 TaskQueue_Shutdown();
600 Host_UnlockSession();
606 //============================================================================
612 Runs all active servers
615 static double Host_Frame(double time)
617 double cl_wait, sv_wait;
619 TaskQueue_Frame(false);
621 // keep the random time dependent, but not when playing demos/benchmarking
622 if(!*sv_random_seed.string && !host.restless)
625 NetConn_UpdateSockets();
627 Log_DestBuffer_Flush();
632 // get new SDL events and add commands from keybindings to the cbuf
633 Sys_SDL_HandleEvents();
635 // process console commands
636 Cbuf_Frame(host.cbuf);
640 // if the accumulators haven't become positive yet, wait a while
641 sv_wait = - SV_Frame(time);
642 cl_wait = - CL_Frame(time);
644 Mem_CheckSentinelsGlobal();
646 if (cls.state == ca_dedicated)
647 return sv_wait; // dedicated
648 else if (!sv.active || svs.threaded)
649 return cl_wait; // connected to server, main menu, or server is on different thread
651 return min(cl_wait, sv_wait); // listen server or singleplayer
654 // Cloudwalk: Most overpowered function declaration...
655 static inline double Host_UpdateTime (double newtime, double oldtime)
657 double time = newtime - oldtime;
661 // warn if it's significant
663 Con_Printf(CON_WARN "Host_UpdateTime: time stepped backwards (went from %f to %f, difference %f)\n", oldtime, newtime, time);
666 else if (time >= 1800)
668 Con_Printf(CON_WARN "Host_UpdateTime: time stepped forward (went from %f to %f, difference %f)\n", oldtime, newtime, time);
677 double time, oldtime, sleeptime;
679 Host_Init(); // Start!
682 oldtime = Sys_DirtyTime();
685 while(host.state < host_shutdown) // see Sys_HandleCrash() comments
687 // Something bad happened, or the server disconnected
688 if (setjmp(host.abortframe))
690 host.state = host_active; // In case we were loading
694 host.dirtytime = Sys_DirtyTime();
695 host.realtime += time = Host_UpdateTime(host.dirtytime, oldtime);
696 oldtime = host.dirtytime;
698 sleeptime = Host_Frame(time);
700 sleeptime -= Sys_DirtyTime() - host.dirtytime; // execution time
701 host.sleeptime = Sys_Sleep(sleeptime);