// Copyright 2020 The Chromium OS 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 CRYPTOHOME_STORAGE_ENCRYPTED_CONTAINER_BACKING_DEVICE_H_
#define CRYPTOHOME_STORAGE_ENCRYPTED_CONTAINER_BACKING_DEVICE_H_

#include <memory>
#include <string>

#include <base/files/file_path.h>
#include <base/values.h>

#include "cryptohome/platform.h"

namespace cryptohome {

// `BackingDeviceType` represents the types of backing devices currently
// supported.
enum class BackingDeviceType {
  kUnknown = 0,
  kLoopbackDevice,
};

// Configuration for backing devices.
struct BackingDeviceConfig {
  BackingDeviceType type;
  std::string name;
  uint64_t size;
  struct {
    base::FilePath backing_file_path;
  } loopback;
};

// `BackingDevice` represents a backing block device that can be used as a
// building block for storage containers.
class BackingDevice {
 public:
  virtual ~BackingDevice() {}

  static std::unique_ptr<BackingDevice> Generate(
      const BackingDeviceConfig& config, Platform* platform);

  virtual bool Create() = 0;
  virtual bool Purge() = 0;
  virtual bool Setup() = 0;
  virtual bool Teardown() = 0;
  virtual BackingDeviceType GetType() = 0;
  virtual base::Optional<base::FilePath> GetPath() = 0;
};

}  // namespace cryptohome

#endif  // CRYPTOHOME_STORAGE_ENCRYPTED_CONTAINER_BACKING_DEVICE_H_