11 releases

0.5.2 May 19, 2022
0.5.1 May 19, 2022
0.5.0 Oct 21, 2021
0.4.2 Aug 16, 2021
0.1.1 Apr 29, 2021

#2 in #btrfs

26 downloads per month

GPL-2.0 license

245KB
6K SLoC

btrd

The btrfs debugger (pronounced "buttered").

btrd is a REPL debugger that helps inspect mounted btrfs filesystems. btrd is particularly useful in exploring on-disk structures and has full knowledge of all on-disk types.

Demo

$ sudo btrd
btrd (the btrfs debugger) v0.1.0
Type 'help' for help

(btrd) filesystem "/mnt/btrfs"
(btrd) k = key(BTRFS_DEV_TREE_OBJECTID, BTRFS_ROOT_ITEM_KEY, 0, 0)
(btrd) print k
struct _btrfs_ioctl_search_key {
    .min_objectid = 4,
    .max_objectid = 18446744073709551615,
    .min_type = 132,
    .max_type = 255,
    .min_offset = 0,
    .max_offset = 18446744073709551615,
    .min_transid = 0,
    .max_transid = 18446744073709551615,
}

(btrd) res = search(BTRFS_ROOT_TREE_OBJECTID, k)
(btrd) len(res)
297

(btrd) res[0]
struct btrfs_root_item {
    .inode = struct btrfs_inode_item {
        .generation = 1,
        .transid = 0,
        .size = 3,
        .nbytes = 16384,
<...>
        .sequence = 0,
        .reserved = [
            0,
            0,
            0,
            0,
        ],
        .atime = struct btrfs_timespec {
            .sec = 0,
            .nsec = 0,
        },
<...>

(btrd) print res[0].inode.nbytes
16384

(btrd) typeof(res[0])
"struct btrfs_root_item"

(btrd) keyof(res[0])
struct btrfs_key {
    .objectid = 4,
    .type = 132,
    .offset = 0,
}

Building

$ git clone https://github.com/danobi/btrd.git
$ cd btrd
$ cargo build --release
$ sudo ./target/release/btrd

Language features

btrd's scripting language is not a hack -- it's a dynamically typed language tailored to filesystem debugging. The following is a list of language features:

Types:

  • Strings
  • Integers (all integers are internally represented as i128)
  • Booleans
  • Arrays (may not be user instantiated)
  • Structs (may not be user defined/instantiated)
  • Functions (first-class support; may not be user defined)

Expressions:

  • Binary expressions (+, -, /, %, >>, &&, ==, etc.)
  • Unary expressions (-, ~, !)
  • Parentheses
  • Function calls
  • Struct field access
  • Array indexes
  • Type casts ((struct btrfs_root) physical_bytenr)

Control flow:

  • while
  • for (ranged based)
  • if/else

There is not and will not be support for:

  • Floating point

Dependencies

~6.5MB
~118K SLoC