diff --git a/hypha/src/error.rs b/hypha/src/error.rs index 4a8ead1..5609a45 100644 --- a/hypha/src/error.rs +++ b/hypha/src/error.rs @@ -7,7 +7,6 @@ use std::fmt::{Display, Formatter}; use std::num::ParseIntError; use std::path::StripPrefixError; use xenclient::XenClientError; -use xenstore::bus::XsdBusError; pub type Result = std::result::Result; @@ -117,8 +116,8 @@ impl From for HyphaError { } } -impl From for HyphaError { - fn from(value: XsdBusError) -> Self { +impl From for HyphaError { + fn from(value: xenstore::error::Error) -> Self { HyphaError::new(value.to_string().as_str()) } } diff --git a/xen/xenclient/src/lib.rs b/xen/xenclient/src/lib.rs index e84e27f..dc8fc78 100644 --- a/xen/xenclient/src/lib.rs +++ b/xen/xenclient/src/lib.rs @@ -20,7 +20,6 @@ use uuid::Uuid; use xencall::sys::CreateDomain; use xencall::{XenCall, XenCallError}; use xenevtchn::EventChannelError; -use xenstore::bus::XsdBusError; use xenstore::client::{ XsPermission, XsdClient, XsdInterface, XS_PERM_NONE, XS_PERM_READ, XS_PERM_READ_WRITE, }; @@ -61,8 +60,8 @@ impl From for XenClientError { } } -impl From for XenClientError { - fn from(value: XsdBusError) -> Self { +impl From for XenClientError { + fn from(value: xenstore::error::Error) -> Self { XenClientError::new(value.to_string().as_str()) } } diff --git a/xen/xenstore/examples/list.rs b/xen/xenstore/examples/list.rs index 9827d03..43ea294 100644 --- a/xen/xenstore/examples/list.rs +++ b/xen/xenstore/examples/list.rs @@ -1,8 +1,8 @@ -use xenstore::bus::XsdBusError; use xenstore::client::{XsdClient, XsdInterface}; +use xenstore::error::Result; use xenstore::sys::XSD_ERROR_EINVAL; -fn list_recursive(client: &mut XsdClient, level: usize, path: &str) -> Result<(), XsdBusError> { +fn list_recursive(client: &mut XsdClient, level: usize, path: &str) -> Result<()> { let children = match client.list(path) { Ok(children) => children, Err(error) => { @@ -28,7 +28,7 @@ fn list_recursive(client: &mut XsdClient, level: usize, path: &str) -> Result<() Ok(()) } -fn main() -> Result<(), XsdBusError> { +fn main() -> Result<()> { let mut client = XsdClient::open()?; list_recursive(&mut client, 0, "/")?; Ok(()) diff --git a/xen/xenstore/src/bus.rs b/xen/xenstore/src/bus.rs index cdd340c..db6cb08 100644 --- a/xen/xenstore/src/bus.rs +++ b/xen/xenstore/src/bus.rs @@ -1,15 +1,11 @@ +use crate::error::{Error, Result}; use crate::sys::{XsdMessageHeader, XSD_ERROR}; -use std::ffi::{CString, FromVecWithNulError, IntoStringError, NulError}; +use std::ffi::CString; use std::fs::metadata; -use std::io; use std::io::{Read, Write}; use std::mem::size_of; use std::net::Shutdown; -use std::num::ParseIntError; use std::os::unix::net::UnixStream; -use std::str::Utf8Error; -use std::string::FromUtf8Error; -use thiserror::Error; const XEN_BUS_PATHS: &[&str] = &["/var/run/xenstored/socket"]; @@ -23,30 +19,6 @@ fn find_bus_path() -> Option { None } -#[derive(Error, Debug)] -pub enum XsdBusError { - #[error("io issue encountered")] - Io(#[from] io::Error), - #[error("utf8 string decode failed")] - Utf8DecodeString(#[from] FromUtf8Error), - #[error("utf8 str decode failed")] - Utf8DecodeStr(#[from] Utf8Error), - #[error("unable to decode cstring as utf8")] - Utf8DecodeCstring(#[from] IntoStringError), - #[error("nul byte found in string")] - NulByteFoundString(#[from] NulError), - #[error("unable to find nul byte in vec")] - VecNulByteNotFound(#[from] FromVecWithNulError), - #[error("unable to parse integer")] - ParseInt(#[from] ParseIntError), - #[error("bus was not found on any available path")] - BusNotFound, - #[error("store responded with error: `{0}`")] - ResponseError(String), - #[error("invalid permissions provided")] - InvalidPermissions, -} - pub struct XsdSocket { handle: UnixStream, } @@ -58,11 +30,11 @@ pub struct XsdResponse { } impl XsdResponse { - pub fn parse_string(&self) -> Result { + pub fn parse_string(&self) -> Result { Ok(CString::from_vec_with_nul(self.payload.clone())?.into_string()?) } - pub fn parse_string_vec(&self) -> Result, XsdBusError> { + pub fn parse_string_vec(&self) -> Result> { let mut strings: Vec = Vec::new(); let mut buffer: Vec = Vec::new(); for b in &self.payload { @@ -77,22 +49,22 @@ impl XsdResponse { Ok(strings) } - pub fn parse_bool(&self) -> Result { + pub fn parse_bool(&self) -> Result { Ok(true) } } impl XsdSocket { - pub fn dial() -> Result { + pub fn dial() -> Result { let path = match find_bus_path() { Some(path) => path, - None => return Err(XsdBusError::BusNotFound), + None => return Err(Error::BusNotFound), }; let stream = UnixStream::connect(path)?; Ok(XsdSocket { handle: stream }) } - pub fn send(&mut self, tx: u32, typ: u32, buf: &[u8]) -> Result { + pub fn send(&mut self, tx: u32, typ: u32, buf: &[u8]) -> Result { let header = XsdMessageHeader { typ, req: 0, @@ -108,29 +80,19 @@ impl XsdSocket { self.handle.read_exact(payload.as_mut_slice())?; if result_header.typ == XSD_ERROR { let error = CString::from_vec_with_nul(payload)?; - return Err(XsdBusError::ResponseError(error.into_string()?)); + return Err(Error::ResponseError(error.into_string()?)); } let response = XsdResponse { header, payload }; Ok(response) } - pub fn send_single( - &mut self, - tx: u32, - typ: u32, - string: &str, - ) -> Result { + pub fn send_single(&mut self, tx: u32, typ: u32, string: &str) -> Result { let text = CString::new(string)?; let buf = text.as_bytes_with_nul(); self.send(tx, typ, buf) } - pub fn send_multiple( - &mut self, - tx: u32, - typ: u32, - array: &[&str], - ) -> Result { + pub fn send_multiple(&mut self, tx: u32, typ: u32, array: &[&str]) -> Result { let mut buf: Vec = Vec::new(); for item in array { buf.extend_from_slice(item.as_bytes()); diff --git a/xen/xenstore/src/client.rs b/xen/xenstore/src/client.rs index cad60bc..745107b 100644 --- a/xen/xenstore/src/client.rs +++ b/xen/xenstore/src/client.rs @@ -1,4 +1,5 @@ -use crate::bus::{XsdBusError, XsdSocket}; +use crate::bus::XsdSocket; +use crate::error::{Error, Result}; use crate::sys::{ XSD_DIRECTORY, XSD_GET_DOMAIN_PATH, XSD_INTRODUCE, XSD_MKDIR, XSD_READ, XSD_RM, XSD_SET_PERMS, XSD_TRANSACTION_END, XSD_TRANSACTION_START, XSD_WRITE, @@ -22,35 +23,35 @@ pub struct XsPermission { } impl XsPermission { - pub fn encode(&self) -> Result { + pub fn encode(&self) -> Result { let c = match self.perms { XS_PERM_READ_WRITE => 'b', XS_PERM_WRITE => 'w', XS_PERM_READ => 'r', XS_PERM_NONE => 'n', - _ => return Err(XsdBusError::InvalidPermissions), + _ => return Err(Error::InvalidPermissions), }; Ok(format!("{}{}", c, self.id)) } } pub trait XsdInterface { - fn list(&mut self, path: &str) -> Result, XsdBusError>; - fn read(&mut self, path: &str) -> Result, XsdBusError>; - fn read_string(&mut self, path: &str) -> Result; - fn write(&mut self, path: &str, data: Vec) -> Result; - fn write_string(&mut self, path: &str, data: &str) -> Result; - fn mkdir(&mut self, path: &str) -> Result; - fn rm(&mut self, path: &str) -> Result; - fn set_perms(&mut self, path: &str, perms: &[XsPermission]) -> Result; + fn list(&mut self, path: &str) -> Result>; + fn read(&mut self, path: &str) -> Result>; + fn read_string(&mut self, path: &str) -> Result; + fn write(&mut self, path: &str, data: Vec) -> Result; + fn write_string(&mut self, path: &str, data: &str) -> Result; + fn mkdir(&mut self, path: &str) -> Result; + fn rm(&mut self, path: &str) -> Result; + fn set_perms(&mut self, path: &str, perms: &[XsPermission]) -> Result; - fn mknod(&mut self, path: &str, perms: &[XsPermission]) -> Result { + fn mknod(&mut self, path: &str, perms: &[XsPermission]) -> Result { let result1 = self.write_string(path, "")?; let result2 = self.set_perms(path, perms)?; Ok(result1 && result2) } - fn read_string_optional(&mut self, path: &str) -> Result, XsdBusError> { + fn read_string_optional(&mut self, path: &str) -> Result> { Ok(match self.read_string(path) { Ok(value) => Some(value), Err(error) => { @@ -63,7 +64,7 @@ pub trait XsdInterface { }) } - fn list_any(&mut self, path: &str) -> Result, XsdBusError> { + fn list_any(&mut self, path: &str) -> Result> { Ok(match self.list(path) { Ok(value) => value, Err(error) => { @@ -78,24 +79,24 @@ pub trait XsdInterface { } impl XsdClient { - pub fn open() -> Result { + pub fn open() -> Result { let socket = XsdSocket::dial()?; Ok(XsdClient { socket }) } - fn list(&mut self, tx: u32, path: &str) -> Result, XsdBusError> { + fn list(&mut self, tx: u32, path: &str) -> Result> { trace!("list tx={tx} path={path}"); let response = self.socket.send_single(tx, XSD_DIRECTORY, path)?; response.parse_string_vec() } - fn read(&mut self, tx: u32, path: &str) -> Result, XsdBusError> { + fn read(&mut self, tx: u32, path: &str) -> Result> { trace!("read tx={tx} path={path}"); let response = self.socket.send_single(tx, XSD_READ, path)?; Ok(response.payload) } - fn write(&mut self, tx: u32, path: &str, data: Vec) -> Result { + fn write(&mut self, tx: u32, path: &str, data: Vec) -> Result { trace!("write tx={tx} path={path} data={:?}", data); let mut buffer = Vec::new(); let path = CString::new(path)?; @@ -105,12 +106,12 @@ impl XsdClient { response.parse_bool() } - fn mkdir(&mut self, tx: u32, path: &str) -> Result { + fn mkdir(&mut self, tx: u32, path: &str) -> Result { trace!("mkdir tx={tx} path={path}"); self.socket.send_single(tx, XSD_MKDIR, path)?.parse_bool() } - fn rm(&mut self, tx: u32, path: &str) -> Result { + fn rm(&mut self, tx: u32, path: &str) -> Result { trace!("rm tx={tx} path={path}"); let result = self.socket.send_single(tx, XSD_RM, path); if let Err(error) = result { @@ -122,12 +123,7 @@ impl XsdClient { result.unwrap().parse_bool() } - fn set_perms( - &mut self, - tx: u32, - path: &str, - perms: &[XsPermission], - ) -> Result { + fn set_perms(&mut self, tx: u32, path: &str, perms: &[XsPermission]) -> Result { trace!("set_perms tx={tx} path={path} perms={:?}", perms); let mut items: Vec = Vec::new(); items.push(path.to_string()); @@ -139,7 +135,7 @@ impl XsdClient { response.parse_bool() } - pub fn transaction(&mut self) -> Result { + pub fn transaction(&mut self) -> Result { trace!("transaction start"); let response = self.socket.send_single(0, XSD_TRANSACTION_START, "")?; let str = response.parse_string()?; @@ -147,19 +143,14 @@ impl XsdClient { Ok(XsdTransaction { client: self, tx }) } - pub fn get_domain_path(&mut self, domid: u32) -> Result { + pub fn get_domain_path(&mut self, domid: u32) -> Result { let response = self.socket .send_single(0, XSD_GET_DOMAIN_PATH, domid.to_string().as_str())?; response.parse_string() } - pub fn introduce_domain( - &mut self, - domid: u32, - mfn: u64, - evtchn: u32, - ) -> Result { + pub fn introduce_domain(&mut self, domid: u32, mfn: u64, evtchn: u32) -> Result { trace!("introduce domain domid={domid} mfn={mfn} evtchn={evtchn}"); let response = self.socket.send_multiple( 0, @@ -180,75 +171,75 @@ pub struct XsdTransaction<'a> { } impl XsdInterface for XsdClient { - fn list(&mut self, path: &str) -> Result, XsdBusError> { + fn list(&mut self, path: &str) -> Result> { self.list(0, path) } - fn read(&mut self, path: &str) -> Result, XsdBusError> { + fn read(&mut self, path: &str) -> Result> { self.read(0, path) } - fn read_string(&mut self, path: &str) -> Result { + fn read_string(&mut self, path: &str) -> Result { Ok(String::from_utf8(self.read(0, path)?)?) } - fn write(&mut self, path: &str, data: Vec) -> Result { + fn write(&mut self, path: &str, data: Vec) -> Result { self.write(0, path, data) } - fn write_string(&mut self, path: &str, data: &str) -> Result { + fn write_string(&mut self, path: &str, data: &str) -> Result { self.write(0, path, data.as_bytes().to_vec()) } - fn mkdir(&mut self, path: &str) -> Result { + fn mkdir(&mut self, path: &str) -> Result { self.mkdir(0, path) } - fn rm(&mut self, path: &str) -> Result { + fn rm(&mut self, path: &str) -> Result { self.rm(0, path) } - fn set_perms(&mut self, path: &str, perms: &[XsPermission]) -> Result { + fn set_perms(&mut self, path: &str, perms: &[XsPermission]) -> Result { self.set_perms(0, path, perms) } } impl XsdInterface for XsdTransaction<'_> { - fn list(&mut self, path: &str) -> Result, XsdBusError> { + fn list(&mut self, path: &str) -> Result> { self.client.list(self.tx, path) } - fn read(&mut self, path: &str) -> Result, XsdBusError> { + fn read(&mut self, path: &str) -> Result> { self.client.read(self.tx, path) } - fn read_string(&mut self, path: &str) -> Result { + fn read_string(&mut self, path: &str) -> Result { Ok(String::from_utf8(self.client.read(self.tx, path)?)?) } - fn write(&mut self, path: &str, data: Vec) -> Result { + fn write(&mut self, path: &str, data: Vec) -> Result { self.client.write(self.tx, path, data) } - fn write_string(&mut self, path: &str, data: &str) -> Result { + fn write_string(&mut self, path: &str, data: &str) -> Result { self.client.write(self.tx, path, data.as_bytes().to_vec()) } - fn mkdir(&mut self, path: &str) -> Result { + fn mkdir(&mut self, path: &str) -> Result { self.client.mkdir(self.tx, path) } - fn rm(&mut self, path: &str) -> Result { + fn rm(&mut self, path: &str) -> Result { self.client.rm(self.tx, path) } - fn set_perms(&mut self, path: &str, perms: &[XsPermission]) -> Result { + fn set_perms(&mut self, path: &str, perms: &[XsPermission]) -> Result { self.client.set_perms(self.tx, path, perms) } } impl XsdTransaction<'_> { - pub fn end(&mut self, abort: bool) -> Result { + pub fn end(&mut self, abort: bool) -> Result { let abort_str = if abort { "F" } else { "T" }; trace!("transaction end abort={}", abort); @@ -258,11 +249,11 @@ impl XsdTransaction<'_> { .parse_bool() } - pub fn commit(&mut self) -> Result { + pub fn commit(&mut self) -> Result { self.end(false) } - pub fn abort(&mut self) -> Result { + pub fn abort(&mut self) -> Result { self.end(true) } } diff --git a/xen/xenstore/src/error.rs b/xen/xenstore/src/error.rs new file mode 100644 index 0000000..50f12ef --- /dev/null +++ b/xen/xenstore/src/error.rs @@ -0,0 +1,31 @@ +use std::ffi::{FromVecWithNulError, IntoStringError, NulError}; +use std::io; +use std::num::ParseIntError; +use std::str::Utf8Error; +use std::string::FromUtf8Error; + +#[derive(thiserror::Error, Debug)] +pub enum Error { + #[error("io issue encountered")] + Io(#[from] io::Error), + #[error("utf8 string decode failed")] + Utf8DecodeString(#[from] FromUtf8Error), + #[error("utf8 str decode failed")] + Utf8DecodeStr(#[from] Utf8Error), + #[error("unable to decode cstring as utf8")] + Utf8DecodeCstring(#[from] IntoStringError), + #[error("nul byte found in string")] + NulByteFoundString(#[from] NulError), + #[error("unable to find nul byte in vec")] + VecNulByteNotFound(#[from] FromVecWithNulError), + #[error("unable to parse integer")] + ParseInt(#[from] ParseIntError), + #[error("bus was not found on any available path")] + BusNotFound, + #[error("store responded with error: `{0}`")] + ResponseError(String), + #[error("invalid permissions provided")] + InvalidPermissions, +} + +pub type Result = std::result::Result; diff --git a/xen/xenstore/src/lib.rs b/xen/xenstore/src/lib.rs index 594ae47..6daf7f0 100644 --- a/xen/xenstore/src/lib.rs +++ b/xen/xenstore/src/lib.rs @@ -1,3 +1,4 @@ pub mod bus; pub mod client; +pub mod error; pub mod sys; diff --git a/xen/xenstore/src/sys.rs b/xen/xenstore/src/sys.rs index 526a45b..27e398a 100644 --- a/xen/xenstore/src/sys.rs +++ b/xen/xenstore/src/sys.rs @@ -1,6 +1,6 @@ -use bytemuck::{Pod, Zeroable}; /// Handwritten protocol definitions for XenStore. /// Used xen/include/public/io/xs_wire.h as a reference. +use bytemuck::{Pod, Zeroable}; use libc; #[derive(Copy, Clone, Pod, Zeroable, Debug)]