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
180 longjmp (host_abortserver, 1);
183 void Host_ServerOptions (void)
189 // client exists, check what mode the user wants
190 i = COM_CheckParm ("-dedicated");
193 cls.state = ca_dedicated;
195 if (i != (com_argc - 1))
196 numplayers = atoi (com_argv[i+1]);
197 if (COM_CheckParm ("-listen"))
198 Sys_Error ("Only one of -dedicated or -listen can be specified");
203 cls.state = ca_disconnected;
204 i = COM_CheckParm ("-listen");
208 if (i != (com_argc - 1))
209 numplayers = atoi (com_argv[i+1]);
215 // no client in the executable, start dedicated server
216 if (COM_CheckParm ("-listen"))
217 Sys_Error ("-listen not available in a dedicated server executable");
219 cls.state = ca_dedicated;
220 // check for -dedicated specifying how many players
221 i = COM_CheckParm ("-dedicated");
222 if (i && i != (com_argc - 1))
223 numplayers = atoi (com_argv[i+1]);
228 if (numplayers > MAX_SCOREBOARD)
229 numplayers = MAX_SCOREBOARD;
231 // Transfusion doesn't support single player games
232 if (gamemode == GAME_TRANSFUSION && numplayers < 4)
236 Cvar_SetValueQuick (&deathmatch, 1);
238 Cvar_SetValueQuick (&deathmatch, 0);
241 SV_SetMaxClients(numplayers);
244 static mempool_t *clients_mempool;
245 void SV_SetMaxClients(int n)
249 n = bound(1, n, MAX_SCOREBOARD);
250 if (svs.maxclients == n)
253 if (!clients_mempool)
254 clients_mempool = Mem_AllocPool("clients");
256 Mem_Free(svs.clients);
257 svs.clients = Mem_Alloc(clients_mempool, svs.maxclients*sizeof(client_t));
262 =======================
264 ======================
266 void Host_InitLocal (void)
268 Host_InitCommands ();
270 Cvar_RegisterVariable (&host_framerate);
271 Cvar_RegisterVariable (&host_speeds);
272 Cvar_RegisterVariable (&slowmo);
273 Cvar_RegisterVariable (&host_minfps);
274 Cvar_RegisterVariable (&host_maxfps);
276 Cvar_RegisterVariable (&sv_echobprint);
278 Cvar_RegisterVariable (&sys_ticrate);
279 Cvar_RegisterVariable (&serverprofile);
281 Cvar_RegisterVariable (&fraglimit);
282 Cvar_RegisterVariable (&timelimit);
283 Cvar_RegisterVariable (&teamplay);
284 Cvar_RegisterVariable (&samelevel);
285 Cvar_RegisterVariable (&noexit);
286 Cvar_RegisterVariable (&skill);
287 Cvar_RegisterVariable (&developer);
288 if (forcedeveloper) // make it real now that the cvar is registered
289 Cvar_SetValue("developer", 1);
290 Cvar_RegisterVariable (&deathmatch);
291 Cvar_RegisterVariable (&coop);
293 Cvar_RegisterVariable (&pausable);
295 Cvar_RegisterVariable (&temp1);
297 Cvar_RegisterVariable (×tamps);
298 Cvar_RegisterVariable (&timeformat);
300 Host_ServerOptions ();
306 Host_WriteConfiguration
308 Writes key bindings and archived cvars to config.cfg
311 void Host_WriteConfiguration (void)
315 // dedicated servers initialize the host but don't parse and set the
317 if (host_initialized && cls.state != ca_dedicated)
319 f = FS_Open ("config.cfg", "w", false);
322 Con_Printf ("Couldn't write config.cfg.\n");
326 Key_WriteBindings (f);
327 Cvar_WriteVariables (f);
338 Sends text across to be displayed
339 FIXME: make this just a stuffed echo?
342 void SV_ClientPrintf(const char *fmt, ...)
347 va_start (argptr,fmt);
348 vsprintf (string, fmt,argptr);
351 MSG_WriteByte (&host_client->message, svc_print);
352 MSG_WriteString (&host_client->message, string);
359 Sends text to all active clients
362 void SV_BroadcastPrintf(const char *fmt, ...)
368 va_start(argptr,fmt);
369 vsprintf(string, fmt,argptr);
372 for (i=0 ; i<svs.maxclients ; i++)
373 if (svs.clients[i].active && svs.clients[i].spawned)
375 MSG_WriteByte(&svs.clients[i].message, svc_print);
376 MSG_WriteString(&svs.clients[i].message, string);
379 if (sv_echobprint.integer && cls.state == ca_dedicated)
380 Sys_Printf("%s", string);
387 Send text over to the client to be executed
390 void Host_ClientCommands(const char *fmt, ...)
395 va_start(argptr,fmt);
396 vsprintf(string, fmt,argptr);
399 MSG_WriteByte(&host_client->message, svc_stufftext);
400 MSG_WriteString(&host_client->message, string);
404 =====================
407 Called when the player is getting totally kicked off the host
408 if (crash = true), don't bother sending signofs
409 =====================
411 void SV_DropClient(qboolean crash)
417 Con_Printf("Client \"%s\" dropped\n", host_client->name);
419 // send any final messages (don't check for errors)
420 if (host_client->netconnection)
422 // free the client (the body stays around)
423 host_client->active = false;
427 // LordHavoc: no opportunity for resending, so use unreliable
428 MSG_WriteByte(&host_client->message, svc_disconnect);
429 NetConn_SendUnreliableMessage(host_client->netconnection, &host_client->message);
432 // break the net connection
433 NetConn_Close(host_client->netconnection);
434 host_client->netconnection = NULL;
436 // LordHavoc: don't call QC if server is dead (avoids recursive
437 // Host_Error in some mods when they run out of edicts)
438 if (sv.active && host_client->edict && host_client->spawned)
440 // call the prog function for removing a client
441 // this will set the body to a dead frame, among other things
442 saveSelf = pr_global_struct->self;
443 pr_global_struct->self = EDICT_TO_PROG(host_client->edict);
444 PR_ExecuteProgram(pr_global_struct->ClientDisconnect, "QC function ClientDisconnect is missing");
445 pr_global_struct->self = saveSelf;
449 // now clear name (after ClientDisconnect was called)
450 host_client->name[0] = 0;
451 host_client->old_frags = -999999;
453 // send notification to all clients
454 for (i = 0, client = svs.clients;i < svs.maxclients;i++, client++)
458 MSG_WriteByte(&client->message, svc_updatename);
459 MSG_WriteByte(&client->message, host_client - svs.clients);
460 MSG_WriteString(&client->message, "");
461 MSG_WriteByte(&client->message, svc_updatefrags);
462 MSG_WriteByte(&client->message, host_client - svs.clients);
463 MSG_WriteShort(&client->message, 0);
464 MSG_WriteByte(&client->message, svc_updatecolors);
465 MSG_WriteByte(&client->message, host_client - svs.clients);
466 MSG_WriteByte(&client->message, 0);
469 NetConn_Heartbeat(1);
476 This only happens at the end of a game, not between levels
479 void Host_ShutdownServer(qboolean crash)
489 // print out where the crash happened, if it was caused by QC
494 // stop all client sounds immediately
497 NetConn_Heartbeat(2);
498 NetConn_Heartbeat(2);
500 // flush any pending messages - like the score!!!
501 start = Sys_DoubleTime();
505 NetConn_ClientFrame();
506 NetConn_ServerFrame();
507 for (i=0, host_client = svs.clients ; i<svs.maxclients ; i++, host_client++)
509 if (host_client->active && host_client->message.cursize)
511 if (NetConn_CanSendMessage(host_client->netconnection))
513 NetConn_SendReliableMessage(host_client->netconnection, &host_client->message);
514 SZ_Clear(&host_client->message);
520 if ((Sys_DoubleTime() - start) > 3.0)
525 // make sure all the clients know we're disconnecting
529 MSG_WriteByte(&buf, svc_disconnect);
530 count = NetConn_SendToAll(&buf, 5);
532 Con_Printf("Host_ShutdownServer: NetConn_SendToAll failed for %u clients\n", count);
534 for (i=0, host_client = svs.clients ; i<svs.maxclients ; i++, host_client++)
535 if (host_client->active)
536 SV_DropClient(crash); // server shutdown
538 NetConn_CloseServerPorts();
543 memset(&sv, 0, sizeof(sv));
544 memset(svs.clients, 0, svs.maxclients * sizeof(client_t));
552 This clears all the memory used by both the client and server, but does
553 not reinitialize anything.
556 void Host_ClearMemory (void)
558 Con_DPrintf ("Clearing memory\n");
562 memset (&sv, 0, sizeof(sv));
563 memset (&cl, 0, sizeof(cl));
567 //============================================================================
573 Returns false if the time is too short to run a frame
576 extern cvar_t cl_avidemo;
577 qboolean Host_FilterTime (double time)
582 if (slowmo.value < 0.0f)
583 Cvar_SetValue("slowmo", 0.0f);
584 if (host_minfps.value < 10.0f)
585 Cvar_SetValue("host_minfps", 10.0f);
586 if (host_maxfps.value < host_minfps.value)
587 Cvar_SetValue("host_maxfps", host_minfps.value);
588 if (cl_avidemo.value < 0.1f && cl_avidemo.value != 0.0f)
589 Cvar_SetValue("cl_avidemo", 0.0f);
591 // check if framerate is too high
592 if (cl_avidemo.value >= 0.1f)
594 timecap = 1.0 / (double)cl_avidemo.value;
595 if ((realtime - oldrealtime) < timecap)
598 else if (!cls.timedemo)
600 // default to sys_ticrate (server framerate - presumably low) unless we're the active window and either connected to a server or playing a video
601 timecap = sys_ticrate.value;
602 if (vid_activewindow && (cls.state == ca_connected || cl_videoplaying))
603 timecap = 1.0 / host_maxfps.value;
605 if ((realtime - oldrealtime) < timecap)
609 // LordHavoc: copy into host_realframetime as well
610 host_realframetime = host_frametime = realtime - oldrealtime;
611 oldrealtime = realtime;
615 // disable time effects
616 cl.frametime = host_frametime;
620 if (host_framerate.value > 0)
621 host_frametime = host_framerate.value;
622 else if (cl_avidemo.value >= 0.1f)
623 host_frametime = (1.0 / cl_avidemo.value);
626 // don't allow really short frames
627 if (host_frametime > (1.0 / host_minfps.value))
628 host_frametime = (1.0 / host_minfps.value);
631 cl.frametime = host_frametime = bound(0, host_frametime * slowmo.value, 0.1f); // LordHavoc: the QC code relies on no less than 10fps
639 Host_GetConsoleCommands
641 Add them exactly as if they had been typed at the console
644 void Host_GetConsoleCommands (void)
650 cmd = Sys_ConsoleInput ();
664 void Host_ServerFrame (void)
666 static double frametimetotal = 0, lastservertime = 0;
667 frametimetotal += host_frametime;
668 // LordHavoc: cap server at sys_ticrate in listen games
669 if (cls.state != ca_dedicated && svs.maxclients > 1 && ((realtime - lastservertime) < sys_ticrate.value))
672 NetConn_ServerFrame();
674 // run the world state
675 if (!sv.paused && (svs.maxclients > 1 || (key_dest == key_game && !key_consoleactive)))
676 sv.frametime = pr_global_struct->frametime = frametimetotal;
680 lastservertime = realtime;
682 // set the time and clear the general datagram
685 // read client messages
688 // move things around and think
689 // always pause in single player if in console or menus
693 // send all messages to the clients
694 SV_SendClientMessages();
696 // send an heartbeat if enough time has passed since the last one
697 NetConn_Heartbeat(0);
705 Runs all active servers
708 void _Host_Frame (float time)
710 static double time1 = 0;
711 static double time2 = 0;
712 static double time3 = 0;
713 int pass1, pass2, pass3;
715 if (setjmp(host_abortserver))
716 return; // something bad happened, or the server disconnected
718 // keep the random time dependent
721 // decide the simulation time
722 if (!Host_FilterTime(time))
724 // if time was rejected, don't totally hog the CPU
729 // get new key events
732 // allow mice or other external controllers to add commands
735 // process console commands
738 // LordHavoc: map and load are delayed until video is initialized
739 Host_PerformSpawnServerAndLoadGame();
741 // if running the server locally, make intentions now
742 if (cls.state == ca_connected && sv.active)
745 //-------------------
749 //-------------------
751 // check for commands typed to the host
752 Host_GetConsoleCommands();
757 //-------------------
761 //-------------------
763 cl.oldtime = cl.time;
764 cl.time += cl.frametime;
766 NetConn_ClientFrame();
768 if (cls.state == ca_connected)
770 // if running the server remotely, send intentions now after
771 // the incoming messages have been read
782 if (host_speeds.integer)
783 time1 = Sys_DoubleTime();
787 if (host_speeds.integer)
788 time2 = Sys_DoubleTime();
791 if (cls.signon == SIGNONS)
793 // LordHavoc: this used to use renderer variables (eww)
794 vec3_t forward, right, up;
795 AngleVectors(cl.viewangles, forward, right, up);
796 S_Update(cl_entities[cl.viewentity].render.origin, forward, right, up);
799 S_Update(vec3_origin, vec3_origin, vec3_origin, vec3_origin);
803 if (host_speeds.integer)
805 pass1 = (time1 - time3)*1000000;
806 time3 = Sys_DoubleTime();
807 pass2 = (time2 - time1)*1000000;
808 pass3 = (time3 - time2)*1000000;
809 Con_Printf("%6ius total %6ius server %6ius gfx %6ius snd\n",
810 pass1+pass2+pass3, pass1, pass2, pass3);
814 host_loopactive = true;
817 void Host_Frame (float time)
820 static double timetotal;
821 static int timecount;
824 if (!serverprofile.integer)
830 time1 = Sys_DoubleTime ();
832 time2 = Sys_DoubleTime ();
834 timetotal += time2 - time1;
837 if (timecount < 1000)
840 m = timetotal*1000/timecount;
844 for (i=0 ; i<svs.maxclients ; i++)
846 if (svs.clients[i].active)
850 Con_Printf ("serverprofile: %2i clients %2i msec\n", c, m);
853 //============================================================================
855 void Render_Init(void);
862 void Host_Init (void)
864 // LordHavoc: quake never seeded the random number generator before... heh
867 // FIXME: this is evil, but possibly temporary
868 if (COM_CheckParm("-developer"))
870 forcedeveloper = true;
871 developer.integer = 1;
876 Memory_Init_Commands();
882 W_LoadWadFile("gfx.wad");
892 Con_Printf ("Builddate: %s\n", buildstring);
894 if (cls.state != ca_dedicated)
906 Cbuf_InsertText ("exec quake.rc\n");
912 host_initialized = true;
914 Con_DPrintf ("========Initialized=========\n");
916 if (cls.state != ca_dedicated)
925 FIXME: this is a callback from Sys_Quit and Sys_Error. It would be better
926 to run quit through here before the final handoff to the sys code.
929 void Host_Shutdown(void)
931 static qboolean isdown = false;
935 Con_Printf ("recursive shutdown\n");
940 Host_WriteConfiguration ();
946 if (cls.state != ca_dedicated)
948 R_Modules_Shutdown();