storage_benchmarks/
block_device.rs

1// Copyright 2022 The Fuchsia Authors. All rights reserved.
2// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file.
4
5use async_trait::async_trait;
6#[cfg(target_os = "fuchsia")]
7use fs_management::filesystem::BlockConnector;
8
9/// Block device configuration options.
10pub struct BlockDeviceConfig {
11    /// If true, the block device will always be added to an FVM volume.  If the system has an FVM
12    /// instance, it'll be added in there, and otherwise a test-only FVM instance will be spawned
13    /// and the volume will be added to that instance.
14    /// Note that even if this is false, the block device might end up in an FVM volume
15    /// (particularly when the system uses FVM).
16    pub requires_fvm: bool,
17
18    /// If true, zxcrypt is initialized on top of the block device.
19    pub use_zxcrypt: bool,
20
21    /// For non-FVM volumes, this is the size of the volume and is required to be set.
22    /// For FVM volumes, this is optional, and if set will pre-size the volume.
23    pub volume_size: Option<u64>,
24}
25
26/// A trait representing a block device.
27pub trait BlockDevice: Send + Sync {
28    #[cfg(target_os = "fuchsia")]
29    fn connector(&self) -> Box<dyn BlockConnector>;
30}
31
32/// A trait for constructing block devices.
33#[async_trait]
34pub trait BlockDeviceFactory: Send + Sync {
35    /// Constructs a new block device.
36    async fn create_block_device(&self, config: &BlockDeviceConfig) -> Box<dyn BlockDevice>;
37}
38
39/// A BlockDeviceFactory that panics when trying to create a block device. This is useful for
40/// benchmarking filesystems that don't need to create a block device.
41pub struct PanickingBlockDeviceFactory {}
42
43impl PanickingBlockDeviceFactory {
44    pub fn new() -> Self {
45        Self {}
46    }
47}
48
49#[async_trait]
50impl BlockDeviceFactory for PanickingBlockDeviceFactory {
51    async fn create_block_device(&self, _config: &BlockDeviceConfig) -> Box<dyn BlockDevice> {
52        panic!("PanickingBlockDeviceFactory can't create block devices");
53    }
54}
storage_benchmarks/block_device.rs

storage_benchmarks/
block_device.rs
