lte-enb-rrc.h

Go to the documentation of this file.

/* -*-  Mode: C++; c-file-style: "gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2011, 2012 Centre Tecnologic de Telecomunicacions de Catalunya (CTTC)
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation;
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 * Authors: Nicola Baldo <nbaldo@cttc.es>
 *          Marco Miozzo <mmiozzo@cttc.es>
 *          Manuel Requena <manuel.requena@cttc.es> 
 */

#ifndef LTE_ENB_RRC_H
#define LTE_ENB_RRC_H

#include <ns3/nstime.h>
#include <ns3/object.h>
#include <ns3/traced-callback.h>
#include <ns3/event-id.h>

#include <ns3/lte-enb-cmac-sap.h>
#include <ns3/lte-mac-sap.h>
#include <ns3/ff-mac-sched-sap.h>
#include <ns3/ff-mac-csched-sap.h>
#include <ns3/lte-pdcp-sap.h>
#include <ns3/epc-x2-sap.h>
#include <ns3/epc-enb-s1-sap.h>
#include <ns3/lte-handover-management-sap.h>
#include <ns3/lte-enb-cphy-sap.h>
#include <ns3/lte-rrc-sap.h>
#include <ns3/lte-anr-sap.h>
#include <ns3/lte-ffr-rrc-sap.h>

#include <map>
#include <set>

namespace ns3 {

class LteRadioBearerInfo;
class LteSignalingRadioBearerInfo;
class LteDataRadioBearerInfo;
class LteEnbRrc;
class Packet;



class UeManager : public Object
{
  friend class LtePdcpSpecificLtePdcpSapUser<UeManager>;

public:


  enum State
  {
    INITIAL_RANDOM_ACCESS = 0,
    CONNECTION_SETUP,
    CONNECTION_REJECTED,
    CONNECTED_NORMALLY,
    CONNECTION_RECONFIGURATION,
    CONNECTION_REESTABLISHMENT,
    HANDOVER_PREPARATION,
    HANDOVER_JOINING,
    HANDOVER_PATH_SWITCH,
    HANDOVER_LEAVING,
    NUM_STATES
  };

  UeManager ();
 
  UeManager (Ptr<LteEnbRrc> rrc, uint16_t rnti, State s);

  virtual ~UeManager (void);

  // inherited from Object
protected:
  virtual void DoInitialize ();
  virtual void DoDispose ();
public: 
  static TypeId GetTypeId (void);

  void SetSource (uint16_t sourceCellId, uint16_t sourceX2apId);

  void SetImsi (uint64_t imsi);

  void SetupDataRadioBearer (EpsBearer bearer, uint8_t bearerId, uint32_t gtpTeid, Ipv4Address transportLayerAddress);

  void RecordDataRadioBearersToBeStarted ();

  void StartDataRadioBearers ();

  void ReleaseDataRadioBearer (uint8_t drbid);

  void ScheduleRrcConnectionReconfiguration ();

  void PrepareHandover (uint16_t cellId);

  void RecvHandoverRequestAck (EpcX2SapUser::HandoverRequestAckParams params);

  LteRrcSap::RadioResourceConfigDedicated GetRadioResourceConfigForHandoverPreparationInfo ();

  LteRrcSap::RrcConnectionReconfiguration GetRrcConnectionReconfigurationForHandover ();

  void SendData (uint8_t bid, Ptr<Packet> p);

  std::vector<EpcX2Sap::ErabToBeSetupItem> GetErabList ();

  void SendUeContextRelease ();

  void RecvHandoverPreparationFailure (uint16_t cellId);

  void RecvSnStatusTransfer (EpcX2SapUser::SnStatusTransferParams params);
 
  void RecvUeContextRelease (EpcX2SapUser::UeContextReleaseParams params); 


  // METHODS FORWARDED FROM ENB RRC SAP ///////////////////////////////////////

  void CompleteSetupUe (LteEnbRrcSapProvider::CompleteSetupUeParameters params);
  void RecvRrcConnectionRequest (LteRrcSap::RrcConnectionRequest msg);
  void RecvRrcConnectionSetupCompleted (LteRrcSap::RrcConnectionSetupCompleted msg);
  void RecvRrcConnectionReconfigurationCompleted (LteRrcSap::RrcConnectionReconfigurationCompleted msg);
  void RecvRrcConnectionReestablishmentRequest (LteRrcSap::RrcConnectionReestablishmentRequest msg);
  void RecvRrcConnectionReestablishmentComplete (LteRrcSap::RrcConnectionReestablishmentComplete msg);
  void RecvMeasurementReport (LteRrcSap::MeasurementReport msg);


  // METHODS FORWARDED FROM ENB CMAC SAP //////////////////////////////////////

  void CmacUeConfigUpdateInd (LteEnbCmacSapUser::UeConfig cmacParams);

  // METHODS FORWARDED FROM ENB PDCP SAP //////////////////////////////////////

  void DoReceivePdcpSdu (LtePdcpSapUser::ReceivePdcpSduParameters params);

  uint16_t GetRnti (void) const;

  uint64_t GetImsi (void) const;

  uint16_t GetSrsConfigurationIndex (void) const;

  void SetSrsConfigurationIndex (uint16_t srsConfIndex);

  State GetState () const;

  void SetPdschConfigDedicated (LteRrcSap::PdschConfigDedicated pdschConfigDedicated);

  typedef void (* StateTracedCallback)
    (uint64_t imsi, uint16_t cellId, uint16_t rnti,
     State oldState, State newState);

private:

  uint8_t AddDataRadioBearerInfo (Ptr<LteDataRadioBearerInfo> radioBearerInfo);

  Ptr<LteDataRadioBearerInfo> GetDataRadioBearerInfo (uint8_t drbid);

  void RemoveDataRadioBearerInfo (uint8_t drbid);

  LteRrcSap::RrcConnectionReconfiguration BuildRrcConnectionReconfiguration ();

  LteRrcSap::RadioResourceConfigDedicated BuildRadioResourceConfigDedicated ();

  uint8_t GetNewRrcTransactionIdentifier ();

  uint8_t Lcid2Drbid (uint8_t lcid);

  uint8_t Drbid2Lcid (uint8_t drbid);

  uint8_t Lcid2Bid (uint8_t lcid);

  uint8_t Bid2Lcid (uint8_t bid);

  uint8_t Drbid2Bid (uint8_t drbid);

  uint8_t Bid2Drbid (uint8_t bid);

  void SwitchToState (State s);

  uint8_t m_lastAllocatedDrbid;

  std::map <uint8_t, Ptr<LteDataRadioBearerInfo> > m_drbMap;

  Ptr<LteSignalingRadioBearerInfo> m_srb0;
  Ptr<LteSignalingRadioBearerInfo> m_srb1;

  uint16_t m_rnti;
  uint64_t m_imsi;
  uint8_t m_lastRrcTransactionIdentifier;
  LteRrcSap::PhysicalConfigDedicated m_physicalConfigDedicated;
  Ptr<LteEnbRrc> m_rrc;
  State m_state;
  LtePdcpSapUser* m_drbPdcpSapUser;
  bool m_pendingRrcConnectionReconfiguration;

  TracedCallback<uint64_t, uint16_t, uint16_t, State, State> m_stateTransitionTrace;

  uint16_t m_sourceX2apId;
  uint16_t m_sourceCellId;
  uint16_t m_targetCellId;
  std::list<uint8_t> m_drbsToBeStarted;
  bool m_needPhyMacConfiguration;

  EventId m_connectionRequestTimeout;
  EventId m_connectionSetupTimeout;
  EventId m_connectionRejectedTimeout;
  EventId m_handoverJoiningTimeout;
  EventId m_handoverLeavingTimeout;

}; // end of `class UeManager`



class LteEnbRrc : public Object
{

  friend class EnbRrcMemberLteEnbCmacSapUser;
  friend class MemberLteHandoverManagementSapUser<LteEnbRrc>;
  friend class MemberLteAnrSapUser<LteEnbRrc>;
  friend class MemberLteFfrRrcSapUser<LteEnbRrc>;
  friend class MemberLteEnbRrcSapProvider<LteEnbRrc>;
  friend class MemberEpcEnbS1SapUser<LteEnbRrc>;
  friend class EpcX2SpecificEpcX2SapUser<LteEnbRrc>;
  friend class UeManager;

public:
  LteEnbRrc ();

  virtual ~LteEnbRrc ();


  // inherited from Object
protected:
  virtual void DoDispose (void);
public:
  static TypeId GetTypeId (void);


  void SetEpcX2SapProvider (EpcX2SapProvider* s);

  EpcX2SapUser* GetEpcX2SapUser ();


  void SetLteEnbCmacSapProvider (LteEnbCmacSapProvider * s);

  LteEnbCmacSapUser* GetLteEnbCmacSapUser ();


  void SetLteHandoverManagementSapProvider (LteHandoverManagementSapProvider * s);

  LteHandoverManagementSapUser* GetLteHandoverManagementSapUser ();


  void SetLteAnrSapProvider (LteAnrSapProvider * s);

  LteAnrSapUser* GetLteAnrSapUser ();



  void SetLteFfrRrcSapProvider (LteFfrRrcSapProvider * s);

  LteFfrRrcSapUser* GetLteFfrRrcSapUser ();

  void SetLteEnbRrcSapUser (LteEnbRrcSapUser * s);

  LteEnbRrcSapProvider* GetLteEnbRrcSapProvider ();

  void SetLteMacSapProvider (LteMacSapProvider* s);


  void SetS1SapProvider (EpcEnbS1SapProvider * s);

  EpcEnbS1SapUser* GetS1SapUser ();


  void SetLteEnbCphySapProvider (LteEnbCphySapProvider * s);

  LteEnbCphySapUser* GetLteEnbCphySapUser ();

  bool HasUeManager (uint16_t rnti) const;

  Ptr<UeManager> GetUeManager (uint16_t rnti);

  uint8_t AddUeMeasReportConfig (LteRrcSap::ReportConfigEutra config);

  void ConfigureCell (uint8_t ulBandwidth,
                      uint8_t dlBandwidth,
                      uint16_t ulEarfcn, 
                      uint16_t dlEarfcn,
                      uint16_t cellId);

  void SetCellId (uint16_t m_cellId);

  bool SendData (Ptr<Packet> p);

  void SetForwardUpCallback (Callback <void, Ptr<Packet> > cb);

  void ConnectionRequestTimeout (uint16_t rnti);

  void ConnectionSetupTimeout (uint16_t rnti);

  void ConnectionRejectedTimeout (uint16_t rnti);

  void HandoverJoiningTimeout (uint16_t rnti);

  void HandoverLeavingTimeout (uint16_t rnti);

  void SendHandoverRequest (uint16_t rnti, uint16_t cellId);

  void DoSendReleaseDataRadioBearer (uint64_t imsi, uint16_t rnti, uint8_t bearerId);

  enum LteEpsBearerToRlcMapping_t {RLC_SM_ALWAYS = 1,
                                   RLC_UM_ALWAYS = 2,
                                   RLC_AM_ALWAYS = 3,
                                   PER_BASED = 4};

  typedef void (* NewUeContextTracedCallback)
    (uint16_t cellId, uint16_t rnti);

  typedef void (* ConnectionHandoverTracedCallback)
    (uint64_t imsi, uint16_t cellId, uint16_t rnti);
  
  typedef void (* HandoverStartTracedCallback)
    (uint64_t imsi, uint16_t cellId, uint16_t rnti, uint16_t targetCid);

  typedef void (* ReceiveReportTracedCallback)
    (uint64_t imsi, uint16_t cellId, uint16_t rnti,
     LteRrcSap::MeasurementReport report);
  
private:


  // RRC SAP methods

  void DoCompleteSetupUe (uint16_t rnti, LteEnbRrcSapProvider::CompleteSetupUeParameters params);
  void DoRecvRrcConnectionRequest (uint16_t rnti, LteRrcSap::RrcConnectionRequest msg);
  void DoRecvRrcConnectionSetupCompleted (uint16_t rnti, LteRrcSap::RrcConnectionSetupCompleted msg);
  void DoRecvRrcConnectionReconfigurationCompleted (uint16_t rnti, LteRrcSap::RrcConnectionReconfigurationCompleted msg);
  void DoRecvRrcConnectionReestablishmentRequest (uint16_t rnti, LteRrcSap::RrcConnectionReestablishmentRequest msg);
  void DoRecvRrcConnectionReestablishmentComplete (uint16_t rnti, LteRrcSap::RrcConnectionReestablishmentComplete msg);
  void DoRecvMeasurementReport (uint16_t rnti, LteRrcSap::MeasurementReport msg);

  // S1 SAP methods

  void DoDataRadioBearerSetupRequest (EpcEnbS1SapUser::DataRadioBearerSetupRequestParameters params);
  void DoPathSwitchRequestAcknowledge (EpcEnbS1SapUser::PathSwitchRequestAcknowledgeParameters params);

  // X2 SAP methods

  void DoRecvHandoverRequest (EpcX2SapUser::HandoverRequestParams params);
  void DoRecvHandoverRequestAck (EpcX2SapUser::HandoverRequestAckParams params);
  void DoRecvHandoverPreparationFailure (EpcX2SapUser::HandoverPreparationFailureParams params);
  void DoRecvSnStatusTransfer (EpcX2SapUser::SnStatusTransferParams params);
  void DoRecvUeContextRelease (EpcX2SapUser::UeContextReleaseParams params);
  void DoRecvLoadInformation (EpcX2SapUser::LoadInformationParams params);
  void DoRecvResourceStatusUpdate (EpcX2SapUser::ResourceStatusUpdateParams params);
  void DoRecvUeData (EpcX2SapUser::UeDataParams params);

  // CMAC SAP methods

  uint16_t DoAllocateTemporaryCellRnti ();
  void DoNotifyLcConfigResult (uint16_t rnti, uint8_t lcid, bool success);
  void DoRrcConfigurationUpdateInd (LteEnbCmacSapUser::UeConfig params);

  // Handover Management SAP methods

  uint8_t DoAddUeMeasReportConfigForHandover (LteRrcSap::ReportConfigEutra reportConfig);
  void DoTriggerHandover (uint16_t rnti, uint16_t targetCellId);

  // ANR SAP methods

  uint8_t DoAddUeMeasReportConfigForAnr (LteRrcSap::ReportConfigEutra reportConfig);

  // FFR RRC SAP methods
  uint8_t DoAddUeMeasReportConfigForFfr (LteRrcSap::ReportConfigEutra reportConfig);
  void DoSetPdschConfigDedicated (uint16_t rnti, LteRrcSap::PdschConfigDedicated pa);
  void DoSendLoadInformation (EpcX2Sap::LoadInformationParams params);

  // Internal methods

  uint16_t AddUe (UeManager::State state);

  void RemoveUe (uint16_t rnti);


  TypeId GetRlcType (EpsBearer bearer);



public:

  void AddX2Neighbour (uint16_t cellId);

  void SetSrsPeriodicity (uint32_t p);

  uint32_t GetSrsPeriodicity () const;

  void SetCsgId (uint32_t csgId, bool csgIndication);

private:

  uint16_t GetNewSrsConfigurationIndex (void);

  void RemoveSrsConfigurationIndex (uint16_t srcCi);

 

  uint8_t GetLogicalChannelGroup (EpsBearer bearer);

  uint8_t GetLogicalChannelPriority (EpsBearer bearer);


  void SendSystemInformation ();

  Callback <void, Ptr<Packet> > m_forwardUpCallback;

  EpcX2SapUser* m_x2SapUser;
  EpcX2SapProvider* m_x2SapProvider;

  LteEnbCmacSapUser* m_cmacSapUser;
  LteEnbCmacSapProvider* m_cmacSapProvider;

  LteHandoverManagementSapUser* m_handoverManagementSapUser;
  LteHandoverManagementSapProvider* m_handoverManagementSapProvider;

  LteAnrSapUser* m_anrSapUser;
  LteAnrSapProvider* m_anrSapProvider;

  LteFfrRrcSapUser* m_ffrRrcSapUser;
  LteFfrRrcSapProvider* m_ffrRrcSapProvider;

  LteEnbRrcSapUser* m_rrcSapUser;
  LteEnbRrcSapProvider* m_rrcSapProvider;

  LteMacSapProvider* m_macSapProvider;

  EpcEnbS1SapProvider* m_s1SapProvider;
  EpcEnbS1SapUser* m_s1SapUser;

  LteEnbCphySapUser* m_cphySapUser;
  LteEnbCphySapProvider* m_cphySapProvider;

  bool m_configured;
  uint16_t m_cellId;
  uint16_t m_dlEarfcn;
  uint16_t m_ulEarfcn;
  uint16_t m_dlBandwidth;
  uint16_t m_ulBandwidth;
  uint16_t m_lastAllocatedRnti;

  LteRrcSap::SystemInformationBlockType1 m_sib1;

  std::map<uint16_t, Ptr<UeManager> > m_ueMap;

  LteRrcSap::MeasConfig m_ueMeasConfig;

  std::set<uint8_t> m_handoverMeasIds;
  std::set<uint8_t> m_anrMeasIds;
  std::set<uint8_t> m_ffrMeasIds;

  struct X2uTeidInfo
  {
    uint16_t rnti;
    uint8_t drbid;
  };

  //       TEID      RNTI, DRBID
  std::map<uint32_t, X2uTeidInfo> m_x2uTeidInfoMap;

  uint8_t m_defaultTransmissionMode;
  enum LteEpsBearerToRlcMapping_t m_epsBearerToRlcMapping;
  Time m_systemInformationPeriodicity;
  uint16_t m_srsCurrentPeriodicityId;
  std::set<uint16_t> m_ueSrsConfigurationIndexSet;
  uint16_t m_lastAllocatedConfigurationIndex;
  bool m_reconfigureUes;

  int8_t m_qRxLevMin;
  bool m_admitHandoverRequest;
  bool m_admitRrcConnectionRequest;
  uint8_t m_rsrpFilterCoefficient;
  uint8_t m_rsrqFilterCoefficient;
  Time m_connectionRequestTimeoutDuration;
  Time m_connectionSetupTimeoutDuration;
  Time m_connectionRejectedTimeoutDuration;
  Time m_handoverJoiningTimeoutDuration;
  Time m_handoverLeavingTimeoutDuration;

  TracedCallback<uint16_t, uint16_t> m_newUeContextTrace;
  TracedCallback<uint64_t, uint16_t, uint16_t> m_connectionEstablishedTrace;
  TracedCallback<uint64_t, uint16_t, uint16_t> m_connectionReconfigurationTrace;
  TracedCallback<uint64_t, uint16_t, uint16_t, uint16_t> m_handoverStartTrace;
  TracedCallback<uint64_t, uint16_t, uint16_t> m_handoverEndOkTrace;
  TracedCallback<uint64_t, uint16_t, uint16_t, LteRrcSap::MeasurementReport> m_recvMeasurementReportTrace;

}; // end of `class LteEnbRrc`


} // namespace ns3

#endif // LTE_ENB_RRC_H