From: Andy Bavier <acb@cs.princeton.edu>
Date: Wed, 12 Aug 2009 20:10:48 +0000 (+0000)
Subject: Moved helper functions to vini_utils.py
X-Git-Tag: sfa-0.9-1~91
X-Git-Url: http://git.onelab.eu/?a=commitdiff_plain;h=1d0a81a8dcacef8e38f20ca76c7e752498def654;p=sfa.git

Moved helper functions to vini_utils.py
---

diff --git a/sfa/rspecs/aggregates/rspec_manager_vini.py b/sfa/rspecs/aggregates/rspec_manager_vini.py
index 4229e017..d2d5e60d 100644
--- a/sfa/rspecs/aggregates/rspec_manager_vini.py
+++ b/sfa/rspecs/aggregates/rspec_manager_vini.py
@@ -3,347 +3,12 @@ from sfa.util.misc import *
 from sfa.util.rspec import Rspec
 from sfa.server.registry import Registries
 from sfa.plc.nodes import *
+from sfa.rspecs.aggregates.vini_utils import *
 import sys
-import socket
-import re
 
 SFA_VINI_DEFAULT_RSPEC = '/etc/sfa/vini.rspec'
 SFA_VINI_WHITELIST = '/etc/sfa/vini.whitelist'
 
-# Taken from bwlimit.py
-#
-# See tc_util.c and http://physics.nist.gov/cuu/Units/binary.html. Be
-# warned that older versions of tc interpret "kbps", "mbps", "mbit",
-# and "kbit" to mean (in this system) "kibps", "mibps", "mibit", and
-# "kibit" and that if an older version is installed, all rates will
-# be off by a small fraction.
-suffixes = {
-    "":         1,
-    "bit":	1,
-    "kibit":	1024,
-    "kbit":	1000,
-    "mibit":	1024*1024,
-    "mbit":	1000000,
-    "gibit":	1024*1024*1024,
-    "gbit":	1000000000,
-    "tibit":	1024*1024*1024*1024,
-    "tbit":	1000000000000,
-    "bps":	8,
-    "kibps":	8*1024,
-    "kbps":	8000,
-    "mibps":	8*1024*1024,
-    "mbps":	8000000,
-    "gibps":	8*1024*1024*1024,
-    "gbps":	8000000000,
-    "tibps":	8*1024*1024*1024*1024,
-    "tbps":	8000000000000
-}
-
-
-def get_tc_rate(s):
-    """
-    Parses an integer or a tc rate string (e.g., 1.5mbit) into bits/second
-    """
-
-    if type(s) == int:
-        return s
-    m = re.match(r"([0-9.]+)(\D*)", s)
-    if m is None:
-        return -1
-    suffix = m.group(2).lower()
-    if suffixes.has_key(suffix):
-        return int(float(m.group(1)) * suffixes[suffix])
-    else:
-        return -1
-
-
-class Node:
-    def __init__(self, node):
-        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 = []
-
-    def get_link_id(self, remote):
-        if self.id < remote.id:
-            link = (self.id<<7) + remote.id
-        else:
-            link = (remote.id<<7) + self.id
-        return link
-        
-    def get_iface_id(self, remote):
-        if self.id < remote.id:
-            iface = 1
-        else:
-            iface = 2
-        return iface
-    
-    def get_virt_ip(self, remote):
-        link = self.get_link_id(remote)
-        iface = self.get_iface_id(remote)
-        first = link >> 6
-        second = ((link & 0x3f)<<2) + iface
-        return "192.168.%d.%d" % (first, second)
-
-    def get_virt_net(self, remote):
-        link = self.get_link_id(remote)
-        first = link >> 6
-        second = (link & 0x3f)<<2
-        return "192.168.%d.%d/30" % (first, second)
-        
-    def get_site(self, sites):
-        return sites[self.site_id]
-            
-    def adjacent_nodes(self, sites, nodes, node_ids):
-        mysite = self.get_site(sites)
-        adj_ids = mysite.adj_node_ids.intersection(node_ids)
-        adj_nodes = []
-        for id in adj_ids:
-            adj_nodes.append(nodes[id])
-        return adj_nodes
-    
-    def init_links(self):
-        self.links = []
-        
-    def add_link(self, remote, bw):
-        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)
-
-        
-class Site:
-    def __init__(self, site):
-        self.id = site['site_id']
-        self.node_ids = site['node_ids']
-        self.adj_site_ids = set()
-        self.adj_node_ids = set()
-
-    def get_sitenodes(self, nodes):
-        n = []
-        for i in self.node_ids:
-            n.append(nodes[i])
-        return n
-    
-    def add_adjacency(self, site):
-        self.adj_site_ids.add(site.id)
-        for n in site.node_ids:
-            self.adj_node_ids.add(n)
-        
-    
-class Slice:
-    def __init__(self, slice):
-        self.id = slice['slice_id']
-        self.name = slice['name']
-        self.node_ids = set(slice['node_ids'])
-        self.slice_tag_ids = slice['slice_tag_ids']
-    
-    def get_tag(self, tagname, slicetags, node = None):
-        for i in self.slice_tag_ids:
-            tag = slicetags[i]
-            if tag.tagname == tagname:
-                if (not node) or (node.id == tag.node_id):
-                    return tag
-        else:
-            return None
-        
-    def get_nodes(self, nodes):
-        n = []
-        for id in self.node_ids:
-            n.append(nodes[id])
-        return n
-             
-    
-    # Add a new slice tag   
-    def add_tag(self, tagname, value, slicetags, node = None):
-        record = {'slice_tag_id':None, 'slice_id':self.id, 'tagname':tagname, 'value':value}
-        if node:
-            record['node_id'] = node.id
-        else:
-            record['node_id'] = None
-        tag = Slicetag(record)
-        slicetags[tag.id] = tag
-        self.slice_tag_ids.append(tag.id)
-        tag.changed = True       
-        tag.updated = True
-        return tag
-    
-    # Update a slice tag if it exists, else add it             
-    def update_tag(self, tagname, value, slicetags, node = None):
-        tag = self.get_tag(tagname, slicetags, node)
-        if tag and tag.value == value:
-            value = "no change"
-        elif tag:
-            tag.value = value
-            tag.changed = True
-        else:
-            tag = self.add_tag(tagname, value, slicetags, node)
-        tag.updated = True
-            
-    def assign_egre_key(self, slicetags):
-        if not self.get_tag('egre_key', slicetags):
-            try:
-                key = free_egre_key(slicetags)
-                self.update_tag('egre_key', key, slicetags)
-            except:
-                # Should handle this case...
-                pass
-        return
-            
-    def turn_on_netns(self, slicetags):
-        tag = self.get_tag('netns', slicetags)
-        if (not tag) or (tag.value != '1'):
-            self.update_tag('netns', '1', slicetags)
-        return
-   
-    def turn_off_netns(self, slicetags):
-        tag = self.get_tag('netns', slicetags)
-        if tag and (tag.value != '0'):
-            tag.delete()
-        return
-    
-    def add_cap_net_admin(self, slicetags):
-        tag = self.get_tag('capabilities', slicetags)
-        if tag:
-            caps = tag.value.split(',')
-            for cap in caps:
-                if cap == "CAP_NET_ADMIN":
-                    return
-            else:
-                newcaps = "CAP_NET_ADMIN," + tag.value
-                self.update_tag('capabilities', newcaps, slicetags)
-        else:
-            self.add_tag('capabilities', 'CAP_NET_ADMIN', slicetags)
-        return
-    
-    def remove_cap_net_admin(self, slicetags):
-        tag = self.get_tag('capabilities', slicetags)
-        if tag:
-            caps = tag.value.split(',')
-            newcaps = []
-            for cap in caps:
-                if cap != "CAP_NET_ADMIN":
-                    newcaps.append(cap)
-            if newcaps:
-                value = ','.join(newcaps)
-                self.update_tag('capabilities', value, slicetags)
-            else:
-                tag.delete()
-        return
-
-    # Update the vsys/setup-link and vsys/setup-nat slice tags.
-    def add_vsys_tags(self, slicetags):
-        link = nat = False
-        for i in self.slice_tag_ids:
-            tag = slicetags[i]
-            if tag.tagname == 'vsys':
-                if tag.value == 'setup-link':
-                    link = True
-                elif tag.value == 'setup-nat':
-                    nat = True
-        if not link:
-            self.add_tag('vsys', 'setup-link', slicetags)
-        if not nat:
-            self.add_tag('vsys', 'setup-nat', slicetags)
-        return
-
-
-class Slicetag:
-    newid = -1 
-    def __init__(self, tag):
-        self.id = tag['slice_tag_id']
-        if not self.id:
-            # Make one up for the time being...
-            self.id = Slicetag.newid
-            Slicetag.newid -= 1
-        self.slice_id = tag['slice_id']
-        self.tagname = tag['tagname']
-        self.value = tag['value']
-        self.node_id = tag['node_id']
-        self.updated = False
-        self.changed = False
-        self.deleted = False
-    
-    # Mark a tag as deleted
-    def delete(self):
-        self.deleted = True
-        self.updated = True
-    
-    def write(self, api):
-        if self.changed:
-            if int(self.id) > 0:
-                api.plshell.UpdateSliceTag(api.plauth, self.id, self.value)
-            else:
-                api.plshell.AddSliceTag(api.plauth, self.slice_id, 
-                                        self.tagname, self.value, self.node_id)
-        elif self.deleted and int(self.id) > 0:
-            api.plshell.DeleteSliceTag(api.plauth, self.id)
-
-
-"""
-Create a dictionary of site objects keyed by site ID
-"""
-def get_sites():
-    tmp = []
-    for site in GetSites():
-        t = site['site_id'], Site(site)
-        tmp.append(t)
-    return dict(tmp)
-
-
-"""
-Create a dictionary of node objects keyed by node ID
-"""
-def get_nodes(api):
-    tmp = []
-    for node in api.plshell.GetNodes(api.plauth):
-        t = node['node_id'], Node(node)
-        tmp.append(t)
-    return dict(tmp)
-
-"""
-Create a dictionary of slice objects keyed by slice ID
-"""
-def get_slice(api, slicename):
-    slice = api.plshell.GetSlices(api.plauth, [slicename])
-    if slice:
-        return Slice(slice[0])
-    else:
-        return None
-
-"""
-Create a dictionary of slicetag objects keyed by slice tag ID
-"""
-def get_slice_tags(api):
-    tmp = []
-    for tag in api.plshell.GetSliceTags(api.plauth):
-        t = tag['slice_tag_id'], Slicetag(tag)
-        tmp.append(t)
-    return dict(tmp)
-    
-"""
-Find a free EGRE key
-"""
-def free_egre_key(slicetags):
-    used = set()
-    for i in slicetags:
-        tag = slicetags[i]
-        if tag.tagname == 'egre_key':
-            used.add(int(tag.value))
-                
-    for i in range(1, 256):
-        if i not in used:
-            key = i
-            break
-    else:
-        raise KeyError("No more EGRE keys available")
-        
-    return "%s" % key
-   
-
 """
 Copied from create_slice_aggregate() in sfa.plc.slices
 """
diff --git a/sfa/rspecs/aggregates/vini_utils.py b/sfa/rspecs/aggregates/vini_utils.py
new file mode 100644
index 00000000..82f86069
--- /dev/null
+++ b/sfa/rspecs/aggregates/vini_utils.py
@@ -0,0 +1,337 @@
+import re
+import socket
+
+# Taken from bwlimit.py
+#
+# See tc_util.c and http://physics.nist.gov/cuu/Units/binary.html. Be
+# warned that older versions of tc interpret "kbps", "mbps", "mbit",
+# and "kbit" to mean (in this system) "kibps", "mibps", "mibit", and
+# "kibit" and that if an older version is installed, all rates will
+# be off by a small fraction.
+suffixes = {
+    "":         1,
+    "bit":	1,
+    "kibit":	1024,
+    "kbit":	1000,
+    "mibit":	1024*1024,
+    "mbit":	1000000,
+    "gibit":	1024*1024*1024,
+    "gbit":	1000000000,
+    "tibit":	1024*1024*1024*1024,
+    "tbit":	1000000000000,
+    "bps":	8,
+    "kibps":	8*1024,
+    "kbps":	8000,
+    "mibps":	8*1024*1024,
+    "mbps":	8000000,
+    "gibps":	8*1024*1024*1024,
+    "gbps":	8000000000,
+    "tibps":	8*1024*1024*1024*1024,
+    "tbps":	8000000000000
+}
+
+
+def get_tc_rate(s):
+    """
+    Parses an integer or a tc rate string (e.g., 1.5mbit) into bits/second
+    """
+
+    if type(s) == int:
+        return s
+    m = re.match(r"([0-9.]+)(\D*)", s)
+    if m is None:
+        return -1
+    suffix = m.group(2).lower()
+    if suffixes.has_key(suffix):
+        return int(float(m.group(1)) * suffixes[suffix])
+    else:
+        return -1
+
+
+class Node:
+    def __init__(self, node):
+        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 = []
+
+    def get_link_id(self, remote):
+        if self.id < remote.id:
+            link = (self.id<<7) + remote.id
+        else:
+            link = (remote.id<<7) + self.id
+        return link
+        
+    def get_iface_id(self, remote):
+        if self.id < remote.id:
+            iface = 1
+        else:
+            iface = 2
+        return iface
+    
+    def get_virt_ip(self, remote):
+        link = self.get_link_id(remote)
+        iface = self.get_iface_id(remote)
+        first = link >> 6
+        second = ((link & 0x3f)<<2) + iface
+        return "192.168.%d.%d" % (first, second)
+
+    def get_virt_net(self, remote):
+        link = self.get_link_id(remote)
+        first = link >> 6
+        second = (link & 0x3f)<<2
+        return "192.168.%d.%d/30" % (first, second)
+        
+    def get_site(self, sites):
+        return sites[self.site_id]
+            
+    def adjacent_nodes(self, sites, nodes, node_ids):
+        mysite = self.get_site(sites)
+        adj_ids = mysite.adj_node_ids.intersection(node_ids)
+        adj_nodes = []
+        for id in adj_ids:
+            adj_nodes.append(nodes[id])
+        return adj_nodes
+    
+    def init_links(self):
+        self.links = []
+        
+    def add_link(self, remote, bw):
+        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)
+
+        
+class Site:
+    def __init__(self, site):
+        self.id = site['site_id']
+        self.node_ids = site['node_ids']
+        self.adj_site_ids = set()
+        self.adj_node_ids = set()
+
+    def get_sitenodes(self, nodes):
+        n = []
+        for i in self.node_ids:
+            n.append(nodes[i])
+        return n
+    
+    def add_adjacency(self, site):
+        self.adj_site_ids.add(site.id)
+        for n in site.node_ids:
+            self.adj_node_ids.add(n)
+        
+    
+class Slice:
+    def __init__(self, slice):
+        self.id = slice['slice_id']
+        self.name = slice['name']
+        self.node_ids = set(slice['node_ids'])
+        self.slice_tag_ids = slice['slice_tag_ids']
+    
+    def get_tag(self, tagname, slicetags, node = None):
+        for i in self.slice_tag_ids:
+            tag = slicetags[i]
+            if tag.tagname == tagname:
+                if (not node) or (node.id == tag.node_id):
+                    return tag
+        else:
+            return None
+        
+    def get_nodes(self, nodes):
+        n = []
+        for id in self.node_ids:
+            n.append(nodes[id])
+        return n
+             
+    
+    # Add a new slice tag   
+    def add_tag(self, tagname, value, slicetags, node = None):
+        record = {'slice_tag_id':None, 'slice_id':self.id, 'tagname':tagname, 'value':value}
+        if node:
+            record['node_id'] = node.id
+        else:
+            record['node_id'] = None
+        tag = Slicetag(record)
+        slicetags[tag.id] = tag
+        self.slice_tag_ids.append(tag.id)
+        tag.changed = True       
+        tag.updated = True
+        return tag
+    
+    # Update a slice tag if it exists, else add it             
+    def update_tag(self, tagname, value, slicetags, node = None):
+        tag = self.get_tag(tagname, slicetags, node)
+        if tag and tag.value == value:
+            value = "no change"
+        elif tag:
+            tag.value = value
+            tag.changed = True
+        else:
+            tag = self.add_tag(tagname, value, slicetags, node)
+        tag.updated = True
+            
+    def assign_egre_key(self, slicetags):
+        if not self.get_tag('egre_key', slicetags):
+            try:
+                key = free_egre_key(slicetags)
+                self.update_tag('egre_key', key, slicetags)
+            except:
+                # Should handle this case...
+                pass
+        return
+            
+    def turn_on_netns(self, slicetags):
+        tag = self.get_tag('netns', slicetags)
+        if (not tag) or (tag.value != '1'):
+            self.update_tag('netns', '1', slicetags)
+        return
+   
+    def turn_off_netns(self, slicetags):
+        tag = self.get_tag('netns', slicetags)
+        if tag and (tag.value != '0'):
+            tag.delete()
+        return
+    
+    def add_cap_net_admin(self, slicetags):
+        tag = self.get_tag('capabilities', slicetags)
+        if tag:
+            caps = tag.value.split(',')
+            for cap in caps:
+                if cap == "CAP_NET_ADMIN":
+                    return
+            else:
+                newcaps = "CAP_NET_ADMIN," + tag.value
+                self.update_tag('capabilities', newcaps, slicetags)
+        else:
+            self.add_tag('capabilities', 'CAP_NET_ADMIN', slicetags)
+        return
+    
+    def remove_cap_net_admin(self, slicetags):
+        tag = self.get_tag('capabilities', slicetags)
+        if tag:
+            caps = tag.value.split(',')
+            newcaps = []
+            for cap in caps:
+                if cap != "CAP_NET_ADMIN":
+                    newcaps.append(cap)
+            if newcaps:
+                value = ','.join(newcaps)
+                self.update_tag('capabilities', value, slicetags)
+            else:
+                tag.delete()
+        return
+
+    # Update the vsys/setup-link and vsys/setup-nat slice tags.
+    def add_vsys_tags(self, slicetags):
+        link = nat = False
+        for i in self.slice_tag_ids:
+            tag = slicetags[i]
+            if tag.tagname == 'vsys':
+                if tag.value == 'setup-link':
+                    link = True
+                elif tag.value == 'setup-nat':
+                    nat = True
+        if not link:
+            self.add_tag('vsys', 'setup-link', slicetags)
+        if not nat:
+            self.add_tag('vsys', 'setup-nat', slicetags)
+        return
+
+
+class Slicetag:
+    newid = -1 
+    def __init__(self, tag):
+        self.id = tag['slice_tag_id']
+        if not self.id:
+            # Make one up for the time being...
+            self.id = Slicetag.newid
+            Slicetag.newid -= 1
+        self.slice_id = tag['slice_id']
+        self.tagname = tag['tagname']
+        self.value = tag['value']
+        self.node_id = tag['node_id']
+        self.updated = False
+        self.changed = False
+        self.deleted = False
+    
+    # Mark a tag as deleted
+    def delete(self):
+        self.deleted = True
+        self.updated = True
+    
+    def write(self, api):
+        if self.changed:
+            if int(self.id) > 0:
+                api.plshell.UpdateSliceTag(api.plauth, self.id, self.value)
+            else:
+                api.plshell.AddSliceTag(api.plauth, self.slice_id, 
+                                        self.tagname, self.value, self.node_id)
+        elif self.deleted and int(self.id) > 0:
+            api.plshell.DeleteSliceTag(api.plauth, self.id)
+
+
+"""
+Create a dictionary of site objects keyed by site ID
+"""
+def get_sites():
+    tmp = []
+    for site in GetSites():
+        t = site['site_id'], Site(site)
+        tmp.append(t)
+    return dict(tmp)
+
+
+"""
+Create a dictionary of node objects keyed by node ID
+"""
+def get_nodes(api):
+    tmp = []
+    for node in api.plshell.GetNodes(api.plauth):
+        t = node['node_id'], Node(node)
+        tmp.append(t)
+    return dict(tmp)
+
+"""
+Create a dictionary of slice objects keyed by slice ID
+"""
+def get_slice(api, slicename):
+    slice = api.plshell.GetSlices(api.plauth, [slicename])
+    if slice:
+        return Slice(slice[0])
+    else:
+        return None
+
+"""
+Create a dictionary of slicetag objects keyed by slice tag ID
+"""
+def get_slice_tags(api):
+    tmp = []
+    for tag in api.plshell.GetSliceTags(api.plauth):
+        t = tag['slice_tag_id'], Slicetag(tag)
+        tmp.append(t)
+    return dict(tmp)
+    
+"""
+Find a free EGRE key
+"""
+def free_egre_key(slicetags):
+    used = set()
+    for i in slicetags:
+        tag = slicetags[i]
+        if tag.tagname == 'egre_key':
+            used.add(int(tag.value))
+                
+    for i in range(1, 256):
+        if i not in used:
+            key = i
+            break
+    else:
+        raise KeyError("No more EGRE keys available")
+        
+    return "%s" % key
+   
+