1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
//! Symmetrical messenger for both client and server.

use crate::scenegraph::{self, ScenegraphError};
use global_counter::primitive::exact::CounterU64;
use nix::cmsg_space;
use nix::fcntl::{fcntl, FcntlArg};
use nix::sys::socket::{recvmsg, sendmsg, ControlMessage, ControlMessageOwned, MsgFlags};
use rustc_hash::FxHashMap;
use stardust_xr_schemas::flat::flatbuffers::{self, InvalidFlatbuffer};
use stardust_xr_schemas::flat::message::{root_as_message, Message as FlatMessage, MessageArgs};
use stardust_xr_schemas::flex::flexbuffers;
use std::future::Future;
use std::io::{IoSlice, IoSliceMut};
use std::os::fd::{AsRawFd, FromRawFd, IntoRawFd, OwnedFd, RawFd};
use std::sync::Arc;
use thiserror::Error;
use tokio::io::{AsyncReadExt, AsyncWriteExt, Interest};
use tokio::net::unix::{OwnedReadHalf, OwnedWriteHalf};
use tokio::net::UnixStream;
use tokio::sync::{mpsc, oneshot};
use tracing::instrument;

#[instrument(level = "trace", skip_all)]
fn debug_call(
	incoming: bool,
	call_type: u8,
	id: u64,
	path: Option<&str>,
	method: Option<&str>,
	err: Option<&str>,
	data: &[u8],
) {
	let level = match call_type {
		0 => tracing::Level::WARN,
		_ => tracing::Level::DEBUG,
	};

	if tracing::level_enabled!(level) {
		let call_type = match call_type {
			0 => "error",
			1 => "signal",
			2 => "method call",
			3 => "method return",
			_ => "unknown",
		};
		let data = match flexbuffers::Reader::get_root(data) {
			Ok(root) => root.to_string(),
			Err(_) => String::from_utf8_lossy(data).into_owned(),
		};

		match level {
			tracing::Level::WARN => {
				tracing::warn!(
					source = match incoming {
						true => "remote",
						false => "local",
					},
					id,
					path,
					method,
					err,
					data,
					"Stardust error",
				)
			}
			_ => {
				tracing::trace!(
					direction = match incoming {
						true => "incoming",
						false => "outgoing",
					},
					call_type,
					id,
					path,
					method,
					err,
					data,
					"Stardust message",
				)
			}
		}
	}
}

/// Error for all messenger-related failures.
#[derive(Error, Debug)]
pub enum MessengerError {
	/// The MessageReceiver has been dropped with pending futures
	#[error("Receiver has been dropped")]
	ReceiverDropped,
	#[error("IO Error: {0}")]
	IOError(std::io::Error),
	/// The incoming message is corrupted
	#[error("Invalid flatbuffer {0}")]
	InvalidFlatbuffer(InvalidFlatbuffer),
	/// The message type u8 is greater than method return (3)
	#[error("Message type is out of bounds")]
	MessageTypeOutOfBounds,
}
impl From<std::io::Error> for MessengerError {
	fn from(e: std::io::Error) -> Self {
		MessengerError::IOError(e)
	}
}
impl From<InvalidFlatbuffer> for MessengerError {
	fn from(e: InvalidFlatbuffer) -> Self {
		MessengerError::InvalidFlatbuffer(e)
	}
}

/// Wrapper for messages after being serialized, for type safety.
pub struct Message {
	data: Vec<u8>,
	fds: Vec<OwnedFd>,
}
impl Message {
	pub fn into_message(self) -> Vec<u8> {
		self.data
	}
	pub fn into_components(self) -> (Vec<u8>, Vec<OwnedFd>) {
		(self.data, self.fds)
	}
}

/// Header for sending messages over the socket.
#[derive(Clone, Copy)]
pub struct Header {
	pub body_length: u32,
}
impl Header {
	pub const SIZE: usize = 4;
	pub fn into_bytes(self) -> [u8; Self::SIZE] {
		self.body_length.to_ne_bytes()
	}
	pub fn from_bytes(bytes: [u8; Self::SIZE]) -> Self {
		let body_length = u32::from_ne_bytes(bytes);
		Header { body_length }
	}
}

type PendingFuture = oneshot::Sender<Result<Message, String>>;
type PendingFutureSender = mpsc::UnboundedSender<(u64, PendingFuture)>;
type PendingFutureReceiver = mpsc::UnboundedReceiver<(u64, PendingFuture)>;

/// Receiving half of the messenger.
pub struct MessageReceiver {
	read: OwnedReadHalf,
	pending_futures: FxHashMap<u64, PendingFuture>,
	pending_future_rx: PendingFutureReceiver,
	send_handle: MessageSenderHandle,
}
impl MessageReceiver {
	fn new(
		read: OwnedReadHalf,
		pending_future_rx: PendingFutureReceiver,
		send_handle: MessageSenderHandle,
	) -> Self {
		MessageReceiver {
			read,
			pending_futures: Default::default(),
			pending_future_rx,
			send_handle,
		}
	}
	/// Take all the pending futures in the queue from method calls and store them for when the other side sends a method return.
	pub fn update_pending_futures(&mut self) {
		while let Ok((id, future)) = self.pending_future_rx.try_recv() {
			let _ = self.pending_futures.insert(id, future);
		}
	}
	/// Await a message from the socket, parse it, and handle it.
	pub async fn dispatch<S: scenegraph::Scenegraph>(
		&mut self,
		scenegraph: &S,
	) -> Result<(), MessengerError> {
		let mut header_buffer = [0_u8; Header::SIZE];
		self.read.read_exact(&mut header_buffer).await?;
		let header = Header::from_bytes(header_buffer);

		let mut body: Vec<u8> = std::vec::from_elem(0_u8, header.body_length as usize);
		let fds: Vec<OwnedFd>;
		let iov = &mut [IoSliceMut::new(body.as_mut_slice())];

		// 253 is the Linux value for SCM_MAX_FD (max FDs in a cmsg)
		let mut cmsgs = cmsg_space!([RawFd; 253]);

		let stream = self.read.as_ref();
		fds = stream
			.async_io(Interest::READABLE, || {
				match recvmsg::<()>(stream.as_raw_fd(), iov, Some(&mut cmsgs), MsgFlags::empty()) {
					Ok(recv_msg) => {
						let fds = recv_msg
							.cmsgs()
							.map(|cmsg| {
								if let ControlMessageOwned::ScmRights(fds) = cmsg {
									fds
								} else {
									Vec::new()
								}
							})
							.flatten()
							.filter_map(|fd| match fcntl(fd, FcntlArg::F_GETFD) {
								Err(nix::errno::Errno::EBADF) => None,
								_ => unsafe { Some(OwnedFd::from_raw_fd(fd)) }, // Consider non-EBADF errors as valid
							})
							.collect();
						Ok(fds)
					}
					Err(nix::Error::EWOULDBLOCK) => Err(std::io::ErrorKind::WouldBlock.into()),
					Err(e) => Err(std::io::Error::new(std::io::ErrorKind::Other, e)),
				}
			})
			.await?;

		self.update_pending_futures();
		self.handle_message(body, scenegraph, fds)
	}

	#[instrument(level = "trace", skip_all)]
	fn handle_message<S: scenegraph::Scenegraph>(
		&mut self,
		raw_message: Vec<u8>,
		scenegraph: &S,
		fds: Vec<OwnedFd>,
	) -> Result<(), MessengerError> {
		let message = root_as_message(&raw_message)?;
		let message_type = message.type_();

		debug_call(
			true,
			message_type,
			message.id(),
			message.object(),
			message.method(),
			message.error(),
			message.data().map(|d| d.bytes()).unwrap_or(&[]),
		);
		let id = message.id();
		let path = message.object().unwrap_or("unknown");
		let method = message.method().unwrap_or("unknown");
		let data = message.data().unwrap_or_default().bytes();
		match message_type {
			// Errors
			0 => {
				let future_opt = self.pending_futures.remove(&message.id());
				if let Some(future) = future_opt {
					let _ = future.send(Err(message.error().unwrap_or("unknown").to_string()));
				}
			}
			// Signals
			1 => {
				let signal_status = scenegraph.send_signal(path, method, data, fds);
				if let Err(e) = signal_status {
					self.send_handle
						.error(message.id(), path, method, e, data)?;
				}
			}
			// Method called
			2 => {
				let (response_tx, response_rx) =
					oneshot::channel::<Result<(Vec<u8>, Vec<OwnedFd>), ScenegraphError>>();
				let send_handle = self.send_handle.clone();
				scenegraph.execute_method(path, method, data, fds, response_tx);
				tokio::task::spawn(async move {
					let Ok(message) = root_as_message(&raw_message) else {return};
					let path = message.object().unwrap_or("unknown");
					let method = message.method().unwrap_or("unknown");
					let data = message.data().unwrap_or_default().bytes();
					if let Ok(result) = response_rx.await {
						let _ = match result {
							Ok((data, fds)) => send_handle.send(serialize_call(
								3,
								message.id(),
								path,
								method,
								None,
								&data,
								fds,
							)),
							Err(error) => {
								send_handle.error(message.id(), path, method, error, data)
							}
						};
					} else {
						let _ = send_handle.error(
							message.id(),
							path,
							method,
							"Internal: method did not return a response",
							data,
						);
					}
				});
			}
			// Method return
			3 => {
				let future_opt = self.pending_futures.remove(&id);
				match future_opt {
					None => {
						self.send_handle.error(
							message.id(),
							path,
							method,
							"Method return without method call".to_string(),
							data,
						)?;
					}
					Some(future) => {
						let _ = future.send(Ok(Message {
							data: data.to_vec(),
							fds,
						}));
					}
				}
			}
			_ => println!("Type is wayyy off"),
		}
		Ok(())
	}
}

/// Generate an error message from arguments.
pub fn serialize_error<T: std::fmt::Display>(
	id: u64,
	object: &str,
	method: &str,
	err: T,
	data: &[u8],
) -> Message {
	let error = format!("{}", err);
	serialize_call(
		0,
		id,
		object,
		method,
		Some(error.as_str()),
		data,
		Vec::new(),
	)
}
/// Generate a signal message from arguments.
pub fn serialize_signal_call(
	id: u64,
	object: &str,
	method: &str,
	data: &[u8],
	fds: Vec<OwnedFd>,
) -> Message {
	serialize_call(1, id, object, method, None, data, fds)
}
/// Generate a method message from arguments.
pub fn serialize_method_call(
	id: u64,
	object: &str,
	method: &str,
	data: &[u8],
	fds: Vec<OwnedFd>,
) -> Message {
	serialize_call(2, id, object, method, None, data, fds)
}
#[instrument(level = "trace", skip_all)]
fn serialize_call(
	call_type: u8,
	id: u64,
	path: &str,
	method: &str,
	err: Option<&str>,
	data: &[u8],
	fds: Vec<OwnedFd>,
) -> Message {
	debug_call(false, call_type, id, Some(path), Some(method), err, data);

	let mut fbb = flatbuffers::FlatBufferBuilder::with_capacity(1024);
	let flex_path = fbb.create_string(path);
	let flex_method = fbb.create_string(method);
	let flex_err = err.map(|s| fbb.create_string(s));
	let flex_data = fbb.create_vector(data);

	let message_constructed = FlatMessage::create(
		&mut fbb,
		&MessageArgs {
			type_: call_type,
			id,
			object: Some(flex_path),
			method: Some(flex_method),
			error: flex_err,
			data: Some(flex_data),
		},
	);
	fbb.finish(message_constructed, None);
	Message {
		data: fbb.finished_data().to_vec(),
		fds,
	}
}

/// Sender half of the messenger
pub struct MessageSender {
	write: OwnedWriteHalf,
	handle: MessageSenderHandle,
	message_rx: mpsc::UnboundedReceiver<Message>,
	pending_future_tx: PendingFutureSender,
	message_counter: Arc<CounterU64>,
}
impl MessageSender {
	fn new(write: OwnedWriteHalf, pending_future_tx: PendingFutureSender) -> Self {
		let (message_tx, message_rx) = mpsc::unbounded_channel();
		let max_message_id = Arc::new(CounterU64::new(0));
		MessageSender {
			write,
			handle: MessageSenderHandle {
				message_tx,
				pending_future_tx: pending_future_tx.clone(),
				message_counter: max_message_id.clone(),
			},
			message_rx,
			pending_future_tx,
			message_counter: max_message_id,
		}
	}
	/// Send all the queued messages from the handles
	pub async fn flush(&mut self) -> Result<(), MessengerError> {
		while let Some(message) = self.message_rx.recv().await {
			self.send(message).await?;
		}
		Ok(())
	}
	/// Send a message and await until sent.
	pub async fn send(&mut self, message: Message) -> Result<(), MessengerError> {
		let body = &message.data;
		let header = Header {
			body_length: body.len() as u32,
		};

		self.write.write_all(&header.into_bytes()).await?;

		if message.fds.is_empty() {
			self.write.write_all(body).await?;
		} else {
			let iov = &[IoSlice::new(body)];
			let fds = message
				.fds
				.into_iter()
				.map(IntoRawFd::into_raw_fd)
				.collect::<Vec<_>>();
			let cmsgs = &[ControlMessage::ScmRights(&fds)];

			let stream = self.write.as_ref();
			stream
				.async_io(Interest::WRITABLE, || {
					match sendmsg::<()>(stream.as_raw_fd(), iov, cmsgs, MsgFlags::empty(), None) {
						Ok(_) => Ok(()),
						Err(nix::Error::EWOULDBLOCK) => Err(std::io::ErrorKind::WouldBlock.into()),
						Err(e) => Err(std::io::Error::new(std::io::ErrorKind::Other, e)),
					}
				})
				.await?;
		}
		Ok(())
	}
	/// Get a handle to send messages from anywhere.
	pub fn handle(&self) -> MessageSenderHandle {
		self.handle.clone()
	}

	/// Send a signal immediately, await until sent.
	pub async fn signal(
		&mut self,
		node_path: &str,
		signal_name: &str,
		data: &[u8],
		fds: Vec<OwnedFd>,
	) -> Result<(), MessengerError> {
		let id = self.message_counter.inc();
		self.send(serialize_signal_call(id, node_path, signal_name, data, fds))
			.await
	}
	/// Call a method immediately, await until other side sends back a response or the message fails to send.
	pub async fn method(
		&mut self,
		node_path: &str,
		method: &str,
		data: &[u8],
		fds: Vec<OwnedFd>,
	) -> Result<Result<Message, String>, MessengerError> {
		let (tx, rx) = oneshot::channel();
		let id = self.message_counter.inc();
		self.pending_future_tx
			.send((id, tx))
			.map_err(|_| MessengerError::ReceiverDropped)?;
		self.send(serialize_method_call(id, node_path, method, data, fds))
			.await?;
		rx.await.map_err(|_| MessengerError::ReceiverDropped)
	}
}

/// Handle to the message sender, so you can synchronously send messages from anywhere without blocking.
#[derive(Clone)]
pub struct MessageSenderHandle {
	message_tx: mpsc::UnboundedSender<Message>,
	pending_future_tx: PendingFutureSender,
	message_counter: Arc<CounterU64>,
}
impl MessageSenderHandle {
	/// Queue up an error to be sent.
	pub fn error<E: std::fmt::Display>(
		&self,
		id: u64,
		node_path: &str,
		method_name: &str,
		err: E,
		data: &[u8],
	) -> Result<(), MessengerError> {
		self.send(serialize_error(id, node_path, method_name, err, data))
	}
	/// Queue up a signal to be sent.
	pub fn signal(
		&self,
		node_path: &str,
		signal_name: &str,
		data: &[u8],
		fds: Vec<OwnedFd>,
	) -> Result<(), MessengerError> {
		let id = self.message_counter.inc();
		self.send(serialize_signal_call(id, node_path, signal_name, data, fds))
	}
	/// Queue up a method to be sent and get back a future for when a response is returned.
	pub fn method(
		&self,
		node_path: &str,
		method: &str,
		data: &[u8],
		fds: Vec<OwnedFd>,
	) -> Result<impl Future<Output = Result<Message, String>>, MessengerError> {
		let (tx, rx) = oneshot::channel();
		let id = self.message_counter.inc();
		self.pending_future_tx
			.send((id, tx))
			.map_err(|_| MessengerError::ReceiverDropped)?;
		self.send(serialize_method_call(id, node_path, method, data, fds))?;
		Ok(async move { rx.await.map_err(|e| e.to_string())? })
	}

	#[instrument(level = "trace", skip_all)]
	fn send(&self, message: Message) -> Result<(), MessengerError> {
		self.message_tx
			.send(message)
			.map_err(|_| MessengerError::ReceiverDropped)
	}
}

/// Create 2 messenger halves from a connection to a stardust client or server.
pub fn create(connection: UnixStream) -> (MessageSender, MessageReceiver) {
	let (read, write) = connection.into_split();
	let (pending_future_tx, pending_future_rx) = mpsc::unbounded_channel();
	let sender = MessageSender::new(write, pending_future_tx);
	let receiver = MessageReceiver::new(read, pending_future_rx, sender.handle());
	(sender, receiver)
}