diff --git a/xous-rs/src/buffer.rs b/xous-rs/src/buffer.rs new file mode 100644 index 000000000..47926a150 --- /dev/null +++ b/xous-rs/src/buffer.rs @@ -0,0 +1,130 @@ +use crate::{ + map_memory, send_message, Error, MemoryMessage, MemoryRange, MemorySize, Message, + Result, CID, +}; + +#[derive(Debug)] +pub struct XousBuffer<'a> { + range: MemoryRange, + valid: MemoryRange, + slice: &'a mut [u8], + should_drop: bool, +} + +impl<'a> XousBuffer<'a> { + #[allow(dead_code)] + pub fn new(len: usize) -> Self { + let remainder = if ((len & 0xFFF) == 0) && (len > 0) { + 0 + } else { + 0x1000 - (len & 0xFFF) + }; + + #[cfg(feature = "bit-flags")] + let flags = crate::MemoryFlags::R | crate::MemoryFlags::W; + #[cfg(not(feature = "bit-flags"))] + let flags = 0b0000_0010 | 0b0000_0100; + + let new_mem = map_memory( + None, + None, + // Ensure our byte size is a multiple of 4096 + len + remainder, + flags, + ) + .expect("XousBuffer: error in new()/map_memory"); + + let mut valid = new_mem; + valid.size = MemorySize::new(len + remainder).unwrap(); + XousBuffer { + range: new_mem, + slice: unsafe { + core::slice::from_raw_parts_mut(new_mem.as_mut_ptr(), len + remainder) + }, + valid, + should_drop: true, + } + } + + #[allow(dead_code)] + pub unsafe fn from_memory_message(mem: &'a MemoryMessage) -> Self { + XousBuffer { + range: mem.buf, + slice: core::slice::from_raw_parts_mut(mem.buf.as_mut_ptr(), mem.buf.len()), + valid: mem.buf, + should_drop: false, + } + } + + /// Perform a mutable lend of this Carton to the server. + #[allow(dead_code)] + pub fn lend_mut(&mut self, connection: CID, id: u32) -> core::result::Result { + let msg = MemoryMessage { + id: id as usize, + buf: self.valid, + offset: None, + valid: crate::MemorySize::new(self.slice.len()), + }; + send_message(connection, Message::MutableBorrow(msg)) + } + + #[allow(dead_code)] + pub fn lend(&self, connection: CID, id: u32) -> core::result::Result { + let msg = MemoryMessage { + id: id as usize, + buf: self.valid, + offset: None, + valid: crate::MemorySize::new(self.slice.len()), + }; + send_message(connection, Message::Borrow(msg)) + } + + #[allow(dead_code)] + pub fn send(mut self, connection: CID, id: u32) -> core::result::Result { + let msg = crate::MemoryMessage { + id: id as usize, + buf: self.valid, + offset: None, + valid: crate::MemorySize::new(self.slice.len()), + }; + let result = send_message(connection, Message::Move(msg))?; + + // prevents it from being Dropped. + self.should_drop = false; + Ok(result) + } +} + +impl<'a> core::convert::AsRef<[u8]> for XousBuffer<'a> { + fn as_ref(&self) -> &[u8] { + self.slice + } +} + +impl<'a> core::convert::AsMut<[u8]> for XousBuffer<'a> { + fn as_mut(&mut self) -> &mut [u8] { + self.slice + } +} + +impl<'a> core::ops::Deref for XousBuffer<'a> { + type Target = [u8]; + + fn deref(&self) -> &Self::Target { + &*self.slice + } +} + +impl<'a> core::ops::DerefMut for XousBuffer<'a> { + fn deref_mut(&mut self) -> &mut Self::Target { + &mut *self.slice + } +} + +impl<'a> Drop for XousBuffer<'a> { + fn drop(&mut self) { + if self.should_drop { + crate::unmap_memory(self.range).expect("XousBuffer: failed to drop memory"); + } + } +} diff --git a/xous-rs/src/lib.rs b/xous-rs/src/lib.rs index 4b178f993..ac5c90b3c 100644 --- a/xous-rs/src/lib.rs +++ b/xous-rs/src/lib.rs @@ -15,14 +15,18 @@ pub mod carton; pub mod definitions; mod messages; +pub mod buffer; pub mod process; +pub mod string; pub mod syscall; pub mod names; pub use arch::{ProcessArgs, ProcessInit, ProcessKey, ThreadInit}; +pub use buffer::XousBuffer; pub use definitions::*; pub use messages::*; +pub use string::*; pub use syscall::*; #[cfg(not(any(target_os = "none", target_os = "xous")))] diff --git a/xous-rs/src/string.rs b/xous-rs/src/string.rs new file mode 100644 index 000000000..44a8771c4 --- /dev/null +++ b/xous-rs/src/string.rs @@ -0,0 +1,189 @@ +use crate::Error; + +#[derive(Copy, Clone)] +pub struct String { + bytes: [u8; N], + len: u32, // length in bytes, not characters +} + +impl String { + pub fn new() -> String { + String { + bytes: [0; N], + len: 0, + } + } + + pub fn from_str(src: T) -> String + where + T: AsRef, + { + let src = src.as_ref(); + let mut s = Self::new(); + // Copy the string into our backing store. + for (&src_byte, dest_byte) in src.as_bytes().iter().zip(&mut s.bytes) { + *dest_byte = src_byte; + } + // Set the string length to the length of the passed-in String, + // or the maximum possible length. Which ever is smaller. + s.len = s.bytes.len().min(src.as_bytes().len()) as u32; + + // If the string is not valid, set its length to 0. + if s.as_str().is_err() { + s.len = 0; + } + + s + } + + pub fn as_bytes(&self) -> [u8; N] { + self.bytes + } + + pub fn as_str(&self) -> core::result::Result<&str, core::str::Utf8Error> { + core::str::from_utf8(&self.bytes[0..self.len as usize]) + } + + pub fn len(&self) -> usize { + self.len as usize + } + + pub fn is_empty(&self) -> bool { + self.len == 0 + } + + /// Clear the contents of this String and set the length to 0 + pub fn clear(&mut self) { + self.len = 0; + self.bytes = [0; N]; + } + + pub fn to_str(&self) -> &str { + unsafe { core::str::from_utf8_unchecked(&self.bytes[0..self.len()]) } + } + + /// awful, O(N) implementation because we have to iterate through the entire string + /// and decode variable-length utf8 characters, until we can't. + pub fn pop(&mut self) -> Option { + if self.len() < 1 { + return None; + } + // first, make a copy of the string + let tempbytes: [u8; N] = self.bytes; + let tempstr = unsafe { core::str::from_utf8_unchecked(&tempbytes[0..self.len()]) }.clone(); + // clear our own string + self.len = 0; + self.bytes = [0; N]; + + // now copy over character by character, until just before the last character + let mut char_iter = tempstr.chars(); + let mut maybe_c = char_iter.next(); + loop { + match maybe_c { + Some(c) => { + let next_c = char_iter.next(); + match next_c { + Some(_thing) => { + self.push(c).unwrap(); // always succeeds because we're re-encoding our string + maybe_c = next_c; + } + None => return next_c, + } + } + None => { + return None; // we should actually never get here because len() == 0 case already covered + } + } + } + } + + pub fn push(&mut self, ch: char) -> core::result::Result { + match ch.len_utf8() { + 1 => { + if self.len() < self.bytes.len() { + self.bytes[self.len()] = ch as u8; + self.len += 1; + Ok(1) + } else { + Err(Error::OutOfMemory) + } + } + _ => { + let mut bytes: usize = 0; + let mut data: [u8; 4] = [0; 4]; + let subslice = ch.encode_utf8(&mut data); + if self.len() + subslice.len() < self.bytes.len() { + for c in subslice.bytes() { + self.bytes[self.len()] = c; + self.len += 1; + bytes += 1; + } + Ok(bytes) + } else { + Err(Error::OutOfMemory) + } + } + } + } + + pub fn append(&mut self, s: &str) -> core::result::Result { + let mut bytes_added = 0; + for ch in s.chars() { + if let Ok(bytes) = self.push(ch) { + bytes_added += bytes; + } else { + return Err(Error::OutOfMemory); + } + } + Ok(bytes_added) + } + + pub fn push_byte(&mut self, b: u8) -> core::result::Result<(), Error> { + if self.len() < self.bytes.len() { + self.bytes[self.len()] = b; + self.len += 1; + Ok(()) + } else { + Err(Error::OutOfMemory) + } + } +} + +impl core::fmt::Display for String { + fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result { + write!(f, "{}", self.to_str()) + } +} + +impl core::fmt::Write for String { + fn write_str(&mut self, s: &str) -> core::result::Result<(), core::fmt::Error> { + for c in s.bytes() { + if self.len() < self.bytes.len() { + self.bytes[self.len()] = c; + self.len += 1; + } + } + Ok(()) + } +} + +impl core::fmt::Debug for String { + fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result { + write!(f, "{}", self.to_str()) + } +} + +impl core::convert::AsRef for String { + fn as_ref(&self) -> &str { + self.to_str() + } +} + +impl PartialEq for String { + fn eq(&self, other: &Self) -> bool { + self.bytes[..self.len as usize] == other.bytes[..other.len as usize] + && self.len == other.len + } +} + +impl Eq for String {}