Fix IEEE 802.11 ADDBA transaction handling

Author: mgonzalezlopezudc

examples/wireless/qos/omnetpp.ini

@@ -83,5 +83,28 @@ sim-time-limit = 10s
 extends = MacQos
 **.isBlockAckSupported = true
 
+[Config MacQosWithTransactionalBlockAck]
+description = "Exercises successful and timed-out ADDBA transactions"
+extends = MacQosWithoutAggregation
+sim-time-limit = 3s
+
+# Use one voice flow so each wireless hop has a single peer/TID data flow.
+*.cliHost.numApps = 1
+*.cliHost.app[0].destPort = 5000
+*.cliHost.app[0].packetName = "TransactionalBlockAck"
+*.cliHost.app[0].startTime = 1s
+*.cliHost.app[0].stopTime = 2s
+*.cliHost.app[0].sendInterval = 10ms
+*.srvHost.numApps = 1
+*.srvHost.app[0].localPort = 5000
+
+# The client-to-AP transaction succeeds. The AP-to-server transaction times
+# out, because the server deliberately does not support Block Ack.
+*.cliHost.wlan[0].mac.hcf.isBlockAckSupported = true
+*.ap.wlan[0].mac.hcf.isBlockAckSupported = true
+*.srvHost.wlan[0].mac.hcf.isBlockAckSupported = false
+**.mac.hcf.originatorAckPolicy.blockAckReqThreshold = 2
+**.mac.hcf.originatorBlockAckAgreementPolicy.addbaFailureTimeout = 250ms
+
 # radio medium
 *.radioMedium.sameTransmissionStartTimeCheck = "ignore"

src/inet/linklayer/ieee80211/mac/blockack/OriginatorBlockAckAgreement.h

@@ -15,6 +15,12 @@ namespace ieee80211 {
 
 class OriginatorBlockAckAgreementHandler;
 
+enum class OriginatorBlockAckAgreementState
+{
+    PENDING,
+    ESTABLISHED,
+};
+
 class INET_API OriginatorBlockAckAgreement : public cObject
 {
   protected:
@@ -25,19 +31,22 @@ class INET_API OriginatorBlockAckAgreement : public cObject
     int bufferSize = -1;
     bool isAMsduSupported = false;
     bool isDelayedBlockAckPolicySupported = false;
-    bool isAddbaResponseReceived = false;
+    OriginatorBlockAckAgreementState state = OriginatorBlockAckAgreementState::PENDING;
     bool isAddbaRequestSent = false;
+    uint8_t dialogToken = 0;
+    simtime_t addbaResponseDeadline = -1;
     simtime_t blockAckTimeoutValue = -1;
     simtime_t expirationTime = -1;
 
   public:
-    OriginatorBlockAckAgreement(MacAddress receiverAddr, Tid tid, SequenceNumberCyclic startingSequenceNumber, int bufferSize, bool isAMsduSupported, bool isDelayedBlockAckPolicySupported) :
+    OriginatorBlockAckAgreement(MacAddress receiverAddr, Tid tid, SequenceNumberCyclic startingSequenceNumber, int bufferSize, bool isAMsduSupported, bool isDelayedBlockAckPolicySupported, uint8_t dialogToken) :
         receiverAddr(receiverAddr),
         tid(tid),
         startingSequenceNumber(startingSequenceNumber),
         bufferSize(bufferSize),
         isAMsduSupported(isAMsduSupported),
-        isDelayedBlockAckPolicySupported(isDelayedBlockAckPolicySupported)
+        isDelayedBlockAckPolicySupported(isDelayedBlockAckPolicySupported),
+        dialogToken(dialogToken)
     {
     }
 
@@ -46,21 +55,25 @@ class INET_API OriginatorBlockAckAgreement : public cObject
     virtual int getBufferSize() const { return bufferSize; }
     virtual SequenceNumberCyclic getStartingSequenceNumber() { return startingSequenceNumber; }
     virtual void setStartingSequenceNumber(SequenceNumberCyclic sequenceNumber) { startingSequenceNumber = sequenceNumber; }
-    virtual bool getIsAddbaResponseReceived() const { return isAddbaResponseReceived; }
+    virtual bool getIsAddbaResponseReceived() const { return state == OriginatorBlockAckAgreementState::ESTABLISHED; }
+    virtual bool isPending() const { return state == OriginatorBlockAckAgreementState::PENDING; }
     virtual bool getIsAddbaRequestSent() const { return isAddbaRequestSent; }
     virtual bool getIsAMsduSupported() const { return isAMsduSupported; }
     virtual bool getIsDelayedBlockAckPolicySupported() const { return isDelayedBlockAckPolicySupported; }
     virtual MacAddress getReceiverAddr() const { return receiverAddr; }
     virtual Tid getTid() const { return tid; }
     virtual const simtime_t getBlockAckTimeoutValue() const { return blockAckTimeoutValue; }
     virtual int getNumSentBaPolicyFrames() const { return numSentBaPolicyFrames; }
+    virtual uint8_t getDialogToken() const { return dialogToken; }
+    virtual simtime_t getAddbaResponseDeadline() const { return addbaResponseDeadline; }
 
     virtual void setBufferSize(int bufferSize) { this->bufferSize = bufferSize; }
-    virtual void setIsAddbaResponseReceived(bool isAddbaResponseReceived) { this->isAddbaResponseReceived = isAddbaResponseReceived; }
+    virtual void setIsAddbaResponseReceived(bool isAddbaResponseReceived) { state = isAddbaResponseReceived ? OriginatorBlockAckAgreementState::ESTABLISHED : OriginatorBlockAckAgreementState::PENDING; }
     virtual void setIsAddbaRequestSent(bool isAddbaRequestSent) { this->isAddbaRequestSent = isAddbaRequestSent; }
     virtual void setIsAMsduSupported(bool isAMsduSupported) { this->isAMsduSupported = isAMsduSupported; }
     virtual void setIsDelayedBlockAckPolicySupported(bool isDelayedBlockAckPolicySupported) { this->isDelayedBlockAckPolicySupported = isDelayedBlockAckPolicySupported; }
     virtual void setBlockAckTimeoutValue(const simtime_t blockAckTimeoutValue) { this->blockAckTimeoutValue = blockAckTimeoutValue; }
+    virtual void setAddbaResponseDeadline(simtime_t addbaResponseDeadline) { this->addbaResponseDeadline = addbaResponseDeadline; }
 
     virtual void baPolicyFrameSent() { numSentBaPolicyFrames++; }
     virtual void calculateExpirationTime() { expirationTime = blockAckTimeoutValue == 0 ? SIMTIME_MAX : simTime() + blockAckTimeoutValue; }
@@ -71,4 +84,3 @@ class INET_API OriginatorBlockAckAgreement : public cObject
 } /* namespace inet */
 
 #endif
-

src/inet/linklayer/ieee80211/mac/blockack/OriginatorBlockAckAgreementHandler.cc

@@ -14,11 +14,19 @@ namespace ieee80211 {
 
 void OriginatorBlockAckAgreementHandler::createAgreement(const Ptr<const Ieee80211AddbaRequest>& addbaRequest)
 {
-    OriginatorBlockAckAgreement *blockAckAgreement = new OriginatorBlockAckAgreement(addbaRequest->getReceiverAddress(), addbaRequest->getTid(), addbaRequest->getStartingSequenceNumber(), addbaRequest->getBufferSize(), addbaRequest->getAMsduSupported(), addbaRequest->getBlockAckPolicy() == 0);
+    ASSERT(addbaRequest->getDialogToken() != 0);
+    OriginatorBlockAckAgreement *blockAckAgreement = new OriginatorBlockAckAgreement(addbaRequest->getReceiverAddress(), addbaRequest->getTid(), addbaRequest->getStartingSequenceNumber(), addbaRequest->getBufferSize(), addbaRequest->getAMsduSupported(), addbaRequest->getBlockAckPolicy() == 0, addbaRequest->getDialogToken());
     auto agreementId = std::make_pair(addbaRequest->getReceiverAddress(), addbaRequest->getTid());
     blockAckAgreements[agreementId] = blockAckAgreement;
 }
 
+uint8_t OriginatorBlockAckAgreementHandler::allocateDialogToken()
+{
+    auto dialogToken = nextDialogToken;
+    nextDialogToken = nextDialogToken == 255 ? 1 : nextDialogToken + 1;
+    return dialogToken;
+}
+
 simtime_t OriginatorBlockAckAgreementHandler::computeEarliestExpirationTime()
 {
     simtime_t earliestTime = SIMTIME_MAX;
@@ -33,6 +41,35 @@ simtime_t OriginatorBlockAckAgreementHandler::computeEarliestExpirationTime()
     return earliestTime;
 }
 
+simtime_t OriginatorBlockAckAgreementHandler::computeEarliestAddbaResponseDeadline() const
+{
+    simtime_t earliestDeadline = SIMTIME_MAX;
+    for (const auto& entry : blockAckAgreements) {
+        auto agreement = entry.second;
+        if (agreement->isPending() && agreement->getIsAddbaRequestSent()) {
+            ASSERT(agreement->getAddbaResponseDeadline() >= 0);
+            earliestDeadline = std::min(earliestDeadline, agreement->getAddbaResponseDeadline());
+        }
+    }
+    return earliestDeadline;
+}
+
+void OriginatorBlockAckAgreementHandler::addbaResponseTimeoutExpired(IBlockAckAgreementHandlerCallback *callback)
+{
+    auto now = simTime();
+    for (auto it = blockAckAgreements.begin(); it != blockAckAgreements.end();) {
+        auto agreement = it->second;
+        if (agreement->isPending() && agreement->getIsAddbaRequestSent() && agreement->getAddbaResponseDeadline() <= now) {
+            EV_INFO << "ADDBA Response timeout for receiver=" << agreement->getReceiverAddr() << " tid=" << (int)agreement->getTid() << endl;
+            it = blockAckAgreements.erase(it);
+            delete agreement;
+        }
+        else
+            it++;
+    }
+    scheduleAddbaResponseTimer(callback);
+}
+
 void OriginatorBlockAckAgreementHandler::blockAckAgreementExpired(IProcedureCallback *procedureCallback, IBlockAckAgreementHandlerCallback *agreementHandlerCallback)
 {
     // When a timeout of BlockAckTimeout is detected, the STA shall send a DELBA frame to the
@@ -57,6 +94,9 @@ const Ptr<Ieee80211AddbaRequest> OriginatorBlockAckAgreementHandler::buildAddbaR
 {
     auto addbaRequest = makeShared<Ieee80211AddbaRequest>();
     addbaRequest->setReceiverAddress(receiverAddr);
+    // IEEE Std 802.11-2024, 9.6.4.2: a solicited ADDBA Request uses a nonzero
+    // Dialog Token, and the corresponding response copies that token.
+    addbaRequest->setDialogToken(allocateDialogToken());
     addbaRequest->setTid(tid);
     addbaRequest->setAMsduSupported(blockAckAgreementPolicy->isMsduSupported());
     addbaRequest->setBlockAckTimeoutValue(blockAckAgreementPolicy->getBlockAckTimeoutValue());
@@ -92,13 +132,24 @@ void OriginatorBlockAckAgreementHandler::scheduleInactivityTimer(IBlockAckAgreem
         callback->scheduleInactivityTimer(earliestExpirationTime);
 }
 
+void OriginatorBlockAckAgreementHandler::scheduleAddbaResponseTimer(IBlockAckAgreementHandlerCallback *callback)
+{
+    callback->scheduleAddbaResponseTimer(computeEarliestAddbaResponseDeadline());
+}
+
 OriginatorBlockAckAgreement *OriginatorBlockAckAgreementHandler::getAgreement(MacAddress receiverAddr, Tid tid)
 {
     auto agreementId = std::make_pair(receiverAddr, tid);
     auto it = blockAckAgreements.find(agreementId);
     return it != blockAckAgreements.end() ? it->second : nullptr;
 }
 
+bool OriginatorBlockAckAgreementHandler::isAddbaResponsePending(MacAddress receiverAddr, Tid tid) const
+{
+    auto it = blockAckAgreements.find(std::make_pair(receiverAddr, tid));
+    return it != blockAckAgreements.end() && it->second->isPending();
+}
+
 const Ptr<Ieee80211Delba> OriginatorBlockAckAgreementHandler::buildDelba(MacAddress receiverAddr, Tid tid, int reasonCode)
 {
     auto delba = makeShared<Ieee80211Delba>();
@@ -132,15 +183,23 @@ void OriginatorBlockAckAgreementHandler::processTransmittedDataFrame(Packet *pac
     }
 }
 
-void OriginatorBlockAckAgreementHandler::processReceivedAddbaResp(const Ptr<const Ieee80211AddbaResponse>& addbaResp, IOriginatorBlockAckAgreementPolicy *blockAckAgreementPolicy, IBlockAckAgreementHandlerCallback *callback)
+OriginatorBlockAckAgreement *OriginatorBlockAckAgreementHandler::processReceivedAddbaResp(const Ptr<const Ieee80211AddbaResponse>& addbaResp, IOriginatorBlockAckAgreementPolicy *blockAckAgreementPolicy, IBlockAckAgreementHandlerCallback *callback)
 {
     auto agreement = getAgreement(addbaResp->getTransmitterAddress(), addbaResp->getTid());
-    if (blockAckAgreementPolicy->isAddbaReqAccepted(addbaResp, agreement)) {
+    // IEEE Std 802.11-2024, 11.5.2.2: only a successful response matching the
+    // outstanding peer, TID, and Dialog Token establishes the agreement.
+    if (agreement == nullptr || !agreement->isPending() || !agreement->getIsAddbaRequestSent() || agreement->getDialogToken() != addbaResp->getDialogToken())
+        return nullptr;
+    if (addbaResp->getStatusCode() == 0 && blockAckAgreementPolicy->isAddbaReqAccepted(addbaResp, agreement)) {
         updateAgreement(agreement, addbaResp);
         scheduleInactivityTimer(callback);
+        scheduleAddbaResponseTimer(callback);
+        return agreement;
     }
     else {
-        // TODO send a new one?
+        terminateAgreement(addbaResp->getTransmitterAddress(), addbaResp->getTid());
+        scheduleAddbaResponseTimer(callback);
+        return nullptr;
     }
 }
 
@@ -152,13 +211,21 @@ void OriginatorBlockAckAgreementHandler::updateAgreement(OriginatorBlockAckAgree
     agreement->calculateExpirationTime();
 }
 
-void OriginatorBlockAckAgreementHandler::processTransmittedAddbaReq(const Ptr<const Ieee80211AddbaRequest>& addbaReq)
+void OriginatorBlockAckAgreementHandler::processTransmittedAddbaReq(const Ptr<const Ieee80211AddbaRequest>& addbaReq, IOriginatorBlockAckAgreementPolicy *blockAckAgreementPolicy, IBlockAckAgreementHandlerCallback *callback)
 {
     auto agreement = getAgreement(addbaReq->getReceiverAddress(), addbaReq->getTid());
-    if (agreement)
+    if (agreement && agreement->isPending() && agreement->getDialogToken() == addbaReq->getDialogToken()) {
+        if (agreement->getAddbaResponseDeadline() < 0) {
+            auto addbaFailureTimeout = blockAckAgreementPolicy->computeAddbaFailureTimeout();
+            if (addbaFailureTimeout <= 0)
+                throw cRuntimeError("ADDBA failure timeout must be greater than zero");
+            agreement->setAddbaResponseDeadline(simTime() + addbaFailureTimeout);
+        }
         agreement->setIsAddbaRequestSent(true);
+        scheduleAddbaResponseTimer(callback);
+    }
     else
-        throw cRuntimeError("Block Ack Agreement should have already been added");
+        EV_WARN << "Ignoring stale transmitted ADDBA Request for receiver=" << addbaReq->getReceiverAddress() << " tid=" << (int)addbaReq->getTid() << " dialogToken=" << (int)addbaReq->getDialogToken() << endl;
 }
 
 void OriginatorBlockAckAgreementHandler::processTransmittedDelba(const Ptr<const Ieee80211Delba>& delba)
@@ -180,4 +247,3 @@ OriginatorBlockAckAgreementHandler::~OriginatorBlockAckAgreementHandler()
 
 } // namespace ieee80211
 } // namespace inet
-

src/inet/linklayer/ieee80211/mac/blockack/OriginatorBlockAckAgreementHandler.h

@@ -21,31 +21,36 @@ class INET_API OriginatorBlockAckAgreementHandler : public IOriginatorBlockAckAg
 {
   protected:
     std::map<std::pair<MacAddress, Tid>, OriginatorBlockAckAgreement *> blockAckAgreements;
+    uint8_t nextDialogToken = 1;
 
   protected:
     virtual const Ptr<Ieee80211AddbaRequest> buildAddbaRequest(MacAddress receiverAddr, Tid tid, SequenceNumberCyclic startingSequenceNumber, IOriginatorBlockAckAgreementPolicy *blockAckAgreementPolicy);
+    virtual uint8_t allocateDialogToken();
     virtual void createAgreement(const Ptr<const Ieee80211AddbaRequest>& addbaRequest);
     virtual void updateAgreement(OriginatorBlockAckAgreement *agreement, const Ptr<const Ieee80211AddbaResponse>& addbaResp);
     virtual void terminateAgreement(MacAddress originatorAddr, Tid tid);
     virtual const Ptr<Ieee80211Delba> buildDelba(MacAddress receiverAddr, Tid tid, int reasonCode);
     virtual simtime_t computeEarliestExpirationTime();
+    virtual simtime_t computeEarliestAddbaResponseDeadline() const;
     virtual void scheduleInactivityTimer(IBlockAckAgreementHandlerCallback *callback);
+    virtual void scheduleAddbaResponseTimer(IBlockAckAgreementHandlerCallback *callback);
 
   public:
     virtual ~OriginatorBlockAckAgreementHandler();
-    virtual void processTransmittedAddbaReq(const Ptr<const Ieee80211AddbaRequest>& addbaReq) override;
+    virtual void processTransmittedAddbaReq(const Ptr<const Ieee80211AddbaRequest>& addbaReq, IOriginatorBlockAckAgreementPolicy *blockAckAgreementPolicy, IBlockAckAgreementHandlerCallback *callback) override;
     virtual void processTransmittedDataFrame(Packet *packet, const Ptr<const Ieee80211DataHeader>& dataHeader, IOriginatorBlockAckAgreementPolicy *blockAckAgreementPolicy, IProcedureCallback *callback) override;
     virtual void processReceivedBlockAck(const Ptr<const Ieee80211BlockAck>& blockAck, IBlockAckAgreementHandlerCallback *callback) override;
-    virtual void processReceivedAddbaResp(const Ptr<const Ieee80211AddbaResponse>& addbaResp, IOriginatorBlockAckAgreementPolicy *blockAckAgreementPolicy, IBlockAckAgreementHandlerCallback *callback) override;
+    virtual OriginatorBlockAckAgreement *processReceivedAddbaResp(const Ptr<const Ieee80211AddbaResponse>& addbaResp, IOriginatorBlockAckAgreementPolicy *blockAckAgreementPolicy, IBlockAckAgreementHandlerCallback *callback) override;
     virtual void processReceivedDelba(const Ptr<const Ieee80211Delba>& delba, IOriginatorBlockAckAgreementPolicy *blockAckAgreementPolicy) override;
     virtual void processTransmittedDelba(const Ptr<const Ieee80211Delba>& delba) override;
     virtual void blockAckAgreementExpired(IProcedureCallback *procedureCallback, IBlockAckAgreementHandlerCallback *agreementHandlerCallback) override;
+    virtual void addbaResponseTimeoutExpired(IBlockAckAgreementHandlerCallback *callback) override;
 
     virtual OriginatorBlockAckAgreement *getAgreement(MacAddress receiverAddr, Tid tid) override;
+    virtual bool isAddbaResponsePending(MacAddress receiverAddr, Tid tid) const override;
 };
 
 } // namespace ieee80211
 } // namespace inet
 
 #endif
-

src/inet/linklayer/ieee80211/mac/blockack/OriginatorBlockAckAgreementPolicy.cc

@@ -24,15 +24,16 @@ void OriginatorBlockAckAgreementPolicy::initialize(int stage)
         aMsduSupported = par("aMsduSupported");
         maximumAllowedBufferSize = par("maximumAllowedBufferSize");
         blockAckTimeoutValue = par("blockAckTimeoutValue");
-        // TODO addbaFailureTimeout = par("addbaFailureTimeout");
+        addbaFailureTimeout = par("addbaFailureTimeout");
+        if (addbaFailureTimeout <= 0)
+            throw cRuntimeError("addbaFailureTimeout must be greater than zero");
         WATCH(blockAckReqThreshold);
     }
 }
 
 simtime_t OriginatorBlockAckAgreementPolicy::computeAddbaFailureTimeout() const
 {
-    // TODO ADDBAFailureTimeout -- 6.3.29.2.2 Semantics of the service primitive
-    throw cRuntimeError("Unimplemented");
+    return addbaFailureTimeout;
 }
 
 bool OriginatorBlockAckAgreementPolicy::isAddbaReqNeeded(Packet *packet, const Ptr<const Ieee80211DataHeader>& header)
@@ -42,8 +43,7 @@ bool OriginatorBlockAckAgreementPolicy::isAddbaReqNeeded(Packet *packet, const P
 
 bool OriginatorBlockAckAgreementPolicy::isAddbaReqAccepted(const Ptr<const Ieee80211AddbaResponse>& addbaResp, OriginatorBlockAckAgreement *agreement)
 {
-    ASSERT(agreement);
-    return true;
+    return agreement != nullptr && addbaResp->getStatusCode() == 0;
 }
 
 bool OriginatorBlockAckAgreementPolicy::isDelbaAccepted(const Ptr<const Ieee80211Delba>& delba)
@@ -53,4 +53,3 @@ bool OriginatorBlockAckAgreementPolicy::isDelbaAccepted(const Ptr<const Ieee8021
 
 } /* namespace ieee80211 */
 } /* namespace inet */
-

src/inet/linklayer/ieee80211/mac/blockack/OriginatorBlockAckAgreementPolicy.ned

@@ -23,6 +23,6 @@ simple OriginatorBlockAckAgreementPolicy extends SimpleModule like IOriginatorBl
         bool aMsduSupported = default(true);
         int maximumAllowedBufferSize = default(64);
         double blockAckTimeoutValue @unit(s) = default(0s); // 0 means that it depends on the originator
+        double addbaFailureTimeout @unit(s) = default(1s);
         @display("i=block/control");
 }
-