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 // true if into command execution
38 qboolean host_initialized;
39 // LordHavoc: used to turn Host_Error into Sys_Error if starting up or shutting down
40 qboolean host_loopactive = false;
41 // LordHavoc: set when quit is executed
42 qboolean host_shuttingdown = false;
44 double host_frametime;
45 // LordHavoc: the real frametime, before slowmo and clamping are applied (used for console scrolling)
46 double host_realframetime;
47 // the real time, without any slowmo or clamping
49 // realtime from previous frame
51 // how many frames have occurred
54 // used for -developer commandline parameter, hacky hacky
58 client_t *host_client;
60 jmp_buf host_abortserver;
62 // pretend frames take this amount of time (in seconds), 0 = realtime
63 cvar_t host_framerate = {0, "host_framerate","0"};
64 // shows time used by certain subsystems
65 cvar_t host_speeds = {0, "host_speeds","0"};
66 // LordHavoc: framerate independent slowmo
67 cvar_t slowmo = {0, "slowmo", "1.0"};
68 // LordHavoc: game logic lower cap on framerate (if framerate is below this is, it pretends it is this, so game logic will run normally)
69 cvar_t host_minfps = {CVAR_SAVE, "host_minfps", "10"};
70 // LordHavoc: framerate upper cap
71 cvar_t host_maxfps = {CVAR_SAVE, "host_maxfps", "1000"};
73 // print broadcast messages in dedicated mode
74 cvar_t sv_echobprint = {CVAR_SAVE, "sv_echobprint", "1"};
76 cvar_t sys_ticrate = {CVAR_SAVE, "sys_ticrate","0.05"};
77 cvar_t serverprofile = {0, "serverprofile","0"};
79 cvar_t fraglimit = {CVAR_NOTIFY, "fraglimit","0"};
80 cvar_t timelimit = {CVAR_NOTIFY, "timelimit","0"};
81 cvar_t teamplay = {CVAR_NOTIFY, "teamplay","0"};
83 cvar_t samelevel = {0, "samelevel","0"};
84 cvar_t noexit = {CVAR_NOTIFY, "noexit","0"};
86 cvar_t developer = {0, "developer","0"};
88 cvar_t skill = {0, "skill","1"};
89 cvar_t deathmatch = {0, "deathmatch","0"};
90 cvar_t coop = {0, "coop","0"};
92 cvar_t pausable = {0, "pausable","1"};
94 cvar_t temp1 = {0, "temp1","0"};
96 cvar_t timestamps = {CVAR_SAVE, "timestamps", "0"};
97 cvar_t timeformat = {CVAR_SAVE, "timeformat", "[%b %e %X] "};
104 void Host_EndGame (const char *format, ...)
109 va_start (argptr,format);
110 vsprintf (string,format,argptr);
112 Con_DPrintf ("Host_EndGame: %s\n",string);
115 Host_ShutdownServer (false);
117 if (cls.state == ca_dedicated)
118 Sys_Error ("Host_EndGame: %s\n",string); // dedicated servers exit
120 if (cls.demonum != -1)
125 longjmp (host_abortserver, 1);
132 This shuts down both the client and server
135 void PRVM_ProcessError(void);
136 static char hosterrorstring1[4096];
137 static char hosterrorstring2[4096];
138 static qboolean hosterror = false;
139 extern char sv_spawnmap[MAX_QPATH];
140 extern char sv_loadgame[MAX_OSPATH];
141 void Host_Error (const char *error, ...)
145 va_start (argptr,error);
146 vsprintf (hosterrorstring1,error,argptr);
149 Con_Printf ("Host_Error: %s\n", hosterrorstring1);
151 // LordHavoc: if first frame has not been shown, or currently shutting
152 // down, do Sys_Error instead
153 if (!host_loopactive || host_shuttingdown)
154 Sys_Error ("Host_Error: %s", hosterrorstring1);
157 Sys_Error ("Host_Error: recursively entered (original error was: %s new error is: %s)", hosterrorstring2, hosterrorstring1);
160 strcpy(hosterrorstring2, hosterrorstring1);
162 // make sure we don't get in a loading loop
166 CL_Parse_DumpPacket();
170 //PRVM_Crash(); // crash current prog
172 // crash all prvm progs
178 Host_ShutdownServer (false);
180 if (cls.state == ca_dedicated)
181 Sys_Error ("Host_Error: %s\n",hosterrorstring2); // dedicated servers exit
188 longjmp (host_abortserver, 1);
191 mempool_t *sv_clients_mempool = NULL;
193 void Host_ServerOptions (void)
202 // client exists, check what mode the user wants
203 i = COM_CheckParm ("-dedicated");
206 cls.state = ca_dedicated;
207 // default players unless specified
208 if (i != (com_argc - 1))
209 numplayers = atoi (com_argv[i+1]);
210 if (COM_CheckParm ("-listen"))
211 Sys_Error ("Only one of -dedicated or -listen can be specified");
215 cls.state = ca_disconnected;
216 i = COM_CheckParm ("-listen");
219 // default players unless specified
220 if (i != (com_argc - 1))
221 numplayers = atoi (com_argv[i+1]);
225 // default players in some games, singleplayer in most
226 if (gamemode != GAME_TRANSFUSION && gamemode != GAME_GOODVSBAD2 && gamemode != GAME_NEXUIZ && gamemode != GAME_BATTLEMECH)
233 // no client in the executable, always start dedicated server
234 if (COM_CheckParm ("-listen"))
235 Sys_Error ("-listen not available in a dedicated server executable");
236 cls.state = ca_dedicated;
237 // check for -dedicated specifying how many players
238 i = COM_CheckParm ("-dedicated");
239 // default players unless specified
240 if (i && i != (com_argc - 1))
241 numplayers = atoi (com_argv[i+1]);
247 numplayers = bound(1, numplayers, MAX_SCOREBOARD);
249 if (numplayers > 1 && !deathmatch.integer)
250 Cvar_SetValueQuick(&deathmatch, 1);
252 svs.maxclients = numplayers;
253 sv_clients_mempool = Mem_AllocPool("server clients");
254 svs.clients = Mem_Alloc(sv_clients_mempool, sizeof(client_t) * svs.maxclients);
258 =======================
260 ======================
262 void Host_SaveConfig_f(void);
263 void Host_InitLocal (void)
265 Host_InitCommands ();
267 Cmd_AddCommand("saveconfig", Host_SaveConfig_f);
269 Cvar_RegisterVariable (&host_framerate);
270 Cvar_RegisterVariable (&host_speeds);
271 Cvar_RegisterVariable (&slowmo);
272 Cvar_RegisterVariable (&host_minfps);
273 Cvar_RegisterVariable (&host_maxfps);
275 Cvar_RegisterVariable (&sv_echobprint);
277 Cvar_RegisterVariable (&sys_ticrate);
278 Cvar_RegisterVariable (&serverprofile);
280 Cvar_RegisterVariable (&fraglimit);
281 Cvar_RegisterVariable (&timelimit);
282 Cvar_RegisterVariable (&teamplay);
283 Cvar_RegisterVariable (&samelevel);
284 Cvar_RegisterVariable (&noexit);
285 Cvar_RegisterVariable (&skill);
286 Cvar_RegisterVariable (&developer);
287 if (forcedeveloper) // make it real now that the cvar is registered
288 Cvar_SetValue("developer", 1);
289 Cvar_RegisterVariable (&deathmatch);
290 Cvar_RegisterVariable (&coop);
292 Cvar_RegisterVariable (&pausable);
294 Cvar_RegisterVariable (&temp1);
296 Cvar_RegisterVariable (×tamps);
297 Cvar_RegisterVariable (&timeformat);
299 Host_ServerOptions ();
307 Writes key bindings and archived cvars to config.cfg
310 void Host_SaveConfig_f(void)
314 // dedicated servers initialize the host but don't parse and set the
316 if (host_initialized && cls.state != ca_dedicated)
318 f = FS_Open ("config.cfg", "w", false);
321 Con_Printf ("Couldn't write config.cfg.\n");
325 Key_WriteBindings (f);
326 Cvar_WriteVariables (f);
337 Sends text across to be displayed
338 FIXME: make this just a stuffed echo?
341 void SV_ClientPrintf(const char *fmt, ...)
346 va_start (argptr,fmt);
347 vsprintf (string, fmt,argptr);
350 MSG_WriteByte (&host_client->message, svc_print);
351 MSG_WriteString (&host_client->message, string);
358 Sends text to all active clients
361 void SV_BroadcastPrintf(const char *fmt, ...)
368 va_start(argptr,fmt);
369 vsnprintf(string, sizeof(string), fmt,argptr);
372 for (i = 0, client = svs.clients;i < svs.maxclients;i++, client++)
376 MSG_WriteByte(&client->message, svc_print);
377 MSG_WriteString(&client->message, string);
381 if (sv_echobprint.integer && cls.state == ca_dedicated)
382 Sys_Printf("%s", string);
389 Send text over to the client to be executed
392 void Host_ClientCommands(const char *fmt, ...)
397 va_start(argptr,fmt);
398 vsprintf(string, fmt,argptr);
401 MSG_WriteByte(&host_client->message, svc_stufftext);
402 MSG_WriteString(&host_client->message, string);
406 =====================
409 Called when the player is getting totally kicked off the host
410 if (crash = true), don't bother sending signofs
411 =====================
413 void SV_DropClient(qboolean crash)
419 Con_Printf("Client \"%s\" dropped\n", host_client->name);
421 // send any final messages (don't check for errors)
422 if (host_client->netconnection)
424 // free the client (the body stays around)
427 // LordHavoc: no opportunity for resending, so use unreliable
428 MSG_WriteByte(&host_client->message, svc_disconnect);
429 NetConn_SendUnreliableMessage(host_client->netconnection, &host_client->message);
432 // break the net connection
433 NetConn_Close(host_client->netconnection);
434 host_client->netconnection = NULL;
436 // LordHavoc: don't call QC if server is dead (avoids recursive
437 // Host_Error in some mods when they run out of edicts)
438 if (sv.active && host_client->edict && host_client->spawned)
440 // call the prog function for removing a client
441 // this will set the body to a dead frame, among other things
442 saveSelf = pr_global_struct->self;
443 pr_global_struct->self = EDICT_TO_PROG(host_client->edict);
444 PR_ExecuteProgram(pr_global_struct->ClientDisconnect, "QC function ClientDisconnect is missing");
445 pr_global_struct->self = saveSelf;
449 // send notification to all clients
450 for (i = 0, client = svs.clients;i < svs.maxclients;i++, client++)
454 MSG_WriteByte(&client->message, svc_updatename);
455 MSG_WriteByte(&client->message, host_client->number);
456 MSG_WriteString(&client->message, "");
457 MSG_WriteByte(&client->message, svc_updatefrags);
458 MSG_WriteByte(&client->message, host_client->number);
459 MSG_WriteShort(&client->message, 0);
460 MSG_WriteByte(&client->message, svc_updatecolors);
461 MSG_WriteByte(&client->message, host_client->number);
462 MSG_WriteByte(&client->message, 0);
465 NetConn_Heartbeat(1);
467 // free the client now
468 if (host_client->entitydatabase4)
469 EntityFrame4_FreeDatabase(host_client->entitydatabase4);
470 // clear the client struct (this sets active to false)
471 memset(host_client, 0, sizeof(*host_client));
478 This only happens at the end of a game, not between levels
481 void Host_ShutdownServer(qboolean crash)
490 // print out where the crash happened, if it was caused by QC
495 // stop all client sounds immediately
498 NetConn_Heartbeat(2);
499 NetConn_Heartbeat(2);
501 // make sure all the clients know we're disconnecting
505 MSG_WriteByte(&buf, svc_disconnect);
506 count = NetConn_SendToAll(&buf, 5);
508 Con_Printf("Host_ShutdownServer: NetConn_SendToAll failed for %u clients\n", count);
510 for (i = 0, host_client = svs.clients;i < svs.maxclients;i++, host_client++)
511 if (host_client->active)
512 SV_DropClient(crash); // server shutdown
514 NetConn_CloseServerPorts();
519 memset(&sv, 0, sizeof(sv));
520 memset(svs.clients, 0, svs.maxclients*sizeof(client_t));
528 This clears all the memory used by both the client and server, but does
529 not reinitialize anything.
532 void Host_ClearMemory (void)
534 Con_DPrintf ("Clearing memory\n");
538 memset (&sv, 0, sizeof(sv));
539 memset (&cl, 0, sizeof(cl));
543 //============================================================================
549 Returns false if the time is too short to run a frame
552 extern cvar_t cl_avidemo;
553 qboolean Host_FilterTime (double time)
555 double timecap, timeleft;
558 if (slowmo.value < 0.0f)
559 Cvar_SetValue("slowmo", 0.0f);
560 if (host_minfps.value < 10.0f)
561 Cvar_SetValue("host_minfps", 10.0f);
562 if (host_maxfps.value < host_minfps.value)
563 Cvar_SetValue("host_maxfps", host_minfps.value);
564 if (cl_avidemo.value < 0.1f && cl_avidemo.value != 0.0f)
565 Cvar_SetValue("cl_avidemo", 0.0f);
567 // check if framerate is too high
570 // default to sys_ticrate (server framerate - presumably low) unless we
571 // have a good reason to run faster
572 timecap = sys_ticrate.value;
573 if (cl_avidemo.value >= 0.1f)
574 timecap = 1.0 / (double)cl_avidemo.value;
575 else if (vid_activewindow)
576 timecap = 1.0 / host_maxfps.value;
578 timeleft = oldrealtime + timecap - realtime;
581 // don't totally hog the CPU
582 if (timeleft >= 0.02)
588 // LordHavoc: copy into host_realframetime as well
589 host_realframetime = host_frametime = realtime - oldrealtime;
590 oldrealtime = realtime;
594 // disable time effects
595 cl.frametime = host_frametime;
599 if (host_framerate.value > 0)
600 host_frametime = host_framerate.value;
601 else if (cl_avidemo.value >= 0.1f)
602 host_frametime = (1.0 / cl_avidemo.value);
605 // don't allow really short frames
606 if (host_frametime > (1.0 / host_minfps.value))
607 host_frametime = (1.0 / host_minfps.value);
610 cl.frametime = host_frametime = bound(0, host_frametime * slowmo.value, 0.1f); // LordHavoc: the QC code relies on no less than 10fps
618 Host_GetConsoleCommands
620 Add them exactly as if they had been typed at the console
623 void Host_GetConsoleCommands (void)
629 cmd = Sys_ConsoleInput ();
643 void Host_ServerFrame (void)
645 static double frametimetotal = 0, lastservertime = 0;
646 frametimetotal += host_frametime;
647 // LordHavoc: cap server at sys_ticrate in networked games
648 if (!cl.islocalgame && ((realtime - lastservertime) < sys_ticrate.value))
651 NetConn_ServerFrame();
653 // run the world state
654 if (!sv.paused && (!cl.islocalgame || (key_dest == key_game && !key_consoleactive)))
655 sv.frametime = pr_global_struct->frametime = frametimetotal;
659 lastservertime = realtime;
661 // set the time and clear the general datagram
664 // read client messages
667 // move things around and think
668 // always pause in single player if in console or menus
672 // send all messages to the clients
673 SV_SendClientMessages();
675 // send an heartbeat if enough time has passed since the last one
676 NetConn_Heartbeat(0);
684 Runs all active servers
687 void _Host_Frame (float time)
689 static double time1 = 0;
690 static double time2 = 0;
691 static double time3 = 0;
692 int pass1, pass2, pass3;
693 usercmd_t cmd; // Used for receiving input
695 if (setjmp(host_abortserver))
696 return; // something bad happened, or the server disconnected
698 // keep the random time dependent
701 // decide the simulation time
702 if (!Host_FilterTime(time))
705 cl.islocalgame = NetConn_IsLocalGame();
707 // get new key events
710 // allow mice or other external controllers to add commands
713 // Collect input into cmd
714 IN_ProcessMove(&cmd);
716 // process console commands
719 // LordHavoc: map and load are delayed until video is initialized
720 Host_PerformSpawnServerAndLoadGame();
722 // if running the server locally, make intentions now
723 if (cls.state == ca_connected && sv.active)
726 //-------------------
730 //-------------------
732 // check for commands typed to the host
733 Host_GetConsoleCommands();
738 //-------------------
742 //-------------------
744 cl.oldtime = cl.time;
745 cl.time += cl.frametime;
747 NetConn_ClientFrame();
749 if (cls.state == ca_connected)
751 // if running the server remotely, send intentions now after
752 // the incoming messages have been read
763 if (host_speeds.integer)
764 time1 = Sys_DoubleTime();
768 if (host_speeds.integer)
769 time2 = Sys_DoubleTime();
772 if (cls.signon == SIGNONS && cl.viewentity >= 0 && cl.viewentity < MAX_EDICTS && cl_entities[cl.viewentity].state_current.active)
774 // LordHavoc: this used to use renderer variables (eww)
775 vec3_t forward, left, up, origin;
776 Matrix4x4_ToVectors(&cl_entities[cl.viewentity].render.matrix, forward, left, up, origin);
777 S_Update(origin, forward, left, up);
780 S_Update(vec3_origin, vec3_origin, vec3_origin, vec3_origin);
784 if (host_speeds.integer)
786 pass1 = (time1 - time3)*1000000;
787 time3 = Sys_DoubleTime();
788 pass2 = (time2 - time1)*1000000;
789 pass3 = (time3 - time2)*1000000;
790 Con_Printf("%6ius total %6ius server %6ius gfx %6ius snd\n",
791 pass1+pass2+pass3, pass1, pass2, pass3);
795 host_loopactive = true;
799 void Host_Frame (float time)
802 static double timetotal;
803 static int timecount;
806 if (!serverprofile.integer)
812 time1 = Sys_DoubleTime ();
814 time2 = Sys_DoubleTime ();
816 timetotal += time2 - time1;
819 if (timecount < 1000)
822 m = timetotal*1000/timecount;
826 for (i=0 ; i<svs.maxclients ; i++)
828 if (svs.clients[i].active)
832 Con_Printf ("serverprofile: %2i clients %2i msec\n", c, m);
835 //============================================================================
837 void Render_Init(void);
844 void Host_Init (void)
846 // LordHavoc: quake never seeded the random number generator before... heh
849 // FIXME: this is evil, but possibly temporary
850 if (COM_CheckParm("-developer"))
852 forcedeveloper = true;
853 developer.integer = 1;
858 Memory_Init_Commands();
872 Con_Printf ("Builddate: %s\n", buildstring);
874 if (cls.state != ca_dedicated)
886 Cbuf_InsertText ("exec quake.rc\n");
892 host_initialized = true;
894 Con_DPrintf ("========Initialized=========\n");
896 if (cls.state != ca_dedicated)
900 SCR_BeginLoadingPlaque();
909 FIXME: this is a callback from Sys_Quit and Sys_Error. It would be better
910 to run quit through here before the final handoff to the sys code.
913 void Host_Shutdown(void)
915 static qboolean isdown = false;
919 Con_Printf ("recursive shutdown\n");
929 // AK hmm, no PRVM_Shutdown(); yet
937 if (cls.state != ca_dedicated)
939 R_Modules_Shutdown();