bareflank-hypervisor/bfvmm/tests/debug/debug_ring/test_debug_ring.cpp

//
// Bareflank Hypervisor
// Copyright (C) 2015 Assured Information Security, Inc.
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA

#include <catch/catch.hpp>

#include <bfgsl.h>
#include <bfnewdelete.h>
#include <debug/debug_ring/debug_ring.h>

using namespace bfvmm;

debug_ring_resources_t *drr;

char rb[DEBUG_RING_SIZE];
char wb[DEBUG_RING_SIZE + 100];

void
init_wb(uint64_t num, char val = 'A')
{
    for (auto i = 0U; i < num; i++) {
        gsl::at(wb, i) = val;
    }

    gsl::at(wb, num) = 0;
}

TEST_CASE("get_drr: get_drr_invalid_drr")
{
    CHECK(get_drr(0, nullptr) == GET_DRR_FAILURE);
}

TEST_CASE("get_drr: get_drr_invalid_vcpuid")
{
    CHECK(get_drr(0x1000, &drr) == GET_DRR_FAILURE);
}

TEST_CASE("debug_ring: constructor_out_of_memory")
{
    auto __ = gsl::finally([&] {
        g_new_throws_bad_alloc = 0;
    });

    g_new_throws_bad_alloc = sizeof(debug_ring_resources_t);
    debug_ring dr(0);
}

TEST_CASE("debug_ring: write_out_of_memory")
{
    debug_ring dr(0);

    CHECK_NOTHROW(dr.write("hello"));
}

TEST_CASE("debug_ring_read: read_with_invalid_drr")
{
    CHECK(debug_ring_read(nullptr, static_cast<char *>(rb), DEBUG_RING_SIZE) == 0);
}

TEST_CASE("debug_ring_read: read_with_null_string")
{
    debug_ring dr(0);
    get_drr(0, &drr);

    CHECK(debug_ring_read(drr, nullptr, DEBUG_RING_SIZE) == 0);
}

TEST_CASE("debug_ring_read: read_with_zero_length")
{
    debug_ring dr(0);
    get_drr(0, &drr);

    CHECK(debug_ring_read(drr, static_cast<char *>(rb), 0) == 0);
}

TEST_CASE("write: write_with_zero_length")
{
    debug_ring dr(0);
    get_drr(0, &drr);

    auto zero_len_wb = "";

    CHECK_NOTHROW(dr.write(static_cast<const char *>(zero_len_wb)));
}

TEST_CASE("write: write_string_to_dr_that_is_larger_than_dr")
{
    debug_ring dr(0);
    get_drr(0, &drr);

    init_wb(DEBUG_RING_SIZE);

    CHECK_NOTHROW(dr.write(static_cast<const char *>(wb)));
}

TEST_CASE("write: write_string_to_dr_that_is_much_larger_than_dr")
{
    debug_ring dr(0);
    get_drr(0, &drr);

    init_wb(DEBUG_RING_SIZE + 50);

    CHECK_NOTHROW(dr.write(static_cast<const char *>(wb)));
}

TEST_CASE("write: write_one_small_string_to_dr")
{
    debug_ring dr(0);
    get_drr(0, &drr);

    auto small_wb = "01234";

    CHECK_NOTHROW(dr.write(static_cast<const char *>(small_wb)));
    CHECK(debug_ring_read(drr, static_cast<char *>(rb), DEBUG_RING_SIZE) == 5);
}

TEST_CASE("write: fill_dr")
{
    debug_ring dr(0);
    get_drr(0, &drr);

    init_wb(DEBUG_RING_SIZE - 1);

    CHECK_NOTHROW(dr.write(static_cast<const char *>(wb)));
    CHECK(debug_ring_read(drr, static_cast<char *>(rb), DEBUG_RING_SIZE) == DEBUG_RING_SIZE - 1);
    CHECK(rb[DEBUG_RING_SIZE - 1] == '\0');
}

TEST_CASE("write: overcommit_dr")
{
    debug_ring dr(0);
    get_drr(0, &drr);

    init_wb(DEBUG_RING_SIZE - 10, 'A');
    CHECK_NOTHROW(dr.write(static_cast<const char *>(wb)));

    init_wb(100, 'B');
    CHECK_NOTHROW(dr.write(static_cast<const char *>(wb)));

    CHECK(debug_ring_read(drr, static_cast<char *>(rb), DEBUG_RING_SIZE) == 100);
    CHECK(rb[0] == 'B');
}

TEST_CASE("write: overcommit_dr_more_than_once")
{
    debug_ring dr(0);
    get_drr(0, &drr);

    init_wb(DEBUG_RING_SIZE - 150, 'A');
    CHECK_NOTHROW(dr.write(static_cast<const char *>(wb)));

    init_wb(DEBUG_RING_SIZE - 150, 'B');
    CHECK_NOTHROW(dr.write(static_cast<const char *>(wb)));

    init_wb(DEBUG_RING_SIZE - 150, 'C');
    CHECK_NOTHROW(dr.write(static_cast<const char *>(wb)));

    CHECK(debug_ring_read(drr, static_cast<char *>(rb), DEBUG_RING_SIZE) == DEBUG_RING_SIZE - 150);
    CHECK(rb[0] == 'C');
}

TEST_CASE("debug_ring_read: read_with_empty_dr")
{
    debug_ring dr(0);
    get_drr(0, &drr);

    CHECK(debug_ring_read(drr, static_cast<char *>(rb), DEBUG_RING_SIZE) == 0);
}

TEST_CASE("write: acceptance_test_stress")
{
    debug_ring dr(0);
    get_drr(0, &drr);

    auto small_wb = "012";

    for (auto i = 0U; i < DEBUG_RING_SIZE; i++) {
        dr.write(static_cast<const char *>(small_wb));
    }

    // The total number of bytes that we read out, should be equal to
    // the total number of strings that can fit into the debug ring, minus
    // the '\0' for each string (as they are stripped).

    auto num = DEBUG_RING_SIZE / (strlen(static_cast<const char *>(small_wb)) + 1);
    auto total = num * strlen(static_cast<const char *>(small_wb));

    CHECK(debug_ring_read(drr, static_cast<char *>(rb), DEBUG_RING_SIZE) == total);
    CHECK(rb[0] == '0');
}