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