lib/machina/virtio_block.h

// Copyright 2017 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.

#ifndef GARNET_LIB_MACHINA_VIRTIO_BLOCK_H_
#define GARNET_LIB_MACHINA_VIRTIO_BLOCK_H_

#include <fbl/mutex.h>
#include <fbl/unique_ptr.h>
#include <virtio/block.h>

#include "garnet/lib/machina/block_dispatcher.h"
#include "garnet/lib/machina/virtio.h"

typedef struct file_state file_state_t;

namespace machina {

// Stores the state of a block device.
class VirtioBlock : public VirtioDevice {
 public:
  static constexpr size_t kSectorSize = 512;

  VirtioBlock(const PhysMem& phys_mem);
  ~VirtioBlock() override = default;

  // Set the dispatcher to use to interface with the back-end.
  zx_status_t SetDispatcher(fbl::unique_ptr<BlockDispatcher> dispatcher);

  // Starts a thread to monitor the queue for incomming block requests.
  zx_status_t Start();

  // Our config space is read-only.
  zx_status_t WriteConfig(uint64_t addr, const IoValue& value) override {
    return ZX_ERR_NOT_SUPPORTED;
  }

  zx_status_t HandleBlockRequest(virtio_queue_t* queue,
                                 uint16_t head,
                                 uint32_t* used);

  bool is_read_only() { return has_device_features(VIRTIO_BLK_F_RO); }

  // The queue used for handling block reauests.
  virtio_queue_t& queue() { return queue_; }

 private:
  // Queue for handling block requests.
  virtio_queue_t queue_;
  // Device configuration fields.
  virtio_blk_config_t config_ = {};
  fbl::unique_ptr<BlockDispatcher> dispatcher_;
};

}  // namespace machina

#endif  // GARNET_LIB_MACHINA_VIRTIO_BLOCK_H_