florian/btrfs_explorer
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

add README.md

Browse Source
This commit is contained in:
Florian Stecker 2024-05-23 15:50:55 -04:00
parent 700f1d3de2
commit d7d5c2100d
2 changed files with 29 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
README.md Normal file
View File

@ -0,0 +1,27 @@
# BTRFS explorer - view the layout of your data on disk #
To better understand the on-disk format of BTRFS (one of the main file systems used in Linux) I wrote a parser for it and added a simple web interface. Maybe this can be useful for anyone else trying to understand BTRFS by allowing to look at a concrete example. I also tried to add explanations at some points, but they could be more detailed.
## Online demo ##
This is just a 3 GiB image which contains a base installation of Arch Linux. And I took a snapshot called "freshinstall". The tool offers a few different views:
* [The chunks:](https://florianstecker.net/btrfs/) this shows the layout of the physical disk. It is split into "chunks" which are a few hundred megabytes in size and can contain data or metadata. Click on one of the metadata chunks to see how the B-trees are laid out in them. To see what is actually contained in these trees, use the "root tree" view below.
* [The root tree:](https://florianstecker.net/btrfs/tree/1) this shows the metadata on a higher level: the B-trees form a key-value store which stores all kinds of data like files, directories, subvolumes, checksums, free space etc. The "root tree" is the highest level node from which you can click through all the other trees. The most interesting is tree 5 (the filesystem tree) with which you can browse through the entire filesystem (although it currently doesn't show the contents of large files).
* [The chunk tree:](https://florianstecker.net/btrfs/tree/3) this tree with the ID 3 is a bit special in that it's not listed in the root tree (it also lives in the system chunks instead of the metadata chunks). It contains the mapping between virtual and physical addresses, providing the "device mapper" and RAID functionality of BTRFS. The "chunks" overview above is really just showing the contents of this tree.
## Using your own data ##
To install this, clone the repository, get [Rust], and run
cargo build --release
which creates a standalone binary at the path `target/release/btrfs_explorer_bin`.
Now you can just run the `btrfs_explorer_bin` binary. It takes two arguments: the first is a disk image and the second (optional) argument is the address the web server should listen at, in the format `address:port`. The default is `localhost:8080`.
Then visit the address (e.g. `http://localhost:8080`) in a browser to see the chunk view, and `http://localhost:8080/tree/1` for the root tree view, etc.
Ideally it should be possible to use this on block devices, even mounted ones, but at the moment that has a few issues, so I would recommend only looking at images (it never writes anything, so at least it should never destroy any data, but there might be crashes).
[Rust]: https://www.rust-lang.org/

4
btrfs_explorer_bin/src/main.rs
View File

@ -17,9 +17,9 @@ fn main() -> Result<(), MainError> {
let filename: &str = args[1].as_ref();
let sockaddr: &str = args.get(2)
.map_or("localhost:8080", <String as Deref>::deref);
.map_or("localhost:8080", Deref::deref);
let http_path: String = args.get(3)
.map_or(String::new(), <String as ToOwned>::to_owned);
.map_or(String::new(), Clone::clone);
http_path_set(http_path);
let file = OpenOptions::new().read(true).open(filename)?;