PacketFlowObserverBase.h Source File¶

Simu5G: PacketFlowObserverBase.h Source File
Simu5G
//
//                  Simu5G
//
// Copyright (C) 2019-2021 Giovanni Nardini, Giovanni Stea, Antonio Virdis et al. (University of Pisa)
// Copyright (C) 2022-2026 Giovanni Nardini, Giovanni Stea et al. (University of Pisa)
//
// This file is part of a software released under the license included in file
// "license.pdf". Please read LICENSE and README files before using it.
// The above files and the present reference are part of the software itself,
// and cannot be removed from it.
//
 
#ifndef _LTE_PacketFlowObserverBASE_H_
#define _LTE_PacketFlowObserverBASE_H_
 
#include "simu5g/common/LteCommon.h"
#include "simu5g/mec/utils/MecCommon.h"
 
namespace simu5g {
 
using namespace omnetpp;
 
typedef std::set<unsigned int> SequenceNumberSet;
typedef unsigned int BurstId;
 
class LteRlcUmDataPdu;
struct StatusDescriptor;
class PacketFlowObserverBase : public cSimpleModule, public cListener
{
  protected:
 
    /*
     * this structure maintains the state of a PDCP
     * used to calculate L2Meas of RNI service
     */
    struct PdcpStatus {
        bool hasArrivedAll;
        bool discardedAtRlc;
        bool discardedAtMac;
        bool sentOverTheAir;
        unsigned int pdcpSduSize;
        simtime_t entryTime;
    };
 
    DiscardedPkts pktDiscardCounterTotal_; // total discarded packets counter of the node
 
    RanNodeType nodeType_; // UE or NODEB (used for set MACROS)
    short int harqProcesses_; // number of HARQ processes
 
    std::string pfmType;
 
  protected:
    int numInitStages() const override { return inet::NUM_INIT_STAGES; }
    void initialize(int stage) override;
 
    // Return true if a data structure for this bearer is present.
    // Bearers are keyed by (peer node, DRB ID): DRB IDs are only unique per
    // peer pair, so a bare DRB ID does not identify a bearer at a node.
    virtual bool hasDrbId(DrbKey drbKey) = 0;
 
    // Initialize a new data structure for this bearer. Abstract since in eNodeB case,
    // it initializes different structures with respect to the UE
    virtual void initDrbId(DrbKey drbKey, MacNodeId nodeId) = 0;
 
    // Reset the data structure for this bearer. Abstract since in eNodeB case,
    // it clears different structures with respect to the UE
    virtual void clearDrbId(DrbKey drbKey) = 0;
 
    // Reset data structures for all connections
    virtual void clearAllDrbIds() = 0;
 
  public:
    virtual void insertPdcpSdu(inet::Packet *pdcpPkt) = 0;
    virtual void receivedPdcpSdu(inet::Packet *pdcpPkt) = 0;
    virtual void insertRlcPdu(DrbKey drbKey, const LteRlcUmDataPdu *rlcPdu, RlcBurstStatus status) = 0;
    virtual void macPduArrived(MacNodeId peerId, const LteMacPdu *macPdu) = 0;
    virtual void ulMacPduArrived(MacNodeId nodeId, unsigned int grantId) {};
    virtual void discardMacPdu(MacNodeId peerId, const LteMacPdu *macPdu) = 0;
    virtual void discardRlcPdu(DrbKey drbKey, unsigned int rlcSno, bool fromMac = false) = 0;
    virtual void grantSent(MacNodeId nodeId, unsigned int grantId) {}
 
    virtual void resetDiscardCounter();
 
    // cListener interface for receiving signals from protocol layers
    void receiveSignal(cComponent *source, simsignal_t signalID, cObject *obj, cObject *details) override;
};
 
} //namespace
 
#endif