zperf.h

Go to the documentation of this file.

/*
 * Copyright (c) 2016 Intel Corporation
 * Copyright (c) 2022 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: Apache-2.0
 */

 
#ifndef ZEPHYR_INCLUDE_NET_ZPERF_H_
#define ZEPHYR_INCLUDE_NET_ZPERF_H_
 
#include <zephyr/net/net_ip.h>
#include <zephyr/net/socket.h>
 
#ifdef __cplusplus
extern "C" {
#endif

 
enum zperf_status {
        ZPERF_SESSION_STARTED,
        ZPERF_SESSION_PERIODIC_RESULT,
        ZPERF_SESSION_FINISHED,
        ZPERF_SESSION_ERROR
} __packed;

typedef int (*zperf_data_load_custom)(void *user_ctx, uint64_t offset,
                                      uint8_t *data, uint32_t len);
 
struct zperf_upload_params {
        uint64_t unix_offset_us;
        zperf_data_load_custom data_loader;
        void *data_loader_ctx;
        union {
                struct net_sockaddr_storage peer_addr_storage;
                /* Use the peer_addr_storage instead of this one. */
                struct net_sockaddr peer_addr;
        };
        uint32_t duration_ms;
        uint32_t rate_kbps;
        uint16_t packet_size;
        char if_name[NET_IFNAMSIZ];
        struct {
                uint8_t tos;
                int tcp_nodelay;
                int priority;
#ifdef CONFIG_ZPERF_SESSION_PER_THREAD
                int thread_priority;
                bool wait_for_start;
#endif
                uint32_t report_interval_ms;
        } options;
};
 
struct zperf_download_params {
        uint16_t port;
        union {
                struct net_sockaddr_storage addr_storage;
                /* Use the addr_storage instead of this one. */
                struct net_sockaddr addr;
        };
        char if_name[NET_IFNAMSIZ];
};
 
#ifdef CONFIG_NET_ZPERF_RAW_TX
struct zperf_raw_upload_params {
        uint32_t duration_ms;         
        uint32_t rate_kbps;           
        uint16_t packet_size;         
        uint8_t *hdr;                 
        uint16_t hdr_len;             
        int if_index;                 
};
#endif /* CONFIG_NET_ZPERF_RAW_TX */


struct zperf_results {
        uint32_t nb_packets_sent;     
        uint32_t nb_packets_rcvd;     
        uint32_t nb_packets_lost;     
        uint32_t nb_packets_outorder; 
        uint64_t total_len;           
        uint64_t time_in_us;          
        uint32_t jitter_in_us;        
        uint64_t client_time_in_us;   
        uint32_t packet_size;         
        uint32_t nb_packets_errors;   
        bool is_multicast;            
};

typedef void (*zperf_callback)(enum zperf_status status,
                               struct zperf_results *result,
                               void *user_data);

int zperf_udp_upload(const struct zperf_upload_params *param,
                     struct zperf_results *result);

int zperf_tcp_upload(const struct zperf_upload_params *param,
                     struct zperf_results *result);

int zperf_udp_upload_async(const struct zperf_upload_params *param,
                           zperf_callback callback, void *user_data);

int zperf_tcp_upload_async(const struct zperf_upload_params *param,
                           zperf_callback callback, void *user_data);

int zperf_udp_download(const struct zperf_download_params *param,
                       zperf_callback callback, void *user_data);

int zperf_tcp_download(const struct zperf_download_params *param,
                       zperf_callback callback, void *user_data);

int zperf_udp_download_stop(void);

int zperf_tcp_download_stop(void);
 
#ifdef CONFIG_NET_ZPERF_RAW_TX
int zperf_raw_upload(const struct zperf_raw_upload_params *param,
                     struct zperf_results *result);

int zperf_raw_upload_async(const struct zperf_raw_upload_params *param,
                           zperf_callback callback, void *user_data);
#endif /* CONFIG_NET_ZPERF_RAW_TX */
 
#ifdef __cplusplus
}
#endif

 
#endif /* ZEPHYR_INCLUDE_NET_ZPERF_H_ */