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
//! # Crosstalk Macros
//!
//! This crate provides macros for simplifying communication between threads using the Crosstalk library.
//!
//! ## Benchmarks
//!
//! The benchmarks module contains functions to benchmark different communication scenarios.
//!
//! ## External Dependencies
//!
//! This file imports external dependencies such as `quote` and `syn` for code generation and parsing.
//!
//! ## Functionality
//!
//! This file contains various functions for handling message transmission and reception between publishers and subscribers.
//! The functions are designed to work efficiently and return when messages are successfully received.
//! There are also functions for draining messages from subscribers and handling multiple publishers and subscribers.
//!
//! ## Constants
//!
//! The file defines constants for the number of publishers, subscribers, and messages used in the benchmarks.
//!
//! ## Custom Structs
//!
//! There are examples of custom structs like `DetectorOutput`, though they are currently commented out for future use.
//!
//! ## Topics Enum
//!
//! An example enum `TopicZoo` is defined for different topics that can be communicated between threads.
//!
//! ## Utility Functions
//!
//! Utility functions like `write` and `read` are provided for writing messages to publishers and reading messages from subscribers.
//!
//! ## Error Handling
//!
//! The code includes error handling for downcasting message types using the `downcast` function.
//!
//! ## Benchmarking
//!
//! Benchmarks are set up for various communication scenarios to measure performance and efficiency.
//!
//! ## Thread Management
//!
//! The file manages threads for communication between publishers and subscribers, ensuring messages are received and processed correctly.
//!
//! ## License
//!
//! This code is licensed under the MIT license.
// --------------------------------------------------
// external
// --------------------------------------------------
use quote::{
quote,
format_ident,
};
use syn::{
Data,
Path,
Type,
Token,
parse::{
Parse,
ParseStream,
},
DeriveInput,
PathArguments,
GenericArgument,
parse_macro_input,
punctuated::Punctuated,
};
use proc_macro2::Ident;
use proc_macro::TokenStream;
use std::collections::HashSet;
use proc_macro2::TokenStream as TokenStream2;
#[derive(Debug)]
struct NodeField {
topic: Path,
_arrow: Token![=>],
dtype: Type,
}
impl Parse for NodeField {
fn parse(input: ParseStream) -> syn::Result<Self> {
Ok(NodeField {
topic: input.parse()?,
_arrow: input.parse()?,
dtype: input.parse()?,
})
}
}
struct NodeFields(Punctuated<NodeField, Token![,]>);
impl Parse for NodeFields {
fn parse(input: ParseStream) -> syn::Result<Self> {
let content = Punctuated::<NodeField, Token![,]>::parse_terminated(input)?;
Ok(NodeFields(content))
}
}
fn get_publisher_arm(tenum: &Ident, case: Option<&Path>, dtype: &Type) -> TokenStream2 {
let contents = quote! {
=> {
let err = ::crosstalk::Error::PublisherMismatch(
::std::any::type_name::<D>().into(),
::std::any::type_name::<#dtype>().into(),
);
if ::std::any::TypeId::of::<D>()
== ::std::any::TypeId::of::<#dtype>() {
// --------------------------------------------------
// if the datatype matches, get the flume sender to create the publisher
// --------------------------------------------------
let tsen = match self.senders.contains_key(&topic) {
true => {
let tsen_ = ::crosstalk::downcast::<
::crosstalk::external::broadcast::Sender<#dtype>
>(self.senders.remove(&topic).unwrap()).unwrap();
let tsen = tsen_.clone();
self.senders.insert(topic, Box::new(tsen_));
tsen
},
false => {
// size is defined during crosstalk::BoundedNode::new(size)
let (sender, _) = ::crosstalk::external::broadcast::channel::<#dtype>(self.size);
self.senders.insert(topic, Box::new(sender.clone()));
if self.create_runtimes {
let rt = match ::crosstalk::external::runtime::Runtime::new() {
Ok(rt) => ::std::sync::Arc::new(rt),
Err(err) => {
::crosstalk::external::log::error!("{}", err);
return Err(Box::new(err))
}
};
self.runtimes.insert(topic, rt);
}
sender
}
};
// --------------------------------------------------
// create and return publisher
// --------------------------------------------------
match ::crosstalk::downcast::<::crosstalk::Publisher<D, #tenum>>(Box::new(::crosstalk::Publisher::new(tsen, topic))) {
Ok(publisher) => Ok(publisher),
Err(_e) => { // <-- this should never happen
::crosstalk::external::log::error!("{}", err);
Err(Box::new(err))
}
}
} else {
// --------------------------------------------------
// if the datatype does not match, return an error
// --------------------------------------------------
::crosstalk::external::log::error!("{}", err);
Err(Box::new(err))
}
}
};
// --------------------------------------------------
// if arm not specified, use default (_)
// --------------------------------------------------
match case {
Some(case) => quote! { #case #contents },
None => quote! { _ #contents }
}
}
fn get_subscriber_arm(case: Option<&Path>, dtype: &Type) -> TokenStream2 {
let contents = quote! {
=> {
let err = ::crosstalk::Error::SubscriberMismatch(
::std::any::type_name::<D>().into(),
::std::any::type_name::<#dtype>().into(),
);
if ::std::any::TypeId::of::<D>()
== ::std::any::TypeId::of::<#dtype>() {
// --------------------------------------------------
// if the datatype matches, get the flume receiver to create the subscriber
// --------------------------------------------------
let tsen = match self.senders.contains_key(&topic) {
true => {
let tsen_ = ::crosstalk::downcast::<
::crosstalk::external::broadcast::Sender<#dtype>
>(self.senders.remove(&topic).unwrap()).unwrap();
let tsen = tsen_.clone();
self.senders.insert(topic, Box::new(tsen_));
tsen
},
false => {
// size is defined during crosstalk::BoundedNode::new(size)
let (sender, _) = ::crosstalk::external::broadcast::channel::<#dtype>(self.size);
self.senders.insert(topic, Box::new(sender.clone()));
sender
}
};
let rt = match self.create_runtimes {
true => match self.runtimes.get(&topic) {
Some(rt) => Some(rt.clone()),
None => {
let rt = match ::crosstalk::external::runtime::Runtime::new() {
Ok(rt) => ::std::sync::Arc::new(rt),
Err(err) => {
::crosstalk::external::log::error!("{}", err);
return Err(Box::new(err))
}
};
self.runtimes.insert(topic, rt.clone());
Some(rt)
}
},
false => None,
};
// --------------------------------------------------
// create and return subscriber
// --------------------------------------------------
match ::crosstalk::downcast::<::crosstalk::external::broadcast::Sender<D>>(Box::new(tsen)) {
Ok(sender) => Ok(::crosstalk::Subscriber::new(topic, None, ::std::sync::Arc::new(sender), rt)),
// Ok(rec) => Ok(::crosstalk::Subscriber::new(did, ::std::sync::Arc::new(::std::sync::Mutex::new(self)), rec, topic)),
Err(_e) => { // <-- this should never happen
::crosstalk::external::log::error!("{}", err);
Err(Box::new(err))
}
}
} else {
// --------------------------------------------------
// if the datatype does not match, return an error
// --------------------------------------------------
::crosstalk::external::log::error!("{}", err);
Err(Box::new(err))
}
}
};
// --------------------------------------------------
// if arm not specified, use default (_)
// --------------------------------------------------
match case {
Some(case) => quote! { #case #contents },
None => quote! { _ #contents }
}
}
#[proc_macro]
pub fn init(input: TokenStream) -> TokenStream {
// --------------------------------------------------
// parse
// --------------------------------------------------
let NodeFields(fields) = parse_macro_input!(input as NodeFields);
// --------------------------------------------------
// see if there are multiple enums for topics
// --------------------------------------------------
let unique_enum_names = fields
.iter()
.map(|nf|
nf
.topic
.segments
.first()
.map(|s|
s
.ident
.to_string()
).unwrap()
)
.collect::<HashSet<_>>()
.into_iter()
.collect::<Vec<_>>();
if unique_enum_names.len() > 1 {
// TODO: change this to use crosstalk::Error
let error_desc = "Multiple Topic Enums found in constructing crosstalk node";
let error_msg = "Please use only one Enum to represent Topics, and use the absolute path to the Enum (e.g. `TopicEnum::MyTopic` instead of `MyTopic`)";
panic!("\n{}\nFound:\n{:#?}\n{}", error_desc, unique_enum_names, error_msg);
}
let enum_master = format_ident!( "{}", &unique_enum_names[0]);
// --------------------------------------------------
// get topic names/types
// --------------------------------------------------
let nt = fields
.iter()
.map(|nf| (&nf.topic, &nf.dtype))
.map(|(n, t)| (
n.to_owned(),
t.to_owned(),
))
.collect::<Vec<_>>();
// --------------------------------------------------
// default type
// --------------------------------------------------
let dt: Type = syn::parse_quote! { String };
// --------------------------------------------------
// publisher arms
// - add default case
// --------------------------------------------------
let mut pub_arms: Vec<TokenStream2> = nt
.iter()
.map(|(n, t)| {
get_publisher_arm(&enum_master, Some(n), t)
}).collect();
pub_arms.push(get_publisher_arm(&enum_master, None, &dt));
// --------------------------------------------------
// subscriber arms
// - add default case
// --------------------------------------------------
let mut sub_arms: Vec<TokenStream2> = nt
.iter()
.map(|(n, t)| get_subscriber_arm(Some(n), t))
.collect::<Vec<_>>();
sub_arms.push(get_subscriber_arm(None, &dt));
// --------------------------------------------------
// output
// --------------------------------------------------
let output: TokenStream2 = quote! {
#[automatically_derived]
impl ::crosstalk::CrosstalkPubSub<#enum_master> for ::crosstalk::ImplementedBoundedNode<#enum_master> {
fn publisher<D: 'static>(&mut self, topic: #enum_master) -> Result<::crosstalk::Publisher<D, #enum_master>, Box<dyn ::std::error::Error>> {
match topic {
#(#pub_arms,)*
}
}
fn subscriber<D: Clone + Send + 'static>(&mut self, topic: #enum_master) -> Result<::crosstalk::Subscriber<D, #enum_master>, Box<dyn ::std::error::Error>> {
match topic {
#(#sub_arms,)*
}
}
fn pubsub<D: Clone + Send + 'static>(&mut self, topic: #enum_master) -> Result<(::crosstalk::Publisher<D, #enum_master>, ::crosstalk::Subscriber<D, #enum_master>), Box<dyn ::std::error::Error>> {
match self.publisher(topic) {
Ok(publisher) => {
match self.subscriber(topic) {
Ok(subscriber) => Ok((publisher, subscriber)),
Err(err) => Err(err),
}
},
Err(err) => Err(err),
}
}
fn delete_publisher<D: 'static>(&mut self, _publisher: ::crosstalk::Publisher<D, #enum_master>) {}
fn delete_subscriber<D: Clone + Send + 'static>(&mut self, subscriber: ::crosstalk::Subscriber<D, #enum_master>) {}
}
};
// --------------------------------------------------
// return
// --------------------------------------------------
TokenStream::from(output)
}
#[proc_macro_derive(AsTopic)]
pub fn derive_enum_as_topic(input: TokenStream) -> TokenStream {
let input = parse_macro_input!(input as DeriveInput);
// ensure only dealing with enums
if let Data::Enum(_) = &input.data {
} else { panic!("CrosstalkTopic can only be derived on enums"); }
// TODO: get error from crosstalk errors
let name = &input.ident;
let expanded = quote! {
#[automatically_derived]
impl ::core::clone::Clone for #name {
#[inline]
fn clone(&self) -> #name { *self }
}
#[automatically_derived]
impl ::core::marker::Copy for #name {}
// TODO: impl this once stable
// #[automatically_derived]
// impl ::core::marker::StructuralPartialEq for #name {}
#[automatically_derived]
impl ::core::cmp::PartialEq for #name {
#[inline]
fn eq(&self, other: &#name) -> bool {
let __self_tag = ::std::mem::discriminant(self);
let __arg1_tag = ::std::mem::discriminant(other);
__self_tag == __arg1_tag
}
}
#[automatically_derived]
impl ::core::cmp::Eq for #name { }
#[automatically_derived]
impl ::core::hash::Hash for #name {
#[inline]
fn hash<__H: ::core::hash::Hasher>(&self, state: &mut __H) {
let __self_tag = ::std::mem::discriminant(self);
::core::hash::Hash::hash(&__self_tag, state)
}
}
#[automatically_derived]
impl ::crosstalk::CrosstalkTopic for #name {}
};
TokenStream::from(expanded)
}
fn _type2fish(ty: &Type) -> TokenStream2 {
match ty {
Type::Path(type_path) => {
let mut tokens = TokenStream2::new();
for (i, segment) in type_path.path.segments.iter().enumerate() {
if i > 0 {
tokens.extend(quote!(::));
}
let ident = &segment.ident;
tokens.extend(quote!(#ident));
match &segment.arguments {
PathArguments::AngleBracketed(args) => {
let args_tokens: Vec<TokenStream2> = args.args.iter().map(|arg| {
match arg {
GenericArgument::Type(ty) => _type2fish(ty),
// Extend this match to handle other GenericArgument variants as needed
_ => quote!(#arg),
}
}).collect();
if !args_tokens.is_empty() {
tokens.extend(quote!(::<#(#args_tokens),*>));
}
},
// Handle other PathArguments variants if necessary
_ => {}
}
}
tokens
},
// Extend this match to handle other Type variants as needed
_ => quote!(#ty),
}
}