SDAP: Turn Qfi into strong typedef

avarga · avarga · commit 743ac26ab420 · 2026-03-06T12:49:41.000+01:00
diff --git a/src/simu5g/common/LteCommon.msg b/src/simu5g/common/LteCommon.msg
@@ -80,6 +80,19 @@ class DrbId {
     @fromValue(DrbId($.intValue()));
 };
 
+/// QoS Flow Identifier (6-bit, 0-63 per 3GPP TS 24.501)
+class Qfi {
+    @existingClass; // enum class Qfi : uint8_t;
+    @descriptor(false);
+    @primitive;
+    @castFunction(false);
+    @fromString(Qfi(string2int64($)));
+    @toString(int642string(num($)));
+    @defaultValue(QFI_NONE);
+    @toValue((omnetpp::intval_t)(num($)));
+    @fromValue(Qfi($.intValue()));
+};
+
 /// Connection Identifier: <MacNodeId,LogicalCid>
 class MacCid {
     @existingClass; // class MacCid with separate nodeId and lcid fields
diff --git a/src/simu5g/common/LteTypes.h b/src/simu5g/common/LteTypes.h
@@ -74,6 +74,10 @@ SIMU5G_STRONG_TYPEDEF(LogicalCid, unsigned short)
 /// Data Radio Bearer Identifier (used in PDCP/RLC layers, maps 1:1 to LogicalCid)
 SIMU5G_STRONG_TYPEDEF(DrbId, unsigned short)
 
+/// QoS Flow Identifier (6-bit, 0-63 per 3GPP TS 24.501)
+SIMU5G_STRONG_TYPEDEF(Qfi, uint8_t)
+constexpr Qfi QFI_NONE = Qfi(0);
+
 /// Invalid/uninitialized LCID and DRB ID values
 constexpr LogicalCid LCID_NONE = LogicalCid(65535);
 constexpr DrbId DRBID_NONE = DrbId(65535);
diff --git a/src/simu5g/common/QfiTag.msg b/src/simu5g/common/QfiTag.msg
@@ -9,6 +9,7 @@
 //
 import inet.common.INETDefs;
 import inet.common.TagBase;
+import simu5g.common.LteCommon;
 
 cplusplus {{
    using namespace inet;
@@ -27,7 +28,7 @@ namespace simu5g;
 // QfiInd is typically used when receiving packets upwards.
 //
 class QfiTagBase extends inet::TagBase {
-	    uint8_t qfi = 0;  // QFI value (range: 0–63), defaults to 0 if not set
+	    Qfi qfi;  // QFI value (range: 0–63)
 }
 
 class QfiReq extends QfiTagBase
diff --git a/src/simu5g/corenetwork/gtp/GtpUser.cc b/src/simu5g/corenetwork/gtp/GtpUser.cc
@@ -146,9 +146,9 @@ void GtpUser::handleFromTrafficFlowFilter(Packet *datagram)
 
     auto tftInfo = datagram->removeTag<TftControlInfo>();
     TrafficFlowTemplateId flowId = tftInfo->getTft();
-    uint8_t qfi = tftInfo->getQfi();
+    Qfi qfi = tftInfo->getQfi();
 
-    EV << "GtpUser::handleFromTrafficFlowFilter - Received a tftMessage with flowId[" << flowId << "] qfi[" << (int)qfi << "]" << endl;
+    EV << "GtpUser::handleFromTrafficFlowFilter - Received a tftMessage with flowId[" << flowId << "] qfi[" << qfi << "]" << endl;
 
     if (flowId == TFT_REMOVED_DESTINATION) {
         // the destination has been removed from the simulation. Delete datagram
@@ -235,7 +235,7 @@ void GtpUser::handleFromUdp(Packet *pkt)
     originalPacket->addTagIfAbsent<PacketProtocolTag>()->setProtocol(&Protocol::ipv4);
 
     // Restore QFI from GTP-U header so SDAP can use it for QFI-to-DRB mapping
-    if (gtpUserMsg->getQfi() > 0)
+    if (gtpUserMsg->getQfi() != QFI_NONE)
         originalPacket->addTagIfAbsent<QfiReq>()->setQfi(gtpUserMsg->getQfi());
     // remove any pending socket indications
     auto sockInd = pkt->removeTagIfPresent<SocketInd>();
diff --git a/src/simu5g/corenetwork/gtp/GtpUserMsg.msg b/src/simu5g/corenetwork/gtp/GtpUserMsg.msg
@@ -11,11 +11,12 @@
 
 import inet.common.INETDefs;
 import inet.common.packet.chunk.Chunk;
+import simu5g.common.LteCommon;
 
 namespace simu5g;
 
 class GtpUserMsg extends inet::FieldsChunk {
     unsigned int teid;
-    uint8_t qfi = 0;  // QoS Flow Identifier (carried in PDU Session Container in real GTP-U)
+    Qfi qfi;  // QoS Flow Identifier (carried in PDU Session Container in real GTP-U)
     chunkLength = inet::B(1); // TODO: size 0
 }
diff --git a/src/simu5g/corenetwork/trafficFlowFilter/TftControlInfo.msg b/src/simu5g/corenetwork/trafficFlowFilter/TftControlInfo.msg
@@ -18,5 +18,5 @@ namespace simu5g;
 class TftControlInfo extends inet::TagBase
 {
     unsigned int tft;
-    uint8_t qfi = 0;  // QFI derived from IP DSCP (simplified PDR matching)
+    Qfi qfi;  // QFI derived from IP DSCP (simplified PDR matching)
 };
diff --git a/src/simu5g/corenetwork/trafficFlowFilter/TrafficFlowFilter.cc b/src/simu5g/corenetwork/trafficFlowFilter/TrafficFlowFilter.cc
@@ -135,9 +135,10 @@ void TrafficFlowFilter::handleMessage(cMessage *msg)
 
     // Simplified QFI derivation: use IP DSCP as QFI directly.
     // In a real 5G UPF, this would be done via PDR/QER rules.
-    tftInfo->setQfi(ipv4Header->getDscp());
+    Qfi qfi = Qfi(ipv4Header->getDscp());
+    tftInfo->setQfi(qfi);
 
-    EV << "TrafficFlowFilter::handleMessage - setting tft=" << tftId << " qfi=" << (int)ipv4Header->getDscp() << endl;
+    EV << "TrafficFlowFilter::handleMessage - setting tft=" << tftId << " qfi=" << qfi << endl;
 
     // send the datagram to the GTP-U module
     send(pkt, "gtpUserGateOut");
diff --git a/src/simu5g/stack/sdap/NrSdap.cc b/src/simu5g/stack/sdap/NrSdap.cc
@@ -59,7 +59,7 @@ bool NrSdap::requiresSdapHeader(const DrbConfig *drb)
     return drb->isDefault || drb->qfiList.size() > 1;
 }
 
-bool NrSdap::shouldEnableReflectiveQos(int qfi)
+bool NrSdap::shouldEnableReflectiveQos(Qfi qfi)
 {
     return par("useReflectiveQos").boolValue(); // for now -- should come from RRC config
 }
@@ -106,35 +106,35 @@ void NrSdap::handleMessage(cMessage *msg)
 
 void NrSdap::handleUpperPacket(inet::Packet *pkt)
 {
-    uint8_t qfi = 0;
+    Qfi qfi = QFI_NONE;
     bool qfiFromReflectiveQos = false;
 
     // Extract QFI from QfiReq tag if present (set by GtpUser from GTP-U header, or by app directly)
     if (pkt->hasTag<QfiReq>()) {
         qfi = pkt->getTag<QfiReq>()->getQfi();
-        EV_INFO << "SDAP TX: QFI = " << (int)qfi << " extracted from QfiReq\n";
+        EV_INFO << "SDAP TX: QFI = " << qfi << " extracted from QfiReq\n";
     }
     else if (isUe) {
         // UE UL: try reflective QoS first (3GPP-defined mechanism)
         if (reflectiveQosTable != nullptr) {
-            uint8_t reflectiveQfi = reflectiveQosTable->lookupUplinkQfi(pkt);
-            if (reflectiveQfi > 0) {
+            Qfi reflectiveQfi = reflectiveQosTable->lookupUplinkQfi(pkt);
+            if (reflectiveQfi != QFI_NONE) {
                 qfi = reflectiveQfi;
                 qfiFromReflectiveQos = true;
-                EV_INFO << "SDAP TX: QFI = " << (int)qfi << " derived from reflective QoS\n";
+                EV_INFO << "SDAP TX: QFI = " << qfi << " derived from reflective QoS\n";
             }
         }
         // Optional non-standard fallback: derive QFI from DSCP field of the IP header
-        if (qfi == 0 && par("useDscpAsQfiFallback").boolValue()) {
+        if (qfi == QFI_NONE && par("useDscpAsQfiFallback").boolValue()) {
             if (pkt->hasTag<FlowControlInfo>()) {
                 uint8_t tos = (uint8_t)pkt->getTag<FlowControlInfo>()->getTypeOfService();
                 if (tos > 0) {
-                    qfi = tos >> 2;
-                    EV_INFO << "SDAP TX: QFI = " << (int)qfi << " derived from DSCP (fallback)\n";
+                    qfi = Qfi(tos >> 2);
+                    EV_INFO << "SDAP TX: QFI = " << qfi << " derived from DSCP (fallback)\n";
                 }
             }
         }
-        if (qfi == 0)
+        if (qfi == QFI_NONE)
             EV_WARN << "SDAP TX: No QFI from reflective QoS or DSCP, using QFI=0 (default DRB)\n";
     }
     else {
@@ -153,13 +153,13 @@ void NrSdap::handleUpperPacket(inet::Packet *pkt)
     if (!drb) {
         drb = drbTable_.getDefaultDrb(nodeId);
         if (drb)
-            EV_WARN << "SDAP TX: No DRB mapping for nodeId=" << nodeId << " QFI=" << (int)qfi
+            EV_WARN << "SDAP TX: No DRB mapping for nodeId=" << nodeId << " QFI=" << qfi
                     << ", falling back to default DRB " << drb->drbId << "\n";
     }
     if (!drb)
         throw cRuntimeError("SDAP TX: No DRB available for nodeId=%d", (int)num(nodeId));
 
-    EV_INFO << "SDAP TX: Selected DRB=" << drb->drbId << " for QFI=" << (int)qfi << "\n";
+    EV_INFO << "SDAP TX: Selected DRB=" << drb->drbId << " for QFI=" << qfi << "\n";
 
     // Check if SDAP header is required for this DRB
     if (requiresSdapHeader(drb)) {
@@ -172,7 +172,7 @@ void NrSdap::handleUpperPacket(inet::Packet *pkt)
         sdapHeader->setReflectiveQoS(enableReflectiveQos);
 
         pkt->insertAtFront(sdapHeader);
-        EV_INFO << "SDAP TX: Inserted SDAP header with QFI = " << (int)qfi
+        EV_INFO << "SDAP TX: Inserted SDAP header with QFI = " << qfi
                 << ", reflectiveQoS = " << (enableReflectiveQos ? "true" : "false") << "\n";
     }
     else {
@@ -207,7 +207,7 @@ void NrSdap::handleLowerPacket(inet::Packet *pkt)
 
     EV_INFO << "SDAP RX: Received packet from DRB " << drbId << ": " << pkt->peekAtFront() << "\n";
 
-    int qfi = 0;
+    Qfi qfi = QFI_NONE;
 
     // Check if packet has SDAP header (should be at the front according to 3GPP TS 37.324)
     if (requiresSdapHeader(drb)) {
@@ -218,14 +218,14 @@ void NrSdap::handleLowerPacket(inet::Packet *pkt)
         EV_INFO << "SDAP RX: Extracted SDAP header with QFI = " << qfi << "\n";
 
         // Validate QFI range (0-63 according to 3GPP)
-        if (qfi > 63) {
+        if (num(qfi) > 63) {
             EV_WARN << "SDAP RX: Invalid QFI value " << qfi << " (should be 0-63)\n";
-            qfi = 0; // Use default QFI
+            qfi = QFI_NONE;
         }
 
         // Handle reflective QoS if UE and enabled
         if (sdapHeader->getReflectiveQoS()) {
-            EV_INFO << "SDAP RX: Reflective QoS enabled for QFI " << (int)qfi << "\n";
+            EV_INFO << "SDAP RX: Reflective QoS enabled for QFI " << qfi << "\n";
             if (isUe && reflectiveQosTable != nullptr) {
                 reflectiveQosTable->handleDownlinkFlow(pkt, qfi);
             }
@@ -243,7 +243,7 @@ void NrSdap::handleLowerPacket(inet::Packet *pkt)
 
     // Validate QFI ↔ DRB consistency
     if (drb) {
-        if (!contains(drb->qfiList, (int)qfi))
+        if (!contains(drb->qfiList, qfi))
             EV_WARN << "SDAP RX: DRB/QFI mismatch! Received on DRB=" << drbId << ", QFI=" << qfi << " not in qfiList\n";
     }
 
@@ -255,7 +255,7 @@ void NrSdap::handleLowerPacket(inet::Packet *pkt)
     const inet::Protocol *upperProto = getUpperProtocol(drb);
     pkt->addTagIfAbsent<PacketProtocolTag>()->setProtocol(upperProto);
 
-    EV_INFO << "SDAP RX: Forwarding packet with QFI " << qfi << " to upper layer (protocol: " << upperProto->getName() << ")\n";
+    EV_INFO << "SDAP RX: Forwarding packet with QFI=" << qfi << " to upper layer (protocol: " << upperProto->getName() << ")\n";
     send(pkt, "upperLayerOut");
 }
 
diff --git a/src/simu5g/stack/sdap/NrSdap.h b/src/simu5g/stack/sdap/NrSdap.h
@@ -54,7 +54,7 @@ class NrSdap : public cSimpleModule
 
   protected:
     bool requiresSdapHeader(const DrbConfig *drb);
-    bool shouldEnableReflectiveQos(int qfi);
+    bool shouldEnableReflectiveQos(Qfi qfi);
     const inet::Protocol *getUpperProtocol(const DrbConfig *ctx);
     virtual void initialize() override;
     virtual void handleMessage(cMessage *msg) override;
diff --git a/src/simu5g/stack/sdap/common/DrbConfig.h b/src/simu5g/stack/sdap/common/DrbConfig.h
@@ -22,7 +22,7 @@ struct DrbConfig {
     DrbId drbId = DRBID_NONE;         // DRB identifier (= nrPdcp[]/nrRlc[] array index)
     MacNodeId ueNodeId = NODEID_NONE; // NODEID_NONE = "self" (UE side); numeric MacNodeId on gNB
     bool isDefault = false;           // true if this is the default DRB for this UE
-    std::vector<int> qfiList;       // QFIs mapped to this DRB
+    std::vector<Qfi> qfiList;       // QFIs mapped to this DRB
     LteRlcType rlcType = UM;        // RLC mode for this DRB (AM, UM, TM)
     PduSessionType pduSessionType = IP_V4;  // PDU session type (3GPP TS 23.501)
     std::string upperProtocol;  // INET protocol name for upper layer dispatch (empty = derive from pduSessionType)
@@ -42,7 +42,7 @@ inline std::ostream& operator<<(std::ostream& os, const DrbConfig& ctx) {
     return os;
 }
 
-inline std::ostream& operator<<(std::ostream& os, const std::pair<MacNodeId,int>& p) {
+inline std::ostream& operator<<(std::ostream& os, const std::pair<MacNodeId,Qfi>& p) {
     os << "(" << p.first << "," << p.second << ")";
     return os;
 }
diff --git a/src/simu5g/stack/sdap/common/DrbTable.cc b/src/simu5g/stack/sdap/common/DrbTable.cc
@@ -39,7 +39,7 @@ void DrbTable::loadFromJson(const cValueArray *arr)
         // qfiList
         const cValueArray *qfiArr = check_and_cast<const cValueArray *>(entry->get("qfiList").objectValue());
         for (int j = 0; j < (int)qfiArr->size(); j++)
-            ctx.qfiList.push_back(qfiArr->get(j).intValue());
+            ctx.qfiList.push_back(Qfi(qfiArr->get(j).intValue()));
 
         // rlcType (optional, default UM)
         if (entry->containsKey("rlcType"))
@@ -76,7 +76,7 @@ void DrbTable::loadFromJson(const cValueArray *arr)
 
         // Build reverse lookup: (nodeId, qfi) -> DrbConfig*
         const DrbConfig *ptr = &ctx;
-        for (int qfi : ctx.qfiList)
+        for (Qfi qfi : ctx.qfiList)
             qfiToDrb_[{ctx.ueNodeId, qfi}] = ptr;
 
         // Build default DRB map
@@ -94,7 +94,7 @@ const DrbConfig* DrbTable::getDrb(DrbKey key) const
     return it != drbMap_.end() ? &it->second : nullptr;
 }
 
-const DrbConfig* DrbTable::getDrbForQfi(MacNodeId nodeId, int qfi) const
+const DrbConfig* DrbTable::getDrbForQfi(MacNodeId nodeId, Qfi qfi) const
 {
     auto it = qfiToDrb_.find({nodeId, qfi});
     return it != qfiToDrb_.end() ? it->second : nullptr;
diff --git a/src/simu5g/stack/sdap/common/DrbTable.h b/src/simu5g/stack/sdap/common/DrbTable.h
@@ -30,7 +30,7 @@ class DrbTable
     std::map<DrbKey, DrbConfig> drbMap_;
 
     // Reverse lookup: (nodeId, qfi) -> DrbConfig*  (UE uses NODEID_NONE as nodeId)
-    std::map<std::pair<MacNodeId,int>, const DrbConfig*> qfiToDrb_;
+    std::map<std::pair<MacNodeId,Qfi>, const DrbConfig*> qfiToDrb_;
 
     // Default DRB per nodeId (UE: NODEID_NONE key; gNB: per-UE keys)
     std::map<MacNodeId, const DrbConfig*> defaultDrb_;
@@ -45,7 +45,7 @@ class DrbTable
     const DrbConfig* getDrb(DrbKey key) const;
 
     // Reverse lookup: (nodeId, qfi) -> DrbConfig  (UE passes NODEID_NONE)
-    const DrbConfig* getDrbForQfi(MacNodeId nodeId, int qfi) const;
+    const DrbConfig* getDrbForQfi(MacNodeId nodeId, Qfi qfi) const;
 
     // Default DRB for a given nodeId (gNB: per-UE; UE: NODEID_NONE)
     const DrbConfig* getDefaultDrb(MacNodeId nodeId) const;
diff --git a/src/simu5g/stack/sdap/common/ReflectiveQosTable.cc b/src/simu5g/stack/sdap/common/ReflectiveQosTable.cc
@@ -60,7 +60,7 @@ void ReflectiveQosTable::finish()
 }
 
 
-void ReflectiveQosTable::handleDownlinkFlow(inet::Packet *pkt, uint8_t qfi)
+void ReflectiveQosTable::handleDownlinkFlow(inet::Packet *pkt, Qfi qfi)
 {
     // Extract flow key from the packet
     FlowKey downlinkFlowKey = extractFlowKey(pkt);
@@ -80,37 +80,37 @@ void ReflectiveQosTable::handleDownlinkFlow(inet::Packet *pkt, uint8_t qfi)
         it->second.lastSeen = simTime();
         it->second.isActive = true;
         EV_INFO << "ReflectiveQosTable: Updated reflective QoS flow: " << uplinkFlowKey.toString()
-                << " -> QFI " << (int)qfi << "\n";
+                << " -> QFI " << qfi << "\n";
     } else {
         // Create new reflective flow
         ReflectiveQosFlow newFlow(qfi, uplinkFlowKey);
         reflectiveFlows_[uplinkFlowKey] = newFlow;
         EV_INFO << "ReflectiveQosTable: Created new reflective QoS flow: " << uplinkFlowKey.toString()
-                << " -> QFI " << (int)qfi << "\n";
+                << " -> QFI " << qfi << "\n";
     }
 
     // Cleanup expired flows periodically
     cleanupExpiredFlows();
 }
 
-uint8_t ReflectiveQosTable::lookupUplinkQfi(inet::Packet *pkt)
+Qfi ReflectiveQosTable::lookupUplinkQfi(inet::Packet *pkt)
 {
     if (reflectiveFlows_.empty())
-        return 0;
+        return QFI_NONE;
 
     // Extract flow key from the packet
     FlowKey uplinkFlowKey = extractFlowKey(pkt);
 
     if (uplinkFlowKey.srcAddr.empty() || uplinkFlowKey.dstAddr.empty())
-        return 0;
+        return QFI_NONE;
 
     // Look up the flow in reflective flows
     auto it = reflectiveFlows_.find(uplinkFlowKey);
     if (it != reflectiveFlows_.end() && it->second.isActive) {
         // Check if flow hasn't expired
         if (simTime() - it->second.lastSeen <= timeout_) {
             EV_INFO << "ReflectiveQosTable: Found reflective QoS match: " << uplinkFlowKey.toString()
-                    << " -> QFI " << (int)it->second.qfi << "\n";
+                    << " -> QFI " << it->second.qfi << "\n";
             return it->second.qfi;
         }
         else {
@@ -120,7 +120,7 @@ uint8_t ReflectiveQosTable::lookupUplinkQfi(inet::Packet *pkt)
         }
     }
 
-    return 0; // No match found
+    return QFI_NONE; // No match found
 }
 
 void ReflectiveQosTable::cleanupExpiredFlows()
@@ -163,7 +163,7 @@ void ReflectiveQosTable::printFlows() const
         std::cout << "Flow mappings:" << std::endl;
         for (const auto& pair : reflectiveFlows_) {
             const ReflectiveQosFlow& flow = pair.second;
-            EV_INFO << "  " << pair.first.toString() << " -> QFI " << (int)flow.qfi
+            EV_INFO << "  " << pair.first.toString() << " -> QFI " << flow.qfi
                      << " (last seen: " << flow.lastSeen << ", active: " << (flow.isActive ? "Yes" : "No") << ")" << std::endl;
         }
     }
diff --git a/src/simu5g/stack/sdap/common/ReflectiveQosTable.h b/src/simu5g/stack/sdap/common/ReflectiveQosTable.h
diff --git a/src/simu5g/stack/sdap/packet/NrSdapHeader.msg b/src/simu5g/stack/sdap/packet/NrSdapHeader.msg

Original file line number	Diff line number	Diff line change
`@@ -18,5 +18,5 @@ namespace simu5g;`
`18`	`18`	`class TftControlInfo extends inet::TagBase`
`19`	`19`	`{`
`20`	`20`	`unsigned int tft;`
`21`		`- uint8_t qfi = 0; // QFI derived from IP DSCP (simplified PDR matching)`
	`21`	`+ Qfi qfi; // QFI derived from IP DSCP (simplified PDR matching)`
`22`	`22`	`};`