src/camera/drivers/hw_accel/gdc/gdc_task_unittest.cc

// Copyright 2019 The Fuchsia Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#include <fidl/fuchsia.sysmem/cpp/wire.h>
#include <lib/ddk/debug.h>
#include <lib/fake-bti/bti.h>
#include <lib/mmio/mmio.h>
#include <lib/zbi-format/graphics.h>

#include <condition_variable>
#include <memory>
#include <mutex>
#include <utility>
#include <vector>

#include <mock-mmio-reg/mock-mmio-reg.h>
#include <zxtest/zxtest.h>

#include "src/camera/drivers/hw_accel/gdc/gdc.h"
#include "src/camera/drivers/hw_accel/gdc/gdc_regs.h"
#include "src/camera/drivers/hw_accel/task/task.h"
#include "src/camera/drivers/test_utils/fake_buffer_collection.h"
#include "src/lib/fsl/handles/object_info.h"

namespace gdc {
namespace {

constexpr uint32_t kWidth = 1080;
constexpr uint32_t kHeight = 764;
constexpr uint32_t kNumberOfBuffers = 5;
constexpr uint32_t kNumberOfMmios = 50;
constexpr uint32_t kConfigSize = 10000;
constexpr uint32_t kMaxTasks = 10;
constexpr uint32_t kImageFormatTableSize = 8;

template <typename T>
ddk_mock::MockMmioReg& GetMockReg(ddk_mock::MockMmioRegRegion& registers) {
  return registers[T::Get().addr()];
}

void CreateContiguousConfigVmos(const zx::bti& bti_handle, uint32_t vmo_size, uint32_t vmo_count,
                                std::stack<zx::vmo>& config_contig_vmos) {
  for (uint32_t i = 0; i < vmo_count; i++) {
    zx::vmo vmo;
    EXPECT_OK(zx::vmo::create_contiguous(bti_handle, vmo_size, 0, &vmo));
    config_contig_vmos.push(std::move(vmo));
  }
}

// Integration test for the driver defined in //src/camera/drivers/hw_accel/gdc
class TaskTest : public zxtest::Test {
 public:
  void ProcessFrameCallback(uint32_t input_buffer_index, uint32_t output_buffer_index,
                            frame_status_t status, uint64_t capture_timestamp) {
    std::lock_guard al(lock_);
    callback_check_.emplace_back(input_buffer_index, output_buffer_index, capture_timestamp);
    frame_ready_ = true;
    event_.notify_one();
    if (status != FRAME_STATUS_OK) {
      frame_status_error_ = true;
    }
  }

  void ResChangeCallback() {
    std::lock_guard al(lock_);
    frame_ready_ = true;
    event_.notify_one();
  }

  void RemoveTaskCallback(task_remove_status_t status) {
    std::lock_guard al(lock_);
    frame_removed_ = true;
    frame_status_error_ = status;
    remove_task_event_.notify_one();
  }

  void WaitAndReset() {
    std::lock_guard al(lock_);
    while (frame_ready_ == false) {
      event_.wait(lock_);
    }
    frame_ready_ = false;
  }

  void WaitForRemoveTaskAndReset() {
    std::lock_guard al(lock_);
    while (frame_removed_ == false) {
      remove_task_event_.wait(lock_);
    }
    frame_removed_ = false;
  }

  uint32_t GetCallbackSize() {
    std::lock_guard al(lock_);
    return static_cast<uint32_t>(callback_check_.size());
  }

  uint32_t GetCallbackBackOutputBufferIndex() {
    std::lock_guard al(lock_);
    return std::get<1>(callback_check_.back());
  }

  uint32_t GetCallbackBackInputBufferIndex() {
    std::lock_guard al(lock_);
    return std::get<0>(callback_check_.back());
  }

  uint64_t GetCallbackBackCaptureTimestamp() {
    std::lock_guard al(lock_);
    return std::get<2>(callback_check_.back());
  }

 protected:
  void SetUpBufferCollections(uint32_t buffer_collection_count) {
    frame_ready_ = false;
    ASSERT_OK(fake_bti_create(bti_handle_.reset_and_get_address()));
    ASSERT_OK(camera::GetImageFormat(input_image_format_,
                                     fidl::ToUnderlying(fuchsia_sysmem::PixelFormatType::kNv12),
                                     kWidth, kHeight));
    ASSERT_OK(camera::GetImageFormat(output_image_format_table_[0],
                                     fidl::ToUnderlying(fuchsia_sysmem::PixelFormatType::kNv12),
                                     kWidth, kHeight));
    ASSERT_OK(camera::GetImageFormat(output_image_format_table_[1],
                                     fidl::ToUnderlying(fuchsia_sysmem::PixelFormatType::kNv12),
                                     kWidth, kHeight));
    ASSERT_OK(camera::GetImageFormat(output_image_format_table_[2],
                                     fidl::ToUnderlying(fuchsia_sysmem::PixelFormatType::kNv12),
                                     kWidth, kHeight));
    zx_status_t status = camera::CreateContiguousBufferCollectionInfo(
        input_buffer_collection_, input_image_format_, bti_handle_.get(), buffer_collection_count);
    ASSERT_OK(status);

    status = camera::CreateContiguousBufferCollectionInfo(
        output_buffer_collection_, output_image_format_table_[0], bti_handle_.get(),
        buffer_collection_count);
    ASSERT_OK(status);

    zx::vmo config_vmo;
    status = zx_vmo_create_contiguous(bti_handle_.get(), kConfigSize, 0,
                                      config_vmo.reset_and_get_address());

    config_info_.config_vmo = config_vmo.release();
    config_info_.size = kConfigSize;
    ASSERT_OK(status);

    CreateContiguousConfigVmos(bti_handle_, kConfigSize, kImageFormatTableSize + kMaxTasks,
                               config_contig_vmos_);
  }

  // Sets up GdcDevice, initialize a task.
  // Returns a task id.
  uint32_t SetupForFrameProcessing(ddk_mock::MockMmioRegRegion& fake_regs) {
    SetUpBufferCollections(kNumberOfBuffers);

    zx::port port;
    EXPECT_OK(zx::port::create(ZX_PORT_BIND_TO_INTERRUPT, &port));

    frame_callback_.frame_ready = [](void* ctx, const frame_available_info* info) {
      EXPECT_EQ(static_cast<TaskTest*>(ctx)->output_image_format_index_,
                info->metadata.image_format_index);
      return static_cast<TaskTest*>(ctx)->ProcessFrameCallback(info->metadata.input_buffer_index,
                                                               info->buffer_id, info->frame_status,
                                                               info->metadata.capture_timestamp);
    };
    frame_callback_.ctx = this;

    res_callback_.frame_resolution_changed = [](void* ctx, const frame_available_info* info) {
      EXPECT_EQ(static_cast<TaskTest*>(ctx)->output_image_format_index_,
                info->metadata.image_format_index);
      return static_cast<TaskTest*>(ctx)->ResChangeCallback();
    };
    res_callback_.ctx = this;

    remove_task_callback_.task_removed = [](void* ctx, task_remove_status_t status) {
      return static_cast<TaskTest*>(ctx)->RemoveTaskCallback(status);
    };
    remove_task_callback_.ctx = this;

    EXPECT_OK(zx::interrupt::create(zx::resource(), 0, ZX_INTERRUPT_VIRTUAL, &irq_));
    EXPECT_OK(port.duplicate(ZX_RIGHT_SAME_RIGHTS, &port_));

    zx::interrupt irq;
    EXPECT_OK(irq_.duplicate(ZX_RIGHT_SAME_RIGHTS, &irq));

    gdc_device_ = std::make_unique<GdcDevice>(nullptr, fdf::MmioBuffer(fake_regs.GetMmioBuffer()),
                                              fdf::MmioBuffer(fake_regs.GetMmioBuffer()),
                                              std::move(config_contig_vmos_), std::move(irq),
                                              std::move(bti_handle_), std::move(port));

    gdc_config_info config_vmo_info_array[kImageFormatTableSize];
    uint32_t task_id;

    for (uint32_t i = 0; i < kImageFormatTableSize; i++) {
      EXPECT_OK(zx_handle_duplicate(config_info_.config_vmo, ZX_RIGHT_SAME_RIGHTS,
                                    &config_vmo_info_array[i].config_vmo));
      config_vmo_info_array[i].size = kConfigSize;
    }

    zx_status_t status = gdc_device_->GdcInitTask(
        &input_buffer_collection_, &output_buffer_collection_, &input_image_format_,
        output_image_format_table_, kImageFormatTableSize, 0,
        reinterpret_cast<gdc_config_info*>(&config_vmo_info_array), kImageFormatTableSize,
        &frame_callback_, &res_callback_, &remove_task_callback_, &task_id);
    EXPECT_OK(status);
    output_image_format_index_ = 0;

    // Start the thread.
    EXPECT_OK(gdc_device_->StartThread());

    return task_id;
  }

  void SetExpectations(ddk_mock::MockMmioRegRegion& fake_regs) {
    GetMockReg<Config>(fake_regs).ExpectWrite(0).ExpectWrite(0).ExpectWrite(1);

    GetMockReg<ConfigAddr>(fake_regs).ExpectWrite();
    GetMockReg<ConfigSize>(fake_regs).ExpectWrite();

    GetMockReg<DataInWidth>(fake_regs).ExpectWrite(input_image_format_.display_width);
    GetMockReg<DataInHeight>(fake_regs).ExpectWrite(input_image_format_.display_height);
    GetMockReg<DataOutWidth>(fake_regs).ExpectWrite(output_image_format_table_[0].display_width);
    GetMockReg<DataOutHeight>(fake_regs).ExpectWrite(output_image_format_table_[0].display_height);

    GetMockReg<Data1InAddr>(fake_regs).ExpectWrite();
    GetMockReg<Data1InOffset>(fake_regs).ExpectWrite(input_image_format_.bytes_per_row);

    GetMockReg<Data2InAddr>(fake_regs).ExpectWrite();
    GetMockReg<Data2InOffset>(fake_regs).ExpectWrite(input_image_format_.bytes_per_row);

    GetMockReg<Data1OutAddr>(fake_regs).ExpectWrite();
    GetMockReg<Data1OutOffset>(fake_regs).ExpectWrite(output_image_format_table_[0].bytes_per_row);
    GetMockReg<Data2OutAddr>(fake_regs).ExpectWrite();
    GetMockReg<Data2OutOffset>(fake_regs).ExpectWrite(output_image_format_table_[0].bytes_per_row);
  }

  void TearDown() override {
    zx_handle_close(config_info_.config_vmo);

    camera::DestroyContiguousBufferCollection(input_buffer_collection_);
    camera::DestroyContiguousBufferCollection(output_buffer_collection_);
  }

  zx::bti bti_handle_;
  zx::port port_;
  zx::interrupt irq_;
  hw_accel_frame_callback_t frame_callback_;
  hw_accel_res_change_callback_t res_callback_;
  hw_accel_remove_task_callback_t remove_task_callback_;
  buffer_collection_info_2_t input_buffer_collection_;
  buffer_collection_info_2_t output_buffer_collection_;
  image_format_2_t input_image_format_;
  // Array of output Image formats.
  image_format_2_t output_image_format_table_[kImageFormatTableSize];
  std::unique_ptr<GdcDevice> gdc_device_;
  uint32_t output_image_format_index_;
  gdc_config_info config_info_;
  std::stack<zx::vmo> config_contig_vmos_;
  bool frame_status_error_ = false;

 private:
  std::vector<std::tuple<uint32_t, uint32_t, uint64_t>> callback_check_;
  bool frame_ready_;
  bool frame_removed_;
  std::mutex lock_;
  std::condition_variable_any event_;
  std::condition_variable_any remove_task_event_ __TA_GUARDED(lock_);
};

TEST_F(TaskTest, BasicCreationTest) {
  SetUpBufferCollections(kNumberOfBuffers);
  auto task = std::make_unique<GdcTask>();
  zx_status_t status =
      task->Init(&input_buffer_collection_, &output_buffer_collection_, &input_image_format_,
                 output_image_format_table_, 1, 0, &config_info_, 1, config_contig_vmos_,
                 &frame_callback_, &res_callback_, &remove_task_callback_, bti_handle_);
  EXPECT_OK(status);
}

TEST_F(TaskTest, InvalidFormatTest) {
  SetUpBufferCollections(kNumberOfBuffers);
  image_format_2_t format;
  EXPECT_OK(camera::GetImageFormat(
      format, fidl::ToUnderlying(fuchsia_sysmem::PixelFormatType::kNv12), kWidth, kHeight));
  format.pixel_format.type = ZBI_PIXEL_FORMAT_MONO_8;
  auto task = std::make_unique<GdcTask>();
  EXPECT_EQ(ZX_ERR_INVALID_ARGS,
            task->Init(&input_buffer_collection_, &output_buffer_collection_, &format,
                       output_image_format_table_, 1, 0, &config_info_, 1, config_contig_vmos_,
                       &frame_callback_, &res_callback_, &remove_task_callback_, bti_handle_));
}

TEST_F(TaskTest, InputBufferTest) {
  SetUpBufferCollections(kNumberOfBuffers);
  auto task = std::make_unique<GdcTask>();
  auto status =
      task->Init(&input_buffer_collection_, &output_buffer_collection_, &input_image_format_,
                 output_image_format_table_, 1, 0, &config_info_, 1, config_contig_vmos_,
                 &frame_callback_, &res_callback_, &remove_task_callback_, bti_handle_);
  EXPECT_OK(status);

  // Get the input buffers physical addresses
  // Request for physical addresses of the buffers.
  // Expecting to get error when requesting for invalid index.
  zx_paddr_t addr;
  for (uint32_t i = 0; i < kNumberOfBuffers; i++) {
    EXPECT_OK(task->GetInputBufferPhysAddr(0, &addr));
  }

  EXPECT_EQ(ZX_ERR_INVALID_ARGS, task->GetInputBufferPhysAddr(kNumberOfBuffers, &addr));
}

TEST_F(TaskTest, InvalidVmoAndOutputFormatCountTest) {
  SetUpBufferCollections(kNumberOfBuffers);
  auto task = std::make_unique<GdcTask>();
  auto status = task->Init(&input_buffer_collection_, &output_buffer_collection_,
                           &input_image_format_, output_image_format_table_, kImageFormatTableSize,
                           0, &config_info_, 1, config_contig_vmos_, &frame_callback_,
                           &res_callback_, &remove_task_callback_, bti_handle_);
  EXPECT_EQ(status, ZX_ERR_INVALID_ARGS);
}

TEST_F(TaskTest, InvalidVmoTest) {
  SetUpBufferCollections(0);
  auto task = std::make_unique<GdcTask>();
  auto status =
      task->Init(&input_buffer_collection_, &output_buffer_collection_, &input_image_format_,
                 output_image_format_table_, 1, 0, &config_info_, 1, config_contig_vmos_,
                 &frame_callback_, &res_callback_, &remove_task_callback_, bti_handle_);
  // Expecting Task setup to be returning an error when there are
  // no VMOs in the buffer collection. At the moment VmoPool library
  // doesn't return an error.
  EXPECT_EQ(ZX_ERR_INVALID_ARGS, status);
}

TEST_F(TaskTest, InitTaskTest) {
  ddk_mock::MockMmioRegRegion fake_regs(sizeof(uint32_t), kNumberOfMmios);

  [[maybe_unused]] auto task_id = SetupForFrameProcessing(fake_regs);

  std::vector<uint32_t> received_ids;
  for (uint32_t i = 0; i < kMaxTasks; i++) {
    uint32_t task_id;
    zx_status_t status = gdc_device_->GdcInitTask(
        &input_buffer_collection_, &output_buffer_collection_, &input_image_format_,
        output_image_format_table_, 1, 0, &config_info_, 1, &frame_callback_, &res_callback_,
        &remove_task_callback_, &task_id);
    EXPECT_OK(status);
    // Checking to see if we are getting unique task ids.
    auto entry = find(received_ids.begin(), received_ids.end(), task_id);
    EXPECT_EQ(received_ids.end(), entry);
    received_ids.push_back(task_id);
  }
}

TEST_F(TaskTest, RemoveTaskTest) {
  ddk_mock::MockMmioRegRegion fake_regs(sizeof(uint32_t), kNumberOfMmios);

  auto task_id = SetupForFrameProcessing(fake_regs);

  // Posting a task for frame processing.
  zx_status_t status = gdc_device_->GdcProcessFrame(task_id, kNumberOfBuffers - 1, 0);
  EXPECT_OK(status);

  // Posting a task to remove task.
  ASSERT_NO_DEATH(([this, task_id]() { gdc_device_->GdcRemoveTask(task_id); }));

  // Trigger the interrupt manually.
  zx_port_packet packet = {kPortKeyDebugFakeInterrupt, ZX_PKT_TYPE_USER, ZX_OK, {}};
  EXPECT_OK(port_.queue(&packet));

  // Expecting the task for frame processing to be completed first.
  // Check if the callback was called.
  WaitAndReset();
  EXPECT_EQ(1, GetCallbackSize());

  // Wait for the callback.
  WaitForRemoveTaskAndReset();
  EXPECT_EQ(frame_status_error_, TASK_REMOVE_STATUS_OK);
}

TEST_F(TaskTest, ProcessInvalidFrameTest) {
  ddk_mock::MockMmioRegRegion fake_regs(sizeof(uint32_t), kNumberOfMmios);

  [[maybe_unused]] auto task_id = SetupForFrameProcessing(fake_regs);

  // Invalid task id.
  zx_status_t status = gdc_device_->GdcProcessFrame(0xFF, 0, 0);
  EXPECT_EQ(ZX_ERR_INVALID_ARGS, status);
}

TEST_F(TaskTest, InvalidBufferProcessFrameTest) {
  ddk_mock::MockMmioRegRegion fake_regs(sizeof(uint32_t), kNumberOfMmios);

  [[maybe_unused]] auto task_id = SetupForFrameProcessing(fake_regs);

  // Invalid buffer id.
  zx_status_t status = gdc_device_->GdcProcessFrame(task_id, kNumberOfBuffers, 0);
  EXPECT_EQ(ZX_ERR_INVALID_ARGS, status);
}

TEST_F(TaskTest, ProcessFrameTest) {
  ddk_mock::MockMmioRegRegion fake_regs(sizeof(uint32_t), kNumberOfMmios);

  auto task_id = SetupForFrameProcessing(fake_regs);

  SetExpectations(fake_regs);

  // Valid buffer & task id.
  constexpr uint64_t kCaptureTimestamp = 42;
  zx_status_t status =
      gdc_device_->GdcProcessFrame(task_id, kNumberOfBuffers - 1, kCaptureTimestamp);
  EXPECT_OK(status);

  // Trigger the interrupt manually.
  zx_port_packet packet = {kPortKeyDebugFakeInterrupt, ZX_PKT_TYPE_USER, ZX_OK, {}};
  EXPECT_OK(port_.queue(&packet));

  // Check if the callback was called.
  WaitAndReset();
  ASSERT_EQ(1, GetCallbackSize());
  EXPECT_EQ(GetCallbackBackCaptureTimestamp(), kCaptureTimestamp);

  fake_regs.VerifyAll();
}

TEST_F(TaskTest, SetOutputResTest) {
  ddk_mock::MockMmioRegRegion fake_regs(sizeof(uint32_t), kNumberOfMmios);

  auto task_id = SetupForFrameProcessing(fake_regs);

  SetExpectations(fake_regs);

  output_image_format_index_ = 2;
  zx_status_t status = gdc_device_->GdcSetOutputResolution(task_id, 2);
  EXPECT_OK(status);
  WaitAndReset();

  // Valid buffer & task id.
  status = gdc_device_->GdcProcessFrame(task_id, kNumberOfBuffers - 1, 0);
  EXPECT_OK(status);

  // Trigger the interrupt manually.
  zx_port_packet packet = {kPortKeyDebugFakeInterrupt, ZX_PKT_TYPE_USER, ZX_OK, {}};
  EXPECT_OK(port_.queue(&packet));

  // Check if the callback was called.
  // The callback checks that the index of the output format returned matches
  // what we set it to above.
  WaitAndReset();
  EXPECT_EQ(1, GetCallbackSize());
  EXPECT_FALSE(frame_status_error_);

  fake_regs.VerifyAll();
}

TEST_F(TaskTest, ReleaseValidFrameTest) {
  ddk_mock::MockMmioRegRegion fake_regs(sizeof(uint32_t), kNumberOfMmios);

  auto task_id = SetupForFrameProcessing(fake_regs);

  // Valid buffer & task id.
  zx_status_t status = gdc_device_->GdcProcessFrame(task_id, kNumberOfBuffers - 1, 0);
  EXPECT_OK(status);

  // Trigger the interrupt manually.
  zx_port_packet packet = {kPortKeyDebugFakeInterrupt, ZX_PKT_TYPE_USER, ZX_OK, {}};
  EXPECT_OK(port_.queue(&packet));

  // Check if the callback was called.
  WaitAndReset();
  EXPECT_EQ(1, GetCallbackSize());
  EXPECT_FALSE(frame_status_error_);

  // Release the output buffer index provided as callback.
  ASSERT_NO_DEATH(([this, task_id]() {
    gdc_device_->GdcReleaseFrame(task_id, GetCallbackBackOutputBufferIndex());
  }));
}

TEST_F(TaskTest, ReleaseInValidFrameTest) {
  ddk_mock::MockMmioRegRegion fake_regs(sizeof(uint32_t), kNumberOfMmios);

  auto task_id = SetupForFrameProcessing(fake_regs);

  // Valid buffer & task id.
  zx_status_t status = gdc_device_->GdcProcessFrame(task_id, kNumberOfBuffers - 1, 0);
  EXPECT_OK(status);

  // Trigger the interrupt manually.
  zx_port_packet packet = {kPortKeyDebugFakeInterrupt, ZX_PKT_TYPE_USER, ZX_OK, {}};
  EXPECT_OK(port_.queue(&packet));

  // Check if the callback was called.
  WaitAndReset();
  EXPECT_EQ(1, GetCallbackSize());
  EXPECT_FALSE(frame_status_error_);
}

TEST_F(TaskTest, MultipleProcessFrameTest) {
  ddk_mock::MockMmioRegRegion fake_regs(sizeof(uint32_t), kNumberOfMmios);

  auto task_id = SetupForFrameProcessing(fake_regs);

  // Process few frames, putting them in a queue
  zx_status_t status = gdc_device_->GdcProcessFrame(task_id, kNumberOfBuffers - 1, 0);
  EXPECT_OK(status);
  status = gdc_device_->GdcProcessFrame(task_id, kNumberOfBuffers - 2, 0);
  EXPECT_OK(status);
  status = gdc_device_->GdcProcessFrame(task_id, kNumberOfBuffers - 3, 0);
  EXPECT_OK(status);

  // Trigger the interrupt manually.
  zx_port_packet packet = {kPortKeyDebugFakeInterrupt, ZX_PKT_TYPE_USER, ZX_OK, {}};
  EXPECT_OK(port_.queue(&packet));

  // Check if the callback was called once.
  WaitAndReset();
  EXPECT_EQ(1, GetCallbackSize());
  EXPECT_EQ(kNumberOfBuffers - 1, GetCallbackBackInputBufferIndex());
  EXPECT_FALSE(frame_status_error_);

  // Trigger the interrupt manually.
  packet = {kPortKeyDebugFakeInterrupt, ZX_PKT_TYPE_USER, ZX_OK, {}};
  EXPECT_OK(port_.queue(&packet));

  // Check if the callback was called one more time.
  WaitAndReset();
  EXPECT_EQ(2, GetCallbackSize());
  EXPECT_EQ(kNumberOfBuffers - 2, GetCallbackBackInputBufferIndex());
  EXPECT_FALSE(frame_status_error_);

  // This time adding another frame to process while its
  // waiting for an interrupt.
  status = gdc_device_->GdcProcessFrame(task_id, kNumberOfBuffers - 4, 0);
  EXPECT_OK(status);

  // Trigger the interrupt manually.
  packet = {kPortKeyDebugFakeInterrupt, ZX_PKT_TYPE_USER, ZX_OK, {}};
  EXPECT_OK(port_.queue(&packet));

  // Check if the callback was called one more time.
  WaitAndReset();
  EXPECT_EQ(3, GetCallbackSize());
  EXPECT_EQ(kNumberOfBuffers - 3, GetCallbackBackInputBufferIndex());
  EXPECT_FALSE(frame_status_error_);

  // Trigger the interrupt manually.
  packet = {kPortKeyDebugFakeInterrupt, ZX_PKT_TYPE_USER, ZX_OK, {}};
  EXPECT_OK(port_.queue(&packet));

  // Check if the callback was called one more time.
  WaitAndReset();
  EXPECT_EQ(4, GetCallbackSize());
  EXPECT_FALSE(frame_status_error_);
}

TEST_F(TaskTest, DropFrameTest) {
  ddk_mock::MockMmioRegRegion fake_regs(sizeof(uint32_t), kNumberOfMmios);

  auto task_id = SetupForFrameProcessing(fake_regs);

  // We process kNumberOfBuffers frames.
  for (uint32_t i = 0; i < kNumberOfBuffers; i++) {
    auto status = gdc_device_->GdcProcessFrame(task_id, i, 0);
    EXPECT_OK(status);
  }

  // Ensure that all of them are processed. This ensures that all o/p buffers are used.
  for (uint32_t t = 1; t <= kNumberOfBuffers; t++) {
    // Trigger the interrupt manually.
    zx_port_packet packet = {kPortKeyDebugFakeInterrupt, ZX_PKT_TYPE_USER, ZX_OK, {}};
    EXPECT_OK(port_.queue(&packet));

    // Check if the callback was called.
    WaitAndReset();
    EXPECT_EQ(t, GetCallbackSize());
    EXPECT_FALSE(frame_status_error_);
    EXPECT_EQ(t - 1, GetCallbackBackInputBufferIndex());
  }

  // Adding one more frame to process.
  auto status = gdc_device_->GdcProcessFrame(task_id, 0, 0);
  EXPECT_OK(status);

  // Trigger the interrupt manually.
  zx_port_packet packet = {kPortKeyDebugFakeInterrupt, ZX_PKT_TYPE_USER, ZX_OK, {}};
  EXPECT_OK(port_.queue(&packet));

  // Check if the callback was called.
  WaitAndReset();
  EXPECT_EQ(kNumberOfBuffers + 1, GetCallbackSize());
  EXPECT_TRUE(frame_status_error_);
}

TEST(TaskTest, NonContigVmoTest) {
  zx::bti bti_handle;
  hw_accel_frame_callback_t frame_callback;
  hw_accel_res_change_callback_t res_callback;
  hw_accel_remove_task_callback_t remove_task_callback;
  zx::vmo config_vmo;
  buffer_collection_info_2_t input_buffer_collection;
  buffer_collection_info_2_t output_buffer_collection;
  ASSERT_OK(fake_bti_create(bti_handle.reset_and_get_address()));
  image_format_2_t format;
  EXPECT_OK(camera::GetImageFormat(
      format, fidl::ToUnderlying(fuchsia_sysmem::PixelFormatType::kNv12), kWidth, kHeight));
  zx_status_t status = camera::CreateContiguousBufferCollectionInfo(
      input_buffer_collection, format, bti_handle.get(), kNumberOfBuffers);
  ASSERT_OK(status);

  status = camera::CreateContiguousBufferCollectionInfo(output_buffer_collection, format,
                                                        bti_handle.get(), kNumberOfBuffers);
  ASSERT_OK(status);

  ASSERT_OK(zx::vmo::create(kConfigSize, 0, &config_vmo));

  gdc_config_info info;
  info.config_vmo = config_vmo.release();
  info.size = kConfigSize;

  std::stack<zx::vmo> config_contig_vmos;
  CreateContiguousConfigVmos(bti_handle, kConfigSize, 1, config_contig_vmos);

  auto task = std::make_unique<GdcTask>();
  image_format_2_t image_format_table[kImageFormatTableSize];
  EXPECT_OK(camera::GetImageFormat(image_format_table[0],
                                   fidl::ToUnderlying(fuchsia_sysmem::PixelFormatType::kNv12),
                                   kWidth, kHeight));
  status = task->Init(&input_buffer_collection, &output_buffer_collection, &format,
                      image_format_table, 1, 0, &info, 1, config_contig_vmos, &frame_callback,
                      &res_callback, &remove_task_callback, bti_handle);
  // Expecting Task setup to convert the non-contig vmo to contig
  EXPECT_EQ(ZX_OK, status);

  // Cleanup
  EXPECT_OK(camera::DestroyContiguousBufferCollection(input_buffer_collection));
  EXPECT_OK(camera::DestroyContiguousBufferCollection(output_buffer_collection));
  zx_handle_close(info.config_vmo);
}

TEST(TaskTest, InvalidConfigVmoTest) {
  zx::bti bti_handle;
  hw_accel_frame_callback_t frame_callback;
  hw_accel_res_change_callback_t res_callback;
  hw_accel_remove_task_callback_t remove_task_callback;

  zx::vmo config_vmo;
  buffer_collection_info_2_t input_buffer_collection;
  buffer_collection_info_2_t output_buffer_collection;
  ASSERT_OK(fake_bti_create(bti_handle.reset_and_get_address()));
  image_format_2_t format;
  EXPECT_OK(camera::GetImageFormat(
      format, fidl::ToUnderlying(fuchsia_sysmem::PixelFormatType::kNv12), kWidth, kHeight));
  zx_status_t status = camera::CreateContiguousBufferCollectionInfo(
      input_buffer_collection, format, bti_handle.get(), kNumberOfBuffers);
  ASSERT_OK(status);

  status = camera::CreateContiguousBufferCollectionInfo(output_buffer_collection, format,
                                                        bti_handle.get(), kNumberOfBuffers);
  ASSERT_OK(status);

  gdc_config_info info;
  info.config_vmo = ZX_HANDLE_INVALID;
  info.size = kConfigSize;

  std::stack<zx::vmo> config_contig_vmos;
  CreateContiguousConfigVmos(bti_handle, kConfigSize, 1, config_contig_vmos);

  auto task = std::make_unique<GdcTask>();
  image_format_2_t image_format_table[kImageFormatTableSize];
  EXPECT_OK(camera::GetImageFormat(image_format_table[0],
                                   fidl::ToUnderlying(fuchsia_sysmem::PixelFormatType::kNv12),
                                   kWidth, kHeight));
  status = task->Init(&input_buffer_collection, &output_buffer_collection, &format,
                      image_format_table, 1, 0, &info, 1, config_contig_vmos, &frame_callback,
                      &res_callback, &remove_task_callback, bti_handle);
  // Expecting Task setup to convert the non-contig vmo to contig
  EXPECT_EQ(ZX_ERR_INVALID_ARGS, status);

  // Cleanup
  EXPECT_OK(camera::DestroyContiguousBufferCollection(input_buffer_collection));
  EXPECT_OK(camera::DestroyContiguousBufferCollection(output_buffer_collection));
}

TEST(TaskTest, InvalidBufferCollectionTest) {
  zx::bti bti_handle;
  hw_accel_frame_callback_t frame_callback;
  hw_accel_res_change_callback_t res_callback;
  hw_accel_remove_task_callback_t remove_task_callback;

  zx::vmo config_vmo;

  ASSERT_OK(fake_bti_create(bti_handle.reset_and_get_address()));

  ASSERT_OK(zx::vmo::create_contiguous(bti_handle, kConfigSize, 0, &config_vmo));

  auto task = std::make_unique<GdcTask>();
  image_format_2_t image_format_table[kImageFormatTableSize];

  EXPECT_OK(camera::GetImageFormat(image_format_table[0],
                                   fidl::ToUnderlying(fuchsia_sysmem::PixelFormatType::kNv12),
                                   kWidth, kHeight));
  gdc_config_info info;
  info.config_vmo = config_vmo.release();
  info.size = kConfigSize;

  std::stack<zx::vmo> config_contig_vmos;
  CreateContiguousConfigVmos(bti_handle, kConfigSize, 1, config_contig_vmos);

  zx_status_t status =
      task->Init(nullptr, nullptr, nullptr, image_format_table, 1, 0, &info, 1, config_contig_vmos,
                 &frame_callback, &res_callback, &remove_task_callback, bti_handle);
  EXPECT_NE(ZX_OK, status);
}

TEST_F(TaskTest, ReuseConfigContiguousVmoTest) {
  SetUpBufferCollections(kNumberOfBuffers);

  std::stack<zx::vmo> config_contig_vmos;
  CreateContiguousConfigVmos(bti_handle_, config_info_.size, 1, config_contig_vmos);
  auto original_vmo_koid = fsl::GetKoid(config_contig_vmos.top().get());

  auto task = std::make_unique<GdcTask>();
  zx_status_t status =
      task->Init(&input_buffer_collection_, &output_buffer_collection_, &input_image_format_,
                 output_image_format_table_, 1, 0, &config_info_, 1, config_contig_vmos,
                 &frame_callback_, &res_callback_, &remove_task_callback_, bti_handle_);
  EXPECT_OK(status);

  EXPECT_TRUE(config_contig_vmos.empty());
  task->OnRemoveTask(config_contig_vmos);
  ASSERT_FALSE(config_contig_vmos.empty());

  EXPECT_EQ(original_vmo_koid, fsl::GetKoid(config_contig_vmos.top().get()));
}

TEST_F(TaskTest, CreateConfigContiguousVmoTest) {
  SetUpBufferCollections(kNumberOfBuffers);

  // Use an invalid size (1 byte) for the config VMO. The task will need to create its own
  // contiguous VMO to use instead.
  std::stack<zx::vmo> config_contig_vmos;
  CreateContiguousConfigVmos(bti_handle_, 1, 1, config_contig_vmos);
  auto original_vmo_koid = fsl::GetKoid(config_contig_vmos.top().get());

  auto task = std::make_unique<GdcTask>();
  zx_status_t status =
      task->Init(&input_buffer_collection_, &output_buffer_collection_, &input_image_format_,
                 output_image_format_table_, 1, 0, &config_info_, 1, config_contig_vmos,
                 &frame_callback_, &res_callback_, &remove_task_callback_, bti_handle_);
  EXPECT_OK(status);

  EXPECT_TRUE(config_contig_vmos.empty());
  task->OnRemoveTask(config_contig_vmos);
  ASSERT_FALSE(config_contig_vmos.empty());

  EXPECT_NE(original_vmo_koid, fsl::GetKoid(config_contig_vmos.top().get()));
}

}  // namespace
}  // namespace gdc