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 void Host_ServerOptions (void)
174 i = COM_CheckParm ("-dedicated");
177 cls.state = ca_dedicated;
179 if (i != (com_argc - 1))
180 numplayers = atoi (com_argv[i+1]);
183 cls.state = ca_disconnected;
185 i = COM_CheckParm ("-listen");
188 if (cls.state == ca_dedicated)
189 Sys_Error ("Only one of -dedicated or -listen can be specified");
191 if (i != (com_argc - 1))
192 numplayers = atoi (com_argv[i+1]);
197 if (numplayers > MAX_SCOREBOARD)
198 numplayers = MAX_SCOREBOARD;
200 // Transfusion doesn't support single player games
201 if (gamemode == GAME_TRANSFUSION && numplayers < 4)
205 Cvar_SetValueQuick (&deathmatch, 1);
207 Cvar_SetValueQuick (&deathmatch, 0);
210 SV_SetMaxClients(numplayers);
213 static mempool_t *clients_mempool;
214 void SV_SetMaxClients(int n)
218 n = bound(1, n, MAX_SCOREBOARD);
219 if (svs.maxclients == n)
222 if (!clients_mempool)
223 clients_mempool = Mem_AllocPool("clients");
225 Mem_Free(svs.clients);
226 svs.clients = Mem_Alloc(clients_mempool, svs.maxclients*sizeof(client_t));
231 =======================
233 ======================
235 void Host_InitLocal (void)
237 Host_InitCommands ();
239 Cvar_RegisterVariable (&host_framerate);
240 Cvar_RegisterVariable (&host_speeds);
241 Cvar_RegisterVariable (&slowmo);
242 Cvar_RegisterVariable (&host_minfps);
243 Cvar_RegisterVariable (&host_maxfps);
245 Cvar_RegisterVariable (&sv_echobprint);
247 Cvar_RegisterVariable (&sys_ticrate);
248 Cvar_RegisterVariable (&serverprofile);
250 Cvar_RegisterVariable (&fraglimit);
251 Cvar_RegisterVariable (&timelimit);
252 Cvar_RegisterVariable (&teamplay);
253 Cvar_RegisterVariable (&samelevel);
254 Cvar_RegisterVariable (&noexit);
255 Cvar_RegisterVariable (&skill);
256 Cvar_RegisterVariable (&developer);
257 if (forcedeveloper) // make it real now that the cvar is registered
258 Cvar_SetValue("developer", 1);
259 Cvar_RegisterVariable (&deathmatch);
260 Cvar_RegisterVariable (&coop);
262 Cvar_RegisterVariable (&pausable);
264 Cvar_RegisterVariable (&temp1);
266 Cvar_RegisterVariable (×tamps);
267 Cvar_RegisterVariable (&timeformat);
269 Host_ServerOptions ();
275 Host_WriteConfiguration
277 Writes key bindings and archived cvars to config.cfg
280 void Host_WriteConfiguration (void)
284 // dedicated servers initialize the host but don't parse and set the
286 if (host_initialized && cls.state != ca_dedicated)
288 f = Qopen (va("%s/config.cfg",com_gamedir), "w");
291 Con_Printf ("Couldn't write config.cfg.\n");
295 Key_WriteBindings (f);
296 Cvar_WriteVariables (f);
307 Sends text across to be displayed
308 FIXME: make this just a stuffed echo?
311 void SV_ClientPrintf (char *fmt, ...)
316 va_start (argptr,fmt);
317 vsprintf (string, fmt,argptr);
320 MSG_WriteByte (&host_client->message, svc_print);
321 MSG_WriteString (&host_client->message, string);
328 Sends text to all active clients
331 void SV_BroadcastPrintf (char *fmt, ...)
337 va_start (argptr,fmt);
338 vsprintf (string, fmt,argptr);
341 for (i=0 ; i<svs.maxclients ; i++)
342 if (svs.clients[i].active && svs.clients[i].spawned)
344 MSG_WriteByte (&svs.clients[i].message, svc_print);
345 MSG_WriteString (&svs.clients[i].message, string);
348 if (sv_echobprint.integer && cls.state == ca_dedicated)
349 Sys_Printf ("%s", string);
356 Send text over to the client to be executed
359 void Host_ClientCommands (char *fmt, ...)
364 va_start (argptr,fmt);
365 vsprintf (string, fmt,argptr);
368 MSG_WriteByte (&host_client->message, svc_stufftext);
369 MSG_WriteString (&host_client->message, string);
373 =====================
376 Called when the player is getting totally kicked off the host
377 if (crash = true), don't bother sending signofs
378 =====================
380 void SV_DropClient (qboolean crash)
388 // send any final messages (don't check for errors)
389 if (NET_CanSendMessage (host_client->netconnection))
391 MSG_WriteByte (&host_client->message, svc_disconnect);
392 NET_SendMessage (host_client->netconnection, &host_client->message);
395 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)
397 // call the prog function for removing a client
398 // this will set the body to a dead frame, among other things
399 saveSelf = pr_global_struct->self;
400 pr_global_struct->self = EDICT_TO_PROG(host_client->edict);
401 PR_ExecuteProgram (pr_global_struct->ClientDisconnect, "QC function ClientDisconnect is missing");
402 pr_global_struct->self = saveSelf;
405 Sys_Printf ("Client %s removed\n",host_client->name);
408 // break the net connection
409 NET_Close (host_client->netconnection);
410 host_client->netconnection = NULL;
412 // free the client (the body stays around)
413 host_client->active = false;
414 host_client->name[0] = 0;
415 host_client->old_frags = -999999;
416 net_activeconnections--;
418 // send notification to all clients
419 for (i=0, client = svs.clients ; i<svs.maxclients ; i++, client++)
423 MSG_WriteByte (&client->message, svc_updatename);
424 MSG_WriteByte (&client->message, host_client - svs.clients);
425 MSG_WriteString (&client->message, "");
426 MSG_WriteByte (&client->message, svc_updatefrags);
427 MSG_WriteByte (&client->message, host_client - svs.clients);
428 MSG_WriteShort (&client->message, 0);
429 MSG_WriteByte (&client->message, svc_updatecolors);
430 MSG_WriteByte (&client->message, host_client - svs.clients);
431 MSG_WriteByte (&client->message, 0);
439 This only happens at the end of a game, not between levels
442 void Host_ShutdownServer(qboolean crash)
453 // print out where the crash happened, if it was caused by QC
458 // stop all client sounds immediately
461 // flush any pending messages - like the score!!!
462 start = Sys_DoubleTime();
466 for (i=0, host_client = svs.clients ; i<svs.maxclients ; i++, host_client++)
468 if (host_client->active && host_client->message.cursize)
470 if (NET_CanSendMessage (host_client->netconnection))
472 NET_SendMessage(host_client->netconnection, &host_client->message);
473 SZ_Clear (&host_client->message);
477 NET_GetMessage(host_client->netconnection);
482 if ((Sys_DoubleTime() - start) > 3.0)
487 // make sure all the clients know we're disconnecting
491 MSG_WriteByte(&buf, svc_disconnect);
492 count = NET_SendToAll(&buf, 5);
494 Con_Printf("Host_ShutdownServer: NET_SendToAll failed for %u clients\n", count);
496 for (i=0, host_client = svs.clients ; i<svs.maxclients ; i++, host_client++)
497 if (host_client->active)
498 SV_DropClient(crash);
503 memset (&sv, 0, sizeof(sv));
504 memset (svs.clients, 0, svs.maxclients * sizeof(client_t));
512 This clears all the memory used by both the client and server, but does
513 not reinitialize anything.
516 void Host_ClearMemory (void)
518 Con_DPrintf ("Clearing memory\n");
522 memset (&sv, 0, sizeof(sv));
523 memset (&cl, 0, sizeof(cl));
527 //============================================================================
533 Returns false if the time is too short to run a frame
536 extern cvar_t cl_avidemo;
537 qboolean Host_FilterTime (double time)
542 if (slowmo.value < 0.0f)
543 Cvar_SetValue("slowmo", 0.0f);
544 if (host_minfps.value < 10.0f)
545 Cvar_SetValue("host_minfps", 10.0f);
546 if (host_maxfps.value < host_minfps.value)
547 Cvar_SetValue("host_maxfps", host_minfps.value);
548 if (cl_avidemo.value < 0.1f && cl_avidemo.value != 0.0f)
549 Cvar_SetValue("cl_avidemo", 0.0f);
551 // check if framerate is too high
552 if (cl_avidemo.value >= 0.1f)
554 timecap = 1.0 / (double)cl_avidemo.value;
555 if ((realtime - oldrealtime) < timecap)
558 else if (!cls.timedemo)
560 // default to sys_ticrate (server framerate - presumably low) unless we're the active window and either connected to a server or playing a video
561 timecap = sys_ticrate.value;
562 if (vid_activewindow && (cls.state == ca_connected || cl_videoplaying))
563 timecap = 1.0 / host_maxfps.value;
565 if ((realtime - oldrealtime) < timecap)
569 // LordHavoc: copy into host_realframetime as well
570 host_realframetime = host_frametime = realtime - oldrealtime;
571 oldrealtime = realtime;
575 // disable time effects
576 cl.frametime = host_frametime;
580 if (host_framerate.value > 0)
581 host_frametime = host_framerate.value;
582 else if (cl_avidemo.value >= 0.1f)
583 host_frametime = (1.0 / cl_avidemo.value);
586 // don't allow really short frames
587 if (host_frametime > (1.0 / host_minfps.value))
588 host_frametime = (1.0 / host_minfps.value);
591 cl.frametime = host_frametime = bound(0, host_frametime * slowmo.value, 0.1f); // LordHavoc: the QC code relies on no less than 10fps
599 Host_GetConsoleCommands
601 Add them exactly as if they had been typed at the console
604 void Host_GetConsoleCommands (void)
610 cmd = Sys_ConsoleInput ();
624 void Host_ServerFrame (void)
626 static double frametimetotal = 0, lastservertime = 0;
627 frametimetotal += host_frametime;
628 // LordHavoc: cap server at sys_ticrate in listen games
629 if (cls.state != ca_dedicated && svs.maxclients > 1 && ((realtime - lastservertime) < sys_ticrate.value))
631 // run the world state
632 if (!sv.paused && (svs.maxclients > 1 || (key_dest == key_game && !key_consoleactive)))
633 sv.frametime = pr_global_struct->frametime = frametimetotal;
637 lastservertime = realtime;
639 // set the time and clear the general datagram
642 // check for new clients
643 SV_CheckForNewClients ();
645 // read client messages
648 // move things around and think
649 // always pause in single player if in console or menus
653 // send all messages to the clients
654 SV_SendClientMessages ();
662 Runs all active servers
665 void _Host_Frame (float time)
667 static double time1 = 0;
668 static double time2 = 0;
669 static double time3 = 0;
670 int pass1, pass2, pass3;
672 if (setjmp (host_abortserver) )
673 return; // something bad happened, or the server disconnected
675 // keep the random time dependent
678 // decide the simulation time
679 if (!Host_FilterTime (time))
681 // if time was rejected, don't totally hog the CPU
686 // get new key events
687 Sys_SendKeyEvents ();
689 // allow mice or other external controllers to add commands
692 // process console commands
697 // if running the server locally, make intentions now
701 //-------------------
705 //-------------------
707 // check for commands typed to the host
708 Host_GetConsoleCommands ();
713 //-------------------
717 //-------------------
719 // if running the server remotely, send intentions now after
720 // the incoming messages have been read
724 // fetch results from server
725 if (cls.state == ca_connected)
726 CL_ReadFromServer ();
733 if (host_speeds.integer)
734 time1 = Sys_DoubleTime ();
738 if (host_speeds.integer)
739 time2 = Sys_DoubleTime ();
742 if (cls.signon == SIGNONS)
744 // LordHavoc: this used to use renderer variables (eww)
745 vec3_t forward, right, up;
746 AngleVectors(cl.viewangles, forward, right, up);
747 S_Update (cl_entities[cl.viewentity].render.origin, forward, right, up);
750 S_Update (vec3_origin, vec3_origin, vec3_origin, vec3_origin);
754 if (host_speeds.integer)
756 pass1 = (time1 - time3)*1000000;
757 time3 = Sys_DoubleTime ();
758 pass2 = (time2 - time1)*1000000;
759 pass3 = (time3 - time2)*1000000;
760 Con_Printf ("%6ius total %6ius server %6ius gfx %6ius snd\n",
761 pass1+pass2+pass3, pass1, pass2, pass3);
765 host_loopactive = true;
768 void Host_Frame (float time)
771 static double timetotal;
772 static int timecount;
775 if (!serverprofile.integer)
781 time1 = Sys_DoubleTime ();
783 time2 = Sys_DoubleTime ();
785 timetotal += time2 - time1;
788 if (timecount < 1000)
791 m = timetotal*1000/timecount;
795 for (i=0 ; i<svs.maxclients ; i++)
797 if (svs.clients[i].active)
801 Con_Printf ("serverprofile: %2i clients %2i msec\n", c, m);
804 //============================================================================
806 void Render_Init(void);
807 void QuakeIO_Init(void);
814 void Host_Init (void)
816 // LordHavoc: quake never seeded the random number generator before... heh
819 // FIXME: this is evil, but possibly temporary
820 if (COM_CheckParm("-developer"))
822 forcedeveloper = true;
823 developer.integer = 1;
828 Memory_Init_Commands();
835 W_LoadWadFile ("gfx.wad");
845 Con_Printf ("Builddate: %s\n", buildstring);
847 if (cls.state != ca_dedicated)
855 #ifndef _WIN32 // on non win32, mouse comes before video for security reasons
865 #ifdef _WIN32 // on non win32, mouse comes before video for security reasons
870 Cbuf_InsertText ("exec quake.rc\n");
872 host_initialized = true;
874 Sys_Printf ("========Quake Initialized=========\n");
882 FIXME: this is a callback from Sys_Quit and Sys_Error. It would be better
883 to run quit through here before the final handoff to the sys code.
886 void Host_Shutdown(void)
888 static qboolean isdown = false;
892 printf ("recursive shutdown\n");
897 Host_WriteConfiguration ();
904 if (cls.state != ca_dedicated)
906 R_Modules_Shutdown();