A Discrete-Event Network Simulator
API
pss-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 PSS_FF_MAC_SCHEDULER_H
23 #define PSS_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 <ns3/nstime.h>
32 #include <ns3/lte-amc.h>
33 #include <ns3/lte-ffr-sap.h>
34 
35 // value for SINR outside the range defined by FF-API, used to indicate that there
36 // is no CQI for this element
37 #define NO_SINR -5000
38 
39 
40 #define HARQ_PROC_NUM 8
41 #define HARQ_DL_TIMEOUT 11
42 
43 namespace ns3 {
44 
45 
46 typedef std::vector < uint8_t > DlHarqProcessesStatus_t;
47 typedef std::vector < uint8_t > DlHarqProcessesTimer_t;
48 typedef std::vector < DlDciListElement_s > DlHarqProcessesDciBuffer_t;
49 typedef std::vector < std::vector <struct RlcPduListElement_s> > RlcPduList_t; // vector of the LCs and layers per UE
50 typedef std::vector < RlcPduList_t > DlHarqRlcPduListBuffer_t; // vector of the 8 HARQ processes per UE
51 
52 typedef std::vector < UlDciListElement_s > UlHarqProcessesDciBuffer_t;
53 typedef std::vector < uint8_t > UlHarqProcessesStatus_t;
54 
55 
60 {
62  unsigned long totalBytesTransmitted;
63  unsigned int lastTtiBytesTransmitted;
67 };
68 
69 
70 
71 
72 
81 {
82 public:
89 
93  virtual ~PssFfMacScheduler ();
94 
95  // inherited from Object
96  virtual void DoDispose (void);
97  static TypeId GetTypeId (void);
98 
99  // inherited from FfMacScheduler
100  virtual void SetFfMacCschedSapUser (FfMacCschedSapUser* s);
101  virtual void SetFfMacSchedSapUser (FfMacSchedSapUser* s);
104 
105  // FFR SAPs
106  virtual void SetLteFfrSapProvider (LteFfrSapProvider* s);
107  virtual LteFfrSapUser* GetLteFfrSapUser ();
108 
111 
112  void TransmissionModeConfigurationUpdate (uint16_t rnti, uint8_t txMode);
113 
114 private:
115  //
116  // Implementation of the CSCHED API primitives
117  // (See 4.1 for description of the primitives)
118  //
119 
121 
123 
125 
127 
129 
130  //
131  // Implementation of the SCHED API primitives
132  // (See 4.2 for description of the primitives)
133  //
134 
136 
138 
140 
142 
144 
146 
148 
150 
152 
154 
156 
157 
158  int GetRbgSize (int dlbandwidth);
159 
160  int LcActivePerFlow (uint16_t rnti);
161 
162  double EstimateUlSinr (uint16_t rnti, uint16_t rb);
163 
164  void RefreshDlCqiMaps (void);
165  void RefreshUlCqiMaps (void);
166 
167  void UpdateDlRlcBufferInfo (uint16_t rnti, uint8_t lcid, uint16_t size);
168  void UpdateUlRlcBufferInfo (uint16_t rnti, uint16_t size);
169 
176  uint8_t UpdateHarqProcessId (uint16_t rnti);
177 
184  uint8_t HarqProcessAvailability (uint16_t rnti);
185 
190  void RefreshHarqProcesses ();
191 
193 
194  /*
195  * Vectors of UE's LC info
196  */
197  std::map <LteFlowId_t, FfMacSchedSapProvider::SchedDlRlcBufferReqParameters> m_rlcBufferReq;
198 
199 
200  /*
201  * Map of UE statistics (per RNTI basis) in downlink
202  */
203  std::map <uint16_t, pssFlowPerf_t> m_flowStatsDl;
204 
205  /*
206  * Map of UE statistics (per RNTI basis)
207  */
208  std::map <uint16_t, pssFlowPerf_t> m_flowStatsUl;
209 
210 
211  /*
212  * Map of UE's DL CQI P01 received
213  */
214  std::map <uint16_t,uint8_t> m_p10CqiRxed;
215  /*
216  * Map of UE's timers on DL CQI P01 received
217  */
218  std::map <uint16_t,uint32_t> m_p10CqiTimers;
219 
220  /*
221  * Map of UE's DL CQI A30 received
222  */
223  std::map <uint16_t,SbMeasResult_s> m_a30CqiRxed;
224  /*
225  * Map of UE's timers on DL CQI A30 received
226  */
227  std::map <uint16_t,uint32_t> m_a30CqiTimers;
228 
229  /*
230  * Map of previous allocated UE per RBG
231  * (used to retrieve info from UL-CQI)
232  */
233  std::map <uint16_t, std::vector <uint16_t> > m_allocationMaps;
234 
235  /*
236  * Map of UEs' UL-CQI per RBG
237  */
238  std::map <uint16_t, std::vector <double> > m_ueCqi;
239  /*
240  * Map of UEs' timers on UL-CQI per RBG
241  */
242  std::map <uint16_t, uint32_t> m_ueCqiTimers;
243 
244  /*
245  * Map of UE's buffer status reports received
246  */
247  std::map <uint16_t,uint32_t> m_ceBsrRxed;
248 
249  // MAC SAPs
254 
255  // FFR SAPs
258 
259  // Internal parameters
261 
262 
263  double m_timeWindow;
264 
265  uint16_t m_nextRntiUl; // RNTI of the next user to be served next scheduling in UL
266 
267  uint32_t m_cqiTimersThreshold; // # of TTIs for which a CQI canbe considered valid
268 
269  std::map <uint16_t,uint8_t> m_uesTxMode; // txMode of the UEs
270 
271  std::string m_fdSchedulerType;
272 
273  uint32_t m_nMux; // TD scheduler selects nMux UEs and transfer them to FD scheduler
274 
275  // HARQ attributes
279  bool m_harqOn;
280  std::map <uint16_t, uint8_t> m_dlHarqCurrentProcessId;
281  //HARQ status
282  // 0: process Id available
283  // x>0: process Id equal to `x` trasmission count
284  std::map <uint16_t, DlHarqProcessesStatus_t> m_dlHarqProcessesStatus;
285  std::map <uint16_t, DlHarqProcessesTimer_t> m_dlHarqProcessesTimer;
286  std::map <uint16_t, DlHarqProcessesDciBuffer_t> m_dlHarqProcessesDciBuffer;
287  std::map <uint16_t, DlHarqRlcPduListBuffer_t> m_dlHarqProcessesRlcPduListBuffer;
288  std::vector <DlInfoListElement_s> m_dlInfoListBuffered; // HARQ retx buffered
289 
290  std::map <uint16_t, uint8_t> m_ulHarqCurrentProcessId;
291  //HARQ status
292  // 0: process Id available
293  // x>0: process Id equal to `x` trasmission count
294  std::map <uint16_t, UlHarqProcessesStatus_t> m_ulHarqProcessesStatus;
295  std::map <uint16_t, UlHarqProcessesDciBuffer_t> m_ulHarqProcessesDciBuffer;
296 
297 
298  // RACH attributes
299  std::vector <struct RachListElement_s> m_rachList;
300  std::vector <uint16_t> m_rachAllocationMap;
301  uint8_t m_ulGrantMcs; // MCS for UL grant (default 0)
302 
303 };
304 
305 } // namespace ns3
306 
307 #endif /* PSS_FF_MAC_SCHEDULER_H */
std::map< uint16_t, uint32_t > m_p10CqiTimers
std::map< uint16_t, std::vector< uint16_t > > m_allocationMaps
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:102
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 DoCschedLcConfigReq(const struct FfMacCschedSapProvider::CschedLcConfigReqParameters &params)
virtual LteFfrSapUser * GetLteFfrSapUser()
std::map< uint16_t, uint8_t > m_uesTxMode
void DoSchedUlSrInfoReq(const struct FfMacSchedSapProvider::SchedUlSrInfoReqParameters &params)
int LcActivePerFlow(uint16_t rnti)
Parameters of the CSCHED_UE_RELEASE_REQ primitive.
void DoCschedLcReleaseReq(const struct FfMacCschedSapProvider::CschedLcReleaseReqParameters &params)
void TransmissionModeConfigurationUpdate(uint16_t rnti, uint8_t txMode)
std::map< uint16_t, uint8_t > m_p10CqiRxed
void UpdateDlRlcBufferInfo(uint16_t rnti, uint8_t lcid, uint16_t size)
std::vector< UlDciListElement_s > UlHarqProcessesDciBuffer_t
std::map< uint16_t, pssFlowPerf_t > m_flowStatsUl
std::vector< uint8_t > DlHarqProcessesTimer_t
Provides the CSCHED SAP.
std::map< uint16_t, UlHarqProcessesStatus_t > m_ulHarqProcessesStatus
std::map< uint16_t, UlHarqProcessesDciBuffer_t > m_ulHarqProcessesDciBuffer
Parameters of the CSCHED_LC_RELEASE_REQ primitive.
Flow information.
Parameters of the SCHED_DL_TRIGGER_REQ primitive.
static TypeId GetTypeId(void)
std::map< uint16_t, DlHarqProcessesDciBuffer_t > m_dlHarqProcessesDciBuffer
std::map< uint16_t, DlHarqProcessesStatus_t > m_dlHarqProcessesStatus
FfMacCschedSapUser * m_cschedSapUser
void DoSchedUlMacCtrlInfoReq(const struct FfMacSchedSapProvider::SchedUlMacCtrlInfoReqParameters &params)
void DoSchedDlTriggerReq(const struct FfMacSchedSapProvider::SchedDlTriggerReqParameters &params)
std::vector< RlcPduList_t > DlHarqRlcPduListBuffer_t
int GetRbgSize(int dlbandwidth)
Parameters of the SCHED_DL_MAC_BUFFER_REQ primitive.
Parameters of the SCHED_DL_PAGING_BUFFER_REQ primitive.
void DoSchedDlCqiInfoReq(const struct FfMacSchedSapProvider::SchedDlCqiInfoReqParameters &params)
double secondLastAveragedThroughput
Past average throughput.
virtual FfMacSchedSapProvider * GetFfMacSchedSapProvider()
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.
double EstimateUlSinr(uint16_t rnti, uint16_t rb)
bool m_harqOn
m_harqOn when false inhibit te HARQ mechanisms (by default active)
std::map< LteFlowId_t, FfMacSchedSapProvider::SchedDlRlcBufferReqParameters > m_rlcBufferReq
void DoSchedDlRlcBufferReq(const struct FfMacSchedSapProvider::SchedDlRlcBufferReqParameters &params)
Provides the SCHED SAP.
LteFfrSapProvider * m_ffrSapProvider
unsigned int lastTtiBytesTransmitted
Total bytes send by eNb for this UE.
Parameters of the SCHED_UL_NOISE_INTERFERENCE_REQ primitive.
void DoCschedUeConfigReq(const struct FfMacCschedSapProvider::CschedUeConfigReqParameters &params)
double lastAveragedThroughput
Total bytes send by eNB in last tti for this UE.
std::map< uint16_t, DlHarqRlcPduListBuffer_t > m_dlHarqProcessesRlcPduListBuffer
void DoSchedUlNoiseInterferenceReq(const struct FfMacSchedSapProvider::SchedUlNoiseInterferenceReqParameters &params)
Every class exported by the ns3 library is enclosed in the ns3 namespace.
void DoSchedDlPagingBufferReq(const struct FfMacSchedSapProvider::SchedDlPagingBufferReqParameters &params)
unsigned long totalBytesTransmitted
std::vector< DlDciListElement_s > DlHarqProcessesDciBuffer_t
Parameters of the CSCHED_LC_CONFIG_REQ primitive.
virtual void SetFfMacSchedSapUser(FfMacSchedSapUser *s)
set the user part of the FfMacSchedSap that this Scheduler will interact with.
std::map< uint16_t, pssFlowPerf_t > m_flowStatsDl
uint8_t HarqProcessAvailability(uint16_t rnti)
Return the availability of free process for the RNTI specified.
std::map< uint16_t, uint8_t > m_ulHarqCurrentProcessId
void RefreshHarqProcesses()
Refresh HARQ processes according to the timers.
void DoSchedUlTriggerReq(const struct FfMacSchedSapProvider::SchedUlTriggerReqParameters &params)
std::map< uint16_t, DlHarqProcessesTimer_t > m_dlHarqProcessesTimer
void UpdateUlRlcBufferInfo(uint16_t rnti, uint16_t size)
This abstract base class identifies the interface by means of which the helper object can plug on the...
uint8_t UpdateHarqProcessId(uint16_t rnti)
Update and return a new process Id for the RNTI specified.
std::vector< struct RachListElement_s > m_rachList
void DoSchedDlMacBufferReq(const struct FfMacSchedSapProvider::SchedDlMacBufferReqParameters &params)
Parameters of the SCHED_DL_CQI_INFO_REQ primitive.
void DoCschedCellConfigReq(const struct FfMacCschedSapProvider::CschedCellConfigReqParameters &params)
virtual ~PssFfMacScheduler()
Destructor.
std::map< uint16_t, SbMeasResult_s > m_a30CqiRxed
void DoSchedUlCqiInfoReq(const struct FfMacSchedSapProvider::SchedUlCqiInfoReqParameters &params)
std::map< uint16_t, uint32_t > m_ceBsrRxed
std::vector< uint8_t > UlHarqProcessesStatus_t
virtual void DoDispose(void)
Destructor implementation.
std::vector< uint8_t > DlHarqProcessesStatus_t
Parameters of the SCHED_UL_CQI_INFO_REQ primitive.
void DoSchedDlRachInfoReq(const struct FfMacSchedSapProvider::SchedDlRachInfoReqParameters &params)
FfMacCschedSapProvider::CschedCellConfigReqParameters m_cschedCellConfig
virtual void SetLteFfrSapProvider(LteFfrSapProvider *s)
Set the Provider part of the LteFfrSap that this Scheduler will interact with.
virtual void SetFfMacCschedSapUser(FfMacCschedSapUser *s)
set the user part of the FfMacCschedSap that this Scheduler will interact with.
Parameters of the SCHED_UL_MAC_CTRL_INFO_REQ primitive.
std::vector< uint16_t > m_rachAllocationMap
std::vector< DlInfoListElement_s > m_dlInfoListBuffered
FfMacCschedSapProvider * m_cschedSapProvider
std::map< uint16_t, uint32_t > m_a30CqiTimers
Parameters of the SCHED_UL_SR_INFO_REQ primitive.
std::map< uint16_t, std::vector< double > > m_ueCqi
std::map< uint16_t, uint32_t > m_ueCqiTimers
Parameters of the SCHED_DL_RACH_INFO_REQ primitive.
Parameters of the CSCHED_UE_CONFIG_REQ primitive.
void DoCschedUeReleaseReq(const struct FfMacCschedSapProvider::CschedUeReleaseReqParameters &params)
std::map< uint16_t, uint8_t > m_dlHarqCurrentProcessId
virtual FfMacCschedSapProvider * GetFfMacCschedSapProvider()
FfMacSchedSapUser * m_schedSapUser
a unique identifier for an interface.
Definition: type-id.h:58
FfMacSchedSapProvider * m_schedSapProvider
Implements the SCHED SAP and CSCHED SAP for a Priority Set scheduler.