A Discrete-Event Network Simulator
API
pf-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 */
19
20#ifndef PF_FF_MAC_SCHEDULER_H
21#define PF_FF_MAC_SCHEDULER_H
22
23#include <ns3/ff-mac-csched-sap.h>
24#include <ns3/ff-mac-sched-sap.h>
25#include <ns3/ff-mac-scheduler.h>
26#include <ns3/lte-amc.h>
27#include <ns3/lte-common.h>
28#include <ns3/lte-ffr-sap.h>
29#include <ns3/nstime.h>
30
31#include <map>
32#include <vector>
33
34// value for SINR outside the range defined by FF-API, used to indicate that there
35// is no CQI for this element
36#define NO_SINR -5000
37
38#define HARQ_PROC_NUM 8
39#define HARQ_DL_TIMEOUT 11
40
41namespace ns3
42{
43
44typedef std::vector<uint8_t> DlHarqProcessesStatus_t;
45typedef std::vector<uint8_t> DlHarqProcessesTimer_t;
46typedef std::vector<DlDciListElement_s> DlHarqProcessesDciBuffer_t;
47typedef std::vector<std::vector<struct RlcPduListElement_s>>
48 RlcPduList_t; // vector of the LCs and layers per UE
49typedef std::vector<RlcPduList_t> DlHarqRlcPduListBuffer_t; // vector of the 8 HARQ processes per UE
50
51typedef std::vector<UlDciListElement_s> UlHarqProcessesDciBuffer_t;
52typedef std::vector<uint8_t> UlHarqProcessesStatus_t;
53
56{
58 unsigned long totalBytesTransmitted;
61};
62
71{
72 public:
79
83 ~PfFfMacScheduler() override;
84
85 // inherited from Object
86 void DoDispose() override;
91 static TypeId GetTypeId();
92
93 // inherited from FfMacScheduler
98
99 // FFR SAPs
100 void SetLteFfrSapProvider(LteFfrSapProvider* s) override;
102
107
114 void TransmissionModeConfigurationUpdate(uint16_t rnti, uint8_t txMode);
115
116 private:
117 //
118 // Implementation of the CSCHED API primitives
119 // (See 4.1 for description of the primitives)
120 //
121
129
137
145
153
161
162 //
163 // Implementation of the SCHED API primitives
164 // (See 4.2 for description of the primitives)
165 //
166
174
182
190
198
206
214
222
230
237
245
253
260 int GetRbgSize(int dlbandwidth);
261
268 unsigned int LcActivePerFlow(uint16_t rnti);
269
277 double EstimateUlSinr(uint16_t rnti, uint16_t rb);
278
280 void RefreshDlCqiMaps();
282 void RefreshUlCqiMaps();
283
291 void UpdateDlRlcBufferInfo(uint16_t rnti, uint8_t lcid, uint16_t size);
298 void UpdateUlRlcBufferInfo(uint16_t rnti, uint16_t size);
299
306 uint8_t UpdateHarqProcessId(uint16_t rnti);
307
314 uint8_t HarqProcessAvailability(uint16_t rnti);
315
321
323
327 std::map<LteFlowId_t, FfMacSchedSapProvider::SchedDlRlcBufferReqParameters> m_rlcBufferReq;
328
332 std::map<uint16_t, pfsFlowPerf_t> m_flowStatsDl;
333
337 std::map<uint16_t, pfsFlowPerf_t> m_flowStatsUl;
338
342 std::map<uint16_t, uint8_t> m_p10CqiRxed;
346 std::map<uint16_t, uint32_t> m_p10CqiTimers;
347
351 std::map<uint16_t, SbMeasResult_s> m_a30CqiRxed;
355 std::map<uint16_t, uint32_t> m_a30CqiTimers;
356
361 std::map<uint16_t, std::vector<uint16_t>> m_allocationMaps;
362
366 std::map<uint16_t, std::vector<double>> m_ueCqi;
370 std::map<uint16_t, uint32_t> m_ueCqiTimers;
371
375 std::map<uint16_t, uint32_t> m_ceBsrRxed;
376
377 // MAC SAPs
382
383 // FFR SAPs
386
387 // Internal parameters
390
392
393 uint16_t m_nextRntiUl;
394
396
397 std::map<uint16_t, uint8_t> m_uesTxMode;
398
399 // HARQ attributes
404 std::map<uint16_t, uint8_t> m_dlHarqCurrentProcessId;
405 // HARQ status
406 // 0: process Id available
407 // x>0: process Id equal to `x` transmission count
408 std::map<uint16_t, DlHarqProcessesStatus_t> m_dlHarqProcessesStatus;
409 std::map<uint16_t, DlHarqProcessesTimer_t> m_dlHarqProcessesTimer;
410 std::map<uint16_t, DlHarqProcessesDciBuffer_t>
412 std::map<uint16_t, DlHarqRlcPduListBuffer_t>
414 std::vector<DlInfoListElement_s> m_dlInfoListBuffered;
415
416 std::map<uint16_t, uint8_t> m_ulHarqCurrentProcessId;
417 // HARQ status
418 // 0: process Id available
419 // x>0: process Id equal to `x` transmission count
420 std::map<uint16_t, UlHarqProcessesStatus_t> m_ulHarqProcessesStatus;
421 std::map<uint16_t, UlHarqProcessesDciBuffer_t>
423
424 // RACH attributes
425 std::vector<struct RachListElement_s> m_rachList;
426 std::vector<uint16_t> m_rachAllocationMap;
427 uint8_t m_ulGrantMcs;
428};
429
430} // namespace ns3
431
432#endif /* PF_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.
Implements the SCHED SAP and CSCHED SAP for a Proportional Fair scheduler.
void RefreshHarqProcesses()
Refresh HARQ processes according to the timers.
std::map< uint16_t, uint8_t > m_dlHarqCurrentProcessId
DL HARQ current process ID.
FfMacCschedSapProvider::CschedCellConfigReqParameters m_cschedCellConfig
CSched cell config.
void DoSchedDlCqiInfoReq(const struct FfMacSchedSapProvider::SchedDlCqiInfoReqParameters &params)
Sched DL CQI info request.
static TypeId GetTypeId()
Get the type ID.
void DoCschedUeConfigReq(const struct FfMacCschedSapProvider::CschedUeConfigReqParameters &params)
CSched UE config request.
~PfFfMacScheduler() override
Destructor.
std::map< uint16_t, DlHarqProcessesStatus_t > m_dlHarqProcessesStatus
DL HARQ process status.
double EstimateUlSinr(uint16_t rnti, uint16_t rb)
Estimate UL SINR.
void TransmissionModeConfigurationUpdate(uint16_t rnti, uint8_t txMode)
transmission mode configuration update
std::map< LteFlowId_t, FfMacSchedSapProvider::SchedDlRlcBufferReqParameters > m_rlcBufferReq
Vectors of UE's LC info.
bool m_harqOn
m_harqOn when false inhibit the HARQ mechanisms (by default active)
std::map< uint16_t, UlHarqProcessesStatus_t > m_ulHarqProcessesStatus
UL HARQ process status.
std::map< uint16_t, uint32_t > m_a30CqiTimers
Map of UE's timers on DL CQI A30 received.
std::map< uint16_t, uint8_t > m_p10CqiRxed
Map of UE's DL CQI P01 received.
void DoSchedUlTriggerReq(const struct FfMacSchedSapProvider::SchedUlTriggerReqParameters &params)
Sched UL trigger request.
void DoSchedUlNoiseInterferenceReq(const struct FfMacSchedSapProvider::SchedUlNoiseInterferenceReqParameters &params)
Sched UL noise interference request.
void DoCschedCellConfigReq(const struct FfMacCschedSapProvider::CschedCellConfigReqParameters &params)
CSched cell config request.
LteFfrSapUser * GetLteFfrSapUser() override
std::vector< struct RachListElement_s > m_rachList
RACH list.
void DoSchedDlRlcBufferReq(const struct FfMacSchedSapProvider::SchedDlRlcBufferReqParameters &params)
Sched DL RLC buffer request.
void SetFfMacSchedSapUser(FfMacSchedSapUser *s) override
set the user part of the FfMacSchedSap that this Scheduler will interact with.
std::map< uint16_t, DlHarqProcessesTimer_t > m_dlHarqProcessesTimer
DL HARQ process timer.
std::map< uint16_t, DlHarqProcessesDciBuffer_t > m_dlHarqProcessesDciBuffer
DL HARQ process DCI buffer.
void DoSchedUlMacCtrlInfoReq(const struct FfMacSchedSapProvider::SchedUlMacCtrlInfoReqParameters &params)
Sched UL MAC control info request.
FfMacSchedSapProvider * m_schedSapProvider
Sched SAP provider.
FfMacCschedSapProvider * GetFfMacCschedSapProvider() override
std::map< uint16_t, uint32_t > m_ueCqiTimers
Map of UEs' timers on UL-CQI per RBG.
void UpdateUlRlcBufferInfo(uint16_t rnti, uint16_t size)
Update UL RCL buffer info.
void DoCschedUeReleaseReq(const struct FfMacCschedSapProvider::CschedUeReleaseReqParameters &params)
CSched UE release request.
std::map< uint16_t, DlHarqRlcPduListBuffer_t > m_dlHarqProcessesRlcPduListBuffer
DL HARQ process RLC PDU list buffer.
std::map< uint16_t, uint32_t > m_ceBsrRxed
Map of UE's buffer status reports received.
void DoDispose() override
Destructor implementation.
void DoCschedLcReleaseReq(const struct FfMacCschedSapProvider::CschedLcReleaseReqParameters &params)
CSched LC release request.
FfMacCschedSapUser * m_cschedSapUser
CSched SAP user.
unsigned int LcActivePerFlow(uint16_t rnti)
LC active per flow.
void RefreshDlCqiMaps()
Refresh DL CQI maps.
void DoSchedDlTriggerReq(const struct FfMacSchedSapProvider::SchedDlTriggerReqParameters &params)
Sched DL trigger request.
LteFfrSapUser * m_ffrSapUser
FFR SAP user.
void DoSchedUlSrInfoReq(const struct FfMacSchedSapProvider::SchedUlSrInfoReqParameters &params)
Sched UL SR info request.
void DoSchedDlMacBufferReq(const struct FfMacSchedSapProvider::SchedDlMacBufferReqParameters &params)
Sched DL MAC buffer request.
uint8_t m_ulGrantMcs
MCS for UL grant (default 0)
std::map< uint16_t, SbMeasResult_s > m_a30CqiRxed
Map of UE's DL CQI A30 received.
std::map< uint16_t, std::vector< double > > m_ueCqi
Map of UEs' UL-CQI per RBG.
std::map< uint16_t, pfsFlowPerf_t > m_flowStatsDl
Map of UE statistics (per RNTI basis) in downlink.
void DoSchedDlPagingBufferReq(const struct FfMacSchedSapProvider::SchedDlPagingBufferReqParameters &params)
Sched DL paging buffer request.
double m_timeWindow
time window
std::map< uint16_t, pfsFlowPerf_t > m_flowStatsUl
Map of UE statistics (per RNTI basis)
void RefreshUlCqiMaps()
Refresh UL CQI maps.
LteFfrSapProvider * m_ffrSapProvider
FFR SAP provider.
uint8_t HarqProcessAvailability(uint16_t rnti)
Return the availability of free process for the RNTI specified.
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 SetFfMacCschedSapUser(FfMacCschedSapUser *s) override
set the user part of the FfMacCschedSap that this Scheduler will interact with.
uint8_t UpdateHarqProcessId(uint16_t rnti)
Update and return a new process Id for the RNTI specified.
void UpdateDlRlcBufferInfo(uint16_t rnti, uint8_t lcid, uint16_t size)
Update DL RCL buffer info.
void DoCschedLcConfigReq(const struct FfMacCschedSapProvider::CschedLcConfigReqParameters &params)
CSched LC config request.
std::map< uint16_t, uint8_t > m_uesTxMode
txMode of the UEs
uint16_t m_nextRntiUl
RNTI of the next user to be served next scheduling in UL.
std::map< uint16_t, uint32_t > m_p10CqiTimers
Map of UE's timers on DL CQI P01 received.
FfMacCschedSapProvider * m_cschedSapProvider
CSched SAP provider.
void SetLteFfrSapProvider(LteFfrSapProvider *s) override
Set the Provider part of the LteFfrSap that this Scheduler will interact with.
void DoSchedDlRachInfoReq(const struct FfMacSchedSapProvider::SchedDlRachInfoReqParameters &params)
Sched DL RACH info request.
int GetRbgSize(int dlbandwidth)
Get RBG size.
std::map< uint16_t, UlHarqProcessesDciBuffer_t > m_ulHarqProcessesDciBuffer
UL HARQ process DCI buffer.
std::map< uint16_t, uint8_t > m_ulHarqCurrentProcessId
UL HARQ current process ID.
void DoSchedUlCqiInfoReq(const struct FfMacSchedSapProvider::SchedUlCqiInfoReqParameters &params)
Sched UL CQI info request.
FfMacSchedSapProvider * GetFfMacSchedSapProvider() override
std::vector< uint16_t > m_rachAllocationMap
RACH allocation map.
std::vector< DlInfoListElement_s > m_dlInfoListBuffered
HARQ retx buffered.
FfMacSchedSapUser * m_schedSapUser
Sched SAP user.
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.
pfsFlowPerf_t structure
unsigned long totalBytesTransmitted
total bytes transmitted
Time flowStart
flow start time
double lastAveragedThroughput
last averaged throughput
unsigned int lastTtiBytesTrasmitted
last total bytes transmitted