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 as published by
7 # the Free Software Foundation, either version 3 of the License, or
8 # (at your option) any later version.
10 # This program is distributed in the hope that it will be useful,
11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 # GNU General Public License for more details.
15 # You should have received a copy of the GNU General Public License
16 # along with this program. If not, see <http://www.gnu.org/licenses/>.
18 # Author: Alina Quereilhac <alina.quereilhac@inria.fr>
20 from nepi.execution.attribute import Attribute, Flags, Types
21 from nepi.execution.resource import clsinit_copy
22 from nepi.resources.ns3.ns3base import NS3Base
25 class NS3BaseNode(NS3Base):
26 _rtype = "abstract::ns3::Node"
28 def __init__(self, ec, guid):
29 super(NS3BaseNode, self).__init__(ec, guid)
30 self._simulation = None
36 self._dceapplications = None
39 def _register_attributes(cls):
40 enablestack = Attribute("enableStack",
41 "Install network stack in Node, including: ARP, "
42 "IP4, ICMP, UDP and TCP ",
47 cls._register_attribute(enablestack)
51 if not self._simulation:
52 from nepi.resources.ns3.ns3simulation import NS3Simulation
53 for guid in self.connections:
54 rm = self.ec.get_resource(guid)
55 if isinstance(rm, NS3Simulation):
58 if not self._simulation:
59 msg = "Node not connected to simulation"
61 raise RuntimeError, msg
63 return self._simulation
68 from nepi.resources.ns3.ns3ipv4l3protocol import NS3BaseIpv4L3Protocol
69 ipv4s = self.get_connected(NS3BaseIpv4L3Protocol.get_rtype())
78 from nepi.resources.ns3.ns3arpl3protocol import NS3BaseArpL3Protocol
79 arps = self.get_connected(NS3BaseArpL3Protocol.get_rtype())
87 if not self._mobility:
88 from nepi.resources.ns3.ns3mobilitymodel import NS3BaseMobilityModel
89 mobility = self.get_connected(NS3BaseMobilityModel.get_rtype())
91 self._mobility = mobility[0]
98 from nepi.resources.ns3.ns3netdevice import NS3BaseNetDevice
99 devices = self.get_connected(NS3BaseNetDevice.get_rtype())
102 msg = "Node not connected to devices"
104 raise RuntimeError, msg
106 self._devices = devices
115 def dceapplications(self):
116 if not self._dceapplications:
117 from nepi.resources.ns3.ns3dceapplication import NS3BaseDceApplication
118 self._dceapplications = self.get_connected(NS3BaseDceApplication.get_rtype())
120 return self._dceapplications
123 def _rms_to_wait(self):
125 rms.add(self.simulation)
135 mobility = self.mobility
141 def _configure_object(self):
142 if self.get("enableStack"):
143 uuid_stack_helper = self.simulation.create("InternetStackHelper")
144 self.simulation.invoke(uuid_stack_helper, "Install", self.uuid)
146 # Retrieve IPV4 object
147 ipv4_uuid = self.simulation.invoke(self.uuid, "retrieveObject",
148 "ns3::Ipv4L3Protocol")
150 # Add IPv4 RM to the node
151 ipv4 = self.ec.register_resource("ns3::Ipv4L3Protocol")
152 self.ec.register_connection(self.guid, ipv4)
153 ipv4rm = self.ec.get_resource(ipv4)
154 ipv4rm._uuid = ipv4_uuid
157 ### node.AggregateObject(PacketSocketFactory())
158 uuid_packet_socket_factory = self.simulation.create("PacketSocketFactory")
159 self.simulation.invoke(self.uuid, "AggregateObject", uuid_packet_socket_factory)
161 self._node_id = self.simulation.invoke(self.uuid, "GetId")
163 dceapplications = self.dceapplications
165 self._add_dce(dceapplications)
167 def _connect_object(self):
168 if not self.get("enableStack"):
171 self.simulation.invoke(self.uuid, "AggregateObject", ipv4.uuid)
172 self._connected.add(ipv4.uuid)
173 ipv4._connected.add(self.uuid)
177 self.simulation.invoke(self.uuid, "AggregateObject", arp.uuid)
178 self._connected.add(arp.uuid)
179 arp._connected.add(self.uuid)
181 mobility = self.mobility
183 self.simulation.invoke(self.uuid, "AggregateObject", mobility.uuid)
184 self._connected.add(mobility.uuid)
185 mobility._connected.add(self.uuid)
187 def _add_dce(self, dceapplications):
188 dceapp = dceapplications[0]
190 container_uuid = self.simulation.create("NodeContainer")
191 self.simulation.invoke(container_uuid, "Add", self.uuid)
192 with dceapp.dce_manager_lock:
193 self.simulation.invoke(dceapp.dce_manager_helper_uuid,
194 "Install", container_uuid)