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