A Discrete-Event Network Simulator
API
rr-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  * Nicola Baldo <nbaldo@cttc.es>
20  */
21 
22 #ifndef RR_FF_MAC_SCHEDULER_H
23 #define RR_FF_MAC_SCHEDULER_H
24 
25 #include <ns3/ff-mac-csched-sap.h>
26 #include <ns3/ff-mac-sched-sap.h>
27 #include <ns3/ff-mac-scheduler.h>
28 #include <vector>
29 #include <map>
30 #include <ns3/lte-common.h>
31 #include <ns3/lte-amc.h>
32 #include <ns3/lte-ffr-sap.h>
33 
34 #define HARQ_PROC_NUM 8
35 #define HARQ_DL_TIMEOUT 11
36 
37 namespace ns3 {
38 
39 
40 typedef std::vector < uint8_t > DlHarqProcessesStatus_t;
41 typedef std::vector < uint8_t > DlHarqProcessesTimer_t;
42 typedef std::vector < DlDciListElement_s > DlHarqProcessesDciBuffer_t;
43 typedef std::vector < std::vector <struct RlcPduListElement_s> > RlcPduList_t; // vector of the LCs and layers per UE
44 typedef std::vector < RlcPduList_t > DlHarqRlcPduListBuffer_t; // vector of the 8 HARQ processes per UE
45 
46 typedef std::vector < UlDciListElement_s > UlHarqProcessesDciBuffer_t;
47 typedef std::vector < uint8_t > UlHarqProcessesStatus_t;
48 
49 
50 
51 
60 {
61 public:
68 
72  virtual ~RrFfMacScheduler ();
73 
74  // inherited from Object
75  virtual void DoDispose (void);
80  static TypeId GetTypeId (void);
81 
82  // inherited from FfMacScheduler
83  virtual void SetFfMacCschedSapUser (FfMacCschedSapUser* s);
84  virtual void SetFfMacSchedSapUser (FfMacSchedSapUser* s);
87 
88  // FFR SAPs
89  virtual void SetLteFfrSapProvider (LteFfrSapProvider* s);
90  virtual LteFfrSapUser* GetLteFfrSapUser ();
91 
96 
102  void TransmissionModeConfigurationUpdate (uint16_t rnti, uint8_t txMode);
103 
104 private:
105  //
106  // Implementation of the CSCHED API primitives
107  // (See 4.1 for description of the primitives)
108  //
109 
115 
121 
127 
133 
139 
140  //
141  // Implementation of the SCHED API primitives
142  // (See 4.2 for description of the primitives)
143  //
144 
150 
156 
162 
168 
174 
180 
186 
192 
198 
204 
210 
216  int GetRbgSize (int dlbandwidth);
217 
225 
227  void RefreshDlCqiMaps (void);
229  void RefreshUlCqiMaps (void);
230 
237  void UpdateDlRlcBufferInfo (uint16_t rnti, uint8_t lcid, uint16_t size);
243  void UpdateUlRlcBufferInfo (uint16_t rnti, uint16_t size);
244 
251  uint8_t UpdateHarqProcessId (uint16_t rnti);
252 
259  uint8_t HarqProcessAvailability (uint16_t rnti);
260 
265  void RefreshHarqProcesses ();
266 
268 
272  std::list <FfMacSchedSapProvider::SchedDlRlcBufferReqParameters> m_rlcBufferReq;
273 
277  std::map <uint16_t,uint8_t> m_p10CqiRxed;
281  std::map <uint16_t,uint32_t> m_p10CqiTimers;
282 
287  std::map <uint16_t, std::vector <uint16_t> > m_allocationMaps;
288 
292  std::map <uint16_t, std::vector <double> > m_ueCqi;
296  std::map <uint16_t, uint32_t> m_ueCqiTimers;
297 
298 
299 
303  std::map <uint16_t,uint32_t> m_ceBsrRxed;
304 
305  // MAC SAPs
310 
311  // FFR SAPs
314 
315  // Internal parameters
317 
318  uint16_t m_nextRntiDl;
319  uint16_t m_nextRntiUl;
320 
322 
323  std::map <uint16_t,uint8_t> m_uesTxMode;
324 
325 
326 
327  // HARQ attributes
331  bool m_harqOn;
332  std::map <uint16_t, uint8_t> m_dlHarqCurrentProcessId;
333  //HARQ status
334  // 0: process Id available
335  // x>0: process Id equal to `x` transmission count
336  std::map <uint16_t, DlHarqProcessesStatus_t> m_dlHarqProcessesStatus;
337  std::map <uint16_t, DlHarqProcessesTimer_t> m_dlHarqProcessesTimer;
338  std::map <uint16_t, DlHarqProcessesDciBuffer_t> m_dlHarqProcessesDciBuffer;
339  std::map <uint16_t, DlHarqRlcPduListBuffer_t> m_dlHarqProcessesRlcPduListBuffer;
340  std::vector <DlInfoListElement_s> m_dlInfoListBuffered;
341 
342  std::map <uint16_t, uint8_t> m_ulHarqCurrentProcessId;
343  //HARQ status
344  // 0: process Id available
345  // x>0: process Id equal to `x` transmission count
346  std::map <uint16_t, UlHarqProcessesStatus_t> m_ulHarqProcessesStatus;
347  std::map <uint16_t, UlHarqProcessesDciBuffer_t> m_ulHarqProcessesDciBuffer;
348 
349 
350  // RACH attributes
351  std::vector <struct RachListElement_s> m_rachList;
352  std::vector <uint16_t> m_rachAllocationMap;
353  uint8_t m_ulGrantMcs;
354 };
355 
356 } // namespace ns3
357 
358 #endif /* RR_FF_MAC_SCHEDULER_H */
void RefreshUlCqiMaps(void)
Refresh UL CQI maps function.
std::vector< std::vector< struct RlcPduListElement_s > > RlcPduList_t
vector of the LCs and layers per UE
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:138
virtual FfMacSchedSapProvider * GetFfMacSchedSapProvider()
Ptr< LteAmc > m_amc
AMC.
std::map< uint16_t, uint32_t > m_ueCqiTimers
Map of UEs&#39; timers on UL-CQI per RBG.
Parameters of the CSCHED_UE_RELEASE_REQ primitive.
static TypeId GetTypeId(void)
Get the type ID.
std::vector< UlDciListElement_s > UlHarqProcessesDciBuffer_t
UL HARQ process DCI buffer vector.
void RefreshDlCqiMaps(void)
Refresh DL CQI maps function.
std::vector< uint8_t > DlHarqProcessesTimer_t
DL HARQ process timer vector typedef.
void DoCschedCellConfigReq(const struct FfMacCschedSapProvider::CschedCellConfigReqParameters &params)
CSched cell config request.
Provides the CSCHED SAP.
static bool SortRlcBufferReq(FfMacSchedSapProvider::SchedDlRlcBufferReqParameters i, FfMacSchedSapProvider::SchedDlRlcBufferReqParameters j)
Sort RLC buffer request function.
virtual void SetFfMacSchedSapUser(FfMacSchedSapUser *s)
set the user part of the FfMacSchedSap that this Scheduler will interact with.
FfMacCschedSapProvider * m_cschedSapProvider
CSched SAP provider.
Parameters of the CSCHED_LC_RELEASE_REQ primitive.
void DoCschedLcConfigReq(const struct FfMacCschedSapProvider::CschedLcConfigReqParameters &params)
CSched LC config request.
void DoCschedUeConfigReq(const struct FfMacCschedSapProvider::CschedUeConfigReqParameters &params)
CSched UE config request.
void DoSchedDlRachInfoReq(const struct FfMacSchedSapProvider::SchedDlRachInfoReqParameters &params)
Sched DL RACH info request.
FfMacSchedSapUser * m_schedSapUser
Sched SAP user.
Parameters of the SCHED_DL_TRIGGER_REQ primitive.
virtual ~RrFfMacScheduler()
Destructor.
uint8_t UpdateHarqProcessId(uint16_t rnti)
Update and return a new process Id for the RNTI specified.
void DoSchedDlPagingBufferReq(const struct FfMacSchedSapProvider::SchedDlPagingBufferReqParameters &params)
Sched DL paging buffer request.
std::map< uint16_t, uint8_t > m_ulHarqCurrentProcessId
UL HARQ current process ID.
std::map< uint16_t, DlHarqRlcPduListBuffer_t > m_dlHarqProcessesRlcPduListBuffer
DL HARQ process RLC PDU list buffer.
std::vector< RlcPduList_t > DlHarqRlcPduListBuffer_t
vector of the 8 HARQ processes per UE
Parameters of the SCHED_DL_MAC_BUFFER_REQ primitive.
Parameters of the SCHED_DL_PAGING_BUFFER_REQ primitive.
std::map< uint16_t, uint8_t > m_p10CqiRxed
Map of UE&#39;s DL CQI P01 received.
virtual LteFfrSapUser * GetLteFfrSapUser()
FfMacCschedSapProvider::CschedCellConfigReqParameters m_cschedCellConfig
CSched cell config.
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.
std::map< uint16_t, DlHarqProcessesStatus_t > m_dlHarqProcessesStatus
DL HARQ process status.
LteFfrSapUser * m_ffrSapUser
FFR SAP user.
virtual void SetFfMacCschedSapUser(FfMacCschedSapUser *s)
set the user part of the FfMacCschedSap that this Scheduler will interact with.
std::map< uint16_t, std::vector< uint16_t > > m_allocationMaps
Map of previous allocated UE per RBG (used to retrieve info from UL-CQI)
FfMacCschedSapUser * m_cschedSapUser
CSched SAP user.
void DoSchedDlRlcBufferReq(const struct FfMacSchedSapProvider::SchedDlRlcBufferReqParameters &params)
Sched DL RLC buffer request.
std::map< uint16_t, UlHarqProcessesDciBuffer_t > m_ulHarqProcessesDciBuffer
UL HARQ process DCI buffer.
Provides the SCHED SAP.
std::map< uint16_t, uint32_t > m_p10CqiTimers
Map of UE&#39;s timers on DL CQI P01 received.
uint8_t HarqProcessAvailability(uint16_t rnti)
Return the availability of free process for the RNTI specified.
void DoSchedUlCqiInfoReq(const struct FfMacSchedSapProvider::SchedUlCqiInfoReqParameters &params)
Sched UL CQI info request.
Parameters of the SCHED_UL_NOISE_INTERFERENCE_REQ primitive.
virtual void SetLteFfrSapProvider(LteFfrSapProvider *s)
Set the Provider part of the LteFfrSap that this Scheduler will interact with.
void RefreshHarqProcesses()
Refresh HARQ processes according to the timers.
void DoSchedUlSrInfoReq(const struct FfMacSchedSapProvider::SchedUlSrInfoReqParameters &params)
Sched UL SRS info request.
void UpdateUlRlcBufferInfo(uint16_t rnti, uint16_t size)
Update UL RLC buffer info function.
void DoSchedUlMacCtrlInfoReq(const struct FfMacSchedSapProvider::SchedUlMacCtrlInfoReqParameters &params)
Sched UL MAC control info request.
Every class exported by the ns3 library is enclosed in the ns3 namespace.
bool m_harqOn
m_harqOn when false inhibit the HARQ mechanisms (by default active)
int GetRbgSize(int dlbandwidth)
Get RBG size function.
std::list< FfMacSchedSapProvider::SchedDlRlcBufferReqParameters > m_rlcBufferReq
Vectors of UE&#39;s RLC info.
std::map< uint16_t, std::vector< double > > m_ueCqi
Map of UEs&#39; UL-CQI per RBG.
std::vector< DlDciListElement_s > DlHarqProcessesDciBuffer_t
DL HARQ process DCI buffer vector typedef.
Parameters of the CSCHED_LC_CONFIG_REQ primitive.
void DoSchedUlNoiseInterferenceReq(const struct FfMacSchedSapProvider::SchedUlNoiseInterferenceReqParameters &params)
Sched UL noise interference request.
MemberCschedSapProvider class.
uint8_t m_ulGrantMcs
MCS for UL grant (default 0)
std::map< uint16_t, UlHarqProcessesStatus_t > m_ulHarqProcessesStatus
UL HARQ process status.
LteFfrSapProvider * m_ffrSapProvider
FFR SAP provider.
void DoCschedLcReleaseReq(const struct FfMacCschedSapProvider::CschedLcReleaseReqParameters &params)
CSched LC release request.
virtual FfMacCschedSapProvider * GetFfMacCschedSapProvider()
This abstract base class identifies the interface by means of which the helper object can plug on the...
FfMacCschedSapUser class.
Parameters of the SCHED_DL_CQI_INFO_REQ primitive.
FfMacSchedSapProvider * m_schedSapProvider
Sched SAP provider.
Implements the SCHED SAP and CSCHED SAP for a Round Robin scheduler.
std::vector< uint8_t > UlHarqProcessesStatus_t
UL HARQ process status vector.
RrFfMacScheduler()
Constructor.
std::vector< uint8_t > DlHarqProcessesStatus_t
DL HARQ process status vector typedef.
Parameters of the SCHED_UL_CQI_INFO_REQ primitive.
std::map< uint16_t, DlHarqProcessesDciBuffer_t > m_dlHarqProcessesDciBuffer
DL HARQ process DCI buffer.
std::vector< struct RachListElement_s > m_rachList
RACH list.
void UpdateDlRlcBufferInfo(uint16_t rnti, uint8_t lcid, uint16_t size)
Update DL RLC buffer info function.
std::map< uint16_t, DlHarqProcessesTimer_t > m_dlHarqProcessesTimer
DL HARQ process timer.
uint16_t m_nextRntiUl
RNTI of the next user to be served next scheduling in UL.
std::map< uint16_t, uint8_t > m_dlHarqCurrentProcessId
DL HARQ current process ID.
Parameters of the SCHED_UL_MAC_CTRL_INFO_REQ primitive.
void DoSchedDlTriggerReq(const struct FfMacSchedSapProvider::SchedDlTriggerReqParameters &params)
Sched DL trigger request.
void DoCschedUeReleaseReq(const struct FfMacCschedSapProvider::CschedUeReleaseReqParameters &params)
CSched UE release request.
uint32_t m_cqiTimersThreshold
of TTIs for which a CQI can be considered valid
Parameters of the SCHED_UL_SR_INFO_REQ primitive.
uint16_t m_nextRntiDl
RNTI of the next user to be served next scheduling in DL.
void DoSchedDlCqiInfoReq(const struct FfMacSchedSapProvider::SchedDlCqiInfoReqParameters &params)
Sched DL CQI info request.
void TransmissionModeConfigurationUpdate(uint16_t rnti, uint8_t txMode)
Transmission mode configuration update function.
Parameters of the SCHED_DL_RACH_INFO_REQ primitive.
void DoSchedDlMacBufferReq(const struct FfMacSchedSapProvider::SchedDlMacBufferReqParameters &params)
Sched DL MAC buffer request.
MemberSchedSapProvider class.
Parameters of the CSCHED_UE_CONFIG_REQ primitive.
virtual void DoDispose(void)
Destructor implementation.
std::vector< DlInfoListElement_s > m_dlInfoListBuffered
HARQ retx buffered.
std::map< uint16_t, uint32_t > m_ceBsrRxed
Map of UE&#39;s buffer status reports received.
std::vector< uint16_t > m_rachAllocationMap
RACH allocation map.
a unique identifier for an interface.
Definition: type-id.h:58
FfMacSchedSapUser class.
std::map< uint16_t, uint8_t > m_uesTxMode
txMode of the UEs
void DoSchedUlTriggerReq(const struct FfMacSchedSapProvider::SchedUlTriggerReqParameters &params)
Sched UL trigger request.