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: framerate upper cap
71 cvar_t cl_maxfps = {CVAR_SAVE, "cl_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] "};
103 This shuts down both the client and server
106 void PRVM_ProcessError(void);
107 static char hosterrorstring1[4096];
108 static char hosterrorstring2[4096];
109 static qboolean hosterror = false;
110 void Host_Error (const char *error, ...)
114 va_start (argptr,error);
115 dpvsnprintf (hosterrorstring1,sizeof(hosterrorstring1),error,argptr);
118 Con_Printf("Host_Error: %s\n", hosterrorstring1);
120 // LordHavoc: if first frame has not been shown, or currently shutting
121 // down, do Sys_Error instead
122 if (!host_loopactive || host_shuttingdown)
123 Sys_Error ("Host_Error: %s", hosterrorstring1);
126 Sys_Error ("Host_Error: recursively entered (original error was: %s new error is: %s)", hosterrorstring2, hosterrorstring1);
129 strcpy(hosterrorstring2, hosterrorstring1);
131 CL_Parse_DumpPacket();
135 //PRVM_Crash(); // crash current prog
137 // crash all prvm progs
142 Host_ShutdownServer (false);
144 if (cls.state == ca_dedicated)
145 Sys_Error ("Host_Error: %s\n",hosterrorstring2); // dedicated servers exit
152 longjmp (host_abortserver, 1);
155 void Host_ServerOptions (void)
162 // COMMANDLINEOPTION: Server: -dedicated [playerlimit] starts a dedicated server (with a command console), default playerlimit is 8
163 // COMMANDLINEOPTION: Server: -listen [playerlimit] starts a multiplayer server with graphical client, like singleplayer but other players can connect, default playerlimit is 8
166 // client exists, check what mode the user wants
167 i = COM_CheckParm ("-dedicated");
170 cls.state = ca_dedicated;
171 // default players unless specified
172 if (i != (com_argc - 1))
173 numplayers = atoi (com_argv[i+1]);
174 if (COM_CheckParm ("-listen"))
175 Sys_Error ("Only one of -dedicated or -listen can be specified");
179 cls.state = ca_disconnected;
180 i = COM_CheckParm ("-listen");
183 // default players unless specified
184 if (i != (com_argc - 1))
185 numplayers = atoi (com_argv[i+1]);
189 // default players in some games, singleplayer in most
190 if (gamemode != GAME_TRANSFUSION && gamemode != GAME_GOODVSBAD2 && gamemode != GAME_NEXUIZ && gamemode != GAME_BATTLEMECH)
197 // no client in the executable, always start dedicated server
198 if (COM_CheckParm ("-listen"))
199 Sys_Error ("-listen not available in a dedicated server executable");
200 cls.state = ca_dedicated;
201 // check for -dedicated specifying how many players
202 i = COM_CheckParm ("-dedicated");
203 // default players unless specified
204 if (i && i != (com_argc - 1))
205 numplayers = atoi (com_argv[i+1]);
211 numplayers = bound(1, numplayers, MAX_SCOREBOARD);
213 if (numplayers > 1 && !deathmatch.integer)
214 Cvar_SetValueQuick(&deathmatch, 1);
216 svs.maxclients = numplayers;
217 svs.clients = Mem_Alloc(sv_mempool, sizeof(client_t) * svs.maxclients);
221 =======================
223 ======================
225 void Host_SaveConfig_f(void);
226 void Host_InitLocal (void)
228 Host_InitCommands ();
230 Cmd_AddCommand("saveconfig", Host_SaveConfig_f);
232 Cvar_RegisterVariable (&host_framerate);
233 Cvar_RegisterVariable (&host_speeds);
234 Cvar_RegisterVariable (&slowmo);
235 Cvar_RegisterVariable (&cl_maxfps);
237 Cvar_RegisterVariable (&sv_echobprint);
239 Cvar_RegisterVariable (&sys_ticrate);
240 Cvar_RegisterVariable (&serverprofile);
242 Cvar_RegisterVariable (&fraglimit);
243 Cvar_RegisterVariable (&timelimit);
244 Cvar_RegisterVariable (&teamplay);
245 Cvar_RegisterVariable (&samelevel);
246 Cvar_RegisterVariable (&noexit);
247 Cvar_RegisterVariable (&skill);
248 Cvar_RegisterVariable (&developer);
249 if (forcedeveloper) // make it real now that the cvar is registered
250 Cvar_SetValue("developer", 1);
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_ServerOptions ();
269 Writes key bindings and archived cvars to config.cfg
272 void Host_SaveConfig_f(void)
276 // dedicated servers initialize the host but don't parse and set the
278 // LordHavoc: save a config only after Host_Frame finished the first frame
279 if (host_initialized && host_loopactive && cls.state != ca_dedicated)
281 f = FS_Open ("config.cfg", "wb", false, false);
284 Con_Print("Couldn't write config.cfg.\n");
288 Key_WriteBindings (f);
289 Cvar_WriteVariables (f);
300 Sends text across to be displayed
301 FIXME: make this just a stuffed echo?
304 void SV_ClientPrint(const char *msg)
306 MSG_WriteByte(&host_client->message, svc_print);
307 MSG_WriteString(&host_client->message, msg);
314 Sends text across to be displayed
315 FIXME: make this just a stuffed echo?
318 void SV_ClientPrintf(const char *fmt, ...)
323 va_start(argptr,fmt);
324 dpvsnprintf(msg,sizeof(msg),fmt,argptr);
334 Sends text to all active clients
337 void SV_BroadcastPrint(const char *msg)
342 for (i = 0, client = svs.clients;i < svs.maxclients;i++, client++)
346 MSG_WriteByte(&client->message, svc_print);
347 MSG_WriteString(&client->message, msg);
351 if (sv_echobprint.integer && cls.state == ca_dedicated)
359 Sends text to all active clients
362 void SV_BroadcastPrintf(const char *fmt, ...)
367 va_start(argptr,fmt);
368 dpvsnprintf(msg,sizeof(msg),fmt,argptr);
371 SV_BroadcastPrint(msg);
378 Send text over to the client to be executed
381 void Host_ClientCommands(const char *fmt, ...)
386 va_start(argptr,fmt);
387 dpvsnprintf(string, sizeof(string), fmt, argptr);
390 MSG_WriteByte(&host_client->message, svc_stufftext);
391 MSG_WriteString(&host_client->message, string);
395 =====================
398 Called when the player is getting totally kicked off the host
399 if (crash = true), don't bother sending signofs
400 =====================
402 void SV_DropClient(qboolean crash)
405 Con_Printf("Client \"%s\" dropped\n", host_client->name);
407 // make sure edict is not corrupt (from a level change for example)
408 host_client->edict = EDICT_NUM(host_client - svs.clients + 1);
410 if (host_client->netconnection)
412 // free the client (the body stays around)
415 // LordHavoc: no opportunity for resending, so use unreliable
416 MSG_WriteByte(&host_client->message, svc_disconnect);
417 NetConn_SendUnreliableMessage(host_client->netconnection, &host_client->message);
419 // break the net connection
420 NetConn_Close(host_client->netconnection);
421 host_client->netconnection = NULL;
424 // call qc ClientDisconnect function
425 // LordHavoc: don't call QC if server is dead (avoids recursive
426 // Host_Error in some mods when they run out of edicts)
427 if (host_client->active && sv.active && host_client->edict && host_client->spawned)
429 // call the prog function for removing a client
430 // this will set the body to a dead frame, among other things
431 int saveSelf = pr_global_struct->self;
432 pr_global_struct->self = EDICT_TO_PROG(host_client->edict);
433 PR_ExecuteProgram(pr_global_struct->ClientDisconnect, "QC function ClientDisconnect is missing");
434 pr_global_struct->self = saveSelf;
437 // remove leaving player from scoreboard
438 //host_client->edict->v->netname = PR_SetString(host_client->name);
439 //if ((val = GETEDICTFIELDVALUE(host_client->edict, eval_clientcolors)))
441 //host_client->edict->v->frags = 0;
442 host_client->name[0] = 0;
443 host_client->colors = 0;
444 host_client->frags = 0;
445 // send notification to all clients
446 // get number of client manually just to make sure we get it right...
447 i = host_client - svs.clients;
448 MSG_WriteByte (&sv.reliable_datagram, svc_updatename);
449 MSG_WriteByte (&sv.reliable_datagram, i);
450 MSG_WriteString (&sv.reliable_datagram, host_client->name);
451 MSG_WriteByte (&sv.reliable_datagram, svc_updatecolors);
452 MSG_WriteByte (&sv.reliable_datagram, i);
453 MSG_WriteByte (&sv.reliable_datagram, host_client->colors);
454 MSG_WriteByte (&sv.reliable_datagram, svc_updatefrags);
455 MSG_WriteByte (&sv.reliable_datagram, i);
456 MSG_WriteShort (&sv.reliable_datagram, host_client->frags);
458 // free the client now
459 if (host_client->entitydatabase)
460 EntityFrame_FreeDatabase(host_client->entitydatabase);
461 if (host_client->entitydatabase4)
462 EntityFrame4_FreeDatabase(host_client->entitydatabase4);
463 if (host_client->entitydatabase5)
464 EntityFrame5_FreeDatabase(host_client->entitydatabase5);
468 // clear a fields that matter to DP_SV_CLIENTNAME and DP_SV_CLIENTCOLORS, and also frags
469 ED_ClearEdict(host_client->edict);
472 // clear the client struct (this sets active to false)
473 memset(host_client, 0, sizeof(*host_client));
475 // update server listing on the master because player count changed
476 // (which the master uses for filtering empty/full servers)
477 NetConn_Heartbeat(1);
484 This only happens at the end of a game, not between levels
487 void Host_ShutdownServer(qboolean crash)
493 Con_DPrintf("Host_ShutdownServer\n");
498 // print out where the crash happened, if it was caused by QC
501 NetConn_Heartbeat(2);
502 NetConn_Heartbeat(2);
504 // make sure all the clients know we're disconnecting
508 MSG_WriteByte(&buf, svc_disconnect);
509 count = NetConn_SendToAll(&buf, 5);
511 Con_Printf("Host_ShutdownServer: NetConn_SendToAll failed for %u clients\n", count);
513 for (i = 0, host_client = svs.clients;i < svs.maxclients;i++, host_client++)
514 if (host_client->active)
515 SV_DropClient(crash); // server shutdown
517 NetConn_CloseServerPorts();
524 memset(&sv, 0, sizeof(sv));
525 memset(svs.clients, 0, svs.maxclients*sizeof(client_t));
533 This clears all the memory used by both the client and server, but does
534 not reinitialize anything.
537 void Host_ClearMemory (void)
539 Con_DPrint("Clearing memory\n");
543 memset (&sv, 0, sizeof(sv));
544 memset (&cl, 0, sizeof(cl));
548 //============================================================================
554 Returns false if the time is too short to run a frame
557 extern qboolean cl_capturevideo_active;
558 extern double cl_capturevideo_framerate;
559 qboolean Host_FilterTime (double time)
561 double timecap, timeleft;
564 if (sys_ticrate.value < 0.00999 || sys_ticrate.value > 0.10001)
565 Cvar_SetValue("sys_ticrate", bound(0.01, sys_ticrate.value, 0.1));
566 if (slowmo.value < 0)
567 Cvar_SetValue("slowmo", 0);
568 if (host_framerate.value < 0.00001 && host_framerate.value != 0)
569 Cvar_SetValue("host_framerate", 0);
570 if (cl_maxfps.value < 1)
571 Cvar_SetValue("cl_maxfps", 1);
575 // disable time effects during timedemo
576 cl.frametime = host_realframetime = host_frametime = realtime - oldrealtime;
577 oldrealtime = realtime;
581 // check if framerate is too high
582 // default to sys_ticrate (server framerate - presumably low) unless we
583 // have a good reason to run faster
584 timecap = host_framerate.value;
586 timecap = sys_ticrate.value;
587 if (cls.state != ca_dedicated)
589 if (cl_capturevideo_active)
590 timecap = 1.0 / cl_capturevideo_framerate;
591 else if (vid_activewindow)
592 timecap = 1.0 / cl_maxfps.value;
595 timeleft = (oldrealtime - realtime) + timecap;
599 // don't totally hog the CPU
600 if (cls.state == ca_dedicated)
602 // if dedicated, try to use as little cpu as possible by waiting
603 // just a little longer than necessary
604 // (yes this means it doesn't quite keep up with the framerate)
605 msleft = (int)ceil(timeleft * 1000);
609 // if not dedicated, try to hit exactly a steady framerate by not
610 // sleeping the full amount
611 msleft = (int)floor(timeleft * 1000);
618 // LordHavoc: copy into host_realframetime as well
619 host_realframetime = host_frametime = realtime - oldrealtime;
620 oldrealtime = realtime;
622 // apply slowmo scaling
623 host_frametime *= slowmo.value;
625 // host_framerate overrides all else
626 if (host_framerate.value)
627 host_frametime = host_framerate.value;
629 // never run a frame longer than 1 second
630 if (host_frametime > 1)
633 cl.frametime = host_frametime;
641 Host_GetConsoleCommands
643 Add them exactly as if they had been typed at the console
646 void Host_GetConsoleCommands (void)
652 cmd = Sys_ConsoleInput ();
666 void Host_ServerFrame (void)
668 // never run more than 5 frames at a time as a sanity limit
669 int framecount, framelimit = 5;
676 sv.timer += host_realframetime;
677 // run the world state
678 // don't allow simulation to run too fast or too slow or logic glitches can occur
679 for (framecount = 0;framecount < framelimit && sv.timer > 0;framecount++)
682 advancetime = min(sv.timer, sys_ticrate.value);
684 advancetime = sys_ticrate.value;
685 sv.timer -= advancetime;
687 // only advance time if not paused
688 // the game also pauses in singleplayer when menu or console is used
689 sv.frametime = advancetime * slowmo.value;
690 if (host_framerate.value)
691 sv.frametime = host_framerate.value;
692 if (sv.paused || (cl.islocalgame && (key_dest != key_game || key_consoleactive)))
695 pr_global_struct->frametime = sv.frametime;
697 // set the time and clear the general datagram
700 // check for network packets to the server each world step incase they
701 // come in midframe (particularly if host is running really slow)
702 NetConn_ServerFrame();
704 // read client messages
707 // move things around and think unless paused
711 // send all messages to the clients
712 SV_SendClientMessages();
714 // send an heartbeat if enough time has passed since the last one
715 NetConn_Heartbeat(0);
717 // if we fell behind too many frames just don't worry about it
727 Runs all active servers
730 void _Host_Frame (float time)
732 static double time1 = 0;
733 static double time2 = 0;
734 static double time3 = 0;
735 int pass1, pass2, pass3;
737 if (setjmp(host_abortserver))
738 return; // something bad happened, or the server disconnected
740 // decide the simulation time
741 if (!Host_FilterTime(time))
744 // keep the random time dependent
747 cl.islocalgame = NetConn_IsLocalGame();
749 // get new key events
752 // allow mice or other external controllers to add commands
755 // Collect input into cmd
758 // process console commands
761 // if running the server locally, make intentions now
762 if (cls.state == ca_connected && sv.active)
765 //-------------------
769 //-------------------
771 // check for commands typed to the host
772 Host_GetConsoleCommands();
777 //-------------------
781 //-------------------
783 cl.oldtime = cl.time;
784 cl.time += cl.frametime;
786 NetConn_ClientFrame();
788 if (cls.state == ca_connected)
790 // if running the server remotely, send intentions now after
791 // the incoming messages have been read
802 if (host_speeds.integer)
803 time1 = Sys_DoubleTime();
807 if (host_speeds.integer)
808 time2 = Sys_DoubleTime();
811 if (cls.signon == SIGNONS && cl_entities[cl.viewentity].state_current.active)
813 // LordHavoc: this used to use renderer variables (eww)
814 S_Update(&cl_entities[cl.viewentity].render.matrix);
817 S_Update(&identitymatrix);
821 if (host_speeds.integer)
823 pass1 = (time1 - time3)*1000000;
824 time3 = Sys_DoubleTime();
825 pass2 = (time2 - time1)*1000000;
826 pass3 = (time3 - time2)*1000000;
827 Con_Printf("%6ius total %6ius server %6ius gfx %6ius snd\n",
828 pass1+pass2+pass3, pass1, pass2, pass3);
832 host_loopactive = true;
836 void Host_Frame (float time)
839 static double timetotal;
840 static int timecount;
843 if (!serverprofile.integer)
849 time1 = Sys_DoubleTime ();
851 time2 = Sys_DoubleTime ();
853 timetotal += time2 - time1;
856 if (timecount < 1000)
859 m = timetotal*1000/timecount;
863 for (i=0 ; i<svs.maxclients ; i++)
865 if (svs.clients[i].active)
869 Con_Printf("serverprofile: %2i clients %2i msec\n", c, m);
872 //============================================================================
874 void Render_Init(void);
881 void Host_Init (void)
885 // LordHavoc: quake never seeded the random number generator before... heh
888 // FIXME: this is evil, but possibly temporary
889 // COMMANDLINEOPTION: Console: -developer enables warnings and other notices (RECOMMENDED for mod developers)
890 if (COM_CheckParm("-developer"))
892 forcedeveloper = true;
893 developer.integer = 1;
898 Memory_Init_Commands();
912 Con_Printf("Builddate: %s\n", buildstring);
914 if (cls.state != ca_dedicated)
929 // only cvars are executed when host_initialized == false
930 if (gamemode == GAME_TEU)
931 Cbuf_InsertText("exec teu.rc\n");
933 Cbuf_InsertText("exec quake.rc\n");
939 host_initialized = true;
941 Con_DPrint("========Initialized=========\n");
943 if (cls.state != ca_dedicated)
947 CL_InitTEnts (); // We must wait after sound startup to load tent sounds
948 SCR_BeginLoadingPlaque();
952 // set up the default startmap_sp and startmap_dm aliases, mods can
954 if (gamemode == GAME_NEHAHRA)
956 Cbuf_InsertText ("alias startmap_sp \"map nehstart\"\n");
957 Cbuf_InsertText ("alias startmap_dm \"map nehstart\"\n");
959 else if (gamemode == GAME_TRANSFUSION)
961 Cbuf_InsertText ("alias startmap_sp \"map e1m1\"\n");
962 Cbuf_InsertText ("alias startmap_dm \"map bb1\"\n");
964 else if (gamemode == GAME_NEXUIZ)
966 Cbuf_InsertText ("alias startmap_sp \"map nexdm01\"\n");
967 Cbuf_InsertText ("alias startmap_dm \"map nexdm01\"\n");
971 Cbuf_InsertText ("alias startmap_sp \"map start\"\n");
972 Cbuf_InsertText ("alias startmap_dm \"map start\"\n");
975 // stuff it again so the first host frame will execute it again, this time
977 if (gamemode == GAME_TEU)
978 Cbuf_InsertText("exec teu.rc\n");
980 Cbuf_InsertText("exec quake.rc\n");
986 // We must wait for the log_file cvar to be initialized to start the log
989 if (cls.state == ca_dedicated || COM_CheckParm("-listen"))
990 if (!sv.active && !cls.demoplayback && !cls.connect_trying)
991 Cbuf_InsertText ("startmap_dm\n");
995 // check for special benchmark mode
996 // 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)
997 i = COM_CheckParm("-benchmark");
998 if (i && i + 1 < com_argc)
999 if (!sv.active && !cls.demoplayback && !cls.connect_trying)
1000 Cbuf_InsertText(va("timedemo %s\n", com_argv[i + 1]));
1004 if (!sv.active && !cls.demoplayback && !cls.connect_trying)
1006 Cbuf_InsertText("togglemenu\n");
1007 if (gamemode == GAME_NEXUIZ)
1009 Cbuf_InsertText("playvideo logo\n");
1010 Cbuf_InsertText("cd loop 1\n");
1024 FIXME: this is a callback from Sys_Quit and Sys_Error. It would be better
1025 to run quit through here before the final handoff to the sys code.
1028 void Host_Shutdown(void)
1030 static qboolean isdown = false;
1034 Con_Print("recursive shutdown\n");
1039 // disconnect client from server if active
1042 // shut down local server if active
1043 Host_ShutdownServer (false);
1050 // AK hmm, no PRVM_Shutdown(); yet
1052 CL_Video_Shutdown();
1054 Host_SaveConfig_f();
1056 CDAudio_Shutdown ();
1058 NetConn_Shutdown ();
1062 if (cls.state != ca_dedicated)
1064 R_Modules_Shutdown();