versions/v1_5_0/mynewt-core/sys/log/full/test/util/src/log_test_util.c

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *  http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

#include "log_test_util/log_test_util.h"

static struct flash_area fcb_areas[] = {
    [0] = {
        .fa_off = 0x00000000,
        .fa_size = 16 * 1024
    },
    [1] = {
        .fa_off = 0x00004000,
        .fa_size = 16 * 1024
    }
};

static int ltu_str_idx = 0;
static int ltu_str_max_idx = 0;

char *ltu_str_logs[] = {
    "testdata",
    "1testdata2",
    "",
    "alkjfadkjsfajsd;kfjadls;hg;lasdhgl;aksdhfl;asdkh;afbabababaaacsds",
    NULL
};

static uint8_t ltu_cbmem_buf[2048];

int
ltu_num_strs(void)
{
    int i;

    for (i = 0; ltu_str_logs[i] != NULL; i++) { }

    return i;
}

struct os_mbuf *
ltu_flat_to_fragged_mbuf(const void *flat, int len, int frag_sz)
{
    const uint8_t *u8p;
    struct os_mbuf *first;
    struct os_mbuf *cur;
    int chunk_sz;
    int rc;

    first = NULL;

    u8p = flat;
    do {
        cur = os_msys_get(0, 0);
        TEST_ASSERT_FATAL(cur != NULL);

        if (len >= frag_sz) {
            chunk_sz = frag_sz;
        } else {
            chunk_sz = len;
        }

        rc = os_mbuf_copyinto(cur, 0, u8p, chunk_sz);
        TEST_ASSERT_FATAL(rc == 0);

        u8p += chunk_sz;
        len -= chunk_sz;

        if (first == NULL) {
            first = cur;
        } else {
            os_mbuf_concat(first, cur);
        }
    } while (len > 0);

    return first;
}

void
ltu_setup_fcb(struct fcb_log *fcb_log, struct log *log)
{
    int rc;
    int i;

    sysinit();

    *fcb_log = (struct fcb_log) { 0 };

    fcb_log->fl_fcb.f_sectors = fcb_areas;
    fcb_log->fl_fcb.f_sector_cnt = sizeof(fcb_areas) / sizeof(fcb_areas[0]);
    fcb_log->fl_fcb.f_magic = 0x7EADBADF;
    fcb_log->fl_fcb.f_version = 0;

    for (i = 0; i < fcb_log->fl_fcb.f_sector_cnt; i++) {
        rc = flash_area_erase(&fcb_areas[i], 0, fcb_areas[i].fa_size);
        TEST_ASSERT(rc == 0);
    }
    rc = fcb_init(&fcb_log->fl_fcb);
    TEST_ASSERT(rc == 0);

    log_register("log", log, &log_fcb_handler, fcb_log, LOG_SYSLEVEL);
}

void
ltu_setup_cbmem(struct cbmem *cbmem, struct log *log)
{
    sysinit();

    cbmem_init(cbmem, ltu_cbmem_buf, sizeof ltu_cbmem_buf);
    log_register("log", log, &log_cbmem_handler, cbmem, LOG_SYSLEVEL);
}

static int
ltu_walk_verify(struct log *log, struct log_offset *log_offset,
                void *dptr, uint16_t len)
{
    int rc;
    struct log_entry_hdr ueh;
    struct os_mbuf *om;
    char data[128];
    int dlen;

    TEST_ASSERT(ltu_str_idx < ltu_str_max_idx);

    /*** Verify contents using single read. */

    rc = log_read(log, dptr, &ueh, 0, sizeof(ueh));
    TEST_ASSERT(rc == sizeof(ueh));

    dlen = len - sizeof(ueh);
    TEST_ASSERT(dlen < sizeof(data));

    rc = log_read(log, dptr, data, sizeof(ueh), dlen);
    TEST_ASSERT(rc == dlen);

    data[rc] = '\0';

    TEST_ASSERT(strlen(ltu_str_logs[ltu_str_idx]) == dlen);
    TEST_ASSERT(!memcmp(ltu_str_logs[ltu_str_idx], data, dlen));

    /*** Verify contents using separate header and body reads. */

    rc = log_read_hdr(log, dptr, &ueh);
    TEST_ASSERT(rc == 0);

    rc = log_read_body(log, dptr, data, 0, dlen);
    TEST_ASSERT(rc == dlen);

    TEST_ASSERT(strlen(ltu_str_logs[ltu_str_idx]) == dlen);
    TEST_ASSERT(!memcmp(ltu_str_logs[ltu_str_idx], data, dlen));

    /*** Verify contents using mbuf read. */

    om = os_msys_get_pkthdr(0, 0);
    TEST_ASSERT_FATAL(om != NULL);

    rc = log_read_mbuf(log, dptr, om, sizeof(ueh), dlen);
    TEST_ASSERT(rc == dlen);

    TEST_ASSERT(strlen(ltu_str_logs[ltu_str_idx]) == dlen);
    TEST_ASSERT(os_mbuf_cmpf(om, 0, ltu_str_logs[ltu_str_idx], dlen) == 0);

    /*** Verify contents using mbuf read body. */

    os_mbuf_adj(om, OS_MBUF_PKTLEN(om));

    rc = log_read_mbuf_body(log, dptr, om, 0, dlen);
    TEST_ASSERT(rc == dlen);

    TEST_ASSERT(strlen(ltu_str_logs[ltu_str_idx]) == dlen);
    TEST_ASSERT(os_mbuf_cmpf(om, 0, ltu_str_logs[ltu_str_idx], dlen) == 0);

    os_mbuf_free_chain(om);

    ltu_str_idx++;

    return 0;
}

static int
ltu_walk_body_verify(struct log *log, struct log_offset *log_offset,
                     const struct log_entry_hdr *euh, void *dptr, uint16_t len)
{
    struct os_mbuf *om;
    char data[128];
    int rc;

    TEST_ASSERT(ltu_str_idx < ltu_str_max_idx);

    /*** Verify contents using single read. */

    TEST_ASSERT(len < sizeof(data));

    rc = log_read_body(log, dptr, data, 0, len);
    TEST_ASSERT(rc == len);

    data[rc] = '\0';

    TEST_ASSERT(strlen(ltu_str_logs[ltu_str_idx]) == len);
    TEST_ASSERT(memcmp(ltu_str_logs[ltu_str_idx], data, len) == 0);

    /*** Verify contents using mbuf read body. */

    om = os_msys_get_pkthdr(0, 0);
    TEST_ASSERT_FATAL(om != NULL);

    rc = log_read_mbuf_body(log, dptr, om, 0, len);
    TEST_ASSERT(rc == len);

    TEST_ASSERT(strlen(ltu_str_logs[ltu_str_idx]) == len);
    TEST_ASSERT(os_mbuf_cmpf(om, 0, ltu_str_logs[ltu_str_idx], len) == 0);

    os_mbuf_free_chain(om);

    ltu_str_idx++;

    return 0;
}

static int
ltu_walk_empty(struct log *log, struct log_offset *log_offset,
               void *dptr, uint16_t len)
{
    TEST_ASSERT(0);
    return 0;
}

void
ltu_verify_contents(struct log *log)
{
    struct log_offset log_offset = { 0 };
    int rc;

    ltu_str_max_idx = ltu_num_strs();

    /* Regular walk. */
    ltu_str_idx = 0;
    rc = log_walk(log, ltu_walk_verify, &log_offset);
    TEST_ASSERT(rc == 0);
    TEST_ASSERT(ltu_str_idx == ltu_str_max_idx);

    /* Body walk. */
    ltu_str_idx = 0;
    rc = log_walk_body(log, ltu_walk_body_verify, &log_offset);
    TEST_ASSERT(rc == 0);
    TEST_ASSERT(ltu_str_idx == ltu_str_max_idx);

    rc = log_flush(log);
    TEST_ASSERT(rc == 0);

    rc = log_walk(log, ltu_walk_empty, &log_offset);
    TEST_ASSERT(rc == 0);
}