mirror of
https://github.com/Astatin3/unshell.git
synced 2026-06-08 22:38:01 -06:00
Add stateful call leaf runtime
This commit is contained in:
@@ -195,7 +195,9 @@ pub fn run_hook_data_receive(iterations: usize) -> usize {
|
|||||||
.receive(&Ingress::Child(path(&["worker"])), frame)
|
.receive(&Ingress::Child(path(&["worker"])), frame)
|
||||||
.expect("hook data should work");
|
.expect("hook data should work");
|
||||||
match outcome.event {
|
match outcome.event {
|
||||||
Some(LocalEvent::Data { header, message }) => {
|
Some(LocalEvent::Data {
|
||||||
|
header, message, ..
|
||||||
|
}) => {
|
||||||
checksum = checksum
|
checksum = checksum
|
||||||
.wrapping_add(header.hook_id.unwrap_or_default() as usize)
|
.wrapping_add(header.hook_id.unwrap_or_default() as usize)
|
||||||
.wrapping_add(message.data.len())
|
.wrapping_add(message.data.len())
|
||||||
|
|||||||
@@ -1,46 +1,101 @@
|
|||||||
use std::error::Error;
|
use std::error::Error;
|
||||||
|
use std::{convert::Infallible, string::String};
|
||||||
|
|
||||||
use unshell::Leaf;
|
use rkyv::{Archive, Deserialize, Serialize};
|
||||||
use unshell::protocol::tree::{Endpoint, Ingress, LocalEvent, ProtocolEndpoint};
|
use unshell::protocol::tree::{Call, CallLeaf, Ingress, LeafRuntime, ProtocolEndpoint};
|
||||||
|
use unshell::protocol::tree::{ChildRoute, ConnectionState};
|
||||||
|
use unshell::protocol::{PacketType, decode_frame};
|
||||||
|
use unshell::{Leaf, procedures};
|
||||||
|
|
||||||
#[derive(Leaf)]
|
#[derive(Leaf)]
|
||||||
#[leaf(org = "org", product = "example", version = "v1", leaf_name = "echo")]
|
#[leaf(org = "org", product = "example", version = "v1", leaf_name = "echo")]
|
||||||
#[leaf(procedures(call, stream))]
|
struct EchoLeaf {
|
||||||
struct EchoLeaf;
|
prefix: String,
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Archive, Serialize, Deserialize, Debug, Clone, PartialEq, Eq)]
|
||||||
|
struct EchoRequest {
|
||||||
|
text: String,
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Archive, Serialize, Deserialize, Debug, Clone, PartialEq, Eq)]
|
||||||
|
struct EchoResponse {
|
||||||
|
text: String,
|
||||||
|
}
|
||||||
|
|
||||||
|
#[procedures(error = Infallible)]
|
||||||
|
impl EchoLeaf {
|
||||||
|
#[call]
|
||||||
|
fn echo(&mut self, request: Call<EchoRequest>) -> EchoResponse {
|
||||||
|
EchoResponse {
|
||||||
|
text: format!("{}{}", self.prefix, request.input.text),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl CallLeaf for EchoLeaf {
|
||||||
|
type Error = Infallible;
|
||||||
|
}
|
||||||
|
|
||||||
fn path(parts: &[&str]) -> Vec<String> {
|
fn path(parts: &[&str]) -> Vec<String> {
|
||||||
parts.iter().map(|part| (*part).to_owned()).collect()
|
parts.iter().map(|part| (*part).to_owned()).collect()
|
||||||
}
|
}
|
||||||
|
|
||||||
fn main() -> Result<(), Box<dyn Error>> {
|
fn main() -> Result<(), Box<dyn Error>> {
|
||||||
let mut endpoint = ProtocolEndpoint::new(
|
let endpoint = ProtocolEndpoint::new(
|
||||||
path(&["agent"]),
|
path(&["agent"]),
|
||||||
Some(Vec::new()),
|
Some(Vec::new()),
|
||||||
Vec::new(),
|
Vec::new(),
|
||||||
vec![EchoLeaf::protocol_leaf_spec()],
|
vec![EchoLeaf::protocol_leaf_spec()],
|
||||||
);
|
);
|
||||||
|
let mut runtime = LeafRuntime::new(
|
||||||
|
endpoint,
|
||||||
|
EchoLeaf {
|
||||||
|
prefix: String::from("echo: "),
|
||||||
|
},
|
||||||
|
);
|
||||||
|
|
||||||
let hook_id = endpoint.allocate_hook_id();
|
let mut controller = ProtocolEndpoint::new(
|
||||||
let frame = endpoint.make_call(
|
Vec::new(),
|
||||||
|
None,
|
||||||
|
vec![ChildRoute {
|
||||||
|
path: path(&["agent"]),
|
||||||
|
state: ConnectionState::Registered,
|
||||||
|
}],
|
||||||
|
Vec::new(),
|
||||||
|
);
|
||||||
|
let hook_id = controller.allocate_hook_id();
|
||||||
|
let controller_outcome = controller.send_call(
|
||||||
path(&["agent"]),
|
path(&["agent"]),
|
||||||
Some(EchoLeaf::protocol_leaf_name()),
|
Some(EchoLeaf::protocol_leaf_name()),
|
||||||
EchoLeaf::protocol_procedure_id("call").expect("known procedure suffix"),
|
EchoLeaf::protocol_procedure_id("echo").expect("known procedure suffix"),
|
||||||
Some(hook_id),
|
Some(hook_id),
|
||||||
b"hello leaf".to_vec(),
|
unshell::protocol::tree::encode_call_reply(&EchoRequest {
|
||||||
|
text: String::from("hello leaf"),
|
||||||
|
})?,
|
||||||
)?;
|
)?;
|
||||||
|
let Some((_, frame)) = controller_outcome.forward else {
|
||||||
let outcome = endpoint.receive(&Ingress::Parent, frame)?;
|
return Err("expected controller to forward call".into());
|
||||||
let Some(LocalEvent::Call { header, message }) = outcome.event else {
|
|
||||||
return Err("expected local leaf call".into());
|
|
||||||
};
|
};
|
||||||
|
|
||||||
assert_eq!(header.dst_leaf.as_deref(), Some("org.example.v1.echo"));
|
let outcome = runtime.receive(&Ingress::Parent, frame)?;
|
||||||
assert_eq!(message.procedure_id, "org.example.v1.echo.call");
|
let [response_frame] = outcome.frames.as_slice() else {
|
||||||
|
return Err("expected one response frame".into());
|
||||||
|
};
|
||||||
|
let parsed = decode_frame(response_frame.as_slice())?;
|
||||||
|
assert_eq!(parsed.packet_type(), PacketType::Data);
|
||||||
|
let response = unshell::protocol::tree::decode_call_input::<EchoResponse>(
|
||||||
|
parsed.deserialize_data()?.data.as_slice(),
|
||||||
|
)?;
|
||||||
|
|
||||||
|
assert_eq!(EchoLeaf::protocol_leaf_name(), "org.example.v1.echo");
|
||||||
|
assert_eq!(response.text, "echo: hello leaf");
|
||||||
|
|
||||||
println!(
|
println!(
|
||||||
"leaf={} procedure={}",
|
"leaf={} procedure={} response={}",
|
||||||
EchoLeaf::protocol_leaf_name(),
|
EchoLeaf::protocol_leaf_name(),
|
||||||
message.procedure_id
|
EchoLeaf::protocol_procedure_id("echo").expect("known procedure suffix"),
|
||||||
|
response.text,
|
||||||
);
|
);
|
||||||
Ok(())
|
Ok(())
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -2,36 +2,16 @@
|
|||||||
mod common;
|
mod common;
|
||||||
|
|
||||||
use std::error::Error;
|
use std::error::Error;
|
||||||
use std::io::{self, Read, Write};
|
|
||||||
use std::net::TcpStream;
|
use std::net::TcpStream;
|
||||||
use std::process::{Child, ChildStdin, Command, ExitStatus, Stdio};
|
use std::sync::mpsc::RecvTimeoutError;
|
||||||
use std::sync::mpsc::{self, Receiver, RecvTimeoutError, Sender};
|
|
||||||
use std::thread;
|
|
||||||
use std::time::Duration;
|
use std::time::Duration;
|
||||||
|
|
||||||
use unshell::protocol::tree::{Endpoint, Ingress, LocalEvent};
|
use unshell::protocol::tree::Ingress;
|
||||||
|
|
||||||
struct ShellSession {
|
|
||||||
child: Child,
|
|
||||||
stdin: Option<ChildStdin>,
|
|
||||||
return_path: Vec<String>,
|
|
||||||
hook_id: u64,
|
|
||||||
procedure_id: String,
|
|
||||||
readers_closed: usize,
|
|
||||||
exit_status: Option<ExitStatus>,
|
|
||||||
}
|
|
||||||
|
|
||||||
enum OutputEvent {
|
|
||||||
Chunk(Vec<u8>),
|
|
||||||
ReaderClosed,
|
|
||||||
}
|
|
||||||
|
|
||||||
fn main() -> Result<(), Box<dyn Error>> {
|
fn main() -> Result<(), Box<dyn Error>> {
|
||||||
let mut stream = TcpStream::connect(common::LISTEN_ADDR)?;
|
let mut stream = TcpStream::connect(common::LISTEN_ADDR)?;
|
||||||
let frame_rx = common::spawn_frame_reader(stream.try_clone()?);
|
let frame_rx = common::spawn_frame_reader(stream.try_clone()?);
|
||||||
let mut endpoint = common::build_agent_endpoint();
|
let mut runtime = common::build_agent_runtime();
|
||||||
let mut session: Option<ShellSession> = None;
|
|
||||||
let mut output_rx: Option<Receiver<OutputEvent>> = None;
|
|
||||||
|
|
||||||
println!("connected to controller at {}", common::LISTEN_ADDR);
|
println!("connected to controller at {}", common::LISTEN_ADDR);
|
||||||
|
|
||||||
@@ -39,241 +19,16 @@ fn main() -> Result<(), Box<dyn Error>> {
|
|||||||
match frame_rx.recv_timeout(Duration::from_millis(25)) {
|
match frame_rx.recv_timeout(Duration::from_millis(25)) {
|
||||||
Ok(result) => {
|
Ok(result) => {
|
||||||
let frame = result?;
|
let frame = result?;
|
||||||
let outcome = endpoint.receive(&Ingress::Parent, frame)?;
|
let outcome = runtime.receive(&Ingress::Parent, frame)?;
|
||||||
if let Some(event) = common::pump_outcome(&mut stream, outcome)? {
|
common::write_frames(&mut stream, &outcome.frames)?;
|
||||||
handle_local_event(
|
|
||||||
&mut endpoint,
|
|
||||||
&mut stream,
|
|
||||||
&mut session,
|
|
||||||
&mut output_rx,
|
|
||||||
event,
|
|
||||||
)?;
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
Err(RecvTimeoutError::Timeout) => {}
|
Err(RecvTimeoutError::Timeout) => {}
|
||||||
Err(RecvTimeoutError::Disconnected) => break,
|
Err(RecvTimeoutError::Disconnected) => break,
|
||||||
}
|
}
|
||||||
|
|
||||||
if let Some(rx) = output_rx.as_ref() {
|
let outcome = runtime.poll()?;
|
||||||
while let Ok(event) = rx.try_recv() {
|
common::write_frames(&mut stream, &outcome.frames)?;
|
||||||
handle_shell_output(&mut endpoint, &mut stream, &mut session, event)?;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if finalize_exited_shell(&mut endpoint, &mut stream, &mut session)? {
|
|
||||||
output_rx = None;
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
Ok(())
|
Ok(())
|
||||||
}
|
}
|
||||||
|
|
||||||
fn handle_local_event(
|
|
||||||
endpoint: &mut unshell::protocol::tree::ProtocolEndpoint,
|
|
||||||
stream: &mut TcpStream,
|
|
||||||
session: &mut Option<ShellSession>,
|
|
||||||
output_rx: &mut Option<Receiver<OutputEvent>>,
|
|
||||||
event: LocalEvent,
|
|
||||||
) -> Result<(), Box<dyn Error>> {
|
|
||||||
match event {
|
|
||||||
LocalEvent::Call { header, message } => {
|
|
||||||
let shell_leaf_name = common::shell_leaf_name();
|
|
||||||
let start_procedure = common::shell_start_procedure();
|
|
||||||
if header.dst_leaf.as_deref() != Some(shell_leaf_name.as_str())
|
|
||||||
|| message.procedure_id != start_procedure
|
|
||||||
{
|
|
||||||
return Ok(());
|
|
||||||
}
|
|
||||||
|
|
||||||
let Some(hook) = message.response_hook else {
|
|
||||||
return Ok(());
|
|
||||||
};
|
|
||||||
|
|
||||||
let (new_session, rx) =
|
|
||||||
start_shell(&hook.return_path, hook.hook_id, &message.procedure_id)?;
|
|
||||||
*session = Some(new_session);
|
|
||||||
*output_rx = Some(rx);
|
|
||||||
|
|
||||||
let outcome = endpoint.send_data(
|
|
||||||
hook.return_path,
|
|
||||||
hook.hook_id,
|
|
||||||
message.procedure_id,
|
|
||||||
b"shell ready\n".to_vec(),
|
|
||||||
false,
|
|
||||||
)?;
|
|
||||||
let _ = common::pump_outcome(stream, outcome)?;
|
|
||||||
}
|
|
||||||
LocalEvent::Data { message, .. } => {
|
|
||||||
let Some(active_session) = session.as_mut() else {
|
|
||||||
return Ok(());
|
|
||||||
};
|
|
||||||
|
|
||||||
if !message.data.is_empty() {
|
|
||||||
let Some(stdin) = active_session.stdin.as_mut() else {
|
|
||||||
return Ok(());
|
|
||||||
};
|
|
||||||
stdin.write_all(&message.data)?;
|
|
||||||
stdin.flush()?;
|
|
||||||
}
|
|
||||||
|
|
||||||
if message.end_hook {
|
|
||||||
active_session.stdin.take();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
LocalEvent::Fault { message, .. } => {
|
|
||||||
eprintln!(
|
|
||||||
"controller reported protocol fault: 0x{:02X}",
|
|
||||||
message.fault.0
|
|
||||||
);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
Ok(())
|
|
||||||
}
|
|
||||||
|
|
||||||
fn handle_shell_output(
|
|
||||||
endpoint: &mut unshell::protocol::tree::ProtocolEndpoint,
|
|
||||||
stream: &mut TcpStream,
|
|
||||||
session: &mut Option<ShellSession>,
|
|
||||||
event: OutputEvent,
|
|
||||||
) -> Result<(), Box<dyn Error>> {
|
|
||||||
let Some(active_session) = session.as_mut() else {
|
|
||||||
return Ok(());
|
|
||||||
};
|
|
||||||
|
|
||||||
match event {
|
|
||||||
OutputEvent::Chunk(bytes) => {
|
|
||||||
let outcome = endpoint.send_data(
|
|
||||||
active_session.return_path.clone(),
|
|
||||||
active_session.hook_id,
|
|
||||||
active_session.procedure_id.clone(),
|
|
||||||
bytes,
|
|
||||||
false,
|
|
||||||
)?;
|
|
||||||
let _ = common::pump_outcome(stream, outcome)?;
|
|
||||||
}
|
|
||||||
OutputEvent::ReaderClosed => {
|
|
||||||
active_session.readers_closed += 1;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
Ok(())
|
|
||||||
}
|
|
||||||
|
|
||||||
fn finalize_exited_shell(
|
|
||||||
endpoint: &mut unshell::protocol::tree::ProtocolEndpoint,
|
|
||||||
stream: &mut TcpStream,
|
|
||||||
session: &mut Option<ShellSession>,
|
|
||||||
) -> Result<bool, Box<dyn Error>> {
|
|
||||||
let Some(active_session) = session.as_mut() else {
|
|
||||||
return Ok(false);
|
|
||||||
};
|
|
||||||
|
|
||||||
if active_session.exit_status.is_none() {
|
|
||||||
active_session.exit_status = active_session.child.try_wait()?;
|
|
||||||
}
|
|
||||||
|
|
||||||
let Some(exit_status) = active_session.exit_status else {
|
|
||||||
return Ok(false);
|
|
||||||
};
|
|
||||||
if active_session.readers_closed < 2 {
|
|
||||||
return Ok(false);
|
|
||||||
}
|
|
||||||
|
|
||||||
let summary = format!("shell exited with {exit_status}\n");
|
|
||||||
let outcome = endpoint.send_data(
|
|
||||||
active_session.return_path.clone(),
|
|
||||||
active_session.hook_id,
|
|
||||||
active_session.procedure_id.clone(),
|
|
||||||
summary.into_bytes(),
|
|
||||||
true,
|
|
||||||
)?;
|
|
||||||
let _ = common::pump_outcome(stream, outcome)?;
|
|
||||||
*session = None;
|
|
||||||
Ok(true)
|
|
||||||
}
|
|
||||||
|
|
||||||
fn start_shell(
|
|
||||||
return_path: &[String],
|
|
||||||
hook_id: u64,
|
|
||||||
procedure_id: &str,
|
|
||||||
) -> io::Result<(ShellSession, Receiver<OutputEvent>)> {
|
|
||||||
let mut command = if cfg!(windows) {
|
|
||||||
let mut command = Command::new("cmd.exe");
|
|
||||||
command.arg("/Q");
|
|
||||||
command
|
|
||||||
} else {
|
|
||||||
let mut command = Command::new("/bin/sh");
|
|
||||||
command.arg("-i");
|
|
||||||
command
|
|
||||||
};
|
|
||||||
|
|
||||||
let mut child = command
|
|
||||||
.stdin(Stdio::piped())
|
|
||||||
.stdout(Stdio::piped())
|
|
||||||
.stderr(Stdio::piped())
|
|
||||||
.spawn()?;
|
|
||||||
|
|
||||||
let stdin = child
|
|
||||||
.stdin
|
|
||||||
.take()
|
|
||||||
.ok_or_else(|| io::Error::other("failed to capture shell stdin"))?;
|
|
||||||
let stdout = child
|
|
||||||
.stdout
|
|
||||||
.take()
|
|
||||||
.ok_or_else(|| io::Error::other("failed to capture shell stdout"))?;
|
|
||||||
let stderr = child
|
|
||||||
.stderr
|
|
||||||
.take()
|
|
||||||
.ok_or_else(|| io::Error::other("failed to capture shell stderr"))?;
|
|
||||||
|
|
||||||
let (tx, rx) = mpsc::channel();
|
|
||||||
spawn_pipe_reader(stdout, tx.clone());
|
|
||||||
spawn_pipe_reader(stderr, tx);
|
|
||||||
|
|
||||||
Ok((
|
|
||||||
ShellSession {
|
|
||||||
child,
|
|
||||||
stdin: Some(stdin),
|
|
||||||
return_path: return_path.to_vec(),
|
|
||||||
hook_id,
|
|
||||||
procedure_id: procedure_id.to_owned(),
|
|
||||||
readers_closed: 0,
|
|
||||||
exit_status: None,
|
|
||||||
},
|
|
||||||
rx,
|
|
||||||
))
|
|
||||||
}
|
|
||||||
|
|
||||||
fn spawn_pipe_reader<R>(mut reader: R, tx: Sender<OutputEvent>)
|
|
||||||
where
|
|
||||||
R: Read + Send + 'static,
|
|
||||||
{
|
|
||||||
thread::spawn(move || {
|
|
||||||
let mut buffer = [0u8; 1024];
|
|
||||||
loop {
|
|
||||||
match reader.read(&mut buffer) {
|
|
||||||
Ok(0) => {
|
|
||||||
let _ = tx.send(OutputEvent::ReaderClosed);
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
Ok(read_len) => {
|
|
||||||
if tx
|
|
||||||
.send(OutputEvent::Chunk(buffer[..read_len].to_vec()))
|
|
||||||
.is_err()
|
|
||||||
{
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
Err(error) if error.kind() == io::ErrorKind::Interrupted => {}
|
|
||||||
Err(error) => {
|
|
||||||
let _ = tx.send(OutputEvent::Chunk(
|
|
||||||
format!("shell pipe read error: {error}\n").into_bytes(),
|
|
||||||
));
|
|
||||||
let _ = tx.send(OutputEvent::ReaderClosed);
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|||||||
@@ -17,25 +17,46 @@ fn main() -> Result<(), Box<dyn Error>> {
|
|||||||
let mut endpoint = common::build_controller_endpoint();
|
let mut endpoint = common::build_controller_endpoint();
|
||||||
let hook_id = endpoint.allocate_hook_id();
|
let hook_id = endpoint.allocate_hook_id();
|
||||||
let shell_leaf_name = common::shell_leaf_name();
|
let shell_leaf_name = common::shell_leaf_name();
|
||||||
let start_procedure = common::shell_start_procedure();
|
let open_procedure = common::shell_open_procedure();
|
||||||
|
|
||||||
let outcome = endpoint.send_call(
|
let outcome = endpoint.send_call(
|
||||||
common::agent_path(),
|
common::agent_path(),
|
||||||
Some(shell_leaf_name),
|
Some(shell_leaf_name),
|
||||||
start_procedure.clone(),
|
open_procedure.clone(),
|
||||||
Some(hook_id),
|
Some(hook_id),
|
||||||
Vec::new(),
|
common::shell_open_payload(),
|
||||||
|
)?;
|
||||||
|
common::write_frames(
|
||||||
|
&mut stream,
|
||||||
|
&outcome
|
||||||
|
.forward
|
||||||
|
.into_iter()
|
||||||
|
.map(|(_, frame)| frame)
|
||||||
|
.collect::<Vec<_>>(),
|
||||||
)?;
|
)?;
|
||||||
let _ = common::pump_outcome(&mut stream, outcome)?;
|
|
||||||
|
|
||||||
let mut commands_sent = false;
|
for (index, command) in ["pwd\n", "whoami\n", "exit\n"].iter().enumerate() {
|
||||||
|
let outcome = endpoint.send_data(
|
||||||
|
common::agent_path(),
|
||||||
|
hook_id,
|
||||||
|
open_procedure.clone(),
|
||||||
|
command.as_bytes().to_vec(),
|
||||||
|
index == 2,
|
||||||
|
)?;
|
||||||
|
common::write_frames(
|
||||||
|
&mut stream,
|
||||||
|
&outcome
|
||||||
|
.forward
|
||||||
|
.into_iter()
|
||||||
|
.map(|(_, frame)| frame)
|
||||||
|
.collect::<Vec<_>>(),
|
||||||
|
)?;
|
||||||
|
}
|
||||||
|
|
||||||
for result in frame_rx {
|
for result in frame_rx {
|
||||||
let frame = result?;
|
let frame = result?;
|
||||||
let outcome = endpoint.receive(&Ingress::Child(common::agent_path()), frame)?;
|
let outcome = endpoint.receive(&Ingress::Child(common::agent_path()), frame)?;
|
||||||
let event = common::pump_outcome(&mut stream, outcome)?;
|
let Some(event) = outcome.event else {
|
||||||
|
|
||||||
let Some(event) = event else {
|
|
||||||
continue;
|
continue;
|
||||||
};
|
};
|
||||||
|
|
||||||
@@ -43,20 +64,6 @@ fn main() -> Result<(), Box<dyn Error>> {
|
|||||||
LocalEvent::Data { message, .. } => {
|
LocalEvent::Data { message, .. } => {
|
||||||
print!("{}", String::from_utf8_lossy(&message.data));
|
print!("{}", String::from_utf8_lossy(&message.data));
|
||||||
|
|
||||||
if !commands_sent {
|
|
||||||
commands_sent = true;
|
|
||||||
for (index, command) in ["pwd\n", "whoami\n", "exit\n"].iter().enumerate() {
|
|
||||||
let outcome = endpoint.send_data(
|
|
||||||
common::agent_path(),
|
|
||||||
hook_id,
|
|
||||||
start_procedure.clone(),
|
|
||||||
command.as_bytes().to_vec(),
|
|
||||||
index == 2,
|
|
||||||
)?;
|
|
||||||
let _ = common::pump_outcome(&mut stream, outcome)?;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if message.end_hook {
|
if message.end_hook {
|
||||||
break;
|
break;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,17 +1,124 @@
|
|||||||
|
use std::collections::BTreeMap;
|
||||||
|
use std::fmt;
|
||||||
use std::io::{self, ErrorKind, Read, Write};
|
use std::io::{self, ErrorKind, Read, Write};
|
||||||
use std::net::TcpStream;
|
use std::net::TcpStream;
|
||||||
use std::sync::mpsc::{self, Receiver};
|
use std::process::{Child, ChildStdin, Command, ExitStatus, Stdio};
|
||||||
|
use std::sync::mpsc::{self, Receiver, TryRecvError};
|
||||||
use std::thread;
|
use std::thread;
|
||||||
|
|
||||||
use unshell::Leaf;
|
|
||||||
use unshell::protocol::FrameBytes;
|
use unshell::protocol::FrameBytes;
|
||||||
use unshell::protocol::tree::{ChildRoute, EndpointOutcome, LocalEvent, ProtocolEndpoint};
|
use unshell::protocol::tree::{
|
||||||
|
Call, CallLeaf, ChildRoute, HookKey, IncomingData, IncomingFault, LeafRuntime, OutgoingData,
|
||||||
|
ProtocolEndpoint,
|
||||||
|
};
|
||||||
|
use unshell::{Leaf, procedures};
|
||||||
|
|
||||||
pub const LISTEN_ADDR: &str = "127.0.0.1:4444";
|
pub const LISTEN_ADDR: &str = "127.0.0.1:4444";
|
||||||
|
|
||||||
#[derive(Leaf)]
|
#[derive(Default, Leaf)]
|
||||||
#[leaf(procedures(start))]
|
pub struct RemoteShellLeaf {
|
||||||
pub struct RemoteShellLeaf;
|
sessions: BTreeMap<HookKey, ShellSession>,
|
||||||
|
}
|
||||||
|
|
||||||
|
#[procedures(error = ShellLeafError)]
|
||||||
|
impl RemoteShellLeaf {
|
||||||
|
#[call]
|
||||||
|
fn open(&mut self, call: Call<()>) -> Result<(), ShellLeafError> {
|
||||||
|
let hook_key = call.response_hook.ok_or(ShellLeafError::MissingHook)?;
|
||||||
|
let session = ShellSession::spawn(
|
||||||
|
hook_key.return_path.clone(),
|
||||||
|
hook_key.hook_id,
|
||||||
|
call.procedure_id,
|
||||||
|
)?;
|
||||||
|
|
||||||
|
if let Some(mut previous) = self.sessions.insert(hook_key, session) {
|
||||||
|
previous.terminate()?;
|
||||||
|
}
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl CallLeaf for RemoteShellLeaf {
|
||||||
|
type Error = ShellLeafError;
|
||||||
|
|
||||||
|
fn on_data(&mut self, data: IncomingData) -> Result<Vec<OutgoingData>, Self::Error> {
|
||||||
|
let Some(session) = self.sessions.get_mut(&data.hook_key) else {
|
||||||
|
return Ok(Vec::new());
|
||||||
|
};
|
||||||
|
|
||||||
|
if !data.message.data.is_empty() {
|
||||||
|
let Some(stdin) = session.stdin.as_mut() else {
|
||||||
|
return Ok(Vec::new());
|
||||||
|
};
|
||||||
|
stdin.write_all(&data.message.data)?;
|
||||||
|
stdin.flush()?;
|
||||||
|
}
|
||||||
|
|
||||||
|
if !data.message.end_hook {
|
||||||
|
return Ok(Vec::new());
|
||||||
|
}
|
||||||
|
|
||||||
|
let session = self
|
||||||
|
.sessions
|
||||||
|
.remove(&data.hook_key)
|
||||||
|
.ok_or(ShellLeafError::MissingSession)?;
|
||||||
|
close_session(session)
|
||||||
|
}
|
||||||
|
|
||||||
|
fn on_fault(&mut self, fault: IncomingFault) -> Result<(), Self::Error> {
|
||||||
|
if let Some(mut session) = self.sessions.remove(&fault.hook_key) {
|
||||||
|
session.terminate()?;
|
||||||
|
}
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
fn poll(&mut self) -> Result<Vec<OutgoingData>, Self::Error> {
|
||||||
|
let mut outgoing = Vec::new();
|
||||||
|
let mut closed = Vec::new();
|
||||||
|
|
||||||
|
for key in self.sessions.keys().cloned().collect::<Vec<_>>() {
|
||||||
|
let Some(session) = self.sessions.get_mut(&key) else {
|
||||||
|
continue;
|
||||||
|
};
|
||||||
|
|
||||||
|
loop {
|
||||||
|
match session.output_rx.try_recv() {
|
||||||
|
Ok(OutputEvent::Chunk(bytes)) => {
|
||||||
|
outgoing.push(session.packet(bytes, false));
|
||||||
|
}
|
||||||
|
Ok(OutputEvent::ReaderClosed) => {
|
||||||
|
session.readers_closed += 1;
|
||||||
|
}
|
||||||
|
Err(TryRecvError::Empty) => break,
|
||||||
|
Err(TryRecvError::Disconnected) => {
|
||||||
|
session.readers_closed = 2;
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if session.local_end_sent {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
|
if session.exit_status.is_none() {
|
||||||
|
session.exit_status = session.child.try_wait()?;
|
||||||
|
}
|
||||||
|
|
||||||
|
if session.exit_status.is_some() && session.readers_closed >= 2 {
|
||||||
|
outgoing.push(session.packet(Vec::new(), true));
|
||||||
|
session.local_end_sent = true;
|
||||||
|
closed.push(key);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
for key in closed {
|
||||||
|
self.sessions.remove(&key);
|
||||||
|
}
|
||||||
|
|
||||||
|
Ok(outgoing)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
pub fn agent_path() -> Vec<String> {
|
pub fn agent_path() -> Vec<String> {
|
||||||
path(&["agent"])
|
path(&["agent"])
|
||||||
@@ -32,22 +139,30 @@ pub fn build_controller_endpoint() -> ProtocolEndpoint {
|
|||||||
}
|
}
|
||||||
|
|
||||||
#[allow(dead_code)]
|
#[allow(dead_code)]
|
||||||
pub fn build_agent_endpoint() -> ProtocolEndpoint {
|
pub fn build_agent_runtime() -> LeafRuntime<RemoteShellLeaf> {
|
||||||
ProtocolEndpoint::new(
|
let endpoint = ProtocolEndpoint::new(
|
||||||
agent_path(),
|
agent_path(),
|
||||||
Some(Vec::new()),
|
Some(Vec::new()),
|
||||||
Vec::new(),
|
Vec::new(),
|
||||||
vec![RemoteShellLeaf::protocol_leaf_spec()],
|
vec![RemoteShellLeaf::protocol_leaf_spec()],
|
||||||
)
|
);
|
||||||
|
LeafRuntime::new(endpoint, RemoteShellLeaf::default())
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[allow(dead_code)]
|
||||||
pub fn shell_leaf_name() -> String {
|
pub fn shell_leaf_name() -> String {
|
||||||
RemoteShellLeaf::protocol_leaf_name()
|
RemoteShellLeaf::protocol_leaf_name()
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn shell_start_procedure() -> String {
|
#[allow(dead_code)]
|
||||||
RemoteShellLeaf::protocol_procedure_id("start")
|
pub fn shell_open_procedure() -> String {
|
||||||
.expect("remote shell leaf declares a start procedure")
|
RemoteShellLeaf::protocol_procedure_id("open")
|
||||||
|
.expect("remote shell leaf declares an open procedure")
|
||||||
|
}
|
||||||
|
|
||||||
|
#[allow(dead_code)]
|
||||||
|
pub fn shell_open_payload() -> Vec<u8> {
|
||||||
|
unshell::protocol::tree::encode_call_reply(&()).expect("unit shell open payload should encode")
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn write_frame(stream: &mut TcpStream, frame: &[u8]) -> io::Result<()> {
|
pub fn write_frame(stream: &mut TcpStream, frame: &[u8]) -> io::Result<()> {
|
||||||
@@ -59,17 +174,11 @@ pub fn write_frame(stream: &mut TcpStream, frame: &[u8]) -> io::Result<()> {
|
|||||||
Ok(())
|
Ok(())
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn pump_outcome(
|
pub fn write_frames(stream: &mut TcpStream, frames: &[FrameBytes]) -> io::Result<()> {
|
||||||
stream: &mut TcpStream,
|
for frame in frames {
|
||||||
outcome: EndpointOutcome,
|
write_frame(stream, frame)?;
|
||||||
) -> io::Result<Option<LocalEvent>> {
|
|
||||||
if let Some((_route, frame)) = outcome.forward {
|
|
||||||
// These examples model one direct parent-child link over one TCP stream, so
|
|
||||||
// any forwarded protocol frame is emitted on the same socket.
|
|
||||||
write_frame(stream, &frame)?;
|
|
||||||
}
|
}
|
||||||
|
Ok(())
|
||||||
Ok(outcome.event)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn spawn_frame_reader(mut stream: TcpStream) -> Receiver<io::Result<FrameBytes>> {
|
pub fn spawn_frame_reader(mut stream: TcpStream) -> Receiver<io::Result<FrameBytes>> {
|
||||||
@@ -95,6 +204,16 @@ pub fn spawn_frame_reader(mut stream: TcpStream) -> Receiver<io::Result<FrameByt
|
|||||||
rx
|
rx
|
||||||
}
|
}
|
||||||
|
|
||||||
|
fn close_session(mut session: ShellSession) -> Result<Vec<OutgoingData>, ShellLeafError> {
|
||||||
|
session.terminate()?;
|
||||||
|
if session.local_end_sent {
|
||||||
|
return Ok(Vec::new());
|
||||||
|
}
|
||||||
|
|
||||||
|
session.local_end_sent = true;
|
||||||
|
Ok(vec![session.packet(Vec::new(), true)])
|
||||||
|
}
|
||||||
|
|
||||||
fn read_frame(stream: &mut TcpStream) -> io::Result<Option<FrameBytes>> {
|
fn read_frame(stream: &mut TcpStream) -> io::Result<Option<FrameBytes>> {
|
||||||
let mut len_bytes = [0u8; 4];
|
let mut len_bytes = [0u8; 4];
|
||||||
match stream.read_exact(&mut len_bytes) {
|
match stream.read_exact(&mut len_bytes) {
|
||||||
@@ -115,3 +234,156 @@ fn read_frame(stream: &mut TcpStream) -> io::Result<Option<FrameBytes>> {
|
|||||||
frame.extend_from_slice(&bytes);
|
frame.extend_from_slice(&bytes);
|
||||||
Ok(Some(frame))
|
Ok(Some(frame))
|
||||||
}
|
}
|
||||||
|
|
||||||
|
struct ShellSession {
|
||||||
|
child: Child,
|
||||||
|
stdin: Option<ChildStdin>,
|
||||||
|
output_rx: Receiver<OutputEvent>,
|
||||||
|
return_path: Vec<String>,
|
||||||
|
hook_id: u64,
|
||||||
|
procedure_id: String,
|
||||||
|
readers_closed: usize,
|
||||||
|
exit_status: Option<ExitStatus>,
|
||||||
|
local_end_sent: bool,
|
||||||
|
}
|
||||||
|
|
||||||
|
enum OutputEvent {
|
||||||
|
Chunk(Vec<u8>),
|
||||||
|
ReaderClosed,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl ShellSession {
|
||||||
|
fn spawn(
|
||||||
|
return_path: Vec<String>,
|
||||||
|
hook_id: u64,
|
||||||
|
procedure_id: String,
|
||||||
|
) -> Result<Self, ShellLeafError> {
|
||||||
|
let mut command = if cfg!(windows) {
|
||||||
|
let mut command = Command::new("cmd.exe");
|
||||||
|
command.arg("/Q");
|
||||||
|
command
|
||||||
|
} else {
|
||||||
|
let mut command = Command::new("/bin/sh");
|
||||||
|
command.arg("-i");
|
||||||
|
command
|
||||||
|
};
|
||||||
|
|
||||||
|
let mut child = command
|
||||||
|
.stdin(Stdio::piped())
|
||||||
|
.stdout(Stdio::piped())
|
||||||
|
.stderr(Stdio::piped())
|
||||||
|
.spawn()?;
|
||||||
|
|
||||||
|
let stdin = child
|
||||||
|
.stdin
|
||||||
|
.take()
|
||||||
|
.ok_or_else(|| io::Error::other("failed to capture shell stdin"))?;
|
||||||
|
let stdout = child
|
||||||
|
.stdout
|
||||||
|
.take()
|
||||||
|
.ok_or_else(|| io::Error::other("failed to capture shell stdout"))?;
|
||||||
|
let stderr = child
|
||||||
|
.stderr
|
||||||
|
.take()
|
||||||
|
.ok_or_else(|| io::Error::other("failed to capture shell stderr"))?;
|
||||||
|
|
||||||
|
let (tx, rx) = mpsc::channel();
|
||||||
|
spawn_pipe_reader(stdout, tx.clone());
|
||||||
|
spawn_pipe_reader(stderr, tx);
|
||||||
|
|
||||||
|
Ok(Self {
|
||||||
|
child,
|
||||||
|
stdin: Some(stdin),
|
||||||
|
output_rx: rx,
|
||||||
|
return_path,
|
||||||
|
hook_id,
|
||||||
|
procedure_id,
|
||||||
|
readers_closed: 0,
|
||||||
|
exit_status: None,
|
||||||
|
local_end_sent: false,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
fn packet(&self, data: Vec<u8>, end_hook: bool) -> OutgoingData {
|
||||||
|
OutgoingData {
|
||||||
|
dst_path: self.return_path.clone(),
|
||||||
|
hook_id: self.hook_id,
|
||||||
|
procedure_id: self.procedure_id.clone(),
|
||||||
|
data,
|
||||||
|
end_hook,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fn terminate(&mut self) -> Result<(), ShellLeafError> {
|
||||||
|
self.stdin.take();
|
||||||
|
match self.child.try_wait()? {
|
||||||
|
Some(status) => {
|
||||||
|
self.exit_status = Some(status);
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
None => {
|
||||||
|
self.child.kill()?;
|
||||||
|
self.exit_status = Some(self.child.wait()?);
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fn spawn_pipe_reader<R>(mut reader: R, tx: mpsc::Sender<OutputEvent>)
|
||||||
|
where
|
||||||
|
R: Read + Send + 'static,
|
||||||
|
{
|
||||||
|
thread::spawn(move || {
|
||||||
|
loop {
|
||||||
|
let mut buffer = [0u8; 1024];
|
||||||
|
match reader.read(&mut buffer) {
|
||||||
|
Ok(0) => {
|
||||||
|
let _ = tx.send(OutputEvent::ReaderClosed);
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
Ok(read_len) => {
|
||||||
|
if tx
|
||||||
|
.send(OutputEvent::Chunk(buffer[..read_len].to_vec()))
|
||||||
|
.is_err()
|
||||||
|
{
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
Err(error) if error.kind() == io::ErrorKind::Interrupted => {}
|
||||||
|
Err(error) => {
|
||||||
|
let _ = tx.send(OutputEvent::Chunk(
|
||||||
|
format!("shell pipe read error: {error}\n").into_bytes(),
|
||||||
|
));
|
||||||
|
let _ = tx.send(OutputEvent::ReaderClosed);
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Debug)]
|
||||||
|
pub enum ShellLeafError {
|
||||||
|
Io(io::Error),
|
||||||
|
MissingHook,
|
||||||
|
MissingSession,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl fmt::Display for ShellLeafError {
|
||||||
|
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
|
||||||
|
match self {
|
||||||
|
Self::Io(error) => write!(f, "{error}"),
|
||||||
|
Self::MissingHook => f.write_str("shell open requires a response hook"),
|
||||||
|
Self::MissingSession => f.write_str("shell session missing for active hook"),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl std::error::Error for ShellLeafError {}
|
||||||
|
|
||||||
|
impl From<io::Error> for ShellLeafError {
|
||||||
|
fn from(value: io::Error) -> Self {
|
||||||
|
Self::Io(value)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|||||||
+1
-1
@@ -20,6 +20,6 @@ extern crate self as unshell;
|
|||||||
pub mod logger;
|
pub mod logger;
|
||||||
pub mod protocol;
|
pub mod protocol;
|
||||||
|
|
||||||
pub use unshell_macros::Leaf;
|
pub use unshell_macros::{Leaf, procedures};
|
||||||
|
|
||||||
// pub use ush_obfuscate as obfuscate;
|
// pub use ush_obfuscate as obfuscate;
|
||||||
|
|||||||
@@ -0,0 +1,106 @@
|
|||||||
|
use alloc::{borrow::ToOwned, format, string::String, vec, vec::Vec};
|
||||||
|
use core::convert::Infallible;
|
||||||
|
|
||||||
|
use rkyv::{Archive, Deserialize, Serialize};
|
||||||
|
|
||||||
|
use crate::protocol::tree::{
|
||||||
|
Call, CallLeaf, ChildRoute, ConnectionState, Ingress, LeafRuntime, ProtocolEndpoint,
|
||||||
|
decode_call_input, encode_call_reply,
|
||||||
|
};
|
||||||
|
use crate::protocol::{PacketType, decode_frame};
|
||||||
|
use crate::{Leaf, procedures};
|
||||||
|
|
||||||
|
fn path(parts: &[&str]) -> Vec<String> {
|
||||||
|
parts.iter().map(|part| (*part).to_owned()).collect()
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Leaf)]
|
||||||
|
#[leaf(id = "org.example.v1.echo")]
|
||||||
|
struct EchoLeaf {
|
||||||
|
prefix: String,
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Archive, Serialize, Deserialize, Debug, Clone, PartialEq, Eq)]
|
||||||
|
struct EchoRequest {
|
||||||
|
text: String,
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Archive, Serialize, Deserialize, Debug, Clone, PartialEq, Eq)]
|
||||||
|
struct EchoResponse {
|
||||||
|
text: String,
|
||||||
|
}
|
||||||
|
|
||||||
|
#[procedures(error = Infallible)]
|
||||||
|
impl EchoLeaf {
|
||||||
|
#[call]
|
||||||
|
fn echo(&mut self, request: Call<EchoRequest>) -> EchoResponse {
|
||||||
|
EchoResponse {
|
||||||
|
text: format!("{}{}", self.prefix, request.input.text),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl CallLeaf for EchoLeaf {
|
||||||
|
type Error = Infallible;
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn leaf_runtime_dispatches_generated_call_procedure() {
|
||||||
|
let endpoint = ProtocolEndpoint::new(
|
||||||
|
path(&["agent"]),
|
||||||
|
Some(Vec::new()),
|
||||||
|
Vec::new(),
|
||||||
|
vec![EchoLeaf::protocol_leaf_spec()],
|
||||||
|
);
|
||||||
|
let mut runtime = LeafRuntime::new(
|
||||||
|
endpoint,
|
||||||
|
EchoLeaf {
|
||||||
|
prefix: String::from("echo: "),
|
||||||
|
},
|
||||||
|
);
|
||||||
|
|
||||||
|
let mut controller = ProtocolEndpoint::new(
|
||||||
|
Vec::new(),
|
||||||
|
None,
|
||||||
|
vec![ChildRoute {
|
||||||
|
path: path(&["agent"]),
|
||||||
|
state: ConnectionState::Registered,
|
||||||
|
}],
|
||||||
|
Vec::new(),
|
||||||
|
);
|
||||||
|
let hook_id = controller.allocate_hook_id();
|
||||||
|
let controller_outcome = controller
|
||||||
|
.send_call(
|
||||||
|
path(&["agent"]),
|
||||||
|
Some(EchoLeaf::protocol_leaf_name()),
|
||||||
|
EchoLeaf::protocol_procedure_id("echo").expect("generated suffix should resolve"),
|
||||||
|
Some(hook_id),
|
||||||
|
encode_call_reply(&EchoRequest {
|
||||||
|
text: String::from("hello"),
|
||||||
|
})
|
||||||
|
.expect("request should encode"),
|
||||||
|
)
|
||||||
|
.expect("call should encode");
|
||||||
|
let Some((_, frame)) = controller_outcome.forward else {
|
||||||
|
panic!("controller should forward call to child");
|
||||||
|
};
|
||||||
|
|
||||||
|
let outcome = runtime
|
||||||
|
.receive(&Ingress::Parent, frame)
|
||||||
|
.expect("runtime should handle call");
|
||||||
|
let [response_frame] = outcome.frames.as_slice() else {
|
||||||
|
panic!("expected one response frame");
|
||||||
|
};
|
||||||
|
|
||||||
|
let parsed = decode_frame(response_frame.as_slice()).expect("response frame should decode");
|
||||||
|
assert_eq!(parsed.packet_type(), PacketType::Data);
|
||||||
|
let response = decode_call_input::<EchoResponse>(
|
||||||
|
parsed
|
||||||
|
.deserialize_data()
|
||||||
|
.expect("data payload should deserialize")
|
||||||
|
.data
|
||||||
|
.as_slice(),
|
||||||
|
)
|
||||||
|
.expect("typed response should decode");
|
||||||
|
assert_eq!(response.text, "echo: hello");
|
||||||
|
}
|
||||||
@@ -1,2 +1,3 @@
|
|||||||
|
mod call;
|
||||||
mod protocol;
|
mod protocol;
|
||||||
mod tree;
|
mod tree;
|
||||||
|
|||||||
@@ -81,6 +81,7 @@ fn protocol_endpoint_introspection_returns_leaf_summary() {
|
|||||||
let LocalEvent::Data {
|
let LocalEvent::Data {
|
||||||
header,
|
header,
|
||||||
message: response,
|
message: response,
|
||||||
|
..
|
||||||
} = outcome.event.as_ref().expect("expected local data event")
|
} = outcome.event.as_ref().expect("expected local data event")
|
||||||
else {
|
else {
|
||||||
panic!("expected local data event");
|
panic!("expected local data event");
|
||||||
@@ -142,7 +143,9 @@ fn invalid_hook_peer_emits_local_fault_event() {
|
|||||||
assert!(!outcome.dropped);
|
assert!(!outcome.dropped);
|
||||||
|
|
||||||
match outcome.event.as_ref().expect("expected event") {
|
match outcome.event.as_ref().expect("expected event") {
|
||||||
LocalEvent::Fault { header, message } => {
|
LocalEvent::Fault {
|
||||||
|
header, message, ..
|
||||||
|
} => {
|
||||||
assert_eq!(header.packet_type, PacketType::Fault);
|
assert_eq!(header.packet_type, PacketType::Fault);
|
||||||
assert_eq!(header.hook_id, Some(hook_id));
|
assert_eq!(header.hook_id, Some(hook_id));
|
||||||
assert_eq!(
|
assert_eq!(
|
||||||
@@ -251,3 +254,68 @@ fn pending_hook_fault_is_delivered_before_activation() {
|
|||||||
|
|
||||||
assert!(outcome.forward.is_some() || outcome.event.is_some());
|
assert!(outcome.forward.is_some() || outcome.event.is_some());
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn callee_side_end_hook_marks_local_end_before_peer_close() {
|
||||||
|
let mut endpoint = ProtocolEndpoint::new(path(&["server"]), None, Vec::new(), Vec::new());
|
||||||
|
endpoint
|
||||||
|
.add_endpoint_procedure("example.service.v1.invoke")
|
||||||
|
.expect("procedure registration should succeed");
|
||||||
|
let frame = encode_packet(
|
||||||
|
&PacketHeader {
|
||||||
|
packet_type: PacketType::Call,
|
||||||
|
src_path: Vec::new(),
|
||||||
|
dst_path: path(&["server"]),
|
||||||
|
dst_leaf: None,
|
||||||
|
hook_id: None,
|
||||||
|
},
|
||||||
|
&crate::protocol::CallMessage {
|
||||||
|
procedure_id: "example.service.v1.invoke".to_owned(),
|
||||||
|
data: vec![1],
|
||||||
|
response_hook: Some(crate::protocol::HookTarget {
|
||||||
|
hook_id: 21,
|
||||||
|
return_path: Vec::new(),
|
||||||
|
}),
|
||||||
|
},
|
||||||
|
)
|
||||||
|
.expect("call should encode");
|
||||||
|
|
||||||
|
endpoint
|
||||||
|
.receive(&Ingress::Parent, frame)
|
||||||
|
.expect("callee should accept call");
|
||||||
|
|
||||||
|
let key = crate::protocol::tree::HookKey::new(Vec::new(), 21);
|
||||||
|
assert!(endpoint.hooks.active(&key).is_some());
|
||||||
|
|
||||||
|
endpoint
|
||||||
|
.send_data(
|
||||||
|
Vec::new(),
|
||||||
|
21,
|
||||||
|
"example.service.v1.invoke",
|
||||||
|
Vec::new(),
|
||||||
|
true,
|
||||||
|
)
|
||||||
|
.expect("callee local end should succeed");
|
||||||
|
assert!(endpoint.hooks.active(&key).is_some());
|
||||||
|
|
||||||
|
let peer_final = encode_packet(
|
||||||
|
&PacketHeader {
|
||||||
|
packet_type: PacketType::Data,
|
||||||
|
src_path: Vec::new(),
|
||||||
|
dst_path: path(&["server"]),
|
||||||
|
dst_leaf: None,
|
||||||
|
hook_id: Some(21),
|
||||||
|
},
|
||||||
|
&DataMessage {
|
||||||
|
procedure_id: "example.service.v1.invoke".to_owned(),
|
||||||
|
data: Vec::new(),
|
||||||
|
end_hook: true,
|
||||||
|
},
|
||||||
|
)
|
||||||
|
.expect("peer final data should encode");
|
||||||
|
|
||||||
|
endpoint
|
||||||
|
.receive(&Ingress::Parent, peer_final)
|
||||||
|
.expect("callee should accept peer close");
|
||||||
|
assert!(endpoint.hooks.active(&key).is_none());
|
||||||
|
}
|
||||||
|
|||||||
@@ -0,0 +1,350 @@
|
|||||||
|
//! Stateful application-layer call runtime built on top of `ProtocolEndpoint`.
|
||||||
|
|
||||||
|
use alloc::{string::String, vec::Vec};
|
||||||
|
use core::fmt;
|
||||||
|
|
||||||
|
use rkyv::{Archive, Serialize, rancor::Error, to_bytes, util::AlignedVec};
|
||||||
|
|
||||||
|
use crate::protocol::{
|
||||||
|
CallMessage, DataMessage, FrameBytes, FrameError, HookTarget, PacketHeader, ProtocolFault,
|
||||||
|
};
|
||||||
|
|
||||||
|
use super::{
|
||||||
|
Endpoint, EndpointError, HookKey, Ingress, LocalEvent, ProtocolEndpoint, ProtocolLeaf,
|
||||||
|
};
|
||||||
|
|
||||||
|
/// One typed incoming `Call` passed to a leaf procedure.
|
||||||
|
#[derive(Debug, Clone, PartialEq, Eq)]
|
||||||
|
pub struct Call<T> {
|
||||||
|
pub input: T,
|
||||||
|
pub caller_path: Vec<String>,
|
||||||
|
pub procedure_id: String,
|
||||||
|
pub dst_leaf: Option<String>,
|
||||||
|
pub response_hook: Option<HookKey>,
|
||||||
|
}
|
||||||
|
|
||||||
|
/// One incoming local call event that already passed protocol validation.
|
||||||
|
#[derive(Debug, Clone, PartialEq, Eq)]
|
||||||
|
pub struct IncomingCall {
|
||||||
|
pub header: PacketHeader,
|
||||||
|
pub message: CallMessage,
|
||||||
|
}
|
||||||
|
|
||||||
|
/// One incoming local data event tied to an active hook.
|
||||||
|
#[derive(Debug, Clone, PartialEq, Eq)]
|
||||||
|
pub struct IncomingData {
|
||||||
|
pub header: PacketHeader,
|
||||||
|
pub message: DataMessage,
|
||||||
|
pub hook_key: HookKey,
|
||||||
|
}
|
||||||
|
|
||||||
|
/// One incoming local fault event tied to a pending or active hook.
|
||||||
|
#[derive(Debug, Clone, PartialEq, Eq)]
|
||||||
|
pub struct IncomingFault {
|
||||||
|
pub header: PacketHeader,
|
||||||
|
pub fault: crate::protocol::FaultMessage,
|
||||||
|
pub hook_key: HookKey,
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Outcome of one generated initial call procedure.
|
||||||
|
#[derive(Debug, Clone, PartialEq, Eq)]
|
||||||
|
pub enum CallResult<T> {
|
||||||
|
Reply(T),
|
||||||
|
NoReply,
|
||||||
|
}
|
||||||
|
|
||||||
|
/// One hook-associated `Data` packet emitted by leaf code.
|
||||||
|
#[derive(Debug, Clone, PartialEq, Eq)]
|
||||||
|
pub struct OutgoingData {
|
||||||
|
pub dst_path: Vec<String>,
|
||||||
|
pub hook_id: u64,
|
||||||
|
pub procedure_id: String,
|
||||||
|
pub data: Vec<u8>,
|
||||||
|
pub end_hook: bool,
|
||||||
|
}
|
||||||
|
|
||||||
|
/// One runtime-normalized reply produced by generated call dispatch.
|
||||||
|
#[derive(Debug, Clone, PartialEq, Eq)]
|
||||||
|
pub enum CallReply {
|
||||||
|
Reply(Vec<u8>),
|
||||||
|
NoReply,
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Error surfaced while decoding one incoming call or encoding one generated reply.
|
||||||
|
#[derive(Debug)]
|
||||||
|
pub enum DispatchError<E> {
|
||||||
|
Decode(FrameError),
|
||||||
|
Encode(FrameError),
|
||||||
|
Handler(E),
|
||||||
|
}
|
||||||
|
|
||||||
|
impl<E> fmt::Display for DispatchError<E>
|
||||||
|
where
|
||||||
|
E: fmt::Display,
|
||||||
|
{
|
||||||
|
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
|
||||||
|
match self {
|
||||||
|
Self::Decode(error) => write!(f, "call decode failed: {error}"),
|
||||||
|
Self::Encode(error) => write!(f, "call reply encode failed: {error}"),
|
||||||
|
Self::Handler(error) => write!(f, "call handler failed: {error}"),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl<E> core::error::Error for DispatchError<E> where E: core::error::Error + 'static {}
|
||||||
|
|
||||||
|
/// Error surfaced by the stateful leaf runtime.
|
||||||
|
#[derive(Debug)]
|
||||||
|
pub enum LeafRuntimeError<E> {
|
||||||
|
Endpoint(EndpointError),
|
||||||
|
Dispatch(DispatchError<E>),
|
||||||
|
Leaf(E),
|
||||||
|
}
|
||||||
|
|
||||||
|
impl<E> fmt::Display for LeafRuntimeError<E>
|
||||||
|
where
|
||||||
|
E: fmt::Display,
|
||||||
|
{
|
||||||
|
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
|
||||||
|
match self {
|
||||||
|
Self::Endpoint(error) => write!(f, "{error}"),
|
||||||
|
Self::Dispatch(error) => write!(f, "{error}"),
|
||||||
|
Self::Leaf(error) => write!(f, "{error}"),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl<E> core::error::Error for LeafRuntimeError<E> where E: core::error::Error + 'static {}
|
||||||
|
|
||||||
|
impl<E> From<EndpointError> for LeafRuntimeError<E> {
|
||||||
|
fn from(value: EndpointError) -> Self {
|
||||||
|
Self::Endpoint(value)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// High-level leaf behavior layered on top of validated protocol events.
|
||||||
|
pub trait CallLeaf: ProtocolLeaf {
|
||||||
|
type Error;
|
||||||
|
|
||||||
|
/// Handles hook-associated inbound `Data` after protocol validation.
|
||||||
|
fn on_data(&mut self, _data: IncomingData) -> Result<Vec<OutgoingData>, Self::Error> {
|
||||||
|
Ok(Vec::new())
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Observes one inbound `Fault` after protocol validation.
|
||||||
|
fn on_fault(&mut self, _fault: IncomingFault) -> Result<(), Self::Error> {
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Polls the leaf for locally-generated hook traffic.
|
||||||
|
fn poll(&mut self) -> Result<Vec<OutgoingData>, Self::Error> {
|
||||||
|
Ok(Vec::new())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Stateful runtime that combines a protocol endpoint with one leaf instance.
|
||||||
|
#[derive(Debug)]
|
||||||
|
pub struct LeafRuntime<L> {
|
||||||
|
endpoint: ProtocolEndpoint,
|
||||||
|
leaf: L,
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Frames emitted by the runtime after one receive or poll step.
|
||||||
|
#[derive(Debug, Default)]
|
||||||
|
pub struct RuntimeOutcome {
|
||||||
|
pub frames: Vec<FrameBytes>,
|
||||||
|
pub dropped: bool,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl<L> LeafRuntime<L> {
|
||||||
|
#[must_use]
|
||||||
|
pub fn new(endpoint: ProtocolEndpoint, leaf: L) -> Self {
|
||||||
|
Self { endpoint, leaf }
|
||||||
|
}
|
||||||
|
|
||||||
|
#[must_use]
|
||||||
|
pub fn endpoint(&self) -> &ProtocolEndpoint {
|
||||||
|
&self.endpoint
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn endpoint_mut(&mut self) -> &mut ProtocolEndpoint {
|
||||||
|
&mut self.endpoint
|
||||||
|
}
|
||||||
|
|
||||||
|
#[must_use]
|
||||||
|
pub fn leaf(&self) -> &L {
|
||||||
|
&self.leaf
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn leaf_mut(&mut self) -> &mut L {
|
||||||
|
&mut self.leaf
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl<L> LeafRuntime<L>
|
||||||
|
where
|
||||||
|
L: CallLeaf + super::CallProcedures<Error = <L as CallLeaf>::Error>,
|
||||||
|
{
|
||||||
|
pub fn receive(
|
||||||
|
&mut self,
|
||||||
|
ingress: &Ingress,
|
||||||
|
frame: FrameBytes,
|
||||||
|
) -> Result<RuntimeOutcome, LeafRuntimeError<<L as CallLeaf>::Error>> {
|
||||||
|
let outcome = self.endpoint.receive(ingress, frame)?;
|
||||||
|
self.process_endpoint_outcome(outcome)
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn poll(&mut self) -> Result<RuntimeOutcome, LeafRuntimeError<<L as CallLeaf>::Error>> {
|
||||||
|
let outgoing = self.leaf.poll().map_err(LeafRuntimeError::Leaf)?;
|
||||||
|
self.emit_outgoing(outgoing)
|
||||||
|
}
|
||||||
|
|
||||||
|
fn process_endpoint_outcome(
|
||||||
|
&mut self,
|
||||||
|
outcome: crate::protocol::tree::EndpointOutcome,
|
||||||
|
) -> Result<RuntimeOutcome, LeafRuntimeError<<L as CallLeaf>::Error>> {
|
||||||
|
let mut runtime = RuntimeOutcome {
|
||||||
|
frames: Vec::new(),
|
||||||
|
dropped: outcome.dropped,
|
||||||
|
};
|
||||||
|
|
||||||
|
if let Some((_route, frame)) = outcome.forward {
|
||||||
|
runtime.frames.push(frame);
|
||||||
|
}
|
||||||
|
|
||||||
|
let Some(event) = outcome.event else {
|
||||||
|
return Ok(runtime);
|
||||||
|
};
|
||||||
|
|
||||||
|
match event {
|
||||||
|
LocalEvent::Call { header, message } => {
|
||||||
|
let incoming = IncomingCall {
|
||||||
|
header,
|
||||||
|
message: message.clone(),
|
||||||
|
};
|
||||||
|
match self.leaf.dispatch_call(incoming) {
|
||||||
|
Ok(CallReply::Reply(bytes)) => {
|
||||||
|
if let Some(hook) = message.response_hook {
|
||||||
|
runtime.frames.extend(self.send_reply_data(
|
||||||
|
hook,
|
||||||
|
message.procedure_id,
|
||||||
|
bytes,
|
||||||
|
true,
|
||||||
|
)?);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
Ok(CallReply::NoReply) => {}
|
||||||
|
Err(error) => {
|
||||||
|
runtime
|
||||||
|
.frames
|
||||||
|
.extend(self.emit_internal_fault_if_possible(&message)?);
|
||||||
|
return Err(LeafRuntimeError::Dispatch(error));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
LocalEvent::Data {
|
||||||
|
header,
|
||||||
|
message,
|
||||||
|
hook_key,
|
||||||
|
} => {
|
||||||
|
let outgoing = self
|
||||||
|
.leaf
|
||||||
|
.on_data(IncomingData {
|
||||||
|
header,
|
||||||
|
message,
|
||||||
|
hook_key,
|
||||||
|
})
|
||||||
|
.map_err(LeafRuntimeError::Leaf)?;
|
||||||
|
runtime.frames.extend(self.emit_outgoing(outgoing)?.frames);
|
||||||
|
}
|
||||||
|
LocalEvent::Fault {
|
||||||
|
header,
|
||||||
|
message,
|
||||||
|
hook_key,
|
||||||
|
} => {
|
||||||
|
self.leaf
|
||||||
|
.on_fault(IncomingFault {
|
||||||
|
header,
|
||||||
|
fault: message,
|
||||||
|
hook_key,
|
||||||
|
})
|
||||||
|
.map_err(LeafRuntimeError::Leaf)?;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
Ok(runtime)
|
||||||
|
}
|
||||||
|
|
||||||
|
fn emit_outgoing(
|
||||||
|
&mut self,
|
||||||
|
outgoing: Vec<OutgoingData>,
|
||||||
|
) -> Result<RuntimeOutcome, LeafRuntimeError<<L as CallLeaf>::Error>> {
|
||||||
|
let mut runtime = RuntimeOutcome::default();
|
||||||
|
for packet in outgoing {
|
||||||
|
let endpoint_outcome = self.endpoint.send_data(
|
||||||
|
packet.dst_path,
|
||||||
|
packet.hook_id,
|
||||||
|
packet.procedure_id,
|
||||||
|
packet.data,
|
||||||
|
packet.end_hook,
|
||||||
|
)?;
|
||||||
|
runtime
|
||||||
|
.frames
|
||||||
|
.extend(self.process_endpoint_outcome(endpoint_outcome)?.frames);
|
||||||
|
}
|
||||||
|
Ok(runtime)
|
||||||
|
}
|
||||||
|
|
||||||
|
fn send_reply_data(
|
||||||
|
&mut self,
|
||||||
|
hook: HookTarget,
|
||||||
|
procedure_id: String,
|
||||||
|
bytes: Vec<u8>,
|
||||||
|
end_hook: bool,
|
||||||
|
) -> Result<Vec<FrameBytes>, LeafRuntimeError<<L as CallLeaf>::Error>> {
|
||||||
|
let endpoint_outcome = self.endpoint.send_data(
|
||||||
|
hook.return_path,
|
||||||
|
hook.hook_id,
|
||||||
|
procedure_id,
|
||||||
|
bytes,
|
||||||
|
end_hook,
|
||||||
|
)?;
|
||||||
|
Ok(self.process_endpoint_outcome(endpoint_outcome)?.frames)
|
||||||
|
}
|
||||||
|
|
||||||
|
fn emit_internal_fault_if_possible(
|
||||||
|
&mut self,
|
||||||
|
message: &CallMessage,
|
||||||
|
) -> Result<Vec<FrameBytes>, LeafRuntimeError<<L as CallLeaf>::Error>> {
|
||||||
|
let Some(hook) = message.response_hook.as_ref() else {
|
||||||
|
return Ok(Vec::new());
|
||||||
|
};
|
||||||
|
let key = HookKey::new(hook.return_path.clone(), hook.hook_id);
|
||||||
|
let outcome = self
|
||||||
|
.endpoint
|
||||||
|
.emit_fault_if_possible(Some(key), ProtocolFault::INTERNAL_ERROR)?;
|
||||||
|
Ok(self.process_endpoint_outcome(outcome)?.frames)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Decodes one archived call payload into a typed application request.
|
||||||
|
pub fn decode_call_input<T>(bytes: &[u8]) -> Result<T, FrameError>
|
||||||
|
where
|
||||||
|
T: Archive,
|
||||||
|
<T as Archive>::Archived: rkyv::Portable
|
||||||
|
+ for<'b> rkyv::bytecheck::CheckBytes<rkyv::api::high::HighValidator<'b, Error>>
|
||||||
|
+ rkyv::Deserialize<T, rkyv::api::high::HighDeserializer<Error>>,
|
||||||
|
{
|
||||||
|
crate::protocol::deserialize_archived_bytes::<<T as Archive>::Archived, T>(bytes)
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Encodes one typed application reply into hook `Data` bytes.
|
||||||
|
pub fn encode_call_reply<T>(value: &T) -> Result<Vec<u8>, FrameError>
|
||||||
|
where
|
||||||
|
T: for<'a> Serialize<
|
||||||
|
rkyv::api::high::HighSerializer<AlignedVec, rkyv::ser::allocator::ArenaHandle<'a>, Error>,
|
||||||
|
>,
|
||||||
|
{
|
||||||
|
let bytes = to_bytes::<Error>(value).map_err(FrameError::Serialize)?;
|
||||||
|
Ok(bytes.as_slice().to_vec())
|
||||||
|
}
|
||||||
@@ -205,6 +205,7 @@ impl ProtocolEndpoint {
|
|||||||
data: Vec<u8>,
|
data: Vec<u8>,
|
||||||
end_hook: bool,
|
end_hook: bool,
|
||||||
) -> Result<EndpointOutcome, EndpointError> {
|
) -> Result<EndpointOutcome, EndpointError> {
|
||||||
|
let local_end_dst_path = dst_path.clone();
|
||||||
let (header, message) =
|
let (header, message) =
|
||||||
self.prepare_data(dst_path, hook_id, procedure_id, data, end_hook)?;
|
self.prepare_data(dst_path, hook_id, procedure_id, data, end_hook)?;
|
||||||
|
|
||||||
@@ -213,7 +214,7 @@ impl ProtocolEndpoint {
|
|||||||
// so fall back to the endpoint's own hook key shape when closing them.
|
// so fall back to the endpoint's own hook key shape when closing them.
|
||||||
let local_hook_key = self
|
let local_hook_key = self
|
||||||
.hooks
|
.hooks
|
||||||
.resolve_active_key(&self.path, hook_id, &self.path)
|
.resolve_active_key(&local_end_dst_path, hook_id, &self.path)
|
||||||
.unwrap_or_else(|| HookKey::new(self.path.clone(), hook_id));
|
.unwrap_or_else(|| HookKey::new(self.path.clone(), hook_id));
|
||||||
if self.hooks.mark_local_end(&local_hook_key) {
|
if self.hooks.mark_local_end(&local_hook_key) {
|
||||||
self.hooks.remove_active(&local_hook_key);
|
self.hooks.remove_active(&local_hook_key);
|
||||||
|
|||||||
@@ -11,7 +11,7 @@ use crate::protocol::{
|
|||||||
CallMessage, DataMessage, FaultMessage, FrameBytes, FrameError, PacketHeader, ValidationError,
|
CallMessage, DataMessage, FaultMessage, FrameBytes, FrameError, PacketHeader, ValidationError,
|
||||||
};
|
};
|
||||||
|
|
||||||
use super::super::{CompiledRoutes, HookTable, RouteDecision};
|
use super::super::{CompiledRoutes, HookKey, HookTable, RouteDecision};
|
||||||
|
|
||||||
/// Registration state for a direct child endpoint.
|
/// Registration state for a direct child endpoint.
|
||||||
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
|
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
|
||||||
@@ -66,10 +66,12 @@ pub enum LocalEvent {
|
|||||||
Data {
|
Data {
|
||||||
header: PacketHeader,
|
header: PacketHeader,
|
||||||
message: DataMessage,
|
message: DataMessage,
|
||||||
|
hook_key: HookKey,
|
||||||
},
|
},
|
||||||
Fault {
|
Fault {
|
||||||
header: PacketHeader,
|
header: PacketHeader,
|
||||||
message: FaultMessage,
|
message: FaultMessage,
|
||||||
|
hook_key: HookKey,
|
||||||
},
|
},
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -35,6 +35,7 @@ impl ProtocolEndpoint {
|
|||||||
RouteDecision::Local => Ok(EndpointOutcome::event(LocalEvent::Fault {
|
RouteDecision::Local => Ok(EndpointOutcome::event(LocalEvent::Fault {
|
||||||
header,
|
header,
|
||||||
message,
|
message,
|
||||||
|
hook_key: key,
|
||||||
})),
|
})),
|
||||||
route => Ok(EndpointOutcome::forward(
|
route => Ok(EndpointOutcome::forward(
|
||||||
route,
|
route,
|
||||||
@@ -75,6 +76,7 @@ impl ProtocolEndpoint {
|
|||||||
message: FaultMessage {
|
message: FaultMessage {
|
||||||
fault: ProtocolFault::INVALID_HOOK_PEER,
|
fault: ProtocolFault::INVALID_HOOK_PEER,
|
||||||
},
|
},
|
||||||
|
hook_key: key,
|
||||||
}));
|
}));
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -87,7 +89,11 @@ impl ProtocolEndpoint {
|
|||||||
self.hooks.remove_active(&key);
|
self.hooks.remove_active(&key);
|
||||||
}
|
}
|
||||||
|
|
||||||
Ok(EndpointOutcome::event(LocalEvent::Data { header, message }))
|
Ok(EndpointOutcome::event(LocalEvent::Data {
|
||||||
|
header,
|
||||||
|
message,
|
||||||
|
hook_key: key,
|
||||||
|
}))
|
||||||
}
|
}
|
||||||
|
|
||||||
pub(crate) fn handle_local_fault(
|
pub(crate) fn handle_local_fault(
|
||||||
@@ -104,6 +110,7 @@ impl ProtocolEndpoint {
|
|||||||
return Ok(EndpointOutcome::event(LocalEvent::Fault {
|
return Ok(EndpointOutcome::event(LocalEvent::Fault {
|
||||||
header,
|
header,
|
||||||
message,
|
message,
|
||||||
|
hook_key: key,
|
||||||
}));
|
}));
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -117,6 +124,7 @@ impl ProtocolEndpoint {
|
|||||||
return Ok(EndpointOutcome::event(LocalEvent::Fault {
|
return Ok(EndpointOutcome::event(LocalEvent::Fault {
|
||||||
header,
|
header,
|
||||||
message,
|
message,
|
||||||
|
hook_key: pending_key,
|
||||||
}));
|
}));
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -75,6 +75,7 @@ impl ProtocolEndpoint {
|
|||||||
Ok(EndpointOutcome::event(super::core::LocalEvent::Data {
|
Ok(EndpointOutcome::event(super::core::LocalEvent::Data {
|
||||||
header: response_header,
|
header: response_header,
|
||||||
message: response,
|
message: response,
|
||||||
|
hook_key: key,
|
||||||
}))
|
}))
|
||||||
}
|
}
|
||||||
route => Ok(EndpointOutcome::forward(
|
route => Ok(EndpointOutcome::forward(
|
||||||
|
|||||||
@@ -1,9 +1,8 @@
|
|||||||
//! Application-facing leaf metadata helpers.
|
//! Application-facing leaf metadata helpers.
|
||||||
//!
|
//!
|
||||||
//! The protocol runtime itself only knows about `LeafSpec` metadata and validated
|
//! The protocol runtime itself only knows about `LeafSpec` metadata and validated
|
||||||
//! `LocalEvent::Call` delivery. This trait sits one layer above that runtime so
|
//! `LocalEvent` delivery. `ProtocolLeaf` owns the canonical dotted leaf id, while
|
||||||
//! application code can declare canonical leaf names and procedure ids once and
|
//! `CallProcedures` owns generated procedure ids and initial call dispatch.
|
||||||
//! then reuse the generated metadata when building endpoints and dispatching calls.
|
|
||||||
|
|
||||||
use alloc::{string::String, vec::Vec};
|
use alloc::{string::String, vec::Vec};
|
||||||
|
|
||||||
@@ -13,6 +12,11 @@ use super::LeafSpec;
|
|||||||
pub trait ProtocolLeaf {
|
pub trait ProtocolLeaf {
|
||||||
/// Returns the canonical dotted leaf name hosted by this type.
|
/// Returns the canonical dotted leaf name hosted by this type.
|
||||||
fn leaf_name() -> String;
|
fn leaf_name() -> String;
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Generated call metadata and initial `Call` dispatch for one leaf.
|
||||||
|
pub trait CallProcedures: ProtocolLeaf {
|
||||||
|
type Error;
|
||||||
|
|
||||||
/// Returns the local procedure suffixes supported by this leaf.
|
/// Returns the local procedure suffixes supported by this leaf.
|
||||||
fn procedure_suffixes() -> &'static [&'static str];
|
fn procedure_suffixes() -> &'static [&'static str];
|
||||||
@@ -44,6 +48,12 @@ pub trait ProtocolLeaf {
|
|||||||
procedures: Self::procedure_ids(),
|
procedures: Self::procedure_ids(),
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Dispatches one initial `Call` that targeted this leaf.
|
||||||
|
fn dispatch_call(
|
||||||
|
&mut self,
|
||||||
|
call: crate::protocol::tree::IncomingCall,
|
||||||
|
) -> Result<crate::protocol::tree::CallReply, crate::protocol::tree::DispatchError<Self::Error>>;
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Builds one canonical dotted leaf id from crate-local metadata plus optional
|
/// Builds one canonical dotted leaf id from crate-local metadata plus optional
|
||||||
|
|||||||
@@ -5,17 +5,23 @@
|
|||||||
//! - `hook` contains the pending/active hook lifecycle tables used by endpoint runtime code.
|
//! - `hook` contains the pending/active hook lifecycle tables used by endpoint runtime code.
|
||||||
//! - `endpoint` ties those pieces together into the runtime-facing protocol endpoint API.
|
//! - `endpoint` ties those pieces together into the runtime-facing protocol endpoint API.
|
||||||
|
|
||||||
|
mod call;
|
||||||
mod endpoint;
|
mod endpoint;
|
||||||
mod hook;
|
mod hook;
|
||||||
mod leaf;
|
mod leaf;
|
||||||
mod routing;
|
mod routing;
|
||||||
|
|
||||||
|
pub use call::{
|
||||||
|
Call, CallLeaf, CallReply, CallResult, DispatchError, IncomingCall, IncomingData,
|
||||||
|
IncomingFault, LeafRuntime, LeafRuntimeError, OutgoingData, RuntimeOutcome, decode_call_input,
|
||||||
|
encode_call_reply,
|
||||||
|
};
|
||||||
pub use endpoint::{
|
pub use endpoint::{
|
||||||
ChildRoute, ConnectionState, Endpoint, EndpointError, EndpointOutcome, Ingress, LeafSpec,
|
ChildRoute, ConnectionState, Endpoint, EndpointError, EndpointOutcome, Ingress, LeafSpec,
|
||||||
LocalEvent, ProtocolEndpoint,
|
LocalEvent, ProtocolEndpoint,
|
||||||
};
|
};
|
||||||
pub use hook::{ActiveHook, HookConflict, HookKey, HookTable, PendingHook};
|
pub use hook::{ActiveHook, HookConflict, HookKey, HookTable, PendingHook};
|
||||||
pub use leaf::{ProtocolLeaf, derive_leaf_name};
|
pub use leaf::{CallProcedures, ProtocolLeaf, derive_leaf_name};
|
||||||
pub use routing::{
|
pub use routing::{
|
||||||
CompiledRoutes, DefaultRouteProvider, LeafNode, RouteDecision, RouteProvider, TreeNode,
|
CompiledRoutes, DefaultRouteProvider, LeafNode, RouteDecision, RouteProvider, TreeNode,
|
||||||
is_prefix, route_destination,
|
is_prefix, route_destination,
|
||||||
|
|||||||
@@ -18,7 +18,9 @@ impl Simulation {
|
|||||||
) -> Result<(), SimError> {
|
) -> Result<(), SimError> {
|
||||||
let node_path = self.node(node_id).display_path();
|
let node_path = self.node(node_id).display_path();
|
||||||
match event {
|
match event {
|
||||||
LocalEvent::Data { header, message } => {
|
LocalEvent::Data {
|
||||||
|
header, message, ..
|
||||||
|
} => {
|
||||||
let text = String::from_utf8_lossy(&message.data).to_string();
|
let text = String::from_utf8_lossy(&message.data).to_string();
|
||||||
let hook_ref = format_hook_ref(
|
let hook_ref = format_hook_ref(
|
||||||
self.node(node_id).path.as_slice(),
|
self.node(node_id).path.as_slice(),
|
||||||
@@ -64,7 +66,9 @@ impl Simulation {
|
|||||||
message,
|
message,
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
LocalEvent::Fault { header, message } => {
|
LocalEvent::Fault {
|
||||||
|
header, message, ..
|
||||||
|
} => {
|
||||||
let hook_ref = format_hook_ref(
|
let hook_ref = format_hook_ref(
|
||||||
self.node(node_id).path.as_slice(),
|
self.node(node_id).path.as_slice(),
|
||||||
header.hook_id.unwrap_or(0),
|
header.hook_id.unwrap_or(0),
|
||||||
|
|||||||
+376
-63
@@ -1,9 +1,10 @@
|
|||||||
//! Proc macros for `unshell` application-layer leaf declarations.
|
//! Proc macros for `unshell` application-layer leaf declarations.
|
||||||
|
|
||||||
use proc_macro::TokenStream;
|
use proc_macro::TokenStream;
|
||||||
use quote::quote;
|
use quote::{format_ident, quote};
|
||||||
use syn::{
|
use syn::{
|
||||||
DeriveInput, Error, Ident, LitStr, Result, Token, parse::Parse, parse_macro_input,
|
Attribute, DeriveInput, Error, FnArg, GenericArgument, Ident, ImplItem, ImplItemFn, ItemImpl,
|
||||||
|
LitStr, PatType, Result, ReturnType, Token, Type, TypePath, parse::Parse, parse_macro_input,
|
||||||
punctuated::Punctuated,
|
punctuated::Punctuated,
|
||||||
};
|
};
|
||||||
|
|
||||||
@@ -15,6 +16,17 @@ pub fn derive_leaf(input: TokenStream) -> TokenStream {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[proc_macro_attribute]
|
||||||
|
pub fn procedures(attr: TokenStream, item: TokenStream) -> TokenStream {
|
||||||
|
match expand_procedures(
|
||||||
|
parse_macro_input!(attr as ProceduresAttributes),
|
||||||
|
parse_macro_input!(item as ItemImpl),
|
||||||
|
) {
|
||||||
|
Ok(tokens) => tokens.into(),
|
||||||
|
Err(error) => error.to_compile_error().into(),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
fn expand_leaf(input: DeriveInput) -> Result<proc_macro2::TokenStream> {
|
fn expand_leaf(input: DeriveInput) -> Result<proc_macro2::TokenStream> {
|
||||||
let struct_name = input.ident;
|
let struct_name = input.ident;
|
||||||
match input.data {
|
match input.data {
|
||||||
@@ -28,23 +40,8 @@ fn expand_leaf(input: DeriveInput) -> Result<proc_macro2::TokenStream> {
|
|||||||
};
|
};
|
||||||
|
|
||||||
let parsed = LeafAttributes::parse_from(&input.attrs)?;
|
let parsed = LeafAttributes::parse_from(&input.attrs)?;
|
||||||
let procedures = parsed.procedures.clone().ok_or_else(|| {
|
|
||||||
Error::new_spanned(&struct_name, "missing #[leaf(procedures(...))] attribute")
|
|
||||||
})?;
|
|
||||||
|
|
||||||
if procedures.is_empty() {
|
|
||||||
return Err(Error::new_spanned(
|
|
||||||
&struct_name,
|
|
||||||
"leaf must declare at least one procedure suffix",
|
|
||||||
));
|
|
||||||
}
|
|
||||||
|
|
||||||
let (impl_generics, ty_generics, where_clause) = input.generics.split_for_impl();
|
let (impl_generics, ty_generics, where_clause) = input.generics.split_for_impl();
|
||||||
let leaf_name_expr = parsed.leaf_name_expression(&struct_name);
|
let leaf_name_expr = parsed.leaf_name_expression(&struct_name);
|
||||||
let procedure_suffix_literals = procedures
|
|
||||||
.iter()
|
|
||||||
.map(|procedure| LitStr::new(&procedure.to_string(), proc_macro2::Span::call_site()))
|
|
||||||
.collect::<Vec<_>>();
|
|
||||||
let warning_note = parsed
|
let warning_note = parsed
|
||||||
.explicit_id_value()
|
.explicit_id_value()
|
||||||
.as_ref()
|
.as_ref()
|
||||||
@@ -59,39 +56,17 @@ fn expand_leaf(input: DeriveInput) -> Result<proc_macro2::TokenStream> {
|
|||||||
proc_macro2::Span::call_site(),
|
proc_macro2::Span::call_site(),
|
||||||
)
|
)
|
||||||
})
|
})
|
||||||
.map(|note| {
|
.map(|note| quote! { #[deprecated(note = #note)] });
|
||||||
let attr = quote! { #[deprecated(note = #note)] };
|
let leaf_name_warning_attr = warning_note.unwrap_or_else(|| quote! {});
|
||||||
(attr.clone(), attr.clone(), attr)
|
|
||||||
});
|
|
||||||
let (leaf_spec_warning_attr, procedure_warning_attr, leaf_name_warning_attr) =
|
|
||||||
warning_note.unwrap_or_else(|| (quote! {}, quote! {}, quote! {}));
|
|
||||||
|
|
||||||
Ok(quote! {
|
Ok(quote! {
|
||||||
impl #impl_generics ::unshell::protocol::tree::ProtocolLeaf for #struct_name #ty_generics #where_clause {
|
impl #impl_generics ::unshell::protocol::tree::ProtocolLeaf for #struct_name #ty_generics #where_clause {
|
||||||
fn leaf_name() -> ::unshell::alloc::string::String {
|
fn leaf_name() -> ::unshell::alloc::string::String {
|
||||||
#leaf_name_expr
|
#leaf_name_expr
|
||||||
}
|
}
|
||||||
|
|
||||||
fn procedure_suffixes() -> &'static [&'static str] {
|
|
||||||
&[#(#procedure_suffix_literals),*]
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
impl #impl_generics #struct_name #ty_generics #where_clause {
|
impl #impl_generics #struct_name #ty_generics #where_clause {
|
||||||
/// Returns the canonical protocol leaf metadata for this type.
|
|
||||||
#leaf_spec_warning_attr
|
|
||||||
pub fn protocol_leaf_spec() -> ::unshell::protocol::tree::LeafSpec {
|
|
||||||
<Self as ::unshell::protocol::tree::ProtocolLeaf>::leaf_spec()
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Resolves one local procedure suffix to its full canonical `procedure_id`.
|
|
||||||
#procedure_warning_attr
|
|
||||||
pub fn protocol_procedure_id(
|
|
||||||
suffix: &str,
|
|
||||||
) -> ::core::option::Option<::unshell::alloc::string::String> {
|
|
||||||
<Self as ::unshell::protocol::tree::ProtocolLeaf>::procedure_id(suffix)
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Returns the canonical dotted leaf name declared for this type.
|
/// Returns the canonical dotted leaf name declared for this type.
|
||||||
#leaf_name_warning_attr
|
#leaf_name_warning_attr
|
||||||
pub fn protocol_leaf_name() -> ::unshell::alloc::string::String {
|
pub fn protocol_leaf_name() -> ::unshell::alloc::string::String {
|
||||||
@@ -101,6 +76,315 @@ fn expand_leaf(input: DeriveInput) -> Result<proc_macro2::TokenStream> {
|
|||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
|
fn expand_procedures(
|
||||||
|
attr: ProceduresAttributes,
|
||||||
|
mut item: ItemImpl,
|
||||||
|
) -> Result<proc_macro2::TokenStream> {
|
||||||
|
let self_ty = item.self_ty.clone();
|
||||||
|
let impl_generics = item.generics.clone();
|
||||||
|
let (impl_generics_tokens, ty_generics, where_clause) = impl_generics.split_for_impl();
|
||||||
|
let error_ty = attr.error.ok_or_else(|| {
|
||||||
|
Error::new_spanned(
|
||||||
|
&item.self_ty,
|
||||||
|
"missing #[procedures(error = MyError)] attribute",
|
||||||
|
)
|
||||||
|
})?;
|
||||||
|
|
||||||
|
let mut dispatch_arms = Vec::new();
|
||||||
|
|
||||||
|
for impl_item in &mut item.items {
|
||||||
|
let ImplItem::Fn(method) = impl_item else {
|
||||||
|
continue;
|
||||||
|
};
|
||||||
|
if !take_call_attr(&mut method.attrs) {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
|
dispatch_arms.push(expand_call_arm(method)?);
|
||||||
|
}
|
||||||
|
|
||||||
|
if dispatch_arms.is_empty() {
|
||||||
|
return Err(Error::new_spanned(
|
||||||
|
&item.self_ty,
|
||||||
|
"#[procedures] requires at least one #[call] method",
|
||||||
|
));
|
||||||
|
}
|
||||||
|
|
||||||
|
let suffix_literals = dispatch_arms
|
||||||
|
.iter()
|
||||||
|
.map(|arm| arm.suffix_literal.clone())
|
||||||
|
.collect::<Vec<_>>();
|
||||||
|
let procedure_matches = dispatch_arms.iter().map(|arm| {
|
||||||
|
let suffix = &arm.suffix_literal;
|
||||||
|
quote! { #suffix => <Self as ::unshell::protocol::tree::CallProcedures>::procedure_id(#suffix), }
|
||||||
|
});
|
||||||
|
let dispatch_checks = dispatch_arms.iter().map(|arm| arm.dispatch_tokens.clone());
|
||||||
|
|
||||||
|
Ok(quote! {
|
||||||
|
#item
|
||||||
|
|
||||||
|
impl #impl_generics_tokens ::unshell::protocol::tree::CallProcedures for #self_ty #where_clause {
|
||||||
|
type Error = #error_ty;
|
||||||
|
|
||||||
|
fn procedure_suffixes() -> &'static [&'static str] {
|
||||||
|
&[#(#suffix_literals),*]
|
||||||
|
}
|
||||||
|
|
||||||
|
fn dispatch_call(
|
||||||
|
&mut self,
|
||||||
|
call: ::unshell::protocol::tree::IncomingCall,
|
||||||
|
) -> ::core::result::Result<
|
||||||
|
::unshell::protocol::tree::CallReply,
|
||||||
|
::unshell::protocol::tree::DispatchError<Self::Error>,
|
||||||
|
> {
|
||||||
|
#(#dispatch_checks)*
|
||||||
|
unreachable!("protocol runtime validated local procedure dispatch")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl #impl_generics_tokens #self_ty #ty_generics #where_clause {
|
||||||
|
/// Returns the canonical protocol leaf metadata for this type.
|
||||||
|
pub fn protocol_leaf_spec() -> ::unshell::protocol::tree::LeafSpec {
|
||||||
|
<Self as ::unshell::protocol::tree::CallProcedures>::leaf_spec()
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Resolves one local procedure suffix to its full canonical `procedure_id`.
|
||||||
|
pub fn protocol_procedure_id(
|
||||||
|
suffix: &str,
|
||||||
|
) -> ::core::option::Option<::unshell::alloc::string::String> {
|
||||||
|
match suffix {
|
||||||
|
#(#procedure_matches)*
|
||||||
|
_ => ::core::option::Option::None,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
struct CallArm {
|
||||||
|
suffix_literal: LitStr,
|
||||||
|
dispatch_tokens: proc_macro2::TokenStream,
|
||||||
|
}
|
||||||
|
|
||||||
|
fn expand_call_arm(method: &ImplItemFn) -> Result<CallArm> {
|
||||||
|
let method_name = &method.sig.ident;
|
||||||
|
let suffix_literal = LitStr::new(&method_name.to_string(), method_name.span());
|
||||||
|
let call_id_expr = quote! {
|
||||||
|
<Self as ::unshell::protocol::tree::CallProcedures>::procedure_id(#suffix_literal)
|
||||||
|
.expect("generated procedure id must exist")
|
||||||
|
};
|
||||||
|
|
||||||
|
let inputs = method
|
||||||
|
.sig
|
||||||
|
.inputs
|
||||||
|
.iter()
|
||||||
|
.filter(|input| !matches!(input, FnArg::Receiver(_)))
|
||||||
|
.collect::<Vec<_>>();
|
||||||
|
|
||||||
|
let invocation = expand_invocation(method_name, &inputs)?;
|
||||||
|
let return_value = expand_return_conversion(&method.sig.output, quote! { __unshell_result })?;
|
||||||
|
|
||||||
|
Ok(CallArm {
|
||||||
|
suffix_literal: suffix_literal.clone(),
|
||||||
|
dispatch_tokens: quote! {
|
||||||
|
if call.message.procedure_id == #call_id_expr {
|
||||||
|
let __unshell_result = #invocation;
|
||||||
|
return { #return_value };
|
||||||
|
}
|
||||||
|
},
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
fn expand_invocation(method_name: &Ident, inputs: &[&FnArg]) -> Result<proc_macro2::TokenStream> {
|
||||||
|
if inputs.is_empty() {
|
||||||
|
return Ok(quote! { self.#method_name() });
|
||||||
|
}
|
||||||
|
|
||||||
|
if inputs.len() == 1 {
|
||||||
|
let FnArg::Typed(PatType { ty, .. }) = inputs[0] else {
|
||||||
|
return Err(Error::new_spanned(
|
||||||
|
inputs[0],
|
||||||
|
"unsupported receiver in procedure signature",
|
||||||
|
));
|
||||||
|
};
|
||||||
|
|
||||||
|
if let Some(inner) = extract_call_inner_type(ty) {
|
||||||
|
return Ok(quote! {{
|
||||||
|
let __unshell_input = ::unshell::protocol::tree::decode_call_input::<#inner>(
|
||||||
|
call.message.data.as_slice(),
|
||||||
|
)
|
||||||
|
.map_err(::unshell::protocol::tree::DispatchError::Decode)?;
|
||||||
|
let __unshell_call = ::unshell::protocol::tree::Call {
|
||||||
|
input: __unshell_input,
|
||||||
|
caller_path: call.header.src_path.clone(),
|
||||||
|
procedure_id: call.message.procedure_id.clone(),
|
||||||
|
dst_leaf: call.header.dst_leaf.clone(),
|
||||||
|
response_hook: call
|
||||||
|
.message
|
||||||
|
.response_hook
|
||||||
|
.as_ref()
|
||||||
|
.map(|hook| ::unshell::protocol::tree::HookKey::new(
|
||||||
|
hook.return_path.clone(),
|
||||||
|
hook.hook_id,
|
||||||
|
)),
|
||||||
|
};
|
||||||
|
self.#method_name(__unshell_call)
|
||||||
|
}});
|
||||||
|
}
|
||||||
|
|
||||||
|
return Ok(quote! {{
|
||||||
|
let __unshell_input = ::unshell::protocol::tree::decode_call_input::<#ty>(
|
||||||
|
call.message.data.as_slice(),
|
||||||
|
)
|
||||||
|
.map_err(::unshell::protocol::tree::DispatchError::Decode)?;
|
||||||
|
self.#method_name(__unshell_input)
|
||||||
|
}});
|
||||||
|
}
|
||||||
|
|
||||||
|
let tuple_types = inputs
|
||||||
|
.iter()
|
||||||
|
.map(|input| match input {
|
||||||
|
FnArg::Typed(PatType { ty, .. }) => Ok(ty.clone()),
|
||||||
|
other => Err(Error::new_spanned(
|
||||||
|
other,
|
||||||
|
"unsupported receiver in procedure signature",
|
||||||
|
)),
|
||||||
|
})
|
||||||
|
.collect::<Result<Vec<_>>>()?;
|
||||||
|
let vars = (0..tuple_types.len())
|
||||||
|
.map(|index| format_ident!("__unshell_arg_{index}"))
|
||||||
|
.collect::<Vec<_>>();
|
||||||
|
|
||||||
|
Ok(quote! {{
|
||||||
|
let (#(#vars),*) = ::unshell::protocol::tree::decode_call_input::<(#(#tuple_types),*)>(
|
||||||
|
call.message.data.as_slice(),
|
||||||
|
)
|
||||||
|
.map_err(::unshell::protocol::tree::DispatchError::Decode)?;
|
||||||
|
self.#method_name(#(#vars),*)
|
||||||
|
}})
|
||||||
|
}
|
||||||
|
|
||||||
|
fn expand_return_conversion(
|
||||||
|
return_type: &ReturnType,
|
||||||
|
value: proc_macro2::TokenStream,
|
||||||
|
) -> Result<proc_macro2::TokenStream> {
|
||||||
|
match return_type {
|
||||||
|
ReturnType::Default => Ok(quote! {
|
||||||
|
let _ = #value;
|
||||||
|
::core::result::Result::Ok(::unshell::protocol::tree::CallReply::NoReply)
|
||||||
|
}),
|
||||||
|
ReturnType::Type(_, ty) => normalize_output_type(ty, value),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fn normalize_output_type(
|
||||||
|
ty: &Type,
|
||||||
|
value: proc_macro2::TokenStream,
|
||||||
|
) -> Result<proc_macro2::TokenStream> {
|
||||||
|
if is_unit_type(ty) {
|
||||||
|
return Ok(quote! {
|
||||||
|
let _ = #value;
|
||||||
|
::core::result::Result::Ok(::unshell::protocol::tree::CallReply::NoReply)
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
if let Some(inner) = extract_outer_type_argument(ty, "CallResult") {
|
||||||
|
let inner_conversion = normalize_reply_value(inner, quote! { __unshell_value })?;
|
||||||
|
return Ok(quote! {
|
||||||
|
match #value {
|
||||||
|
::unshell::protocol::tree::CallResult::Reply(__unshell_value) => {
|
||||||
|
#inner_conversion
|
||||||
|
}
|
||||||
|
::unshell::protocol::tree::CallResult::NoReply => {
|
||||||
|
::core::result::Result::Ok(::unshell::protocol::tree::CallReply::NoReply)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
if let Some((ok_ty, _error_ty)) = extract_result_type_arguments(ty) {
|
||||||
|
let ok_conversion = normalize_output_type(ok_ty, quote! { __unshell_value })?;
|
||||||
|
return Ok(quote! {
|
||||||
|
match #value {
|
||||||
|
::core::result::Result::Ok(__unshell_value) => { #ok_conversion }
|
||||||
|
::core::result::Result::Err(__unshell_error) => {
|
||||||
|
::core::result::Result::Err(
|
||||||
|
::unshell::protocol::tree::DispatchError::Handler(__unshell_error)
|
||||||
|
)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
normalize_reply_value(ty, value)
|
||||||
|
}
|
||||||
|
|
||||||
|
fn normalize_reply_value(
|
||||||
|
_ty: &Type,
|
||||||
|
value: proc_macro2::TokenStream,
|
||||||
|
) -> Result<proc_macro2::TokenStream> {
|
||||||
|
Ok(quote! {
|
||||||
|
::core::result::Result::Ok(::unshell::protocol::tree::CallReply::Reply(
|
||||||
|
::unshell::protocol::tree::encode_call_reply(&#value)
|
||||||
|
.map_err(::unshell::protocol::tree::DispatchError::Encode)?
|
||||||
|
))
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
fn extract_call_inner_type(ty: &Type) -> Option<&Type> {
|
||||||
|
extract_outer_type_argument(ty, "Call")
|
||||||
|
}
|
||||||
|
|
||||||
|
fn extract_outer_type_argument<'a>(ty: &'a Type, expected: &str) -> Option<&'a Type> {
|
||||||
|
let Type::Path(TypePath { path, .. }) = ty else {
|
||||||
|
return None;
|
||||||
|
};
|
||||||
|
let segment = path.segments.last()?;
|
||||||
|
if segment.ident != expected {
|
||||||
|
return None;
|
||||||
|
}
|
||||||
|
let syn::PathArguments::AngleBracketed(arguments) = &segment.arguments else {
|
||||||
|
return None;
|
||||||
|
};
|
||||||
|
match arguments.args.first()? {
|
||||||
|
GenericArgument::Type(inner) => Some(inner),
|
||||||
|
_ => None,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fn extract_result_type_arguments(ty: &Type) -> Option<(&Type, &Type)> {
|
||||||
|
let Type::Path(TypePath { path, .. }) = ty else {
|
||||||
|
return None;
|
||||||
|
};
|
||||||
|
let segment = path.segments.last()?;
|
||||||
|
if segment.ident != "Result" {
|
||||||
|
return None;
|
||||||
|
}
|
||||||
|
let syn::PathArguments::AngleBracketed(arguments) = &segment.arguments else {
|
||||||
|
return None;
|
||||||
|
};
|
||||||
|
let mut args = arguments.args.iter();
|
||||||
|
let ok = match args.next()? {
|
||||||
|
GenericArgument::Type(value) => value,
|
||||||
|
_ => return None,
|
||||||
|
};
|
||||||
|
let err = match args.next()? {
|
||||||
|
GenericArgument::Type(value) => value,
|
||||||
|
_ => return None,
|
||||||
|
};
|
||||||
|
Some((ok, err))
|
||||||
|
}
|
||||||
|
|
||||||
|
fn is_unit_type(ty: &Type) -> bool {
|
||||||
|
matches!(ty, Type::Tuple(tuple) if tuple.elems.is_empty())
|
||||||
|
}
|
||||||
|
|
||||||
|
fn take_call_attr(attrs: &mut Vec<Attribute>) -> bool {
|
||||||
|
let original_len = attrs.len();
|
||||||
|
attrs.retain(|attr| !attr.path().is_ident("call"));
|
||||||
|
original_len != attrs.len()
|
||||||
|
}
|
||||||
|
|
||||||
#[derive(Default)]
|
#[derive(Default)]
|
||||||
struct LeafAttributes {
|
struct LeafAttributes {
|
||||||
name: Option<LitStr>,
|
name: Option<LitStr>,
|
||||||
@@ -109,11 +393,10 @@ struct LeafAttributes {
|
|||||||
product: Option<LitStr>,
|
product: Option<LitStr>,
|
||||||
version: Option<LitStr>,
|
version: Option<LitStr>,
|
||||||
leaf_name: Option<LitStr>,
|
leaf_name: Option<LitStr>,
|
||||||
procedures: Option<Vec<Ident>>,
|
|
||||||
}
|
}
|
||||||
|
|
||||||
impl LeafAttributes {
|
impl LeafAttributes {
|
||||||
fn parse_from(attrs: &[syn::Attribute]) -> Result<Self> {
|
fn parse_from(attrs: &[Attribute]) -> Result<Self> {
|
||||||
let mut parsed = Self::default();
|
let mut parsed = Self::default();
|
||||||
|
|
||||||
for attr in attrs {
|
for attr in attrs {
|
||||||
@@ -170,16 +453,6 @@ impl LeafAttributes {
|
|||||||
return Ok(());
|
return Ok(());
|
||||||
}
|
}
|
||||||
|
|
||||||
if meta.path.is_ident("procedures") {
|
|
||||||
if parsed.procedures.is_some() {
|
|
||||||
return Err(meta.error("duplicate leaf procedures attribute"));
|
|
||||||
}
|
|
||||||
|
|
||||||
let nested: ProcedureList = meta.input.parse()?;
|
|
||||||
parsed.procedures = Some(nested.0.into_iter().collect());
|
|
||||||
return Ok(());
|
|
||||||
}
|
|
||||||
|
|
||||||
Err(meta.error("unsupported #[leaf(...)] attribute"))
|
Err(meta.error("unsupported #[leaf(...)] attribute"))
|
||||||
})?;
|
})?;
|
||||||
}
|
}
|
||||||
@@ -250,6 +523,56 @@ fn looks_like_canonical_leaf_name(name: &str) -> bool {
|
|||||||
.all(|character| character.is_ascii_digit() || character == '_')
|
.all(|character| character.is_ascii_digit() || character == '_')
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[derive(Default)]
|
||||||
|
struct ProceduresAttributes {
|
||||||
|
error: Option<Type>,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Parse for ProceduresAttributes {
|
||||||
|
fn parse(input: syn::parse::ParseStream<'_>) -> Result<Self> {
|
||||||
|
if input.is_empty() {
|
||||||
|
return Ok(Self::default());
|
||||||
|
}
|
||||||
|
|
||||||
|
let mut parsed = Self::default();
|
||||||
|
let assignments = Punctuated::<Assignment, Token![,]>::parse_terminated(input)?;
|
||||||
|
for assignment in assignments {
|
||||||
|
if assignment.name == "error" {
|
||||||
|
if parsed.error.is_some() {
|
||||||
|
return Err(Error::new_spanned(
|
||||||
|
assignment.name,
|
||||||
|
"duplicate procedures error attribute",
|
||||||
|
));
|
||||||
|
}
|
||||||
|
parsed.error = Some(assignment.value);
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
return Err(Error::new_spanned(
|
||||||
|
assignment.name,
|
||||||
|
"unsupported #[procedures(...)] attribute",
|
||||||
|
));
|
||||||
|
}
|
||||||
|
Ok(parsed)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
struct Assignment {
|
||||||
|
name: Ident,
|
||||||
|
value: Type,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Parse for Assignment {
|
||||||
|
fn parse(input: syn::parse::ParseStream<'_>) -> Result<Self> {
|
||||||
|
Ok(Self {
|
||||||
|
name: input.parse()?,
|
||||||
|
value: {
|
||||||
|
input.parse::<Token![=]>()?;
|
||||||
|
input.parse()?
|
||||||
|
},
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
#[cfg(test)]
|
#[cfg(test)]
|
||||||
mod tests {
|
mod tests {
|
||||||
use super::looks_like_canonical_leaf_name;
|
use super::looks_like_canonical_leaf_name;
|
||||||
@@ -267,13 +590,3 @@ mod tests {
|
|||||||
assert!(!looks_like_canonical_leaf_name("Org.example.v1.echo"));
|
assert!(!looks_like_canonical_leaf_name("Org.example.v1.echo"));
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
struct ProcedureList(Punctuated<Ident, Token![,]>);
|
|
||||||
|
|
||||||
impl Parse for ProcedureList {
|
|
||||||
fn parse(input: syn::parse::ParseStream<'_>) -> Result<Self> {
|
|
||||||
let content;
|
|
||||||
syn::parenthesized!(content in input);
|
|
||||||
Ok(Self(Punctuated::parse_terminated(&content)?))
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|||||||
Reference in New Issue
Block a user