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 qboolean host_initialized; // true if into command execution
38 qboolean host_loopactive = false; // LordHavoc: used to turn Host_Error into Sys_Error if starting up or shutting down
39 qboolean host_shuttingdown = false; // LordHavoc: set when quit is executed
41 double host_frametime;
42 double host_realframetime; // LordHavoc: the real frametime, before slowmo and clamping are applied (used for console scrolling)
43 double realtime; // without any filtering or bounding
44 double oldrealtime; // last frame run
47 int forcedeveloper; // used for -developer commandline parameter, hacky hacky
49 client_t *host_client; // current client
51 jmp_buf host_abortserver;
53 cvar_t host_framerate = {0, "host_framerate","0"}; // set for slow motion
54 cvar_t host_speeds = {0, "host_speeds","0"}; // set for running times
55 cvar_t slowmo = {0, "slowmo", "1.0"}; // LordHavoc: framerate independent slowmo
56 cvar_t host_minfps = {CVAR_SAVE, "host_minfps", "10"}; // LordHavoc: game logic lower cap on framerate (if framerate is below this is, it pretends it is this, so game logic will run normally)
57 cvar_t host_maxfps = {CVAR_SAVE, "host_maxfps", "1000"}; // LordHavoc: framerate upper cap
59 cvar_t sys_ticrate = {CVAR_SAVE, "sys_ticrate","0.05"};
60 cvar_t serverprofile = {0, "serverprofile","0"};
62 cvar_t fraglimit = {CVAR_NOTIFY, "fraglimit","0"};
63 cvar_t timelimit = {CVAR_NOTIFY, "timelimit","0"};
64 cvar_t teamplay = {CVAR_NOTIFY, "teamplay","0"};
66 cvar_t samelevel = {0, "samelevel","0"};
67 cvar_t noexit = {CVAR_NOTIFY, "noexit","0"};
69 cvar_t developer = {0, "developer","0"};
71 cvar_t skill = {0, "skill","1"}; // 0 - 3
72 cvar_t deathmatch = {0, "deathmatch","0"}; // 0, 1, or 2
73 cvar_t coop = {0, "coop","0"}; // 0 or 1
75 cvar_t pausable = {0, "pausable","1"};
77 cvar_t temp1 = {0, "temp1","0"};
79 cvar_t timestamps = {CVAR_SAVE, "timestamps", "0"};
80 cvar_t timeformat = {CVAR_SAVE, "timeformat", "[%b %e %X] "};
87 void Host_EndGame (char *message, ...)
92 va_start (argptr,message);
93 vsprintf (string,message,argptr);
95 Con_DPrintf ("Host_EndGame: %s\n",string);
98 Host_ShutdownServer (false);
100 if (cls.state == ca_dedicated)
101 Sys_Error ("Host_EndGame: %s\n",string); // dedicated servers exit
103 if (cls.demonum != -1)
108 longjmp (host_abortserver, 1);
115 This shuts down both the client and server
118 char hosterrorstring[4096];
119 void Host_Error (char *error, ...)
122 static qboolean inerror = false;
124 // LordHavoc: if first frame has not been shown, or currently shutting
125 // down, do Sys_Error instead
126 if (!host_loopactive || host_shuttingdown)
129 va_start (argptr,error);
130 vsprintf (string,error,argptr);
132 Sys_Error ("%s", string);
138 va_start (argptr,error);
139 vsprintf (string,error,argptr);
141 Sys_Error ("Host_Error: recursively entered (original error was: %s new error is: %s)", hosterrorstring, string);
145 va_start (argptr,error);
146 vsprintf (hosterrorstring,error,argptr);
148 Con_Printf ("Host_Error: %s\n",hosterrorstring);
151 Host_ShutdownServer (false);
153 if (cls.state == ca_dedicated)
154 Sys_Error ("Host_Error: %s\n",hosterrorstring); // dedicated servers exit
161 longjmp (host_abortserver, 1);
164 static mempool_t *clients_mempool;
171 void Host_FindMaxClients (void)
177 i = COM_CheckParm ("-dedicated");
180 cls.state = ca_dedicated;
181 if (i != (com_argc - 1))
183 svs.maxclients = atoi (com_argv[i+1]);
189 cls.state = ca_disconnected;
191 i = COM_CheckParm ("-listen");
194 if (cls.state == ca_dedicated)
195 Sys_Error ("Only one of -dedicated or -listen can be specified");
196 if (i != (com_argc - 1))
197 svs.maxclients = atoi (com_argv[i+1]);
202 // Transfusion doesn't support single player games
203 if (gamemode == GAME_TRANSFUSION && svs.maxclients < 4)
206 if (svs.maxclients < 1)
208 else if (svs.maxclients > MAX_SCOREBOARD)
209 svs.maxclients = MAX_SCOREBOARD;
211 svs.maxclientslimit = svs.maxclients;
212 if (svs.maxclientslimit < MAX_SCOREBOARD) // LordHavoc: upped listen mode limit from 4 to MAX_SCOREBOARD
213 svs.maxclientslimit = MAX_SCOREBOARD;
214 if (!clients_mempool)
215 clients_mempool = Mem_AllocPool("clients");
217 Mem_Free(svs.clients);
218 svs.clients = Mem_Alloc(clients_mempool, svs.maxclientslimit*sizeof(client_t));
220 if (svs.maxclients > 1)
221 Cvar_SetValue ("deathmatch", 1.0);
223 Cvar_SetValue ("deathmatch", 0.0);
228 =======================
230 ======================
232 void Host_InitLocal (void)
234 Host_InitCommands ();
236 Cvar_RegisterVariable (&host_framerate);
237 Cvar_RegisterVariable (&host_speeds);
238 Cvar_RegisterVariable (&slowmo);
239 Cvar_RegisterVariable (&host_minfps);
240 Cvar_RegisterVariable (&host_maxfps);
242 Cvar_RegisterVariable (&sys_ticrate);
243 Cvar_RegisterVariable (&serverprofile);
245 Cvar_RegisterVariable (&fraglimit);
246 Cvar_RegisterVariable (&timelimit);
247 Cvar_RegisterVariable (&teamplay);
248 Cvar_RegisterVariable (&samelevel);
249 Cvar_RegisterVariable (&noexit);
250 Cvar_RegisterVariable (&skill);
251 Cvar_RegisterVariable (&developer);
252 if (forcedeveloper) // make it real now that the cvar is registered
253 Cvar_SetValue("developer", 1);
254 Cvar_RegisterVariable (&deathmatch);
255 Cvar_RegisterVariable (&coop);
257 Cvar_RegisterVariable (&pausable);
259 Cvar_RegisterVariable (&temp1);
261 Cvar_RegisterVariable (×tamps);
262 Cvar_RegisterVariable (&timeformat);
264 Host_FindMaxClients ();
270 Host_WriteConfiguration
272 Writes key bindings and archived cvars to config.cfg
275 void Host_WriteConfiguration (void)
279 // dedicated servers initialize the host but don't parse and set the
281 if (host_initialized && cls.state != ca_dedicated)
283 f = Qopen (va("%s/config.cfg",com_gamedir), "w");
286 Con_Printf ("Couldn't write config.cfg.\n");
290 Key_WriteBindings (f);
291 Cvar_WriteVariables (f);
302 Sends text across to be displayed
303 FIXME: make this just a stuffed echo?
306 void SV_ClientPrintf (char *fmt, ...)
311 va_start (argptr,fmt);
312 vsprintf (string, fmt,argptr);
315 MSG_WriteByte (&host_client->message, svc_print);
316 MSG_WriteString (&host_client->message, string);
323 Sends text to all active clients
326 void SV_BroadcastPrintf (char *fmt, ...)
332 va_start (argptr,fmt);
333 vsprintf (string, fmt,argptr);
336 for (i=0 ; i<svs.maxclients ; i++)
337 if (svs.clients[i].active && svs.clients[i].spawned)
339 MSG_WriteByte (&svs.clients[i].message, svc_print);
340 MSG_WriteString (&svs.clients[i].message, string);
348 Send text over to the client to be executed
351 void Host_ClientCommands (char *fmt, ...)
356 va_start (argptr,fmt);
357 vsprintf (string, fmt,argptr);
360 MSG_WriteByte (&host_client->message, svc_stufftext);
361 MSG_WriteString (&host_client->message, string);
365 =====================
368 Called when the player is getting totally kicked off the host
369 if (crash = true), don't bother sending signofs
370 =====================
372 void SV_DropClient (qboolean crash)
380 // send any final messages (don't check for errors)
381 if (NET_CanSendMessage (host_client->netconnection))
383 MSG_WriteByte (&host_client->message, svc_disconnect);
384 NET_SendMessage (host_client->netconnection, &host_client->message);
387 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)
389 // call the prog function for removing a client
390 // this will set the body to a dead frame, among other things
391 saveSelf = pr_global_struct->self;
392 pr_global_struct->self = EDICT_TO_PROG(host_client->edict);
393 PR_ExecuteProgram (pr_global_struct->ClientDisconnect, "QC function ClientDisconnect is missing");
394 pr_global_struct->self = saveSelf;
397 Sys_Printf ("Client %s removed\n",host_client->name);
400 // break the net connection
401 NET_Close (host_client->netconnection);
402 host_client->netconnection = NULL;
404 // free the client (the body stays around)
405 host_client->active = false;
406 host_client->name[0] = 0;
407 host_client->old_frags = -999999;
408 net_activeconnections--;
410 // send notification to all clients
411 for (i=0, client = svs.clients ; i<svs.maxclients ; i++, client++)
415 MSG_WriteByte (&client->message, svc_updatename);
416 MSG_WriteByte (&client->message, host_client - svs.clients);
417 MSG_WriteString (&client->message, "");
418 MSG_WriteByte (&client->message, svc_updatefrags);
419 MSG_WriteByte (&client->message, host_client - svs.clients);
420 MSG_WriteShort (&client->message, 0);
421 MSG_WriteByte (&client->message, svc_updatecolors);
422 MSG_WriteByte (&client->message, host_client - svs.clients);
423 MSG_WriteByte (&client->message, 0);
431 This only happens at the end of a game, not between levels
434 void Host_ShutdownServer(qboolean crash)
447 // stop all client sounds immediately
450 // flush any pending messages - like the score!!!
451 start = Sys_DoubleTime();
455 for (i=0, host_client = svs.clients ; i<svs.maxclients ; i++, host_client++)
457 if (host_client->active && host_client->message.cursize)
459 if (NET_CanSendMessage (host_client->netconnection))
461 NET_SendMessage(host_client->netconnection, &host_client->message);
462 SZ_Clear (&host_client->message);
466 NET_GetMessage(host_client->netconnection);
471 if ((Sys_DoubleTime() - start) > 3.0)
476 // make sure all the clients know we're disconnecting
480 MSG_WriteByte(&buf, svc_disconnect);
481 count = NET_SendToAll(&buf, 5);
483 Con_Printf("Host_ShutdownServer: NET_SendToAll failed for %u clients\n", count);
485 for (i=0, host_client = svs.clients ; i<svs.maxclients ; i++, host_client++)
486 if (host_client->active)
487 SV_DropClient(crash);
492 memset (&sv, 0, sizeof(sv));
493 memset (svs.clients, 0, svs.maxclientslimit*sizeof(client_t));
501 This clears all the memory used by both the client and server, but does
502 not reinitialize anything.
505 void Host_ClearMemory (void)
507 Con_DPrintf ("Clearing memory\n");
511 memset (&sv, 0, sizeof(sv));
512 memset (&cl, 0, sizeof(cl));
516 //============================================================================
522 Returns false if the time is too short to run a frame
525 extern cvar_t cl_avidemo;
526 qboolean Host_FilterTime (double time)
531 if (slowmo.value < 0.0f)
532 Cvar_SetValue("slowmo", 0.0f);
533 if (host_minfps.value < 10.0f)
534 Cvar_SetValue("host_minfps", 10.0f);
535 if (host_maxfps.value < host_minfps.value)
536 Cvar_SetValue("host_maxfps", host_minfps.value);
537 if (cl_avidemo.value < 0.1f && cl_avidemo.value != 0.0f)
538 Cvar_SetValue("cl_avidemo", 0.0f);
540 // check if framerate is too high
541 if (cl_avidemo.value >= 0.1f)
543 timecap = 1.0 / (double)cl_avidemo.value;
544 if ((realtime - oldrealtime) < timecap)
547 else if (!cls.timedemo)
549 // default to sys_ticrate (server framerate - presumably low) unless we're the active window and either connected to a server or playing a video
550 timecap = sys_ticrate.value;
551 if (vid_activewindow && (cls.state == ca_connected || cl_videoplaying))
552 timecap = 1.0 / host_maxfps.value;
554 if ((realtime - oldrealtime) < timecap)
558 // LordHavoc: copy into host_realframetime as well
559 host_realframetime = host_frametime = realtime - oldrealtime;
560 oldrealtime = realtime;
564 // disable time effects
565 cl.frametime = host_frametime;
569 if (host_framerate.value > 0)
570 host_frametime = host_framerate.value;
571 else if (cl_avidemo.value >= 0.1f)
572 host_frametime = (1.0 / cl_avidemo.value);
575 // don't allow really short frames
576 if (host_frametime > (1.0 / host_minfps.value))
577 host_frametime = (1.0 / host_minfps.value);
580 cl.frametime = host_frametime = bound(0, host_frametime * slowmo.value, 0.1f); // LordHavoc: the QC code relies on no less than 10fps
588 Host_GetConsoleCommands
590 Add them exactly as if they had been typed at the console
593 void Host_GetConsoleCommands (void)
599 cmd = Sys_ConsoleInput ();
613 void Host_ServerFrame (void)
615 static double frametimetotal = 0, lastservertime = 0;
616 frametimetotal += host_frametime;
617 // LordHavoc: cap server at sys_ticrate in listen games
618 if (cls.state != ca_dedicated && svs.maxclients > 1 && ((realtime - lastservertime) < sys_ticrate.value))
620 // run the world state
621 if (!sv.paused && (svs.maxclients > 1 || key_dest == key_game) )
622 sv.frametime = pr_global_struct->frametime = frametimetotal;
626 lastservertime = realtime;
628 // set the time and clear the general datagram
631 // check for new clients
632 SV_CheckForNewClients ();
634 // read client messages
637 // move things around and think
638 // always pause in single player if in console or menus
639 if (!sv.paused && (svs.maxclients > 1 || key_dest == key_game) )
642 // send all messages to the clients
643 SV_SendClientMessages ();
651 Runs all active servers
654 void _Host_Frame (float time)
656 static double time1 = 0;
657 static double time2 = 0;
658 static double time3 = 0;
659 int pass1, pass2, pass3;
661 if (setjmp (host_abortserver) )
662 return; // something bad happened, or the server disconnected
664 // keep the random time dependent
667 // decide the simulation time
668 if (!Host_FilterTime (time))
670 // if time was rejected, don't totally hog the CPU
675 // get new key events
676 Sys_SendKeyEvents ();
678 // allow mice or other external controllers to add commands
681 // process console commands
686 // if running the server locally, make intentions now
690 //-------------------
694 //-------------------
696 // check for commands typed to the host
697 Host_GetConsoleCommands ();
702 //-------------------
706 //-------------------
708 // if running the server remotely, send intentions now after
709 // the incoming messages have been read
713 // fetch results from server
714 if (cls.state == ca_connected)
715 CL_ReadFromServer ();
722 if (host_speeds.integer)
723 time1 = Sys_DoubleTime ();
727 if (host_speeds.integer)
728 time2 = Sys_DoubleTime ();
731 if (cls.signon == SIGNONS)
733 // LordHavoc: this used to use renderer variables (eww)
734 vec3_t forward, right, up;
735 AngleVectors(cl.viewangles, forward, right, up);
736 S_Update (cl_entities[cl.viewentity].render.origin, forward, right, up);
739 S_Update (vec3_origin, vec3_origin, vec3_origin, vec3_origin);
743 if (host_speeds.integer)
745 pass1 = (time1 - time3)*1000000;
746 time3 = Sys_DoubleTime ();
747 pass2 = (time2 - time1)*1000000;
748 pass3 = (time3 - time2)*1000000;
749 Con_Printf ("%6ius total %6ius server %6ius gfx %6ius snd\n",
750 pass1+pass2+pass3, pass1, pass2, pass3);
754 host_loopactive = true;
757 void Host_Frame (float time)
760 static double timetotal;
761 static int timecount;
764 if (!serverprofile.integer)
770 time1 = Sys_DoubleTime ();
772 time2 = Sys_DoubleTime ();
774 timetotal += time2 - time1;
777 if (timecount < 1000)
780 m = timetotal*1000/timecount;
784 for (i=0 ; i<svs.maxclients ; i++)
786 if (svs.clients[i].active)
790 Con_Printf ("serverprofile: %2i clients %2i msec\n", c, m);
793 //============================================================================
795 void Render_Init(void);
796 void QuakeIO_Init(void);
803 void Host_Init (void)
805 // LordHavoc: quake never seeded the random number generator before... heh
808 // FIXME: this is evil, but possibly temporary
809 if (COM_CheckParm("-developer"))
811 forcedeveloper = true;
812 developer.integer = 1;
817 Memory_Init_Commands();
824 W_LoadWadFile ("gfx.wad");
834 Con_Printf ("Builddate: %s\n", buildstring);
836 if (cls.state != ca_dedicated)
844 #ifndef _WIN32 // on non win32, mouse comes before video for security reasons
854 #ifdef _WIN32 // on non win32, mouse comes before video for security reasons
859 Cbuf_InsertText ("exec quake.rc\n");
861 host_initialized = true;
863 Sys_Printf ("========Quake Initialized=========\n");
871 FIXME: this is a callback from Sys_Quit and Sys_Error. It would be better
872 to run quit through here before the final handoff to the sys code.
875 void Host_Shutdown(void)
877 static qboolean isdown = false;
881 printf ("recursive shutdown\n");
886 Host_WriteConfiguration ();
893 if (cls.state != ca_dedicated)
895 R_Modules_Shutdown();