Struct HermitData 

pub struct HermitData { /* private fields */ }

Holds the context necessary to run high-level hermit functions.

Implementations

impl HermitData

pub fn new() -> Self

Creates an instance of HermitData using ~/.cache/hermit as the data directory.

pub fn with_dir<P>(data_dir: P) -> Self

where P: Into<PathBuf>,

Creates a HermitData using the given directory as the base path for storing recording data.

pub fn data_dir(&self) -> &Path

Returns the path to the data directory where recordings are stored.

pub fn record(&self, command: Command) -> Result<Recording, Error>

Records the execution of the given command, returning its Recording.

If recording failed, then an error is returned. Note that if the command itself failed, then we still return a successful recording, but its exit status will be non-zero.

This low-level API does not create a Hermit container, so it has no authenticated private-mount provenance to supply. Detcore derives mount identities from the completed guest namespace. CLI container callers with producer-owned root provenance must use Self::record_with_mountinfo.

The ptrace session runs on a tracer thread, so the calling thread needs no particular stack; see run.

pub fn record_with_mountinfo( &self, command: Command, mountinfo_root_rewrites: Vec<MountInfoRootRewrite>, ) -> Result<Recording, Error>

Records with mountinfo provenance captured from the active container.

The ptrace session runs on a tracer thread, so the calling thread needs no particular stack; see run.

pub fn create_recording_dir(&self) -> Result<TempDir, Error>

Creates a temporary directory for a recording that has not been committed yet.

pub fn commit_recording( &self, data: TempDir, exit_status: ExitStatus, ) -> Result<Recording, Error>

Commits a completed temporary recording to the recording store.

pub fn replay(&self, id: Id) -> Result<ExitStatus, Error>

Replays the given recording ID.

The ptrace session runs on a tracer thread, so the calling thread needs no particular stack; see run.

pub fn replay_with_gdbserver( &self, id: Id, port: u16, ) -> Result<ExitStatus, Error>

Replays the given recording ID with a gdbserver available to attach to.

The ptrace session runs on a tracer thread, so the calling thread needs no particular stack; see run.

pub fn recordings(&self) -> impl Iterator<Item = Id> + use<>

Returns an iterator over the recordings.

Use Self::recording_metadata to get more information about a recording.

pub fn try_recordings(&self) -> Result<Vec<Id>, Error>

Returns all recordings, or an error if the data directory cannot be enumerated completely.

A missing data directory has no recordings. Other filesystem errors are returned rather than being mistaken for an empty or partial inventory.

pub fn recording_metadata(&self, id: Id) -> Result<Metadata, Error>

Returns the metadata of a recording.

pub fn remove(&self, id: Id) -> Result<(), Error>

Deletes a recording.

pub fn last_id(&self) -> Result<Id, Error>

Returns the last recorded ID.

pub fn note_latest(&self, id: &Id, asked: bool) -> Result<(), Error>

Atomically names id as the newest recording: last-run always, and last, which a bare hermit replay replays, when the user asked for the recording (hermit record, hermit run --record-networking) rather than a run leaving its manifest; see https://github.com/rrnewton/hermit/issues/4271.

Trait Implementations

impl Default for HermitData

fn default() -> Self

Returns the “default value” for a type.

impl<'a> From<Option<&'a PathBuf>> for HermitData

fn from(data_dir: Option<&'a PathBuf>) -> Self

Converts to this type from the input type.