nr-gnb-component-carrier-manager.h

// Copyright (c) 2015 Danilo Abrignani
//
// SPDX-License-Identifier: GPL-2.0-only
//
// Author: Danilo Abrignani <danilo.abrignani@unibo.it>
 
#ifndef NR_GNB_COMPONENT_CARRIER_MANAGER_H
#define NR_GNB_COMPONENT_CARRIER_MANAGER_H
 
#include "nr-ccm-mac-sap.h"
#include "nr-ccm-rrc-sap.h"
#include "nr-gnb-cmac-sap.h"
#include "nr-gnb-rrc.h"
#include "nr-mac-sap.h"
#include "nr-rrc-sap.h"
 
#include "ns3/object.h"
 
#include <map>
#include <vector>
 
namespace ns3
{
 
class NrCcmRrcSapUser;
class NrCcmRrcSapProvider;
class NrMacSapUser;
class NrMacSapProvider;
class NrGnbCmacSapProvider;
class NrCcmMacSapProvider;
 
class NrGnbComponentCarrierManager : public Object
{
  public:
    NrGnbComponentCarrierManager();
    ~NrGnbComponentCarrierManager() override;
    static TypeId GetTypeId();
 
    virtual void SetNrCcmRrcSapUser(NrCcmRrcSapUser* s);
 
    virtual NrCcmRrcSapProvider* GetNrCcmRrcSapProvider();
 
    virtual NrCcmMacSapUser* GetNrCcmMacSapUser();
 
    virtual NrMacSapProvider* GetNrMacSapProvider();
 
    virtual bool SetMacSapProvider(uint8_t componentCarrierId, NrMacSapProvider* sap);
 
    virtual bool SetCcmMacSapProviders(uint8_t componentCarrierId, NrCcmMacSapProvider* sap);
 
    virtual void SetNumberOfComponentCarriers(uint16_t noOfComponentCarriers);
 
  protected:
    // inherited from Object
    void DoDispose() override;
 
    virtual void DoReportUeMeas(uint16_t rnti, NrRrcSap::MeasResults measResults) = 0;
 
    struct NrUeInfo
    {
        std::map<uint8_t, NrMacSapUser*>
            m_ueAttached; 
        std::map<uint8_t, NrGnbCmacSapProvider::LcInfo>
            m_rlcLcInstantiated; 
        uint8_t m_enabledComponentCarrier; 
        uint8_t m_ueState;                 
    };
 
    std::map<uint16_t, NrUeInfo> m_ueInfo; 
    uint16_t m_noOfComponentCarriers; 
    // pointer to RRC object for direct function calls, e.g. when CCM needs to obtain
    // a pointer to RLC object of a specific flow
    Ptr<NrGnbRrc> m_rrc; 
 
    /*
     * This interface is used to receive API calls from the RLC instance that through
     * NrMacSapProvider interface. The component carrier manager acts a proxy. This means that all
     * RLC instances will see as in previous architecture the NrMacSapProvider interface, but the
     * actual provider in new architecture will be some of child classes of
     * NrGnbComponentCarrierManager. So, NrGnbComponentCarrierManager class will receive function
     * calls that are meant for MAC, and will forward them to the MAC of the component carriers
     * based on the logic implemented in NrComponentCarrierManager. This attribute will be
     * initialized by using class that implements NrMacSapProvider interface and class that
     * implements NrGnbComponentCarrierManager base class e.g.:GnbMacMemberNrMacSapProvider
     * <NrGnbComponentCarrierManagerImpl>
     */
    NrMacSapProvider* m_macSapProvider; 
    // This map is initialized in NrHelper when the Component Carrier Manager is initialized,
    // contains component carrier id and a pointer to the corresponding NrMacSapProvider interface
    // of the MAC instance
    std::map<uint8_t, NrMacSapProvider*>
        m_macSapProvidersMap; 
    // This map contains pointers to NrCcmMacSapProvider interfaces of the
    // MAC instances. NrCcmMacSapProvider is new interface added for the
    // communication between component carrier manager and MAC instance,
    // to allow CCM to control UL buffer status reporting, and forwarding to
    // schedulers. Before adding carrier aggregation to NR module, MAC was
    // directly forwarding UL buffer status report to scheduler. Now is this
    // done through CCM, which decides to which MAC scheduler to forward UL BSR.
    std::map<uint8_t, NrCcmMacSapProvider*>
        m_ccmMacSapProviderMap; 
    NrCcmMacSapUser*
        m_ccmMacSapUser; 
    NrCcmRrcSapUser* m_ccmRrcSapUser; 
    NrCcmRrcSapProvider*
        m_ccmRrcSapProvider; 
 
}; // end of class NrGnbComponentCarrierManager
 
} // end of namespace ns3
 
#endif /* NR_GNB_COMPONENT_CARRIER_MANAGER_H */