2 # NEPI, a framework to manage network experiments
3 # Copyright (C) 2013 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 # Force the load of ns3 libraries
21 from nepi.resources.ns3.ns3wrapper import load_ns3_module
26 adapted_types = ["ns3::Node",
28 #"ns3::DceApplication",
32 "ns3::Icmpv4L4Protocol",
34 "ns3::Ipv4L3Protocol",
35 "ns3::PropagationLossModel",
37 "ns3::PropagationDelayModel",
38 "ns3::WifiRemoteStationManager",
44 "ns3::ErrorRateModel"]
46 base_types = ["ns3::IpL4Protocol"]
48 def select_base_class(ns3, tid):
49 base_class_import = None
54 type_id = ns3.TypeId()
56 for type_name in adapted_types:
57 tid_base = type_id.LookupByName(type_name)
58 if type_name == rtype or tid.IsChildOf(tid_base):
59 base_class = "NS3Base" + type_name.replace("ns3::", "")
60 base_module = "ns3" + type_name.replace("ns3::", "").lower()
61 base_class_import = "from nepi.resources.ns3.%s import %s " % (
62 base_module, base_class)
63 return (base_class_import, base_class)
65 base_class_import = "from nepi.resources.ns3.ns3base import NS3Base"
66 base_class = "NS3Base"
68 for type_name in base_types:
69 tid_base = type_id.LookupByName(type_name)
70 if type_name == rtype or tid.IsChildOf(tid_base):
71 return (base_class_import, base_class)
76 ns3 = load_ns3_module()
78 type_id = ns3.TypeId()
80 tid_count = type_id.GetRegisteredN()
81 base = type_id.LookupByName("ns3::Object")
83 # Create a .py file using the ns-3 RM template for each ns-3 TypeId
84 for i in xrange(tid_count):
85 tid = type_id.GetRegistered(i)
87 (base_class_import, base_class) = select_base_class(ns3, tid)
91 if tid.MustHideFromDocumentation() or \
92 not tid.HasConstructor() or \
93 not tid.IsChildOf(base):
96 attributes = template_attributes(ns3, tid)
97 traces = template_traces(ns3, tid)
99 while ptid.HasParent():
100 ptid = ptid.GetParent()
101 attributes += template_attributes(ns3, ptid)
102 traces += template_traces(ns3, ptid)
104 attributes = "\n" + attributes if attributes else "pass"
105 traces = "\n" + traces if traces else "pass"
107 category = tid.GetGroupName()
109 rtype = tid.GetName()
110 classname = rtype.replace("ns3::", "NS3").replace("::","")
111 uncamm_rtype = re.sub('([a-z])([A-Z])', r'\1-\2', rtype).lower()
112 short_rtype = uncamm_rtype.replace("::","-")
114 d = os.path.dirname(os.path.realpath(__file__))
115 ftemp = open(os.path.join(d, "templates", "resource_manager_template.txt"), "r")
116 template = ftemp.read()
119 template = template. \
120 replace("<CLASS_NAME>", classname). \
121 replace("<RTYPE>", rtype). \
122 replace("<ATTRIBUTES>", attributes). \
123 replace("<TRACES>", traces). \
124 replace("<BASE_CLASS_IMPORT>", base_class_import). \
125 replace("<BASE_CLASS>", base_class). \
126 replace("<SHORT-RTYPE>", short_rtype)
128 fname = uncamm_rtype.replace('ns3::', ''). \
130 replace("-","_").lower() + ".py"
132 f = open(os.path.join(d, "classes", fname), "w")
133 print os.path.join(d, fname)
138 def template_attributes(ns3, tid):
139 d = os.path.dirname(os.path.realpath(__file__))
140 ftemp = open(os.path.join(d, "templates", "attribute_template.txt"), "r")
141 template = ftemp.read()
146 attr_count = tid.GetAttributeN()
147 for i in xrange(attr_count):
148 attr_info = tid.GetAttribute(i)
149 if not attr_info.accessor.HasGetter():
152 attr_flags = "Flags.Reserved"
153 flags = attr_info.flags
154 if (flags & ns3.TypeId.ATTR_CONSTRUCT) == ns3.TypeId.ATTR_CONSTRUCT:
155 attr_flags += " | Flags.Construct"
157 if (flags & ns3.TypeId.ATTR_GET) != ns3.TypeId.ATTR_GET:
158 attr_flags += " | Flags.NoRead"
159 elif (flags & ns3.TypeId.ATTR_SET) != ns3.TypeId.ATTR_SET:
160 attr_flags += " | Flags.NoWrite"
162 attr_name = attr_info.name
163 checker = attr_info.checker
164 attr_help = attr_info.help.replace('"', '\\"').replace("'", "\\'")
165 value = attr_info.initialValue
166 attr_value = value.SerializeToString(checker)
167 attr_allowed = "None"
169 attr_type = "Types.String"
171 if isinstance(value, ns3.ObjectVectorValue):
173 elif isinstance(value, ns3.PointerValue):
175 elif isinstance(value, ns3.WaypointValue):
177 elif isinstance(value, ns3.BooleanValue):
178 attr_type = "Types.Bool"
179 attr_value = "True" if attr_value == "true" else "False"
180 elif isinstance(value, ns3.EnumValue):
181 attr_type = "Types.Enumerate"
182 allowed = checker.GetUnderlyingTypeInformation().split("|")
183 attr_allowed = "[%s]" % ",".join(map(lambda x: "\"%s\"" % x, allowed))
184 elif isinstance(value, ns3.DoubleValue):
185 attr_type = "Types.Double"
187 elif isinstance(value, ns3.UintegerValue):
188 attr_type = "Types.Integer"
191 attr_id = "attr_" + attr_name.lower().replace("-", "_")
192 attributes += template.replace("<ATTR_ID>", attr_id) \
193 .replace("<ATTR_NAME>", attr_name) \
194 .replace("<ATTR_HELP>", attr_help) \
195 .replace("<ATTR_TYPE>", attr_type) \
196 .replace("<ATTR_DEFAULT>", attr_value) \
197 .replace("<ATTR_ALLOWED>", attr_allowed) \
198 .replace("<ATTR_RANGE>", attr_range) \
199 .replace("<ATTR_FLAGS>", attr_flags)
203 def template_traces(ns3, tid):
204 d = os.path.dirname(os.path.realpath(__file__))
205 ftemp = open(os.path.join(d, "templates", "trace_template.txt"), "r")
206 template = ftemp.read()
211 trace_count = tid.GetTraceSourceN()
212 for i in xrange(trace_count):
213 trace_info = tid.GetTraceSource(i)
214 trace_name = trace_info.name
215 trace_help = trace_info.help.replace('"', '\\"').replace("'", "\\'")
217 trace_id = trace_name.lower()
218 traces += template.replace("<TRACE_ID>", trace_id) \
219 .replace("<TRACE_NAME>", trace_name) \
220 .replace("<TRACE_HELP>", trace_help)
224 if __name__ == "__main__":