A Discrete-Event Network Simulator
API
cqa-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) 2012 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  * Authors: Biljana Bojovic <bbojovic@cttc.es>, Nicola Baldo<nbaldo@cttc.es>.
19  *
20  * Note: Implementation is using many common scheduler functionalities in its original version implemented by Marco Miozzo<mmiozzo@cttc.es> in PF and RR
21  * schedulers. *
22  */
23 
24 #ifndef CQA_FF_MAC_SCHEDULER_H
25 #define CQA_FF_MAC_SCHEDULER_H
26 
27 #include <ns3/lte-common.h>
28 #include <ns3/ff-mac-csched-sap.h>
29 #include <ns3/ff-mac-sched-sap.h>
30 #include <ns3/ff-mac-scheduler.h>
31 #include <vector>
32 #include <map>
33 #include <set>
34 #include <ns3/nstime.h>
35 #include <ns3/lte-amc.h>
36 #include <ns3/lte-ffr-sap.h>
37 
38 // value for SINR outside the range defined by FF-API, used to indicate that there
39 // is no CQI for this element
40 
41 #define NO_SINR -5000
42 #define HARQ_PROC_NUM 8
43 #define HARQ_DL_TIMEOUT 11
44 
45 namespace ns3 {
46 
48 typedef std::vector < uint8_t > DlHarqProcessesStatus_t;
50 typedef std::vector < uint8_t > DlHarqProcessesTimer_t;
52 typedef std::vector < DlDciListElement_s > DlHarqProcessesDciBuffer_t;
54 typedef std::vector < std::vector <struct RlcPduListElement_s> > RlcPduList_t;
56 typedef std::vector < RlcPduList_t > DlHarqRlcPduListBuffer_t;
58 typedef std::vector < UlDciListElement_s > UlHarqProcessesDciBuffer_t;
60 typedef std::vector < uint8_t > UlHarqProcessesStatus_t;
61 
64 {
66  unsigned long totalBytesTransmitted;
67  unsigned int lastTtiBytesTransmitted;
71 
72 };
73 
82 {
83 public:
90 
94  virtual ~CqaFfMacScheduler ();
95 
96  // inherited from Object
97  virtual void DoDispose (void);
102  static TypeId GetTypeId (void);
103 
104  // inherited from FfMacScheduler
105  virtual void SetFfMacCschedSapUser (FfMacCschedSapUser* s);
106  virtual void SetFfMacSchedSapUser (FfMacSchedSapUser* s);
109 
110  // FFR SAPs
111  virtual void SetLteFfrSapProvider (LteFfrSapProvider* s);
113 
118 
124  void TransmissionModeConfigurationUpdate (uint16_t rnti, uint8_t txMode);
125 
126 private:
127  //
128  // Implementation of the CSCHED API primitives
129  // (See 4.1 for description of the primitives)
130  //
131 
137 
143 
149 
155 
161 
162  //
163  // Implementation of the SCHED API primitives
164  // (See 4.2 for description of the primitives)
165  //
166 
172 
178 
184 
190 
196 
202 
208 
214 
220 
226 
232 
238  int GetRbgSize (int dlbandwidth);
239 
245  unsigned int LcActivePerFlow (uint16_t rnti);
246 
253  double EstimateUlSinr (uint16_t rnti, uint16_t rb);
254 
256  void RefreshDlCqiMaps (void);
258  void RefreshUlCqiMaps (void);
259 
266  void UpdateDlRlcBufferInfo (uint16_t rnti, uint8_t lcid, uint16_t size);
272  void UpdateUlRlcBufferInfo (uint16_t rnti, uint16_t size);
273 
280  uint8_t UpdateHarqProcessId (uint16_t rnti);
281 
288  uint8_t HarqProcessAvailability (uint16_t rnti);
289 
294  void RefreshHarqProcesses ();
295 
297 
301  std::map <LteFlowId_t, FfMacSchedSapProvider::SchedDlRlcBufferReqParameters> m_rlcBufferReq;
302 
303 
307  std::map <uint16_t, CqasFlowPerf_t> m_flowStatsDl;
308 
312  std::map <uint16_t, CqasFlowPerf_t> m_flowStatsUl;
313 
317  std::map <LteFlowId_t,struct LogicalChannelConfigListElement_s> m_ueLogicalChannelsConfigList;
318 
322  std::map <uint16_t,uint8_t> m_p10CqiRxed;
323 
327  std::map <uint16_t,uint32_t> m_p10CqiTimers;
328 
332  std::map <uint16_t,SbMeasResult_s> m_a30CqiRxed;
333 
337  std::map <uint16_t,uint32_t> m_a30CqiTimers;
338 
343  std::map <uint16_t, std::vector <uint16_t> > m_allocationMaps;
344 
348  std::map <uint16_t, std::vector <double> > m_ueCqi;
349 
353  std::map <uint16_t, uint32_t> m_ueCqiTimers;
354 
358  std::map <uint16_t,uint32_t> m_ceBsrRxed;
359 
360  // MAC SAPs
365 
366  // FFR SAPs
369 
372 
373 
374  double m_timeWindow;
375 
376  uint16_t m_nextRntiUl;
377 
379 
380  std::map <uint16_t,uint8_t> m_uesTxMode;
381 
382  // HARQ attributes
383  bool m_harqOn;
384  std::map <uint16_t, uint8_t> m_dlHarqCurrentProcessId;
385  //HARQ status
386  // 0: process Id available
387  // x>0: process Id equal to `x` transmission count
388  std::map <uint16_t, DlHarqProcessesStatus_t> m_dlHarqProcessesStatus;
389  std::map <uint16_t, DlHarqProcessesTimer_t> m_dlHarqProcessesTimer;
390  std::map <uint16_t, DlHarqProcessesDciBuffer_t> m_dlHarqProcessesDciBuffer;
391  std::map <uint16_t, DlHarqRlcPduListBuffer_t> m_dlHarqProcessesRlcPduListBuffer;
392  std::vector <DlInfoListElement_s> m_dlInfoListBuffered;
393 
394  std::map <uint16_t, uint8_t> m_ulHarqCurrentProcessId;
395  //HARQ status
396  // 0: process Id available
397  // x>0: process Id equal to `x` transmission count
398  std::map <uint16_t, UlHarqProcessesStatus_t> m_ulHarqProcessesStatus;
399  std::map <uint16_t, UlHarqProcessesDciBuffer_t> m_ulHarqProcessesDciBuffer;
400 
401 
402  // RACH attributes
403  std::vector <struct RachListElement_s> m_rachList;
404  std::vector <uint16_t> m_rachAllocationMap;
405  uint8_t m_ulGrantMcs;
406 
407 
408  std::string m_CqaMetric;
409 
410 };
411 
412 } // namespace ns3
413 
414 #endif /* QOS_FF_MAC_SCHEDULER_H */
Implements the SCHED SAP and CSCHED SAP for the Channel and QoS Aware Scheduler.
std::map< uint16_t, DlHarqRlcPduListBuffer_t > m_dlHarqProcessesRlcPduListBuffer
DL HARQ process RLC PDU list buffer.
FfMacCschedSapProvider * m_cschedSapProvider
Csched SAP provider.
std::map< uint16_t, uint8_t > m_p10CqiRxed
Map of UE's DL CQI P01 received.
void RefreshHarqProcesses()
Refresh HARQ processes according to the timers.
virtual FfMacCschedSapProvider * GetFfMacCschedSapProvider()
void DoSchedUlSrInfoReq(const struct FfMacSchedSapProvider::SchedUlSrInfoReqParameters &params)
Sched UL Sr Info Request.
uint8_t HarqProcessAvailability(uint16_t rnti)
Return the availability of free process for the RNTI specified.
int GetRbgSize(int dlbandwidth)
Get RGB Size.
std::map< uint16_t, CqasFlowPerf_t > m_flowStatsDl
Map of UE statistics (per RNTI basis) in downlink.
std::map< uint16_t, uint8_t > m_dlHarqCurrentProcessId
DL HARQ process ID.
std::map< uint16_t, std::vector< double > > m_ueCqi
Map of UEs' UL-CQI per RBG.
static TypeId GetTypeId(void)
Get the type ID.
void DoCschedCellConfigReq(const struct FfMacCschedSapProvider::CschedCellConfigReqParameters &params)
Csched Cell Config Request.
std::map< uint16_t, DlHarqProcessesTimer_t > m_dlHarqProcessesTimer
DL HARQ process timers.
double m_timeWindow
time window
std::map< LteFlowId_t, struct LogicalChannelConfigListElement_s > m_ueLogicalChannelsConfigList
Map of UE logical channel config list.
void RefreshDlCqiMaps(void)
Refresh DL CGI maps.
std::map< uint16_t, uint32_t > m_ueCqiTimers
Map of UEs' timers on UL-CQI per RBG.
virtual void SetFfMacSchedSapUser(FfMacSchedSapUser *s)
set the user part of the FfMacSchedSap that this Scheduler will interact with.
void DoSchedDlTriggerReq(const struct FfMacSchedSapProvider::SchedDlTriggerReqParameters &params)
Sched DL RLC Buffer Request.
std::map< uint16_t, std::vector< uint16_t > > m_allocationMaps
Map of previous allocated UE per RBG (used to retrieve info from UL-CQI)
std::map< uint16_t, uint32_t > m_p10CqiTimers
Map of UE's timers on DL CQI P01 received.
unsigned int LcActivePerFlow(uint16_t rnti)
LC Active per flow.
FfMacSchedSapUser * m_schedSapUser
MAC Sched SAP user.
void UpdateDlRlcBufferInfo(uint16_t rnti, uint8_t lcid, uint16_t size)
Update DL RLC buffer info.
LteFfrSapProvider * m_ffrSapProvider
FFR SAP provider.
uint8_t UpdateHarqProcessId(uint16_t rnti)
Update and return a new process Id for the RNTI specified.
void DoSchedUlNoiseInterferenceReq(const struct FfMacSchedSapProvider::SchedUlNoiseInterferenceReqParameters &params)
Sched UL Noise InterferenceRequest.
std::map< uint16_t, DlHarqProcessesDciBuffer_t > m_dlHarqProcessesDciBuffer
DL HARQ process DCI buffer.
std::map< uint16_t, uint8_t > m_ulHarqCurrentProcessId
UL HARQ current process ID.
virtual ~CqaFfMacScheduler()
Destructor.
void DoSchedDlCqiInfoReq(const struct FfMacSchedSapProvider::SchedDlCqiInfoReqParameters &params)
Sched DL CGI Info Request.
FfMacCschedSapUser * m_cschedSapUser
MAC Csched SAP user.
std::map< uint16_t, SbMeasResult_s > m_a30CqiRxed
Map of UE's DL CQI A30 received.
LteFfrSapUser * m_ffrSapUser
FFR SAP user.
void DoCschedLcConfigReq(const struct FfMacCschedSapProvider::CschedLcConfigReqParameters &params)
Csched LC Config Request.
void UpdateUlRlcBufferInfo(uint16_t rnti, uint16_t size)
Update UL RLC buffer info.
virtual void SetLteFfrSapProvider(LteFfrSapProvider *s)
Set the Provider part of the LteFfrSap that this Scheduler will interact with.
std::map< uint16_t, UlHarqProcessesStatus_t > m_ulHarqProcessesStatus
UL HARQ process status.
uint8_t m_ulGrantMcs
MCS for UL grant (default 0)
void DoSchedDlRachInfoReq(const struct FfMacSchedSapProvider::SchedDlRachInfoReqParameters &params)
Sched DL RACH Info Request.
std::vector< uint16_t > m_rachAllocationMap
RACH allocation map.
void DoCschedUeConfigReq(const struct FfMacCschedSapProvider::CschedUeConfigReqParameters &params)
Csched UE Config Request.
std::vector< struct RachListElement_s > m_rachList
RACH list.
void DoSchedUlTriggerReq(const struct FfMacSchedSapProvider::SchedUlTriggerReqParameters &params)
Sched UL Trigger Request.
void DoSchedDlPagingBufferReq(const struct FfMacSchedSapProvider::SchedDlPagingBufferReqParameters &params)
Sched DL Paging Buffer Request.
void DoSchedUlCqiInfoReq(const struct FfMacSchedSapProvider::SchedUlCqiInfoReqParameters &params)
Sched UL CGI Info Request.
std::map< uint16_t, UlHarqProcessesDciBuffer_t > m_ulHarqProcessesDciBuffer
UL HARQ process DCI buffer.
Ptr< LteAmc > m_amc
LTE AMC object.
void DoSchedDlMacBufferReq(const struct FfMacSchedSapProvider::SchedDlMacBufferReqParameters &params)
Sched DL MAC Buffer Request.
std::vector< DlInfoListElement_s > m_dlInfoListBuffered
DL HARQ retx buffered.
void DoCschedUeReleaseReq(const struct FfMacCschedSapProvider::CschedUeReleaseReqParameters &params)
Csched UE Release Request.
std::map< uint16_t, CqasFlowPerf_t > m_flowStatsUl
Map of UE statistics (per RNTI basis)
std::map< uint16_t, uint32_t > m_a30CqiTimers
Map of UE's timers on DL CQI A30 received.
virtual void SetFfMacCschedSapUser(FfMacCschedSapUser *s)
set the user part of the FfMacCschedSap that this Scheduler will interact with.
FfMacSchedSapProvider * m_schedSapProvider
Sched SAP provider.
virtual FfMacSchedSapProvider * GetFfMacSchedSapProvider()
std::map< uint16_t, uint8_t > m_uesTxMode
txMode of the UEs
void DoSchedUlMacCtrlInfoReq(const struct FfMacSchedSapProvider::SchedUlMacCtrlInfoReqParameters &params)
Sched UL MAC Control Info Request.
double EstimateUlSinr(uint16_t rnti, uint16_t rb)
Estimate UL Sinr.
void RefreshUlCqiMaps(void)
Refresh UL CGI maps.
virtual LteFfrSapUser * GetLteFfrSapUser()
FfMacCschedSapProvider::CschedCellConfigReqParameters m_cschedCellConfig
Internal parameters.
std::map< uint16_t, DlHarqProcessesStatus_t > m_dlHarqProcessesStatus
DL HARQ process statuses.
uint16_t m_nextRntiUl
RNTI of the next user to be served next scheduling in UL.
std::map< uint16_t, uint32_t > m_ceBsrRxed
Map of UE's buffer status reports received.
void DoSchedDlRlcBufferReq(const struct FfMacSchedSapProvider::SchedDlRlcBufferReqParameters &params)
Sched DL RLC Buffer Request.
std::map< LteFlowId_t, FfMacSchedSapProvider::SchedDlRlcBufferReqParameters > m_rlcBufferReq
Vectors of UE's LC info.
std::string m_CqaMetric
CQA metric name.
virtual void DoDispose(void)
Destructor implementation.
void DoCschedLcReleaseReq(const struct FfMacCschedSapProvider::CschedLcReleaseReqParameters &params)
Csched LC Release Request.
bool m_harqOn
m_harqOn when false inhibit the HARQ mechanisms (by default active)
void TransmissionModeConfigurationUpdate(uint16_t rnti, uint8_t txMode)
Trans mode config update.
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
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:103
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.
CGA Flow Performance structure.
double lastAveragedThroughput
Past average throughput.
double secondLastAveragedThroughput
Second last average throughput.
double targetThroughput
Target throughput.
Time flowStart
flow start time
unsigned int lastTtiBytesTransmitted
Total bytes send by eNB in last tti for this UE.
unsigned long totalBytesTransmitted
Total bytes send by eNb for this UE.
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.