removed another bunch of references to geni
[sfa.git] / sfa / rspecs / aggregates / vini / utils.py
index 8250e84..ea36aad 100644 (file)
@@ -1,7 +1,70 @@
 import re
 import socket
+from sfa.util.faults import *
 from sfa.rspecs.aggregates.vini.topology import *
 
+default_topo_xml = """
+            <LinkSpec>
+                <endpoint>i2atla1</endpoint>
+                <endpoint>i2chic1</endpoint>
+                <kbps>1000</kbps>
+            </LinkSpec>
+            <LinkSpec>
+                <endpoint>i2atla1</endpoint>
+                <endpoint>i2hous1</endpoint>
+                <kbps>1000</kbps>
+            </LinkSpec>
+            <LinkSpec>
+                <endpoint>i2atla1</endpoint>
+                <endpoint>i2wash1</endpoint>
+                <kbps>1000</kbps>
+            </LinkSpec>
+            <LinkSpec>
+                <endpoint>i2chic1</endpoint>
+                <endpoint>i2kans1</endpoint>
+                <kbps>1000</kbps>
+            </LinkSpec>
+            <LinkSpec>
+                <endpoint>i2chic1</endpoint>
+                <endpoint>i2wash1</endpoint>
+                <kbps>1000</kbps>
+            </LinkSpec>
+            <LinkSpec>
+                <endpoint>i2hous1</endpoint>
+                <endpoint>i2kans1</endpoint>
+                <kbps>1000</kbps>
+            </LinkSpec>
+            <LinkSpec>
+                <endpoint>i2hous1</endpoint>
+                <endpoint>i2losa1</endpoint>
+                <kbps>1000</kbps>
+            </LinkSpec>
+            <LinkSpec>
+                <endpoint>i2kans1</endpoint>
+                <endpoint>i2salt1</endpoint>
+                <kbps>1000</kbps>
+            </LinkSpec>
+            <LinkSpec>
+                <endpoint>i2losa1</endpoint>
+                <endpoint>i2salt1</endpoint>
+                <kbps>1000</kbps>
+            </LinkSpec>
+            <LinkSpec>
+                <endpoint>i2losa1</endpoint>
+                <endpoint>i2seat1</endpoint>
+                <kbps>1000</kbps>
+            </LinkSpec>
+            <LinkSpec>
+                <endpoint>i2newy1</endpoint>
+                <endpoint>i2wash1</endpoint>
+                <kbps>1000</kbps>
+            </LinkSpec>
+            <LinkSpec>
+                <endpoint>i2salt1</endpoint>
+                <endpoint>i2seat1</endpoint>
+                <kbps>1000</kbps>
+            </LinkSpec>"""
+      
 # Taken from bwlimit.py
 #
 # See tc_util.c and http://physics.nist.gov/cuu/Units/binary.html. Be
@@ -48,15 +111,30 @@ def get_tc_rate(s):
     else:
         return -1
 
+def format_tc_rate(rate):
+    """
+    Formats a bits/second rate into a tc rate string
+    """
+
+    if rate >= 1000000000 and (rate % 1000000000) == 0:
+        return "%.0fgbit" % (rate / 1000000000.)
+    elif rate >= 1000000 and (rate % 1000000) == 0:
+        return "%.0fmbit" % (rate / 1000000.)
+    elif rate >= 1000:
+        return "%.0fkbit" % (rate / 1000.)
+    else:
+        return "%.0fbit" % rate
+
 
 class Node:
-    def __init__(self, node):
+    def __init__(self, node, bps = 1000 * 1000000):
         self.id = node['node_id']
         self.hostname = node['hostname']
         self.shortname = self.hostname.replace('.vini-veritas.net', '')
         self.site_id = node['site_id']
         self.ipaddr = socket.gethostbyname(self.hostname)
-        self.links = []
+        self.bps = bps
+        self.links = set()
 
     def get_link_id(self, remote):
         if self.id < remote.id:
@@ -88,15 +166,22 @@ class Node:
     def get_site(self, sites):
         return sites[self.site_id]
     
-    def init_links(self):
-        self.links = []
-        
-    def add_link(self, remote, bw):
+    def get_topo_rspec(self, link):
+        if link.end1 == self:
+            remote = link.end2
+        elif link.end2 == self:
+            remote = link.end1
+        else:
+            raise Error("Link does not connect to Node")
+            
         my_ip = self.get_virt_ip(remote)
         remote_ip = remote.get_virt_ip(self)
         net = self.get_virt_net(remote)
-        link = remote.id, remote.ipaddr, bw, my_ip, remote_ip, net
-        self.links.append(link)
+        bw = format_tc_rate(link.bps)
+        return (remote.id, remote.ipaddr, bw, my_ip, remote_ip, net)
+        
+    def add_link(self, link):
+        self.links.add(link)
         
     def add_tag(self, sites):
         s = self.get_site(sites)
@@ -106,27 +191,36 @@ class Node:
             self.tag = s.tag + index
         else:
             self.tag = None
-        
 
-class SiteLink:
-    def __init__(self, site1, site2, mbps = 1000):
-        self.site1 = site1
-        self.site2 = site2
-        self.totalMbps = mbps
-        self.availMbps = mbps
+    # Assumes there is at most one Link between two sites
+    def get_sitelink(self, node, sites):
+        site1 = sites[self.site_id]
+        site2 = sites[node.site_id]
+        sl = site1.links.intersection(site2.links)
+        if len(sl):
+            return sl.pop()
+        return None
+    
+
+class Link:
+    def __init__(self, end1, end2, bps = 1000 * 1000000):
+        self.end1 = end1
+        self.end2 = end2
+        self.bps = bps
         
-        site1.add_sitelink(self)
-        site2.add_sitelink(self)
+        end1.add_link(self)
+        end2.add_link(self)
         
         
 class Site:
     def __init__(self, site):
         self.id = site['site_id']
         self.node_ids = site['node_ids']
-        self.name = site['abbreviated_name']
+        self.name = site['abbreviated_name'].replace(" ", "_")
         self.tag = site['login_base']
         self.public = site['is_public']
-        self.sitelinks = []
+        self.enabled = site['enabled']
+        self.links = set()
 
     def get_sitenodes(self, nodes):
         n = []
@@ -134,8 +228,8 @@ class Site:
             n.append(nodes[i])
         return n
     
-    def add_sitelink(self, link):
-        self.sitelinks.append(link)
+    def add_link(self, link):
+        self.links.add(link)
     
     
 class Slice:
@@ -287,6 +381,251 @@ class Slicetag:
             api.plshell.DeleteSliceTag(api.plauth, self.id)
 
 
+"""
+A topology is a compound object consisting of:
+* a dictionary mapping site IDs to Site objects
+* a dictionary mapping node IDs to Node objects
+* the Site objects are connected via SiteLink objects representing
+  the physical topology and available bandwidth
+* the Node objects are connected via Link objects representing
+  the requested or assigned virtual topology of a slice
+"""
+class Topology:
+    def __init__(self, api):
+        self.api = api
+        self.sites = get_sites(api)
+        self.nodes = get_nodes(api)
+        self.tags = get_slice_tags(api)
+        self.sitelinks = []
+        self.nodelinks = []
+    
+        for (s1, s2) in PhysicalLinks:
+            self.sitelinks.append(Link(self.sites[s1], self.sites[s2]))
+        
+        for id in self.nodes:
+            self.nodes[id].add_tag(self.sites)
+        
+        for t in self.tags:
+            tag = self.tags[t]
+            if tag.tagname == 'topo_rspec':
+                node1 = self.nodes[tag.node_id]
+                l = eval(tag.value)
+                for (id, realip, bw, lvip, rvip, vnet) in l:
+                    allocbps = get_tc_rate(bw)
+                    node1.bps -= allocbps
+                    try:
+                        node2 = self.nodes[id]
+                        if node1.id < node2.id:
+                            sl = node1.get_sitelink(node2, self.sites)
+                            sl.bps -= allocbps
+                    except:
+                        pass
+
+    
+    def lookupSite(self, id):
+        val = None
+        try:
+            val = self.sites[id]
+        except:
+            raise KeyError("site ID %s not found" % id)
+        return val
+    
+    def getSites(self):
+        sites = []
+        for s in self.sites:
+            sites.append(self.sites[s])
+        return sites
+        
+    def lookupNode(self, id):
+        val = None
+        try:
+            val = self.nodes[id]
+        except:
+            raise KeyError("node ID %s not found" % id)
+        return val
+    
+    def getNodes(self):
+        nodes = []
+        for n in self.nodes:
+            nodes.append(self.nodes[n])
+        return nodes
+    
+    def nodesInTopo(self):
+        nodes = []
+        for n in self.nodes:
+            if self.nodes[n].links:
+                nodes.append(self.nodes[n])
+        return nodes
+            
+    def lookupSliceTag(self, id):
+        val = None
+        try:
+            val = self.tags[id]
+        except:
+            raise KeyError("slicetag ID %s not found" % id)
+        return val
+    
+    def getSliceTags(self):
+        tags = []
+        for t in self.tags:
+            tags.append(self.tags[t])
+        return tags
+    
+    def lookupSiteLink(self, node1, node2):
+        site1 = self.sites[node1.site_id]
+        site2 = self.sites[node2.site_id]
+        for link in self.sitelinks:
+            if site1 == link.end1 and site2 == link.end2:
+                return link
+            if site2 == link.end1 and site1 == link.end2:
+                return link
+        return None
+    
+    def nodeTopoFromRSpec(self, rspec):
+        if self.nodelinks:
+            raise Error("virtual topology already present")
+            
+        rspecdict = rspec.toDict()
+        nodedict = {}
+        for node in self.getNodes():
+            nodedict[node.tag] = node
+            
+        linkspecs = rspecdict['RSpec']['Request'][0]['NetSpec'][0]['LinkSpec']    
+        for l in linkspecs:
+            n1 = nodedict[l['endpoint'][0]]
+            n2 = nodedict[l['endpoint'][1]]
+            bps = int(l['kbps'][0]) * 1000
+            self.nodelinks.append(Link(n1, n2, bps))
+    def nodeTopoFromSliceTags(self, slice):
+        if self.nodelinks:
+            raise Error("virtual topology already present")
+            
+        for node in slice.get_nodes(self.nodes):
+            linktag = slice.get_tag('topo_rspec', self.tags, node)
+            if linktag:
+                l = eval(linktag.value)
+                for (id, realip, bw, lvip, rvip, vnet) in l:
+                    if node.id < id:
+                        bps = get_tc_rate(bw)
+                        remote = self.lookupNode(id)
+                        self.nodelinks.append(Link(node, remote, bps))
+
+    def updateSliceTags(self, slice):
+        if not self.nodelinks:
+            return
+        slice.update_tag('vini_topo', 'manual', self.tags)
+        slice.assign_egre_key(self.tags)
+        slice.turn_on_netns(self.tags)
+        slice.add_cap_net_admin(self.tags)
+
+        for node in slice.get_nodes(self.nodes):
+            linkdesc = []
+            for link in node.links:
+                linkdesc.append(node.get_topo_rspec(link))
+            if linkdesc:
+                topo_str = "%s" % linkdesc
+                slice.update_tag('topo_rspec', topo_str, self.tags, node)
+
+        # Update slice tags in database
+        for tag in self.getSliceTags():
+            if tag.slice_id == slice.id:
+                if tag.tagname == 'topo_rspec' and not tag.updated:
+                    tag.delete()
+                tag.write(self.api)
+                
+    """
+    Check the requested topology against the available topology and capacity
+    """
+    def verifyNodeTopo(self, hrn, topo, maxbw):
+        maxbps = get_tc_rate(maxbw)
+        for link in self.nodelinks:
+            if link.bps <= 0:
+                raise SfaInvalidArgument(bw, "BW")
+            if link.bps > maxbps:
+                raise PermissionError(" %s requested %s but max BW is %s" % 
+                                      (hrn, format_tc_rate(link.bps), maxbw))
+                
+            n1 = link.end1
+            n2 = link.end2
+            sitelink = self.lookupSiteLink(n1, n2)
+            if not sitelink:
+                raise PermissionError("%s: nodes %s and %s not adjacent" % (hrn, n1.tag, n2.tag))
+            if sitelink.bps < link.bps:
+                raise PermissionError("%s: insufficient capacity between %s and %s" % (hrn, n1.tag, n2.tag))
+                
+    """
+    Produce XML directly from the topology specification.
+    """
+    def toxml(self, hrn = None):
+        xml = """<?xml version="1.0"?>
+<RSpec name="vini">
+    <Capacity>
+        <NetSpec name="physical_topology">"""
+
+        for site in self.getSites():
+            if not (site.public and site.enabled and site.node_ids):
+                continue
+            
+            xml += """
+            <SiteSpec name="%s"> """ % site.name
+
+            for node in site.get_sitenodes(self.nodes):
+                if not node.tag:
+                    continue
+                
+                xml += """
+                <NodeSpec name="%s">
+                    <hostname>%s</hostname>
+                    <kbps>%s</kbps>
+                </NodeSpec>""" % (node.tag, node.hostname, int(node.bps/1000))
+            xml += """
+            </SiteSpec>"""
+            
+        for link in self.sitelinks:
+            xml += """
+            <SiteLinkSpec>
+                <endpoint>%s</endpoint>
+                <endpoint>%s</endpoint> 
+                <kbps>%s</kbps>
+            </SiteLinkSpec>""" % (link.end1.name, link.end2.name, int(link.bps/1000))
+            
+        
+        if hrn:
+            name = hrn
+        else:
+            name = 'default_topology'
+        xml += """
+        </NetSpec>
+    </Capacity>
+    <Request>
+        <NetSpec name="%s">""" % name
+        
+        if hrn:
+            for link in self.nodelinks:
+                xml += """
+            <LinkSpec>
+                <endpoint>%s</endpoint>
+                <endpoint>%s</endpoint> 
+                <kbps>%s</kbps>
+            </LinkSpec>""" % (link.end1.tag, link.end2.tag, int(link.bps/1000))
+        else:
+            xml += default_topo_xml
+            
+        xml += """
+        </NetSpec>
+    </Request>
+</RSpec>"""
+
+        # Remove all leading whitespace and newlines
+        lines = xml.split("\n")
+        noblanks = ""
+        for line in lines:
+            noblanks += line.strip()
+        return noblanks
+
+
 """
 Create a dictionary of site objects keyed by site ID
 """
@@ -347,23 +686,3 @@ def free_egre_key(slicetags):
         
     return "%s" % key
    
-"""
-Return the network topology.
-The topology consists of:
-* a dictionary mapping site IDs to Site objects
-* a dictionary mapping node IDs to Node objects
-* the Site objects are connected via SiteLink objects representing
-  the physical topology and available bandwidth
-"""
-def get_topology(api):
-    sites = get_sites(api)
-    nodes = get_nodes(api)
-    tags = get_slice_tags(api)
-    
-    for (s1, s2) in PhysicalLinks:
-        SiteLink(sites[s1], sites[s2])
-
-    for id in nodes:
-        nodes[id].add_tag(sites)
-        
-    return (sites, nodes, tags)