xf_iperf.h

浏览该文件的文档.

 
/* Iperf Example - iperf declaration
 
   This example code is in the Public Domain (or CC0 licensed, at your option.)
 
   Unless required by applicable law or agreed to in writing, this
   software is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
   CONDITIONS OF ANY KIND, either express or implied.
*/
 
#ifndef __XF_IPERF_H__
#define __XF_IPERF_H__
 
/* ==================== [Includes] ========================================== */
 
#include "xf_utils.h"
#include "xf_osal.h"
#include "xf_netif.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ==================== [Defines] =========================================== */
 
#define IPERF_IP_TYPE_IPV4              0
#define IPERF_IP_TYPE_IPV6              1
#define IPERF_TRANS_TYPE_TCP            0
#define IPERF_TRANS_TYPE_UDP            1
 
#define IPERF_FLAG_SET(cfg, flag)       ((cfg) |= (flag))
#define IPERF_FLAG_CLR(cfg, flag)       ((cfg) &= (~(flag)))
 
#define IPERF_FLAG_CLIENT               (1)
#define IPERF_FLAG_SERVER               (1 << 1)
#define IPERF_FLAG_TCP                  (1 << 2)
#define IPERF_FLAG_UDP                  (1 << 3)
 
#define IPERF_DEFAULT_PORT              5001
#define IPERF_DEFAULT_INTERVAL          1
#define IPERF_DEFAULT_TIME              30
#define IPERF_DEFAULT_NO_BW_LIMIT       -1
 
#define IPERF_TRAFFIC_TASK_NAME         "iperf_traffic"
#define IPERF_TRAFFIC_TASK_PRIORITY     XF_OSAL_PRIORITY_NORMOL
#define IPERF_TRAFFIC_TASK_STACK        4096
#define IPERF_REPORT_TASK_NAME          "iperf_report"
#define IPERF_REPORT_TASK_PRIORITY      XF_OSAL_PRIORITY_NORMOL
#define IPERF_REPORT_TASK_STACK         4096
 
#define IPERF_DEFAULT_IPV4_UDP_TX_LEN   (1470)
#define IPERF_DEFAULT_IPV6_UDP_TX_LEN   (1450)
#define IPERF_DEFAULT_UDP_RX_LEN        (16 << 10)
#define IPERF_DEFAULT_TCP_TX_LEN        (16 << 10)
#define IPERF_DEFAULT_TCP_RX_LEN        (16 << 10)
 
#define IPERF_MAX_DELAY                 64
 
#define IPERF_SOCKET_RX_TIMEOUT_MS      3000
 
/* ==================== [Typedefs] ========================================== */
 
struct _xf_iperf_ctx_t;
 
typedef struct _xf_iperf_ctx_t *xf_iperf_t;
 
typedef enum _xf_iperf_event_code_t {
    XF_IPERF_EVENT_START = 0x00,        
    XF_IPERF_EVENT_REPORT,              
    XF_IPERF_EVENT_END,                 
    XF_IPERF_EVENT_MAX,                 
} xf_iperf_event_code_t;
 
typedef int32_t xf_iperf_event_id_t;
 
typedef void (*xf_iperf_cb_t)(
    xf_iperf_event_id_t event_id, xf_iperf_t hdl, void *user_args);
 
typedef struct _xf_iperf_cfg_t {
    uint32_t flag;                  
    xf_ip_addr_t dip;               
    xf_ip_addr_t sip;               
    uint8_t type;                   
    uint16_t dport;                 
    uint16_t sport;                 
    uint32_t interval;              
    uint32_t time;                  
    uint16_t len_send_buf;          
    int32_t bw_lim;                 
    uint32_t traffic_task_stack_size;   
    uint32_t traffic_task_prio;         
    bool report_enabled;                
    uint32_t report_task_stack_size;    
    uint32_t report_task_prio;          
} xf_iperf_cfg_t;
 
#define XF_IPERF_DEFAULT_CONFIG() (xf_iperf_cfg_t) { \
        .flag = 0, \
        .dip = {}, \
        .sip = {}, \
        .type = IPERF_IP_TYPE_IPV4, \
        .dport = IPERF_DEFAULT_PORT, \
        .sport = IPERF_DEFAULT_PORT, \
        .interval = IPERF_DEFAULT_INTERVAL, \
        .time = IPERF_DEFAULT_TIME, \
        .len_send_buf = 0, \
        .bw_lim = IPERF_DEFAULT_NO_BW_LIMIT, \
        .traffic_task_stack_size = IPERF_TRAFFIC_TASK_STACK, \
        .traffic_task_prio = IPERF_TRAFFIC_TASK_PRIORITY, \
        .report_enabled = true, \
        .report_task_stack_size = IPERF_REPORT_TASK_STACK, \
        .report_task_prio = IPERF_REPORT_TASK_PRIORITY, \
    }
 
typedef struct _xf_iperf_ctx_t {
    /* public: */
    /* 只读数据 */
    xf_iperf_cfg_t cfg;                 
    uint32_t curr_time;                 
    uint32_t actual_len;                
    float actual_bandwidth;             
    float average_bandwidth;            
    /* privte: */
    bool finish;                        
    uint32_t sockfd;                    
    uint8_t *buffer;                    
    uint32_t buffer_len;                
    uint32_t actual_len_internal;       
    xf_iperf_cb_t cb_func;              
    void *user_args;                    
    xf_osal_thread_t traffic_task_hdl;  
    bool traffic_is_running;            
    xf_osal_thread_t report_task_hdl;   
    bool report_is_running;             
} xf_iperf_ctx_t;
 
/* ==================== [Global Prototypes] ================================= */
 
xf_err_t xf_iperf_start(
    const xf_iperf_cfg_t *p_cfg, xf_iperf_cb_t cb_func, void *user_args);
 
xf_iperf_t xf_iperf_get_handle(void);
 
bool xf_iperf_is_running(void);
 
xf_err_t xf_iperf_stop(void);
 
/* ==================== [Macros] ============================================ */
 
#ifdef __cplusplus
} /* extern "C" */
#endif
 
#endif /* __XF_IPERF_H__ */