aboutsummaryrefslogtreecommitdiff
path: root/macros/src/check.rs
blob: c22a0f1fa18fe9983928a49d00fdde7eb35eba1f (plain) (blame)
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
use std::collections::HashSet;

use proc_macro2::Span;
use rtfm_syntax::{
    analyze::Analysis,
    ast::{App, CustomArg, HardwareTaskKind},
};
use syn::{parse, Path};

pub struct Extra<'a> {
    pub device: &'a Path,
    pub monotonic: Option<&'a Path>,
    pub peripherals: Option<u8>,
}

impl<'a> Extra<'a> {
    pub fn monotonic(&self) -> &'a Path {
        self.monotonic.expect("UNREACHABLE")
    }
}

pub fn app<'a>(app: &'a App, analysis: &Analysis) -> parse::Result<Extra<'a>> {
    // check that all exceptions are valid; only exceptions with configurable priorities are
    // accepted
    for (name, task) in app
        .hardware_tasks
        .iter()
        .filter(|(_, task)| task.kind == HardwareTaskKind::Exception)
    {
        let name_s = task.args.binds(name).to_string();
        match &*name_s {
            // NOTE that some of these don't exist on ARMv6-M but we don't check that here -- the
            // code we generate will check that the exception actually exists on ARMv6-M
            "MemoryManagement" | "BusFault" | "UsageFault" | "SecureFault" | "SVCall"
            | "DebugMonitor" | "PendSV" => {} // OK

            "SysTick" => {
                if analysis.timer_queues.get(&task.args.core).is_some() {
                    return Err(parse::Error::new(
                        name.span(),
                        "this exception can't be used because it's being used by the runtime",
                    ));
                } else {
                    // OK
                }
            }

            _ => {
                return Err(parse::Error::new(
                    name.span(),
                    "only exceptions with configurable priority can be used as hardware tasks",
                ));
            }
        }
    }

    // check that external (device-specific) interrupts are not named after known (Cortex-M)
    // exceptions
    for name in app
        .extern_interrupts
        .iter()
        .flat_map(|(_, interrupts)| interrupts.keys())
    {
        let name_s = name.to_string();

        match &*name_s {
            "NonMaskableInt" | "HardFault" | "MemoryManagement" | "BusFault" | "UsageFault"
            | "SecureFault" | "SVCall" | "DebugMonitor" | "PendSV" | "SysTick" => {
                return Err(parse::Error::new(
                    name.span(),
                    "Cortex-M exceptions can't be used as `extern` interrupts",
                ));
            }

            _ => {}
        }
    }

    // check that there are enough external interrupts to dispatch the software tasks and the timer
    // queue handler
    for core in 0..app.args.cores {
        let mut first = None;
        let priorities = app
            .software_tasks
            .iter()
            .filter_map(|(name, task)| {
                if task.args.core == core {
                    first = Some(name);
                    Some(task.args.priority)
                } else {
                    None
                }
            })
            .chain(analysis.timer_queues.get(&core).map(|tq| tq.priority))
            .collect::<HashSet<_>>();

        let need = priorities.len();
        let given = app
            .extern_interrupts
            .get(&core)
            .map(|ei| ei.len())
            .unwrap_or(0);
        if need > given {
            let s = if app.args.cores == 1 {
                format!(
                    "not enough `extern` interrupts to dispatch \
                     all software tasks (need: {}; given: {})",
                    need, given
                )
            } else {
                format!(
                    "not enough `extern` interrupts to dispatch \
                     all software tasks on this core (need: {}; given: {})",
                    need, given
                )
            };

            return Err(parse::Error::new(first.unwrap().span(), &s));
        }
    }

    let mut device = None;
    let mut monotonic = None;
    let mut peripherals = None;

    for (k, v) in &app.args.custom {
        let ks = k.to_string();

        match &*ks {
            "device" => match v {
                CustomArg::Path(p) => device = Some(p),

                _ => {
                    return Err(parse::Error::new(
                        k.span(),
                        "unexpected argument value; this should be a path",
                    ));
                }
            },

            "monotonic" => match v {
                CustomArg::Path(p) => monotonic = Some(p),

                _ => {
                    return Err(parse::Error::new(
                        k.span(),
                        "unexpected argument value; this should be a path",
                    ));
                }
            },

            "peripherals" => match v {
                CustomArg::Bool(x) if app.args.cores == 1 => {
                    peripherals = if *x { Some(0) } else { None }
                }

                CustomArg::UInt(x) if app.args.cores != 1 => {
                    peripherals = if *x < u64::from(app.args.cores) {
                        Some(*x as u8)
                    } else {
                        return Err(parse::Error::new(
                            k.span(),
                            &format!(
                                "unexpected argument value; \
                                 this should be an integer in the range 0..={}",
                                app.args.cores
                            ),
                        ));
                    }
                }

                _ => {
                    return Err(parse::Error::new(
                        k.span(),
                        if app.args.cores == 1 {
                            "unexpected argument value; this should be a boolean"
                        } else {
                            "unexpected argument value; this should be an integer"
                        },
                    ));
                }
            },

            _ => {
                return Err(parse::Error::new(k.span(), "unexpected argument"));
            }
        }
    }

    if !analysis.timer_queues.is_empty() && monotonic.is_none() {
        return Err(parse::Error::new(
            Span::call_site(),
            "a `monotonic` timer must be specified to use the `schedule` API",
        ));
    }

    if let Some(device) = device {
        Ok(Extra {
            device,
            monotonic,
            peripherals,
        })
    } else {
        Err(parse::Error::new(
            Span::call_site(),
            "a `device` argument must be specified in `#[rtfm::app]`",
        ))
    }
}