A Discrete-Event Network Simulator
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2008 INRIA
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License version 2 as
7  * published by the Free Software Foundation;
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17  *
18  * Author: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
19  */
24 #include "wifi-mac.h"
25 #include "qos-txop.h"
26 #include "ssid.h"
27 #include <set>
28 #include <unordered_map>
30 namespace ns3 {
32 class MacRxMiddle;
33 class MacTxMiddle;
34 class ChannelAccessManager;
35 class ExtendedCapabilities;
36 class FrameExchangeManager;
37 class WifiPsdu;
38 enum WifiTxTimerReason : uint8_t;
40 typedef std::unordered_map <uint16_t /* staId */, Ptr<WifiPsdu> /* PSDU */> WifiPsduMap;
50 class RegularWifiMac : public WifiMac
51 {
52 public:
57  static TypeId GetTypeId (void);
59  RegularWifiMac ();
60  virtual ~RegularWifiMac ();
62  // Implementations of pure virtual methods.
63  void SetShortSlotTimeSupported (bool enable) override;
64  void SetSsid (Ssid ssid) override;
65  void SetAddress (Mac48Address address) override;
66  void SetPromisc (void) override;
67  bool GetShortSlotTimeSupported (void) const override;
68  Ssid GetSsid (void) const override;
69  Mac48Address GetAddress (void) const override;
70  Mac48Address GetBssid (void) const override;
71  void Enqueue (Ptr<Packet> packet, Mac48Address to, Mac48Address from) override;
72  bool SupportsSendFrom (void) const override;
73  void SetWifiPhy (const Ptr<WifiPhy> phy) override;
74  Ptr<WifiPhy> GetWifiPhy (void) const override;
75  void ResetWifiPhy (void) override;
76  void SetWifiRemoteStationManager (const Ptr<WifiRemoteStationManager> stationManager) override;
77  void ConfigureStandard (WifiStandard standard) override;
78  TypeOfStation GetTypeOfStation (void) const override;
79  void SetForwardUpCallback (ForwardUpCallback upCallback) override;
80  void SetLinkUpCallback (Callback<void> linkUp) override;
81  void SetLinkDownCallback (Callback<void> linkDown) override;
84  // Should be implemented by child classes
85  void Enqueue (Ptr<Packet> packet, Mac48Address to) override = 0;
100  void SetCtsToSelfSupported (bool enable);
104  void SetBssid (Mac48Address bssid);
111  Ptr<Txop> GetTxop (void) const;
118  Ptr<QosTxop> GetQosTxop (AcIndex ac) const;
125  Ptr<QosTxop> GetQosTxop (uint8_t tid) const;
138  HtCapabilities GetHtCapabilities (void) const;
144  VhtCapabilities GetVhtCapabilities (void) const;
150  HeCapabilities GetHeCapabilities (void) const;
152 protected:
153  void DoInitialize () override;
154  void DoDispose () override;
155  void SetTypeOfStation (TypeOfStation type) override;
177  typedef std::map<AcIndex, Ptr<QosTxop> > EdcaQueues;
188  Ptr<QosTxop> GetVOQueue (void) const;
194  Ptr<QosTxop> GetVIQueue (void) const;
200  Ptr<QosTxop> GetBEQueue (void) const;
206  Ptr<QosTxop> GetBKQueue (void) const;
215  void ConfigureContentionWindow (uint32_t cwMin, uint32_t cwMax);
230  virtual void Receive (Ptr<WifiMacQueueItem> mpdu);
239  void ForwardUp (Ptr<const Packet> packet, Mac48Address from, Mac48Address to);
254  virtual void SetQosSupported (bool enable);
260  bool GetQosSupported () const;
266  void SetupFrameExchangeManager (void);
273  bool GetHtSupported () const;
280  bool GetVhtSupported () const;
287  void SetErpSupported (bool enable);
293  bool GetErpSupported () const;
300  void SetDsssSupported (bool enable);
306  bool GetDsssSupported () const;
313  bool GetHeSupported () const;
315 private:
317  RegularWifiMac (const RegularWifiMac &);
332  void SetupEdcaQueue (AcIndex ac);
339  void SetVoBlockAckThreshold (uint8_t threshold);
345  void SetViBlockAckThreshold (uint8_t threshold);
351  void SetBeBlockAckThreshold (uint8_t threshold);
357  void SetBkBlockAckThreshold (uint8_t threshold);
364  void SetVoBlockAckInactivityTimeout (uint16_t timeout);
370  void SetViBlockAckInactivityTimeout (uint16_t timeout);
376  void SetBeBlockAckInactivityTimeout (uint16_t timeout);
382  void SetBkBlockAckInactivityTimeout (uint16_t timeout);
414  uint16_t m_voMaxAmsduSize;
415  uint16_t m_viMaxAmsduSize;
416  uint16_t m_beMaxAmsduSize;
417  uint16_t m_bkMaxAmsduSize;
419  uint32_t m_voMaxAmpduSize;
420  uint32_t m_viMaxAmpduSize;
421  uint32_t m_beMaxAmpduSize;
422  uint32_t m_bkMaxAmpduSize;
456  typedef void (* MpduResponseTimeoutCallback)(uint8_t reason, Ptr<const WifiMacQueueItem> mpdu,
457  const WifiTxVector& txVector);
475  typedef void (* PsduResponseTimeoutCallback)(uint8_t reason, Ptr<const WifiPsdu> psdu,
476  const WifiTxVector& txVector);
495  typedef void (* PsduMapResponseTimeoutCallback)(uint8_t reason, WifiPsduMap* psduMap,
496  const std::set<Mac48Address>* missingStations,
497  std::size_t nTotalStations);
510 };
512 } //namespace ns3
514 #endif /* REGULAR_WIFI_MAC_H */
virtual void SetQosSupported(bool enable)
Enable or disable QoS support for the device.
uint16_t m_voMaxAmsduSize
maximum A-MSDU size for AC_VO (in bytes)
Mac48Address m_bssid
void SetVoBlockAckInactivityTimeout(uint16_t timeout)
Set VO block ack inactivity timeout.
void SetupEdcaQueue(AcIndex ac)
This method is a private utility invoked to configure the channel access function for the specified A...
TracedCallback< uint8_t, WifiPsduMap *, const std::set< Mac48Address > *, std::size_t > PsduMapResponseTimeoutTracedCallback
TracedCallback for PSDU map response timeout events typedef.
void SetLinkUpCallback(Callback< void > linkUp) override
MpduResponseTimeoutTracedCallback m_mpduResponseTimeoutCallback
MPDU response timeout traced callback.
bool GetHeSupported() const
Return whether the device supports HE.
Callback template class.
Definition: callback.h:1278
This class mimics the TXVECTOR which is to be passed to the PHY in order to define the parameters whi...
Ptr< Txop > m_txop
This holds a pointer to the TXOP instance for this WifiMac - used for transmission of frames to non-Q...
uint32_t m_bkMaxAmpduSize
maximum A-MPDU size for AC_BK (in bytes)
ForwardUpCallback m_forwardUp
Callback to forward packet up the stack.
This enumeration defines the Access Categories as an enumeration with values corresponding to the AC ...
Definition: qos-utils.h:70
Ptr< WifiPhy > GetWifiPhy(void) const override
virtual void DeaggregateAmsduAndForward(Ptr< WifiMacQueueItem > mpdu)
This method can be called to de-aggregate an A-MSDU and forward the constituent packets up the stack...
bool GetQosSupported() const
Return whether the device supports QoS.
static TypeId GetTypeId(void)
Get the type ID.
uint16_t m_bkMaxAmsduSize
maximum A-MSDU size for AC_BK (in bytes)
EdcaQueues m_edca
This is a map from Access Category index to the corresponding channel access function.
Forward calls to a chain of Callback.
uint32_t m_beMaxAmpduSize
maximum A-MPDU size for AC_BE (in bytes)
void SetErpSupported(bool enable)
Enable or disable ERP support for the device.
ExtendedCapabilities GetExtendedCapabilities(void) const
Return the extended capabilities of the device.
void SetWifiRemoteStationManager(const Ptr< WifiRemoteStationManager > stationManager) override
The Extended Capabilities Information ElementThis class knows how to serialise and deserialise the Ex...
bool SupportsSendFrom(void) const override
Callback< void > m_linkUp
Callback when a link is up.
void ConfigureContentionWindow(uint32_t cwMin, uint32_t cwMax)
The HT Capabilities Information ElementThis class knows how to serialise and deserialise the HT Capab...
void(* PsduMapResponseTimeoutCallback)(uint8_t reason, WifiPsduMap *psduMap, const std::set< Mac48Address > *missingStations, std::size_t nTotalStations)
TracedCallback signature for PSDU map response timeout events.
TracedCallback< uint8_t, Ptr< const WifiPsdu >, const WifiTxVector & > PsduResponseTimeoutTracedCallback
TracedCallback for PSDU response timeout events typedef.
TypeOfStation GetTypeOfStation(void) const override
Return the type of station.
Ptr< WifiPhy > m_phy
Wifi PHY.
uint32_t m_voMaxAmpduSize
maximum A-MPDU size for AC_VO (in bytes)
Ptr< ChannelAccessManager > m_channelAccessManager
channel access manager
ns3::Time timeout
Ptr< WifiRemoteStationManager > GetWifiRemoteStationManager(void) const override
virtual void Receive(Ptr< WifiMacQueueItem > mpdu)
This method acts as the MacRxMiddle receive callback and is invoked to notify us that a frame has bee...
void SetForwardUpCallback(ForwardUpCallback upCallback) override
bool GetShortSlotTimeSupported(void) const override
bool GetDsssSupported() const
Return whether the device supports DSSS.
TracedCallback< const WifiMacHeader & > m_txErrCallback
transmit error callback
Definition: third.py:93
void SetVoBlockAckThreshold(uint8_t threshold)
Set the block ack threshold for AC_VO.
void SetBssid(Mac48Address bssid)
base class for all MAC-level wifi objects.
void SetBkBlockAckThreshold(uint8_t threshold)
Set the block ack threshold for AC_BK.
bool GetErpSupported() const
Return whether the device supports ERP.
bool m_qosSupported
This Boolean is set true iff this WifiMac is to model 802.11e/WMM style Quality of Service...
bool GetVhtSupported() const
Return whether the device supports VHT.
The IEEE 802.11ac VHT Capabilities.
Ssid m_ssid
Service Set ID (SSID)
base class for all MAC-level wifi objects.
Definition: wifi-mac.h:70
Definition: third.py:100
Definition: third.py:99
void SetShortSlotTimeSupported(bool enable) override
Enable or disable short slot time feature.
void DoDispose() override
Destructor implementation.
TracedCallback< WifiMacDropReason, Ptr< const WifiMacQueueItem > > DroppedMpduTracedCallback
TracedCallback for MPDU drop events typedef.
Ptr< MacRxMiddle > m_rxMiddle
RX middle (defragmentation etc.)
Ptr< QosTxop > GetVOQueue(void) const
Accessor for the AC_VO channel access function.
uint16_t m_viMaxAmsduSize
maximum A-MSDU size for AC_VI (in bytes)
uint16_t m_beMaxAmsduSize
maximum A-MSDU size for AC_BE (in bytes)
HeCapabilities GetHeCapabilities(void) const
Return the HE capabilities of the device.
void SetupFrameExchangeManager(void)
Create a Frame Exchange Manager depending on the supported version of the standard.
void SetAddress(Mac48Address address) override
PsduResponseTimeoutTracedCallback m_psduResponseTimeoutCallback
PSDU response timeout traced callback.
TypeOfStation m_typeOfStation
the type of station
void SetBeBlockAckThreshold(uint8_t threshold)
Set the block ack threshold for AC_BE.
void SetSsid(Ssid ssid) override
Callback< void > m_linkDown
Callback when a link is down.
TracedCallback< const WifiMacHeader & > m_txOkCallback
transmit OK callback
Ptr< FrameExchangeManager > GetFrameExchangeManager(void) const
Get the Frame Exchange Manager.
Ptr< FrameExchangeManager > m_feManager
Frame Exchange Manager.
DroppedMpduTracedCallback m_droppedMpduCallback
This trace indicates that an MPDU was dropped for the given reason.
Every class exported by the ns3 library is enclosed in the ns3 namespace.
Identifies the allowed configurations that a Wifi device is configured to use.
Definition: first.py:44
void Enqueue(Ptr< Packet > packet, Mac48Address to, Mac48Address from) override
void ResetWifiPhy(void) override
Remove currently attached WifiPhy device from this MAC.
void(* PsduResponseTimeoutCallback)(uint8_t reason, Ptr< const WifiPsdu > psdu, const WifiTxVector &txVector)
TracedCallback signature for PSDU response timeout events.
Mac48Address GetBssid(void) const override
void SetWifiPhy(const Ptr< WifiPhy > phy) override
an EUI-48 address
Definition: mac48-address.h:43
Ptr< QosTxop > GetVIQueue(void) const
Accessor for the AC_VI channel access function.
void SetTypeOfStation(TypeOfStation type) override
This method is invoked by a subclass to specify what type of station it is implementing.
The IEEE 802.11 SSID Information Element.
Definition: ssid.h:35
void SetViBlockAckInactivityTimeout(uint16_t timeout)
Set VI block ack inactivity timeout.
std::map< AcIndex, Ptr< QosTxop > > EdcaQueues
This type defines a mapping between an Access Category index, and a pointer to the corresponding chan...
MpduTracedCallback m_nackedMpduCallback
nack&#39;ed MPDU callback
void(* DroppedMpduCallback)(WifiMacDropReason reason, Ptr< const WifiMacQueueItem > mpdu)
TracedCallback signature for MPDU drop events.
Ptr< QosTxop > GetBEQueue(void) const
Accessor for the AC_BE channel access function.
Ptr< Txop > GetTxop(void) const
Accessor for the DCF object.
void SetLinkDownCallback(Callback< void > linkDown) override
void SetViBlockAckThreshold(uint8_t threshold)
Set the block ack threshold for AC_VI.
void DoInitialize() override
Initialize() implementation.
Ptr< QosTxop > GetQosTxop(AcIndex ac) const
Accessor for a specified EDCA object.
bool GetHtSupported() const
Return whether the device supports HT.
void SetPromisc(void) override
Sets the interface in promiscuous mode.
MpduTracedCallback m_ackedMpduCallback
ack&#39;ed MPDU callback
void(* MpduResponseTimeoutCallback)(uint8_t reason, Ptr< const WifiMacQueueItem > mpdu, const WifiTxVector &txVector)
TracedCallback signature for MPDU response timeout events.
Ssid GetSsid(void) const override
bool m_ctsToSelfSupported
flag indicating whether CTS-To-Self is supported
TracedCallback< Ptr< const WifiMacQueueItem > > MpduTracedCallback
TracedCallback for acked/nacked MPDUs typedef.
PsduMapResponseTimeoutTracedCallback m_psduMapResponseTimeoutCallback
PSDU map response timeout traced callback.
void ConfigureStandard(WifiStandard standard) override
void SetBkBlockAckInactivityTimeout(uint16_t timeout)
Set BK block ack inactivity timeout.
void ForwardUp(Ptr< const Packet > packet, Mac48Address from, Mac48Address to)
Forward the packet up to the device.
Mac48Address GetAddress(void) const override
bool m_shortSlotTimeSupported
flag whether short slot time is supported
uint32_t m_viMaxAmpduSize
maximum A-MPDU size for AC_VI (in bytes)
bool m_erpSupported
This Boolean is set true iff this WifiMac is to model 802.11g.
Ptr< QosTxop > GetBKQueue(void) const
Accessor for the AC_BK channel access function.
Enumeration for type of station.
Definition: wifi-mac.h:40
void SetCtsToSelfSupported(bool enable)
Enable or disable CTS-to-self feature.
RegularWifiMac & operator=(const RegularWifiMac &mac)
assignment operator
void SetDsssSupported(bool enable)
Enable or disable DSSS support for the device.
Ptr< WifiRemoteStationManager > m_stationManager
Remote station manager (rate control, RTS/CTS/fragmentation thresholds etc.)
Mac48Address m_address
MAC address of this station.
VhtCapabilities GetVhtCapabilities(void) const
Return the VHT capabilities of the device.
The IEEE 802.11ax HE Capabilities.
void SetBeBlockAckInactivityTimeout(uint16_t timeout)
Set BE block ack inactivity timeout.
a unique identifier for an interface.
Definition: type-id.h:58
bool m_dsssSupported
This Boolean is set true iff this WifiMac is to model 802.11b.
std::unordered_map< uint16_t, Ptr< WifiPsdu > > WifiPsduMap
Map of PSDUs indexed by STA-ID.
The reason why an MPDU was dropped.
Definition: wifi-mac.h:54
Ptr< MacTxMiddle > m_txMiddle
TX middle (aggregation etc.)
TracedCallback< uint8_t, Ptr< const WifiMacQueueItem >, const WifiTxVector & > MpduResponseTimeoutTracedCallback
TracedCallback for MPDU response timeout events typedef.
HtCapabilities GetHtCapabilities(void) const
Return the HT capabilities of the device.