Request
The payload of the channel request: the tag byte 6 and the request of the channel.
[6][path …]- The path. UTF-8,
/-separated, with no leading/; empty is the mount itself. Where the path is the last thing in the payload it runs to the end of the payload; where bytes or a second path follow it, a two-byte length precedes it. - A file mount. For a mount of kind
file, the path is empty.
The channel request is defined by diverge-sdk-rs/src/container_proxy/outside/endpoints/fuse/mount/server/channel_request/frame.rs:
//! What a server's channel request frame carries for a FUSE mount.
use std::fmt;
use super::{Path, Read, Rename, Setattr, Truncate, Write};
use crate::wire::decode::Decode;
use crate::wire::encode::{Encode, Writer};
/// What a mount asks the server for, on behalf of the program using
/// it.
///
/// A payload leads with one byte saying which, and the rest is that
/// variant's own bytes. No ask names the mount: the scope it rides is
/// the mount.
///
/// | tag | asks for | payload |
/// |-----|----------|---------|
/// | `0` | [`Read`](Self::Read) | `[path_len: u16 BE][path…][offset: u64 BE][length: u32 BE]` |
/// | `1` | [`Write`](Self::Write) | `[path_len: u16 BE][path…][offset: u64 BE][bytes…]` |
/// | `2` | [`List`](Self::List) | `[path…]` |
/// | `3` | [`Remove`](Self::Remove) | `[path…]` |
/// | `4` | [`Rename`](Self::Rename) | `[from_len: u16 BE][from…][to…]` |
/// | `5` | [`Mkdir`](Self::Mkdir) | `[path…]` |
/// | `6` | [`Stat`](Self::Stat) | `[path…]` |
/// | `7` | [`Truncate`](Self::Truncate) | `[size: u64 BE][path…]` |
/// | `8` | [`Setattr`](Self::Setattr) | `[attrs: 29 bytes][path…]` |
///
/// Where a path is the last thing in a payload it runs to the end;
/// where bytes, fixed fields or a second path follow it, it carries
/// a length prefix. The nine are the nine of
/// [`shared::containers::fuse`](crate::shared::containers::fuse), and
/// each is answered with that module's own frame, one message and
/// the finish; what each MEANS — a file mount's empty path, the root
/// that is never removed or moved, whose refusal a refusal is — is
/// stated there once.
#[derive(Debug, Clone, PartialEq)]
pub enum Frame<'a> {
/// Read a piece of a file of the mount. Tag `0`.
///
/// Every `read(2)` of the file, with its offset and size. See
/// [`read`](crate::shared::containers::fuse::read).
Read(Read<'a>),
/// Write a piece of a file of the mount, in place. Tag `1`.
///
/// Every `write(2)` of the file, with its offset. See
/// [`write`](crate::shared::containers::fuse::write).
Write(Write<'a>),
/// List a directory of the mount. Tag `2`.
///
/// Every listing in a directory mount: names and kinds. See
/// [`list`](crate::shared::containers::fuse::list).
List(Path<'a>),
/// Remove a file or an empty directory of the mount. Tag `3`.
///
/// See [`remove`](crate::shared::containers::fuse::remove).
Remove(Path<'a>),
/// Rename an entry within the mount. Tag `4`.
///
/// See [`rename`](crate::shared::containers::fuse::rename).
Rename(Rename<'a>),
/// Make a directory in the mount. Tag `5`.
///
/// See [`mkdir`](crate::shared::containers::fuse::mkdir).
Mkdir(Path<'a>),
/// What an entry of the mount is: kind, size, mode, owner, group
/// and times. Tag `6`.
///
/// Every attribute of a file mount, and every lookup and
/// attribute of an entry in a directory mount: a `stat` costs
/// fifty-seven bytes back, not the file. See
/// [`stat`](crate::shared::containers::fuse::stat).
Stat(Path<'a>),
/// Set a file of the mount to a length. Tag `7`.
///
/// Every `truncate(2)`, `ftruncate(2)` and `O_TRUNC` open. See
/// [`truncate`](crate::shared::containers::fuse::truncate).
Truncate(Truncate<'a>),
/// Set some of an entry's attributes. Tag `8`.
///
/// Every `chmod(2)`, `chown(2)` and `utimensat(2)`. See
/// [`setattr`](crate::shared::containers::fuse::setattr).
Setattr(Setattr<'a>),
}
/// Tag for [`Frame::Read`].
const READ: u8 = 0;
/// Tag for [`Frame::Write`].
const WRITE: u8 = 1;
/// Tag for [`Frame::List`].
const LIST: u8 = 2;
/// Tag for [`Frame::Remove`].
const REMOVE: u8 = 3;
/// Tag for [`Frame::Rename`].
const RENAME: u8 = 4;
/// Tag for [`Frame::Mkdir`].
const MKDIR: u8 = 5;
/// Tag for [`Frame::Stat`].
const STAT: u8 = 6;
/// Tag for [`Frame::Truncate`].
const TRUNCATE: u8 = 7;
/// Tag for [`Frame::Setattr`].
const SETATTR: u8 = 8;
impl Encode for Frame<'_> {
/// One way to fail: a path too long for its prefix, on the three
/// asks where a path has one. Everything else is bytes copied.
type Error = FrameEncodeError;
fn encode(&self, out: &mut Writer<'_>) -> Result<(), FrameEncodeError> {
match self {
Frame::Read(read) => {
out.extend_from_slice(&[READ]);
read.encode(out)
}
Frame::Write(write) => {
out.extend_from_slice(&[WRITE]);
write.encode(out)
}
Frame::List(path) => {
out.extend_from_slice(&[LIST]);
path.encode(out).map_err(|error| match error {})
}
Frame::Remove(path) => {
out.extend_from_slice(&[REMOVE]);
path.encode(out).map_err(|error| match error {})
}
Frame::Rename(rename) => {
out.extend_from_slice(&[RENAME]);
rename.encode(out)
}
Frame::Mkdir(path) => {
out.extend_from_slice(&[MKDIR]);
path.encode(out).map_err(|error| match error {})
}
Frame::Stat(path) => {
out.extend_from_slice(&[STAT]);
// Its error is `Infallible`, and an empty match on one
// is how you say so: there is no value to handle.
path.encode(out).map_err(|error| match error {})
}
Frame::Truncate(truncate) => {
out.extend_from_slice(&[TRUNCATE]);
truncate.encode(out).map_err(|error| match error {})
}
Frame::Setattr(setattr) => {
out.extend_from_slice(&[SETATTR]);
setattr.encode(out).map_err(|error| match error {})
}
}
}
}
/// A mount ask that could not be written.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub enum FrameEncodeError {
/// A path of more bytes than a two-byte length prefix can say,
/// carrying how many there were. Only the asks where something
/// follows the path prefix it; a path that ends the payload takes
/// any length.
PathLength(usize),
}
impl fmt::Display for FrameEncodeError {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
match self {
FrameEncodeError::PathLength(len) => {
write!(f, "fuse path is {len} bytes, more than 65535")
}
}
}
}
impl std::error::Error for FrameEncodeError {}
impl<'a> Decode<'a> for Frame<'a> {
/// Four ways to fail, and none of them is a parse.
type Error = FrameError;
fn decode(bytes: &'a [u8]) -> Result<Self, Self::Error> {
let (tag, rest) = bytes.split_first().ok_or(FrameError::Empty)?;
match *tag {
READ => Read::decode(rest).map(Frame::Read),
WRITE => Write::decode(rest).map(Frame::Write),
LIST => Path::decode(rest).map(Frame::List),
REMOVE => Path::decode(rest).map(Frame::Remove),
RENAME => Rename::decode(rest).map(Frame::Rename),
MKDIR => Path::decode(rest).map(Frame::Mkdir),
STAT => Path::decode(rest).map(Frame::Stat),
TRUNCATE => Truncate::decode(rest).map(Frame::Truncate),
SETATTR => Setattr::decode(rest).map(Frame::Setattr),
tag => Err(FrameError::UnknownTag(tag)),
}
}
}
/// A mount ask that could not be read.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub enum FrameError {
/// No bytes at all, so not even a tag.
Empty,
/// A tag that is none of this frame's nine.
UnknownTag(u8),
/// Fewer bytes than the ask's fixed part promises — a length
/// prefix, the path a prefix said was there, an offset, a length,
/// a size, or the attributes.
Truncated,
/// A path that is not UTF-8.
PathUtf8,
}
impl fmt::Display for FrameError {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
match self {
FrameError::Empty => {
f.write_str("fuse mount channel request frame is empty")
}
FrameError::UnknownTag(tag) => {
write!(f, "unknown fuse mount channel request tag {tag}")
}
FrameError::Truncated => {
f.write_str("fuse ask is shorter than it promises")
}
FrameError::PathUtf8 => f.write_str("fuse path is not utf-8"),
}
}
}
impl std::error::Error for FrameError {}and by diverge-sdk-rs/src/container_proxy/outside/endpoints/fuse/mount/server/channel_request/path.rs:
//! What an ask names when a path is all of it.
use std::str;
use super::FrameError;
use crate::wire::encode::{Encode, Writer};
/// One entry of the mount: its path relative to the mount root —
/// empty for a file mount, and for a directory mount's root.
///
/// ```text
/// [path: utf8…]
/// ```
///
/// The path runs to the end of the payload, so it needs no prefix and
/// takes any length. This is the whole ask for
/// [`List`](super::Frame::List), [`Remove`](super::Frame::Remove),
/// [`Mkdir`](super::Frame::Mkdir) and [`Stat`](super::Frame::Stat),
/// each of which is answered by its own frame. The mount itself is the scope the ask rides.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Default)]
pub struct Path<'a> {
/// The entry's path inside the mount, `/`-separated, no leading
/// slash; empty is the mount itself.
pub path: &'a str,
}
impl Encode for Path<'_> {
/// [`Infallible`](std::convert::Infallible): the path's bytes are
/// already bytes.
type Error = std::convert::Infallible;
fn encode(&self, out: &mut Writer<'_>) -> Result<(), Self::Error> {
out.extend_from_slice(self.path.as_bytes());
Ok(())
}
}
impl<'a> Path<'a> {
/// Decode from the bytes after the ask's tag. The path borrows
/// from `bytes`.
pub fn decode(bytes: &'a [u8]) -> Result<Self, FrameError> {
Ok(Path {
path: str::from_utf8(bytes).map_err(|_| FrameError::PathUtf8)?,
})
}
}