odp_pktio.c

Basic packet IO loopback example application

/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright (c) 2013-2018 Linaro Limited
 */
 
#include <stdlib.h>
#include <string.h>
#include <getopt.h>
#include <unistd.h>
#include <inttypes.h>
 
#include <odp_api.h>
#include <odp/helper/odph_api.h>
 
#define MAX_WORKERS            (ODP_THREAD_COUNT_MAX - 1)
 
#define SHM_PKT_POOL_SIZE      (512*2048)
 
#define SHM_PKT_POOL_BUF_SIZE  1856
 
#define MAX_PKT_BURST          16
 
#define APPL_MODE_PKT_BURST    0
 
#define APPL_MODE_PKT_QUEUE    1
 
#define APPL_MODE_PKT_SCHED    2
 
#define PRINT_APPL_MODE(x) printf("%s(%i)\n", #x, (x))
 
#define NO_PATH(file_name) (strrchr((file_name), '/') ? \
                strrchr((file_name), '/') + 1 : (file_name))
typedef struct {
    unsigned int cpu_count; 
    int if_count;       
    char **if_names;    
    int mode;       
    char *if_str;       
    double time;        
} appl_args_t;
 
typedef struct {
    char *pktio_dev;    
    int mode;       
} thread_args_t;
 
typedef struct {
    appl_args_t appl;
    odp_shm_t shm;
    thread_args_t thread[MAX_WORKERS];
    odp_atomic_u32_t exit_threads;
} args_t;
 
static args_t *args;
 
/* helper funcs */
static int drop_err_pkts(odp_packet_t pkt_tbl[], unsigned len);
static void swap_pkt_addrs(odp_packet_t pkt_tbl[], unsigned len);
static void parse_args(int argc, char *argv[], appl_args_t *appl_args);
static void print_info(char *progname, appl_args_t *appl_args);
static void usage(char *progname);
 
static odp_pktio_t create_pktio(const char *dev, odp_pool_t pool, int mode)
{
    odp_pktio_t pktio;
    int ret;
    odp_pktio_param_t pktio_param;
    odp_pktin_queue_param_t pktin_param;
 
    odp_pktio_param_init(&pktio_param);
 
    switch (mode) {
    case  APPL_MODE_PKT_BURST:
        pktio_param.in_mode = ODP_PKTIN_MODE_DIRECT;
        break;
    case APPL_MODE_PKT_QUEUE:
        pktio_param.in_mode = ODP_PKTIN_MODE_QUEUE;
        break;
    case APPL_MODE_PKT_SCHED:
        pktio_param.in_mode = ODP_PKTIN_MODE_SCHED;
        break;
    default:
        ODPH_ABORT("invalid mode %d\n", mode);
    }
 
    /* Open a packet IO instance */
    pktio = odp_pktio_open(dev, pool, &pktio_param);
    if (pktio == ODP_PKTIO_INVALID)
        ODPH_ABORT("Error: pktio create failed for %s\n", dev);
 
    odp_pktin_queue_param_init(&pktin_param);
 
    if (mode == APPL_MODE_PKT_SCHED)
        pktin_param.queue_param.sched.sync = ODP_SCHED_SYNC_ATOMIC;
 
    if (odp_pktin_queue_config(pktio, &pktin_param))
        ODPH_ABORT("Error: pktin config failed for %s\n", dev);
 
    if (odp_pktout_queue_config(pktio, NULL))
        ODPH_ABORT("Error: pktout config failed for %s\n", dev);
 
    ret = odp_pktio_start(pktio);
    if (ret != 0)
        ODPH_ABORT("Error: unable to start %s\n", dev);
 
    printf("  created pktio:%02" PRIu64
           ", dev:%s, queue mode (ATOMIC queues)\n"
           "  \tdefault pktio%02" PRIu64 "\n",
           odp_pktio_to_u64(pktio), dev,
           odp_pktio_to_u64(pktio));
 
    return pktio;
}
 
static int pktio_queue_thread(void *arg)
{
    int thr;
    odp_pktio_t pktio;
    thread_args_t *thr_args;
    odp_pktout_queue_t pktout;
    odp_queue_t inq;
    odp_packet_t pkt;
    odp_event_t ev;
    unsigned long pkt_cnt = 0;
    unsigned long err_cnt = 0;
    uint64_t sched_wait = odp_schedule_wait_time(ODP_TIME_MSEC_IN_NS * 100);
 
    thr = odp_thread_id();
    thr_args = arg;
 
    pktio = odp_pktio_lookup(thr_args->pktio_dev);
    if (pktio == ODP_PKTIO_INVALID) {
        ODPH_ERR("  [%02i] Error: lookup of pktio %s failed\n",
             thr, thr_args->pktio_dev);
        return -1;
    }
 
    printf("  [%02i] looked up pktio:%02" PRIu64
           ", queue mode (ATOMIC queues)\n"
           "         default pktio%02" PRIu64 "\n",
           thr, odp_pktio_to_u64(pktio), odp_pktio_to_u64(pktio));
 
    inq = ODP_QUEUE_INVALID;
 
    if ((thr_args->mode == APPL_MODE_PKT_QUEUE) &&
        (odp_pktin_event_queue(pktio, &inq, 1) != 1)) {
        ODPH_ERR("  [%02i] Error: no input queue for %s\n",
             thr, thr_args->pktio_dev);
        return -1;
    }
 
    /* Loop packets */
    while (!odp_atomic_load_u32(&args->exit_threads)) {
        odp_pktio_t pktio_tmp;
 
        if (inq != ODP_QUEUE_INVALID)
            ev = odp_queue_deq(inq);
        else
            ev = odp_schedule(NULL, sched_wait);
 
        if (ev == ODP_EVENT_INVALID)
            continue;
 
        pkt = odp_packet_from_event(ev);
        if (!odp_packet_is_valid(pkt))
            continue;
 
        /* Drop packets with errors */
        if (odp_unlikely(drop_err_pkts(&pkt, 1) == 0)) {
            ODPH_ERR("Drop frame - err_cnt:%lu\n", ++err_cnt);
            continue;
        }
 
        pktio_tmp = odp_packet_input(pkt);
 
        if (odp_pktout_queue(pktio_tmp, &pktout, 1) != 1) {
            ODPH_ERR("  [%02i] Error: no pktout queue\n", thr);
            return -1;
        }
 
        /* Swap Eth MACs and possibly IP-addrs before sending back */
        swap_pkt_addrs(&pkt, 1);
 
        /* Enqueue the packet for output */
        if (odp_pktout_send(pktout, &pkt, 1) != 1) {
            ODPH_ERR("  [%i] Packet send failed.\n", thr);
            odp_packet_free(pkt);
            continue;
        }
 
        /* Print packet counts every once in a while */
        if (odp_unlikely(pkt_cnt++ % 100000 == 0)) {
            printf("  [%02i] pkt_cnt:%lu\n", thr, pkt_cnt);
            fflush(NULL);
        }
    }
 
    return 0;
}
 
static int pktio_ifburst_thread(void *arg)
{
    int thr;
    odp_pktio_t pktio;
    odp_pktin_queue_t pktin;
    odp_pktout_queue_t pktout;
    thread_args_t *thr_args;
    int pkts, pkts_ok;
    odp_packet_t pkt_tbl[MAX_PKT_BURST];
    unsigned long pkt_cnt = 0;
    unsigned long err_cnt = 0;
    unsigned long tmp = 0;
 
    thr = odp_thread_id();
    thr_args = arg;
 
    pktio = odp_pktio_lookup(thr_args->pktio_dev);
    if (pktio == ODP_PKTIO_INVALID) {
        ODPH_ERR("  [%02i] Error: lookup of pktio %s failed\n",
             thr, thr_args->pktio_dev);
        return -1;
    }
 
    printf("  [%02i] looked up pktio:%02" PRIu64 ", burst mode\n",
           thr, odp_pktio_to_u64(pktio));
 
    if (odp_pktin_queue(pktio, &pktin, 1) != 1) {
        ODPH_ERR("  [%02i] Error: no pktin queue\n", thr);
        return -1;
    }
 
    if (odp_pktout_queue(pktio, &pktout, 1) != 1) {
        ODPH_ERR("  [%02i] Error: no pktout queue\n", thr);
        return -1;
    }
 
    /* Loop packets */
    while (!odp_atomic_load_u32(&args->exit_threads)) {
        pkts = odp_pktin_recv(pktin, pkt_tbl, MAX_PKT_BURST);
        if (pkts > 0) {
            /* Drop packets with errors */
            pkts_ok = drop_err_pkts(pkt_tbl, pkts);
            if (pkts_ok > 0) {
                int sent;
 
                /* Swap Eth MACs and IP-addrs */
                swap_pkt_addrs(pkt_tbl, pkts_ok);
                sent = odp_pktout_send(pktout, pkt_tbl,
                               pkts_ok);
                sent = sent > 0 ? sent : 0;
                if (odp_unlikely(sent < pkts_ok)) {
                    err_cnt += pkts_ok - sent;
                    do
                        odp_packet_free(pkt_tbl[sent]);
                    while (++sent < pkts_ok);
                }
            }
 
            if (odp_unlikely(pkts_ok != pkts))
                ODPH_ERR("Dropped frames:%u - err_cnt:%lu\n",
                     pkts - pkts_ok, ++err_cnt);
 
            /* Print packet counts every once in a while */
            tmp += pkts_ok;
            if (odp_unlikely((tmp >= 100000) || /* OR first print:*/
                ((pkt_cnt == 0) && ((tmp-1) < MAX_PKT_BURST)))) {
                pkt_cnt += tmp;
                printf("  [%02i] pkt_cnt:%lu\n", thr, pkt_cnt);
                fflush(NULL);
                tmp = 0;
            }
        }
    }
 
    return 0;
}
 
int main(int argc, char *argv[])
{
    odph_helper_options_t helper_options;
    odph_thread_t thread_tbl[MAX_WORKERS];
    odph_thread_common_param_t thr_common;
    odph_thread_param_t thr_param[MAX_WORKERS];
    odp_pool_t pool;
    int num_workers;
    int i;
    odp_cpumask_t cpumask;
    char cpumaskstr[ODP_CPUMASK_STR_SIZE];
    odp_pool_param_t params;
    odp_instance_t instance;
    odp_init_t init_param;
    odp_shm_t shm;
 
    /* Let helper collect its own arguments (e.g. --odph_proc) */
    argc = odph_parse_options(argc, argv);
    if (odph_options(&helper_options)) {
        ODPH_ERR("Error: reading ODP helper options failed.\n");
        exit(EXIT_FAILURE);
    }
 
    odp_init_param_init(&init_param);
    init_param.mem_model = helper_options.mem_model;
 
    /* Init ODP before calling anything else */
    if (odp_init_global(&instance, &init_param, NULL)) {
        ODPH_ERR("Error: ODP global init failed.\n");
        exit(EXIT_FAILURE);
    }
 
    /* Init this thread */
    if (odp_init_local(instance, ODP_THREAD_CONTROL)) {
        ODPH_ERR("Error: ODP local init failed.\n");
        exit(EXIT_FAILURE);
    }
 
    /* Reserve memory for args from shared mem */
    shm = odp_shm_reserve("_appl_global_data", sizeof(args_t),
                  ODP_CACHE_LINE_SIZE, 0);
    if (shm == ODP_SHM_INVALID) {
        ODPH_ERR("Error: shared mem reserve failed.\n");
        exit(EXIT_FAILURE);
    }
 
    args = odp_shm_addr(shm);
    if (args == NULL) {
        ODPH_ERR("Error: shared mem alloc failed.\n");
        exit(EXIT_FAILURE);
    }
 
    memset(args, 0, sizeof(args_t));
    odp_atomic_init_u32(&args->exit_threads, 0);
    args->shm = shm;
 
    /* Parse and store the application arguments */
    parse_args(argc, argv, &args->appl);
 
    /* Print both system and application information */
    print_info(NO_PATH(argv[0]), &args->appl);
 
    num_workers = MAX_WORKERS;
    if (args->appl.cpu_count && args->appl.cpu_count < MAX_WORKERS)
        num_workers = args->appl.cpu_count;
 
    /* Get default worker cpumask */
    num_workers = odp_cpumask_default_worker(&cpumask, num_workers);
    (void)odp_cpumask_to_str(&cpumask, cpumaskstr, sizeof(cpumaskstr));
 
    printf("num worker threads: %i\n", num_workers);
    printf("first CPU:          %i\n", odp_cpumask_first(&cpumask));
    printf("cpu mask:           %s\n", cpumaskstr);
 
    /* Create packet pool */
    odp_pool_param_init(&params);
    params.pkt.seg_len = SHM_PKT_POOL_BUF_SIZE;
    params.pkt.len     = SHM_PKT_POOL_BUF_SIZE;
    params.pkt.num     = SHM_PKT_POOL_SIZE/SHM_PKT_POOL_BUF_SIZE;
    params.type        = ODP_POOL_PACKET;
 
    pool = odp_pool_create("packet_pool", &params);
 
    if (pool == ODP_POOL_INVALID) {
        ODPH_ERR("Error: packet pool create failed.\n");
        exit(EXIT_FAILURE);
    }
    odp_pool_print(pool);
 
    /* Config and start scheduler */
    odp_schedule_config(NULL);
 
    /* Create a pktio instance for each interface */
    for (i = 0; i < args->appl.if_count; ++i)
        create_pktio(args->appl.if_names[i], pool, args->appl.mode);
 
    /* Create and init worker threads */
    odph_thread_common_param_init(&thr_common);
    thr_common.instance = instance;
    thr_common.cpumask = &cpumask;
 
    for (i = 0; i < num_workers; ++i) {
        int (*thr_run_func)(void *);
        int if_idx;
 
        if_idx = i % args->appl.if_count;
 
        args->thread[i].pktio_dev = args->appl.if_names[if_idx];
        args->thread[i].mode = args->appl.mode;
 
        if (args->appl.mode == APPL_MODE_PKT_BURST)
            thr_run_func = pktio_ifburst_thread;
        else /* APPL_MODE_PKT_QUEUE */
            thr_run_func = pktio_queue_thread;
 
        odph_thread_param_init(&thr_param[i]);
        thr_param[i].start = thr_run_func;
        thr_param[i].arg = &args->thread[i];
        thr_param[i].thr_type = ODP_THREAD_WORKER;
    }
 
    memset(thread_tbl, 0, sizeof(thread_tbl));
    odph_thread_create(thread_tbl, &thr_common, thr_param, num_workers);
 
    if (args->appl.time > 0.0) {
        odp_time_wait_ns(args->appl.time *
                 ODP_TIME_SEC_IN_NS);
        for (i = 0; i < args->appl.if_count; ++i) {
            odp_pktio_t pktio;
 
            pktio = odp_pktio_lookup(args->thread[i].pktio_dev);
            odp_pktio_stop(pktio);
        }
        /* use delay to let workers clean up queues */
        odp_time_wait_ns(100 * ODP_TIME_MSEC_IN_NS);
        odp_atomic_store_u32(&args->exit_threads, 1);
    }
 
    /* Master thread waits for other threads to exit */
    odph_thread_join(thread_tbl, num_workers);
 
    for (i = 0; i < args->appl.if_count; ++i)
        odp_pktio_close(odp_pktio_lookup(args->thread[i].pktio_dev));
 
    free(args->appl.if_names);
    free(args->appl.if_str);
 
    odp_pool_destroy(pool);
 
    if (odp_shm_free(args->shm)) {
        ODPH_ERR("Error: shm free global data\n");
        exit(EXIT_FAILURE);
    }
 
    odp_term_local();
    return odp_term_global(instance);
}
 
static int drop_err_pkts(odp_packet_t pkt_tbl[], unsigned len)
{
    odp_packet_t pkt;
    unsigned pkt_cnt = len;
    unsigned i, j;
 
    for (i = 0, j = 0; i < len; ++i) {
        pkt = pkt_tbl[i];
 
        if (odp_unlikely(odp_packet_has_error(pkt))) {
            odp_packet_free(pkt); /* Drop */
            pkt_cnt--;
        } else if (odp_unlikely(i != j++)) {
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Warray-bounds"
            pkt_tbl[j-1] = pkt;
#pragma GCC diagnostic pop
        }
    }
 
    return pkt_cnt;
}
 
static void swap_pkt_addrs(odp_packet_t pkt_tbl[], unsigned len)
{
    odp_packet_t pkt;
    odph_ethhdr_t *eth;
    odph_ethaddr_t tmp_addr;
    odph_ipv4hdr_t *ip;
    odp_u32be_t ip_tmp_addr; /* tmp ip addr */
    unsigned i;
 
    for (i = 0; i < len; ++i) {
        pkt = pkt_tbl[i];
        if (odp_packet_has_eth(pkt)) {
            eth = (odph_ethhdr_t *)odp_packet_l2_ptr(pkt, NULL);
 
            tmp_addr = eth->dst;
            eth->dst = eth->src;
            eth->src = tmp_addr;
 
            if (odp_packet_has_ipv4(pkt)) {
                /* IPv4 */
                ip = (odph_ipv4hdr_t *)
                    odp_packet_l3_ptr(pkt, NULL);
 
                ip_tmp_addr  = ip->src_addr;
                ip->src_addr = ip->dst_addr;
                ip->dst_addr = ip_tmp_addr;
            }
        }
    }
}
 
static void parse_args(int argc, char *argv[], appl_args_t *appl_args)
{
    int opt;
    int long_index;
    char *token;
    size_t len;
    int i;
    static const struct option longopts[] = {
        {"count", required_argument, NULL, 'c'},
        {"time", required_argument, NULL, 't'},
        {"interface", required_argument, NULL, 'i'},    /* return 'i' */
        {"mode", required_argument, NULL, 'm'},     /* return 'm' */
        {"help", no_argument, NULL, 'h'},       /* return 'h' */
        {NULL, 0, NULL, 0}
    };
 
    static const char *shortopts = "+c:i:m:t:h";
 
    appl_args->cpu_count = 1; /* use one worker by default */
    appl_args->mode = APPL_MODE_PKT_SCHED;
    appl_args->time = 0; 
    while (1) {
        opt = getopt_long(argc, argv, shortopts, longopts, &long_index);
 
        if (opt == -1)
            break;  /* No more options */
 
        switch (opt) {
        case 'c':
            appl_args->cpu_count = atoi(optarg);
            break;
        case 't':
            appl_args->time = atof(optarg);
            break;
            /* parse packet-io interface names */
        case 'i':
            len = strlen(optarg);
            if (len == 0) {
                usage(argv[0]);
                exit(EXIT_FAILURE);
            }
            len += 1;   /* add room for '\0' */
 
            appl_args->if_str = malloc(len);
            if (appl_args->if_str == NULL) {
                usage(argv[0]);
                exit(EXIT_FAILURE);
            }
 
            /* count the number of tokens separated by ',' */
            strcpy(appl_args->if_str, optarg);
            for (token = strtok(appl_args->if_str, ","), i = 0;
                 token != NULL;
                 token = strtok(NULL, ","), i++)
                ;
 
            appl_args->if_count = i;
 
            if (appl_args->if_count == 0) {
                usage(argv[0]);
                exit(EXIT_FAILURE);
            }
 
            /* allocate storage for the if names */
            appl_args->if_names =
                calloc(appl_args->if_count, sizeof(char *));
 
            /* store the if names (reset names string) */
            strcpy(appl_args->if_str, optarg);
            for (token = strtok(appl_args->if_str, ","), i = 0;
                 token != NULL; token = strtok(NULL, ","), i++) {
                appl_args->if_names[i] = token;
            }
            break;
 
        case 'm':
            i = atoi(optarg);
            switch (i) {
            case 0:
                appl_args->mode = APPL_MODE_PKT_BURST;
                break;
            case 1:
                appl_args->mode = APPL_MODE_PKT_QUEUE;
                break;
            case 2:
                appl_args->mode = APPL_MODE_PKT_SCHED;
                break;
            default:
                usage(argv[0]);
                exit(EXIT_FAILURE);
            }
            break;
        case 'h':
            usage(argv[0]);
            exit(EXIT_SUCCESS);
            break;
 
        default:
            break;
        }
    }
 
    if (appl_args->if_count == 0 || appl_args->mode == -1) {
        usage(argv[0]);
        exit(EXIT_FAILURE);
    }
 
    optind = 1;     /* reset 'extern optind' from the getopt lib */
}
 
static void print_info(char *progname, appl_args_t *appl_args)
{
    int i;
 
    odp_sys_info_print();
 
    printf("Running ODP appl: \"%s\"\n"
           "-----------------\n"
           "IF-count:        %i\n"
           "Using IFs:      ",
           progname, appl_args->if_count);
    for (i = 0; i < appl_args->if_count; ++i)
        printf(" %s", appl_args->if_names[i]);
    printf("\n"
           "Mode:            ");
    switch (appl_args->mode) {
    case APPL_MODE_PKT_BURST:
        PRINT_APPL_MODE(APPL_MODE_PKT_BURST);
        break;
    case APPL_MODE_PKT_QUEUE:
        PRINT_APPL_MODE(APPL_MODE_PKT_QUEUE);
        break;
    case APPL_MODE_PKT_SCHED:
        PRINT_APPL_MODE(APPL_MODE_PKT_SCHED);
        break;
    }
    printf("\n\n");
    fflush(NULL);
}
 
static void usage(char *progname)
{
    printf("\n"
           "Usage: %s OPTIONS\n"
           "  E.g. %s -i eth1,eth2,eth3 -m 0\n"
           "\n"
           "OpenDataPlane example application.\n"
           "\n"
           "Mandatory OPTIONS:\n"
           "  -i, --interface Eth interfaces (comma-separated, no spaces)\n"
           "\n"
           "Optional OPTIONS\n"
           "  -c, --count <number> CPU count, 0=all available, default=1\n"
           "  -t, --time <seconds> Number of seconds to run (e.g. 0.1).\n"
           "  -m, --mode      0: Receive and send directly (no queues)\n"
           "                  1: Receive and send via queues.\n"
           "                  2: Receive via scheduler, send via queues.\n"
           "  -h, --help           Display help and exit.\n"
           "\n", NO_PATH(progname), NO_PATH(progname)
        );
}