A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
tta-ff-mac-scheduler.h
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2011 Centre Tecnologic de Telecomunicacions de Catalunya (CTTC)
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License version 2 as
7  * published by the Free Software Foundation;
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17  *
18  * Author: Marco Miozzo <marco.miozzo@cttc.es>
19  * Modification: Dizhi Zhou <dizhi.zhou@gmail.com> // modify codes related to downlink scheduler
20  */
21 
22 #ifndef TTA_FF_MAC_SCHEDULER_H
23 #define TTA_FF_MAC_SCHEDULER_H
24 
25 #include <ns3/lte-common.h>
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 <vector>
30 #include <map>
31 #include <set>
32 #include <ns3/nstime.h>
33 #include <ns3/lte-amc.h>
34 
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 
41 #define HARQ_PROC_NUM 8
42 #define HARQ_DL_TIMEOUT 11
43 
44 namespace ns3 {
45 
46 
47 typedef std::vector < uint8_t > DlHarqProcessesStatus_t;
48 typedef std::vector < uint8_t > DlHarqProcessesTimer_t;
49 typedef std::vector < DlDciListElement_s > DlHarqProcessesDciBuffer_t;
50 typedef std::vector < std::vector <struct RlcPduListElement_s> > RlcPduList_t; // vector of the LCs and layers per UE
51 typedef std::vector < RlcPduList_t > DlHarqRlcPduListBuffer_t; // vector of the 8 HARQ processes per UE
52 
53 typedef std::vector < UlDciListElement_s > UlHarqProcessesDciBuffer_t;
54 typedef std::vector < uint8_t > UlHarqProcessesStatus_t;
55 
56 
69 {
70 public:
77 
81  virtual ~TtaFfMacScheduler ();
82 
83  // inherited from Object
84  virtual void DoDispose (void);
85  static TypeId GetTypeId (void);
86 
87  // inherited from FfMacScheduler
88  virtual void SetFfMacCschedSapUser (FfMacCschedSapUser* s);
89  virtual void SetFfMacSchedSapUser (FfMacSchedSapUser* s);
92 
95 
96  void TransmissionModeConfigurationUpdate (uint16_t rnti, uint8_t txMode);
97 
98 private:
99  //
100  // Implementation of the CSCHED API primitives
101  // (See 4.1 for description of the primitives)
102  //
103 
104  void DoCschedCellConfigReq (const struct FfMacCschedSapProvider::CschedCellConfigReqParameters& params);
105 
106  void DoCschedUeConfigReq (const struct FfMacCschedSapProvider::CschedUeConfigReqParameters& params);
107 
108  void DoCschedLcConfigReq (const struct FfMacCschedSapProvider::CschedLcConfigReqParameters& params);
109 
110  void DoCschedLcReleaseReq (const struct FfMacCschedSapProvider::CschedLcReleaseReqParameters& params);
111 
112  void DoCschedUeReleaseReq (const struct FfMacCschedSapProvider::CschedUeReleaseReqParameters& params);
113 
114  //
115  // Implementation of the SCHED API primitives
116  // (See 4.2 for description of the primitives)
117  //
118 
119  void DoSchedDlRlcBufferReq (const struct FfMacSchedSapProvider::SchedDlRlcBufferReqParameters& params);
120 
121  void DoSchedDlPagingBufferReq (const struct FfMacSchedSapProvider::SchedDlPagingBufferReqParameters& params);
122 
123  void DoSchedDlMacBufferReq (const struct FfMacSchedSapProvider::SchedDlMacBufferReqParameters& params);
124 
125  void DoSchedDlTriggerReq (const struct FfMacSchedSapProvider::SchedDlTriggerReqParameters& params);
126 
127  void DoSchedDlRachInfoReq (const struct FfMacSchedSapProvider::SchedDlRachInfoReqParameters& params);
128 
129  void DoSchedDlCqiInfoReq (const struct FfMacSchedSapProvider::SchedDlCqiInfoReqParameters& params);
130 
131  void DoSchedUlTriggerReq (const struct FfMacSchedSapProvider::SchedUlTriggerReqParameters& params);
132 
133  void DoSchedUlNoiseInterferenceReq (const struct FfMacSchedSapProvider::SchedUlNoiseInterferenceReqParameters& params);
134 
135  void DoSchedUlSrInfoReq (const struct FfMacSchedSapProvider::SchedUlSrInfoReqParameters& params);
136 
137  void DoSchedUlMacCtrlInfoReq (const struct FfMacSchedSapProvider::SchedUlMacCtrlInfoReqParameters& params);
138 
139  void DoSchedUlCqiInfoReq (const struct FfMacSchedSapProvider::SchedUlCqiInfoReqParameters& params);
140 
141 
142  int GetRbgSize (int dlbandwidth);
143 
144  int LcActivePerFlow (uint16_t rnti);
145 
146  double EstimateUlSinr (uint16_t rnti, uint16_t rb);
147 
148  void RefreshDlCqiMaps (void);
149  void RefreshUlCqiMaps (void);
150 
151  void UpdateDlRlcBufferInfo (uint16_t rnti, uint8_t lcid, uint16_t size);
152  void UpdateUlRlcBufferInfo (uint16_t rnti, uint16_t size);
153 
160  uint8_t UpdateHarqProcessId (uint16_t rnti);
161 
168  uint8_t HarqProcessAvailability (uint16_t rnti);
169 
174  void RefreshHarqProcesses ();
175 
176  Ptr<LteAmc> m_amc;
177 
178  /*
179  * Vectors of UE's LC info
180  */
181  std::map <LteFlowId_t, FfMacSchedSapProvider::SchedDlRlcBufferReqParameters> m_rlcBufferReq;
182 
183 
184  /*
185  * Set of UE statistics (per RNTI basis) in downlink
186  */
187  std::set <uint16_t> m_flowStatsDl;
188 
189  /*
190  * Set of UE statistics (per RNTI basis)
191  */
192  std::set <uint16_t> m_flowStatsUl;
193 
194 
195  /*
196  * Map of UE's DL CQI P01 received
197  */
198  std::map <uint16_t,uint8_t> m_p10CqiRxed;
199  /*
200  * Map of UE's timers on DL CQI P01 received
201  */
202  std::map <uint16_t,uint32_t> m_p10CqiTimers;
203 
204  /*
205  * Map of UE's DL CQI A30 received
206  */
207  std::map <uint16_t,SbMeasResult_s> m_a30CqiRxed;
208  /*
209  * Map of UE's timers on DL CQI A30 received
210  */
211  std::map <uint16_t,uint32_t> m_a30CqiTimers;
212 
213  /*
214  * Map of previous allocated UE per RBG
215  * (used to retrieve info from UL-CQI)
216  */
217  std::map <uint16_t, std::vector <uint16_t> > m_allocationMaps;
218 
219  /*
220  * Map of UEs' UL-CQI per RBG
221  */
222  std::map <uint16_t, std::vector <double> > m_ueCqi;
223  /*
224  * Map of UEs' timers on UL-CQI per RBG
225  */
226  std::map <uint16_t, uint32_t> m_ueCqiTimers;
227 
228  /*
229  * Map of UE's buffer status reports received
230  */
231  std::map <uint16_t,uint32_t> m_ceBsrRxed;
232 
233  // MAC SAPs
234  FfMacCschedSapUser* m_cschedSapUser;
235  FfMacSchedSapUser* m_schedSapUser;
236  FfMacCschedSapProvider* m_cschedSapProvider;
237  FfMacSchedSapProvider* m_schedSapProvider;
238 
239 
240  // Internal parameters
242 
243 
244  uint16_t m_nextRntiUl; // RNTI of the next user to be served next scheduling in UL
245 
246  uint32_t m_cqiTimersThreshold; // # of TTIs for which a CQI canbe considered valid
247 
248  std::map <uint16_t,uint8_t> m_uesTxMode; // txMode of the UEs
249 
250  // HARQ attributes
254  bool m_harqOn;
255  std::map <uint16_t, uint8_t> m_dlHarqCurrentProcessId;
256  //HARQ status
257  // 0: process Id available
258  // x>0: process Id equal to `x` trasmission count
259  std::map <uint16_t, DlHarqProcessesStatus_t> m_dlHarqProcessesStatus;
260  std::map <uint16_t, DlHarqProcessesTimer_t> m_dlHarqProcessesTimer;
261  std::map <uint16_t, DlHarqProcessesDciBuffer_t> m_dlHarqProcessesDciBuffer;
262  std::map <uint16_t, DlHarqRlcPduListBuffer_t> m_dlHarqProcessesRlcPduListBuffer;
263  std::vector <DlInfoListElement_s> m_dlInfoListBuffered; // HARQ retx buffered
264 
265  std::map <uint16_t, uint8_t> m_ulHarqCurrentProcessId;
266  //HARQ status
267  // 0: process Id available
268  // x>0: process Id equal to `x` trasmission count
269  std::map <uint16_t, UlHarqProcessesStatus_t> m_ulHarqProcessesStatus;
270  std::map <uint16_t, UlHarqProcessesDciBuffer_t> m_ulHarqProcessesDciBuffer;
271 
272 
273  // RACH attributes
274  std::vector <struct RachListElement_s> m_rachList;
275  std::vector <uint16_t> m_rachAllocationMap;
276  uint8_t m_ulGrantMcs; // MCS for UL grant (default 0)
277 
278 };
279 
280 } // namespace ns3
281 
282 #endif /* TTA_FF_MAC_SCHEDULER_H */
smart pointer class similar to boost::intrusive_ptr
Definition: ptr.h:59
virtual FfMacSchedSapProvider * GetFfMacSchedSapProvider()
Provides the CSCHED SAP.
virtual void DoDispose(void)
void RefreshHarqProcesses()
Refresh HARQ processes according to the timers.
uint8_t UpdateHarqProcessId(uint16_t rnti)
Update and return a new process Id for the RNTI specified.
Provides the SCHED SAP.
uint8_t HarqProcessAvailability(uint16_t rnti)
Return the availability of free process for the RNTI specified.
virtual FfMacCschedSapProvider * GetFfMacCschedSapProvider()
virtual void SetFfMacSchedSapUser(FfMacSchedSapUser *s)
virtual void SetFfMacCschedSapUser(FfMacCschedSapUser *s)
a unique identifier for an interface.
Definition: type-id.h:44
Implements the SCHED SAP and CSCHED SAP for a Throughput to Average scheduler.