A Discrete-Event Network Simulator
API
tta-ff-mac-scheduler.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2011 Centre Tecnologic de Telecomunicacions de Catalunya (CTTC)
3 *
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License version 2 as
6 * published by the Free Software Foundation;
7 *
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
12 *
13 * You should have received a copy of the GNU General Public License
14 * along with this program; if not, write to the Free Software
15 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16 *
17 * Author: Marco Miozzo <marco.miozzo@cttc.es>
18 * Modification: Dizhi Zhou <dizhi.zhou@gmail.com> // modify codes related to downlink scheduler
19 */
20
21#ifndef TTA_FF_MAC_SCHEDULER_H
22#define TTA_FF_MAC_SCHEDULER_H
23
24#include <ns3/ff-mac-csched-sap.h>
25#include <ns3/ff-mac-sched-sap.h>
26#include <ns3/ff-mac-scheduler.h>
27#include <ns3/lte-amc.h>
28#include <ns3/lte-common.h>
29#include <ns3/lte-ffr-sap.h>
30#include <ns3/nstime.h>
31
32#include <map>
33#include <set>
34#include <vector>
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#define HARQ_PROC_NUM 8
41#define HARQ_DL_TIMEOUT 11
42
43namespace ns3
44{
45
46typedef std::vector<uint8_t> DlHarqProcessesStatus_t;
47typedef std::vector<uint8_t> DlHarqProcessesTimer_t;
48typedef std::vector<DlDciListElement_s> DlHarqProcessesDciBuffer_t;
49typedef std::vector<std::vector<struct RlcPduListElement_s>>
50 RlcPduList_t; // vector of the LCs and layers per UE
51typedef std::vector<RlcPduList_t> DlHarqRlcPduListBuffer_t; // vector of the 8 HARQ processes per UE
52
53typedef std::vector<UlDciListElement_s> UlHarqProcessesDciBuffer_t;
54typedef std::vector<uint8_t> UlHarqProcessesStatus_t;
55
64{
65 public:
72
76 ~TtaFfMacScheduler() override;
77
78 // inherited from Object
79 void DoDispose() override;
84 static TypeId GetTypeId();
85
86 // inherited from FfMacScheduler
91
92 // FFR SAPs
95
100
106 void TransmissionModeConfigurationUpdate(uint16_t rnti, uint8_t txMode);
107
108 private:
109 //
110 // Implementation of the CSCHED API primitives
111 // (See 4.1 for description of the primitives)
112 //
113
120
127
134
141
148
149 //
150 // Implementation of the SCHED API primitives
151 // (See 4.2 for description of the primitives)
152 //
153
160
167
174
181
188
195
202
209
215
222
229
235 int GetRbgSize(int dlbandwidth);
236
242 unsigned int LcActivePerFlow(uint16_t rnti);
243
250 double EstimateUlSinr(uint16_t rnti, uint16_t rb);
251
253 void RefreshDlCqiMaps();
255 void RefreshUlCqiMaps();
256
263 void UpdateDlRlcBufferInfo(uint16_t rnti, uint8_t lcid, uint16_t size);
269 void UpdateUlRlcBufferInfo(uint16_t rnti, uint16_t size);
270
277 uint8_t UpdateHarqProcessId(uint16_t rnti);
278
285 bool HarqProcessAvailability(uint16_t rnti);
286
292
294
298 std::map<LteFlowId_t, FfMacSchedSapProvider::SchedDlRlcBufferReqParameters> m_rlcBufferReq;
299
303 std::set<uint16_t> m_flowStatsDl;
304
308 std::set<uint16_t> m_flowStatsUl;
309
313 std::map<uint16_t, uint8_t> m_p10CqiRxed;
317 std::map<uint16_t, uint32_t> m_p10CqiTimers;
318
322 std::map<uint16_t, SbMeasResult_s> m_a30CqiRxed;
326 std::map<uint16_t, uint32_t> m_a30CqiTimers;
327
332 std::map<uint16_t, std::vector<uint16_t>> m_allocationMaps;
333
337 std::map<uint16_t, std::vector<double>> m_ueCqi;
341 std::map<uint16_t, uint32_t> m_ueCqiTimers;
342
346 std::map<uint16_t, uint32_t> m_ceBsrRxed;
347
348 // MAC SAPs
353
354 // FFR SAPs
357
358 // Internal parameters
361
362 uint16_t m_nextRntiUl;
363
365
366 std::map<uint16_t, uint8_t> m_uesTxMode;
367
368 // HARQ attributes
373 std::map<uint16_t, uint8_t> m_dlHarqCurrentProcessId;
374 // HARQ status
375 // 0: process Id available
376 // x>0: process Id equal to `x` transmission count
377 std::map<uint16_t, DlHarqProcessesStatus_t> m_dlHarqProcessesStatus;
378 std::map<uint16_t, DlHarqProcessesTimer_t> m_dlHarqProcessesTimer;
379 std::map<uint16_t, DlHarqProcessesDciBuffer_t>
381 std::map<uint16_t, DlHarqRlcPduListBuffer_t>
383 std::vector<DlInfoListElement_s> m_dlInfoListBuffered;
384
385 std::map<uint16_t, uint8_t> m_ulHarqCurrentProcessId;
386 // HARQ status
387 // 0: process Id available
388 // x>0: process Id equal to `x` transmission count
389 std::map<uint16_t, UlHarqProcessesStatus_t> m_ulHarqProcessesStatus;
390 std::map<uint16_t, UlHarqProcessesDciBuffer_t>
392
393 // RACH attributes
394 std::vector<struct RachListElement_s> m_rachList;
395 std::vector<uint16_t> m_rachAllocationMap;
396 uint8_t m_ulGrantMcs;
397};
398
399} // namespace ns3
400
401#endif /* TTA_FF_MAC_SCHEDULER_H */
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:41
Service Access Point (SAP) offered by the eNodeB RRC instance to the Frequency Reuse algorithm instan...
Definition: lte-ffr-sap.h:141
MemberCschedSapProvider class.
MemberSchedSapProvider class.
Smart pointer class similar to boost::intrusive_ptr.
Definition: ptr.h:78
Implements the SCHED SAP and CSCHED SAP for a Throughput to Average scheduler.
std::map< uint16_t, uint8_t > m_p10CqiRxed
Map of UE's DL CQI P01 received.
std::map< uint16_t, uint32_t > m_a30CqiTimers
Map of UE's timers on DL CQI A30 received.
FfMacSchedSapUser * m_schedSapUser
Sched SAP user.
bool m_harqOn
m_harqOn when false inhibit the HARQ mechanisms (by default active)
void RefreshHarqProcesses()
Refresh HARQ processes according to the timers.
void DoCschedLcReleaseReq(const struct FfMacCschedSapProvider::CschedLcReleaseReqParameters &params)
CSched LC release request function.
void SetLteFfrSapProvider(LteFfrSapProvider *s) override
Set the Provider part of the LteFfrSap that this Scheduler will interact with.
std::map< uint16_t, std::vector< double > > m_ueCqi
Map of UEs' UL-CQI per RBG.
void DoSchedDlPagingBufferReq(const struct FfMacSchedSapProvider::SchedDlPagingBufferReqParameters &params)
Sched DL paging buffer request function.
std::set< uint16_t > m_flowStatsDl
Set of UE statistics (per RNTI basis) in downlink.
void DoDispose() override
Destructor implementation.
void DoCschedLcConfigReq(const struct FfMacCschedSapProvider::CschedLcConfigReqParameters &params)
CSched LC config request function.
uint16_t m_nextRntiUl
RNTI of the next user to be served next scheduling in UL.
void DoCschedUeReleaseReq(const struct FfMacCschedSapProvider::CschedUeReleaseReqParameters &params)
CSched UE release request function.
int GetRbgSize(int dlbandwidth)
Get RBG size function.
void SetFfMacCschedSapUser(FfMacCschedSapUser *s) override
set the user part of the FfMacCschedSap that this Scheduler will interact with.
LteFfrSapUser * m_ffrSapUser
FFR SAP user.
void UpdateDlRlcBufferInfo(uint16_t rnti, uint8_t lcid, uint16_t size)
Update DL RLC buffer info function.
std::vector< DlInfoListElement_s > m_dlInfoListBuffered
HARQ retx buffered.
void RefreshDlCqiMaps()
Refresh DL CQI maps.
std::map< uint16_t, SbMeasResult_s > m_a30CqiRxed
Map of UE's DL CQI A30 received.
double EstimateUlSinr(uint16_t rnti, uint16_t rb)
Estimate UL SINR function.
LteFfrSapProvider * m_ffrSapProvider
FFR SAP provider.
std::vector< struct RachListElement_s > m_rachList
RACH list.
FfMacSchedSapProvider * GetFfMacSchedSapProvider() override
void DoCschedUeConfigReq(const struct FfMacCschedSapProvider::CschedUeConfigReqParameters &params)
CSched UE config request function.
void DoSchedDlMacBufferReq(const struct FfMacSchedSapProvider::SchedDlMacBufferReqParameters &params)
Sched DL MAC buffer request function.
void RefreshUlCqiMaps()
Refresh UL CQI maps.
static TypeId GetTypeId()
Get the type ID.
~TtaFfMacScheduler() override
Destructor.
std::map< uint16_t, uint8_t > m_uesTxMode
txMode of the UEs
std::map< uint16_t, std::vector< uint16_t > > m_allocationMaps
Map of previous allocated UE per RBG (used to retrieve info from UL-CQI)
void SetFfMacSchedSapUser(FfMacSchedSapUser *s) override
set the user part of the FfMacSchedSap that this Scheduler will interact with.
FfMacCschedSapProvider * m_cschedSapProvider
CSched SAP provider.
std::map< uint16_t, uint8_t > m_ulHarqCurrentProcessId
UL HARQ current process ID.
std::map< uint16_t, uint8_t > m_dlHarqCurrentProcessId
DL HARQ current process ID.
std::map< uint16_t, UlHarqProcessesStatus_t > m_ulHarqProcessesStatus
UL HARQ process status.
std::vector< uint16_t > m_rachAllocationMap
RACH allocation map.
LteFfrSapUser * GetLteFfrSapUser() override
std::map< uint16_t, DlHarqProcessesStatus_t > m_dlHarqProcessesStatus
DL HARQ process status.
void DoSchedUlSrInfoReq(const struct FfMacSchedSapProvider::SchedUlSrInfoReqParameters &params)
Sched UL SR info request function.
uint8_t UpdateHarqProcessId(uint16_t rnti)
Update and return a new process Id for the RNTI specified.
void DoSchedDlCqiInfoReq(const struct FfMacSchedSapProvider::SchedDlCqiInfoReqParameters &params)
Sched DL CQI info request function.
FfMacCschedSapUser * m_cschedSapUser
CSched SAP user.
FfMacCschedSapProvider * GetFfMacCschedSapProvider() override
std::map< uint16_t, UlHarqProcessesDciBuffer_t > m_ulHarqProcessesDciBuffer
UL HARQ process DCI buffer.
void DoSchedDlRlcBufferReq(const struct FfMacSchedSapProvider::SchedDlRlcBufferReqParameters &params)
Sched DL RLC buffer request function.
std::map< uint16_t, uint32_t > m_p10CqiTimers
Map of UE's timers on DL CQI P01 received.
void DoSchedUlMacCtrlInfoReq(const struct FfMacSchedSapProvider::SchedUlMacCtrlInfoReqParameters &params)
Sched UL MAC control info request function.
void TransmissionModeConfigurationUpdate(uint16_t rnti, uint8_t txMode)
Transmission mode configuration update.
void DoSchedUlTriggerReq(const struct FfMacSchedSapProvider::SchedUlTriggerReqParameters &params)
Sched UL trigger request function.
void UpdateUlRlcBufferInfo(uint16_t rnti, uint16_t size)
Update DL RLC buffer info function.
bool HarqProcessAvailability(uint16_t rnti)
Return the availability of free process for the RNTI specified.
unsigned int LcActivePerFlow(uint16_t rnti)
LC active per flow function.
std::map< uint16_t, uint32_t > m_ueCqiTimers
Map of UEs' timers on UL-CQI per RBG.
std::map< uint16_t, DlHarqProcessesTimer_t > m_dlHarqProcessesTimer
DL HARQ process timer.
std::map< uint16_t, uint32_t > m_ceBsrRxed
Map of UE's buffer status reports received.
std::map< uint16_t, DlHarqRlcPduListBuffer_t > m_dlHarqProcessesRlcPduListBuffer
DL HARQ process RLC PDU list buffer.
void DoSchedDlRachInfoReq(const struct FfMacSchedSapProvider::SchedDlRachInfoReqParameters &params)
Sched DL RACH info request function.
void DoSchedDlTriggerReq(const struct FfMacSchedSapProvider::SchedDlTriggerReqParameters &params)
Sched DL trigger request function.
FfMacSchedSapProvider * m_schedSapProvider
Sched SAP provider.
std::map< LteFlowId_t, FfMacSchedSapProvider::SchedDlRlcBufferReqParameters > m_rlcBufferReq
Vectors of UE's LC info.
std::set< uint16_t > m_flowStatsUl
Set of UE statistics (per RNTI basis)
void DoSchedUlNoiseInterferenceReq(const struct FfMacSchedSapProvider::SchedUlNoiseInterferenceReqParameters &params)
Sched UL noise interference request function.
void DoSchedUlCqiInfoReq(const struct FfMacSchedSapProvider::SchedUlCqiInfoReqParameters &params)
Sched UL CQI info request function.
FfMacCschedSapProvider::CschedCellConfigReqParameters m_cschedCellConfig
CSched cell config.
uint8_t m_ulGrantMcs
MCS for UL grant (default 0)
std::map< uint16_t, DlHarqProcessesDciBuffer_t > m_dlHarqProcessesDciBuffer
DL HARQ process DCI buffer.
void DoCschedCellConfigReq(const struct FfMacCschedSapProvider::CschedCellConfigReqParameters &params)
CSched cell config request function.
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.
params
Fit Fluctuating Two Ray model to the 3GPP TR 38.901 using the Anderson-Darling goodness-of-fit ##.
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.