some refactoring. added mappings of legacy node types to Node and Device types and emulation types

This commit is contained in:
Rod A Santiago 2016-08-19 15:29:07 -07:00
parent 71c2dcf0af
commit 1a249fe1ec

View file

@ -13,9 +13,47 @@ import threading, traceback, sys
from core.api import coreapi, corewrapper, coreapi2 from core.api import coreapi, corewrapper, coreapi2
from core.experiments import ExperimentStore from core.experiments import ExperimentStore
# Aliases
wrapper = corewrapper wrapper = corewrapper
legacy = coreapi legacy = coreapi
# Legacy node types that are Devices in API2
deviceTypesSet = set([
coreapi.CORE_NODE_SWITCH,
coreapi.CORE_NODE_HUB,
coreapi.CORE_NODE_WLAN,
coreapi.CORE_NODE_RJ45,
coreapi.CORE_NODE_TUNNEL,
coreapi.CORE_NODE_KTUNNEL,
coreapi.CORE_NODE_EMANE])
# Legacy node types that are Devices in API2
nodeTypesSet = set([
coreapi.CORE_NODE_DEF,
coreapi.CORE_NODE_XEN])
# Legacy node types to API2 device type field mapping
devtypeDict = {
coreapi.CORE_NODE_SWITCH: coreapi2.Device.SWITCH,
coreapi.CORE_NODE_HUB: coreapi2.Device.HUB,
coreapi.CORE_NODE_WLAN: coreapi2.Device.WLAN,
coreapi.CORE_NODE_RJ45: coreapi2.Device.RJ45,
coreapi.CORE_NODE_TUNNEL: coreapi2.Device.TUNNEL,
coreapi.CORE_NODE_KTUNNEL: coreapi2.Device.KTUNNEL
}
# Legacy node types to API2 emulator field mapping
emulationDict = {
coreapi.CORE_NODE_DEF: coreapi2.Node.DEFAULT,
coreapi.CORE_NODE_XEN: coreapi2.Node.XEN,
coreapi.CORE_NODE_EMANE: coreapi2.Device.EMANE
}
class CoreApiBridge(object): class CoreApiBridge(object):
def __init__(self, handler): def __init__(self, handler):
@ -32,6 +70,17 @@ class CoreApiBridge(object):
# Reference to the owning handler in the core-daemon # Reference to the owning handler in the core-daemon
self.handler = handler self.handler = handler
def info(self, msg):
''' Utility method for writing output to stdout.
'''
print msg
sys.stdout.flush()
def warn(self, msg):
''' Utility method for writing output to stderr.
'''
print >> sys.stderr, msg
sys.stderr.flush()
def recvmsg(self): def recvmsg(self):
''' Receive data, parse a CoreMessage and queue it onto an existing ''' Receive data, parse a CoreMessage and queue it onto an existing
@ -53,9 +102,10 @@ class CoreApiBridge(object):
# send to API2 client # send to API2 client
self.handler.request.sendall(reply) self.handler.request.sendall(reply)
except Exception, e: except Exception, e:
print "-"*60 if self.handler.debug:
traceback.print_exc(file=sys.stdout) self.info("-"*60)
print "-"*60 traceback.print_exc(file=sys.stdout)
self.info("-"*60)
raise e raise e
@ -70,9 +120,10 @@ class CoreApiBridge(object):
for msg in msgs: for msg in msgs:
self.handler.request.sendall(msg) self.handler.request.sendall(msg)
except Exception, e: except Exception, e:
print "-"*60 if self.handler.debug:
traceback.print_exc(file=sys.stdout) self.info("-"*60)
print "-"*60 traceback.print_exc(file=sys.stdout)
self.info("-"*60)
raise e raise e
@ -84,7 +135,7 @@ class CoreApiBridge(object):
message.ParseFromString(data) message.ParseFromString(data)
if message.HasField('session'): if message.HasField('session'):
return self.processApi2SessionMsg(message.session, return self.processApi2SessionMsg(message.session,
message.purpose) message.purpose)
if message.HasField('experiment'): if message.HasField('experiment'):
return self.processApi2ExperimentMsg(message.experiment, return self.processApi2ExperimentMsg(message.experiment,
message.purpose) message.purpose)
@ -92,166 +143,270 @@ class CoreApiBridge(object):
return self.processApi2Event(message.event, return self.processApi2Event(message.event,
message.purpose) message.purpose)
def processLegacyCoreMessage(self, messages): def processLegacyCoreMessage(self, messages):
api2msgs = [] api2msgs = []
for msgstr in messages: for msgstr in messages:
# Unpack the message # Unpack the message
parser = wrapper.CoreMessageParser(msgstr) parser = wrapper.CoreMessageParser(msgstr)
if parser.getType() == legacy.CORE_API_REG_MSG: if parser.getType() == legacy.CORE_API_REG_MSG:
regMsg = parser.createWrapper() self.processLegacyRegMsg(parser.createWrapper(), api2msgs)
'''
print "RegisterMessage"
print "\twireless=", regMsg.getWireless()
print "\tmobility=", regMsg.getMobility()
print "\tutility=", regMsg.getUtility()
print "\texec=", regMsg.getExecsrv()
print "\tgui=", regMsg.getGui()
print "\temul=", regMsg.getEmulsrv()
print "\tsess=", regMsg.getSession()
'''
elif parser.getType() == legacy.CORE_API_SESS_MSG: elif parser.getType() == legacy.CORE_API_SESS_MSG:
sessMsg = parser.createWrapper() self.processLegacySessionMsg(parser.createWrapper(), api2msgs)
'''
print "SessionMessage"
print "\tnumber=", sessMsg.getNumber()
print "\tname=", sessMsg.getName()
print "\tfile=", sessMsg.getFile()
print "\tnodecount=", sessMsg.getNodecount()
print "\tdate=", sessMsg.getDate()
print "\tthumb=", sessMsg.getThumb()
print "\tuser=", sessMsg.getUser()
print "\topaque=", sessMsg.getOpaque()
'''
sessions = sessMsg.getNumber().split("|")
port_num = int(sessions[0])
newMsg = coreapi2.CoreMessage()
newMsg.session.clientId = 'client' + sessions[0]
newMsg.session.port_num = port_num
# List active experiments in the server
for sid in sessions:
sid = int(sid)
if sid == 0:
continue
session = self.handler.session.server.getsession(sessionid=sid, useexisting=True)
if session is None:
print "Invalid session ID received from daemon"
continue
if session == self.handler.session:
continue
expId = session.metadata.getitem('experimentId')
if expId:
newMsg.session.all_exps.append(expId)
else:
newMsg.session.all_exps.append('_%s' % (str(sid)))
newMsg.purpose = coreapi2.ADD
api2msgs.append(coreapi2.pack(newMsg))
elif parser.getType() == legacy.CORE_API_EVENT_MSG: elif parser.getType() == legacy.CORE_API_EVENT_MSG:
event = parser.createWrapper() self.processLegacyEventMsg(parser.createWrapper(), api2msgs)
'''
print "Event:"
print "\tnode=", event.getNode()
print "\ttype=", event.getType()
print "\tname=", event.getName()
print "\tdata=", event.getData()
print "\ttime=", event.getTime()
print "\tsessions=", event.getSession()
'''
if event.getType() == legacy.CORE_EVENT_RUNTIME_STATE:
newMsg = coreapi2.CoreMessage()
newMsg.purpose = coreapi2.STATE_CHANGE
newMsg.event.state = coreapi2.RUNTIME
api2msgs.append(coreapi2.pack(newMsg))
with self.lock:
if self.collector:
self.collector.experiment.running = True
self.collector.purpose = coreapi2.MODIFY
else:
raise RuntimeError, "runtime entered without an instantiated experiment"
api2msgs.append(coreapi2.pack(self.collector))
self.collector = None
elif parser.getType() == legacy.CORE_API_NODE_MSG: elif parser.getType() == legacy.CORE_API_NODE_MSG:
node = parser.createWrapper() self.processLegacyNodeMsg(parser.createWrapper(), api2msgs)
print "Node:"
print "\tnumber=", node.getNumber()
print "\ttype=", node.getType()
print "\tname=", node.getName()
print "\tipaddr=", node.getIpaddr()
print "\tmacaddr=", node.getMacaddr()
print "\tip6addr=", node.getIp6addr()
print "\tmodel=", node.getModel()
print "\temusrv=", node.getEmusrv()
print "\tsession=", node.getSession()
print "\txpos=", node.getXpos()
print "\typos=", node.getYpos()
print "\tcanvas=", node.getCanvas()
print "\temuid=", node.getEmuid()
print "\tnetid=", node.getNetid()
print "\tservices=", node.getServices()
print "\tlat=", node.getLat()
print "\tlon=", node.getLong()
print "\talt=", node.getAlt()
print "\ticon=", node.getIcon()
print "\topaque=", node.getOpaque()
'''
if handler.session.getstate() == legacy.CORE_EVENT_INSTANTIATION_STATE:
'''
api2_node=None
api2_dev=None
with self.lock:
if self.assocExperiment:
nodeOrDev = None
newMsg = None
if not self.collector:
newMsg = coreapi2.CoreMessage()
if coreapi2.findNodeByIdx(self.assocExperiment, node.getNumber()):
if self.collector:
nodeOrDev = coreapi2.getNodeByIdx(self.collector.experiment, node.getNumber())
else:
nodeOrDev = newMsg.node
elif coreapi2.findDeviceByIdx(self.assocExperiment, node.getNumber()):
if self.collector:
nodeOrDev = coreapi2.getDeviceByIdx(self.collector.experiment, node.getNumber())
else:
nodeOrDev = newMsg.device
if nodeOrDev:
nodeOrDev.idx = node.getNumber()
if node.getEmuid() is not None: nodeOrDev.emu_id=node.getEmuid()
if node.getName() is not None: nodeOrDev.name=node.getName()
if node.getXpos() is not None: nodeOrDev.location.x_pos=node.getXpos()
if node.getYpos() is not None: nodeOrDev.location.y_pos=node.getYpos()
if newMsg:
newMsg.purpose = coreapi2.MODIFY
api2msgs.append(coreapi2.pack(newMsg))
else:
print "Received update for unknown node or device", node.getNumber()
else:
print "Received update for node or device without an associated experiment", node.getNumber()
else: else:
print "received message type", parser.getType() self.warn("received message type %s" % (parser.getType()))
return api2msgs return api2msgs
def processLegacyRegMsg(self, regMsg, api2msgs):
'''
Intercept an outgoing register message from the CORE daemon and generate
equivalent API2 message to send to the client
'''
'''
print "RegisterMessage"
print "\twireless=", regMsg.getWireless()
print "\tmobility=", regMsg.getMobility()
print "\tutility=", regMsg.getUtility()
print "\texec=", regMsg.getExecsrv()
print "\tgui=", regMsg.getGui()
print "\temul=", regMsg.getEmulsrv()
print "\tsess=", regMsg.getSession()
'''
pass
def processLegacySessionMsg(self, sessMsg, api2msgs):
'''
Intercept an outgoing session message from the CORE daemon and generate the equivalent
API2 messages to send to the client
'''
'''
print "SessionMessage"
print "\tnumber=", sessMsg.getNumber()
print "\tname=", sessMsg.getName()
print "\tfile=", sessMsg.getFile()
print "\tnodecount=", sessMsg.getNodecount()
print "\tdate=", sessMsg.getDate()
print "\tthumb=", sessMsg.getThumb()
print "\tuser=", sessMsg.getUser()
print "\topaque=", sessMsg.getOpaque()
'''
sessions = sessMsg.getNumber().split("|")
port_num = int(sessions[0])
newMsg = coreapi2.CoreMessage()
newMsg.session.clientId = 'client' + sessions[0]
newMsg.session.port_num = port_num
# List active experiments in the server
for sid in sessions:
sid = int(sid)
if sid == 0:
continue
session = self.handler.session.server.getsession(sessionid=sid, useexisting=True)
if session is None:
self.warn("Invalid session ID received from daemon")
continue
if session == self.handler.session:
continue
expId = session.metadata.getitem('experimentId')
if expId:
newMsg.session.all_exps.append(expId)
else:
newMsg.session.all_exps.append('_%s' % (str(sid)))
newMsg.purpose = coreapi2.ADD
api2msgs.append(coreapi2.pack(newMsg))
def processLegacyEventMsg(self, event, api2msgs):
'''
Intercept an outgoing event generated by the CORE daemon and generate the equivalent
API2 messages to send to the client
'''
'''
print "Event:"
print "\tnode=", event.getNode()
print "\ttype=", event.getType()
print "\tname=", event.getName()
print "\tdata=", event.getData()
print "\ttime=", event.getTime()
print "\tsessions=", event.getSession()
'''
if event.getType() == legacy.CORE_EVENT_RUNTIME_STATE:
newMsg = coreapi2.CoreMessage()
newMsg.purpose = coreapi2.STATE_CHANGE
newMsg.event.state = coreapi2.RUNTIME
api2msgs.append(coreapi2.pack(newMsg))
with self.lock:
if self.collector:
self.collector.experiment.running = True
self.collector.purpose = coreapi2.MODIFY
else:
raise RuntimeError, "runtime entered without an instantiated experiment"
api2msgs.append(coreapi2.pack(self.collector))
self.collector = None
def processLegacyNodeMsg(self, nodeMsg, api2msgs):
'''
Intercept an outgoing legacy node message generated by the CORE daemon and generate the equivalent
API2 messages to send to the client
'''
print "Node:"
print "\tnumber=", nodeMsg.getNumber()
print "\ttype=", nodeMsg.getType()
print "\tname=", nodeMsg.getName()
print "\tipaddr=", nodeMsg.getIpaddr()
print "\tmacaddr=", nodeMsg.getMacaddr()
print "\tip6addr=", nodeMsg.getIp6addr()
print "\tmodel=", nodeMsg.getModel()
print "\temusrv=", nodeMsg.getEmusrv()
print "\tsession=", nodeMsg.getSession()
print "\txpos=", nodeMsg.getXpos()
print "\typos=", nodeMsg.getYpos()
print "\tcanvas=", nodeMsg.getCanvas()
print "\temuid=", nodeMsg.getEmuid()
print "\tnetid=", nodeMsg.getNetid()
print "\tservices=", nodeMsg.getServices()
print "\tlat=", nodeMsg.getLat()
print "\tlon=", nodeMsg.getLong()
print "\talt=", nodeMsg.getAlt()
print "\ticon=", nodeMsg.getIcon()
print "\topaque=", nodeMsg.getOpaque()
api2_node=None
api2_dev=None
with self.lock:
#if self.assocExperiment:
nodeOrDev = None
newMsg = None
if not self.collector:
newMsg = coreapi2.CoreMessage()
# The legacy API uses a Node message to convey everything from hubs to hosts. But it does
# always have type information in it.
# Check if the legacy message updates an existing API2 node or a device
isNode = self.assocExperiment and coreapi2.findNodeByIdx(self.assocExperiment,
nodeMsg.getNumber())
isDev = self.assocExperiment and coreapi2.findDeviceByIdx(self.assocExperiment,
nodeMsg.getNumber())
# If the node number in the message maps to a node or a device in the associated experiment,
# check if the message indicates a consistent type
if isNode and nodeMsg.getType() is not None and nodeMsg.getType() not in nodeTypesSet:
raise RuntimeError, "Inconsistent node types."
if isDev and nodeMsg.getType() is not None and nodeMsg.getType() not in deviceTypesSet:
raise RuntimeError, "Inconsistent device types."
if not isNode and not isDev and nodeMsg.getType() is not None:
isNode = isNode(nodeMsg.getType())
isDev = isDev(nodeMsg.getType())
# Add the node/device to either the experiment object in the collector for transmission as
# part of a API2 session/experiment, or to a new message for independent API2 Node or
# Device message transmission
if isNode:
# add or update an node
if self.collector:
nodeOrDev = coreapi2.getNodeByIdx(self.collector.experiment, nodeMsg.getNumber())
else:
nodeOrDev = newMsg.node
elif isDev:
# add or update a device
if self.collector:
nodeOrDev = coreapi2.getDeviceByIdx(self.collector.experiment, nodeMsg.getNumber())
else:
nodeOrDev = newMsg.device
else:
raise RuntimeError, "Unrecognized node number without type information"
if nodeOrDev:
nodeOrDev.idx = nodeMsg.getNumber()
if nodeMsg.getEmuid() is not None: nodeOrDev.emu_id=nodeMsg.getEmuid()
if nodeMsg.getName() is not None: nodeOrDev.name=nodeMsg.getName()
if nodeMsg.getXpos() is not None: nodeOrDev.location.x_pos=nodeMsg.getXpos()
if nodeMsg.getYpos() is not None: nodeOrDev.location.y_pos=nodeMsg.getYpos()
if nodeMsg.getIcon() is not None: nodeOrDev.icon=nodeMsg.getIcon()
if nodeMsg.getType() is not None:
try:
if isDev and devtypeDict.get(nodeMsg.getType()) is not None:
nodeOrDev.device_type = devtypeDict.get(nodeMsg.getType())
if emulationDict.get(nodeMsg.getType()) is not None:
nodeOrDev.emulation = emulationDict.get(nodeMsg.getType())
except e:
self.warn("Unmapped type in legacy node message")
# TODO: if nodeMsg.getCanvas() is not None: nodeOrDev.canvas=nodeMsg.getCanvas()
# TODO: association with networks
# TODO: services
if newMsg:
newMsg.purpose = coreapi2.MODIFY
api2msgs.append(coreapi2.pack(newMsg))
else:
self.warn("Received update for unknown node or device %d" % (nodeMsg.getNumber()))
def processApi2SessionMsg(self, message, purpose): def processApi2SessionMsg(self, message, purpose):
print 'Received session request message' if self.handler.debug:
self.info('Received session request message')
if purpose == coreapi2.ADD: if purpose == coreapi2.ADD:
legacymsgs = [] legacymsgs = []
legacymsgs.append(wrapper.RegMsg.instantiate(0, gui='true')) legacymsgs.append(wrapper.RegMsg.instantiate(0, gui='true'))
return legacymsgs return legacymsgs
# The response will be sent to the API2 client when a legacy session message is received from the daemon # The response will be sent to the API2 client when a legacy session message is received from the daemon
elif purpose == coreapi2.MODIFY: elif purpose == coreapi2.MODIFY:
pass legacymsgs = []
if message.HasField("experiment"):
exp = message.experiment
if exp.HasField("experimentId"):
expId = str(experiment.experimentId)
response = coreapi2.CoreMessage()
response.experiment.experimentId = exp.experimentId;
response.purpose = purpose
with self.lock:
self.assocExperiment = exp
self.collector = response
if expId.startswith('_'):
try:
legacySessNo = int(expId[1:])
legacymsgs.append(wrapper.RegMsg.instantiate(0, gui='true'))
legacymsgs.append(wrapper.SessionMsg.instantiate(0, legacySessNo))
except:
# TODO: get legacy session number from experimentId if running, or pass back
# non-running experiment components
pass
else:
# TODO: get legacy session number from experimentId if running, or pass back
# non-running experiment components
pass
else:
self.warn("session modify request without an experimentId")
else:
self.warn("session modify request without an experiment")
return legacymsgs
elif purpose == coreapi2.DELETE: elif purpose == coreapi2.DELETE:
# TODO: shutdown session # TODO: shutdown session
pass pass
else: else:
print 'Received invalid purpose for SESSION' self.warn('Received invalid purpose for SESSION')
def processApi2ExperimentMsg(self, exp, purpose): def processApi2ExperimentMsg(self, exp, purpose):
@ -290,11 +445,12 @@ class CoreApiBridge(object):
legacy.CORE_EVENT_DATACOLLECT_STATE)) legacy.CORE_EVENT_DATACOLLECT_STATE))
return msgs return msgs
else: else:
print "Unsupported experiment modification received" self.warn("Unsupported experiment modification received")
def translateApi2ExperimentMsg(self, message): def translateApi2ExperimentMsg(self, message):
print 'Received experiment message' if self.handler.debug:
self.info('Received experiment message')
msgs = [] msgs = []
# Flag need to be 0 otherwise CORE will not enter runtime state (per JavaAdaptor, need verification) # Flag need to be 0 otherwise CORE will not enter runtime state (per JavaAdaptor, need verification)
msgs.append(wrapper.SessionMsg.instantiate( msgs.append(wrapper.SessionMsg.instantiate(
@ -377,7 +533,8 @@ class CoreApiBridge(object):
def processApi2Event(self, event, purpose): def processApi2Event(self, event, purpose):
print 'Received event' if self.debug:
self.info('Received event')