-
Notifications
You must be signed in to change notification settings - Fork 14
/
udpst.c
1681 lines (1616 loc) · 80.5 KB
/
udpst.c
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* Copyright (c) 2020, Broadband Forum
* Copyright (c) 2020, AT&T Communications
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* 3. Neither the name of the copyright holder nor the names of its
* contributors may be used to endorse or promote products derived from this
* software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
*
* UDP Speed Test - udpst.c
*
* This file contains main() and handles configuration initialization as well
* as parameter processing.
*
* Author Date Comments
* -------------------- ---------- ----------------------------------
* Len Ciavattone 01/16/2019 Created
* Len Ciavattone 10/18/2019 Add param for load sample period
* Len Ciavattone 11/04/2019 Add minimum delays to summary
* Len Ciavattone 06/16/2020 Add dual-stack (IPv6) support
* Len Ciavattone 07/02/2020 Added (HMAC-SHA256) authentication
* Len Ciavattone 08/04/2020 Rearranged source files
* Len Ciavattone 09/03/2020 Added __linux__ conditionals
* Len Ciavattone 10/09/2020 Add parameter for bimodal support
* Len Ciavattone 11/10/2020 Add option to ignore OoO/Dup
* Len Ciavattone 06/08/2021 Add DISABLE_INT_TIMER conditional
* to support older client devices
* Len Ciavattone 10/13/2021 Refresh with clang-format
* Limit format options to client
* Add TR-181 fields in JSON
* Add JSON error status and message
* Len Ciavattone 11/18/2021 Add backward compat. protocol version
* Add bandwidth management support
* Len Ciavattone 12/08/2021 Add starting sending rate
* Len Ciavattone 12/17/2021 Add payload randomization
* Len Ciavattone 12/21/2021 Add traditional (1500 byte) MTU
* Len Ciavattone 02/02/2022 Add rate adj. algo. selection
* Len Ciavattone 12/29/2022 Add single test option on server
* Len Ciavattone 01/14/2023 Add multi-connection support
* Len Ciavattone 02/14/2023 Add per-server port selection and
* clock updates based on rx packets
* Len Ciavattone 03/04/2023 Load balance returned epoll events
* Len Ciavattone 03/22/2023 Add optimization output to banner
* Len Ciavattone 04/04/2023 Add optional rate limiting to banner
* Len Ciavattone 05/24/2023 Add data output (export) capability
* Len Ciavattone 10/01/2023 Updated ErrorStatus values
* Len Ciavattone 03/03/2024 Add multi-key support
* Len Ciavattone 04/12/2024 Add checksum info to banner
*
*/
#define UDPST
#ifdef __linux__
#define _GNU_SOURCE
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <errno.h>
#include <limits.h>
#include <time.h>
#include <fcntl.h>
#include <unistd.h>
#include <signal.h>
#include <net/if.h>
#include <netinet/in.h>
#include <sys/epoll.h>
#include <sys/stat.h>
#include <sys/time.h>
#ifdef AUTH_KEY_ENABLE
#include <openssl/hmac.h>
#include <openssl/x509.h>
#endif
#else
#include "../udpst_alt1.h"
#endif
//
#include "cJSON.h"
#include "udpst_common.h"
#include "udpst_protocol.h"
#include "udpst.h"
#include "udpst_control.h"
#include "udpst_data.h"
#include "udpst_srates.h"
#ifndef __linux__
#include "../udpst_alt2.h"
#endif
//----------------------------------------------------------------------------
//
// Internal function prototypes
//
void signal_alrm(int);
void signal_exit(int);
int proc_parameters(int, char **, int);
int param_error(int, int, int);
int read_keyfile(int);
int json_finish(void);
//----------------------------------------------------------------------------
//
// Global data
//
#define ENDTEXT_BASIC "[%d]End time reached"
#define ENDTEXT_NEWBW ENDTEXT_BASIC " (New USBW: %d, DSBW: %d)\n"
#define NOAUTH_TEXT "ERROR: Built without authentication functionality\n"
int errConn = -1, monConn = -1, aggConn = -1; // Error, monitoring, and aggregate
char scratch[STRING_SIZE]; // General purpose scratch buffer
struct configuration conf; // Configuration data structure
struct repository repo; // Repository of global data
struct connection *conn; // Connection table (array)
static volatile sig_atomic_t sig_alrm = 0; // Interrupt indicator
static volatile sig_atomic_t sig_exit = 0; // Interrupt indicator
struct epoll_event epoll_events[MAX_EPOLL_EVENTS];
char *boolText[] = {"Disabled", "Enabled"};
char *rateAdjAlgo[] = {"B", "C"}; // Aligned to CHTA_RA_ALGO_x
//
cJSON *json_top = NULL, *json_output = NULL, *json_siArray = NULL;
char json_errbuf[STRING_SIZE], json_errbuf2[STRING_SIZE];
//----------------------------------------------------------------------------
// Function definitions
//----------------------------------------------------------------------------
//
// Program entry point
//
int main(int argc, char **argv) {
pid_t pid;
int i, j, var, var2, readyfds, fdpass, pristatus, secstatus;
int appstatus = STATUS_ERROR, outputfd = STDOUT_FILENO, logfilefd = -1;
struct itimerval itime;
struct sigaction saction;
struct stat statbuf;
//
// Sanity check that rate adjustment algorithm identifiers align with protocol
//
if (sizeof(rateAdjAlgo) / sizeof(char *) != CHTA_RA_ALGO_MAX + 1) {
var = sprintf(scratch, "ERROR: Invalid number of rate adjustment algorithm identifiers\n");
var = write(outputfd, scratch, var);
return STATUS_INIT_ERRBASE + ERROR_INIT_GENERIC;
}
for (var = CHTA_RA_ALGO_MIN; var <= CHTA_RA_ALGO_MAX; var++) {
if (rateAdjAlgo[var] == NULL) {
var = sprintf(scratch, "ERROR: Null pointer for rate adjustment algorithm identifier\n");
var = write(outputfd, scratch, var);
return STATUS_INIT_ERRBASE + ERROR_INIT_GENERIC;
}
}
//
// Verify and process parameters, initialize configuration and repository
//
if ((var = proc_parameters(argc, argv, outputfd)) != -1) {
return STATUS_CONF_ERRBASE + var;
}
//
// Read and store key entries if key file provided
//
if (conf.keyFile != NULL) {
if ((var = read_keyfile(outputfd)) != -1) {
return STATUS_CONF_ERRBASE + var;
}
}
//
// Create top-level JSON output object if needed
//
if (conf.jsonOutput) {
json_top = cJSON_CreateObject();
}
*json_errbuf = '\0'; // Initialize to no error
*json_errbuf2 = '\0'; // Initialize to no error
//
// Execute as daemon if requested
//
if (conf.isDaemon) {
//
// Open log file before child creation
//
if (conf.logFile != NULL) {
if ((logfilefd = open(conf.logFile, LOGFILE_FLAGS, LOGFILE_MODE)) < 0) {
var = snprintf(scratch, STRING_SIZE, "OPEN ERROR: <%s> %s\n", conf.logFile, strerror(errno));
var = write(outputfd, scratch, var);
return STATUS_INIT_ERRBASE + ERROR_INIT_GENERIC;
}
if (fstat(logfilefd, &statbuf) < 0) {
var = snprintf(scratch, STRING_SIZE, "FSTAT ERROR: <%s> %s\n", conf.logFile, strerror(errno));
var = write(outputfd, scratch, var);
return STATUS_INIT_ERRBASE + ERROR_INIT_GENERIC;
}
repo.logFileSize = (int) statbuf.st_size; // Initialize log file size
outputfd = logfilefd;
}
//
// Create child
//
if ((pid = fork()) < 0) {
var = sprintf(scratch, "ERROR: fork() failed\n");
var = write(outputfd, scratch, var);
return STATUS_INIT_ERRBASE + ERROR_INIT_GENERIC;
} else if (pid != 0) {
return STATUS_SUCCESS; // Parent exits
}
//
// Initialize child
//
setsid();
var = chdir("/");
umask(0);
if ((i = open("/dev/null", O_RDWR)) >= 0) {
dup2(i, STDIN_FILENO);
dup2(i, STDOUT_FILENO);
dup2(i, STDERR_FILENO);
if ((i != STDIN_FILENO) && (i != STDOUT_FILENO) && (i != STDERR_FILENO))
close(i);
}
}
//
// Initialize local copy of system time clock and seed RNG
//
clock_gettime(CLOCK_REALTIME, &repo.systemClock);
srandom((unsigned int) repo.systemClock.tv_nsec);
//
// Print banner or initialize JSON output object
//
if (!conf.jsonOutput) {
var = sprintf(scratch, SOFTWARE_TITLE "\nSoftware Ver: %s", SOFTWARE_VER);
if (repo.isServer)
var += sprintf(&scratch[var], ", Protocol Ver: %d-%d", PROTOCOL_MIN, PROTOCOL_VER);
else
var += sprintf(&scratch[var], ", Protocol Ver: %d", PROTOCOL_VER); // Client is always the latest
var += sprintf(&scratch[var], ", Built: " __DATE__ " " __TIME__);
#ifdef RATE_LIMITING
var += sprintf(&scratch[var], ", Rate Limiting via '-B mbps'");
#endif // RATE_LIMITING
scratch[var++] = '\n';
var = write(outputfd, scratch, var);
//
var = 0;
if (conf.ipv6Only)
var = IPV6_ADDSIZE;
if (conf.traditionalMTU)
i = MAX_TPAYLOAD_SIZE - var;
else
i = MAX_PAYLOAD_SIZE - var;
if (conf.jumboStatus)
j = MAX_JPAYLOAD_SIZE - var;
else
j = i;
if (repo.isServer)
var = sprintf(scratch, "Mode: Server, Payload Default[Max]: %d[%d]", i, j);
else
var = sprintf(scratch, "Mode: Client, Payload Default[Max]: %d[%d]", i, j);
#ifdef AUTH_KEY_ENABLE
var += sprintf(&scratch[var], ", Auth: Available");
#else
var += sprintf(&scratch[var], ", Auth: Unavailable");
#endif // AUTH_KEY_ENABLE
#ifdef ADD_HEADER_CSUM
var += sprintf(&scratch[var], ", Checksum: On");
#else
var += sprintf(&scratch[var], ", Checksum: Off");
#endif // ADD_HEADER_CSUM
var += sprintf(&scratch[var], ", Optimizations:");
#ifdef HAVE_SENDMMSG
var += sprintf(&scratch[var], " SendMMsg()");
#ifdef HAVE_GSO
var += sprintf(&scratch[var], "+GSO");
#endif // HAVE_GSO
#endif // HAVE_SENDMMSG
#ifdef HAVE_RECVMMSG
var += sprintf(&scratch[var], " RecvMMsg()+Trunc");
#endif // HAVE_RECVMMSG
scratch[var++] = '\n';
var = write(outputfd, scratch, var);
} else {
//
// Add initial items to top-level object
//
if (!conf.jsonBrief) {
cJSON_AddNumberToObject(json_top, "IPLayerMaxConnections", MAX_MC_COUNT);
cJSON_AddNumberToObject(json_top, "IPLayerMaxIncrementalResult", MAX_TESTINT_TIME / MIN_SUBINT_PERIOD);
cJSON *json_supported = cJSON_CreateObject();
cJSON_AddStringToObject(json_supported, "SoftwareVersion", SOFTWARE_VER);
cJSON_AddNumberToObject(json_supported, "ControlProtocolVersion", PROTOCOL_VER);
cJSON_AddStringToObject(json_supported, "Metrics", "IPLR,Sampled_RTT,IPDV,IPRR,RIPR");
cJSON_AddItemToObject(json_top, "IPLayerCapSupported", json_supported);
}
}
//
// Allocate and initialize buffers
//
repo.sendingRates = calloc(1, MAX_SENDING_RATES * sizeof(struct sendingRate));
repo.sndBuffer = calloc(1, SND_BUFFER_SIZE);
repo.defBuffer = calloc(1, RCV_BUFFER_SIZE);
repo.randData = malloc(MAX_JPAYLOAD_SIZE);
repo.sndBufRand = malloc(SND_BUFFER_SIZE);
conn = malloc(conf.maxConnections * sizeof(struct connection));
if (repo.sendingRates == NULL || repo.sndBuffer == NULL || repo.defBuffer == NULL || repo.randData == NULL ||
repo.sndBufRand == NULL || conn == NULL) {
var = sprintf(scratch, "ERROR: Memory allocation(s) failed\n");
var = write(outputfd, scratch, var);
return STATUS_INIT_ERRBASE + ERROR_INIT_GENERIC;
}
for (i = 0; i < conf.maxConnections; i++)
init_conn(i, FALSE);
for (i = 0; i < (int) (MAX_JPAYLOAD_SIZE / sizeof(int)); i++)
((int *) repo.randData)[i] = random();
//
// Define sending rate table
//
if ((var = def_sending_rates()) > 0) {
var = write(outputfd, scratch, var);
return STATUS_INIT_ERRBASE + ERROR_INIT_GENERIC;
}
//
// Display resulting sending rate table if requested and exit
//
if (conf.showSendingRates) {
show_sending_rates(outputfd);
return STATUS_SUCCESS;
}
//
// Check for needed clock resolution
//
#ifndef DISABLE_INT_TIMER
if (clock_getres(CLOCK_REALTIME, &repo.systemClock) == -1) {
var = sprintf(scratch, "CLOCK_GETRES ERROR: %s\n", strerror(errno));
var = write(outputfd, scratch, var);
return STATUS_INIT_ERRBASE + ERROR_INIT_GENERIC;
}
if (repo.systemClock.tv_nsec > 1) {
var =
sprintf(scratch, "ERROR: Clock resolution (%ld ns) out of range [see compile-time option DISABLE_INT_TIMER]\n",
repo.systemClock.tv_nsec);
var = write(outputfd, scratch, var);
return STATUS_INIT_ERRBASE + ERROR_INIT_GENERIC;
}
clock_gettime(CLOCK_REALTIME, &repo.systemClock); // Reinitialize local copy of system time clock
#endif
//
// Set alarm signal handler
//
#ifndef DISABLE_INT_TIMER
saction.sa_handler = signal_alrm;
sigemptyset(&saction.sa_mask);
saction.sa_flags = SA_RESTART;
if (sigaction(SIGALRM, &saction, NULL) != 0) {
var = sprintf(scratch, "SIGALRM ERROR: %s\n", strerror(errno));
var = write(outputfd, scratch, var);
return STATUS_INIT_ERRBASE + ERROR_INIT_GENERIC;
}
#endif
//
// Create system interval timer used to drive all local timers
//
#ifndef DISABLE_INT_TIMER
itime.it_interval.tv_sec = itime.it_value.tv_sec = 0;
itime.it_interval.tv_usec = itime.it_value.tv_usec = MIN_INTERVAL_USEC;
if (setitimer(ITIMER_REAL, &itime, NULL) != 0) {
var = sprintf(scratch, "ITIMER ERROR: %s\n", strerror(errno));
var = write(outputfd, scratch, var);
return STATUS_INIT_ERRBASE + ERROR_INIT_GENERIC;
}
#endif
//
// Set exit signal handler
//
saction.sa_handler = signal_exit;
sigemptyset(&saction.sa_mask);
saction.sa_flags = 0;
pristatus = 0;
pristatus += sigaction(SIGTERM, &saction, NULL);
pristatus += sigaction(SIGINT, &saction, NULL);
pristatus += sigaction(SIGQUIT, &saction, NULL);
pristatus += sigaction(SIGTSTP, &saction, NULL);
if (pristatus != 0) {
var = sprintf(scratch, "ERROR: Unable to install exit signal handler\n");
var = write(outputfd, scratch, var);
return STATUS_INIT_ERRBASE + ERROR_INIT_GENERIC;
}
//
// Open epoll file descriptor to process I/O events
//
if ((repo.epollFD = epoll_create1(0)) < 0) {
var = sprintf(scratch, "ERROR: Unable to open epoll file descriptor\n");
var = write(outputfd, scratch, var);
return STATUS_INIT_ERRBASE + ERROR_INIT_GENERIC;
}
//
// Set standard FDs as non-blocking
//
pristatus = 0;
var = fcntl(STDIN_FILENO, F_GETFL, 0);
pristatus += fcntl(STDIN_FILENO, F_SETFL, var | O_NONBLOCK);
var = fcntl(STDOUT_FILENO, F_GETFL, 0);
pristatus += fcntl(STDOUT_FILENO, F_SETFL, var | O_NONBLOCK);
var = fcntl(STDERR_FILENO, F_GETFL, 0);
pristatus += fcntl(STDERR_FILENO, F_SETFL, var | O_NONBLOCK);
if (pristatus != 0) {
var = sprintf(scratch, "ERROR: Unable to modify standard I/O FDs\n");
var = write(outputfd, scratch, var);
appstatus = STATUS_INIT_ERRBASE + ERROR_INIT_GENERIC;
sig_exit = TRUE;
}
//
// Create default connection for console, log file or null output
//
if (!sig_exit) {
//
// Select FD and connection type
//
if (!conf.isDaemon) {
var = STDIN_FILENO;
var2 = T_CONSOLE;
} else {
if (conf.logFile != NULL) {
var = logfilefd;
var2 = T_LOG;
} else {
var = STDIN_FILENO;
var2 = T_NULL;
}
}
errConn = new_conn(var, NULL, 0, var2, &recv_proc, &null_action);
if (conf.verbose)
monConn = errConn;
if (!repo.isServer)
aggConn = errConn; // Use initial connection as aggregate connection
}
//
// Display key file info if needed
//
if (!sig_exit && conf.verbose && conf.keyFile != NULL) {
var = sprintf(scratch, "Authentication keys read from key file: %d\n", repo.keyCount);
send_proc(monConn, scratch, var);
if (conf.debug) {
for (i = 0; i < repo.keyCount; i++) {
var = sprintf(scratch, " %3d,%s\n", repo.key[i].id, repo.key[i].key);
send_proc(monConn, scratch, var);
}
}
}
//
// If specified, validate server IP addresses or resolve names into IP addresses
//
for (i = 0; i < repo.serverCount; i++) {
if ((var = sock_mgmt(-1, repo.server[i].name, 0, repo.server[i].ip, SMA_LOOKUP)) != 0) {
send_proc(errConn, scratch, var);
appstatus = STATUS_INIT_ERRBASE + ERROR_INIT_GENERIC;
if (!repo.isServer && conf.jsonOutput) {
tspeccpy(&conn[errConn].endTime, &repo.systemClock); // Schedule immediate exit
} else {
sig_exit = TRUE;
}
break;
}
}
//
// If server, create a connection for control port to process inbound setup requests,
// else create connections for client testing and send setup requests to server(s)
//
if (appstatus == STATUS_ERROR) { // If still set to default error status (i.e., no explicit errors so far)
if (repo.isServer) {
if ((i = new_conn(-1, repo.server[0].ip, repo.server[0].port, T_UDP, &recv_proc, &service_setupreq)) < 0) {
appstatus = STATUS_INIT_ERRBASE + ERROR_INIT_GENERIC;
sig_exit = TRUE;
} else if (conf.verbose) {
var =
sprintf(scratch, "[%d]Awaiting setup requests on %s:%d\n", i, conn[i].locAddr, conn[i].locPort);
send_proc(monConn, scratch, var);
}
} else {
var2 = 0; // Server index (distribute connections across servers)
for (j = 0; j < conf.maxConnCount; j++) {
if ((i = new_conn(-1, NULL, 0, T_UDP, &recv_proc, &service_setupresp)) < 0) {
appstatus = STATUS_INIT_ERRBASE + ERROR_INIT_GENERIC;
if (conf.jsonOutput) {
tspeccpy(&conn[errConn].endTime, &repo.systemClock); // Schedule immediate exit
} else {
sig_exit = TRUE;
}
break;
} else if (send_setupreq(i, j, var2) < 0) {
appstatus = STATUS_INIT_ERRBASE + ERROR_INIT_GENERIC;
if (conf.jsonOutput) {
tspeccpy(&conn[errConn].endTime, &repo.systemClock); // Schedule immediate exit
} else {
sig_exit = TRUE;
}
break;
}
if (++var2 >= repo.serverCount) // Step to next server and restart list when needed
var2 = 0;
}
}
}
//
// Primary control loop
//
while (!sig_exit) {
#ifdef DISABLE_INT_TIMER
sig_alrm = 1; // Simulate expiry of system interval timer
#endif
//
// Await ready FD(s) OR an alarm signal interrupt
//
var = -1;
if (sig_alrm > 0)
var = 0; // Return immediately if alarm was already received
readyfds = epoll_wait(repo.epollFD, epoll_events, MAX_EPOLL_EVENTS, var);
//
// Process FD(s)
//
if (readyfds > 0) {
fdpass = 0;
do {
//
// Do single read (up to RECVMMSG_SIZE) from each ready FD
//
var2 = 0; // Track if any data is read on this pass
for (j = 0; j < readyfds; j++) {
//
// Extract connection from user data
//
i = (int) epoll_events[j].data.u32;
if (i < 0 || i > repo.maxConnIndex) {
if (fdpass == 0) {
var = sprintf(scratch, "ERROR: Invalid epoll_wait user data %d\n", i);
send_proc(errConn, scratch, var);
}
continue;
} else if (conn[i].fd < 0) {
if (fdpass == 0) {
var = sprintf(scratch, "[%d]ERROR: Invalid fd (%d) from epoll_wait\n", i,
conn[i].fd);
send_proc(errConn, scratch, var);
}
continue;
}
//
// Set connection as data ready on first pass, else check if all data has been read
//
if (fdpass == 0) {
conn[i].dataReady = TRUE;
} else if (!conn[i].dataReady) {
continue; // Nothing to do for this connection
}
//
// Update local copy of system time clock
//
clock_gettime(CLOCK_REALTIME, &repo.systemClock);
//
// Execute primary and secondary actions
//
secstatus = 0;
pristatus = (conn[i].priAction)(i);
if (pristatus > 0) {
var2++; // Indicate data was read on this pass
secstatus = (conn[i].secAction)(i);
} else if (pristatus == 0) {
conn[i].dataReady = FALSE; // Indicate all data has been read from this connection
}
//
// Check for close/cleanup request
//
if ((pristatus < 0) || (secstatus < 0)) {
init_conn(i, TRUE);
}
if (sig_exit)
break;
}
fdpass++;
if (sig_exit)
break;
} while (var2 > 0 && sig_alrm == 0); // Do another pass if any data was read AND alarm hasn't fired
}
//
// Process timers
//
if (sig_alrm > 0) {
//
// Clear alarm signal counter
//
sig_alrm = 0;
//
// Update local copy of system time clock
//
clock_gettime(CLOCK_REALTIME, &repo.systemClock);
//
// Check each connection for timer expiry
//
for (i = 0; i <= repo.maxConnIndex; i++) {
//
// Check connection end time first
//
if (tspecisset(&conn[i].endTime)) {
if (tspeccmp(&repo.systemClock, &conn[i].endTime, >)) {
if (repo.isServer) {
if (conf.maxBandwidth > 0) {
// Adjust current upstream/downstream bandwidth
if (conn[i].testType == TEST_TYPE_US) {
if ((repo.usBandwidth -= conn[i].maxBandwidth) < 0)
repo.usBandwidth = 0;
} else {
if ((repo.dsBandwidth -= conn[i].maxBandwidth) < 0)
repo.dsBandwidth = 0;
}
if (conf.verbose) {
var = sprintf(scratch, ENDTEXT_NEWBW, i, repo.usBandwidth,
repo.dsBandwidth);
send_proc(monConn, scratch, var);
}
} else if (conf.verbose) {
var = sprintf(scratch, ENDTEXT_BASIC "\n", i);
send_proc(monConn, scratch, var);
}
if (conf.oneTest) { // Shutdown server after one test
appstatus = repo.endTimeStatus;
sig_exit = TRUE;
}
} else {
if (i == aggConn) {
if (conf.jsonOutput) {
appstatus = json_finish(); // Finalize JSON processing
} else {
appstatus = repo.endTimeStatus;
}
sig_exit = TRUE;
} else if (conn[i].testAction == TEST_ACT_TEST) {
// Decrement active test count if closed while active
if (--repo.actConnCount < 0)
repo.actConnCount = 0;
}
if (conf.verbose) {
var = sprintf(scratch, ENDTEXT_BASIC "\n", i);
send_proc(monConn, scratch, var);
}
}
init_conn(i, TRUE);
continue;
}
}
//
// Must be in data state to continue
//
if (conn[i].state != S_DATA)
continue;
//
// Process timer action routines using elapsed time
//
var2 = 0;
if (tspecisset(&conn[i].timer1Thresh)) {
if (tspeccmp(&repo.systemClock, &conn[i].timer1Thresh, >)) {
(conn[i].timer1Action)(i);
var2++;
}
}
if (tspecisset(&conn[i].timer2Thresh)) {
if (tspeccmp(&repo.systemClock, &conn[i].timer2Thresh, >)) {
(conn[i].timer2Action)(i);
var2++;
}
}
if (tspecisset(&conn[i].timer3Thresh)) {
if (tspeccmp(&repo.systemClock, &conn[i].timer3Thresh, >)) {
(conn[i].timer3Action)(i);
var2++;
}
}
if (var2 > 0) { // Update local copy of system time clock if work was done
clock_gettime(CLOCK_REALTIME, &repo.systemClock);
}
}
}
}
//
// Close files and epoll FD
//
if (logfilefd >= 0)
close(logfilefd);
if (repo.epollFD >= 0)
close(repo.epollFD);
if (repo.intfFD >= 0)
close(repo.intfFD);
//
// Cleanup and free memory
//
free(repo.sendingRates);
free(repo.sndBuffer);
free(repo.defBuffer);
free(repo.randData);
free(repo.sndBufRand);
free(conn);
//
// Stop system timer
//
timerclear(&itime.it_interval);
timerclear(&itime.it_value);
setitimer(ITIMER_REAL, &itime, NULL);
//
// Reset standard FDs to normal
//
var = fcntl(STDIN_FILENO, F_GETFL, 0);
fcntl(STDIN_FILENO, F_SETFL, var & ~O_NONBLOCK);
var = fcntl(STDOUT_FILENO, F_GETFL, 0);
fcntl(STDOUT_FILENO, F_SETFL, var & ~O_NONBLOCK);
var = fcntl(STDERR_FILENO, F_GETFL, 0);
fcntl(STDERR_FILENO, F_SETFL, var & ~O_NONBLOCK);
return appstatus;
}
//----------------------------------------------------------------------------
//
// Signal handlers
//
void signal_alrm(int signal) {
(void) (signal);
//
// Increment alarm signal indicator
//
sig_alrm++;
return;
}
void signal_exit(int signal) {
(void) (signal);
//
// Set exit signal indicator
//
sig_exit = TRUE;
return;
}
//----------------------------------------------------------------------------
//
// Process command-line parameters
//
int proc_parameters(int argc, char **argv, int fd) {
int i, j, var, value;
char *lbuf, *optstring = "ud46C:x1evsf:jTDXSO:B:ri:oRa:y:K:m:I:t:P:p:A:b:L:U:F:c:h:q:E:Ml:k:?";
//
// Clear configuration and global repository data
//
memset(&conf, 0, sizeof(conf));
memset(&repo, 0, sizeof(repo));
//
// Parse direction and port number parameters
//
value = opterr;
opterr = 0;
conf.controlPort = DEF_CONTROL_PORT;
while ((i = getopt(argc, argv, optstring)) != -1) {
switch (i) {
case 'u':
conf.usTesting = TRUE;
break;
case 'd':
conf.dsTesting = TRUE;
break;
case 'p':
value = atoi(optarg);
if ((var = param_error(value, MIN_CONTROL_PORT, MAX_CONTROL_PORT)) > 0) {
var = write(fd, scratch, var);
return ERROR_CONF_GENERIC;
}
conf.controlPort = value;
break;
}
}
//
// Save hostname/IP of servers or IP of local interface on server (allow port number suffix)
//
repo.server[0].name = NULL;
repo.server[0].ip[0] = '\0';
repo.server[0].port = conf.controlPort;
for (i = 0, j = optind; j < argc; i++, j++) {
if (repo.serverCount >= MAX_MC_COUNT) {
var = sprintf(scratch, "ERROR: Server count exceeds maximum (%d)\n", MAX_MC_COUNT);
var = write(fd, scratch, var);
return ERROR_CONF_GENERIC;
}
//
// Parse IP address/port as: <IPv4>, <IPv4>:<port>, <IPv6>, or [<IPv6>]:<port> (see RFC5952)
//
var = 0; // A value of one indicates IP address has port suffix (anything else means no port suffix)
if (*argv[j] == '[') {
argv[j]++; // Adjust base pointer past '['
if ((lbuf = strchr(argv[j], ']')) != NULL)
*lbuf++ = '\0'; // Remove trailing ']' and step to expected ':'
if (lbuf == NULL || *lbuf != ':') {
var = sprintf(scratch, "ERROR: Invalid format for IPv6 address with port number\n");
var = write(fd, scratch, var);
return ERROR_CONF_GENERIC;
}
var++;
} else if ((lbuf = strchr(argv[j], ':')) != NULL) {
var++;
if (strchr(lbuf + 1, ':') != NULL) // Check for second ':'
var++;
}
value = conf.controlPort;
if (var == 1) { // Port suffix present
if (*lbuf == ':') {
*lbuf++ = '\0'; // Remove ':' and step to port number
value = atoi(lbuf); // Convert to numeric
if ((var = param_error(value, MIN_CONTROL_PORT, MAX_CONTROL_PORT)) > 0) {
var = write(fd, scratch, var);
return ERROR_CONF_GENERIC;
}
}
}
repo.server[i].name = argv[j];
repo.server[i].port = value;
repo.serverCount++;
}
//
// Validate direction parameters and determine mode
//
if (conf.usTesting && conf.dsTesting) {
var = sprintf(scratch, "ERROR: %s and %s options are mutually exclusive\n", USTEST_TEXT, DSTEST_TEXT);
var = write(fd, scratch, var);
return ERROR_CONF_GENERIC;
} else if (!conf.usTesting && !conf.dsTesting) {
repo.isServer = TRUE;
if (repo.serverCount > 1) {
var = sprintf(scratch, "ERROR: Server only allows one local bind address or hostname\n");
var = write(fd, scratch, var);
return ERROR_CONF_GENERIC;
}
} else if (repo.serverCount == 0) {
var = sprintf(scratch, "ERROR: Server hostname or IP address required when client\n");
var = write(fd, scratch, var);
return ERROR_CONF_GENERIC;
}
//
// Continue to initialize non-zero configuration data
//
if (!repo.isServer) {
conf.maxConnections = MAX_CLIENT_CONN;
} else {
conf.maxConnections = MAX_SERVER_CONN;
}
conf.addrFamily = AF_UNSPEC;
conf.minConnCount = DEF_MC_COUNT;
conf.maxConnCount = DEF_MC_COUNT;
conf.errSuppress = TRUE;
conf.jumboStatus = DEF_JUMBO_STATUS;
conf.rateAdjAlgo = DEF_RA_ALGO;
conf.useOwDelVar = DEF_USE_OWDELVAR;
conf.ignoreOooDup = DEF_IGNORE_OOODUP;
if (!repo.isServer) {
// Default values
conf.ipTosByte = DEF_IPTOS_BYTE;
conf.srIndexConf = DEF_SRINDEX_CONF;
conf.testIntTime = DEF_TESTINT_TIME;
} else {
// Configured maximums
conf.ipTosByte = MAX_IPTOS_BYTE;
conf.srIndexConf = MAX_SRINDEX_CONF;
conf.testIntTime = MAX_TESTINT_TIME;
}
conf.subIntPeriod = DEF_SUBINT_PERIOD;
conf.sockSndBuf = DEF_SOCKET_BUF;
conf.sockRcvBuf = DEF_SOCKET_BUF;
conf.lowThresh = DEF_LOW_THRESH;
conf.upperThresh = DEF_UPPER_THRESH;
conf.trialInt = DEF_TRIAL_INT;
conf.slowAdjThresh = DEF_SLOW_ADJ_TH;
conf.highSpeedDelta = DEF_HS_DELTA;
conf.seqErrThresh = DEF_SEQ_ERR_TH;
conf.logFileMax = DEF_LOGFILE_MAX * 1000;
//
// Continue to initialize non-zero repository data
//
repo.epollFD = -1; // No file descriptor
repo.maxConnIndex = -1; // No connections allocated
repo.endTimeStatus = STATUS_ERROR; // Default to unspecified error, require explicit success
repo.intfFD = -1; // No file descriptor
repo.keyIndex = -1; // No key index (used when client)
//
// Parse remaining parameters
//
optind = 0;
opterr = value;
while ((i = getopt(argc, argv, optstring)) != -1) {
switch (i) {
case '4':
conf.addrFamily = AF_INET;
conf.ipv4Only = TRUE;
break;
case '6':
conf.addrFamily = AF_INET6;
conf.ipv6Only = TRUE;
break;
case 'C':
if (repo.isServer) {
var = sprintf(scratch, "ERROR: Multi-connection count only set by client\n");
var = write(fd, scratch, var);
return ERROR_CONF_GENERIC;
}
if ((lbuf = strchr(optarg, '-')) != NULL)
*lbuf = '\0';
value = atoi(optarg);
if ((var = param_error(value, MIN_MC_COUNT, MAX_MC_COUNT)) > 0) {
var = write(fd, scratch, var);
return ERROR_CONF_GENERIC;
}
conf.minConnCount = value;
if (lbuf != NULL) {
value = atoi(++lbuf);
if ((var = param_error(value, MIN_MC_COUNT, MAX_MC_COUNT)) > 0) {
var = write(fd, scratch, var);
return ERROR_CONF_GENERIC;
}
} else { // No max specified
if (value < repo.serverCount)
value = repo.serverCount;
}
if (value < repo.serverCount) {
var = sprintf(scratch, "ERROR: Maximum multi-connection count must be >= server count\n");
var = write(fd, scratch, var);
return ERROR_CONF_GENERIC;
}
conf.maxConnCount = value;
break;
case 'x':
if (!repo.isServer) {
var = sprintf(scratch, "ERROR: Execution as daemon only valid when server\n");
var = write(fd, scratch, var);
return ERROR_CONF_GENERIC;
}
conf.isDaemon = TRUE;
break;
case '1':
if (!repo.isServer) {
var = sprintf(scratch, "ERROR: One test execution only valid when server\n");
var = write(fd, scratch, var);