mmiperf.h

/*
 * Copyright 2021-2024 Morse Micro
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#pragma once
 
#include <stdbool.h>
#include <stdint.h>
 
#ifdef __cplusplus
extern "C"
{
#endif
 
#define BLOCK_DURATION_MS 200
 
#define IPV6_HEADER_SIZE_DIFF (20)
 
#define MMIPERF_DEFAULT_PORT (5001)
#define MMIPERF_DEFAULT_UDP_PACKET_SIZE_V4 (1460)
#define MMIPERF_DEFAULT_UDP_PACKET_SIZE_V6 (1440)
#define MMIPERF_DEFAULT_AMOUNT (-1000)
#define MMIPERF_DEFAULT_BANDWIDTH (0)
 
#define MMIPERF_IPADDR_MAXLEN (48)
 
#ifndef MMIPERF_STACK_SIZE
#define MMIPERF_STACK_SIZE 512
#endif
 
enum mmiperf_report_type
{
    MMIPERF_TCP_DONE_SERVER,
    MMIPERF_TCP_DONE_CLIENT,
    MMIPERF_TCP_ABORTED_LOCAL,
    MMIPERF_TCP_ABORTED_LOCAL_DATAERROR,
    MMIPERF_TCP_ABORTED_LOCAL_TXERROR,
    MMIPERF_TCP_ABORTED_REMOTE,
    MMIPERF_UDP_DONE_SERVER,
    MMIPERF_UDP_DONE_CLIENT,
    MMIPERF_INTERRIM_REPORT,
};
 
enum traffic_agent_state
{
    TRAFFIC_AGENT_NOT_STARTED,
    TRAFFIC_AGENT_RUNNING,
    TRAFFIC_AGENT_STOPPED,
};
 
enum iperf_version
{
    IPERF_VERSION_2_0_13,
    IPERF_VERSION_2_0_9,
};
 
typedef struct mmiperf_state *mmiperf_handle_t;
 
struct mmiperf_report
{
    enum mmiperf_report_type report_type;
    char local_addr[MMIPERF_IPADDR_MAXLEN];
    uint16_t local_port;
    char remote_addr[MMIPERF_IPADDR_MAXLEN];
    uint16_t remote_port;
    uint64_t bytes_transferred;
    uint32_t duration_ms;
    uint32_t bandwidth_kbitpsec;
    uint32_t tx_frames;
    uint32_t rx_frames;
    uint32_t out_of_sequence_frames;
    uint32_t error_count;
    uint32_t ipg_count;
    uint32_t ipg_sum_ms;
};
 
typedef void (
    *mmiperf_report_fn)(const struct mmiperf_report *report, void *arg, mmiperf_handle_t handle);
 
struct mmiperf_client_args
{
    char server_addr[MMIPERF_IPADDR_MAXLEN];
    uint16_t server_port;
    uint32_t target_bw;
    uint32_t packet_size;
    int32_t amount;
    mmiperf_report_fn report_fn;
    void *report_arg;
    enum iperf_version version;
};
 
#define MMIPERF_CLIENT_ARGS_DEFAULT                                                              \
    {                                                                                            \
        { 0 }, MMIPERF_DEFAULT_PORT, MMIPERF_DEFAULT_BANDWIDTH, 0, MMIPERF_DEFAULT_AMOUNT, NULL, \
        NULL,  IPERF_VERSION_2_0_13,                                                             \
    }
 
struct mmiperf_server_args
{
    char local_addr[MMIPERF_IPADDR_MAXLEN];
    uint16_t local_port;
    mmiperf_report_fn report_fn;
    void *report_arg;
    enum iperf_version version;
};
 
#define MMIPERF_SERVER_ARGS_DEFAULT                                    \
    {                                                                  \
        { 0 }, MMIPERF_DEFAULT_PORT, NULL, NULL, IPERF_VERSION_2_0_13, \
    }
 
mmiperf_handle_t mmiperf_start_udp_client(const struct mmiperf_client_args *args);
 
mmiperf_handle_t mmiperf_start_udp_server(const struct mmiperf_server_args *args);
 
mmiperf_handle_t mmiperf_start_tcp_client(const struct mmiperf_client_args *args);
 
mmiperf_handle_t mmiperf_start_tcp_server(const struct mmiperf_server_args *args);
 
bool mmiperf_get_interim_report(mmiperf_handle_t handle, struct mmiperf_report *report);
 
#ifdef __cplusplus
}
#endif