ba8d6e6246
retrieve (most of) the output emitted by the server. If the server was invoked with the --json flag, the output will be in JSON, otherwise it will be in the human-readable format. If the client was invoked with the --json flag, the output will be contained within the JSON output structure, otherwise it will be appended (in whatever format) to the bottom of the human-readable output. Because of the sequencing of the output generation and display, the server-side output includes only the starting output, interval statistics and summaries, but not the overall summaries. (The overall summaries were already displayed in the client's output.) Towards issue #160.
315 строки
13 KiB
C
315 строки
13 KiB
C
/*
|
|
* Copyright (c) 2009-2014, The Regents of the University of California,
|
|
* through Lawrence Berkeley National Laboratory (subject to receipt of any
|
|
* required approvals from the U.S. Dept. of Energy). All rights reserved.
|
|
*
|
|
* This code is distributed under a BSD style license, see the LICENSE file
|
|
* for complete information.
|
|
*/
|
|
|
|
#ifndef __IPERF_API_H
|
|
#define __IPERF_API_H
|
|
|
|
#include <setjmp.h>
|
|
|
|
struct iperf_test;
|
|
struct iperf_stream_result;
|
|
struct iperf_interval_results;
|
|
struct iperf_stream;
|
|
|
|
/* default settings */
|
|
#define Ptcp SOCK_STREAM
|
|
#define Pudp SOCK_DGRAM
|
|
#define Psctp 12
|
|
#define DEFAULT_UDP_BLKSIZE 8192
|
|
#define DEFAULT_TCP_BLKSIZE (128 * 1024) /* default read/write block size */
|
|
#define DEFAULT_SCTP_BLKSIZE (64 * 1024)
|
|
|
|
/* short option equivalents, used to support options that only have long form */
|
|
#define OPT_SCTP 1
|
|
#define OPT_LOGFILE 2
|
|
#define OPT_GET_SERVER_OUTPUT 3
|
|
|
|
/* states */
|
|
#define TEST_START 1
|
|
#define TEST_RUNNING 2
|
|
#define RESULT_REQUEST 3
|
|
#define TEST_END 4
|
|
#define STREAM_BEGIN 5
|
|
#define STREAM_RUNNING 6
|
|
#define STREAM_END 7
|
|
#define ALL_STREAMS_END 8
|
|
#define PARAM_EXCHANGE 9
|
|
#define CREATE_STREAMS 10
|
|
#define SERVER_TERMINATE 11
|
|
#define CLIENT_TERMINATE 12
|
|
#define EXCHANGE_RESULTS 13
|
|
#define DISPLAY_RESULTS 14
|
|
#define IPERF_START 15
|
|
#define IPERF_DONE 16
|
|
#define ACCESS_DENIED (-1)
|
|
#define SERVER_ERROR (-2)
|
|
|
|
/* Getter routines for some fields inside iperf_test. */
|
|
int iperf_get_verbose( struct iperf_test* ipt );
|
|
int iperf_get_control_socket( struct iperf_test* ipt );
|
|
int iperf_get_test_omit( struct iperf_test* ipt );
|
|
int iperf_get_test_duration( struct iperf_test* ipt );
|
|
char iperf_get_test_role( struct iperf_test* ipt );
|
|
int iperf_get_test_reverse( struct iperf_test* ipt );
|
|
int iperf_get_test_blksize( struct iperf_test* ipt );
|
|
FILE* iperf_get_test_outfile( struct iperf_test* ipt );
|
|
uint64_t iperf_get_test_rate( struct iperf_test* ipt );
|
|
int iperf_get_test_burst( struct iperf_test* ipt );
|
|
int iperf_get_test_socket_bufsize( struct iperf_test* ipt );
|
|
double iperf_get_test_reporter_interval( struct iperf_test* ipt );
|
|
double iperf_get_test_stats_interval( struct iperf_test* ipt );
|
|
int iperf_get_test_num_streams( struct iperf_test* ipt );
|
|
int iperf_get_test_server_port( struct iperf_test* ipt );
|
|
char* iperf_get_test_server_hostname( struct iperf_test* ipt );
|
|
int iperf_get_test_protocol_id( struct iperf_test* ipt );
|
|
int iperf_get_test_json_output( struct iperf_test* ipt );
|
|
char* iperf_get_test_json_output_string ( struct iperf_test* ipt );
|
|
int iperf_get_test_zerocopy( struct iperf_test* ipt );
|
|
int iperf_get_test_get_server_output( struct iperf_test* ipt );
|
|
|
|
/* Setter routines for some fields inside iperf_test. */
|
|
void iperf_set_verbose( struct iperf_test* ipt, int verbose );
|
|
void iperf_set_control_socket( struct iperf_test* ipt, int ctrl_sck );
|
|
void iperf_set_test_omit( struct iperf_test* ipt, int omit );
|
|
void iperf_set_test_duration( struct iperf_test* ipt, int duration );
|
|
void iperf_set_test_reporter_interval( struct iperf_test* ipt, double reporter_interval );
|
|
void iperf_set_test_stats_interval( struct iperf_test* ipt, double stats_interval );
|
|
void iperf_set_test_state( struct iperf_test* ipt, signed char state );
|
|
void iperf_set_test_blksize( struct iperf_test* ipt, int blksize );
|
|
void iperf_set_test_rate( struct iperf_test* ipt, uint64_t rate );
|
|
void iperf_set_test_burst( struct iperf_test* ipt, int burst );
|
|
void iperf_set_test_server_port( struct iperf_test* ipt, int server_port );
|
|
void iperf_set_test_socket_bufsize( struct iperf_test* ipt, int socket_bufsize );
|
|
void iperf_set_test_num_streams( struct iperf_test* ipt, int num_streams );
|
|
void iperf_set_test_role( struct iperf_test* ipt, char role );
|
|
void iperf_set_test_server_hostname( struct iperf_test* ipt, char* server_hostname );
|
|
void iperf_set_test_reverse( struct iperf_test* ipt, int reverse );
|
|
void iperf_set_test_json_output( struct iperf_test* ipt, int json_output );
|
|
int iperf_has_zerocopy( void );
|
|
void iperf_set_test_zerocopy( struct iperf_test* ipt, int zerocopy );
|
|
void iperf_set_test_get_server_output( struct iperf_test* ipt, int get_server_output );
|
|
|
|
/**
|
|
* exchange_parameters - handles the param_Exchange part for client
|
|
*
|
|
*/
|
|
int iperf_exchange_parameters(struct iperf_test * test);
|
|
|
|
/**
|
|
* add_to_interval_list -- adds new interval to the interval_list
|
|
*
|
|
*/
|
|
void add_to_interval_list(struct iperf_stream_result * rp, struct iperf_interval_results *temp);
|
|
|
|
/**
|
|
* connect_msg -- displays connection message
|
|
* denoting senfer/receiver details
|
|
*
|
|
*/
|
|
void connect_msg(struct iperf_stream * sp);
|
|
|
|
/**
|
|
* iperf_stats_callback -- handles the statistic gathering
|
|
*
|
|
*/
|
|
void iperf_stats_callback(struct iperf_test * test);
|
|
|
|
/**
|
|
* iperf_reporter_callback -- handles the report printing
|
|
*
|
|
*/
|
|
void iperf_reporter_callback(struct iperf_test * test);
|
|
|
|
/**
|
|
* iperf_new_test -- return a new iperf_test with default values
|
|
*
|
|
* returns NULL on failure
|
|
*
|
|
*/
|
|
struct iperf_test *iperf_new_test();
|
|
|
|
int iperf_defaults(struct iperf_test * testp);
|
|
|
|
/**
|
|
* iperf_free_test -- free resources used by test, calls iperf_free_stream to
|
|
* free streams
|
|
*
|
|
*/
|
|
void iperf_free_test(struct iperf_test * testp);
|
|
|
|
/**
|
|
* iperf_new_stream -- return a net iperf_stream with default values
|
|
*
|
|
* returns NULL on failure
|
|
*
|
|
*/
|
|
struct iperf_stream *iperf_new_stream(struct iperf_test *, int);
|
|
|
|
/**
|
|
* iperf_add_stream -- add a stream to a test
|
|
*
|
|
*/
|
|
void iperf_add_stream(struct iperf_test * test, struct iperf_stream * stream);
|
|
|
|
/**
|
|
* iperf_init_stream -- init resources associated with test
|
|
*
|
|
*/
|
|
int iperf_init_stream(struct iperf_stream *, struct iperf_test *);
|
|
|
|
/**
|
|
* iperf_free_stream -- free resources associated with test
|
|
*
|
|
*/
|
|
void iperf_free_stream(struct iperf_stream * sp);
|
|
|
|
int has_tcpinfo(void);
|
|
int has_tcpinfo_retransmits(void);
|
|
void save_tcpinfo(struct iperf_stream *sp, struct iperf_interval_results *irp);
|
|
long get_total_retransmits(struct iperf_interval_results *irp);
|
|
long get_snd_cwnd(struct iperf_interval_results *irp);
|
|
void print_tcpinfo(struct iperf_test *test);
|
|
void build_tcpinfo_message(struct iperf_interval_results *r, char *message);
|
|
|
|
int iperf_set_send_state(struct iperf_test *test, signed char state);
|
|
void iperf_check_throttle(struct iperf_stream *sp, struct timeval *nowP);
|
|
int iperf_send(struct iperf_test *, fd_set *) /* __attribute__((hot)) */;
|
|
int iperf_recv(struct iperf_test *, fd_set *);
|
|
void iperf_catch_sigend(void (*handler)(int));
|
|
void iperf_got_sigend(struct iperf_test *test) __attribute__ ((noreturn));
|
|
void usage();
|
|
void usage_long();
|
|
void warning(char *);
|
|
int iperf_exchange_results(struct iperf_test *);
|
|
int iperf_init_test(struct iperf_test *);
|
|
int iperf_create_send_timers(struct iperf_test *);
|
|
int iperf_parse_arguments(struct iperf_test *, int, char **);
|
|
void iperf_reset_test(struct iperf_test *);
|
|
void iperf_reset_stats(struct iperf_test * test);
|
|
|
|
struct protocol *get_protocol(struct iperf_test *, int);
|
|
int set_protocol(struct iperf_test *, int);
|
|
|
|
void iperf_on_new_stream(struct iperf_stream *);
|
|
void iperf_on_test_start(struct iperf_test *);
|
|
void iperf_on_connect(struct iperf_test *);
|
|
void iperf_on_test_finish(struct iperf_test *);
|
|
|
|
extern jmp_buf env;
|
|
|
|
/* Client routines. */
|
|
int iperf_run_client(struct iperf_test *);
|
|
int iperf_connect(struct iperf_test *);
|
|
int iperf_create_streams(struct iperf_test *);
|
|
int iperf_handle_message_client(struct iperf_test *);
|
|
int iperf_client_end(struct iperf_test *);
|
|
|
|
/* Server routines. */
|
|
int iperf_run_server(struct iperf_test *);
|
|
int iperf_server_listen(struct iperf_test *);
|
|
int iperf_accept(struct iperf_test *);
|
|
int iperf_handle_message_server(struct iperf_test *);
|
|
void iperf_test_reset(struct iperf_test *);
|
|
int iperf_create_pidfile(struct iperf_test *);
|
|
int iperf_delete_pidfile(struct iperf_test *);
|
|
|
|
/* JSON output routines. */
|
|
int iperf_json_start(struct iperf_test *);
|
|
int iperf_json_finish(struct iperf_test *);
|
|
|
|
/* CPU affinity routines */
|
|
int iperf_setaffinity(struct iperf_test *, int affinity);
|
|
int iperf_clearaffinity(struct iperf_test *);
|
|
|
|
/* Custom printf routine. */
|
|
int iprintf(struct iperf_test *test, const char *format, ...) __attribute__ ((format(printf,2,3)));
|
|
int iflush(struct iperf_test *test);
|
|
|
|
/* Error routines. */
|
|
void iperf_err(struct iperf_test *test, const char *format, ...) __attribute__ ((format(printf,2,3)));
|
|
void iperf_errexit(struct iperf_test *test, const char *format, ...) __attribute__ ((format(printf,2,3),noreturn));
|
|
char *iperf_strerror(int);
|
|
extern int i_errno;
|
|
enum {
|
|
IENONE = 0, // No error
|
|
/* Parameter errors */
|
|
IESERVCLIENT = 1, // Iperf cannot be both server and client
|
|
IENOROLE = 2, // Iperf must either be a client (-c) or server (-s)
|
|
IESERVERONLY = 3, // This option is server only
|
|
IECLIENTONLY = 4, // This option is client only
|
|
IEDURATION = 5, // test duration too long. Maximum value = %dMAX_TIME
|
|
IENUMSTREAMS = 6, // Number of parallel streams too large. Maximum value = %dMAX_STREAMS
|
|
IEBLOCKSIZE = 7, // Block size too large. Maximum value = %dMAX_BLOCKSIZE
|
|
IEBUFSIZE = 8, // Socket buffer size too large. Maximum value = %dMAX_TCP_BUFFER
|
|
IEINTERVAL = 9, // Invalid report interval (min = %gMIN_INTERVAL, max = %gMAX_INTERVAL seconds)
|
|
IEMSS = 10, // MSS too large. Maximum value = %dMAX_MSS
|
|
IENOSENDFILE = 11, // This OS does not support sendfile
|
|
IEOMIT = 12, // Bogus value for --omit
|
|
IEUNIMP = 13, // Not implemented yet
|
|
IEFILE = 14, // -F file couldn't be opened
|
|
IEBURST = 15, // Invalid burst count. Maximum value = %dMAX_BURST
|
|
IEENDCONDITIONS = 16, // Only one test end condition (-t, -n, -k) may be specified
|
|
IELOGFILE = 17, // Can't open log file
|
|
IENOSCTP = 18, // No SCTP support available
|
|
/* Test errors */
|
|
IENEWTEST = 100, // Unable to create a new test (check perror)
|
|
IEINITTEST = 101, // Test initialization failed (check perror)
|
|
IELISTEN = 102, // Unable to listen for connections (check perror)
|
|
IECONNECT = 103, // Unable to connect to server (check herror/perror) [from netdial]
|
|
IEACCEPT = 104, // Unable to accept connection from client (check herror/perror)
|
|
IESENDCOOKIE = 105, // Unable to send cookie to server (check perror)
|
|
IERECVCOOKIE = 106, // Unable to receive cookie from client (check perror)
|
|
IECTRLWRITE = 107, // Unable to write to the control socket (check perror)
|
|
IECTRLREAD = 108, // Unable to read from the control socket (check perror)
|
|
IECTRLCLOSE = 109, // Control socket has closed unexpectedly
|
|
IEMESSAGE = 110, // Received an unknown message
|
|
IESENDMESSAGE = 111, // Unable to send control message to client/server (check perror)
|
|
IERECVMESSAGE = 112, // Unable to receive control message from client/server (check perror)
|
|
IESENDPARAMS = 113, // Unable to send parameters to server (check perror)
|
|
IERECVPARAMS = 114, // Unable to receive parameters from client (check perror)
|
|
IEPACKAGERESULTS = 115, // Unable to package results (check perror)
|
|
IESENDRESULTS = 116, // Unable to send results to client/server (check perror)
|
|
IERECVRESULTS = 117, // Unable to receive results from client/server (check perror)
|
|
IESELECT = 118, // Select failed (check perror)
|
|
IECLIENTTERM = 119, // The client has terminated
|
|
IESERVERTERM = 120, // The server has terminated
|
|
IEACCESSDENIED = 121, // The server is busy running a test. Try again later.
|
|
IESETNODELAY = 122, // Unable to set TCP NODELAY (check perror)
|
|
IESETMSS = 123, // Unable to set TCP MSS (check perror)
|
|
IESETBUF = 124, // Unable to set socket buffer size (check perror)
|
|
IESETTOS = 125, // Unable to set IP TOS (check perror)
|
|
IESETCOS = 126, // Unable to set IPv6 traffic class (check perror)
|
|
IESETFLOW = 127, // Unable to set IPv6 flow label
|
|
IEREUSEADDR = 128, // Unable to set reuse address on socket (check perror)
|
|
IENONBLOCKING = 129, // Unable to set socket to non-blocking (check perror)
|
|
IESETWINDOWSIZE = 130, // Unable to set socket window size (check perror)
|
|
IEPROTOCOL = 131, // Protocol does not exist
|
|
IEAFFINITY = 132, // Unable to set CPU affinity (check perror)
|
|
IEDAEMON = 133, // Unable to become a daemon process
|
|
IESETCONGESTION = 134, // Unable to set TCP_CONGESTION
|
|
IEPIDFILE = 135, // Unable to write PID file
|
|
IEV6ONLY = 136, // Unable to set/unset IPV6_V6ONLY (check perror)
|
|
IESETSCTPDISABLEFRAG = 137, // Unable to set SCTP Fragmentation (check perror)
|
|
/* Stream errors */
|
|
IECREATESTREAM = 200, // Unable to create a new stream (check herror/perror)
|
|
IEINITSTREAM = 201, // Unable to initialize stream (check herror/perror)
|
|
IESTREAMLISTEN = 202, // Unable to start stream listener (check perror)
|
|
IESTREAMCONNECT = 203, // Unable to connect stream (check herror/perror)
|
|
IESTREAMACCEPT = 204, // Unable to accepte stream connection (check perror)
|
|
IESTREAMWRITE = 205, // Unable to write to stream socket (check perror)
|
|
IESTREAMREAD = 206, // Unable to read from stream (check perror)
|
|
IESTREAMCLOSE = 207, // Stream has closed unexpectedly
|
|
IESTREAMID = 208, // Stream has invalid ID
|
|
/* Timer errors */
|
|
IENEWTIMER = 300, // Unable to create new timer (check perror)
|
|
IEUPDATETIMER = 301, // Unable to update timer (check perror)
|
|
};
|
|
|
|
#endif /* !__IPERF_API_H */
|