planetstack/core/models/network.py

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