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
26 A server can always be started, even if the system started out as a client
29 A client can NOT be started if the system started as a dedicated server.
31 Memory is cleared / released when a server or client begins, not when they end.
35 quakeparms_t host_parms;
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 // SCR_EndLoadingPlaque (); // reenable screen updates
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]);
203 if (svs.maxclients < 1)
205 else if (svs.maxclients > MAX_SCOREBOARD)
206 svs.maxclients = MAX_SCOREBOARD;
208 svs.maxclientslimit = svs.maxclients;
209 if (svs.maxclientslimit < MAX_SCOREBOARD) // LordHavoc: upped listen mode limit from 4 to MAX_SCOREBOARD
210 svs.maxclientslimit = MAX_SCOREBOARD;
211 if (!clients_mempool)
212 clients_mempool = Mem_AllocPool("clients");
214 Mem_Free(svs.clients);
215 svs.clients = Mem_Alloc(clients_mempool, svs.maxclientslimit*sizeof(client_t));
217 if (svs.maxclients > 1)
218 Cvar_SetValue ("deathmatch", 1.0);
220 Cvar_SetValue ("deathmatch", 0.0);
225 =======================
227 ======================
229 void Host_InitLocal (void)
231 Host_InitCommands ();
233 Cvar_RegisterVariable (&host_framerate);
234 Cvar_RegisterVariable (&host_speeds);
235 Cvar_RegisterVariable (&slowmo);
236 Cvar_RegisterVariable (&host_minfps);
237 Cvar_RegisterVariable (&host_maxfps);
239 Cvar_RegisterVariable (&sys_ticrate);
240 Cvar_RegisterVariable (&serverprofile);
242 Cvar_RegisterVariable (&fraglimit);
243 Cvar_RegisterVariable (&timelimit);
244 Cvar_RegisterVariable (&teamplay);
245 Cvar_RegisterVariable (&samelevel);
246 Cvar_RegisterVariable (&noexit);
247 Cvar_RegisterVariable (&skill);
248 Cvar_RegisterVariable (&developer);
249 if (forcedeveloper) // make it real now that the cvar is registered
250 Cvar_SetValue("developer", 1);
251 Cvar_RegisterVariable (&deathmatch);
252 Cvar_RegisterVariable (&coop);
254 Cvar_RegisterVariable (&pausable);
256 Cvar_RegisterVariable (&temp1);
258 Cvar_RegisterVariable (×tamps);
259 Cvar_RegisterVariable (&timeformat);
261 Host_FindMaxClients ();
267 Host_WriteConfiguration
269 Writes key bindings and archived cvars to config.cfg
272 void Host_WriteConfiguration (void)
276 // dedicated servers initialize the host but don't parse and set the
278 if (host_initialized && cls.state != ca_dedicated)
280 f = Qopen (va("%s/config.cfg",com_gamedir), "w");
283 Con_Printf ("Couldn't write config.cfg.\n");
287 Key_WriteBindings (f);
288 Cvar_WriteVariables (f);
299 Sends text across to be displayed
300 FIXME: make this just a stuffed echo?
303 void SV_ClientPrintf (char *fmt, ...)
308 va_start (argptr,fmt);
309 vsprintf (string, fmt,argptr);
312 MSG_WriteByte (&host_client->message, svc_print);
313 MSG_WriteString (&host_client->message, string);
320 Sends text to all active clients
323 void SV_BroadcastPrintf (char *fmt, ...)
329 va_start (argptr,fmt);
330 vsprintf (string, fmt,argptr);
333 for (i=0 ; i<svs.maxclients ; i++)
334 if (svs.clients[i].active && svs.clients[i].spawned)
336 MSG_WriteByte (&svs.clients[i].message, svc_print);
337 MSG_WriteString (&svs.clients[i].message, string);
345 Send text over to the client to be executed
348 void Host_ClientCommands (char *fmt, ...)
353 va_start (argptr,fmt);
354 vsprintf (string, fmt,argptr);
357 MSG_WriteByte (&host_client->message, svc_stufftext);
358 MSG_WriteString (&host_client->message, string);
362 =====================
365 Called when the player is getting totally kicked off the host
366 if (crash = true), don't bother sending signofs
367 =====================
369 void SV_DropClient (qboolean crash)
377 // send any final messages (don't check for errors)
378 if (NET_CanSendMessage (host_client->netconnection))
380 MSG_WriteByte (&host_client->message, svc_disconnect);
381 NET_SendMessage (host_client->netconnection, &host_client->message);
384 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)
386 // call the prog function for removing a client
387 // this will set the body to a dead frame, among other things
388 saveSelf = pr_global_struct->self;
389 pr_global_struct->self = EDICT_TO_PROG(host_client->edict);
390 PR_ExecuteProgram (pr_global_struct->ClientDisconnect, "QC function ClientDisconnect is missing");
391 pr_global_struct->self = saveSelf;
394 Sys_Printf ("Client %s removed\n",host_client->name);
397 // break the net connection
398 NET_Close (host_client->netconnection);
399 host_client->netconnection = NULL;
401 // free the client (the body stays around)
402 host_client->active = false;
403 host_client->name[0] = 0;
404 host_client->old_frags = -999999;
405 net_activeconnections--;
407 // send notification to all clients
408 for (i=0, client = svs.clients ; i<svs.maxclients ; i++, client++)
412 MSG_WriteByte (&client->message, svc_updatename);
413 MSG_WriteByte (&client->message, host_client - svs.clients);
414 MSG_WriteString (&client->message, "");
415 MSG_WriteByte (&client->message, svc_updatefrags);
416 MSG_WriteByte (&client->message, host_client - svs.clients);
417 MSG_WriteShort (&client->message, 0);
418 MSG_WriteByte (&client->message, svc_updatecolors);
419 MSG_WriteByte (&client->message, host_client - svs.clients);
420 MSG_WriteByte (&client->message, 0);
428 This only happens at the end of a game, not between levels
431 void Host_ShutdownServer(qboolean crash)
444 // stop all client sounds immediately
447 // flush any pending messages - like the score!!!
448 start = Sys_DoubleTime();
452 for (i=0, host_client = svs.clients ; i<svs.maxclients ; i++, host_client++)
454 if (host_client->active && host_client->message.cursize)
456 if (NET_CanSendMessage (host_client->netconnection))
458 NET_SendMessage(host_client->netconnection, &host_client->message);
459 SZ_Clear (&host_client->message);
463 NET_GetMessage(host_client->netconnection);
468 if ((Sys_DoubleTime() - start) > 3.0)
473 // make sure all the clients know we're disconnecting
477 MSG_WriteByte(&buf, svc_disconnect);
478 count = NET_SendToAll(&buf, 5);
480 Con_Printf("Host_ShutdownServer: NET_SendToAll failed for %u clients\n", count);
482 for (i=0, host_client = svs.clients ; i<svs.maxclients ; i++, host_client++)
483 if (host_client->active)
484 SV_DropClient(crash);
489 memset (&sv, 0, sizeof(sv));
490 memset (svs.clients, 0, svs.maxclientslimit*sizeof(client_t));
498 This clears all the memory used by both the client and server, but does
499 not reinitialize anything.
502 void Host_ClearMemory (void)
504 Con_DPrintf ("Clearing memory\n");
508 memset (&sv, 0, sizeof(sv));
509 memset (&cl, 0, sizeof(cl));
513 //============================================================================
519 Returns false if the time is too short to run a frame
522 qboolean Host_FilterTime (double time)
527 if (slowmo.value < 0.0f)
528 Cvar_SetValue("slowmo", 0.0f);
529 if (host_minfps.value < 10.0f)
530 Cvar_SetValue("host_minfps", 10.0f);
531 if (host_maxfps.value < host_minfps.value)
532 Cvar_SetValue("host_maxfps", host_minfps.value);
534 // check if framerate is too high
537 timecap = sys_ticrate.value;
538 if (cls.state == ca_connected)
539 timecap = 1.0 / host_maxfps.value;
541 if ((realtime - oldrealtime) < timecap)
545 // LordHavoc: copy into host_realframetime as well
546 host_realframetime = host_frametime = realtime - oldrealtime;
547 oldrealtime = realtime;
551 // disable time effects
552 cl.frametime = host_frametime;
556 if (host_framerate.value > 0)
557 host_frametime = host_framerate.value;
560 // don't allow really short frames
561 if (host_frametime > (1.0 / host_minfps.value))
562 host_frametime = (1.0 / host_minfps.value);
565 cl.frametime = host_frametime = bound(0, host_frametime * slowmo.value, 0.1f); // LordHavoc: the QC code relies on no less than 10fps
573 Host_GetConsoleCommands
575 Add them exactly as if they had been typed at the console
578 void Host_GetConsoleCommands (void)
584 cmd = Sys_ConsoleInput ();
598 void Host_ServerFrame (void)
600 static double frametimetotal = 0, lastservertime = 0;
601 frametimetotal += host_frametime;
602 // LordHavoc: cap server at sys_ticrate in listen games
603 if (cls.state != ca_dedicated && svs.maxclients > 1 && ((realtime - lastservertime) < sys_ticrate.value))
605 // run the world state
606 if (!sv.paused && (svs.maxclients > 1 || key_dest == key_game) )
607 sv.frametime = pr_global_struct->frametime = frametimetotal;
611 lastservertime = realtime;
612 // pr_global_struct->frametime = host_frametime;
614 // set the time and clear the general datagram
617 // check for new clients
618 SV_CheckForNewClients ();
620 // read client messages
623 // move things around and think
624 // always pause in single player if in console or menus
625 if (!sv.paused && (svs.maxclients > 1 || key_dest == key_game) )
628 // send all messages to the clients
629 SV_SendClientMessages ();
637 Runs all active servers
640 void _Host_Frame (float time)
642 static double time1 = 0;
643 static double time2 = 0;
644 static double time3 = 0;
645 int pass1, pass2, pass3;
647 if (setjmp (host_abortserver) )
648 return; // something bad happened, or the server disconnected
650 // keep the random time dependent
653 // decide the simulation time
654 if (!Host_FilterTime (time))
656 // if time was rejected, don't totally hog the CPU
661 // get new key events
662 Sys_SendKeyEvents ();
664 // allow mice or other external controllers to add commands
667 // process console commands
672 // if running the server locally, make intentions now
676 //-------------------
680 //-------------------
682 // check for commands typed to the host
683 Host_GetConsoleCommands ();
688 //-------------------
692 //-------------------
694 // if running the server remotely, send intentions now after
695 // the incoming messages have been read
699 // fetch results from server
700 if (cls.state == ca_connected)
701 CL_ReadFromServer ();
706 if (host_speeds.integer)
707 time1 = Sys_DoubleTime ();
711 if (host_speeds.integer)
712 time2 = Sys_DoubleTime ();
715 if (cls.signon == SIGNONS)
717 // LordHavoc: this used to use renderer variables (eww)
718 vec3_t forward, right, up;
719 AngleVectors(cl.viewangles, forward, right, up);
720 S_Update (cl_entities[cl.viewentity].render.origin, forward, right, up);
723 S_Update (vec3_origin, vec3_origin, vec3_origin, vec3_origin);
727 if (host_speeds.integer)
729 pass1 = (time1 - time3)*1000000;
730 time3 = Sys_DoubleTime ();
731 pass2 = (time2 - time1)*1000000;
732 pass3 = (time3 - time2)*1000000;
733 Con_Printf ("%6ius total %6ius server %6ius gfx %6ius snd\n",
734 pass1+pass2+pass3, pass1, pass2, pass3);
738 host_loopactive = true;
741 void Host_Frame (float time)
744 static double timetotal;
745 static int timecount;
748 if (!serverprofile.integer)
754 time1 = Sys_DoubleTime ();
756 time2 = Sys_DoubleTime ();
758 timetotal += time2 - time1;
761 if (timecount < 1000)
764 m = timetotal*1000/timecount;
768 for (i=0 ; i<svs.maxclients ; i++)
770 if (svs.clients[i].active)
774 Con_Printf ("serverprofile: %2i clients %2i msec\n", c, m);
777 //============================================================================
779 void Render_Init(void);
780 void QuakeIO_Init(void);
787 void Host_Init (void)
789 com_argc = host_parms.argc;
790 com_argv = host_parms.argv;
791 // FIXME: this is evil, but possibly temporary
792 if (COM_CheckParm("-developer"))
794 forcedeveloper = true;
795 developer.integer = 1;
801 Memory_Init_Commands();
808 W_LoadWadFile ("gfx.wad");
818 Con_Printf ("Exe: "__TIME__" "__DATE__"\n");
820 if (cls.state != ca_dedicated)
828 #ifndef _WIN32 // on non win32, mouse comes before video for security reasons
838 #ifdef _WIN32 // on non win32, mouse comes before video for security reasons
843 Cbuf_InsertText ("exec quake.rc\n");
845 host_initialized = true;
847 Sys_Printf ("========Quake Initialized=========\n");
855 FIXME: this is a callback from Sys_Quit and Sys_Error. It would be better
856 to run quit through here before the final handoff to the sys code.
859 void Host_Shutdown(void)
861 static qboolean isdown = false;
865 printf ("recursive shutdown\n");
870 // keep Con_Printf from trying to update the screen
871 scr_disabled_for_loading = true;
873 Host_WriteConfiguration ();
880 if (cls.state != ca_dedicated)
882 R_Modules_Shutdown();