Manage a set of ns3::Txop. More...
#include "channel-access-manager.h"
Classes | |
struct | EmlsrLinkSwitchInfo |
Information associated with each PHY that is going to operate on another EMLSR link. More... | |
struct | Timespan |
Structure defining start time and end time for a given state. More... | |
Public Member Functions | |
ChannelAccessManager () | |
~ChannelAccessManager () override | |
void | Add (Ptr< Txop > txop) |
void | DeactivatePhyListener (Ptr< WifiPhy > phy) |
Deactivate current registered listener for PHY events on the given PHY. | |
void | DisableEdcaFor (Ptr< Txop > qosTxop, Time duration) |
Time | GetAccessGrantStart (bool ignoreNav=false) const |
Access will never be granted to the medium before the time returned by this method. | |
Time | GetBackoffEndFor (Ptr< Txop > txop) const |
Return the time when the backoff procedure ended (or will end) for the given Txop. | |
Time | GetBackoffStartFor (Ptr< Txop > txop) const |
Return the time when the backoff procedure started for the given Txop. | |
bool | GetGenerateBackoffOnNoTx () const |
MHz_u | GetLargestIdlePrimaryChannel (Time interval, Time end) |
Return the width of the largest primary channel that has been idle for the given time interval before the given time, if any primary channel has been idle, or zero, otherwise. | |
bool | GetPer20MHzBusy (const std::set< uint8_t > &indices) const |
bool | IsBusy () const |
Check if the device is busy sending or receiving, or NAV or CCA busy. | |
bool | NeedBackoffUponAccess (Ptr< Txop > txop, bool hadFramesToTransmit, bool checkMediumBusy) |
Determine if a new backoff needs to be generated as per letter a) of Section 10.23.2.2 of IEEE 802.11-2020 ("EDCA backoff procedure"). | |
void | NotifyAckTimeoutResetNow () |
Notify that ack timer has reset. | |
void | NotifyAckTimeoutStartNow (Time duration) |
Notify that ack timer has started for the given duration. | |
void | NotifyCcaBusyStartNow (Time duration, WifiChannelListType channelType, const std::vector< Time > &per20MhzDurations) |
void | NotifyCtsTimeoutResetNow () |
Notify that CTS timer has reset. | |
void | NotifyCtsTimeoutStartNow (Time duration) |
Notify that CTS timer has started for the given duration. | |
void | NotifyNavResetNow (Time duration) |
void | NotifyNavStartNow (Time duration) |
void | NotifyOffNow () |
Notify the Txop that the device has been put in off mode. | |
void | NotifyOnNow () |
Notify the Txop that the device has been resumed from off mode. | |
void | NotifyRxEndErrorNow () |
Notify the Txop that a packet reception was just completed unsuccessfuly. | |
void | NotifyRxEndOkNow () |
Notify the Txop that a packet reception was just completed successfully. | |
void | NotifyRxStartNow (Time duration) |
void | NotifySleepNow () |
Notify the Txop that the device has been put in sleep mode. | |
void | NotifySwitchingEmlsrLink (Ptr< WifiPhy > phy, const WifiPhyOperatingChannel &channel, uint8_t linkId) |
Notify that the given PHY is about to switch to the given operating channel, which is used by the given link. | |
void | NotifySwitchingStartNow (PhyListener *phyListener, Time duration) |
void | NotifyTxStartNow (Time duration) |
void | NotifyWakeupNow () |
Notify the Txop that the device has been resumed from sleep mode. | |
void | RemovePhyListener (Ptr< WifiPhy > phy) |
Remove current registered listener for PHY events on the given PHY. | |
void | RequestAccess (Ptr< Txop > txop) |
void | ResetAllBackoffs () |
Reset the backoff for all the DCF/EDCAF. | |
void | ResetBackoff (Ptr< Txop > txop) |
Reset the backoff for the given DCF/EDCAF. | |
void | ResetState () |
Reset the state variables of this channel access manager. | |
void | SetGenerateBackoffOnNoTx (bool enable) |
Set the member variable indicating whether the backoff should be invoked when an AC gains the right to start a TXOP but it does not transmit any frame (e.g., due to constraints associated with EMLSR operations), provided that the queue is not actually empty. | |
void | SetLinkId (uint8_t linkId) |
Set the ID of the link this Channel Access Manager is associated with. | |
void | SetupFrameExchangeManager (Ptr< FrameExchangeManager > feManager) |
Set up the Frame Exchange Manager. | |
void | SetupPhyListener (Ptr< WifiPhy > phy) |
Set up (or reactivate) listener for PHY events on the given PHY. | |
Public Member Functions inherited from ns3::Object | |
Object () | |
Constructor. | |
~Object () override | |
Destructor. | |
void | AggregateObject (Ptr< Object > other) |
Aggregate two Objects together. | |
void | Dispose () |
Dispose of this Object. | |
AggregateIterator | GetAggregateIterator () const |
Get an iterator to the Objects aggregated to this one. | |
TypeId | GetInstanceTypeId () const override |
Get the most derived TypeId for this Object. | |
template<typename T > | |
Ptr< T > | GetObject () const |
Get a pointer to the requested aggregated Object. | |
template<> | |
Ptr< Object > | GetObject () const |
Specialization of () for objects of type ns3::Object. | |
template<typename T > | |
Ptr< T > | GetObject (TypeId tid) const |
Get a pointer to the requested aggregated Object by TypeId. | |
template<> | |
Ptr< Object > | GetObject (TypeId tid) const |
Specialization of (TypeId tid) for objects of type ns3::Object. | |
void | Initialize () |
Invoke DoInitialize on all Objects aggregated to this one. | |
bool | IsInitialized () const |
Check if the object has been initialized. | |
void | UnidirectionalAggregateObject (Ptr< Object > other) |
Aggregate an Object to another Object. | |
Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter > | |
SimpleRefCount () | |
Default constructor. | |
SimpleRefCount (const SimpleRefCount &o) | |
Copy constructor. | |
uint32_t | GetReferenceCount () const |
Get the reference count of the object. | |
SimpleRefCount & | operator= (const SimpleRefCount &o) |
Assignment operator. | |
void | Ref () const |
Increment the reference count. | |
void | Unref () const |
Decrement the reference count. | |
Public Member Functions inherited from ns3::ObjectBase | |
virtual | ~ObjectBase () |
Virtual destructor. | |
void | GetAttribute (std::string name, AttributeValue &value, bool permissive=false) const |
Get the value of an attribute, raising fatal errors if unsuccessful. | |
bool | GetAttributeFailSafe (std::string name, AttributeValue &value) const |
Get the value of an attribute without raising errors. | |
void | SetAttribute (std::string name, const AttributeValue &value) |
Set a single attribute, raising fatal errors if unsuccessful. | |
bool | SetAttributeFailSafe (std::string name, const AttributeValue &value) |
Set a single attribute without raising errors. | |
bool | TraceConnect (std::string name, std::string context, const CallbackBase &cb) |
Connect a TraceSource to a Callback with a context. | |
bool | TraceConnectWithoutContext (std::string name, const CallbackBase &cb) |
Connect a TraceSource to a Callback without a context. | |
bool | TraceDisconnect (std::string name, std::string context, const CallbackBase &cb) |
Disconnect from a TraceSource a Callback previously connected with a context. | |
bool | TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb) |
Disconnect from a TraceSource a Callback previously connected without a context. | |
Static Public Member Functions | |
static TypeId | GetTypeId () |
Get the type ID. | |
Static Public Member Functions inherited from ns3::Object | |
static TypeId | GetTypeId () |
Register this type. | |
Static Public Member Functions inherited from ns3::ObjectBase | |
static TypeId | GetTypeId () |
Get the type ID. | |
Protected Member Functions | |
void | DoDispose () override |
Destructor implementation. | |
void | DoInitialize () override |
Initialize() implementation. | |
Protected Member Functions inherited from ns3::Object | |
Object (const Object &o) | |
Copy an Object. | |
virtual void | NotifyNewAggregate () |
Notify all Objects aggregated to this one of a new Object being aggregated. | |
Protected Member Functions inherited from ns3::ObjectBase | |
void | ConstructSelf (const AttributeConstructionList &attributes) |
Complete construction of ObjectBase; invoked by derived classes. | |
virtual void | NotifyConstructionCompleted () |
Notifier called once the ObjectBase is fully constructed. | |
Private Types | |
using | PhyListenerMap = std::unordered_map<Ptr<WifiPhy>, std::shared_ptr<PhyListener>> |
Maps each PHY listener to the associated PHY. | |
typedef std::vector< Ptr< Txop > > | Txops |
typedef for a vector of Txops | |
Private Member Functions | |
void | AccessTimeout () |
Called when access timeout should occur (e.g. | |
void | DoGrantDcfAccess () |
Grant access to Txop using DCF/EDCF contention rules. | |
void | DoRestartAccessTimeoutIfNeeded () |
Time | GetBackoffEndFor (Ptr< Txop > txop, Time accessGrantStart) const |
This overload is provided to enable caching the value returned by GetAccessGrantStart(), which is independent of the given Txop object. | |
Time | GetBackoffStartFor (Ptr< Txop > txop, Time accessGrantStart) const |
This overload is provided to enable caching the value returned by GetAccessGrantStart(), which is independent of the given Txop object. | |
virtual Time | GetEifsNoDifs () const |
Return the EIFS duration minus a DIFS. | |
std::shared_ptr< PhyListener > | GetPhyListener (Ptr< WifiPhy > phy) const |
Get current registered listener for PHY events on the given PHY. | |
virtual Time | GetSifs () const |
Return the Short Interframe Space (SIFS) for this PHY. | |
virtual Time | GetSlot () const |
Return the slot duration for this PHY. | |
void | InitLastBusyStructs () |
Initialize the structures holding busy end times per channel type (primary, secondary, etc.) and per 20 MHz channel. | |
void | ResizeLastBusyStructs () |
Resize the structures holding busy end times per channel type (primary, secondary, etc.) and per 20 MHz channel. | |
void | UpdateBackoff () |
Update backoff slots for all Txops. | |
void | UpdateLastIdlePeriod () |
This method determines whether the medium has been idle during a period (of non-null duration) immediately preceding the time this method is called. | |
Private Attributes | |
EventId | m_accessTimeout |
the access timeout ID | |
Time | m_eifsNoDifs |
EIFS no DIFS time. | |
Ptr< FrameExchangeManager > | m_feManager |
pointer to the Frame Exchange Manager | |
bool | m_generateBackoffOnNoTx |
whether the backoff should be invoked when the AC gains the right to start a TXOP but it does not transmit any frame (e.g., due to constraints associated with EMLSR operations), provided that the queue is not actually empty | |
Time | m_lastAckTimeoutEnd |
the last Ack timeout end time | |
std::map< WifiChannelListType, Time > | m_lastBusyEnd |
the last busy end time for each channel type | |
Time | m_lastCtsTimeoutEnd |
the last CTS timeout end time | |
std::map< WifiChannelListType, Timespan > | m_lastIdle |
the last idle start and end time for each channel type | |
Time | m_lastNavEnd |
the last NAV end time | |
std::vector< Time > | m_lastPer20MHzBusyEnd |
the last busy end time per 20 MHz channel (HE stations and channel width > 20 MHz only) | |
Timespan | m_lastRx |
the last receive start and end time | |
bool | m_lastRxReceivedOk |
the last receive OK | |
Time | m_lastSwitchingEnd |
the last switching end time | |
Time | m_lastTxEnd |
the last transmit end time | |
uint8_t | m_linkId |
the ID of the link this object is associated with | |
bool | m_off |
flag whether it is in off state | |
Ptr< WifiPhy > | m_phy |
pointer to the unique active PHY | |
PhyListenerMap | m_phyListeners |
the PHY listeners | |
bool | m_proactiveBackoff |
whether a new backoff value is generated when a CCA busy period starts and the backoff counter is zero | |
bool | m_sleeping |
flag whether it is in sleeping state | |
std::unordered_map< Ptr< WifiPhy >, EmlsrLinkSwitchInfo > | m_switchingEmlsrLinks |
Store information about the PHY objects that are going to operate on another EMLSR link. | |
Txops | m_txops |
the vector of managed Txops | |
Friends | |
class | ::EmlsrCcaBusyTest |
class | ::EmlsrUlTxopTest |
Allow test cases to access private members. | |
Additional Inherited Members | |
Related Symbols inherited from ns3::ObjectBase | |
static TypeId | GetObjectIid () |
Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. | |
Manage a set of ns3::Txop.
Handle a set of independent ns3::Txop, each of which represents a single DCF within a MAC stack. Each ns3::Txop has a priority implicitly associated with it (the priority is determined when the ns3::Txop is added to the ChannelAccessManager: the first Txop to be added gets the highest priority, the second, the second highest priority, and so on.) which is used to handle "internal" collisions. i.e., when two local Txop are expected to get access to the medium at the same time, the highest priority local Txop wins access to the medium and the other Txop suffers a "internal" collision.
Definition at line 51 of file channel-access-manager.h.
|
private |
Maps each PHY listener to the associated PHY.
Definition at line 498 of file channel-access-manager.h.
|
private |
typedef for a vector of Txops
Definition at line 460 of file channel-access-manager.h.
ns3::ChannelAccessManager::ChannelAccessManager | ( | ) |
Definition at line 192 of file channel-access-manager.cc.
References ns3::MicroSeconds().
|
override |
Definition at line 208 of file channel-access-manager.cc.
References NS_LOG_FUNCTION.
|
private |
Called when access timeout should occur (e.g.
backoff procedure expired).
Definition at line 637 of file channel-access-manager.cc.
References DoGrantDcfAccess(), DoRestartAccessTimeoutIfNeeded(), NS_LOG_FUNCTION, and UpdateBackoff().
Referenced by DoRestartAccessTimeoutIfNeeded().
txop | a new Txop. |
The ChannelAccessManager does not take ownership of this pointer so, the callee must make sure that the Txop pointer will stay valid as long as the ChannelAccessManager is valid. Note that the order in which Txop objects are added to a ChannelAccessManager matters: the first Txop added has the highest priority, the second Txop added, has the second highest priority, etc.
Definition at line 358 of file channel-access-manager.cc.
References m_txops, and NS_LOG_FUNCTION.
Deactivate current registered listener for PHY events on the given PHY.
All notifications but channel switch notifications coming from an inactive listener are ignored.
phy | the WifiPhy to listen to |
Definition at line 300 of file channel-access-manager.cc.
References GetPhyListener(), m_phy, and NS_LOG_FUNCTION.
Referenced by SetupPhyListener().
qosTxop | a QosTxop that needs to be disabled |
duration | the amount of time during which the QosTxop is disabled |
Disable the given EDCA for the given amount of time. This EDCA will not be granted channel access during this period and the backoff timer will be frozen. After this period, the EDCA will start normal operations again by resuming the backoff timer.
Definition at line 850 of file channel-access-manager.cc.
References DoRestartAccessTimeoutIfNeeded(), m_linkId, ns3::Simulator::Now(), NS_ASSERT, NS_LOG_DEBUG, NS_LOG_FUNCTION, and UpdateBackoff().
|
overrideprotectedvirtual |
Destructor implementation.
This method is called by Dispose() or by the Object's destructor, whichever comes first.
Subclasses are expected to implement their real destruction code in an overridden version of this method and chain up to their parent's implementation once they are done. i.e, for simplicity, the destructor of every subclass should be empty and its content should be moved to the associated DoDispose() method.
It is safe to call GetObject() from within this method.
Reimplemented from ns3::Object.
Definition at line 221 of file channel-access-manager.cc.
References m_feManager, m_phy, m_phyListeners, m_txops, and NS_LOG_FUNCTION.
|
private |
Grant access to Txop using DCF/EDCF contention rules.
This is the first Txop we find with an expired backoff and which needs access to the medium. i.e., it has data to send.
all other Txops with a lower priority whose backoff has expired and which needed access to the medium must be notified that we did get an internal collision.
Now, we notify all of these changes in one go if the EDCAF winning the contention actually transmitted a frame. It is necessary to perform first the calculations of which Txops are colliding and then only apply the changes because applying the changes through notification could change the global state of the manager, and, thus, could change the result of the calculations.
Definition at line 554 of file channel-access-manager.cc.
References GetAccessGrantStart(), GetBackoffEndFor(), ns3::WifiPhy::GetChannelWidth(), GetLargestIdlePrimaryChannel(), ns3::WifiPhy::GetOperatingChannel(), ns3::WifiPhy::GetPhyBand(), ns3::WifiPhy::GetPifs(), GetSifs(), GetSlot(), ns3::WifiPhyOperatingChannel::IsOfdm(), m_feManager, m_linkId, m_phy, m_txops, ns3::Simulator::Now(), NS_ASSERT, NS_LOG_DEBUG, NS_LOG_FUNCTION, ns3::Txop::REQUESTED, ns3::StaticCast(), and ns3::WIFI_PHY_BAND_2_4GHZ.
Referenced by AccessTimeout(), and RequestAccess().
|
overrideprotectedvirtual |
Initialize() implementation.
This method is called only once by Initialize(). If the user calls Initialize() multiple times, DoInitialize() is called only the first time.
Subclasses are expected to override this method and chain up to their parent's implementation once they are done. It is safe to call GetObject() and AggregateObject() from within this method.
Reimplemented from ns3::Object.
Definition at line 214 of file channel-access-manager.cc.
References InitLastBusyStructs(), and NS_LOG_FUNCTION.
|
private |
Is there a Txop which needs to access the medium, and, if there is one, how many slots for AIFS+backoff does it require ?
Definition at line 750 of file channel-access-manager.cc.
References AccessTimeout(), ns3::EventId::Cancel(), GetAccessGrantStart(), GetBackoffEndFor(), ns3::Simulator::GetDelayLeft(), ns3::Simulator::GetMaximumSimulationTime(), ns3::EventId::IsExpired(), ns3::EventId::IsPending(), m_accessTimeout, m_linkId, m_txops, ns3::Simulator::Now(), NS_LOG_DEBUG, NS_LOG_FUNCTION, ns3::Txop::REQUESTED, and ns3::Simulator::Schedule().
Referenced by AccessTimeout(), DisableEdcaFor(), NotifyAckTimeoutResetNow(), NotifyCtsTimeoutResetNow(), NotifyNavResetNow(), and RequestAccess().
Time ns3::ChannelAccessManager::GetAccessGrantStart | ( | bool | ignoreNav = false | ) | const |
Access will never be granted to the medium before the time returned by this method.
ignoreNav | flag whether NAV should be ignored |
Definition at line 646 of file channel-access-manager.cc.
References ns3::Time::As(), ns3::ChannelAccessManager::Timespan::end, GetEifsNoDifs(), GetSifs(), m_lastAckTimeoutEnd, m_lastBusyEnd, m_lastCtsTimeoutEnd, m_lastNavEnd, m_lastRx, m_lastRxReceivedOk, m_lastSwitchingEnd, m_lastTxEnd, ns3::Simulator::Now(), NS_LOG_FUNCTION, NS_LOG_INFO, ns3::Time::US, and ns3::WIFI_CHANLIST_PRIMARY.
Referenced by DoGrantDcfAccess(), DoRestartAccessTimeoutIfNeeded(), GetBackoffEndFor(), GetBackoffStartFor(), RequestAccess(), and UpdateBackoff().
Return the time when the backoff procedure ended (or will end) for the given Txop.
txop | the Txop |
Definition at line 696 of file channel-access-manager.cc.
References GetAccessGrantStart(), and GetBackoffEndFor().
Referenced by DoGrantDcfAccess(), DoRestartAccessTimeoutIfNeeded(), and GetBackoffEndFor().
|
private |
This overload is provided to enable caching the value returned by GetAccessGrantStart(), which is independent of the given Txop object.
txop | the Txop |
accessGrantStart | the value returned by GetAccessGrantStart() |
Definition at line 702 of file channel-access-manager.cc.
References ns3::Time::As(), GetBackoffStartFor(), GetSlot(), m_linkId, NS_LOG_DEBUG, NS_LOG_FUNCTION, and ns3::Time::US.
Return the time when the backoff procedure started for the given Txop.
txop | the Txop |
Definition at line 677 of file channel-access-manager.cc.
References GetAccessGrantStart(), and GetBackoffStartFor().
Referenced by GetBackoffEndFor(), GetBackoffStartFor(), and UpdateBackoff().
|
private |
This overload is provided to enable caching the value returned by GetAccessGrantStart(), which is independent of the given Txop object.
txop | the Txop |
accessGrantStart | the value returned by GetAccessGrantStart() |
Definition at line 683 of file channel-access-manager.cc.
References ns3::Time::As(), GetSlot(), m_linkId, NS_LOG_DEBUG, NS_LOG_FUNCTION, ns3::Time::S, and ns3::Time::US.
|
privatevirtual |
Return the EIFS duration minus a DIFS.
Reimplemented in ChannelAccessManagerStub.
Definition at line 352 of file channel-access-manager.cc.
References ns3::WifiPhy::GetAckTxTime(), ns3::WifiPhy::GetSifs(), and m_phy.
Referenced by GetAccessGrantStart().
bool ns3::ChannelAccessManager::GetGenerateBackoffOnNoTx | ( | ) | const |
Definition at line 871 of file channel-access-manager.cc.
References m_generateBackoffOnNoTx.
Referenced by GetTypeId().
Return the width of the largest primary channel that has been idle for the given time interval before the given time, if any primary channel has been idle, or zero, otherwise.
interval | the given time interval |
end | the given end time |
Definition at line 792 of file channel-access-manager.cc.
References ns3::Time::As(), m_lastIdle, NS_LOG_FUNCTION, ns3::Time::S, UpdateLastIdlePeriod(), and ns3::Time::US.
Referenced by DoGrantDcfAccess().
bool ns3::ChannelAccessManager::GetPer20MHzBusy | ( | const std::set< uint8_t > & | indices | ) | const |
indices | a set of indices (starting at 0) specifying the 20 MHz channels to test |
Definition at line 826 of file channel-access-manager.cc.
References ns3::WifiPhy::GetChannelWidth(), m_lastBusyEnd, m_lastPer20MHzBusyEnd, m_phy, ns3::Simulator::Now(), NS_ASSERT, NS_ASSERT_MSG, NS_LOG_DEBUG, and ns3::WIFI_CHANLIST_PRIMARY.
|
private |
Get current registered listener for PHY events on the given PHY.
phy | the given PHY |
Definition at line 235 of file channel-access-manager.cc.
References m_phyListeners.
Referenced by DeactivatePhyListener(), RemovePhyListener(), and SetupPhyListener().
|
privatevirtual |
Return the Short Interframe Space (SIFS) for this PHY.
Reimplemented in ChannelAccessManagerStub.
Definition at line 346 of file channel-access-manager.cc.
References ns3::WifiPhy::GetSifs(), and m_phy.
Referenced by DoGrantDcfAccess(), GetAccessGrantStart(), NeedBackoffUponAccess(), and NotifyTxStartNow().
|
privatevirtual |
Return the slot duration for this PHY.
Reimplemented in ChannelAccessManagerStub.
Definition at line 340 of file channel-access-manager.cc.
References ns3::WifiPhy::GetSlot(), and m_phy.
Referenced by DoGrantDcfAccess(), GetBackoffEndFor(), GetBackoffStartFor(), NeedBackoffUponAccess(), RequestAccess(), and UpdateBackoff().
|
static |
Get the type ID.
Definition at line 164 of file channel-access-manager.cc.
References GetGenerateBackoffOnNoTx(), m_proactiveBackoff, ns3::MakeBooleanAccessor(), ns3::MakeBooleanChecker(), SetGenerateBackoffOnNoTx(), and ns3::TypeId::SetParent().
|
private |
Initialize the structures holding busy end times per channel type (primary, secondary, etc.) and per 20 MHz channel.
All values are set to the current time.
Definition at line 420 of file channel-access-manager.cc.
References m_lastBusyEnd, m_lastIdle, m_lastPer20MHzBusyEnd, ns3::Simulator::Now(), NS_LOG_FUNCTION, and ResizeLastBusyStructs().
Referenced by DoInitialize(), and ResetState().
bool ns3::ChannelAccessManager::IsBusy | ( | ) | const |
Check if the device is busy sending or receiving, or NAV or CCA busy.
Definition at line 445 of file channel-access-manager.cc.
References ns3::ChannelAccessManager::Timespan::end, m_lastBusyEnd, m_lastNavEnd, m_lastRx, m_lastTxEnd, ns3::Simulator::Now(), NS_LOG_FUNCTION, and ns3::WIFI_CHANLIST_PRIMARY.
Referenced by NeedBackoffUponAccess().
bool ns3::ChannelAccessManager::NeedBackoffUponAccess | ( | Ptr< Txop > | txop, |
bool | hadFramesToTransmit, | ||
bool | checkMediumBusy ) |
Determine if a new backoff needs to be generated as per letter a) of Section 10.23.2.2 of IEEE 802.11-2020 ("EDCA backoff procedure").
This method is called upon the occurrence of events such as the enqueuing of a packet or the unblocking of some links after they have been blocked for some reason (e.g., wait for ADDBA Response, wait for TX on another EMLSR link to finish, etc.). The checkMediumBusy argument allows to generate a new backoff regardless of the busy/idle state of the medium, as per Section 35.3.16.4 of 802.11be D4.0.
txop | the Txop requesting to generate a backoff |
hadFramesToTransmit | whether packets available for transmission were queued just before the occurrence of the event triggering this call |
checkMediumBusy | whether generation of backoff (also) depends on the busy/idle state of the medium |
Definition at line 458 of file channel-access-manager.cc.
References GetSifs(), GetSlot(), ns3::Txop::GRANTED, IsBusy(), m_linkId, m_off, m_phy, m_sleeping, ns3::Simulator::Now(), NS_LOG_FUNCTION, ns3::Seconds(), and UpdateBackoff().
void ns3::ChannelAccessManager::NotifyAckTimeoutResetNow | ( | ) |
Notify that ack timer has reset.
Definition at line 1165 of file channel-access-manager.cc.
References DoRestartAccessTimeoutIfNeeded(), m_lastAckTimeoutEnd, ns3::Simulator::Now(), and NS_LOG_FUNCTION.
Referenced by ChannelAccessManagerTest< TxopType >::AddAckTimeoutReset().
void ns3::ChannelAccessManager::NotifyAckTimeoutStartNow | ( | Time | duration | ) |
Notify that ack timer has started for the given duration.
duration | the duration of the timer |
Definition at line 1157 of file channel-access-manager.cc.
References m_lastAckTimeoutEnd, ns3::Simulator::Now(), NS_ASSERT, and NS_LOG_FUNCTION.
void ns3::ChannelAccessManager::NotifyCcaBusyStartNow | ( | Time | duration, |
WifiChannelListType | channelType, | ||
const std::vector< Time > & | per20MhzDurations ) |
duration | expected duration of CCA busy period |
channelType | the channel type for which the CCA busy state is reported. |
per20MhzDurations | vector that indicates for how long each 20 MHz subchannel (corresponding to the index of the element in the vector) is busy and where a zero duration indicates that the subchannel is idle. The vector is non-empty if the PHY supports 802.11ax or later and if the operational channel width is larger than 20 MHz. |
Notify the Txop that a CCA busy period has just started.
Definition at line 930 of file channel-access-manager.cc.
References ns3::Txop::GRANTED, m_lastBusyEnd, m_lastPer20MHzBusyEnd, m_linkId, m_proactiveBackoff, m_txops, ns3::Simulator::Now(), NS_ASSERT, NS_ASSERT_MSG, NS_LOG_DEBUG, NS_LOG_FUNCTION, UpdateBackoff(), and UpdateLastIdlePeriod().
Referenced by ChannelAccessManagerTest< TxopType >::AddCcaBusyEvt(), ChannelAccessManagerTest< TxopType >::AddRxErrorEvt(), ns3::PhyListener::NotifyCcaBusyStart(), and LargestIdlePrimaryChannelTest::RunOne().
void ns3::ChannelAccessManager::NotifyCtsTimeoutResetNow | ( | ) |
Notify that CTS timer has reset.
Definition at line 1180 of file channel-access-manager.cc.
References DoRestartAccessTimeoutIfNeeded(), m_lastCtsTimeoutEnd, ns3::Simulator::Now(), and NS_LOG_FUNCTION.
void ns3::ChannelAccessManager::NotifyCtsTimeoutStartNow | ( | Time | duration | ) |
Notify that CTS timer has started for the given duration.
duration | the duration of the timer |
Definition at line 1173 of file channel-access-manager.cc.
References m_lastCtsTimeoutEnd, ns3::Simulator::Now(), and NS_LOG_FUNCTION.
void ns3::ChannelAccessManager::NotifyNavResetNow | ( | Time | duration | ) |
duration | the value of the received NAV. |
Called at end of RX
If the NAV reset indicates an end-of-NAV which is earlier than the previous end-of-NAV, the expected end of backoff might be later than previously thought so, we might need to restart a new access timeout.
Definition at line 1124 of file channel-access-manager.cc.
References DoRestartAccessTimeoutIfNeeded(), m_lastNavEnd, m_phy, ns3::Simulator::Now(), NS_LOG_DEBUG, NS_LOG_FUNCTION, and UpdateBackoff().
Referenced by ChannelAccessManagerTest< TxopType >::AddNavReset().
void ns3::ChannelAccessManager::NotifyNavStartNow | ( | Time | duration | ) |
duration | the value of the received NAV. |
Called at end of RX
Definition at line 1148 of file channel-access-manager.cc.
References m_lastNavEnd, ns3::Simulator::Now(), NS_LOG_DEBUG, NS_LOG_FUNCTION, and UpdateBackoff().
Referenced by ChannelAccessManagerTest< TxopType >::AddNavStart().
void ns3::ChannelAccessManager::NotifyOffNow | ( | ) |
Notify the Txop that the device has been put in off mode.
Definition at line 1082 of file channel-access-manager.cc.
References ns3::EventId::Cancel(), ns3::EventId::IsPending(), m_accessTimeout, m_off, m_txops, and NS_LOG_FUNCTION.
Referenced by ns3::PhyListener::NotifyOff().
void ns3::ChannelAccessManager::NotifyOnNow | ( | ) |
Notify the Txop that the device has been resumed from off mode.
Definition at line 1112 of file channel-access-manager.cc.
References m_off, m_txops, NS_LOG_FUNCTION, and ResetBackoff().
Referenced by ns3::PhyListener::NotifyOn().
void ns3::ChannelAccessManager::NotifyRxEndErrorNow | ( | ) |
Notify the Txop that a packet reception was just completed unsuccessfuly.
Definition at line 898 of file channel-access-manager.cc.
References ns3::ChannelAccessManager::Timespan::end, m_lastRx, m_lastRxReceivedOk, ns3::Simulator::Now(), NS_LOG_DEBUG, and NS_LOG_FUNCTION.
Referenced by ChannelAccessManagerTest< TxopType >::AddRxErrorEvt(), ChannelAccessManagerTest< TxopType >::AddRxErrorEvt(), and ns3::PhyListener::NotifyRxEndError().
void ns3::ChannelAccessManager::NotifyRxEndOkNow | ( | ) |
Notify the Txop that a packet reception was just completed successfully.
Definition at line 889 of file channel-access-manager.cc.
References ns3::ChannelAccessManager::Timespan::end, m_lastRx, m_lastRxReceivedOk, ns3::Simulator::Now(), NS_LOG_DEBUG, and NS_LOG_FUNCTION.
Referenced by ChannelAccessManagerTest< TxopType >::AddRxOkEvt(), and ns3::PhyListener::NotifyRxEndOk().
void ns3::ChannelAccessManager::NotifyRxStartNow | ( | Time | duration | ) |
duration | expected duration of reception |
Notify the Txop that a packet reception started for the expected duration.
Definition at line 877 of file channel-access-manager.cc.
References ns3::ChannelAccessManager::Timespan::end, m_lastRx, m_lastRxReceivedOk, ns3::Simulator::Now(), NS_LOG_DEBUG, NS_LOG_FUNCTION, ns3::ChannelAccessManager::Timespan::start, UpdateBackoff(), and UpdateLastIdlePeriod().
Referenced by ChannelAccessManagerTest< TxopType >::AddRxErrorEvt(), ChannelAccessManagerTest< TxopType >::AddRxErrorEvt(), ChannelAccessManagerTest< TxopType >::AddRxInsideSifsEvt(), ChannelAccessManagerTest< TxopType >::AddRxOkEvt(), ChannelAccessManagerTest< TxopType >::AddRxStartEvt(), ns3::PhyListener::NotifyRxStart(), and LargestIdlePrimaryChannelTest::RunOne().
void ns3::ChannelAccessManager::NotifySleepNow | ( | ) |
Notify the Txop that the device has been put in sleep mode.
Definition at line 1068 of file channel-access-manager.cc.
References m_feManager, m_linkId, m_sleeping, m_txops, NS_LOG_FUNCTION, and ResetAllBackoffs().
Referenced by ns3::PhyListener::NotifySleep().
void ns3::ChannelAccessManager::NotifySwitchingEmlsrLink | ( | Ptr< WifiPhy > | phy, |
const WifiPhyOperatingChannel & | channel, | ||
uint8_t | linkId ) |
Notify that the given PHY is about to switch to the given operating channel, which is used by the given link.
This notification is sent by the EMLSR Manager when a PHY object switches operating channel to operate on another link.
phy | the PHY object that is going to switch channel |
channel | the new operating channel of the given PHY |
linkId | the ID of the link on which the given PHY is going to operate |
Definition at line 314 of file channel-access-manager.cc.
References m_switchingEmlsrLinks, NS_ASSERT_MSG, and NS_LOG_FUNCTION.
void ns3::ChannelAccessManager::NotifySwitchingStartNow | ( | PhyListener * | phyListener, |
Time | duration ) |
phyListener | the PHY listener that sent this notification |
duration | expected duration of channel switching period |
Notify the Txop that a channel switching period has just started. During switching state, new packets can be enqueued in Txop/QosTxop but they won't access to the medium until the end of the channel switching.
Definition at line 970 of file channel-access-manager.cc.
References ns3::EventId::Cancel(), ns3::DynamicCast(), ns3::EventId::IsPending(), m_accessTimeout, m_feManager, m_lastSwitchingEnd, m_lastTxEnd, m_phyListeners, m_switchingEmlsrLinks, m_txops, ns3::Simulator::Now(), NS_ASSERT, NS_LOG_DEBUG, NS_LOG_FUNCTION, RemovePhyListener(), ResetBackoff(), and ResetState().
Referenced by ChannelAccessManagerTest< TxopType >::AddSwitchingEvt(), and ns3::PhyListener::NotifySwitchingStart().
void ns3::ChannelAccessManager::NotifyTxStartNow | ( | Time | duration | ) |
duration | expected duration of transmission |
Notify the Txop that a packet transmission was just started and is expected to last for the specified duration.
Definition at line 908 of file channel-access-manager.cc.
References ns3::ChannelAccessManager::Timespan::end, GetSifs(), m_lastRx, m_lastRxReceivedOk, m_lastTxEnd, ns3::Simulator::Now(), NS_ASSERT, NS_LOG_DEBUG, NS_LOG_FUNCTION, ns3::ChannelAccessManager::Timespan::start, UpdateBackoff(), and UpdateLastIdlePeriod().
Referenced by ChannelAccessManagerTest< TxopType >::AddTxEvt(), and ns3::PhyListener::NotifyTxStart().
void ns3::ChannelAccessManager::NotifyWakeupNow | ( | ) |
Notify the Txop that the device has been resumed from sleep mode.
Definition at line 1100 of file channel-access-manager.cc.
References m_linkId, m_sleeping, m_txops, NS_LOG_FUNCTION, and ResetBackoff().
Referenced by ns3::PhyListener::NotifyWakeup().
Remove current registered listener for PHY events on the given PHY.
phy | the WifiPhy to listen to |
Definition at line 284 of file channel-access-manager.cc.
References GetPhyListener(), m_phy, m_phyListeners, and NS_LOG_FUNCTION.
Referenced by NotifySwitchingStartNow().
txop | a Txop |
Notify the ChannelAccessManager that a specific Txop needs access to the medium. The ChannelAccessManager is then responsible for starting an access timer and, invoking FrameExchangeManager::StartTransmission when the access is granted if it ever gets granted.
Definition at line 518 of file channel-access-manager.cc.
References DoGrantDcfAccess(), DoRestartAccessTimeoutIfNeeded(), GetAccessGrantStart(), GetSlot(), m_linkId, m_off, m_phy, m_sleeping, ns3::WifiPhy::NotifyChannelAccessRequested(), NS_ASSERT, NS_LOG_FUNCTION, ns3::Txop::REQUESTED, and UpdateBackoff().
void ns3::ChannelAccessManager::ResetAllBackoffs | ( | ) |
Reset the backoff for all the DCF/EDCAF.
Additionally, cancel the access timeout event.
Definition at line 1056 of file channel-access-manager.cc.
References ns3::EventId::Cancel(), m_accessTimeout, m_txops, NS_LOG_FUNCTION, and ResetBackoff().
Referenced by NotifySleepNow().
Reset the backoff for the given DCF/EDCAF.
txop | the given DCF/EDCAF |
Definition at line 1041 of file channel-access-manager.cc.
References m_linkId, ns3::Txop::NOT_REQUESTED, ns3::Simulator::Now(), NS_ASSERT, and NS_LOG_FUNCTION.
Referenced by NotifyOnNow(), NotifySwitchingStartNow(), NotifyWakeupNow(), and ResetAllBackoffs().
void ns3::ChannelAccessManager::ResetState | ( | ) |
Reset the state variables of this channel access manager.
Definition at line 1025 of file channel-access-manager.cc.
References ns3::ChannelAccessManager::Timespan::end, InitLastBusyStructs(), m_lastAckTimeoutEnd, m_lastCtsTimeoutEnd, m_lastNavEnd, m_lastRx, m_lastRxReceivedOk, ns3::Simulator::Now(), NS_LOG_FUNCTION, and UpdateLastIdlePeriod().
Referenced by NotifySwitchingStartNow().
|
private |
Resize the structures holding busy end times per channel type (primary, secondary, etc.) and per 20 MHz channel.
If a value (e.g., the busy end time for secondary40 channel) already exists, it is not changed; otherwise, it is set to the current time.
Definition at line 365 of file channel-access-manager.cc.
References ns3::WifiPhy::GetChannelWidth(), ns3::WifiPhy::GetOperatingChannel(), ns3::WifiPhy::GetStandard(), ns3::WifiPhyOperatingChannel::IsOfdm(), m_lastBusyEnd, m_lastIdle, m_lastPer20MHzBusyEnd, m_phy, ns3::Simulator::Now(), NS_LOG_FUNCTION, ns3::WIFI_CHANLIST_PRIMARY, ns3::WIFI_CHANLIST_SECONDARY, ns3::WIFI_CHANLIST_SECONDARY40, ns3::WIFI_CHANLIST_SECONDARY80, and ns3::WIFI_STANDARD_80211ax.
Referenced by InitLastBusyStructs(), and SetupPhyListener().
void ns3::ChannelAccessManager::SetGenerateBackoffOnNoTx | ( | bool | enable | ) |
Set the member variable indicating whether the backoff should be invoked when an AC gains the right to start a TXOP but it does not transmit any frame (e.g., due to constraints associated with EMLSR operations), provided that the queue is not actually empty.
enable | whether to enable backoff generation when no TX is performed in a TXOP |
Definition at line 864 of file channel-access-manager.cc.
References m_generateBackoffOnNoTx, and NS_LOG_FUNCTION.
Referenced by GetTypeId().
void ns3::ChannelAccessManager::SetLinkId | ( | uint8_t | linkId | ) |
Set the ID of the link this Channel Access Manager is associated with.
linkId | the ID of the link this Channel Access Manager is associated with |
Definition at line 325 of file channel-access-manager.cc.
References m_linkId, and NS_LOG_FUNCTION.
void ns3::ChannelAccessManager::SetupFrameExchangeManager | ( | Ptr< FrameExchangeManager > | feManager | ) |
Set up the Frame Exchange Manager.
feManager | the Frame Exchange Manager |
Definition at line 332 of file channel-access-manager.cc.
References m_feManager, and NS_LOG_FUNCTION.
Set up (or reactivate) listener for PHY events on the given PHY.
The new (or reactivated) listener becomes the active listener and the previous active listener attached to another PHY, if any, is deactivated.
phy | the WifiPhy to listen to |
Definition at line 245 of file channel-access-manager.cc.
References DeactivatePhyListener(), GetPhyListener(), m_lastSwitchingEnd, m_phy, m_phyListeners, ns3::Simulator::Now(), NS_ASSERT_MSG, NS_LOG_DEBUG, NS_LOG_FUNCTION, and ResizeLastBusyStructs().
|
private |
Update backoff slots for all Txops.
Definition at line 714 of file channel-access-manager.cc.
References GetAccessGrantStart(), GetBackoffStartFor(), GetSlot(), m_linkId, m_txops, ns3::Simulator::Now(), NS_LOG_DEBUG, and NS_LOG_FUNCTION.
Referenced by AccessTimeout(), DisableEdcaFor(), NeedBackoffUponAccess(), NotifyCcaBusyStartNow(), NotifyNavResetNow(), NotifyNavStartNow(), NotifyRxStartNow(), NotifyTxStartNow(), and RequestAccess().
|
private |
This method determines whether the medium has been idle during a period (of non-null duration) immediately preceding the time this method is called.
If so, the last idle start time and end time for each channel type are updated. Otherwise, no change is made by this method. This method is normally called when we are notified of the start of a transmission, reception, CCA Busy or switching to correctly maintain the information about the last idle period.
Definition at line 1188 of file channel-access-manager.cc.
References ns3::ChannelAccessManager::Timespan::end, m_lastBusyEnd, m_lastIdle, m_lastRx, m_lastSwitchingEnd, m_lastTxEnd, ns3::Simulator::Now(), NS_ASSERT, NS_LOG_DEBUG, NS_LOG_FUNCTION, and ns3::Time::S.
Referenced by GetLargestIdlePrimaryChannel(), NotifyCcaBusyStartNow(), NotifyRxStartNow(), NotifyTxStartNow(), and ResetState().
|
friend |
Definition at line 55 of file channel-access-manager.h.
|
friend |
Allow test cases to access private members.
Definition at line 54 of file channel-access-manager.h.
|
private |
the access timeout ID
Definition at line 479 of file channel-access-manager.h.
Referenced by DoRestartAccessTimeoutIfNeeded(), NotifyOffNow(), NotifySwitchingStartNow(), and ResetAllBackoffs().
|
private |
EIFS no DIFS time.
Definition at line 478 of file channel-access-manager.h.
|
private |
pointer to the Frame Exchange Manager
Definition at line 502 of file channel-access-manager.h.
Referenced by DoDispose(), DoGrantDcfAccess(), NotifySleepNow(), NotifySwitchingStartNow(), and SetupFrameExchangeManager().
|
private |
whether the backoff should be invoked when the AC gains the right to start a TXOP but it does not transmit any frame (e.g., due to constraints associated with EMLSR operations), provided that the queue is not actually empty
Definition at line 480 of file channel-access-manager.h.
Referenced by GetGenerateBackoffOnNoTx(), and SetGenerateBackoffOnNoTx().
|
private |
the last Ack timeout end time
Definition at line 463 of file channel-access-manager.h.
Referenced by GetAccessGrantStart(), NotifyAckTimeoutResetNow(), NotifyAckTimeoutStartNow(), and ResetState().
|
private |
the last busy end time for each channel type
Definition at line 470 of file channel-access-manager.h.
Referenced by GetAccessGrantStart(), GetPer20MHzBusy(), InitLastBusyStructs(), IsBusy(), NotifyCcaBusyStartNow(), ResizeLastBusyStructs(), and UpdateLastIdlePeriod().
|
private |
the last CTS timeout end time
Definition at line 464 of file channel-access-manager.h.
Referenced by GetAccessGrantStart(), NotifyCtsTimeoutResetNow(), NotifyCtsTimeoutStartNow(), and ResetState().
|
private |
the last idle start and end time for each channel type
Definition at line 474 of file channel-access-manager.h.
Referenced by GetLargestIdlePrimaryChannel(), InitLastBusyStructs(), ResizeLastBusyStructs(), and UpdateLastIdlePeriod().
|
private |
the last NAV end time
Definition at line 465 of file channel-access-manager.h.
Referenced by GetAccessGrantStart(), IsBusy(), NotifyNavResetNow(), NotifyNavStartNow(), and ResetState().
|
private |
the last busy end time per 20 MHz channel (HE stations and channel width > 20 MHz only)
Definition at line 471 of file channel-access-manager.h.
Referenced by GetPer20MHzBusy(), InitLastBusyStructs(), NotifyCcaBusyStartNow(), and ResizeLastBusyStructs().
|
private |
the last receive start and end time
Definition at line 466 of file channel-access-manager.h.
Referenced by GetAccessGrantStart(), IsBusy(), NotifyRxEndErrorNow(), NotifyRxEndOkNow(), NotifyRxStartNow(), NotifyTxStartNow(), ResetState(), and UpdateLastIdlePeriod().
|
private |
the last receive OK
Definition at line 467 of file channel-access-manager.h.
Referenced by GetAccessGrantStart(), NotifyRxEndErrorNow(), NotifyRxEndOkNow(), NotifyRxStartNow(), NotifyTxStartNow(), and ResetState().
|
private |
the last switching end time
Definition at line 475 of file channel-access-manager.h.
Referenced by GetAccessGrantStart(), NotifySwitchingStartNow(), SetupPhyListener(), and UpdateLastIdlePeriod().
|
private |
the last transmit end time
Definition at line 468 of file channel-access-manager.h.
Referenced by GetAccessGrantStart(), IsBusy(), NotifySwitchingStartNow(), NotifyTxStartNow(), and UpdateLastIdlePeriod().
|
private |
the ID of the link this object is associated with
Definition at line 503 of file channel-access-manager.h.
Referenced by DisableEdcaFor(), DoGrantDcfAccess(), DoRestartAccessTimeoutIfNeeded(), GetBackoffEndFor(), GetBackoffStartFor(), NeedBackoffUponAccess(), NotifyCcaBusyStartNow(), NotifySleepNow(), NotifyWakeupNow(), RequestAccess(), ResetBackoff(), SetLinkId(), and UpdateBackoff().
|
private |
flag whether it is in off state
Definition at line 477 of file channel-access-manager.h.
Referenced by NeedBackoffUponAccess(), NotifyOffNow(), NotifyOnNow(), and RequestAccess().
pointer to the unique active PHY
Definition at line 501 of file channel-access-manager.h.
Referenced by DeactivatePhyListener(), DoDispose(), DoGrantDcfAccess(), GetEifsNoDifs(), GetPer20MHzBusy(), GetSifs(), GetSlot(), NeedBackoffUponAccess(), NotifyNavResetNow(), RemovePhyListener(), RequestAccess(), ResizeLastBusyStructs(), and SetupPhyListener().
|
private |
the PHY listeners
Definition at line 500 of file channel-access-manager.h.
Referenced by DoDispose(), GetPhyListener(), NotifySwitchingStartNow(), RemovePhyListener(), and SetupPhyListener().
|
private |
whether a new backoff value is generated when a CCA busy period starts and the backoff counter is zero
Definition at line 484 of file channel-access-manager.h.
Referenced by GetTypeId(), and NotifyCcaBusyStartNow().
|
private |
flag whether it is in sleeping state
Definition at line 476 of file channel-access-manager.h.
Referenced by NeedBackoffUponAccess(), NotifySleepNow(), NotifyWakeupNow(), and RequestAccess().
|
private |
Store information about the PHY objects that are going to operate on another EMLSR link.
Definition at line 495 of file channel-access-manager.h.
Referenced by NotifySwitchingEmlsrLink(), and NotifySwitchingStartNow().
|
private |
the vector of managed Txops
Definition at line 462 of file channel-access-manager.h.
Referenced by Add(), DoDispose(), DoGrantDcfAccess(), DoRestartAccessTimeoutIfNeeded(), NotifyCcaBusyStartNow(), NotifyOffNow(), NotifyOnNow(), NotifySleepNow(), NotifySwitchingStartNow(), NotifyWakeupNow(), ResetAllBackoffs(), and UpdateBackoff().