LteMac: getConnDesc(), getMacBuffers(), getBsrVirtualBuffers(): replaced with better functions

Do not expose the internal maps -- leaky abstraction, hinders refactoring,etc

Replacements:
- getConnDesc(cid), getActiveConnDescCids()
- getMacBuffer(cid), getActiveMacBufferCids()
- getBsrVirtualBuffer(cid), getActiveBsrVirtualBufferCids()

Author: avarga

src/simu5g/stack/compManager/compManagerProportional/LteCompManagerProportional.cc

@@ -31,12 +31,11 @@ void LteCompManagerProportional::provisionalSchedule()
     provisionedBlocks_ = 0;
 
     Direction dir = DL;
-    std::map<MacCid, LteMacBuffer*> *vbuf = mac_->getMacBuffers();
     ActiveSet *activeSet = mac_->getActiveSet(dir);
     for (MacCid cid : *activeSet) {
         MacNodeId ueId = cid.getNodeId();
 
-        unsigned int queueLength = vbuf->at(cid)->getQueueOccupancy();
+        unsigned int queueLength = mac_->getMacBuffer(cid)->getQueueOccupancy();
 
         // Compute the number of bytes available in one block for this UE
         unsigned int bytesPerBlock = 0;

src/simu5g/stack/mac/LteMacBase.h

@@ -237,10 +237,23 @@ class LteMacBase : public cSimpleModule
         return cellId_;
     }
 
-    // Returns the virtual buffers
-    std::map<MacCid, LteMacBuffer*> *getMacBuffers()
+    // Returns the virtual buffer for a specific CID
+    LteMacBuffer* getMacBuffer(MacCid cid)
     {
-        return &macBuffers_;
+        auto it = macBuffers_.find(cid);
+        if (it == macBuffers_.end())
+            throw cRuntimeError("LteMacBase::getMacBuffer - Buffer for CID %s not found", cid.str().c_str());
+        return it->second;
+    }
+
+    // Returns list of active buffer CIDs
+    std::vector<MacCid> getActiveMacBufferCids()
+    {
+        std::vector<MacCid> activeCids;
+        activeCids.reserve(macBuffers_.size());
+        for (const auto& [cid,_] : macBuffers_)
+            activeCids.push_back(cid);
+        return activeCids;
     }
 
     // Returns Traffic Class to cid mapping
@@ -249,10 +262,23 @@ class LteMacBase : public cSimpleModule
         return lcgMap_;
     }
 
-    // Returns connection descriptors
-    std::map<MacCid, FlowControlInfo>& getConnDesc()
+    // Returns flow control info for a specific CID
+    const FlowControlInfo& getConnDesc(MacCid cid)
+    {
+        auto it = connDesc_.find(cid);
+        if (it == connDesc_.end())
+            throw cRuntimeError("LteMacBase: Connection %s not found", cid.str().c_str());
+        return it->second;
+    }
+
+    // Returns list of active connection CIDs
+    std::vector<MacCid> getActiveConnectionCids()
     {
-        return connDesc_;
+        std::vector<MacCid> activeCids;
+        activeCids.reserve(connDesc_.size());
+        for (const auto& [cid,_] : connDesc_)
+            activeCids.push_back(cid);
+        return activeCids;
     }
 
     // Returns the harq tx buffers

src/simu5g/stack/mac/LteMacEnb.h

@@ -175,9 +175,22 @@ class LteMacEnb : public LteMacBase
     ~LteMacEnb() override;
 
     /// Returns the BSR virtual buffers.
-    std::map<MacCid, LteMacBuffer*> *getBsrVirtualBuffers()
+    LteMacBuffer *getBsrVirtualBuffer(MacCid cid)
     {
-        return &bsrbuf_;
+        auto it = bsrbuf_.find(cid);
+        if (it == bsrbuf_.end())
+            throw cRuntimeError("LteMacBase::getBsrVirtualBuffer - Buffer for CID %s not found", cid.str().c_str());
+        return it->second;
+    }
+
+    // Returns list of active buffer CIDs
+    std::vector<MacCid> getActiveBsrVirtualBufferCids()
+    {
+        std::vector<MacCid> activeCids;
+        activeCids.reserve(bsrbuf_.size());
+        for (const auto& [cid,_] : bsrbuf_)
+            activeCids.push_back(cid);
+        return activeCids;
     }
 
     /**

src/simu5g/stack/mac/scheduler/LcgScheduler.cc

@@ -79,7 +79,7 @@ ScheduleList& LcgScheduler::schedule(unsigned int availableBytes, Direction gran
             for (it = it_pair.first; it != et; ++it) {
                 // get the Flow descriptor
                 MacCid cid = it->second.first;
-                FlowControlInfo connDesc = mac_->getConnDesc().at(cid);
+                FlowControlInfo connDesc = mac_->getConnDesc(cid);
                 if (connDesc.getDirection() == D2D) {
                     // get the connection virtual buffer
                     LteMacBuffer *vQueue = it->second.second;
@@ -106,7 +106,7 @@ ScheduleList& LcgScheduler::schedule(unsigned int availableBytes, Direction gran
             MacCid cid = it->second.first;
 
             // get the Flow descriptor
-            FlowControlInfo connDesc = mac_->getConnDesc().at(cid);
+            FlowControlInfo connDesc = mac_->getConnDesc(cid);
             // TODO get the QoS parameters
 
             // connection must have the same direction as the grant
@@ -341,4 +341,3 @@ ScheduleList& LcgScheduler::getScheduledBytesList()
 }
 
 } //namespace simu5g
-

src/simu5g/stack/mac/scheduler/LteSchedulerEnb.cc

@@ -48,8 +48,6 @@ LteSchedulerEnb& LteSchedulerEnb::operator=(const LteSchedulerEnb& other)
     activeConnectionSet_ = other.activeConnectionSet_;
     scheduleList_ = other.scheduleList_;
     allocatedCws_ = other.allocatedCws_;
-    vbuf_ = other.vbuf_;
-    bsrbuf_ = other.bsrbuf_;
     harqTxBuffers_ = other.harqTxBuffers_;
     harqRxBuffers_ = other.harqRxBuffers_;
     resourceBlocks_ = other.resourceBlocks_;
@@ -93,9 +91,6 @@ void LteSchedulerEnb::initialize(Direction dir, LteMacEnb *mac, Binder *binder)
 
     binder_ = binder;
 
-    vbuf_ = mac_->getMacBuffers();
-    bsrbuf_ = mac_->getBsrVirtualBuffers();
-
     harqTxBuffers_ = mac_->getHarqTxBuffers();
     harqRxBuffers_ = mac_->getHarqRxBuffers();
 
@@ -347,7 +342,7 @@ unsigned int LteSchedulerEnb::scheduleGrant(MacCid cid, unsigned int bytes, bool
     }
 
     // Get virtual buffer reference
-    LteMacBuffer *conn = ((dir == DL) ? vbuf_->at(cid) : bsrbuf_->at(cid));
+    LteMacBuffer *conn = (dir == DL) ? mac_->getMacBuffer(cid) : mac_->getBsrVirtualBuffer(cid);
 
     // get the buffer size
     unsigned int queueLength = conn->getQueueOccupancy(); // in bytes

src/simu5g/stack/mac/scheduler/LteSchedulerEnb.h

@@ -93,12 +93,6 @@ class LteSchedulerEnb
     // Codeword list
     LteMacAllocatedCws allocatedCws_;
 
-    // Pointer to downlink virtual buffers (that are in LteMacBase)
-    std::map<MacCid, LteMacBuffer*> *vbuf_ = nullptr;
-
-    // Pointer to uplink virtual buffers (that are in LteMacBase)
-    std::map<MacCid, LteMacBuffer*> *bsrbuf_ = nullptr;
-
     // Pointer to Harq Tx Buffers (that are in LteMacBase)
     std::map<GHz, HarqTxBuffers> *harqTxBuffers_ = nullptr;
 

src/simu5g/stack/mac/scheduling_modules/LteAllocatorBestFit.cc

@@ -137,7 +137,7 @@ void LteAllocatorBestFit::prepareSchedule()
         MacNodeId nodeId = cid.getNodeId();
 
         // Get virtual buffer reference
-        LteMacBuffer *conn = eNbScheduler_->bsrbuf_->at(cid);
+        LteMacBuffer *conn = eNbScheduler_->mac_->getBsrVirtualBuffer(cid);
         // Check whether the virtual buffer is empty
         if (conn->isEmpty()) {
             // The BSR buffer for this node is empty. Abort scheduling for the node: no data to transmit.
@@ -228,7 +228,7 @@ void LteAllocatorBestFit::prepareSchedule()
         // Compute Tx params for the extracted node
         const UserTxParams& txParams = mac_->getAmc()->computeTxParams(nodeId, dir, carrierFrequency_);
         // Get virtual buffer reference
-        LteMacBuffer *conn = eNbScheduler_->bsrbuf_->at(cid);
+        LteMacBuffer *conn = eNbScheduler_->mac_->getBsrVirtualBuffer(cid);
 
         // Get a reference of the first BSR
         PacketInfo vpkt = conn->front();

src/simu5g/stack/mac/scheduling_modules/LteDrr.cc

@@ -119,25 +119,20 @@ void LteDrr::commitSchedule()
 
 void LteDrr::updateSchedulingInfo()
 {
-    // Get connections.
-    std::map<MacCid, LteMacBuffer*> *conn;
-
-    if (direction_ == DL) {
-        conn = eNbScheduler_->mac_->getMacBuffers();
-    }
-    else if (direction_ == UL) {
-        conn = eNbScheduler_->mac_->getBsrVirtualBuffers();
-    }
-    else {
-        conn = nullptr;
+    // Get active buffer CIDs based on direction.
+    std::vector<MacCid> activeCids;
+
+    if (direction_ == DL)
+        activeCids = eNbScheduler_->mac_->getActiveMacBufferCids();
+    else if (direction_ == UL)
+        activeCids = eNbScheduler_->mac_->getActiveBsrVirtualBufferCids();
+    else
         throw cRuntimeError("LteDrr::updateSchedulingInfo invalid direction");
-    }
 
     // Select the minimum rate and MAC SDU size.
     double minSize = 0;
     double minRate = 0;
-    for (auto& it : *conn) {
-        MacCid cid = it.first;
+    for (MacCid cid : activeCids) {
         MacNodeId nodeId = cid.getNodeId();
         bool eligible = true;
         const UserTxParams& info = eNbScheduler_->mac_->getAmc()->computeTxParams(nodeId, direction_, carrierFrequency_);
@@ -181,4 +176,3 @@ void LteDrr::notifyActiveConnection(MacCid cid)
 }
 
 } //namespace
-

src/simu5g/stack/mac/scheduling_modules/LteMaxCiOptMB.cc

@@ -235,12 +235,8 @@ void LteMaxCiOptMB::generateProblem()
 
     appFileStream << "\\ ================ Constraint 6 ================" << endl;
     for ( iUe = 0; iUe < totUes; ++iUe) {
-        std::map<MacCid, LteMacBuffer*> *buf = mac_->getMacBuffers();
-        std::map<MacCid, LteMacBuffer*>::iterator it = buf->find(cidList_[iUe]);
-        int queue = 0;
-        if (it == mac_->getMacBuffers()->end())
-            cRuntimeError("LteMaxCiOptMB::generateProblem: Cannot find CID %s", cidList_[iUe].str().c_str());
-        queue = it->second->getQueueOccupancy();
+        LteMacBuffer *macBuffer = mac_->getMacBuffer(cidList_[iUe]);
+        int queue = macBuffer->getQueueOccupancy();
         MacNodeId ueId = ueList_[iUe];
         appFileStream << "v" << ueId << " - p" << ueId << " <= " << queue << endl;
     }