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
30 A server can always be started, even if the system started out as a client
33 A client can NOT be started if the system started as a dedicated server.
35 Memory is cleared / released when a server or client begins, not when they end.
39 // true if into command execution
40 qboolean host_initialized;
41 // LordHavoc: used to turn Host_Error into Sys_Error if starting up or shutting down
42 qboolean host_loopactive = false;
43 // LordHavoc: set when quit is executed
44 qboolean host_shuttingdown = false;
46 double host_frametime;
47 // LordHavoc: the real frametime, before slowmo and clamping are applied (used for console scrolling)
48 double host_realframetime;
49 // the real time, without any slowmo or clamping
51 // realtime from previous frame
53 // how many frames have occurred
56 // used for -developer commandline parameter, hacky hacky
60 client_t *host_client;
62 jmp_buf host_abortserver;
64 // pretend frames take this amount of time (in seconds), 0 = realtime
65 cvar_t host_framerate = {0, "host_framerate","0"};
66 // shows time used by certain subsystems
67 cvar_t host_speeds = {0, "host_speeds","0"};
68 // LordHavoc: framerate independent slowmo
69 cvar_t slowmo = {0, "slowmo", "1.0"};
70 // LordHavoc: game logic lower cap on framerate (if framerate is below this is, it pretends it is this, so game logic will run normally)
71 cvar_t host_minfps = {CVAR_SAVE, "host_minfps", "10"};
72 // LordHavoc: framerate upper cap
73 cvar_t host_maxfps = {CVAR_SAVE, "host_maxfps", "1000"};
75 // print broadcast messages in dedicated mode
76 cvar_t sv_echobprint = {CVAR_SAVE, "sv_echobprint", "1"};
78 cvar_t sys_ticrate = {CVAR_SAVE, "sys_ticrate","0.05"};
79 cvar_t serverprofile = {0, "serverprofile","0"};
81 cvar_t fraglimit = {CVAR_NOTIFY, "fraglimit","0"};
82 cvar_t timelimit = {CVAR_NOTIFY, "timelimit","0"};
83 cvar_t teamplay = {CVAR_NOTIFY, "teamplay","0"};
85 cvar_t samelevel = {0, "samelevel","0"};
86 cvar_t noexit = {CVAR_NOTIFY, "noexit","0"};
88 cvar_t developer = {0, "developer","0"};
90 cvar_t skill = {0, "skill","1"};
91 cvar_t deathmatch = {0, "deathmatch","0"};
92 cvar_t coop = {0, "coop","0"};
94 cvar_t pausable = {0, "pausable","1"};
96 cvar_t temp1 = {0, "temp1","0"};
98 cvar_t timestamps = {CVAR_SAVE, "timestamps", "0"};
99 cvar_t timeformat = {CVAR_SAVE, "timeformat", "[%b %e %X] "};
105 This shuts down both the client and server
108 void PRVM_ProcessError(void);
109 static char hosterrorstring1[4096];
110 static char hosterrorstring2[4096];
111 static qboolean hosterror = false;
112 void Host_Error (const char *error, ...)
116 va_start (argptr,error);
117 vsprintf (hosterrorstring1,error,argptr);
120 Con_Printf("Host_Error: %s\n", hosterrorstring1);
122 // LordHavoc: if first frame has not been shown, or currently shutting
123 // down, do Sys_Error instead
124 if (!host_loopactive || host_shuttingdown)
125 Sys_Error ("Host_Error: %s", hosterrorstring1);
128 Sys_Error ("Host_Error: recursively entered (original error was: %s new error is: %s)", hosterrorstring2, hosterrorstring1);
131 strcpy(hosterrorstring2, hosterrorstring1);
133 CL_Parse_DumpPacket();
137 //PRVM_Crash(); // crash current prog
139 // crash all prvm progs
144 Host_ShutdownServer (false);
146 if (cls.state == ca_dedicated)
147 Sys_Error ("Host_Error: %s\n",hosterrorstring2); // dedicated servers exit
154 longjmp (host_abortserver, 1);
157 mempool_t *sv_clients_mempool = NULL;
159 void Host_ServerOptions (void)
166 // COMMANDLINEOPTION: Server: -dedicated [playerlimit] starts a dedicated server (with a command console), default playerlimit is 8
167 // COMMANDLINEOPTION: Server: -listen [playerlimit] starts a multiplayer server with graphical client, like singleplayer but other players can connect, default playerlimit is 8
170 // client exists, check what mode the user wants
171 i = COM_CheckParm ("-dedicated");
174 cls.state = ca_dedicated;
175 // default players unless specified
176 if (i != (com_argc - 1))
177 numplayers = atoi (com_argv[i+1]);
178 if (COM_CheckParm ("-listen"))
179 Sys_Error ("Only one of -dedicated or -listen can be specified");
183 cls.state = ca_disconnected;
184 i = COM_CheckParm ("-listen");
187 // default players unless specified
188 if (i != (com_argc - 1))
189 numplayers = atoi (com_argv[i+1]);
193 // default players in some games, singleplayer in most
194 if (gamemode != GAME_TRANSFUSION && gamemode != GAME_GOODVSBAD2 && gamemode != GAME_NEXUIZ && gamemode != GAME_BATTLEMECH)
201 // no client in the executable, always start dedicated server
202 if (COM_CheckParm ("-listen"))
203 Sys_Error ("-listen not available in a dedicated server executable");
204 cls.state = ca_dedicated;
205 // check for -dedicated specifying how many players
206 i = COM_CheckParm ("-dedicated");
207 // default players unless specified
208 if (i && i != (com_argc - 1))
209 numplayers = atoi (com_argv[i+1]);
215 numplayers = bound(1, numplayers, MAX_SCOREBOARD);
217 if (numplayers > 1 && !deathmatch.integer)
218 Cvar_SetValueQuick(&deathmatch, 1);
220 svs.maxclients = numplayers;
221 sv_clients_mempool = Mem_AllocPool("server clients", 0, NULL);
222 svs.clients = Mem_Alloc(sv_clients_mempool, sizeof(client_t) * svs.maxclients);
226 =======================
228 ======================
230 void Host_SaveConfig_f(void);
231 void Host_InitLocal (void)
233 Host_InitCommands ();
235 Cmd_AddCommand("saveconfig", Host_SaveConfig_f);
237 Cvar_RegisterVariable (&host_framerate);
238 Cvar_RegisterVariable (&host_speeds);
239 Cvar_RegisterVariable (&slowmo);
240 Cvar_RegisterVariable (&host_minfps);
241 Cvar_RegisterVariable (&host_maxfps);
243 Cvar_RegisterVariable (&sv_echobprint);
245 Cvar_RegisterVariable (&sys_ticrate);
246 Cvar_RegisterVariable (&serverprofile);
248 Cvar_RegisterVariable (&fraglimit);
249 Cvar_RegisterVariable (&timelimit);
250 Cvar_RegisterVariable (&teamplay);
251 Cvar_RegisterVariable (&samelevel);
252 Cvar_RegisterVariable (&noexit);
253 Cvar_RegisterVariable (&skill);
254 Cvar_RegisterVariable (&developer);
255 if (forcedeveloper) // make it real now that the cvar is registered
256 Cvar_SetValue("developer", 1);
257 Cvar_RegisterVariable (&deathmatch);
258 Cvar_RegisterVariable (&coop);
260 Cvar_RegisterVariable (&pausable);
262 Cvar_RegisterVariable (&temp1);
264 Cvar_RegisterVariable (×tamps);
265 Cvar_RegisterVariable (&timeformat);
267 Host_ServerOptions ();
275 Writes key bindings and archived cvars to config.cfg
278 void Host_SaveConfig_f(void)
282 // dedicated servers initialize the host but don't parse and set the
284 if (host_initialized && cls.state != ca_dedicated)
286 f = FS_Open ("config.cfg", "w", false);
289 Con_Print("Couldn't write config.cfg.\n");
293 Key_WriteBindings (f);
294 Cvar_WriteVariables (f);
305 Sends text across to be displayed
306 FIXME: make this just a stuffed echo?
309 void SV_ClientPrint(const char *msg)
311 MSG_WriteByte(&host_client->message, svc_print);
312 MSG_WriteString(&host_client->message, msg);
319 Sends text across to be displayed
320 FIXME: make this just a stuffed echo?
323 void SV_ClientPrintf(const char *fmt, ...)
328 va_start(argptr,fmt);
329 vsnprintf(msg,sizeof(msg),fmt,argptr);
339 Sends text to all active clients
342 void SV_BroadcastPrint(const char *msg)
347 for (i = 0, client = svs.clients;i < svs.maxclients;i++, client++)
351 MSG_WriteByte(&client->message, svc_print);
352 MSG_WriteString(&client->message, msg);
356 if (sv_echobprint.integer && cls.state == ca_dedicated)
364 Sends text to all active clients
367 void SV_BroadcastPrintf(const char *fmt, ...)
372 va_start(argptr,fmt);
373 vsnprintf(msg,sizeof(msg),fmt,argptr);
376 SV_BroadcastPrint(msg);
383 Send text over to the client to be executed
386 void Host_ClientCommands(const char *fmt, ...)
391 va_start(argptr,fmt);
392 vsprintf(string, fmt,argptr);
395 MSG_WriteByte(&host_client->message, svc_stufftext);
396 MSG_WriteString(&host_client->message, string);
400 =====================
403 Called when the player is getting totally kicked off the host
404 if (crash = true), don't bother sending signofs
405 =====================
407 void SV_DropClient(qboolean crash)
410 Con_Printf("Client \"%s\" dropped\n", host_client->name);
412 // send any final messages (don't check for errors)
413 if (host_client->netconnection)
415 // free the client (the body stays around)
418 // LordHavoc: no opportunity for resending, so use unreliable
419 MSG_WriteByte(&host_client->message, svc_disconnect);
420 NetConn_SendUnreliableMessage(host_client->netconnection, &host_client->message);
423 // break the net connection
424 NetConn_Close(host_client->netconnection);
425 host_client->netconnection = NULL;
427 // LordHavoc: don't call QC if server is dead (avoids recursive
428 // Host_Error in some mods when they run out of edicts)
429 if (sv.active && host_client->edict && host_client->spawned)
431 // call the prog function for removing a client
432 // this will set the body to a dead frame, among other things
433 int saveSelf = pr_global_struct->self;
434 pr_global_struct->self = EDICT_TO_PROG(host_client->edict);
435 PR_ExecuteProgram(pr_global_struct->ClientDisconnect, "QC function ClientDisconnect is missing");
436 pr_global_struct->self = saveSelf;
440 // remove leaving player from scoreboard
441 // clear a fields that matter to DP_SV_CLIENTNAME and DP_SV_CLIENTCOLORS, and also frags
442 ED_ClearEdict(host_client->edict);
443 //host_client->edict->v->netname = PR_SetString(host_client->name);
444 //if ((val = GETEDICTFIELDVALUE(host_client->edict, eval_clientcolors)))
446 //host_client->edict->v->frags = 0;
447 host_client->name[0] = 0;
448 host_client->colors = 0;
449 host_client->frags = 0;
450 // send notification to all clients
451 // get number of client manually just to make sure we get it right...
452 i = host_client - svs.clients;
453 MSG_WriteByte (&sv.reliable_datagram, svc_updatename);
454 MSG_WriteByte (&sv.reliable_datagram, i);
455 MSG_WriteString (&sv.reliable_datagram, host_client->name);
456 MSG_WriteByte (&sv.reliable_datagram, svc_updatecolors);
457 MSG_WriteByte (&sv.reliable_datagram, i);
458 MSG_WriteByte (&sv.reliable_datagram, host_client->colors);
459 MSG_WriteByte (&sv.reliable_datagram, svc_updatefrags);
460 MSG_WriteByte (&sv.reliable_datagram, i);
461 MSG_WriteShort (&sv.reliable_datagram, host_client->frags);
463 // free the client now
464 if (host_client->entitydatabase)
465 EntityFrame_FreeDatabase(host_client->entitydatabase);
466 if (host_client->entitydatabase4)
467 EntityFrame4_FreeDatabase(host_client->entitydatabase4);
468 if (host_client->entitydatabase5)
469 EntityFrame5_FreeDatabase(host_client->entitydatabase5);
470 // clear the client struct (this sets active to false)
471 memset(host_client, 0, sizeof(*host_client));
473 // update server listing on the master because player count changed
474 // (which the master uses for filtering empty/full servers)
475 NetConn_Heartbeat(1);
482 This only happens at the end of a game, not between levels
485 void Host_ShutdownServer(qboolean crash)
491 Con_DPrintf("Host_ShutdownServer\n");
496 // print out where the crash happened, if it was caused by QC
499 NetConn_Heartbeat(2);
500 NetConn_Heartbeat(2);
502 // make sure all the clients know we're disconnecting
506 MSG_WriteByte(&buf, svc_disconnect);
507 count = NetConn_SendToAll(&buf, 5);
509 Con_Printf("Host_ShutdownServer: NetConn_SendToAll failed for %u clients\n", count);
511 for (i = 0, host_client = svs.clients;i < svs.maxclients;i++, host_client++)
512 if (host_client->active)
513 SV_DropClient(crash); // server shutdown
515 NetConn_CloseServerPorts();
522 memset(&sv, 0, sizeof(sv));
523 memset(svs.clients, 0, svs.maxclients*sizeof(client_t));
531 This clears all the memory used by both the client and server, but does
532 not reinitialize anything.
535 void Host_ClearMemory (void)
537 Con_DPrint("Clearing memory\n");
541 memset (&sv, 0, sizeof(sv));
542 memset (&cl, 0, sizeof(cl));
546 //============================================================================
552 Returns false if the time is too short to run a frame
555 extern cvar_t cl_avidemo;
556 qboolean Host_FilterTime (double time)
558 double timecap, timeleft;
561 if (slowmo.value < 0.0f)
562 Cvar_SetValue("slowmo", 0.0f);
563 if (host_minfps.value < 10.0f)
564 Cvar_SetValue("host_minfps", 10.0f);
565 if (host_maxfps.value < host_minfps.value)
566 Cvar_SetValue("host_maxfps", host_minfps.value);
567 if (cl_avidemo.value < 0.1f && cl_avidemo.value != 0.0f)
568 Cvar_SetValue("cl_avidemo", 0.0f);
570 // check if framerate is too high
573 // default to sys_ticrate (server framerate - presumably low) unless we
574 // have a good reason to run faster
575 timecap = sys_ticrate.value;
576 if (cls.state != ca_dedicated)
578 if (cl_avidemo.value >= 0.1f)
579 timecap = 1.0 / (double)cl_avidemo.value;
580 else if (vid_activewindow)
581 timecap = 1.0 / host_maxfps.value;
584 timeleft = oldrealtime + timecap - realtime;
587 // don't totally hog the CPU
588 if (timeleft >= 0.02)
589 Sys_Sleep((int)(timeleft * 1000) - 5);
594 // LordHavoc: copy into host_realframetime as well
595 host_realframetime = host_frametime = realtime - oldrealtime;
596 oldrealtime = realtime;
600 // disable time effects
601 cl.frametime = host_frametime;
605 if (host_framerate.value > 0)
606 host_frametime = host_framerate.value;
607 else if (cl_avidemo.value >= 0.1f)
608 host_frametime = (1.0 / cl_avidemo.value);
611 // don't allow really short frames
612 if (host_frametime > (1.0 / host_minfps.value))
613 host_frametime = (1.0 / host_minfps.value);
616 cl.frametime = host_frametime = bound(0, host_frametime * slowmo.value, 0.1f); // LordHavoc: the QC code relies on no less than 10fps
624 Host_GetConsoleCommands
626 Add them exactly as if they had been typed at the console
629 void Host_GetConsoleCommands (void)
635 cmd = Sys_ConsoleInput ();
649 void Host_ServerFrame (void)
651 static double frametimetotal = 0, lastservertime = 0;
652 frametimetotal += host_frametime;
653 // LordHavoc: cap server at sys_ticrate in networked games
654 if (!cl.islocalgame && ((realtime - lastservertime) < sys_ticrate.value))
657 NetConn_ServerFrame();
659 // run the world state
660 if (!sv.paused && (!cl.islocalgame || (key_dest == key_game && !key_consoleactive)))
661 sv.frametime = pr_global_struct->frametime = frametimetotal;
665 lastservertime = realtime;
667 // set the time and clear the general datagram
670 // read client messages
673 // move things around and think
674 // always pause in single player if in console or menus
678 // send all messages to the clients
679 SV_SendClientMessages();
681 // send an heartbeat if enough time has passed since the last one
682 NetConn_Heartbeat(0);
690 Runs all active servers
693 void _Host_Frame (float time)
695 static double time1 = 0;
696 static double time2 = 0;
697 static double time3 = 0;
698 int pass1, pass2, pass3;
699 usercmd_t cmd; // Used for receiving input
701 if (setjmp(host_abortserver))
702 return; // something bad happened, or the server disconnected
704 // keep the random time dependent
707 // decide the simulation time
708 if (!Host_FilterTime(time))
711 cl.islocalgame = NetConn_IsLocalGame();
713 // get new key events
716 // allow mice or other external controllers to add commands
719 // Collect input into cmd
720 IN_ProcessMove(&cmd);
722 // process console commands
725 // if running the server locally, make intentions now
726 if (cls.state == ca_connected && sv.active)
729 //-------------------
733 //-------------------
735 // check for commands typed to the host
736 Host_GetConsoleCommands();
741 //-------------------
745 //-------------------
747 cl.oldtime = cl.time;
748 cl.time += cl.frametime;
750 NetConn_ClientFrame();
752 if (cls.state == ca_connected)
754 // if running the server remotely, send intentions now after
755 // the incoming messages have been read
766 if (host_speeds.integer)
767 time1 = Sys_DoubleTime();
771 if (host_speeds.integer)
772 time2 = Sys_DoubleTime();
775 if (cls.signon == SIGNONS && cl.viewentity >= 0 && cl.viewentity < MAX_EDICTS && cl_entities[cl.viewentity].state_current.active)
777 // LordHavoc: this used to use renderer variables (eww)
778 S_Update(&cl_entities[cl.viewentity].render.matrix);
781 S_Update(&identitymatrix);
785 if (host_speeds.integer)
787 pass1 = (time1 - time3)*1000000;
788 time3 = Sys_DoubleTime();
789 pass2 = (time2 - time1)*1000000;
790 pass3 = (time3 - time2)*1000000;
791 Con_Printf("%6ius total %6ius server %6ius gfx %6ius snd\n",
792 pass1+pass2+pass3, pass1, pass2, pass3);
796 host_loopactive = true;
800 void Host_Frame (float time)
803 static double timetotal;
804 static int timecount;
807 if (!serverprofile.integer)
813 time1 = Sys_DoubleTime ();
815 time2 = Sys_DoubleTime ();
817 timetotal += time2 - time1;
820 if (timecount < 1000)
823 m = timetotal*1000/timecount;
827 for (i=0 ; i<svs.maxclients ; i++)
829 if (svs.clients[i].active)
833 Con_Printf("serverprofile: %2i clients %2i msec\n", c, m);
836 //============================================================================
838 void Render_Init(void);
845 void Host_Init (void)
849 // LordHavoc: quake never seeded the random number generator before... heh
852 // FIXME: this is evil, but possibly temporary
853 // COMMANDLINEOPTION: Console: -developer enables warnings and other notices (RECOMMENDED for mod developers)
854 if (COM_CheckParm("-developer"))
856 forcedeveloper = true;
857 developer.integer = 1;
862 Memory_Init_Commands();
876 Con_Printf("Builddate: %s\n", buildstring);
878 if (cls.state != ca_dedicated)
891 // only cvars are executed when host_initialized == false
892 if (gamemode == GAME_TEU)
893 Cbuf_InsertText("exec teu.rc\n");
895 Cbuf_InsertText("exec quake.rc\n");
898 host_initialized = true;
900 Con_DPrint("========Initialized=========\n");
902 if (cls.state != ca_dedicated)
905 SCR_BeginLoadingPlaque();
909 // stuff it again so the first host frame will execute it again, this time
911 if (gamemode == GAME_TEU)
912 Cbuf_InsertText("exec teu.rc\n");
914 Cbuf_InsertText("exec quake.rc\n");
916 if (!sv.active && (cls.state == ca_dedicated || COM_CheckParm("-listen")))
918 if (gamemode == GAME_TRANSFUSION)
919 Cbuf_InsertText ("map bb1\n");
920 else if (gamemode == GAME_NEXUIZ)
921 Cbuf_InsertText ("map nexdm01\n");
923 Cbuf_InsertText ("map start\n");
926 // check for special benchmark mode
927 // COMMANDLINEOPTION: Client: -benchmark <demoname> runs a timedemo and quits, results of any timedemo can be found in gamedir/benchmark.log (for example id1/benchmark.log)
928 i = COM_CheckParm("-benchmark");
929 if (i && i + 1 < com_argc)
930 Cbuf_InsertText(va("timedemo %s\n", com_argv[i + 1]));
934 // We must wait for the log_file cvar to be initialized to start the log
943 FIXME: this is a callback from Sys_Quit and Sys_Error. It would be better
944 to run quit through here before the final handoff to the sys code.
947 void Host_Shutdown(void)
949 static qboolean isdown = false;
953 Con_Print("recursive shutdown\n");
958 // disconnect client from server if active
961 // shut down local server if active
962 Host_ShutdownServer (false);
969 // AK hmm, no PRVM_Shutdown(); yet
977 if (cls.state != ca_dedicated)
979 R_Modules_Shutdown();