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