1# 2# Copyright (c) 2013-2016 Intel Corporation. 3# 4# SPDX-License-Identifier: GPL-2.0-only 5# 6# DESCRIPTION 7# This module provides the OpenEmbedded partition object definitions. 8# 9# AUTHORS 10# Tom Zanussi <tom.zanussi (at] linux.intel.com> 11# Ed Bartosh <ed.bartosh> (at] linux.intel.com> 12 13import logging 14import os 15import uuid 16 17from wic import WicError 18from wic.misc import exec_cmd, exec_native_cmd, get_bitbake_var 19from wic.pluginbase import PluginMgr 20 21logger = logging.getLogger('wic') 22 23class Partition(): 24 25 def __init__(self, args, lineno): 26 self.args = args 27 self.active = args.active 28 self.align = args.align 29 self.disk = args.disk 30 self.device = None 31 self.extra_space = args.extra_space 32 self.exclude_path = args.exclude_path 33 self.include_path = args.include_path 34 self.change_directory = args.change_directory 35 self.fsopts = args.fsopts 36 self.fspassno = args.fspassno 37 self.fstype = args.fstype 38 self.label = args.label 39 self.use_label = args.use_label 40 self.mkfs_extraopts = args.mkfs_extraopts 41 self.mountpoint = args.mountpoint 42 self.no_table = args.no_table 43 self.num = None 44 self.offset = args.offset 45 self.overhead_factor = args.overhead_factor 46 self.part_name = args.part_name 47 self.part_type = args.part_type 48 self.rootfs_dir = args.rootfs_dir 49 self.size = args.size 50 self.fixed_size = args.fixed_size 51 self.source = args.source 52 self.sourceparams = args.sourceparams 53 self.system_id = args.system_id 54 self.use_uuid = args.use_uuid 55 self.uuid = args.uuid 56 self.fsuuid = args.fsuuid 57 self.type = args.type 58 self.no_fstab_update = args.no_fstab_update 59 self.updated_fstab_path = None 60 self.has_fstab = False 61 self.update_fstab_in_rootfs = False 62 self.hidden = args.hidden 63 self.mbr = args.mbr 64 65 self.lineno = lineno 66 self.source_file = "" 67 68 def get_extra_block_count(self, current_blocks): 69 """ 70 The --size param is reflected in self.size (in kB), and we already 71 have current_blocks (1k) blocks, calculate and return the 72 number of (1k) blocks we need to add to get to --size, 0 if 73 we're already there or beyond. 74 """ 75 logger.debug("Requested partition size for %s: %d", 76 self.mountpoint, self.size) 77 78 if not self.size: 79 return 0 80 81 requested_blocks = self.size 82 83 logger.debug("Requested blocks %d, current_blocks %d", 84 requested_blocks, current_blocks) 85 86 if requested_blocks > current_blocks: 87 return requested_blocks - current_blocks 88 else: 89 return 0 90 91 def get_rootfs_size(self, actual_rootfs_size=0): 92 """ 93 Calculate the required size of rootfs taking into consideration 94 --size/--fixed-size flags as well as overhead and extra space, as 95 specified in kickstart file. Raises an error if the 96 `actual_rootfs_size` is larger than fixed-size rootfs. 97 98 """ 99 if self.fixed_size: 100 rootfs_size = self.fixed_size 101 if actual_rootfs_size > rootfs_size: 102 raise WicError("Actual rootfs size (%d kB) is larger than " 103 "allowed size %d kB" % 104 (actual_rootfs_size, rootfs_size)) 105 else: 106 extra_blocks = self.get_extra_block_count(actual_rootfs_size) 107 if extra_blocks < self.extra_space: 108 extra_blocks = self.extra_space 109 110 rootfs_size = actual_rootfs_size + extra_blocks 111 rootfs_size = int(rootfs_size * self.overhead_factor) 112 113 logger.debug("Added %d extra blocks to %s to get to %d total blocks", 114 extra_blocks, self.mountpoint, rootfs_size) 115 116 return rootfs_size 117 118 @property 119 def disk_size(self): 120 """ 121 Obtain on-disk size of partition taking into consideration 122 --size/--fixed-size options. 123 124 """ 125 return self.fixed_size if self.fixed_size else self.size 126 127 def prepare(self, creator, cr_workdir, oe_builddir, rootfs_dir, 128 bootimg_dir, kernel_dir, native_sysroot, updated_fstab_path): 129 """ 130 Prepare content for individual partitions, depending on 131 partition command parameters. 132 """ 133 self.updated_fstab_path = updated_fstab_path 134 if self.updated_fstab_path and not (self.fstype.startswith("ext") or self.fstype == "msdos"): 135 self.update_fstab_in_rootfs = True 136 137 if not self.source: 138 if self.fstype == "none" or self.no_table: 139 return 140 if not self.size and not self.fixed_size: 141 raise WicError("The %s partition has a size of zero. Please " 142 "specify a non-zero --size/--fixed-size for that " 143 "partition." % self.mountpoint) 144 145 if self.fstype == "swap": 146 self.prepare_swap_partition(cr_workdir, oe_builddir, 147 native_sysroot) 148 self.source_file = "%s/fs.%s" % (cr_workdir, self.fstype) 149 else: 150 if self.fstype in ('squashfs', 'erofs'): 151 raise WicError("It's not possible to create empty %s " 152 "partition '%s'" % (self.fstype, self.mountpoint)) 153 154 rootfs = "%s/fs_%s.%s.%s" % (cr_workdir, self.label, 155 self.lineno, self.fstype) 156 if os.path.isfile(rootfs): 157 os.remove(rootfs) 158 159 prefix = "ext" if self.fstype.startswith("ext") else self.fstype 160 method = getattr(self, "prepare_empty_partition_" + prefix) 161 method(rootfs, oe_builddir, native_sysroot) 162 self.source_file = rootfs 163 return 164 165 plugins = PluginMgr.get_plugins('source') 166 167 if self.source not in plugins: 168 raise WicError("The '%s' --source specified for %s doesn't exist.\n\t" 169 "See 'wic list source-plugins' for a list of available" 170 " --sources.\n\tSee 'wic help source-plugins' for " 171 "details on adding a new source plugin." % 172 (self.source, self.mountpoint)) 173 174 srcparams_dict = {} 175 if self.sourceparams: 176 # Split sourceparams string of the form key1=val1[,key2=val2,...] 177 # into a dict. Also accepts valueless keys i.e. without = 178 splitted = self.sourceparams.split(',') 179 srcparams_dict = dict((par.split('=', 1) + [None])[:2] for par in splitted if par) 180 181 plugin = PluginMgr.get_plugins('source')[self.source] 182 plugin.do_configure_partition(self, srcparams_dict, creator, 183 cr_workdir, oe_builddir, bootimg_dir, 184 kernel_dir, native_sysroot) 185 plugin.do_stage_partition(self, srcparams_dict, creator, 186 cr_workdir, oe_builddir, bootimg_dir, 187 kernel_dir, native_sysroot) 188 plugin.do_prepare_partition(self, srcparams_dict, creator, 189 cr_workdir, oe_builddir, bootimg_dir, 190 kernel_dir, rootfs_dir, native_sysroot) 191 plugin.do_post_partition(self, srcparams_dict, creator, 192 cr_workdir, oe_builddir, bootimg_dir, 193 kernel_dir, rootfs_dir, native_sysroot) 194 195 # further processing required Partition.size to be an integer, make 196 # sure that it is one 197 if not isinstance(self.size, int): 198 raise WicError("Partition %s internal size is not an integer. " 199 "This a bug in source plugin %s and needs to be fixed." % 200 (self.mountpoint, self.source)) 201 202 if self.fixed_size and self.size > self.fixed_size: 203 raise WicError("File system image of partition %s is " 204 "larger (%d kB) than its allowed size %d kB" % 205 (self.mountpoint, self.size, self.fixed_size)) 206 207 def prepare_rootfs(self, cr_workdir, oe_builddir, rootfs_dir, 208 native_sysroot, real_rootfs = True, pseudo_dir = None): 209 """ 210 Prepare content for a rootfs partition i.e. create a partition 211 and fill it from a /rootfs dir. 212 213 Currently handles ext2/3/4, btrfs, vfat and squashfs. 214 """ 215 216 rootfs = "%s/rootfs_%s.%s.%s" % (cr_workdir, self.label, 217 self.lineno, self.fstype) 218 if os.path.isfile(rootfs): 219 os.remove(rootfs) 220 221 p_prefix = os.environ.get("PSEUDO_PREFIX", "%s/usr" % native_sysroot) 222 if (pseudo_dir): 223 # Canonicalize the ignore paths. This corresponds to 224 # calling oe.path.canonicalize(), which is used in bitbake.conf. 225 ignore_paths = [rootfs] + (get_bitbake_var("PSEUDO_IGNORE_PATHS") or "").split(",") 226 canonical_paths = [] 227 for path in ignore_paths: 228 if "$" not in path: 229 trailing_slash = path.endswith("/") and "/" or "" 230 canonical_paths.append(os.path.realpath(path) + trailing_slash) 231 ignore_paths = ",".join(canonical_paths) 232 233 pseudo = "export PSEUDO_PREFIX=%s;" % p_prefix 234 pseudo += "export PSEUDO_LOCALSTATEDIR=%s;" % pseudo_dir 235 pseudo += "export PSEUDO_PASSWD=%s;" % rootfs_dir 236 pseudo += "export PSEUDO_NOSYMLINKEXP=1;" 237 pseudo += "export PSEUDO_IGNORE_PATHS=%s;" % ignore_paths 238 pseudo += "%s " % get_bitbake_var("FAKEROOTCMD") 239 else: 240 pseudo = None 241 242 if not self.size and real_rootfs: 243 # The rootfs size is not set in .ks file so try to get it 244 # from bitbake variable 245 rsize_bb = get_bitbake_var('ROOTFS_SIZE') 246 rdir = get_bitbake_var('IMAGE_ROOTFS') 247 if rsize_bb and rdir == rootfs_dir: 248 # Bitbake variable ROOTFS_SIZE is calculated in 249 # Image._get_rootfs_size method from meta/lib/oe/image.py 250 # using IMAGE_ROOTFS_SIZE, IMAGE_ROOTFS_ALIGNMENT, 251 # IMAGE_OVERHEAD_FACTOR and IMAGE_ROOTFS_EXTRA_SPACE 252 self.size = int(round(float(rsize_bb))) 253 else: 254 # Bitbake variable ROOTFS_SIZE is not defined so compute it 255 # from the rootfs_dir size using the same logic found in 256 # get_rootfs_size() from meta/classes/image.bbclass 257 du_cmd = "du -ks %s" % rootfs_dir 258 out = exec_cmd(du_cmd) 259 self.size = int(out.split()[0]) 260 261 prefix = "ext" if self.fstype.startswith("ext") else self.fstype 262 method = getattr(self, "prepare_rootfs_" + prefix) 263 method(rootfs, cr_workdir, oe_builddir, rootfs_dir, native_sysroot, pseudo) 264 self.source_file = rootfs 265 266 # get the rootfs size in the right units for kickstart (kB) 267 du_cmd = "du -Lbks %s" % rootfs 268 out = exec_cmd(du_cmd) 269 self.size = int(out.split()[0]) 270 271 def prepare_rootfs_ext(self, rootfs, cr_workdir, oe_builddir, rootfs_dir, 272 native_sysroot, pseudo): 273 """ 274 Prepare content for an ext2/3/4 rootfs partition. 275 """ 276 du_cmd = "du -ks %s" % rootfs_dir 277 out = exec_cmd(du_cmd) 278 actual_rootfs_size = int(out.split()[0]) 279 280 rootfs_size = self.get_rootfs_size(actual_rootfs_size) 281 282 with open(rootfs, 'w') as sparse: 283 os.ftruncate(sparse.fileno(), rootfs_size * 1024) 284 285 extraopts = self.mkfs_extraopts or "-F -i 8192" 286 287 if os.getenv('SOURCE_DATE_EPOCH'): 288 sde_time = int(os.getenv('SOURCE_DATE_EPOCH')) 289 if pseudo: 290 pseudo = "export E2FSPROGS_FAKE_TIME=%s;%s " % (sde_time, pseudo) 291 else: 292 pseudo = "export E2FSPROGS_FAKE_TIME=%s; " % sde_time 293 294 # Set hash_seed to generate deterministic directory indexes 295 namespace = uuid.UUID("e7429877-e7b3-4a68-a5c9-2f2fdf33d460") 296 if self.fsuuid: 297 namespace = uuid.UUID(self.fsuuid) 298 hash_seed = str(uuid.uuid5(namespace, str(sde_time))) 299 extraopts += " -E hash_seed=%s" % hash_seed 300 301 label_str = "" 302 if self.label: 303 label_str = "-L %s" % self.label 304 305 mkfs_cmd = "mkfs.%s %s %s %s -U %s -d %s" % \ 306 (self.fstype, extraopts, rootfs, label_str, self.fsuuid, rootfs_dir) 307 exec_native_cmd(mkfs_cmd, native_sysroot, pseudo=pseudo) 308 309 if self.updated_fstab_path and self.has_fstab and not self.no_fstab_update: 310 debugfs_script_path = os.path.join(cr_workdir, "debugfs_script") 311 with open(debugfs_script_path, "w") as f: 312 f.write("cd etc\n") 313 f.write("rm fstab\n") 314 f.write("write %s fstab\n" % (self.updated_fstab_path)) 315 debugfs_cmd = "debugfs -w -f %s %s" % (debugfs_script_path, rootfs) 316 exec_native_cmd(debugfs_cmd, native_sysroot) 317 318 mkfs_cmd = "fsck.%s -pvfD %s" % (self.fstype, rootfs) 319 exec_native_cmd(mkfs_cmd, native_sysroot, pseudo=pseudo) 320 321 if os.getenv('SOURCE_DATE_EPOCH'): 322 sde_time = hex(int(os.getenv('SOURCE_DATE_EPOCH'))) 323 debugfs_script_path = os.path.join(cr_workdir, "debugfs_script") 324 files = [] 325 for root, dirs, others in os.walk(rootfs_dir): 326 base = root.replace(rootfs_dir, "").rstrip(os.sep) 327 files += [ "/" if base == "" else base ] 328 files += [ base + "/" + n for n in dirs + others ] 329 with open(debugfs_script_path, "w") as f: 330 f.write("set_current_time %s\n" % (sde_time)) 331 if self.updated_fstab_path and self.has_fstab and not self.no_fstab_update: 332 f.write("set_inode_field /etc/fstab mtime %s\n" % (sde_time)) 333 f.write("set_inode_field /etc/fstab mtime_extra 0\n") 334 for file in set(files): 335 for time in ["atime", "ctime", "crtime"]: 336 f.write("set_inode_field \"%s\" %s %s\n" % (file, time, sde_time)) 337 f.write("set_inode_field \"%s\" %s_extra 0\n" % (file, time)) 338 for time in ["wtime", "mkfs_time", "lastcheck"]: 339 f.write("set_super_value %s %s\n" % (time, sde_time)) 340 for time in ["mtime", "first_error_time", "last_error_time"]: 341 f.write("set_super_value %s 0\n" % (time)) 342 debugfs_cmd = "debugfs -w -f %s %s" % (debugfs_script_path, rootfs) 343 exec_native_cmd(debugfs_cmd, native_sysroot) 344 345 self.check_for_Y2038_problem(rootfs, native_sysroot) 346 347 def prepare_rootfs_btrfs(self, rootfs, cr_workdir, oe_builddir, rootfs_dir, 348 native_sysroot, pseudo): 349 """ 350 Prepare content for a btrfs rootfs partition. 351 """ 352 du_cmd = "du -ks %s" % rootfs_dir 353 out = exec_cmd(du_cmd) 354 actual_rootfs_size = int(out.split()[0]) 355 356 rootfs_size = self.get_rootfs_size(actual_rootfs_size) 357 358 with open(rootfs, 'w') as sparse: 359 os.ftruncate(sparse.fileno(), rootfs_size * 1024) 360 361 label_str = "" 362 if self.label: 363 label_str = "-L %s" % self.label 364 365 mkfs_cmd = "mkfs.%s -b %d -r %s %s %s -U %s %s" % \ 366 (self.fstype, rootfs_size * 1024, rootfs_dir, label_str, 367 self.mkfs_extraopts, self.fsuuid, rootfs) 368 exec_native_cmd(mkfs_cmd, native_sysroot, pseudo=pseudo) 369 370 def prepare_rootfs_msdos(self, rootfs, cr_workdir, oe_builddir, rootfs_dir, 371 native_sysroot, pseudo): 372 """ 373 Prepare content for a msdos/vfat rootfs partition. 374 """ 375 du_cmd = "du -bks %s" % rootfs_dir 376 out = exec_cmd(du_cmd) 377 blocks = int(out.split()[0]) 378 379 rootfs_size = self.get_rootfs_size(blocks) 380 381 label_str = "-n boot" 382 if self.label: 383 label_str = "-n %s" % self.label 384 385 size_str = "" 386 387 extraopts = self.mkfs_extraopts or '-S 512' 388 389 dosfs_cmd = "mkdosfs %s -i %s %s %s -C %s %d" % \ 390 (label_str, self.fsuuid, size_str, extraopts, rootfs, 391 rootfs_size) 392 exec_native_cmd(dosfs_cmd, native_sysroot) 393 394 mcopy_cmd = "mcopy -i %s -s %s/* ::/" % (rootfs, rootfs_dir) 395 exec_native_cmd(mcopy_cmd, native_sysroot) 396 397 if self.updated_fstab_path and self.has_fstab and not self.no_fstab_update: 398 mcopy_cmd = "mcopy -m -i %s %s ::/etc/fstab" % (rootfs, self.updated_fstab_path) 399 exec_native_cmd(mcopy_cmd, native_sysroot) 400 401 chmod_cmd = "chmod 644 %s" % rootfs 402 exec_cmd(chmod_cmd) 403 404 prepare_rootfs_vfat = prepare_rootfs_msdos 405 406 def prepare_rootfs_squashfs(self, rootfs, cr_workdir, oe_builddir, rootfs_dir, 407 native_sysroot, pseudo): 408 """ 409 Prepare content for a squashfs rootfs partition. 410 """ 411 extraopts = self.mkfs_extraopts or '-noappend' 412 squashfs_cmd = "mksquashfs %s %s %s" % \ 413 (rootfs_dir, rootfs, extraopts) 414 exec_native_cmd(squashfs_cmd, native_sysroot, pseudo=pseudo) 415 416 def prepare_rootfs_erofs(self, rootfs, cr_workdir, oe_builddir, rootfs_dir, 417 native_sysroot, pseudo): 418 """ 419 Prepare content for a erofs rootfs partition. 420 """ 421 extraopts = self.mkfs_extraopts or '' 422 erofs_cmd = "mkfs.erofs %s -U %s %s %s" % \ 423 (extraopts, self.fsuuid, rootfs, rootfs_dir) 424 exec_native_cmd(erofs_cmd, native_sysroot, pseudo=pseudo) 425 426 def prepare_empty_partition_none(self, rootfs, oe_builddir, native_sysroot): 427 pass 428 429 def prepare_empty_partition_ext(self, rootfs, oe_builddir, 430 native_sysroot): 431 """ 432 Prepare an empty ext2/3/4 partition. 433 """ 434 size = self.disk_size 435 with open(rootfs, 'w') as sparse: 436 os.ftruncate(sparse.fileno(), size * 1024) 437 438 extraopts = self.mkfs_extraopts or "-i 8192" 439 440 label_str = "" 441 if self.label: 442 label_str = "-L %s" % self.label 443 444 mkfs_cmd = "mkfs.%s -F %s %s -U %s %s" % \ 445 (self.fstype, extraopts, label_str, self.fsuuid, rootfs) 446 exec_native_cmd(mkfs_cmd, native_sysroot) 447 448 self.check_for_Y2038_problem(rootfs, native_sysroot) 449 450 def prepare_empty_partition_btrfs(self, rootfs, oe_builddir, 451 native_sysroot): 452 """ 453 Prepare an empty btrfs partition. 454 """ 455 size = self.disk_size 456 with open(rootfs, 'w') as sparse: 457 os.ftruncate(sparse.fileno(), size * 1024) 458 459 label_str = "" 460 if self.label: 461 label_str = "-L %s" % self.label 462 463 mkfs_cmd = "mkfs.%s -b %d %s -U %s %s %s" % \ 464 (self.fstype, self.size * 1024, label_str, self.fsuuid, 465 self.mkfs_extraopts, rootfs) 466 exec_native_cmd(mkfs_cmd, native_sysroot) 467 468 def prepare_empty_partition_msdos(self, rootfs, oe_builddir, 469 native_sysroot): 470 """ 471 Prepare an empty vfat partition. 472 """ 473 blocks = self.disk_size 474 475 label_str = "-n boot" 476 if self.label: 477 label_str = "-n %s" % self.label 478 479 size_str = "" 480 481 extraopts = self.mkfs_extraopts or '-S 512' 482 483 dosfs_cmd = "mkdosfs %s -i %s %s %s -C %s %d" % \ 484 (label_str, self.fsuuid, extraopts, size_str, rootfs, 485 blocks) 486 487 exec_native_cmd(dosfs_cmd, native_sysroot) 488 489 chmod_cmd = "chmod 644 %s" % rootfs 490 exec_cmd(chmod_cmd) 491 492 prepare_empty_partition_vfat = prepare_empty_partition_msdos 493 494 def prepare_swap_partition(self, cr_workdir, oe_builddir, native_sysroot): 495 """ 496 Prepare a swap partition. 497 """ 498 path = "%s/fs.%s" % (cr_workdir, self.fstype) 499 500 with open(path, 'w') as sparse: 501 os.ftruncate(sparse.fileno(), self.size * 1024) 502 503 label_str = "" 504 if self.label: 505 label_str = "-L %s" % self.label 506 507 mkswap_cmd = "mkswap %s -U %s %s" % (label_str, self.fsuuid, path) 508 exec_native_cmd(mkswap_cmd, native_sysroot) 509 510 def check_for_Y2038_problem(self, rootfs, native_sysroot): 511 """ 512 Check if the filesystem is affected by the Y2038 problem 513 (Y2038 problem = 32 bit time_t overflow in January 2038) 514 """ 515 def get_err_str(part): 516 err = "The {} filesystem {} has no Y2038 support." 517 if part.mountpoint: 518 args = [part.fstype, "mounted at %s" % part.mountpoint] 519 elif part.label: 520 args = [part.fstype, "labeled '%s'" % part.label] 521 elif part.part_name: 522 args = [part.fstype, "in partition '%s'" % part.part_name] 523 else: 524 args = [part.fstype, "in partition %s" % part.num] 525 return err.format(*args) 526 527 # ext2 and ext3 are always affected by the Y2038 problem 528 if self.fstype in ["ext2", "ext3"]: 529 logger.warn(get_err_str(self)) 530 return 531 532 ret, out = exec_native_cmd("dumpe2fs %s" % rootfs, native_sysroot) 533 534 # if ext4 is affected by the Y2038 problem depends on the inode size 535 for line in out.splitlines(): 536 if line.startswith("Inode size:"): 537 size = int(line.split(":")[1].strip()) 538 if size < 256: 539 logger.warn("%s Inodes (of size %d) are too small." % 540 (get_err_str(self), size)) 541 break 542 543