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 quakeparms_t host_parms;
39 qboolean host_initialized; // true if into command execution
40 qboolean host_loopactive = false; // LordHavoc: used to turn Host_Error into Sys_Error if starting up or shutting down
41 qboolean host_shuttingdown = false; // LordHavoc: set when quit is executed
43 double host_frametime;
44 double host_realframetime; // LordHavoc: the real frametime, before slowmo and clamping are applied (used for console scrolling)
45 double realtime; // without any filtering or bounding
46 double oldrealtime; // last frame run
49 int forcedeveloper; // used for -developer commandline parameter, hacky hacky
51 client_t *host_client; // current client
53 jmp_buf host_abortserver;
55 cvar_t host_framerate = {0, "host_framerate","0"}; // set for slow motion
56 cvar_t host_speeds = {0, "host_speeds","0"}; // set for running times
57 cvar_t slowmo = {0, "slowmo", "1.0"}; // LordHavoc: framerate independent slowmo
58 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)
59 cvar_t host_maxfps = {CVAR_SAVE, "host_maxfps", "1000"}; // LordHavoc: framerate upper cap
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 (&sys_ticrate);
245 Cvar_RegisterVariable (&serverprofile);
247 Cvar_RegisterVariable (&fraglimit);
248 Cvar_RegisterVariable (&timelimit);
249 Cvar_RegisterVariable (&teamplay);
250 Cvar_RegisterVariable (&samelevel);
251 Cvar_RegisterVariable (&noexit);
252 Cvar_RegisterVariable (&skill);
253 Cvar_RegisterVariable (&developer);
254 if (forcedeveloper) // make it real now that the cvar is registered
255 Cvar_SetValue("developer", 1);
256 Cvar_RegisterVariable (&deathmatch);
257 Cvar_RegisterVariable (&coop);
259 Cvar_RegisterVariable (&pausable);
261 Cvar_RegisterVariable (&temp1);
263 Cvar_RegisterVariable (×tamps);
264 Cvar_RegisterVariable (&timeformat);
266 Host_FindMaxClients ();
272 Host_WriteConfiguration
274 Writes key bindings and archived cvars to config.cfg
277 void Host_WriteConfiguration (void)
281 // dedicated servers initialize the host but don't parse and set the
283 if (host_initialized && cls.state != ca_dedicated)
285 f = Qopen (va("%s/config.cfg",com_gamedir), "w");
288 Con_Printf ("Couldn't write config.cfg.\n");
292 Key_WriteBindings (f);
293 Cvar_WriteVariables (f);
304 Sends text across to be displayed
305 FIXME: make this just a stuffed echo?
308 void SV_ClientPrintf (char *fmt, ...)
313 va_start (argptr,fmt);
314 vsprintf (string, fmt,argptr);
317 MSG_WriteByte (&host_client->message, svc_print);
318 MSG_WriteString (&host_client->message, string);
325 Sends text to all active clients
328 void SV_BroadcastPrintf (char *fmt, ...)
334 va_start (argptr,fmt);
335 vsprintf (string, fmt,argptr);
338 for (i=0 ; i<svs.maxclients ; i++)
339 if (svs.clients[i].active && svs.clients[i].spawned)
341 MSG_WriteByte (&svs.clients[i].message, svc_print);
342 MSG_WriteString (&svs.clients[i].message, string);
350 Send text over to the client to be executed
353 void Host_ClientCommands (char *fmt, ...)
358 va_start (argptr,fmt);
359 vsprintf (string, fmt,argptr);
362 MSG_WriteByte (&host_client->message, svc_stufftext);
363 MSG_WriteString (&host_client->message, string);
367 =====================
370 Called when the player is getting totally kicked off the host
371 if (crash = true), don't bother sending signofs
372 =====================
374 void SV_DropClient (qboolean crash)
382 // send any final messages (don't check for errors)
383 if (NET_CanSendMessage (host_client->netconnection))
385 MSG_WriteByte (&host_client->message, svc_disconnect);
386 NET_SendMessage (host_client->netconnection, &host_client->message);
389 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)
391 // call the prog function for removing a client
392 // this will set the body to a dead frame, among other things
393 saveSelf = pr_global_struct->self;
394 pr_global_struct->self = EDICT_TO_PROG(host_client->edict);
395 PR_ExecuteProgram (pr_global_struct->ClientDisconnect, "QC function ClientDisconnect is missing");
396 pr_global_struct->self = saveSelf;
399 Sys_Printf ("Client %s removed\n",host_client->name);
402 // break the net connection
403 NET_Close (host_client->netconnection);
404 host_client->netconnection = NULL;
406 // free the client (the body stays around)
407 host_client->active = false;
408 host_client->name[0] = 0;
409 host_client->old_frags = -999999;
410 net_activeconnections--;
412 // send notification to all clients
413 for (i=0, client = svs.clients ; i<svs.maxclients ; i++, client++)
417 MSG_WriteByte (&client->message, svc_updatename);
418 MSG_WriteByte (&client->message, host_client - svs.clients);
419 MSG_WriteString (&client->message, "");
420 MSG_WriteByte (&client->message, svc_updatefrags);
421 MSG_WriteByte (&client->message, host_client - svs.clients);
422 MSG_WriteShort (&client->message, 0);
423 MSG_WriteByte (&client->message, svc_updatecolors);
424 MSG_WriteByte (&client->message, host_client - svs.clients);
425 MSG_WriteByte (&client->message, 0);
433 This only happens at the end of a game, not between levels
436 void Host_ShutdownServer(qboolean crash)
449 // stop all client sounds immediately
452 // flush any pending messages - like the score!!!
453 start = Sys_DoubleTime();
457 for (i=0, host_client = svs.clients ; i<svs.maxclients ; i++, host_client++)
459 if (host_client->active && host_client->message.cursize)
461 if (NET_CanSendMessage (host_client->netconnection))
463 NET_SendMessage(host_client->netconnection, &host_client->message);
464 SZ_Clear (&host_client->message);
468 NET_GetMessage(host_client->netconnection);
473 if ((Sys_DoubleTime() - start) > 3.0)
478 // make sure all the clients know we're disconnecting
482 MSG_WriteByte(&buf, svc_disconnect);
483 count = NET_SendToAll(&buf, 5);
485 Con_Printf("Host_ShutdownServer: NET_SendToAll failed for %u clients\n", count);
487 for (i=0, host_client = svs.clients ; i<svs.maxclients ; i++, host_client++)
488 if (host_client->active)
489 SV_DropClient(crash);
494 memset (&sv, 0, sizeof(sv));
495 memset (svs.clients, 0, svs.maxclientslimit*sizeof(client_t));
503 This clears all the memory used by both the client and server, but does
504 not reinitialize anything.
507 void Host_ClearMemory (void)
509 Con_DPrintf ("Clearing memory\n");
513 memset (&sv, 0, sizeof(sv));
514 memset (&cl, 0, sizeof(cl));
518 //============================================================================
524 Returns false if the time is too short to run a frame
527 extern cvar_t cl_avidemo;
528 qboolean Host_FilterTime (double time)
533 if (slowmo.value < 0.0f)
534 Cvar_SetValue("slowmo", 0.0f);
535 if (host_minfps.value < 10.0f)
536 Cvar_SetValue("host_minfps", 10.0f);
537 if (host_maxfps.value < host_minfps.value)
538 Cvar_SetValue("host_maxfps", host_minfps.value);
539 if (cl_avidemo.value < 0.1f && cl_avidemo.value != 0.0f)
540 Cvar_SetValue("cl_avidemo", 0.0f);
542 // check if framerate is too high
543 if (cl_avidemo.value >= 0.1f)
545 timecap = 1.0 / (double)cl_avidemo.value;
546 if ((realtime - oldrealtime) < timecap)
549 else if (!cls.timedemo)
551 // default to sys_ticrate (server framerate - presumably low) unless we're the active window and either connected to a server or playing a video
552 timecap = sys_ticrate.value;
553 if (vid_activewindow && (cls.state == ca_connected || cl_videoplaying))
554 timecap = 1.0 / host_maxfps.value;
556 if ((realtime - oldrealtime) < timecap)
560 // LordHavoc: copy into host_realframetime as well
561 host_realframetime = host_frametime = realtime - oldrealtime;
562 oldrealtime = realtime;
566 // disable time effects
567 cl.frametime = host_frametime;
571 if (host_framerate.value > 0)
572 host_frametime = host_framerate.value;
573 else if (cl_avidemo.value >= 0.1f)
574 host_frametime = (1.0 / cl_avidemo.value);
577 // don't allow really short frames
578 if (host_frametime > (1.0 / host_minfps.value))
579 host_frametime = (1.0 / host_minfps.value);
582 cl.frametime = host_frametime = bound(0, host_frametime * slowmo.value, 0.1f); // LordHavoc: the QC code relies on no less than 10fps
590 Host_GetConsoleCommands
592 Add them exactly as if they had been typed at the console
595 void Host_GetConsoleCommands (void)
601 cmd = Sys_ConsoleInput ();
615 void Host_ServerFrame (void)
617 static double frametimetotal = 0, lastservertime = 0;
618 frametimetotal += host_frametime;
619 // LordHavoc: cap server at sys_ticrate in listen games
620 if (cls.state != ca_dedicated && svs.maxclients > 1 && ((realtime - lastservertime) < sys_ticrate.value))
622 // run the world state
623 if (!sv.paused && (svs.maxclients > 1 || key_dest == key_game) )
624 sv.frametime = pr_global_struct->frametime = frametimetotal;
628 lastservertime = realtime;
630 // set the time and clear the general datagram
633 // check for new clients
634 SV_CheckForNewClients ();
636 // read client messages
639 // move things around and think
640 // always pause in single player if in console or menus
641 if (!sv.paused && (svs.maxclients > 1 || key_dest == key_game) )
644 // send all messages to the clients
645 SV_SendClientMessages ();
653 Runs all active servers
656 void _Host_Frame (float time)
658 static double time1 = 0;
659 static double time2 = 0;
660 static double time3 = 0;
661 int pass1, pass2, pass3;
663 if (setjmp (host_abortserver) )
664 return; // something bad happened, or the server disconnected
666 // keep the random time dependent
669 // decide the simulation time
670 if (!Host_FilterTime (time))
672 // if time was rejected, don't totally hog the CPU
677 // get new key events
678 Sys_SendKeyEvents ();
680 // allow mice or other external controllers to add commands
683 // process console commands
688 // if running the server locally, make intentions now
692 //-------------------
696 //-------------------
698 // check for commands typed to the host
699 Host_GetConsoleCommands ();
704 //-------------------
708 //-------------------
710 // if running the server remotely, send intentions now after
711 // the incoming messages have been read
715 // fetch results from server
716 if (cls.state == ca_connected)
717 CL_ReadFromServer ();
724 if (host_speeds.integer)
725 time1 = Sys_DoubleTime ();
729 if (host_speeds.integer)
730 time2 = Sys_DoubleTime ();
733 if (cls.signon == SIGNONS)
735 // LordHavoc: this used to use renderer variables (eww)
736 vec3_t forward, right, up;
737 AngleVectors(cl.viewangles, forward, right, up);
738 S_Update (cl_entities[cl.viewentity].render.origin, forward, right, up);
741 S_Update (vec3_origin, vec3_origin, vec3_origin, vec3_origin);
745 if (host_speeds.integer)
747 pass1 = (time1 - time3)*1000000;
748 time3 = Sys_DoubleTime ();
749 pass2 = (time2 - time1)*1000000;
750 pass3 = (time3 - time2)*1000000;
751 Con_Printf ("%6ius total %6ius server %6ius gfx %6ius snd\n",
752 pass1+pass2+pass3, pass1, pass2, pass3);
756 host_loopactive = true;
759 void Host_Frame (float time)
762 static double timetotal;
763 static int timecount;
766 if (!serverprofile.integer)
772 time1 = Sys_DoubleTime ();
774 time2 = Sys_DoubleTime ();
776 timetotal += time2 - time1;
779 if (timecount < 1000)
782 m = timetotal*1000/timecount;
786 for (i=0 ; i<svs.maxclients ; i++)
788 if (svs.clients[i].active)
792 Con_Printf ("serverprofile: %2i clients %2i msec\n", c, m);
795 //============================================================================
797 void Render_Init(void);
798 void QuakeIO_Init(void);
805 void Host_Init (void)
807 // LordHavoc: quake never seeded the random number generator before... heh
810 com_argc = host_parms.argc;
811 com_argv = host_parms.argv;
812 // FIXME: this is evil, but possibly temporary
813 if (COM_CheckParm("-developer"))
815 forcedeveloper = true;
816 developer.integer = 1;
821 Memory_Init_Commands();
828 W_LoadWadFile ("gfx.wad");
838 Con_Printf ("Builddate: %s\n", buildstring);
840 if (cls.state != ca_dedicated)
848 #ifndef _WIN32 // on non win32, mouse comes before video for security reasons
858 #ifdef _WIN32 // on non win32, mouse comes before video for security reasons
863 Cbuf_InsertText ("exec quake.rc\n");
865 host_initialized = true;
867 Sys_Printf ("========Quake Initialized=========\n");
875 FIXME: this is a callback from Sys_Quit and Sys_Error. It would be better
876 to run quit through here before the final handoff to the sys code.
879 void Host_Shutdown(void)
881 static qboolean isdown = false;
885 printf ("recursive shutdown\n");
890 Host_WriteConfiguration ();
897 if (cls.state != ca_dedicated)
899 R_Modules_Shutdown();