A Discrete-Event Network Simulator
API
tdmt-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 TDMT_FF_MAC_SCHEDULER_H
23 #define TDMT_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 ~TdMtFfMacScheduler ();
78 
79  // inherited from Object
80  virtual void DoDispose (void);
81  static TypeId GetTypeId (void);
82 
83  // inherited from FfMacScheduler
84  virtual void SetFfMacCschedSapUser (FfMacCschedSapUser* s);
85  virtual void SetFfMacSchedSapUser (FfMacSchedSapUser* s);
88 
89  // FFR SAPs
90  virtual void SetLteFfrSapProvider (LteFfrSapProvider* s);
91  virtual LteFfrSapUser* GetLteFfrSapUser ();
92 
95 
96  void TransmissionModeConfigurationUpdate (uint16_t rnti, uint8_t txMode);
97 
98 private:
99  //
100  // Implementation of the CSCHED API primitives
101  // (See 4.1 for description of the primitives)
102  //
103 
105 
107 
109 
111 
113 
114  //
115  // Implementation of the SCHED API primitives
116  // (See 4.2 for description of the primitives)
117  //
118 
120 
122 
124 
126 
128 
130 
132 
134 
136 
138 
140 
141 
142  int GetRbgSize (int dlbandwidth);
143 
144  int LcActivePerFlow (uint16_t rnti);
145 
146  double EstimateUlSinr (uint16_t rnti, uint16_t rb);
147 
148  void RefreshDlCqiMaps (void);
149  void RefreshUlCqiMaps (void);
150 
151  void UpdateDlRlcBufferInfo (uint16_t rnti, uint8_t lcid, uint16_t size);
152  void UpdateUlRlcBufferInfo (uint16_t rnti, uint16_t size);
153 
160  uint8_t UpdateHarqProcessId (uint16_t rnti);
161 
168  uint8_t HarqProcessAvailability (uint16_t rnti);
169 
174  void RefreshHarqProcesses ();
175 
177 
178  /*
179  * Vectors of UE's LC info
180  */
181  std::map <LteFlowId_t, FfMacSchedSapProvider::SchedDlRlcBufferReqParameters> m_rlcBufferReq;
182 
183 
184  /*
185  * Set of UE statistics (per RNTI basis) in downlink
186  */
187  std::set <uint16_t> m_flowStatsDl;
188 
189  /*
190  * Set of UE statistics (per RNTI basis)
191  */
192  std::set <uint16_t> m_flowStatsUl;
193 
194 
195  /*
196  * Map of UE's DL CQI P01 received
197  */
198  std::map <uint16_t,uint8_t> m_p10CqiRxed;
199  /*
200  * Map of UE's timers on DL CQI P01 received
201  */
202  std::map <uint16_t,uint32_t> m_p10CqiTimers;
203 
204  /*
205  * Map of UE's DL CQI A30 received
206  */
207  std::map <uint16_t,SbMeasResult_s> m_a30CqiRxed;
208  /*
209  * Map of UE's timers on DL CQI A30 received
210  */
211  std::map <uint16_t,uint32_t> m_a30CqiTimers;
212 
213  /*
214  * Map of previous allocated UE per RBG
215  * (used to retrieve info from UL-CQI)
216  */
217  std::map <uint16_t, std::vector <uint16_t> > m_allocationMaps;
218 
219  /*
220  * Map of UEs' UL-CQI per RBG
221  */
222  std::map <uint16_t, std::vector <double> > m_ueCqi;
223  /*
224  * Map of UEs' timers on UL-CQI per RBG
225  */
226  std::map <uint16_t, uint32_t> m_ueCqiTimers;
227 
228  /*
229  * Map of UE's buffer status reports received
230  */
231  std::map <uint16_t,uint32_t> m_ceBsrRxed;
232 
233  // MAC SAPs
238 
239  // FFR SAPs
242 
243  // Internal parameters
245 
246 
247  uint16_t m_nextRntiUl; // RNTI of the next user to be served next scheduling in UL
248 
249  uint32_t m_cqiTimersThreshold; // # of TTIs for which a CQI canbe considered valid
250 
251  std::map <uint16_t,uint8_t> m_uesTxMode; // txMode of the UEs
252 
253  // HARQ attributes
257  bool m_harqOn;
258  std::map <uint16_t, uint8_t> m_dlHarqCurrentProcessId;
259  //HARQ status
260  // 0: process Id available
261  // x>0: process Id equal to `x` trasmission count
262  std::map <uint16_t, DlHarqProcessesStatus_t> m_dlHarqProcessesStatus;
263  std::map <uint16_t, DlHarqProcessesTimer_t> m_dlHarqProcessesTimer;
264  std::map <uint16_t, DlHarqProcessesDciBuffer_t> m_dlHarqProcessesDciBuffer;
265  std::map <uint16_t, DlHarqRlcPduListBuffer_t> m_dlHarqProcessesRlcPduListBuffer;
266  std::vector <DlInfoListElement_s> m_dlInfoListBuffered; // HARQ retx buffered
267 
268  std::map <uint16_t, uint8_t> m_ulHarqCurrentProcessId;
269  //HARQ status
270  // 0: process Id available
271  // x>0: process Id equal to `x` trasmission count
272  std::map <uint16_t, UlHarqProcessesStatus_t> m_ulHarqProcessesStatus;
273  std::map <uint16_t, UlHarqProcessesDciBuffer_t> m_ulHarqProcessesDciBuffer;
274 
275 
276  // RACH attributes
277  std::vector <struct RachListElement_s> m_rachList;
278  std::vector <uint16_t> m_rachAllocationMap;
279  uint8_t m_ulGrantMcs; // MCS for UL grant (default 0)
280 
281 };
282 
283 } // namespace ns3
284 
285 #endif /* TDMT_FF_MAC_SCHEDULER_H */
std::set< uint16_t > m_flowStatsDl
std::map< uint16_t, uint8_t > m_uesTxMode
std::vector< std::vector< struct RlcPduListElement_s > > RlcPduList_t
Smart pointer class similar to boost::intrusive_ptr.
Definition: ptr.h:73
Service Access Point (SAP) offered by the eNodeB RRC instance to the Frequency Reuse algorithm instan...
Definition: lte-ffr-sap.h:132
void DoCschedUeReleaseReq(const struct FfMacCschedSapProvider::CschedUeReleaseReqParameters &params)
void DoSchedUlNoiseInterferenceReq(const struct FfMacSchedSapProvider::SchedUlNoiseInterferenceReqParameters &params)
std::vector< DlInfoListElement_s > m_dlInfoListBuffered
std::map< uint16_t, uint32_t > m_ceBsrRxed
double EstimateUlSinr(uint16_t rnti, uint16_t rb)
Parameters of the CSCHED_UE_RELEASE_REQ primitive.
std::map< uint16_t, std::vector< double > > m_ueCqi
std::vector< UlDciListElement_s > UlHarqProcessesDciBuffer_t
virtual LteFfrSapUser * GetLteFfrSapUser()
std::vector< uint8_t > DlHarqProcessesTimer_t
virtual ~TdMtFfMacScheduler()
Destructor.
Provides the CSCHED SAP.
std::set< uint16_t > m_flowStatsUl
FfMacCschedSapProvider * m_cschedSapProvider
std::map< uint16_t, uint8_t > m_ulHarqCurrentProcessId
void DoSchedUlMacCtrlInfoReq(const struct FfMacSchedSapProvider::SchedUlMacCtrlInfoReqParameters &params)
Parameters of the CSCHED_LC_RELEASE_REQ primitive.
Parameters of the SCHED_DL_TRIGGER_REQ primitive.
std::map< uint16_t, UlHarqProcessesDciBuffer_t > m_ulHarqProcessesDciBuffer
void DoSchedDlMacBufferReq(const struct FfMacSchedSapProvider::SchedDlMacBufferReqParameters &params)
std::map< uint16_t, uint32_t > m_p10CqiTimers
std::vector< struct RachListElement_s > m_rachList
FfMacCschedSapProvider::CschedCellConfigReqParameters m_cschedCellConfig
virtual void SetFfMacCschedSapUser(FfMacCschedSapUser *s)
set the user part of the FfMacCschedSap that this Scheduler will interact with.
virtual FfMacCschedSapProvider * GetFfMacCschedSapProvider()
std::vector< RlcPduList_t > DlHarqRlcPduListBuffer_t
Parameters of the SCHED_DL_MAC_BUFFER_REQ primitive.
Parameters of the SCHED_DL_PAGING_BUFFER_REQ primitive.
bool m_harqOn
m_harqOn when false inhibit te HARQ mechanisms (by default active)
virtual FfMacSchedSapProvider * GetFfMacSchedSapProvider()
std::map< uint16_t, DlHarqProcessesDciBuffer_t > m_dlHarqProcessesDciBuffer
std::map< uint16_t, SbMeasResult_s > m_a30CqiRxed
Service Access Point (SAP) offered by the Frequency Reuse algorithm instance to the MAC Scheduler ins...
Definition: lte-ffr-sap.h:39
Parameters of the SCHED_UL_TRIGGER_REQ primitive.
Provides the SCHED SAP.
int LcActivePerFlow(uint16_t rnti)
void DoCschedUeConfigReq(const struct FfMacCschedSapProvider::CschedUeConfigReqParameters &params)
Parameters of the SCHED_UL_NOISE_INTERFERENCE_REQ primitive.
uint8_t UpdateHarqProcessId(uint16_t rnti)
Update and return a new process Id for the RNTI specified.
virtual void SetFfMacSchedSapUser(FfMacSchedSapUser *s)
set the user part of the FfMacSchedSap that this Scheduler will interact with.
void DoSchedDlRlcBufferReq(const struct FfMacSchedSapProvider::SchedDlRlcBufferReqParameters &params)
void UpdateDlRlcBufferInfo(uint16_t rnti, uint8_t lcid, uint16_t size)
Every class exported by the ns3 library is enclosed in the ns3 namespace.
std::vector< DlDciListElement_s > DlHarqProcessesDciBuffer_t
Parameters of the CSCHED_LC_CONFIG_REQ primitive.
std::map< uint16_t, uint32_t > m_a30CqiTimers
void DoSchedDlPagingBufferReq(const struct FfMacSchedSapProvider::SchedDlPagingBufferReqParameters &params)
void DoCschedCellConfigReq(const struct FfMacCschedSapProvider::CschedCellConfigReqParameters &params)
virtual void SetLteFfrSapProvider(LteFfrSapProvider *s)
Set the Provider part of the LteFfrSap that this Scheduler will interact with.
LteFfrSapProvider * m_ffrSapProvider
std::map< uint16_t, DlHarqRlcPduListBuffer_t > m_dlHarqProcessesRlcPduListBuffer
This abstract base class identifies the interface by means of which the helper object can plug on the...
std::vector< uint16_t > m_rachAllocationMap
Parameters of the SCHED_DL_CQI_INFO_REQ primitive.
void RefreshHarqProcesses()
Refresh HARQ processes according to the timers.
void DoSchedUlCqiInfoReq(const struct FfMacSchedSapProvider::SchedUlCqiInfoReqParameters &params)
FfMacCschedSapUser * m_cschedSapUser
std::vector< uint8_t > UlHarqProcessesStatus_t
std::map< LteFlowId_t, FfMacSchedSapProvider::SchedDlRlcBufferReqParameters > m_rlcBufferReq
std::map< uint16_t, UlHarqProcessesStatus_t > m_ulHarqProcessesStatus
std::vector< uint8_t > DlHarqProcessesStatus_t
Parameters of the SCHED_UL_CQI_INFO_REQ primitive.
void DoSchedDlRachInfoReq(const struct FfMacSchedSapProvider::SchedDlRachInfoReqParameters &params)
void TransmissionModeConfigurationUpdate(uint16_t rnti, uint8_t txMode)
void UpdateUlRlcBufferInfo(uint16_t rnti, uint16_t size)
Parameters of the SCHED_UL_MAC_CTRL_INFO_REQ primitive.
void DoSchedDlTriggerReq(const struct FfMacSchedSapProvider::SchedDlTriggerReqParameters &params)
Parameters of the SCHED_UL_SR_INFO_REQ primitive.
std::map< uint16_t, uint8_t > m_dlHarqCurrentProcessId
void DoCschedLcReleaseReq(const struct FfMacCschedSapProvider::CschedLcReleaseReqParameters &params)
std::map< uint16_t, uint8_t > m_p10CqiRxed
Parameters of the SCHED_DL_RACH_INFO_REQ primitive.
void DoSchedUlSrInfoReq(const struct FfMacSchedSapProvider::SchedUlSrInfoReqParameters &params)
Parameters of the CSCHED_UE_CONFIG_REQ primitive.
virtual void DoDispose(void)
Destructor implementation.
void DoSchedUlTriggerReq(const struct FfMacSchedSapProvider::SchedUlTriggerReqParameters &params)
FfMacSchedSapProvider * m_schedSapProvider
Implements the SCHED SAP and CSCHED SAP for a Time Domain Maximize Throughput scheduler.
std::map< uint16_t, std::vector< uint16_t > > m_allocationMaps
a unique identifier for an interface.
Definition: type-id.h:58
std::map< uint16_t, DlHarqProcessesStatus_t > m_dlHarqProcessesStatus
uint8_t HarqProcessAvailability(uint16_t rnti)
Return the availability of free process for the RNTI specified.
std::map< uint16_t, DlHarqProcessesTimer_t > m_dlHarqProcessesTimer
void DoCschedLcConfigReq(const struct FfMacCschedSapProvider::CschedLcConfigReqParameters &params)
int GetRbgSize(int dlbandwidth)
void DoSchedDlCqiInfoReq(const struct FfMacSchedSapProvider::SchedDlCqiInfoReqParameters &params)
FfMacSchedSapUser * m_schedSapUser
std::map< uint16_t, uint32_t > m_ueCqiTimers