aboutsummaryrefslogtreecommitdiff
path: root/kernel/src/devices/block_device_utils.tests.cpp
blob: f78e4773f67854cf0f08cb930b78bf1bade7a914 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
#include "kernel/devices/block_device_utils.hpp"

#include "kernel/test_support/cpu.hpp"
#include "kernel/test_support/devices/block_device.hpp"
#include "kernel/test_support/devices/character_device.hpp"

#include <kstd/memory>
#include <kstd/print>
#include <kstd/vector>

#include <catch2/catch_test_macros.hpp>

#include <cstddef>
#include <cstdint>

SCENARIO("reading from a block device with block_device_utils", "[devices][block_device_utils]")
{
  GIVEN("a block device with known data")
  {
    auto const block_size = 512;
    auto device = kstd::make_shared<kernel::tests::devices::block_device>(0, 0, "test_block_device", block_size);
    kstd::vector<uint8_t> block_data(block_size);
    for (size_t i = 0; i < block_data.size(); ++i)
    {
      block_data[i] = static_cast<uint8_t>(i % 256);
    }
    device->write_block(0, block_data.data());
    device->write_block(1, block_data.data());

    WHEN("reading from the block device using block_device_utils")
    {
      kstd::vector<uint8_t> read_buffer(block_size);
      auto bytes_read = kernel::devices::block_device_utils::read(device, read_buffer.data(), 0, read_buffer.size());

      THEN("the correct number of bytes is read")
      {
        REQUIRE(bytes_read == read_buffer.size());
      }

      THEN("the data read matches the data written to the block device")
      {
        REQUIRE(read_buffer == block_data);
      }
    }

    WHEN("reading over block boundaries")
    {
      kstd::vector<uint8_t> read_buffer(1024);
      auto bytes_read = kernel::devices::block_device_utils::read(device, read_buffer.data(), 256, read_buffer.size());

      THEN("the correct number of bytes is read")
      {
        REQUIRE(bytes_read == 1.5 * block_size);
      }

      THEN("the data read matches the expected data across block boundaries")
      {
        for (size_t i = 0; i < bytes_read; ++i)
        {
          uint8_t expected_value = static_cast<uint8_t>((256 + i) % 256);
          REQUIRE(read_buffer[i] == expected_value);
        }
      }
    }

    WHEN("reading beyond the device capacity")
    {
      kstd::vector<uint8_t> read_buffer(block_size);
      auto bytes_read = kernel::devices::block_device_utils::read(device, read_buffer.data(), 1024, read_buffer.size());

      THEN("no bytes are read")
      {
        REQUIRE(bytes_read == 0);
      }
    }

    WHEN("reading nothing")
    {
      kstd::vector<uint8_t> read_buffer(block_size);
      auto bytes_read = kernel::devices::block_device_utils::read(device, read_buffer.data(), 0, 0);

      THEN("no bytes are read")
      {
        REQUIRE(bytes_read == 0);
      }
    }

    WHEN("reading with a null buffer")
    {
      THEN("the system panics")
      {
        REQUIRE_THROWS_AS(kernel::devices::block_device_utils::read(device, nullptr, 0, 512), kernel::tests::cpu::halt);
      }
    }
  }
}

SCENARIO("writing to a block device using block_device_utils", "[devices][block_device_utils]")
{
  GIVEN("a block device")
  {
    auto const block_size = 512;
    auto device =
        kstd::make_shared<kernel::tests::devices::block_device>(0, 0, "test_block_device", block_size, 2 * block_size);

    WHEN("writing to the block device using block_device_utils")
    {
      kstd::vector<uint8_t> write_buffer(block_size);
      for (size_t i = 0; i < write_buffer.size(); ++i)
      {
        write_buffer[i] = static_cast<uint8_t>(i % 256);
      }

      auto bytes_written =
          kernel::devices::block_device_utils::write(device, write_buffer.data(), 0, write_buffer.size());

      THEN("the correct number of bytes is written")
      {
        REQUIRE(bytes_written == write_buffer.size());
      }

      THEN("the data written matches the data read back from the block device")
      {
        kstd::vector<uint8_t> read_buffer(block_size);
        device->read_block(0, read_buffer.data());
        REQUIRE(read_buffer == write_buffer);
      }
    }

    WHEN("writing over block boundaries")
    {
      kstd::vector<uint8_t> write_buffer(2 * block_size);
      for (size_t i = 0; i < write_buffer.size(); ++i)
      {
        write_buffer[i] = static_cast<uint8_t>(i % 256);
      }

      auto bytes_written =
          kernel::devices::block_device_utils::write(device, write_buffer.data(), 256, write_buffer.size());

      THEN("the correct number of bytes is written")
      {
        REQUIRE(bytes_written == 1.5 * block_size);
      }

      THEN("the data written matches the data read back from the block device across block boundaries")
      {
        kstd::vector<uint8_t> read_buffer(2 * block_size);
        auto bytes_read = kernel::devices::block_device_utils::read(device, read_buffer.data(), 256, 2 * block_size);

        for (size_t i = 0; i < bytes_read; ++i)
        {
          REQUIRE(read_buffer[i] == write_buffer[i]);
        }
      }
    }

    WHEN("writing beyond the device capacity")
    {
      kstd::vector<uint8_t> write_buffer(block_size);
      auto bytes_written =
          kernel::devices::block_device_utils::write(device, write_buffer.data(), 1024, write_buffer.size());

      THEN("no bytes are written")
      {
        REQUIRE(bytes_written == 0);
      }
    }

    WHEN("writing nothing")
    {
      kstd::vector<uint8_t> write_buffer(block_size);
      auto bytes_written = kernel::devices::block_device_utils::write(device, write_buffer.data(), 0, 0);

      THEN("no bytes are written")
      {
        REQUIRE(bytes_written == 0);
      }
    }

    WHEN("writing with a null buffer")
    {
      THEN("the system panics")
      {
        REQUIRE_THROWS_AS(kernel::devices::block_device_utils::write(device, nullptr, 0, block_size),
                          kernel::tests::cpu::halt);
      }
    }
  }
}

SCENARIO("block_device_utils with a non-block device", "[devices][block_device_utils]")
{
  GIVEN("a non-block device")
  {
    auto device = kstd::make_shared<kernel::tests::devices::character_device>(0, 0, "test_character_device");

    WHEN("attempting to read from the non-block device using block_device_utils")
    {
      kstd::vector<uint8_t> read_buffer(512);
      THEN("the system panics")
      {
        REQUIRE_THROWS_AS(kernel::devices::block_device_utils::read(device, read_buffer.data(), 0, read_buffer.size()),
                          kernel::tests::cpu::halt);
      }
    }

    WHEN("attempting to write to the non-block device using block_device_utils")
    {
      kstd::vector<uint8_t> write_buffer(512);
      THEN("the system panics")
      {
        REQUIRE_THROWS_AS(
            kernel::devices::block_device_utils::write(device, write_buffer.data(), 0, write_buffer.size()),
            kernel::tests::cpu::halt);
      }
    }
  }
}