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