Measure some timing values for output in status; also, if developer is 1, complain...
[divverent/darkplaces.git] / server.h
1 /*
2 Copyright (C) 1996-1997 Id Software, Inc.
3
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.
8
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.
12
13 See the GNU General Public License for more details.
14
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.
18
19 */
20 // server.h
21
22 #ifndef SERVER_H
23 #define SERVER_H
24
25 typedef struct server_static_s
26 {
27         // number of svs.clients slots (updated by maxplayers command)
28         int maxclients;
29         // client slots
30         struct client_s *clients;
31         // episode completion information
32         int serverflags;
33         // cleared when at SV_SpawnServer
34         qboolean changelevel_issued;
35         // server infostring
36         char serverinfo[MAX_SERVERINFO_STRING];
37         // performance data
38         float perf_cpuload;
39         float perf_lost;
40         float perf_offset_avg;
41         float perf_offset_max;
42         float perf_offset_sdev;
43         // temporary performance data accumulators
44         float perf_acc_realtime;
45         float perf_acc_sleeptime;
46         float perf_acc_lost;
47         float perf_acc_offset;
48         float perf_acc_offset_squared;
49         float perf_acc_offset_max;
50         int perf_acc_offset_samples;
51 } server_static_t;
52
53 //=============================================================================
54
55 typedef enum server_state_e {ss_loading, ss_active} server_state_t;
56
57 #define MAX_CONNECTFLOODADDRESSES 16
58 typedef struct server_connectfloodaddress_s
59 {
60         double lasttime;
61         lhnetaddress_t address;
62 }
63 server_connectfloodaddress_t;
64
65 typedef struct server_s
66 {
67         // false if only a net client
68         qboolean active;
69
70         qboolean paused;
71         // handle connections specially
72         qboolean loadgame;
73
74         // one of the PROTOCOL_ values
75         protocolversion_t protocol;
76
77         double time;
78
79         double frametime;
80
81         // used by PF_checkclient
82         int lastcheck;
83         double lastchecktime;
84
85         // crc of clientside progs at time of level start
86         int csqc_progcrc; // -1 = no progs
87         int csqc_progsize; // -1 = no progs
88         char csqc_progname[MAX_QPATH]; // copied from csqc_progname at level start
89
90         // collision culling data
91         world_t world;
92
93         // map name
94         char name[64];
95         // maps/<name>.bsp, for model_precache[0]
96         char modelname[64];
97         struct model_s *worldmodel;
98         // NULL terminated
99         // LordHavoc: precaches are now MAX_QPATH rather than a pointer
100         // updated by SV_ModelIndex
101         char model_precache[MAX_MODELS][MAX_QPATH];
102         struct model_s *models[MAX_MODELS];
103         // NULL terminated
104         // LordHavoc: precaches are now MAX_QPATH rather than a pointer
105         // updated by SV_SoundIndex
106         char sound_precache[MAX_SOUNDS][MAX_QPATH];
107         char lightstyles[MAX_LIGHTSTYLES][64];
108         // some actions are only valid during load
109         server_state_t state;
110
111         sizebuf_t datagram;
112         unsigned char datagram_buf[NET_MAXMESSAGE];
113
114         // copied to all clients at end of frame
115         sizebuf_t reliable_datagram;
116         unsigned char reliable_datagram_buf[NET_MAXMESSAGE];
117
118         sizebuf_t signon;
119         // LordHavoc: increased signon message buffer from 8192
120         unsigned char signon_buf[NET_MAXMESSAGE];
121
122         // connection flood blocking
123         // note this is in server_t rather than server_static_t so that it is
124         // reset on each map command (such as New Game in singleplayer)
125         server_connectfloodaddress_t connectfloodaddresses[MAX_CONNECTFLOODADDRESSES];
126
127 #define SV_MAX_PARTICLEEFFECTNAME 256
128         qboolean particleeffectnamesloaded;
129         char particleeffectname[SV_MAX_PARTICLEEFFECTNAME][MAX_QPATH];
130
131         int writeentitiestoclient_stats_culled_pvs;
132         int writeentitiestoclient_stats_culled_trace;
133         int writeentitiestoclient_stats_visibleentities;
134         int writeentitiestoclient_stats_totalentities;
135         int writeentitiestoclient_cliententitynumber;
136         int writeentitiestoclient_clientnumber;
137         sizebuf_t *writeentitiestoclient_msg;
138         vec3_t writeentitiestoclient_testeye;
139         int writeentitiestoclient_pvsbytes;
140         unsigned char writeentitiestoclient_pvs[MAX_MAP_LEAFS/8];
141         entity_state_t writeentitiestoclient_sendstates[MAX_EDICTS];
142 } server_t;
143
144 // if defined this does ping smoothing, otherwise it does not
145 //#define NUM_PING_TIMES 16
146
147 #define NUM_SPAWN_PARMS 16
148
149 typedef struct client_s
150 {
151         // false = empty client slot
152         qboolean active;
153         // false = don't do ClientDisconnect on drop
154         qboolean clientconnectcalled;
155         // false = don't send datagrams
156         qboolean spawned;
157         // 1 = send svc_serverinfo and advance to 2, 2 doesn't send, then advances to 0 (allowing unlimited sending) when prespawn is received
158         int sendsignon;
159
160         // requested rate in bytes per second
161         int rate;
162
163         // realtime this client connected
164         double connecttime;
165
166         // keepalive messages must be sent periodically during signon
167         double keepalivetime;
168
169         // communications handle
170         netconn_t *netconnection;
171
172         int movesequence;
173         // movement
174         usercmd_t cmd;
175         // intended motion calced from cmd
176         vec3_t wishdir;
177
178         // PRVM_EDICT_NUM(clientnum+1)
179         prvm_edict_t *edict;
180
181 #ifdef NUM_PING_TIMES
182         float ping_times[NUM_PING_TIMES];
183         // ping_times[num_pings%NUM_PING_TIMES]
184         int num_pings;
185 #endif
186         // LordHavoc: can be used for prediction or whatever...
187         float ping;
188
189         // this is used by sv_clmovement_minping code
190         double clmovement_disabletimeout;
191         // this is used by sv_clmvoement_waitforinput code
192         int clmovement_skipphysicsframes;
193
194 // spawn parms are carried from level to level
195         float spawn_parms[NUM_SPAWN_PARMS];
196
197         // properties that are sent across the network only when changed
198         char name[64], old_name[64];
199         int colors, old_colors;
200         int frags, old_frags;
201         char playermodel[MAX_QPATH], old_model[MAX_QPATH];
202         char playerskin[MAX_QPATH], old_skin[MAX_QPATH];
203
204         // netaddress support
205         char netaddress[MAX_QPATH];
206
207         // visibility state
208         float visibletime[MAX_EDICTS];
209
210         // version number of csqc-based entity to decide whether to send it
211         unsigned char csqcentityversion[MAX_EDICTS];
212
213         // prevent animated names
214         float nametime;
215
216         // latest received clc_ackframe (used to detect packet loss)
217         int latestframenum;
218
219         // cache weaponmodel name lookups
220         char weaponmodel[MAX_QPATH];
221         int weaponmodelindex;
222
223         entityframe_database_t *entitydatabase;
224         entityframe4_database_t *entitydatabase4;
225         entityframe5_database_t *entitydatabase5;
226
227         // delta compression of stats
228         unsigned char statsdeltabits[(MAX_CL_STATS+7)/8];
229         int stats[MAX_CL_STATS];
230
231         unsigned char unreliablemsg_data[NET_MAXMESSAGE];
232         sizebuf_t unreliablemsg;
233         int unreliablemsg_splitpoints;
234         int unreliablemsg_splitpoint[NET_MAXMESSAGE/16];
235
236         // information on an active download if any
237         qfile_t *download_file;
238         int download_expectedposition; // next position the client should ack
239         qboolean download_started;
240         char download_name[MAX_QPATH];
241
242         // fixangle data
243         qboolean fixangle_angles_set;
244         vec3_t fixangle_angles;
245 } client_t;
246
247
248 //=============================================================================
249
250 // edict->movetype values
251 #define MOVETYPE_NONE                   0               // never moves
252 #define MOVETYPE_ANGLENOCLIP    1
253 #define MOVETYPE_ANGLECLIP              2
254 #define MOVETYPE_WALK                   3               // gravity
255 #define MOVETYPE_STEP                   4               // gravity, special edge handling
256 #define MOVETYPE_FLY                    5
257 #define MOVETYPE_TOSS                   6               // gravity
258 #define MOVETYPE_PUSH                   7               // no clip to world, push and crush
259 #define MOVETYPE_NOCLIP                 8
260 #define MOVETYPE_FLYMISSILE             9               // extra size to monsters
261 #define MOVETYPE_BOUNCE                 10
262 #define MOVETYPE_BOUNCEMISSILE  11              // bounce w/o gravity
263 #define MOVETYPE_FOLLOW                 12              // track movement of aiment
264 #define MOVETYPE_FAKEPUSH               13              // tenebrae's push that doesn't push
265
266 // edict->solid values
267 #define SOLID_NOT                               0               // no interaction with other objects
268 #define SOLID_TRIGGER                   1               // touch on edge, but not blocking
269 #define SOLID_BBOX                              2               // touch on edge, block
270 #define SOLID_SLIDEBOX                  3               // touch on edge, but not an onground
271 #define SOLID_BSP                               4               // bsp clip, touch on edge, block
272 // LordHavoc: corpse code
273 #define SOLID_CORPSE                    5               // same as SOLID_BBOX, except it behaves as SOLID_NOT against SOLID_SLIDEBOX objects (players/monsters)
274
275 // edict->deadflag values
276 #define DEAD_NO                                 0
277 #define DEAD_DYING                              1
278 #define DEAD_DEAD                               2
279
280 #define DAMAGE_NO                               0
281 #define DAMAGE_YES                              1
282 #define DAMAGE_AIM                              2
283
284 // edict->flags
285 #define FL_FLY                                  1
286 #define FL_SWIM                                 2
287 #define FL_CONVEYOR                             4
288 #define FL_CLIENT                               8
289 #define FL_INWATER                              16
290 #define FL_MONSTER                              32
291 #define FL_GODMODE                              64
292 #define FL_NOTARGET                             128
293 #define FL_ITEM                                 256
294 #define FL_ONGROUND                             512
295 #define FL_PARTIALGROUND                1024    // not all corners are valid
296 #define FL_WATERJUMP                    2048    // player jumping out of water
297 #define FL_JUMPRELEASED                 4096    // for jump debouncing
298
299 #define SPAWNFLAG_NOT_EASY                      256
300 #define SPAWNFLAG_NOT_MEDIUM            512
301 #define SPAWNFLAG_NOT_HARD                      1024
302 #define SPAWNFLAG_NOT_DEATHMATCH        2048
303
304 //============================================================================
305
306 extern cvar_t coop;
307 extern cvar_t deathmatch;
308 extern cvar_t fraglimit;
309 extern cvar_t gamecfg;
310 extern cvar_t noexit;
311 extern cvar_t nomonsters;
312 extern cvar_t pausable;
313 extern cvar_t pr_checkextension;
314 extern cvar_t samelevel;
315 extern cvar_t saved1;
316 extern cvar_t saved2;
317 extern cvar_t saved3;
318 extern cvar_t saved4;
319 extern cvar_t savedgamecfg;
320 extern cvar_t scratch1;
321 extern cvar_t scratch2;
322 extern cvar_t scratch3;
323 extern cvar_t scratch4;
324 extern cvar_t skill;
325 extern cvar_t slowmo;
326 extern cvar_t sv_accelerate;
327 extern cvar_t sv_aim;
328 extern cvar_t sv_airaccel_qw;
329 extern cvar_t sv_airaccel_sideways_friction;
330 extern cvar_t sv_airaccelerate;
331 extern cvar_t sv_allowdownloads;
332 extern cvar_t sv_allowdownloads_archive;
333 extern cvar_t sv_allowdownloads_config;
334 extern cvar_t sv_allowdownloads_dlcache;
335 extern cvar_t sv_allowdownloads_inarchive;
336 extern cvar_t sv_areagrid_mingridsize;
337 extern cvar_t sv_checkforpacketsduringsleep;
338 extern cvar_t sv_clmovement_enable;
339 extern cvar_t sv_clmovement_minping;
340 extern cvar_t sv_clmovement_minping_disabletime;
341 extern cvar_t sv_clmovement_waitforinput;
342 extern cvar_t sv_cullentities_nevercullbmodels;
343 extern cvar_t sv_cullentities_pvs;
344 extern cvar_t sv_cullentities_stats;
345 extern cvar_t sv_cullentities_trace;
346 extern cvar_t sv_cullentities_trace_delay;
347 extern cvar_t sv_cullentities_trace_enlarge;
348 extern cvar_t sv_cullentities_trace_prediction;
349 extern cvar_t sv_cullentities_trace_samples;
350 extern cvar_t sv_cullentities_trace_samples_extra;
351 extern cvar_t sv_debugmove;
352 extern cvar_t sv_echobprint;
353 extern cvar_t sv_edgefriction;
354 extern cvar_t sv_entpatch;
355 extern cvar_t sv_fixedframeratesingleplayer;
356 extern cvar_t sv_freezenonclients;
357 extern cvar_t sv_friction;
358 extern cvar_t sv_gameplayfix_blowupfallenzombies;
359 extern cvar_t sv_gameplayfix_droptofloorstartsolid;
360 extern cvar_t sv_gameplayfix_findradiusdistancetobox;
361 extern cvar_t sv_gameplayfix_grenadebouncedownslopes;
362 extern cvar_t sv_gameplayfix_multiplethinksperframe;
363 extern cvar_t sv_gameplayfix_noairborncorpse;
364 extern cvar_t sv_gameplayfix_qwplayerphysics;
365 extern cvar_t sv_gameplayfix_setmodelrealbox;
366 extern cvar_t sv_gameplayfix_stepdown;
367 extern cvar_t sv_gameplayfix_stepwhilejumping;
368 extern cvar_t sv_gameplayfix_swiminbmodels;
369 extern cvar_t sv_gameplayfix_upwardvelocityclearsongroundflag;
370 extern cvar_t sv_gravity;
371 extern cvar_t sv_idealpitchscale;
372 extern cvar_t sv_jumpstep;
373 extern cvar_t sv_jumpvelocity;
374 extern cvar_t sv_maxairspeed;
375 extern cvar_t sv_maxrate;
376 extern cvar_t sv_maxspeed;
377 extern cvar_t sv_maxvelocity;
378 extern cvar_t sv_newflymove;
379 extern cvar_t sv_nostep;
380 extern cvar_t sv_playerphysicsqc;
381 extern cvar_t sv_progs;
382 extern cvar_t sv_protocolname;
383 extern cvar_t sv_random_seed;
384 extern cvar_t sv_ratelimitlocalplayer;
385 extern cvar_t sv_sound_land;
386 extern cvar_t sv_sound_watersplash;
387 extern cvar_t sv_stepheight;
388 extern cvar_t sv_stopspeed;
389 extern cvar_t sv_wallfriction;
390 extern cvar_t sv_wateraccelerate;
391 extern cvar_t sv_waterfriction;
392 extern cvar_t sys_ticrate;
393 extern cvar_t teamplay;
394 extern cvar_t temp1;
395 extern cvar_t timelimit;
396
397 extern mempool_t *sv_mempool;
398
399 // persistant server info
400 extern server_static_t svs;
401 // local server
402 extern server_t sv;
403
404 extern client_t *host_client;
405
406 //===========================================================
407
408 void SV_Init (void);
409
410 void SV_StartParticle (vec3_t org, vec3_t dir, int color, int count);
411 void SV_StartEffect (vec3_t org, int modelindex, int startframe, int framecount, int framerate);
412 void SV_StartSound (prvm_edict_t *entity, int channel, const char *sample, int volume, float attenuation);
413
414 void SV_ConnectClient (int clientnum, netconn_t *netconnection);
415 void SV_DropClient (qboolean crash);
416
417 void SV_SendClientMessages (void);
418
419 void SV_ReadClientMessage(void);
420
421 // precachemode values:
422 // 0 = fail if not precached,
423 // 1 = warn if not found and precache if possible
424 // 2 = precache
425 int SV_ModelIndex(const char *s, int precachemode);
426 int SV_SoundIndex(const char *s, int precachemode);
427
428 int SV_ParticleEffectIndex(const char *name);
429
430 void SV_SetIdealPitch (void);
431
432 void SV_AddUpdates (void);
433
434 void SV_ClientThink (void);
435
436 void SV_ClientPrint(const char *msg);
437 void SV_ClientPrintf(const char *fmt, ...) DP_FUNC_PRINTF(1);
438 void SV_BroadcastPrint(const char *msg);
439 void SV_BroadcastPrintf(const char *fmt, ...) DP_FUNC_PRINTF(1);
440
441 void SV_Physics (void);
442 void SV_Physics_ClientMove (void);
443 void SV_Physics_ClientEntity (prvm_edict_t *ent);
444
445 qboolean SV_PlayerCheckGround (prvm_edict_t *ent);
446 qboolean SV_CheckBottom (prvm_edict_t *ent);
447 qboolean SV_movestep (prvm_edict_t *ent, vec3_t move, qboolean relink, qboolean noenemy, qboolean settrace);
448
449 // Needs to be called any time an entity changes origin, mins, maxs, or solid
450 // sets ent->v.absmin and ent->v.absmax
451 // if touchtriggers, calls prog functions for the intersected triggers
452 void SV_LinkEdict (prvm_edict_t *ent, qboolean touch_triggers);
453
454 // calculates hitsupercontentsmask for a generic qc entity
455 int SV_GenericHitSuperContentsMask(const prvm_edict_t *edict);
456 // traces a box move against worldmodel and all entities in the specified area
457 trace_t SV_Move(const vec3_t start, const vec3_t mins, const vec3_t maxs, const vec3_t end, int type, prvm_edict_t *passedict, int hitsupercontentsmask);
458
459 #define SV_PointSuperContents(point) (SV_Move((point), vec3_origin, vec3_origin, (point), sv_gameplayfix_swiminbmodels.integer ? MOVE_NOMONSTERS : MOVE_WORLDONLY, NULL, 0).startsupercontents)
460
461 void SV_FlushBroadcastMessages(void);
462 void SV_WriteClientdataToMessage (client_t *client, prvm_edict_t *ent, sizebuf_t *msg, int *stats);
463
464 void SV_MoveToGoal (void);
465
466 void SV_ApplyClientMove (void);
467 void SV_SaveSpawnparms (void);
468 void SV_SpawnServer (const char *server);
469
470 void SV_CheckVelocity (prvm_edict_t *ent);
471
472 void SV_SetupVM(void);
473
474 void SV_VM_Begin(void);
475 void SV_VM_End(void);
476
477 const char *Host_TimingReport(); // for output in Host_Status_f
478
479 #endif
480