Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 6 additions & 7 deletions lib/hyper/node/img/thin_pool.ex
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,7 @@ defmodule Hyper.Node.Img.ThinPool do

defmodule State do
@moduledoc false
@enforce_keys [:meta_loop]
defstruct [:meta_loop, next: 0, freed: []]
defstruct next: 0, freed: []
end

@spec start_link(keyword()) :: GenServer.on_start()
Expand All @@ -47,11 +46,11 @@ defmodule Hyper.Node.Img.ThinPool do
{:ok, %{scanned: non_neg_integer(), written: non_neg_integer()}} | {:error, term()}
@decorate with_span("Hyper.Node.Img.ThinPool.fork_delta", include: [:parent, :cow])
def fork_delta(parent, origin, cow) do
{scratch_id, meta_loop} = GenServer.call(__MODULE__, :reserve_scratch)
scratch_id = GenServer.call(__MODULE__, :reserve_scratch)

result =
serialized_on(parent, fn ->
SuidHelper.ForkDelta.run(@pool_name, meta_loop, parent, scratch_id, origin, cow)
SuidHelper.ForkDelta.run(@pool_name, parent, scratch_id, origin, cow)
end)

GenServer.call(__MODULE__, {:release_scratch, scratch_id, result})
Expand All @@ -77,9 +76,9 @@ defmodule Hyper.Node.Img.ThinPool do
with :ok <- File.mkdir_p(Hyper.Cfg.Dirs.scratch_dir()),
{:ok, meta} <- ensure_backing(@meta_file, ImgConfig.thin_pool_meta_size()),
{:ok, data} <- ensure_backing(@data_file, ImgConfig.thin_pool_data_size()),
{:ok, _pool_dev, meta_loop} <-
{:ok, _pool_dev, _meta_loop} <-
SuidHelper.Thin.create_pool(@pool_name, meta, data, ImgConfig.thin_block_sectors(), 0) do
{:ok, %State{meta_loop: meta_loop}}
{:ok, %State{}}
else
{:error, reason} -> {:stop, reason}
end
Expand All @@ -98,7 +97,7 @@ defmodule Hyper.Node.Img.ThinPool do
@impl true
def handle_call(:reserve_scratch, _from, state) do
{id, state} = id_alloc(state)
{:reply, {id, state.meta_loop}, state}
{:reply, id, state}
end

@impl true
Expand Down
5 changes: 2 additions & 3 deletions lib/hyper/suid_helper/fork_delta.ex
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,13 @@ defmodule Hyper.SuidHelper.ForkDelta do

@type err :: SuidHelper.err()

@spec run(String.t(), Path.t(), String.t(), non_neg_integer(), Path.t(), Path.t()) ::
@spec run(String.t(), String.t(), non_neg_integer(), Path.t(), Path.t()) ::
{:ok, %{scanned: non_neg_integer(), written: non_neg_integer()}} | {:error, err()}
@decorate with_span("Hyper.SuidHelper.ForkDelta.run", include: [:parent, :cow])
def run(pool, meta_dev, parent, scratch_id, origin, cow) do
def run(pool, parent, scratch_id, origin, cow) do
request = %{
op: "thin_fork_delta",
pool: pool,
meta: meta_dev,
parent: parent,
scratch_id: scratch_id,
origin: origin,
Expand Down
4 changes: 0 additions & 4 deletions native/.cargo/mutants.toml
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,6 @@ exclude_re = [
"suidhelper/src/net/vm\\.rs:.*VmNet<'_>::",
"suidhelper/src/cli/vm/claim\\.rs:.*SocketPin<'_>::",
"suidhelper/src/cli/vm/teardown\\.rs:.*Teardown::unpin_sockets",
# The metadata-device check runs as root against a fake dmsetup; killed by suidhelper's
# a_meta_that_is_not_the_pools_metadata_is_refused_before_any_snapshot_as_root (tests/e2e/
# fork_delta.rs) in the privileged E2E job.
"suidhelper/src/cli/fork_delta\\.rs:.*replace != with == in <impl Op for ThinForkDelta>::run$",
# Guest network setup runs inside a booted guest; killed by test/e2e/guest_network_test.exs
# in the KVM integration job.
"guest-agent/src/net\\.rs:.*GuestNet::(from_proc|configure)",
Expand Down
149 changes: 147 additions & 2 deletions native/hyperrs-fs/src/dev.rs
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@
use super::file::DeviceType;
use super::file::{self, Any, DeviceType, IsBlockDevice, OpenFlags, SafeFile};
use super::path::{self, IsAbsolute, SafePath, StrictComponents};
use derive_more::{Constructor, Display};
use nix::libc::dev_t;
use nix::sys::stat::{major, makedev, minor, Mode};
use std::fs;
use std::io;
use std::marker::PhantomData;
use std::path::{Path, PathBuf};
use std::str::FromStr;
use thiserror::Error as ThisError;

Expand Down Expand Up @@ -80,11 +84,93 @@ impl<T: DeviceType> DeviceNode<T> {
}
}

#[derive(Debug, ThisError)]
pub enum OpenDeviceError {
#[error("reading {path}: {source}")]
Sysfs {
path: PathBuf,
#[source]
source: io::Error,
},
#[error("sysfs gives block device {dev} no DEVNAME")]
NoName { dev: DeviceNumber },
#[error("block device {dev}'s name {name:?}: {source}")]
Name {
dev: DeviceNumber,
name: String,
#[source]
source: path::ValidationError,
},
#[error("opening block device {dev}: {source}")]
Open {
dev: DeviceNumber,
#[source]
source: file::ValidationError,
},
#[error("{} is block device {got}, not {want}", path.display())]
Mismatch {
path: PathBuf,
want: DeviceNumber,
got: DeviceNumber,
},
}

impl SafeFile<IsBlockDevice, Any, Any> {
/// Open block device `dev` at `/dev/<DEVNAME>`, the name the kernel gives it in sysfs.
/// Whatever node sits at that path must be `dev` itself, or the open is refused.
pub fn open_block(dev: DeviceNumber, flags: OpenFlags) -> Result<Self, OpenDeviceError> {
let uevent = PathBuf::from(format!("/sys/dev/block/{dev}/uevent"));
let text = fs::read_to_string(&uevent).map_err(|source| OpenDeviceError::Sysfs {
path: uevent,
source,
})?;
let name = dev_name(&text).ok_or(OpenDeviceError::NoName { dev })?;
let node = Path::new("/dev").join(name);
let safe = <&SafePath<IsAbsolute, StrictComponents>>::try_from(node.as_path()).map_err(
|source| OpenDeviceError::Name {
dev,
name: name.to_owned(),
source,
},
)?;
open_numbered(safe, dev, flags)
}
}

fn dev_name(uevent: &str) -> Option<&str> {
uevent
.lines()
.find_map(|line| line.strip_prefix("DEVNAME="))
.filter(|name| !name.is_empty())
}

fn open_numbered(
node: &SafePath<IsAbsolute, StrictComponents>,
want: DeviceNumber,
flags: OpenFlags,
) -> Result<SafeFile<IsBlockDevice, Any, Any>, OpenDeviceError> {
let open = |source| OpenDeviceError::Open { dev: want, source };
let file = SafeFile::open(node, flags).map_err(open)?;
let got = file.rdev().map_err(open)?;
if got == want {
Ok(file)
} else {
Err(OpenDeviceError::Mismatch {
path: node.as_path().to_path_buf(),
want,
got,
})
}
}

#[cfg(test)]
mod tests {
use super::DeviceNumber;
use super::{dev_name, open_numbered, DeviceNumber, OpenDeviceError};
use crate::file::{Any, IsBlockDevice, OpenFlags, SafeFile};
use crate::path::{IsAbsolute, SafePath, StrictComponents};
use pretty_assertions::assert_eq;
use rstest::rstest;
use std::path::{Path, PathBuf};
use test_strategy::proptest;

#[proptest]
Expand All @@ -106,4 +192,63 @@ mod tests {
fn from_str_refuses_anything_but_major_colon_minor(#[case] raw: &str) {
assert!(raw.parse::<DeviceNumber>().is_err(), "{raw:?}");
}

#[rstest]
#[case::loop_device("MAJOR=7\nMINOR=3\nDEVNAME=loop3\nDEVTYPE=disk\n", Some("loop3"))]
#[case::nested_name("MAJOR=104\nMINOR=0\nDEVNAME=cciss/c0d0\n", Some("cciss/c0d0"))]
#[case::first_line("DEVNAME=dm-0\n", Some("dm-0"))]
#[case::missing("MAJOR=7\nMINOR=3\n", None)]
#[case::empty_name("DEVNAME=\n", None)]
#[case::only_a_suffix_match("XDEVNAME=loop3\n", None)]
fn dev_name_is_the_devname_line_of_the_uevent(
#[case] uevent: &str,
#[case] want: Option<&str>,
) {
assert_eq!(dev_name(uevent), want);
}

/// Every block device the kernel lists, by number and by its `/dev` node.
fn block_devices() -> Vec<(DeviceNumber, PathBuf)> {
std::fs::read_dir("/sys/dev/block")
.unwrap()
.filter_map(|entry| {
let entry = entry.unwrap();
let dev = entry.file_name().to_str()?.parse().ok()?;
let uevent = std::fs::read_to_string(entry.path().join("uevent")).ok()?;
let node = Path::new("/dev").join(dev_name(&uevent)?);
node.exists().then_some((dev, node))
})
.collect()
}

// O_PATH needs no read permission on the node, so this runs unprivileged.
#[test]
fn open_block_yields_the_device_it_was_asked_for() {
let devices = block_devices();
assert!(!devices.is_empty(), "no block devices in /sys/dev/block");
for (dev, _) in devices {
let file = SafeFile::<IsBlockDevice, Any, Any>::open_block(dev, OpenFlags::PATH)
.unwrap_or_else(|e| panic!("{dev}: {e}"));
assert_eq!(file.rdev().unwrap(), dev);
}
}

#[test]
fn a_node_that_is_another_device_is_refused() {
let devices = block_devices();
let [(_, node), (other, _), ..] = devices.as_slice() else {
eprintln!(
"SKIP a_node_that_is_another_device_is_refused: fewer than two block devices"
);
return;
};
let node = <&SafePath<IsAbsolute, StrictComponents>>::try_from(node.as_path()).unwrap();

let got = open_numbered(node, *other, OpenFlags::PATH);

assert!(
matches!(got, Err(OpenDeviceError::Mismatch { want, .. }) if want == *other),
"{got:?}"
);
}
}
31 changes: 8 additions & 23 deletions native/suidhelper/src/cli/fork_delta.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,15 @@ use crate::cli::MapperPath;
use crate::cli::Op;
use crate::config::Config;
use crate::dm::{HyperDmName, HyperDmTable, NameError, TableError};
use hyperrs_fs::dev::DeviceNumber;
use hyperrs_fs::file::{self, Any, IsBlockDevice, OpenFlags, SafeFile};
use hyperrs_fs::path;
use hyperrs_fs::dev::OpenDeviceError;
use hyperrs_fs::file::{Any, IsBlockDevice, OpenFlags, SafeFile};
use hyperrs_linux::dm::thin_dump::{
self as dump, DumpError, MappingsError, MetadataDump, ParseError, ThinMappings,
};
use hyperrs_linux::dm::{
self, DevPath, DmTable, OpenThinError, Origin, Persistence, RemoveMode, RunError,
SnapshotError, SnapshotTable, ThinId, ThinMessage, ThinPoolError,
};
use hyperrs_linux::loopdev::LoopDevNum;
use hyperrs_linux::Access;
use hyperrs_process::binary::RootSafeBinError;
use hyperrs_process::privilege::{PrivilegeError, Unprivileged};
Expand All @@ -34,7 +32,6 @@ const CHUNK_BYTES: usize = 1 << 20;
#[serde(deny_unknown_fields)]
pub struct ThinForkDelta {
pool: HyperDmName,
meta: LoopDevNum,
parent: HyperDmName,
scratch_id: ThinId,
#[serde_as(as = "MapperPath")]
Expand All @@ -45,15 +42,8 @@ pub struct ThinForkDelta {

#[derive(Debug, ThisError)]
pub enum ForkDeltaError {
#[error("metadata device path: {0}")]
Path(#[from] path::ValidationError),
#[error("opening metadata device: {0}")]
Open(#[from] file::ValidationError),
#[error("{meta} is not the pool's metadata device {pool}")]
NotPoolMetadata {
meta: DeviceNumber,
pool: DeviceNumber,
},
#[error("opening the pool's metadata device: {0}")]
Metadata(#[from] OpenDeviceError),
#[error("locking metadata device: {0}")]
Lock(#[source] io::Error),
#[error(transparent)]
Expand Down Expand Up @@ -106,7 +96,6 @@ impl Op for ThinForkDelta {
let config = Config::get();
let dmsetup = dm::Dmsetup::new(config.dmsetup()?);
let thin_dump = dump::ThinDump::new(config.thin_dump()?);
let meta = self.meta.path()?;
let origin = Origin::Device((*self.origin).clone());
let target = HyperDmTable::new(DmTable::Snapshot(SnapshotTable {
sectors: 0,
Expand All @@ -121,14 +110,10 @@ impl Op for ThinForkDelta {
let _root = token.elevate()?;
let sectors = self.origin.sectors().map_err(DmError::from)?;
let pool = dmsetup.thin_pool(&self.pool)?;
let meta = SafeFile::<IsBlockDevice, Any, Any>::open(&meta, OpenFlags::RDONLY)?;
let (got, want) = (meta.rdev()?, pool.metadata());
if got != want {
return Err(ForkDeltaError::NotPoolMetadata {
meta: got,
pool: want,
});
}
let meta = SafeFile::<IsBlockDevice, Any, Any>::open_block(
pool.metadata(),
OpenFlags::RDONLY,
)?;
let snapshot = match pool.open_thin(&self.parent)?.snapshot(self.scratch_id) {
Ok(snapshot) => snapshot,
Err(e @ SnapshotError::Resume { created: true, .. }) => {
Expand Down
7 changes: 5 additions & 2 deletions native/suidhelper/src/cli/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -222,11 +222,14 @@ mod tests {
#[case::retired_prepare_op(json!({"op": "vm_prepare", "id": "v1", "uid": 900_001}))]
#[case::retired_stage_op(json!({"op": "vm_stage", "id": "v1", "kernel": "/srv/hyper/vmlinux",
"device": "/dev/mapper/hyper-v1", "uid": 900_001, "gid": 900_001}))]
#[case::fork_delta_caller_named_meta(json!({"op": "thin_fork_delta", "pool": "hyper-pool",
"meta": "/dev/loop3", "parent": "hyper-v1", "scratch_id": 9,
"origin": "/dev/mapper/hyper-img", "cow": "/srv/hyper/cow.img", "chunk_sectors": 8}))]
#[case::fork_delta_caller_named_source(json!({"op": "thin_fork_delta", "pool": "hyper-pool",
"meta": "/dev/loop3", "parent": "hyper-v1", "scratch_id": 9, "src": "/dev/mapper/hyper-a",
"parent": "hyper-v1", "scratch_id": 9, "src": "/dev/mapper/hyper-a",
"origin": "/dev/mapper/hyper-img", "cow": "/srv/hyper/cow.img", "chunk_sectors": 8}))]
#[case::fork_delta_scratch_id_past_24_bits(json!({"op": "thin_fork_delta", "pool": "hyper-pool",
"meta": "/dev/loop3", "parent": "hyper-v1", "scratch_id": 16_777_216,
"parent": "hyper-v1", "scratch_id": 16_777_216,
"origin": "/dev/mapper/hyper-img", "cow": "/srv/hyper/cow.img", "chunk_sectors": 8}))]
#[case::retired_thin_copy_op(json!({"op": "thin_copy", "pool": "hyper-pool",
"meta": "/dev/loop3", "src": "/dev/mapper/hyper-a", "origin": "/dev/mapper/hyper-img",
Expand Down
Loading
Loading