Skip to main content

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