A Discrete-Event Network Simulator
API
tta-ff-mac-scheduler.h
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2011 Centre Tecnologic de Telecomunicacions de Catalunya (CTTC)
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License version 2 as
7  * published by the Free Software Foundation;
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17  *
18  * Author: Marco Miozzo <marco.miozzo@cttc.es>
19  * Modification: Dizhi Zhou <dizhi.zhou@gmail.com> // modify codes related to downlink scheduler
20  */
21 
22 #ifndef TTA_FF_MAC_SCHEDULER_H
23 #define TTA_FF_MAC_SCHEDULER_H
24 
25 #include <ns3/lte-common.h>
26 #include <ns3/ff-mac-csched-sap.h>
27 #include <ns3/ff-mac-sched-sap.h>
28 #include <ns3/ff-mac-scheduler.h>
29 #include <vector>
30 #include <map>
31 #include <set>
32 #include <ns3/nstime.h>
33 #include <ns3/lte-amc.h>
34 #include <ns3/lte-ffr-sap.h>
35 
36 // value for SINR outside the range defined by FF-API, used to indicate that there
37 // is no CQI for this element
38 #define NO_SINR -5000
39 
40 
41 #define HARQ_PROC_NUM 8
42 #define HARQ_DL_TIMEOUT 11
43 
44 namespace ns3 {
45 
46 
47 typedef std::vector < uint8_t > DlHarqProcessesStatus_t;
48 typedef std::vector < uint8_t > DlHarqProcessesTimer_t;
49 typedef std::vector < DlDciListElement_s > DlHarqProcessesDciBuffer_t;
50 typedef std::vector < std::vector <struct RlcPduListElement_s> > RlcPduList_t; // vector of the LCs and layers per UE
51 typedef std::vector < RlcPduList_t > DlHarqRlcPduListBuffer_t; // vector of the 8 HARQ processes per UE
52 
53 typedef std::vector < UlDciListElement_s > UlHarqProcessesDciBuffer_t;
54 typedef std::vector < uint8_t > UlHarqProcessesStatus_t;
55 
56 
65 {
66 public:
73 
77  virtual ~TtaFfMacScheduler ();
78 
79  // inherited from Object
80  virtual void DoDispose (void);
85  static TypeId GetTypeId (void);
86 
87  // inherited from FfMacScheduler
88  virtual void SetFfMacCschedSapUser (FfMacCschedSapUser* s);
89  virtual void SetFfMacSchedSapUser (FfMacSchedSapUser* s);
92 
93  // FFR SAPs
94  virtual void SetLteFfrSapProvider (LteFfrSapProvider* s);
96 
101 
107  void TransmissionModeConfigurationUpdate (uint16_t rnti, uint8_t txMode);
108 
109 private:
110  //
111  // Implementation of the CSCHED API primitives
112  // (See 4.1 for description of the primitives)
113  //
114 
120 
126 
132 
138 
144 
145  //
146  // Implementation of the SCHED API primitives
147  // (See 4.2 for description of the primitives)
148  //
149 
155 
161 
167 
173 
179 
185 
191 
197 
203 
209 
215 
221  int GetRbgSize (int dlbandwidth);
222 
228  unsigned int LcActivePerFlow (uint16_t rnti);
229 
236  double EstimateUlSinr (uint16_t rnti, uint16_t rb);
237 
239  void RefreshDlCqiMaps (void);
241  void RefreshUlCqiMaps (void);
242 
249  void UpdateDlRlcBufferInfo (uint16_t rnti, uint8_t lcid, uint16_t size);
255  void UpdateUlRlcBufferInfo (uint16_t rnti, uint16_t size);
256 
263  uint8_t UpdateHarqProcessId (uint16_t rnti);
264 
271  uint8_t HarqProcessAvailability (uint16_t rnti);
272 
277  void RefreshHarqProcesses ();
278 
280 
284  std::map <LteFlowId_t, FfMacSchedSapProvider::SchedDlRlcBufferReqParameters> m_rlcBufferReq;
285 
286 
290  std::set <uint16_t> m_flowStatsDl;
291 
295  std::set <uint16_t> m_flowStatsUl;
296 
297 
301  std::map <uint16_t,uint8_t> m_p10CqiRxed;
305  std::map <uint16_t,uint32_t> m_p10CqiTimers;
306 
310  std::map <uint16_t,SbMeasResult_s> m_a30CqiRxed;
314  std::map <uint16_t,uint32_t> m_a30CqiTimers;
315 
320  std::map <uint16_t, std::vector <uint16_t> > m_allocationMaps;
321 
325  std::map <uint16_t, std::vector <double> > m_ueCqi;
329  std::map <uint16_t, uint32_t> m_ueCqiTimers;
330 
334  std::map <uint16_t,uint32_t> m_ceBsrRxed;
335 
336  // MAC SAPs
341 
342  // FFR SAPs
345 
346  // Internal parameters
348 
349 
350  uint16_t m_nextRntiUl;
351 
353 
354  std::map <uint16_t,uint8_t> m_uesTxMode;
355 
356  // HARQ attributes
360  bool m_harqOn;
361  std::map <uint16_t, uint8_t> m_dlHarqCurrentProcessId;
362  //HARQ status
363  // 0: process Id available
364  // x>0: process Id equal to `x` transmission count
365  std::map <uint16_t, DlHarqProcessesStatus_t> m_dlHarqProcessesStatus;
366  std::map <uint16_t, DlHarqProcessesTimer_t> m_dlHarqProcessesTimer;
367  std::map <uint16_t, DlHarqProcessesDciBuffer_t> m_dlHarqProcessesDciBuffer;
368  std::map <uint16_t, DlHarqRlcPduListBuffer_t> m_dlHarqProcessesRlcPduListBuffer;
369  std::vector <DlInfoListElement_s> m_dlInfoListBuffered;
370 
371  std::map <uint16_t, uint8_t> m_ulHarqCurrentProcessId;
372  //HARQ status
373  // 0: process Id available
374  // x>0: process Id equal to `x` transmission count
375  std::map <uint16_t, UlHarqProcessesStatus_t> m_ulHarqProcessesStatus;
376  std::map <uint16_t, UlHarqProcessesDciBuffer_t> m_ulHarqProcessesDciBuffer;
377 
378 
379  // RACH attributes
380  std::vector <struct RachListElement_s> m_rachList;
381  std::vector <uint16_t> m_rachAllocationMap;
382  uint8_t m_ulGrantMcs;
383 
384 };
385 
386 } // namespace ns3
387 
388 #endif /* TTA_FF_MAC_SCHEDULER_H */
Provides the CSCHED SAP.
FfMacCschedSapUser class.
Provides the SCHED SAP.
FfMacSchedSapUser class.
This abstract base class identifies the interface by means of which the helper object can plug on the...
Service Access Point (SAP) offered by the Frequency Reuse algorithm instance to the MAC Scheduler ins...
Definition: lte-ffr-sap.h:40
Service Access Point (SAP) offered by the eNodeB RRC instance to the Frequency Reuse algorithm instan...
Definition: lte-ffr-sap.h:139
MemberCschedSapProvider class.
MemberSchedSapProvider class.
Smart pointer class similar to boost::intrusive_ptr.
Definition: ptr.h:74
Implements the SCHED SAP and CSCHED SAP for a Throughput to Average scheduler.
FfMacSchedSapUser * m_schedSapUser
Sched SAP user.
bool m_harqOn
m_harqOn when false inhibit the HARQ mechanisms (by default active)
std::map< uint16_t, uint32_t > m_ceBsrRxed
Map of UE's buffer status reports received.
void RefreshHarqProcesses()
Refresh HARQ processes according to the timers.
void DoCschedLcReleaseReq(const struct FfMacCschedSapProvider::CschedLcReleaseReqParameters &params)
CSched LC release request function.
virtual FfMacCschedSapProvider * GetFfMacCschedSapProvider()
void RefreshDlCqiMaps(void)
Refresh DL CQI maps.
std::map< uint16_t, std::vector< double > > m_ueCqi
Map of UEs' UL-CQI per RBG.
void DoSchedDlPagingBufferReq(const struct FfMacSchedSapProvider::SchedDlPagingBufferReqParameters &params)
Sched DL paging buffer request function.
std::map< uint16_t, uint8_t > m_uesTxMode
txMode of the UEs
std::set< uint16_t > m_flowStatsDl
Set of UE statistics (per RNTI basis) in downlink.
uint8_t HarqProcessAvailability(uint16_t rnti)
Return the availability of free process for the RNTI specified.
void DoCschedLcConfigReq(const struct FfMacCschedSapProvider::CschedLcConfigReqParameters &params)
CSched LC config request function.
uint16_t m_nextRntiUl
RNTI of the next user to be served next scheduling in UL.
void DoCschedUeReleaseReq(const struct FfMacCschedSapProvider::CschedUeReleaseReqParameters &params)
CSched UE release request function.
int GetRbgSize(int dlbandwidth)
Get RBG size function.
LteFfrSapUser * m_ffrSapUser
FFR SAP user.
void UpdateDlRlcBufferInfo(uint16_t rnti, uint8_t lcid, uint16_t size)
Update DL RLC buffer info function.
std::vector< DlInfoListElement_s > m_dlInfoListBuffered
HARQ retx buffered.
virtual LteFfrSapUser * GetLteFfrSapUser()
double EstimateUlSinr(uint16_t rnti, uint16_t rb)
Estimate UL SINR function.
LteFfrSapProvider * m_ffrSapProvider
FFR SAP provider.
std::vector< struct RachListElement_s > m_rachList
RACH list.
void DoCschedUeConfigReq(const struct FfMacCschedSapProvider::CschedUeConfigReqParameters &params)
CSched UE config request function.
virtual void SetLteFfrSapProvider(LteFfrSapProvider *s)
Set the Provider part of the LteFfrSap that this Scheduler will interact with.
void DoSchedDlMacBufferReq(const struct FfMacSchedSapProvider::SchedDlMacBufferReqParameters &params)
Sched DL MAC buffer request function.
std::map< uint16_t, uint8_t > m_p10CqiRxed
Map of UE's DL CQI P01 received.
std::map< uint16_t, std::vector< uint16_t > > m_allocationMaps
Map of previous allocated UE per RBG (used to retrieve info from UL-CQI)
FfMacCschedSapProvider * m_cschedSapProvider
CSched SAP provider.
std::map< uint16_t, uint8_t > m_ulHarqCurrentProcessId
UL HARQ current process ID.
virtual ~TtaFfMacScheduler()
Destructor.
std::map< uint16_t, uint8_t > m_dlHarqCurrentProcessId
DL HARQ current process ID.
static TypeId GetTypeId(void)
Get the type ID.
virtual void SetFfMacSchedSapUser(FfMacSchedSapUser *s)
set the user part of the FfMacSchedSap that this Scheduler will interact with.
virtual void SetFfMacCschedSapUser(FfMacCschedSapUser *s)
set the user part of the FfMacCschedSap that this Scheduler will interact with.
std::map< uint16_t, UlHarqProcessesStatus_t > m_ulHarqProcessesStatus
UL HARQ process status.
std::vector< uint16_t > m_rachAllocationMap
RACH allocation map.
std::map< uint16_t, DlHarqProcessesStatus_t > m_dlHarqProcessesStatus
DL HARQ process status.
void DoSchedUlSrInfoReq(const struct FfMacSchedSapProvider::SchedUlSrInfoReqParameters &params)
Sched UL SR info request function.
virtual FfMacSchedSapProvider * GetFfMacSchedSapProvider()
uint8_t UpdateHarqProcessId(uint16_t rnti)
Update and return a new process Id for the RNTI specified.
void DoSchedDlCqiInfoReq(const struct FfMacSchedSapProvider::SchedDlCqiInfoReqParameters &params)
Sched DL CQI info request function.
FfMacCschedSapUser * m_cschedSapUser
CSched SAP user.
std::map< uint16_t, UlHarqProcessesDciBuffer_t > m_ulHarqProcessesDciBuffer
UL HARQ process DCI buffer.
void DoSchedDlRlcBufferReq(const struct FfMacSchedSapProvider::SchedDlRlcBufferReqParameters &params)
Sched DL RLC buffer request function.
void DoSchedUlMacCtrlInfoReq(const struct FfMacSchedSapProvider::SchedUlMacCtrlInfoReqParameters &params)
Sched UL MAC control info request function.
void TransmissionModeConfigurationUpdate(uint16_t rnti, uint8_t txMode)
Transmission mode configuration update.
std::map< uint16_t, SbMeasResult_s > m_a30CqiRxed
Map of UE's DL CQI A30 received.
void DoSchedUlTriggerReq(const struct FfMacSchedSapProvider::SchedUlTriggerReqParameters &params)
Sched UL trigger request function.
void UpdateUlRlcBufferInfo(uint16_t rnti, uint16_t size)
Update DL RLC buffer info function.
unsigned int LcActivePerFlow(uint16_t rnti)
LC active per flow function.
std::map< uint16_t, uint32_t > m_ueCqiTimers
Map of UEs' timers on UL-CQI per RBG.
std::map< uint16_t, DlHarqProcessesTimer_t > m_dlHarqProcessesTimer
DL HARQ process timer.
std::map< uint16_t, DlHarqRlcPduListBuffer_t > m_dlHarqProcessesRlcPduListBuffer
DL HARQ process RLC PDU list buffer.
virtual void DoDispose(void)
Destructor implementation.
void DoSchedDlRachInfoReq(const struct FfMacSchedSapProvider::SchedDlRachInfoReqParameters &params)
Sched DL RACH info request function.
void DoSchedDlTriggerReq(const struct FfMacSchedSapProvider::SchedDlTriggerReqParameters &params)
Sched DL trigger request function.
void RefreshUlCqiMaps(void)
Refresh UL CQI maps.
FfMacSchedSapProvider * m_schedSapProvider
Sched SAP provider.
std::map< LteFlowId_t, FfMacSchedSapProvider::SchedDlRlcBufferReqParameters > m_rlcBufferReq
Vectors of UE's LC info.
std::set< uint16_t > m_flowStatsUl
Set of UE statistics (per RNTI basis)
void DoSchedUlNoiseInterferenceReq(const struct FfMacSchedSapProvider::SchedUlNoiseInterferenceReqParameters &params)
Sched UL noise interference request function.
void DoSchedUlCqiInfoReq(const struct FfMacSchedSapProvider::SchedUlCqiInfoReqParameters &params)
Sched UL CQI info request function.
FfMacCschedSapProvider::CschedCellConfigReqParameters m_cschedCellConfig
CSched cell config.
std::map< uint16_t, uint32_t > m_a30CqiTimers
Map of UE's timers on DL CQI A30 received.
uint8_t m_ulGrantMcs
MCS for UL grant (default 0)
std::map< uint16_t, DlHarqProcessesDciBuffer_t > m_dlHarqProcessesDciBuffer
DL HARQ process DCI buffer.
void DoCschedCellConfigReq(const struct FfMacCschedSapProvider::CschedCellConfigReqParameters &params)
CSched cell config request function.
std::map< uint16_t, uint32_t > m_p10CqiTimers
Map of UE's timers on DL CQI P01 received.
a unique identifier for an interface.
Definition: type-id.h:59
Every class exported by the ns3 library is enclosed in the ns3 namespace.
std::vector< UlDciListElement_s > UlHarqProcessesDciBuffer_t
UL HARQ process DCI buffer vector.
std::vector< uint8_t > DlHarqProcessesTimer_t
DL HARQ process timer vector typedef.
std::vector< uint8_t > DlHarqProcessesStatus_t
DL HARQ process status vector typedef.
std::vector< RlcPduList_t > DlHarqRlcPduListBuffer_t
vector of the 8 HARQ processes per UE
std::vector< std::vector< struct RlcPduListElement_s > > RlcPduList_t
vector of the LCs and layers per UE
std::vector< DlDciListElement_s > DlHarqProcessesDciBuffer_t
DL HARQ process DCI buffer vector typedef.
std::vector< uint8_t > UlHarqProcessesStatus_t
UL HARQ process status vector.
Parameters of the CSCHED_LC_CONFIG_REQ primitive.
Parameters of the CSCHED_LC_RELEASE_REQ primitive.
Parameters of the CSCHED_UE_CONFIG_REQ primitive.
Parameters of the CSCHED_UE_RELEASE_REQ primitive.
Parameters of the SCHED_DL_CQI_INFO_REQ primitive.
Parameters of the SCHED_DL_MAC_BUFFER_REQ primitive.
Parameters of the SCHED_DL_PAGING_BUFFER_REQ primitive.
Parameters of the SCHED_DL_RACH_INFO_REQ primitive.
Parameters of the SCHED_DL_TRIGGER_REQ primitive.
Parameters of the SCHED_UL_CQI_INFO_REQ primitive.
Parameters of the SCHED_UL_MAC_CTRL_INFO_REQ primitive.
Parameters of the SCHED_UL_NOISE_INTERFERENCE_REQ primitive.
Parameters of the SCHED_UL_SR_INFO_REQ primitive.
Parameters of the SCHED_UL_TRIGGER_REQ primitive.