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 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 sv_echobprint = {CVAR_SAVE, "sv_echobprint", "1"}; // print broadcast messages in dedicated mode
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);
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]);
206 // Transfusion doesn't support single player games
207 if (gamemode == GAME_TRANSFUSION && svs.maxclients < 4)
210 if (svs.maxclients < 1)
212 else if (svs.maxclients > MAX_SCOREBOARD)
213 svs.maxclients = MAX_SCOREBOARD;
215 svs.maxclientslimit = svs.maxclients;
216 if (svs.maxclientslimit < MAX_SCOREBOARD) // LordHavoc: upped listen mode limit from 4 to MAX_SCOREBOARD
217 svs.maxclientslimit = MAX_SCOREBOARD;
218 if (!clients_mempool)
219 clients_mempool = Mem_AllocPool("clients");
221 Mem_Free(svs.clients);
222 svs.clients = Mem_Alloc(clients_mempool, svs.maxclientslimit*sizeof(client_t));
224 if (svs.maxclients > 1)
225 Cvar_SetValue ("deathmatch", 1.0);
227 Cvar_SetValue ("deathmatch", 0.0);
232 =======================
234 ======================
236 void Host_InitLocal (void)
238 Host_InitCommands ();
240 Cvar_RegisterVariable (&host_framerate);
241 Cvar_RegisterVariable (&host_speeds);
242 Cvar_RegisterVariable (&slowmo);
243 Cvar_RegisterVariable (&host_minfps);
244 Cvar_RegisterVariable (&host_maxfps);
246 Cvar_RegisterVariable (&sv_echobprint);
248 Cvar_RegisterVariable (&sys_ticrate);
249 Cvar_RegisterVariable (&serverprofile);
251 Cvar_RegisterVariable (&fraglimit);
252 Cvar_RegisterVariable (&timelimit);
253 Cvar_RegisterVariable (&teamplay);
254 Cvar_RegisterVariable (&samelevel);
255 Cvar_RegisterVariable (&noexit);
256 Cvar_RegisterVariable (&skill);
257 Cvar_RegisterVariable (&developer);
258 if (forcedeveloper) // make it real now that the cvar is registered
259 Cvar_SetValue("developer", 1);
260 Cvar_RegisterVariable (&deathmatch);
261 Cvar_RegisterVariable (&coop);
263 Cvar_RegisterVariable (&pausable);
265 Cvar_RegisterVariable (&temp1);
267 Cvar_RegisterVariable (×tamps);
268 Cvar_RegisterVariable (&timeformat);
270 Host_FindMaxClients ();
276 Host_WriteConfiguration
278 Writes key bindings and archived cvars to config.cfg
281 void Host_WriteConfiguration (void)
285 // dedicated servers initialize the host but don't parse and set the
287 if (host_initialized && cls.state != ca_dedicated)
289 f = Qopen (va("%s/config.cfg",com_gamedir), "w");
292 Con_Printf ("Couldn't write config.cfg.\n");
296 Key_WriteBindings (f);
297 Cvar_WriteVariables (f);
308 Sends text across to be displayed
309 FIXME: make this just a stuffed echo?
312 void SV_ClientPrintf (char *fmt, ...)
317 va_start (argptr,fmt);
318 vsprintf (string, fmt,argptr);
321 MSG_WriteByte (&host_client->message, svc_print);
322 MSG_WriteString (&host_client->message, string);
329 Sends text to all active clients
332 void SV_BroadcastPrintf (char *fmt, ...)
338 va_start (argptr,fmt);
339 vsprintf (string, fmt,argptr);
342 for (i=0 ; i<svs.maxclients ; i++)
343 if (svs.clients[i].active && svs.clients[i].spawned)
345 MSG_WriteByte (&svs.clients[i].message, svc_print);
346 MSG_WriteString (&svs.clients[i].message, string);
349 if (sv_echobprint.integer && cls.state == ca_dedicated)
350 Sys_Printf ("%s", string);
357 Send text over to the client to be executed
360 void Host_ClientCommands (char *fmt, ...)
365 va_start (argptr,fmt);
366 vsprintf (string, fmt,argptr);
369 MSG_WriteByte (&host_client->message, svc_stufftext);
370 MSG_WriteString (&host_client->message, string);
374 =====================
377 Called when the player is getting totally kicked off the host
378 if (crash = true), don't bother sending signofs
379 =====================
381 void SV_DropClient (qboolean crash)
389 // send any final messages (don't check for errors)
390 if (NET_CanSendMessage (host_client->netconnection))
392 MSG_WriteByte (&host_client->message, svc_disconnect);
393 NET_SendMessage (host_client->netconnection, &host_client->message);
396 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)
398 // call the prog function for removing a client
399 // this will set the body to a dead frame, among other things
400 saveSelf = pr_global_struct->self;
401 pr_global_struct->self = EDICT_TO_PROG(host_client->edict);
402 PR_ExecuteProgram (pr_global_struct->ClientDisconnect, "QC function ClientDisconnect is missing");
403 pr_global_struct->self = saveSelf;
406 Sys_Printf ("Client %s removed\n",host_client->name);
409 // break the net connection
410 NET_Close (host_client->netconnection);
411 host_client->netconnection = NULL;
413 // free the client (the body stays around)
414 host_client->active = false;
415 host_client->name[0] = 0;
416 host_client->old_frags = -999999;
417 net_activeconnections--;
419 // send notification to all clients
420 for (i=0, client = svs.clients ; i<svs.maxclients ; i++, client++)
424 MSG_WriteByte (&client->message, svc_updatename);
425 MSG_WriteByte (&client->message, host_client - svs.clients);
426 MSG_WriteString (&client->message, "");
427 MSG_WriteByte (&client->message, svc_updatefrags);
428 MSG_WriteByte (&client->message, host_client - svs.clients);
429 MSG_WriteShort (&client->message, 0);
430 MSG_WriteByte (&client->message, svc_updatecolors);
431 MSG_WriteByte (&client->message, host_client - svs.clients);
432 MSG_WriteByte (&client->message, 0);
440 This only happens at the end of a game, not between levels
443 void Host_ShutdownServer(qboolean crash)
454 // print out where the crash happened, if it was caused by QC
459 // stop all client sounds immediately
462 // flush any pending messages - like the score!!!
463 start = Sys_DoubleTime();
467 for (i=0, host_client = svs.clients ; i<svs.maxclients ; i++, host_client++)
469 if (host_client->active && host_client->message.cursize)
471 if (NET_CanSendMessage (host_client->netconnection))
473 NET_SendMessage(host_client->netconnection, &host_client->message);
474 SZ_Clear (&host_client->message);
478 NET_GetMessage(host_client->netconnection);
483 if ((Sys_DoubleTime() - start) > 3.0)
488 // make sure all the clients know we're disconnecting
492 MSG_WriteByte(&buf, svc_disconnect);
493 count = NET_SendToAll(&buf, 5);
495 Con_Printf("Host_ShutdownServer: NET_SendToAll failed for %u clients\n", count);
497 for (i=0, host_client = svs.clients ; i<svs.maxclients ; i++, host_client++)
498 if (host_client->active)
499 SV_DropClient(crash);
504 memset (&sv, 0, sizeof(sv));
505 memset (svs.clients, 0, svs.maxclientslimit*sizeof(client_t));
513 This clears all the memory used by both the client and server, but does
514 not reinitialize anything.
517 void Host_ClearMemory (void)
519 Con_DPrintf ("Clearing memory\n");
523 memset (&sv, 0, sizeof(sv));
524 memset (&cl, 0, sizeof(cl));
528 //============================================================================
534 Returns false if the time is too short to run a frame
537 extern cvar_t cl_avidemo;
538 qboolean Host_FilterTime (double time)
543 if (slowmo.value < 0.0f)
544 Cvar_SetValue("slowmo", 0.0f);
545 if (host_minfps.value < 10.0f)
546 Cvar_SetValue("host_minfps", 10.0f);
547 if (host_maxfps.value < host_minfps.value)
548 Cvar_SetValue("host_maxfps", host_minfps.value);
549 if (cl_avidemo.value < 0.1f && cl_avidemo.value != 0.0f)
550 Cvar_SetValue("cl_avidemo", 0.0f);
552 // check if framerate is too high
553 if (cl_avidemo.value >= 0.1f)
555 timecap = 1.0 / (double)cl_avidemo.value;
556 if ((realtime - oldrealtime) < timecap)
559 else if (!cls.timedemo)
561 // default to sys_ticrate (server framerate - presumably low) unless we're the active window and either connected to a server or playing a video
562 timecap = sys_ticrate.value;
563 if (vid_activewindow && (cls.state == ca_connected || cl_videoplaying))
564 timecap = 1.0 / host_maxfps.value;
566 if ((realtime - oldrealtime) < timecap)
570 // LordHavoc: copy into host_realframetime as well
571 host_realframetime = host_frametime = realtime - oldrealtime;
572 oldrealtime = realtime;
576 // disable time effects
577 cl.frametime = host_frametime;
581 if (host_framerate.value > 0)
582 host_frametime = host_framerate.value;
583 else if (cl_avidemo.value >= 0.1f)
584 host_frametime = (1.0 / cl_avidemo.value);
587 // don't allow really short frames
588 if (host_frametime > (1.0 / host_minfps.value))
589 host_frametime = (1.0 / host_minfps.value);
592 cl.frametime = host_frametime = bound(0, host_frametime * slowmo.value, 0.1f); // LordHavoc: the QC code relies on no less than 10fps
600 Host_GetConsoleCommands
602 Add them exactly as if they had been typed at the console
605 void Host_GetConsoleCommands (void)
611 cmd = Sys_ConsoleInput ();
625 void Host_ServerFrame (void)
627 static double frametimetotal = 0, lastservertime = 0;
628 frametimetotal += host_frametime;
629 // LordHavoc: cap server at sys_ticrate in listen games
630 if (cls.state != ca_dedicated && svs.maxclients > 1 && ((realtime - lastservertime) < sys_ticrate.value))
632 // run the world state
633 if (!sv.paused && (svs.maxclients > 1 || (key_dest == key_game && !key_consoleactive)))
634 sv.frametime = pr_global_struct->frametime = frametimetotal;
638 lastservertime = realtime;
640 // set the time and clear the general datagram
643 // check for new clients
644 SV_CheckForNewClients ();
646 // read client messages
649 // move things around and think
650 // always pause in single player if in console or menus
654 // send all messages to the clients
655 SV_SendClientMessages ();
663 Runs all active servers
666 void _Host_Frame (float time)
668 static double time1 = 0;
669 static double time2 = 0;
670 static double time3 = 0;
671 int pass1, pass2, pass3;
673 if (setjmp (host_abortserver) )
674 return; // something bad happened, or the server disconnected
676 // keep the random time dependent
679 // decide the simulation time
680 if (!Host_FilterTime (time))
682 // if time was rejected, don't totally hog the CPU
687 // get new key events
688 Sys_SendKeyEvents ();
690 // allow mice or other external controllers to add commands
693 // process console commands
698 // if running the server locally, make intentions now
702 //-------------------
706 //-------------------
708 // check for commands typed to the host
709 Host_GetConsoleCommands ();
714 //-------------------
718 //-------------------
720 // if running the server remotely, send intentions now after
721 // the incoming messages have been read
725 // fetch results from server
726 if (cls.state == ca_connected)
727 CL_ReadFromServer ();
734 if (host_speeds.integer)
735 time1 = Sys_DoubleTime ();
739 if (host_speeds.integer)
740 time2 = Sys_DoubleTime ();
743 if (cls.signon == SIGNONS)
745 // LordHavoc: this used to use renderer variables (eww)
746 vec3_t forward, right, up;
747 AngleVectors(cl.viewangles, forward, right, up);
748 S_Update (cl_entities[cl.viewentity].render.origin, forward, right, up);
751 S_Update (vec3_origin, vec3_origin, vec3_origin, vec3_origin);
755 if (host_speeds.integer)
757 pass1 = (time1 - time3)*1000000;
758 time3 = Sys_DoubleTime ();
759 pass2 = (time2 - time1)*1000000;
760 pass3 = (time3 - time2)*1000000;
761 Con_Printf ("%6ius total %6ius server %6ius gfx %6ius snd\n",
762 pass1+pass2+pass3, pass1, pass2, pass3);
766 host_loopactive = true;
769 void Host_Frame (float time)
772 static double timetotal;
773 static int timecount;
776 if (!serverprofile.integer)
782 time1 = Sys_DoubleTime ();
784 time2 = Sys_DoubleTime ();
786 timetotal += time2 - time1;
789 if (timecount < 1000)
792 m = timetotal*1000/timecount;
796 for (i=0 ; i<svs.maxclients ; i++)
798 if (svs.clients[i].active)
802 Con_Printf ("serverprofile: %2i clients %2i msec\n", c, m);
805 //============================================================================
807 void Render_Init(void);
808 void QuakeIO_Init(void);
815 void Host_Init (void)
817 // LordHavoc: quake never seeded the random number generator before... heh
820 // FIXME: this is evil, but possibly temporary
821 if (COM_CheckParm("-developer"))
823 forcedeveloper = true;
824 developer.integer = 1;
829 Memory_Init_Commands();
836 W_LoadWadFile ("gfx.wad");
846 Con_Printf ("Builddate: %s\n", buildstring);
848 if (cls.state != ca_dedicated)
856 #ifndef _WIN32 // on non win32, mouse comes before video for security reasons
866 #ifdef _WIN32 // on non win32, mouse comes before video for security reasons
871 Cbuf_InsertText ("exec quake.rc\n");
873 host_initialized = true;
875 Sys_Printf ("========Quake Initialized=========\n");
883 FIXME: this is a callback from Sys_Quit and Sys_Error. It would be better
884 to run quit through here before the final handoff to the sys code.
887 void Host_Shutdown(void)
889 static qboolean isdown = false;
893 printf ("recursive shutdown\n");
898 Host_WriteConfiguration ();
905 if (cls.state != ca_dedicated)
907 R_Modules_Shutdown();