pw_allocator/block_test.cc

// Copyright 2020 The Pigweed Authors
//
// Licensed 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
//
//     https://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 "pw_allocator/block.h"

#include <cstring>
#include <span>

#include "gtest/gtest.h"

using std::byte;

namespace pw::allocator {

TEST(Block, CanCreateSingleBlock) {
  constexpr size_t kN = 200;
  alignas(Block*) byte bytes[kN];

  Block* block = nullptr;
  auto status = Block::Init(std::span(bytes, kN), &block);

  ASSERT_EQ(status, OkStatus());
  EXPECT_EQ(block->OuterSize(), kN);
  EXPECT_EQ(block->InnerSize(),
            kN - sizeof(Block) - 2 * PW_ALLOCATOR_POISON_OFFSET);
  EXPECT_EQ(block->Prev(), nullptr);
  EXPECT_EQ(block->Next(), (Block*)((uintptr_t)block + kN));
  EXPECT_EQ(block->Used(), false);
  EXPECT_EQ(block->Last(), true);
}

TEST(Block, CannotCreateUnalignedSingleBlock) {
  constexpr size_t kN = 1024;

  // Force alignment, so we can un-force it below
  alignas(Block*) byte bytes[kN];
  byte* byte_ptr = bytes;

  Block* block = nullptr;
  auto status = Block::Init(std::span(byte_ptr + 1, kN - 1), &block);

  EXPECT_EQ(status, Status::InvalidArgument());
}

TEST(Block, CannotCreateTooSmallBlock) {
  constexpr size_t kN = 2;
  alignas(Block*) byte bytes[kN];
  Block* block = nullptr;
  auto status = Block::Init(std::span(bytes, kN), &block);

  EXPECT_EQ(status, Status::InvalidArgument());
}

TEST(Block, CanSplitBlock) {
  constexpr size_t kN = 1024;
  constexpr size_t kSplitN = 512;
  alignas(Block*) byte bytes[kN];

  Block* block = nullptr;
  EXPECT_EQ(Block::Init(std::span(bytes, kN), &block), OkStatus());

  Block* next_block = nullptr;
  auto status = block->Split(kSplitN, &next_block);

  ASSERT_EQ(status, OkStatus());
  EXPECT_EQ(block->InnerSize(), kSplitN);
  EXPECT_EQ(block->OuterSize(),
            kSplitN + sizeof(Block) + 2 * PW_ALLOCATOR_POISON_OFFSET);
  EXPECT_EQ(block->Last(), false);

  EXPECT_EQ(next_block->OuterSize(),
            kN - kSplitN - sizeof(Block) - 2 * PW_ALLOCATOR_POISON_OFFSET);
  EXPECT_EQ(next_block->Used(), false);
  EXPECT_EQ(next_block->Last(), true);

  EXPECT_EQ(block->Next(), next_block);
  EXPECT_EQ(next_block->Prev(), block);
}

TEST(Block, CanSplitBlockUnaligned) {
  constexpr size_t kN = 1024;
  constexpr size_t kSplitN = 513;

  alignas(Block*) byte bytes[kN];

  // We should split at sizeof(Block) + kSplitN bytes. Then
  // we need to round that up to an alignof(Block*) boundary.
  uintptr_t split_addr = ((uintptr_t)&bytes) + kSplitN;
  split_addr += alignof(Block*) - (split_addr % alignof(Block*));
  uintptr_t split_len = split_addr - (uintptr_t)&bytes;

  Block* block = nullptr;
  EXPECT_EQ(Block::Init(std::span(bytes, kN), &block), OkStatus());

  Block* next_block = nullptr;
  auto status = block->Split(kSplitN, &next_block);

  ASSERT_EQ(status, OkStatus());
  EXPECT_EQ(block->InnerSize(), split_len);
  EXPECT_EQ(block->OuterSize(),
            split_len + sizeof(Block) + 2 * PW_ALLOCATOR_POISON_OFFSET);
  EXPECT_EQ(next_block->OuterSize(),
            kN - split_len - sizeof(Block) - 2 * PW_ALLOCATOR_POISON_OFFSET);
  EXPECT_EQ(next_block->Used(), false);
  EXPECT_EQ(block->Next(), next_block);
  EXPECT_EQ(next_block->Prev(), block);
}

TEST(Block, CanSplitMidBlock) {
  // Split once, then split the original block again to ensure that the
  // pointers get rewired properly.
  // I.e.
  // [[             BLOCK 1            ]]
  // block1->Split()
  // [[       BLOCK1       ]][[ BLOCK2 ]]
  // block1->Split()
  // [[ BLOCK1 ]][[ BLOCK3 ]][[ BLOCK2 ]]

  constexpr size_t kN = 1024;
  constexpr size_t kSplit1 = 512;
  constexpr size_t kSplit2 = 256;
  alignas(Block*) byte bytes[kN];

  Block* block = nullptr;
  EXPECT_EQ(Block::Init(std::span(bytes, kN), &block), OkStatus());

  Block* block2 = nullptr;
  block->Split(kSplit1, &block2)
      .IgnoreError();  // TODO(pwbug/387): Handle Status properly

  Block* block3 = nullptr;
  block->Split(kSplit2, &block3)
      .IgnoreError();  // TODO(pwbug/387): Handle Status properly

  EXPECT_EQ(block->Next(), block3);
  EXPECT_EQ(block3->Next(), block2);
  EXPECT_EQ(block2->Prev(), block3);
  EXPECT_EQ(block3->Prev(), block);
}

TEST(Block, CannotSplitBlockWithoutHeaderSpace) {
  constexpr size_t kN = 1024;
  constexpr size_t kSplitN =
      kN - sizeof(Block) - 2 * PW_ALLOCATOR_POISON_OFFSET - 1;
  alignas(Block*) byte bytes[kN];

  Block* block = nullptr;
  EXPECT_EQ(Block::Init(std::span(bytes, kN), &block), OkStatus());

  Block* next_block = nullptr;
  auto status = block->Split(kSplitN, &next_block);

  EXPECT_EQ(status, Status::ResourceExhausted());
  EXPECT_EQ(next_block, nullptr);
}

TEST(Block, MustProvideNextBlockPointer) {
  constexpr size_t kN = 1024;
  constexpr size_t kSplitN = kN - sizeof(Block) - 1;
  alignas(Block*) byte bytes[kN];

  Block* block = nullptr;
  EXPECT_EQ(Block::Init(std::span(bytes, kN), &block), OkStatus());

  auto status = block->Split(kSplitN, nullptr);
  EXPECT_EQ(status, Status::InvalidArgument());
}

TEST(Block, CannotMakeBlockLargerInSplit) {
  // Ensure that we can't ask for more space than the block actually has...
  constexpr size_t kN = 1024;
  alignas(Block*) byte bytes[kN];

  Block* block = nullptr;
  EXPECT_EQ(Block::Init(std::span(bytes, kN), &block), OkStatus());

  Block* next_block = nullptr;
  auto status = block->Split(block->InnerSize() + 1, &next_block);

  EXPECT_EQ(status, Status::OutOfRange());
}

TEST(Block, CannotMakeSecondBlockLargerInSplit) {
  // Ensure that the second block in split is at least of the size of header.
  constexpr size_t kN = 1024;
  alignas(Block*) byte bytes[kN];

  Block* block = nullptr;
  EXPECT_EQ(Block::Init(std::span(bytes, kN), &block), OkStatus());

  Block* next_block = nullptr;
  auto status = block->Split(
      block->InnerSize() - sizeof(Block) - 2 * PW_ALLOCATOR_POISON_OFFSET + 1,
      &next_block);

  ASSERT_EQ(status, Status::ResourceExhausted());
  EXPECT_EQ(next_block, nullptr);
}

TEST(Block, CanMakeZeroSizeFirstBlock) {
  // This block does support splitting with zero payload size.
  constexpr size_t kN = 1024;
  alignas(Block*) byte bytes[kN];

  Block* block = nullptr;
  EXPECT_EQ(Block::Init(std::span(bytes, kN), &block), OkStatus());

  Block* next_block = nullptr;
  auto status = block->Split(0, &next_block);

  ASSERT_EQ(status, OkStatus());
  EXPECT_EQ(block->InnerSize(), static_cast<size_t>(0));
}

TEST(Block, CanMakeZeroSizeSecondBlock) {
  // Likewise, the split block can be zero-width.
  constexpr size_t kN = 1024;
  alignas(Block*) byte bytes[kN];

  Block* block = nullptr;
  EXPECT_EQ(Block::Init(std::span(bytes, kN), &block), OkStatus());

  Block* next_block = nullptr;
  auto status = block->Split(
      block->InnerSize() - sizeof(Block) - 2 * PW_ALLOCATOR_POISON_OFFSET,
      &next_block);

  ASSERT_EQ(status, OkStatus());
  EXPECT_EQ(next_block->InnerSize(), static_cast<size_t>(0));
}

TEST(Block, CanMarkBlockUsed) {
  constexpr size_t kN = 1024;
  alignas(Block*) byte bytes[kN];

  Block* block = nullptr;
  EXPECT_EQ(Block::Init(std::span(bytes, kN), &block), OkStatus());

  block->MarkUsed();
  EXPECT_EQ(block->Used(), true);

  // Mark used packs that data into the next pointer. Check that it's still
  // valid
  EXPECT_EQ(block->Next(), (Block*)((uintptr_t)block + kN));

  block->MarkFree();
  EXPECT_EQ(block->Used(), false);
}

TEST(Block, CannotSplitUsedBlock) {
  constexpr size_t kN = 1024;
  alignas(Block*) byte bytes[kN];

  Block* block = nullptr;
  EXPECT_EQ(Block::Init(std::span(bytes, kN), &block), OkStatus());

  block->MarkUsed();

  Block* next_block = nullptr;
  auto status = block->Split(512, &next_block);
  EXPECT_EQ(status, Status::FailedPrecondition());
}

TEST(Block, CanMergeWithNextBlock) {
  // Do the three way merge from "CanSplitMidBlock", and let's
  // merge block 3 and 2
  constexpr size_t kN = 1024;
  constexpr size_t kSplit1 = 512;
  constexpr size_t kSplit2 = 256;
  alignas(Block*) byte bytes[kN];

  Block* block = nullptr;
  EXPECT_EQ(Block::Init(std::span(bytes, kN), &block), OkStatus());

  Block* block2 = nullptr;
  block->Split(kSplit1, &block2)
      .IgnoreError();  // TODO(pwbug/387): Handle Status properly

  Block* block3 = nullptr;
  block->Split(kSplit2, &block3)
      .IgnoreError();  // TODO(pwbug/387): Handle Status properly

  EXPECT_EQ(block3->MergeNext(), OkStatus());

  EXPECT_EQ(block->Next(), block3);
  EXPECT_EQ(block3->Prev(), block);
  EXPECT_EQ(block->InnerSize(), kSplit2);

  // The resulting "right hand" block should have an outer size of 1024 - 256 -
  // sizeof(Block) - 2*PW_ALLOCATOR_POISON_OFFSET, which accounts for the first
  // block.
  EXPECT_EQ(block3->OuterSize(),
            kN - kSplit2 - sizeof(Block) - 2 * PW_ALLOCATOR_POISON_OFFSET);
}

TEST(Block, CannotMergeWithFirstOrLastBlock) {
  constexpr size_t kN = 1024;
  alignas(Block*) byte bytes[kN];

  // Do a split, just to check that the checks on Next/Prev are
  // different...
  Block* block = nullptr;
  EXPECT_EQ(Block::Init(std::span(bytes, kN), &block), OkStatus());

  Block* next_block = nullptr;
  block->Split(512, &next_block)
      .IgnoreError();  // TODO(pwbug/387): Handle Status properly

  EXPECT_EQ(next_block->MergeNext(), Status::OutOfRange());
  EXPECT_EQ(block->MergePrev(), Status::OutOfRange());
}

TEST(Block, CannotMergeUsedBlock) {
  constexpr size_t kN = 1024;
  alignas(Block*) byte bytes[kN];

  // Do a split, just to check that the checks on Next/Prev are
  // different...
  Block* block = nullptr;
  EXPECT_EQ(Block::Init(std::span(bytes, kN), &block), OkStatus());

  Block* next_block = nullptr;
  block->Split(512, &next_block)
      .IgnoreError();  // TODO(pwbug/387): Handle Status properly

  block->MarkUsed();
  EXPECT_EQ(block->MergeNext(), Status::FailedPrecondition());
  EXPECT_EQ(next_block->MergePrev(), Status::FailedPrecondition());
}

TEST(Block, CanCheckValidBlock) {
  constexpr size_t kN = 1024;
  alignas(Block*) byte bytes[kN];

  Block* first_block = nullptr;
  EXPECT_EQ(Block::Init(std::span(bytes, kN), &first_block), OkStatus());

  Block* second_block = nullptr;
  first_block->Split(512, &second_block)
      .IgnoreError();  // TODO(pwbug/387): Handle Status properly

  Block* third_block = nullptr;
  second_block->Split(256, &third_block)
      .IgnoreError();  // TODO(pwbug/387): Handle Status properly

  EXPECT_EQ(first_block->IsValid(), true);
  EXPECT_EQ(second_block->IsValid(), true);
  EXPECT_EQ(third_block->IsValid(), true);
}

TEST(Block, CanCheckInalidBlock) {
  constexpr size_t kN = 1024;
  alignas(Block*) byte bytes[kN];

  Block* first_block = nullptr;
  EXPECT_EQ(Block::Init(std::span(bytes, kN), &first_block), OkStatus());

  Block* second_block = nullptr;
  first_block->Split(512, &second_block)
      .IgnoreError();  // TODO(pwbug/387): Handle Status properly

  Block* third_block = nullptr;
  second_block->Split(256, &third_block)
      .IgnoreError();  // TODO(pwbug/387): Handle Status properly

  Block* fourth_block = nullptr;
  third_block->Split(128, &fourth_block)
      .IgnoreError();  // TODO(pwbug/387): Handle Status properly

  std::byte* next_ptr = reinterpret_cast<std::byte*>(first_block);
  memcpy(next_ptr, second_block, sizeof(void*));
  EXPECT_EQ(first_block->IsValid(), false);
  EXPECT_EQ(second_block->IsValid(), false);
  EXPECT_EQ(third_block->IsValid(), true);
  EXPECT_EQ(fourth_block->IsValid(), true);

#if defined(PW_ALLOCATOR_POISON_ENABLE) && PW_ALLOCATOR_POISON_ENABLE
  std::byte fault_poison[PW_ALLOCATOR_POISON_OFFSET] = {std::byte(0)};
  std::byte* front_poison =
      reinterpret_cast<std::byte*>(third_block) + sizeof(*third_block);
  memcpy(front_poison, fault_poison, PW_ALLOCATOR_POISON_OFFSET);
  EXPECT_EQ(third_block->IsValid(), false);

  std::byte* end_poison =
      reinterpret_cast<std::byte*>(fourth_block) + sizeof(*fourth_block);
  memcpy(end_poison, fault_poison, PW_ALLOCATOR_POISON_OFFSET);
  EXPECT_EQ(fourth_block->IsValid(), false);
#endif  // PW_ALLOCATOR_POISON_ENABLE
}

TEST(Block, CanPoisonBlock) {
#if defined(PW_ALLOCATOR_POISON_ENABLE) && PW_ALLOCATOR_POISON_ENABLE
  constexpr size_t kN = 1024;
  alignas(Block*) byte bytes[kN];

  Block* first_block = nullptr;
  EXPECT_EQ(Block::Init(std::span(bytes, kN), &first_block), OkStatus());

  Block* second_block = nullptr;
  first_block->Split(512, &second_block)
      .IgnoreError();  // TODO(pwbug/387): Handle Status properly

  Block* third_block = nullptr;
  second_block->Split(256, &third_block)
      .IgnoreError();  // TODO(pwbug/387): Handle Status properly

  EXPECT_EQ(first_block->IsValid(), true);
  EXPECT_EQ(second_block->IsValid(), true);
  EXPECT_EQ(third_block->IsValid(), true);
#endif  // PW_ALLOCATOR_POISON_ENABLE
}

}  // namespace pw::allocator