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 sv_echobprint = {CVAR_SAVE, "sv_echobprint", "1"}; // print broadcast messages in dedicated mode
61 cvar_t sys_ticrate = {CVAR_SAVE, "sys_ticrate","0.05"};
62 cvar_t serverprofile = {0, "serverprofile","0"};
64 cvar_t fraglimit = {CVAR_NOTIFY, "fraglimit","0"};
65 cvar_t timelimit = {CVAR_NOTIFY, "timelimit","0"};
66 cvar_t teamplay = {CVAR_NOTIFY, "teamplay","0"};
68 cvar_t samelevel = {0, "samelevel","0"};
69 cvar_t noexit = {CVAR_NOTIFY, "noexit","0"};
71 cvar_t developer = {0, "developer","0"};
73 cvar_t skill = {0, "skill","1"}; // 0 - 3
74 cvar_t deathmatch = {0, "deathmatch","0"}; // 0, 1, or 2
75 cvar_t coop = {0, "coop","0"}; // 0 or 1
77 cvar_t pausable = {0, "pausable","1"};
79 cvar_t temp1 = {0, "temp1","0"};
81 cvar_t timestamps = {CVAR_SAVE, "timestamps", "0"};
82 cvar_t timeformat = {CVAR_SAVE, "timeformat", "[%b %e %X] "};
89 void Host_EndGame (char *message, ...)
94 va_start (argptr,message);
95 vsprintf (string,message,argptr);
97 Con_DPrintf ("Host_EndGame: %s\n",string);
100 Host_ShutdownServer (false);
102 if (cls.state == ca_dedicated)
103 Sys_Error ("Host_EndGame: %s\n",string); // dedicated servers exit
105 if (cls.demonum != -1)
110 longjmp (host_abortserver, 1);
117 This shuts down both the client and server
120 char hosterrorstring[4096];
121 void Host_Error (char *error, ...)
124 static qboolean inerror = false;
126 // LordHavoc: if first frame has not been shown, or currently shutting
127 // down, do Sys_Error instead
128 if (!host_loopactive || host_shuttingdown)
131 va_start (argptr,error);
132 vsprintf (string,error,argptr);
134 Sys_Error ("%s", string);
140 va_start (argptr,error);
141 vsprintf (string,error,argptr);
143 Sys_Error ("Host_Error: recursively entered (original error was: %s new error is: %s)", hosterrorstring, string);
147 va_start (argptr,error);
148 vsprintf (hosterrorstring,error,argptr);
150 Con_Printf ("Host_Error: %s\n",hosterrorstring);
153 Host_ShutdownServer (false);
155 if (cls.state == ca_dedicated)
156 Sys_Error ("Host_Error: %s\n",hosterrorstring); // dedicated servers exit
163 longjmp (host_abortserver, 1);
166 static mempool_t *clients_mempool;
173 void Host_FindMaxClients (void)
179 i = COM_CheckParm ("-dedicated");
182 cls.state = ca_dedicated;
183 if (i != (com_argc - 1))
185 svs.maxclients = atoi (com_argv[i+1]);
191 cls.state = ca_disconnected;
193 i = COM_CheckParm ("-listen");
196 if (cls.state == ca_dedicated)
197 Sys_Error ("Only one of -dedicated or -listen can be specified");
198 if (i != (com_argc - 1))
199 svs.maxclients = atoi (com_argv[i+1]);
204 // Transfusion doesn't support single player games
205 if (gamemode == GAME_TRANSFUSION && svs.maxclients < 4)
208 if (svs.maxclients < 1)
210 else if (svs.maxclients > MAX_SCOREBOARD)
211 svs.maxclients = MAX_SCOREBOARD;
213 svs.maxclientslimit = svs.maxclients;
214 if (svs.maxclientslimit < MAX_SCOREBOARD) // LordHavoc: upped listen mode limit from 4 to MAX_SCOREBOARD
215 svs.maxclientslimit = MAX_SCOREBOARD;
216 if (!clients_mempool)
217 clients_mempool = Mem_AllocPool("clients");
219 Mem_Free(svs.clients);
220 svs.clients = Mem_Alloc(clients_mempool, svs.maxclientslimit*sizeof(client_t));
222 if (svs.maxclients > 1)
223 Cvar_SetValue ("deathmatch", 1.0);
225 Cvar_SetValue ("deathmatch", 0.0);
230 =======================
232 ======================
234 void Host_InitLocal (void)
236 Host_InitCommands ();
238 Cvar_RegisterVariable (&host_framerate);
239 Cvar_RegisterVariable (&host_speeds);
240 Cvar_RegisterVariable (&slowmo);
241 Cvar_RegisterVariable (&host_minfps);
242 Cvar_RegisterVariable (&host_maxfps);
244 Cvar_RegisterVariable (&sv_echobprint);
246 Cvar_RegisterVariable (&sys_ticrate);
247 Cvar_RegisterVariable (&serverprofile);
249 Cvar_RegisterVariable (&fraglimit);
250 Cvar_RegisterVariable (&timelimit);
251 Cvar_RegisterVariable (&teamplay);
252 Cvar_RegisterVariable (&samelevel);
253 Cvar_RegisterVariable (&noexit);
254 Cvar_RegisterVariable (&skill);
255 Cvar_RegisterVariable (&developer);
256 if (forcedeveloper) // make it real now that the cvar is registered
257 Cvar_SetValue("developer", 1);
258 Cvar_RegisterVariable (&deathmatch);
259 Cvar_RegisterVariable (&coop);
261 Cvar_RegisterVariable (&pausable);
263 Cvar_RegisterVariable (&temp1);
265 Cvar_RegisterVariable (×tamps);
266 Cvar_RegisterVariable (&timeformat);
268 Host_FindMaxClients ();
274 Host_WriteConfiguration
276 Writes key bindings and archived cvars to config.cfg
279 void Host_WriteConfiguration (void)
283 // dedicated servers initialize the host but don't parse and set the
285 if (host_initialized && cls.state != ca_dedicated)
287 f = Qopen (va("%s/config.cfg",com_gamedir), "w");
290 Con_Printf ("Couldn't write config.cfg.\n");
294 Key_WriteBindings (f);
295 Cvar_WriteVariables (f);
306 Sends text across to be displayed
307 FIXME: make this just a stuffed echo?
310 void SV_ClientPrintf (char *fmt, ...)
315 va_start (argptr,fmt);
316 vsprintf (string, fmt,argptr);
319 MSG_WriteByte (&host_client->message, svc_print);
320 MSG_WriteString (&host_client->message, string);
327 Sends text to all active clients
330 void SV_BroadcastPrintf (char *fmt, ...)
336 va_start (argptr,fmt);
337 vsprintf (string, fmt,argptr);
340 for (i=0 ; i<svs.maxclients ; i++)
341 if (svs.clients[i].active && svs.clients[i].spawned)
343 MSG_WriteByte (&svs.clients[i].message, svc_print);
344 MSG_WriteString (&svs.clients[i].message, string);
347 if (sv_echobprint.integer && cls.state == ca_dedicated)
348 Sys_Printf ("%s", string);
355 Send text over to the client to be executed
358 void Host_ClientCommands (char *fmt, ...)
363 va_start (argptr,fmt);
364 vsprintf (string, fmt,argptr);
367 MSG_WriteByte (&host_client->message, svc_stufftext);
368 MSG_WriteString (&host_client->message, string);
372 =====================
375 Called when the player is getting totally kicked off the host
376 if (crash = true), don't bother sending signofs
377 =====================
379 void SV_DropClient (qboolean crash)
387 // send any final messages (don't check for errors)
388 if (NET_CanSendMessage (host_client->netconnection))
390 MSG_WriteByte (&host_client->message, svc_disconnect);
391 NET_SendMessage (host_client->netconnection, &host_client->message);
394 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)
396 // call the prog function for removing a client
397 // this will set the body to a dead frame, among other things
398 saveSelf = pr_global_struct->self;
399 pr_global_struct->self = EDICT_TO_PROG(host_client->edict);
400 PR_ExecuteProgram (pr_global_struct->ClientDisconnect, "QC function ClientDisconnect is missing");
401 pr_global_struct->self = saveSelf;
404 Sys_Printf ("Client %s removed\n",host_client->name);
407 // break the net connection
408 NET_Close (host_client->netconnection);
409 host_client->netconnection = NULL;
411 // free the client (the body stays around)
412 host_client->active = false;
413 host_client->name[0] = 0;
414 host_client->old_frags = -999999;
415 net_activeconnections--;
417 // send notification to all clients
418 for (i=0, client = svs.clients ; i<svs.maxclients ; i++, client++)
422 MSG_WriteByte (&client->message, svc_updatename);
423 MSG_WriteByte (&client->message, host_client - svs.clients);
424 MSG_WriteString (&client->message, "");
425 MSG_WriteByte (&client->message, svc_updatefrags);
426 MSG_WriteByte (&client->message, host_client - svs.clients);
427 MSG_WriteShort (&client->message, 0);
428 MSG_WriteByte (&client->message, svc_updatecolors);
429 MSG_WriteByte (&client->message, host_client - svs.clients);
430 MSG_WriteByte (&client->message, 0);
438 This only happens at the end of a game, not between levels
441 void Host_ShutdownServer(qboolean crash)
454 // stop all client sounds immediately
457 // flush any pending messages - like the score!!!
458 start = Sys_DoubleTime();
462 for (i=0, host_client = svs.clients ; i<svs.maxclients ; i++, host_client++)
464 if (host_client->active && host_client->message.cursize)
466 if (NET_CanSendMessage (host_client->netconnection))
468 NET_SendMessage(host_client->netconnection, &host_client->message);
469 SZ_Clear (&host_client->message);
473 NET_GetMessage(host_client->netconnection);
478 if ((Sys_DoubleTime() - start) > 3.0)
483 // make sure all the clients know we're disconnecting
487 MSG_WriteByte(&buf, svc_disconnect);
488 count = NET_SendToAll(&buf, 5);
490 Con_Printf("Host_ShutdownServer: NET_SendToAll failed for %u clients\n", count);
492 for (i=0, host_client = svs.clients ; i<svs.maxclients ; i++, host_client++)
493 if (host_client->active)
494 SV_DropClient(crash);
499 memset (&sv, 0, sizeof(sv));
500 memset (svs.clients, 0, svs.maxclientslimit*sizeof(client_t));
508 This clears all the memory used by both the client and server, but does
509 not reinitialize anything.
512 void Host_ClearMemory (void)
514 Con_DPrintf ("Clearing memory\n");
518 memset (&sv, 0, sizeof(sv));
519 memset (&cl, 0, sizeof(cl));
523 //============================================================================
529 Returns false if the time is too short to run a frame
532 extern cvar_t cl_avidemo;
533 qboolean Host_FilterTime (double time)
538 if (slowmo.value < 0.0f)
539 Cvar_SetValue("slowmo", 0.0f);
540 if (host_minfps.value < 10.0f)
541 Cvar_SetValue("host_minfps", 10.0f);
542 if (host_maxfps.value < host_minfps.value)
543 Cvar_SetValue("host_maxfps", host_minfps.value);
544 if (cl_avidemo.value < 0.1f && cl_avidemo.value != 0.0f)
545 Cvar_SetValue("cl_avidemo", 0.0f);
547 // check if framerate is too high
548 if (cl_avidemo.value >= 0.1f)
550 timecap = 1.0 / (double)cl_avidemo.value;
551 if ((realtime - oldrealtime) < timecap)
554 else if (!cls.timedemo)
556 // default to sys_ticrate (server framerate - presumably low) unless we're the active window and either connected to a server or playing a video
557 timecap = sys_ticrate.value;
558 if (vid_activewindow && (cls.state == ca_connected || cl_videoplaying))
559 timecap = 1.0 / host_maxfps.value;
561 if ((realtime - oldrealtime) < timecap)
565 // LordHavoc: copy into host_realframetime as well
566 host_realframetime = host_frametime = realtime - oldrealtime;
567 oldrealtime = realtime;
571 // disable time effects
572 cl.frametime = host_frametime;
576 if (host_framerate.value > 0)
577 host_frametime = host_framerate.value;
578 else if (cl_avidemo.value >= 0.1f)
579 host_frametime = (1.0 / cl_avidemo.value);
582 // don't allow really short frames
583 if (host_frametime > (1.0 / host_minfps.value))
584 host_frametime = (1.0 / host_minfps.value);
587 cl.frametime = host_frametime = bound(0, host_frametime * slowmo.value, 0.1f); // LordHavoc: the QC code relies on no less than 10fps
595 Host_GetConsoleCommands
597 Add them exactly as if they had been typed at the console
600 void Host_GetConsoleCommands (void)
606 cmd = Sys_ConsoleInput ();
620 void Host_ServerFrame (void)
622 static double frametimetotal = 0, lastservertime = 0;
623 frametimetotal += host_frametime;
624 // LordHavoc: cap server at sys_ticrate in listen games
625 if (cls.state != ca_dedicated && svs.maxclients > 1 && ((realtime - lastservertime) < sys_ticrate.value))
627 // run the world state
628 if (!sv.paused && (svs.maxclients > 1 || key_dest == key_game) )
629 sv.frametime = pr_global_struct->frametime = frametimetotal;
633 lastservertime = realtime;
635 // set the time and clear the general datagram
638 // check for new clients
639 SV_CheckForNewClients ();
641 // read client messages
644 // move things around and think
645 // always pause in single player if in console or menus
646 if (!sv.paused && (svs.maxclients > 1 || key_dest == key_game) )
649 // send all messages to the clients
650 SV_SendClientMessages ();
658 Runs all active servers
661 void _Host_Frame (float time)
663 static double time1 = 0;
664 static double time2 = 0;
665 static double time3 = 0;
666 int pass1, pass2, pass3;
668 if (setjmp (host_abortserver) )
669 return; // something bad happened, or the server disconnected
671 // keep the random time dependent
674 // decide the simulation time
675 if (!Host_FilterTime (time))
677 // if time was rejected, don't totally hog the CPU
682 // get new key events
683 Sys_SendKeyEvents ();
685 // allow mice or other external controllers to add commands
688 // process console commands
693 // if running the server locally, make intentions now
697 //-------------------
701 //-------------------
703 // check for commands typed to the host
704 Host_GetConsoleCommands ();
709 //-------------------
713 //-------------------
715 // if running the server remotely, send intentions now after
716 // the incoming messages have been read
720 // fetch results from server
721 if (cls.state == ca_connected)
722 CL_ReadFromServer ();
729 if (host_speeds.integer)
730 time1 = Sys_DoubleTime ();
734 if (host_speeds.integer)
735 time2 = Sys_DoubleTime ();
738 if (cls.signon == SIGNONS)
740 // LordHavoc: this used to use renderer variables (eww)
741 vec3_t forward, right, up;
742 AngleVectors(cl.viewangles, forward, right, up);
743 S_Update (cl_entities[cl.viewentity].render.origin, forward, right, up);
746 S_Update (vec3_origin, vec3_origin, vec3_origin, vec3_origin);
750 if (host_speeds.integer)
752 pass1 = (time1 - time3)*1000000;
753 time3 = Sys_DoubleTime ();
754 pass2 = (time2 - time1)*1000000;
755 pass3 = (time3 - time2)*1000000;
756 Con_Printf ("%6ius total %6ius server %6ius gfx %6ius snd\n",
757 pass1+pass2+pass3, pass1, pass2, pass3);
761 host_loopactive = true;
764 void Host_Frame (float time)
767 static double timetotal;
768 static int timecount;
771 if (!serverprofile.integer)
777 time1 = Sys_DoubleTime ();
779 time2 = Sys_DoubleTime ();
781 timetotal += time2 - time1;
784 if (timecount < 1000)
787 m = timetotal*1000/timecount;
791 for (i=0 ; i<svs.maxclients ; i++)
793 if (svs.clients[i].active)
797 Con_Printf ("serverprofile: %2i clients %2i msec\n", c, m);
800 //============================================================================
802 void Render_Init(void);
803 void QuakeIO_Init(void);
810 void Host_Init (void)
812 // LordHavoc: quake never seeded the random number generator before... heh
815 // FIXME: this is evil, but possibly temporary
816 if (COM_CheckParm("-developer"))
818 forcedeveloper = true;
819 developer.integer = 1;
824 Memory_Init_Commands();
831 W_LoadWadFile ("gfx.wad");
841 Con_Printf ("Builddate: %s\n", buildstring);
843 if (cls.state != ca_dedicated)
851 #ifndef _WIN32 // on non win32, mouse comes before video for security reasons
861 #ifdef _WIN32 // on non win32, mouse comes before video for security reasons
866 Cbuf_InsertText ("exec quake.rc\n");
868 host_initialized = true;
870 Sys_Printf ("========Quake Initialized=========\n");
878 FIXME: this is a callback from Sys_Quit and Sys_Error. It would be better
879 to run quit through here before the final handoff to the sys code.
882 void Host_Shutdown(void)
884 static qboolean isdown = false;
888 printf ("recursive shutdown\n");
893 Host_WriteConfiguration ();
900 if (cls.state != ca_dedicated)
902 R_Modules_Shutdown();