Diff for /embedaddon/iperf/src/iperf_api.h between versions 1.1.1.2 and 1.1.1.3

version 1.1.1.2, 2021/03/17 00:36:46 version 1.1.1.3, 2023/09/27 11:14:54
Line 1 Line 1
 /*  /*
 * iperf, Copyright (c) 2014-2020, The Regents of the University of * iperf, Copyright (c) 2014-2022, The Regents of the University of
  * California, through Lawrence Berkeley National Laboratory (subject   * California, through Lawrence Berkeley National Laboratory (subject
  * to receipt of any required approvals from the U.S. Dept. of   * to receipt of any required approvals from the U.S. Dept. of
  * Energy).  All rights reserved.   * Energy).  All rights reserved.
Line 56  typedef uint64_t iperf_size_t; Line 56  typedef uint64_t iperf_size_t;
 #define DEFAULT_UDP_BLKSIZE 1460 /* default is dynamically set, else this */  #define DEFAULT_UDP_BLKSIZE 1460 /* default is dynamically set, else this */
 #define DEFAULT_TCP_BLKSIZE (128 * 1024)  /* default read/write block size */  #define DEFAULT_TCP_BLKSIZE (128 * 1024)  /* default read/write block size */
 #define DEFAULT_SCTP_BLKSIZE (64 * 1024)  #define DEFAULT_SCTP_BLKSIZE (64 * 1024)
   #define DEFAULT_PACING_TIMER 1000
   #define DEFAULT_NO_MSG_RCVD_TIMEOUT 120000
   #define MIN_NO_MSG_RCVD_TIMEOUT 100
   
   #define WARN_STR_LEN 128
   
 /* short option equivalents, used to support options that only have long form */  /* short option equivalents, used to support options that only have long form */
 #define OPT_SCTP 1  #define OPT_SCTP 1
 #define OPT_LOGFILE 2  #define OPT_LOGFILE 2
Line 79  typedef uint64_t iperf_size_t; Line 84  typedef uint64_t iperf_size_t;
 #define OPT_BIDIRECTIONAL 20  #define OPT_BIDIRECTIONAL 20
 #define OPT_SERVER_BITRATE_LIMIT 21  #define OPT_SERVER_BITRATE_LIMIT 21
 #define OPT_TIMESTAMPS 22  #define OPT_TIMESTAMPS 22
   #define OPT_SERVER_SKEW_THRESHOLD 23
   #define OPT_BIND_DEV 24
   #define OPT_IDLE_TIMEOUT 25
   #define OPT_DONT_FRAGMENT 26
   #define OPT_RCV_TIMEOUT 27
   #define OPT_SND_TIMEOUT 28
   
 /* states */  /* states */
 #define TEST_START 1  #define TEST_START 1
Line 107  int iperf_get_test_omit( struct iperf_test* ipt ); Line 118  int iperf_get_test_omit( struct iperf_test* ipt );
 int     iperf_get_test_duration( struct iperf_test* ipt );  int     iperf_get_test_duration( struct iperf_test* ipt );
 char    iperf_get_test_role( 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_reverse( struct iperf_test* ipt );
   int     iperf_get_test_bidirectional( struct iperf_test* ipt );
 int     iperf_get_test_blksize( struct iperf_test* ipt );  int     iperf_get_test_blksize( struct iperf_test* ipt );
 FILE*   iperf_get_test_outfile( struct iperf_test* ipt );  FILE*   iperf_get_test_outfile( struct iperf_test* ipt );
 uint64_t iperf_get_test_rate( struct iperf_test* ipt );  uint64_t iperf_get_test_rate( struct iperf_test* ipt );
Line 121  int iperf_get_test_num_streams( struct iperf_test* ipt Line 133  int iperf_get_test_num_streams( struct iperf_test* ipt
 int     iperf_get_test_repeating_payload( struct iperf_test* ipt );  int     iperf_get_test_repeating_payload( struct iperf_test* ipt );
 int     iperf_get_test_timestamps( struct iperf_test* ipt );  int     iperf_get_test_timestamps( struct iperf_test* ipt );
 const char* iperf_get_test_timestamp_format( struct iperf_test* ipt );  const char* iperf_get_test_timestamp_format( struct iperf_test* ipt );
   int     iperf_get_test_bind_port( struct iperf_test* ipt );
 int     iperf_get_test_server_port( struct iperf_test* ipt );  int     iperf_get_test_server_port( struct iperf_test* ipt );
 char*   iperf_get_test_server_hostname( struct iperf_test* ipt );  char*   iperf_get_test_server_hostname( struct iperf_test* ipt );
 char*   iperf_get_test_template( struct iperf_test* ipt );  char*   iperf_get_test_template( struct iperf_test* ipt );
Line 129  int iperf_get_test_json_output( struct iperf_test* ipt Line 142  int iperf_get_test_json_output( struct iperf_test* ipt
 char*   iperf_get_test_json_output_string ( 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_zerocopy( struct iperf_test* ipt );
 int     iperf_get_test_get_server_output( struct iperf_test* ipt );  int     iperf_get_test_get_server_output( struct iperf_test* ipt );
   char    iperf_get_test_unit_format(struct iperf_test *ipt);
 char*   iperf_get_test_bind_address ( struct iperf_test* ipt );  char*   iperf_get_test_bind_address ( struct iperf_test* ipt );
   char*   iperf_get_test_bind_dev(struct iperf_test *ipt);
 int     iperf_get_test_udp_counters_64bit( struct iperf_test* ipt );  int     iperf_get_test_udp_counters_64bit( struct iperf_test* ipt );
 int     iperf_get_test_one_off( struct iperf_test* ipt );  int     iperf_get_test_one_off( struct iperf_test* ipt );
 int iperf_get_test_tos( struct iperf_test* ipt );  int iperf_get_test_tos( struct iperf_test* ipt );
Line 137  char* iperf_get_extra_data( struct iperf_test* ipt ); Line 152  char* iperf_get_extra_data( struct iperf_test* ipt );
 char*   iperf_get_iperf_version(void);  char*   iperf_get_iperf_version(void);
 int     iperf_get_test_no_delay( struct iperf_test* ipt );  int     iperf_get_test_no_delay( struct iperf_test* ipt );
 int     iperf_get_test_connect_timeout( struct iperf_test* ipt );  int     iperf_get_test_connect_timeout( struct iperf_test* ipt );
   int     iperf_get_dont_fragment( struct iperf_test* ipt );
   char*   iperf_get_test_congestion_control(struct iperf_test* ipt);
   int iperf_get_test_mss(struct iperf_test* ipt);
   int     iperf_get_mapped_v4(struct iperf_test* ipt);
   
 /* Setter routines for some fields inside iperf_test. */  /* Setter routines for some fields inside iperf_test. */
 void    iperf_set_verbose( struct iperf_test* ipt, int verbose );  void    iperf_set_verbose( struct iperf_test* ipt, int verbose );
Line 153  void    iperf_set_test_pacing_timer( struct iperf_test Line 172  void    iperf_set_test_pacing_timer( struct iperf_test
 void    iperf_set_test_bytes( struct iperf_test* ipt, uint64_t bytes );  void    iperf_set_test_bytes( struct iperf_test* ipt, uint64_t bytes );
 void    iperf_set_test_blocks( struct iperf_test* ipt, uint64_t blocks );  void    iperf_set_test_blocks( struct iperf_test* ipt, uint64_t blocks );
 void    iperf_set_test_burst( struct iperf_test* ipt, int burst );  void    iperf_set_test_burst( struct iperf_test* ipt, int burst );
   void    iperf_set_test_bind_port( struct iperf_test* ipt, int bind_port );
 void    iperf_set_test_server_port( struct iperf_test* ipt, int server_port );  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_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_num_streams( struct iperf_test* ipt, int num_streams );
Line 167  void iperf_set_test_json_output( struct iperf_test* ip Line 187  void iperf_set_test_json_output( struct iperf_test* ip
 int     iperf_has_zerocopy( void );  int     iperf_has_zerocopy( void );
 void    iperf_set_test_zerocopy( struct iperf_test* ipt, int zerocopy );  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 );  void    iperf_set_test_get_server_output( struct iperf_test* ipt, int get_server_output );
   void    iperf_set_test_unit_format(struct iperf_test *ipt, char unit_format);
 void    iperf_set_test_bind_address( struct iperf_test* ipt, const char *bind_address );  void    iperf_set_test_bind_address( struct iperf_test* ipt, const char *bind_address );
   void    iperf_set_test_bind_dev(struct iperf_test *ipt, const char *bnd_dev);
 void    iperf_set_test_udp_counters_64bit( struct iperf_test* ipt, int udp_counters_64bit );  void    iperf_set_test_udp_counters_64bit( struct iperf_test* ipt, int udp_counters_64bit );
 void    iperf_set_test_one_off( struct iperf_test* ipt, int one_off );  void    iperf_set_test_one_off( struct iperf_test* ipt, int one_off );
 void    iperf_set_test_tos( struct iperf_test* ipt, int tos );  void    iperf_set_test_tos( struct iperf_test* ipt, int tos );
 void    iperf_set_test_extra_data( struct iperf_test* ipt, const char *dat );  void    iperf_set_test_extra_data( struct iperf_test* ipt, const char *dat );
 void    iperf_set_test_bidirectional( struct iperf_test* ipt, int bidirectional);  void    iperf_set_test_bidirectional( struct iperf_test* ipt, int bidirectional);
 void    iperf_set_test_no_delay( struct iperf_test* ipt, int no_delay);  void    iperf_set_test_no_delay( struct iperf_test* ipt, int no_delay);
   void    iperf_set_dont_fragment( struct iperf_test* ipt, int dont_fragment );
   void    iperf_set_test_congestion_control(struct iperf_test* ipt, char* cc);
   void    iperf_set_test_mss(struct iperf_test* ipt, int mss);
   void    iperf_set_mapped_v4(struct iperf_test* ipt, const int val);
   void    iperf_set_on_new_stream_callback(struct iperf_test* ipt, void (*callback)());
   void    iperf_set_on_test_start_callback(struct iperf_test* ipt, void (*callback)());
   void    iperf_set_on_test_connect_callback(struct iperf_test* ipt, void (*callback)());
   void    iperf_set_on_test_finish_callback(struct iperf_test* ipt, void (*callback)());
   
 #if defined(HAVE_SSL)  #if defined(HAVE_SSL)
 void    iperf_set_test_client_username(struct iperf_test *ipt, const char *client_username);  void    iperf_set_test_client_username(struct iperf_test *ipt, const char *client_username);
 void    iperf_set_test_client_password(struct iperf_test *ipt, const char *client_password);  void    iperf_set_test_client_password(struct iperf_test *ipt, const char *client_password);
 void    iperf_set_test_client_rsa_pubkey(struct iperf_test *ipt, const char *client_rsa_pubkey_base64);  void    iperf_set_test_client_rsa_pubkey(struct iperf_test *ipt, const char *client_rsa_pubkey_base64);
 void    iperf_set_test_server_authorized_users(struct iperf_test *ipt, const char *server_authorized_users);  void    iperf_set_test_server_authorized_users(struct iperf_test *ipt, const char *server_authorized_users);
   void    iperf_set_test_server_skew_threshold(struct iperf_test *ipt, int server_skew_threshold);
 void    iperf_set_test_server_rsa_privkey(struct iperf_test *ipt, const char *server_rsa_privkey_base64);  void    iperf_set_test_server_rsa_privkey(struct iperf_test *ipt, const char *server_rsa_privkey_base64);
 #endif // HAVE_SSL  #endif // HAVE_SSL
   
Line 259  int       iperf_init_stream(struct iperf_stream *, str Line 290  int       iperf_init_stream(struct iperf_stream *, str
  */   */
 void      iperf_free_stream(struct iperf_stream * sp);  void      iperf_free_stream(struct iperf_stream * sp);
   
   /**
    * iperf_common_sockopts -- init stream socket with common socket options
    *
    */
   int       iperf_common_sockopts(struct iperf_test *, int s);
   
 int has_tcpinfo(void);  int has_tcpinfo(void);
 int has_tcpinfo_retransmits(void);  int has_tcpinfo_retransmits(void);
 void save_tcpinfo(struct iperf_stream *sp, struct iperf_interval_results *irp);  void save_tcpinfo(struct iperf_stream *sp, struct iperf_interval_results *irp);
 long get_total_retransmits(struct iperf_interval_results *irp);  long get_total_retransmits(struct iperf_interval_results *irp);
 long get_snd_cwnd(struct iperf_interval_results *irp);  long get_snd_cwnd(struct iperf_interval_results *irp);
   long get_snd_wnd(struct iperf_interval_results *irp);
 long get_rtt(struct iperf_interval_results *irp);  long get_rtt(struct iperf_interval_results *irp);
 long get_rttvar(struct iperf_interval_results *irp);  long get_rttvar(struct iperf_interval_results *irp);
 long get_pmtu(struct iperf_interval_results *irp);  long get_pmtu(struct iperf_interval_results *irp);
Line 284  int iperf_init_test(struct iperf_test *); Line 322  int iperf_init_test(struct iperf_test *);
 int iperf_create_send_timers(struct iperf_test *);  int iperf_create_send_timers(struct iperf_test *);
 int iperf_parse_arguments(struct iperf_test *, int, char **);  int iperf_parse_arguments(struct iperf_test *, int, char **);
 int iperf_open_logfile(struct iperf_test *);  int iperf_open_logfile(struct iperf_test *);
   void iperf_close_logfile(struct iperf_test *);
 void iperf_reset_test(struct iperf_test *);  void iperf_reset_test(struct iperf_test *);
 void iperf_reset_stats(struct iperf_test * test);  void iperf_reset_stats(struct iperf_test * test);
   
Line 361  enum { Line 400  enum {
     IEBADPORT = 26,         // Bad port number      IEBADPORT = 26,         // Bad port number
     IETOTALRATE = 27,       // Total required bandwidth is larger than server's limit      IETOTALRATE = 27,       // Total required bandwidth is larger than server's limit
     IETOTALINTERVAL = 28,   // Invalid time interval for calculating average data rate      IETOTALINTERVAL = 28,   // Invalid time interval for calculating average data rate
       IESKEWTHRESHOLD = 29,   // Invalid value specified as skew threshold
       IEIDLETIMEOUT = 30,     // Invalid value specified as idle state timeout
       IERCVTIMEOUT = 31,      // Illegal message receive timeout
       IERVRSONLYRCVTIMEOUT = 32,  // Client receive timeout is valid only in reverse mode
       IESNDTIMEOUT = 33,      // Illegal message send timeout
       IEUDPFILETRANSFER = 34, // Cannot transfer file using UDP
     /* Test errors */      /* Test errors */
     IENEWTEST = 100,        // Unable to create a new test (check perror)      IENEWTEST = 100,        // Unable to create a new test (check perror)
     IEINITTEST = 101,       // Test initialization failed (check perror)      IEINITTEST = 101,       // Test initialization failed (check perror)
Line 405  enum { Line 450  enum {
     IESETPACING= 140,       // Unable to set socket pacing rate      IESETPACING= 140,       // Unable to set socket pacing rate
     IESETBUF2= 141,         // Socket buffer size incorrect (written value != read value)      IESETBUF2= 141,         // Socket buffer size incorrect (written value != read value)
     IEAUTHTEST = 142,       // Test authorization failed      IEAUTHTEST = 142,       // Test authorization failed
       IEBINDDEV = 143,        // Unable to bind-to-device (check perror, maybe permissions?)
       IENOMSG = 144,          // No message was received for NO_MSG_RCVD_TIMEOUT time period
       IESETDONTFRAGMENT = 145,   // Unable to set IP Do-Not-Fragment
       IEBINDDEVNOSUPPORT = 146,  // `ip%%dev` is not supported as system does not support bind to device
       IEHOSTDEV = 147,        // host device name (ip%%<dev>) is supported (and required) only for IPv6 link-local address
       IESETUSERTIMEOUT = 148, // Unable to set TCP USER_TIMEOUT (check perror)
     /* Stream errors */      /* Stream errors */
     IECREATESTREAM = 200,   // Unable to create a new stream (check herror/perror)      IECREATESTREAM = 200,   // Unable to create a new stream (check herror/perror)
     IEINITSTREAM = 201,     // Unable to initialize stream (check herror/perror)      IEINITSTREAM = 201,     // Unable to initialize stream (check herror/perror)
    IESTREAMLISTEN = 202,   // Unable to start stream listener (check perror)     IESTREAMLISTEN = 202,   // Unable to start stream listener (check perror)
     IESTREAMCONNECT = 203,  // Unable to connect stream (check herror/perror)      IESTREAMCONNECT = 203,  // Unable to connect stream (check herror/perror)
     IESTREAMACCEPT = 204,   // Unable to accepte stream connection (check perror)      IESTREAMACCEPT = 204,   // Unable to accepte stream connection (check perror)
     IESTREAMWRITE = 205,    // Unable to write to stream socket (check perror)      IESTREAMWRITE = 205,    // Unable to write to stream socket (check perror)

Removed from v.1.1.1.2  
changed lines
  Added in v.1.1.1.3


FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>