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
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 // SCR_EndLoadingPlaque (); // reenable screen updates
149 va_start (argptr,error);
150 vsprintf (hosterrorstring,error,argptr);
152 Con_Printf ("Host_Error: %s\n",hosterrorstring);
155 Host_ShutdownServer (false);
157 if (cls.state == ca_dedicated)
158 Sys_Error ("Host_Error: %s\n",hosterrorstring); // dedicated servers exit
165 longjmp (host_abortserver, 1);
168 static mempool_t *clients_mempool;
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 if (!clients_mempool)
214 clients_mempool = Mem_AllocPool("clients");
216 Mem_Free(svs.clients);
217 svs.clients = Mem_Alloc(clients_mempool, svs.maxclientslimit*sizeof(client_t));
219 if (svs.maxclients > 1)
220 Cvar_SetValue ("deathmatch", 1.0);
222 Cvar_SetValue ("deathmatch", 0.0);
227 =======================
229 ======================
231 void Host_InitLocal (void)
233 Host_InitCommands ();
235 Cvar_RegisterVariable (&host_framerate);
236 Cvar_RegisterVariable (&host_speeds);
237 Cvar_RegisterVariable (&slowmo);
238 Cvar_RegisterVariable (&host_minfps);
239 Cvar_RegisterVariable (&host_maxfps);
241 Cvar_RegisterVariable (&sys_ticrate);
242 Cvar_RegisterVariable (&serverprofile);
244 Cvar_RegisterVariable (&fraglimit);
245 Cvar_RegisterVariable (&timelimit);
246 Cvar_RegisterVariable (&teamplay);
247 Cvar_RegisterVariable (&samelevel);
248 Cvar_RegisterVariable (&noexit);
249 Cvar_RegisterVariable (&skill);
250 Cvar_RegisterVariable (&developer);
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
445 if (cls.state == ca_connected)
448 // flush any pending messages - like the score!!!
449 start = Sys_DoubleTime();
453 for (i=0, host_client = svs.clients ; i<svs.maxclients ; i++, host_client++)
455 if (host_client->active && host_client->message.cursize)
457 if (NET_CanSendMessage (host_client->netconnection))
459 NET_SendMessage(host_client->netconnection, &host_client->message);
460 SZ_Clear (&host_client->message);
464 NET_GetMessage(host_client->netconnection);
469 if ((Sys_DoubleTime() - start) > 3.0)
474 // make sure all the clients know we're disconnecting
478 MSG_WriteByte(&buf, svc_disconnect);
479 count = NET_SendToAll(&buf, 5);
481 Con_Printf("Host_ShutdownServer: NET_SendToAll failed for %u clients\n", count);
483 for (i=0, host_client = svs.clients ; i<svs.maxclients ; i++, host_client++)
484 if (host_client->active)
485 SV_DropClient(crash);
490 memset (&sv, 0, sizeof(sv));
491 memset (svs.clients, 0, svs.maxclientslimit*sizeof(client_t));
499 This clears all the memory used by both the client and server, but does
500 not reinitialize anything.
503 void Host_ClearMemory (void)
505 Con_DPrintf ("Clearing memory\n");
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 (double time)
528 if (slowmo.value < 0.0f)
529 Cvar_SetValue("slowmo", 0.0f);
530 if (host_minfps.value < 10.0f)
531 Cvar_SetValue("host_minfps", 10.0f);
532 if (host_maxfps.value < host_minfps.value)
533 Cvar_SetValue("host_maxfps", host_minfps.value);
535 // check if framerate is too high
538 timecap = sys_ticrate.value;
539 if (cls.state == ca_connected)
540 timecap = 1.0 / host_maxfps.value;
542 if ((realtime - oldrealtime) < timecap)
546 // LordHavoc: copy into host_realframetime as well
547 host_realframetime = host_frametime = realtime - oldrealtime;
548 oldrealtime = realtime;
552 // disable time effects
553 cl.frametime = host_frametime;
557 if (host_framerate.value > 0)
558 host_frametime = host_framerate.value;
561 // don't allow really short frames
562 if (host_frametime > (1.0 / host_minfps.value))
563 host_frametime = (1.0 / host_minfps.value);
566 cl.frametime = host_frametime = bound(0, host_frametime * slowmo.value, 0.1f); // LordHavoc: the QC code relies on no less than 10fps
574 Host_GetConsoleCommands
576 Add them exactly as if they had been typed at the console
579 void Host_GetConsoleCommands (void)
585 cmd = Sys_ConsoleInput ();
599 void Host_ServerFrame (void)
601 static double frametimetotal = 0, lastservertime = 0;
602 frametimetotal += host_frametime;
603 // LordHavoc: cap server at sys_ticrate in listen games
604 if (cls.state != ca_dedicated && svs.maxclients > 1 && ((realtime - lastservertime) < sys_ticrate.value))
606 // run the world state
607 sv.frametime = pr_global_struct->frametime = frametimetotal;
609 lastservertime = realtime;
610 // pr_global_struct->frametime = host_frametime;
612 // set the time and clear the general datagram
615 // check for new clients
616 SV_CheckForNewClients ();
618 // read client messages
621 // move things around and think
622 // always pause in single player if in console or menus
623 if (!sv.paused && (svs.maxclients > 1 || key_dest == key_game) )
626 // send all messages to the clients
627 SV_SendClientMessages ();
635 Runs all active servers
638 void _Host_Frame (float time)
640 static double time1 = 0;
641 static double time2 = 0;
642 static double time3 = 0;
643 int pass1, pass2, pass3;
645 if (setjmp (host_abortserver) )
646 return; // something bad happened, or the server disconnected
648 // keep the random time dependent
651 // decide the simulation time
652 if (!Host_FilterTime (time))
654 // if time was rejected, don't totally hog the CPU
659 // get new key events
660 Sys_SendKeyEvents ();
662 // allow mice or other external controllers to add commands
665 // process console commands
670 // if running the server locally, make intentions now
674 //-------------------
678 //-------------------
680 // check for commands typed to the host
681 Host_GetConsoleCommands ();
686 //-------------------
690 //-------------------
692 // if running the server remotely, send intentions now after
693 // the incoming messages have been read
697 // fetch results from server
698 if (cls.state == ca_connected)
699 CL_ReadFromServer ();
704 if (host_speeds.integer)
705 time1 = Sys_DoubleTime ();
709 if (host_speeds.integer)
710 time2 = Sys_DoubleTime ();
713 if (cls.signon == SIGNONS)
715 S_Update (r_origin, vpn, vright, vup);
719 S_Update (vec3_origin, vec3_origin, vec3_origin, vec3_origin);
723 if (host_speeds.integer)
725 pass1 = (time1 - time3)*1000000;
726 time3 = Sys_DoubleTime ();
727 pass2 = (time2 - time1)*1000000;
728 pass3 = (time3 - time2)*1000000;
729 Con_Printf ("%6ius total %6ius server %6ius gfx %6ius snd\n",
730 pass1+pass2+pass3, pass1, pass2, pass3);
734 host_loopactive = true;
737 void Host_Frame (float time)
740 static double timetotal;
741 static int timecount;
744 if (!serverprofile.integer)
750 time1 = Sys_DoubleTime ();
752 time2 = Sys_DoubleTime ();
754 timetotal += time2 - time1;
757 if (timecount < 1000)
760 m = timetotal*1000/timecount;
764 for (i=0 ; i<svs.maxclients ; i++)
766 if (svs.clients[i].active)
770 Con_Printf ("serverprofile: %2i clients %2i msec\n", c, m);
773 //============================================================================
775 void Render_Init(void);
776 void QuakeIO_Init(void);
783 void Host_Init (void)
785 com_argc = host_parms.argc;
786 com_argv = host_parms.argv;
790 Memory_Init_Commands();
797 W_LoadWadFile ("gfx.wad");
807 Con_Printf ("Exe: "__TIME__" "__DATE__"\n");
809 if (cls.state != ca_dedicated)
817 #ifndef _WIN32 // on non win32, mouse comes before video for security reasons
827 #ifdef _WIN32 // on non win32, mouse comes before video for security reasons
832 Cbuf_InsertText ("exec quake.rc\n");
834 host_initialized = true;
836 Sys_Printf ("========Quake Initialized=========\n");
844 FIXME: this is a callback from Sys_Quit and Sys_Error. It would be better
845 to run quit through here before the final handoff to the sys code.
848 void Host_Shutdown(void)
850 static qboolean isdown = false;
854 printf ("recursive shutdown\n");
859 // keep Con_Printf from trying to update the screen
860 scr_disabled_for_loading = true;
862 Host_WriteConfiguration ();
869 if (cls.state != ca_dedicated)
871 R_Modules_Shutdown();