fidl_handle_tests/
channel.rs

1// Copyright 2020 The Fuchsia Authors. All rights reserved.
2// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file.
4
5use crate::LoggingFixture;
6use async_trait::async_trait;
7use fidl::HandleBased;
8
9fn reverse<T>(value: (T, T)) -> (T, T) {
10    (value.1, value.0)
11}
12
13fn maybe_reverse<T>(really_do_it: bool, value: (T, T)) -> (T, T) {
14    if really_do_it { (value.1, value.0) } else { (value.0, value.1) }
15}
16
17pub enum CreateHandlePurpose {
18    PrimaryTestChannel,
19    PayloadChannel,
20}
21
22#[async_trait]
23pub trait Fixture: LoggingFixture {
24    async fn create_handles(&self, purpose: CreateHandlePurpose) -> (fidl::Channel, fidl::Channel);
25}
26
27#[derive(Clone, Copy)]
28enum AfterSend {
29    RemainOpen,
30    CloseSender,
31}
32
33async fn send_message(
34    fixture: &mut impl LoggingFixture,
35    channels: (fidl::Channel, fidl::Channel),
36    after_send: AfterSend,
37    mut out: Vec<(&[u8], &mut Vec<fidl::NullableHandle>)>,
38) {
39    let channels = (
40        fidl::AsyncChannel::from_channel(channels.0),
41        fidl::AsyncChannel::from_channel(channels.1),
42    );
43    let num_handles_in: Vec<_> = out.iter().map(|(_, handles)| handles.len()).collect();
44    for (out_bytes, handles) in out.iter_mut() {
45        fixture.log(&format!(
46            "#    send message from {:?} to {:?}: {:?}, {:?}",
47            channels.0, channels.1, out_bytes, handles
48        ));
49        assert_eq!(channels.0.write(out_bytes, *handles), Ok(()));
50    }
51    match after_send {
52        AfterSend::RemainOpen => (),
53        AfterSend::CloseSender => drop(channels.0),
54    }
55    for ((out_bytes, out_handles), num_handles_in) in out.iter_mut().zip(num_handles_in) {
56        let mut msg = fidl::MessageBufEtc::new();
57        // other channel should eventually receive the message, but we allow that propagation
58        // need not be instant
59        channels.1.recv_etc_msg(&mut msg).await.unwrap();
60        let (bytes, handles) = msg.split_mut();
61        assert_eq!(bytes.as_slice(), *out_bytes);
62        assert_eq!(handles.len(), num_handles_in);
63        for i in 0..handles.len() {
64            std::mem::swap(&mut handles[i].handle, &mut out_handles[i]);
65        }
66    }
67}
68
69async fn send_channel(
70    fixture: &mut impl LoggingFixture,
71    first: (fidl::Channel, fidl::Channel),
72    second: (fidl::Channel, fidl::Channel),
73    after_send_first: AfterSend,
74    after_send_second: AfterSend,
75) {
76    let mut second_b = vec![second.1.into_handle()];
77    send_message(fixture, first, after_send_first, vec![(&[], &mut second_b)]).await;
78    send_message(
79        fixture,
80        (second.0, fidl::Channel::from_handle(second_b.into_iter().next().unwrap())),
81        after_send_second,
82        vec![(&[100, 101, 102, 103, 104], &mut vec![])],
83    )
84    .await;
85}
86
87pub async fn run(mut fixture: impl Fixture) {
88    fixture.log(&format!("# send message a->b"));
89    let channels = fixture.create_handles(CreateHandlePurpose::PrimaryTestChannel).await;
90    send_message(&mut fixture, channels, AfterSend::RemainOpen, vec![(&[1, 2, 3], &mut vec![])])
91        .await;
92    fixture.log(&format!("# send message b->a"));
93    let channels = reverse(fixture.create_handles(CreateHandlePurpose::PrimaryTestChannel).await);
94    send_message(&mut fixture, channels, AfterSend::RemainOpen, vec![(&[7, 8, 9], &mut vec![])])
95        .await;
96
97    fixture.log(&format!("# send message then close a->b"));
98    let channels = fixture.create_handles(CreateHandlePurpose::PrimaryTestChannel).await;
99    send_message(&mut fixture, channels, AfterSend::CloseSender, vec![(&[1, 2, 3], &mut vec![])])
100        .await;
101    fixture.log(&format!("# send message then close b->a"));
102    let channels = reverse(fixture.create_handles(CreateHandlePurpose::PrimaryTestChannel).await);
103    send_message(&mut fixture, channels, AfterSend::CloseSender, vec![(&[7, 8, 9], &mut vec![])])
104        .await;
105
106    for reverse_ab in [false, true].iter() {
107        for reverse_cd in [false, true].iter() {
108            for after_send_ab in [AfterSend::RemainOpen, AfterSend::CloseSender].iter() {
109                for after_send_cd in [AfterSend::RemainOpen, AfterSend::CloseSender].iter() {
110                    fixture.log(&format!(
111                        "# send channel {}{}; {}{}",
112                        match after_send_ab {
113                            AfterSend::RemainOpen => "",
114                            AfterSend::CloseSender => "then close ",
115                        },
116                        match reverse_ab {
117                            false => "a->b",
118                            true => "b->a",
119                        },
120                        match after_send_cd {
121                            AfterSend::RemainOpen => "",
122                            AfterSend::CloseSender => "then close ",
123                        },
124                        match reverse_ab {
125                            false => "c->d",
126                            true => "d->c",
127                        }
128                    ));
129                    let ab = fixture.create_handles(CreateHandlePurpose::PrimaryTestChannel).await;
130                    let cd = fixture.create_handles(CreateHandlePurpose::PayloadChannel).await;
131                    send_channel(
132                        &mut fixture,
133                        maybe_reverse(*reverse_ab, ab),
134                        maybe_reverse(*reverse_cd, cd),
135                        *after_send_ab,
136                        *after_send_cd,
137                    )
138                    .await;
139                }
140            }
141        }
142    }
143
144    // Verify a very large send (just bytes to simplify the test for now)
145    let channels = fixture.create_handles(CreateHandlePurpose::PrimaryTestChannel).await;
146    send_message(
147        &mut fixture,
148        channels,
149        AfterSend::CloseSender,
150        vec![
151            (&[0], &mut vec![]),
152            (&[1], &mut vec![]),
153            (&[2], &mut vec![]),
154            (&[3], &mut vec![]),
155            (&[4], &mut vec![]),
156            (&[5], &mut vec![]),
157            (&[6], &mut vec![]),
158            (&[7], &mut vec![]),
159            (&[8], &mut vec![]),
160            (&[9], &mut vec![]),
161            (&[10], &mut vec![]),
162            (&[11], &mut vec![]),
163            (&[12], &mut vec![]),
164            (&[13], &mut vec![]),
165            (&[14], &mut vec![]),
166            (&[15], &mut vec![]),
167            (&[16], &mut vec![]),
168            (&[17], &mut vec![]),
169            (&[18], &mut vec![]),
170            (&[19], &mut vec![]),
171            (&[20], &mut vec![]),
172            (&[21], &mut vec![]),
173            (&[22], &mut vec![]),
174            (&[23], &mut vec![]),
175            (&[24], &mut vec![]),
176            (&[25], &mut vec![]),
177            (&[26], &mut vec![]),
178            (&[27], &mut vec![]),
179            (&[28], &mut vec![]),
180            (&[29], &mut vec![]),
181            (&[30], &mut vec![]),
182            (&[31], &mut vec![]),
183            (&[32], &mut vec![]),
184            (&[33], &mut vec![]),
185            (&[34], &mut vec![]),
186            (&[35], &mut vec![]),
187            (&[36], &mut vec![]),
188            (&[37], &mut vec![]),
189            (&[38], &mut vec![]),
190            (&[39], &mut vec![]),
191            (&[40], &mut vec![]),
192            (&[41], &mut vec![]),
193            (&[42], &mut vec![]),
194            (&[43], &mut vec![]),
195            (&[44], &mut vec![]),
196            (&[45], &mut vec![]),
197            (&[46], &mut vec![]),
198            (&[47], &mut vec![]),
199            (&[48], &mut vec![]),
200            (&[49], &mut vec![]),
201            (&[50], &mut vec![]),
202            (&[51], &mut vec![]),
203            (&[52], &mut vec![]),
204            (&[53], &mut vec![]),
205            (&[54], &mut vec![]),
206            (&[55], &mut vec![]),
207            (&[56], &mut vec![]),
208            (&[57], &mut vec![]),
209            (&[58], &mut vec![]),
210            (&[59], &mut vec![]),
211            (&[60], &mut vec![]),
212            (&[61], &mut vec![]),
213            (&[62], &mut vec![]),
214            (&[63], &mut vec![]),
215            (&[64], &mut vec![]),
216            (&[65], &mut vec![]),
217            (&[66], &mut vec![]),
218            (&[67], &mut vec![]),
219            (&[68], &mut vec![]),
220            (&[69], &mut vec![]),
221            (&[70], &mut vec![]),
222            (&[71], &mut vec![]),
223            (&[72], &mut vec![]),
224            (&[73], &mut vec![]),
225            (&[74], &mut vec![]),
226            (&[75], &mut vec![]),
227            (&[76], &mut vec![]),
228            (&[77], &mut vec![]),
229            (&[78], &mut vec![]),
230            (&[79], &mut vec![]),
231            (&[80], &mut vec![]),
232            (&[81], &mut vec![]),
233            (&[82], &mut vec![]),
234            (&[83], &mut vec![]),
235            (&[84], &mut vec![]),
236            (&[85], &mut vec![]),
237            (&[86], &mut vec![]),
238            (&[87], &mut vec![]),
239            (&[88], &mut vec![]),
240            (&[89], &mut vec![]),
241            (&[90], &mut vec![]),
242            (&[91], &mut vec![]),
243            (&[92], &mut vec![]),
244            (&[93], &mut vec![]),
245            (&[94], &mut vec![]),
246            (&[95], &mut vec![]),
247            (&[96], &mut vec![]),
248            (&[97], &mut vec![]),
249            (&[98], &mut vec![]),
250            (&[99], &mut vec![]),
251            (&[100], &mut vec![]),
252            (&[101], &mut vec![]),
253            (&[102], &mut vec![]),
254            (&[103], &mut vec![]),
255            (&[104], &mut vec![]),
256            (&[105], &mut vec![]),
257            (&[106], &mut vec![]),
258            (&[107], &mut vec![]),
259            (&[108], &mut vec![]),
260            (&[109], &mut vec![]),
261            (&[110], &mut vec![]),
262            (&[111], &mut vec![]),
263            (&[112], &mut vec![]),
264            (&[113], &mut vec![]),
265            (&[114], &mut vec![]),
266            (&[115], &mut vec![]),
267            (&[116], &mut vec![]),
268            (&[117], &mut vec![]),
269            (&[118], &mut vec![]),
270            (&[119], &mut vec![]),
271            (&[120], &mut vec![]),
272            (&[121], &mut vec![]),
273            (&[122], &mut vec![]),
274            (&[123], &mut vec![]),
275            (&[124], &mut vec![]),
276            (&[125], &mut vec![]),
277            (&[126], &mut vec![]),
278            (&[127], &mut vec![]),
279            (&[128], &mut vec![]),
280            (&[129], &mut vec![]),
281            (&[130], &mut vec![]),
282            (&[131], &mut vec![]),
283            (&[132], &mut vec![]),
284            (&[133], &mut vec![]),
285            (&[134], &mut vec![]),
286            (&[135], &mut vec![]),
287            (&[136], &mut vec![]),
288            (&[137], &mut vec![]),
289            (&[138], &mut vec![]),
290            (&[139], &mut vec![]),
291            (&[140], &mut vec![]),
292            (&[141], &mut vec![]),
293            (&[142], &mut vec![]),
294            (&[143], &mut vec![]),
295            (&[144], &mut vec![]),
296            (&[145], &mut vec![]),
297            (&[146], &mut vec![]),
298            (&[147], &mut vec![]),
299            (&[148], &mut vec![]),
300            (&[149], &mut vec![]),
301            (&[150], &mut vec![]),
302            (&[151], &mut vec![]),
303            (&[152], &mut vec![]),
304            (&[153], &mut vec![]),
305            (&[154], &mut vec![]),
306            (&[155], &mut vec![]),
307            (&[156], &mut vec![]),
308            (&[157], &mut vec![]),
309            (&[158], &mut vec![]),
310            (&[159], &mut vec![]),
311            (&[160], &mut vec![]),
312            (&[161], &mut vec![]),
313            (&[162], &mut vec![]),
314            (&[163], &mut vec![]),
315            (&[164], &mut vec![]),
316            (&[165], &mut vec![]),
317            (&[166], &mut vec![]),
318            (&[167], &mut vec![]),
319            (&[168], &mut vec![]),
320            (&[169], &mut vec![]),
321            (&[170], &mut vec![]),
322            (&[171], &mut vec![]),
323            (&[172], &mut vec![]),
324            (&[173], &mut vec![]),
325            (&[174], &mut vec![]),
326            (&[175], &mut vec![]),
327            (&[176], &mut vec![]),
328            (&[177], &mut vec![]),
329            (&[178], &mut vec![]),
330            (&[179], &mut vec![]),
331            (&[180], &mut vec![]),
332            (&[181], &mut vec![]),
333            (&[182], &mut vec![]),
334            (&[183], &mut vec![]),
335            (&[184], &mut vec![]),
336            (&[185], &mut vec![]),
337            (&[186], &mut vec![]),
338            (&[187], &mut vec![]),
339            (&[188], &mut vec![]),
340            (&[189], &mut vec![]),
341            (&[190], &mut vec![]),
342            (&[191], &mut vec![]),
343            (&[192], &mut vec![]),
344            (&[193], &mut vec![]),
345            (&[194], &mut vec![]),
346            (&[195], &mut vec![]),
347            (&[196], &mut vec![]),
348            (&[197], &mut vec![]),
349            (&[198], &mut vec![]),
350            (&[199], &mut vec![]),
351            (&[200], &mut vec![]),
352            (&[201], &mut vec![]),
353            (&[202], &mut vec![]),
354            (&[203], &mut vec![]),
355            (&[204], &mut vec![]),
356            (&[205], &mut vec![]),
357            (&[206], &mut vec![]),
358            (&[207], &mut vec![]),
359            (&[208], &mut vec![]),
360            (&[209], &mut vec![]),
361            (&[210], &mut vec![]),
362            (&[211], &mut vec![]),
363            (&[212], &mut vec![]),
364            (&[213], &mut vec![]),
365            (&[214], &mut vec![]),
366            (&[215], &mut vec![]),
367            (&[216], &mut vec![]),
368            (&[217], &mut vec![]),
369            (&[218], &mut vec![]),
370            (&[219], &mut vec![]),
371            (&[220], &mut vec![]),
372            (&[221], &mut vec![]),
373            (&[222], &mut vec![]),
374            (&[223], &mut vec![]),
375            (&[224], &mut vec![]),
376            (&[225], &mut vec![]),
377            (&[226], &mut vec![]),
378            (&[227], &mut vec![]),
379            (&[228], &mut vec![]),
380            (&[229], &mut vec![]),
381            (&[230], &mut vec![]),
382            (&[231], &mut vec![]),
383            (&[232], &mut vec![]),
384            (&[233], &mut vec![]),
385            (&[234], &mut vec![]),
386            (&[235], &mut vec![]),
387            (&[236], &mut vec![]),
388            (&[237], &mut vec![]),
389            (&[238], &mut vec![]),
390            (&[239], &mut vec![]),
391            (&[240], &mut vec![]),
392            (&[241], &mut vec![]),
393            (&[242], &mut vec![]),
394            (&[243], &mut vec![]),
395            (&[244], &mut vec![]),
396            (&[245], &mut vec![]),
397            (&[246], &mut vec![]),
398            (&[247], &mut vec![]),
399            (&[248], &mut vec![]),
400            (&[249], &mut vec![]),
401            (&[250], &mut vec![]),
402            (&[251], &mut vec![]),
403            (&[252], &mut vec![]),
404            (&[253], &mut vec![]),
405            (&[254], &mut vec![]),
406            (&[255], &mut vec![]),
407        ],
408    )
409    .await;
410}
411
412#[cfg(test)]
413mod test {
414    use super::*;
415
416    struct FidlFixture;
417
418    #[async_trait]
419    impl Fixture for FidlFixture {
420        async fn create_handles(&self, _: CreateHandlePurpose) -> (fidl::Channel, fidl::Channel) {
421            fidl::Channel::create()
422        }
423    }
424
425    impl LoggingFixture for FidlFixture {
426        fn log(&mut self, msg: &str) {
427            println!("{}", msg);
428        }
429    }
430
431    #[fuchsia_async::run_singlethreaded(test)]
432    async fn tests() {
433        run(FidlFixture).await
434    }
435}