A Discrete-Event Network Simulator
API
cqa-ff-mac-scheduler.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2012 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 * Authors: Biljana Bojovic <bbojovic@cttc.es>, Nicola Baldo<nbaldo@cttc.es>.
18 *
19 * Note: Implementation is using many common scheduler functionalities in its original version
20 * implemented by Marco Miozzo<mmiozzo@cttc.es> in PF and RR schedulers. *
21 */
22
23#ifndef CQA_FF_MAC_SCHEDULER_H
24#define CQA_FF_MAC_SCHEDULER_H
25
26#include <ns3/ff-mac-csched-sap.h>
27#include <ns3/ff-mac-sched-sap.h>
28#include <ns3/ff-mac-scheduler.h>
29#include <ns3/lte-amc.h>
30#include <ns3/lte-common.h>
31#include <ns3/lte-ffr-sap.h>
32#include <ns3/nstime.h>
33
34#include <map>
35#include <set>
36#include <vector>
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
45namespace ns3
46{
47
49typedef std::vector<uint8_t> DlHarqProcessesStatus_t;
51typedef std::vector<uint8_t> DlHarqProcessesTimer_t;
53typedef std::vector<DlDciListElement_s> DlHarqProcessesDciBuffer_t;
55typedef std::vector<std::vector<struct RlcPduListElement_s>> RlcPduList_t;
57typedef std::vector<RlcPduList_t> DlHarqRlcPduListBuffer_t;
59typedef std::vector<UlDciListElement_s> UlHarqProcessesDciBuffer_t;
61typedef std::vector<uint8_t> UlHarqProcessesStatus_t;
62
65{
67 unsigned long totalBytesTransmitted;
72};
73
82{
83 public:
90
94 ~CqaFfMacScheduler() override;
95
96 // inherited from Object
97 void DoDispose() override;
102 static TypeId GetTypeId();
103
104 // inherited from FfMacScheduler
106 void SetFfMacSchedSapUser(FfMacSchedSapUser* s) override;
109
110 // FFR SAPs
111 void SetLteFfrSapProvider(LteFfrSapProvider* s) override;
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
138
145
152
159
166
167 //
168 // Implementation of the SCHED API primitives
169 // (See 4.2 for description of the primitives)
170 //
171
178
185
192
199
206
213
220
227
233
240
247
253 int GetRbgSize(int dlbandwidth);
254
260 unsigned int LcActivePerFlow(uint16_t rnti);
261
268 double EstimateUlSinr(uint16_t rnti, uint16_t rb);
269
271 void RefreshDlCqiMaps();
273 void RefreshUlCqiMaps();
274
281 void UpdateDlRlcBufferInfo(uint16_t rnti, uint8_t lcid, uint16_t size);
287 void UpdateUlRlcBufferInfo(uint16_t rnti, uint16_t size);
288
295 uint8_t UpdateHarqProcessId(uint16_t rnti);
296
303 bool HarqProcessAvailability(uint16_t rnti);
304
310
312
316 std::map<LteFlowId_t, FfMacSchedSapProvider::SchedDlRlcBufferReqParameters> m_rlcBufferReq;
317
321 std::map<uint16_t, CqasFlowPerf_t> m_flowStatsDl;
322
326 std::map<uint16_t, CqasFlowPerf_t> m_flowStatsUl;
327
331 std::map<LteFlowId_t, struct LogicalChannelConfigListElement_s> m_ueLogicalChannelsConfigList;
332
336 std::map<uint16_t, uint8_t> m_p10CqiRxed;
337
341 std::map<uint16_t, uint32_t> m_p10CqiTimers;
342
346 std::map<uint16_t, SbMeasResult_s> m_a30CqiRxed;
347
351 std::map<uint16_t, uint32_t> m_a30CqiTimers;
352
357 std::map<uint16_t, std::vector<uint16_t>> m_allocationMaps;
358
362 std::map<uint16_t, std::vector<double>> m_ueCqi;
363
367 std::map<uint16_t, uint32_t> m_ueCqiTimers;
368
372 std::map<uint16_t, uint32_t> m_ceBsrRxed;
373
374 // MAC SAPs
379
380 // FFR SAPs
383
386
388
389 uint16_t m_nextRntiUl;
390
392
393 std::map<uint16_t, uint8_t> m_uesTxMode;
394
395 // HARQ attributes
396 bool m_harqOn;
397 std::map<uint16_t, uint8_t> m_dlHarqCurrentProcessId;
398 // HARQ status
399 // 0: process Id available
400 // x>0: process Id equal to `x` transmission count
401 std::map<uint16_t, DlHarqProcessesStatus_t>
403 std::map<uint16_t, DlHarqProcessesTimer_t> m_dlHarqProcessesTimer;
404 std::map<uint16_t, DlHarqProcessesDciBuffer_t>
406 std::map<uint16_t, DlHarqRlcPduListBuffer_t>
408 std::vector<DlInfoListElement_s> m_dlInfoListBuffered;
409
410 std::map<uint16_t, uint8_t> m_ulHarqCurrentProcessId;
411 // HARQ status
412 // 0: process Id available
413 // x>0: process Id equal to `x` transmission count
414 std::map<uint16_t, UlHarqProcessesStatus_t> m_ulHarqProcessesStatus;
415 std::map<uint16_t, UlHarqProcessesDciBuffer_t>
417
418 // RACH attributes
419 std::vector<struct RachListElement_s> m_rachList;
420 std::vector<uint16_t> m_rachAllocationMap;
421 uint8_t m_ulGrantMcs;
422
423 std::string m_CqaMetric;
424};
425
426} // namespace ns3
427
428#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.
void RefreshHarqProcesses()
Refresh HARQ processes according to the timers.
void DoSchedUlSrInfoReq(const struct FfMacSchedSapProvider::SchedUlSrInfoReqParameters &params)
Sched UL Sr Info Request.
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, uint32_t > m_p10CqiTimers
Map of UE's timers on DL CQI P01 received.
std::map< uint16_t, uint8_t > m_dlHarqCurrentProcessId
DL HARQ process ID.
void DoCschedCellConfigReq(const struct FfMacCschedSapProvider::CschedCellConfigReqParameters &params)
Csched Cell Config Request.
static TypeId GetTypeId()
Get the type ID.
std::map< uint16_t, DlHarqProcessesTimer_t > m_dlHarqProcessesTimer
DL HARQ process timers.
double m_timeWindow
time window
std::map< uint16_t, uint32_t > m_a30CqiTimers
Map of UE's timers on DL CQI A30 received.
std::map< uint16_t, std::vector< double > > m_ueCqi
Map of UEs' UL-CQI per RBG.
std::map< uint16_t, uint32_t > m_ueCqiTimers
Map of UEs' timers on UL-CQI per RBG.
~CqaFfMacScheduler() override
Destructor.
void DoSchedDlTriggerReq(const struct FfMacSchedSapProvider::SchedDlTriggerReqParameters &params)
Sched DL RLC Buffer Request.
unsigned int LcActivePerFlow(uint16_t rnti)
LC Active per flow.
void SetLteFfrSapProvider(LteFfrSapProvider *s) override
Set the Provider part of the LteFfrSap that this Scheduler will interact with.
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.
std::map< uint16_t, SbMeasResult_s > m_a30CqiRxed
Map of UE's DL CQI A30 received.
void DoSchedDlCqiInfoReq(const struct FfMacSchedSapProvider::SchedDlCqiInfoReqParameters &params)
Sched DL CGI Info Request.
FfMacCschedSapUser * m_cschedSapUser
MAC Csched SAP user.
bool HarqProcessAvailability(uint16_t rnti)
Return the availability of free process for the RNTI specified.
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.
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::map< uint16_t, uint8_t > m_uesTxMode
txMode of the UEs
std::map< LteFlowId_t, struct LogicalChannelConfigListElement_s > m_ueLogicalChannelsConfigList
Map of UE logical channel config list.
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 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.
std::map< uint16_t, uint8_t > m_p10CqiRxed
Map of UE's DL CQI P01 received.
void DoDispose() override
Destructor implementation.
void DoSchedDlPagingBufferReq(const struct FfMacSchedSapProvider::SchedDlPagingBufferReqParameters &params)
Sched DL Paging 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)
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.
void RefreshUlCqiMaps()
Refresh UL CGI maps.
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.
FfMacSchedSapProvider * GetFfMacSchedSapProvider() override
void SetFfMacCschedSapUser(FfMacCschedSapUser *s) override
set the user part of the FfMacCschedSap that this Scheduler will interact with.
std::map< uint16_t, CqasFlowPerf_t > m_flowStatsUl
Map of UE statistics (per RNTI basis)
FfMacSchedSapProvider * m_schedSapProvider
Sched SAP provider.
FfMacCschedSapProvider * GetFfMacCschedSapProvider() override
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 RefreshDlCqiMaps()
Refresh DL CGI maps.
FfMacCschedSapProvider::CschedCellConfigReqParameters m_cschedCellConfig
Internal parameters.
std::map< uint16_t, DlHarqProcessesStatus_t > m_dlHarqProcessesStatus
DL HARQ process statuses.
LteFfrSapUser * GetLteFfrSapUser() override
uint16_t m_nextRntiUl
RNTI of the next user to be served next scheduling in UL.
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.
std::map< uint16_t, uint32_t > m_ceBsrRxed
Map of UE's buffer status reports received.
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: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: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 ##.
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.