Statistics
| Branch: | Tag: | Revision:

root / image_creator / bundle_volume.py @ 4a35faa5

History | View | Annotate | Download (15.3 kB)

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

    
34
import os
35
import re
36
import tempfile
37
from collections import namedtuple
38

    
39
import parted
40

    
41
from image_creator.rsync import Rsync
42
from image_creator.util import get_command
43
from image_creator.util import FatalError
44
from image_creator.util import try_fail_repeat
45

    
46
findfs = get_command('findfs')
47
dd = get_command('dd')
48
dmsetup = get_command('dmsetup')
49
losetup = get_command('losetup')
50
mount = get_command('mount')
51
umount = get_command('umount')
52
blkid = get_command('blkid')
53

    
54
MKFS_OPTS = {'ext2': ['-F'],
55
             'ext3': ['-F'],
56
             'ext4': ['-F'],
57
             'reiserfs': ['-ff'],
58
             'btrfs': [],
59
             'minix': [],
60
             'xfs': ['-f'],
61
             'jfs': ['-f'],
62
             'ntfs': ['-F'],
63
             'msdos': [],
64
             'vfat': []}
65

    
66

    
67
class BundleVolume(object):
68
    """This class can be used to create an image out of the running system"""
69

    
70
    def __init__(self, out, meta):
71
        """Create an instance of the BundleVolume class."""
72
        self.out = out
73
        self.meta = meta
74

    
75
        self.out.output('Searching for root device ...', False)
76
        root = self._get_root_partition()
77

    
78
        if root.startswith("UUID=") or root.startswith("LABEL="):
79
            root = findfs(root).stdout.strip()
80

    
81
        if not re.match('/dev/[hsv]d[a-z][1-9]*$', root):
82
            raise FatalError("Don't know how to handle root device: %s" % root)
83

    
84
        out.success(root)
85

    
86
        disk_file = re.split('[0-9]', root)[0]
87
        device = parted.Device(disk_file)
88
        self.disk = parted.Disk(device)
89

    
90
    def _read_fstable(self, f):
91

    
92
        if not os.path.isfile(f):
93
            raise FatalError("Unable to open: `%s'. File is missing." % f)
94

    
95
        FileSystemTableEntry = namedtuple('FileSystemTableEntry',
96
                                          'dev mpoint fs opts freq passno')
97
        with open(f) as table:
98
            for line in iter(table):
99
                entry = line.split('#')[0].strip().split()
100
                if len(entry) != 6:
101
                    continue
102
                yield FileSystemTableEntry(*entry)
103

    
104
    def _get_root_partition(self):
105
        for entry in self._read_fstable('/etc/fstab'):
106
            if entry.mpoint == '/':
107
                return entry.dev
108

    
109
        raise FatalError("Unable to find root device in /etc/fstab")
110

    
111
    def _is_mpoint(self, path):
112
        for entry in self._read_fstable('/proc/mounts'):
113
            if entry.mpoint == path:
114
                return True
115
        return False
116

    
117
    def _get_mount_options(self, device):
118
        for entry in self._read_fstable('/proc/mounts'):
119
            if not entry.dev.startswith('/'):
120
                continue
121

    
122
            if os.path.realpath(entry.dev) == os.path.realpath(device):
123
                return entry
124

    
125
        return None
126

    
127
    def _create_partition_table(self, image):
128

    
129
        if self.disk.type != 'msdos':
130
            raise FatalError('Only msdos partition tables are supported')
131

    
132
        # Copy the MBR and the space between the MBR and the first partition.
133
        # In Grub version 1 Stage 1.5 is located there.
134
        first_sector = self.disk.getPrimaryPartitions()[0].geometry.start
135

    
136
        dd('if=%s' % self.disk.device.path, 'of=%s' % image,
137
           'bs=%d' % self.disk.device.sectorSize,
138
           'count=%d' % first_sector, 'conv=notrunc')
139

    
140
        # Create the Extended boot records (EBRs) in the image
141
        extended = self.disk.getExtendedPartition()
142
        if not extended:
143
            return
144

    
145
        # Extended boot records precede the logical partitions they describe
146
        logical = self.disk.getLogicalPartitions()
147
        start = extended.geometry.start
148
        for i in range(len(logical)):
149
            end = logical[i].geometry.start - 1
150
            dd('if=%s' % self.disk.device.path, 'of=%s' % image,
151
               'count=%d' % (end - start + 1), 'conv=notrunc',
152
               'seek=%d' % start, 'skip=%d' % start)
153
            start = logical[i].geometry.end + 1
154

    
155
    def _get_partitions(self, disk):
156
        Partition = namedtuple('Partition', 'num start end type fs')
157

    
158
        partitions = []
159
        for p in disk.partitions:
160
            num = p.number
161
            start = p.geometry.start
162
            end = p.geometry.end
163
            ptype = p.type
164
            fs = p.fileSystem.type if p.fileSystem is not None else ''
165
            partitions.append(Partition(num, start, end, ptype, fs))
166

    
167
        return partitions
168

    
169
    def _shrink_partitions(self, image):
170

    
171
        new_end = self.disk.device.getLength()
172

    
173
        image_dev = parted.Device(image)
174
        image_disk = parted.Disk(image_dev)
175

    
176
        is_extended = lambda p: p.type == parted.PARTITION_EXTENDED
177
        is_logical = lambda p: p.type == parted.PARTITION_LOGICAL
178

    
179
        partitions = self._get_partitions(self.disk)
180

    
181
        last = partitions[-1]
182
        if last.fs == 'linux-swap(v1)':
183
            MB = 2 ** 20
184
            size = (last.end - last.start + 1) * self.disk.device.sectorSize
185
            self.meta['SWAP'] = "%d:%s" % (last.num, (size + MB - 1) // MB)
186

    
187
            image_disk.deletePartition(
188
                image_disk.getPartitionBySector(last.start))
189
            image_disk.commit()
190

    
191
            if is_logical(last) and last.num == 5:
192
                extended = image_disk.getExtendedPartition()
193
                image_disk.deletePartition(extended)
194
                image_disk.commit()
195
                partitions.remove(filter(is_extended, partitions)[0])
196

    
197
            partitions.remove(last)
198
            last = partitions[-1]
199

    
200
            # Leave 2048 blocks at the end
201
            new_end = last.end + 2048
202

    
203
        mount_options = self._get_mount_options(
204
            self.disk.getPartitionBySector(last.start).path)
205
        if mount_options is not None:
206
            stat = os.statvfs(mount_options.mpoint)
207
            # Shrink the last partition. The new size should be the size of the
208
            # occupied blocks
209
            blcks = stat.f_blocks - stat.f_bavail
210
            new_size = (blcks * stat.f_frsize) // self.disk.device.sectorSize
211

    
212
            # Add 10% just to be on the safe side
213
            part_end = last.start + (new_size * 11) // 10
214
            # Align to 2048
215
            part_end = ((part_end + 2047) // 2048) * 2048
216

    
217
            image_disk.setPartitionGeometry(
218
                image_disk.getPartitionBySector(last.start),
219
                parted.Constraint(device=image_disk.device),
220
                start=last.start, end=part_end)
221
            image_disk.commit()
222

    
223
            # Parted may have changed this for better alignment
224
            part_end = image_disk.getPartitionBySector(last.start).geometry.end
225
            last = last._replace(end=part_end)
226
            partitions[-1] = last
227

    
228
            # Leave 2048 blocks at the end.
229
            new_end = part_end + 2048
230

    
231
            if last.type == parted.PARTITION_LOGICAL:
232
                # Fix the extended partition
233
                extended = disk.getExtendedPartition()
234

    
235
                image_disk.setPartitionGeometry(
236
                    extended, parted.Constraint(device=img_dev),
237
                    ext.geometry.start, end=last.end)
238
                image_disk.commit()
239

    
240
        image_dev.destroy()
241
        return new_end
242

    
243
    def _map_partition(self, dev, num, start, end):
244
        name = os.path.basename(dev)
245
        tablefd, table = tempfile.mkstemp()
246
        try:
247
            size = end - start + 1
248
            os.write(tablefd, "0 %d linear %s %d" % (size, dev, start))
249
            dmsetup('create', "%sp%d" % (name, num), table)
250
        finally:
251
            os.unlink(table)
252

    
253
        return "/dev/mapper/%sp%d" % (name, num)
254

    
255
    def _unmap_partition(self, dev):
256
        if not os.path.exists(dev):
257
            return
258

    
259
        try_fail_repeat(dmsetup, 'remove', dev.split('/dev/mapper/')[1])
260

    
261
    def _mount(self, target, devs):
262

    
263
        devs.sort(key=lambda d: d[1])
264
        for dev, mpoint in devs:
265
            absmpoint = os.path.abspath(target + mpoint)
266
            if not os.path.exists(absmpoint):
267
                os.makedirs(absmpoint)
268
            mount(dev, absmpoint)
269

    
270
    def _umount_all(self, target):
271
        mpoints = []
272
        for entry in self._read_fstable('/proc/mounts'):
273
            if entry.mpoint.startswith(os.path.abspath(target)):
274
                    mpoints.append(entry.mpoint)
275

    
276
        mpoints.sort()
277
        for mpoint in reversed(mpoints):
278
            try_fail_repeat(umount, mpoint)
279

    
280
    def _to_exclude(self):
281
        excluded = ['/tmp', '/var/tmp']
282
        local_filesystems = MKFS_OPTS.keys() + ['rootfs']
283
        for entry in self._read_fstable('/proc/mounts'):
284
            if entry.fs in local_filesystems:
285
                continue
286

    
287
            mpoint = entry.mpoint
288
            if mpoint in excluded:
289
                continue
290

    
291
            descendants = filter(
292
                lambda p: p.startswith(mpoint + '/'), excluded)
293
            if len(descendants):
294
                for d in descendants:
295
                    excluded.remove(d)
296
                excluded.append(mpoint)
297
                continue
298

    
299
            dirname = mpoint
300
            basename = ''
301
            found_ancestor = False
302
            while dirname != '/':
303
                (dirname, basename) = os.path.split(dirname)
304
                if dirname in excluded:
305
                    found_ancestor = True
306
                    break
307

    
308
            if not found_ancestor:
309
                excluded.append(mpoint)
310

    
311
        return map(lambda d: d + "/*", excluded)
312

    
313
    def _replace_uuids(self, target, new_uuid):
314

    
315
        files = ['/etc/fstab',
316
                 '/boot/grub/grub.cfg',
317
                 '/boot/grub/menu.lst',
318
                 '/boot/grub/grub.conf']
319

    
320
        orig = dict(map(
321
            lambda p: (
322
                p.number,
323
                blkid('-s', 'UUID', '-o', 'value', p.path).stdout.strip()),
324
            self.disk.partitions))
325

    
326
        for f in map(lambda f: target + f, files):
327

    
328
            if not os.path.exists(f):
329
                continue
330

    
331
            with open(f, 'r') as src:
332
                lines = src.readlines()
333
            with open(f, 'w') as dest:
334
                for line in lines:
335
                    for i, uuid in new_uuid.items():
336
                        line = re.sub(orig[i], uuid, line)
337
                    dest.write(line)
338

    
339
    def _create_filesystems(self, image):
340

    
341
        filesystem = {}
342
        for p in self.disk.partitions:
343
            filesystem[p.number] = self._get_mount_options(p.path)
344

    
345
        partitions = self._get_partitions(parted.Disk(parted.Device(image)))
346
        unmounted = filter(lambda p: filesystem[p.num] is None, partitions)
347
        mounted = filter(lambda p: filesystem[p.num] is not None, partitions)
348

    
349
        # For partitions that are not mounted right now, we can simply dd them
350
        # into the image.
351
        for p in unmounted:
352
            dd('if=%s' % self.disk.device.path, 'of=%s' % image,
353
               'count=%d' % (p.end - p.start + 1), 'conv=notrunc',
354
               'seek=%d' % p.start, 'skip=%d' % p.start)
355

    
356
        loop = str(losetup('-f', '--show', image)).strip()
357
        mapped = {}
358
        try:
359
            for p in mounted:
360
                i = p.num
361
                mapped[i] = self._map_partition(loop, i, p.start, p.end)
362

    
363
            new_uuid = {}
364
            # Create the file systems
365
            for i, dev in mapped.iteritems():
366
                fs = filesystem[i].fs
367
                self.out.output('Creating %s filesystem on partition %d ... ' %
368
                                (fs, i), False)
369
                get_command('mkfs.%s' % fs)(*(MKFS_OPTS[fs] + [dev]))
370
                self.out.success('done')
371
                new_uuid[i] = blkid(
372
                    '-s', 'UUID', '-o', 'value', dev).stdout.strip()
373

    
374
            target = tempfile.mkdtemp()
375
            try:
376
                absmpoints = self._mount(target,
377
                                         [(mapped[i], filesystem[i].mpoint)
378
                                         for i in mapped.keys()])
379
                exclude = self._to_exclude() + [image]
380

    
381
                rsync = Rsync(self.out)
382

    
383
                # Excluded paths need to be relative to the source
384
                for excl in map(lambda p: os.path.relpath(p, '/'), exclude):
385
                    rsync.exclude(excl)
386

    
387
                rsync.archive().hard_links().xattrs().sparse().acls()
388
                rsync.run('/', target, 'host', 'tmp image')
389

    
390
                # We need to replace the old UUID referencies with the new
391
                # ones in grub configuration files and /etc/fstab for file
392
                # systems that have been recreated.
393
                self._replace_uuids(target, new_uuid)
394

    
395
            finally:
396
                self._umount_all(target)
397
                os.rmdir(target)
398
        finally:
399
            for dev in mapped.values():
400
                self._unmap_partition(dev)
401
            losetup('-d', loop)
402

    
403
    def create_image(self, image):
404
        """Given an image filename, this method will create an image out of the
405
        running system.
406
        """
407

    
408
        size = self.disk.device.getLength() * self.disk.device.sectorSize
409

    
410
        # Create sparse file to host the image
411
        fd = os.open(image, os.O_WRONLY | os.O_CREAT)
412
        try:
413
            os.ftruncate(fd, size)
414
        finally:
415
            os.close(fd)
416

    
417
        self._create_partition_table(image)
418

    
419
        end_sector = self._shrink_partitions(image)
420

    
421
        size = (end_sector + 1) * self.disk.device.sectorSize
422

    
423
        # Truncate image to the new size.
424
        fd = os.open(image, os.O_RDWR)
425
        try:
426
            os.ftruncate(fd, size)
427
        finally:
428
            os.close(fd)
429

    
430
        # Check if the available space is enough to host the image
431
        dirname = os.path.dirname(image)
432
        self.out.output("Examining available space in %s ..." % dirname, False)
433
        stat = os.statvfs(dirname)
434
        available = stat.f_bavail * stat.f_frsize
435
        if available <= size:
436
            raise FatalError('Not enough space in %s to host the image' %
437
                             dirname)
438
        self.out.success("sufficient")
439

    
440
        self._create_filesystems(image)
441

    
442
        return image
443

    
444
# vim: set sta sts=4 shiftwidth=4 sw=4 et ai :