2016-01-14 12:12:51 +00:00
# ex:ts=4:sw=4:sts=4:et
# -*- tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*-
#
# Copyright (c) 2013-2016 Intel Corporation.
# All rights reserved.
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License version 2 as
# published by the Free Software Foundation.
#
# This program 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 this program; if not, write to the Free Software Foundation, Inc.,
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
#
# DESCRIPTION
# This module provides the OpenEmbedded partition object definitions.
#
# AUTHORS
# Tom Zanussi <tom.zanussi (at] linux.intel.com>
# Ed Bartosh <ed.bartosh> (at] linux.intel.com>
import os
import tempfile
from wic . utils . oe . misc import msger , parse_sourceparams
wic: obey the rootfs size from the metadata
When no --size is specified for the rootfs in the .wks, we want to obey the
rootfs size from the metadata, otherwise the defined IMAGE_ROOTFS_EXTRA_SPACE
and IMAGE_OVERHEAD_FACTOR will not be obeyed. In some cases, this can result
in image construction failure, if the size determined by du was insufficient
to hold the files without the aforementioned extra space.
This fallback from --size to ROOTFS_SIZE was already implemented when
--rootfs-dir is specified in the .wks, but it did not occur otherwise, neither
when --rootfs-dir= was passed to `wic create` nor when IMAGE_ROOTFS was used.
This made a certain amount of sense, as this fallback logic happened at such
a level that it wasn't able to identify which partitions were rootfs
partitions otherwise. Rather than doing it at that level, we can do it in
prepare_rootfs(), which is run by the rootfs source plugins.
Note that IMAGE_OVERHEAD_FACTOR and a --overhead-factor in the .wks will now
both be applied when --size isn't specified in the .wks. A warning is added
about this, though a user won't see it unless wic fails or they examine the
do_image_wic log.
Fixes [YOCTO #10815]
(From OE-Core rev: 1d50e11286722c4114c1ae0bc285f846cd85fc4c)
Signed-off-by: Christopher Larson <chris_larson@mentor.com>
Signed-off-by: Ross Burton <ross.burton@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-12-15 19:42:39 +00:00
from wic . utils . oe . misc import exec_cmd , exec_native_cmd , get_bitbake_var
2016-01-14 12:12:51 +00:00
from wic . plugin import pluginmgr
partition_methods = {
" do_stage_partition " : None ,
" do_prepare_partition " : None ,
" do_configure_partition " : None ,
}
2016-05-04 13:06:17 +00:00
class Partition ( ) :
2016-01-14 12:12:51 +00:00
def __init__ ( self , args , lineno ) :
self . args = args
self . active = args . active
self . align = args . align
self . disk = args . disk
self . extra_space = args . extra_space
self . fsopts = args . fsopts
self . fstype = args . fstype
self . label = args . label
self . mountpoint = args . mountpoint
self . no_table = args . no_table
self . overhead_factor = args . overhead_factor
self . part_type = args . part_type
self . rootfs_dir = args . rootfs_dir
self . size = args . size
2016-12-19 11:20:58 +00:00
self . fixed_size = args . fixed_size
2016-01-14 12:12:51 +00:00
self . source = args . source
self . sourceparams = args . sourceparams
2016-04-22 09:32:01 +00:00
self . system_id = args . system_id
2016-02-13 09:02:18 +00:00
self . use_uuid = args . use_uuid
2016-01-14 12:12:51 +00:00
self . uuid = args . uuid
self . lineno = lineno
self . source_file = " "
self . sourceparams_dict = { }
def get_extra_block_count ( self , current_blocks ) :
"""
The - - size param is reflected in self . size ( in kB ) , and we already
have current_blocks ( 1 k ) blocks , calculate and return the
number of ( 1 k ) blocks we need to add to get to - - size , 0 if
we ' re already there or beyond.
"""
msger . debug ( " Requested partition size for %s : %d " % \
( self . mountpoint , self . size ) )
if not self . size :
return 0
requested_blocks = self . size
msger . debug ( " Requested blocks %d , current_blocks %d " % \
( requested_blocks , current_blocks ) )
if requested_blocks > current_blocks :
return requested_blocks - current_blocks
else :
return 0
2016-12-19 11:20:58 +00:00
def get_rootfs_size ( self , actual_rootfs_size = 0 ) :
"""
Calculate the required size of rootfs taking into consideration
- - size / - - fixed - size flags as well as overhead and extra space , as
specified in kickstart file . Raises an error if the
` actual_rootfs_size ` is larger than fixed - size rootfs .
"""
if self . fixed_size :
rootfs_size = self . fixed_size
if actual_rootfs_size > rootfs_size :
msger . error ( " Actual rootfs size ( %d kB) is larger than allowed size %d kB " \
% ( actual_rootfs_size , rootfs_size ) )
else :
extra_blocks = self . get_extra_block_count ( actual_rootfs_size )
if extra_blocks < self . extra_space :
extra_blocks = self . extra_space
rootfs_size = actual_rootfs_size + extra_blocks
rootfs_size * = self . overhead_factor
msger . debug ( " Added %d extra blocks to %s to get to %d total blocks " % \
( extra_blocks , self . mountpoint , rootfs_size ) )
return rootfs_size
@property
def disk_size ( self ) :
"""
Obtain on - disk size of partition taking into consideration
- - size / - - fixed - size options .
"""
return self . fixed_size if self . fixed_size else self . size
2016-01-14 12:12:51 +00:00
def prepare ( self , creator , cr_workdir , oe_builddir , rootfs_dir ,
bootimg_dir , kernel_dir , native_sysroot ) :
"""
Prepare content for individual partitions , depending on
partition command parameters .
"""
if self . sourceparams :
self . sourceparams_dict = parse_sourceparams ( self . sourceparams )
if not self . source :
2016-12-19 11:20:58 +00:00
if not self . size and not self . fixed_size :
msger . error ( " The %s partition has a size of zero. Please "
" specify a non-zero --size/--fixed-size for that partition. " % \
2016-01-14 12:12:51 +00:00
self . mountpoint )
if self . fstype and self . fstype == " swap " :
self . prepare_swap_partition ( cr_workdir , oe_builddir ,
native_sysroot )
2016-02-25 17:21:49 +00:00
self . source_file = " %s /fs. %s " % ( cr_workdir , self . fstype )
2016-01-14 12:12:51 +00:00
elif self . fstype :
rootfs = " %s /fs_ %s . %s . %s " % ( cr_workdir , self . label ,
self . lineno , self . fstype )
if os . path . isfile ( rootfs ) :
os . remove ( rootfs )
for prefix in ( " ext " , " btrfs " , " vfat " , " squashfs " ) :
if self . fstype . startswith ( prefix ) :
method = getattr ( self ,
" prepare_empty_partition_ " + prefix )
method ( rootfs , oe_builddir , native_sysroot )
self . source_file = rootfs
break
return
plugins = pluginmgr . get_source_plugins ( )
if self . source not in plugins :
msger . error ( " The ' %s ' --source specified for %s doesn ' t exist. \n \t "
" See ' wic list source-plugins ' for a list of available "
" --sources. \n \t See ' wic help source-plugins ' for "
" details on adding a new source plugin. " % \
( self . source , self . mountpoint ) )
self . _source_methods = pluginmgr . get_source_plugin_methods ( \
self . source , partition_methods )
self . _source_methods [ " do_configure_partition " ] ( self , self . sourceparams_dict ,
creator , cr_workdir ,
oe_builddir ,
bootimg_dir ,
kernel_dir ,
native_sysroot )
self . _source_methods [ " do_stage_partition " ] ( self , self . sourceparams_dict ,
creator , cr_workdir ,
oe_builddir ,
bootimg_dir , kernel_dir ,
native_sysroot )
self . _source_methods [ " do_prepare_partition " ] ( self , self . sourceparams_dict ,
creator , cr_workdir ,
oe_builddir ,
bootimg_dir , kernel_dir , rootfs_dir ,
native_sysroot )
2016-12-19 11:20:58 +00:00
2016-11-10 12:18:32 +00:00
# further processing required Partition.size to be an integer, make
# sure that it is one
if type ( self . size ) is not int :
msger . error ( " Partition %s internal size is not an integer. " \
" This a bug in source plugin %s and needs to be fixed. " \
% ( self . mountpoint , self . source ) )
2016-01-14 12:12:51 +00:00
2016-12-19 11:20:58 +00:00
if self . fixed_size and self . size > self . fixed_size :
msger . error ( " File system image of partition %s is larger ( %d kB) than its " \
" allowed size %d kB " % ( self . mountpoint ,
self . size , self . fixed_size ) )
2016-01-14 12:12:51 +00:00
def prepare_rootfs_from_fs_image ( self , cr_workdir , oe_builddir ,
rootfs_dir ) :
"""
Handle an already - created partition e . g . xxx . ext3
"""
rootfs = oe_builddir
du_cmd = " du -Lbks %s " % rootfs
out = exec_cmd ( du_cmd )
rootfs_size = out . split ( ) [ 0 ]
2016-11-10 12:18:32 +00:00
self . size = int ( rootfs_size )
2016-01-14 12:12:51 +00:00
self . source_file = rootfs
def prepare_rootfs ( self , cr_workdir , oe_builddir , rootfs_dir ,
native_sysroot ) :
"""
Prepare content for a rootfs partition i . e . create a partition
and fill it from a / rootfs dir .
Currently handles ext2 / 3 / 4 , btrfs and vfat .
"""
p_prefix = os . environ . get ( " PSEUDO_PREFIX " , " %s /usr " % native_sysroot )
p_localstatedir = os . environ . get ( " PSEUDO_LOCALSTATEDIR " ,
" %s /../pseudo " % rootfs_dir )
p_passwd = os . environ . get ( " PSEUDO_PASSWD " , rootfs_dir )
p_nosymlinkexp = os . environ . get ( " PSEUDO_NOSYMLINKEXP " , " 1 " )
pseudo = " export PSEUDO_PREFIX= %s ; " % p_prefix
pseudo + = " export PSEUDO_LOCALSTATEDIR= %s ; " % p_localstatedir
pseudo + = " export PSEUDO_PASSWD= %s ; " % p_passwd
pseudo + = " export PSEUDO_NOSYMLINKEXP= %s ; " % p_nosymlinkexp
pseudo + = " %s /usr/bin/pseudo " % native_sysroot
rootfs = " %s /rootfs_ %s . %s . %s " % ( cr_workdir , self . label ,
self . lineno , self . fstype )
if os . path . isfile ( rootfs ) :
os . remove ( rootfs )
2016-11-10 12:18:34 +00:00
if not self . fstype :
msger . error ( " File system for partition %s not specified in kickstart, " \
" use --fstype option " % ( self . mountpoint ) )
wic: obey the rootfs size from the metadata
When no --size is specified for the rootfs in the .wks, we want to obey the
rootfs size from the metadata, otherwise the defined IMAGE_ROOTFS_EXTRA_SPACE
and IMAGE_OVERHEAD_FACTOR will not be obeyed. In some cases, this can result
in image construction failure, if the size determined by du was insufficient
to hold the files without the aforementioned extra space.
This fallback from --size to ROOTFS_SIZE was already implemented when
--rootfs-dir is specified in the .wks, but it did not occur otherwise, neither
when --rootfs-dir= was passed to `wic create` nor when IMAGE_ROOTFS was used.
This made a certain amount of sense, as this fallback logic happened at such
a level that it wasn't able to identify which partitions were rootfs
partitions otherwise. Rather than doing it at that level, we can do it in
prepare_rootfs(), which is run by the rootfs source plugins.
Note that IMAGE_OVERHEAD_FACTOR and a --overhead-factor in the .wks will now
both be applied when --size isn't specified in the .wks. A warning is added
about this, though a user won't see it unless wic fails or they examine the
do_image_wic log.
Fixes [YOCTO #10815]
(From OE-Core rev: 1d50e11286722c4114c1ae0bc285f846cd85fc4c)
Signed-off-by: Christopher Larson <chris_larson@mentor.com>
Signed-off-by: Ross Burton <ross.burton@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-12-15 19:42:39 +00:00
# Get rootfs size from bitbake variable if it's not set in .ks file
if not self . size :
# Bitbake variable ROOTFS_SIZE is calculated in
# Image._get_rootfs_size method from meta/lib/oe/image.py
# using IMAGE_ROOTFS_SIZE, IMAGE_ROOTFS_ALIGNMENT,
# IMAGE_OVERHEAD_FACTOR and IMAGE_ROOTFS_EXTRA_SPACE
rsize_bb = get_bitbake_var ( ' ROOTFS_SIZE ' )
if rsize_bb :
msger . warning ( ' overhead-factor was specified, but size was not, so bitbake variables will be used for the size. In this case both IMAGE_OVERHEAD_FACTOR and --overhead-factor will be applied ' )
self . size = int ( round ( float ( rsize_bb ) ) )
2016-01-14 12:12:51 +00:00
for prefix in ( " ext " , " btrfs " , " vfat " , " squashfs " ) :
if self . fstype . startswith ( prefix ) :
method = getattr ( self , " prepare_rootfs_ " + prefix )
method ( rootfs , oe_builddir , rootfs_dir , native_sysroot , pseudo )
self . source_file = rootfs
# get the rootfs size in the right units for kickstart (kB)
du_cmd = " du -Lbks %s " % rootfs
out = exec_cmd ( du_cmd )
2016-11-10 12:18:32 +00:00
self . size = int ( out . split ( ) [ 0 ] )
2016-01-14 12:12:51 +00:00
break
def prepare_rootfs_ext ( self , rootfs , oe_builddir , rootfs_dir ,
native_sysroot , pseudo ) :
"""
Prepare content for an ext2 / 3 / 4 rootfs partition .
"""
du_cmd = " du -ks %s " % rootfs_dir
out = exec_cmd ( du_cmd )
actual_rootfs_size = int ( out . split ( ) [ 0 ] )
2016-12-19 11:20:58 +00:00
rootfs_size = self . get_rootfs_size ( actual_rootfs_size )
2016-01-14 12:12:51 +00:00
2016-11-02 20:33:07 +00:00
with open ( rootfs , ' w ' ) as sparse :
os . ftruncate ( sparse . fileno ( ) , rootfs_size * 1024 )
2016-01-14 12:12:51 +00:00
extra_imagecmd = " -i 8192 "
label_str = " "
if self . label :
label_str = " -L %s " % self . label
mkfs_cmd = " mkfs. %s -F %s %s %s -d %s " % \
( self . fstype , extra_imagecmd , rootfs , label_str , rootfs_dir )
exec_native_cmd ( mkfs_cmd , native_sysroot , pseudo = pseudo )
def prepare_rootfs_btrfs ( self , rootfs , oe_builddir , rootfs_dir ,
native_sysroot , pseudo ) :
"""
Prepare content for a btrfs rootfs partition .
Currently handles ext2 / 3 / 4 and btrfs .
"""
du_cmd = " du -ks %s " % rootfs_dir
out = exec_cmd ( du_cmd )
actual_rootfs_size = int ( out . split ( ) [ 0 ] )
2016-12-19 11:20:58 +00:00
rootfs_size = self . get_rootfs_size ( actual_rootfs_size )
2016-01-14 12:12:51 +00:00
2016-11-02 20:33:07 +00:00
with open ( rootfs , ' w ' ) as sparse :
os . ftruncate ( sparse . fileno ( ) , rootfs_size * 1024 )
2016-01-14 12:12:51 +00:00
label_str = " "
if self . label :
label_str = " -L %s " % self . label
mkfs_cmd = " mkfs. %s -b %d -r %s %s %s " % \
( self . fstype , rootfs_size * 1024 , rootfs_dir , label_str , rootfs )
exec_native_cmd ( mkfs_cmd , native_sysroot , pseudo = pseudo )
def prepare_rootfs_vfat ( self , rootfs , oe_builddir , rootfs_dir ,
native_sysroot , pseudo ) :
"""
Prepare content for a vfat rootfs partition .
"""
du_cmd = " du -bks %s " % rootfs_dir
out = exec_cmd ( du_cmd )
blocks = int ( out . split ( ) [ 0 ] )
2016-12-19 11:20:58 +00:00
rootfs_size = self . get_rootfs_size ( blocks )
2016-01-14 12:12:51 +00:00
label_str = " -n boot "
if self . label :
label_str = " -n %s " % self . label
2016-12-19 11:20:58 +00:00
dosfs_cmd = " mkdosfs %s -S 512 -C %s %d " % ( label_str , rootfs , rootfs_size )
2016-01-14 12:12:51 +00:00
exec_native_cmd ( dosfs_cmd , native_sysroot )
mcopy_cmd = " mcopy -i %s -s %s /* ::/ " % ( rootfs , rootfs_dir )
exec_native_cmd ( mcopy_cmd , native_sysroot )
chmod_cmd = " chmod 644 %s " % rootfs
exec_cmd ( chmod_cmd )
def prepare_rootfs_squashfs ( self , rootfs , oe_builddir , rootfs_dir ,
native_sysroot , pseudo ) :
"""
Prepare content for a squashfs rootfs partition .
"""
squashfs_cmd = " mksquashfs %s %s -noappend " % \
( rootfs_dir , rootfs )
exec_native_cmd ( squashfs_cmd , native_sysroot , pseudo = pseudo )
def prepare_empty_partition_ext ( self , rootfs , oe_builddir ,
native_sysroot ) :
"""
Prepare an empty ext2 / 3 / 4 partition .
"""
2016-12-19 11:20:58 +00:00
size = self . disk_size
2016-11-02 20:33:07 +00:00
with open ( rootfs , ' w ' ) as sparse :
2016-12-19 11:20:58 +00:00
os . ftruncate ( sparse . fileno ( ) , size * 1024 )
2016-01-14 12:12:51 +00:00
extra_imagecmd = " -i 8192 "
label_str = " "
if self . label :
label_str = " -L %s " % self . label
mkfs_cmd = " mkfs. %s -F %s %s %s " % \
( self . fstype , extra_imagecmd , label_str , rootfs )
exec_native_cmd ( mkfs_cmd , native_sysroot )
def prepare_empty_partition_btrfs ( self , rootfs , oe_builddir ,
native_sysroot ) :
"""
Prepare an empty btrfs partition .
"""
2016-12-19 11:20:58 +00:00
size = self . disk_size
2016-11-02 20:33:07 +00:00
with open ( rootfs , ' w ' ) as sparse :
2016-12-19 11:20:58 +00:00
os . ftruncate ( sparse . fileno ( ) , size * 1024 )
2016-01-14 12:12:51 +00:00
label_str = " "
if self . label :
label_str = " -L %s " % self . label
mkfs_cmd = " mkfs. %s -b %d %s %s " % \
( self . fstype , self . size * 1024 , label_str , rootfs )
exec_native_cmd ( mkfs_cmd , native_sysroot )
def prepare_empty_partition_vfat ( self , rootfs , oe_builddir ,
native_sysroot ) :
"""
Prepare an empty vfat partition .
"""
2016-12-19 11:20:58 +00:00
blocks = self . disk_size
2016-01-14 12:12:51 +00:00
label_str = " -n boot "
if self . label :
label_str = " -n %s " % self . label
dosfs_cmd = " mkdosfs %s -S 512 -C %s %d " % ( label_str , rootfs , blocks )
exec_native_cmd ( dosfs_cmd , native_sysroot )
chmod_cmd = " chmod 644 %s " % rootfs
exec_cmd ( chmod_cmd )
def prepare_empty_partition_squashfs ( self , cr_workdir , oe_builddir ,
native_sysroot ) :
"""
Prepare an empty squashfs partition .
"""
msger . warning ( " Creating of an empty squashfs %s partition was attempted. " \
" Proceeding as requested. " % self . mountpoint )
path = " %s /fs_ %s . %s " % ( cr_workdir , self . label , self . fstype )
os . path . isfile ( path ) and os . remove ( path )
# it is not possible to create a squashfs without source data,
# thus prepare an empty temp dir that is used as source
tmpdir = tempfile . mkdtemp ( )
squashfs_cmd = " mksquashfs %s %s -noappend " % \
( tmpdir , path )
exec_native_cmd ( squashfs_cmd , native_sysroot )
os . rmdir ( tmpdir )
# get the rootfs size in the right units for kickstart (kB)
du_cmd = " du -Lbks %s " % path
out = exec_cmd ( du_cmd )
fs_size = out . split ( ) [ 0 ]
2016-11-10 12:18:32 +00:00
self . size = int ( fs_size )
2016-01-14 12:12:51 +00:00
def prepare_swap_partition ( self , cr_workdir , oe_builddir , native_sysroot ) :
"""
Prepare a swap partition .
"""
path = " %s /fs. %s " % ( cr_workdir , self . fstype )
2016-11-02 20:33:07 +00:00
with open ( path , ' w ' ) as sparse :
os . ftruncate ( sparse . fileno ( ) , self . size * 1024 )
2016-01-14 12:12:51 +00:00
import uuid
label_str = " "
if self . label :
label_str = " -L %s " % self . label
mkswap_cmd = " mkswap %s -U %s %s " % ( label_str , str ( uuid . uuid1 ( ) ) , path )
exec_native_cmd ( mkswap_cmd , native_sysroot )