xous: add offset and valid to returned memory

This will enable us to have more information about the result that is
returned when mutable memory is modified by a server.

Signed-off-by: Sean Cross <sean@xobs.io>
This commit is contained in:
Sean Cross 2021-03-25 13:16:15 +08:00
parent 52c993556f
commit c7b2b2cab0
3 changed files with 77 additions and 29 deletions

View file

@ -260,6 +260,8 @@ fn return_memory(
in_irq: bool, in_irq: bool,
sender: MessageSender, sender: MessageSender,
buf: MemoryRange, buf: MemoryRange,
offset: Option<MemorySize>,
valid: Option<MemorySize>,
) -> SysCallResult { ) -> SysCallResult {
SystemServices::with_mut(|ss| { SystemServices::with_mut(|ss| {
let sender = SenderID::from(sender); let sender = SenderID::from(sender);
@ -339,7 +341,7 @@ fn return_memory(
// print!(" [waking up PID {}:{}]", client_pid, client_tid); // print!(" [waking up PID {}:{}]", client_pid, client_tid);
ss.ready_thread(client_pid, client_tid)?; ss.ready_thread(client_pid, client_tid)?;
ss.switch_to_thread(client_pid, Some(client_tid))?; ss.switch_to_thread(client_pid, Some(client_tid))?;
ss.set_thread_result(client_pid, client_tid, xous_kernel::Result::Ok)?; ss.set_thread_result(client_pid, client_tid, xous_kernel::Result::MemoryReturned(offset, valid))?;
// Return success to the server // Return success to the server
Ok(xous_kernel::Result::Ok) Ok(xous_kernel::Result::Ok)
@ -352,7 +354,7 @@ fn return_memory(
// Switch to the client // Switch to the client
ss.ready_thread(client_pid, client_tid)?; ss.ready_thread(client_pid, client_tid)?;
ss.switch_to_thread(client_pid, Some(client_tid))?; ss.switch_to_thread(client_pid, Some(client_tid))?;
Ok(xous_kernel::Result::Ok) Ok(xous_kernel::Result::MemoryReturned(offset, valid))
} }
}) })
} }
@ -780,7 +782,7 @@ pub fn handle_inner(pid: PID, tid: TID, in_irq: bool, call: SysCall) -> SysCallR
ss.connect_to_server(sid) ss.connect_to_server(sid)
.map(xous_kernel::Result::ConnectionID) .map(xous_kernel::Result::ConnectionID)
}), }),
SysCall::ReturnMemory(sender, buf) => return_memory(pid, tid, in_irq, sender, buf), SysCall::ReturnMemory(sender, buf, offset, valid) => return_memory(pid, tid, in_irq, sender, buf, offset, valid),
SysCall::ReturnScalar1(sender, arg) => return_scalar(pid, tid, in_irq, sender, arg), SysCall::ReturnScalar1(sender, arg) => return_scalar(pid, tid, in_irq, sender, arg),
SysCall::ReturnScalar2(sender, arg1, arg2) => { SysCall::ReturnScalar2(sender, arg1, arg2) => {
return_scalar2(pid, tid, in_irq, sender, arg1, arg2) return_scalar2(pid, tid, in_irq, sender, arg1, arg2)

View file

@ -414,14 +414,16 @@ impl Message {
impl TryFrom<(usize, usize, usize, usize, usize, usize)> for Message { impl TryFrom<(usize, usize, usize, usize, usize, usize)> for Message {
type Error = (); type Error = ();
fn try_from(value: (usize, usize, usize, usize, usize, usize)) -> core::result::Result<Self, Self::Error> { fn try_from(
value: (usize, usize, usize, usize, usize, usize),
) -> core::result::Result<Self, Self::Error> {
match value.0 { match value.0 {
1 => Ok(Message::MutableBorrow(MemoryMessage { 1 => Ok(Message::MutableBorrow(MemoryMessage {
id: value.1, id: value.1,
buf: MemoryRange::new(value.2, value.3).map_err(|_| ())?, buf: MemoryRange::new(value.2, value.3).map_err(|_| ())?,
offset: MemoryAddress::new(value.4), offset: MemoryAddress::new(value.4),
valid: MemorySize::new(value.5), valid: MemorySize::new(value.5),
})), })),
2 => Ok(Message::Borrow(MemoryMessage { 2 => Ok(Message::Borrow(MemoryMessage {
id: value.1, id: value.1,
buf: MemoryRange::new(value.2, value.3).map_err(|_| ())?, buf: MemoryRange::new(value.2, value.3).map_err(|_| ())?,
@ -433,14 +435,14 @@ impl TryFrom<(usize, usize, usize, usize, usize, usize)> for Message {
buf: MemoryRange::new(value.2, value.3).map_err(|_| ())?, buf: MemoryRange::new(value.2, value.3).map_err(|_| ())?,
offset: MemoryAddress::new(value.4), offset: MemoryAddress::new(value.4),
valid: MemorySize::new(value.5), valid: MemorySize::new(value.5),
})), })),
4 => Ok(Message::Scalar(ScalarMessage { 4 => Ok(Message::Scalar(ScalarMessage {
id: value.1, id: value.1,
arg1: value.2, arg1: value.2,
arg2: value.3, arg2: value.3,
arg3: value.4, arg3: value.4,
arg4: value.5, arg4: value.5,
})), })),
5 => Ok(Message::BlockingScalar(ScalarMessage { 5 => Ok(Message::BlockingScalar(ScalarMessage {
id: value.1, id: value.1,
arg1: value.2, arg1: value.2,
@ -616,6 +618,12 @@ pub enum Result {
/// The message was successful but no value was returned. /// The message was successful but no value was returned.
None, None,
/// Memory was returned, and more information is available.
MemoryReturned(
Option<MemorySize>, /* offset */
Option<MemorySize>, /* valid */
),
UnknownResult(usize, usize, usize, usize, usize, usize, usize), UnknownResult(usize, usize, usize, usize, usize, usize, usize),
} }
@ -662,6 +670,16 @@ impl Result {
} }
Result::WouldBlock => [16, 0, 0, 0, 0, 0, 0, 0], Result::WouldBlock => [16, 0, 0, 0, 0, 0, 0, 0],
Result::None => [17, 0, 0, 0, 0, 0, 0, 0], Result::None => [17, 0, 0, 0, 0, 0, 0, 0],
Result::MemoryReturned(offset, valid) => [
18,
offset.map(|o| o.get()).unwrap_or_default(),
valid.map(|v| v.get()).unwrap_or_default(),
0,
0,
0,
0,
0,
],
Result::UnknownResult(arg1, arg2, arg3, arg4, arg5, arg6, arg7) => { Result::UnknownResult(arg1, arg2, arg3, arg4, arg5, arg6, arg7) => {
[usize::MAX, *arg1, *arg2, *arg3, *arg4, *arg5, *arg6, *arg7] [usize::MAX, *arg1, *arg2, *arg3, *arg4, *arg5, *arg6, *arg7]
} }
@ -737,6 +755,7 @@ impl Result {
), ),
16 => Result::WouldBlock, 16 => Result::WouldBlock,
17 => Result::None, 17 => Result::None,
18 => Result::MemoryReturned(MemorySize::new(src[1]), MemorySize::new(src[2])),
_ => Result::UnknownResult(src[0], src[1], src[2], src[3], src[4], src[5], src[6]), _ => Result::UnknownResult(src[0], src[1], src[2], src[3], src[4], src[5], src[6]),
} }
} }

View file

@ -3,7 +3,7 @@ use crate::{
MemorySize, MemoryType, Message, MessageEnvelope, MessageSender, ProcessArgs, ProcessInit, MemorySize, MemoryType, Message, MessageEnvelope, MessageSender, ProcessArgs, ProcessInit,
Result, ScalarMessage, SysCallResult, ThreadInit, CID, PID, SID, TID, Result, ScalarMessage, SysCallResult, ThreadInit, CID, PID, SID, TID,
}; };
use core::convert::{TryInto, TryFrom}; use core::convert::{TryFrom, TryInto};
// use num_derive::FromPrimitive; // use num_derive::FromPrimitive;
// use num_traits::FromPrimitive; // use num_traits::FromPrimitive;
@ -253,7 +253,12 @@ pub enum SysCall {
TrySendMessage(CID, Message), TrySendMessage(CID, Message),
/// Return a Borrowed memory region to the sender /// Return a Borrowed memory region to the sender
ReturnMemory(MessageSender, MemoryRange), ReturnMemory(
MessageSender, /* source of this message */
MemoryRange, /* address of range */
Option<MemorySize>, /* offset */
Option<MemorySize>, /* valid */
),
/// Return a scalar to the sender /// Return a scalar to the sender
ReturnScalar1(MessageSender, usize), ReturnScalar1(MessageSender, usize),
@ -597,13 +602,13 @@ impl SysCall {
sc.arg4, sc.arg4,
], ],
}, },
SysCall::ReturnMemory(sender, buf) => [ SysCall::ReturnMemory(sender, buf, offset, valid) => [
SysCallNumber::ReturnMemory as usize, SysCallNumber::ReturnMemory as usize,
sender.to_usize(), sender.to_usize(),
buf.as_ptr() as usize, buf.as_ptr() as usize,
buf.len(), buf.len(),
0, offset.map(|o| o.get()).unwrap_or_default(),
0, valid.map(|v| v.get()).unwrap_or_default(),
0, 0,
0, 0,
], ],
@ -758,9 +763,12 @@ impl SysCall {
SysCallNumber::SendMessage => Message::try_from((a2, a3, a4, a5, a6, a7)) SysCallNumber::SendMessage => Message::try_from((a2, a3, a4, a5, a6, a7))
.map(|m| SysCall::SendMessage(a1.try_into().unwrap(), m)) .map(|m| SysCall::SendMessage(a1.try_into().unwrap(), m))
.unwrap_or_else(|_| SysCall::Invalid(a1, a2, a3, a4, a5, a6, a7)), .unwrap_or_else(|_| SysCall::Invalid(a1, a2, a3, a4, a5, a6, a7)),
SysCallNumber::ReturnMemory => { SysCallNumber::ReturnMemory => SysCall::ReturnMemory(
SysCall::ReturnMemory(MessageSender::from_usize(a1), MemoryRange::new(a2, a3)?) MessageSender::from_usize(a1),
} MemoryRange::new(a2, a3)?,
MemorySize::new(a4),
MemorySize::new(a5),
),
SysCallNumber::CreateThread => { SysCallNumber::CreateThread => {
SysCall::CreateThread(crate::arch::args_to_thread(a1, a2, a3, a4, a5, a6, a7)?) SysCall::CreateThread(crate::arch::args_to_thread(a1, a2, a3, a4, a5, a6, a7)?)
} }
@ -848,7 +856,7 @@ impl SysCall {
Message::Move(_) | Message::Borrow(_) | Message::MutableBorrow(_) Message::Move(_) | Message::Borrow(_) | Message::MutableBorrow(_)
) )
} }
SysCall::ReturnMemory(_, _) => true, SysCall::ReturnMemory(_, _, _, _) => true,
_ => false, _ => false,
} }
} }
@ -885,7 +893,7 @@ impl SysCall {
/// Returns `true` if the associated syscall is returning memory /// Returns `true` if the associated syscall is returning memory
pub fn is_return_memory(&self) -> bool { pub fn is_return_memory(&self) -> bool {
matches!(self, SysCall::ReturnMemory(_, _)) matches!(self, SysCall::ReturnMemory(_, _, _, _))
} }
/// If the syscall has memory attached to it, return the memory /// If the syscall has memory attached to it, return the memory
@ -897,7 +905,7 @@ impl SysCall {
| Message::MutableBorrow(memory_message) => Some(memory_message.buf), | Message::MutableBorrow(memory_message) => Some(memory_message.buf),
_ => None, _ => None,
}, },
SysCall::ReturnMemory(_, range) => Some(*range), SysCall::ReturnMemory(_, range, _, _) => Some(*range),
_ => None, _ => None,
} }
} }
@ -912,7 +920,7 @@ impl SysCall {
| SysCall::ReturnToParent(_, _) | SysCall::ReturnToParent(_, _)
| SysCall::ReturnScalar2(_, _, _) | SysCall::ReturnScalar2(_, _, _)
| SysCall::ReturnScalar1(_, _) | SysCall::ReturnScalar1(_, _)
| SysCall::ReturnMemory(_, _) | SysCall::ReturnMemory(_, _, _, _)
) )
} }
} }
@ -986,7 +994,24 @@ pub fn unmap_memory(range: MemoryRange) -> core::result::Result<(), Error> {
/// Map the given physical address to the given virtual address. /// Map the given physical address to the given virtual address.
/// The `size` field must be page-aligned. /// The `size` field must be page-aligned.
pub fn return_memory(sender: MessageSender, mem: MemoryRange) -> core::result::Result<(), Error> { pub fn return_memory(sender: MessageSender, mem: MemoryRange) -> core::result::Result<(), Error> {
let result = rsyscall(SysCall::ReturnMemory(sender, mem))?; let result = rsyscall(SysCall::ReturnMemory(sender, mem, None, None))?;
if let crate::Result::Ok = result {
Ok(())
} else if let Result::Error(e) = result {
Err(e)
} else {
Err(Error::InternalError)
}
}
/// Map the given physical address to the given virtual address.
/// The `size` field must be page-aligned.
pub fn return_memory_offset(
sender: MessageSender,
mem: MemoryRange,
offset: Option<MemorySize>,
) -> core::result::Result<(), Error> {
let result = rsyscall(SysCall::ReturnMemory(sender, mem, offset, None))?;
if let crate::Result::Ok = result { if let crate::Result::Ok = result {
Ok(()) Ok(())
} else if let Result::Error(e) = result { } else if let Result::Error(e) = result {
@ -1206,6 +1231,7 @@ pub fn try_send_message(connection: CID, message: Message) -> core::result::Resu
Ok(Result::Ok) => Ok(Result::Ok), Ok(Result::Ok) => Ok(Result::Ok),
Ok(Result::Scalar1(a)) => Ok(Result::Scalar1(a)), Ok(Result::Scalar1(a)) => Ok(Result::Scalar1(a)),
Ok(Result::Scalar2(a, b)) => Ok(Result::Scalar2(a, b)), Ok(Result::Scalar2(a, b)) => Ok(Result::Scalar2(a, b)),
Ok(Result::MemoryReturned(offset, valid)) => Ok(Result::MemoryReturned(offset, valid)),
Err(e) => Err(e), Err(e) => Err(e),
v => panic!("Unexpected return value: {:?}", v), v => panic!("Unexpected return value: {:?}", v),
} }
@ -1247,6 +1273,7 @@ pub fn send_message(connection: CID, message: Message) -> core::result::Result<R
Ok(Result::Ok) => Ok(Result::Ok), Ok(Result::Ok) => Ok(Result::Ok),
Ok(Result::Scalar1(a)) => Ok(Result::Scalar1(a)), Ok(Result::Scalar1(a)) => Ok(Result::Scalar1(a)),
Ok(Result::Scalar2(a, b)) => Ok(Result::Scalar2(a, b)), Ok(Result::Scalar2(a, b)) => Ok(Result::Scalar2(a, b)),
Ok(Result::MemoryReturned(offset, valid)) => Ok(Result::MemoryReturned(offset, valid)),
Err(e) => Err(e), Err(e) => Err(e),
v => panic!("Unexpected return value: {:?}", v), v => panic!("Unexpected return value: {:?}", v),
} }