nr-no-backhaul-epc-helper.h

// Copyright (c) 2019 Centre Tecnologic de Telecomunicacions de Catalunya (CTTC)
//
// SPDX-License-Identifier: GPL-2.0-only
//
// Author: Manuel Requena <manuel.requena@cttc.es>
//         (based on the original point-to-point-epc-helper.h)
 
#ifndef NR_NO_BACKHAUL_EPC_HELPER_H
#define NR_NO_BACKHAUL_EPC_HELPER_H
 
#include "nr-epc-helper.h"
 
namespace ns3
{
 
class NrEpcSgwApplication;
class NrEpcPgwApplication;
class NrEpcMmeApplication;
 
class NrNoBackhaulEpcHelper : public NrEpcHelper
{
  public:
    NrNoBackhaulEpcHelper();
 
    ~NrNoBackhaulEpcHelper() override;
 
    // inherited from Object
    static TypeId GetTypeId();
    void DoDispose() override;
 
    // inherited from NrEpcHelper
    void AddGnb(Ptr<Node> gnbNode,
                Ptr<NetDevice> nrGnbNetDevice,
                std::vector<uint16_t> cellIds) override;
    void AddUe(Ptr<NetDevice> ueNrDevice, uint64_t imsi) override;
    void AddX2Interface(Ptr<Node> gnbNode1, Ptr<Node> gnbNode2) override;
    void AddS1Interface(Ptr<Node> gnb,
                        Ipv4Address gnbAddress,
                        Ipv4Address sgwAddress,
                        std::vector<uint16_t> cellIds) override;
    uint8_t ActivateEpsBearer(Ptr<NetDevice> ueNrDevice,
                              uint64_t imsi,
                              Ptr<NrEpcTft> tft,
                              NrEpsBearer bearer) override;
    Ptr<Node> GetSgwNode() const override;
    Ptr<Node> GetPgwNode() const override;
    Ipv4InterfaceContainer AssignUeIpv4Address(NetDeviceContainer ueDevices) override;
    Ipv6InterfaceContainer AssignUeIpv6Address(NetDeviceContainer ueDevices) override;
    Ipv4Address GetUeDefaultGatewayAddress() override;
    Ipv6Address GetUeDefaultGatewayAddress6() override;
    int64_t AssignStreams(int64_t stream) override;
    std::pair<Ptr<Node>, Ipv4Address> SetupRemoteHost(std::optional<std::string> dataRate,
                                                      std::optional<uint16_t> mtu,
                                                      std::optional<Time> delay) override;
    std::pair<Ptr<Node>, Ipv6Address> SetupRemoteHost6(std::optional<std::string> dataRate,
                                                       std::optional<uint16_t> mtu,
                                                       std::optional<Time> delay) override;
 
  protected:
    virtual void DoAddX2Interface(const Ptr<NrEpcX2>& gnb1X2,
                                  const Ptr<NetDevice>& gnb1NrDev,
                                  const Ipv4Address& gnb1X2Address,
                                  const Ptr<NrEpcX2>& gnb2X2,
                                  const Ptr<NetDevice>& gnb2NrDev,
                                  const Ipv4Address& gnb2X2Address) const;
 
    virtual void DoActivateEpsBearerForUe(const Ptr<NetDevice>& ueDevice,
                                          const Ptr<NrEpcTft>& tft,
                                          const NrEpsBearer& bearer) const;
 
  private:
    Ipv4AddressHelper m_uePgwAddressHelper;
    Ipv6AddressHelper m_uePgwAddressHelper6;
 
    Ptr<Node> m_pgw;
 
    Ptr<Node> m_sgw;
 
    Ptr<Node> m_mme;
 
    Ptr<NrEpcSgwApplication> m_sgwApp;
 
    Ptr<NrEpcPgwApplication> m_pgwApp;
 
    Ptr<NrEpcMmeApplication> m_mmeApp;
 
    Ptr<VirtualNetDevice> m_tunDevice;
 
    uint16_t m_gtpuUdpPort;
 
    Ipv4AddressHelper m_s11Ipv4AddressHelper;
 
    DataRate m_s11LinkDataRate;
 
    Time m_s11LinkDelay;
 
    uint16_t m_s11LinkMtu;
 
    uint16_t m_gtpcUdpPort;
 
    Ipv4AddressHelper m_s5Ipv4AddressHelper;
 
    DataRate m_s5LinkDataRate;
 
    Time m_s5LinkDelay;
 
    uint16_t m_s5LinkMtu;
 
    std::map<uint64_t, Ptr<NetDevice>> m_imsiGnbDeviceMap;
 
    Ipv4AddressHelper m_x2Ipv4AddressHelper;
 
    DataRate m_x2LinkDataRate;
 
    Time m_x2LinkDelay;
 
    uint16_t m_x2LinkMtu;
 
    bool m_x2LinkEnablePcap;
 
    std::string m_x2LinkPcapPrefix;
};
 
} // namespace ns3
 
#endif // NR_NO_BACKHAUL_EPC_HELPER_H