16#include "ns3/wifi-acknowledgment.h"
17#include "ns3/wifi-mac-queue.h"
18#include "ns3/wifi-protection.h"
19#include "ns3/wifi-psdu.h"
35 TypeId(
"ns3::RrMultiUserScheduler")
39 .AddAttribute(
"NStations",
40 "The maximum number of stations that can be granted an RU in a DL MU "
45 .AddAttribute(
"EnableTxopSharing",
46 "If enabled, allow A-MPDUs of different TIDs in a DL MU PPDU.",
50 .AddAttribute(
"ForceDlOfdma",
51 "If enabled, return DL_MU_TX even if no DL MU PPDU could be built.",
55 .AddAttribute(
"EnableUlOfdma",
56 "If enabled, return UL_MU_TX if DL_MU_TX was returned the previous time.",
60 .AddAttribute(
"EnableBsrp",
61 "If enabled, send a BSRP Trigger Frame before an UL MU transmission.",
67 "The default size in bytes of the solicited PSDU (to be sent in a TB PPDU)",
71 .AddAttribute(
"UseCentral26TonesRus",
72 "If enabled, central 26-tone RUs are allocated, too, when the "
73 "selected RU type is at least 52 tones.",
79 "Maximum amount of credits a station can have. When transmitting a DL MU PPDU, "
80 "the amount of credits received by each station equals the TX duration (in "
81 "microseconds) divided by the total number of stations. Stations that are the "
82 "recipient of the DL MU PPDU have to pay a number of credits equal to the TX "
83 "duration (in microseconds) times the allocated bandwidth share",
105 m_apMac->TraceConnectWithoutContext(
108 m_apMac->TraceConnectWithoutContext(
126 m_apMac->TraceDisconnectWithoutContext(
129 m_apMac->TraceDisconnectWithoutContext(
142 if (mpdu && !
m_apMac->GetHeSupported(mpdu->GetHeader().GetAddr1()))
179 std::size_t nCentral26TonesRus;
185 nCentral26TonesRus = 0;
195 txVector.
SetBssColor(heConfiguration->GetBssColor());
203 std::min<std::size_t>(
m_nStations, count + nCentral26TonesRus))
205 NS_LOG_DEBUG(
"Next candidate STA (MAC=" << staIt->address <<
", AID=" << staIt->aid <<
")");
207 if (!canBeSolicited(*staIt))
209 NS_LOG_DEBUG(
"Skipping station based on provided function object");
215 !
m_apMac->GetEhtSupported(staIt->address))
218 "Skipping non-EHT STA because this Trigger Frame is only soliciting EHT STAs");
228 if (
m_apMac->GetBaAgreementEstablishedAsRecipient(staIt->address, tid))
236 NS_LOG_DEBUG(
"No Block Ack agreement established with " << staIt->address);
244 if (
m_apMac->GetEhtSupported() &&
m_apMac->GetEhtSupported(staIt->address))
256 ->GetAffiliatedStaAddress(staIt->address)
257 .value_or(staIt->address));
263 suTxVector.GetMode().GetMcsValue(),
264 suTxVector.GetNss()});
301 for (uint8_t tid = 0; tid < 8; ++tid)
319 {WIFI_QOSDATA_QUEUE, WIFI_UNICAST, *mldAddr, 0},
323 {WIFI_QOSDATA_QUEUE, WIFI_UNICAST, *mldAddr, 0},
327 NS_LOG_INFO(
"EMLSR client " << *mldAddr <<
" is using another link");
341 NS_LOG_DEBUG(
"No HE stations associated: return SU_TX");
348 if (txVector.GetHeMuUserInfoMap().empty())
371 NS_LOG_DEBUG(
"Remaining TXOP duration is not enough for BSRP TF exchange");
382 userInfo.GetAid12());
383 qosNullTxDuration =
Max(qosNullTxDuration, duration);
399 NS_LOG_DEBUG(
"Remaining TXOP duration is not enough for BSRP TF exchange");
435 NS_LOG_DEBUG(
"No HE stations associated: return SU_TX");
445 if (txVector.GetHeMuUserInfoMap().empty())
453 for (
const auto& candidate : txVector.GetHeMuUserInfoMap())
455 auto address =
m_apMac->GetMldOrLinkAddressByAid(candidate.first);
456 NS_ASSERT_MSG(address,
"AID " << candidate.first <<
" not found");
461 NS_LOG_DEBUG(
"Buffer status of station " << *address <<
" is unknown");
466 NS_LOG_DEBUG(
"Buffer status of station " << *address <<
" is not limited");
467 maxBufferSize = 0xffffffff;
476 if (maxBufferSize == 0)
502 NS_LOG_DEBUG(
"Remaining TXOP duration is not enough for UL MU exchange");
514 maxDuration =
Min(maxDuration,
520 NS_LOG_DEBUG(
"Remaining TXOP duration is not enough for UL MU exchange");
532 userInfo.GetAid12());
533 bufferTxTime =
Max(bufferTxTime, duration);
536 if (bufferTxTime < maxDuration)
539 maxDuration = bufferTxTime;
552 userInfo.GetAid12());
553 minDuration = (minDuration.
IsZero() ? duration :
Min(minDuration, duration));
556 if (maxDuration < minDuration)
568 std::tie(ulLength, maxDuration) =
590 if (!
m_apMac->GetHeSupported(address))
595 auto mldOrLinkAddress =
m_apMac->GetMldOrLinkAddressByAid(aid);
596 NS_ASSERT_MSG(mldOrLinkAddress,
"AID " << aid <<
" not found");
602 const auto staIt = std::find_if(staList.second.cbegin(),
603 staList.second.cend(),
604 [aid](
auto&& info) { return info.aid == aid; });
605 if (staIt == staList.second.cend())
607 staList.second.push_back(
MasterInfo{aid, *mldOrLinkAddress, 0.0});
612 return info.aid == aid;
625 if (!
m_apMac->GetHeSupported(address))
630 auto mldOrLinkAddress =
m_apMac->GetMldOrLinkAddressByAid(aid);
631 NS_ASSERT_MSG(mldOrLinkAddress,
"AID " << aid <<
" not found");
633 if (
m_apMac->IsAssociated(*mldOrLinkAddress))
641 staList.second.remove_if([&aid](
const MasterInfo& info) {
return info.
aid == aid; });
655 NS_LOG_DEBUG(
"No HE stations associated: return SU_TX");
661 std::size_t nCentral26TonesRus;
668 nCentral26TonesRus = 0;
671 uint8_t currTid =
wifiAcList.at(primaryAc).GetHighTid();
675 if (mpdu && mpdu->GetHeader().IsQosData())
677 currTid = mpdu->GetHeader().GetQosTid();
681 std::vector<uint8_t> tids;
687 uint8_t firstTid = (acIt->first == primaryAc ? currTid : acIt->second.GetHighTid());
688 tids.push_back(firstTid);
689 tids.push_back(acIt->second.GetOtherTid(firstTid));
694 tids.push_back(currTid);
716 std::vector<uint8_t> ruAllocations;
718 ruAllocations.resize(numRuAllocs);
723 std::min(
static_cast<std::size_t
>(
m_nStations), count + nCentral26TonesRus))
725 NS_LOG_DEBUG(
"Next candidate STA (MAC=" << staIt->address <<
", AID=" << staIt->aid <<
")");
728 !
m_apMac->GetEhtSupported(staIt->address))
730 NS_LOG_DEBUG(
"Skipping non-EHT STA because this DL MU PPDU is sent to EHT STAs only");
738 for (uint8_t tid : tids)
744 if (
m_apMac->GetBaAgreementEstablishedAsOriginator(staIt->address, tid))
746 mpdu =
m_apMac->GetQosTxop(ac)->PeekNextMpdu(
m_linkId, tid, staIt->address);
772 {{currRuType, 1, true},
778 NS_LOG_DEBUG(
"Adding the peeked frame violates the time constraints");
784 NS_LOG_DEBUG(
"Adding candidate STA (MAC=" << staIt->address
785 <<
", AID=" << staIt->aid
786 <<
") TID=" << +tid);
793 NS_LOG_DEBUG(
"No frames to send to " << staIt->address <<
" with TID=" << +tid);
802 if (m_candidates.empty())
806 NS_LOG_DEBUG(
"The AP does not have suitable frames to transmit: return NO_TX");
809 NS_LOG_DEBUG(
"The AP does not have suitable frames to transmit: return SU_TX");
813 return TxFormat::DL_MU_TX;
825 std::size_t nRusAssigned = m_candidates.size();
826 std::size_t nCentral26TonesRus;
828 HeRu::GetEqualSizedRusForStations(m_allowedWidth, nRusAssigned, nCentral26TonesRus);
830 NS_LOG_DEBUG(nRusAssigned <<
" stations are being assigned a " << ruType <<
" RU");
832 if (!m_useCentral26TonesRus || m_candidates.size() == nRusAssigned)
834 nCentral26TonesRus = 0;
838 nCentral26TonesRus = std::min(m_candidates.size() - nRusAssigned, nCentral26TonesRus);
839 NS_LOG_DEBUG(nCentral26TonesRus <<
" stations are being assigned a 26-tones RU");
846 auto candidateIt = m_candidates.begin();
847 auto ruSet = HeRu::GetRusOfType(m_allowedWidth, ruType);
848 auto ruSetIt = ruSet.begin();
849 auto central26TonesRus = HeRu::GetCentral26TonesRus(m_allowedWidth, ruType);
850 auto central26TonesRusIt = central26TonesRus.begin();
852 for (std::size_t i = 0; i < nRusAssigned + nCentral26TonesRus; i++)
854 NS_ASSERT(candidateIt != m_candidates.end());
855 auto mapIt = heMuUserInfoMap.find(candidateIt->first->aid);
856 NS_ASSERT(mapIt != heMuUserInfoMap.end());
859 {(i < nRusAssigned ? *ruSetIt++ : *central26TonesRusIt++),
866 m_candidates.erase(candidateIt, m_candidates.end());
870RrMultiUserScheduler::UpdateCredits(std::list<MasterInfo>& staList,
877 std::map<HeRu::RuType, std::size_t> ruMap;
880 ruMap.insert({userInfo.second.ru.GetRuType(), 0}).
first->second++;
885 double creditsPerSta = txDuration.
ToDouble(Time::US) / staList.size();
888 double debitsPerMhz =
890 std::accumulate(ruMap.begin(), ruMap.end(), 0, [](uint16_t sum,
auto pair) {
891 return sum + pair.second * HeRu::GetBandwidth(pair.first);
895 for (
auto& sta : staList)
897 sta.credits += creditsPerSta;
898 sta.credits = std::min(sta.credits, m_maxCredits.ToDouble(Time::US));
902 for (
auto& candidate : m_candidates)
907 candidate.first->credits -= debitsPerMhz * HeRu::GetBandwidth(mapIt->second.ru.GetRuType());
915RrMultiUserScheduler::ComputeDlMuInfo()
919 if (m_candidates.empty())
932 Time actualAvailableTime = (m_initialFrame ? Time::Min() : m_availableTime);
934 for (
const auto& candidate : m_candidates)
936 mpdu = candidate.second;
939 bool ret [[maybe_unused]] =
940 GetHeFem(m_linkId)->TryAddMpdu(mpdu, dlMuInfo.
txParams, actualAvailableTime);
942 "Weird that an MPDU does not meet constraints when "
943 "transmitted over a larger RU");
949 for (
const auto& candidate : m_candidates)
952 mpdu = candidate.second;
954 uint8_t tid = mpdu->GetHeader().GetQosTid();
955 NS_ASSERT_MSG(mpdu->GetOriginal()->GetHeader().GetAddr1() == candidate.first->address,
956 "RA of the stored MPDU must match the stored address");
961 if (!mpdu->GetHeader().IsRetry())
965 item = GetHeFem(m_linkId)->GetMsduAggregator()->GetNextAmsdu(mpdu,
978 std::vector<Ptr<WifiMpdu>> mpduList =
979 GetHeFem(m_linkId)->GetMpduAggregator()->GetNextAmpdu(item,
983 if (mpduList.size() > 1)
986 dlMuInfo.
psduMap[candidate.first->aid] = Create<WifiPsdu>(std::move(mpduList));
990 dlMuInfo.
psduMap[candidate.first->aid] = Create<WifiPsdu>(item,
true);
995 AcIndex primaryAc = m_edca->GetAccessCategory();
996 UpdateCredits(m_staListDl[primaryAc],
1000 NS_LOG_DEBUG(
"Next station to serve has AID=" << m_staListDl[primaryAc].front().aid);
1006RrMultiUserScheduler::ComputeUlMuInfo()
1008 return UlMuInfo{m_trigger, m_triggerMacHdr, std::move(m_txParams)};
static std::pair< uint16_t, Time > ConvertHeTbPpduDurationToLSigLength(Time ppduDuration, const WifiTxVector &txVector, WifiPhyBand band)
Compute the L-SIG length value corresponding to the given HE TB PPDU duration.
static RuType GetEqualSizedRusForStations(MHz_u bandwidth, std::size_t &nStations, std::size_t &nCentral26TonesRus)
Given the channel bandwidth and the number of stations candidate for being assigned an RU,...
RuType
The different HE Resource Unit (RU) types.
MultiUserScheduler is an abstract base class defining the API that APs supporting at least VHT can us...
bool m_initialFrame
true if a TXOP is being started
void DoInitialize() override
Initialize() implementation.
TxFormat GetLastTxFormat(uint8_t linkId)
Get the format of the last transmission on the given link, as determined by the last call to NotifyAc...
Ptr< ApWifiMac > m_apMac
the AP wifi MAC
Time m_availableTime
the time available for frame exchange
Ptr< WifiRemoteStationManager > GetWifiRemoteStationManager(uint8_t linkId) const
Get the station manager attached to the AP on the given link.
uint8_t m_linkId
the ID of the link over which channel access has been granted
uint32_t GetMaxSizeOfQosNullAmpdu(const CtrlTriggerHeader &trigger) const
Get the maximum size in bytes among the A-MPDUs containing QoS Null frames and solicited by the given...
Ptr< QosTxop > m_edca
the AC that gained channel access
void DoDispose() override
Destructor implementation.
Ptr< WifiMpdu > GetTriggerFrame(const CtrlTriggerHeader &trigger, uint8_t linkId) const
Get an MPDU containing the given Trigger Frame.
MHz_u m_allowedWidth
the allowed width for the current transmission
Ptr< HeFrameExchangeManager > GetHeFem(uint8_t linkId) const
Get the HE Frame Exchange Manager attached to the AP on the given link.
TxFormat
Enumeration of the possible transmission formats.
Smart pointer class similar to boost::intrusive_ptr.
Ptr< WifiMpdu > PeekNextMpdu(uint8_t linkId, uint8_t tid=8, Mac48Address recipient=Mac48Address::GetBroadcast(), Ptr< const WifiMpdu > mpdu=nullptr)
Peek the next frame to transmit on the given link to the given receiver and of the given TID from the...
AcIndex GetAccessCategory() const
Get the access category of this object.
RrMultiUserScheduler is a simple OFDMA scheduler that indicates to perform a DL OFDMA transmission if...
TxFormat SelectTxFormat() override
Select the format of the next transmission.
bool m_enableBsrp
send a BSRP before an UL MU transmission
void NotifyStationAssociated(uint16_t aid, Mac48Address address)
Notify the scheduler that a station associated with the AP.
static TypeId GetTypeId()
Get the type ID.
~RrMultiUserScheduler() override
uint32_t m_ulPsduSize
the size in byte of the solicited PSDU
std::list< CandidateInfo > m_candidates
Candidate stations for MU TX.
bool m_useCentral26TonesRus
whether to allocate central 26-tone RUs
bool m_forceDlOfdma
return DL_OFDMA even if no DL MU PPDU was built
bool m_enableUlOfdma
enable the scheduler to also return UL_OFDMA
void DoInitialize() override
Initialize() implementation.
void DoDispose() override
Destructor implementation.
void UpdateCredits(std::list< MasterInfo > &staList, Time txDuration, const WifiTxVector &txVector)
Update credits of the stations in the given list considering that a PPDU having the given duration is...
WifiMacHeader m_triggerMacHdr
MAC header for Trigger Frame.
uint8_t m_nStations
Number of stations/slots to fill.
WifiTxParameters m_txParams
TX parameters.
virtual TxFormat TrySendingDlMuPpdu()
Check if it is possible to send a DL MU PPDU given the current time limits.
void NotifyStationDeassociated(uint16_t aid, Mac48Address address)
Notify the scheduler that a station deassociated with the AP.
Time m_maxCredits
Max amount of credits a station can have.
virtual WifiTxVector GetTxVectorForUlMu(std::function< bool(const MasterInfo &)> canBeSolicited)
Compute a TXVECTOR that can be used to construct a Trigger Frame to solicit transmissions from suitab...
bool m_enableTxopSharing
allow A-MPDUs of different TIDs in a DL MU PPDU
CtrlTriggerHeader m_trigger
Trigger Frame to send.
std::map< AcIndex, std::list< MasterInfo > > m_staListDl
Per-AC list of stations (next to serve for DL first)
virtual bool CanSolicitStaInBasicTf(const MasterInfo &info) const
Determine whether the given STA can be solicited via a Basic Trigger Frame.
virtual TxFormat TrySendingBsrpTf()
Check if it is possible to send a BSRP Trigger Frame given the current time limits.
virtual bool CanSolicitStaInBsrpTf(const MasterInfo &info) const
Determine whether the given STA can be solicited via a BSRP Trigger Frame.
virtual TxFormat TrySendingBasicTf()
Check if it is possible to send a Basic Trigger Frame given the current time limits.
void FinalizeTxVector(WifiTxVector &txVector)
Finalize the given TXVECTOR by only including the largest subset of the current set of candidate stat...
std::list< MasterInfo > m_staListUl
List of stations to serve for UL.
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.
bool IsNegative() const
Exactly equivalent to t <= 0.
static Time Min()
Minimum representable Time Not to be confused with Min(Time,Time).
double ToDouble(Unit unit) const
Get the Time value expressed in a particular unit.
bool IsZero() const
Exactly equivalent to t == 0.
a unique identifier for an interface.
TypeId SetParent(TypeId tid)
Set the parent TypeId.
Hold an unsigned integer type.
uint8_t GetMcsValue() const
static Time CalculateTxDuration(uint32_t size, const WifiTxVector &txVector, WifiPhyBand band, uint16_t staId=SU_STA_ID)
std::optional< Time > m_txDuration
TX duration of the frame.
std::unique_ptr< WifiProtection > m_protection
protection method
std::unique_ptr< WifiAcknowledgment > m_acknowledgment
acknowledgment method
WifiTxVector m_txVector
TXVECTOR of the frame being prepared.
void Clear()
Reset the TX parameters.
This class mimics the TXVECTOR which is to be passed to the PHY in order to define the parameters whi...
void SetEhtPpduType(uint8_t type)
Set the EHT_PPDU_TYPE parameter.
void SetGuardInterval(Time guardInterval)
Sets the guard interval duration (in nanoseconds)
std::map< uint16_t, HeMuUserInfo > HeMuUserInfoMap
map of HE MU specific user info parameters indexed by STA-ID
WifiMode GetMode(uint16_t staId=SU_STA_ID) const
If this TX vector is associated with an SU PPDU, return the selected payload transmission mode.
void SetHeMuUserInfo(uint16_t staId, HeMuUserInfo userInfo)
Set the HE MU user-specific transmission information for the given STA-ID.
WifiPreamble GetPreambleType() const
void SetChannelWidth(MHz_u channelWidth)
Sets the selected channelWidth.
const HeMuUserInfoMap & GetHeMuUserInfoMap() const
Get a const reference to the map HE MU user-specific transmission information indexed by STA-ID.
uint8_t GetNss(uint16_t staId=SU_STA_ID) const
If this TX vector is associated with an SU PPDU, return the number of spatial streams.
MHz_u GetChannelWidth() const
void SetBssColor(uint8_t color)
Set the BSS color.
void SetPreambleType(WifiPreamble preamble)
Sets the preamble type.
#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...
#define NS_ABORT_MSG_IF(cond, msg)
Abnormal program termination if a condition is true, with a message.
#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_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_LOG_INFO(msg)
Use NS_LOG to output a message of level LOG_INFO.
#define NS_OBJECT_ENSURE_REGISTERED(type)
Register an Object subclass with the TypeId system.
Time Seconds(double value)
Construct a Time in the indicated unit.
AcIndex QosUtilsMapTidToAc(uint8_t tid)
Maps TID (Traffic ID) to Access classes.
AcIndex
This enumeration defines the Access Categories as an enumeration with values corresponding to the AC ...
@ WAITING_EMLSR_TRANSITION_DELAY
Declaration of ns3::HePhy class and ns3::HeSigAParameters struct.
Every class exported by the ns3 library is enclosed in the ns3 namespace.
Time GetPpduMaxTime(WifiPreamble preamble)
Get the maximum PPDU duration (see Section 10.14 of 802.11-2016) for the PHY layers defining the aPPD...
Ptr< const AttributeChecker > MakeBooleanChecker()
Ptr< const AttributeChecker > MakeUintegerChecker()
Ptr< const AttributeAccessor > MakeTimeAccessor(T1 a1)
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...
Ptr< const AttributeAccessor > MakeUintegerAccessor(T1 a1)
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...
Ptr< const AttributeAccessor > MakeBooleanAccessor(T1 a1)
Ptr< const AttributeChecker > MakeTimeChecker()
Helper to make an unbounded Time checker.
Information to be provided in case of DL MU transmission.
WifiTxParameters txParams
the transmission parameters
WifiPsduMap psduMap
the DL MU PPDU to transmit
Information to be provided in case of UL MU transmission.
Information used to sort stations.
Mac48Address address
station's MAC Address
double credits
credits accumulated by the station
uint16_t aid
station's AID