2 * $Logfile: /Freespace2/code/Network/multilag.cpp $
8 * Revision 1.1 2002/05/03 03:28:10 root
12 * 4 11/19/98 8:03a Dave
13 * Full support for D3-style reliable sockets. Revamped packet lag/loss
14 * system, made it receiver side and at the lowest possible level.
16 * 3 11/17/98 11:12a Dave
17 * Removed player identification by address. Now assign explicit id #'s.
19 * 2 10/07/98 10:53a Dave
22 * 1 10/07/98 10:50a Dave
24 * 15 6/05/98 9:54a Lawrance
27 * 14 4/27/98 6:02p Dave
28 * Modify how missile scoring works. Fixed a team select ui bug. Speed up
29 * multi_lag system. Put in new main hall.
31 * 13 4/18/98 5:00p Dave
32 * Put in observer zoom key. Made mission sync screen more informative.
34 * 12 4/06/98 12:37a Lawrance
35 * fix compile bug with demo
37 * 11 4/04/98 8:42p Dave
38 * Tested and debugged UDP reliable socket layer. Modified lag system to
39 * take this into account.
41 * 10 4/02/98 6:29p Lawrance
42 * compile out multilag code for demo
44 * 9 3/14/98 2:48p Dave
45 * Cleaned up observer joining code. Put in support for file xfers to
46 * ingame joiners (observers or not). Revamped and reinstalled pseudo
49 * 8 1/11/98 10:03p Allender
50 * removed <winsock.h> from headers which included it. Made psnet_socket
51 * type which is defined just as SOCKET type is.
53 * 7 12/29/97 5:21p Dave
54 * Put in object update sequencing for multiplayer.
56 * 6 12/16/97 6:17p Dave
57 * Put in primary weapon support for multiplayer weapon select screen.
59 * 5 12/10/97 4:45p Dave
60 * Added in more detailed support for multiplayer packet lag/loss. Fixed
61 * some multiplayer stuff. Added some controls to the standalone.
63 * 4 12/01/97 4:59p Dave
64 * Synchronized multiplayer debris objects. Put in pilot popup in main
65 * hall. Optimized simulated multiplayer lag module. Fixed a potential
68 * 3 11/28/97 7:04p Dave
69 * Emergency checkin due to big system crash.
71 * 2 11/28/97 5:06p Dave
72 * Put in facilities for simulating multiplayer lag.
74 * 1 11/28/97 4:38p Dave
89 // ----------------------------------------------------------------------------------------------------
90 // LAGLOSS DEFINES/VARS
93 // default LAGLOSS values
94 #define MULTI_LAGLOSS_DEF_LAG (-1)
95 #define MULTI_LAGLOSS_DEF_LAGMIN (-1)
96 #define MULTI_LAGLOSS_DEF_LAGMAX (-1)
97 #define MULTI_LAGLOSS_DEF_LOSS (-1.0f)
98 #define MULTI_LAGLOSS_DEF_LOSSMIN (-1.0f)
99 #define MULTI_LAGLOSS_DEF_LOSSMAX (-1.0f)
100 #define MULTI_LAGLOSS_DEF_STREAK (2500)
103 int Multi_lag_inited = 0;
105 // lag values (base - max and min)
106 int Multi_lag_base = -1;
107 int Multi_lag_min = -1;
108 int Multi_lag_max = -1;
110 // packet loss values (base - max and min)
111 float Multi_loss_base = -1.0f;
112 float Multi_loss_min = -1.0f;
113 float Multi_loss_max = -1.0f;
115 // streaks for lagging
116 int Multi_streak_stamp = -1; // timestamp telling when the streak of a certain lag is done
117 int Multi_streak_time = 0; // how long each streak will last
118 int Multi_current_streak = -1; // what lag the current streak has
120 // struct for buffering stuff on receives
121 typedef struct lag_buf {
122 ubyte data[700]; // the data from the packet
123 int data_len; // length of the data
124 uint socket; // this can be either a PSNET_SOCKET or a PSNET_SOCKET_RELIABLE
125 int stamp; // when this expires, make this packet available
126 SOCKADDR_IN ip_addr; // ip address when in TCP
127 SOCKADDR_IPX ipx_addr; // ipx address when in IPX mode
129 struct lag_buf * prev; // prev in the list
130 struct lag_buf * next; // next in the list
133 // lag buffers - malloced
135 #define MAX_LAG_BUFFERS 1 // only 1 buffer in non-debug builds
137 #define MAX_LAG_BUFFERS 1000
139 lag_buf *Lag_buffers[MAX_LAG_BUFFERS];
140 int Lag_buf_count = 0; // how many lag_buf's are currently in use
142 lag_buf Lag_free_list;
143 lag_buf Lag_used_list;
146 // ----------------------------------------------------------------------------------------------------
147 // LAGLOSS FORWARD DECLARATIONS
150 // get a value to lag a packet with (in ms)
151 int multi_lag_get_random_lag();
153 // boolean yes or no - should this packet be lost?
154 int multi_lag_should_be_lost();
156 // get a free packet buffer, return NULL on fail
157 lag_buf *multi_lag_get_free();
159 // put a lag buffer back
160 void multi_lag_put_free(lag_buf *buf);
162 // ----------------------------------------------------------------------------------------------------
166 void multi_lag_init()
168 // never do lag in a non-debug build
169 #if defined(NDEBUG) || !defined(MULTI_USE_LAG)
170 Multi_lag_inited = 0;
174 // if we're already inited, don't do anything
175 if(Multi_lag_inited){
179 // try and allocate lag bufs
180 for(idx=0; idx<MAX_LAG_BUFFERS; idx++){
181 Lag_buffers[idx] = (lag_buf*)malloc(sizeof(lag_buf));
182 if(Lag_buffers[idx] == NULL){
187 // initialize lag buffer lists
188 list_init( &Lag_free_list );
189 list_init( &Lag_used_list );
191 // Link all object slots into the free list
192 for (idx=0; idx<MAX_LAG_BUFFERS; idx++) {
193 list_append(&Lag_free_list, Lag_buffers[idx]);
196 // set the default lag values
197 Multi_lag_base = MULTI_LAGLOSS_DEF_LAG;
198 Multi_lag_min = MULTI_LAGLOSS_DEF_LAGMIN;
199 Multi_lag_max = MULTI_LAGLOSS_DEF_LAGMAX;
201 // set the default loss values
202 Multi_loss_base = MULTI_LAGLOSS_DEF_LOSS;
203 Multi_loss_min = MULTI_LAGLOSS_DEF_LOSSMIN;
204 Multi_loss_max = MULTI_LAGLOSS_DEF_LOSSMAX;
206 // set the default lag streak time
207 Multi_streak_time = MULTI_LAGLOSS_DEF_STREAK;
209 Multi_lag_inited = 1;
213 void multi_lag_close()
217 // if we're not inited already, don't do anything
218 if(!Multi_lag_inited){
222 // free up lag buffers
223 for(idx=0; idx<MAX_LAG_BUFFERS; idx++){
224 if(Lag_buffers[idx] != NULL){
225 free(Lag_buffers[idx]);
226 Lag_buffers[idx] = NULL;
230 Multi_lag_inited = 0;
233 // select for multi_lag
234 int multi_lag_select(int nfds, fd_set *readfds, fd_set *writefds, fd_set *except_fds, const timeval *timeout)
239 SOCKADDR_IPX ipx_addr;
241 lag_buf *moveup, *item;
243 Assert(readfds != NULL);
244 Assert(writefds == NULL);
245 Assert(except_fds == NULL);
247 // clear out addresses
248 memset(&ip_addr, 0, sizeof(SOCKADDR_IN));
249 memset(&ipx_addr, 0, sizeof(SOCKADDR_IPX));
251 // if there's data on the socket, read it
252 if(select(nfds, readfds, writefds, except_fds, timeout)){
253 // read the data and stuff it
255 t_from_len = sizeof(SOCKADDR_IN);
256 ret_val = recvfrom(readfds->fd_array[0], t_buf, 1024, 0, (SOCKADDR*)&ip_addr, &t_from_len);
258 t_from_len = sizeof(SOCKADDR_IPX);
259 ret_val = recvfrom(readfds->fd_array[0], t_buf, 1024, 0, (SOCKADDR*)&ipx_addr, &t_from_len);
262 // wacky socket error
263 if(ret_val == SOCKET_ERROR){
267 // if we should be dropping this packet
268 if(!multi_lag_should_be_lost()){
269 // get a free packet buf and stuff the data
270 item = multi_lag_get_free();
272 Assert(ret_val < 700);
273 memcpy(item->data, t_buf, ret_val);
274 item->data_len = ret_val;
275 item->ip_addr = ip_addr;
276 item->ipx_addr = ipx_addr;
277 item->socket = readfds->fd_array[0];
278 item->stamp = timestamp(multi_lag_get_random_lag());
283 // always unset the readfds
284 readfds->fd_count = 0;
286 // now determine if we have any pending packets - find the first one
287 // NOTE : this _could_ be the packet we just read. In fact, with a 0 lag, this will always be the case
288 moveup=GET_FIRST(&Lag_used_list);
289 while ( moveup!=END_OF_LIST(&Lag_used_list) ) {
290 // if the timestamp has elapsed and we have a matching socket
291 if((readfds->fd_array[0] == (SOCKET)moveup->socket) && ((moveup->stamp <= 0) || timestamp_elapsed(moveup->stamp))){
292 // set this so we think select returned yes
293 readfds->fd_count = 1;
297 moveup = GET_NEXT(moveup);
304 // recvfrom for multilag
305 int multi_lag_recvfrom(uint s, char *buf, int len, int flags, struct sockaddr *from, int *fromlen)
307 lag_buf *moveup = NULL;
308 lag_buf *item = NULL;
310 // now determine if we have any pending packets - find the first one
311 moveup=GET_FIRST(&Lag_used_list);
312 while ( moveup!=END_OF_LIST(&Lag_used_list) ) {
313 // if the timestamp has elapsed
314 if((s == (SOCKET)moveup->socket) && ((moveup->stamp <= 0) || timestamp_elapsed(moveup->stamp))){
319 moveup = GET_NEXT(moveup);
322 // if this happens, it means that the multi_lag_select() returned an improper value
325 Assert(item->data_len <= len);
326 memcpy(buf, item->data, item->data_len);
328 memcpy(from, &item->ip_addr, sizeof(SOCKADDR_IN));
330 memcpy(from, &item->ipx_addr, sizeof(SOCKADDR_IPX));
333 // stick the item back on the free list
334 multi_lag_put_free(item);
336 // return the size in bytes
337 return item->data_len;
340 // ----------------------------------------------------------------------------------------------------
341 // LAGLOSS FORWARD DEFINITIONS
344 int multi_lag_get_random_lag()
346 // first determine the percentage we'll be checking against
350 // if the lag system isn't inited, don't do anything (no lag)
351 if(!Multi_lag_inited){
356 // see if we should be going up or down (loss max/loss min)
358 if((float)rand()/(float)RAND_MAX < 0.5){
360 if(Multi_lag_min >= 0){
361 mod = - (int)((float)(Multi_lag_base - Multi_lag_min) * ((float)rand()/(float)RAND_MAX));
365 if(Multi_lag_max >= 0){
366 mod = (int)((float)(Multi_lag_max - Multi_lag_base) * ((float)rand()/(float)RAND_MAX));
370 // if the current streak has elapsed, calculate a new one
371 if((Multi_streak_stamp == -1) || (timestamp_elapsed(Multi_streak_stamp))){
372 // timestamp the new streak
373 Multi_streak_stamp = timestamp(Multi_streak_time);
375 // set the return value
376 ret = Multi_lag_base + mod;
378 // set the lag value of this current streak
379 Multi_current_streak = ret;
381 // otherwise use the lag for the current streak
383 ret = Multi_current_streak;
389 // this _may_ be a bit heavyweight, but it _is_ debug code
390 int multi_lag_should_be_lost()
392 // first determine the percentage we'll be checking against
395 // if the lag system isn't inited, don't do anything
396 if(!Multi_lag_inited){
400 // see if we should be going up or down (loss max/loss min)
402 if((float)rand()/(float)RAND_MAX < 0.5){
404 if(Multi_loss_min >= 0.0f){
405 mod = - ((Multi_loss_base - Multi_loss_min) * ((float)rand()/(float)RAND_MAX));
409 if(Multi_loss_max >= 0.0f){
410 mod = ((Multi_loss_max - Multi_loss_base) * ((float)rand()/(float)RAND_MAX));
414 if((float)rand()/(float)RAND_MAX <= Multi_loss_base + mod){
421 // get a free packet buffer, return NULL on fail
422 lag_buf *multi_lag_get_free()
426 // if we're out of buffers
427 if(Lag_buf_count >= MAX_LAG_BUFFERS){
428 nprintf(("Network", "Out of lag buffers!\n"));
433 lagp = GET_FIRST(&Lag_free_list);
434 Assert( lagp != &Lag_free_list ); // shouldn't have the dummy element
436 // remove trailp from the free list
437 list_remove( &Lag_free_list, lagp );
439 // insert trailp onto the end of used list
440 list_append( &Lag_used_list, lagp );
442 // increase the count
447 // put a lag buffer back
448 void multi_lag_put_free(lag_buf *buf)
450 // remove objp from the used list
451 list_remove( &Lag_used_list, buf);
453 // add objp to the end of the free
454 list_append( &Lag_free_list, buf );
460 void multi_lagloss_dcf()
462 // if the lag system isn't inited, don't do anything
463 if(!Multi_lag_inited){
464 dc_printf("Lag System Not Initialized!\n");
468 // display all available commands
469 dc_printf("Usage :\nlag <ms> (-1 to disable)\nlag_min <ms>\nlag_max <ms>\nloss <0-100> (-1 to disable)\nloss_min <0-100>\nloss_max <0-100>\nlag_streak <ms>\nlagloss\n");
471 // display lag settings
473 dc_printf("\n Base %d\n Min %d\n Max %d\n Streak %d\n", Multi_lag_base, Multi_lag_min, Multi_lag_max, Multi_streak_time);
475 // display loss settings
476 dc_printf("Loss : ");
477 dc_printf("\n Base %f\n Min %f\n Max %f\n", Multi_loss_base, Multi_loss_min, Multi_loss_max);
482 // if the lag system isn't inited, don't do anything
483 if(!Multi_lag_inited){
484 dc_printf("Lag System Not Initialized!\n");
489 // parse the argument and change things around accordingly
490 if(Dc_arg_type & ARG_INT){
492 // switch the lag sim off
496 dc_printf("Turning simulated lag off\n");
498 } else if((Multi_lag_max >= 0) && (Dc_arg_int > Multi_lag_max)){
499 dc_printf("Base value greater than max value, ignoring...");
500 } else if((Multi_lag_min >= 0) && (Dc_arg_int < Multi_lag_min)){
501 dc_printf("Base value smaller than min value, ignoring...");
503 Multi_lag_base = Dc_arg_int;
511 // if the lag system isn't inited, don't do anything
512 if(!Multi_lag_inited){
513 dc_printf("Lag System Not Initialized!\n");
518 // parse the argument and change things around accordingly
519 if(Dc_arg_type & ARG_INT){
520 if(Dc_arg_int > Multi_lag_base){
521 dc_printf("Min value greater than base value, ignoring...");
526 Multi_lag_min = Dc_arg_int;
535 // if the lag system isn't inited, don't do anything
536 if(!Multi_lag_inited){
537 dc_printf("Lag System Not Initialized!\n");
541 // parse the argument and change things around accordingly
543 if(Dc_arg_type & ARG_INT){
544 if((Dc_arg >=0) && (Dc_arg_int < Multi_lag_base)){
545 dc_printf("Max value smaller than base value, ignoring...");
550 Multi_lag_max = Dc_arg_int;
559 // if the lag system isn't inited, don't do anything
560 if(!Multi_lag_inited){
561 dc_printf("Lag System Not Initialized!\n");
565 // parse the argument and change things around accordingly
567 if(Dc_arg_type & ARG_INT){
568 float val = (float)Dc_arg_int / 100.0f;
570 if(Dc_arg_int > 100){
571 dc_printf("Illegal loss base value, ignoring...");
572 } else if(Dc_arg_int < 0){
573 // switch the loss sim off
574 dc_printf("Turning simulated loss off\n");
575 Multi_loss_base = -1.0f;
576 Multi_loss_min = -1.0f;
577 Multi_loss_max = -1.0f;
579 } else if((Multi_loss_max >= 0.0f) && (val > Multi_loss_max)){
580 dc_printf("Base value greater than max value, ignoring...");
581 } else if((Multi_loss_min >= 0.0f) && (val < Multi_loss_min)){
582 dc_printf("Base value smaller than min value, ignoring...");
584 Multi_loss_base = val;
592 // if the lag system isn't inited, don't do anything
593 if(!Multi_lag_inited){
594 dc_printf("Lag System Not Initialized!\n");
598 // parse the argument and change things around accordingly
600 if(Dc_arg_type & ARG_INT){
601 float val = (float)Dc_arg_int / 100.0f;
603 if(val > Multi_loss_base){
604 dc_printf("Min value greater than base value, ignoring...");
606 // otherwise set the value
608 Multi_loss_min = -1.0f;
610 Multi_loss_min = val;
619 // if the lag system isn't inited, don't do anything
620 if(!Multi_lag_inited){
621 dc_printf("Lag System Not Initialized!\n");
625 // parse the argument and change things around accordingly
627 if(Dc_arg_type & ARG_INT){
628 float val = (float)Dc_arg_int / 100.0f;
630 if(val < Multi_loss_base){
631 dc_printf("Max value smaller than base value, ignoring...");
633 // otherwise set the value
635 Multi_loss_max = -1.0f;
637 Multi_loss_min = val;
646 // if the lag system isn't inited, don't do anything
647 if(!Multi_lag_inited){
648 dc_printf("Lag System Not Initialized!\n");
657 // if the lag system isn't inited, don't do anything
658 if(!Multi_lag_inited){
659 dc_printf("Lag System Not Initialized!\n");
664 if(Dc_arg_type & ARG_INT){
666 Multi_streak_time = Dc_arg_int;
673 // if the lag system isn't inited, don't do anything
674 if(!Multi_lag_inited){
675 dc_printf("Lag System Not Initialized!\n");
679 dc_printf("Setting bad lag/loss parameters\n");
681 // set good lagloss parameters
682 Multi_lag_base = 500;
686 Multi_loss_base = 0.2f;
687 Multi_loss_min = 0.15f;
688 Multi_loss_max = 0.23f;
690 Multi_streak_time = 800;
691 Multi_streak_stamp = -1;
692 Multi_current_streak = -1;
697 // if the lag system isn't inited, don't do anything
698 if(!Multi_lag_inited){
699 dc_printf("Lag System Not Initialized!\n");
703 dc_printf("Setting avg lag/loss parameters\n");
705 // set good lagloss parameters
706 Multi_lag_base = 275;
710 Multi_loss_base = 0.15f;
711 Multi_loss_min = 0.1f;
712 Multi_loss_max = 0.20f;
714 Multi_streak_time = 900;
715 Multi_streak_stamp = -1;
716 Multi_current_streak = -1;
721 // if the lag system isn't inited, don't do anything
722 if(!Multi_lag_inited){
723 dc_printf("Lag System Not Initialized!\n");
727 dc_printf("Setting good lag/loss parameters\n");
729 // set good lagloss parameters
730 Multi_lag_base = 100;
734 Multi_loss_base = 0.08f;
735 Multi_loss_min = 0.0f;
736 Multi_loss_max = 0.1f;
738 Multi_streak_time = 1000;
739 Multi_streak_stamp = -1;
740 Multi_current_streak = -1;