2 * Copyright (C) Volition, Inc. 1999. All rights reserved.
4 * All source code herein is the property of Volition, Inc. You may not sell
5 * or otherwise commercially exploit the source or things you created based on
10 * $Logfile: /Freespace2/code/Network/multilag.cpp $
16 * Revision 1.6 2004/07/04 11:39:06 taylor
17 * fix missing debrief text, crash on exit, path separator's, warning fixes, no GR_SOFT
19 * Revision 1.5 2002/06/09 04:41:24 relnev
20 * added copyright header
22 * Revision 1.4 2002/05/26 20:49:54 theoddone33
25 * Revision 1.3 2002/05/26 20:22:48 theoddone33
26 * Most of network/ works
28 * Revision 1.2 2002/05/07 03:16:47 theoddone33
29 * The Great Newline Fix
31 * Revision 1.1.1.1 2002/05/03 03:28:10 root
35 * 4 11/19/98 8:03a Dave
36 * Full support for D3-style reliable sockets. Revamped packet lag/loss
37 * system, made it receiver side and at the lowest possible level.
39 * 3 11/17/98 11:12a Dave
40 * Removed player identification by address. Now assign explicit id #'s.
42 * 2 10/07/98 10:53a Dave
45 * 1 10/07/98 10:50a Dave
47 * 15 6/05/98 9:54a Lawrance
50 * 14 4/27/98 6:02p Dave
51 * Modify how missile scoring works. Fixed a team select ui bug. Speed up
52 * multi_lag system. Put in new main hall.
54 * 13 4/18/98 5:00p Dave
55 * Put in observer zoom key. Made mission sync screen more informative.
57 * 12 4/06/98 12:37a Lawrance
58 * fix compile bug with demo
60 * 11 4/04/98 8:42p Dave
61 * Tested and debugged UDP reliable socket layer. Modified lag system to
62 * take this into account.
64 * 10 4/02/98 6:29p Lawrance
65 * compile out multilag code for demo
67 * 9 3/14/98 2:48p Dave
68 * Cleaned up observer joining code. Put in support for file xfers to
69 * ingame joiners (observers or not). Revamped and reinstalled pseudo
72 * 8 1/11/98 10:03p Allender
73 * removed <winsock.h> from headers which included it. Made psnet_socket
74 * type which is defined just as SOCKET type is.
76 * 7 12/29/97 5:21p Dave
77 * Put in object update sequencing for multiplayer.
79 * 6 12/16/97 6:17p Dave
80 * Put in primary weapon support for multiplayer weapon select screen.
82 * 5 12/10/97 4:45p Dave
83 * Added in more detailed support for multiplayer packet lag/loss. Fixed
84 * some multiplayer stuff. Added some controls to the standalone.
86 * 4 12/01/97 4:59p Dave
87 * Synchronized multiplayer debris objects. Put in pilot popup in main
88 * hall. Optimized simulated multiplayer lag module. Fixed a potential
91 * 3 11/28/97 7:04p Dave
92 * Emergency checkin due to big system crash.
94 * 2 11/28/97 5:06p Dave
95 * Put in facilities for simulating multiplayer lag.
97 * 1 11/28/97 4:38p Dave
106 #include <sys/time.h>
107 #include <sys/types.h>
108 #include <sys/socket.h>
109 #include <netinet/in.h>
110 #include <arpa/inet.h>
116 #include "multilag.h"
119 #include "linklist.h"
121 // ----------------------------------------------------------------------------------------------------
122 // LAGLOSS DEFINES/VARS
125 // default LAGLOSS values
126 #define MULTI_LAGLOSS_DEF_LAG (-1)
127 #define MULTI_LAGLOSS_DEF_LAGMIN (-1)
128 #define MULTI_LAGLOSS_DEF_LAGMAX (-1)
129 #define MULTI_LAGLOSS_DEF_LOSS (-1.0f)
130 #define MULTI_LAGLOSS_DEF_LOSSMIN (-1.0f)
131 #define MULTI_LAGLOSS_DEF_LOSSMAX (-1.0f)
132 #define MULTI_LAGLOSS_DEF_STREAK (2500)
135 int Multi_lag_inited = 0;
137 // lag values (base - max and min)
138 int Multi_lag_base = -1;
139 int Multi_lag_min = -1;
140 int Multi_lag_max = -1;
142 // packet loss values (base - max and min)
143 float Multi_loss_base = -1.0f;
144 float Multi_loss_min = -1.0f;
145 float Multi_loss_max = -1.0f;
147 // streaks for lagging
148 int Multi_streak_stamp = -1; // timestamp telling when the streak of a certain lag is done
149 int Multi_streak_time = 0; // how long each streak will last
150 int Multi_current_streak = -1; // what lag the current streak has
152 // struct for buffering stuff on receives
153 typedef struct lag_buf {
154 ubyte data[700]; // the data from the packet
155 int data_len; // length of the data
156 uint socket; // this can be either a PSNET_SOCKET or a PSNET_SOCKET_RELIABLE
157 int stamp; // when this expires, make this packet available
158 struct sockaddr_in ip_addr; // ip address when in TCP
160 struct lag_buf * prev; // prev in the list
161 struct lag_buf * next; // next in the list
164 // lag buffers - malloced
166 #define MAX_LAG_BUFFERS 1 // only 1 buffer in non-debug builds
168 #define MAX_LAG_BUFFERS 1000
170 lag_buf *Lag_buffers[MAX_LAG_BUFFERS];
171 int Lag_buf_count = 0; // how many lag_buf's are currently in use
173 lag_buf Lag_free_list;
174 lag_buf Lag_used_list;
177 // ----------------------------------------------------------------------------------------------------
178 // LAGLOSS FORWARD DECLARATIONS
181 // get a value to lag a packet with (in ms)
182 int multi_lag_get_random_lag();
184 // boolean yes or no - should this packet be lost?
185 int multi_lag_should_be_lost();
187 // get a free packet buffer, return NULL on fail
188 lag_buf *multi_lag_get_free();
190 // put a lag buffer back
191 void multi_lag_put_free(lag_buf *buf);
193 // ----------------------------------------------------------------------------------------------------
197 void multi_lag_init()
199 // never do lag in a non-debug build
200 #if defined(NDEBUG) || !defined(MULTI_USE_LAG)
201 Multi_lag_inited = 0;
205 // if we're already inited, don't do anything
206 if(Multi_lag_inited){
210 // try and allocate lag bufs
211 for(idx=0; idx<MAX_LAG_BUFFERS; idx++){
212 Lag_buffers[idx] = (lag_buf*)malloc(sizeof(lag_buf));
213 if(Lag_buffers[idx] == NULL){
218 // initialize lag buffer lists
219 list_init( &Lag_free_list );
220 list_init( &Lag_used_list );
222 // Link all object slots into the free list
223 for (idx=0; idx<MAX_LAG_BUFFERS; idx++) {
224 list_append(&Lag_free_list, Lag_buffers[idx]);
227 // set the default lag values
228 Multi_lag_base = MULTI_LAGLOSS_DEF_LAG;
229 Multi_lag_min = MULTI_LAGLOSS_DEF_LAGMIN;
230 Multi_lag_max = MULTI_LAGLOSS_DEF_LAGMAX;
232 // set the default loss values
233 Multi_loss_base = MULTI_LAGLOSS_DEF_LOSS;
234 Multi_loss_min = MULTI_LAGLOSS_DEF_LOSSMIN;
235 Multi_loss_max = MULTI_LAGLOSS_DEF_LOSSMAX;
237 // set the default lag streak time
238 Multi_streak_time = MULTI_LAGLOSS_DEF_STREAK;
240 Multi_lag_inited = 1;
244 void multi_lag_close()
248 // if we're not inited already, don't do anything
249 if(!Multi_lag_inited){
253 // free up lag buffers
254 for(idx=0; idx<MAX_LAG_BUFFERS; idx++){
255 if(Lag_buffers[idx] != NULL){
256 free(Lag_buffers[idx]);
257 Lag_buffers[idx] = NULL;
261 Multi_lag_inited = 0;
264 // select for multi_lag
265 int multi_lag_select(int nfds, fd_set *readfds, fd_set *writefds, fd_set *except_fds, timeval *timeout)
271 socklen_t t_from_len;
273 struct sockaddr_in ip_addr;
275 lag_buf *moveup, *item;
277 SDL_assert(readfds != NULL);
278 SDL_assert(writefds == NULL);
279 SDL_assert(except_fds == NULL);
281 // clear out addresses
282 memset(&ip_addr, 0, sizeof(struct sockaddr_in));
284 // if there's data on the socket, read it
285 if(select(nfds+1, readfds, writefds, except_fds, timeout)){
286 // read the data and stuff it
288 t_from_len = sizeof(struct sockaddr_in);
289 ret_val = recvfrom(nfds, t_buf, 1024, 0, (struct sockaddr*)&ip_addr, &t_from_len);
294 // wacky socket error
295 if(ret_val == SOCKET_ERROR){
299 // if we should be dropping this packet
300 if(!multi_lag_should_be_lost()){
301 // get a free packet buf and stuff the data
302 item = multi_lag_get_free();
304 SDL_assert(ret_val < 700);
305 memcpy(item->data, t_buf, ret_val);
306 item->data_len = ret_val;
307 item->ip_addr = ip_addr;
309 item->stamp = timestamp(multi_lag_get_random_lag());
314 // always unset the readfds
315 FD_CLR((SOCKET)nfds, readfds);
317 // now determine if we have any pending packets - find the first one
318 // NOTE : this _could_ be the packet we just read. In fact, with a 0 lag, this will always be the case
319 moveup=GET_FIRST(&Lag_used_list);
320 while ( moveup!=END_OF_LIST(&Lag_used_list) ) {
321 // if the timestamp has elapsed and we have a matching socket
322 if((nfds == (int)moveup->socket) && ((moveup->stamp <= 0) || timestamp_elapsed(moveup->stamp))){
323 // set this so we think select returned yes
324 FD_SET(nfds, readfds);
328 moveup = GET_NEXT(moveup);
335 // recvfrom for multilag
336 int multi_lag_recvfrom(uint s, char *buf, int len, int flags, struct sockaddr *from, int *fromlen)
338 lag_buf *moveup = NULL;
339 lag_buf *item = NULL;
341 // now determine if we have any pending packets - find the first one
342 moveup=GET_FIRST(&Lag_used_list);
343 while ( moveup!=END_OF_LIST(&Lag_used_list) ) {
344 // if the timestamp has elapsed
345 if(((int)s == (SOCKET)moveup->socket) && ((moveup->stamp <= 0) || timestamp_elapsed(moveup->stamp))){
350 moveup = GET_NEXT(moveup);
353 // if this happens, it means that the multi_lag_select() returned an improper value
356 SDL_assert(item->data_len <= len);
357 memcpy(buf, item->data, item->data_len);
359 memcpy(from, &item->ip_addr, sizeof(struct sockaddr_in));
364 // stick the item back on the free list
365 multi_lag_put_free(item);
367 // return the size in bytes
368 return item->data_len;
371 // ----------------------------------------------------------------------------------------------------
372 // LAGLOSS FORWARD DEFINITIONS
375 int multi_lag_get_random_lag()
377 // first determine the percentage we'll be checking against
381 // if the lag system isn't inited, don't do anything (no lag)
382 if(!Multi_lag_inited){
387 // see if we should be going up or down (loss max/loss min)
389 if((float)myrand()/(float)MY_RAND_MAX < 0.5){
391 if(Multi_lag_min >= 0){
392 mod = - (int)((float)(Multi_lag_base - Multi_lag_min) * ((float)myrand()/(float)MY_RAND_MAX));
396 if(Multi_lag_max >= 0){
397 mod = (int)((float)(Multi_lag_max - Multi_lag_base) * ((float)myrand()/(float)MY_RAND_MAX));
401 // if the current streak has elapsed, calculate a new one
402 if((Multi_streak_stamp == -1) || (timestamp_elapsed(Multi_streak_stamp))){
403 // timestamp the new streak
404 Multi_streak_stamp = timestamp(Multi_streak_time);
406 // set the return value
407 ret = Multi_lag_base + mod;
409 // set the lag value of this current streak
410 Multi_current_streak = ret;
412 // otherwise use the lag for the current streak
414 ret = Multi_current_streak;
420 // this _may_ be a bit heavyweight, but it _is_ debug code
421 int multi_lag_should_be_lost()
423 // first determine the percentage we'll be checking against
426 // if the lag system isn't inited, don't do anything
427 if(!Multi_lag_inited){
431 // see if we should be going up or down (loss max/loss min)
433 if((float)myrand()/(float)MY_RAND_MAX < 0.5){
435 if(Multi_loss_min >= 0.0f){
436 mod = - ((Multi_loss_base - Multi_loss_min) * ((float)myrand()/(float)MY_RAND_MAX));
440 if(Multi_loss_max >= 0.0f){
441 mod = ((Multi_loss_max - Multi_loss_base) * ((float)myrand()/(float)MY_RAND_MAX));
445 if((float)myrand()/(float)MY_RAND_MAX <= Multi_loss_base + mod){
452 // get a free packet buffer, return NULL on fail
453 lag_buf *multi_lag_get_free()
457 // if we're out of buffers
458 if(Lag_buf_count >= MAX_LAG_BUFFERS){
459 nprintf(("Network", "Out of lag buffers!\n"));
464 lagp = GET_FIRST(&Lag_free_list);
465 SDL_assert( lagp != &Lag_free_list ); // shouldn't have the dummy element
467 // remove trailp from the free list
468 list_remove( &Lag_free_list, lagp );
470 // insert trailp onto the end of used list
471 list_append( &Lag_used_list, lagp );
473 // increase the count
478 // put a lag buffer back
479 void multi_lag_put_free(lag_buf *buf)
481 // remove objp from the used list
482 list_remove( &Lag_used_list, buf);
484 // add objp to the end of the free
485 list_append( &Lag_free_list, buf );
491 void multi_lagloss_dcf()
493 // if the lag system isn't inited, don't do anything
494 if(!Multi_lag_inited){
495 dc_printf("Lag System Not Initialized!\n");
499 // display all available commands
500 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");
502 // display lag settings
504 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);
506 // display loss settings
507 dc_printf("Loss : ");
508 dc_printf("\n Base %f\n Min %f\n Max %f\n", Multi_loss_base, Multi_loss_min, Multi_loss_max);
513 // if the lag system isn't inited, don't do anything
514 if(!Multi_lag_inited){
515 dc_printf("Lag System Not Initialized!\n");
520 // parse the argument and change things around accordingly
521 if(Dc_arg_type & ARG_INT){
523 // switch the lag sim off
527 dc_printf("Turning simulated lag off\n");
529 } else if((Multi_lag_max >= 0) && (Dc_arg_int > Multi_lag_max)){
530 dc_printf("Base value greater than max value, ignoring...");
531 } else if((Multi_lag_min >= 0) && (Dc_arg_int < Multi_lag_min)){
532 dc_printf("Base value smaller than min value, ignoring...");
534 Multi_lag_base = Dc_arg_int;
542 // if the lag system isn't inited, don't do anything
543 if(!Multi_lag_inited){
544 dc_printf("Lag System Not Initialized!\n");
549 // parse the argument and change things around accordingly
550 if(Dc_arg_type & ARG_INT){
551 if(Dc_arg_int > Multi_lag_base){
552 dc_printf("Min value greater than base value, ignoring...");
557 Multi_lag_min = Dc_arg_int;
566 // if the lag system isn't inited, don't do anything
567 if(!Multi_lag_inited){
568 dc_printf("Lag System Not Initialized!\n");
572 // parse the argument and change things around accordingly
574 if(Dc_arg_type & ARG_INT){
575 if((Dc_arg >=0) && (Dc_arg_int < Multi_lag_base)){
576 dc_printf("Max value smaller than base value, ignoring...");
581 Multi_lag_max = Dc_arg_int;
590 // if the lag system isn't inited, don't do anything
591 if(!Multi_lag_inited){
592 dc_printf("Lag System Not Initialized!\n");
596 // parse the argument and change things around accordingly
598 if(Dc_arg_type & ARG_INT){
599 float val = (float)Dc_arg_int / 100.0f;
601 if(Dc_arg_int > 100){
602 dc_printf("Illegal loss base value, ignoring...");
603 } else if(Dc_arg_int < 0){
604 // switch the loss sim off
605 dc_printf("Turning simulated loss off\n");
606 Multi_loss_base = -1.0f;
607 Multi_loss_min = -1.0f;
608 Multi_loss_max = -1.0f;
610 } else if((Multi_loss_max >= 0.0f) && (val > Multi_loss_max)){
611 dc_printf("Base value greater than max value, ignoring...");
612 } else if((Multi_loss_min >= 0.0f) && (val < Multi_loss_min)){
613 dc_printf("Base value smaller than min value, ignoring...");
615 Multi_loss_base = val;
623 // if the lag system isn't inited, don't do anything
624 if(!Multi_lag_inited){
625 dc_printf("Lag System Not Initialized!\n");
629 // parse the argument and change things around accordingly
631 if(Dc_arg_type & ARG_INT){
632 float val = (float)Dc_arg_int / 100.0f;
634 if(val > Multi_loss_base){
635 dc_printf("Min value greater than base value, ignoring...");
637 // otherwise set the value
639 Multi_loss_min = -1.0f;
641 Multi_loss_min = val;
650 // if the lag system isn't inited, don't do anything
651 if(!Multi_lag_inited){
652 dc_printf("Lag System Not Initialized!\n");
656 // parse the argument and change things around accordingly
658 if(Dc_arg_type & ARG_INT){
659 float val = (float)Dc_arg_int / 100.0f;
661 if(val < Multi_loss_base){
662 dc_printf("Max value smaller than base value, ignoring...");
664 // otherwise set the value
666 Multi_loss_max = -1.0f;
668 Multi_loss_min = val;
677 // if the lag system isn't inited, don't do anything
678 if(!Multi_lag_inited){
679 dc_printf("Lag System Not Initialized!\n");
688 // if the lag system isn't inited, don't do anything
689 if(!Multi_lag_inited){
690 dc_printf("Lag System Not Initialized!\n");
695 if(Dc_arg_type & ARG_INT){
697 Multi_streak_time = Dc_arg_int;
704 // if the lag system isn't inited, don't do anything
705 if(!Multi_lag_inited){
706 dc_printf("Lag System Not Initialized!\n");
710 dc_printf("Setting bad lag/loss parameters\n");
712 // set good lagloss parameters
713 Multi_lag_base = 500;
717 Multi_loss_base = 0.2f;
718 Multi_loss_min = 0.15f;
719 Multi_loss_max = 0.23f;
721 Multi_streak_time = 800;
722 Multi_streak_stamp = -1;
723 Multi_current_streak = -1;
728 // if the lag system isn't inited, don't do anything
729 if(!Multi_lag_inited){
730 dc_printf("Lag System Not Initialized!\n");
734 dc_printf("Setting avg lag/loss parameters\n");
736 // set good lagloss parameters
737 Multi_lag_base = 275;
741 Multi_loss_base = 0.15f;
742 Multi_loss_min = 0.1f;
743 Multi_loss_max = 0.20f;
745 Multi_streak_time = 900;
746 Multi_streak_stamp = -1;
747 Multi_current_streak = -1;
752 // if the lag system isn't inited, don't do anything
753 if(!Multi_lag_inited){
754 dc_printf("Lag System Not Initialized!\n");
758 dc_printf("Setting good lag/loss parameters\n");
760 // set good lagloss parameters
761 Multi_lag_base = 100;
765 Multi_loss_base = 0.08f;
766 Multi_loss_min = 0.0f;
767 Multi_loss_max = 0.1f;
769 Multi_streak_time = 1000;
770 Multi_streak_stamp = -1;
771 Multi_current_streak = -1;