A Discrete-Event Network Simulator
API
fdtbfq-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 FDTBFQ_FF_MAC_SCHEDULER_H
22#define FDTBFQ_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
39#define NO_SINR -5000
40
42#define HARQ_PROC_NUM 8
44#define HARQ_DL_TIMEOUT 11
45
46namespace ns3
47{
48
49typedef std::vector<uint8_t> DlHarqProcessesStatus_t;
50typedef std::vector<uint8_t> DlHarqProcessesTimer_t;
51typedef std::vector<DlDciListElement_s> DlHarqProcessesDciBuffer_t;
52typedef std::vector<std::vector<struct RlcPduListElement_s>>
54typedef std::vector<RlcPduList_t>
56
57typedef std::vector<UlDciListElement_s> UlHarqProcessesDciBuffer_t;
58typedef std::vector<uint8_t> UlHarqProcessesStatus_t;
59
64{
70 int counter;
76};
77
87{
88 public:
95
99 ~FdTbfqFfMacScheduler() override;
100
101 // inherited from Object
102 void DoDispose() override;
107 static TypeId GetTypeId();
108
109 // inherited from FfMacScheduler
119 void SetFfMacSchedSapUser(FfMacSchedSapUser* s) override;
130
131 // FFR SAPs
136 void SetLteFfrSapProvider(LteFfrSapProvider* s) override;
142
147
153 void TransmissionModeConfigurationUpdate(uint16_t rnti, uint8_t txMode);
154
155 private:
156 //
157 // Implementation of the CSCHED API primitives
158 // (See 4.1 for description of the primitives)
159 //
160
167
174
181
188
195
196 //
197 // Implementation of the SCHED API primitives
198 // (See 4.2 for description of the primitives)
199 //
200
207
214
221
229
236
243
250
257
263
270
277
283 int GetRbgSize(int dlbandwidth);
284
290 unsigned int LcActivePerFlow(uint16_t rnti);
291
298 double EstimateUlSinr(uint16_t rnti, uint16_t rb);
299
301 void RefreshDlCqiMaps();
303 void RefreshUlCqiMaps();
304
311 void UpdateDlRlcBufferInfo(uint16_t rnti, uint8_t lcid, uint16_t size);
317 void UpdateUlRlcBufferInfo(uint16_t rnti, uint16_t size);
318
325 uint8_t UpdateHarqProcessId(uint16_t rnti);
326
333 uint8_t HarqProcessAvailability(uint16_t rnti);
334
340
342
346 std::map<LteFlowId_t, FfMacSchedSapProvider::SchedDlRlcBufferReqParameters> m_rlcBufferReq;
347
351 std::map<uint16_t, fdtbfqsFlowPerf_t> m_flowStatsDl;
352
356 std::map<uint16_t, fdtbfqsFlowPerf_t> m_flowStatsUl;
357
361 std::map<uint16_t, uint8_t> m_p10CqiRxed;
362
366 std::map<uint16_t, uint32_t> m_p10CqiTimers;
367
371 std::map<uint16_t, SbMeasResult_s> m_a30CqiRxed;
372
376 std::map<uint16_t, uint32_t> m_a30CqiTimers;
377
382 std::map<uint16_t, std::vector<uint16_t>> m_allocationMaps;
383
387 std::map<uint16_t, std::vector<double>> m_ueCqi;
388
392 std::map<uint16_t, uint32_t> m_ueCqiTimers;
393
397 std::map<uint16_t, uint32_t> m_ceBsrRxed;
398
399 // MAC SAPs
404
405 // FFR SAPs
408
409 // Internal parameters
412
413 uint16_t m_nextRntiUl;
414
416
417 std::map<uint16_t, uint8_t> m_uesTxMode;
418
419 uint64_t bankSize;
420
422
424
426
428
429 // HARQ attributes
430 bool m_harqOn;
431 std::map<uint16_t, uint8_t> m_dlHarqCurrentProcessId;
432 // HARQ status
433 // 0: process Id available
434 // x>0: process Id equal to `x` transmission count
435 std::map<uint16_t, DlHarqProcessesStatus_t> m_dlHarqProcessesStatus;
436 std::map<uint16_t, DlHarqProcessesTimer_t> m_dlHarqProcessesTimer;
437 std::map<uint16_t, DlHarqProcessesDciBuffer_t>
439 std::map<uint16_t, DlHarqRlcPduListBuffer_t>
441 std::vector<DlInfoListElement_s> m_dlInfoListBuffered;
442
443 std::map<uint16_t, uint8_t> m_ulHarqCurrentProcessId;
444 // HARQ status
445 // 0: process Id available
446 // x>0: process Id equal to `x` transmission count
447 std::map<uint16_t, UlHarqProcessesStatus_t> m_ulHarqProcessesStatus;
448 std::map<uint16_t, UlHarqProcessesDciBuffer_t>
450
451 // RACH attributes
452 std::vector<struct RachListElement_s> m_rachList;
453 std::vector<uint16_t> m_rachAllocationMap;
454 uint8_t m_ulGrantMcs;
455};
456
457} // namespace ns3
458
459#endif /* FDTBFQ_FF_MAC_SCHEDULER_H */
Implements the SCHED SAP and CSCHED SAP for a Frequency Domain Token Bank Fair Queue scheduler.
std::vector< uint16_t > m_rachAllocationMap
RACH allocation map.
void DoCschedLcConfigReq(const struct FfMacCschedSapProvider::CschedLcConfigReqParameters &params)
CSched LC config request function.
std::vector< struct RachListElement_s > m_rachList
RACH list.
uint32_t m_tokenPoolSize
maximum size of token pool (byte)
std::map< uint16_t, fdtbfqsFlowPerf_t > m_flowStatsUl
Map of UE statistics (per RNTI basis)
void DoSchedUlCqiInfoReq(const struct FfMacSchedSapProvider::SchedUlCqiInfoReqParameters &params)
Sched UL CQI info request function.
LteFfrSapProvider * m_ffrSapProvider
FFR SAP provider.
std::map< uint16_t, uint32_t > m_ceBsrRxed
Map of UE's buffer status reports received.
std::map< LteFlowId_t, FfMacSchedSapProvider::SchedDlRlcBufferReqParameters > m_rlcBufferReq
Vectors of UE's LC info.
std::map< uint16_t, std::vector< double > > m_ueCqi
Map of UEs' UL-CQI per RBG.
static TypeId GetTypeId()
Get the type ID.
uint64_t bankSize
the number of bytes in token bank
uint8_t UpdateHarqProcessId(uint16_t rnti)
Update and return a new process Id for the RNTI specified.
void DoCschedUeReleaseReq(const struct FfMacCschedSapProvider::CschedUeReleaseReqParameters &params)
CSched UE release request function.
LteFfrSapUser * m_ffrSapUser
FFR SAP user.
std::map< uint16_t, uint8_t > m_ulHarqCurrentProcessId
UL HARQ current process ID.
void SetFfMacCschedSapUser(FfMacCschedSapUser *s) override
Set FF MAC Csched SAP user function.
void DoSchedUlTriggerReq(const struct FfMacSchedSapProvider::SchedUlTriggerReqParameters &params)
Sched UL trigger request function.
std::map< uint16_t, DlHarqProcessesDciBuffer_t > m_dlHarqProcessesDciBuffer
DL HARQ process DCI buffer.
void RefreshHarqProcesses()
Refresh HARQ processes according to the timers.
LteFfrSapUser * GetLteFfrSapUser() override
Get FFR SAP user function.
~FdTbfqFfMacScheduler() override
Destructor.
void DoSchedDlRachInfoReq(const struct FfMacSchedSapProvider::SchedDlRachInfoReqParameters &params)
Sched DL RACH info request function.
void DoCschedUeConfigReq(const struct FfMacCschedSapProvider::CschedUeConfigReqParameters &params)
CSched UE config request function.
uint32_t m_creditableThreshold
threshold of flow credit
void UpdateDlRlcBufferInfo(uint16_t rnti, uint8_t lcid, uint16_t size)
Update DL RLC buffer info function.
void SetFfMacSchedSapUser(FfMacSchedSapUser *s) override
Set FF MAC sched SAP user function.
std::map< uint16_t, uint8_t > m_dlHarqCurrentProcessId
DL HARQ current process ID.
void DoSchedDlCqiInfoReq(const struct FfMacSchedSapProvider::SchedDlCqiInfoReqParameters &params)
Sched DL CQI info request function.
void DoSchedDlPagingBufferReq(const struct FfMacSchedSapProvider::SchedDlPagingBufferReqParameters &params)
Sched DL paging buffer request function.
std::map< uint16_t, uint8_t > m_p10CqiRxed
Map of UE's DL CQI P01 received.
void DoSchedUlMacCtrlInfoReq(const struct FfMacSchedSapProvider::SchedUlMacCtrlInfoReqParameters &params)
Sched UL MAC control info request function.
std::vector< DlInfoListElement_s > m_dlInfoListBuffered
HARQ retx buffered.
FfMacCschedSapProvider::CschedCellConfigReqParameters m_cschedCellConfig
Csched cell config.
void RefreshDlCqiMaps()
Refresh DL CQI maps function.
void DoDispose() override
Destructor implementation.
double EstimateUlSinr(uint16_t rnti, uint16_t rb)
Estimate UL SNR function.
void DoSchedDlRlcBufferReq(const struct FfMacSchedSapProvider::SchedDlRlcBufferReqParameters &params)
Sched DL RLC buffer request function.
std::map< uint16_t, SbMeasResult_s > m_a30CqiRxed
Map of UE's DL CQI A30 received.
std::map< uint16_t, UlHarqProcessesDciBuffer_t > m_ulHarqProcessesDciBuffer
UL HARQ process DCI buffer.
std::map< uint16_t, uint32_t > m_ueCqiTimers
Map of UEs' timers on UL-CQI per RBG.
std::map< uint16_t, uint32_t > m_p10CqiTimers
Map of UE's timers on DL CQI P01 received.
void SetLteFfrSapProvider(LteFfrSapProvider *s) override
Set FFR SAP provider function.
FfMacCschedSapProvider * GetFfMacCschedSapProvider() override
Get FF MAC CSched SAP provider function.
void TransmissionModeConfigurationUpdate(uint16_t rnti, uint8_t txMode)
Transmisson mode config update function.
void DoSchedUlNoiseInterferenceReq(const struct FfMacSchedSapProvider::SchedUlNoiseInterferenceReqParameters &params)
Sched UL noise interference request function.
std::map< uint16_t, UlHarqProcessesStatus_t > m_ulHarqProcessesStatus
UL HARQ process status.
uint32_t m_creditLimit
flow credit limit (byte)
int m_debtLimit
flow debt limit (byte)
void DoSchedUlSrInfoReq(const struct FfMacSchedSapProvider::SchedUlSrInfoReqParameters &params)
Sched UL SR info request function.
std::map< uint16_t, uint32_t > m_a30CqiTimers
Map of UE's timers on DL CQI A30 received.
uint8_t m_ulGrantMcs
MCS for UL grant (default 0)
void RefreshUlCqiMaps()
Refresh UL CQI maps function.
FfMacCschedSapProvider * m_cschedSapProvider
CSched SAP provider.
std::map< uint16_t, DlHarqProcessesStatus_t > m_dlHarqProcessesStatus
DL HARQ process status.
void DoCschedCellConfigReq(const struct FfMacCschedSapProvider::CschedCellConfigReqParameters &params)
Csched cell config request function.
FfMacSchedSapProvider * m_schedSapProvider
sched SAP provider
std::map< uint16_t, DlHarqRlcPduListBuffer_t > m_dlHarqProcessesRlcPduListBuffer
DL HARQ process RLC PDU list buffer.
void DoSchedDlTriggerReq(const struct FfMacSchedSapProvider::SchedDlTriggerReqParameters &params)
Sched DL trigger request function.
std::map< uint16_t, uint8_t > m_uesTxMode
txMode of the UEs
void DoSchedDlMacBufferReq(const struct FfMacSchedSapProvider::SchedDlMacBufferReqParameters &params)
Sched DL MAC buffer request function.
std::map< uint16_t, fdtbfqsFlowPerf_t > m_flowStatsDl
Map of UE statistics (per RNTI basis) in downlink.
uint8_t HarqProcessAvailability(uint16_t rnti)
Return the availability of free process for the RNTI specified.
FfMacSchedSapProvider * GetFfMacSchedSapProvider() override
Get FF MAC sched SAP provider function.
FfMacSchedSapUser * m_schedSapUser
sched SAP user
uint16_t m_nextRntiUl
RNTI of the next user to be served next scheduling in UL.
std::map< uint16_t, std::vector< uint16_t > > m_allocationMaps
Map of previous allocated UE per RBG (used to retrieve info from UL-CQI)
unsigned int LcActivePerFlow(uint16_t rnti)
LC Active per flow function.
std::map< uint16_t, DlHarqProcessesTimer_t > m_dlHarqProcessesTimer
DL HARQ process timer.
FfMacCschedSapUser * m_cschedSapUser
Csched SAP user.
void UpdateUlRlcBufferInfo(uint16_t rnti, uint16_t size)
Update UL RLC buffer info function.
int GetRbgSize(int dlbandwidth)
Get RBG size function.
bool m_harqOn
m_harqOn when false inhibit the HARQ mechanisms (by default active)
void DoCschedLcReleaseReq(const struct FfMacCschedSapProvider::CschedLcReleaseReqParameters &params)
CSched LC release request function.
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
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.
Time flowStart
flow start time
int counter
the number of token borrow or given to token bank
uint32_t burstCredit
the maximum number of tokens connection i can borrow from the bank each time
int debtLimit
counter threshold that the flow cannot further borrow tokens from 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)
uint32_t tokenPoolSize
current size of token pool (byte)
uint32_t maxTokenPoolSize
maximum size of token pool (byte)
uint64_t tokenGenerationRate
token generation rate ( byte/s )