models.py 15.4 KB
Newer Older
1 2
# coding=utf-8

3
from contextlib import contextmanager
4
import logging
5 6
import uuid

7
from django.db.models import (Model, BooleanField, CharField, DateTimeField,
8
                              ForeignKey)
9
from django.utils import timezone
10
from django.utils.translation import ugettext_lazy as _
11
from model_utils.models import TimeStampedModel
12
from sizefield.models import FileSizeField
13

14
from acl.models import AclBase
15
from .tasks import local_tasks, remote_tasks
16
from celery.exceptions import TimeoutError
17
from common.models import ActivityModel, activitycontextimpl, WorkerNotFound
18 19 20 21

logger = logging.getLogger(__name__)


22
class DataStore(Model):
Guba Sándor committed
23

24 25
    """Collection of virtual disks.
    """
26 27 28 29
    name = CharField(max_length=100, unique=True, verbose_name=_('name'))
    path = CharField(max_length=200, unique=True, verbose_name=_('path'))
    hostname = CharField(max_length=40, unique=True,
                         verbose_name=_('hostname'))
Guba Sándor committed
30

31 32 33 34 35 36 37 38
    class Meta:
        ordering = ['name']
        verbose_name = _('datastore')
        verbose_name_plural = _('datastores')

    def __unicode__(self):
        return u'%s (%s)' % (self.name, self.path)

39
    def get_remote_queue_name(self, queue_id, check_worker=True):
40 41
        logger.debug("Checking for storage queue %s.%s",
                     self.hostname, queue_id)
42 43
        if not check_worker or local_tasks.check_queue(self.hostname,
                                                       queue_id):
44 45 46
            return self.hostname + '.' + queue_id
        else:
            raise WorkerNotFound()
47

48

49
class Disk(AclBase, TimeStampedModel):
Guba Sándor committed
50

51 52
    """A virtual disk.
    """
53 54 55 56 57
    ACL_LEVELS = (
        ('user', _('user')),          # see all details
        ('operator', _('operator')),
        ('owner', _('owner')),        # superuser, can delete, delegate perms
    )
58 59
    TYPES = [('qcow2-norm', 'qcow2 normal'), ('qcow2-snap', 'qcow2 snapshot'),
             ('iso', 'iso'), ('raw-ro', 'raw read-only'), ('raw-rw', 'raw')]
60 61 62 63 64
    name = CharField(blank=True, max_length=100, verbose_name=_("name"))
    filename = CharField(max_length=256, verbose_name=_("filename"))
    datastore = ForeignKey(DataStore, verbose_name=_("datastore"),
                           help_text=_("The datastore that holds the disk."))
    type = CharField(max_length=10, choices=TYPES)
65
    size = FileSizeField()
66 67
    base = ForeignKey('self', blank=True, null=True,
                      related_name='derivatives')
68 69
    ready = BooleanField(default=False,
                         help_text=_("The associated resource is ready."))
70
    dev_num = CharField(default='a', max_length=1,
71
                        verbose_name=_("device number"))
72
    destroyed = DateTimeField(blank=True, default=None, null=True)
73 74 75 76 77 78

    class Meta:
        ordering = ['name']
        verbose_name = _('disk')
        verbose_name_plural = _('disks')

79 80
    class WrongDiskTypeError(Exception):

81 82 83 84 85 86 87 88
        def __init__(self, type, message=None):
            if message is None:
                message = ("Operation can't be invoked on a disk of type '%s'."
                           % type)

            Exception.__init__(self, message)

            self.type = type
89

90 91
    class DiskInUseError(Exception):

92 93 94 95
        def __init__(self, disk, message=None):
            if message is None:
                message = ("The requested operation can't be performed on "
                           "disk '%s (%s)' because it is in use." %
Dudás Ádám committed
96
                           (disk.name, disk.filename))
97 98 99 100

            Exception.__init__(self, message)

            self.disk = disk
101

102 103
    @property
    def path(self):
104
        """Get the path where the files are stored."""
105 106 107 108
        return self.datastore.path + '/' + self.filename

    @property
    def format(self):
109
        """Returns the proper file format for different type of images."""
110 111 112
        return {
            'qcow2-norm': 'qcow2',
            'qcow2-snap': 'qcow2',
113
            'iso': 'raw',
114 115 116 117
            'raw-ro': 'raw',
            'raw-rw': 'raw',
        }[self.type]

118 119
    @property
    def device_type(self):
120
        """Returns the proper device prefix for different file format."""
121
        return {
122 123
            'qcow2-norm': 'vd',
            'qcow2-snap': 'vd',
124
            'iso': 'hd',
125 126 127
            'raw-ro': 'vd',
            'raw-rw': 'vd',
        }[self.type]
128

129
    def is_in_use(self):
130
        """Returns True if disc is attached to an active VM else False"""
131
        return any([i.state != 'STOPPED' for i in self.instance_set.all()])
132

133 134
    def get_exclusive(self):
        """Get an instance of the disk for exclusive usage.
135

136 137 138
        This method manipulates the database only.
        """
        type_mapping = {
139 140 141
            'qcow2-norm': 'qcow2-snap',
            'iso': 'iso',
            'raw-ro': 'raw-rw',
142 143 144 145 146 147 148
        }

        if self.type not in type_mapping.keys():
            raise self.WrongDiskTypeError(self.type)

        filename = self.filename if self.type == 'iso' else str(uuid.uuid4())
        new_type = type_mapping[self.type]
149

150 151 152
        return Disk.objects.create(base=self, datastore=self.datastore,
                                   filename=filename, name=self.name,
                                   size=self.size, type=new_type)
153 154

    def get_vmdisk_desc(self):
155
        """Serialize disk object to the vmdriver."""
156
        return {
157
            'source': self.path,
158 159
            'driver_type': self.format,
            'driver_cache': 'default',
160
            'target_device': self.device_type + self.dev_num,
161
            'disk_device': 'cdrom' if self.type == 'iso' else 'disk'
162 163
        }

164
    def get_disk_desc(self):
165
        """Serialize disk object to the storage driver."""
166 167 168 169 170 171 172 173 174
        return {
            'name': self.filename,
            'dir': self.datastore.path,
            'format': self.format,
            'size': self.size,
            'base_name': self.base.filename if self.base else None,
            'type': 'snapshot' if self.type == 'qcow2-snap' else 'normal'
        }

175
    def get_remote_queue_name(self, queue_id):
176
        """Returns the proper queue name based on the datastore."""
177 178 179 180 181
        if self.datastore:
            return self.datastore.get_remote_queue_name(queue_id)
        else:
            return None

182 183 184
    def __unicode__(self):
        return u"%s (#%d)" % (self.name, self.id)

185 186 187 188 189
    def clean(self, *args, **kwargs):
        if self.size == "" and self.base:
            self.size = self.base.size
        super(Disk, self).clean(*args, **kwargs)

190
    def deploy(self, user=None, task_uuid=None):
191 192 193 194 195
        """Reify the disk model on the associated data store.

        :param self: the disk model to reify
        :type self: storage.models.Disk

196 197 198 199 200 201 202
        :param user: The user who's issuing the command.
        :type user: django.contrib.auth.models.User

        :param task_uuid: The task's UUID, if the command is being executed
                          asynchronously.
        :type task_uuid: str

203 204 205 206
        :return: True if a new reification of the disk has been created;
                 otherwise, False.
        :rtype: bool
        """
207 208 209 210
        if self.destroyed:
            self.destroyed = None
            self.save()

211
        if self.ready:
212
            return False
213

214 215 216 217
        with disk_activity(code_suffix='deploy', disk=self,
                           task_uuid=task_uuid, user=user) as act:

            # Delegate create / snapshot jobs
218
            queue_name = self.get_remote_queue_name('storage')
219 220 221 222 223 224 225 226 227 228 229 230
            disk_desc = self.get_disk_desc()
            if self.type == 'qcow2-snap':
                with act.sub_activity('creating_snapshot'):
                    remote_tasks.snapshot.apply_async(args=[disk_desc],
                                                      queue=queue_name).get()
            else:
                with act.sub_activity('creating_disk'):
                    remote_tasks.create.apply_async(args=[disk_desc],
                                                    queue=queue_name).get()

            self.ready = True
            self.save()
231

232
            return True
233

234
    def deploy_async(self, user=None):
235 236
        """Execute deploy asynchronously.
        """
237 238
        return local_tasks.deploy.apply_async(args=[self, user],
                                              queue="localhost.man")
239

240
    @classmethod
241 242 243 244 245 246 247 248 249 250 251 252
    def create_empyt_async(instance=None, params=None, user=None):
        """Create empty Disk object asynchronusly.

        :param instance: instnace object to connect disk
        :type instane: vm.models.Instance
        :param params: disk custom parameters
        :type params: dict
        :param user: owner of the disk
        :type user: django.contrib.auth.User
        """
        return local_tasks.create_empty.apply_async(
            args=[instance, params, user], queue="localhost.man")
253 254

    @classmethod
255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276
    def create_empty(cls, instance=None, params=None,
                     user=None, task_uuid=None):
        """Create empty Disk object.

        :param instance: instnace object to connect disk
        :type instane: vm.models.Instance
        :param params: disk custom parameters
        :type params: dict
        :param user: owner of the disk
        :type user: django.contrib.auth.User
        """
        with disk_activity(code_suffix="create", task_uuid=task_uuid,
                           user=user) as act:
            disk = cls()
            if params:
                disk.__dict__.update(params)
            disk.save()
            act.disk = disk
            act.save()
            if instance:
                instance.disks.add(disk)
            return disk
277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293

    @classmethod
    def create_from_url_async(cls, url, instance=None, params=None, user=None):
        """Create disk object and download data from url asynchronusly.

        :param url: image url to download.
        :type url: url
        :param instance: instnace object to connect disk
        :type instane: vm.models.Instance
        :param params: disk custom parameters
        :type params: dict
        :param user: owner of the disk
        :type user: django.contrib.auth.User

        :return: Task
        :rtype: AsyncResult
        """
294
        return local_tasks.create_from_url.apply_async(kwargs={
295 296
            'cls': cls, 'url': url, 'instance': instance,
            'params': params, 'user': user},
297
            queue='localhost.man')
298

299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315
    @classmethod
    def create_from_url(cls, url, instance=None, params=None, user=None,
                        task_uuid=None, abortable_task=None):
        """Create disk object and download data from url synchronusly.

        :param url: image url to download.
        :type url: url
        :param instance: instnace object to connect disk
        :type instane: vm.models.Instance
        :param params: disk custom parameters
        :type params: dict
        :param user: owner of the disk
        :type user: django.contrib.auth.User

        :return: Task
        :rtype: AsyncResult
        """
316 317 318 319
        disk = cls()
        disk.filename = str(uuid.uuid4())
        disk.type = "iso"
        disk.size = 1
320
        # TODO get proper datastore
321
        disk.datastore = DataStore.objects.all()[0]
322 323
        if params:
            disk.__dict__.update(params)
324
        disk.save()
325 326
        if instance:
            instance.disks.add(disk)
327 328
        queue_name = disk.get_remote_queue_name('storage')

329 330 331 332 333 334 335 336 337
        def __on_abort(activity, error):
            activity.disk.destroyed = timezone.now()
            activity.disk.save()

        if abortable_task:
            from celery.contrib.abortable import AbortableAsyncResult

            class AbortException(Exception):
                pass
338 339

        with disk_activity(code_suffix='download', disk=disk,
340 341 342 343 344 345 346 347 348 349 350 351 352 353
                           task_uuid=task_uuid, user=user,
                           on_abort=__on_abort):
            result = remote_tasks.download.apply_async(
                kwargs={'url': url, 'parent_id': task_uuid,
                        'disk': disk.get_disk_desc()},
                queue=queue_name)
            while True:
                try:
                    size = result.get(timeout=5)
                    break
                except TimeoutError:
                    if abortable_task and abortable_task.is_aborted():
                        AbortableAsyncResult(result.id).abort()
                        raise AbortException("Download aborted by user.")
354
            disk.size = size
355
            disk.ready = True
356 357
            disk.save()

358
    def destroy(self, user=None, task_uuid=None):
359 360 361
        if self.destroyed:
            return False

362 363 364 365
        with disk_activity(code_suffix='destroy', disk=self,
                           task_uuid=task_uuid, user=user):
            self.destroyed = timezone.now()
            self.save()
366

367
            return True
368

369
    def destroy_async(self, user=None):
370 371
        """Execute destroy asynchronously.
        """
372 373
        return local_tasks.destroy.apply_async(args=[self, user],
                                               queue='localhost.man')
374

375
    def restore(self, user=None, task_uuid=None):
376
        """Restore destroyed disk.
377 378 379 380 381 382 383 384
        """
        # TODO
        pass

    def restore_async(self, user=None):
        local_tasks.restore.apply_async(args=[self, user],
                                        queue='localhost.man')

385
    def save_as(self, user=None, task_uuid=None):
386 387 388 389 390 391 392 393 394 395 396 397
        mapping = {
            'qcow2-snap': ('qcow2-norm', self.base),
        }
        if self.type not in mapping.keys():
            raise self.WrongDiskTypeError(self.type)

        if self.is_in_use():
            raise self.DiskInUseError(self)

        # from this point on, the caller has to guarantee that the disk is not
        # going to be used until the operation is complete

398 399 400 401 402 403 404
        with disk_activity(code_suffix='save_as', disk=self,
                           task_uuid=task_uuid, user=user):

            filename = str(uuid.uuid4())
            new_type, new_base = mapping[self.type]

            disk = Disk.objects.create(base=new_base, datastore=self.datastore,
405
                                       filename=filename, name=self.name,
406 407
                                       size=self.size, type=new_type)

408
            queue_name = self.get_remote_queue_name('storage')
409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424
            remote_tasks.merge.apply_async(args=[self.get_disk_desc(),
                                                 disk.get_disk_desc()],
                                           queue=queue_name).get()

            disk.ready = True
            disk.save()

            return disk


class DiskActivity(ActivityModel):
    disk = ForeignKey(Disk, related_name='activity_log',
                      help_text=_('Disk this activity works on.'),
                      verbose_name=_('disk'))

    @classmethod
425
    def create(cls, code_suffix, disk, task_uuid=None, user=None):
426
        act = cls(activity_code='storage.Disk.' + code_suffix,
427
                  disk=disk, parent=None, started=timezone.now(),
428
                  task_uuid=task_uuid, user=user)
429
        act.save()
430
        return act
431

432 433 434
    def create_sub(self, code_suffix, task_uuid=None):
        act = DiskActivity(
            activity_code=self.activity_code + '.' + code_suffix,
435
            disk=self.disk, parent=self, started=timezone.now(),
436 437 438
            task_uuid=task_uuid, user=self.user)
        act.save()
        return act
439

440 441 442
    @contextmanager
    def sub_activity(self, code_suffix, task_uuid=None):
        act = self.create_sub(code_suffix, task_uuid)
443
        return activitycontextimpl(act)
444

445

446
@contextmanager
447 448
def disk_activity(code_suffix, disk, task_uuid=None, user=None,
                  on_abort=None, on_commit=None):
449
    act = DiskActivity.create(code_suffix, disk, task_uuid, user)
450
    return activitycontextimpl(act, on_abort=on_abort, on_commit=on_commit)