35#include "ns3/attribute-container.h"
36#include "ns3/eht-configuration.h"
37#include "ns3/emlsr-manager.h"
38#include "ns3/he-configuration.h"
39#include "ns3/ht-configuration.h"
41#include "ns3/packet.h"
43#include "ns3/pointer.h"
44#include "ns3/random-variable-stream.h"
45#include "ns3/simulator.h"
46#include "ns3/string.h"
67 .AddAttribute(
"ProbeRequestTimeout",
68 "The duration to actively probe the channel.",
72 .AddAttribute(
"WaitBeaconTimeout",
73 "The duration to dwell on a channel while passively scanning for beacon",
77 .AddAttribute(
"AssocRequestTimeout",
78 "The interval between two consecutive association request attempts.",
82 .AddAttribute(
"MaxMissedBeacons",
83 "Number of beacons which much be consecutively missed before "
84 "we attempt to restart association.",
87 MakeUintegerChecker<uint32_t>())
90 "If true, we send probe requests. If false, we don't."
91 "NOTE: if more than one STA in your simulation is using active probing, "
92 "you should enable it at a different simulation time for each STA, "
93 "otherwise all the STAs will start sending probes at the same time resulting in "
95 "See bug 1060 for more info.",
99 .AddAttribute(
"ProbeDelay",
100 "Delay (in microseconds) to be used prior to transmitting a "
101 "Probe frame during active scanning.",
102 StringValue(
"ns3::UniformRandomVariable[Min=50.0|Max=250.0]"),
104 MakePointerChecker<RandomVariableStream>())
107 "Enable/disable power save mode on the given link. The power management mode is "
108 "actually changed when the AP acknowledges a frame sent with the Power Management "
109 "field set to the value corresponding to the requested mode",
114 MakeUintegerChecker<uint8_t>()))
115 .AddAttribute(
"PmModeSwitchTimeout",
116 "If switching to a new Power Management mode is not completed within "
117 "this amount of time, make another attempt at switching Power "
122 .AddTraceSource(
"Assoc",
123 "Associated with an access point. If this is an MLD that associated "
124 "with an AP MLD, the AP MLD address is provided.",
126 "ns3::Mac48Address::TracedCallback")
127 .AddTraceSource(
"LinkSetupCompleted",
128 "A link was setup in the context of ML setup with an AP MLD. "
129 "Provides ID of the setup link and AP MAC address",
131 "ns3::StaWifiMac::LinkSetupCallback")
132 .AddTraceSource(
"DeAssoc",
133 "Association with an access point lost. If this is an MLD "
134 "that disassociated with an AP MLD, the AP MLD address is provided.",
136 "ns3::Mac48Address::TracedCallback")
137 .AddTraceSource(
"LinkSetupCanceled",
138 "A link setup in the context of ML setup with an AP MLD was torn down. "
139 "Provides ID of the setup link and AP MAC address",
141 "ns3::StaWifiMac::LinkSetupCallback",
143 "Disassociation only occurs at MLD level; use DeAssoc trace.")
144 .AddTraceSource(
"BeaconArrival",
145 "Time of beacons arrival from associated AP",
147 "ns3::Time::TracedCallback")
148 .AddTraceSource(
"ReceivedBeaconInfo",
149 "Information about every received Beacon frame",
151 "ns3::ApInfo::TracedCallback");
156 : m_state(UNASSOCIATED),
158 m_assocRequestEvent()
223std::unique_ptr<WifiMac::LinkEntity>
226 return std::make_unique<StaLinkEntity>();
246 auto currentStream = stream + 1;
248 return (currentStream - stream);
287 NS_LOG_DEBUG(
"STA is still scanning, reset scanning process");
303 for (
auto& phy : phys)
305 phy->SetCapabilitiesChangedCallback(
314 uint16_t width = phy->GetOperatingChannel().IsOfdm() ? 20 : phy->GetChannelWidth();
315 uint8_t ch = phy->GetOperatingChannel().GetPrimaryChannelNumber(width, phy->GetStandard());
316 return {ch, phy->GetPhyBand()};
322 std::stringstream ss;
325 std::copy(linkIds.cbegin(), linkIds.cend(), std::ostream_iterator<uint16_t>(ss,
" "));
329 for (
const auto& [linkId, lnk] :
GetLinks())
333 if (linkIds.contains(linkId))
336 link.emlsrEnabled =
true;
342 if (link.emlsrEnabled)
346 link.emlsrEnabled =
false;
395 packet->AddHeader(probe);
414std::variant<MgtAssocRequestHeader, MgtReassocRequestHeader>
419 std::variant<MgtAssocRequestHeader, MgtReassocRequestHeader> mgtFrame;
425 mgtFrame = std::move(reassoc);
433 auto fill = [&](
auto&& frame) {
434 frame.template Get<Ssid>() =
GetSsid();
436 frame.template Get<SupportedRates>() = supportedRates.rates;
437 frame.template Get<ExtendedSupportedRatesIE>() = supportedRates.extendedRates;
439 frame.SetListenInterval(0);
463 std::visit(fill, mgtFrame);
501 mldCapabilities.emplace();
502 mldCapabilities->maxNSimultaneousLinks =
GetNLinks() - 1;
503 mldCapabilities->srsSupport = 0;
508 ehtConfiguration->GetAttributeFailSafe(
"TidToLinkMappingNegSupport", negSupport);
510 mldCapabilities->tidToLinkMappingSupport =
static_cast<uint8_t
>(negSupport.
Get());
511 mldCapabilities->freqSepForStrApMld = 0;
512 mldCapabilities->aarSupport = 0;
518 for (
const auto& [index, link] :
GetLinks())
522 if (index != linkId && staLink.bssid.has_value())
534 perStaProfile.SetCompleteProfile();
539 perStaProfile.SetStaMacAddress(staLink.feManager->GetAddress());
544 return multiLinkElement;
547std::vector<TidToLinkMapping>
556 ehtConfig->GetAttributeFailSafe(
"TidToLinkMappingNegSupport", negSupport);
559 "Cannot request TID-to-Link Mapping if negotiation is not supported");
569 !mappingValidForNegType1,
570 "Mapping TIDs to distinct link sets is incompatible with negotiation support of 1");
579 NS_LOG_DEBUG(
"Using default mapping because AP MLD advertised negotiation support of 1");
584 std::vector<TidToLinkMapping> ret(1);
589 auto fillIe = [&ret](
const auto& mapping) {
590 ret.back().m_control.defaultMapping = mapping.empty();
592 for (
const auto& [tid, linkSet] : mapping)
598 NS_ABORT_MSG_IF(linkSet.empty(),
"Cannot map a TID to an empty link set");
599 ret.back().SetLinkMappingOfTid(tid, linkSet);
632 "No link selected to send the (Re)Association Request");
633 uint8_t linkId = it->first;
636 "No BSSID set for the link on which the (Re)Association Request is to be sent");
642 hdr.
SetAddr2(link.feManager->GetAddress());
657 auto addMle = [&](
auto&& frame) {
660 std::visit(addMle, frame);
663 if (
const auto& mldCapabilities =
666 mldCapabilities->get().tidToLinkMappingSupport)) >
669 auto addTlm = [&](
auto&& frame) {
672 std::visit(addTlm, frame);
678 packet->AddHeader(std::get<MgtAssocRequestHeader>(frame));
682 packet->AddHeader(std::get<MgtReassocRequestHeader>(frame));
758 for (
const auto& [
id, link] :
GetLinks())
786 if (!bestAp.has_value())
788 NS_LOG_DEBUG(
"Exhausted list of candidate AP; restart scanning");
793 NS_LOG_DEBUG(
"Attempting to associate with AP: " << *bestAp);
794 UpdateApInfo(bestAp->m_frame, bestAp->m_apAddr, bestAp->m_bssid, bestAp->m_linkId);
799 staLink.sendAssocReq =
false;
800 staLink.bssid = std::nullopt;
805 std::shared_ptr<CommonInfoBasicMle> mleCommonInfo;
808 std::visit([](
auto&& frame) {
return frame.template Get<MultiLinkElement>(); },
810 std::map<uint8_t, uint8_t> swapInfo;
811 for (
const auto& [localLinkId, apLinkId, bssid] : bestAp->m_setupLinks)
814 NS_LOG_DEBUG(
"Setting up link (local ID=" << +localLinkId <<
", AP ID=" << +apLinkId
819 mleCommonInfo = std::make_shared<CommonInfoBasicMle>(mle->GetCommonInfoBasic());
822 swapInfo.emplace(localLinkId, apLinkId);
828 auto getBeaconInterval = [](
auto&& frame) {
829 using T = std::decay_t<
decltype(frame)>;
830 if constexpr (std::is_same_v<T, MgtBeaconHeader> ||
831 std::is_same_v<T, MgtProbeResponseHeader>)
841 Time beaconInterval = std::visit(getBeaconInterval, bestAp->m_frame);
880 for (
const auto& [
id, link] :
GetLinks())
882 if (link->phy && link->phy->IsStateRx())
884 delay = std::max(delay, link->phy->GetDelayUntilIdle());
897 for (
const auto& [
id, link] :
GetLinks())
904 bssid = std::nullopt;
907 NS_LOG_DEBUG(
"Set state to UNASSOCIATED and start scanning");
949 std::set<uint8_t> linkIds;
950 for (
const auto& [
id, link] :
GetLinks())
965 uint8_t linkId = *linkIds.begin();
1032 uint8_t linkId = *linkIds.begin();
1085 std::stringstream ss;
1086 std::copy(linkIds.cbegin(), linkIds.cend(), std::ostream_iterator<uint16_t>(ss,
" "));
1089 const auto linkId = *linkIds.cbegin();
1090 const auto bssid =
GetBssid(linkId);
1091 const auto apAddress =
1113 const WifiMacHeader* hdr = &mpdu->GetOriginal()->GetHeader();
1133 NS_LOG_LOGIC(
"Received data frame while not associated: ignore");
1139 NS_LOG_LOGIC(
"Received data frame not from the DS: ignore");
1143 std::set<Mac48Address> apAddresses;
1148 if (!apAddresses.contains(mpdu->GetHeader().GetAddr2()))
1150 NS_LOG_LOGIC(
"Received data frame not from the BSS we are associated with: ignore");
1156 NS_LOG_LOGIC(
"Received (QoS) Null Data frame: ignore");
1164 NS_ASSERT(apAddresses.contains(mpdu->GetHeader().GetAddr3()));
1205 action.protectedEhtAction ==
1234 mpdu->GetPacket()->PeekHeader(beacon);
1243 goodBeacon = bssid.has_value() && (hdr.
GetAddr3() == *bssid);
1253 bool found = mpdu->GetPacket()->PeekPacketTag(snrTag);
1257 .m_snr = snrTag.
Get(),
1258 .m_frame = std::move(beacon),
1260 .m_linkId = linkId};
1296 mpdu->GetPacket()->PeekHeader(probeResp);
1302 bool found = mpdu->GetPacket()->PeekPacketTag(snrTag);
1306 .m_snr = snrTag.
Get(),
1307 .m_frame = std::move(probeResp),
1308 .m_channel = {GetCurrentChannel(linkId)},
1309 .m_linkId = linkId});
1324 std::optional<Mac48Address> apMldAddress;
1326 mpdu->GetPacket()->PeekHeader(assocResp);
1346 if (
const auto& mldCapabilities =
1349 mldCapabilities->get().tidToLinkMappingSupport) >
1398 std::list<uint8_t> setupLinks;
1399 for (
const auto& [
id, link] :
GetLinks())
1401 setupLinks.push_back(
id);
1405 setupLinks.remove(linkId);
1412 "The link on which the Association Response was received "
1413 "is not a link we requested to setup");
1415 "The link ID of the AP that transmitted the Association "
1416 "Response does not match the stored link ID");
1418 mle->GetMldMacAddress(),
1419 "The AP MLD MAC address in the received Multi-Link Element does not "
1420 "match the address stored in the station manager for link "
1423 for (std::size_t elem = 0; elem < mle->GetNPerStaProfileSubelements(); elem++)
1425 auto& perStaProfile = mle->GetPerStaProfile(elem);
1426 uint8_t apLinkId = perStaProfile.GetLinkId();
1427 auto it =
GetLinks().find(apLinkId);
1428 uint8_t staLinkid = 0;
1429 std::optional<Mac48Address> bssid;
1431 !(bssid =
GetLink((staLinkid = it->first)).
bssid).has_value(),
1432 "Setup for AP link ID " << apLinkId <<
" was not requested");
1434 "The BSSID in the Per-STA Profile for link ID "
1435 << +staLinkid <<
" does not match the stored BSSID");
1438 perStaProfile.GetStaMacAddress()) != mle->GetMldMacAddress(),
1439 "The AP MLD MAC address in the received Multi-Link Element does not "
1440 "match the address stored in the station manager for link "
1447 "AID should be the same for all the links");
1449 NS_LOG_DEBUG(
"Setup on link " << staLinkid <<
" completed");
1461 setupLinks.remove(staLinkid);
1465 for (
const auto&
id : setupLinks)
1480 for (
const auto& [
id, link] :
GetLinks())
1484 if (
const auto txop =
GetTxop())
1486 txop->StartAccessAfterEvent(
id,
1494 edca->StartAccessAfterEvent(
id,
1515 NS_ASSERT_MSG(psduMap.size() == 1 && psduMap.begin()->second->GetNMpdus() == 1 &&
1516 psduMap.begin()->second->GetHeader(0).IsAck(),
1517 "Expected a Normal Ack after Association Response frame");
1522 for (
const auto& [
id, lnk] :
GetLinks())
1549 std::pair<bool, uint8_t>{
true,
id});
1570 std::pair<bool, uint8_t>{
false,
id});
1580 phy->TraceConnectWithoutContext(
"PhyTxPsduBegin", cb);
1582 [=]() { phy->TraceDisconnectWithoutContext(
"PhyTxPsduBegin", cb); });
1592 auto check = [&](
auto&& mgtFrame) ->
bool {
1594 NS_ASSERT(mgtFrame.template Get<SupportedRates>());
1596 mgtFrame.template Get<ExtendedSupportedRatesIE>()};
1597 for (
const auto& selector :
GetWifiPhy(linkId)->GetBssMembershipSelectorList())
1599 if (!rates.IsBssMembershipSelectorRate(selector))
1601 NS_LOG_DEBUG(
"Supported rates do not fit with the BSS membership selector");
1609 return std::visit(
check, frame);
1621 const std::optional<ErpInformation>* erpInformation =
nullptr;
1623 if (
const auto* beacon = std::get_if<MgtBeaconHeader>(&frame))
1627 else if (
const auto* probe = std::get_if<MgtProbeResponseHeader>(&frame))
1633 auto commonOps = [&](
auto&& frame) {
1634 const auto& capabilities = frame.Capabilities();
1635 NS_ASSERT(frame.template Get<SupportedRates>());
1637 frame.template Get<ExtendedSupportedRatesIE>()};
1638 for (
const auto& mode :
GetWifiPhy(linkId)->GetModeList())
1640 if (rates.IsSupportedRate(mode.GetDataRate(
GetWifiPhy(linkId)->GetChannelWidth())))
1643 if (rates.IsBasicRate(mode.GetDataRate(
GetWifiPhy(linkId)->GetChannelWidth())))
1650 bool isShortPreambleEnabled = capabilities.IsShortPreamble();
1651 if (erpInformation && erpInformation->has_value() &&
GetErpSupported(linkId))
1653 isShortPreambleEnabled &= !(*erpInformation)->GetBarkerPreambleMode();
1654 if ((*erpInformation)->GetUseProtection() != 0)
1662 if (capabilities.IsShortSlotTime() ==
true)
1675 capabilities.IsShortSlotTime());
1682 bool qosSupported =
false;
1683 const auto& edcaParameters = frame.template Get<EdcaParameterSet>();
1684 if (edcaParameters.has_value())
1686 qosSupported =
true;
1690 edcaParameters->GetBeCWmin(),
1691 edcaParameters->GetBeCWmax(),
1692 edcaParameters->GetBeAifsn(),
1696 edcaParameters->GetBkCWmin(),
1697 edcaParameters->GetBkCWmax(),
1698 edcaParameters->GetBkAifsn(),
1702 edcaParameters->GetViCWmin(),
1703 edcaParameters->GetViCWmax(),
1704 edcaParameters->GetViAifsn(),
1708 edcaParameters->GetVoCWmin(),
1709 edcaParameters->GetVoCWmax(),
1710 edcaParameters->GetVoAifsn(),
1719 if (
const auto& htCapabilities = frame.template Get<HtCapabilities>();
1720 htCapabilities.has_value())
1737 const auto& vhtCapabilities = frame.template Get<VhtCapabilities>();
1740 if (vhtCapabilities.has_value() &&
1741 vhtCapabilities->GetRxHighestSupportedLgiDataRate() > 0)
1748 if (vhtCapabilities->IsSupportedRxMcs(mcs.GetMcsValue()))
1761 const auto& heCapabilities = frame.template Get<HeCapabilities>();
1762 if (heCapabilities.has_value() && heCapabilities->GetSupportedMcsAndNss() != 0)
1767 if (heCapabilities->IsSupportedRxMcs(mcs.GetMcsValue()))
1772 if (
const auto& heOperation = frame.template Get<HeOperation>();
1773 heOperation.has_value())
1781 const auto& muEdcaParameters = frame.template Get<MuEdcaParameterSet>();
1782 if (muEdcaParameters.has_value())
1785 muEdcaParameters->GetMuCwMin(
AC_BE),
1786 muEdcaParameters->GetMuCwMax(
AC_BE),
1787 muEdcaParameters->GetMuAifsn(
AC_BE),
1788 muEdcaParameters->GetMuEdcaTimer(
AC_BE)},
1791 muEdcaParameters->GetMuCwMin(
AC_BK),
1792 muEdcaParameters->GetMuCwMax(
AC_BK),
1793 muEdcaParameters->GetMuAifsn(
AC_BK),
1794 muEdcaParameters->GetMuEdcaTimer(
AC_BK)},
1797 muEdcaParameters->GetMuCwMin(
AC_VI),
1798 muEdcaParameters->GetMuCwMax(
AC_VI),
1799 muEdcaParameters->GetMuAifsn(
AC_VI),
1800 muEdcaParameters->GetMuEdcaTimer(
AC_VI)},
1803 muEdcaParameters->GetMuCwMin(
AC_VO),
1804 muEdcaParameters->GetMuCwMax(
AC_VO),
1805 muEdcaParameters->GetMuAifsn(
AC_VO),
1806 muEdcaParameters->GetMuEdcaTimer(
AC_VO)},
1812 if (
const auto& he6GhzCapabilities = frame.template Get<He6GhzBandCapabilities>())
1816 *he6GhzCapabilities);
1825 const auto& ehtCapabilities = frame.template Get<EhtCapabilities>();
1830 if (
const auto& mle = frame.template Get<MultiLinkElement>(); mle &&
m_emlsrManager)
1832 if (mle->HasEmlCapabilities())
1834 m_emlsrManager->SetTransitionTimeout(mle->GetTransitionTimeout());
1836 if (
const auto& common = mle->GetCommonInfoBasic(); common.m_mediumSyncDelayInfo)
1838 m_emlsrManager->SetMediumSyncDuration(common.GetMediumSyncDelayTimer());
1839 m_emlsrManager->SetMediumSyncOfdmEdThreshold(common.GetMediumSyncOfdmEdThreshold());
1840 m_emlsrManager->SetMediumSyncMaxNTxops(common.GetMediumSyncMaxNTxops());
1846 std::visit(commonOps, frame);
1852 const auto [enable, linkId] = enableLinkIdPair;
1859 NS_LOG_DEBUG(
"Not associated yet, record the PM mode to switch to upon association");
1866 NS_LOG_DEBUG(
"Link " << +linkId <<
" has not been setup, ignore request");
1887 NS_LOG_DEBUG(
"Next transmitted frame will be sent with PM=" << enable);
1906 m_txop->
Queue(Create<WifiMpdu>(Create<Packet>(), hdr));
1927 auto linkIds = mpdu->GetInFlightLinkIds();
1929 "The TA of the acked MPDU (" << *mpdu
1930 <<
") is not a link "
1931 "address and the MPDU is not inflight");
1936 linkId = *linkIds.begin();
1937 mpdu =
GetTxopQueue(mpdu->GetQueueAc())->GetAlias(mpdu, *linkId);
1940 auto& link =
GetLink(*linkId);
1958 for (
const auto& mode :
GetWifiPhy(linkId)->GetModeList())
1960 uint64_t modeDataRate = mode.GetDataRate(
GetWifiPhy(linkId)->GetChannelWidth());
1961 NS_LOG_DEBUG(
"Adding supported rate of " << modeDataRate);
1966 for (
const auto& selector :
GetWifiPhy(linkId)->GetBssMembershipSelectorList())
1981 return capabilities;
1994 edca->SetMinCw(params.cwMin, linkId);
1995 edca->SetMaxCw(params.cwMax, linkId);
1996 edca->SetAifsn(params.aifsn, linkId);
1997 edca->SetTxopLimit(params.txopLimit, linkId);
2004 edca->SetMuCwMin(params.cwMin, linkId);
2005 edca->SetMuCwMax(params.cwMax, linkId);
2006 edca->SetMuAifsn(params.aifsn, linkId);
2007 edca->SetMuEdcaTimer(params.muEdcaTimer, linkId);
2016 NS_LOG_DEBUG(
"PHY capabilities changed: send reassociation request");
2076 for (
auto& [
id, link] :
GetLinks())
2078 if (link->phy == phy &&
id != linkId)
2080 link->phy =
nullptr;
2085 auto connectPhy = [=,
this]()
mutable {
2086 auto& newLink =
GetLink(linkId);
2090 newLink.channelAccessManager->SetupPhyListener(phy);
2094 newLink.channelAccessManager->ResetState();
2097 newLink.feManager->ResetPhy();
2099 newLink.feManager->SetWifiPhy(phy);
2101 newLink.stationManager->SetupPhy(phy);
2136 os <<
"BSSID=" << apInfo.
m_bssid <<
", AP addr=" << apInfo.
m_apAddr <<
", SNR=" << apInfo.
m_snr
2138 <<
"}, Link ID=" << +apInfo.
m_linkId <<
", Frame=[";
2139 std::visit([&os](
auto&& frame) { frame.Print(os); }, apInfo.
m_frame);
A container for one type of attribute.
AttributeValue implementation for Boolean.
Base class for Callback class.
bool IsNull() const
Check for null implementation.
The IEEE 802.11be EHT Capabilities.
Hold variables of type enum.
void Cancel()
This method is syntactic sugar for the ns3::Simulator::Cancel method.
bool IsPending() const
This method is syntactic sugar for !IsExpired().
bool IsExpired() const
This method is syntactic sugar for the ns3::Simulator::IsExpired method.
The Extended Capabilities Information Element.
The Extended Supported Rates Information Element.
The HE 6 GHz Band Capabilities (IEEE 802.11ax-2021 9.4.2.263)
The IEEE 802.11ax HE Capabilities.
The HT Capabilities Information Element.
static Mac48Address ConvertFrom(const Address &address)
static Mac48Address GetBroadcast()
void SetLinkId(uint8_t linkId)
Set the Link ID subfield in the STA Control field.
void AddPerStaProfileSubelement()
Add a Per-STA Profile Subelement in the Link Info field.
void SetEmlsrSupported(bool supported)
Set the EMLSR Support subfield of the EML Capabilities subfield in the Common Info field to 1 if EMLS...
CommonInfoBasicMle & GetCommonInfoBasic()
void SetEmlsrTransitionDelay(Time delay)
Set the EMLSR Transition Delay subfield of the EML Capabilities subfield in the Common Info field.
PerStaProfileSubelement & GetPerStaProfile(std::size_t i)
Get a reference to the i-th Per-STA Profile Subelement in the Link Info field.
void SetEmlsrPaddingDelay(Time delay)
Set the EMLSR Padding Delay subfield of the EML Capabilities subfield in the Common Info field.
void SetMldMacAddress(Mac48Address address)
Set the MLD MAC Address subfield in the Common Info field.
std::size_t GetNPerStaProfileSubelements() const
Return the number of Per-STA Profile Subelement in the Link Info field.
bool TraceConnectWithoutContext(std::string name, const CallbackBase &cb)
Connect a TraceSource to a Callback without a context.
bool IsInitialized() const
Check if the object has been initialized.
AttributeValue implementation for Pair.
Smart pointer class similar to boost::intrusive_ptr.
virtual double GetValue()=0
Get the next random value drawn from the distribution.
void SetStream(int64_t stream)
Specifies the stream number for the RngStream.
static EventId Schedule(const Time &delay, FUNC f, Ts &&... args)
Schedule an event to expire after delay.
static Time Now()
Return the current simulation virtual time.
static Time GetDelayLeft(const EventId &id)
Get the remaining time until this event will execute.
Introspection did not find any typical Config paths.
double Get() const
Return the SNR value.
The IEEE 802.11 SSID Information Element.
The Wifi MAC high model for a non-AP STA in a BSS.
std::set< uint8_t > GetSetupLinkIds() const
Get the IDs of the setup links (if any).
void ScanningTimeout(const std::optional< ApInfo > &bestAp)
This method is called after wait beacon timeout or wait probe request timeout has occurred.
Time m_waitBeaconTimeout
wait beacon timeout
int64_t AssignStreams(int64_t stream) override
Assign a fixed random variable stream number to the random variables used by this model.
void SetPowerSaveMode(const std::pair< bool, uint8_t > &enableLinkIdPair)
Enable or disable Power Save mode on the given link.
Ptr< WifiAssocManager > m_assocManager
Association Manager.
void DoCompleteConfig() override
Allow subclasses to complete the configuration of the MAC layer components.
bool m_activeProbing
active probing
void DoInitialize() override
Initialize() implementation.
void SetAssocManager(Ptr< WifiAssocManager > assocManager)
Set the Association Manager.
bool CanForwardPacketsTo(Mac48Address to) const override
Return true if packets can be forwarded to the given destination, false otherwise.
std::unique_ptr< LinkEntity > CreateLinkEntity() const override
Create a LinkEntity object.
void SetState(MacState value)
Set the current MAC state.
Time m_beaconWatchdogEnd
beacon watchdog end
AllSupportedRates GetSupportedRates(uint8_t linkId) const
Return an instance of SupportedRates that contains all rates that we support including HT rates.
void SetEdcaParameters(const EdcaParams ¶ms, uint8_t linkId)
Set the EDCA parameters for the given link.
TracedCallback< Mac48Address > m_deAssocLogger
disassociation logger
MacState
The current MAC state of the STA.
void NotifyChannelSwitching(uint8_t linkId) override
Notify that channel on the given link has been switched.
bool GetActiveProbing() const
Return whether active probing is enabled.
EventId m_beaconWatchdog
beacon watchdog
void PhyCapabilitiesChanged()
Indicate that PHY capabilities have changed.
StaLinkEntity & GetStaLink(const std::unique_ptr< WifiMac::LinkEntity > &link) const
Cast the given LinkEntity object to StaLinkEntity.
void ReceiveProbeResp(Ptr< const WifiMpdu > mpdu, uint8_t linkId)
Process the Probe Response frame received on the given link.
void SetPmModeAfterAssociation(uint8_t linkId)
Set the Power Management mode of the setup links after association.
WifiScanParams::Channel GetCurrentChannel(uint8_t linkId) const
Get the current primary20 channel used on the given link as a (channel number, PHY band) pair.
uint16_t GetAssociationId() const
Return the association ID.
void TryToEnsureAssociated()
Try to ensure that we are associated with an AP by taking an appropriate action depending on the curr...
void ReceiveAssocResp(Ptr< const WifiMpdu > mpdu, uint8_t linkId)
Process the (Re)Association Response frame received on the given link.
void NotifySwitchingEmlsrLink(Ptr< WifiPhy > phy, uint8_t linkId, Time delay)
Notify that the given PHY switched channel to operate on another EMLSR link.
std::variant< MgtAssocRequestHeader, MgtReassocRequestHeader > GetAssociationRequest(bool isReassoc, uint8_t linkId) const
Get the (Re)Association Request frame to send on a given link.
static TypeId GetTypeId()
Get the type ID.
void DoDispose() override
Destructor implementation.
void SendProbeRequest(uint8_t linkId)
Enqueue a probe request packet for transmission on the given link.
void BlockTxOnLink(uint8_t linkId, WifiQueueBlockedReason reason)
Block transmissions on the given link for the given reason.
StaLinkEntity & GetLink(uint8_t linkId) const
Get a reference to the link associated with the given ID.
uint32_t m_maxMissedBeacons
maximum missed beacons
TracedCallback< uint8_t, Mac48Address > m_setupCompleted
link setup completed logger
TracedCallback< Mac48Address > m_assocLogger
association logger
void SetWifiPhys(const std::vector< Ptr< WifiPhy > > &phys) override
void SetMuEdcaParameters(const MuEdcaParams ¶ms, uint8_t linkId)
Set the MU EDCA parameters for the given link.
TracedCallback< uint8_t, Mac48Address > m_setupCanceled
link setup canceled logger
void NotifyEmlsrModeChanged(const std::set< uint8_t > &linkIds)
Notify the MAC that EMLSR mode has changed on the given set of links.
bool CheckSupportedRates(std::variant< MgtBeaconHeader, MgtProbeResponseHeader > frame, uint8_t linkId)
Determine whether the supported rates indicated in a given Beacon frame or Probe Response frame fit w...
Mac48Address DoGetLocalAddress(const Mac48Address &remoteAddr) const override
This method is called if this device is an MLD to determine the MAC address of the affiliated STA use...
void RestartBeaconWatchdog(Time delay)
Restarts the beacon timer.
void SetEmlsrManager(Ptr< EmlsrManager > emlsrManager)
Set the EMLSR Manager.
Time m_pmModeSwitchTimeout
PM mode switch timeout.
void Disassociated()
Set the state to unassociated and try to associate again.
Ptr< EmlsrManager > GetEmlsrManager() const
void TxOk(Ptr< const WifiMpdu > mpdu)
Notify that the MPDU we sent was successfully received by the receiver (i.e.
void Receive(Ptr< const WifiMpdu > mpdu, uint8_t linkId) override
This method acts as the MacRxMiddle receive callback and is invoked to notify us that a frame has bee...
WifiTidLinkMapping m_ulTidLinkMappingInAssocReq
store the UL TID-to-Link Mapping included in the Association Request frame
WifiPowerManagementMode GetPmMode(uint8_t linkId) const
Ptr< RandomVariableStream > m_probeDelay
RandomVariable used to randomize the time of the first Probe Response on each channel.
TracedCallback< ApInfo > m_beaconInfo
beacon info logger
void MissedBeacons()
This method is called after we have not received a beacon from the AP on any link.
uint16_t m_aid
Association AID.
MacState m_state
MAC state.
bool IsEmlsrLink(uint8_t linkId) const
void Enqueue(Ptr< Packet > packet, Mac48Address to) override
void StartScanning()
Start the scanning process which trigger active or passive scanning based on the active probing flag.
std::vector< TidToLinkMapping > GetTidToLinkMappingElements(WifiTidToLinkMappingNegSupport apNegSupport)
TracedCallback< Time > m_beaconArrival
beacon arrival logger
void UnblockTxOnLink(std::set< uint8_t > linkIds, WifiQueueBlockedReason reason)
Unblock transmissions on the given links for the given reason.
void AssocRequestTimeout()
This method is called after the association timeout occurred.
Ptr< EmlsrManager > m_emlsrManager
EMLSR Manager.
void UpdateApInfo(const MgtFrameType &frame, const Mac48Address &apAddr, const Mac48Address &bssid, uint8_t linkId)
Update associated AP's information from the given management frame (Beacon, Probe Response or Associa...
Time m_assocRequestTimeout
association request timeout
void ReceiveBeacon(Ptr< const WifiMpdu > mpdu, uint8_t linkId)
Process the Beacon frame received on the given link.
Time m_probeRequestTimeout
probe request timeout
void SetActiveProbing(bool enable)
Enable or disable active probing.
CapabilityInformation GetCapabilities(uint8_t linkId) const
Return the Capability information for the given link.
bool IsAssociated() const
Return whether we are associated with an AP.
std::variant< MgtBeaconHeader, MgtProbeResponseHeader, MgtAssocResponseHeader > MgtFrameType
type of the management frames used to get info about APs
bool IsWaitAssocResp() const
Return whether we are waiting for an association response from an AP.
MultiLinkElement GetMultiLinkElement(bool isReassoc, uint8_t linkId) const
Return the Multi-Link Element to include in the management frames transmitted on the given link.
EventId m_assocRequestEvent
association request event
void SendAssociationRequest(bool isReassoc)
Forward an association or reassociation request packet to the DCF.
WifiTidLinkMapping m_dlTidLinkMappingInAssocReq
store the DL TID-to-Link Mapping included in the Association Request frame
bool IsSuccess() const
Return whether the status code is success.
Hold variables of type string.
The Supported Rates Information Element.
TID-to-Link Mapping Information Element.
Simulation virtual time values and global simulation resolution.
TimeWithUnit As(const Unit unit=Time::AUTO) const
Attach a unit to a Time, to facilitate output in a specific unit.
AttributeValue implementation for Time.
static constexpr bool DIDNT_HAVE_FRAMES_TO_TRANSMIT
no packet available for transmission was in the queue
static constexpr bool CHECK_MEDIUM_BUSY
generation of backoff (also) depends on the busy/idle state of the medium
virtual void Queue(Ptr< Packet > packet, const WifiMacHeader &hdr)
a unique identifier for an interface.
@ ATTR_GET
The attribute can be read.
@ ATTR_SET
The attribute can be written.
TypeId SetParent(TypeId tid)
Set the parent TypeId.
@ OBSOLETE
Attribute or trace source is not used anymore; simulation fails.
Hold an unsigned integer type.
The IEEE 802.11ac VHT Capabilities.
base class for all MAC-level wifi objects.
Ptr< FrameExchangeManager > GetFrameExchangeManager(uint8_t linkId=SINGLE_LINK_OP_ID) const
Get the Frame Exchange Manager associated with the given link.
Ptr< QosTxop > GetBEQueue() const
Accessor for the AC_BE channel access function.
virtual void NotifyChannelSwitching(uint8_t linkId)
Notify that channel on the given link has been switched.
std::optional< Mac48Address > GetMldAddress(const Mac48Address &remoteAddr) const
Mac48Address GetBssid(uint8_t linkId) const
Ptr< HeConfiguration > GetHeConfiguration() const
const std::map< uint8_t, std::unique_ptr< LinkEntity > > & GetLinks() const
Ptr< Txop > GetTxop() const
Accessor for the Txop object.
VhtCapabilities GetVhtCapabilities(uint8_t linkId) const
Return the VHT capabilities of the device for the given link.
Callback< void > m_linkDown
Callback when a link is down.
bool GetQosSupported() const
Return whether the device supports QoS.
Ptr< Txop > m_txop
TXOP used for transmission of frames to non-QoS peers.
Ptr< WifiMacQueueScheduler > GetMacQueueScheduler() const
Get the wifi MAC queue scheduler.
uint8_t GetNLinks() const
Get the number of links (can be greater than 1 for 11be devices only).
void SwapLinks(std::map< uint8_t, uint8_t > links)
Swap the links based on the information included in the given map.
void DoInitialize() override
Initialize() implementation.
void UnblockUnicastTxOnLinks(WifiQueueBlockedReason reason, const Mac48Address &address, const std::set< uint8_t > &linkIds)
Unblock the transmission on the given links of all unicast frames addressed to the station with the g...
bool GetErpSupported(uint8_t linkId) const
Return whether the device supports ERP on the given link.
Ptr< QosTxop > GetVOQueue() const
Accessor for the AC_VO channel access function.
void SetTypeOfStation(TypeOfStation type)
This method is invoked by a subclass to specify what type of station it is implementing.
Ptr< WifiPhy > GetWifiPhy(uint8_t linkId=SINGLE_LINK_OP_ID) const
void BlockUnicastTxOnLinks(WifiQueueBlockedReason reason, const Mac48Address &address, const std::set< uint8_t > &linkIds)
Block the transmission on the given links of all unicast frames addressed to the station with the giv...
bool GetEhtSupported() const
Return whether the device supports EHT.
bool GetHeSupported() const
Return whether the device supports HE.
HtCapabilities GetHtCapabilities(uint8_t linkId) const
Return the HT capabilities of the device for the given link.
virtual std::optional< uint8_t > GetLinkIdByAddress(const Mac48Address &address) const
Get the ID of the link having the given MAC address, if any.
virtual bool HasFramesToTransmit(uint8_t linkId)
Check if the MAC has frames to transmit over the given link.
void ApplyTidLinkMapping(const Mac48Address &mldAddr, WifiDirection dir)
Apply the TID-to-Link Mapping negotiated with the given MLD for the given direction by properly confi...
Ptr< EhtConfiguration > GetEhtConfiguration() const
bool GetVhtSupported(uint8_t linkId) const
Return whether the device supports VHT on the given link.
virtual int64_t AssignStreams(int64_t stream)
Assign a fixed random variable stream number to the random variables used by this model.
virtual void DeaggregateAmsduAndForward(Ptr< const WifiMpdu > mpdu)
This method can be called to de-aggregate an A-MSDU and forward the constituent packets up the stack.
void SetBssid(Mac48Address bssid, uint8_t linkId)
Ptr< WifiNetDevice > GetDevice() const
Return the device this PHY is associated with.
void UpdateTidToLinkMapping(const Mac48Address &mldAddr, WifiDirection dir, const WifiTidLinkMapping &mapping)
Update the TID-to-Link Mappings for the given MLD in the given direction based on the given negotiate...
ExtendedCapabilities GetExtendedCapabilities() const
Return the extended capabilities of the device.
He6GhzBandCapabilities GetHe6GhzBandCapabilities(uint8_t linkId) const
Return the HE 6GHz band capabilities of the device for the given 6 GHz link.
virtual Ptr< WifiMacQueue > GetTxopQueue(AcIndex ac) const
Get the wifi MAC queue of the (Qos)Txop associated with the given AC, if such (Qos)Txop is installed,...
std::optional< uint8_t > GetLinkForPhy(Ptr< const WifiPhy > phy) const
Get the ID of the link (if any) on which the given PHY is operating.
bool GetShortSlotTimeSupported() const
void NotifyRxDrop(Ptr< const Packet > packet)
Ptr< WifiRemoteStationManager > GetWifiRemoteStationManager(uint8_t linkId=0) const
bool GetHtSupported(uint8_t linkId) const
Return whether the device supports HT on the given link.
void ForwardUp(Ptr< const Packet > packet, Mac48Address from, Mac48Address to)
Forward the packet up to the device.
bool Is6GhzBand(uint8_t linkId) const
Indicate if a given link is on the 6 GHz band.
virtual void Receive(Ptr< const WifiMpdu > mpdu, uint8_t linkId)
This method acts as the MacRxMiddle receive callback and is invoked to notify us that a frame has bee...
Mac48Address GetAddress() const
EhtCapabilities GetEhtCapabilities(uint8_t linkId) const
Return the EHT capabilities of the device for the given link.
Callback< void > m_linkUp
Callback when a link is up.
LinkEntity & GetLink(uint8_t linkId) const
Get a reference to the link associated with the given ID.
HeCapabilities GetHeCapabilities(uint8_t linkId) const
Return the HE capabilities of the device for the given link.
virtual void SetWifiPhys(const std::vector< Ptr< WifiPhy > > &phys)
Ptr< QosTxop > GetQosTxop(AcIndex ac) const
Accessor for a specified EDCA object.
void NotifyTxDrop(Ptr< const Packet > packet)
void DoDispose() override
Destructor implementation.
static Time CalculateTxDuration(uint32_t size, const WifiTxVector &txVector, WifiPhyBand band, uint16_t staId=SU_STA_ID)
void SetSlot(Time slot)
Set the slot duration for this PHY.
void SetOffMode()
Put in off mode.
This class mimics the TXVECTOR which is to be passed to the PHY in order to define the parameters whi...
#define NS_ASSERT(condition)
At runtime, in debugging builds, if this condition is not true, the program prints the source file,...
#define NS_ASSERT_MSG(condition, message)
At runtime, in debugging builds, if this condition is not true, the program prints the message to out...
Ptr< const AttributeAccessor > MakeBooleanAccessor(T1 a1)
Ptr< const AttributeChecker > MakeBooleanChecker()
Ptr< const AttributeAccessor > MakePointerAccessor(T1 a1)
Ptr< const AttributeChecker > MakeTimeChecker()
Helper to make an unbounded Time checker.
Ptr< const AttributeAccessor > MakeTimeAccessor(T1 a1)
Ptr< const AttributeAccessor > MakeUintegerAccessor(T1 a1)
#define NS_ABORT_MSG(msg)
Unconditional abnormal program termination with a message.
#define NS_ABORT_MSG_IF(cond, msg)
Abnormal program termination if a condition is true, with a message.
#define NS_ABORT_IF(cond)
Abnormal program termination if a condition is true.
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
#define NS_LOG_DEBUG(msg)
Use NS_LOG to output a message of level LOG_DEBUG.
#define NS_LOG_LOGIC(msg)
Use NS_LOG to output a message of level LOG_LOGIC.
#define NS_LOG_FUNCTION_NOARGS()
Output the name of the function.
#define NS_LOG_FUNCTION(parameters)
If log level LOG_FUNCTION is enabled, this macro will output all input parameters separated by ",...
#define NS_OBJECT_ENSURE_REGISTERED(type)
Register an Object subclass with the TypeId system.
Time MicroSeconds(uint64_t value)
Construct a Time in the indicated unit.
Time NanoSeconds(uint64_t value)
Construct a Time in the indicated unit.
Time Seconds(double value)
Construct a Time in the indicated unit.
Time MilliSeconds(uint64_t value)
Construct a Time in the indicated unit.
Ptr< const TraceSourceAccessor > MakeTraceSourceAccessor(T a)
Create a TraceSourceAccessor which will control access to the underlying trace source.
WifiPowerManagementMode
Enumeration for power management modes.
uint8_t QosUtilsGetTidForPacket(Ptr< const Packet > packet)
If a QoS tag is attached to the packet, returns a value < 8.
WifiQueueBlockedReason
Enumeration of the reasons to block container queues.
@ WIFI_PM_SWITCHING_TO_ACTIVE
@ WIFI_PM_SWITCHING_TO_PS
@ WIFI_PHY_BAND_UNSPECIFIED
Unspecified.
@ WIFI_MOD_CLASS_VHT
VHT (Clause 22)
@ WIFI_MOD_CLASS_HE
HE (Clause 27)
Every class exported by the ns3 library is enclosed in the ns3 namespace.
std::unordered_map< uint16_t, Ptr< const WifiPsdu > > WifiConstPsduMap
Map of const PSDUs indexed by STA-ID.
Callback< R, Args... > MakeCallback(R(T::*memPtr)(Args...), OBJ objPtr)
Build Callbacks for class method members which take varying numbers of arguments and potentially retu...
WifiTidToLinkMappingNegSupport
TID-to-Link Mapping Negotiation Support.
std::ostream & operator<<(std::ostream &os, const Angles &a)
const std::map< AcIndex, WifiAc > wifiAcList
Map containing the four ACs in increasing order of priority (according to Table 10-1 "UP-to-AC Mappin...
@ WIFI_MAC_MGT_PROBE_REQUEST
@ WIFI_MAC_MGT_ASSOCIATION_RESPONSE
@ WIFI_MAC_MGT_ASSOCIATION_REQUEST
@ WIFI_MAC_MGT_REASSOCIATION_REQUEST
@ WIFI_MAC_MGT_PROBE_RESPONSE
@ WIFI_MAC_MGT_REASSOCIATION_RESPONSE
bool TidToLinkMappingValidForNegType1(const WifiTidLinkMapping &dlLinkMapping, const WifiTidLinkMapping &ulLinkMapping)
Check if the given TID-to-Link Mappings are valid for a negotiation type of 1.
@ LOG_FUNCTION
Function tracing for non-trivial function calls.
Struct containing all supported rates.
void AddBssMembershipSelectorRate(uint64_t bs)
Add a special value to the supported rate set, corresponding to a BSS membership selector.
void AddSupportedRate(uint64_t bs)
Add the given rate to the supported rates.
std::optional< MldCapabilities > m_mldCapabilities
MLD Capabilities.
Struct to hold information regarding observed AP through active/passive scanning.
MgtFrameType m_frame
The body of the management frame used to update AP info.
WifiScanParams::Channel m_channel
The channel the management frame was received on.
Mac48Address m_apAddr
AP MAC address.
uint8_t m_linkId
ID of the link used to communicate with the AP.
Mac48Address m_bssid
BSSID.
double m_snr
SNR in linear scale.
Structure holding information specific to a single link.
bool sendAssocReq
whether this link is used to send the Association Request frame
std::optional< Mac48Address > bssid
BSSID of the AP to associate with over this link.
bool emlsrEnabled
whether EMLSR mode is enabled on this link
WifiPowerManagementMode pmMode
the current PM mode, if the STA is associated, or the PM mode to switch to upon association,...
~StaLinkEntity() override
Destructor (a virtual method is needed to make this struct polymorphic)
Ptr< WifiPhy > phy
Wifi PHY object.
Struct identifying a channel to scan.
WifiPhyBand band
PHY band.
uint16_t number
channel number
Structure holding scan parameters.
std::list< Channel > ChannelList
typedef for a list of channels
std::vector< ChannelList > channelList
list of channels to scan, for each link
Time probeDelay
delay prior to transmitting a Probe Request
WifiScanType type
indicates either active or passive scanning
Time maxChannelTime
maximum time to spend on each channel
Ssid ssid
desired SSID or wildcard SSID
Time minChannelTime
minimum time to spend on each channel