RIOT/tests/pkg/nimble_l2cap/main.c

/*
 * Copyright (C) 2019 Freie Universität Berlin
 *
 * This file is subject to the terms and conditions of the GNU Lesser
 * General Public License v2.1. See the file LICENSE in the top level
 * directory for more details.
 */

/**
 * @ingroup     tests
 * @{
 *
 * @file
 * @brief       Client to test and benchmark raw L2CAP COC for NimBLE
 *
 * @author      Hauke Petersen <hauke.petersen@fu-berlin.de>
 *
 * @}
 */

#include <stdio.h>
#include <stdlib.h>
#include <string.h>

#include "nimble_riot.h"
#include "host/ble_hs.h"
#include "host/ble_gap.h"
#include "host/util/util.h"

#include "test_utils/expect.h"
#include "shell.h"
#include "thread.h"
#include "thread_flags.h"
#include "net/bluetil/ad.h"
#include "xtimer.h"

#include "nimble_l2cap_test_conf.h"

#define FLAG_UP             (1u << 0)
#define FLAG_SYNC           (1u << 1)
#define FLAG_TX_UNSTALLED   (1u << 2)

/* synchronization state */
static thread_t *_main;
static volatile uint32_t _last_rx_seq;

/* BLE connection state */
static uint16_t _handle = 0;
static struct ble_l2cap_chan *_coc = NULL;

/* buffer allocation */
static os_membuf_t _coc_mem[OS_MEMPOOL_SIZE(MBUFCNT, MBUFSIZE)];
static struct os_mempool _coc_mempool;
static struct os_mbuf_pool _coc_mbuf_pool;
static uint32_t _rxbuf[APP_MTU / 4];
static uint32_t _txbuf[APP_MTU / 4];

static void _on_data(struct ble_l2cap_event *event)
{
    int res;
    (void)res;
    struct os_mbuf *rxd = event->receive.sdu_rx;
    expect(rxd != NULL);
    int rx_len = (int)OS_MBUF_PKTLEN(rxd);
    expect(rx_len <= (int)APP_MTU);

    res = os_mbuf_copydata(rxd, 0, rx_len, _rxbuf);
    expect(res == 0);
    _last_rx_seq = _rxbuf[POS_SEQ];
    if (_rxbuf[POS_TYPE] == TYPE_INCTEST) {
        thread_flags_set(_main, FLAG_SYNC);
    }

    /* free buffer */
    res = os_mbuf_free_chain(rxd);
    expect(res == 0);
    rxd = os_mbuf_get_pkthdr(&_coc_mbuf_pool, 0);
    expect(rxd != NULL);
    res = ble_l2cap_recv_ready(_coc, rxd);
    expect(res == 0);
}

static int _on_l2cap_evt(struct ble_l2cap_event *event, void *arg)
{
    (void)arg;

    switch (event->type) {
        case BLE_L2CAP_EVENT_COC_CONNECTED:
            _coc = event->connect.chan;
            puts("# L2CAP: CONNECTED");
            thread_flags_set(_main, FLAG_UP);
            break;
        case BLE_L2CAP_EVENT_COC_DISCONNECTED:
            _coc = NULL;
            puts("# L2CAP: DISCONNECTED");
            break;
        case BLE_L2CAP_EVENT_COC_DATA_RECEIVED:
            _on_data(event);
            break;
        case BLE_L2CAP_EVENT_COC_TX_UNSTALLED:
            thread_flags_set(_main, FLAG_TX_UNSTALLED);
            break;
        case BLE_L2CAP_EVENT_COC_ACCEPT:
            /* this event should never be triggered for the L2CAP client */
            /* fallthrough */
        default:
            expect(0);
            break;
    }

    return 0;
}

static int _on_gap_evt(struct ble_gap_event *event, void *arg)
{
    (void)arg;
    printf("# GAP event: %i\n", (int)event->type);

    switch (event->type) {
        case BLE_GAP_EVENT_CONNECT: {
            _handle = event->connect.conn_handle;
            struct os_mbuf *sdu_rx = os_mbuf_get_pkthdr(&_coc_mbuf_pool, 0);
            expect(sdu_rx != NULL);
            int res = ble_l2cap_connect(_handle, APP_CID, APP_MTU, sdu_rx,
                                       _on_l2cap_evt, NULL);
            expect(res == 0);
            break;
        }
        case BLE_GAP_EVENT_DISCONNECT:
            _handle = 0;
            puts("# TERMINATED, bye bye");
            break;
        case BLE_GAP_EVENT_CONN_UPDATE:
        case BLE_GAP_EVENT_CONN_UPDATE_REQ:
        default:
            break;
    }

    return 0;
}

static void _filter_and_connect(struct ble_gap_disc_desc *disc)
{
    int res;
    bluetil_ad_t ad;

    /* we use the bluetil module read-only here, so its save to cast the AD
     * buffer to non-const */
    bluetil_ad_init(&ad, (uint8_t *)disc->data,
                    (size_t)disc->length_data, (size_t)disc->length_data);
    res = bluetil_ad_find_and_cmp(&ad, BLE_GAP_AD_NAME,
                                  APP_NODENAME, (sizeof(APP_NODENAME) - 1));
    if (res) {
        res = ble_gap_disc_cancel();
        expect(res == 0);

        printf("# Found Server, connecting now");
        res = ble_gap_connect(nimble_riot_own_addr_type, &disc->addr,
                              BLE_HS_FOREVER, NULL, _on_gap_evt, NULL);
        expect(res == 0);
    }
}

static int _on_scan_evt(struct ble_gap_event *event, void *arg)
{
    (void)arg;

    switch (event->type) {
        case BLE_GAP_EVENT_DISC:
            _filter_and_connect(&event->disc);
            break;
        case BLE_GAP_EVENT_DISC_COMPLETE:
        default:
            break;
    }

    return 0;
}

static void _send(uint32_t type, uint32_t seq, size_t len)
{
    int res = 0;
    (void)res;
    struct os_mbuf *txd;

    expect(_coc);
    expect(len >= 8);
    expect(len <= APP_MTU);
    printf("# Sending: size %5" PRIuSIZE " seq %5" PRIu32 "\n", len, seq);

    _txbuf[POS_TYPE] = type;
    _txbuf[POS_SEQ] = seq;
    txd = os_mbuf_get_pkthdr(&_coc_mbuf_pool, 0);
    expect(txd != NULL);
    res = os_mbuf_append(txd, _txbuf, len);
    expect(res == 0);

    do {
        res = ble_l2cap_send(_coc, txd);
        if (res == BLE_HS_EBUSY) {
            thread_flags_wait_all(FLAG_TX_UNSTALLED);
        }
    } while (res == BLE_HS_EBUSY);

    if ((res != 0) && (res != BLE_HS_ESTALLED)) {
        printf("# err: failed to send (%i)\n", res);
        expect(0);
    }
}

static int _cmd_inctest(int argc, char **argv)
{
    size_t step = 10;
    size_t limit = APP_MTU;

    if ((argc == 2) && (strncmp(argv[1], "help", 4) == 0)) {
        printf("usage: %s [step [limit]]\n", argv[0]);
        return 0;
    }
    if (_coc == NULL) {
        puts("err: not connected");
        return 1;
    }

    /* parse params */
    if (argc >= 2) {
        step = atoi(argv[1]);
    }
    if (argc >= 3) {
        limit = atoi(argv[2]);
        if ((limit < 8) || (limit > APP_MTU)) {
            puts("err: invalid limit payload length given");
            return 1;
        }
    }

    /* send out packets with increasing payload size */
    thread_flags_clear(FLAG_SYNC);
    uint32_t seq = 0;
    uint32_t time = xtimer_now_usec();
    for (size_t i = 8; i < limit; i += step) {
        _send(TYPE_INCTEST, ++seq, i);
        thread_flags_wait_all(FLAG_SYNC);
        if (_last_rx_seq != seq) {
            printf("# err: bad sequence number in response (%u)\n",
                   (unsigned)_last_rx_seq);
            expect(0);
        }
    }
    time = (xtimer_now_usec() - time);
    puts("# TEST COMPLETE");
    printf("-> runtime: %ums\n", (unsigned)(time / 1000));
    return 0;
}

static int _cmd_floodtest(int argc, char **argv)
{
    size_t pktsize = PKTSIZE_DEFAULT;
    unsigned limit = FLOOD_DEFAULT;

    if ((argc == 2) && (strncmp(argv[1], "help", 4) == 0)) {
        printf("usage: %s [payload_size [num_of_packets]]\n", argv[0]);
        return 0;
    }
    if (_coc == NULL) {
        puts("err: not connected");
        return 1;
    }

    if (argc >= 2) {
        pktsize = atoi(argv[1]);
        if ((pktsize < 8) || (pktsize > APP_MTU)) {
            puts("err: invalid packet size given");
            return 1;
        }
    }
    if (argc >= 3) {
        limit = atoi(argv[2]);
    }

    /* now lets flood */
    uint32_t seq = 0;
    uint32_t time = xtimer_now_usec();
    unsigned sum = 0;
    for (unsigned i = 0; i < limit; i++) {
        _send(TYPE_FLOODING, ++seq, pktsize);
        sum += pktsize;
    }
    /* we wait for the last packet to be returned to compensate any internal
     * packet buffering, but we also include this extra packet transmission in
     * the throughput calculation */
    sum += pktsize;
    while (_last_rx_seq != seq) {}
    time = (xtimer_now_usec() - time);
    puts("# TEST COMPLETE");
    printf("-> runtime: %ums\n", (unsigned)(time / 1000));
    printf("-> ~ %u bytes/s\n", (unsigned)((sum * 1000) / (time / 1000)));

    return 0;
}

static const shell_command_t _cmds[] = {
    { "inctest", "send stream of payloads of incremental size", _cmd_inctest },
    { "flood", "flood connection with data", _cmd_floodtest },
    { NULL, NULL, NULL }
};

int main(void)
{
    int res;
    (void)res;
    puts("NimBLE L2CAP test application");

    /* save context of the main thread */
    _main = thread_get_active();

    /* initialize buffers and setup the test environment */
    res = os_mempool_init(&_coc_mempool, MBUFCNT, MBUFSIZE, _coc_mem, "appbuf");
    expect(res == 0);
    res = os_mbuf_pool_init(&_coc_mbuf_pool, &_coc_mempool, MBUFSIZE, MBUFCNT);
    expect(res == 0);

    /* start scanning for a suitable test server */
    puts("# Scanning now");
    struct ble_gap_disc_params params = { 0 };
    res = ble_gap_disc(nimble_riot_own_addr_type, BLE_HS_FOREVER,
                       &params, _on_scan_evt, NULL);
    expect(res == 0);

    /* wait until we are connected to the test server */
    thread_flags_wait_all(FLAG_UP);
    struct ble_l2cap_chan_info info;
    ble_l2cap_get_chan_info(_coc, &info);
    puts("# Connection established");
    printf("# MTUs: our %i, remote %i\n",
           (int)info.our_l2cap_mtu, (int)info.peer_l2cap_mtu);

    /* start shell */
    puts("# Shell is now available");
    char line_buf[SHELL_DEFAULT_BUFSIZE];
    shell_run(_cmds, line_buf, SHELL_DEFAULT_BUFSIZE);

    /* should be never reached */
    return 0;
}