A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
lte-ue-net-device.cc
Go to the documentation of this file.
1/*
2 * Copyright (c) 2010 TELEMATICS LAB, DEE - Politecnico di Bari
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: Giuseppe Piro <g.piro@poliba.it>
18 * Nicola Baldo <nbaldo@cttc.es>
19 * Marco Miozzo <mmiozzo@cttc.es>
20 * Modified by:
21 * Danilo Abrignani <danilo.abrignani@unibo.it> (Carrier Aggregation - GSoC 2015)
22 * Biljana Bojovic <biljana.bojovic@cttc.es> (Carrier Aggregation)
23 */
24
25#include "lte-ue-net-device.h"
26
27#include "epc-ue-nas.h"
28#include "lte-enb-net-device.h"
29#include "lte-net-device.h"
31#include "lte-ue-mac.h"
32#include "lte-ue-phy.h"
33#include "lte-ue-rrc.h"
34
35#include "ns3/callback.h"
36#include "ns3/enum.h"
37#include "ns3/ipv4-header.h"
38#include "ns3/ipv4.h"
39#include "ns3/ipv6-header.h"
40#include "ns3/ipv6.h"
41#include "ns3/llc-snap-header.h"
42#include "ns3/node.h"
43#include "ns3/packet-burst.h"
44#include "ns3/packet.h"
45#include "ns3/pointer.h"
46#include "ns3/simulator.h"
47#include "ns3/trace-source-accessor.h"
48#include "ns3/uinteger.h"
49#include <ns3/ipv4-l3-protocol.h>
50#include <ns3/ipv6-l3-protocol.h>
51#include <ns3/log.h>
52#include <ns3/object-factory.h>
53#include <ns3/object-map.h>
54
55namespace ns3
56{
57
58NS_LOG_COMPONENT_DEFINE("LteUeNetDevice");
59
60NS_OBJECT_ENSURE_REGISTERED(LteUeNetDevice);
61
62TypeId
64{
65 static TypeId tid =
66 TypeId("ns3::LteUeNetDevice")
68 .AddConstructor<LteUeNetDevice>()
69 .AddAttribute("EpcUeNas",
70 "The NAS associated to this UeNetDevice",
73 MakePointerChecker<EpcUeNas>())
74 .AddAttribute("LteUeRrc",
75 "The RRC associated to this UeNetDevice",
78 MakePointerChecker<LteUeRrc>())
79 .AddAttribute("LteUeComponentCarrierManager",
80 "The ComponentCarrierManager associated to this UeNetDevice",
83 MakePointerChecker<LteUeComponentCarrierManager>())
84 .AddAttribute("ComponentCarrierMapUe",
85 "List of all component Carrier.",
88 MakeObjectMapChecker<ComponentCarrierUe>())
89 .AddAttribute("Imsi",
90 "International Mobile Subscriber Identity assigned to this UE",
93 MakeUintegerChecker<uint64_t>())
94 .AddAttribute(
95 "DlEarfcn",
96 "Downlink E-UTRA Absolute Radio Frequency Channel Number (EARFCN) "
97 "as per 3GPP 36.101 Section 5.7.3.",
98 UintegerValue(100),
100 MakeUintegerChecker<uint32_t>(0, 262143))
101 .AddAttribute(
102 "CsgId",
103 "The Closed Subscriber Group (CSG) identity that this UE is associated with, "
104 "i.e., giving the UE access to cells which belong to this particular CSG. "
105 "This restriction only applies to initial cell selection and EPC-enabled "
106 "simulation. "
107 "This does not revoke the UE's access to non-CSG cells.",
108 UintegerValue(0),
110 MakeUintegerChecker<uint32_t>());
111
112 return tid;
113}
114
116 : m_isConstructed(false)
117{
118 NS_LOG_FUNCTION(this);
119}
120
122{
123 NS_LOG_FUNCTION(this);
124}
125
126void
128{
129 NS_LOG_FUNCTION(this);
130 m_targetEnb = nullptr;
131
132 m_rrc->Dispose();
133 m_rrc = nullptr;
134
135 m_nas->Dispose();
136 m_nas = nullptr;
137 for (uint32_t i = 0; i < m_ccMap.size(); i++)
138 {
139 m_ccMap.at(i)->Dispose();
140 }
141 m_componentCarrierManager->Dispose();
143}
144
145void
147{
148 NS_LOG_FUNCTION(this);
149
150 if (m_isConstructed)
151 {
152 NS_LOG_LOGIC(this << " Updating configuration: IMSI " << m_imsi << " CSG ID " << m_csgId);
153 m_nas->SetImsi(m_imsi);
154 m_rrc->SetImsi(m_imsi);
155 m_nas->SetCsgId(m_csgId); // this also handles propagation to RRC
156 }
157 else
158 {
159 /*
160 * NAS and RRC instances are not be ready yet, so do nothing now and
161 * expect ``DoInitialize`` to re-invoke this function.
162 */
163 }
164}
165
168{
169 NS_LOG_FUNCTION(this);
170 return m_ccMap.at(0)->GetMac();
171}
172
175{
176 NS_LOG_FUNCTION(this);
177 return m_rrc;
178}
179
182{
183 NS_LOG_FUNCTION(this);
184 return m_ccMap.at(0)->GetPhy();
185}
186
189{
190 NS_LOG_FUNCTION(this);
192}
193
196{
197 NS_LOG_FUNCTION(this);
198 return m_nas;
199}
200
201uint64_t
203{
204 NS_LOG_FUNCTION(this);
205 return m_imsi;
206}
207
210{
211 NS_LOG_FUNCTION(this);
212 return m_dlEarfcn;
213}
214
215void
217{
218 NS_LOG_FUNCTION(this << earfcn);
219 m_dlEarfcn = earfcn;
220}
221
224{
225 NS_LOG_FUNCTION(this);
226 return m_csgId;
227}
228
229void
231{
232 NS_LOG_FUNCTION(this << csgId);
233 m_csgId = csgId;
234 UpdateConfig(); // propagate the change down to NAS and RRC
235}
236
237void
239{
240 NS_LOG_FUNCTION(this << enb);
241 m_targetEnb = enb;
242}
243
246{
247 NS_LOG_FUNCTION(this);
248 return m_targetEnb;
249}
250
251std::map<uint8_t, Ptr<ComponentCarrierUe>>
253{
254 return m_ccMap;
255}
256
257void
259{
260 m_ccMap = ccm;
261}
262
263void
265{
266 NS_LOG_FUNCTION(this);
267 m_isConstructed = true;
268 UpdateConfig();
269
270 for (auto it = m_ccMap.begin(); it != m_ccMap.end(); ++it)
271 {
272 it->second->GetPhy()->Initialize();
273 it->second->GetMac()->Initialize();
274 }
275 m_rrc->Initialize();
276}
277
278bool
279LteUeNetDevice::Send(Ptr<Packet> packet, const Address& dest, uint16_t protocolNumber)
280{
281 NS_LOG_FUNCTION(this << packet << dest << protocolNumber);
283 protocolNumber != Ipv6L3Protocol::PROT_NUMBER,
284 "unsupported protocol " << protocolNumber
285 << ", only IPv4 and IPv6 are supported");
286 return m_nas->Send(packet, protocolNumber);
287}
288
289} // namespace ns3
a polymophic address class
Definition: address.h:101
static const uint16_t PROT_NUMBER
Protocol number (0x0800)
static const uint16_t PROT_NUMBER
The protocol number for IPv6 (0x86DD).
LteNetDevice provides basic implementation for all LTE network devices.
void DoDispose() override
Destructor implementation.
uint32_t m_csgId
the CSG ID
void DoInitialize() override
Initialize() implementation.
Ptr< LteUeRrc > m_rrc
the RRC
uint64_t m_imsi
the IMSI
static TypeId GetTypeId()
Get the type ID.
void UpdateConfig()
Propagate attributes and configuration to sub-modules.
std::map< uint8_t, Ptr< ComponentCarrierUe > > m_ccMap
CC map.
Ptr< LteUeComponentCarrierManager > GetComponentCarrierManager() const
Get the componentn carrier manager.
Ptr< LteEnbNetDevice > GetTargetEnb()
Get the target eNB where the UE is registered.
Ptr< LteUeRrc > GetRrc() const
Get the RRC.
Ptr< EpcUeNas > GetNas() const
Get the NAS.
uint64_t GetImsi() const
Get the IMSI.
void SetCsgId(uint32_t csgId)
Enlist the UE device as a member of a particular CSG.
Ptr< LteUeComponentCarrierManager > m_componentCarrierManager
the component carrier manager
Ptr< LteUePhy > GetPhy() const
Get the Phy.
uint32_t m_dlEarfcn
downlink carrier frequency
void SetDlEarfcn(uint32_t earfcn)
Ptr< LteUeMac > GetMac() const
Get the MAC.
Ptr< EpcUeNas > m_nas
the NAS
bool Send(Ptr< Packet > packet, const Address &dest, uint16_t protocolNumber) override
std::map< uint8_t, Ptr< ComponentCarrierUe > > GetCcMap()
Get the ComponentCarrier Map for the UE.
void SetTargetEnb(Ptr< LteEnbNetDevice > enb)
Set the target eNB where the UE is registered.
void DoDispose() override
Destructor implementation.
void SetCcMap(std::map< uint8_t, Ptr< ComponentCarrierUe > > ccm)
Set the ComponentCarrier Map for the UE.
uint32_t GetDlEarfcn() const
Ptr< LteEnbNetDevice > m_targetEnb
target ENB
uint32_t GetCsgId() const
Returns the CSG ID the UE is currently a member of.
bool m_isConstructed
is constructed?
AttributeValue implementation for Pointer.
Definition: pointer.h:48
Smart pointer class similar to boost::intrusive_ptr.
Definition: ptr.h:77
a unique identifier for an interface.
Definition: type-id.h:59
TypeId SetParent(TypeId tid)
Set the parent TypeId.
Definition: type-id.cc:932
Hold an unsigned integer type.
Definition: uinteger.h:45
ObjectPtrContainerValue ObjectMapValue
ObjectMapValue is an alias for ObjectPtrContainerValue.
Definition: object-map.h:40
Ptr< const AttributeAccessor > MakeObjectMapAccessor(U T::*memberVariable)
MakeAccessorHelper implementation for ObjectVector.
Definition: object-map.h:76
Ptr< const AttributeAccessor > MakePointerAccessor(T1 a1)
Definition: pointer.h:259
Ptr< const AttributeAccessor > MakeUintegerAccessor(T1 a1)
Definition: uinteger.h:46
#define NS_ABORT_MSG_IF(cond, msg)
Abnormal program termination if a condition is true, with a message.
Definition: abort.h:108
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition: log.h:202
#define NS_LOG_LOGIC(msg)
Use NS_LOG to output a message of level LOG_LOGIC.
Definition: log.h:282
#define NS_LOG_FUNCTION(parameters)
If log level LOG_FUNCTION is enabled, this macro will output all input parameters separated by ",...
#define NS_OBJECT_ENSURE_REGISTERED(type)
Register an Object subclass with the TypeId system.
Definition: object-base.h:46
Every class exported by the ns3 library is enclosed in the ns3 namespace.