A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
tdtbfq-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 TDTBFQ_FF_MAC_SCHEDULER_H
22#define TDTBFQ_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 <vector>
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#define HARQ_PROC_NUM 8
40#define HARQ_DL_TIMEOUT 11
41
42namespace ns3
43{
44
45typedef std::vector<uint8_t> DlHarqProcessesStatus_t;
46typedef std::vector<uint8_t> DlHarqProcessesTimer_t;
47typedef std::vector<DlDciListElement_s> DlHarqProcessesDciBuffer_t;
48typedef std::vector<std::vector<struct RlcPduListElement_s>>
49 RlcPduList_t; // vector of the LCs and layers per UE
50typedef std::vector<RlcPduList_t> DlHarqRlcPduListBuffer_t; // vector of the 8 HARQ processes per UE
51
52typedef std::vector<UlDciListElement_s> UlHarqProcessesDciBuffer_t;
53typedef std::vector<uint8_t> UlHarqProcessesStatus_t;
54
59{
65 int counter;
71};
72
81{
82 public:
89
93 ~TdTbfqFfMacScheduler() override;
94
95 // inherited from Object
96 void DoDispose() override;
101 static TypeId GetTypeId();
102
103 // inherited from FfMacScheduler
105 void SetFfMacSchedSapUser(FfMacSchedSapUser* s) override;
108
109 // FFR SAPs
110 void SetLteFfrSapProvider(LteFfrSapProvider* s) override;
112
117
123 void TransmissionModeConfigurationUpdate(uint16_t rnti, uint8_t txMode);
124
125 private:
126 //
127 // Implementation of the CSCHED API primitives
128 // (See 4.1 for description of the primitives)
129 //
130
137
144
151
158
165
166 //
167 // Implementation of the SCHED API primitives
168 // (See 4.2 for description of the primitives)
169 //
170
177
184
191
198
205
212
219
226
232
239
246
252 int GetRbgSize(int dlbandwidth);
253
259 unsigned int LcActivePerFlow(uint16_t rnti);
260
267 double EstimateUlSinr(uint16_t rnti, uint16_t rb);
268
270 void RefreshDlCqiMaps();
272 void RefreshUlCqiMaps();
273
280 void UpdateDlRlcBufferInfo(uint16_t rnti, uint8_t lcid, uint16_t size);
286 void UpdateUlRlcBufferInfo(uint16_t rnti, uint16_t size);
287
294 uint8_t UpdateHarqProcessId(uint16_t rnti);
295
302 bool HarqProcessAvailability(uint16_t rnti);
303
309
311
315 std::map<LteFlowId_t, FfMacSchedSapProvider::SchedDlRlcBufferReqParameters> m_rlcBufferReq;
316
320 std::map<uint16_t, tdtbfqsFlowPerf_t> m_flowStatsDl;
321
325 std::map<uint16_t, tdtbfqsFlowPerf_t> m_flowStatsUl;
326
330 std::map<uint16_t, uint8_t> m_p10CqiRxed;
334 std::map<uint16_t, uint32_t> m_p10CqiTimers;
335
339 std::map<uint16_t, SbMeasResult_s> m_a30CqiRxed;
343 std::map<uint16_t, uint32_t> m_a30CqiTimers;
344
349 std::map<uint16_t, std::vector<uint16_t>> m_allocationMaps;
350
354 std::map<uint16_t, std::vector<double>> m_ueCqi;
358 std::map<uint16_t, uint32_t> m_ueCqiTimers;
359
363 std::map<uint16_t, uint32_t> m_ceBsrRxed;
364
365 // MAC SAPs
370
371 // FFR SAPs
374
375 // Internal parameters
378
379 uint16_t m_nextRntiUl;
380
382
383 std::map<uint16_t, uint8_t> m_uesTxMode;
384
385 uint64_t bankSize;
386
388
390
392
394
395 // HARQ attributes
400 std::map<uint16_t, uint8_t> m_dlHarqCurrentProcessId;
401 // HARQ status
402 // 0: process Id available
403 // x>0: process Id equal to `x` transmission count
404 std::map<uint16_t, DlHarqProcessesStatus_t> m_dlHarqProcessesStatus;
405 std::map<uint16_t, DlHarqProcessesTimer_t> m_dlHarqProcessesTimer;
406 std::map<uint16_t, DlHarqProcessesDciBuffer_t>
408 std::map<uint16_t, DlHarqRlcPduListBuffer_t>
410 std::vector<DlInfoListElement_s> m_dlInfoListBuffered;
411
412 std::map<uint16_t, uint8_t> m_ulHarqCurrentProcessId;
413 // HARQ status
414 // 0: process Id available
415 // x>0: process Id equal to `x` transmission count
416 std::map<uint16_t, UlHarqProcessesStatus_t> m_ulHarqProcessesStatus;
417 std::map<uint16_t, UlHarqProcessesDciBuffer_t>
419
420 // RACH attributes
421 std::vector<struct RachListElement_s> m_rachList;
422 std::vector<uint16_t> m_rachAllocationMap;
423 uint8_t m_ulGrantMcs;
424};
425
426} // namespace ns3
427
428#endif /* TDTBFQ_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 Time Domain Token Bank Fair Queue scheduler.
uint16_t m_nextRntiUl
RNTI of the next user to be served next scheduling in UL.
void DoSchedDlRachInfoReq(const struct FfMacSchedSapProvider::SchedDlRachInfoReqParameters &params)
Sched DL RACH info request.
bool HarqProcessAvailability(uint16_t rnti)
Return the availability of free process for the RNTI specified.
void DoSchedDlCqiInfoReq(const struct FfMacSchedSapProvider::SchedDlCqiInfoReqParameters &params)
Sched DL CQI info request.
void SetLteFfrSapProvider(LteFfrSapProvider *s) override
Set the Provider part of the LteFfrSap that this Scheduler will interact with.
void DoSchedUlNoiseInterferenceReq(const struct FfMacSchedSapProvider::SchedUlNoiseInterferenceReqParameters &params)
Sched UL noise interference request.
void DoSchedDlMacBufferReq(const struct FfMacSchedSapProvider::SchedDlMacBufferReqParameters &params)
Sched DL MAC buffer request.
static TypeId GetTypeId()
Get the type ID.
std::map< uint16_t, uint8_t > m_uesTxMode
txMode of the UEs
std::map< uint16_t, DlHarqProcessesTimer_t > m_dlHarqProcessesTimer
DL HARQ process timer.
void UpdateDlRlcBufferInfo(uint16_t rnti, uint8_t lcid, uint16_t size)
Update DL RLC buffer info function.
void UpdateUlRlcBufferInfo(uint16_t rnti, uint16_t size)
Update UL RLC buffer info function.
~TdTbfqFfMacScheduler() override
Destructor.
FfMacSchedSapProvider * m_schedSapProvider
Sched SAP provider.
std::map< uint16_t, UlHarqProcessesDciBuffer_t > m_ulHarqProcessesDciBuffer
UL HARQ process DCI buffer.
FfMacCschedSapProvider::CschedCellConfigReqParameters m_cschedCellConfig
CSched cell config.
FfMacSchedSapUser * m_schedSapUser
A=Sched SAP user.
void DoSchedDlPagingBufferReq(const struct FfMacSchedSapProvider::SchedDlPagingBufferReqParameters &params)
Sched DL paging buffer request.
unsigned int LcActivePerFlow(uint16_t rnti)
LC active flow size.
std::map< uint16_t, DlHarqProcessesDciBuffer_t > m_dlHarqProcessesDciBuffer
DL HARQ process DCI buffer.
std::map< uint16_t, DlHarqRlcPduListBuffer_t > m_dlHarqProcessesRlcPduListBuffer
DL HARQ process RLC PDU list buffer.
uint32_t m_creditLimit
flow credit limit (byte)
uint8_t UpdateHarqProcessId(uint16_t rnti)
Update and return a new process Id for the RNTI specified.
std::map< uint16_t, uint32_t > m_a30CqiTimers
Map of UE's timers on DL CQI A30 received.
void DoCschedLcReleaseReq(const struct FfMacCschedSapProvider::CschedLcReleaseReqParameters &params)
CSched LC release request.
std::vector< uint16_t > m_rachAllocationMap
RACH allocation map.
LteFfrSapUser * m_ffrSapUser
FFR SAP user.
std::map< uint16_t, uint32_t > m_ceBsrRxed
Map of UE's buffer status reports received.
int GetRbgSize(int dlbandwidth)
Get RBG size.
std::map< uint16_t, uint32_t > m_p10CqiTimers
Map of UE's timers on DL CQI P01 received.
std::map< uint16_t, uint8_t > m_ulHarqCurrentProcessId
UL HARQ current process ID.
void DoSchedDlRlcBufferReq(const struct FfMacSchedSapProvider::SchedDlRlcBufferReqParameters &params)
Sched DL RLC buffer request.
void RefreshDlCqiMaps()
Refresh DL CQI maps function.
void DoSchedUlCqiInfoReq(const struct FfMacSchedSapProvider::SchedUlCqiInfoReqParameters &params)
Sched UL CQI info request.
uint8_t m_ulGrantMcs
MCS for UL grant (default 0)
std::map< uint16_t, std::vector< double > > m_ueCqi
Map of UEs' UL-CQI per RBG.
FfMacSchedSapProvider * GetFfMacSchedSapProvider() override
uint32_t m_creditableThreshold
threshold of flow credit
std::map< uint16_t, tdtbfqsFlowPerf_t > m_flowStatsUl
Map of UE statistics (per RNTI basis)
LteFfrSapUser * GetLteFfrSapUser() override
FfMacCschedSapProvider * GetFfMacCschedSapProvider() override
void TransmissionModeConfigurationUpdate(uint16_t rnti, uint8_t txMode)
Transmission mde configuration update function.
std::map< LteFlowId_t, FfMacSchedSapProvider::SchedDlRlcBufferReqParameters > m_rlcBufferReq
Vectors of UE's LC info.
FfMacCschedSapProvider * m_cschedSapProvider
CSched SAP provider.
void RefreshUlCqiMaps()
Refresh UL CQI maps function.
void SetFfMacSchedSapUser(FfMacSchedSapUser *s) override
set the user part of the FfMacSchedSap that this Scheduler will interact with.
void DoSchedUlTriggerReq(const struct FfMacSchedSapProvider::SchedUlTriggerReqParameters &params)
Sched UL trigger request.
int m_debtLimit
flow debt limit (byte)
double EstimateUlSinr(uint16_t rnti, uint16_t rb)
Estimate UL SINR function.
void DoCschedUeReleaseReq(const struct FfMacCschedSapProvider::CschedUeReleaseReqParameters &params)
CSched UE release request.
void DoCschedLcConfigReq(const struct FfMacCschedSapProvider::CschedLcConfigReqParameters &params)
CSched LC config request.
void DoSchedUlSrInfoReq(const struct FfMacSchedSapProvider::SchedUlSrInfoReqParameters &params)
Sched UL SR info request.
LteFfrSapProvider * m_ffrSapProvider
FFR SAP provider.
std::map< uint16_t, uint8_t > m_p10CqiRxed
Map of UE's DL CQI P01 received.
void DoCschedCellConfigReq(const struct FfMacCschedSapProvider::CschedCellConfigReqParameters &params)
CSched cell config request.
uint32_t m_tokenPoolSize
maximum size of token pool (byte)
std::map< uint16_t, DlHarqProcessesStatus_t > m_dlHarqProcessesStatus
DL HARQ process status.
FfMacCschedSapUser * m_cschedSapUser
CSched SAP user.
std::map< uint16_t, uint32_t > m_ueCqiTimers
Map of UEs' timers on UL-CQI per RBG.
void DoDispose() override
Destructor implementation.
void DoSchedUlMacCtrlInfoReq(const struct FfMacSchedSapProvider::SchedUlMacCtrlInfoReqParameters &params)
Sched UL MAC control info request.
std::map< uint16_t, uint8_t > m_dlHarqCurrentProcessId
DL HARQ current process ID.
void DoSchedDlTriggerReq(const struct FfMacSchedSapProvider::SchedDlTriggerReqParameters &params)
Sched DL trigger 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)
void RefreshHarqProcesses()
Refresh HARQ processes according to the timers.
void SetFfMacCschedSapUser(FfMacCschedSapUser *s) override
set the user part of the FfMacCschedSap that this Scheduler will interact with.
std::vector< struct RachListElement_s > m_rachList
RACH list.
std::vector< DlInfoListElement_s > m_dlInfoListBuffered
HARQ retx buffered.
std::map< uint16_t, UlHarqProcessesStatus_t > m_ulHarqProcessesStatus
UL HARQ process status.
void DoCschedUeConfigReq(const struct FfMacCschedSapProvider::CschedUeConfigReqParameters &params)
CSched UE config request.
std::map< uint16_t, tdtbfqsFlowPerf_t > m_flowStatsDl
Map of UE statistics (per RNTI basis) in downlink.
std::map< uint16_t, SbMeasResult_s > m_a30CqiRxed
Map of UE's DL CQI A30 received.
uint64_t bankSize
the number of bytes in token bank
bool m_harqOn
m_harqOn when false inhibit the HARQ mechanisms (by default active)
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:105
a unique identifier for an interface.
Definition: type-id.h:60
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.
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.
uint32_t tokenPoolSize
current size of token pool (byte)
int debtLimit
counter threshold that the flow cannot further borrow tokens from bank
uint32_t maxTokenPoolSize
maximum size of token pool (byte)
int counter
the number of token borrow or given to token bank
uint32_t creditableThreshold
the flow cannot borrow token from bank until the number of token it has deposited to bank reaches thi...
uint64_t packetArrivalRate
packet arrival rate( byte/s)
uint64_t tokenGenerationRate
token generation rate ( byte/s )
Time flowStart
flow start time
uint32_t burstCredit
the maximum number of tokens connection i can borrow from the bank each time