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) 2020 Universita' degli Studi di Napoli Federico II
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: Stefano Avallone <stavallo@unina.it>
19  */
24 #include "ns3/qos-frame-exchange-manager.h"
25 #include "ns3/mpdu-aggregator.h"
26 #include "ns3/msdu-aggregator.h"
27 #include "ns3/wifi-psdu.h"
31 class HeAggregationTest;
33 namespace ns3 {
35 class MgtAddBaResponseHeader;
36 class RecipientBlockAckAgreement;
45 {
46 public:
48  friend class ::AmpduAggregationTest;
50  friend class ::TwoLevelAggregationTest;
52  friend class ::HeAggregationTest;
58  static TypeId GetTypeId (void);
60  virtual ~HtFrameExchangeManager ();
62  bool StartFrameExchange (Ptr<QosTxop> edca, Time availableTime, bool initialFrame) override;
63  void SetWifiMac (const Ptr<RegularWifiMac> mac) override;
64  void CalculateAcknowledgmentTime (WifiAcknowledgment* acknowledgment) const override;
91  const WifiTxParameters& txParams,
92  Time ppduDurationLimit) const override;
105  virtual bool IsWithinAmpduSizeLimit (uint32_t ampduSize, Mac48Address receiver, uint8_t tid,
106  WifiModulationClass modulation) const;
122  virtual bool TryAggregateMsdu (Ptr<const WifiMacQueueItem> msdu, WifiTxParameters& txParams,
123  Time availableTime) const;
137  const WifiTxParameters& txParams,
138  Time ppduDurationLimit) const;
155  void CreateBlockAckAgreement (const MgtAddBaResponseHeader *respHdr,
156  Mac48Address originator, uint16_t startingSeq);
163  void DestroyBlockAckAgreement (Mac48Address originator, uint8_t tid);
171  void SendAddBaResponse (const MgtAddBaRequestHeader *reqHdr,
172  Mac48Address originator);
179  virtual uint16_t GetSupportedBaBufferSize (void) const;
190  bool GetBaAgreementEstablished (Mac48Address originator, uint8_t tid) const;
199  BlockAckType GetBlockAckType (Mac48Address originator, uint8_t tid) const;
201 protected:
202  void DoDispose () override;
204  void ReceiveMpdu (Ptr<WifiMacQueueItem> mpdu, RxSignalInfo rxSignalInfo,
205  const WifiTxVector& txVector, bool inAmpdu) override;
206  void EndReceiveAmpdu (Ptr<const WifiPsdu> psdu, const RxSignalInfo& rxSignalInfo,
207  const WifiTxVector& txVector, const std::vector<bool>& perMpduStatus) override;
208  void NotifyReceivedNormalAck (Ptr<WifiMacQueueItem> mpdu) override;
210  void RetransmitMpduAfterMissedAck (Ptr<WifiMacQueueItem> mpdu) const override;
211  void RetransmitMpduAfterMissedCts (Ptr<WifiMacQueueItem> mpdu) const override;
212  void ForwardMpduDown (Ptr<WifiMacQueueItem> mpdu, WifiTxVector& txVector) override;
213  void CtsTimeout (Ptr<WifiMacQueueItem> rts, const WifiTxVector& txVector) override;
214  void TransmissionSucceeded (void) override;
215  void DequeueMpdu (Ptr<WifiMacQueueItem> mpdu) override;
224  virtual Ptr<WifiPsdu> GetWifiPsdu (Ptr<WifiMacQueueItem> mpdu, const WifiTxVector& txVector) const;
232  Ptr<BlockAckManager> GetBaManager (uint8_t tid) const;
241  virtual Time GetPsduDurationId (Time txDuration, const WifiTxParameters& txParams) const;
260  virtual void NotifyTxToEdca (Ptr<const WifiPsdu> psdu) const;
269  virtual void ForwardPsduDown (Ptr<const WifiPsdu> psdu, WifiTxVector& txVector);
276  void DequeuePsdu (Ptr<const WifiPsdu> psdu);
292  virtual bool SendMpduFromBaManager (Ptr<QosTxop> edca, Time availableTime, bool initialFrame);
308  virtual bool SendDataFrame (Ptr<const WifiMacQueueItem> peekedItem,
309  Time availableTime, bool initialFrame);
323  virtual bool NeedSetupBlockAck (Mac48Address recipient, uint8_t tid);
335  void SendAddBaRequest (Mac48Address recipient, uint8_t tid, uint16_t startingSeq,
336  uint16_t timeout, bool immediateBAck);
346  void SendDelbaFrame (Mac48Address addr, uint8_t tid, bool byOriginator);
356  void SendBlockAck (const RecipientBlockAckAgreement& agreement, Time durationId,
357  WifiTxVector& blockAckTxVector, double rxSnr);
365  virtual void BlockAckTimeout (Ptr<WifiPsdu> psdu, const WifiTxVector& txVector);
375  virtual void MissedBlockAck (Ptr<WifiPsdu> psdu, const WifiTxVector& txVector, bool& resetCw);
378  typedef std::pair<Mac48Address, uint8_t> AgreementKey;
380  std::map<AgreementKey, RecipientBlockAckAgreement> m_agreements;
384 private:
389  void SendPsdu (void);
393 };
395 } //namespace ns3
This enumeration defines the modulation classes per (Table 10-6 "Modulation classes"; IEEE 802...
virtual Ptr< WifiPsdu > GetWifiPsdu(Ptr< WifiMacQueueItem > mpdu, const WifiTxVector &txVector) const
Get a PSDU containing the given MPDU.
virtual bool IsWithinLimitsIfAggregateMsdu(Ptr< const WifiMacQueueItem > msdu, const WifiTxParameters &txParams, Time ppduDurationLimit) const
Check if the PSDU obtained by aggregating the given MSDU to the PSDU specified by the given TX parame...
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:103
void ForwardMpduDown(Ptr< WifiMacQueueItem > mpdu, WifiTxVector &txVector) override
Forward an MPDU down to the PHY layer.
This class mimics the TXVECTOR which is to be passed to the PHY in order to define the parameters whi...
void SendPsduWithProtection(Ptr< WifiPsdu > psdu, WifiTxParameters &txParams)
Send a PSDU (A-MPDU or BlockAckReq frame) requesting a BlockAck frame or a BlockAckReq frame followed...
void SendBlockAck(const RecipientBlockAckAgreement &agreement, Time durationId, WifiTxVector &blockAckTxVector, double rxSnr)
Create a BlockAck frame with header equal to blockAck and start its transmission. ...
void CalculateAcknowledgmentTime(WifiAcknowledgment *acknowledgment) const override
Calculate the time required to acknowledge a frame according to the given acknowledgment method...
void CreateBlockAckAgreement(const MgtAddBaResponseHeader *respHdr, Mac48Address originator, uint16_t startingSeq)
virtual void MissedBlockAck(Ptr< WifiPsdu > psdu, const WifiTxVector &txVector, bool &resetCw)
Take necessary actions when a BlockAck is missed, such as scheduling a BlockAckReq frame or the retra...
Maintains the scoreboard and the receive reordering buffer used by a recipient of a Block Ack agreeme...
Implement the header for management frames of type Add Block Ack request.
Definition: mgt-headers.h:990
WifiAcknowledgment is an abstract base struct.
virtual bool NeedSetupBlockAck(Mac48Address recipient, uint8_t tid)
A Block Ack agreement needs to be established with the given recipient for the given TID if it does n...
virtual bool TryAggregateMsdu(Ptr< const WifiMacQueueItem > msdu, WifiTxParameters &txParams, Time availableTime) const
Check if aggregating an MSDU to the current MPDU (as specified by the given TX parameters) does not v...
bool StartFrameExchange(Ptr< QosTxop > edca, Time availableTime, bool initialFrame) override
Start a frame exchange (including protection frames and acknowledgment frames as needed) that fits wi...
ns3::Time timeout
Ptr< MsduAggregator > m_msduAggregator
A-MSDU aggregator.
virtual void ForwardPsduDown(Ptr< const WifiPsdu > psdu, WifiTxVector &txVector)
Forward a PSDU down to the PHY layer.
void DestroyBlockAckAgreement(Mac48Address originator, uint8_t tid)
Destroy a Block Ack agreement.
Ptr< WifiPsdu > m_psdu
the A-MPDU being transmitted
void SetWifiMac(const Ptr< RegularWifiMac > mac) override
Set the MAC layer to use.
RxSignalInfo structure containing info on the received signal.
Definition: phy-entity.h:66
QosFrameExchangeManager handles the frame exchange sequences for QoS stations.
Definition: third.py:99
void DequeueMpdu(Ptr< WifiMacQueueItem > mpdu) override
Dequeue the given MPDU from the queue in which it is stored.
virtual bool IsWithinAmpduSizeLimit(uint32_t ampduSize, Mac48Address receiver, uint8_t tid, WifiModulationClass modulation) const
Check whether an A-MPDU of the given size meets the constraint on the maximum size for A-MPDUs sent t...
virtual void BlockAckTimeout(Ptr< WifiPsdu > psdu, const WifiTxVector &txVector)
Called when the BlockAck timeout expires.
void TransmissionSucceeded(void) override
Take necessary actions upon a transmission success.
void EndReceiveAmpdu(Ptr< const WifiPsdu > psdu, const RxSignalInfo &rxSignalInfo, const WifiTxVector &txVector, const std::vector< bool > &perMpduStatus) override
This method is called when the reception of an A-MPDU including multiple MPDUs is completed...
Every class exported by the ns3 library is enclosed in the ns3 namespace.
void SendPsdu(void)
Send the current PSDU, which can be acknowledged by a BlockAck frame or followed by a BlockAckReq fra...
void RetransmitMpduAfterMissedCts(Ptr< WifiMacQueueItem > mpdu) const override
Retransmit an MPDU that was not sent because a CTS was not received.
void RetransmitMpduAfterMissedAck(Ptr< WifiMacQueueItem > mpdu) const override
Retransmit an MPDU that was not acknowledged.
an EUI-48 address
Definition: mac48-address.h:43
void DoDispose() override
Destructor implementation.
bool IsWithinLimitsIfAddMpdu(Ptr< const WifiMacQueueItem > mpdu, const WifiTxParameters &txParams, Time ppduDurationLimit) const override
Check if the PSDU obtained by aggregating the given MPDU to the PSDU specified by the given TX parame...
virtual Time GetPsduDurationId(Time txDuration, const WifiTxParameters &txParams) const
Compute how to set the Duration/ID field of PSDUs that do not include fragments.
virtual uint16_t GetSupportedBaBufferSize(void) const
Get the maximum supported buffer size for a Block Ack agreement.
Two Level Aggregation Test.
std::map< AgreementKey, RecipientBlockAckAgreement > m_agreements
WifiTxParameters m_txParams
the TX parameters for the current frame
virtual void NotifyTxToEdca(Ptr< const WifiPsdu > psdu) const
Notify the transmission of the given PSDU to the EDCAF associated with the AC the PSDU belongs to...
Ampdu Aggregation Test.
Ptr< BlockAckManager > GetBaManager(uint8_t tid) const
Get the Block Ack Manager handling the given TID.
Ptr< MpduAggregator > GetMpduAggregator(void) const
Returns the aggregator used to construct A-MPDU subframes.
The different BlockAck variants.
void ReceiveMpdu(Ptr< WifiMacQueueItem > mpdu, RxSignalInfo rxSignalInfo, const WifiTxVector &txVector, bool inAmpdu) override
This method handles the reception of an MPDU (possibly included in an A-MPDU)
Ptr< MsduAggregator > GetMsduAggregator(void) const
Returns the aggregator used to construct A-MSDU subframes.
802.11ax aggregation test which permits 64 or 256 MPDUs in A-MPDU according to the negociated buffer ...
Implement the header for management frames of type Add Block Ack response.
Definition: mgt-headers.h:1122
This class stores the TX parameters (TX vector, protection mechanism, acknowledgment mechanism...
void SendAddBaResponse(const MgtAddBaRequestHeader *reqHdr, Mac48Address originator)
This method can be called to accept a received ADDBA Request.
virtual bool SendDataFrame(Ptr< const WifiMacQueueItem > peekedItem, Time availableTime, bool initialFrame)
Given a non-broadcast QoS data frame, prepare the PSDU to transmit by attempting A-MSDU and A-MPDU ag...
std::pair< Mac48Address, uint8_t > AgreementKey
agreement key typedef (MAC address and TID)
void NotifyReceivedNormalAck(Ptr< WifiMacQueueItem > mpdu) override
Notify other components that an MPDU was acknowledged.
BlockAckType GetBlockAckType(Mac48Address originator, uint8_t tid) const
Get the type of BlockAck frames sent to the given originator.
void SendDelbaFrame(Mac48Address addr, uint8_t tid, bool byOriginator)
Sends DELBA frame to cancel a block ack agreement with STA addressed by addr for TID tid...
void NotifyPacketDiscarded(Ptr< const WifiMacQueueItem > mpdu) override
Pass the given MPDU, discarded because of the max retry limit was reached, to the MPDU dropped callba...
virtual bool SendMpduFromBaManager(Ptr< QosTxop > edca, Time availableTime, bool initialFrame)
If the Block Ack Manager associated with the given EDCA has a BlockAckReq frame to transmit (the dura...
void SendAddBaRequest(Mac48Address recipient, uint8_t tid, uint16_t startingSeq, uint16_t timeout, bool immediateBAck)
Sends an ADDBA Request to establish a block ack agreement with STA addressed by recipient for TID tid...
Ptr< MpduAggregator > m_mpduAggregator
A-MPDU aggregator.
a unique identifier for an interface.
Definition: type-id.h:58
void DequeuePsdu(Ptr< const WifiPsdu > psdu)
Dequeue the MPDUs of the given PSDU from the queue in which they are stored.
HtFrameExchangeManager handles the frame exchange sequences for HT stations.
void CtsTimeout(Ptr< WifiMacQueueItem > rts, const WifiTxVector &txVector) override
Called when the CTS timeout expires.
static TypeId GetTypeId(void)
Get the type ID.
bool GetBaAgreementEstablished(Mac48Address originator, uint8_t tid) const
Return true if a Block Ack agreement has been established with the given originator for the given TID...