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)
43 double realtime; // without any filtering or bounding
44 double oldrealtime; // last frame run
53 client_t *host_client; // current client
55 jmp_buf host_abortserver;
57 cvar_t host_framerate = {"host_framerate","0"}; // set for slow motion
58 cvar_t host_speeds = {"host_speeds","0"}; // set for running times
59 cvar_t slowmo = {"slowmo", "1.0"}; // LordHavoc: framerate independent slowmo
60 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)
61 cvar_t host_maxfps = {"host_maxfps", "1000"}; // LordHavoc: framerate upper cap
63 cvar_t sys_ticrate = {"sys_ticrate","0.05"};
64 cvar_t serverprofile = {"serverprofile","0"};
66 cvar_t fraglimit = {"fraglimit","0",false,true};
67 cvar_t timelimit = {"timelimit","0",false,true};
68 cvar_t teamplay = {"teamplay","0",false,true};
70 cvar_t samelevel = {"samelevel","0"};
71 cvar_t noexit = {"noexit","0",false,true};
73 cvar_t developer = {"developer","0"};
75 cvar_t skill = {"skill","1"}; // 0 - 3
76 cvar_t deathmatch = {"deathmatch","0"}; // 0, 1, or 2
77 cvar_t coop = {"coop","0"}; // 0 or 1
79 cvar_t pausable = {"pausable","1"};
81 cvar_t temp1 = {"temp1","0"};
83 cvar_t timestamps = {"timestamps", "0", true};
84 cvar_t timeformat = {"timeformat", "[%b %e %X] ", true};
91 void Host_EndGame (char *message, ...)
96 va_start (argptr,message);
97 vsprintf (string,message,argptr);
99 Con_DPrintf ("Host_EndGame: %s\n",string);
102 Host_ShutdownServer (false);
104 if (cls.state == ca_dedicated)
105 Sys_Error ("Host_EndGame: %s\n",string); // dedicated servers exit
107 if (cls.demonum != -1)
112 longjmp (host_abortserver, 1);
119 This shuts down both the client and server
122 char hosterrorstring[4096];
123 extern qboolean hostloopactive;
124 void Host_Error (char *error, ...)
127 static qboolean inerror = false;
129 // LordHavoc: if host_frame loop has not been run yet, do a Sys_Error instead
133 va_start (argptr,error);
134 vsprintf (string,error,argptr);
136 Sys_Error ("%s", string);
142 va_start (argptr,error);
143 vsprintf (string,error,argptr);
145 Sys_Error ("Host_Error: recursively entered (original error was: %s new error is: %s)", hosterrorstring, string);
149 SCR_EndLoadingPlaque (); // reenable screen updates
151 va_start (argptr,error);
152 vsprintf (hosterrorstring,error,argptr);
154 Con_Printf ("Host_Error: %s\n",hosterrorstring);
157 Host_ShutdownServer (false);
159 if (cls.state == ca_dedicated)
160 Sys_Error ("Host_Error: %s\n",hosterrorstring); // dedicated servers exit
167 longjmp (host_abortserver, 1);
175 void Host_FindMaxClients (void)
181 i = COM_CheckParm ("-dedicated");
184 cls.state = ca_dedicated;
185 if (i != (com_argc - 1))
187 svs.maxclients = atoi (com_argv[i+1]);
193 cls.state = ca_disconnected;
195 i = COM_CheckParm ("-listen");
198 if (cls.state == ca_dedicated)
199 Sys_Error ("Only one of -dedicated or -listen can be specified");
200 if (i != (com_argc - 1))
201 svs.maxclients = atoi (com_argv[i+1]);
205 if (svs.maxclients < 1)
207 else if (svs.maxclients > MAX_SCOREBOARD)
208 svs.maxclients = MAX_SCOREBOARD;
210 svs.maxclientslimit = svs.maxclients;
211 if (svs.maxclientslimit < MAX_SCOREBOARD) // LordHavoc: upped listen mode limit from 4 to MAX_SCOREBOARD
212 svs.maxclientslimit = MAX_SCOREBOARD;
213 svs.clients = Hunk_AllocName (svs.maxclientslimit*sizeof(client_t), "clients");
215 if (svs.maxclients > 1)
216 Cvar_SetValue ("deathmatch", 1.0);
218 Cvar_SetValue ("deathmatch", 0.0);
223 =======================
225 ======================
227 void Host_InitLocal (void)
229 Host_InitCommands ();
231 Cvar_RegisterVariable (&host_framerate);
232 Cvar_RegisterVariable (&host_speeds);
233 Cvar_RegisterVariable (&slowmo);
234 Cvar_RegisterVariable (&host_minfps);
235 Cvar_RegisterVariable (&host_maxfps);
237 Cvar_RegisterVariable (&sys_ticrate);
238 Cvar_RegisterVariable (&serverprofile);
240 Cvar_RegisterVariable (&fraglimit);
241 Cvar_RegisterVariable (&timelimit);
242 Cvar_RegisterVariable (&teamplay);
243 Cvar_RegisterVariable (&samelevel);
244 Cvar_RegisterVariable (&noexit);
245 Cvar_RegisterVariable (&skill);
246 Cvar_RegisterVariable (&developer);
247 Cvar_RegisterVariable (&deathmatch);
248 Cvar_RegisterVariable (&coop);
250 Cvar_RegisterVariable (&pausable);
252 Cvar_RegisterVariable (&temp1);
254 Cvar_RegisterVariable (×tamps);
255 Cvar_RegisterVariable (&timeformat);
257 Host_FindMaxClients ();
259 host_time = 1.0; // so a think at time 0 won't get called
265 Host_WriteConfiguration
267 Writes key bindings and archived cvars to config.cfg
270 void Host_WriteConfiguration (void)
274 // dedicated servers initialize the host but don't parse and set the
276 if (host_initialized & !isDedicated)
278 f = fopen (va("%s/config.cfg",com_gamedir), "w");
281 Con_Printf ("Couldn't write config.cfg.\n");
285 Key_WriteBindings (f);
286 Cvar_WriteVariables (f);
297 Sends text across to be displayed
298 FIXME: make this just a stuffed echo?
301 void SV_ClientPrintf (char *fmt, ...)
306 va_start (argptr,fmt);
307 vsprintf (string, fmt,argptr);
310 MSG_WriteByte (&host_client->message, svc_print);
311 MSG_WriteString (&host_client->message, string);
318 Sends text to all active clients
321 void SV_BroadcastPrintf (char *fmt, ...)
327 va_start (argptr,fmt);
328 vsprintf (string, fmt,argptr);
331 for (i=0 ; i<svs.maxclients ; i++)
332 if (svs.clients[i].active && svs.clients[i].spawned)
334 MSG_WriteByte (&svs.clients[i].message, svc_print);
335 MSG_WriteString (&svs.clients[i].message, string);
343 Send text over to the client to be executed
346 void Host_ClientCommands (char *fmt, ...)
351 va_start (argptr,fmt);
352 vsprintf (string, fmt,argptr);
355 MSG_WriteByte (&host_client->message, svc_stufftext);
356 MSG_WriteString (&host_client->message, string);
360 =====================
363 Called when the player is getting totally kicked off the host
364 if (crash = true), don't bother sending signofs
365 =====================
367 void SV_DropClient (qboolean crash)
375 // send any final messages (don't check for errors)
376 if (NET_CanSendMessage (host_client->netconnection))
378 MSG_WriteByte (&host_client->message, svc_disconnect);
379 NET_SendMessage (host_client->netconnection, &host_client->message);
382 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)
384 // call the prog function for removing a client
385 // this will set the body to a dead frame, among other things
386 saveSelf = pr_global_struct->self;
387 pr_global_struct->self = EDICT_TO_PROG(host_client->edict);
388 PR_ExecuteProgram (pr_global_struct->ClientDisconnect, "QC function ClientDisconnect is missing");
389 pr_global_struct->self = saveSelf;
392 Sys_Printf ("Client %s removed\n",host_client->name);
395 // break the net connection
396 NET_Close (host_client->netconnection);
397 host_client->netconnection = NULL;
399 // free the client (the body stays around)
400 host_client->active = false;
401 host_client->name[0] = 0;
402 host_client->old_frags = -999999;
403 net_activeconnections--;
405 // send notification to all clients
406 for (i=0, client = svs.clients ; i<svs.maxclients ; i++, client++)
410 MSG_WriteByte (&client->message, svc_updatename);
411 MSG_WriteByte (&client->message, host_client - svs.clients);
412 MSG_WriteString (&client->message, "");
413 MSG_WriteByte (&client->message, svc_updatefrags);
414 MSG_WriteByte (&client->message, host_client - svs.clients);
415 MSG_WriteShort (&client->message, 0);
416 MSG_WriteByte (&client->message, svc_updatecolors);
417 MSG_WriteByte (&client->message, host_client - svs.clients);
418 MSG_WriteByte (&client->message, 0);
426 This only happens at the end of a game, not between levels
429 void Host_ShutdownServer(qboolean crash)
442 // stop all client sounds immediately
443 if (cls.state == ca_connected)
446 // flush any pending messages - like the score!!!
447 start = Sys_FloatTime();
451 for (i=0, host_client = svs.clients ; i<svs.maxclients ; i++, host_client++)
453 if (host_client->active && host_client->message.cursize)
455 if (NET_CanSendMessage (host_client->netconnection))
457 NET_SendMessage(host_client->netconnection, &host_client->message);
458 SZ_Clear (&host_client->message);
462 NET_GetMessage(host_client->netconnection);
467 if ((Sys_FloatTime() - start) > 3.0)
472 // make sure all the clients know we're disconnecting
476 MSG_WriteByte(&buf, svc_disconnect);
477 count = NET_SendToAll(&buf, 5);
479 Con_Printf("Host_ShutdownServer: NET_SendToAll failed for %u clients\n", count);
481 for (i=0, host_client = svs.clients ; i<svs.maxclients ; i++, host_client++)
482 if (host_client->active)
483 SV_DropClient(crash);
488 memset (&sv, 0, sizeof(sv));
489 memset (svs.clients, 0, svs.maxclientslimit*sizeof(client_t));
497 This clears all the memory used by both the client and server, but does
498 not reinitialize anything.
501 void Host_ClearMemory (void)
503 Con_DPrintf ("Clearing memory\n");
506 Hunk_FreeToLowMark (host_hunklevel);
509 memset (&sv, 0, sizeof(sv));
510 memset (&cl, 0, sizeof(cl));
514 //============================================================================
520 Returns false if the time is too short to run a frame
523 qboolean Host_FilterTime (float 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 if ((!cls.timedemo) && ((realtime - oldrealtime) < (1.0 / host_maxfps.value)))
535 return false; // framerate is too high
537 host_realframetime = host_frametime = realtime - oldrealtime; // LordHavoc: copy into host_realframetime as well
538 oldrealtime = realtime;
541 return true; // disable time effects
543 if (host_framerate.value > 0)
544 host_frametime = host_framerate.value;
547 // don't allow really short frames
548 if (host_frametime > (1.0 / host_minfps.value))
549 host_frametime = (1.0 / host_minfps.value);
552 host_frametime *= slowmo.value;
553 cl.frametime = host_frametime;
561 Host_GetConsoleCommands
563 Add them exactly as if they had been typed at the console
566 void Host_GetConsoleCommands (void)
572 cmd = Sys_ConsoleInput ();
586 void Host_ServerFrame (void)
588 static double frametimetotal = 0, lastservertime = 0;
589 frametimetotal += host_frametime;
590 // LordHavoc: cap server at sys_ticrate in listen games
591 if (!isDedicated && svs.maxclients > 1 && ((realtime - lastservertime) < sys_ticrate.value))
593 // run the world state
594 sv.frametime = pr_global_struct->frametime = frametimetotal;
596 lastservertime = realtime;
597 // pr_global_struct->frametime = host_frametime;
599 // set the time and clear the general datagram
602 // check for new clients
603 SV_CheckForNewClients ();
605 // read client messages
608 // move things around and think
609 // always pause in single player if in console or menus
610 if (!sv.paused && (svs.maxclients > 1 || key_dest == key_game) )
613 // send all messages to the clients
614 SV_SendClientMessages ();
622 Runs all active servers
625 void _Host_Frame (float time)
627 static double time1 = 0;
628 static double time2 = 0;
629 static double time3 = 0;
630 int pass1, pass2, pass3;
632 if (setjmp (host_abortserver) )
633 return; // something bad happened, or the server disconnected
636 // keep the random time dependent
639 // decide the simulation time
640 if (!Host_FilterTime (time))
641 return; // don't run too fast, or packets will flood out
643 // get new key events
644 Sys_SendKeyEvents ();
646 // allow mice or other external controllers to add commands
649 // process console commands
654 // if running the server locally, make intentions now
658 //-------------------
662 //-------------------
664 // check for commands typed to the host
665 Host_GetConsoleCommands ();
670 //-------------------
674 //-------------------
676 // if running the server remotely, send intentions now after
677 // the incoming messages have been read
681 host_time += host_frametime;
683 // fetch results from server
684 if (cls.state == ca_connected)
685 CL_ReadFromServer ();
688 if (host_speeds.value)
689 time1 = Sys_FloatTime ();
693 if (host_speeds.value)
694 time2 = Sys_FloatTime ();
697 if (cls.signon == SIGNONS)
699 S_Update (r_origin, vpn, vright, vup);
703 S_Update (vec3_origin, vec3_origin, vec3_origin, vec3_origin);
707 if (host_speeds.value)
709 pass1 = (time1 - time3)*1000000;
710 time3 = Sys_FloatTime ();
711 pass2 = (time2 - time1)*1000000;
712 pass3 = (time3 - time2)*1000000;
713 Con_Printf ("%6ius total %6ius server %6ius gfx %6ius snd\n",
714 pass1+pass2+pass3, pass1, pass2, pass3);
720 void Host_Frame (float time)
723 static double timetotal;
724 static int timecount;
727 if (!serverprofile.value)
733 time1 = Sys_FloatTime ();
735 time2 = Sys_FloatTime ();
737 timetotal += time2 - time1;
740 if (timecount < 1000)
743 m = timetotal*1000/timecount;
747 for (i=0 ; i<svs.maxclients ; i++)
749 if (svs.clients[i].active)
753 Con_Printf ("serverprofile: %2i clients %2i msec\n", c, m);
756 //============================================================================
760 #define VCR_SIGNATURE 0x56435231
768 if (COM_CheckParm("-playback"))
771 Sys_Error("No other parameters allowed with -playback\n");
773 Sys_FileOpenRead("quake.vcr", &vcrFile);
775 Sys_Error("playback file not found\n");
777 Sys_FileRead (vcrFile, &i, sizeof(int));
778 if (i != VCR_SIGNATURE)
779 Sys_Error("Invalid signature in vcr file\n");
781 Sys_FileRead (vcrFile, &com_argc, sizeof(int));
782 com_argv = qmalloc(com_argc * sizeof(char *));
783 com_argv[0] = host_parms.argv[0];
784 for (i = 0; i < com_argc; i++)
786 Sys_FileRead (vcrFile, &len, sizeof(int));
788 Sys_FileRead (vcrFile, p, len);
791 com_argc++; /* add one for arg[0] */
792 host_parms.argc = com_argc;
793 host_parms.argv = com_argv;
796 if ( (n = COM_CheckParm("-record")) != 0)
798 vcrFile = Sys_FileOpenWrite("quake.vcr");
801 Sys_FileWrite(vcrFile, &i, sizeof(int));
803 Sys_FileWrite(vcrFile, &i, sizeof(int));
804 for (i = 1; i < com_argc; i++)
809 Sys_FileWrite(vcrFile, &len, sizeof(int));
810 Sys_FileWrite(vcrFile, "-playback", len);
813 len = strlen(com_argv[i]) + 1;
814 Sys_FileWrite(vcrFile, &len, sizeof(int));
815 Sys_FileWrite(vcrFile, com_argv[i], len);
833 minimum_memory = MINIMUM_MEMORY;
835 minimum_memory = MINIMUM_MEMORY_LEVELPAK;
837 if (COM_CheckParm ("-minmemory"))
838 host_parms.memsize = minimum_memory;
840 if (host_parms.memsize < minimum_memory)
841 Sys_Error ("Only %4.1f megs of memory available, can't execute game", host_parms.memsize / (float)0x100000);
844 host_parms.memsize = DEFAULTMEM * 1024 * 1024;
846 i = COM_CheckParm("-mem");
848 host_parms.memsize = (int) (atof(com_argv[i+1]) * 1024 * 1024);
850 i = COM_CheckParm("-winmem");
852 host_parms.memsize = (int) (atof(com_argv[i+1]) * 1024 * 1024);
854 i = COM_CheckParm("-heapsize");
856 host_parms.memsize = (int) (atof(com_argv[i+1]) * 1024);
858 host_parms.membase = qmalloc(host_parms.memsize);
859 if (!host_parms.membase)
860 Sys_Error("Not enough memory free, close some programs and try again, or free disk space\n");
862 com_argc = host_parms.argc;
863 com_argv = host_parms.argv;
865 Memory_Init (host_parms.membase, host_parms.memsize);
871 COM_Init (host_parms.basedir);
873 W_LoadWadFile ("gfx.wad");
882 Con_Printf ("Exe: "__TIME__" "__DATE__"\n");
883 Con_Printf ("%4.1f megabyte heap\n",host_parms.memsize/(1024*1024.0));
885 R_InitTextures (); // needed even for dedicated servers
887 if (cls.state != ca_dedicated)
889 Palette_Init("gfx/palette.lmp");
891 #ifndef _WIN32 // on non win32, mouse comes before video for security reasons
901 #ifdef _WIN32 // on non win32, mouse comes before video for security reasons
906 Cbuf_InsertText ("exec quake.rc\n");
908 Hunk_AllocName (0, "-HOST_HUNKLEVEL-");
909 host_hunklevel = Hunk_LowMark ();
911 host_initialized = true;
913 Sys_Printf ("========Quake Initialized=========\n");
921 FIXME: this is a callback from Sys_Quit and Sys_Error. It would be better
922 to run quit through here before the final handoff to the sys code.
925 void Host_Shutdown(void)
927 static qboolean isdown = false;
931 printf ("recursive shutdown\n");
936 // keep Con_Printf from trying to update the screen
937 scr_disabled_for_loading = true;
939 Host_WriteConfiguration ();
946 if (cls.state != ca_dedicated)
948 R_Modules_Shutdown();