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 hostloopactive = 0; // LordHavoc: used to turn Host_Error into Sys_Error if Host_Frame has not yet run
40 double host_frametime;
41 double host_realframetime; // LordHavoc: the real frametime, before slowmo and clamping are applied (used for console scrolling)
42 double realtime; // without any filtering or bounding
43 double oldrealtime; // last frame run
52 client_t *host_client; // current client
54 jmp_buf host_abortserver;
56 cvar_t host_framerate = {"host_framerate","0"}; // set for slow motion
57 cvar_t host_speeds = {"host_speeds","0"}; // set for running times
58 cvar_t slowmo = {"slowmo", "1.0"}; // LordHavoc: framerate independent slowmo
59 cvar_t host_minfps = {"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)
60 cvar_t host_maxfps = {"host_maxfps", "1000"}; // LordHavoc: framerate upper cap
62 cvar_t sys_ticrate = {"sys_ticrate","0.05"};
63 cvar_t serverprofile = {"serverprofile","0"};
65 cvar_t fraglimit = {"fraglimit","0",false,true};
66 cvar_t timelimit = {"timelimit","0",false,true};
67 cvar_t teamplay = {"teamplay","0",false,true};
69 cvar_t samelevel = {"samelevel","0"};
70 cvar_t noexit = {"noexit","0",false,true};
72 cvar_t developer = {"developer","0"};
74 cvar_t skill = {"skill","1"}; // 0 - 3
75 cvar_t deathmatch = {"deathmatch","0"}; // 0, 1, or 2
76 cvar_t coop = {"coop","0"}; // 0 or 1
78 cvar_t pausable = {"pausable","1"};
80 cvar_t temp1 = {"temp1","0"};
82 cvar_t timestamps = {"timestamps", "0", true};
83 cvar_t timeformat = {"timeformat", "[%b %e %X] ", true};
90 void Host_EndGame (char *message, ...)
95 va_start (argptr,message);
96 vsprintf (string,message,argptr);
98 Con_DPrintf ("Host_EndGame: %s\n",string);
101 Host_ShutdownServer (false);
103 if (cls.state == ca_dedicated)
104 Sys_Error ("Host_EndGame: %s\n",string); // dedicated servers exit
106 if (cls.demonum != -1)
111 longjmp (host_abortserver, 1);
118 This shuts down both the client and server
121 char hosterrorstring[4096];
122 extern qboolean hostloopactive;
123 void Host_Error (char *error, ...)
126 static qboolean inerror = false;
128 // LordHavoc: if host_frame loop has not been run yet, do a Sys_Error instead
132 va_start (argptr,error);
133 vsprintf (string,error,argptr);
135 Sys_Error ("%s", string);
141 va_start (argptr,error);
142 vsprintf (string,error,argptr);
144 Sys_Error ("Host_Error: recursively entered (original error was: %s new error is: %s)", hosterrorstring, string);
148 // SCR_EndLoadingPlaque (); // reenable screen updates
150 va_start (argptr,error);
151 vsprintf (hosterrorstring,error,argptr);
153 Con_Printf ("Host_Error: %s\n",hosterrorstring);
156 Host_ShutdownServer (false);
158 if (cls.state == ca_dedicated)
159 Sys_Error ("Host_Error: %s\n",hosterrorstring); // dedicated servers exit
166 longjmp (host_abortserver, 1);
174 void Host_FindMaxClients (void)
180 i = COM_CheckParm ("-dedicated");
183 cls.state = ca_dedicated;
184 if (i != (com_argc - 1))
186 svs.maxclients = atoi (com_argv[i+1]);
192 cls.state = ca_disconnected;
194 i = COM_CheckParm ("-listen");
197 if (cls.state == ca_dedicated)
198 Sys_Error ("Only one of -dedicated or -listen can be specified");
199 if (i != (com_argc - 1))
200 svs.maxclients = atoi (com_argv[i+1]);
204 if (svs.maxclients < 1)
206 else if (svs.maxclients > MAX_SCOREBOARD)
207 svs.maxclients = MAX_SCOREBOARD;
209 svs.maxclientslimit = svs.maxclients;
210 if (svs.maxclientslimit < MAX_SCOREBOARD) // LordHavoc: upped listen mode limit from 4 to MAX_SCOREBOARD
211 svs.maxclientslimit = MAX_SCOREBOARD;
212 svs.clients = Hunk_AllocName (svs.maxclientslimit*sizeof(client_t), "clients");
214 if (svs.maxclients > 1)
215 Cvar_SetValue ("deathmatch", 1.0);
217 Cvar_SetValue ("deathmatch", 0.0);
222 =======================
224 ======================
226 void Host_InitLocal (void)
228 Host_InitCommands ();
230 Cvar_RegisterVariable (&host_framerate);
231 Cvar_RegisterVariable (&host_speeds);
232 Cvar_RegisterVariable (&slowmo);
233 Cvar_RegisterVariable (&host_minfps);
234 Cvar_RegisterVariable (&host_maxfps);
236 Cvar_RegisterVariable (&sys_ticrate);
237 Cvar_RegisterVariable (&serverprofile);
239 Cvar_RegisterVariable (&fraglimit);
240 Cvar_RegisterVariable (&timelimit);
241 Cvar_RegisterVariable (&teamplay);
242 Cvar_RegisterVariable (&samelevel);
243 Cvar_RegisterVariable (&noexit);
244 Cvar_RegisterVariable (&skill);
245 Cvar_RegisterVariable (&developer);
246 Cvar_RegisterVariable (&deathmatch);
247 Cvar_RegisterVariable (&coop);
249 Cvar_RegisterVariable (&pausable);
251 Cvar_RegisterVariable (&temp1);
253 Cvar_RegisterVariable (×tamps);
254 Cvar_RegisterVariable (&timeformat);
256 Host_FindMaxClients ();
262 Host_WriteConfiguration
264 Writes key bindings and archived cvars to config.cfg
267 void Host_WriteConfiguration (void)
271 // dedicated servers initialize the host but don't parse and set the
273 if (host_initialized & !isDedicated)
275 f = fopen (va("%s/config.cfg",com_gamedir), "w");
278 Con_Printf ("Couldn't write config.cfg.\n");
282 Key_WriteBindings (f);
283 Cvar_WriteVariables (f);
294 Sends text across to be displayed
295 FIXME: make this just a stuffed echo?
298 void SV_ClientPrintf (char *fmt, ...)
303 va_start (argptr,fmt);
304 vsprintf (string, fmt,argptr);
307 MSG_WriteByte (&host_client->message, svc_print);
308 MSG_WriteString (&host_client->message, string);
315 Sends text to all active clients
318 void SV_BroadcastPrintf (char *fmt, ...)
324 va_start (argptr,fmt);
325 vsprintf (string, fmt,argptr);
328 for (i=0 ; i<svs.maxclients ; i++)
329 if (svs.clients[i].active && svs.clients[i].spawned)
331 MSG_WriteByte (&svs.clients[i].message, svc_print);
332 MSG_WriteString (&svs.clients[i].message, string);
340 Send text over to the client to be executed
343 void Host_ClientCommands (char *fmt, ...)
348 va_start (argptr,fmt);
349 vsprintf (string, fmt,argptr);
352 MSG_WriteByte (&host_client->message, svc_stufftext);
353 MSG_WriteString (&host_client->message, string);
357 =====================
360 Called when the player is getting totally kicked off the host
361 if (crash = true), don't bother sending signofs
362 =====================
364 void SV_DropClient (qboolean crash)
372 // send any final messages (don't check for errors)
373 if (NET_CanSendMessage (host_client->netconnection))
375 MSG_WriteByte (&host_client->message, svc_disconnect);
376 NET_SendMessage (host_client->netconnection, &host_client->message);
379 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)
381 // call the prog function for removing a client
382 // this will set the body to a dead frame, among other things
383 saveSelf = pr_global_struct->self;
384 pr_global_struct->self = EDICT_TO_PROG(host_client->edict);
385 PR_ExecuteProgram (pr_global_struct->ClientDisconnect, "QC function ClientDisconnect is missing");
386 pr_global_struct->self = saveSelf;
389 Sys_Printf ("Client %s removed\n",host_client->name);
392 // break the net connection
393 NET_Close (host_client->netconnection);
394 host_client->netconnection = NULL;
396 // free the client (the body stays around)
397 host_client->active = false;
398 host_client->name[0] = 0;
399 host_client->old_frags = -999999;
400 net_activeconnections--;
402 // send notification to all clients
403 for (i=0, client = svs.clients ; i<svs.maxclients ; i++, client++)
407 MSG_WriteByte (&client->message, svc_updatename);
408 MSG_WriteByte (&client->message, host_client - svs.clients);
409 MSG_WriteString (&client->message, "");
410 MSG_WriteByte (&client->message, svc_updatefrags);
411 MSG_WriteByte (&client->message, host_client - svs.clients);
412 MSG_WriteShort (&client->message, 0);
413 MSG_WriteByte (&client->message, svc_updatecolors);
414 MSG_WriteByte (&client->message, host_client - svs.clients);
415 MSG_WriteByte (&client->message, 0);
423 This only happens at the end of a game, not between levels
426 void Host_ShutdownServer(qboolean crash)
439 // stop all client sounds immediately
440 if (cls.state == ca_connected)
443 // flush any pending messages - like the score!!!
444 start = Sys_FloatTime();
448 for (i=0, host_client = svs.clients ; i<svs.maxclients ; i++, host_client++)
450 if (host_client->active && host_client->message.cursize)
452 if (NET_CanSendMessage (host_client->netconnection))
454 NET_SendMessage(host_client->netconnection, &host_client->message);
455 SZ_Clear (&host_client->message);
459 NET_GetMessage(host_client->netconnection);
464 if ((Sys_FloatTime() - start) > 3.0)
469 // make sure all the clients know we're disconnecting
473 MSG_WriteByte(&buf, svc_disconnect);
474 count = NET_SendToAll(&buf, 5);
476 Con_Printf("Host_ShutdownServer: NET_SendToAll failed for %u clients\n", count);
478 for (i=0, host_client = svs.clients ; i<svs.maxclients ; i++, host_client++)
479 if (host_client->active)
480 SV_DropClient(crash);
485 memset (&sv, 0, sizeof(sv));
486 memset (svs.clients, 0, svs.maxclientslimit*sizeof(client_t));
494 This clears all the memory used by both the client and server, but does
495 not reinitialize anything.
498 void Host_ClearMemory (void)
500 Con_DPrintf ("Clearing memory\n");
503 Hunk_FreeToLowMark (host_hunklevel);
506 memset (&sv, 0, sizeof(sv));
507 memset (&cl, 0, sizeof(cl));
511 //============================================================================
517 Returns false if the time is too short to run a frame
520 qboolean Host_FilterTime (double time)
525 if (slowmo.value < 0.0f)
526 Cvar_SetValue("slowmo", 0.0f);
527 if (host_minfps.value < 10.0f)
528 Cvar_SetValue("host_minfps", 10.0f);
529 if (host_maxfps.value < host_minfps.value)
530 Cvar_SetValue("host_maxfps", host_minfps.value);
532 // check if framerate is too high
535 timecap = sys_ticrate.value;
536 if (cls.state == ca_connected)
537 timecap = 1.0 / host_maxfps.value;
539 if ((realtime - oldrealtime) < timecap)
543 host_realframetime = host_frametime = realtime - oldrealtime; // LordHavoc: copy into host_realframetime as well
544 oldrealtime = realtime;
547 return true; // disable time effects
549 if (host_framerate.value > 0)
550 host_frametime = host_framerate.value;
553 // don't allow really short frames
554 if (host_frametime > (1.0 / host_minfps.value))
555 host_frametime = (1.0 / host_minfps.value);
558 host_frametime *= slowmo.value;
559 cl.frametime = host_frametime;
567 Host_GetConsoleCommands
569 Add them exactly as if they had been typed at the console
572 void Host_GetConsoleCommands (void)
578 cmd = Sys_ConsoleInput ();
592 void Host_ServerFrame (void)
594 static double frametimetotal = 0, lastservertime = 0;
595 frametimetotal += host_frametime;
596 // LordHavoc: cap server at sys_ticrate in listen games
597 if (!isDedicated && svs.maxclients > 1 && ((realtime - lastservertime) < sys_ticrate.value))
599 // run the world state
600 sv.frametime = pr_global_struct->frametime = frametimetotal;
602 lastservertime = realtime;
603 // pr_global_struct->frametime = host_frametime;
605 // set the time and clear the general datagram
608 // check for new clients
609 SV_CheckForNewClients ();
611 // read client messages
614 // move things around and think
615 // always pause in single player if in console or menus
616 if (!sv.paused && (svs.maxclients > 1 || key_dest == key_game) )
619 // send all messages to the clients
620 SV_SendClientMessages ();
628 Runs all active servers
631 void _Host_Frame (float time)
633 static double time1 = 0;
634 static double time2 = 0;
635 static double time3 = 0;
636 int pass1, pass2, pass3;
638 if (setjmp (host_abortserver) )
639 return; // something bad happened, or the server disconnected
642 // keep the random time dependent
645 // decide the simulation time
646 if (!Host_FilterTime (time))
648 // if time was rejected, don't totally hog the CPU
653 // get new key events
654 Sys_SendKeyEvents ();
656 // allow mice or other external controllers to add commands
659 // process console commands
664 // if running the server locally, make intentions now
668 //-------------------
672 //-------------------
674 // check for commands typed to the host
675 Host_GetConsoleCommands ();
680 //-------------------
684 //-------------------
686 // if running the server remotely, send intentions now after
687 // the incoming messages have been read
691 // fetch results from server
692 if (cls.state == ca_connected)
693 CL_ReadFromServer ();
696 if (host_speeds.value)
697 time1 = Sys_FloatTime ();
701 if (host_speeds.value)
702 time2 = Sys_FloatTime ();
705 if (cls.signon == SIGNONS)
707 S_Update (r_origin, vpn, vright, vup);
711 S_Update (vec3_origin, vec3_origin, vec3_origin, vec3_origin);
715 if (host_speeds.value)
717 pass1 = (time1 - time3)*1000000;
718 time3 = Sys_FloatTime ();
719 pass2 = (time2 - time1)*1000000;
720 pass3 = (time3 - time2)*1000000;
721 Con_Printf ("%6ius total %6ius server %6ius gfx %6ius snd\n",
722 pass1+pass2+pass3, pass1, pass2, pass3);
728 void Host_Frame (float time)
731 static double timetotal;
732 static int timecount;
735 if (!serverprofile.value)
741 time1 = Sys_FloatTime ();
743 time2 = Sys_FloatTime ();
745 timetotal += time2 - time1;
748 if (timecount < 1000)
751 m = timetotal*1000/timecount;
755 for (i=0 ; i<svs.maxclients ; i++)
757 if (svs.clients[i].active)
761 Con_Printf ("serverprofile: %2i clients %2i msec\n", c, m);
764 //============================================================================
778 minimum_memory = MINIMUM_MEMORY;
780 minimum_memory = MINIMUM_MEMORY_LEVELPAK;
782 if (COM_CheckParm ("-minmemory"))
783 host_parms.memsize = minimum_memory;
785 if (host_parms.memsize < minimum_memory)
786 Sys_Error ("Only %4.1f megs of memory available, can't execute game", host_parms.memsize / (float)0x100000);
789 host_parms.memsize = DEFAULTMEM * 1024 * 1024;
791 i = COM_CheckParm("-mem");
793 host_parms.memsize = (int) (atof(com_argv[i+1]) * 1024 * 1024);
795 i = COM_CheckParm("-winmem");
797 host_parms.memsize = (int) (atof(com_argv[i+1]) * 1024 * 1024);
799 i = COM_CheckParm("-heapsize");
801 host_parms.memsize = (int) (atof(com_argv[i+1]) * 1024);
803 host_parms.membase = qmalloc(host_parms.memsize);
804 if (!host_parms.membase)
805 Sys_Error("Not enough memory free, close some programs and try again, or free disk space\n");
807 com_argc = host_parms.argc;
808 com_argv = host_parms.argv;
810 Memory_Init (host_parms.membase, host_parms.memsize);
815 COM_Init (host_parms.basedir);
817 W_LoadWadFile ("gfx.wad");
826 Con_Printf ("Exe: "__TIME__" "__DATE__"\n");
827 Con_Printf ("%4.1f megabyte heap\n",host_parms.memsize/(1024*1024.0));
829 if (cls.state != ca_dedicated)
831 Palette_Init("gfx/palette.lmp");
833 #ifndef _WIN32 // on non win32, mouse comes before video for security reasons
843 #ifdef _WIN32 // on non win32, mouse comes before video for security reasons
848 Cbuf_InsertText ("exec quake.rc\n");
850 Hunk_AllocName (0, "-HOST_HUNKLEVEL-");
851 host_hunklevel = Hunk_LowMark ();
853 host_initialized = true;
855 Sys_Printf ("========Quake Initialized=========\n");
863 FIXME: this is a callback from Sys_Quit and Sys_Error. It would be better
864 to run quit through here before the final handoff to the sys code.
867 void Host_Shutdown(void)
869 static qboolean isdown = false;
873 printf ("recursive shutdown\n");
878 // keep Con_Printf from trying to update the screen
879 scr_disabled_for_loading = true;
881 Host_WriteConfiguration ();
888 if (cls.state != ca_dedicated)
890 R_Modules_Shutdown();