1 /* 2 * iperf, Copyright (c) 2014-2020, 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 TTD@lbl.gov. 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 #ifndef __IPERF_API_H 28 #define __IPERF_API_H 29 30 #include <sys/socket.h> 31 #include <sys/time.h> 32 #include <setjmp.h> 33 #include <stdio.h> 34 #ifdef HAVE_STDINT_H 35 #include <stdint.h> 36 #endif 37 #ifdef __cplusplus 38 extern "C" { /* open extern "C" */ 39 #endif 40 41 42 struct iperf_test; 43 struct iperf_stream_result; 44 struct iperf_interval_results; 45 struct iperf_stream; 46 struct iperf_time; 47 48 #if !defined(__IPERF_H) 49 typedef uint64_t iperf_size_t; 50 #endif // __IPERF_H 51 52 /* default settings */ 53 #define Ptcp SOCK_STREAM 54 #define Pudp SOCK_DGRAM 55 #define Psctp 12 56 #define DEFAULT_UDP_BLKSIZE 1460 /* default is dynamically set, else this */ 57 #define DEFAULT_TCP_BLKSIZE (128 * 1024) /* default read/write block size */ 58 #define DEFAULT_SCTP_BLKSIZE (64 * 1024) 59 #define DEFAULT_PACING_TIMER 1000 60 #define DEFAULT_NO_MSG_RCVD_TIMEOUT 120000 61 #define MIN_NO_MSG_RCVD_TIMEOUT 100 62 63 /* short option equivalents, used to support options that only have long form */ 64 #define OPT_SCTP 1 65 #define OPT_LOGFILE 2 66 #define OPT_GET_SERVER_OUTPUT 3 67 #define OPT_UDP_COUNTERS_64BIT 4 68 #define OPT_CLIENT_PORT 5 69 #define OPT_NUMSTREAMS 6 70 #define OPT_FORCEFLUSH 7 71 #define OPT_NO_FQ_SOCKET_PACING 9 /* UNUSED */ 72 #define OPT_FQ_RATE 10 73 #define OPT_DSCP 11 74 #define OPT_CLIENT_USERNAME 12 75 #define OPT_CLIENT_RSA_PUBLIC_KEY 13 76 #define OPT_SERVER_RSA_PRIVATE_KEY 14 77 #define OPT_SERVER_AUTHORIZED_USERS 15 78 #define OPT_PACING_TIMER 16 79 #define OPT_CONNECT_TIMEOUT 17 80 #define OPT_REPEATING_PAYLOAD 18 81 #define OPT_EXTRA_DATA 19 82 #define OPT_BIDIRECTIONAL 20 83 #define OPT_SERVER_BITRATE_LIMIT 21 84 #define OPT_TIMESTAMPS 22 85 #define OPT_SERVER_SKEW_THRESHOLD 23 86 #define OPT_BIND_DEV 24 87 #define OPT_IDLE_TIMEOUT 25 88 #define OPT_DONT_FRAGMENT 26 89 #define OPT_RCV_TIMEOUT 27 90 91 /* states */ 92 #define TEST_START 1 93 #define TEST_RUNNING 2 94 #define RESULT_REQUEST 3 /* not used */ 95 #define TEST_END 4 96 #define STREAM_BEGIN 5 /* not used */ 97 #define STREAM_RUNNING 6 /* not used */ 98 #define STREAM_END 7 /* not used */ 99 #define ALL_STREAMS_END 8 /* not used */ 100 #define PARAM_EXCHANGE 9 101 #define CREATE_STREAMS 10 102 #define SERVER_TERMINATE 11 103 #define CLIENT_TERMINATE 12 104 #define EXCHANGE_RESULTS 13 105 #define DISPLAY_RESULTS 14 106 #define IPERF_START 15 107 #define IPERF_DONE 16 108 #define ACCESS_DENIED (-1) 109 #define SERVER_ERROR (-2) 110 111 /* Getter routines for some fields inside iperf_test. */ 112 int iperf_get_verbose( struct iperf_test* ipt ); 113 int iperf_get_control_socket( struct iperf_test* ipt ); 114 int iperf_get_test_omit( struct iperf_test* ipt ); 115 int iperf_get_test_duration( struct iperf_test* ipt ); 116 char iperf_get_test_role( struct iperf_test* ipt ); 117 int iperf_get_test_reverse( struct iperf_test* ipt ); 118 int iperf_get_test_blksize( struct iperf_test* ipt ); 119 FILE* iperf_get_test_outfile( struct iperf_test* ipt ); 120 uint64_t iperf_get_test_rate( struct iperf_test* ipt ); 121 int iperf_get_test_pacing_timer( struct iperf_test* ipt ); 122 uint64_t iperf_get_test_bytes( struct iperf_test* ipt ); 123 uint64_t iperf_get_test_blocks( struct iperf_test* ipt ); 124 int iperf_get_test_burst( struct iperf_test* ipt ); 125 int iperf_get_test_socket_bufsize( struct iperf_test* ipt ); 126 double iperf_get_test_reporter_interval( struct iperf_test* ipt ); 127 double iperf_get_test_stats_interval( struct iperf_test* ipt ); 128 int iperf_get_test_num_streams( struct iperf_test* ipt ); 129 int iperf_get_test_repeating_payload( struct iperf_test* ipt ); 130 int iperf_get_test_timestamps( struct iperf_test* ipt ); 131 const char* iperf_get_test_timestamp_format( struct iperf_test* ipt ); 132 int iperf_get_test_server_port( struct iperf_test* ipt ); 133 char* iperf_get_test_server_hostname( struct iperf_test* ipt ); 134 char* iperf_get_test_template( struct iperf_test* ipt ); 135 int iperf_get_test_protocol_id( struct iperf_test* ipt ); 136 int iperf_get_test_json_output( struct iperf_test* ipt ); 137 char* iperf_get_test_json_output_string ( struct iperf_test* ipt ); 138 int iperf_get_test_zerocopy( struct iperf_test* ipt ); 139 int iperf_get_test_get_server_output( struct iperf_test* ipt ); 140 char* iperf_get_test_bind_address ( struct iperf_test* ipt ); 141 int iperf_get_test_udp_counters_64bit( struct iperf_test* ipt ); 142 int iperf_get_test_one_off( struct iperf_test* ipt ); 143 int iperf_get_test_tos( struct iperf_test* ipt ); 144 char* iperf_get_extra_data( struct iperf_test* ipt ); 145 char* iperf_get_iperf_version(void); 146 int iperf_get_test_no_delay( struct iperf_test* ipt ); 147 int iperf_get_test_connect_timeout( struct iperf_test* ipt ); 148 int iperf_get_dont_fragment( struct iperf_test* ipt ); 149 char* iperf_get_test_congestion_control(struct iperf_test* ipt); 150 151 /* Setter routines for some fields inside iperf_test. */ 152 void iperf_set_verbose( struct iperf_test* ipt, int verbose ); 153 void iperf_set_control_socket( struct iperf_test* ipt, int ctrl_sck ); 154 void iperf_set_test_omit( struct iperf_test* ipt, int omit ); 155 void iperf_set_test_duration( struct iperf_test* ipt, int duration ); 156 void iperf_set_test_reporter_interval( struct iperf_test* ipt, double reporter_interval ); 157 void iperf_set_test_stats_interval( struct iperf_test* ipt, double stats_interval ); 158 void iperf_set_test_state( struct iperf_test* ipt, signed char state ); 159 void iperf_set_test_blksize( struct iperf_test* ipt, int blksize ); 160 void iperf_set_test_logfile( struct iperf_test* ipt, const char *logfile ); 161 void iperf_set_test_rate( struct iperf_test* ipt, uint64_t rate ); 162 void iperf_set_test_pacing_timer( struct iperf_test* ipt, int pacing_timer ); 163 void iperf_set_test_bytes( struct iperf_test* ipt, uint64_t bytes ); 164 void iperf_set_test_blocks( struct iperf_test* ipt, uint64_t blocks ); 165 void iperf_set_test_burst( struct iperf_test* ipt, int burst ); 166 void iperf_set_test_server_port( struct iperf_test* ipt, int server_port ); 167 void iperf_set_test_socket_bufsize( struct iperf_test* ipt, int socket_bufsize ); 168 void iperf_set_test_num_streams( struct iperf_test* ipt, int num_streams ); 169 void iperf_set_test_repeating_payload( struct iperf_test* ipt, int repeating_payload ); 170 void iperf_set_test_timestamps( struct iperf_test* ipt, int timestamps ); 171 void iperf_set_test_timestamp_format( struct iperf_test*, const char *tf ); 172 void iperf_set_test_role( struct iperf_test* ipt, char role ); 173 void iperf_set_test_server_hostname( struct iperf_test* ipt, const char* server_hostname ); 174 void iperf_set_test_template( struct iperf_test *ipt, const char *tmp_template ); 175 void iperf_set_test_reverse( struct iperf_test* ipt, int reverse ); 176 void iperf_set_test_json_output( struct iperf_test* ipt, int json_output ); 177 int iperf_has_zerocopy( void ); 178 void iperf_set_test_zerocopy( struct iperf_test* ipt, int zerocopy ); 179 void iperf_set_test_get_server_output( struct iperf_test* ipt, int get_server_output ); 180 void iperf_set_test_bind_address( struct iperf_test* ipt, const char *bind_address ); 181 void iperf_set_test_udp_counters_64bit( struct iperf_test* ipt, int udp_counters_64bit ); 182 void iperf_set_test_one_off( struct iperf_test* ipt, int one_off ); 183 void iperf_set_test_tos( struct iperf_test* ipt, int tos ); 184 void iperf_set_test_extra_data( struct iperf_test* ipt, const char *dat ); 185 void iperf_set_test_bidirectional( struct iperf_test* ipt, int bidirectional); 186 void iperf_set_test_no_delay( struct iperf_test* ipt, int no_delay); 187 void iperf_set_dont_fragment( struct iperf_test* ipt, int dont_fragment ); 188 void iperf_set_test_congestion_control(struct iperf_test* ipt, char* cc); 189 190 #if defined(HAVE_SSL) 191 void iperf_set_test_client_username(struct iperf_test *ipt, const char *client_username); 192 void iperf_set_test_client_password(struct iperf_test *ipt, const char *client_password); 193 void iperf_set_test_client_rsa_pubkey(struct iperf_test *ipt, const char *client_rsa_pubkey_base64); 194 void iperf_set_test_server_authorized_users(struct iperf_test *ipt, const char *server_authorized_users); 195 void iperf_set_test_server_skew_threshold(struct iperf_test *ipt, int server_skew_threshold); 196 void iperf_set_test_server_rsa_privkey(struct iperf_test *ipt, const char *server_rsa_privkey_base64); 197 #endif // HAVE_SSL 198 199 void iperf_set_test_connect_timeout(struct iperf_test *ipt, int ct); 200 201 /** 202 * exchange_parameters - handles the param_Exchange part for client 203 * 204 */ 205 int iperf_exchange_parameters(struct iperf_test * test); 206 207 /** 208 * add_to_interval_list -- adds new interval to the interval_list 209 * 210 */ 211 void add_to_interval_list(struct iperf_stream_result * rp, struct iperf_interval_results *temp); 212 213 /** 214 * connect_msg -- displays connection message 215 * denoting senfer/receiver details 216 * 217 */ 218 void connect_msg(struct iperf_stream * sp); 219 220 /** 221 * iperf_stats_callback -- handles the statistic gathering 222 * 223 */ 224 void iperf_stats_callback(struct iperf_test * test); 225 226 /** 227 * iperf_reporter_callback -- handles the report printing 228 * 229 */ 230 void iperf_reporter_callback(struct iperf_test * test); 231 232 /** 233 * iperf_new_test -- return a new iperf_test with default values 234 * 235 * returns NULL on failure 236 * 237 */ 238 struct iperf_test *iperf_new_test(void); 239 240 int iperf_defaults(struct iperf_test * testp); 241 242 /** 243 * iperf_free_test -- free resources used by test, calls iperf_free_stream to 244 * free streams 245 * 246 */ 247 void iperf_free_test(struct iperf_test * testp); 248 249 /** 250 * iperf_new_stream -- return a net iperf_stream with default values 251 * 252 * returns NULL on failure 253 * 254 */ 255 struct iperf_stream *iperf_new_stream(struct iperf_test *, int, int); 256 257 /** 258 * iperf_add_stream -- add a stream to a test 259 * 260 */ 261 void iperf_add_stream(struct iperf_test * test, struct iperf_stream * stream); 262 263 /** 264 * iperf_init_stream -- init resources associated with test 265 * 266 */ 267 int iperf_init_stream(struct iperf_stream *, struct iperf_test *); 268 269 /** 270 * iperf_free_stream -- free resources associated with test 271 * 272 */ 273 void iperf_free_stream(struct iperf_stream * sp); 274 275 int has_tcpinfo(void); 276 int has_tcpinfo_retransmits(void); 277 void save_tcpinfo(struct iperf_stream *sp, struct iperf_interval_results *irp); 278 long get_total_retransmits(struct iperf_interval_results *irp); 279 long get_snd_cwnd(struct iperf_interval_results *irp); 280 long get_snd_wnd(struct iperf_interval_results *irp); 281 long get_rtt(struct iperf_interval_results *irp); 282 long get_rttvar(struct iperf_interval_results *irp); 283 long get_pmtu(struct iperf_interval_results *irp); 284 void print_tcpinfo(struct iperf_test *test); 285 void build_tcpinfo_message(struct iperf_interval_results *r, char *message); 286 287 int iperf_set_send_state(struct iperf_test *test, signed char state); 288 void iperf_check_throttle(struct iperf_stream *sp, struct iperf_time *nowP); 289 int iperf_send(struct iperf_test *, fd_set *) /* __attribute__((hot)) */; 290 int iperf_recv(struct iperf_test *, fd_set *); 291 void iperf_catch_sigend(void (*handler)(int)); 292 void iperf_got_sigend(struct iperf_test *test) __attribute__ ((noreturn)); 293 void usage(void); 294 void usage_long(FILE * f); 295 void warning(const char *); 296 int iperf_exchange_results(struct iperf_test *); 297 int iperf_init_test(struct iperf_test *); 298 int iperf_create_send_timers(struct iperf_test *); 299 int iperf_parse_arguments(struct iperf_test *, int, char **); 300 int iperf_open_logfile(struct iperf_test *); 301 void iperf_reset_test(struct iperf_test *); 302 void iperf_reset_stats(struct iperf_test * test); 303 304 struct protocol *get_protocol(struct iperf_test *, int); 305 int set_protocol(struct iperf_test *, int); 306 307 void iperf_on_new_stream(struct iperf_stream *); 308 void iperf_on_test_start(struct iperf_test *); 309 void iperf_on_connect(struct iperf_test *); 310 void iperf_on_test_finish(struct iperf_test *); 311 312 extern jmp_buf env; 313 314 /* Client routines. */ 315 int iperf_run_client(struct iperf_test *); 316 int iperf_connect(struct iperf_test *); 317 int iperf_create_streams(struct iperf_test *, int sender); 318 int iperf_handle_message_client(struct iperf_test *); 319 int iperf_client_end(struct iperf_test *); 320 321 /* Server routines. */ 322 int iperf_run_server(struct iperf_test *); 323 int iperf_server_listen(struct iperf_test *); 324 int iperf_accept(struct iperf_test *); 325 int iperf_handle_message_server(struct iperf_test *); 326 int iperf_create_pidfile(struct iperf_test *); 327 int iperf_delete_pidfile(struct iperf_test *); 328 void iperf_check_total_rate(struct iperf_test *, iperf_size_t); 329 330 /* JSON output routines. */ 331 int iperf_json_start(struct iperf_test *); 332 int iperf_json_finish(struct iperf_test *); 333 334 /* CPU affinity routines */ 335 int iperf_setaffinity(struct iperf_test *, int affinity); 336 int iperf_clearaffinity(struct iperf_test *); 337 338 /* Custom printf routine. */ 339 int iperf_printf(struct iperf_test *test, const char *format, ...) __attribute__ ((format(printf,2,3))); 340 int iflush(struct iperf_test *test); 341 342 /* Error routines. */ 343 void iperf_err(struct iperf_test *test, const char *format, ...) __attribute__ ((format(printf,2,3))); 344 void iperf_errexit(struct iperf_test *test, const char *format, ...) __attribute__ ((format(printf,2,3),noreturn)); 345 char *iperf_strerror(int); 346 extern int i_errno; 347 enum { 348 IENONE = 0, // No error 349 /* Parameter errors */ 350 IESERVCLIENT = 1, // Iperf cannot be both server and client 351 IENOROLE = 2, // Iperf must either be a client (-c) or server (-s) 352 IESERVERONLY = 3, // This option is server only 353 IECLIENTONLY = 4, // This option is client only 354 IEDURATION = 5, // test duration too long. Maximum value = %dMAX_TIME 355 IENUMSTREAMS = 6, // Number of parallel streams too large. Maximum value = %dMAX_STREAMS 356 IEBLOCKSIZE = 7, // Block size too large. Maximum value = %dMAX_BLOCKSIZE 357 IEBUFSIZE = 8, // Socket buffer size too large. Maximum value = %dMAX_TCP_BUFFER 358 IEINTERVAL = 9, // Invalid report interval (min = %gMIN_INTERVAL, max = %gMAX_INTERVAL seconds) 359 IEMSS = 10, // MSS too large. Maximum value = %dMAX_MSS 360 IENOSENDFILE = 11, // This OS does not support sendfile 361 IEOMIT = 12, // Bogus value for --omit 362 IEUNIMP = 13, // Not implemented yet 363 IEFILE = 14, // -F file couldn't be opened 364 IEBURST = 15, // Invalid burst count. Maximum value = %dMAX_BURST 365 IEENDCONDITIONS = 16, // Only one test end condition (-t, -n, -k) may be specified 366 IELOGFILE = 17, // Can't open log file 367 IENOSCTP = 18, // No SCTP support available 368 IEBIND = 19, // UNUSED: Local port specified with no local bind option 369 IEUDPBLOCKSIZE = 20, // Block size invalid 370 IEBADTOS = 21, // Bad TOS value 371 IESETCLIENTAUTH = 22, // Bad configuration of client authentication 372 IESETSERVERAUTH = 23, // Bad configuration of server authentication 373 IEBADFORMAT = 24, // Bad format argument to -f 374 IEREVERSEBIDIR = 25, // Iperf cannot be both reverse and bidirectional 375 IEBADPORT = 26, // Bad port number 376 IETOTALRATE = 27, // Total required bandwidth is larger than server's limit 377 IETOTALINTERVAL = 28, // Invalid time interval for calculating average data rate 378 IESKEWTHRESHOLD = 29, // Invalid value specified as skew threshold 379 IEIDLETIMEOUT = 30, // Invalid value specified as idle state timeout 380 IERCVTIMEOUT = 31, // Illegal message receive timeout 381 IERVRSONLYRCVTIMEOUT = 32, // Client receive timeout is valid only in reverse mode 382 /* Test errors */ 383 IENEWTEST = 100, // Unable to create a new test (check perror) 384 IEINITTEST = 101, // Test initialization failed (check perror) 385 IELISTEN = 102, // Unable to listen for connections (check perror) 386 IECONNECT = 103, // Unable to connect to server (check herror/perror) [from netdial] 387 IEACCEPT = 104, // Unable to accept connection from client (check herror/perror) 388 IESENDCOOKIE = 105, // Unable to send cookie to server (check perror) 389 IERECVCOOKIE = 106, // Unable to receive cookie from client (check perror) 390 IECTRLWRITE = 107, // Unable to write to the control socket (check perror) 391 IECTRLREAD = 108, // Unable to read from the control socket (check perror) 392 IECTRLCLOSE = 109, // Control socket has closed unexpectedly 393 IEMESSAGE = 110, // Received an unknown message 394 IESENDMESSAGE = 111, // Unable to send control message to client/server (check perror) 395 IERECVMESSAGE = 112, // Unable to receive control message from client/server (check perror) 396 IESENDPARAMS = 113, // Unable to send parameters to server (check perror) 397 IERECVPARAMS = 114, // Unable to receive parameters from client (check perror) 398 IEPACKAGERESULTS = 115, // Unable to package results (check perror) 399 IESENDRESULTS = 116, // Unable to send results to client/server (check perror) 400 IERECVRESULTS = 117, // Unable to receive results from client/server (check perror) 401 IESELECT = 118, // Select failed (check perror) 402 IECLIENTTERM = 119, // The client has terminated 403 IESERVERTERM = 120, // The server has terminated 404 IEACCESSDENIED = 121, // The server is busy running a test. Try again later. 405 IESETNODELAY = 122, // Unable to set TCP/SCTP NODELAY (check perror) 406 IESETMSS = 123, // Unable to set TCP/SCTP MSS (check perror) 407 IESETBUF = 124, // Unable to set socket buffer size (check perror) 408 IESETTOS = 125, // Unable to set IP TOS (check perror) 409 IESETCOS = 126, // Unable to set IPv6 traffic class (check perror) 410 IESETFLOW = 127, // Unable to set IPv6 flow label 411 IEREUSEADDR = 128, // Unable to set reuse address on socket (check perror) 412 IENONBLOCKING = 129, // Unable to set socket to non-blocking (check perror) 413 IESETWINDOWSIZE = 130, // Unable to set socket window size (check perror) 414 IEPROTOCOL = 131, // Protocol does not exist 415 IEAFFINITY = 132, // Unable to set CPU affinity (check perror) 416 IEDAEMON = 133, // Unable to become a daemon process 417 IESETCONGESTION = 134, // Unable to set TCP_CONGESTION 418 IEPIDFILE = 135, // Unable to write PID file 419 IEV6ONLY = 136, // Unable to set/unset IPV6_V6ONLY (check perror) 420 IESETSCTPDISABLEFRAG = 137, // Unable to set SCTP Fragmentation (check perror) 421 IESETSCTPNSTREAM= 138, // Unable to set SCTP number of streams (check perror) 422 IESETSCTPBINDX= 139, // Unable to process sctp_bindx() parameters 423 IESETPACING= 140, // Unable to set socket pacing rate 424 IESETBUF2= 141, // Socket buffer size incorrect (written value != read value) 425 IEAUTHTEST = 142, // Test authorization failed 426 IEBINDDEV = 143, // Unable to bind-to-device (check perror, maybe permissions?) 427 IENOMSG = 144, // No message was received for NO_MSG_RCVD_TIMEOUT time period 428 IESETDONTFRAGMENT = 145, // Unable to set IP Do-Not-Fragment 429 /* Stream errors */ 430 IECREATESTREAM = 200, // Unable to create a new stream (check herror/perror) 431 IEINITSTREAM = 201, // Unable to initialize stream (check herror/perror) 432 IESTREAMLISTEN = 202, // Unable to start stream listener (check perror) 433 IESTREAMCONNECT = 203, // Unable to connect stream (check herror/perror) 434 IESTREAMACCEPT = 204, // Unable to accepte stream connection (check perror) 435 IESTREAMWRITE = 205, // Unable to write to stream socket (check perror) 436 IESTREAMREAD = 206, // Unable to read from stream (check perror) 437 IESTREAMCLOSE = 207, // Stream has closed unexpectedly 438 IESTREAMID = 208, // Stream has invalid ID 439 /* Timer errors */ 440 IENEWTIMER = 300, // Unable to create new timer (check perror) 441 IEUPDATETIMER = 301, // Unable to update timer (check perror) 442 }; 443 444 445 #ifdef __cplusplus 446 } /* close extern "C" */ 447 #endif 448 449 450 #endif /* !__IPERF_API_H */ 451