sl4f_lib/wlan/
facade.rs

1// Copyright 2018 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::wlan::types;
6use anyhow::{Context as _, Error};
7use fidl_fuchsia_wlan_common as fidl_common;
8use fidl_fuchsia_wlan_device_service::{DeviceMonitorMarker, DeviceMonitorProxy};
9use fuchsia_component::client::connect_to_protocol;
10use fuchsia_sync::RwLock;
11use ieee80211::{MacAddr, Ssid};
12use std::collections::HashMap;
13use wlan_common::scan::ScanResult;
14
15// WlanFacade: proxies commands from sl4f test to proper fidl APIs
16//
17// This object is shared among all threads created by server.  The inner object is the facade
18// itself.  Callers interact with a wrapped version of the facade that enforces read/write
19// protection.
20//
21// Use: Create once per server instantiation.
22#[derive(Debug)]
23struct InnerWlanFacade {
24    // TODO(https://fxbug.dev/42165549)
25    #[allow(unused)]
26    scan_results: bool,
27}
28
29#[derive(Debug)]
30pub(crate) struct WlanFacade {
31    monitor_svc: DeviceMonitorProxy,
32    // TODO(https://fxbug.dev/42165549)
33    #[allow(unused)]
34    inner: RwLock<InnerWlanFacade>,
35}
36
37impl WlanFacade {
38    pub fn new() -> Result<WlanFacade, Error> {
39        let monitor_svc = connect_to_protocol::<DeviceMonitorMarker>()?;
40
41        Ok(WlanFacade { monitor_svc, inner: RwLock::new(InnerWlanFacade { scan_results: false }) })
42    }
43
44    /// Gets the list of wlan interface IDs.
45    pub async fn get_iface_id_list(&self) -> Result<Vec<u16>, Error> {
46        let wlan_iface_ids = wlan_service_util::get_iface_list(&self.monitor_svc)
47            .await
48            .context("Get Iface Id List: failed to get wlan iface list")?;
49        Ok(wlan_iface_ids)
50    }
51
52    /// Gets the list of wlan interface IDs.
53    pub async fn get_phy_id_list(&self) -> Result<Vec<u16>, Error> {
54        let wlan_phy_ids = wlan_service_util::get_phy_list(&self.monitor_svc)
55            .await
56            .context("Get Phy Id List: failed to get wlan phy list")?;
57        Ok(wlan_phy_ids)
58    }
59
60    pub async fn scan(&self) -> Result<Vec<String>, Error> {
61        // get the first client interface
62        let sme_proxy = wlan_service_util::client::get_first_sme(&self.monitor_svc)
63            .await
64            .context("Scan: failed to get client iface sme proxy")?;
65
66        // start the scan
67        let scan_result_list =
68            wlan_service_util::client::passive_scan(&sme_proxy).await.context("Scan failed")?;
69
70        // send the ssids back to the test
71        let mut ssid_list = Vec::new();
72        for scan_result in &scan_result_list {
73            let scan_result: ScanResult = scan_result.clone().try_into()?;
74            let ssid = String::from_utf8_lossy(&scan_result.bss_description.ssid).into_owned();
75            ssid_list.push(ssid);
76        }
77        Ok(ssid_list)
78    }
79
80    async fn passive_scan(
81        &self,
82    ) -> Result<impl IntoIterator<Item = Result<ScanResult, Error>>, Error> {
83        // get the first client interface
84        let sme_proxy = wlan_service_util::client::get_first_sme(&self.monitor_svc)
85            .await
86            .context("Scan: failed to get client iface sme proxy")?;
87        // start the scan
88        Ok(wlan_service_util::client::passive_scan(&sme_proxy)
89            .await
90            .context("Scan failed")?
91            .into_iter()
92            .map(ScanResult::try_from))
93    }
94
95    pub async fn scan_for_bss_info(
96        &self,
97    ) -> Result<HashMap<String, Vec<Box<types::BssDescriptionDef>>>, Error> {
98        let mut scan_results_by_ssid_string = HashMap::new();
99        for scan_result in self.passive_scan().await? {
100            let scan_result = scan_result.context("Failed to convert scan result")?;
101            let entry = scan_results_by_ssid_string
102                .entry(String::from(scan_result.bss_description.ssid.to_string_not_redactable()))
103                .or_insert(vec![]);
104
105            let fidl_bss_desc: fidl_common::BssDescription = scan_result.bss_description.into();
106            entry.push(Box::new(fidl_bss_desc.into()));
107        }
108        Ok(scan_results_by_ssid_string)
109    }
110
111    pub async fn connect(
112        &self,
113        target_ssid: Ssid,
114        target_pwd: Vec<u8>,
115        target_bss_desc: fidl_common::BssDescription,
116    ) -> Result<bool, Error> {
117        let sme_proxy = wlan_service_util::client::get_first_sme(&self.monitor_svc)
118            .await
119            .context("Connect: failed to get client iface sme proxy")?;
120        wlan_service_util::client::connect(&sme_proxy, target_ssid, target_pwd, target_bss_desc)
121            .await
122    }
123
124    pub async fn create_iface(
125        &self,
126        phy_id: u16,
127        role: fidl_common::WlanMacRole,
128        sta_addr: MacAddr,
129    ) -> Result<u16, Error> {
130        let iface_id = wlan_service_util::create_iface(&self.monitor_svc, phy_id, role, sta_addr)
131            .await
132            .context("Create: Failed to create iface")?;
133
134        Ok(iface_id)
135    }
136
137    /// Destroys a WLAN interface by input interface ID.
138    ///
139    /// # Arguments
140    /// * `iface_id` - The u16 interface id.
141    pub async fn destroy_iface(&self, iface_id: u16) -> Result<(), Error> {
142        wlan_service_util::destroy_iface(&self.monitor_svc, iface_id)
143            .await
144            .context("Destroy: Failed to destroy iface")
145    }
146
147    pub async fn disconnect(&self) -> Result<(), Error> {
148        wlan_service_util::client::disconnect_all(&self.monitor_svc)
149            .await
150            .context("Disconnect: Failed to disconnect ifaces")
151    }
152
153    pub async fn status(&self) -> Result<types::ClientStatusResponseDef, Error> {
154        // get the first client interface
155        let sme_proxy = wlan_service_util::client::get_first_sme(&self.monitor_svc)
156            .await
157            .context("Status: failed to get iface sme proxy")?;
158
159        let rsp = sme_proxy.status().await.context("failed to get status from sme_proxy")?;
160
161        Ok(rsp.into())
162    }
163
164    pub async fn query_iface(
165        &self,
166        iface_id: u16,
167    ) -> Result<types::QueryIfaceResponseWrapper, Error> {
168        let iface_info = self
169            .monitor_svc
170            .query_iface(iface_id)
171            .await
172            .context("Failed to query iface information")?
173            .map_err(|e| zx::Status::from_raw(e));
174
175        match iface_info {
176            Ok(info) => Ok(types::QueryIfaceResponseWrapper(info.into())),
177            Err(zx::Status::NOT_FOUND) => {
178                Err(format_err!("no iface information for ID: {}", iface_id))
179            }
180            Err(e) => Err(e.into()),
181        }
182    }
183}
sl4f_lib/wlan/facade.rs

sl4f_lib/wlan/
facade.rs
