models.py 31.7 KB
Newer Older
1
# Copyright 2011-2012 GRNET S.A. All rights reserved.
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions
# are met:
#
#   1. Redistributions of source code must retain the above copyright
#      notice, this list of conditions and the following disclaimer.
#
#  2. Redistributions in binary form must reproduce the above copyright
#     notice, this list of conditions and the following disclaimer in the
#     documentation and/or other materials provided with the distribution.
#
# THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
# ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
# SUCH DAMAGE.
#
# The views and conclusions contained in the software and documentation are
# those of the authors and should not be interpreted as representing official
# policies, either expressed or implied, of GRNET S.A.

30
31
import datetime

32
from copy import deepcopy
33
from django.conf import settings
34
from django.db import models
35
36

import utils
37
from contextlib import contextmanager
38
from hashlib import sha1
39
from snf_django.lib.api import faults
40
from django.conf import settings as snf_settings
41
from aes_encrypt import encrypt_db_charfield, decrypt_db_charfield
42

43
from synnefo.db import pools, fields
44

45
46
from synnefo.logic.rapi_pool import (get_rapi_client,
                                     put_rapi_client)
47

48
49
50
import logging
log = logging.getLogger(__name__)

51

52
class Flavor(models.Model):
53
    cpu = models.IntegerField('Number of CPUs', default=0)
54
55
    ram = models.IntegerField('RAM size in MiB', default=0)
    disk = models.IntegerField('Disk size in GiB', default=0)
56
    disk_template = models.CharField('Disk template', max_length=32)
57
    deleted = models.BooleanField('Deleted', default=False)
58

Vassilios Karakoidas's avatar
Vassilios Karakoidas committed
59
    class Meta:
60
        verbose_name = u'Virtual machine flavor'
61
        unique_together = ('cpu', 'ram', 'disk', 'disk_template')
62

63
64
    @property
    def name(self):
65
        """Returns flavor name (generated)"""
66
67
        return u'C%dR%dD%d%s' % (self.cpu, self.ram, self.disk,
                                 self.disk_template)
68

69
    def __unicode__(self):
70
        return "<%s:%s>" % (str(self.id), self.name)
71

72

73
74
75
76
77
class Backend(models.Model):
    clustername = models.CharField('Cluster Name', max_length=128, unique=True)
    port = models.PositiveIntegerField('Port', default=5080)
    username = models.CharField('Username', max_length=64, blank=True,
                                null=True)
78
    password_hash = models.CharField('Password', max_length=128, blank=True,
Christos Stavrakakis's avatar
Christos Stavrakakis committed
79
                                     null=True)
80
81
    # Sha1 is up to 40 characters long
    hash = models.CharField('Hash', max_length=40, editable=False, null=False)
82
83
84
85
    # Unique index of the Backend, used for the mac-prefixes of the
    # BackendNetworks
    index = models.PositiveIntegerField('Index', null=False, unique=True,
                                        default=0)
86
87
    drained = models.BooleanField('Drained', default=False, null=False)
    offline = models.BooleanField('Offline', default=False, null=False)
88
89
90
    # Type of hypervisor
    hypervisor = models.CharField('Hypervisor', max_length=32, default="kvm",
                                  null=False)
91
    disk_templates = fields.SeparatedValuesField("Disk Templates", null=True)
92
93
94
95
96
97
98
99
100
101
102
103
    # Last refresh of backend resources
    updated = models.DateTimeField(auto_now_add=True)
    # Backend resources
    mfree = models.PositiveIntegerField('Free Memory', default=0, null=False)
    mtotal = models.PositiveIntegerField('Total Memory', default=0, null=False)
    dfree = models.PositiveIntegerField('Free Disk', default=0, null=False)
    dtotal = models.PositiveIntegerField('Total Disk', default=0, null=False)
    pinst_cnt = models.PositiveIntegerField('Primary Instances', default=0,
                                            null=False)
    ctotal = models.PositiveIntegerField('Total number of logical processors',
                                         default=0, null=False)

104
105
106
107
108
109
    HYPERVISORS = (
        ("kvm", "Linux KVM hypervisor"),
        ("xen-pvm", "Xen PVM hypervisor"),
        ("xen-hvm", "Xen KVM hypervisor"),
    )

110
111
112
113
114
    class Meta:
        verbose_name = u'Backend'
        ordering = ["clustername"]

    def __unicode__(self):
Christos Stavrakakis's avatar
Christos Stavrakakis committed
115
        return self.clustername + "(id=" + str(self.id) + ")"
116
117
118
119
120

    @property
    def backend_id(self):
        return self.id

121
    def get_client(self):
122
        """Get or create a client. """
123
        if self.offline:
124
            raise faults.ServiceUnavailable
125
        return get_rapi_client(self.id, self.hash,
126
127
                               self.clustername,
                               self.port,
128
129
130
131
132
133
                               self.username,
                               self.password)

    @staticmethod
    def put_client(client):
            put_rapi_client(client)
134
135
136

    def create_hash(self):
        """Create a hash for this backend. """
Christos Stavrakakis's avatar
Christos Stavrakakis committed
137
138
139
        sha = sha1('%s%s%s%s' %
                   (self.clustername, self.port, self.username, self.password))
        return sha.hexdigest()
140

141
142
143
144
145
146
147
148
    @property
    def password(self):
        return decrypt_db_charfield(self.password_hash)

    @password.setter
    def password(self, value):
        self.password_hash = encrypt_db_charfield(value)

149
150
151
152
153
154
155
    def save(self, *args, **kwargs):
        # Create a new hash each time a Backend is saved
        old_hash = self.hash
        self.hash = self.create_hash()
        super(Backend, self).save(*args, **kwargs)
        if self.hash != old_hash:
            # Populate the new hash to the new instances
Christos Stavrakakis's avatar
Christos Stavrakakis committed
156
157
            self.virtual_machines.filter(deleted=False)\
                                 .update(backend_hash=self.hash)
158

159
160
161
162
163
    def __init__(self, *args, **kwargs):
        super(Backend, self).__init__(*args, **kwargs)
        if not self.pk:
            # Generate a unique index for the Backend
            indexes = Backend.objects.all().values_list('index', flat=True)
164
165
166
167
168
            try:
                first_free = [x for x in xrange(0, 16) if x not in indexes][0]
                self.index = first_free
            except IndexError:
                raise Exception("Can not create more than 16 backends")
169

170
171
172
173
174
175
176
177
178
    def use_hotplug(self):
        return self.hypervisor == "kvm" and snf_settings.GANETI_USE_HOTPLUG

    def get_create_params(self):
        params = deepcopy(snf_settings.GANETI_CREATEINSTANCE_KWARGS)
        params["hvparams"] = params.get("hvparams", {})\
                                   .get(self.hypervisor, {})
        return params

179

180
181
182
183
184
185
186
187
188
189
190
191
# A backend job may be in one of the following possible states
BACKEND_STATUSES = (
    ('queued', 'request queued'),
    ('waiting', 'request waiting for locks'),
    ('canceling', 'request being canceled'),
    ('running', 'request running'),
    ('canceled', 'request canceled'),
    ('success', 'request completed successfully'),
    ('error', 'request returned error')
)


192
class QuotaHolderSerial(models.Model):
193
194
195
196
197
198
199
200
201
202
    """Model representing a serial for a Quotaholder Commission.

    serial:   The serial that Quotaholder assigned to this commission
    pending:  Whether it has been decided to accept or reject this commission
    accept:   If pending is False, this attribute indicates whether to accept
              or reject this commission
    resolved: Whether this commission has been accepted or rejected to
              Quotaholder.

    """
Christos Stavrakakis's avatar
Christos Stavrakakis committed
203
204
    serial = models.BigIntegerField(null=False, primary_key=True,
                                    db_index=True)
205
    pending = models.BooleanField(default=True, db_index=True)
206
207
    accept = models.BooleanField(default=False)
    resolved = models.BooleanField(default=False)
208
209
210
211
212

    class Meta:
        verbose_name = u'Quota Serial'
        ordering = ["serial"]

213
214
215
    def __unicode__(self):
        return u"<serial: %s>" % self.serial

216

Vassilios Karakoidas's avatar
Vassilios Karakoidas committed
217
class VirtualMachine(models.Model):
218
    # The list of possible actions for a VM
219
    ACTIONS = (
Christos Stavrakakis's avatar
Christos Stavrakakis committed
220
221
222
223
224
        ('CREATE', 'Create VM'),
        ('START', 'Start VM'),
        ('STOP', 'Shutdown VM'),
        ('SUSPEND', 'Admin Suspend VM'),
        ('REBOOT', 'Reboot VM'),
225
226
        ('DESTROY', 'Destroy VM'),
        ('RESIZE', 'Resize a VM'),
227
228
        ('ADDFLOATINGIP', 'Add floating IP to VM'),
        ('REMOVEFLOATINGIP', 'Add floating IP to VM'),
229
    )
230

231
    # The internal operating state of a VM
232
233
234
235
236
    OPER_STATES = (
        ('BUILD', 'Queued for creation'),
        ('ERROR', 'Creation failed'),
        ('STOPPED', 'Stopped'),
        ('STARTED', 'Started'),
237
238
        ('DESTROYED', 'Destroyed'),
        ('RESIZE', 'Resizing')
239
    )
240

241
    # The list of possible operations on the backend
242
243
244
245
246
    BACKEND_OPCODES = (
        ('OP_INSTANCE_CREATE', 'Create Instance'),
        ('OP_INSTANCE_REMOVE', 'Remove Instance'),
        ('OP_INSTANCE_STARTUP', 'Startup Instance'),
        ('OP_INSTANCE_SHUTDOWN', 'Shutdown Instance'),
247
248
249
250
251
252
        ('OP_INSTANCE_REBOOT', 'Reboot Instance'),

        # These are listed here for completeness,
        # and are ignored for the time being
        ('OP_INSTANCE_SET_PARAMS', 'Set Instance Parameters'),
        ('OP_INSTANCE_QUERY_DATA', 'Query Instance Data'),
253
254
255
256
257
258
        ('OP_INSTANCE_REINSTALL', 'Reinstall Instance'),
        ('OP_INSTANCE_ACTIVATE_DISKS', 'Activate Disks'),
        ('OP_INSTANCE_DEACTIVATE_DISKS', 'Deactivate Disks'),
        ('OP_INSTANCE_REPLACE_DISKS', 'Replace Disks'),
        ('OP_INSTANCE_MIGRATE', 'Migrate Instance'),
        ('OP_INSTANCE_CONSOLE', 'Get Instance Console'),
259
260
        ('OP_INSTANCE_RECREATE_DISKS', 'Recreate Disks'),
        ('OP_INSTANCE_FAILOVER', 'Failover Instance')
261
    )
262

263
264
    # The operating state of a VM,
    # upon the successful completion of a backend operation.
265
266
    # IMPORTANT: Make sure all keys have a corresponding
    # entry in BACKEND_OPCODES if you update this field, see #1035, #1111.
267
268
269
270
271
    OPER_STATE_FROM_OPCODE = {
        'OP_INSTANCE_CREATE': 'STARTED',
        'OP_INSTANCE_REMOVE': 'DESTROYED',
        'OP_INSTANCE_STARTUP': 'STARTED',
        'OP_INSTANCE_SHUTDOWN': 'STOPPED',
272
273
        'OP_INSTANCE_REBOOT': 'STARTED',
        'OP_INSTANCE_SET_PARAMS': None,
274
        'OP_INSTANCE_QUERY_DATA': None,
275
276
        'OP_INSTANCE_REINSTALL': None,
        'OP_INSTANCE_ACTIVATE_DISKS': None,
277
        'OP_INSTANCE_DEACTIVATE_DISKS': None,
278
        'OP_INSTANCE_REPLACE_DISKS': None,
279
280
        'OP_INSTANCE_MIGRATE': None,
        'OP_INSTANCE_CONSOLE': None,
281
282
        'OP_INSTANCE_RECREATE_DISKS': None,
        'OP_INSTANCE_FAILOVER': None
283
284
    }

285
286
287
    # This dictionary contains the correspondence between
    # internal operating states and Server States as defined
    # by the Rackspace API.
288
289
290
291
292
    RSAPI_STATE_FROM_OPER_STATE = {
        "BUILD": "BUILD",
        "ERROR": "ERROR",
        "STOPPED": "STOPPED",
        "STARTED": "ACTIVE",
293
294
        'RESIZE': 'RESIZE',
        'DESTROYED': 'DELETED',
295
296
    }

297
    name = models.CharField('Virtual Machine Name', max_length=255)
298
    userid = models.CharField('User ID of the owner', max_length=100,
299
                              db_index=True, null=False)
300
    backend = models.ForeignKey(Backend, null=True,
301
302
                                related_name="virtual_machines",
                                on_delete=models.PROTECT)
303
    backend_hash = models.CharField(max_length=128, null=True, editable=False)
304
305
    created = models.DateTimeField(auto_now_add=True)
    updated = models.DateTimeField(auto_now=True)
306
    imageid = models.CharField(max_length=100, null=False)
307
    hostid = models.CharField(max_length=100)
308
    flavor = models.ForeignKey(Flavor, on_delete=models.PROTECT)
309
    deleted = models.BooleanField('Deleted', default=False, db_index=True)
310
    suspended = models.BooleanField('Administratively Suspended',
311
                                    default=False)
312
    serial = models.ForeignKey(QuotaHolderSerial,
313
314
                               related_name='virtual_machine', null=True,
                               on_delete=models.SET_NULL)
315

316
    # VM State
317
318
319
320
    # The following fields are volatile data, in the sense
    # that they need not be persistent in the DB, but rather
    # get generated at runtime by quering Ganeti and applying
    # updates received from Ganeti.
321

322
323
324
    # In the future they could be moved to a separate caching layer
    # and removed from the database.
    # [vkoukis] after discussion with [faidon].
325
326
327
328
    action = models.CharField(choices=ACTIONS, max_length=30, null=True,
                              default=None)
    operstate = models.CharField(choices=OPER_STATES, max_length=30,
                                 null=False, default="BUILD")
329
    backendjobid = models.PositiveIntegerField(null=True)
330
    backendopcode = models.CharField(choices=BACKEND_OPCODES, max_length=30,
331
                                     null=True)
332
    backendjobstatus = models.CharField(choices=BACKEND_STATUSES,
333
                                        max_length=30, null=True)
334
    backendlogmsg = models.TextField(null=True)
335
    buildpercentage = models.IntegerField(default=0)
336
    backendtime = models.DateTimeField(default=datetime.datetime.min)
337

338
339
340
    # Latest action and corresponding Ganeti job ID, for actions issued
    # by the API
    task = models.CharField(max_length=64, null=True)
341
    task_job_id = models.BigIntegerField(null=True)
342

343
344
    def get_client(self):
        if self.backend:
345
            return self.backend.get_client()
346
        else:
347
            raise faults.ServiceUnavailable
348

349
350
351
352
353
354
    def get_last_diagnostic(self, **filters):
        try:
            return self.diagnostics.filter()[0]
        except IndexError:
            return None

355
356
357
358
    @staticmethod
    def put_client(client):
            put_rapi_client(client)

359
360
361
362
363
364
    def save(self, *args, **kwargs):
        # Store hash for first time saved vm
        if (self.id is None or self.backend_hash == '') and self.backend:
            self.backend_hash = self.backend.hash
        super(VirtualMachine, self).save(*args, **kwargs)

365
    @property
366
    def backend_vm_id(self):
367
        """Returns the backend id for this VM by prepending backend-prefix."""
368
369
        if not self.id:
            raise VirtualMachine.InvalidBackendIdError("self.id is None")
370
        return "%s%s" % (settings.BACKEND_PREFIX_ID, str(self.id))
371

372
373
374
    class Meta:
        verbose_name = u'Virtual machine instance'
        get_latest_by = 'created'
375

376
    def __unicode__(self):
377
        return u"<vm:%s@backend:%s>" % (self.id, self.backend_id)
378

Christos Stavrakakis's avatar
Christos Stavrakakis committed
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
    # Error classes
    class InvalidBackendIdError(Exception):
        def __init__(self, value):
            self.value = value

        def __str__(self):
            return repr(self.value)

    class InvalidBackendMsgError(Exception):
        def __init__(self, opcode, status):
            self.opcode = opcode
            self.status = status

        def __str__(self):
            return repr('<opcode: %s, status: %s>' % (self.opcode,
                        self.status))

    class InvalidActionError(Exception):
        def __init__(self, action):
            self._action = action

        def __str__(self):
            return repr(str(self._action))

403

Vassilios Karakoidas's avatar
Vassilios Karakoidas committed
404
405
406
class VirtualMachineMetadata(models.Model):
    meta_key = models.CharField(max_length=50)
    meta_value = models.CharField(max_length=500)
407
408
    vm = models.ForeignKey(VirtualMachine, related_name='metadata',
                           on_delete=models.CASCADE)
409

Vassilios Karakoidas's avatar
Vassilios Karakoidas committed
410
    class Meta:
411
        unique_together = (('meta_key', 'vm'),)
412
        verbose_name = u'Key-value pair of metadata for a VM.'
413

Vassilios Karakoidas's avatar
Vassilios Karakoidas committed
414
    def __unicode__(self):
415
        return u'%s: %s' % (self.meta_key, self.meta_value)
Vassilios Karakoidas's avatar
Vassilios Karakoidas committed
416
417


418
class Network(models.Model):
419
    OPER_STATES = (
420
        ('PENDING', 'Pending'),  # Unused because of lazy networks
421
        ('ACTIVE', 'Active'),
422
423
424
425
426
        ('DELETED', 'Deleted'),
        ('ERROR', 'Error')
    )

    ACTIONS = (
Christos Stavrakakis's avatar
Christos Stavrakakis committed
427
428
        ('CREATE', 'Create Network'),
        ('DESTROY', 'Destroy Network'),
429
430
        ('ADD', 'Add server to Network'),
        ('REMOVE', 'Remove server from Network'),
431
432
433
434
435
436
437
438
439
    )

    RSAPI_STATE_FROM_OPER_STATE = {
        'PENDING': 'PENDING',
        'ACTIVE': 'ACTIVE',
        'DELETED': 'DELETED',
        'ERROR': 'ERROR'
    }

440
441
    FLAVORS = {
        'CUSTOM': {
Christos Stavrakakis's avatar
Christos Stavrakakis committed
442
443
444
445
446
            'mode': 'bridged',
            'link': settings.DEFAULT_BRIDGE,
            'mac_prefix': settings.DEFAULT_MAC_PREFIX,
            'tags': None,
            'desc': "Basic flavor used for a bridged network",
447
448
        },
        'IP_LESS_ROUTED': {
Christos Stavrakakis's avatar
Christos Stavrakakis committed
449
450
451
452
453
454
            'mode': 'routed',
            'link': settings.DEFAULT_ROUTING_TABLE,
            'mac_prefix': settings.DEFAULT_MAC_PREFIX,
            'tags': 'ip-less-routed',
            'desc': "Flavor used for an IP-less routed network using"
                    " Proxy ARP",
455
456
        },
        'MAC_FILTERED': {
Christos Stavrakakis's avatar
Christos Stavrakakis committed
457
458
459
460
461
462
463
            'mode': 'bridged',
            'link': settings.DEFAULT_MAC_FILTERED_BRIDGE,
            'mac_prefix': 'pool',
            'tags': 'private-filtered',
            'desc': "Flavor used for bridged networks that offer isolation"
                    " via filtering packets based on their src "
                    " MAC (ebtables)",
464
465
        },
        'PHYSICAL_VLAN': {
Christos Stavrakakis's avatar
Christos Stavrakakis committed
466
467
468
469
470
471
            'mode': 'bridged',
            'link': 'pool',
            'mac_prefix': settings.DEFAULT_MAC_PREFIX,
            'tags': 'physical-vlan',
            'desc': "Flavor used for bridged network that offer isolation"
                    " via dedicated physical vlan",
472
473
        },
    }
474

475
    name = models.CharField('Network Name', max_length=128)
476
477
    userid = models.CharField('User ID of the owner', max_length=128,
                              null=True, db_index=True)
478
479
480
    # subnet will be null for IPv6 only networks
    subnet = models.CharField('Subnet', max_length=32, null=True)
    # subnet6 will be null for IPv4 only networks
Christos Stavrakakis's avatar
Christos Stavrakakis committed
481
    subnet6 = models.CharField('IPv6 Subnet', max_length=64, null=True)
482
    gateway = models.CharField('Gateway', max_length=32, null=True)
Christos Stavrakakis's avatar
Christos Stavrakakis committed
483
    gateway6 = models.CharField('IPv6 Gateway', max_length=64, null=True)
484
    dhcp = models.BooleanField('DHCP', default=True)
485
486
487
    flavor = models.CharField('Flavor', max_length=32, null=False)
    mode = models.CharField('Network Mode', max_length=16, null=True)
    link = models.CharField('Network Link', max_length=32, null=True)
488
    mac_prefix = models.CharField('MAC Prefix', max_length=32, null=False)
489
    tags = models.CharField('Network Tags', max_length=128, null=True)
490
    public = models.BooleanField(default=False, db_index=True)
491
492
    created = models.DateTimeField(auto_now_add=True)
    updated = models.DateTimeField(auto_now=True)
493
    deleted = models.BooleanField('Deleted', default=False, db_index=True)
494
495
    state = models.CharField(choices=OPER_STATES, max_length=32,
                             default='PENDING')
496
    machines = models.ManyToManyField(VirtualMachine,
497
                                      through='NetworkInterface')
498
499
    action = models.CharField(choices=ACTIONS, max_length=32, null=True,
                              default=None)
500
    drained = models.BooleanField("Drained", default=False, null=False)
501
    floating_ip_pool = models.BooleanField('Floating IP Pool', null=False,
Christos Stavrakakis's avatar
Christos Stavrakakis committed
502
                                           default=False)
Christos Stavrakakis's avatar
Christos Stavrakakis committed
503
    pool = models.OneToOneField('IPPoolTable', related_name='network',
Christos Stavrakakis's avatar
Christos Stavrakakis committed
504
505
506
507
508
                                default=lambda: IPPoolTable.objects.create(
                                                            available_map='',
                                                            reserved_map='',
                                                            size=0),
                                null=True)
509
    serial = models.ForeignKey(QuotaHolderSerial, related_name='network',
510
                               null=True, on_delete=models.SET_NULL)
Christos Stavrakakis's avatar
Christos Stavrakakis committed
511

512
    def __unicode__(self):
513
        return "<Network: %s>" % str(self.id)
514

515
516
    @property
    def backend_id(self):
517
        """Return the backend id by prepending backend-prefix."""
518
519
        if not self.id:
            raise Network.InvalidBackendIdError("self.id is None")
520
        return "%snet-%s" % (settings.BACKEND_PREFIX_ID, str(self.id))
521
522
523
524
525
526

    @property
    def backend_tag(self):
        """Return the network tag to be used in backend

        """
527
528
529
530
        if self.tags:
            return self.tags.split(',')
        else:
            return []
531

532
533
534
    def create_backend_network(self, backend=None):
        """Create corresponding BackendNetwork entries."""

Christos Stavrakakis's avatar
Christos Stavrakakis committed
535
536
        backends = [backend] if backend else\
            Backend.objects.filter(offline=False)
537
        for backend in backends:
Christos Stavrakakis's avatar
Christos Stavrakakis committed
538
539
540
541
            backend_exists =\
                BackendNetwork.objects.filter(backend=backend, network=self)\
                                      .exists()
            if not backend_exists:
542
                BackendNetwork.objects.create(backend=backend, network=self)
543

Christos Stavrakakis's avatar
Christos Stavrakakis committed
544
    def get_pool(self, with_lock=True):
545
546
547
548
549
        if not self.pool_id:
            self.pool = IPPoolTable.objects.create(available_map='',
                                                   reserved_map='',
                                                   size=0)
            self.save()
Christos Stavrakakis's avatar
Christos Stavrakakis committed
550
551
552
553
        objects = IPPoolTable.objects
        if with_lock:
            objects = objects.select_for_update()
        return objects.get(id=self.pool_id).pool
Christos Stavrakakis's avatar
Christos Stavrakakis committed
554

Christos Stavrakakis's avatar
Christos Stavrakakis committed
555
556
    def reserve_address(self, address):
        pool = self.get_pool()
Christos Stavrakakis's avatar
Christos Stavrakakis committed
557
        pool.reserve(address)
Christos Stavrakakis's avatar
Christos Stavrakakis committed
558
        pool.save()
Christos Stavrakakis's avatar
Christos Stavrakakis committed
559

Christos Stavrakakis's avatar
Christos Stavrakakis committed
560
561
562
563
    def release_address(self, address):
        pool = self.get_pool()
        pool.put(address)
        pool.save()
Christos Stavrakakis's avatar
Christos Stavrakakis committed
564

Christos Stavrakakis's avatar
Christos Stavrakakis committed
565
566
567
568
569
570
571
572
573
574
575
576
577
    class InvalidBackendIdError(Exception):
        def __init__(self, value):
            self.value = value

        def __str__(self):
            return repr(self.value)

    class InvalidBackendMsgError(Exception):
        def __init__(self, opcode, status):
            self.opcode = opcode
            self.status = status

        def __str__(self):
Christos Stavrakakis's avatar
Christos Stavrakakis committed
578
579
            return repr('<opcode: %s, status: %s>'
                        % (self.opcode, self.status))
Christos Stavrakakis's avatar
Christos Stavrakakis committed
580
581
582
583
584
585
586
587

    class InvalidActionError(Exception):
        def __init__(self, action):
            self._action = action

        def __str__(self):
            return repr(str(self._action))

588

589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
class BackendNetwork(models.Model):
    OPER_STATES = (
        ('PENDING', 'Pending'),
        ('ACTIVE', 'Active'),
        ('DELETED', 'Deleted'),
        ('ERROR', 'Error')
    )

    # The list of possible operations on the backend
    BACKEND_OPCODES = (
        ('OP_NETWORK_ADD', 'Create Network'),
        ('OP_NETWORK_CONNECT', 'Activate Network'),
        ('OP_NETWORK_DISCONNECT', 'Deactivate Network'),
        ('OP_NETWORK_REMOVE', 'Remove Network'),
        # These are listed here for completeness,
        # and are ignored for the time being
        ('OP_NETWORK_SET_PARAMS', 'Set Network Parameters'),
        ('OP_NETWORK_QUERY_DATA', 'Query Network Data')
    )

    # The operating state of a Netowork,
    # upon the successful completion of a backend operation.
    # IMPORTANT: Make sure all keys have a corresponding
    # entry in BACKEND_OPCODES if you update this field, see #1035, #1111.
    OPER_STATE_FROM_OPCODE = {
        'OP_NETWORK_ADD': 'PENDING',
        'OP_NETWORK_CONNECT': 'ACTIVE',
        'OP_NETWORK_DISCONNECT': 'PENDING',
        'OP_NETWORK_REMOVE': 'DELETED',
        'OP_NETWORK_SET_PARAMS': None,
        'OP_NETWORK_QUERY_DATA': None
    }

622
623
    network = models.ForeignKey(Network, related_name='backend_networks',
                                on_delete=models.CASCADE)
624
625
    backend = models.ForeignKey(Backend, related_name='networks',
                                on_delete=models.PROTECT)
626
627
628
    created = models.DateTimeField(auto_now_add=True)
    updated = models.DateTimeField(auto_now=True)
    deleted = models.BooleanField('Deleted', default=False)
629
    mac_prefix = models.CharField('MAC Prefix', max_length=32, null=False)
630
631
632
633
634
635
636
637
638
639
640
    operstate = models.CharField(choices=OPER_STATES, max_length=30,
                                 default='PENDING')
    backendjobid = models.PositiveIntegerField(null=True)
    backendopcode = models.CharField(choices=BACKEND_OPCODES, max_length=30,
                                     null=True)
    backendjobstatus = models.CharField(choices=BACKEND_STATUSES,
                                        max_length=30, null=True)
    backendlogmsg = models.TextField(null=True)
    backendtime = models.DateTimeField(null=False,
                                       default=datetime.datetime.min)

641
642
643
644
    class Meta:
        # Ensure one entry for each network in each backend
        unique_together = (("network", "backend"))

645
646
647
648
649
650
651
652
653
654
655
656
    def __init__(self, *args, **kwargs):
        """Initialize state for just created BackendNetwork instances."""
        super(BackendNetwork, self).__init__(*args, **kwargs)
        if not self.mac_prefix:
            # Generate the MAC prefix of the BackendNetwork, by combining
            # the Network prefix with the index of the Backend
            net_prefix = self.network.mac_prefix
            backend_suffix = hex(self.backend.index).replace('0x', '')
            mac_prefix = net_prefix + backend_suffix
            try:
                utils.validate_mac(mac_prefix + ":00:00:00")
            except utils.InvalidMacAddress:
Christos Stavrakakis's avatar
Christos Stavrakakis committed
657
658
                raise utils.InvalidMacAddress("Invalid MAC prefix '%s'" %
                                              mac_prefix)
659
660
            self.mac_prefix = mac_prefix

661
662
663
    def __unicode__(self):
        return '<%s@%s>' % (self.network, self.backend)

664
665
666
667

class NetworkInterface(models.Model):
    FIREWALL_PROFILES = (
        ('ENABLED', 'Enabled'),
668
669
        ('DISABLED', 'Disabled'),
        ('PROTECTED', 'Protected')
670
    )
671

672
673
674
    STATES = (
        ("ACTIVE", "Active"),
        ("BUILDING", "Building"),
675
        ("ERROR", "Error"),
676
677
    )

678
679
680
681
    machine = models.ForeignKey(VirtualMachine, related_name='nics',
                                on_delete=models.CASCADE)
    network = models.ForeignKey(Network, related_name='nics',
                                on_delete=models.CASCADE)
682
683
    created = models.DateTimeField(auto_now_add=True)
    updated = models.DateTimeField(auto_now=True)
684
    index = models.IntegerField(null=True)
685
    mac = models.CharField(max_length=32, null=True, unique=True)
686
687
688
    ipv4 = models.CharField(max_length=15, null=True)
    ipv6 = models.CharField(max_length=100, null=True)
    firewall_profile = models.CharField(choices=FIREWALL_PROFILES,
689
                                        max_length=30, null=True)
Christos Stavrakakis's avatar
Christos Stavrakakis committed
690
    state = models.CharField(max_length=32, null=False, default="ACTIVE",
691
                             choices=STATES)
692

693
694
695
696
697
    @property
    def backend_uuid(self):
        """Return the backend id by prepending backend-prefix."""
        return "%snic-%s" % (settings.BACKEND_PREFIX_ID, str(self.id))

Giorgos Verigakis's avatar
Giorgos Verigakis committed
698
    def __unicode__(self):
699
        return "<%s:vm:%s network:%s ipv4:%s ipv6:%s>" % \
700
            (self.id, self.machine_id, self.network_id, self.ipv4,
701
             self.ipv6)
702

703
704
705
706
707
708
709
710
711
    @property
    def is_floating_ip(self):
        network = self.network
        if self.ipv4 and network.floating_ip_pool:
            return network.floating_ips.filter(machine=self.machine,
                                               ipv4=self.ipv4,
                                               deleted=False).exists()
        return False

712
713
714
715
716
    class Meta:
        # Assert than an IPv4 address from the same network will not be
        # assigned to more than one NICs
        unique_together = ("network", "ipv4")

717

718
719
720
721
722
class FloatingIP(models.Model):
    userid = models.CharField("UUID of the owner", max_length=128,
                              null=False, db_index=True)
    ipv4 = models.IPAddressField(null=False, unique=True, db_index=True)
    network = models.ForeignKey(Network, related_name="floating_ips",
723
                                null=False, on_delete=models.CASCADE)
724
    machine = models.ForeignKey(VirtualMachine, related_name="floating_ips",
725
                                null=True, on_delete=models.CASCADE)
726
727
728
    created = models.DateTimeField(auto_now_add=True)
    deleted = models.BooleanField(default=False, null=False)
    serial = models.ForeignKey(QuotaHolderSerial,
729
730
                               related_name="floating_ips", null=True,
                               on_delete=models.SET_NULL)
731
732

    def __unicode__(self):
733
        return "<FIP: %s@%s>" % (self.ipv4, self.network.id)
734
735
736
737
738
739
740
741

    def in_use(self):
        if self.machine is None:
            return False
        else:
            return (not self.machine.deleted)


742
743
744
745
class PoolTable(models.Model):
    available_map = models.TextField(default="", null=False)
    reserved_map = models.TextField(default="", null=False)
    size = models.IntegerField(null=False)
746

747
748
749
    # Optional Fields
    base = models.CharField(null=True, max_length=32)
    offset = models.IntegerField(null=True)
750

751
752
753
754
    class Meta:
        abstract = True

    @classmethod
755
    def get_pool(cls):
756
        try:
757
            pool_row = cls.objects.select_for_update().get()
758
            return pool_row.pool
Christos Stavrakakis's avatar
Christos Stavrakakis committed
759
        except cls.DoesNotExist:
760
            raise pools.EmptyPool
761

762
763
764
    @property
    def pool(self):
        return self.manager(self)
765
766


767
768
class BridgePoolTable(PoolTable):
    manager = pools.BridgePool
769

770
    def __unicode__(self):
771
        return u"<BridgePool id:%s>" % self.id
772

Christos Stavrakakis's avatar
Christos Stavrakakis committed
773

774
775
class MacPrefixPoolTable(PoolTable):
    manager = pools.MacPrefixPool
Christos Stavrakakis's avatar
Christos Stavrakakis committed
776

777
    def __unicode__(self):
778
        return u"<MACPrefixPool id:%s>" % self.id
779

Christos Stavrakakis's avatar
Christos Stavrakakis committed
780
781
782

class IPPoolTable(PoolTable):
    manager = pools.IPPool
783

784
785
786
    def __unicode__(self):
        return u"<IPv4AdressPool, network: %s>" % self.network

787
788
789

@contextmanager
def pooled_rapi_client(obj):
790
        if isinstance(obj, (VirtualMachine, BackendNetwork)):
791
792
793
794
795
            backend = obj.backend
        else:
            backend = obj

        if backend.offline:
796
            log.warning("Trying to connect with offline backend: %s", backend)
797
798
            raise faults.ServiceUnavailable("Can not connect to offline"
                                            " backend: %s" % backend)
799
800
801
802

        b = backend
        client = get_rapi_client(b.id, b.hash, b.clustername, b.port,
                                 b.username, b.password)
803
804
805
806
        try:
            yield client
        finally:
            put_rapi_client(client)
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829


class VirtualMachineDiagnosticManager(models.Manager):
    """
    Custom manager for :class:`VirtualMachineDiagnostic` model.
    """

    # diagnostic creation helpers
    def create_for_vm(self, vm, level, message, **kwargs):
        attrs = {'machine': vm, 'level': level, 'message': message}
        attrs.update(kwargs)
        # update instance updated time
        self.create(**attrs)
        vm.save()

    def create_error(self, vm, **kwargs):
        self.create_for_vm(vm, 'ERROR', **kwargs)

    def create_debug(self, vm, **kwargs):
        self.create_for_vm(vm, 'DEBUG', **kwargs)

    def since(self, vm, created_since, **kwargs):
        return self.get_query_set().filter(vm=vm, created__gt=created_since,
Christos Stavrakakis's avatar
Christos Stavrakakis committed
830
                                           **kwargs)
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848


class VirtualMachineDiagnostic(models.Model):
    """
    Model to store backend information messages that relate to the state of
    the virtual machine.
    """

    TYPES = (
        ('ERROR', 'Error'),
        ('WARNING', 'Warning'),
        ('INFO', 'Info'),
        ('DEBUG', 'Debug'),
    )

    objects = VirtualMachineDiagnosticManager()

    created = models.DateTimeField(auto_now_add=True)
849
850
    machine = models.ForeignKey('VirtualMachine', related_name="diagnostics",
                                on_delete=models.CASCADE)
851
852
853
854
855
856
857
858
    level = models.CharField(max_length=20, choices=TYPES)
    source = models.CharField(max_length=100)
    source_date = models.DateTimeField(null=True)
    message = models.CharField(max_length=255)
    details = models.TextField(null=True)

    class Meta:
        ordering = ['-created']