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
28 A server can always be started, even if the system started out as a client
31 A client can NOT be started if the system started as a dedicated server.
33 Memory is cleared / released when a server or client begins, not when they end.
37 // true if into command execution
38 qboolean host_initialized;
39 // LordHavoc: used to turn Host_Error into Sys_Error if starting up or shutting down
40 qboolean host_loopactive = false;
41 // LordHavoc: set when quit is executed
42 qboolean host_shuttingdown = false;
44 double host_frametime;
45 // LordHavoc: the real frametime, before slowmo and clamping are applied (used for console scrolling)
46 double host_realframetime;
47 // the real time, without any slowmo or clamping
49 // realtime from previous frame
51 // how many frames have occurred
54 // used for -developer commandline parameter, hacky hacky
58 client_t *host_client;
60 jmp_buf host_abortserver;
62 // pretend frames take this amount of time (in seconds), 0 = realtime
63 cvar_t host_framerate = {0, "host_framerate","0"};
64 // shows time used by certain subsystems
65 cvar_t host_speeds = {0, "host_speeds","0"};
66 // LordHavoc: framerate independent slowmo
67 cvar_t slowmo = {0, "slowmo", "1.0"};
68 // LordHavoc: game logic lower cap on framerate (if framerate is below this is, it pretends it is this, so game logic will run normally)
69 cvar_t host_minfps = {CVAR_SAVE, "host_minfps", "10"};
70 // LordHavoc: framerate upper cap
71 cvar_t host_maxfps = {CVAR_SAVE, "host_maxfps", "1000"};
73 // print broadcast messages in dedicated mode
74 cvar_t sv_echobprint = {CVAR_SAVE, "sv_echobprint", "1"};
76 cvar_t sys_ticrate = {CVAR_SAVE, "sys_ticrate","0.05"};
77 cvar_t serverprofile = {0, "serverprofile","0"};
79 cvar_t fraglimit = {CVAR_NOTIFY, "fraglimit","0"};
80 cvar_t timelimit = {CVAR_NOTIFY, "timelimit","0"};
81 cvar_t teamplay = {CVAR_NOTIFY, "teamplay","0"};
83 cvar_t samelevel = {0, "samelevel","0"};
84 cvar_t noexit = {CVAR_NOTIFY, "noexit","0"};
86 cvar_t developer = {0, "developer","0"};
88 cvar_t skill = {0, "skill","1"};
89 cvar_t deathmatch = {0, "deathmatch","0"};
90 cvar_t coop = {0, "coop","0"};
92 cvar_t pausable = {0, "pausable","1"};
94 cvar_t temp1 = {0, "temp1","0"};
96 cvar_t timestamps = {CVAR_SAVE, "timestamps", "0"};
97 cvar_t timeformat = {CVAR_SAVE, "timeformat", "[%b %e %X] "};
99 cvar_t sv_maxplayers = {0, "maxplayers", "8"};
106 void Host_EndGame (const char *format, ...)
111 va_start (argptr,format);
112 vsprintf (string,format,argptr);
114 Con_DPrintf ("Host_EndGame: %s\n",string);
117 Host_ShutdownServer (false);
119 if (cls.state == ca_dedicated)
120 Sys_Error ("Host_EndGame: %s\n",string); // dedicated servers exit
122 if (cls.demonum != -1)
127 longjmp (host_abortserver, 1);
134 This shuts down both the client and server
137 static char hosterrorstring1[4096];
138 static char hosterrorstring2[4096];
139 static qboolean hosterror = false;
140 extern char sv_spawnmap[MAX_QPATH];
141 extern char sv_loadgame[MAX_OSPATH];
142 void Host_Error (const char *error, ...)
146 va_start (argptr,error);
147 vsprintf (hosterrorstring1,error,argptr);
150 Con_Printf ("Host_Error: %s\n", hosterrorstring1);
152 // LordHavoc: if first frame has not been shown, or currently shutting
153 // down, do Sys_Error instead
154 if (!host_loopactive || host_shuttingdown)
155 Sys_Error ("Host_Error: %s", hosterrorstring1);
158 Sys_Error ("Host_Error: recursively entered (original error was: %s new error is: %s)", hosterrorstring2, hosterrorstring1);
161 strcpy(hosterrorstring2, hosterrorstring1);
163 // make sure we don't get in a loading loop
167 CL_Parse_DumpPacket();
172 Host_ShutdownServer (false);
174 if (cls.state == ca_dedicated)
175 Sys_Error ("Host_Error: %s\n",hosterrorstring2); // dedicated servers exit
182 longjmp (host_abortserver, 1);
185 void Host_ServerOptions (void)
194 // client exists, check what mode the user wants
195 i = COM_CheckParm ("-dedicated");
198 cls.state = ca_dedicated;
199 // default players unless specified
200 if (i != (com_argc - 1))
201 numplayers = atoi (com_argv[i+1]);
202 if (COM_CheckParm ("-listen"))
203 Sys_Error ("Only one of -dedicated or -listen can be specified");
207 cls.state = ca_disconnected;
208 i = COM_CheckParm ("-listen");
211 // default players unless specified
212 if (i != (com_argc - 1))
213 numplayers = atoi (com_argv[i+1]);
217 // default players in some games, singleplayer in most
218 if (gamemode != GAME_TRANSFUSION && gamemode != GAME_GOODVSBAD2 && gamemode != GAME_NEXUIZ && gamemode != GAME_BATTLEMECH)
225 // no client in the executable, always start dedicated server
226 if (COM_CheckParm ("-listen"))
227 Sys_Error ("-listen not available in a dedicated server executable");
228 cls.state = ca_dedicated;
229 // check for -dedicated specifying how many players
230 i = COM_CheckParm ("-dedicated");
231 // default players unless specified
232 if (i && i != (com_argc - 1))
233 numplayers = atoi (com_argv[i+1]);
239 numplayers = bound(1, numplayers, MAX_SCOREBOARD);
243 if (!deathmatch.integer)
244 Cvar_SetValueQuick(&deathmatch, 1);
247 Cvar_SetValueQuick(&deathmatch, 0);
249 Cvar_SetValueQuick(&sv_maxplayers, numplayers);
253 =======================
255 ======================
257 void Host_InitLocal (void)
259 Host_InitCommands ();
261 Cvar_RegisterVariable (&host_framerate);
262 Cvar_RegisterVariable (&host_speeds);
263 Cvar_RegisterVariable (&slowmo);
264 Cvar_RegisterVariable (&host_minfps);
265 Cvar_RegisterVariable (&host_maxfps);
267 Cvar_RegisterVariable (&sv_echobprint);
269 Cvar_RegisterVariable (&sys_ticrate);
270 Cvar_RegisterVariable (&serverprofile);
272 Cvar_RegisterVariable (&fraglimit);
273 Cvar_RegisterVariable (&timelimit);
274 Cvar_RegisterVariable (&teamplay);
275 Cvar_RegisterVariable (&samelevel);
276 Cvar_RegisterVariable (&noexit);
277 Cvar_RegisterVariable (&skill);
278 Cvar_RegisterVariable (&developer);
279 if (forcedeveloper) // make it real now that the cvar is registered
280 Cvar_SetValue("developer", 1);
281 Cvar_RegisterVariable (&deathmatch);
282 Cvar_RegisterVariable (&coop);
284 Cvar_RegisterVariable (&pausable);
286 Cvar_RegisterVariable (&temp1);
288 Cvar_RegisterVariable (×tamps);
289 Cvar_RegisterVariable (&timeformat);
291 Cvar_RegisterVariable(&sv_maxplayers);
293 Host_ServerOptions ();
299 Host_WriteConfiguration
301 Writes key bindings and archived cvars to config.cfg
304 void Host_WriteConfiguration (void)
308 // dedicated servers initialize the host but don't parse and set the
310 if (host_initialized && cls.state != ca_dedicated)
312 f = FS_Open ("config.cfg", "w", false);
315 Con_Printf ("Couldn't write config.cfg.\n");
319 Key_WriteBindings (f);
320 Cvar_WriteVariables (f);
331 Sends text across to be displayed
332 FIXME: make this just a stuffed echo?
335 void SV_ClientPrintf(const char *fmt, ...)
340 va_start (argptr,fmt);
341 vsprintf (string, fmt,argptr);
344 MSG_WriteByte (&host_client->message, svc_print);
345 MSG_WriteString (&host_client->message, string);
352 Sends text to all active clients
355 void SV_BroadcastPrintf(const char *fmt, ...)
362 va_start(argptr,fmt);
363 vsnprintf(string, sizeof(string), fmt,argptr);
366 for (i = 0;i < MAX_SCOREBOARD;i++)
368 if ((client = svs.connectedclients[i]) && client->spawned)
370 MSG_WriteByte(&client->message, svc_print);
371 MSG_WriteString(&client->message, string);
375 if (sv_echobprint.integer && cls.state == ca_dedicated)
376 Sys_Printf("%s", string);
383 Send text over to the client to be executed
386 void Host_ClientCommands(const char *fmt, ...)
391 va_start(argptr,fmt);
392 vsprintf(string, fmt,argptr);
395 MSG_WriteByte(&host_client->message, svc_stufftext);
396 MSG_WriteString(&host_client->message, string);
400 =====================
403 Called when the player is getting totally kicked off the host
404 if (crash = true), don't bother sending signofs
405 =====================
407 void SV_DropClient(qboolean crash)
413 Con_Printf("Client \"%s\" dropped\n", host_client->name);
415 // send any final messages (don't check for errors)
416 if (host_client->netconnection)
418 // free the client (the body stays around)
421 // LordHavoc: no opportunity for resending, so use unreliable
422 MSG_WriteByte(&host_client->message, svc_disconnect);
423 NetConn_SendUnreliableMessage(host_client->netconnection, &host_client->message);
426 // break the net connection
427 NetConn_Close(host_client->netconnection);
428 host_client->netconnection = NULL;
430 // LordHavoc: don't call QC if server is dead (avoids recursive
431 // Host_Error in some mods when they run out of edicts)
432 if (sv.active && host_client->edict && host_client->spawned)
434 // call the prog function for removing a client
435 // this will set the body to a dead frame, among other things
436 saveSelf = pr_global_struct->self;
437 pr_global_struct->self = EDICT_TO_PROG(host_client->edict);
438 PR_ExecuteProgram(pr_global_struct->ClientDisconnect, "QC function ClientDisconnect is missing");
439 pr_global_struct->self = saveSelf;
443 // send notification to all clients
444 for (i = 0;i < MAX_SCOREBOARD;i++)
446 if (!(client = svs.connectedclients[i]))
448 MSG_WriteByte(&client->message, svc_updatename);
449 MSG_WriteByte(&client->message, host_client->number);
450 MSG_WriteString(&client->message, "");
451 MSG_WriteByte(&client->message, svc_updatefrags);
452 MSG_WriteByte(&client->message, host_client->number);
453 MSG_WriteShort(&client->message, 0);
454 MSG_WriteByte(&client->message, svc_updatecolors);
455 MSG_WriteByte(&client->message, host_client->number);
456 MSG_WriteByte(&client->message, 0);
459 NetConn_Heartbeat(1);
461 // free the client now
462 if (host_client->entitydatabase4)
463 EntityFrame4_FreeDatabase(host_client->entitydatabase4);
464 // remove the index reference
465 svs.connectedclients[host_client->number] = NULL;
466 Mem_Free(host_client);
473 This only happens at the end of a game, not between levels
476 void Host_ShutdownServer(qboolean crash)
486 // print out where the crash happened, if it was caused by QC
491 // stop all client sounds immediately
494 NetConn_Heartbeat(2);
495 NetConn_Heartbeat(2);
497 // flush any pending messages - like the score!!!
498 start = Sys_DoubleTime();
502 NetConn_ClientFrame();
503 NetConn_ServerFrame();
504 for (i = 0;i < MAX_SCOREBOARD;i++)
506 host_client = svs.connectedclients[i];
507 if (host_client && host_client->message.cursize)
509 if (NetConn_CanSendMessage(host_client->netconnection))
511 NetConn_SendReliableMessage(host_client->netconnection, &host_client->message);
512 SZ_Clear(&host_client->message);
518 if ((Sys_DoubleTime() - start) > 3.0)
523 // make sure all the clients know we're disconnecting
527 MSG_WriteByte(&buf, svc_disconnect);
528 count = NetConn_SendToAll(&buf, 5);
530 Con_Printf("Host_ShutdownServer: NetConn_SendToAll failed for %u clients\n", count);
532 for (i = 0;i < MAX_SCOREBOARD;i++)
533 if ((host_client = svs.connectedclients[i]))
534 SV_DropClient(crash); // server shutdown
536 NetConn_CloseServerPorts();
541 memset(&sv, 0, sizeof(sv));
549 This clears all the memory used by both the client and server, but does
550 not reinitialize anything.
553 void Host_ClearMemory (void)
555 Con_DPrintf ("Clearing memory\n");
559 memset (&sv, 0, sizeof(sv));
560 memset (&cl, 0, sizeof(cl));
564 //============================================================================
570 Returns false if the time is too short to run a frame
573 extern cvar_t cl_avidemo;
574 qboolean Host_FilterTime (double time)
579 if (slowmo.value < 0.0f)
580 Cvar_SetValue("slowmo", 0.0f);
581 if (host_minfps.value < 10.0f)
582 Cvar_SetValue("host_minfps", 10.0f);
583 if (host_maxfps.value < host_minfps.value)
584 Cvar_SetValue("host_maxfps", host_minfps.value);
585 if (cl_avidemo.value < 0.1f && cl_avidemo.value != 0.0f)
586 Cvar_SetValue("cl_avidemo", 0.0f);
588 // check if framerate is too high
589 if (cl_avidemo.value >= 0.1f)
591 timecap = 1.0 / (double)cl_avidemo.value;
592 if ((realtime - oldrealtime) < timecap)
595 else if (!cls.timedemo)
597 // default to sys_ticrate (server framerate - presumably low) unless we're the active window and either connected to a server or playing a video
598 timecap = sys_ticrate.value;
599 if (vid_activewindow && (cls.state == ca_connected || cl_videoplaying))
600 timecap = 1.0 / host_maxfps.value;
602 if ((realtime - oldrealtime) < timecap)
606 // LordHavoc: copy into host_realframetime as well
607 host_realframetime = host_frametime = realtime - oldrealtime;
608 oldrealtime = realtime;
612 // disable time effects
613 cl.frametime = host_frametime;
617 if (host_framerate.value > 0)
618 host_frametime = host_framerate.value;
619 else if (cl_avidemo.value >= 0.1f)
620 host_frametime = (1.0 / cl_avidemo.value);
623 // don't allow really short frames
624 if (host_frametime > (1.0 / host_minfps.value))
625 host_frametime = (1.0 / host_minfps.value);
628 cl.frametime = host_frametime = bound(0, host_frametime * slowmo.value, 0.1f); // LordHavoc: the QC code relies on no less than 10fps
636 Host_GetConsoleCommands
638 Add them exactly as if they had been typed at the console
641 void Host_GetConsoleCommands (void)
647 cmd = Sys_ConsoleInput ();
661 void Host_ServerFrame (void)
663 static double frametimetotal = 0, lastservertime = 0;
664 frametimetotal += host_frametime;
665 // LordHavoc: cap server at sys_ticrate in networked games
666 if (!cl.islocalgame && ((realtime - lastservertime) < sys_ticrate.value))
669 NetConn_ServerFrame();
671 // run the world state
672 if (!sv.paused && (!cl.islocalgame || (key_dest == key_game && !key_consoleactive)))
673 sv.frametime = pr_global_struct->frametime = frametimetotal;
677 lastservertime = realtime;
679 // set the time and clear the general datagram
682 // read client messages
685 // move things around and think
686 // always pause in single player if in console or menus
690 // send all messages to the clients
691 SV_SendClientMessages();
693 // send an heartbeat if enough time has passed since the last one
694 NetConn_Heartbeat(0);
702 Runs all active servers
705 void _Host_Frame (float time)
707 static double time1 = 0;
708 static double time2 = 0;
709 static double time3 = 0;
710 int pass1, pass2, pass3;
712 if (setjmp(host_abortserver))
713 return; // something bad happened, or the server disconnected
715 // keep the random time dependent
718 // decide the simulation time
719 if (!Host_FilterTime(time))
721 // if time was rejected, don't totally hog the CPU
726 cl.islocalgame = NetConn_IsLocalGame();
728 // get new key events
731 // allow mice or other external controllers to add commands
734 // process console commands
737 // LordHavoc: map and load are delayed until video is initialized
738 Host_PerformSpawnServerAndLoadGame();
740 // if running the server locally, make intentions now
741 if (cls.state == ca_connected && sv.active)
744 //-------------------
748 //-------------------
750 // check for commands typed to the host
751 Host_GetConsoleCommands();
756 //-------------------
760 //-------------------
762 cl.oldtime = cl.time;
763 cl.time += cl.frametime;
765 NetConn_ClientFrame();
767 if (cls.state == ca_connected)
769 // if running the server remotely, send intentions now after
770 // the incoming messages have been read
781 if (host_speeds.integer)
782 time1 = Sys_DoubleTime();
786 if (host_speeds.integer)
787 time2 = Sys_DoubleTime();
790 if (cls.signon == SIGNONS)
792 // LordHavoc: this used to use renderer variables (eww)
793 vec3_t forward, right, up;
794 AngleVectors(cl.viewangles, forward, right, up);
795 S_Update(cl_entities[cl.viewentity].render.origin, forward, right, up);
798 S_Update(vec3_origin, vec3_origin, vec3_origin, vec3_origin);
802 if (host_speeds.integer)
804 pass1 = (time1 - time3)*1000000;
805 time3 = Sys_DoubleTime();
806 pass2 = (time2 - time1)*1000000;
807 pass3 = (time3 - time2)*1000000;
808 Con_Printf("%6ius total %6ius server %6ius gfx %6ius snd\n",
809 pass1+pass2+pass3, pass1, pass2, pass3);
813 host_loopactive = true;
816 void Host_Frame (float time)
819 static double timetotal;
820 static int timecount;
823 if (!serverprofile.integer)
829 time1 = Sys_DoubleTime ();
831 time2 = Sys_DoubleTime ();
833 timetotal += time2 - time1;
836 if (timecount < 1000)
839 m = timetotal*1000/timecount;
843 for (i = 0;i < MAX_SCOREBOARD;i++)
844 if (svs.connectedclients[i])
847 Con_Printf ("serverprofile: %2i clients %2i msec\n", c, m);
850 //============================================================================
852 void Render_Init(void);
859 void Host_Init (void)
861 // LordHavoc: quake never seeded the random number generator before... heh
864 // FIXME: this is evil, but possibly temporary
865 if (COM_CheckParm("-developer"))
867 forcedeveloper = true;
868 developer.integer = 1;
873 Memory_Init_Commands();
879 W_LoadWadFile("gfx.wad");
889 Con_Printf ("Builddate: %s\n", buildstring);
891 if (cls.state != ca_dedicated)
903 Cbuf_InsertText ("exec quake.rc\n");
909 host_initialized = true;
911 Con_DPrintf ("========Initialized=========\n");
913 if (cls.state != ca_dedicated)
922 FIXME: this is a callback from Sys_Quit and Sys_Error. It would be better
923 to run quit through here before the final handoff to the sys code.
926 void Host_Shutdown(void)
928 static qboolean isdown = false;
932 Con_Printf ("recursive shutdown\n");
937 Host_WriteConfiguration ();
943 if (cls.state != ca_dedicated)
945 R_Modules_Shutdown();