fastxdr 1.0.2

Generate Rust types from XDR specs with fast, zero-copy deserialisation
Documentation
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
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
use super::*;

#[derive(Debug, Clone, PartialEq)]
pub struct UnionSwitch {
    pub var_name: String,
    pub var_type: BasicType,
}

#[derive(Debug, Clone, PartialEq)]
pub struct Union {
    pub name: String,
    pub cases: Vec<UnionCase>,
    pub default: Option<UnionCase>,
    pub void_cases: Vec<String>,
    pub switch: UnionSwitch,
}

impl Union {
    pub(crate) fn new(vs: Vec<Node<'_>>) -> Self {
        let name = vs[0].ident_str().to_string();

        let mut cases = Vec::new();
        let mut void_cases = Vec::new();
        let mut default = None;

        let switch = UnionSwitch {
            var_name: vs[2].ident_str().to_string(),
            var_type: BasicType::from(vs[1].ident_str().to_string()),
        };

        // Collect the set of case values that "fallthrough" to the eventual
        // UnionCase
        let mut case_values = Vec::new();

        for v in vs.into_iter().skip(3) {
            let mut is_default_case = false;
            let stmt = match v {
                Node::UnionCase(nodes) => CaseStmt::parse(case_values, nodes),
                Node::UnionDefault(nodes) => {
                    is_default_case = true;
                    case_values.push("default".to_string());
                    CaseStmt::parse(case_values, nodes)
                }
                v => panic!("unexpected token type for union {:?}", v),
            };

            match stmt {
                CaseStmt::Defined(c) if is_default_case => default = Some(c),
                CaseStmt::Defined(c) => cases.push(c),
                CaseStmt::Fallthrough(values) => {
                    // The parsed fallthrough ident has been pushed to the
                    // returned case_values
                    case_values = values;
                    continue;
                }
                CaseStmt::Void(values) => void_cases.extend_from_slice(&values),
            }

            case_values = Vec::new()
        }

        Union {
            name,
            cases,
            default,
            void_cases,
            switch,
        }
    }

    pub fn name(&self) -> &str {
        &self.name
    }
}

impl CompoundType for Union {
    fn inner_types(&self) -> Vec<&ArrayType<BasicType>> {
        self.cases
            .iter()
            .chain(self.default.iter())
            .map(|f| &f.field_value)
            .collect()
    }

    fn contains_opaque(&self) -> bool {
        self.cases
            .iter()
            .chain(self.default.iter())
            .any(|f| f.contains_opaque())
    }
}

#[derive(Debug, Clone, PartialEq)]
pub struct UnionCase {
    /// The case values that map to this field name and type.
    ///
    /// This can be more than one value when the union contains fallthrough
    /// statements.
    pub case_values: Vec<String>,
    pub field_name: String,
    pub field_value: ArrayType<BasicType>,
}

impl UnionCase {
    pub(crate) fn new(case_values: Vec<String>, field: Vec<Node<'_>>) -> Self {
        match field.as_slice() {
            [Node::Type(t), Node::Type(BasicType::Ident(l))] => Self {
                case_values,
                field_name: l.to_string(),
                field_value: ArrayType::None(t.to_owned()),
            },
            _ => panic!("invalid number of union field tokens"),
        }
    }

    pub fn contains_opaque(&self) -> bool {
        match self.field_value.unwrap_array() {
            BasicType::Opaque => true,
            _ => false,
        }
    }
}

enum CaseStmt {
    /// A case statement with no fields defined, falling through to the next
    /// case statement.
    Fallthrough(Vec<String>),

    /// A fully-defined case statement, with a case value and fields.
    Defined(UnionCase),

    Void(Vec<String>),
}

impl CaseStmt {
    fn parse(mut case_values: Vec<String>, mut nodes: Vec<Node<'_>>) -> Self {
        match nodes.remove(0) {
            Node::Type(t) => case_values.push(t.as_str().to_string()),
            Node::UnionVoid => {
                // No ident, this is a default case
                return Self::Void(case_values);
            }
            Node::UnionDataField(nodes) => {
                // No ident, this is a default case
                return Self::Defined(UnionCase::new(case_values, nodes));
            }
            _ => unreachable!(),
        };

        if nodes.is_empty() {
            return Self::Fallthrough(case_values);
        }

        match nodes.remove(0) {
            Node::UnionDataField(nodes) => Self::Defined(UnionCase::new(case_values, nodes)),
            Node::UnionVoid => Self::Void(case_values),
            _ => unreachable!(),
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    macro_rules! parse {
        ($input: expr) => {{
            let ast = XDRParser::parse(Rule::item, $input)
                .unwrap()
                .next()
                .unwrap();

            let root = walk(ast);
            let union = root.into_inner().remove(0);
            match union {
                Node::Union(u) => u,
                _ => panic!("not a union in ast root"),
            }
        }};
    }

    #[test]
    fn test_union() {
        let got = parse!(
            r#"
		union createhow4 switch (createmode4 mode) {
			case GUARDED4:
					fattr4         createattrs;
			case EXCLUSIVE4:
					verifier4      createverf;
		};"#
        );

        assert_eq!(got.name, "createhow4");
        assert_eq!(got.default, None);
        assert_eq!(got.void_cases.len(), 0);
        assert_eq!(got.cases.len(), 2);

        assert_eq!(&got.cases[0].case_values, &["GUARDED4"]);
        assert_eq!(got.cases[0].field_name, "createattrs");
        assert_eq!(
            got.cases[0].field_value,
            ArrayType::None(BasicType::Ident("fattr4".to_string()))
        );

        assert_eq!(&got.cases[1].case_values, &["EXCLUSIVE4"]);
        assert_eq!(got.cases[1].field_name, "createverf");
        assert_eq!(
            got.cases[1].field_value,
            ArrayType::None(BasicType::Ident("verifier4".to_string()))
        );

        assert_eq!(got.switch.var_name, "mode");
        assert_eq!(
            got.switch.var_type,
            BasicType::Ident("createmode4".to_string())
        );
    }

    #[test]
    fn test_union_fallthrough() {
        let got = parse!(
            r#"
		union createhow4 switch (createmode4 mode) {
			case UNCHECKED4:
			case GUARDED4:
					fattr4         createattrs;
			case EXCLUSIVE4:
					verifier4      createverf;
		};"#
        );

        assert_eq!(got.name, "createhow4");
        assert_eq!(got.default, None);
        assert_eq!(got.void_cases.len(), 0);
        assert_eq!(got.cases.len(), 2);

        assert_eq!(&got.cases[0].case_values, &["UNCHECKED4", "GUARDED4"]);
        assert_eq!(got.cases[0].field_name, "createattrs");
        assert_eq!(
            got.cases[0].field_value,
            ArrayType::None(BasicType::Ident("fattr4".to_string()))
        );

        assert_eq!(&got.cases[1].case_values, &["EXCLUSIVE4"]);
        assert_eq!(got.cases[1].field_name, "createverf");
        assert_eq!(
            got.cases[1].field_value,
            ArrayType::None(BasicType::Ident("verifier4".to_string()))
        );

        assert_eq!(got.switch.var_name, "mode");
        assert_eq!(
            got.switch.var_type,
            BasicType::Ident("createmode4".to_string())
        );
    }

    #[test]
    fn test_union_void_default() {
        let got = parse!(
            r#"
		union LOCKU4res switch (nfsstat4 status) {
			case NFS4_OK:
					stateid4       lock_stateid;
			default:
					void;
		};"#
        );

        assert_eq!(got.name, "LOCKU4res");
        assert_eq!(got.default, None);

        assert_eq!(got.cases.len(), 1);
        assert_eq!(&got.cases[0].case_values, &["NFS4_OK"]);
        assert_eq!(got.cases[0].field_name, "lock_stateid");
        assert_eq!(
            got.cases[0].field_value,
            ArrayType::None(BasicType::Ident("stateid4".to_string()))
        );

        assert_eq!(got.void_cases.len(), 1);
        assert_eq!(&got.void_cases, &["default"]);

        assert_eq!(got.switch.var_name, "status");
        assert_eq!(
            got.switch.var_type,
            BasicType::Ident("nfsstat4".to_string())
        );
    }

    #[test]
    fn test_union_default() {
        let got = parse!(
            r#"
		union LOCKU4res switch (nfsstat4 status) {
			case NFS4_OK:
					stateid4       lock_stateid;
			default:
					type_name field_name;
		};"#
        );

        assert_eq!(got.name, "LOCKU4res");
        assert_eq!(got.cases.len(), 1);
        assert_eq!(&got.cases[0].case_values, &["NFS4_OK"]);
        assert_eq!(got.cases[0].field_name, "lock_stateid");
        assert_eq!(
            got.cases[0].field_value,
            ArrayType::None(BasicType::Ident("stateid4".to_string()))
        );

        assert_eq!(got.void_cases.len(), 0);

        let default = &got.default.unwrap();
        assert_eq!(default.case_values, &["default"]);
        assert_eq!(default.field_name, "field_name");
        assert_eq!(
            default.field_value,
            ArrayType::None(BasicType::Ident("type_name".to_string()))
        );

        assert_eq!(got.switch.var_name, "status");
        assert_eq!(
            got.switch.var_type,
            BasicType::Ident("nfsstat4".to_string())
        );
    }

    #[test]
    fn test_union_case_void() {
        let got = parse!(
            r#"
		union LOCKU4res switch (nfsstat4 status) {
			case NFS4_OK:
					stateid4       lock_stateid;
			case something:
				void;
			default:
					type_name field_name;
		};"#
        );

        assert_eq!(got.name, "LOCKU4res");
        assert_eq!(got.cases.len(), 1);
        assert_eq!(&got.cases[0].case_values, &["NFS4_OK"]);
        assert_eq!(got.cases[0].field_name, "lock_stateid");
        assert_eq!(
            got.cases[0].field_value,
            ArrayType::None(BasicType::Ident("stateid4".to_string()))
        );

        assert_eq!(got.void_cases, &["something"]);

        let default = &got.default.unwrap();
        assert_eq!(default.case_values, &["default"]);
        assert_eq!(default.field_name, "field_name");
        assert_eq!(
            default.field_value,
            ArrayType::None(BasicType::Ident("type_name".to_string()))
        );

        assert_eq!(got.switch.var_name, "status");
        assert_eq!(
            got.switch.var_type,
            BasicType::Ident("nfsstat4".to_string())
        );
    }

    #[test]
    fn test_union_case_void_fallthrough() {
        let got = parse!(
            r#"
		union LOCKU4res switch (nfsstat4 status) {
			case NFS4_OK:
					stateid4       lock_stateid;
			case another:
			case something:
				void;
			default:
					type_name field_name;
		};"#
        );

        assert_eq!(got.name, "LOCKU4res");
        assert_eq!(got.cases.len(), 1);
        assert_eq!(&got.cases[0].case_values, &["NFS4_OK"]);
        assert_eq!(got.cases[0].field_name, "lock_stateid");
        assert_eq!(
            got.cases[0].field_value,
            ArrayType::None(BasicType::Ident("stateid4".to_string()))
        );

        assert_eq!(got.void_cases, &["another", "something",]);

        let default = &got.default.unwrap();
        assert_eq!(default.case_values, &["default"]);
        assert_eq!(default.field_name, "field_name");
        assert_eq!(
            default.field_value,
            ArrayType::None(BasicType::Ident("type_name".to_string()))
        );

        assert_eq!(got.switch.var_name, "status");
        assert_eq!(
            got.switch.var_type,
            BasicType::Ident("nfsstat4".to_string())
        );
    }
}