2 # NEPI, a framework to manage network experiments
3 # Copyright (C) 2014 INRIA
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;
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.
14 # You should have received a copy of the GNU General Public License
15 # along with this program. If not, see <http://www.gnu.org/licenses/>.
17 # Author: Alina Quereilhac <alina.quereilhac@inria.fr>
19 from nepi.execution.attribute import Attribute, Flags, Types
20 from nepi.execution.resource import clsinit_copy
21 from nepi.resources.ns3.ns3base import NS3Base
24 class NS3BaseNode(NS3Base):
25 _rtype = "abstract::ns3::Node"
27 def __init__(self, ec, guid):
28 super(NS3BaseNode, self).__init__(ec, guid)
29 self._simulation = None
35 self._dceapplications = None
38 def _register_attributes(cls):
39 enablestack = Attribute("enableStack",
40 "Install network stack in Node, including: ARP, "
41 "IP4, ICMP, UDP and TCP ",
46 cls._register_attribute(enablestack)
50 if not self._simulation:
51 from nepi.resources.ns3.ns3simulation import NS3Simulation
52 for guid in self.connections:
53 rm = self.ec.get_resource(guid)
54 if isinstance(rm, NS3Simulation):
57 if not self._simulation:
58 msg = "Node not connected to simulation"
60 raise RuntimeError(msg)
62 return self._simulation
67 from nepi.resources.ns3.ns3ipv4l3protocol import NS3BaseIpv4L3Protocol
68 ipv4s = self.get_connected(NS3BaseIpv4L3Protocol.get_rtype())
77 from nepi.resources.ns3.ns3arpl3protocol import NS3BaseArpL3Protocol
78 arps = self.get_connected(NS3BaseArpL3Protocol.get_rtype())
86 if not self._mobility:
87 from nepi.resources.ns3.ns3mobilitymodel import NS3BaseMobilityModel
88 mobility = self.get_connected(NS3BaseMobilityModel.get_rtype())
90 self._mobility = mobility[0]
97 from nepi.resources.ns3.ns3netdevice import NS3BaseNetDevice
98 devices = self.get_connected(NS3BaseNetDevice.get_rtype())
101 msg = "Node not connected to devices"
103 raise RuntimeError(msg)
105 self._devices = devices
114 def dceapplications(self):
115 if not self._dceapplications:
116 from nepi.resources.ns3.ns3dceapplication import NS3BaseDceApplication
117 self._dceapplications = self.get_connected(NS3BaseDceApplication.get_rtype())
119 return self._dceapplications
122 def _rms_to_wait(self):
123 rms = set([self.simulation])
132 rms.add(self.mobility)
136 def _configure_object(self):
137 if self.get("enableStack"):
138 uuid_stack_helper = self.simulation.create("InternetStackHelper")
139 self.simulation.invoke(uuid_stack_helper, "Install", self.uuid)
141 # Retrieve IPV4 object
142 ipv4_uuid = self.simulation.invoke(self.uuid, "retrieveObject",
143 "ns3::Ipv4L3Protocol")
145 # Add IPv4 RM to the node
146 ipv4 = self.ec.register_resource("ns3::Ipv4L3Protocol")
147 self.ec.register_connection(self.guid, ipv4)
148 ipv4rm = self.ec.get_resource(ipv4)
149 ipv4rm._uuid = ipv4_uuid
152 ### node.AggregateObject(PacketSocketFactory())
153 uuid_packet_socket_factory = self.simulation.create("PacketSocketFactory")
154 self.simulation.invoke(self.uuid, "AggregateObject", uuid_packet_socket_factory)
156 self._node_id = self.simulation.invoke(self.uuid, "GetId")
158 dceapplications = self.dceapplications
160 self._add_dce(dceapplications)
162 def _connect_object(self):
163 if not self.get("enableStack"):
166 self.simulation.invoke(self.uuid, "AggregateObject", ipv4.uuid)
167 self._connected.add(ipv4.uuid)
168 ipv4._connected.add(self.uuid)
172 self.simulation.invoke(self.uuid, "AggregateObject", arp.uuid)
173 self._connected.add(arp.uuid)
174 arp._connected.add(self.uuid)
176 mobility = self.mobility
178 self.simulation.invoke(self.uuid, "AggregateObject", mobility.uuid)
179 self._connected.add(mobility.uuid)
180 mobility._connected.add(self.uuid)
182 def _add_dce(self, dceapplications):
183 dceapp = dceapplications[0]
185 container_uuid = self.simulation.create("NodeContainer")
186 self.simulation.invoke(container_uuid, "Add", self.uuid)
188 dce_helper = self.simulation.dce_helper
190 with dce_helper.dce_manager_lock:
191 dce_manager_uuid = dce_helper.dce_manager_uuid
193 self.simulation.invoke(dce_manager_uuid, "Install", container_uuid)