updates to layout core module packages in a more logical way, including renaming methods from objects to nodes and nodes.objid to nodes.id

daemon/core/emulator/coreemu.py

@@ -5,18 +5,16 @@ import signal
 import sys
 
 import core.services
-from core.coreobj import PyCoreNet
-from core.coreobj import PyCoreNode
-from core.data import NodeData
+from core.nodes.base import CoreNodeBase, CoreNetworkBase
+from core.emulator.data import NodeData
 from core.emulator.emudata import LinkOptions
 from core.emulator.emudata import NodeOptions
-from core.enumerations import EventTypes
-from core.enumerations import LinkTypes
-from core.enumerations import NodeTypes
-from core.misc import nodemaps
-from core.misc import nodeutils
-from core.service import ServiceManager
-from core.session import Session
+from core.emulator.enumerations import EventTypes
+from core.emulator.enumerations import LinkTypes
+from core.emulator.enumerations import NodeTypes
+from core.nodes import nodeutils, nodemaps
+from core.services.coreservices import ServiceManager
+from core.emulator.session import Session
 from core.xml.corexml import CoreXmlReader, CoreXmlWriter
 
 
@@ -94,7 +92,7 @@ def is_net_node(node):
     :return: True if object is an instance of a network node, False otherwise
     :rtype: bool
     """
-    return isinstance(node, PyCoreNet)
+    return isinstance(node, CoreNetworkBase)
 
 
 def is_core_node(node):
@@ -105,7 +103,7 @@ def is_core_node(node):
     :return: True if object is an instance of a core node, False otherwise
     :rtype: bool
     """
-    return isinstance(node, PyCoreNode)
+    return isinstance(node, CoreNodeBase)
 
 
 class IdGen(object):
@@ -149,8 +147,8 @@ class EmuSession(Session):
         net_two = None
 
         # retrieve node one
-        node_one = self.get_object(node_one_id)
-        node_two = self.get_object(node_two_id)
+        node_one = self.get_node(node_one_id)
+        node_two = self.get_node(node_two_id)
 
         # both node ids are provided
         tunnel = self.broker.gettunnel(node_one_id, node_two_id)
@@ -245,7 +243,7 @@ class EmuSession(Session):
                     logging.info("adding link for peer to peer nodes: %s - %s", node_one.name, node_two.name)
                     ptp_class = nodeutils.get_node_class(NodeTypes.PEER_TO_PEER)
                     start = self.state > EventTypes.DEFINITION_STATE.value
-                    net_one = self.add_object(cls=ptp_class, start=start)
+                    net_one = self.create_node(cls=ptp_class, start=start)
 
                 # node to network
                 if node_one and net_one:
@@ -366,7 +364,7 @@ class EmuSession(Session):
                         interface_one.detachnet()
                         interface_two.detachnet()
                         if net_one.numnetif() == 0:
-                            self.delete_object(net_one.id)
+                            self.delete_node(net_one.id)
                         node_one.delnetif(interface_one.netindex)
                         node_two.delnetif(interface_two.netindex)
         finally:
@@ -483,7 +481,7 @@ class EmuSession(Session):
         if not _id:
             while True:
                 _id = self.node_id_gen.next()
-                if _id not in self.objects:
+                if _id not in self.nodes:
                     break
 
         # generate name if not provided
@@ -493,7 +491,7 @@ class EmuSession(Session):
 
         # create node
         logging.info("creating node(%s) id(%s) name(%s) start(%s)", node_class.__name__, _id, name, start)
-        node = self.add_object(cls=node_class, _id=_id, name=name, start=start)
+        node = self.create_node(cls=node_class, _id=_id, name=name, start=start)
 
         # set node attributes
         node.icon = node_options.icon
@@ -510,9 +508,9 @@ class EmuSession(Session):
             self.services.add_services(node, node.type, node_options.services)
 
         # boot nodes if created after runtime, LcxNodes, Physical, and RJ45 are all PyCoreNodes
-        is_boot_node = isinstance(node, PyCoreNode) and not nodeutils.is_node(node, NodeTypes.RJ45)
+        is_boot_node = isinstance(node, CoreNodeBase) and not nodeutils.is_node(node, NodeTypes.RJ45)
         if self.state == EventTypes.RUNTIME_STATE.value and is_boot_node:
-            self.write_objects()
+            self.write_nodes()
             self.add_remove_control_interface(node=node, remove=False)
             self.services.boot_services(node)
 
@@ -530,7 +528,7 @@ class EmuSession(Session):
         result = False
         try:
             # get node to update
-            node = self.get_object(node_id)
+            node = self.get_node(node_id)
 
             # set node position and broadcast it
             self.set_node_position(node, node_options)
@@ -546,20 +544,6 @@ class EmuSession(Session):
 
         return result
 
-    def delete_node(self, node_id):
-        """
-        Delete a node from the session and check if session should shutdown, if no nodes are left.
-
-        :param int node_id: id of node to delete
-        :return: True if node deleted, False otherwise
-        :rtype: bool
-        """
-        # delete node and check for session shutdown if a node was removed
-        result = self.custom_delete_object(node_id)
-        if result:
-            self.check_shutdown()
-        return result
-
     def set_node_position(self, node, node_options):
         """
         Set position for a node, use lat/lon/alt if needed.
@@ -625,21 +609,6 @@ class EmuSession(Session):
         self.set_state(EventTypes.SHUTDOWN_STATE, send_event=True)
         super(EmuSession, self).shutdown()
 
-    def custom_delete_object(self, object_id):
-        """
-        Remove an emulation object.
-
-        :param int object_id: object id to remove
-        :return: True if object deleted, False otherwise
-        """
-        result = False
-        with self._objects_lock:
-            if object_id in self.objects:
-                obj = self.objects.pop(object_id)
-                obj.shutdown()
-                result = True
-        return result
-
     def is_active(self):
         """
         Determine if this session is considered to be active. (Runtime or Data collect states)
@@ -704,7 +673,7 @@ class EmuSession(Session):
         :return: nothing
         """
 
-        node = self.get_object(node_id)
+        node = self.get_node(node_id)
 
         if source_name is not None:
             node.addfile(source_name, file_name)
@@ -717,7 +686,7 @@ class EmuSession(Session):
 
         :return: nothing
         """
-        self.delete_objects()
+        self.delete_nodes()
         self.del_hooks()
         self.broker.reset()
         self.emane.reset()

daemon/core/emulator/data.py

@@ -0,0 +1,120 @@
+"""
+CORE data objects.
+"""
+
+import collections
+
+ConfigData = collections.namedtuple("ConfigData", [
+    "message_type",
+    "node",
+    "object",
+    "type",
+    "data_types",
+    "data_values",
+    "captions",
+    "bitmap",
+    "possible_values",
+    "groups",
+    "session",
+    "interface_number",
+    "network_id",
+    "opaque"
+])
+ConfigData.__new__.__defaults__ = (None,) * len(ConfigData._fields)
+
+EventData = collections.namedtuple("EventData", [
+    "node",
+    "event_type",
+    "name",
+    "data",
+    "time",
+    "session"
+])
+EventData.__new__.__defaults__ = (None,) * len(EventData._fields)
+
+ExceptionData = collections.namedtuple("ExceptionData", [
+    "node",
+    "session",
+    "level",
+    "source",
+    "date",
+    "text",
+    "opaque"
+])
+ExceptionData.__new__.__defaults__ = (None,) * len(ExceptionData._fields)
+
+FileData = collections.namedtuple("FileData", [
+    "message_type",
+    "node",
+    "name",
+    "mode",
+    "number",
+    "type",
+    "source",
+    "session",
+    "data",
+    "compressed_data"
+])
+FileData.__new__.__defaults__ = (None,) * len(FileData._fields)
+
+NodeData = collections.namedtuple("NodeData", [
+    "message_type",
+    "id",
+    "node_type",
+    "name",
+    "ip_address",
+    "mac_address",
+    "ip6_address",
+    "model",
+    "emulation_id",
+    "emulation_server",
+    "session",
+    "x_position",
+    "y_position",
+    "canvas",
+    "network_id",
+    "services",
+    "latitude",
+    "longitude",
+    "altitude",
+    "icon",
+    "opaque"
+])
+NodeData.__new__.__defaults__ = (None,) * len(NodeData._fields)
+
+LinkData = collections.namedtuple("LinkData", [
+    "message_type",
+    "node1_id",
+    "node2_id",
+    "delay",
+    "bandwidth",
+    "per",
+    "dup",
+    "jitter",
+    "mer",
+    "burst",
+    "session",
+    "mburst",
+    "link_type",
+    "gui_attributes",
+    "unidirectional",
+    "emulation_id",
+    "network_id",
+    "key",
+    "interface1_id",
+    "interface1_name",
+    "interface1_ip4",
+    "interface1_ip4_mask",
+    "interface1_mac",
+    "interface1_ip6",
+    "interface1_ip6_mask",
+    "interface2_id",
+    "interface2_name",
+    "interface2_ip4",
+    "interface2_ip4_mask",
+    "interface2_mac",
+    "interface2_ip6",
+    "interface2_ip6_mask",
+    "opaque"
+])
+LinkData.__new__.__defaults__ = (None,) * len(LinkData._fields)

daemon/core/emulator/emudata.py

@@ -1,7 +1,7 @@
-from core.enumerations import LinkTypes
-from core.misc.ipaddress import Ipv4Prefix
-from core.misc.ipaddress import Ipv6Prefix
-from core.misc.ipaddress import MacAddress
+from core.emulator.enumerations import LinkTypes
+from core.nodes.ipaddress import Ipv4Prefix
+from core.nodes.ipaddress import Ipv6Prefix
+from core.nodes.ipaddress import MacAddress
 
 
 class NodeOptions(object):

daemon/core/emulator/enumerations.py

@@ -0,0 +1,317 @@
+"""
+Contains all legacy enumerations for interacting with legacy CORE code.
+"""
+
+from enum import Enum
+
+CORE_API_VERSION = "1.23"
+CORE_API_PORT = 4038
+
+
+class MessageTypes(Enum):
+    """
+    CORE message types.
+    """
+    NODE = 0x01
+    LINK = 0x02
+    EXECUTE = 0x03
+    REGISTER = 0x04
+    CONFIG = 0x05
+    FILE = 0x06
+    INTERFACE = 0x07
+    EVENT = 0x08
+    SESSION = 0x09
+    EXCEPTION = 0x0A
+
+
+class MessageFlags(Enum):
+    """
+    CORE message flags.
+    """
+    ADD = 0x01
+    DELETE = 0x02
+    CRI = 0x04
+    LOCAL = 0x08
+    STRING = 0x10
+    TEXT = 0x20
+    TTY = 0x40
+
+
+class NodeTlvs(Enum):
+    """
+    Node type, length, value enumerations.
+    """
+    NUMBER = 0x01
+    TYPE = 0x02
+    NAME = 0x03
+    IP_ADDRESS = 0x04
+    MAC_ADDRESS = 0x05
+    IP6_ADDRESS = 0x06
+    MODEL = 0x07
+    EMULATION_SERVER = 0x08
+    SESSION = 0x0A
+    X_POSITION = 0x20
+    Y_POSITION = 0x21
+    CANVAS = 0x22
+    EMULATION_ID = 0x23
+    NETWORK_ID = 0x24
+    SERVICES = 0x25
+    LATITUDE = 0x30
+    LONGITUDE = 0x31
+    ALTITUDE = 0x32
+    ICON = 0x42
+    OPAQUE = 0x50
+
+
+class NodeTypes(Enum):
+    """
+    Node types.
+    """
+    DEFAULT = 0
+    PHYSICAL = 1
+    TBD = 3
+    SWITCH = 4
+    HUB = 5
+    WIRELESS_LAN = 6
+    RJ45 = 7
+    TUNNEL = 8
+    KTUNNEL = 9
+    EMANE = 10
+    TAP_BRIDGE = 11
+    PEER_TO_PEER = 12
+    CONTROL_NET = 13
+    EMANE_NET = 14
+
+
+class Rj45Models(Enum):
+    """
+    RJ45 model types.
+    """
+    LINKED = 0
+    WIRELESS = 1
+    INSTALLED = 2
+
+
+# Link Message TLV Types
+class LinkTlvs(Enum):
+    """
+    Link type, length, value enumerations.
+    """
+    N1_NUMBER = 0x01
+    N2_NUMBER = 0x02
+    DELAY = 0x03
+    BANDWIDTH = 0x04
+    PER = 0x05
+    DUP = 0x06
+    JITTER = 0x07
+    MER = 0x08
+    BURST = 0x09
+    SESSION = 0x0A
+    MBURST = 0x10
+    TYPE = 0x20
+    GUI_ATTRIBUTES = 0x21
+    UNIDIRECTIONAL = 0x22
+    EMULATION_ID = 0x23
+    NETWORK_ID = 0x24
+    KEY = 0x25
+    INTERFACE1_NUMBER = 0x30
+    INTERFACE1_IP4 = 0x31
+    INTERFACE1_IP4_MASK = 0x32
+    INTERFACE1_MAC = 0x33
+    INTERFACE1_IP6 = 0x34
+    INTERFACE1_IP6_MASK = 0x35
+    INTERFACE2_NUMBER = 0x36
+    INTERFACE2_IP4 = 0x37
+    INTERFACE2_IP4_MASK = 0x38
+    INTERFACE2_MAC = 0x39
+    INTERFACE2_IP6 = 0x40
+    INTERFACE2_IP6_MASK = 0x41
+    INTERFACE1_NAME = 0x42
+    INTERFACE2_NAME = 0x43
+    OPAQUE = 0x50
+
+
+class LinkTypes(Enum):
+    """
+    Link types.
+    """
+    WIRELESS = 0
+    WIRED = 1
+
+
+class ExecuteTlvs(Enum):
+    """
+    Execute type, length, value enumerations.
+    """
+    NODE = 0x01
+    NUMBER = 0x02
+    TIME = 0x03
+    COMMAND = 0x04
+    RESULT = 0x05
+    STATUS = 0x06
+    SESSION = 0x0A
+
+
+class RegisterTlvs(Enum):
+    """
+    Register type, length, value enumerations.
+    """
+    WIRELESS = 0x01
+    MOBILITY = 0x02
+    UTILITY = 0x03
+    EXECUTE_SERVER = 0x04
+    GUI = 0x05
+    EMULATION_SERVER = 0x06
+    SESSION = 0x0A
+
+
+class ConfigTlvs(Enum):
+    """
+    Configuration type, length, value enumerations.
+    """
+    NODE = 0x01
+    OBJECT = 0x02
+    TYPE = 0x03
+    DATA_TYPES = 0x04
+    VALUES = 0x05
+    CAPTIONS = 0x06
+    BITMAP = 0x07
+    POSSIBLE_VALUES = 0x08
+    GROUPS = 0x09
+    SESSION = 0x0A
+    INTERFACE_NUMBER = 0x0B
+    NETWORK_ID = 0x24
+    OPAQUE = 0x50
+
+
+class ConfigFlags(Enum):
+    """
+    Configuration flags.
+    """
+    NONE = 0x00
+    REQUEST = 0x01
+    UPDATE = 0x02
+    RESET = 0x03
+
+
+class ConfigDataTypes(Enum):
+    """
+    Configuration data types.
+    """
+    UINT8 = 0x01
+    UINT16 = 0x02
+    UINT32 = 0x03
+    UINT64 = 0x04
+    INT8 = 0x05
+    INT16 = 0x06
+    INT32 = 0x07
+    INT64 = 0x08
+    FLOAT = 0x09
+    STRING = 0x0A
+    BOOL = 0x0B
+
+
+class FileTlvs(Enum):
+    """
+    File type, length, value enumerations.
+    """
+    NODE = 0x01
+    NAME = 0x02
+    MODE = 0x03
+    NUMBER = 0x04
+    TYPE = 0x05
+    SOURCE_NAME = 0x06
+    SESSION = 0x0A
+    DATA = 0x10
+    COMPRESSED_DATA = 0x11
+
+
+class InterfaceTlvs(Enum):
+    """
+    Interface type, length, value enumerations.
+    """
+    NODE = 0x01
+    NUMBER = 0x02
+    NAME = 0x03
+    IP_ADDRESS = 0x04
+    MASK = 0x05
+    MAC_ADDRESS = 0x06
+    IP6_ADDRESS = 0x07
+    IP6_MASK = 0x08
+    TYPE = 0x09
+    SESSION = 0x0A
+    STATE = 0x0B
+    EMULATION_ID = 0x23
+    NETWORK_ID = 0x24
+
+
+class EventTlvs(Enum):
+    """
+    Event type, length, value enumerations.
+    """
+    NODE = 0x01
+    TYPE = 0x02
+    NAME = 0x03
+    DATA = 0x04
+    TIME = 0x05
+    SESSION = 0x0A
+
+
+class EventTypes(Enum):
+    """
+    Event types.
+    """
+    NONE = 0
+    DEFINITION_STATE = 1
+    CONFIGURATION_STATE = 2
+    INSTANTIATION_STATE = 3
+    RUNTIME_STATE = 4
+    DATACOLLECT_STATE = 5
+    SHUTDOWN_STATE = 6
+    START = 7
+    STOP = 8
+    PAUSE = 9
+    RESTART = 10
+    FILE_OPEN = 11
+    FILE_SAVE = 12
+    SCHEDULED = 13
+    RECONFIGURE = 14
+    INSTANTIATION_COMPLETE = 15
+
+
+class SessionTlvs(Enum):
+    """
+    Session type, length, value enumerations.
+    """
+    NUMBER = 0x01
+    NAME = 0x02
+    FILE = 0x03
+    NODE_COUNT = 0x04
+    DATE = 0x05
+    THUMB = 0x06
+    USER = 0x07
+    OPAQUE = 0x0A
+
+
+class ExceptionTlvs(Enum):
+    """
+    Exception type, length, value enumerations.
+    """
+    NODE = 0x01
+    SESSION = 0x02
+    LEVEL = 0x03
+    SOURCE = 0x04
+    DATE = 0x05
+    TEXT = 0x06
+    OPAQUE = 0x0A
+
+
+class ExceptionLevels(Enum):
+    """
+    Exception levels.
+    """
+    NONE = 0
+    FATAL = 1
+    ERROR = 2
+    WARNING = 3
+    NOTICE = 4