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