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
use std::{borrow::Cow, collections::HashSet};
use device_driver_common::span::SpanExt;
use crate::{
model::{EnumGenerationStyle, Manifest, Object, ObjectId},
passes::{Assumption, Pass},
};
use device_driver_diagnostics::{
Diagnostics, DynError,
errors::{
ConversionTypeTooBig, DifferentBaseTypes, InvalidConversionType,
InvalidInfallibleConversion, ReferencedObjectDoesNotExist,
},
};
/// Checks if fields that have conversion and specified no try to be used, are valid in doing so
pub struct FieldConversionValid;
impl Pass for FieldConversionValid {
const ASSUMPTIONS_MADE: &[Assumption] = &[
Assumption::FieldBaseTypesSpecified,
Assumption::NamesUnique,
Assumption::LocalNamespacesAssigned,
];
const ASSUMPTIONS_RELEASED: &[Assumption] = &[];
fn run_pass(
manifest: &mut Manifest,
diagnostics: &mut Diagnostics,
) -> Result<HashSet<ObjectId>, DynError> {
let mut removals = HashSet::new();
for (field_id, field) in manifest.fields.iter_enumerated() {
if let Some(conversion) = field.field_conversion.as_ref() {
let target_object = manifest.search_type(&conversion.type_ref);
match target_object {
Some(Object::Enum(target_enum)) => {
let target_enum_size = target_enum.size_bits
.ok_or_else(|| DynError::new(
format!(
"target enum `{}` size_bits is none. Should've been set in an earlier pass",
target_enum.name.original()
)
))?;
if u64::from(target_enum_size) > field.field_address.len() {
diagnostics.add(ConversionTypeTooBig {
field: field.name.span,
field_address: field.field_address.span,
conversion_type: target_enum.name.span,
conversion: conversion.type_ref.span,
field_len: field.field_address.len(),
conversion_len: target_enum_size.into(),
});
removals.insert(field_id.into());
continue;
}
if field.base_type != target_enum.base_type {
diagnostics.add(DifferentBaseTypes {
field: field.name.span,
field_base_type: field.base_type.value,
conversion: conversion.type_ref.span,
conversion_object: target_enum.name.span,
conversion_base_type: target_enum.base_type.value,
});
removals.insert(field_id.into());
continue;
}
if !conversion.fallible {
// Check if we know the value we're converting to and if we can support non-try conversion
match target_enum
.generation_style
.as_ref()
.expect("Generation style has been set here in an earlier pass")
{
EnumGenerationStyle::Fallible => {
diagnostics.add(InvalidInfallibleConversion {
field: field.name.span,
conversion: conversion.type_ref.span,
context: vec![
Cow::from("target only supports fallible conversion")
.with_span(target_enum.name.span),
],
existing_type_specifier_content: field
.get_type_specifier_string(manifest),
});
removals.insert(field_id.into());
continue;
}
EnumGenerationStyle::InfallibleWithinRange => {
let field_bits = field.field_address.len() as u32;
let enum_bits = target_enum
.size_bits
.expect("Enum size_bits is already set in a previous pass");
if field_bits > enum_bits {
diagnostics.add(InvalidInfallibleConversion {
field: field.name.span,
conversion: conversion.type_ref.span,
context: vec![
Cow::from(format!(
"The field has a size of {field_bits} bits"
)).with_span(
field.field_address.span,
),
Cow::from(format!(
"Target enum only has a size of {enum_bits} bits. This means not all possible field values can be converted to an enum"
)).with_span(
target_enum.name.span,
),
],
existing_type_specifier_content: field.get_type_specifier_string(manifest)
});
removals.insert(field_id.into());
continue;
}
}
EnumGenerationStyle::Fallback => {
// This always works
}
}
}
}
Some(Object::Extern(target_extern)) => {
let target_extern_base_type = target_extern.base_type.value.as_fixed_size()
.ok_or_else(|| DynError::new(
format!(
"target extern `{}` does not have a fixed size. Should've been checked in an earlier pass",
target_extern.name.original()
)
))?;
let target_extern_size = target_extern
.size_bits
.map(|v| v.value)
.unwrap_or(u64::from(target_extern_base_type.size_bits()));
if target_extern_size > field.field_address.len() {
diagnostics.add(ConversionTypeTooBig {
field: field.name.span,
field_address: field.field_address.span,
conversion_type: target_extern.name.span,
conversion: conversion.type_ref.span,
field_len: field.field_address.len(),
conversion_len: target_extern_size,
});
removals.insert(field_id.into());
continue;
}
if field.base_type != target_extern.base_type {
diagnostics.add(DifferentBaseTypes {
field: field.name.span,
field_base_type: field.base_type.value,
conversion: conversion.type_ref.span,
conversion_object: target_extern.name.span,
conversion_base_type: target_extern.base_type.value,
});
removals.insert(field_id.into());
continue;
}
if !conversion.fallible && !target_extern.supports_infallible {
diagnostics.add(InvalidInfallibleConversion {
field: field.name.span,
conversion: conversion.type_ref.span,
context: vec![
Cow::from("target only supports fallible conversion")
.with_span(target_extern.name.span),
],
existing_type_specifier_content: field
.get_type_specifier_string(manifest),
});
removals.insert(field_id.into());
continue;
}
}
Some(invalid_object) => {
diagnostics.add(InvalidConversionType {
object_reference: conversion.type_ref.span,
referenced_object: invalid_object.name_span(),
});
removals.insert(field_id.into());
continue;
}
None => {
diagnostics.add(ReferencedObjectDoesNotExist {
object_reference: conversion.type_ref.span,
});
removals.insert(field_id.into());
continue;
}
}
}
}
Ok(removals)
}
}