Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 1 | # |
| 2 | # Copyright (c) 2014, Intel Corporation. |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 3 | # |
Brad Bishop | c342db3 | 2019-05-15 21:57:59 -0400 | [diff] [blame] | 4 | # SPDX-License-Identifier: GPL-2.0-only |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 5 | # |
| 6 | # DESCRIPTION |
| 7 | # This implements the 'bootimg-efi' source plugin class for 'wic' |
| 8 | # |
| 9 | # AUTHORS |
| 10 | # Tom Zanussi <tom.zanussi (at] linux.intel.com> |
| 11 | # |
| 12 | |
Brad Bishop | 6e60e8b | 2018-02-01 10:27:11 -0500 | [diff] [blame] | 13 | import logging |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 14 | import os |
| 15 | import shutil |
| 16 | |
Brad Bishop | 6e60e8b | 2018-02-01 10:27:11 -0500 | [diff] [blame] | 17 | from wic import WicError |
| 18 | from wic.engine import get_custom_config |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 19 | from wic.pluginbase import SourcePlugin |
Brad Bishop | d7bf8c1 | 2018-02-25 22:55:05 -0500 | [diff] [blame] | 20 | from wic.misc import (exec_cmd, exec_native_cmd, |
| 21 | get_bitbake_var, BOOTDD_EXTRA_SPACE) |
Brad Bishop | 6e60e8b | 2018-02-01 10:27:11 -0500 | [diff] [blame] | 22 | |
| 23 | logger = logging.getLogger('wic') |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 24 | |
| 25 | class BootimgEFIPlugin(SourcePlugin): |
| 26 | """ |
| 27 | Create EFI boot partition. |
Brad Bishop | 6e60e8b | 2018-02-01 10:27:11 -0500 | [diff] [blame] | 28 | This plugin supports GRUB 2 and systemd-boot bootloaders. |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 29 | """ |
| 30 | |
| 31 | name = 'bootimg-efi' |
| 32 | |
| 33 | @classmethod |
Brad Bishop | d5ae7d9 | 2018-06-14 09:52:03 -0700 | [diff] [blame] | 34 | def do_configure_grubefi(cls, hdddir, creator, cr_workdir, source_params): |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 35 | """ |
| 36 | Create loader-specific (grub-efi) config |
| 37 | """ |
Patrick Williams | d8c66bc | 2016-06-20 12:57:21 -0500 | [diff] [blame] | 38 | configfile = creator.ks.bootloader.configfile |
| 39 | custom_cfg = None |
| 40 | if configfile: |
| 41 | custom_cfg = get_custom_config(configfile) |
| 42 | if custom_cfg: |
| 43 | # Use a custom configuration for grub |
| 44 | grubefi_conf = custom_cfg |
Brad Bishop | 6e60e8b | 2018-02-01 10:27:11 -0500 | [diff] [blame] | 45 | logger.debug("Using custom configuration file " |
| 46 | "%s for grub.cfg", configfile) |
Patrick Williams | d8c66bc | 2016-06-20 12:57:21 -0500 | [diff] [blame] | 47 | else: |
Brad Bishop | 6e60e8b | 2018-02-01 10:27:11 -0500 | [diff] [blame] | 48 | raise WicError("configfile is specified but failed to " |
| 49 | "get it from %s." % configfile) |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 50 | |
Brad Bishop | d5ae7d9 | 2018-06-14 09:52:03 -0700 | [diff] [blame] | 51 | initrd = source_params.get('initrd') |
| 52 | |
| 53 | if initrd: |
| 54 | bootimg_dir = get_bitbake_var("DEPLOY_DIR_IMAGE") |
| 55 | if not bootimg_dir: |
| 56 | raise WicError("Couldn't find DEPLOY_DIR_IMAGE, exiting") |
| 57 | |
| 58 | cp_cmd = "cp %s/%s %s" % (bootimg_dir, initrd, hdddir) |
| 59 | exec_cmd(cp_cmd, True) |
| 60 | else: |
| 61 | logger.debug("Ignoring missing initrd") |
| 62 | |
Patrick Williams | d8c66bc | 2016-06-20 12:57:21 -0500 | [diff] [blame] | 63 | if not custom_cfg: |
| 64 | # Create grub configuration using parameters from wks file |
| 65 | bootloader = creator.ks.bootloader |
Brad Bishop | 1932369 | 2019-04-05 15:28:33 -0400 | [diff] [blame] | 66 | title = source_params.get('title') |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 67 | |
Patrick Williams | d8c66bc | 2016-06-20 12:57:21 -0500 | [diff] [blame] | 68 | grubefi_conf = "" |
| 69 | grubefi_conf += "serial --unit=0 --speed=115200 --word=8 --parity=no --stop=1\n" |
| 70 | grubefi_conf += "default=boot\n" |
| 71 | grubefi_conf += "timeout=%s\n" % bootloader.timeout |
Brad Bishop | 1932369 | 2019-04-05 15:28:33 -0400 | [diff] [blame] | 72 | grubefi_conf += "menuentry '%s'{\n" % (title if title else "boot") |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 73 | |
Brad Bishop | 15ae250 | 2019-06-18 21:44:24 -0400 | [diff] [blame^] | 74 | kernel = get_bitbake_var("KERNEL_IMAGETYPE") |
| 75 | if not kernel: |
| 76 | kernel = "bzImage" |
Patrick Williams | d8c66bc | 2016-06-20 12:57:21 -0500 | [diff] [blame] | 77 | |
Brad Bishop | 15ae250 | 2019-06-18 21:44:24 -0400 | [diff] [blame^] | 78 | label = source_params.get('label') |
| 79 | label_conf = "root=%s" % creator.rootdev |
| 80 | if label: |
| 81 | label_conf = "LABEL=%s" % label |
| 82 | |
| 83 | grubefi_conf += "linux /%s %s rootwait %s\n" \ |
| 84 | % (kernel, label_conf, bootloader.append) |
Brad Bishop | d5ae7d9 | 2018-06-14 09:52:03 -0700 | [diff] [blame] | 85 | |
| 86 | if initrd: |
| 87 | grubefi_conf += "initrd /%s\n" % initrd |
| 88 | |
Patrick Williams | d8c66bc | 2016-06-20 12:57:21 -0500 | [diff] [blame] | 89 | grubefi_conf += "}\n" |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 90 | |
Brad Bishop | 6e60e8b | 2018-02-01 10:27:11 -0500 | [diff] [blame] | 91 | logger.debug("Writing grubefi config %s/hdd/boot/EFI/BOOT/grub.cfg", |
| 92 | cr_workdir) |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 93 | cfg = open("%s/hdd/boot/EFI/BOOT/grub.cfg" % cr_workdir, "w") |
| 94 | cfg.write(grubefi_conf) |
| 95 | cfg.close() |
| 96 | |
| 97 | @classmethod |
Brad Bishop | 6e60e8b | 2018-02-01 10:27:11 -0500 | [diff] [blame] | 98 | def do_configure_systemdboot(cls, hdddir, creator, cr_workdir, source_params): |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 99 | """ |
Patrick Williams | c0f7c04 | 2017-02-23 20:41:17 -0600 | [diff] [blame] | 100 | Create loader-specific systemd-boot/gummiboot config |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 101 | """ |
| 102 | install_cmd = "install -d %s/loader" % hdddir |
| 103 | exec_cmd(install_cmd) |
| 104 | |
| 105 | install_cmd = "install -d %s/loader/entries" % hdddir |
| 106 | exec_cmd(install_cmd) |
| 107 | |
Patrick Williams | d8c66bc | 2016-06-20 12:57:21 -0500 | [diff] [blame] | 108 | bootloader = creator.ks.bootloader |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 109 | |
| 110 | loader_conf = "" |
| 111 | loader_conf += "default boot\n" |
Patrick Williams | d8c66bc | 2016-06-20 12:57:21 -0500 | [diff] [blame] | 112 | loader_conf += "timeout %d\n" % bootloader.timeout |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 113 | |
Brad Bishop | 6e60e8b | 2018-02-01 10:27:11 -0500 | [diff] [blame] | 114 | initrd = source_params.get('initrd') |
| 115 | |
| 116 | if initrd: |
| 117 | # obviously we need to have a common common deploy var |
| 118 | bootimg_dir = get_bitbake_var("DEPLOY_DIR_IMAGE") |
| 119 | if not bootimg_dir: |
| 120 | raise WicError("Couldn't find DEPLOY_DIR_IMAGE, exiting") |
| 121 | |
| 122 | cp_cmd = "cp %s/%s %s" % (bootimg_dir, initrd, hdddir) |
| 123 | exec_cmd(cp_cmd, True) |
| 124 | else: |
| 125 | logger.debug("Ignoring missing initrd") |
| 126 | |
| 127 | logger.debug("Writing systemd-boot config " |
| 128 | "%s/hdd/boot/loader/loader.conf", cr_workdir) |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 129 | cfg = open("%s/hdd/boot/loader/loader.conf" % cr_workdir, "w") |
| 130 | cfg.write(loader_conf) |
| 131 | cfg.close() |
| 132 | |
Patrick Williams | d8c66bc | 2016-06-20 12:57:21 -0500 | [diff] [blame] | 133 | configfile = creator.ks.bootloader.configfile |
| 134 | custom_cfg = None |
| 135 | if configfile: |
| 136 | custom_cfg = get_custom_config(configfile) |
| 137 | if custom_cfg: |
Brad Bishop | 6e60e8b | 2018-02-01 10:27:11 -0500 | [diff] [blame] | 138 | # Use a custom configuration for systemd-boot |
Patrick Williams | d8c66bc | 2016-06-20 12:57:21 -0500 | [diff] [blame] | 139 | boot_conf = custom_cfg |
Brad Bishop | 6e60e8b | 2018-02-01 10:27:11 -0500 | [diff] [blame] | 140 | logger.debug("Using custom configuration file " |
| 141 | "%s for systemd-boots's boot.conf", configfile) |
Patrick Williams | d8c66bc | 2016-06-20 12:57:21 -0500 | [diff] [blame] | 142 | else: |
Brad Bishop | 6e60e8b | 2018-02-01 10:27:11 -0500 | [diff] [blame] | 143 | raise WicError("configfile is specified but failed to " |
| 144 | "get it from %s.", configfile) |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 145 | |
Patrick Williams | d8c66bc | 2016-06-20 12:57:21 -0500 | [diff] [blame] | 146 | if not custom_cfg: |
Brad Bishop | 6e60e8b | 2018-02-01 10:27:11 -0500 | [diff] [blame] | 147 | # Create systemd-boot configuration using parameters from wks file |
Brad Bishop | 15ae250 | 2019-06-18 21:44:24 -0400 | [diff] [blame^] | 148 | kernel = get_bitbake_var("KERNEL_IMAGETYPE") |
| 149 | if not kernel: |
| 150 | kernel = "bzImage" |
| 151 | |
Brad Bishop | 1932369 | 2019-04-05 15:28:33 -0400 | [diff] [blame] | 152 | title = source_params.get('title') |
Patrick Williams | d8c66bc | 2016-06-20 12:57:21 -0500 | [diff] [blame] | 153 | |
| 154 | boot_conf = "" |
Brad Bishop | 1932369 | 2019-04-05 15:28:33 -0400 | [diff] [blame] | 155 | boot_conf += "title %s\n" % (title if title else "boot") |
Brad Bishop | 15ae250 | 2019-06-18 21:44:24 -0400 | [diff] [blame^] | 156 | boot_conf += "linux /%s\n" % kernel |
| 157 | |
| 158 | label = source_params.get('label') |
| 159 | label_conf = "LABEL=Boot root=%s" % creator.rootdev |
| 160 | if label: |
| 161 | label_conf = "LABEL=%s" % label |
| 162 | |
| 163 | boot_conf += "options %s %s\n" % \ |
| 164 | (label_conf, bootloader.append) |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 165 | |
Brad Bishop | 6e60e8b | 2018-02-01 10:27:11 -0500 | [diff] [blame] | 166 | if initrd: |
| 167 | boot_conf += "initrd /%s\n" % initrd |
| 168 | |
| 169 | logger.debug("Writing systemd-boot config " |
| 170 | "%s/hdd/boot/loader/entries/boot.conf", cr_workdir) |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 171 | cfg = open("%s/hdd/boot/loader/entries/boot.conf" % cr_workdir, "w") |
| 172 | cfg.write(boot_conf) |
| 173 | cfg.close() |
| 174 | |
| 175 | |
| 176 | @classmethod |
| 177 | def do_configure_partition(cls, part, source_params, creator, cr_workdir, |
| 178 | oe_builddir, bootimg_dir, kernel_dir, |
| 179 | native_sysroot): |
| 180 | """ |
| 181 | Called before do_prepare_partition(), creates loader-specific config |
| 182 | """ |
| 183 | hdddir = "%s/hdd/boot" % cr_workdir |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 184 | |
| 185 | install_cmd = "install -d %s/EFI/BOOT" % hdddir |
| 186 | exec_cmd(install_cmd) |
| 187 | |
| 188 | try: |
| 189 | if source_params['loader'] == 'grub-efi': |
Brad Bishop | d5ae7d9 | 2018-06-14 09:52:03 -0700 | [diff] [blame] | 190 | cls.do_configure_grubefi(hdddir, creator, cr_workdir, source_params) |
Brad Bishop | 6e60e8b | 2018-02-01 10:27:11 -0500 | [diff] [blame] | 191 | elif source_params['loader'] == 'systemd-boot': |
| 192 | cls.do_configure_systemdboot(hdddir, creator, cr_workdir, source_params) |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 193 | else: |
Brad Bishop | 6e60e8b | 2018-02-01 10:27:11 -0500 | [diff] [blame] | 194 | raise WicError("unrecognized bootimg-efi loader: %s" % source_params['loader']) |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 195 | except KeyError: |
Brad Bishop | 6e60e8b | 2018-02-01 10:27:11 -0500 | [diff] [blame] | 196 | raise WicError("bootimg-efi requires a loader, none specified") |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 197 | |
| 198 | |
| 199 | @classmethod |
| 200 | def do_prepare_partition(cls, part, source_params, creator, cr_workdir, |
| 201 | oe_builddir, bootimg_dir, kernel_dir, |
| 202 | rootfs_dir, native_sysroot): |
| 203 | """ |
| 204 | Called to do the actual content population for a partition i.e. it |
| 205 | 'prepares' the partition to be incorporated into the image. |
| 206 | In this case, prepare content for an EFI (grub) boot partition. |
| 207 | """ |
Brad Bishop | 6e60e8b | 2018-02-01 10:27:11 -0500 | [diff] [blame] | 208 | if not kernel_dir: |
| 209 | kernel_dir = get_bitbake_var("DEPLOY_DIR_IMAGE") |
| 210 | if not kernel_dir: |
| 211 | raise WicError("Couldn't find DEPLOY_DIR_IMAGE, exiting") |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 212 | |
| 213 | staging_kernel_dir = kernel_dir |
| 214 | |
| 215 | hdddir = "%s/hdd/boot" % cr_workdir |
| 216 | |
Brad Bishop | 15ae250 | 2019-06-18 21:44:24 -0400 | [diff] [blame^] | 217 | kernel = get_bitbake_var("KERNEL_IMAGETYPE") |
| 218 | if not kernel: |
| 219 | kernel = "bzImage" |
| 220 | |
| 221 | install_cmd = "install -m 0644 %s/%s %s/%s" % \ |
| 222 | (staging_kernel_dir, kernel, hdddir, kernel) |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 223 | exec_cmd(install_cmd) |
| 224 | |
Brad Bishop | 6e60e8b | 2018-02-01 10:27:11 -0500 | [diff] [blame] | 225 | |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 226 | try: |
| 227 | if source_params['loader'] == 'grub-efi': |
| 228 | shutil.copyfile("%s/hdd/boot/EFI/BOOT/grub.cfg" % cr_workdir, |
| 229 | "%s/grub.cfg" % cr_workdir) |
Brad Bishop | 6e60e8b | 2018-02-01 10:27:11 -0500 | [diff] [blame] | 230 | for mod in [x for x in os.listdir(kernel_dir) if x.startswith("grub-efi-")]: |
| 231 | cp_cmd = "cp %s/%s %s/EFI/BOOT/%s" % (kernel_dir, mod, hdddir, mod[9:]) |
| 232 | exec_cmd(cp_cmd, True) |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 233 | shutil.move("%s/grub.cfg" % cr_workdir, |
| 234 | "%s/hdd/boot/EFI/BOOT/grub.cfg" % cr_workdir) |
Brad Bishop | 6e60e8b | 2018-02-01 10:27:11 -0500 | [diff] [blame] | 235 | elif source_params['loader'] == 'systemd-boot': |
| 236 | for mod in [x for x in os.listdir(kernel_dir) if x.startswith("systemd-")]: |
| 237 | cp_cmd = "cp %s/%s %s/EFI/BOOT/%s" % (kernel_dir, mod, hdddir, mod[8:]) |
| 238 | exec_cmd(cp_cmd, True) |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 239 | else: |
Brad Bishop | 6e60e8b | 2018-02-01 10:27:11 -0500 | [diff] [blame] | 240 | raise WicError("unrecognized bootimg-efi loader: %s" % |
| 241 | source_params['loader']) |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 242 | except KeyError: |
Brad Bishop | 6e60e8b | 2018-02-01 10:27:11 -0500 | [diff] [blame] | 243 | raise WicError("bootimg-efi requires a loader, none specified") |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 244 | |
Brad Bishop | 6e60e8b | 2018-02-01 10:27:11 -0500 | [diff] [blame] | 245 | startup = os.path.join(kernel_dir, "startup.nsh") |
Patrick Williams | c0f7c04 | 2017-02-23 20:41:17 -0600 | [diff] [blame] | 246 | if os.path.exists(startup): |
| 247 | cp_cmd = "cp %s %s/" % (startup, hdddir) |
| 248 | exec_cmd(cp_cmd, True) |
| 249 | |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 250 | du_cmd = "du -bks %s" % hdddir |
| 251 | out = exec_cmd(du_cmd) |
| 252 | blocks = int(out.split()[0]) |
| 253 | |
| 254 | extra_blocks = part.get_extra_block_count(blocks) |
| 255 | |
| 256 | if extra_blocks < BOOTDD_EXTRA_SPACE: |
| 257 | extra_blocks = BOOTDD_EXTRA_SPACE |
| 258 | |
| 259 | blocks += extra_blocks |
| 260 | |
Brad Bishop | 6e60e8b | 2018-02-01 10:27:11 -0500 | [diff] [blame] | 261 | logger.debug("Added %d extra blocks to %s to get to %d total blocks", |
| 262 | extra_blocks, part.mountpoint, blocks) |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 263 | |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 264 | # dosfs image, created by mkdosfs |
| 265 | bootimg = "%s/boot.img" % cr_workdir |
| 266 | |
Brad Bishop | c342db3 | 2019-05-15 21:57:59 -0400 | [diff] [blame] | 267 | label = part.label if part.label else "ESP" |
| 268 | |
| 269 | dosfs_cmd = "mkdosfs -n %s -i %s -C %s %d" % \ |
| 270 | (label, part.fsuuid, bootimg, blocks) |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 271 | exec_native_cmd(dosfs_cmd, native_sysroot) |
| 272 | |
| 273 | mcopy_cmd = "mcopy -i %s -s %s/* ::/" % (bootimg, hdddir) |
| 274 | exec_native_cmd(mcopy_cmd, native_sysroot) |
| 275 | |
| 276 | chmod_cmd = "chmod 644 %s" % bootimg |
| 277 | exec_cmd(chmod_cmd) |
| 278 | |
| 279 | du_cmd = "du -Lbks %s" % bootimg |
| 280 | out = exec_cmd(du_cmd) |
| 281 | bootimg_size = out.split()[0] |
| 282 | |
Brad Bishop | 37a0e4d | 2017-12-04 01:01:44 -0500 | [diff] [blame] | 283 | part.size = int(bootimg_size) |
Patrick Williams | d8c66bc | 2016-06-20 12:57:21 -0500 | [diff] [blame] | 284 | part.source_file = bootimg |