1 /* 2 * iperf, Copyright (c) 2014-2018 The Regents of the University of 3 * California, through Lawrence Berkeley National Laboratory (subject 4 * to receipt of any required approvals from the U.S. Dept. of 5 * Energy). All rights reserved. 6 * 7 * If you have questions about your rights to use or distribute this 8 * software, please contact Berkeley Lab's Technology Transfer 9 * Department at [email protected]. 10 * 11 * NOTICE. This software is owned by the U.S. Department of Energy. 12 * As such, the U.S. Government has been granted for itself and others 13 * acting on its behalf a paid-up, nonexclusive, irrevocable, 14 * worldwide license in the Software to reproduce, prepare derivative 15 * works, and perform publicly and display publicly. Beginning five 16 * (5) years after the date permission to assert copyright is obtained 17 * from the U.S. Department of Energy, and subject to any subsequent 18 * five (5) year renewals, the U.S. Government is granted for itself 19 * and others acting on its behalf a paid-up, nonexclusive, 20 * irrevocable, worldwide license in the Software to reproduce, 21 * prepare derivative works, distribute copies to the public, perform 22 * publicly and display publicly, and to permit others to do so. 23 * 24 * This code is distributed under a BSD style license, see the LICENSE 25 * file for complete information. 26 */ 27 /* iperf_server_api.c: Functions to be used by an iperf server 28 */ 29 30 #include <stdio.h> 31 #include <stdlib.h> 32 #include <string.h> 33 #include <getopt.h> 34 #include <errno.h> 35 #include <unistd.h> 36 #include <assert.h> 37 #include <fcntl.h> 38 #include <sys/socket.h> 39 #include <sys/types.h> 40 #include <netinet/in.h> 41 #include <arpa/inet.h> 42 #include <netdb.h> 43 #ifdef HAVE_STDINT_H 44 #include <stdint.h> 45 #endif 46 #include <sys/time.h> 47 #include <sys/resource.h> 48 #include <sched.h> 49 #include <setjmp.h> 50 51 #include "iperf.h" 52 #include "iperf_api.h" 53 #include "iperf_udp.h" 54 #include "iperf_tcp.h" 55 #include "iperf_util.h" 56 #include "timer.h" 57 #include "iperf_time.h" 58 #include "net.h" 59 #include "units.h" 60 #include "iperf_util.h" 61 #include "iperf_locale.h" 62 63 #if defined(HAVE_TCP_CONGESTION) 64 #if !defined(TCP_CA_NAME_MAX) 65 #define TCP_CA_NAME_MAX 16 66 #endif /* TCP_CA_NAME_MAX */ 67 #endif /* HAVE_TCP_CONGESTION */ 68 69 int 70 iperf_server_listen(struct iperf_test *test) 71 { 72 retry: 73 if((test->listener = netannounce(test->settings->domain, Ptcp, test->bind_address, test->server_port)) < 0) { 74 if (errno == EAFNOSUPPORT && (test->settings->domain == AF_INET6 || test->settings->domain == AF_UNSPEC)) { 75 /* If we get "Address family not supported by protocol", that 76 ** probably means we were compiled with IPv6 but the running 77 ** kernel does not actually do IPv6. This is not too unusual, 78 ** v6 support is and perhaps always will be spotty. 79 */ 80 warning("this system does not seem to support IPv6 - trying IPv4"); 81 test->settings->domain = AF_INET; 82 goto retry; 83 } else { 84 i_errno = IELISTEN; 85 return -1; 86 } 87 } 88 89 if (!test->json_output) { 90 iperf_printf(test, "-----------------------------------------------------------\n"); 91 iperf_printf(test, "Server listening on %d\n", test->server_port); 92 iperf_printf(test, "-----------------------------------------------------------\n"); 93 if (test->forceflush) 94 iflush(test); 95 } 96 97 FD_ZERO(&test->read_set); 98 FD_ZERO(&test->write_set); 99 FD_SET(test->listener, &test->read_set); 100 if (test->listener > test->max_fd) test->max_fd = test->listener; 101 102 return 0; 103 } 104 105 int 106 iperf_accept(struct iperf_test *test) 107 { 108 int s; 109 signed char rbuf = ACCESS_DENIED; 110 socklen_t len; 111 struct sockaddr_storage addr; 112 113 len = sizeof(addr); 114 if ((s = accept(test->listener, (struct sockaddr *) &addr, &len)) < 0) { 115 i_errno = IEACCEPT; 116 return -1; 117 } 118 119 if (test->ctrl_sck == -1) { 120 /* Server free, accept new client */ 121 test->ctrl_sck = s; 122 if (Nread(test->ctrl_sck, test->cookie, COOKIE_SIZE, Ptcp) < 0) { 123 i_errno = IERECVCOOKIE; 124 return -1; 125 } 126 FD_SET(test->ctrl_sck, &test->read_set); 127 if (test->ctrl_sck > test->max_fd) test->max_fd = test->ctrl_sck; 128 129 if (iperf_set_send_state(test, PARAM_EXCHANGE) != 0) 130 return -1; 131 if (iperf_exchange_parameters(test) < 0) 132 return -1; 133 if (test->server_affinity != -1) 134 if (iperf_setaffinity(test, test->server_affinity) != 0) 135 return -1; 136 if (test->on_connect) 137 test->on_connect(test); 138 } else { 139 /* 140 * Don't try to read from the socket. It could block an ongoing test. 141 * Just send ACCESS_DENIED. 142 */ 143 if (Nwrite(s, (char*) &rbuf, sizeof(rbuf), Ptcp) < 0) { 144 i_errno = IESENDMESSAGE; 145 return -1; 146 } 147 close(s); 148 } 149 150 return 0; 151 } 152 153 154 /**************************************************************************/ 155 int 156 iperf_handle_message_server(struct iperf_test *test) 157 { 158 int rval; 159 struct iperf_stream *sp; 160 161 // XXX: Need to rethink how this behaves to fit API 162 if ((rval = Nread(test->ctrl_sck, (char*) &test->state, sizeof(signed char), Ptcp)) <= 0) { 163 if (rval == 0) { 164 iperf_err(test, "the client has unexpectedly closed the connection"); 165 i_errno = IECTRLCLOSE; 166 test->state = IPERF_DONE; 167 return 0; 168 } else { 169 i_errno = IERECVMESSAGE; 170 return -1; 171 } 172 } 173 174 switch(test->state) { 175 case TEST_START: 176 break; 177 case TEST_END: 178 test->done = 1; 179 cpu_util(test->cpu_util); 180 test->stats_callback(test); 181 SLIST_FOREACH(sp, &test->streams, streams) { 182 FD_CLR(sp->socket, &test->read_set); 183 FD_CLR(sp->socket, &test->write_set); 184 close(sp->socket); 185 } 186 test->reporter_callback(test); 187 if (iperf_set_send_state(test, EXCHANGE_RESULTS) != 0) 188 return -1; 189 if (iperf_exchange_results(test) < 0) 190 return -1; 191 if (iperf_set_send_state(test, DISPLAY_RESULTS) != 0) 192 return -1; 193 if (test->on_test_finish) 194 test->on_test_finish(test); 195 break; 196 case IPERF_DONE: 197 break; 198 case CLIENT_TERMINATE: 199 i_errno = IECLIENTTERM; 200 201 // Temporarily be in DISPLAY_RESULTS phase so we can get 202 // ending summary statistics. 203 signed char oldstate = test->state; 204 cpu_util(test->cpu_util); 205 test->state = DISPLAY_RESULTS; 206 test->reporter_callback(test); 207 test->state = oldstate; 208 209 // XXX: Remove this line below! 210 iperf_err(test, "the client has terminated"); 211 SLIST_FOREACH(sp, &test->streams, streams) { 212 FD_CLR(sp->socket, &test->read_set); 213 FD_CLR(sp->socket, &test->write_set); 214 close(sp->socket); 215 } 216 test->state = IPERF_DONE; 217 break; 218 default: 219 i_errno = IEMESSAGE; 220 return -1; 221 } 222 223 return 0; 224 } 225 226 static void 227 server_timer_proc(TimerClientData client_data, struct iperf_time *nowP) 228 { 229 struct iperf_test *test = client_data.p; 230 struct iperf_stream *sp; 231 232 test->timer = NULL; 233 if (test->done) 234 return; 235 test->done = 1; 236 /* Free streams */ 237 while (!SLIST_EMPTY(&test->streams)) { 238 sp = SLIST_FIRST(&test->streams); 239 SLIST_REMOVE_HEAD(&test->streams, streams); 240 close(sp->socket); 241 iperf_free_stream(sp); 242 } 243 close(test->ctrl_sck); 244 } 245 246 static void 247 server_stats_timer_proc(TimerClientData client_data, struct iperf_time *nowP) 248 { 249 struct iperf_test *test = client_data.p; 250 251 if (test->done) 252 return; 253 if (test->stats_callback) 254 test->stats_callback(test); 255 } 256 257 static void 258 server_reporter_timer_proc(TimerClientData client_data, struct iperf_time *nowP) 259 { 260 struct iperf_test *test = client_data.p; 261 262 if (test->done) 263 return; 264 if (test->reporter_callback) 265 test->reporter_callback(test); 266 } 267 268 static int 269 create_server_timers(struct iperf_test * test) 270 { 271 struct iperf_time now; 272 TimerClientData cd; 273 274 if (iperf_time_now(&now) < 0) { 275 i_errno = IEINITTEST; 276 return -1; 277 } 278 cd.p = test; 279 test->timer = test->stats_timer = test->reporter_timer = NULL; 280 if (test->duration != 0 ) { 281 test->done = 0; 282 test->timer = tmr_create(&now, server_timer_proc, cd, (test->duration + test->omit + 5) * SEC_TO_US, 0); 283 if (test->timer == NULL) { 284 i_errno = IEINITTEST; 285 return -1; 286 } 287 } 288 289 test->stats_timer = test->reporter_timer = NULL; 290 if (test->stats_interval != 0) { 291 test->stats_timer = tmr_create(&now, server_stats_timer_proc, cd, test->stats_interval * SEC_TO_US, 1); 292 if (test->stats_timer == NULL) { 293 i_errno = IEINITTEST; 294 return -1; 295 } 296 } 297 if (test->reporter_interval != 0) { 298 test->reporter_timer = tmr_create(&now, server_reporter_timer_proc, cd, test->reporter_interval * SEC_TO_US, 1); 299 if (test->reporter_timer == NULL) { 300 i_errno = IEINITTEST; 301 return -1; 302 } 303 } 304 return 0; 305 } 306 307 static void 308 server_omit_timer_proc(TimerClientData client_data, struct iperf_time *nowP) 309 { 310 struct iperf_test *test = client_data.p; 311 312 test->omit_timer = NULL; 313 test->omitting = 0; 314 iperf_reset_stats(test); 315 if (test->verbose && !test->json_output && test->reporter_interval == 0) 316 iperf_printf(test, "%s", report_omit_done); 317 318 /* Reset the timers. */ 319 if (test->stats_timer != NULL) 320 tmr_reset(nowP, test->stats_timer); 321 if (test->reporter_timer != NULL) 322 tmr_reset(nowP, test->reporter_timer); 323 } 324 325 static int 326 create_server_omit_timer(struct iperf_test * test) 327 { 328 struct iperf_time now; 329 TimerClientData cd; 330 331 if (test->omit == 0) { 332 test->omit_timer = NULL; 333 test->omitting = 0; 334 } else { 335 if (iperf_time_now(&now) < 0) { 336 i_errno = IEINITTEST; 337 return -1; 338 } 339 test->omitting = 1; 340 cd.p = test; 341 test->omit_timer = tmr_create(&now, server_omit_timer_proc, cd, test->omit * SEC_TO_US, 0); 342 if (test->omit_timer == NULL) { 343 i_errno = IEINITTEST; 344 return -1; 345 } 346 } 347 348 return 0; 349 } 350 351 static void 352 cleanup_server(struct iperf_test *test) 353 { 354 /* Close open test sockets */ 355 if (test->ctrl_sck) { 356 close(test->ctrl_sck); 357 } 358 if (test->listener) { 359 close(test->listener); 360 } 361 362 /* Cancel any remaining timers. */ 363 if (test->stats_timer != NULL) { 364 tmr_cancel(test->stats_timer); 365 test->stats_timer = NULL; 366 } 367 if (test->reporter_timer != NULL) { 368 tmr_cancel(test->reporter_timer); 369 test->reporter_timer = NULL; 370 } 371 if (test->omit_timer != NULL) { 372 tmr_cancel(test->omit_timer); 373 test->omit_timer = NULL; 374 } 375 if (test->congestion_used != NULL) { 376 free(test->congestion_used); 377 test->congestion_used = NULL; 378 } 379 if (test->timer != NULL) { 380 tmr_cancel(test->timer); 381 test->timer = NULL; 382 } 383 } 384 385 386 int 387 iperf_run_server(struct iperf_test *test) 388 { 389 int result, s; 390 int send_streams_accepted, rec_streams_accepted; 391 int streams_to_send = 0, streams_to_rec = 0; 392 #if defined(HAVE_TCP_CONGESTION) 393 int saved_errno; 394 #endif /* HAVE_TCP_CONGESTION */ 395 fd_set read_set, write_set; 396 struct iperf_stream *sp; 397 struct iperf_time now; 398 struct timeval* timeout; 399 int flag; 400 401 if (test->logfile) 402 if (iperf_open_logfile(test) < 0) 403 return -1; 404 405 if (test->affinity != -1) 406 if (iperf_setaffinity(test, test->affinity) != 0) 407 return -2; 408 409 if (test->json_output) 410 if (iperf_json_start(test) < 0) 411 return -2; 412 413 if (test->json_output) { 414 cJSON_AddItemToObject(test->json_start, "version", cJSON_CreateString(version)); 415 cJSON_AddItemToObject(test->json_start, "system_info", cJSON_CreateString(get_system_info())); 416 } else if (test->verbose) { 417 iperf_printf(test, "%s\n", version); 418 iperf_printf(test, "%s", ""); 419 iperf_printf(test, "%s\n", get_system_info()); 420 iflush(test); 421 } 422 423 // Open socket and listen 424 if (iperf_server_listen(test) < 0) { 425 return -2; 426 } 427 428 // Begin calculating CPU utilization 429 cpu_util(NULL); 430 431 test->state = IPERF_START; 432 send_streams_accepted = 0; 433 rec_streams_accepted = 0; 434 435 while (test->state != IPERF_DONE) { 436 437 memcpy(&read_set, &test->read_set, sizeof(fd_set)); 438 memcpy(&write_set, &test->write_set, sizeof(fd_set)); 439 440 iperf_time_now(&now); 441 timeout = tmr_timeout(&now); 442 result = select(test->max_fd + 1, &read_set, &write_set, NULL, timeout); 443 if (result < 0 && errno != EINTR) { 444 cleanup_server(test); 445 i_errno = IESELECT; 446 return -1; 447 } 448 if (result > 0) { 449 if (FD_ISSET(test->listener, &read_set)) { 450 if (test->state != CREATE_STREAMS) { 451 if (iperf_accept(test) < 0) { 452 cleanup_server(test); 453 return -1; 454 } 455 FD_CLR(test->listener, &read_set); 456 457 // Set streams number 458 if (test->mode == BIDIRECTIONAL) { 459 streams_to_send = test->num_streams; 460 streams_to_rec = test->num_streams; 461 } else if (test->mode == RECEIVER) { 462 streams_to_rec = test->num_streams; 463 streams_to_send = 0; 464 } else { 465 streams_to_send = test->num_streams; 466 streams_to_rec = 0; 467 } 468 } 469 } 470 if (FD_ISSET(test->ctrl_sck, &read_set)) { 471 if (iperf_handle_message_server(test) < 0) { 472 cleanup_server(test); 473 return -1; 474 } 475 FD_CLR(test->ctrl_sck, &read_set); 476 } 477 478 if (test->state == CREATE_STREAMS) { 479 if (FD_ISSET(test->prot_listener, &read_set)) { 480 481 if ((s = test->protocol->accept(test)) < 0) { 482 cleanup_server(test); 483 return -1; 484 } 485 486 #if defined(HAVE_TCP_CONGESTION) 487 if (test->protocol->id == Ptcp) { 488 if (test->congestion) { 489 if (setsockopt(s, IPPROTO_TCP, TCP_CONGESTION, test->congestion, strlen(test->congestion)) < 0) { 490 /* 491 * ENOENT means we tried to set the 492 * congestion algorithm but the algorithm 493 * specified doesn't exist. This can happen 494 * if the client and server have different 495 * congestion algorithms available. In this 496 * case, print a warning, but otherwise 497 * continue. 498 */ 499 if (errno == ENOENT) { 500 warning("TCP congestion control algorithm not supported"); 501 } 502 else { 503 saved_errno = errno; 504 close(s); 505 cleanup_server(test); 506 errno = saved_errno; 507 i_errno = IESETCONGESTION; 508 return -1; 509 } 510 } 511 } 512 { 513 socklen_t len = TCP_CA_NAME_MAX; 514 char ca[TCP_CA_NAME_MAX + 1]; 515 if (getsockopt(s, IPPROTO_TCP, TCP_CONGESTION, ca, &len) < 0) { 516 saved_errno = errno; 517 close(s); 518 cleanup_server(test); 519 errno = saved_errno; 520 i_errno = IESETCONGESTION; 521 return -1; 522 } 523 test->congestion_used = strdup(ca); 524 if (test->debug) { 525 printf("Congestion algorithm is %s\n", test->congestion_used); 526 } 527 } 528 } 529 #endif /* HAVE_TCP_CONGESTION */ 530 531 if (!is_closed(s)) { 532 533 if (rec_streams_accepted != streams_to_rec) { 534 flag = 0; 535 ++rec_streams_accepted; 536 } else if (send_streams_accepted != streams_to_send) { 537 flag = 1; 538 ++send_streams_accepted; 539 } 540 541 if (flag != -1) { 542 sp = iperf_new_stream(test, s, flag); 543 if (!sp) { 544 cleanup_server(test); 545 return -1; 546 } 547 548 if (sp->sender) 549 FD_SET(s, &test->write_set); 550 else 551 FD_SET(s, &test->read_set); 552 553 if (s > test->max_fd) test->max_fd = s; 554 555 /* 556 * If the protocol isn't UDP, or even if it is but 557 * we're the receiver, set nonblocking sockets. 558 * We need this to allow a server receiver to 559 * maintain interactivity with the control channel. 560 */ 561 if (test->protocol->id != Pudp || 562 !sp->sender) { 563 setnonblocking(s, 1); 564 } 565 566 if (test->on_new_stream) 567 test->on_new_stream(sp); 568 569 flag = -1; 570 } 571 } 572 FD_CLR(test->prot_listener, &read_set); 573 } 574 575 576 if (rec_streams_accepted == streams_to_rec && send_streams_accepted == streams_to_send) { 577 if (test->protocol->id != Ptcp) { 578 FD_CLR(test->prot_listener, &test->read_set); 579 close(test->prot_listener); 580 } else { 581 if (test->no_delay || test->settings->mss || test->settings->socket_bufsize) { 582 FD_CLR(test->listener, &test->read_set); 583 close(test->listener); 584 test->listener = 0; 585 if ((s = netannounce(test->settings->domain, Ptcp, test->bind_address, test->server_port)) < 0) { 586 cleanup_server(test); 587 i_errno = IELISTEN; 588 return -1; 589 } 590 test->listener = s; 591 FD_SET(test->listener, &test->read_set); 592 if (test->listener > test->max_fd) test->max_fd = test->listener; 593 } 594 } 595 test->prot_listener = -1; 596 if (iperf_set_send_state(test, TEST_START) != 0) { 597 cleanup_server(test); 598 return -1; 599 } 600 if (iperf_init_test(test) < 0) { 601 cleanup_server(test); 602 return -1; 603 } 604 if (create_server_timers(test) < 0) { 605 cleanup_server(test); 606 return -1; 607 } 608 if (create_server_omit_timer(test) < 0) { 609 cleanup_server(test); 610 return -1; 611 } 612 if (test->mode != RECEIVER) 613 if (iperf_create_send_timers(test) < 0) { 614 cleanup_server(test); 615 return -1; 616 } 617 if (iperf_set_send_state(test, TEST_RUNNING) != 0) { 618 cleanup_server(test); 619 return -1; 620 } 621 } 622 } 623 624 if (test->state == TEST_RUNNING) { 625 if (test->mode == BIDIRECTIONAL) { 626 if (iperf_recv(test, &read_set) < 0) { 627 cleanup_server(test); 628 return -1; 629 } 630 if (iperf_send(test, &write_set) < 0) { 631 cleanup_server(test); 632 return -1; 633 } 634 } else if (test->mode == SENDER) { 635 // Reverse mode. Server sends. 636 if (iperf_send(test, &write_set) < 0) { 637 cleanup_server(test); 638 return -1; 639 } 640 } else { 641 // Regular mode. Server receives. 642 if (iperf_recv(test, &read_set) < 0) { 643 cleanup_server(test); 644 return -1; 645 } 646 } 647 } 648 } 649 650 if (result == 0 || 651 (timeout != NULL && timeout->tv_sec == 0 && timeout->tv_usec == 0)) { 652 /* Run the timers. */ 653 iperf_time_now(&now); 654 tmr_run(&now); 655 } 656 } 657 658 cleanup_server(test); 659 660 if (test->json_output) { 661 if (iperf_json_finish(test) < 0) 662 return -1; 663 } 664 665 iflush(test); 666 667 if (test->server_affinity != -1) 668 if (iperf_clearaffinity(test) != 0) 669 return -1; 670 671 return 0; 672 } 673