A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
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 
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
85  virtual void SetFfMacSchedSapUser (FfMacSchedSapUser* s);
88 
91 
92  void TransmissionModeConfigurationUpdate (uint16_t rnti, uint8_t txMode);
93 
94 private:
95  //
96  // Implementation of the CSCHED API primitives
97  // (See 4.1 for description of the primitives)
98  //
99 
101 
103 
105 
107 
109 
110  //
111  // Implementation of the SCHED API primitives
112  // (See 4.2 for description of the primitives)
113  //
114 
116 
118 
120 
122 
124 
126 
128 
130 
132 
134 
136 
137 
138  int GetRbgSize (int dlbandwidth);
139 
140  int LcActivePerFlow (uint16_t rnti);
141 
142  double EstimateUlSinr (uint16_t rnti, uint16_t rb);
143 
144  void RefreshDlCqiMaps (void);
145  void RefreshUlCqiMaps (void);
146 
147  void UpdateDlRlcBufferInfo (uint16_t rnti, uint8_t lcid, uint16_t size);
148  void UpdateUlRlcBufferInfo (uint16_t rnti, uint16_t size);
149 
156  uint8_t UpdateHarqProcessId (uint16_t rnti);
157 
164  uint8_t HarqProcessAvailability (uint16_t rnti);
165 
170  void RefreshHarqProcesses ();
171 
173 
174  /*
175  * Vectors of UE's LC info
176  */
177  std::map <LteFlowId_t, FfMacSchedSapProvider::SchedDlRlcBufferReqParameters> m_rlcBufferReq;
178 
179 
180  /*
181  * Set of UE statistics (per RNTI basis) in downlink
182  */
183  std::set <uint16_t> m_flowStatsDl;
184 
185  /*
186  * Set of UE statistics (per RNTI basis)
187  */
188  std::set <uint16_t> m_flowStatsUl;
189 
190 
191  /*
192  * Map of UE's DL CQI P01 received
193  */
194  std::map <uint16_t,uint8_t> m_p10CqiRxed;
195  /*
196  * Map of UE's timers on DL CQI P01 received
197  */
198  std::map <uint16_t,uint32_t> m_p10CqiTimers;
199 
200  /*
201  * Map of UE's DL CQI A30 received
202  */
203  std::map <uint16_t,SbMeasResult_s> m_a30CqiRxed;
204  /*
205  * Map of UE's timers on DL CQI A30 received
206  */
207  std::map <uint16_t,uint32_t> m_a30CqiTimers;
208 
209  /*
210  * Map of previous allocated UE per RBG
211  * (used to retrieve info from UL-CQI)
212  */
213  std::map <uint16_t, std::vector <uint16_t> > m_allocationMaps;
214 
215  /*
216  * Map of UEs' UL-CQI per RBG
217  */
218  std::map <uint16_t, std::vector <double> > m_ueCqi;
219  /*
220  * Map of UEs' timers on UL-CQI per RBG
221  */
222  std::map <uint16_t, uint32_t> m_ueCqiTimers;
223 
224  /*
225  * Map of UE's buffer status reports received
226  */
227  std::map <uint16_t,uint32_t> m_ceBsrRxed;
228 
229  // MAC SAPs
234 
235 
236  // Internal parameters
238 
239 
240  uint16_t m_nextRntiUl; // RNTI of the next user to be served next scheduling in UL
241 
242  uint32_t m_cqiTimersThreshold; // # of TTIs for which a CQI canbe considered valid
243 
244  std::map <uint16_t,uint8_t> m_uesTxMode; // txMode of the UEs
245 
246  // HARQ attributes
250  bool m_harqOn;
251  std::map <uint16_t, uint8_t> m_dlHarqCurrentProcessId;
252  //HARQ status
253  // 0: process Id available
254  // x>0: process Id equal to `x` trasmission count
255  std::map <uint16_t, DlHarqProcessesStatus_t> m_dlHarqProcessesStatus;
256  std::map <uint16_t, DlHarqProcessesTimer_t> m_dlHarqProcessesTimer;
257  std::map <uint16_t, DlHarqProcessesDciBuffer_t> m_dlHarqProcessesDciBuffer;
258  std::map <uint16_t, DlHarqRlcPduListBuffer_t> m_dlHarqProcessesRlcPduListBuffer;
259  std::vector <DlInfoListElement_s> m_dlInfoListBuffered; // HARQ retx buffered
260 
261  std::map <uint16_t, uint8_t> m_ulHarqCurrentProcessId;
262  //HARQ status
263  // 0: process Id available
264  // x>0: process Id equal to `x` trasmission count
265  std::map <uint16_t, UlHarqProcessesStatus_t> m_ulHarqProcessesStatus;
266  std::map <uint16_t, UlHarqProcessesDciBuffer_t> m_ulHarqProcessesDciBuffer;
267 
268 
269  // RACH attributes
270  std::vector <struct RachListElement_s> m_rachList;
271  std::vector <uint16_t> m_rachAllocationMap;
272  uint8_t m_ulGrantMcs; // MCS for UL grant (default 0)
273 
274 };
275 
276 } // namespace ns3
277 
278 #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:59
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
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
Parameters of the SCHED_UL_TRIGGER_REQ primitive.
Ptr< SampleEmitter > s
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)
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)
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)
This method is called by Object::Dispose or by the object's destructor, whichever comes first...
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:49
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