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] "};
104 void Host_EndGame (const char *format, ...)
109 va_start (argptr,format);
110 vsprintf (string,format,argptr);
112 Con_DPrintf ("Host_EndGame: %s\n",string);
115 Host_ShutdownServer (false);
117 if (cls.state == ca_dedicated)
118 Sys_Error ("Host_EndGame: %s\n",string); // dedicated servers exit
120 if (cls.demonum != -1)
125 longjmp (host_abortserver, 1);
132 This shuts down both the client and server
135 static char hosterrorstring1[4096];
136 static char hosterrorstring2[4096];
137 static qboolean hosterror = false;
138 extern char sv_spawnmap[MAX_QPATH];
139 extern char sv_loadgame[MAX_OSPATH];
140 void Host_Error (const char *error, ...)
144 va_start (argptr,error);
145 vsprintf (hosterrorstring1,error,argptr);
148 Con_Printf ("Host_Error: %s\n", hosterrorstring1);
150 // LordHavoc: if first frame has not been shown, or currently shutting
151 // down, do Sys_Error instead
152 if (!host_loopactive || host_shuttingdown)
153 Sys_Error ("Host_Error: %s", hosterrorstring1);
156 Sys_Error ("Host_Error: recursively entered (original error was: %s new error is: %s)", hosterrorstring2, hosterrorstring1);
159 strcpy(hosterrorstring2, hosterrorstring1);
161 // make sure we don't get in a loading loop
165 CL_Parse_DumpPacket();
170 Host_ShutdownServer (false);
172 if (cls.state == ca_dedicated)
173 Sys_Error ("Host_Error: %s\n",hosterrorstring2); // dedicated servers exit
178 // unload any partially loaded models
179 Mod_ClearErrorModels();
183 longjmp (host_abortserver, 1);
186 void Host_ServerOptions (void)
192 // client exists, check what mode the user wants
193 i = COM_CheckParm ("-dedicated");
196 cls.state = ca_dedicated;
198 if (i != (com_argc - 1))
199 numplayers = atoi (com_argv[i+1]);
200 if (COM_CheckParm ("-listen"))
201 Sys_Error ("Only one of -dedicated or -listen can be specified");
206 cls.state = ca_disconnected;
207 i = COM_CheckParm ("-listen");
211 if (i != (com_argc - 1))
212 numplayers = atoi (com_argv[i+1]);
218 // no client in the executable, start dedicated server
219 if (COM_CheckParm ("-listen"))
220 Sys_Error ("-listen not available in a dedicated server executable");
222 cls.state = ca_dedicated;
223 // check for -dedicated specifying how many players
224 i = COM_CheckParm ("-dedicated");
225 if (i && i != (com_argc - 1))
226 numplayers = atoi (com_argv[i+1]);
231 if (numplayers > MAX_SCOREBOARD)
232 numplayers = MAX_SCOREBOARD;
234 // Transfusion doesn't support single player games
235 if (gamemode == GAME_TRANSFUSION && numplayers < 4)
239 Cvar_SetValueQuick (&deathmatch, 1);
241 Cvar_SetValueQuick (&deathmatch, 0);
244 SV_SetMaxClients(numplayers);
247 static mempool_t *clients_mempool;
248 void SV_SetMaxClients(int n)
252 n = bound(1, n, MAX_SCOREBOARD);
253 if (svs.maxclients == n)
256 if (!clients_mempool)
257 clients_mempool = Mem_AllocPool("clients");
259 Mem_Free(svs.clients);
260 svs.clients = Mem_Alloc(clients_mempool, svs.maxclients*sizeof(client_t));
265 =======================
267 ======================
269 void Host_InitLocal (void)
271 Host_InitCommands ();
273 Cvar_RegisterVariable (&host_framerate);
274 Cvar_RegisterVariable (&host_speeds);
275 Cvar_RegisterVariable (&slowmo);
276 Cvar_RegisterVariable (&host_minfps);
277 Cvar_RegisterVariable (&host_maxfps);
279 Cvar_RegisterVariable (&sv_echobprint);
281 Cvar_RegisterVariable (&sys_ticrate);
282 Cvar_RegisterVariable (&serverprofile);
284 Cvar_RegisterVariable (&fraglimit);
285 Cvar_RegisterVariable (&timelimit);
286 Cvar_RegisterVariable (&teamplay);
287 Cvar_RegisterVariable (&samelevel);
288 Cvar_RegisterVariable (&noexit);
289 Cvar_RegisterVariable (&skill);
290 Cvar_RegisterVariable (&developer);
291 if (forcedeveloper) // make it real now that the cvar is registered
292 Cvar_SetValue("developer", 1);
293 Cvar_RegisterVariable (&deathmatch);
294 Cvar_RegisterVariable (&coop);
296 Cvar_RegisterVariable (&pausable);
298 Cvar_RegisterVariable (&temp1);
300 Cvar_RegisterVariable (×tamps);
301 Cvar_RegisterVariable (&timeformat);
303 Host_ServerOptions ();
309 Host_WriteConfiguration
311 Writes key bindings and archived cvars to config.cfg
314 void Host_WriteConfiguration (void)
318 // dedicated servers initialize the host but don't parse and set the
320 if (host_initialized && cls.state != ca_dedicated)
322 f = FS_Open ("config.cfg", "w", false);
325 Con_Printf ("Couldn't write config.cfg.\n");
329 Key_WriteBindings (f);
330 Cvar_WriteVariables (f);
341 Sends text across to be displayed
342 FIXME: make this just a stuffed echo?
345 void SV_ClientPrintf (const char *fmt, ...)
350 va_start (argptr,fmt);
351 vsprintf (string, fmt,argptr);
354 MSG_WriteByte (&host_client->message, svc_print);
355 MSG_WriteString (&host_client->message, string);
362 Sends text to all active clients
365 void SV_BroadcastPrintf (const char *fmt, ...)
371 va_start (argptr,fmt);
372 vsprintf (string, fmt,argptr);
375 for (i=0 ; i<svs.maxclients ; i++)
376 if (svs.clients[i].active && svs.clients[i].spawned)
378 MSG_WriteByte (&svs.clients[i].message, svc_print);
379 MSG_WriteString (&svs.clients[i].message, string);
382 if (sv_echobprint.integer && cls.state == ca_dedicated)
383 Sys_Printf ("%s", string);
390 Send text over to the client to be executed
393 void Host_ClientCommands (const char *fmt, ...)
398 va_start (argptr,fmt);
399 vsprintf (string, fmt,argptr);
402 MSG_WriteByte (&host_client->message, svc_stufftext);
403 MSG_WriteString (&host_client->message, string);
407 =====================
410 Called when the player is getting totally kicked off the host
411 if (crash = true), don't bother sending signofs
412 =====================
414 void SV_DropClient (qboolean crash)
420 Con_Printf ("Client \"%s\" dropped\n", host_client->name);
424 // send any final messages (don't check for errors)
425 if (host_client->netconnection && !host_client->netconnection->disconnected)
428 // LordHavoc: no opportunity for resending, so reliable is silly
429 MSG_WriteByte (&host_client->message, svc_disconnect);
430 NET_SendUnreliableMessage (host_client->netconnection, &host_client->message);
432 if (NET_CanSendMessage (host_client->netconnection))
434 MSG_WriteByte (&host_client->message, svc_disconnect);
435 NET_SendMessage (host_client->netconnection, &host_client->message);
441 // break the net connection
442 NET_Close (host_client->netconnection);
443 host_client->netconnection = NULL;
445 // free the client (the body stays around)
446 host_client->active = false;
447 // note: don't clear name yet
448 net_activeconnections--;
450 if (sv.active && host_client->edict && host_client->spawned) // LordHavoc: don't call QC if server is dead (avoids recursive Host_Error in some mods when they run out of edicts)
452 // call the prog function for removing a client
453 // this will set the body to a dead frame, among other things
454 saveSelf = pr_global_struct->self;
455 pr_global_struct->self = EDICT_TO_PROG(host_client->edict);
456 PR_ExecuteProgram (pr_global_struct->ClientDisconnect, "QC function ClientDisconnect is missing");
457 pr_global_struct->self = saveSelf;
460 // now clear name (after ClientDisconnect was called)
461 host_client->name[0] = 0;
462 host_client->old_frags = -999999;
464 // send notification to all clients
465 for (i=0, client = svs.clients ; i<svs.maxclients ; i++, client++)
469 MSG_WriteByte (&client->message, svc_updatename);
470 MSG_WriteByte (&client->message, host_client - svs.clients);
471 MSG_WriteString (&client->message, "");
472 MSG_WriteByte (&client->message, svc_updatefrags);
473 MSG_WriteByte (&client->message, host_client - svs.clients);
474 MSG_WriteShort (&client->message, 0);
475 MSG_WriteByte (&client->message, svc_updatecolors);
476 MSG_WriteByte (&client->message, host_client - svs.clients);
477 MSG_WriteByte (&client->message, 0);
487 This only happens at the end of a game, not between levels
490 void Host_ShutdownServer(qboolean crash)
500 // print out where the crash happened, if it was caused by QC
505 // stop all client sounds immediately
511 // flush any pending messages - like the score!!!
512 start = Sys_DoubleTime();
516 for (i=0, host_client = svs.clients ; i<svs.maxclients ; i++, host_client++)
518 if (host_client->active && host_client->message.cursize)
520 if (NET_CanSendMessage (host_client->netconnection))
522 NET_SendMessage(host_client->netconnection, &host_client->message);
523 SZ_Clear (&host_client->message);
527 NET_GetMessage(host_client->netconnection);
532 if ((Sys_DoubleTime() - start) > 3.0)
537 // make sure all the clients know we're disconnecting
541 MSG_WriteByte(&buf, svc_disconnect);
542 count = NET_SendToAll(&buf, 5);
544 Con_Printf("Host_ShutdownServer: NET_SendToAll failed for %u clients\n", count);
546 for (i=0, host_client = svs.clients ; i<svs.maxclients ; i++, host_client++)
547 if (host_client->active)
548 SV_DropClient(crash); // server shutdown
553 memset (&sv, 0, sizeof(sv));
554 memset (svs.clients, 0, svs.maxclients * sizeof(client_t));
562 This clears all the memory used by both the client and server, but does
563 not reinitialize anything.
566 void Host_ClearMemory (void)
568 Con_DPrintf ("Clearing memory\n");
572 memset (&sv, 0, sizeof(sv));
573 memset (&cl, 0, sizeof(cl));
577 //============================================================================
583 Returns false if the time is too short to run a frame
586 extern cvar_t cl_avidemo;
587 qboolean Host_FilterTime (double time)
592 if (slowmo.value < 0.0f)
593 Cvar_SetValue("slowmo", 0.0f);
594 if (host_minfps.value < 10.0f)
595 Cvar_SetValue("host_minfps", 10.0f);
596 if (host_maxfps.value < host_minfps.value)
597 Cvar_SetValue("host_maxfps", host_minfps.value);
598 if (cl_avidemo.value < 0.1f && cl_avidemo.value != 0.0f)
599 Cvar_SetValue("cl_avidemo", 0.0f);
601 // check if framerate is too high
602 if (cl_avidemo.value >= 0.1f)
604 timecap = 1.0 / (double)cl_avidemo.value;
605 if ((realtime - oldrealtime) < timecap)
608 else if (!cls.timedemo)
610 // default to sys_ticrate (server framerate - presumably low) unless we're the active window and either connected to a server or playing a video
611 timecap = sys_ticrate.value;
612 if (vid_activewindow && (cls.state == ca_connected || cl_videoplaying))
613 timecap = 1.0 / host_maxfps.value;
615 if ((realtime - oldrealtime) < timecap)
619 // LordHavoc: copy into host_realframetime as well
620 host_realframetime = host_frametime = realtime - oldrealtime;
621 oldrealtime = realtime;
625 // disable time effects
626 cl.frametime = host_frametime;
630 if (host_framerate.value > 0)
631 host_frametime = host_framerate.value;
632 else if (cl_avidemo.value >= 0.1f)
633 host_frametime = (1.0 / cl_avidemo.value);
636 // don't allow really short frames
637 if (host_frametime > (1.0 / host_minfps.value))
638 host_frametime = (1.0 / host_minfps.value);
641 cl.frametime = host_frametime = bound(0, host_frametime * slowmo.value, 0.1f); // LordHavoc: the QC code relies on no less than 10fps
649 Host_GetConsoleCommands
651 Add them exactly as if they had been typed at the console
654 void Host_GetConsoleCommands (void)
660 cmd = Sys_ConsoleInput ();
674 void Host_ServerFrame (void)
676 static double frametimetotal = 0, lastservertime = 0;
677 frametimetotal += host_frametime;
678 // LordHavoc: cap server at sys_ticrate in listen games
679 if (cls.state != ca_dedicated && svs.maxclients > 1 && ((realtime - lastservertime) < sys_ticrate.value))
681 // run the world state
682 if (!sv.paused && (svs.maxclients > 1 || (key_dest == key_game && !key_consoleactive)))
683 sv.frametime = pr_global_struct->frametime = frametimetotal;
687 lastservertime = realtime;
689 // set the time and clear the general datagram
692 // check for new clients
693 SV_CheckForNewClients ();
695 // read client messages
698 // move things around and think
699 // always pause in single player if in console or menus
703 // send all messages to the clients
704 SV_SendClientMessages ();
706 // send an heartbeat if enough time has passed since the last one
715 Runs all active servers
718 void _Host_Frame (float time)
720 static double time1 = 0;
721 static double time2 = 0;
722 static double time3 = 0;
723 int pass1, pass2, pass3;
725 if (setjmp (host_abortserver) )
726 return; // something bad happened, or the server disconnected
728 // keep the random time dependent
731 // decide the simulation time
732 if (!Host_FilterTime (time))
734 // if time was rejected, don't totally hog the CPU
739 // get new key events
740 Sys_SendKeyEvents ();
742 // allow mice or other external controllers to add commands
745 // process console commands
748 // LordHavoc: map and load are delayed until video is initialized
749 Host_PerformSpawnServerAndLoadGame();
753 // if running the server locally, make intentions now
757 //-------------------
761 //-------------------
763 // check for commands typed to the host
764 Host_GetConsoleCommands ();
769 //-------------------
773 //-------------------
775 // if running the server remotely, send intentions now after
776 // the incoming messages have been read
780 // fetch results from server
781 if (cls.state == ca_connected)
782 CL_ReadFromServer ();
789 if (host_speeds.integer)
790 time1 = Sys_DoubleTime ();
794 if (host_speeds.integer)
795 time2 = Sys_DoubleTime ();
798 if (cls.signon == SIGNONS)
800 // LordHavoc: this used to use renderer variables (eww)
801 vec3_t forward, right, up;
802 AngleVectors(cl.viewangles, forward, right, up);
803 S_Update (cl_entities[cl.viewentity].render.origin, forward, right, up);
806 S_Update (vec3_origin, vec3_origin, vec3_origin, vec3_origin);
810 if (host_speeds.integer)
812 pass1 = (time1 - time3)*1000000;
813 time3 = Sys_DoubleTime ();
814 pass2 = (time2 - time1)*1000000;
815 pass3 = (time3 - time2)*1000000;
816 Con_Printf ("%6ius total %6ius server %6ius gfx %6ius snd\n",
817 pass1+pass2+pass3, pass1, pass2, pass3);
821 host_loopactive = true;
824 void Host_Frame (float time)
827 static double timetotal;
828 static int timecount;
831 if (!serverprofile.integer)
837 time1 = Sys_DoubleTime ();
839 time2 = Sys_DoubleTime ();
841 timetotal += time2 - time1;
844 if (timecount < 1000)
847 m = timetotal*1000/timecount;
851 for (i=0 ; i<svs.maxclients ; i++)
853 if (svs.clients[i].active)
857 Con_Printf ("serverprofile: %2i clients %2i msec\n", c, m);
860 //============================================================================
862 void Render_Init(void);
869 void Host_Init (void)
871 // LordHavoc: quake never seeded the random number generator before... heh
874 // FIXME: this is evil, but possibly temporary
875 if (COM_CheckParm("-developer"))
877 forcedeveloper = true;
878 developer.integer = 1;
883 Memory_Init_Commands();
889 W_LoadWadFile ("gfx.wad");
899 Con_Printf ("Builddate: %s\n", buildstring);
901 if (cls.state != ca_dedicated)
913 Cbuf_InsertText ("exec quake.rc\n");
919 host_initialized = true;
921 Con_Printf ("========Quake Initialized=========\n");
923 if (cls.state != ca_dedicated)
932 FIXME: this is a callback from Sys_Quit and Sys_Error. It would be better
933 to run quit through here before the final handoff to the sys code.
936 void Host_Shutdown(void)
938 static qboolean isdown = false;
942 Con_Printf ("recursive shutdown\n");
947 Host_WriteConfiguration ();
953 if (cls.state != ca_dedicated)
955 R_Modules_Shutdown();