diff options
author | 2018-12-16 18:18:17 +0000 | |
---|---|---|
committer | 2018-12-16 18:18:17 +0000 | |
commit | c2fbb2848851e32b78e79ff9e919538b7d5ab8a0 (patch) | |
tree | cadf6359329573a79e937afcef2972f2cf01f6b4 /macros/src/codegen.rs | |
parent | 5c458fc115393b93b158b7f6770bc81596d97977 (diff) | |
parent | d35f5bc0b0453c2e98b8398d36bd2ba553edce45 (diff) | |
download | rtic-c2fbb2848851e32b78e79ff9e919538b7d5ab8a0.tar.gz rtic-c2fbb2848851e32b78e79ff9e919538b7d5ab8a0.tar.zst rtic-c2fbb2848851e32b78e79ff9e919538b7d5ab8a0.zip |
Merge #114
114: properly handle conditional compilation r=japaric a=japaric
of resources and tasks
Co-authored-by: Jorge Aparicio <jorge@japaric.io>
Diffstat (limited to 'macros/src/codegen.rs')
-rw-r--r-- | macros/src/codegen.rs | 302 |
1 files changed, 229 insertions, 73 deletions
diff --git a/macros/src/codegen.rs b/macros/src/codegen.rs index 71c60907..45c3e263 100644 --- a/macros/src/codegen.rs +++ b/macros/src/codegen.rs @@ -10,10 +10,12 @@ use std::{ use proc_macro2::Span; use quote::quote; use rand::{Rng, SeedableRng}; -use syn::{ArgCaptured, Ident, IntSuffix, LitInt}; +use syn::{parse_quote, ArgCaptured, Attribute, Ident, IntSuffix, LitInt}; -use analyze::{Analysis, Ownership}; -use syntax::{App, Idents, Static}; +use crate::{ + analyze::{Analysis, Ownership}, + syntax::{App, Idents, Static}, +}; // NOTE to avoid polluting the user namespaces we map some identifiers to pseudo-hygienic names. // In some instances we also use the pseudo-hygienic names for safety, for example the user should @@ -86,8 +88,6 @@ struct Resources { pub fn app(app: &App, analysis: &Analysis) -> TokenStream { let mut ctxt = Context::default(); - let device = &app.args.device; - let resources = resources(&mut ctxt, &app, analysis); let tasks = tasks(&mut ctxt, &app, analysis); @@ -146,6 +146,7 @@ pub fn app(app: &App, analysis: &Analysis) -> TokenStream { let assertions = assertions(app, analysis); + let main = mk_ident(None); let init = &ctxt.init; quote!( #resources @@ -162,11 +163,7 @@ pub fn app(app: &App, analysis: &Analysis) -> TokenStream { #root_interrupts - // We put these items into a pseudo-module to avoid a collision between the `interrupt` - // import and user code const APP: () = { - use #device::interrupt; - #scoped_interrupts #(#dispatchers)* @@ -178,10 +175,10 @@ pub fn app(app: &App, analysis: &Analysis) -> TokenStream { #idle_fn + #[export_name = "main"] #[allow(unsafe_code)] - #[rtfm::export::entry] #[doc(hidden)] - unsafe fn main() -> ! { + unsafe fn #main() -> ! { #assertions rtfm::export::interrupt::disable(); @@ -204,6 +201,7 @@ fn resources(ctxt: &mut Context, app: &App, analysis: &Analysis) -> proc_macro2: let mut items = vec![]; let mut module = vec![]; for (name, res) in &app.resources { + let cfgs = &res.cfgs; let attrs = &res.attrs; let mut_ = &res.mutability; let ty = &res.ty; @@ -219,6 +217,7 @@ fn resources(ctxt: &mut Context, app: &App, analysis: &Analysis) -> proc_macro2: if let Some(Ownership::Shared { ceiling }) = analysis.ownerships.get(name) { items.push(mk_resource( ctxt, + cfgs, name, quote!(#name), *ceiling, @@ -238,6 +237,7 @@ fn resources(ctxt: &mut Context, app: &App, analysis: &Analysis) -> proc_macro2: .map(|expr| { quote!( #(#attrs)* + #(#cfgs)* #[doc = #symbol] static mut #alias: #ty = #expr; ) @@ -245,6 +245,7 @@ fn resources(ctxt: &mut Context, app: &App, analysis: &Analysis) -> proc_macro2: .unwrap_or_else(|| { quote!( #(#attrs)* + #(#cfgs)* #[doc = #symbol] static mut #alias: rtfm::export::MaybeUninit<#ty> = rtfm::export::MaybeUninit::uninitialized(); @@ -262,6 +263,7 @@ fn resources(ctxt: &mut Context, app: &App, analysis: &Analysis) -> proc_macro2: items.push(mk_resource( ctxt, + cfgs, name, quote!(#ty), *ceiling, @@ -297,6 +299,7 @@ fn init(ctxt: &mut Context, app: &App, analysis: &Analysis) -> proc_macro2::Toke .assigns .iter() .map(|assign| { + let attrs = &assign.attrs; if app .resources .get(&assign.left) @@ -305,11 +308,17 @@ fn init(ctxt: &mut Context, app: &App, analysis: &Analysis) -> proc_macro2::Toke { let alias = &ctxt.statics[&assign.left]; let expr = &assign.right; - quote!(unsafe { #alias.set(#expr); }) + quote!( + #(#attrs)* + unsafe { #alias.set(#expr); } + ) } else { let left = &assign.left; let right = &assign.right; - quote!(#left = #right;) + quote!( + #(#attrs)* + #left = #right; + ) } }) .collect::<Vec<_>>(); @@ -607,12 +616,14 @@ fn prelude( // NOTE This field is just to avoid unused type parameter errors around `'a` defs.push(quote!(#[allow(dead_code)] #priority: &'a core::cell::Cell<u8>)); - exprs.push(quote!(#priority)); + exprs.push(parse_quote!(#priority)); let mut may_call_lock = false; let mut needs_unsafe = false; for name in resources { let res = &app.resources[name]; + let cfgs = &res.cfgs; + let initialized = res.expr.is_some(); let singleton = res.singleton; let mut_ = res.mutability; @@ -624,23 +635,40 @@ fn prelude( // owned by Init if singleton { needs_unsafe = true; - defs.push(quote!(pub #name: #name)); - exprs.push(quote!(#name: <#name as owned_singleton::Singleton>::new())); + defs.push(quote!( + #(#cfgs)* + pub #name: #name + )); + exprs.push(quote!( + #(#cfgs)* + #name: <#name as owned_singleton::Singleton>::new() + )); continue; } else { - defs.push(quote!(pub #name: &'static #mut_ #ty)); + defs.push(quote!( + #(#cfgs)* + pub #name: &'static #mut_ #ty + )); } } else { // owned by someone else if singleton { needs_unsafe = true; - defs.push(quote!(pub #name: &'a mut #name)); - exprs - .push(quote!(#name: &mut <#name as owned_singleton::Singleton>::new())); + defs.push(quote!( + #(#cfgs)* + pub #name: &'a mut #name + )); + exprs.push(quote!( + #(#cfgs)* + #name: &mut <#name as owned_singleton::Singleton>::new() + )); continue; } else { force_mut = true; - defs.push(quote!(pub #name: &'a mut #ty)); + defs.push(quote!( + #(#cfgs)* + pub #name: &'a mut #ty + )); } } @@ -648,9 +676,15 @@ fn prelude( // Resources assigned to init are always const initialized needs_unsafe = true; if force_mut { - exprs.push(quote!(#name: &mut #alias)); + exprs.push(quote!( + #(#cfgs)* + #name: &mut #alias + )); } else { - exprs.push(quote!(#name: &#mut_ #alias)); + exprs.push(quote!( + #(#cfgs)* + #name: &#mut_ #alias + )); } } else { let ownership = &analysis.ownerships[name]; @@ -661,23 +695,43 @@ fn prelude( if singleton { if mut_.is_none() { needs_unsafe = true; - defs.push(quote!(pub #name: &'a #name)); - exprs - .push(quote!(#name: &<#name as owned_singleton::Singleton>::new())); + defs.push(quote!( + #(#cfgs)* + pub #name: &'a #name + )); + exprs.push(quote!( + #(#cfgs)* + #name: &<#name as owned_singleton::Singleton>::new() + )); continue; } else { // Generate a resource proxy - defs.push(quote!(pub #name: resources::#name<'a>)); - exprs.push(quote!(#name: resources::#name { #priority })); + defs.push(quote!( + #(#cfgs)* + pub #name: resources::#name<'a> + )); + exprs.push(quote!( + #(#cfgs)* + #name: resources::#name { #priority } + )); continue; } } else { if mut_.is_none() { - defs.push(quote!(pub #name: &'a #ty)); + defs.push(quote!( + #(#cfgs)* + pub #name: &'a #ty + )); } else { // Generate a resource proxy - defs.push(quote!(pub #name: resources::#name<'a>)); - exprs.push(quote!(#name: resources::#name { #priority })); + defs.push(quote!( + #(#cfgs)* + pub #name: resources::#name<'a> + )); + exprs.push(quote!( + #(#cfgs)* + #name: resources::#name { #priority } + )); continue; } } @@ -685,29 +739,47 @@ fn prelude( if singleton { if kind.runs_once() { needs_unsafe = true; - defs.push(quote!(pub #name: #name)); - exprs.push(quote!(#name: <#name as owned_singleton::Singleton>::new())); + defs.push(quote!( + #(#cfgs)* + pub #name: #name + )); + exprs.push(quote!( + #(#cfgs)* + #name: <#name as owned_singleton::Singleton>::new() + )); } else { needs_unsafe = true; if ownership.is_owned() || mut_.is_none() { - defs.push(quote!(pub #name: &'a #mut_ #name)); + defs.push(quote!( + #(#cfgs)* + pub #name: &'a #mut_ #name + )); let alias = mk_ident(None); items.push(quote!( + #(#cfgs)* let #mut_ #alias = unsafe { <#name as owned_singleton::Singleton>::new() }; )); - exprs.push(quote!(#name: &#mut_ #alias)); + exprs.push(quote!( + #(#cfgs)* + #name: &#mut_ #alias + )); } else { may_call_lock = true; - defs.push(quote!(pub #name: rtfm::Exclusive<'a, #name>)); + defs.push(quote!( + #(#cfgs)* + pub #name: rtfm::Exclusive<'a, #name> + )); let alias = mk_ident(None); items.push(quote!( + #(#cfgs)* let #mut_ #alias = unsafe { <#name as owned_singleton::Singleton>::new() }; )); exprs.push(quote!( + #(#cfgs)* #name: rtfm::Exclusive(&mut #alias) )); } @@ -715,11 +787,17 @@ fn prelude( continue; } else { if ownership.is_owned() || mut_.is_none() { - defs.push(quote!(pub #name: &#lt #mut_ #ty)); + defs.push(quote!( + #(#cfgs)* + pub #name: &#lt #mut_ #ty + )); } else { exclusive = true; may_call_lock = true; - defs.push(quote!(pub #name: rtfm::Exclusive<#lt, #ty>)); + defs.push(quote!( + #(#cfgs)* + pub #name: rtfm::Exclusive<#lt, #ty> + )); } } } @@ -728,9 +806,15 @@ fn prelude( needs_unsafe = true; if initialized { if exclusive { - exprs.push(quote!(#name: rtfm::Exclusive(&mut #alias))); + exprs.push(quote!( + #(#cfgs)* + #name: rtfm::Exclusive(&mut #alias) + )); } else { - exprs.push(quote!(#name: &#mut_ #alias)); + exprs.push(quote!( + #(#cfgs)* + #name: &#mut_ #alias + )); } } else { let method = if mut_.is_some() { @@ -740,9 +824,15 @@ fn prelude( }; if exclusive { - exprs.push(quote!(#name: rtfm::Exclusive(#alias.#method()) )); + exprs.push(quote!( + #(#cfgs)* + #name: rtfm::Exclusive(#alias.#method()) + )); } else { - exprs.push(quote!(#name: #alias.#method() )); + exprs.push(quote!( + #(#cfgs)* + #name: #alias.#method() + )); } } } @@ -755,6 +845,7 @@ fn prelude( None }; + let defs = &defs; let doc = format!("`{}::Resources`", kind.ident().to_string()); let decl = quote!( #[doc = #doc] @@ -893,7 +984,6 @@ fn exceptions(ctxt: &mut Context, app: &App, analysis: &Analysis) -> Vec<proc_ma .iter() .map(|(ident, exception)| { let attrs = &exception.attrs; - let statics = &exception.statics; let stmts = &exception.stmts; let prelude = prelude( @@ -934,15 +1024,18 @@ fn exceptions(ctxt: &mut Context, app: &App, analysis: &Analysis) -> Vec<proc_ma () => quote!(), }; + let locals = mk_locals(&exception.statics, false); + let symbol = ident.to_string(); + let alias = mk_ident(None); let unsafety = &exception.unsafety; quote!( #module - #[rtfm::export::exception] #[doc(hidden)] + #[export_name = #symbol] #(#attrs)* - #unsafety fn #ident() { - #(#statics)* + #unsafety fn #alias() { + #(#locals)* #baseline_let @@ -967,9 +1060,9 @@ fn interrupts( let mut root = vec![]; let mut scoped = vec![]; + let device = &app.args.device; for (ident, interrupt) in &app.interrupts { let attrs = &interrupt.attrs; - let statics = &interrupt.statics; let stmts = &interrupt.stmts; let prelude = prelude( @@ -1010,12 +1103,18 @@ fn interrupts( () => quote!(), }; + let locals = mk_locals(&interrupt.statics, false); + let alias = mk_ident(None); + let symbol = ident.to_string(); let unsafety = &interrupt.unsafety; scoped.push(quote!( - #[interrupt] #(#attrs)* - #unsafety fn #ident() { - #(#statics)* + #[export_name = #symbol] + #unsafety fn #alias() { + // check that this interrupt exists + let _ = #device::interrupt::#ident; + + #(#locals)* #baseline_let @@ -1053,6 +1152,7 @@ fn tasks(ctxt: &mut Context, app: &App, analysis: &Analysis) -> proc_macro2::Tok let resource = mk_resource( ctxt, + &[], &free_alias, quote!(rtfm::export::FreeQueue<#capacity_ty>), *analysis.free_queues.get(name).unwrap_or(&0), @@ -1112,7 +1212,6 @@ fn tasks(ctxt: &mut Context, app: &App, analysis: &Analysis) -> proc_macro2::Tok // second pass to generate the actual task function for (name, task) in &app.tasks { - let attrs = &task.attrs; let inputs = &task.inputs; let locals = mk_locals(&task.statics, false); let stmts = &task.stmts; @@ -1147,6 +1246,8 @@ fn tasks(ctxt: &mut Context, app: &App, analysis: &Analysis) -> proc_macro2::Tok app, )); + let attrs = &task.attrs; + let cfgs = &task.cfgs; let task_alias = &ctxt.tasks[name].alias; let baseline_arg = match () { #[cfg(feature = "timer-queue")] @@ -1159,6 +1260,7 @@ fn tasks(ctxt: &mut Context, app: &App, analysis: &Analysis) -> proc_macro2::Tok }; items.push(quote!( #(#attrs)* + #(#cfgs)* #unsafety fn #task_alias(#baseline_arg #(#inputs,)*) { #(#locals)* @@ -1182,18 +1284,32 @@ fn dispatchers( let mut data = vec![]; let mut dispatchers = vec![]; + let device = &app.args.device; for (level, dispatcher) in &analysis.dispatchers { let ready_alias = mk_ident(None); let enum_alias = mk_ident(None); - let tasks = &dispatcher.tasks; let capacity = mk_typenum_capacity(dispatcher.capacity, true); + let variants = dispatcher + .tasks + .iter() + .map(|task| { + let task_ = &app.tasks[task]; + let cfgs = &task_.cfgs; + + quote!( + #(#cfgs)* + #task + ) + }) + .collect::<Vec<_>>(); let symbol = format!("P{}::READY_QUEUE::{}", level, ready_alias); let e = quote!(rtfm::export); let ty = quote!(#e::ReadyQueue<#enum_alias, #capacity>); let ceiling = *analysis.ready_queues.get(&level).unwrap_or(&0); let resource = mk_resource( ctxt, + &[], &ready_alias, ty.clone(), ceiling, @@ -1204,7 +1320,7 @@ fn dispatchers( data.push(quote!( #[allow(dead_code)] #[allow(non_camel_case_types)] - enum #enum_alias { #(#tasks,)* } + enum #enum_alias { #(#variants,)* } #[doc = #symbol] static mut #ready_alias: #e::MaybeUninit<#ty> = #e::MaybeUninit::uninitialized(); @@ -1212,8 +1328,6 @@ fn dispatchers( #resource )); - let interrupt = &dispatcher.interrupt; - let arms = dispatcher .tasks .iter() @@ -1221,9 +1335,12 @@ fn dispatchers( let task_ = &ctxt.tasks[task]; let inputs = &task_.inputs; let free = &task_.free_queue; - let pats = tuple_pat(&app.tasks[task].inputs); let alias = &task_.alias; + let task__ = &app.tasks[task]; + let pats = tuple_pat(&task__.inputs); + let cfgs = &task__.cfgs; + let baseline_let; let call; match () { @@ -1243,23 +1360,32 @@ fn dispatchers( } }; - quote!(#enum_alias::#task => { - #baseline_let - let input = ptr::read(#inputs.get_ref().get_unchecked(usize::from(index))); - #free.get_mut().split().0.enqueue_unchecked(index); - let (#pats) = input; - #call - }) + quote!( + #(#cfgs)* + #enum_alias::#task => { + #baseline_let + let input = ptr::read(#inputs.get_ref().get_unchecked(usize::from(index))); + #free.get_mut().split().0.enqueue_unchecked(index); + let (#pats) = input; + #call + } + ) }) .collect::<Vec<_>>(); let attrs = &dispatcher.attrs; + let interrupt = &dispatcher.interrupt; + let symbol = interrupt.to_string(); + let alias = mk_ident(None); dispatchers.push(quote!( #(#attrs)* - #[interrupt] - unsafe fn #interrupt() { + #[export_name = #symbol] + unsafe fn #alias() { use core::ptr; + // check that this interrupt exists + let _ = #device::interrupt::#interrupt; + rtfm::export::run(|| { while let Some((task, index)) = #ready_alias.get_mut().split().1.dequeue() { match task { @@ -1293,6 +1419,7 @@ fn spawn(ctxt: &Context, app: &App, analysis: &Analysis) -> proc_macro2::TokenSt for (name, task) in &ctxt.tasks { let alias = &task.spawn_fn; let task_ = &app.tasks[name]; + let cfgs = &task_.cfgs; let free = &task.free_queue; let level = task_.args.priority; let dispatcher = &ctxt.dispatchers[&level]; @@ -1328,6 +1455,7 @@ fn spawn(ctxt: &Context, app: &App, analysis: &Analysis) -> proc_macro2::TokenSt items.push(quote!( #[inline(always)] + #(#cfgs)* unsafe fn #alias( #baseline_arg #priority: &core::cell::Cell<u8>, @@ -1366,8 +1494,10 @@ fn spawn(ctxt: &Context, app: &App, analysis: &Analysis) -> proc_macro2::TokenSt let mut methods = vec![]; for task in spawn { + let task_ = &app.tasks[task]; let alias = &ctxt.tasks[task].spawn_fn; - let inputs = &app.tasks[task].inputs; + let inputs = &task_.inputs; + let cfgs = &task_.cfgs; let ty = tuple_ty(inputs); let pats = tuple_pat(inputs); @@ -1386,6 +1516,7 @@ fn spawn(ctxt: &Context, app: &App, analysis: &Analysis) -> proc_macro2::TokenSt methods.push(quote!( #[allow(unsafe_code)] #[inline] + #(#cfgs)* pub fn #task(&self, #(#inputs,)*) -> Result<(), #ty> { unsafe { #alias(#instant &self.#priority, #pats) } } @@ -1415,12 +1546,15 @@ fn schedule(ctxt: &Context, app: &App) -> proc_macro2::TokenStream { let enum_ = &ctxt.schedule_enum; let inputs = &task_.inputs; let scheduleds = &task_.scheduleds; - let args = &app.tasks[task].inputs; + let task__ = &app.tasks[task]; + let args = &task__.inputs; + let cfgs = &task__.cfgs; let ty = tuple_ty(args); let pats = tuple_pat(args); items.push(quote!( #[inline(always)] + #(#cfgs)* unsafe fn #alias( #priority: &core::cell::Cell<u8>, instant: rtfm::Instant, @@ -1464,12 +1598,15 @@ fn schedule(ctxt: &Context, app: &App) -> proc_macro2::TokenStream { let mut methods = vec![]; for task in schedule { let alias = &ctxt.schedule_fn[task]; - let inputs = &app.tasks[task].inputs; + let task_ = &app.tasks[task]; + let inputs = &task_.inputs; + let cfgs = &task_.cfgs; let ty = tuple_ty(inputs); let pats = tuple_pat(inputs); methods.push(quote!( #[inline] + #(#cfgs)* pub fn #task( &self, instant: rtfm::Instant, @@ -1499,12 +1636,22 @@ fn timer_queue(ctxt: &Context, app: &App, analysis: &Analysis) -> proc_macro2::T let mut items = vec![]; + let variants = tasks + .iter() + .map(|task| { + let cfgs = &app.tasks[task].cfgs; + quote!( + #(#cfgs)* + #task + ) + }) + .collect::<Vec<_>>(); let enum_ = &ctxt.schedule_enum; items.push(quote!( #[allow(dead_code)] #[allow(non_camel_case_types)] #[derive(Clone, Copy)] - enum #enum_ { #(#tasks,)* } + enum #enum_ { #(#variants,)* } )); let cap = mk_typenum_capacity(analysis.timer_queue.capacity, false); @@ -1519,6 +1666,7 @@ fn timer_queue(ctxt: &Context, app: &App, analysis: &Analysis) -> proc_macro2::T items.push(mk_resource( ctxt, + &[], tq, quote!(rtfm::export::TimerQueue<#enum_, #cap>), analysis.timer_queue.ceiling, @@ -1532,13 +1680,16 @@ fn timer_queue(ctxt: &Context, app: &App, analysis: &Analysis) -> proc_macro2::T let arms = tasks .iter() .map(|task| { - let level = app.tasks[task].args.priority; + let task_ = &app.tasks[task]; + let level = task_.args.priority; + let cfgs = &task_.cfgs; let dispatcher_ = &ctxt.dispatchers[&level]; let tenum = &dispatcher_.enum_; let ready = &dispatcher_.ready_queue; let dispatcher = &analysis.dispatchers[&level].interrupt; quote!( + #(#cfgs)* #enum_::#task => { (#ready { #priority }).lock(|rq| { rq.split().0.enqueue_unchecked((#tenum::#task, index)) @@ -1551,10 +1702,11 @@ fn timer_queue(ctxt: &Context, app: &App, analysis: &Analysis) -> proc_macro2::T .collect::<Vec<_>>(); let logical_prio = analysis.timer_queue.priority; + let alias = mk_ident(None); items.push(quote!( - #[rtfm::export::exception] + #[export_name = "SysTick"] #[doc(hidden)] - unsafe fn SysTick() { + unsafe fn #alias() { use rtfm::Mutex; let ref #priority = core::cell::Cell::new(#logical_prio); @@ -1680,6 +1832,7 @@ fn assertions(app: &App, analysis: &Analysis) -> proc_macro2::TokenStream { fn mk_resource( ctxt: &Context, + cfgs: &[Attribute], struct_: &Ident, ty: proc_macro2::TokenStream, ceiling: u8, @@ -1696,6 +1849,7 @@ fn mk_resource( let doc = format!("`{}`", ty); module.push(quote!( #[doc = #doc] + #(#cfgs)* pub struct #struct_<'a> { #[doc(hidden)] pub #priority: &'a core::cell::Cell<u8>, @@ -1705,6 +1859,7 @@ fn mk_resource( quote!(resources::#struct_) } else { items.push(quote!( + #(#cfgs)* struct #struct_<'a> { #priority: &'a core::cell::Cell<u8>, } @@ -1714,6 +1869,7 @@ fn mk_resource( }; items.push(quote!( + #(#cfgs)* impl<'a> rtfm::Mutex for #path<'a> { type T = #ty; @@ -1852,7 +2008,7 @@ fn tuple_ty(inputs: &[ArgCaptured]) -> proc_macro2::TokenStream { } } -#[derive(Clone, Eq, Hash, PartialEq)] +#[derive(Clone, Debug, Eq, Hash, PartialEq)] enum Kind { Exception(Ident), Idle, |