src/connectivity/wlan/drivers/third_party/broadcom/brcmfmac/sim/test/call_after_del_iface_test.cc

// Copyright 2020 The Fuchsia Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be found in the LICENSE file.

#include <fuchsia/hardware/wlanif/c/banjo.h>
#include <zircon/errors.h>

#include <gtest/gtest.h>

#include "src/connectivity/wlan/drivers/third_party/broadcom/brcmfmac/sim/test/sim_test.h"

namespace wlan::brcmfmac {

// Verify that attempts to set the multicast promiscuous mode on a client interface are rejected
// after the interface has been deleted.
TEST_F(SimTest, SetMulticastPromiscClient) {
  ASSERT_EQ(Init(), ZX_OK);

  SimInterface client_ifc;
  ASSERT_EQ(StartInterface(WLAN_INFO_MAC_ROLE_CLIENT, &client_ifc), ZX_OK);

  // We use a fake child device to prevent our wlanif_impl from being deleted.
  auto device = dev_mgr_->FindFirstDevByProtocolId(ZX_PROTOCOL_WLANIF_IMPL);
  ASSERT_NE(device, std::nullopt);
  zx_device_t* fake_child = nullptr;
  ASSERT_EQ(dev_mgr_->DeviceAdd(device->as_device(), nullptr, &fake_child), ZX_OK);

  EXPECT_EQ(client_ifc.SetMulticastPromisc(true), ZX_OK);
  // Save off if_impl_ctx and if_impl_ops as DeleteInterface() will reset client_ifc_.
  void* if_impl_ctx = client_ifc.if_impl_ctx_;
  wlanif_impl_protocol_ops_t if_impl_ops = *client_ifc.if_impl_ops_;
  EXPECT_EQ(DeleteInterface(&client_ifc), ZX_OK);
  EXPECT_NE(if_impl_ops.set_multicast_promisc(if_impl_ctx, true), ZX_OK);

  dev_mgr_->DeviceAsyncRemove(fake_child);
}

// Verify that attempts to set the multicast promiscuous mode on an AP interface are rejected
// after the interface has been deleted.
TEST_F(SimTest, SetMulticastPromiscAP) {
  ASSERT_EQ(Init(), ZX_OK);

  SimInterface ap_ifc;
  ASSERT_EQ(StartInterface(WLAN_INFO_MAC_ROLE_AP, &ap_ifc), ZX_OK);

  // We use a fake child device to prevent our wlanif_impl from being deleted.
  auto device = dev_mgr_->FindFirstDevByProtocolId(ZX_PROTOCOL_WLANIF_IMPL);
  ASSERT_NE(device, std::nullopt);
  zx_device_t* fake_child = nullptr;
  ASSERT_EQ(dev_mgr_->DeviceAdd(device->as_device(), nullptr, &fake_child), ZX_OK);

  EXPECT_EQ(ap_ifc.SetMulticastPromisc(true), ZX_OK);
  // Save off if_impl_ctx and if_impl_ops as DeleteInterface() will reset client_ifc_.
  void* if_impl_ctx = ap_ifc.if_impl_ctx_;
  wlanif_impl_protocol_ops_t if_impl_ops = *ap_ifc.if_impl_ops_;
  EXPECT_EQ(DeleteInterface(&ap_ifc), ZX_OK);
  // Ensure any call into the IF fails after it has been deleted.
  EXPECT_NE(if_impl_ops.set_multicast_promisc(if_impl_ctx, true), ZX_OK);

  dev_mgr_->DeviceAsyncRemove(fake_child);
}

// Verify that attempts to stop a soft AP after the interface is deleted does not cause a failure.
TEST_F(SimTest, StopAP) {
  ASSERT_EQ(Init(), ZX_OK);

  SimInterface ap_ifc;
  ASSERT_EQ(StartInterface(WLAN_INFO_MAC_ROLE_AP, &ap_ifc), ZX_OK);

  ap_ifc.StartSoftAp();

  // We use a fake child device to prevent our wlanif_impl from being deleted.
  auto device = dev_mgr_->FindFirstDevByProtocolId(ZX_PROTOCOL_WLANIF_IMPL);
  ASSERT_NE(device, std::nullopt);
  zx_device_t* fake_child = nullptr;
  ASSERT_EQ(dev_mgr_->DeviceAdd(device->as_device(), nullptr, &fake_child), ZX_OK);

  // Save off if_impl_ctx and if_impl_ops as DeleteInterface() will reset ap_ifc.
  void* if_impl_ctx = ap_ifc.if_impl_ctx_;
  wlanif_impl_protocol_ops_t if_impl_ops = *ap_ifc.if_impl_ops_;
  EXPECT_EQ(DeleteInterface(&ap_ifc), ZX_OK);
  // Delete should have reset the IF's if_impl_ctx
  ASSERT_EQ(ap_ifc.if_impl_ctx_, nullptr);
  // Ensure any call into the IF fails after it has been deleted.
  EXPECT_NE(if_impl_ops.set_multicast_promisc(if_impl_ctx, true), ZX_OK);

  dev_mgr_->DeviceAsyncRemove(fake_child);
}

// Verify that a firmware scan result indication after the interface is stopped does
// not cause a failure.
TEST_F(SimTest, ScanResultAfterIfaceStop) {
  ASSERT_EQ(Init(), ZX_OK);

  SimInterface client_ifc;

  ASSERT_EQ(StartInterface(WLAN_INFO_MAC_ROLE_CLIENT, &client_ifc), ZX_OK);

  client_ifc.StartScan(0, true);
  client_ifc.StopInterface();
  // The scan result will arrive after the iface is torn down.
  env_->Run(zx::sec(1));  // This should be a no-op, not a crash.

  EXPECT_EQ(DeleteInterface(&client_ifc), ZX_OK);
}

// Verify that calling WlanphyImplDestroyIface() twice will not cause a crash when the first call
// failed.
TEST_F(SimTest, DeleteIfaceTwice) {
  ASSERT_EQ(Init(), ZX_OK);

  SimInterface softap_ifc;
  ASSERT_EQ(StartInterface(WLAN_INFO_MAC_ROLE_AP, &softap_ifc), ZX_OK);

  // Inject firmware error to "interface_remove" iovar.
  brcmf_simdev* sim = device_->GetSim();
  sim->sim_fw->err_inj_.AddErrInjIovar("interface_remove", ZX_OK, BCME_ERROR, softap_ifc.iface_id_);

  EXPECT_EQ(DeleteInterface(&softap_ifc), ZX_ERR_IO_REFUSED);

  // Cancel the injected error.
  sim->sim_fw->err_inj_.DelErrInjIovar("interface_remove");

  EXPECT_EQ(DeleteInterface(&softap_ifc), ZX_OK);
};
}  // namespace wlan::brcmfmac