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