block-ack-manager.h

Go to the documentation of this file.

/*
 * Copyright (c) 2009, 2010 MIRKO BANCHI
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation;
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 * Author: Mirko Banchi <mk.banchi@gmail.com>
 */
 
#ifndef BLOCK_ACK_MANAGER_H
#define BLOCK_ACK_MANAGER_H
 
#include "block-ack-type.h"
#include "originator-block-ack-agreement.h"
#include "wifi-mac-header.h"
#include "wifi-mpdu.h"
#include "wifi-tx-vector.h"
 
#include "ns3/nstime.h"
#include "ns3/object.h"
#include "ns3/traced-callback.h"
 
#include <map>
 
namespace ns3
{
 
class MgtAddBaResponseHeader;
class MgtAddBaRequestHeader;
class CtrlBAckResponseHeader;
class CtrlBAckRequestHeader;
class WifiMacQueue;
class WifiMode;
class Packet;
 
struct Bar
{
    Bar();
    Bar(Ptr<const WifiMpdu> bar, uint8_t tid, bool skipIfNoDataQueued = false);
    Ptr<const WifiMpdu> bar; 
    uint8_t tid;             
    bool skipIfNoDataQueued; 
};
 
class BlockAckManager : public Object
{
  private:
    enum MpduStatus : uint8_t
    {
        STAY_INFLIGHT = 0,
        TO_RETRANSMIT,
        ACKNOWLEDGED
    };
 
  public:
    static TypeId GetTypeId();
 
    BlockAckManager();
    ~BlockAckManager() override;
 
    // Delete copy constructor and assignment operator to avoid misuse
    BlockAckManager(const BlockAckManager&) = delete;
    BlockAckManager& operator=(const BlockAckManager&) = delete;
 
    void SetBlockAckManagerMap(const std::map<AcIndex, Ptr<BlockAckManager>>& bamMap);
    bool ExistsAgreement(Mac48Address recipient, uint8_t tid) const;
    bool ExistsAgreementInState(Mac48Address recipient,
                                uint8_t tid,
                                OriginatorBlockAckAgreement::State state) const;
    void CreateAgreement(const MgtAddBaRequestHeader* reqHdr,
                         Mac48Address recipient,
                         bool htSupported = true);
    void DestroyAgreement(Mac48Address recipient, uint8_t tid);
    void UpdateAgreement(const MgtAddBaResponseHeader* respHdr,
                         Mac48Address recipient,
                         uint16_t startingSeq);
    void StorePacket(Ptr<WifiMpdu> mpdu);
    Ptr<const WifiMpdu> GetBar(bool remove = true,
                               uint8_t tid = 8,
                               Mac48Address recipient = Mac48Address::GetBroadcast());
    void NotifyGotAck(Ptr<const WifiMpdu> mpdu);
    void NotifyMissedAck(Ptr<WifiMpdu> mpdu);
    std::pair<uint16_t, uint16_t> NotifyGotBlockAck(const CtrlBAckResponseHeader& blockAck,
                                                    Mac48Address recipient,
                                                    const std::set<uint8_t>& tids,
                                                    size_t index = 0);
    void NotifyMissedBlockAck(Mac48Address recipient, uint8_t tid);
    uint32_t GetNBufferedPackets(Mac48Address recipient, uint8_t tid) const;
    void NotifyAgreementEstablished(Mac48Address recipient, uint8_t tid, uint16_t startingSeq);
    void NotifyAgreementRejected(Mac48Address recipient, uint8_t tid);
    void NotifyAgreementNoReply(Mac48Address recipient, uint8_t tid);
    void NotifyAgreementReset(Mac48Address recipient, uint8_t tid);
    void SetBlockAckThreshold(uint8_t nPackets);
 
    void SetQueue(const Ptr<WifiMacQueue> queue);
 
    void SetBlockAckInactivityCallback(Callback<void, Mac48Address, uint8_t, bool> callback);
    void SetBlockDestinationCallback(Callback<void, Mac48Address, uint8_t> callback);
    void SetUnblockDestinationCallback(Callback<void, Mac48Address, uint8_t> callback);
 
    bool SwitchToBlockAckIfNeeded(Mac48Address recipient, uint8_t tid, uint16_t startingSeq);
    bool NeedBarRetransmission(uint8_t tid, Mac48Address recipient);
    uint16_t GetRecipientBufferSize(Mac48Address recipient, uint8_t tid) const;
    BlockAckReqType GetBlockAckReqType(Mac48Address recipient, uint8_t tid) const;
    BlockAckType GetBlockAckType(Mac48Address recipient, uint8_t tid) const;
    uint16_t GetOriginatorStartingSequence(Mac48Address recipient, uint8_t tid) const;
 
    typedef Callback<void, Ptr<const WifiMpdu>> TxOk;
    typedef Callback<void, Ptr<const WifiMpdu>> TxFailed;
    typedef Callback<void, Ptr<const WifiMpdu>> DroppedOldMpdu;
 
    void SetTxOkCallback(TxOk callback);
    void SetTxFailedCallback(TxFailed callback);
    void SetDroppedOldMpduCallback(DroppedOldMpdu callback);
 
    typedef void (*AgreementStateTracedCallback)(Time now,
                                                 Mac48Address recipient,
                                                 uint8_t tid,
                                                 OriginatorBlockAckAgreement::State state);
 
    void NotifyDiscardedMpdu(Ptr<const WifiMpdu> mpdu);
 
    CtrlBAckRequestHeader GetBlockAckReqHeader(Mac48Address recipient, uint8_t tid) const;
 
    void ScheduleBar(Ptr<const WifiMpdu> bar, bool skipIfNoDataQueued = false);
 
  protected:
    void DoDispose() override;
 
  private:
    void InactivityTimeout(Mac48Address recipient, uint8_t tid);
 
    typedef std::list<Ptr<WifiMpdu>> PacketQueue;
    typedef std::list<Ptr<WifiMpdu>>::iterator PacketQueueI;
    typedef std::list<Ptr<WifiMpdu>>::const_iterator PacketQueueCI;
    typedef std::map<std::pair<Mac48Address, uint8_t>,
                     std::pair<OriginatorBlockAckAgreement, PacketQueue>>
        Agreements;
    typedef std::map<std::pair<Mac48Address, uint8_t>,
                     std::pair<OriginatorBlockAckAgreement, PacketQueue>>::iterator AgreementsI;
    typedef std::map<std::pair<Mac48Address, uint8_t>,
                     std::pair<OriginatorBlockAckAgreement, PacketQueue>>::const_iterator
        AgreementsCI;
 
    PacketQueueI HandleInFlightMpdu(PacketQueueI mpduIt,
                                    MpduStatus status,
                                    const AgreementsI& it,
                                    const Time& now);
 
    Agreements m_agreements;
 
    std::list<Bar> m_bars; 
 
    std::map<AcIndex, Ptr<BlockAckManager>> m_bamMap; 
    uint8_t m_blockAckThreshold;                      
    Ptr<WifiMacQueue> m_queue;                        
    Callback<void, Mac48Address, uint8_t, bool>
        m_blockAckInactivityTimeout;                      
    Callback<void, Mac48Address, uint8_t> m_blockPackets; 
    Callback<void, Mac48Address, uint8_t> m_unblockPackets; 
    TxOk m_txOkCallback;                                    
    TxFailed m_txFailedCallback;                            
    DroppedOldMpdu m_droppedOldMpduCallback;                
 
    TracedCallback<Time, Mac48Address, uint8_t, OriginatorBlockAckAgreement::State>
        m_agreementState;
};
 
} // namespace ns3
 
#endif /* BLOCK_ACK_MANAGER_H */