planetstack/core/models/network.py

   1 import os
   2 import socket
   3 import sys
   4 from django.db import models
   5 from core.models import PlCoreBase, Site, Slice, Sliver, Controller
   6 from core.models import ControllerLinkManager,ControllerLinkDeletionManager
   7 from django.contrib.contenttypes.models import ContentType
   8 from django.contrib.contenttypes import generic
   9 from django.core.exceptions import ValidationError
  10
  11 # If true, then IP addresses will be allocated by the model. If false, then
  12 # we will assume the observer handles it.
  13 NO_OBSERVER=False
  14
  15 def ParseNatList(ports):
  16     """ Support a list of ports in the format "protocol:port, protocol:port, ..."
  17         examples:
  18             tcp 123
  19             tcp 123:133
  20             tcp 123, tcp 124, tcp 125, udp 201, udp 202
  21
  22         User can put either a "/" or a " " between protocol and ports
  23         Port ranges can be specified with "-" or ":"
  24     """
  25     nats = []
  26     if ports:
  27         parts = ports.split(",")
  28         for part in parts:
  29             part = part.strip()
  30             if "/" in part:
  31                 (protocol, ports) = part.split("/",1)
  32             elif " " in part:
  33                 (protocol, ports) = part.split(None,1)
  34             else:
  35                 raise TypeError('malformed port specifier %s, format example: "tcp 123, tcp 201:206, udp 333"' % part)
  36
  37             protocol = protocol.strip()
  38             ports = ports.strip()
  39
  40             if not (protocol in ["udp", "tcp"]):
  41                 raise ValueError('unknown protocol %s' % protocol)
  42
  43             if "-" in ports:
  44                 (first, last) = ports.split("-")
  45                 first = int(first.strip())
  46                 last = int(last.strip())
  47                 portStr = "%d:%d" % (first, last)
  48             elif ":" in ports:
  49                 (first, last) = ports.split(":")
  50                 first = int(first.strip())
  51                 last = int(last.strip())
  52                 portStr = "%d:%d" % (first, last)
  53             else:
  54                 portStr = "%d" % int(ports)
  55
  56             nats.append( {"l4_protocol": protocol, "l4_port": portStr} )
  57
  58     return nats
  59
  60 def ValidateNatList(ports):
  61     try:
  62         ParseNatList(ports)
  63     except Exception,e:
  64         raise ValidationError(str(e))
  65
  66 class NetworkTemplate(PlCoreBase):
  67     VISIBILITY_CHOICES = (('public', 'public'), ('private', 'private'))
  68     TRANSLATION_CHOICES = (('none', 'none'), ('NAT', 'NAT'))
  69     TOPOLOGY_CHOICES = (('bigswitch', 'BigSwitch'), ('physical', 'Physical'), ('custom', 'Custom'))
  70     CONTROLLER_CHOICES = ((None, 'None'), ('onos', 'ONOS'), ('custom', 'Custom'))
  71
  72     name = models.CharField(max_length=32)
  73     description = models.CharField(max_length=1024, blank=True, null=True)
  74     guaranteed_bandwidth = models.IntegerField(default=0)
  75     visibility = models.CharField(max_length=30, choices=VISIBILITY_CHOICES, default="private")
  76     translation = models.CharField(max_length=30, choices=TRANSLATION_CHOICES, default="none")
  77     shared_network_name = models.CharField(max_length=30, blank=True, null=True)
  78     shared_network_id = models.CharField(null=True, blank=True, max_length=256, help_text="Quantum network")
  79     topology_kind = models.CharField(null=False, blank=False, max_length=30, choices=TOPOLOGY_CHOICES, default="BigSwitch")
  80     controller_kind = models.CharField(null=True, blank=True, max_length=30, choices=CONTROLLER_CHOICES, default=None)
  81
  82     def __init__(self, *args, **kwargs):
  83         super(NetworkTemplate, self).__init__(*args, **kwargs)
  84
  85         # somehow these got set wrong inside of the live database. Remove this
  86         # code after all is well...
  87         if (self.topology_kind=="BigSwitch"):
  88             print >> sys.stderr, "XXX warning: topology_kind invalid case"
  89             self.topology_kind="bigswitch"
  90         elif (self.topology_kind=="Physical"):
  91             print >> sys.stderr, "XXX warning: topology_kind invalid case"
  92             self.topology_kind="physical"
  93         elif (self.topology_kind=="Custom"):
  94             print >> sys.stderr, "XXX warning: topology_kind invalid case"
  95             self.toplogy_kind="custom"
  96
  97     def __unicode__(self):  return u'%s' % (self.name)
  98
  99 class Network(PlCoreBase):
 100     name = models.CharField(max_length=32)
 101     template = models.ForeignKey(NetworkTemplate)
 102     subnet = models.CharField(max_length=32, blank=True)
 103     ports = models.CharField(max_length=1024, blank=True, null=True, validators=[ValidateNatList])
 104     labels = models.CharField(max_length=1024, blank=True, null=True)
 105     owner = models.ForeignKey(Slice, related_name="ownedNetworks", help_text="Slice that owns control of this Network")
 106
 107     guaranteed_bandwidth = models.IntegerField(default=0)
 108     permit_all_slices = models.BooleanField(default=False)
 109     permitted_slices = models.ManyToManyField(Slice, blank=True, related_name="availableNetworks")
 110     slices = models.ManyToManyField(Slice, blank=True, related_name="networks", through="NetworkSlice")
 111     slivers = models.ManyToManyField(Sliver, blank=True, related_name="networks", through="NetworkSliver")
 112
 113     topology_parameters = models.TextField(null=True, blank=True)
 114     controller_url = models.CharField(null=True, blank=True, max_length=1024)
 115     controller_parameters = models.TextField(null=True, blank=True)
 116
 117     # for observer/manager
 118     network_id = models.CharField(null=True, blank=True, max_length=256, help_text="Quantum network")
 119     router_id = models.CharField(null=True, blank=True, max_length=256, help_text="Quantum router id")
 120     subnet_id = models.CharField(null=True, blank=True, max_length=256, help_text="Quantum subnet id")
 121
 122     def __unicode__(self):  return u'%s' % (self.name)
 123
 124     def save(self, *args, **kwds):
 125         if (not self.subnet) and (NO_OBSERVER):
 126             from util.network_subnet_allocator import find_unused_subnet
 127             self.subnet = find_unused_subnet(existing_subnets=[x.subnet for x in Network.objects.all()])
 128         super(Network, self).save(*args, **kwds)
 129
 130     def can_update(self, user):
 131         return self.owner.can_update(user)
 132
 133     @property
 134     def nat_list(self):
 135         return ParseNatList(self.ports)
 136
 137     @staticmethod
 138     def select_by_user(user):
 139         if user.is_admin:
 140             qs = Network.objects.all()
 141         else:
 142             slices = Slice.select_by_user(user)
 143             #slice_ids = [s.id for s in Slice.select_by_user(user)]
 144             qs = Network.objects.filter(owner__in=slices)
 145         return qs
 146
 147 class ControllerNetworks(PlCoreBase):
 148     objects = ControllerLinkManager()
 149     deleted_objects = ControllerLinkDeletionManager()
 150
 151     # Stores the openstack ids at various controllers
 152     network = models.ForeignKey(Network, related_name='controllernetworks')
 153     controller = models.ForeignKey(Controller, related_name='controllernetworks')
 154     net_id = models.CharField(null=True, blank=True, max_length=256, help_text="Quantum network")
 155     router_id = models.CharField(null=True, blank=True, max_length=256, help_text="Quantum router id")
 156     subnet_id = models.CharField(null=True, blank=True, max_length=256, help_text="Quantum subnet id")
 157     subnet = models.CharField(max_length=32, blank=True)
 158
 159     def can_update(self, user):
 160         return user.is_admin
 161
 162     @staticmethod
 163     def select_by_user(user):
 164         if user.is_admin:
 165             qs = NetworkControllers.objects.all()
 166         else:
 167             slices = Slice.select_by_user(user)
 168             networks = Network.objects.filter(owner__in=slices)
 169             qs = NetworkControllers.objects.filter(network__in=networks)
 170         return qs
 171
 172 class NetworkSlice(PlCoreBase):
 173     # This object exists solely so we can implement the permission check when
 174     # adding slices to networks. It adds no additional fields to the relation.
 175
 176     network = models.ForeignKey(Network,related_name='networkslices')
 177     slice = models.ForeignKey(Slice,related_name='networkslices')
 178
 179     def save(self, *args, **kwds):
 180         slice = self.slice
 181         if (slice not in self.network.permitted_slices.all()) and (slice != self.network.owner) and (not self.network.permitAllSlices):
 182             # to add a sliver to the network, then one of the following must be true:
 183             #   1) sliver's slice is in network's permittedSlices list,
 184             #   2) sliver's slice is network's owner, or
 185             #   3) network's permitAllSlices is true
 186             raise ValueError("Slice %s is not allowed to connect to network %s" % (str(slice), str(self.network)))
 187
 188         super(NetworkSlice, self).save(*args, **kwds)
 189
 190     def __unicode__(self):  return u'%s-%s' % (self.network.name, self.slice.name)
 191
 192     def can_update(self, user):
 193         return self.slice.can_update(user)
 194
 195     @staticmethod
 196     def select_by_user(user):
 197         if user.is_admin:
 198             qs = NetworkSlice.objects.all()
 199         else:
 200             slice_ids = [s.id for s in Slice.select_by_user(user)]
 201             qs = NetworkSlice.objects.filter(id__in=slice_ids)
 202         return qs
 203
 204 class NetworkSliver(PlCoreBase):
 205     network = models.ForeignKey(Network,related_name='networkslivers')
 206     sliver = models.ForeignKey(Sliver,related_name='networkslivers')
 207     ip = models.GenericIPAddressField(help_text="Sliver ip address", blank=True, null=True)
 208     port_id = models.CharField(null=True, blank=True, max_length=256, help_text="Quantum port id")
 209
 210     def save(self, *args, **kwds):
 211         slice = self.sliver.slice
 212         if (slice not in self.network.permitted_slices.all()) and (slice != self.network.owner) and (not self.network.permitAllSlices):
 213             # to add a sliver to the network, then one of the following must be true:
 214             #   1) sliver's slice is in network's permittedSlices list,
 215             #   2) sliver's slice is network's owner, or
 216             #   3) network's permitAllSlices is true
 217             raise ValueError("Slice %s is not allowed to connect to network %s" % (str(slice), str(self.network)))
 218
 219         if (not self.ip) and (NO_OBSERVER):
 220             from util.network_subnet_allocator import find_unused_address
 221             self.ip = find_unused_address(self.network.subnet,
 222                                           [x.ip for x in self.network.networksliver_set.all()])
 223         super(NetworkSliver, self).save(*args, **kwds)
 224
 225     def __unicode__(self):  return u'%s-%s' % (self.network.name, self.sliver.instance_name)
 226
 227     def can_update(self, user):
 228         return self.sliver.can_update(user)
 229
 230     @staticmethod
 231     def select_by_user(user):
 232         if user.is_admin:
 233             qs = NetworkSliver.objects.all()
 234         else:
 235             sliver_ids = [s.id for s in NetworkSliver.select_by_user(user)]
 236             qs = NetworkSliver.objects.filter(id__in=sliver_ids)
 237         return qs
 238
 239 class Router(PlCoreBase):
 240     name = models.CharField(max_length=32)
 241     owner = models.ForeignKey(Slice, related_name="routers")
 242     permittedNetworks = models.ManyToManyField(Network, blank=True, related_name="availableRouters")
 243     networks = models.ManyToManyField(Network, blank=True, related_name="routers")
 244
 245     def __unicode__(self):  return u'%s' % (self.name)
 246
 247 class NetworkParameterType(PlCoreBase):
 248     name = models.SlugField(help_text="The name of this parameter", max_length=128)
 249     description = models.CharField(max_length=1024)
 250
 251     def __unicode__(self):  return u'%s' % (self.name)
 252
 253 class NetworkParameter(PlCoreBase):
 254     parameter = models.ForeignKey(NetworkParameterType, related_name="networkparameters", help_text="The type of the parameter")
 255     value = models.CharField(help_text="The value of this parameter", max_length=1024)
 256
 257     # The required fields to do a ObjectType lookup, and object_id assignment
 258     content_type = models.ForeignKey(ContentType)
 259     object_id = models.PositiveIntegerField()
 260     content_object = generic.GenericForeignKey('content_type', 'object_id')
 261
 262     def __unicode__(self):
 263         return self.parameter.name
 264
 265