LailaTheElf/embassy
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge #732

Browse Source 
732: macros: simplify task macro using "TAIT laundering". r=Dirbaio a=Dirbaio

This brings the macro to the state before the nightly update #729 #730, with a much cleaner workaround for the opaque type error, from https://github.com/rust-lang/rust/issues/96406

Co-authored-by: Dario Nieuwenhuis <dirbaio@dirbaio.net>
This commit is contained in:
bors[bot] 2022-04-26 17:03:06 +00:00 committed by GitHub
commit 3131510f4c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 14 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
embassy-macros/src/macros/task.rs
View File

@ -33,12 +33,10 @@ pub fn run(args: syn::AttributeArgs, f: syn::ItemFn) -> Result<TokenStream, Toke
ctxt.error_spanned_by(&f.sig, "pool_size must be 1 or greater"); ctxt.error_spanned_by(&f.sig, "pool_size must be 1 or greater");
} }
let mut arg_types = Vec::new();
let mut arg_names = Vec::new(); let mut arg_names = Vec::new();
let mut arg_indexes = Vec::new();
let mut fargs = f.sig.inputs.clone(); let mut fargs = f.sig.inputs.clone();
for (i, arg) in fargs.iter_mut().enumerate() { for arg in fargs.iter_mut() {
match arg { match arg {
syn::FnArg::Receiver(_) => { syn::FnArg::Receiver(_) => {
ctxt.error_spanned_by(arg, "task functions must not have receiver arguments"); ctxt.error_spanned_by(arg, "task functions must not have receiver arguments");
@ -46,8 +44,6 @@ pub fn run(args: syn::AttributeArgs, f: syn::ItemFn) -> Result<TokenStream, Toke
syn::FnArg::Typed(t) => match t.pat.as_mut() { syn::FnArg::Typed(t) => match t.pat.as_mut() {
syn::Pat::Ident(id) => { syn::Pat::Ident(id) => {
arg_names.push(id.ident.clone()); arg_names.push(id.ident.clone());
arg_types.push(t.ty.clone());
arg_indexes.push(syn::Index::from(i));
id.mutability = None; id.mutability = None;
} }
_ => { _ => {
@ -64,8 +60,6 @@ pub fn run(args: syn::AttributeArgs, f: syn::ItemFn) -> Result<TokenStream, Toke
let task_ident = f.sig.ident.clone(); let task_ident = f.sig.ident.clone();
let task_inner_ident = format_ident!("__{}_task", task_ident); let task_inner_ident = format_ident!("__{}_task", task_ident);
let mod_ident = format_ident!("__{}_mod", task_ident);
let args_ident = format_ident!("__{}_args", task_ident);
let mut task_inner = f; let mut task_inner = f;
let visibility = task_inner.vis.clone(); let visibility = task_inner.vis.clone();
@ -73,29 +67,32 @@ pub fn run(args: syn::AttributeArgs, f: syn::ItemFn) -> Result<TokenStream, Toke
task_inner.sig.ident = task_inner_ident.clone(); task_inner.sig.ident = task_inner_ident.clone();
let result = quote! { let result = quote! {
// This is the user's task function, renamed.
// We put it outside the #task_ident fn below, because otherwise
// the items defined there (such as POOL) would be in scope
// in the user's code.
#task_inner #task_inner
#[allow(non_camel_case_types)] #visibility fn #task_ident(#fargs) -> #embassy_path::executor::SpawnToken<impl ::core::future::Future + 'static> {
type #args_ident = (#(#arg_types,)*); use ::core::future::Future;
mod #mod_ident {
use #embassy_path::executor::SpawnToken; use #embassy_path::executor::SpawnToken;
use #embassy_path::executor::raw::TaskStorage; use #embassy_path::executor::raw::TaskStorage;
type Fut = impl ::core::future::Future + 'static; type Fut = impl Future + 'static;
#[allow(clippy::declare_interior_mutable_const)] #[allow(clippy::declare_interior_mutable_const)]
const NEW_TS: TaskStorage<Fut> = TaskStorage::new(); const NEW_TS: TaskStorage<Fut> = TaskStorage::new();
static POOL: [TaskStorage<Fut>; #pool_size] = [NEW_TS; #pool_size]; static POOL: [TaskStorage<Fut>; #pool_size] = [NEW_TS; #pool_size];
pub(super) fn task(args: super::#args_ident) -> SpawnToken<Fut> { // Opaque type laundering, to obscure its origin!
unsafe { TaskStorage::spawn_pool(&POOL, move || super::#task_inner_ident(#(args.#arg_indexes),*)) } // Workaround for "opaque type's hidden type cannot be another opaque type from the same scope"
// https://github.com/rust-lang/rust/issues/96406
fn launder_tait(token: SpawnToken<impl Future+'static>) -> SpawnToken<impl Future+'static> {
token
} }
}
#visibility fn #task_ident(#fargs) -> #embassy_path::executor::SpawnToken<impl ::core::future::Future + 'static> { launder_tait(unsafe { TaskStorage::spawn_pool(&POOL, move || #task_inner_ident(#(#arg_names,)*)) })
#mod_ident::task((#(#arg_names,)*))
} }
}; };