use print() - import print_function - should be fine for both py2 and py3
[nepi.git] / src / nepi / resources / ns3 / resource_manager_generator.py
index c01180e..9097906 100644 (file)
@@ -3,9 +3,8 @@
 #    Copyright (C) 2013 INRIA
 #
 #    This program is free software: you can redistribute it and/or modify
-#    it under the terms of the GNU General Public License as published by
-#    the Free Software Foundation, either version 3 of the License, or
-#    (at your option) any later version.
+#    it under the terms of the GNU General Public License version 2 as
+#    published by the Free Software Foundation;
 #
 #    This program is distributed in the hope that it will be useful,
 #    but WITHOUT ANY WARRANTY; without even the implied warranty of
 #
 # Author: Alina Quereilhac <alina.quereilhac@inria.fr>
 
+#
+# Instructions to automatically generate ns-3 ResourceManagers
+# 
+# Configure the ns-3 enviorment (e.g.):
+#
+#  export PYTHONPATH=~/.nepi/nepi-usr/bin/ns-3/ns-3.20/optimized/build/lib/python/site-packages
+#  export LD_LIBRARY_PATH=~/.nepi/nepi-usr/bin/ns-3/ns-3.20/optimized/build/lib
+#
+# Run the RM generator:
+#
+#  PYTHONPATH=$PYTHONPATH:~/repos/nepi/src python src/nepi/resources/ns3/resource_manager_generator.py
+#
+
+from __future__ import print_function
+
+# Force the load of ns3 libraries
 from nepi.resources.ns3.ns3wrapper import load_ns3_module
 
 import os
 import re
 
+adapted_types = ["ns3::Node",
+        "ns3::Icmpv4L4Protocol",
+        "ns3::ArpL3Protocol",
+        "ns3::Ipv4L3Protocol",
+        "ns3::PropagationLossModel",
+        "ns3::MobilityModel",
+        "ns3::PropagationDelayModel",
+        "ns3::WifiRemoteStationManager",
+        "ns3::WifiNetDevice",
+        "ns3::WifiChannel",
+        "ns3::WifiPhy",
+        "ns3::WifiMac",
+        "ns3::ErrorModel",
+        "ns3::ErrorRateModel",
+        "ns3::Application", 
+        "ns3::FdNetDevice",
+        #"ns3::DceApplication", 
+        "ns3::NetDevice",
+        "ns3::Channel",
+        "ns3::Queue"]
+
+base_types = ["ns3::IpL4Protocol"]
+
+def select_base_class(ns3, tid): 
+    base_class_import = None
+    base_class = None
+   
+    rtype = tid.GetName()
+
+    type_id = ns3.TypeId()
+
+    for type_name in adapted_types:
+        tid_base = type_id.LookupByName(type_name)
+        if type_name == rtype or tid.IsChildOf(tid_base):
+            base_class = "NS3Base" + type_name.replace("ns3::", "")
+            base_module = "ns3" + type_name.replace("ns3::", "").lower()
+            base_class_import = "from nepi.resources.ns3.%s import %s " % (
+                    base_module, base_class)
+            return (base_class_import, base_class)
+
+    base_class_import = "from nepi.resources.ns3.ns3base import NS3Base"
+    base_class = "NS3Base"
+
+    for type_name in base_types:
+        tid_base = type_id.LookupByName(type_name)
+        if type_name == rtype or tid.IsChildOf(tid_base):
+            return (base_class_import, base_class)
+
+    return (None, None)
+
 def create_ns3_rms():
     ns3 = load_ns3_module()
 
@@ -34,6 +99,10 @@ def create_ns3_rms():
     for i in xrange(tid_count):
         tid = type_id.GetRegistered(i)
         
+        (base_class_import, base_class) = select_base_class(ns3, tid)
+        if not base_class:
+            continue
+        
         if tid.MustHideFromDocumentation() or \
                 not tid.HasConstructor() or \
                 not tid.IsChildOf(base): 
@@ -50,12 +119,9 @@ def create_ns3_rms():
         attributes = "\n" + attributes if attributes else "pass"
         traces = "\n" + traces if traces else "pass"
 
-        rtype = tid.GetName()
         category = tid.GetGroupName()
 
-        base_class_import = "from nepi.resources.ns3.ns3base import NS3Base"
-        base_clas = "NS3Base"
+        rtype = tid.GetName()
         classname = rtype.replace("ns3::", "NS3").replace("::","")
         uncamm_rtype = re.sub('([a-z])([A-Z])', r'\1-\2', rtype).lower()
         short_rtype = uncamm_rtype.replace("::","-")
@@ -78,11 +144,11 @@ def create_ns3_rms():
                 replace('::', ''). \
                 replace("-","_").lower() + ".py"
 
-        #f = open(os.path.join(d, "classes", fname), "w")
-        #print os.path.join(d, fname)
-        #print template
-        #f.write(template)
-        #f.close()
+        f = open(os.path.join(d, "classes", fname), "w")
+        print(os.path.join(d, fname))
+        print(template)
+        f.write(template)
+        f.close()
 
 def template_attributes(ns3, tid): 
     d = os.path.dirname(os.path.realpath(__file__))
@@ -98,10 +164,15 @@ def template_attributes(ns3, tid):
         if not attr_info.accessor.HasGetter():
             continue
 
-        attr_flags = "None"
+        attr_flags = "Flags.Reserved"
         flags = attr_info.flags
-        if (flags & ns3.TypeId.ATTR_SET) != ns3.TypeId.ATTR_SET:
-            attr_flags = "Types.ExecReadOnly"
+        if (flags & ns3.TypeId.ATTR_CONSTRUCT) == ns3.TypeId.ATTR_CONSTRUCT:
+            attr_flags += " | Flags.Construct"
+        else:
+            if (flags & ns3.TypeId.ATTR_GET) != ns3.TypeId.ATTR_GET:
+                attr_flags += " | Flags.NoRead"
+            elif (flags & ns3.TypeId.ATTR_SET) != ns3.TypeId.ATTR_SET:
+                attr_flags += " | Flags.NoWrite"
 
         attr_name = attr_info.name
         checker = attr_info.checker
@@ -110,7 +181,7 @@ def template_attributes(ns3, tid):
         attr_value = value.SerializeToString(checker)
         attr_allowed = "None"
         attr_range = "None"
-        attr_type = "Types.STRING"
+        attr_type = "Types.String"
 
         if isinstance(value, ns3.ObjectVectorValue):
             continue
@@ -119,19 +190,20 @@ def template_attributes(ns3, tid):
         elif isinstance(value, ns3.WaypointValue):
             continue
         elif isinstance(value, ns3.BooleanValue):
-            attr_type = "Types.BOOL"
+            attr_type = "Types.Bool"
             attr_value = "True" if attr_value == "true" else "False"
         elif isinstance(value, ns3.EnumValue):
-            attr_type = "Types.ENUM"
-            attr_allowed = "[%s]"% checker.GetUnderlyingTypeInformation().replace("|", ",")
+            attr_type = "Types.Enumerate"
+            allowed = checker.GetUnderlyingTypeInformation().split("|")
+            attr_allowed = "[%s]" % ",".join(map(lambda x: "\"%s\"" % x, allowed))
         elif isinstance(value, ns3.DoubleValue):
-            attr_type = "Types.DOUBLE"
+            attr_type = "Types.Double"
             # TODO: range
         elif isinstance(value, ns3.UintegerValue):
-            attr_type = "Types.INTEGER"
+            attr_type = "Types.Integer"
             # TODO: range
 
-        attr_id = attr_name.lower()
+        attr_id = "attr_" + attr_name.lower().replace("-", "_")
         attributes += template.replace("<ATTR_ID>", attr_id) \
                 .replace("<ATTR_NAME>", attr_name) \
                 .replace("<ATTR_HELP>", attr_help) \