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
use std::{error, fmt};
use crate::ReadError;
#[derive(Debug)]
pub enum Location {
Arg(usize),
ReturnType(usize),
}
impl fmt::Display for Location {
fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
match self {
Self::Arg(idx) => write!(formatter, "arg #{idx}"),
Self::ReturnType(idx) => write!(formatter, "return type #{idx}"),
}
}
}
#[derive(Debug)]
#[non_exhaustive]
pub enum Error {
Read(ReadError),
Wasm(anyhow::Error),
UnexpectedImportType {
module: String,
name: String,
},
NoExport(String),
UnexpectedExportType(String),
UnexpectedArity {
module: Option<String>,
name: String,
expected_arity: usize,
real_arity: usize,
},
UnexpectedType {
module: Option<String>,
name: String,
location: Location,
real_type: walrus::ValType,
},
IncorrectGuard {
function_name: Option<String>,
code_offset: Option<u32>,
},
UnexpectedCall {
function_name: Option<String>,
code_offset: Option<u32>,
},
}
impl fmt::Display for Error {
fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
const EXTERNAL_TOOL_TIP: &str = "This can be caused by an external WASM manipulation tool \
such as `wasm-opt`. Please run such tools *after* the externref processor.";
match self {
Self::Read(err) => write!(formatter, "failed reading WASM custom section: {err}"),
Self::Wasm(err) => write!(formatter, "failed reading WASM module: {err}"),
Self::UnexpectedImportType { module, name } => {
write!(
formatter,
"unexpected type of import `{module}::{name}`; expected a function"
)
}
Self::NoExport(name) => {
write!(formatter, "missing exported function `{name}`")
}
Self::UnexpectedExportType(name) => {
write!(
formatter,
"unexpected type of export `{name}`; expected a function"
)
}
Self::UnexpectedArity {
module,
name,
expected_arity,
real_arity,
} => {
let module_descr = module
.as_ref()
.map_or_else(String::new, |module| format!(" imported from `{module}`"));
write!(
formatter,
"unexpected arity for function `{name}`{module_descr}: \
expected {expected_arity}, got {real_arity}"
)
}
Self::UnexpectedType {
module,
name,
location,
real_type,
} => {
let module_descr = module
.as_ref()
.map_or_else(String::new, |module| format!(" imported from `{module}`"));
write!(
formatter,
"{location} of function `{name}`{module_descr} has unexpected type; \
expected `i32`, got {real_type}"
)
}
Self::IncorrectGuard {
function_name,
code_offset,
} => {
let function_name = function_name
.as_ref()
.map_or("(unnamed function)", String::as_str);
let code_offset = code_offset
.as_ref()
.map_or_else(String::new, |offset| format!(" at {offset}"));
write!(
formatter,
"incorrectly placed externref guard in {function_name}{code_offset}. \
{EXTERNAL_TOOL_TIP}"
)
}
Self::UnexpectedCall {
function_name,
code_offset,
} => {
let function_name = function_name
.as_ref()
.map_or("(unnamed function)", String::as_str);
let code_offset = code_offset
.as_ref()
.map_or_else(String::new, |offset| format!(" at {offset}"));
write!(
formatter,
"unexpected call to an `externref`-returning function \
in {function_name}{code_offset}. {EXTERNAL_TOOL_TIP}"
)
}
}
}
}
impl From<ReadError> for Error {
fn from(err: ReadError) -> Self {
Self::Read(err)
}
}
impl error::Error for Error {
fn source(&self) -> Option<&(dyn error::Error + 'static)> {
match self {
Self::Read(err) => Some(err),
Self::Wasm(err) => Some(err.as_ref()),
_ => None,
}
}
}