A Discrete-Event Network Simulator
API
phy-rx-stats-calculator.cc
Go to the documentation of this file.
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: Jaume Nin <jnin@cttc.es>
19  * modified by: Marco Miozzo <mmiozzo@cttc.es>
20  * Convert MacStatsCalculator in PhyRxStatsCalculator
21  */
22 
24 #include "ns3/string.h"
25 #include <ns3/simulator.h>
26 #include <ns3/log.h>
27 
28 namespace ns3 {
29 
30 NS_LOG_COMPONENT_DEFINE ("PhyRxStatsCalculator");
31 
32 NS_OBJECT_ENSURE_REGISTERED (PhyRxStatsCalculator);
33 
35  : m_dlRxFirstWrite (true),
36  m_ulRxFirstWrite (true)
37 {
38  NS_LOG_FUNCTION (this);
39 
40 }
41 
43 {
44  NS_LOG_FUNCTION (this);
45 }
46 
47 TypeId
49 {
50  static TypeId tid = TypeId ("ns3::PhyRxStatsCalculator")
52  .SetGroupName("Lte")
53  .AddConstructor<PhyRxStatsCalculator> ()
54  .AddAttribute ("DlRxOutputFilename",
55  "Name of the file where the downlink results will be saved.",
56  StringValue ("DlRxPhyStats.txt"),
59  .AddAttribute ("UlRxOutputFilename",
60  "Name of the file where the uplink results will be saved.",
61  StringValue ("UlRxPhyStats.txt"),
64  ;
65  return tid;
66 }
67 
68 void
69 PhyRxStatsCalculator::SetUlRxOutputFilename (std::string outputFilename)
70 {
72 }
73 
74 std::string
76 {
78 }
79 
80 void
81 PhyRxStatsCalculator::SetDlRxOutputFilename (std::string outputFilename)
82 {
84 }
85 
86 std::string
88 {
90 }
91 
92 void
94 {
95  NS_LOG_FUNCTION (this << params.m_cellId << params.m_imsi << params.m_timestamp << params.m_rnti << params.m_layer << params.m_mcs << params.m_size << params.m_rv << params.m_ndi << params.m_correctness);
96  NS_LOG_INFO ("Write DL Rx Phy Stats in " << GetDlRxOutputFilename ().c_str ());
97 
98  std::ofstream outFile;
99  if ( m_dlRxFirstWrite == true )
100  {
101  outFile.open (GetDlRxOutputFilename ().c_str ());
102  if (!outFile.is_open ())
103  {
104  NS_LOG_ERROR ("Can't open file " << GetDlRxOutputFilename ().c_str ());
105  return;
106  }
107  m_dlRxFirstWrite = false;
108  outFile << "% time\tcellId\tIMSI\tRNTI\ttxMode\tlayer\tmcs\tsize\trv\tndi\tcorrect\tccId";
109  outFile << std::endl;
110  }
111  else
112  {
113  outFile.open (GetDlRxOutputFilename ().c_str (), std::ios_base::app);
114  if (!outFile.is_open ())
115  {
116  NS_LOG_ERROR ("Can't open file " << GetDlRxOutputFilename ().c_str ());
117  return;
118  }
119  }
120 
121 // outFile << Simulator::Now ().GetNanoSeconds () / (double) 1e9 << "\t";
122  outFile << params.m_timestamp << "\t";
123  outFile << (uint32_t) params.m_cellId << "\t";
124  outFile << params.m_imsi << "\t";
125  outFile << params.m_rnti << "\t";
126  outFile << (uint32_t) params.m_txMode << "\t";
127  outFile << (uint32_t) params.m_layer << "\t";
128  outFile << (uint32_t) params.m_mcs << "\t";
129  outFile << params.m_size << "\t";
130  outFile << (uint32_t) params.m_rv << "\t";
131  outFile << (uint32_t) params.m_ndi << "\t";
132  outFile << (uint32_t) params.m_correctness << "\t";
133  outFile << (uint32_t) params.m_ccId << std::endl;
134  outFile.close ();
135 }
136 
137 void
139 {
140  NS_LOG_FUNCTION (this << params.m_cellId << params.m_imsi << params.m_timestamp << params.m_rnti << params.m_layer << params.m_mcs << params.m_size << params.m_rv << params.m_ndi << params.m_correctness);
141  NS_LOG_INFO ("Write UL Rx Phy Stats in " << GetUlRxOutputFilename ().c_str ());
142 
143  std::ofstream outFile;
144  if ( m_ulRxFirstWrite == true )
145  {
146  outFile.open (GetUlRxOutputFilename ().c_str ());
147  if (!outFile.is_open ())
148  {
149  NS_LOG_ERROR ("Can't open file " << GetUlRxOutputFilename ().c_str ());
150  return;
151  }
152  m_ulRxFirstWrite = false;
153  outFile << "% time\tcellId\tIMSI\tRNTI\tlayer\tmcs\tsize\trv\tndi\tcorrect\tccId";
154  outFile << std::endl;
155  }
156  else
157  {
158  outFile.open (GetUlRxOutputFilename ().c_str (), std::ios_base::app);
159  if (!outFile.is_open ())
160  {
161  NS_LOG_ERROR ("Can't open file " << GetUlRxOutputFilename ().c_str ());
162  return;
163  }
164  }
165 
166 // outFile << Simulator::Now ().GetNanoSeconds () / (double) 1e9 << "\t";
167  outFile << params.m_timestamp << "\t";
168  outFile << (uint32_t) params.m_cellId << "\t";
169  outFile << params.m_imsi << "\t";
170  outFile << params.m_rnti << "\t";
171  outFile << (uint32_t) params.m_layer << "\t";
172  outFile << (uint32_t) params.m_mcs << "\t";
173  outFile << params.m_size << "\t";
174  outFile << (uint32_t) params.m_rv << "\t";
175  outFile << (uint32_t) params.m_ndi << "\t";
176  outFile << (uint32_t) params.m_correctness << "\t";
177  outFile << (uint32_t) params.m_ccId <<std::endl;
178  outFile.close ();
179 }
180 
181 void
183  std::string path, PhyReceptionStatParameters params)
184 {
185  NS_LOG_FUNCTION (phyRxStats << path);
186  uint64_t imsi = 0;
187  std::ostringstream pathAndRnti;
188  pathAndRnti << path << "/" << params.m_rnti;
189  std::string pathUePhy = path.substr (0, path.find ("/ComponentCarrierMapUe"));
190  if (phyRxStats->ExistsImsiPath (pathAndRnti.str ()) == true)
191  {
192  imsi = phyRxStats->GetImsiPath (pathAndRnti.str ());
193  }
194  else
195  {
196  imsi = FindImsiFromLteNetDevice (pathUePhy);
197  phyRxStats->SetImsiPath (pathAndRnti.str (), imsi);
198  }
199 
200  params.m_imsi = imsi;
201  phyRxStats->DlPhyReception (params);
202 }
203 
204 void
206  std::string path, PhyReceptionStatParameters params)
207 {
208  NS_LOG_FUNCTION (phyRxStats << path);
209  uint64_t imsi = 0;
210  std::ostringstream pathAndRnti;
211  std::string pathEnb = path.substr (0, path.find ("/ComponentCarrierMap"));
212  pathAndRnti << pathEnb << "/LteEnbRrc/UeMap/" << params.m_rnti;
213  if (phyRxStats->ExistsImsiPath (pathAndRnti.str ()) == true)
214  {
215  imsi = phyRxStats->GetImsiPath (pathAndRnti.str ());
216  }
217  else
218  {
219  imsi = FindImsiFromEnbRlcPath (pathAndRnti.str ());
220  phyRxStats->SetImsiPath (pathAndRnti.str (), imsi);
221  }
222 
223  params.m_imsi = imsi;
224  phyRxStats->UlPhyReception (params);
225 }
226 
227 } // namespace ns3
Ptr< const AttributeChecker > MakeStringChecker(void)
Definition: string.cc:30
Base class for ***StatsCalculator classes.
static uint64_t FindImsiFromLteNetDevice(std::string path)
Retrieves IMSI from LteNetDevice path in the attribute system.
Smart pointer class similar to boost::intrusive_ptr.
Definition: ptr.h:73
#define NS_LOG_FUNCTION(parameters)
If log level LOG_FUNCTION is enabled, this macro will output all input parameters separated by "...
uint8_t m_mcs
MCS for transport block.
Definition: lte-common.h:220
#define NS_OBJECT_ENSURE_REGISTERED(type)
Register an Object subclass with the TypeId system.
Definition: object-base.h:45
Hold variables of type string.
Definition: string.h:41
bool m_dlRxFirstWrite
When writing DL RX PHY statistics first time to file, columns description is added.
uint8_t m_rv
the redundancy version (HARQ)
Definition: lte-common.h:222
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition: log.h:205
void DlPhyReception(PhyReceptionStatParameters params)
Notifies the stats calculator that an downlink reception has occurred.
#define NS_LOG_INFO(msg)
Use NS_LOG to output a message of level LOG_INFO.
Definition: log.h:281
int64_t m_timestamp
in millisecond
Definition: lte-common.h:214
std::string GetUlRxOutputFilename(void)
Get the name of the file where the UL RX PHY statistics will be stored.
void SetUlOutputFilename(std::string outputFilename)
Set the name of the file where the uplink statistics will be stored.
virtual ~PhyRxStatsCalculator()
Destructor.
void UlPhyReception(PhyReceptionStatParameters params)
Notifies the stats calculator that an uplink reception has occurred.
uint8_t m_layer
the layer (cw) of the transmission
Definition: lte-common.h:219
std::string GetUlOutputFilename(void)
Get the name of the file where the uplink statistics will be stored.
uint8_t m_ndi
new data indicator flag
Definition: lte-common.h:223
Every class exported by the ns3 library is enclosed in the ns3 namespace.
PhyReceptionStatParameters structure.
Definition: lte-common.h:212
void SetDlOutputFilename(std::string outputFilename)
Set the name of the file where the downlink statistics will be stored.
static uint64_t FindImsiFromEnbRlcPath(std::string path)
Retrieves IMSI from Enb RLC path in the attribute system.
uint8_t m_txMode
the transmission Mode
Definition: lte-common.h:218
uint16_t m_size
Size of transport block.
Definition: lte-common.h:221
static void DlPhyReceptionCallback(Ptr< PhyRxStatsCalculator > phyRxStats, std::string path, PhyReceptionStatParameters params)
trace sink
static void UlPhyReceptionCallback(Ptr< PhyRxStatsCalculator > phyRxStats, std::string path, PhyReceptionStatParameters params)
trace sink
uint8_t m_ccId
component carrier id
Definition: lte-common.h:225
uint8_t m_correctness
correctness of the TB received
Definition: lte-common.h:224
uint16_t m_rnti
C-RNTI scheduled.
Definition: lte-common.h:217
uint16_t m_cellId
Cell ID of the attached Enb.
Definition: lte-common.h:215
std::string GetDlRxOutputFilename(void)
Get the name of the file where the DL RX PHY statistics will be stored.
#define NS_LOG_ERROR(msg)
Use NS_LOG to output a message of level LOG_ERROR.
Definition: log.h:257
Ptr< const AttributeAccessor > MakeStringAccessor(T1 a1)
Create an AttributeAccessor for a class data member, or a lone class get functor or set method...
Definition: string.h:42
void SetUlRxOutputFilename(std::string outputFilename)
Set the name of the file where the UL Rx PHY statistics will be stored.
void SetDlRxOutputFilename(std::string outputFilename)
Set the name of the file where the DL RX PHY statistics will be stored.
uint64_t m_imsi
IMSI of the scheduled UE.
Definition: lte-common.h:216
static TypeId GetTypeId(void)
Register this type.
a unique identifier for an interface.
Definition: type-id.h:58
bool m_ulRxFirstWrite
When writing UL RX PHY statistics first time to file, columns description is added.
TypeId SetParent(TypeId tid)
Set the parent TypeId.
Definition: type-id.cc:922
Takes care of storing the information generated at PHY layer regarding reception. ...
std::string GetDlOutputFilename(void)
Get the name of the file where the downlink statistics will be stored.