1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143

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

use {
    crate::{
        block_devices::{FvmVolumeFactory, RamdiskFactory},
        filesystems::{F2fs, Fxfs, Memfs, Minfs},
    },
    regex::{Regex, RegexSetBuilder},
    std::{fs::OpenOptions, path::PathBuf, sync::Arc, vec::Vec},
    storage_benchmarks::{
        directory_benchmarks::{
            DirectoryTreeStructure, GitStatus, OpenDeeplyNestedFile, OpenFile, StatPath,
            WalkDirectoryTreeCold, WalkDirectoryTreeWarm,
        },
        io_benchmarks::{
            ReadRandomCold, ReadRandomWarm, ReadSequentialCold, ReadSequentialWarm,
            WriteRandomCold, WriteRandomWarm, WriteSequentialCold, WriteSequentialFsyncCold,
            WriteSequentialFsyncWarm, WriteSequentialWarm,
        },
        BenchmarkSet, FilesystemConfig,
    },
};

mod block_devices;
mod filesystems;

/// Fuchsia Filesystem Benchmarks
#[derive(argh::FromArgs)]
struct Args {
    /// path to write the fuchsiaperf formatted benchmark results to.
    #[argh(option)]
    output_fuchsiaperf: Option<PathBuf>,

    /// outputs a summary of the benchmark results in csv format.
    #[argh(switch)]
    output_csv: bool,

    /// regex to specify a subset of benchmarks to run. Multiple regex can be provided and
    /// benchmarks matching any of them will be run. The benchmark names are formatted as
    /// "<benchmark>/<filesystem>". All benchmarks are run if no filter is provided.
    #[argh(option)]
    filter: Vec<Regex>,

    /// registers a trace provider and adds a trace duration with the benchmarks name around each
    /// benchmark.
    #[argh(switch)]
    enable_tracing: bool,

    /// starts each filesystem to force the filesystem components and the benchmark component to be
    /// loaded into blobfs. Does not run any benchmarks.
    ///
    /// When trying to collect a trace immediately after modifying a filesystem or a benchmark, the
    /// start of the trace will be polluted with downloading the new blobs, writing the blobs to
    /// blobfs, and then paging the blobs back in. Running the benchmark component with this flag
    /// once before running it again with tracing enabled will remove most of the component loading
    /// from the start of the trace.
    #[argh(switch)]
    load_blobs_for_tracing: bool,
}

fn build_benchmark_set() -> BenchmarkSet {
    let filesystems: Vec<Arc<dyn FilesystemConfig>> = vec![
        Arc::new(Fxfs::new()),
        Arc::new(F2fs::new()),
        Arc::new(Memfs::new()),
        Arc::new(Minfs::new()),
    ];
    const OP_SIZE: usize = 8 * 1024;
    const OP_COUNT: usize = 1024;

    let mut benchmark_set = BenchmarkSet::new();
    benchmark_set.add_benchmark(ReadSequentialCold::new(OP_SIZE, OP_COUNT), &filesystems);
    benchmark_set.add_benchmark(ReadSequentialWarm::new(OP_SIZE, OP_COUNT), &filesystems);
    benchmark_set.add_benchmark(ReadRandomCold::new(OP_SIZE, OP_COUNT), &filesystems);
    benchmark_set.add_benchmark(ReadRandomWarm::new(OP_SIZE, OP_COUNT), &filesystems);
    benchmark_set.add_benchmark(WriteSequentialCold::new(OP_SIZE, OP_COUNT), &filesystems);
    benchmark_set.add_benchmark(WriteSequentialWarm::new(OP_SIZE, OP_COUNT), &filesystems);
    benchmark_set.add_benchmark(WriteRandomCold::new(OP_SIZE, OP_COUNT), &filesystems);
    benchmark_set.add_benchmark(WriteRandomWarm::new(OP_SIZE, OP_COUNT), &filesystems);
    benchmark_set.add_benchmark(WriteSequentialFsyncCold::new(OP_SIZE, OP_COUNT), &filesystems);
    benchmark_set.add_benchmark(WriteSequentialFsyncWarm::new(OP_SIZE, OP_COUNT), &filesystems);
    benchmark_set.add_benchmark(StatPath::new(), &filesystems);
    benchmark_set.add_benchmark(OpenFile::new(), &filesystems);
    benchmark_set.add_benchmark(OpenDeeplyNestedFile::new(), &filesystems);

    // Creates a total of 62 directories and 189 files.
    let dts = DirectoryTreeStructure {
        files_per_directory: 3,
        directories_per_directory: 2,
        max_depth: 5,
    };
    benchmark_set.add_benchmark(WalkDirectoryTreeCold::new(dts, 20), &filesystems);
    benchmark_set.add_benchmark(WalkDirectoryTreeWarm::new(dts, 20), &filesystems);
    benchmark_set.add_benchmark(GitStatus::new(), &filesystems);

    benchmark_set
}

async fn load_blobs_for_tracing() {
    let filesystems: Vec<Arc<dyn FilesystemConfig>> = vec![
        Arc::new(Fxfs::new()),
        Arc::new(F2fs::new()),
        Arc::new(Memfs::new()),
        Arc::new(Minfs::new()),
    ];
    let ramdisk_factory = RamdiskFactory::new(4096, 32 * 1024).await;
    for fs in &filesystems {
        fs.start_filesystem(&ramdisk_factory).await.shutdown().await;
    }
}

#[fuchsia::main(logging_tags = ["storage_benchmarks"])]
async fn main() {
    let args: Args = argh::from_env();

    if args.load_blobs_for_tracing {
        load_blobs_for_tracing().await;
        return;
    }

    if args.enable_tracing {
        fuchsia_trace_provider::trace_provider_create_with_fdio();
    }

    let mut filter = RegexSetBuilder::new(args.filter.iter().map(|f| f.as_str()));
    filter.case_insensitive(true);
    let filter = filter.build().unwrap();

    let fvm_volume_factory = FvmVolumeFactory::new().await;
    let benchmark_suite = build_benchmark_set();
    let results = benchmark_suite.run(&fvm_volume_factory, &filter).await;

    results.write_table(std::io::stdout());
    if args.output_csv {
        results.write_csv(std::io::stdout())
    }
    if let Some(path) = args.output_fuchsiaperf {
        let file = OpenOptions::new().write(true).create(true).open(path).unwrap();
        results.write_fuchsia_perf_json(file);
    }
}