A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
fdbet-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 FDBET_FF_MAC_SCHEDULER_H
23 #define FDBET_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 
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 
57 {
59  unsigned long totalBytesTransmitted;
60  unsigned int lastTtiBytesTrasmitted;
62 };
63 
64 
73 {
74 public:
81 
85  virtual ~FdBetFfMacScheduler ();
86 
87  // inherited from Object
88  virtual void DoDispose (void);
89  static TypeId GetTypeId (void);
90 
91  // inherited from FfMacScheduler
93  virtual void SetFfMacSchedSapUser (FfMacSchedSapUser* s);
96 
99 
100  void TransmissionModeConfigurationUpdate (uint16_t rnti, uint8_t txMode);
101 
102 private:
103  //
104  // Implementation of the CSCHED API primitives
105  // (See 4.1 for description of the primitives)
106  //
107 
109 
111 
113 
115 
117 
118  //
119  // Implementation of the SCHED API primitives
120  // (See 4.2 for description of the primitives)
121  //
122 
124 
126 
128 
130 
132 
134 
136 
138 
140 
142 
144 
145 
146  int GetRbgSize (int dlbandwidth);
147 
148  int LcActivePerFlow (uint16_t rnti);
149 
150  double EstimateUlSinr (uint16_t rnti, uint16_t rb);
151 
152  void RefreshDlCqiMaps (void);
153  void RefreshUlCqiMaps (void);
154 
155  void UpdateDlRlcBufferInfo (uint16_t rnti, uint8_t lcid, uint16_t size);
156  void UpdateUlRlcBufferInfo (uint16_t rnti, uint16_t size);
157 
164  uint8_t UpdateHarqProcessId (uint16_t rnti);
165 
172  uint8_t HarqProcessAvailability (uint16_t rnti);
173 
178  void RefreshHarqProcesses ();
179 
181 
182  /*
183  * Vectors of UE's LC info
184  */
185  std::map <LteFlowId_t, FfMacSchedSapProvider::SchedDlRlcBufferReqParameters> m_rlcBufferReq;
186 
187 
188  /*
189  * Map of UE statistics (per RNTI basis) in downlink
190  */
191  std::map <uint16_t, fdbetsFlowPerf_t> m_flowStatsDl;
192 
193  /*
194  * Map of UE statistics (per RNTI basis)
195  */
196  std::map <uint16_t, fdbetsFlowPerf_t> m_flowStatsUl;
197 
198 
199  /*
200  * Map of UE's DL CQI P01 received
201  */
202  std::map <uint16_t,uint8_t> m_p10CqiRxed;
203  /*
204  * Map of UE's timers on DL CQI P01 received
205  */
206  std::map <uint16_t,uint32_t> m_p10CqiTimers;
207 
208  /*
209  * Map of UE's DL CQI A30 received
210  */
211  std::map <uint16_t,SbMeasResult_s> m_a30CqiRxed;
212  /*
213  * Map of UE's timers on DL CQI A30 received
214  */
215  std::map <uint16_t,uint32_t> m_a30CqiTimers;
216 
217  /*
218  * Map of previous allocated UE per RBG
219  * (used to retrieve info from UL-CQI)
220  */
221  std::map <uint16_t, std::vector <uint16_t> > m_allocationMaps;
222 
223  /*
224  * Map of UEs' UL-CQI per RBG
225  */
226  std::map <uint16_t, std::vector <double> > m_ueCqi;
227  /*
228  * Map of UEs' timers on UL-CQI per RBG
229  */
230  std::map <uint16_t, uint32_t> m_ueCqiTimers;
231 
232  /*
233  * Map of UE's buffer status reports received
234  */
235  std::map <uint16_t,uint32_t> m_ceBsrRxed;
236 
237  // MAC SAPs
242 
243 
244  // Internal parameters
246 
247 
248  double m_timeWindow;
249 
250  uint16_t m_nextRntiUl; // RNTI of the next user to be served next scheduling in UL
251 
252  uint32_t m_cqiTimersThreshold; // # of TTIs for which a CQI canbe considered valid
253 
254  std::map <uint16_t,uint8_t> m_uesTxMode; // txMode of the UEs
255 
256  // HARQ attributes
260  bool m_harqOn;
261  std::map <uint16_t, uint8_t> m_dlHarqCurrentProcessId;
262  //HARQ status
263  // 0: process Id available
264  // x>0: process Id equal to `x` trasmission count
265  std::map <uint16_t, DlHarqProcessesStatus_t> m_dlHarqProcessesStatus;
266  std::map <uint16_t, DlHarqProcessesTimer_t> m_dlHarqProcessesTimer;
267  std::map <uint16_t, DlHarqProcessesDciBuffer_t> m_dlHarqProcessesDciBuffer;
268  std::map <uint16_t, DlHarqRlcPduListBuffer_t> m_dlHarqProcessesRlcPduListBuffer;
269  std::vector <DlInfoListElement_s> m_dlInfoListBuffered; // HARQ retx buffered
270 
271  std::map <uint16_t, uint8_t> m_ulHarqCurrentProcessId;
272  //HARQ status
273  // 0: process Id available
274  // x>0: process Id equal to `x` trasmission count
275  std::map <uint16_t, UlHarqProcessesStatus_t> m_ulHarqProcessesStatus;
276  std::map <uint16_t, UlHarqProcessesDciBuffer_t> m_ulHarqProcessesDciBuffer;
277 
278 
279  // RACH attributes
280  std::vector <struct RachListElement_s> m_rachList;
281  std::vector <uint16_t> m_rachAllocationMap;
282  uint8_t m_ulGrantMcs; // MCS for UL grant (default 0)
283 
284 };
285 
286 } // namespace ns3
287 
288 #endif /* FDBET_FF_MAC_SCHEDULER_H */
virtual void SetFfMacCschedSapUser(FfMacCschedSapUser *s)
set the user part of the FfMacCschedSap that this Scheduler will interact with.
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:79
void RefreshHarqProcesses()
Refresh HARQ processes according to the timers.
std::vector< std::vector< struct RlcPduListElement_s > > RlcPduList_t
smart pointer class similar to boost::intrusive_ptr
Definition: ptr.h:60
void UpdateDlRlcBufferInfo(uint16_t rnti, uint8_t lcid, uint16_t size)
virtual ~FdBetFfMacScheduler()
Destructor.
Parameters of the CSCHED_UE_RELEASE_REQ primitive.
void DoSchedUlMacCtrlInfoReq(const struct FfMacSchedSapProvider::SchedUlMacCtrlInfoReqParameters &params)
void DoSchedUlNoiseInterferenceReq(const struct FfMacSchedSapProvider::SchedUlNoiseInterferenceReqParameters &params)
std::vector< UlDciListElement_s > UlHarqProcessesDciBuffer_t
virtual void DoDispose(void)
This method is called by Object::Dispose or by the object's destructor, whichever comes first...
std::vector< uint8_t > DlHarqProcessesTimer_t
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.
Provides the CSCHED SAP.
std::map< uint16_t, fdbetsFlowPerf_t > m_flowStatsDl
Parameters of the CSCHED_LC_RELEASE_REQ primitive.
virtual FfMacSchedSapProvider * GetFfMacSchedSapProvider()
std::map< uint16_t, uint8_t > m_p10CqiRxed
std::vector< uint16_t > m_rachAllocationMap
Parameters of the SCHED_DL_TRIGGER_REQ primitive.
std::map< uint16_t, DlHarqProcessesDciBuffer_t > m_dlHarqProcessesDciBuffer
void DoSchedUlTriggerReq(const struct FfMacSchedSapProvider::SchedUlTriggerReqParameters &params)
FfMacSchedSapUser * m_schedSapUser
void DoSchedDlMacBufferReq(const struct FfMacSchedSapProvider::SchedDlMacBufferReqParameters &params)
Implements the SCHED SAP and CSCHED SAP for a Frequency Domain Blind Equal Throughput scheduler...
std::vector< RlcPduList_t > DlHarqRlcPduListBuffer_t
Parameters of the SCHED_DL_MAC_BUFFER_REQ primitive.
std::map< uint16_t, uint32_t > m_ueCqiTimers
Parameters of the SCHED_DL_PAGING_BUFFER_REQ primitive.
void DoSchedUlCqiInfoReq(const struct FfMacSchedSapProvider::SchedUlCqiInfoReqParameters &params)
std::map< uint16_t, UlHarqProcessesDciBuffer_t > m_ulHarqProcessesDciBuffer
void DoCschedLcReleaseReq(const struct FfMacCschedSapProvider::CschedLcReleaseReqParameters &params)
Parameters of the SCHED_UL_TRIGGER_REQ primitive.
void DoCschedCellConfigReq(const struct FfMacCschedSapProvider::CschedCellConfigReqParameters &params)
Ptr< SampleEmitter > s
uint8_t HarqProcessAvailability(uint16_t rnti)
Return the availability of free process for the RNTI specified.
std::map< uint16_t, UlHarqProcessesStatus_t > m_ulHarqProcessesStatus
FfMacCschedSapProvider * m_cschedSapProvider
std::map< uint16_t, uint8_t > m_dlHarqCurrentProcessId
std::map< uint16_t, DlHarqProcessesStatus_t > m_dlHarqProcessesStatus
Provides the SCHED SAP.
std::map< uint16_t, uint32_t > m_p10CqiTimers
double EstimateUlSinr(uint16_t rnti, uint16_t rb)
virtual FfMacCschedSapProvider * GetFfMacCschedSapProvider()
void UpdateUlRlcBufferInfo(uint16_t rnti, uint16_t size)
Parameters of the SCHED_UL_NOISE_INTERFERENCE_REQ primitive.
std::map< uint16_t, DlHarqRlcPduListBuffer_t > m_dlHarqProcessesRlcPduListBuffer
FfMacSchedSapProvider * m_schedSapProvider
void DoSchedDlCqiInfoReq(const struct FfMacSchedSapProvider::SchedDlCqiInfoReqParameters &params)
FfMacCschedSapUser * m_cschedSapUser
std::vector< DlDciListElement_s > DlHarqProcessesDciBuffer_t
Parameters of the CSCHED_LC_CONFIG_REQ primitive.
std::map< uint16_t, std::vector< double > > m_ueCqi
std::map< uint16_t, uint8_t > m_uesTxMode
std::map< uint16_t, uint32_t > m_a30CqiTimers
std::map< uint16_t, DlHarqProcessesTimer_t > m_dlHarqProcessesTimer
std::vector< struct RachListElement_s > m_rachList
This abstract base class identifies the interface by means of which the helper object can plug on the...
Parameters of the SCHED_DL_CQI_INFO_REQ primitive.
std::vector< DlInfoListElement_s > m_dlInfoListBuffered
std::vector< uint8_t > UlHarqProcessesStatus_t
void DoSchedDlRlcBufferReq(const struct FfMacSchedSapProvider::SchedDlRlcBufferReqParameters &params)
void DoSchedDlRachInfoReq(const struct FfMacSchedSapProvider::SchedDlRachInfoReqParameters &params)
std::vector< uint8_t > DlHarqProcessesStatus_t
Parameters of the SCHED_UL_CQI_INFO_REQ primitive.
std::map< uint16_t, uint8_t > m_ulHarqCurrentProcessId
Parameters of the SCHED_UL_MAC_CTRL_INFO_REQ primitive.
void TransmissionModeConfigurationUpdate(uint16_t rnti, uint8_t txMode)
void DoCschedLcConfigReq(const struct FfMacCschedSapProvider::CschedLcConfigReqParameters &params)
Parameters of the SCHED_UL_SR_INFO_REQ primitive.
std::map< uint16_t, fdbetsFlowPerf_t > m_flowStatsUl
std::map< uint16_t, std::vector< uint16_t > > m_allocationMaps
bool m_harqOn
m_harqOn when false inhibit te HARQ mechanisms (by default active)
Parameters of the SCHED_DL_RACH_INFO_REQ primitive.
void DoSchedDlPagingBufferReq(const struct FfMacSchedSapProvider::SchedDlPagingBufferReqParameters &params)
Parameters of the CSCHED_UE_CONFIG_REQ primitive.
void DoCschedUeReleaseReq(const struct FfMacCschedSapProvider::CschedUeReleaseReqParameters &params)
a unique identifier for an interface.
Definition: type-id.h:49
std::map< LteFlowId_t, FfMacSchedSapProvider::SchedDlRlcBufferReqParameters > m_rlcBufferReq
void DoCschedUeConfigReq(const struct FfMacCschedSapProvider::CschedUeConfigReqParameters &params)
FfMacCschedSapProvider::CschedCellConfigReqParameters m_cschedCellConfig
std::map< uint16_t, SbMeasResult_s > m_a30CqiRxed
void DoSchedUlSrInfoReq(const struct FfMacSchedSapProvider::SchedUlSrInfoReqParameters &params)
std::map< uint16_t, uint32_t > m_ceBsrRxed
void DoSchedDlTriggerReq(const struct FfMacSchedSapProvider::SchedDlTriggerReqParameters &params)