kiwi-el8/kiwi/filesystem/base.py
Marcus Schäfer c79afab617 Support for overlay disk images
overlay disk images uses a readonly root partition and are
overlayed using overlayfs to hook in a cow based read-write
space. This commit implements the basic disk setup.
Implementation to boot such a disk in the kiwi boot code
is still missing, as well as the investigation if dracut
is able to boot such a disk too. References #65
2016-06-01 08:40:51 +02:00

151 lines
4.8 KiB
Python

# Copyright (c) 2015 SUSE Linux GmbH. All rights reserved.
#
# This file is part of kiwi.
#
# kiwi is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# kiwi is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with kiwi. If not, see <http://www.gnu.org/licenses/>
#
import os
# project
from ..logger import log
from ..utils.sync import DataSync
from ..mount_manager import MountManager
from ..exceptions import (
KiwiFileSystemSyncError
)
class FileSystemBase(object):
"""
Implements base class for filesystem interface
Attributes
* :attr:`filesystem_mount`
mount point when the filesystem is mounted for data sync
* :attr:`device_provider`
Instance of a class based on DeviceProvider
required for filesystems which needs a block device for
creation. In most cases the DeviceProvider is a LoopDevice
* :attr:`root_dir`
root directory path name
* :attr:`filename`
filesystem file if no block device is needed to create
it, e.g squashfs
* :attr:`custom_args`
custom filesystem arguments
"""
def __init__(self, device_provider, root_dir=None, custom_args=None):
# filesystems created with a block device stores the mountpoint
# here. The file name of the file containing the filesystem is
# stored in the device_provider if the filesystem is represented
# as a file there
self.filesystem_mount = None
# bind the block device providing class instance to this object.
# This is done to guarantee the correct destructor order when
# the device should be released. This is only required if the
# filesystem required a block device to become created
self.device_provider = device_provider
self.root_dir = root_dir
# filesystems created without a block device stores the result
# filesystem file name here
self.filename = None
self.custom_args = {}
self.post_init(custom_args)
def post_init(self, custom_args):
"""
Post initialization method
Store dictionary of custom arguments if not empty. This
overrides the default custom argument hash
:param dict custom_args: custom arguments
"""
if custom_args:
self.custom_args = custom_args
if 'create_options' not in self.custom_args:
self.custom_args['create_options'] = []
if 'mount_options' not in self.custom_args:
self.custom_args['mount_options'] = []
def create_on_device(self, label=None):
"""
Create filesystem on block device
Implement in specialized filesystem class for filesystems which
requires a block device for creation, e.g ext4.
:param string label: label name
"""
raise NotImplementedError
def create_on_file(self, filename, label=None, exclude=None):
"""
Create filesystem from root data tree
Implement in specialized filesystem class for filesystems which
requires a data tree for creation, e.g squashfs.
:param string filename: result file path name
:param string label: label name
:param list exclude: list of exclude dirs/files
"""
raise NotImplementedError
def sync_data(self, exclude=None):
"""
Copy root data tree into filesystem
:param list exclude: list of exclude dirs/files
"""
if not self.root_dir:
raise KiwiFileSystemSyncError(
'no root directory specified'
)
if not os.path.exists(self.root_dir):
raise KiwiFileSystemSyncError(
'given root directory %s does not exist' % self.root_dir
)
self.filesystem_mount = MountManager(
device=self.device_provider.get_device()
)
self.filesystem_mount.mount(
self.custom_args['mount_options']
)
data = DataSync(
self.root_dir, self.filesystem_mount.mountpoint
)
data.sync_data(
options=['-a', '-H', '-X', '-A', '--one-file-system'],
exclude=exclude
)
self.filesystem_mount.umount()
def __del__(self):
if self.filesystem_mount:
log.info('Cleaning up %s instance', type(self).__name__)
self.filesystem_mount.umount()