blob: 7fa4ff20bd3a96493b1e23141a81c46edcb94c4d [file] [log] [blame]
Patrick Williamsc124f4f2015-09-15 14:41:29 -05001
Brad Bishop1a4b7ee2018-12-16 17:11:34 -08002IMAGE_CLASSES ??= ""
3
4# rootfs bootstrap install
5# warning - image-container resets this
6ROOTFS_BOOTSTRAP_INSTALL = "run-postinsts"
7
8# Handle inherits of any of the image classes we need
9IMGCLASSES = "rootfs_${IMAGE_PKGTYPE} image_types ${IMAGE_CLASSES}"
Brad Bishop6e60e8b2018-02-01 10:27:11 -050010# Only Linux SDKs support populate_sdk_ext, fall back to populate_sdk_base
Patrick Williamsd8c66bc2016-06-20 12:57:21 -050011# in the non-Linux SDK_OS case, such as mingw32
Brad Bishop1a4b7ee2018-12-16 17:11:34 -080012IMGCLASSES += "${@['populate_sdk_base', 'populate_sdk_ext']['linux' in d.getVar("SDK_OS")]}"
13IMGCLASSES += "${@bb.utils.contains_any('IMAGE_FSTYPES', 'live iso hddimg', 'image-live', '', d)}"
14IMGCLASSES += "${@bb.utils.contains('IMAGE_FSTYPES', 'container', 'image-container', '', d)}"
15IMGCLASSES += "image_types_wic"
16IMGCLASSES += "rootfs-postcommands"
17IMGCLASSES += "image-postinst-intercepts"
18inherit ${IMGCLASSES}
Patrick Williamsc124f4f2015-09-15 14:41:29 -050019
20TOOLCHAIN_TARGET_TASK += "${PACKAGE_INSTALL}"
21TOOLCHAIN_TARGET_TASK_ATTEMPTONLY += "${PACKAGE_INSTALL_ATTEMPTONLY}"
22POPULATE_SDK_POST_TARGET_COMMAND += "rootfs_sysroot_relativelinks; "
23
Brad Bishopd7bf8c12018-02-25 22:55:05 -050024LICENSE ?= "MIT"
Patrick Williamsc124f4f2015-09-15 14:41:29 -050025PACKAGES = ""
Brad Bishop1a4b7ee2018-12-16 17:11:34 -080026DEPENDS += "${@' '.join(["%s-qemuwrapper-cross" % m for m in d.getVar("MULTILIB_VARIANTS").split()])} qemuwrapper-cross depmodwrapper-cross cross-localedef-native"
Brad Bishop19323692019-04-05 15:28:33 -040027RDEPENDS += "${PACKAGE_INSTALL} ${LINGUAS_INSTALL} ${IMAGE_INSTALL_DEBUGFS}"
Patrick Williamsc124f4f2015-09-15 14:41:29 -050028RRECOMMENDS += "${PACKAGE_INSTALL_ATTEMPTONLY}"
Brad Bishop1a4b7ee2018-12-16 17:11:34 -080029PATH_prepend = "${@":".join(all_multilib_tune_values(d, 'STAGING_BINDIR_CROSS').split())}:"
Patrick Williamsc124f4f2015-09-15 14:41:29 -050030
31INHIBIT_DEFAULT_DEPS = "1"
32
Patrick Williamsc124f4f2015-09-15 14:41:29 -050033# IMAGE_FEATURES may contain any available package group
34IMAGE_FEATURES ?= ""
35IMAGE_FEATURES[type] = "list"
Brad Bishopc342db32019-05-15 21:57:59 -040036IMAGE_FEATURES[validitems] += "debug-tweaks read-only-rootfs stateless-rootfs empty-root-password allow-empty-password allow-root-login post-install-logging"
Patrick Williamsc124f4f2015-09-15 14:41:29 -050037
38# Generate companion debugfs?
39IMAGE_GEN_DEBUGFS ?= "0"
40
Brad Bishop1a4b7ee2018-12-16 17:11:34 -080041# These pacackages will be installed as additional into debug rootfs
42IMAGE_INSTALL_DEBUGFS ?= ""
Patrick Williamsc124f4f2015-09-15 14:41:29 -050043
Patrick Williamsd8c66bc2016-06-20 12:57:21 -050044# These packages will be removed from a read-only rootfs after all other
45# packages have been installed
Brad Bishopd7bf8c12018-02-25 22:55:05 -050046ROOTFS_RO_UNNEEDED ??= "update-rc.d base-passwd shadow ${VIRTUAL-RUNTIME_update-alternatives} ${ROOTFS_BOOTSTRAP_INSTALL}"
Patrick Williamsd8c66bc2016-06-20 12:57:21 -050047
Patrick Williamsc124f4f2015-09-15 14:41:29 -050048# packages to install from features
49FEATURE_INSTALL = "${@' '.join(oe.packagegroup.required_packages(oe.data.typed_value('IMAGE_FEATURES', d), d))}"
50FEATURE_INSTALL[vardepvalue] = "${FEATURE_INSTALL}"
51FEATURE_INSTALL_OPTIONAL = "${@' '.join(oe.packagegroup.optional_packages(oe.data.typed_value('IMAGE_FEATURES', d), d))}"
52FEATURE_INSTALL_OPTIONAL[vardepvalue] = "${FEATURE_INSTALL_OPTIONAL}"
53
54# Define some very basic feature package groups
55FEATURE_PACKAGES_package-management = "${ROOTFS_PKGMANAGE}"
56SPLASH ?= "psplash"
57FEATURE_PACKAGES_splash = "${SPLASH}"
58
59IMAGE_INSTALL_COMPLEMENTARY = '${@complementary_globs("IMAGE_FEATURES", d)}'
60
61def check_image_features(d):
Brad Bishop6e60e8b2018-02-01 10:27:11 -050062 valid_features = (d.getVarFlag('IMAGE_FEATURES', 'validitems') or "").split()
Patrick Williamsc124f4f2015-09-15 14:41:29 -050063 valid_features += d.getVarFlags('COMPLEMENTARY_GLOB').keys()
64 for var in d:
65 if var.startswith("PACKAGE_GROUP_"):
66 bb.warn("PACKAGE_GROUP is deprecated, please use FEATURE_PACKAGES instead")
67 valid_features.append(var[14:])
68 elif var.startswith("FEATURE_PACKAGES_"):
69 valid_features.append(var[17:])
70 valid_features.sort()
71
72 features = set(oe.data.typed_value('IMAGE_FEATURES', d))
73 for feature in features:
74 if feature not in valid_features:
75 if bb.utils.contains('EXTRA_IMAGE_FEATURES', feature, True, False, d):
76 raise bb.parse.SkipRecipe("'%s' in IMAGE_FEATURES (added via EXTRA_IMAGE_FEATURES) is not a valid image feature. Valid features: %s" % (feature, ' '.join(valid_features)))
77 else:
78 raise bb.parse.SkipRecipe("'%s' in IMAGE_FEATURES is not a valid image feature. Valid features: %s" % (feature, ' '.join(valid_features)))
79
80IMAGE_INSTALL ?= ""
81IMAGE_INSTALL[type] = "list"
82export PACKAGE_INSTALL ?= "${IMAGE_INSTALL} ${ROOTFS_BOOTSTRAP_INSTALL} ${FEATURE_INSTALL}"
83PACKAGE_INSTALL_ATTEMPTONLY ?= "${FEATURE_INSTALL_OPTIONAL}"
84
Patrick Williamsc0f7c042017-02-23 20:41:17 -060085IMGDEPLOYDIR = "${WORKDIR}/deploy-${PN}-image-complete"
86
Patrick Williamsc124f4f2015-09-15 14:41:29 -050087# Images are generally built explicitly, do not need to be part of world.
88EXCLUDE_FROM_WORLD = "1"
89
90USE_DEVFS ?= "1"
91USE_DEPMOD ?= "1"
92
93PID = "${@os.getpid()}"
94
95PACKAGE_ARCH = "${MACHINE_ARCH}"
96
97LDCONFIGDEPEND ?= "ldconfig-native:do_populate_sysroot"
Patrick Williamsc124f4f2015-09-15 14:41:29 -050098LDCONFIGDEPEND_libc-musl = ""
99
100# This is needed to have depmod data in PKGDATA_DIR,
101# but if you're building small initramfs image
102# e.g. to include it in your kernel, you probably
103# don't want this dependency, which is causing dependency loop
104KERNELDEPMODDEPEND ?= "virtual/kernel:do_packagedata"
105
106do_rootfs[depends] += " \
107 makedevs-native:do_populate_sysroot virtual/fakeroot-native:do_populate_sysroot ${LDCONFIGDEPEND} \
108 virtual/update-alternatives-native:do_populate_sysroot update-rc.d-native:do_populate_sysroot \
109 ${KERNELDEPMODDEPEND} \
110"
111do_rootfs[recrdeptask] += "do_packagedata"
112
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500113def rootfs_command_variables(d):
114 return ['ROOTFS_POSTPROCESS_COMMAND','ROOTFS_PREPROCESS_COMMAND','ROOTFS_POSTINSTALL_COMMAND','ROOTFS_POSTUNINSTALL_COMMAND','OPKG_PREPROCESS_COMMANDS','OPKG_POSTPROCESS_COMMANDS','IMAGE_POSTPROCESS_COMMAND',
115 'IMAGE_PREPROCESS_COMMAND','RPM_PREPROCESS_COMMANDS','RPM_POSTPROCESS_COMMANDS','DEB_PREPROCESS_COMMANDS','DEB_POSTPROCESS_COMMANDS']
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500116
117python () {
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500118 variables = rootfs_command_variables(d) + sdk_command_variables(d)
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500119 for var in variables:
120 if d.getVar(var, False):
121 d.setVarFlag(var, 'func', '1')
122}
123
124def rootfs_variables(d):
125 from oe.rootfs import variable_depends
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600126 variables = ['IMAGE_DEVICE_TABLE','IMAGE_DEVICE_TABLES','BUILD_IMAGES_FROM_FEEDS','IMAGE_TYPES_MASKED','IMAGE_ROOTFS_ALIGNMENT','IMAGE_OVERHEAD_FACTOR','IMAGE_ROOTFS_SIZE','IMAGE_ROOTFS_EXTRA_SPACE',
127 'IMAGE_ROOTFS_MAXSIZE','IMAGE_NAME','IMAGE_LINK_NAME','IMAGE_MANIFEST','DEPLOY_DIR_IMAGE','IMAGE_FSTYPES','IMAGE_INSTALL_COMPLEMENTARY','IMAGE_LINGUAS',
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500128 'MULTILIBRE_ALLOW_REP','MULTILIB_TEMP_ROOTFS','MULTILIB_VARIANTS','MULTILIBS','ALL_MULTILIB_PACKAGE_ARCHS','MULTILIB_GLOBAL_VARIANTS','BAD_RECOMMENDATIONS','NO_RECOMMENDATIONS',
129 'PACKAGE_ARCHS','PACKAGE_CLASSES','TARGET_VENDOR','TARGET_ARCH','TARGET_OS','OVERRIDES','BBEXTENDVARIANT','FEED_DEPLOYDIR_BASE_URI','INTERCEPT_DIR','USE_DEVFS',
Brad Bishop1a4b7ee2018-12-16 17:11:34 -0800130 'CONVERSIONTYPES', 'IMAGE_GEN_DEBUGFS', 'ROOTFS_RO_UNNEEDED', 'IMGDEPLOYDIR', 'PACKAGE_EXCLUDE_COMPLEMENTARY', 'REPRODUCIBLE_TIMESTAMP_ROOTFS', 'IMAGE_INSTALL_DEBUGFS']
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500131 variables.extend(rootfs_command_variables(d))
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500132 variables.extend(variable_depends(d))
133 return " ".join(variables)
134
135do_rootfs[vardeps] += "${@rootfs_variables(d)}"
136
137do_build[depends] += "virtual/kernel:do_deploy"
138
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500139
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500140python () {
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500141 def extraimage_getdepends(task):
142 deps = ""
143 for dep in (d.getVar('EXTRA_IMAGEDEPENDS') or "").split():
144 deps += " %s:%s" % (dep, task)
145 return deps
146
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500147 d.appendVarFlag('do_image_complete', 'depends', extraimage_getdepends('do_populate_sysroot'))
148
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500149 deps = " " + imagetypes_getdepends(d)
150 d.appendVarFlag('do_rootfs', 'depends', deps)
151
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500152 #process IMAGE_FEATURES, we must do this before runtime_mapping_rename
153 #Check for replaces image features
154 features = set(oe.data.typed_value('IMAGE_FEATURES', d))
155 remain_features = features.copy()
156 for feature in features:
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500157 replaces = set((d.getVar("IMAGE_FEATURES_REPLACES_%s" % feature) or "").split())
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500158 remain_features -= replaces
159
160 #Check for conflict image features
161 for feature in remain_features:
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500162 conflicts = set((d.getVar("IMAGE_FEATURES_CONFLICTS_%s" % feature) or "").split())
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500163 temp = conflicts & remain_features
164 if temp:
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500165 bb.fatal("%s contains conflicting IMAGE_FEATURES %s %s" % (d.getVar('PN'), feature, ' '.join(list(temp))))
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500166
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600167 d.setVar('IMAGE_FEATURES', ' '.join(sorted(list(remain_features))))
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500168
169 check_image_features(d)
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500170}
171
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500172IMAGE_POSTPROCESS_COMMAND ?= ""
173
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500174# some default locales
175IMAGE_LINGUAS ?= "de-de fr-fr en-gb"
176
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500177LINGUAS_INSTALL ?= "${@" ".join(map(lambda s: "locale-base-%s" % s, d.getVar('IMAGE_LINGUAS').split()))}"
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500178
179# Prefer image, but use the fallback files for lookups if the image ones
180# aren't yet available.
181PSEUDO_PASSWD = "${IMAGE_ROOTFS}:${STAGING_DIR_NATIVE}"
182
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500183PACKAGE_EXCLUDE ??= ""
184PACKAGE_EXCLUDE[type] = "list"
185
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500186fakeroot python do_rootfs () {
187 from oe.rootfs import create_rootfs
188 from oe.manifest import create_manifest
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500189 import logging
190
191 logger = d.getVar('BB_TASK_LOGGER', False)
192 if logger:
193 logcatcher = bb.utils.LogCatcher()
194 logger.addHandler(logcatcher)
195 else:
196 logcatcher = None
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500197
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600198 # NOTE: if you add, remove or significantly refactor the stages of this
199 # process then you should recalculate the weightings here. This is quite
200 # easy to do - just change the MultiStageProgressReporter line temporarily
201 # to pass debug=True as the last parameter and you'll get a printout of
202 # the weightings as well as a map to the lines where next_stage() was
203 # called. Of course this isn't critical, but it helps to keep the progress
204 # reporting accurate.
205 stage_weights = [1, 203, 354, 186, 65, 4228, 1, 353, 49, 330, 382, 23, 1]
206 progress_reporter = bb.progress.MultiStageProgressReporter(d, stage_weights)
207 progress_reporter.next_stage()
208
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500209 # Handle package exclusions
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500210 excl_pkgs = d.getVar("PACKAGE_EXCLUDE").split()
211 inst_pkgs = d.getVar("PACKAGE_INSTALL").split()
212 inst_attempt_pkgs = d.getVar("PACKAGE_INSTALL_ATTEMPTONLY").split()
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500213
214 d.setVar('PACKAGE_INSTALL_ORIG', ' '.join(inst_pkgs))
215 d.setVar('PACKAGE_INSTALL_ATTEMPTONLY', ' '.join(inst_attempt_pkgs))
216
217 for pkg in excl_pkgs:
218 if pkg in inst_pkgs:
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500219 bb.warn("Package %s, set to be excluded, is in %s PACKAGE_INSTALL (%s). It will be removed from the list." % (pkg, d.getVar('PN'), inst_pkgs))
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500220 inst_pkgs.remove(pkg)
221
222 if pkg in inst_attempt_pkgs:
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500223 bb.warn("Package %s, set to be excluded, is in %s PACKAGE_INSTALL_ATTEMPTONLY (%s). It will be removed from the list." % (pkg, d.getVar('PN'), inst_pkgs))
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500224 inst_attempt_pkgs.remove(pkg)
225
226 d.setVar("PACKAGE_INSTALL", ' '.join(inst_pkgs))
227 d.setVar("PACKAGE_INSTALL_ATTEMPTONLY", ' '.join(inst_attempt_pkgs))
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500228
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500229 # Ensure we handle package name remapping
230 # We have to delay the runtime_mapping_rename until just before rootfs runs
231 # otherwise, the multilib renaming could step in and squash any fixups that
232 # may have occurred.
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500233 pn = d.getVar('PN')
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500234 runtime_mapping_rename("PACKAGE_INSTALL", pn, d)
235 runtime_mapping_rename("PACKAGE_INSTALL_ATTEMPTONLY", pn, d)
236 runtime_mapping_rename("BAD_RECOMMENDATIONS", pn, d)
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500237
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500238 # Generate the initial manifest
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500239 create_manifest(d)
240
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600241 progress_reporter.next_stage()
242
243 # generate rootfs
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500244 d.setVarFlag('REPRODUCIBLE_TIMESTAMP_ROOTFS', 'export', '1')
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500245 create_rootfs(d, progress_reporter=progress_reporter, logcatcher=logcatcher)
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600246
247 progress_reporter.finish()
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500248}
249do_rootfs[dirs] = "${TOPDIR}"
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600250do_rootfs[cleandirs] += "${S} ${IMGDEPLOYDIR}"
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500251do_rootfs[umask] = "022"
Brad Bishop1a4b7ee2018-12-16 17:11:34 -0800252do_rootfs[file-checksums] += "${POSTINST_INTERCEPT_CHECKSUMS}"
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500253addtask rootfs after do_prepare_recipe_sysroot
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500254
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500255fakeroot python do_image () {
256 from oe.utils import execute_pre_post_process
257
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500258 d.setVarFlag('REPRODUCIBLE_TIMESTAMP_ROOTFS', 'export', '1')
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500259 pre_process_cmds = d.getVar("IMAGE_PREPROCESS_COMMAND")
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500260
261 execute_pre_post_process(d, pre_process_cmds)
262}
263do_image[dirs] = "${TOPDIR}"
264do_image[umask] = "022"
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500265addtask do_image after do_rootfs
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500266
267fakeroot python do_image_complete () {
268 from oe.utils import execute_pre_post_process
269
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500270 post_process_cmds = d.getVar("IMAGE_POSTPROCESS_COMMAND")
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500271
272 execute_pre_post_process(d, post_process_cmds)
273}
274do_image_complete[dirs] = "${TOPDIR}"
275do_image_complete[umask] = "022"
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600276SSTATETASKS += "do_image_complete"
277SSTATE_SKIP_CREATION_task-image-complete = '1'
278do_image_complete[sstate-inputdirs] = "${IMGDEPLOYDIR}"
279do_image_complete[sstate-outputdirs] = "${DEPLOY_DIR_IMAGE}"
Brad Bishop316dfdd2018-06-25 12:45:53 -0400280do_image_complete[stamp-extra-info] = "${MACHINE_ARCH}"
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500281addtask do_image_complete after do_image before do_build
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500282python do_image_complete_setscene () {
283 sstate_setscene(d)
284}
285addtask do_image_complete_setscene
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500286
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600287# Add image-level QA/sanity checks to IMAGE_QA_COMMANDS
288#
289# IMAGE_QA_COMMANDS += " \
290# image_check_everything_ok \
291# "
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500292# This task runs all functions in IMAGE_QA_COMMANDS after the rootfs
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600293# construction has completed in order to validate the resulting image.
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500294#
295# The functions should use ${IMAGE_ROOTFS} to find the unpacked rootfs
296# directory, which if QA passes will be the basis for the images.
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600297fakeroot python do_image_qa () {
298 from oe.utils import ImageQAFailed
299
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500300 qa_cmds = (d.getVar('IMAGE_QA_COMMANDS') or '').split()
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600301 qamsg = ""
302
303 for cmd in qa_cmds:
304 try:
305 bb.build.exec_func(cmd, d)
306 except oe.utils.ImageQAFailed as e:
307 qamsg = qamsg + '\tImage QA function %s failed: %s\n' % (e.name, e.description)
Brad Bishop08902b02019-08-20 09:16:51 -0400308 except Exception as e:
309 qamsg = qamsg + '\tImage QA function %s failed\n' % cmd
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600310
311 if qamsg:
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500312 imgname = d.getVar('IMAGE_NAME')
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600313 bb.fatal("QA errors found whilst validating image: %s\n%s" % (imgname, qamsg))
314}
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500315addtask do_image_qa after do_rootfs before do_image
316
317SSTATETASKS += "do_image_qa"
318SSTATE_SKIP_CREATION_task-image-qa = '1'
319do_image_qa[sstate-inputdirs] = ""
320do_image_qa[sstate-outputdirs] = ""
321python do_image_qa_setscene () {
322 sstate_setscene(d)
323}
324addtask do_image_qa_setscene
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600325
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500326def setup_debugfs_variables(d):
327 d.appendVar('IMAGE_ROOTFS', '-dbg')
Brad Bishop96ff1982019-08-19 13:50:42 -0400328 if d.getVar('IMAGE_LINK_NAME'):
329 d.appendVar('IMAGE_LINK_NAME', '-dbg')
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500330 d.appendVar('IMAGE_NAME','-dbg')
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600331 d.setVar('IMAGE_BUILDING_DEBUGFS', 'true')
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500332 debugfs_image_fstypes = d.getVar('IMAGE_FSTYPES_DEBUGFS')
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500333 if debugfs_image_fstypes:
334 d.setVar('IMAGE_FSTYPES', debugfs_image_fstypes)
335
336python setup_debugfs () {
337 setup_debugfs_variables(d)
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500338}
339
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500340python () {
341 vardeps = set()
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600342 # We allow CONVERSIONTYPES to have duplicates. That avoids breaking
343 # derived distros when OE-core or some other layer independently adds
344 # the same type. There is still only one command for each type, but
345 # presumably the commands will do the same when the type is the same,
346 # even when added in different places.
347 #
348 # Without de-duplication, gen_conversion_cmds() below
349 # would create the same compression command multiple times.
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500350 ctypes = set(d.getVar('CONVERSIONTYPES').split())
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600351 old_overrides = d.getVar('OVERRIDES', False)
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500352
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500353 def _image_base_type(type):
354 basetype = type
355 for ctype in ctypes:
356 if type.endswith("." + ctype):
357 basetype = type[:-len("." + ctype)]
358 break
359
360 if basetype != type:
361 # New base type itself might be generated by a conversion command.
362 basetype = _image_base_type(basetype)
363
364 return basetype
365
366 basetypes = {}
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500367 alltypes = d.getVar('IMAGE_FSTYPES').split()
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500368 typedeps = {}
369
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500370 if d.getVar('IMAGE_GEN_DEBUGFS') == "1":
371 debugfs_fstypes = d.getVar('IMAGE_FSTYPES_DEBUGFS').split()
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500372 for t in debugfs_fstypes:
373 alltypes.append("debugfs_" + t)
374
375 def _add_type(t):
376 baset = _image_base_type(t)
377 input_t = t
378 if baset not in basetypes:
379 basetypes[baset]= []
380 if t not in basetypes[baset]:
381 basetypes[baset].append(t)
382 debug = ""
383 if t.startswith("debugfs_"):
384 t = t[8:]
385 debug = "debugfs_"
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500386 deps = (d.getVar('IMAGE_TYPEDEP_' + t) or "").split()
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500387 vardeps.add('IMAGE_TYPEDEP_' + t)
388 if baset not in typedeps:
389 typedeps[baset] = set()
390 deps = [debug + dep for dep in deps]
391 for dep in deps:
392 if dep not in alltypes:
393 alltypes.append(dep)
394 _add_type(dep)
395 basedep = _image_base_type(dep)
396 typedeps[baset].add(basedep)
397
398 if baset != input_t:
399 _add_type(baset)
400
401 for t in alltypes[:]:
402 _add_type(t)
403
404 d.appendVarFlag('do_image', 'vardeps', ' '.join(vardeps))
405
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500406 maskedtypes = (d.getVar('IMAGE_TYPES_MASKED') or "").split()
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600407 maskedtypes = [dbg + t for t in maskedtypes for dbg in ("", "debugfs_")]
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500408
409 for t in basetypes:
410 vardeps = set()
411 cmds = []
412 subimages = []
413 realt = t
414
415 if t in maskedtypes:
416 continue
417
418 localdata = bb.data.createCopy(d)
419 debug = ""
420 if t.startswith("debugfs_"):
421 setup_debugfs_variables(localdata)
422 debug = "setup_debugfs "
423 realt = t[8:]
424 localdata.setVar('OVERRIDES', '%s:%s' % (realt, old_overrides))
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500425 localdata.setVar('type', realt)
426 # Delete DATETIME so we don't expand any references to it now
427 # This means the task's hash can be stable rather than having hardcoded
428 # date/time values. It will get expanded at execution time.
429 # Similarly TMPDIR since otherwise we see QA stamp comparision problems
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500430 # Expand PV else it can trigger get_srcrev which can fail due to these variables being unset
431 localdata.setVar('PV', d.getVar('PV'))
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500432 localdata.delVar('DATETIME')
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500433 localdata.delVar('DATE')
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500434 localdata.delVar('TMPDIR')
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500435 vardepsexclude = (d.getVarFlag('IMAGE_CMD_' + realt, 'vardepsexclude', True) or '').split()
436 for dep in vardepsexclude:
437 localdata.delVar(dep)
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500438
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500439 image_cmd = localdata.getVar("IMAGE_CMD")
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500440 vardeps.add('IMAGE_CMD_' + realt)
441 if image_cmd:
442 cmds.append("\t" + image_cmd)
443 else:
444 bb.fatal("No IMAGE_CMD defined for IMAGE_FSTYPES entry '%s' - possibly invalid type name or missing support class" % t)
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600445 cmds.append(localdata.expand("\tcd ${IMGDEPLOYDIR}"))
446
447 # Since a copy of IMAGE_CMD_xxx will be inlined within do_image_xxx,
448 # prevent a redundant copy of IMAGE_CMD_xxx being emitted as a function.
449 d.delVarFlag('IMAGE_CMD_' + realt, 'func')
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500450
451 rm_tmp_images = set()
452 def gen_conversion_cmds(bt):
Gerson Fernando Budke3c4c45d2017-09-19 14:15:36 -0300453 for ctype in sorted(ctypes):
Brad Bishop37a0e4d2017-12-04 01:01:44 -0500454 if bt.endswith("." + ctype):
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500455 type = bt[0:-len(ctype) - 1]
456 if type.startswith("debugfs_"):
457 type = type[8:]
458 # Create input image first.
459 gen_conversion_cmds(type)
460 localdata.setVar('type', type)
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500461 cmd = "\t" + (localdata.getVar("CONVERSION_CMD_" + ctype) or localdata.getVar("COMPRESS_CMD_" + ctype))
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600462 if cmd not in cmds:
463 cmds.append(cmd)
464 vardeps.add('CONVERSION_CMD_' + ctype)
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500465 vardeps.add('COMPRESS_CMD_' + ctype)
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600466 subimage = type + "." + ctype
467 if subimage not in subimages:
468 subimages.append(subimage)
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500469 if type not in alltypes:
470 rm_tmp_images.add(localdata.expand("${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.${type}"))
471
472 for bt in basetypes[t]:
473 gen_conversion_cmds(bt)
474
475 localdata.setVar('type', realt)
476 if t not in alltypes:
477 rm_tmp_images.add(localdata.expand("${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.${type}"))
478 else:
479 subimages.append(realt)
480
481 # Clean up after applying all conversion commands. Some of them might
482 # use the same input, therefore we cannot delete sooner without applying
483 # some complex dependency analysis.
Brad Bishop37a0e4d2017-12-04 01:01:44 -0500484 for image in sorted(rm_tmp_images):
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500485 cmds.append("\trm " + image)
486
487 after = 'do_image'
488 for dep in typedeps[t]:
489 after += ' do_image_%s' % dep.replace("-", "_").replace(".", "_")
490
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500491 task = "do_image_%s" % t.replace("-", "_").replace(".", "_")
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500492
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500493 d.setVar(task, '\n'.join(cmds))
494 d.setVarFlag(task, 'func', '1')
495 d.setVarFlag(task, 'fakeroot', '1')
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500496
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500497 d.appendVarFlag(task, 'prefuncs', ' ' + debug + ' set_image_size')
Brad Bishopa5c52ff2018-11-23 10:55:50 +1300498 d.prependVarFlag(task, 'postfuncs', 'create_symlinks ')
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500499 d.appendVarFlag(task, 'subimages', ' ' + ' '.join(subimages))
500 d.appendVarFlag(task, 'vardeps', ' ' + ' '.join(vardeps))
Brad Bishop19323692019-04-05 15:28:33 -0400501 d.appendVarFlag(task, 'vardepsexclude', ' DATETIME DATE ' + ' '.join(vardepsexclude))
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500502
503 bb.debug(2, "Adding task %s before %s, after %s" % (task, 'do_image_complete', after))
504 bb.build.addtask(task, 'do_image_complete', after, d)
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500505}
506
507#
508# Compute the rootfs size
509#
510def get_rootfs_size(d):
511 import subprocess
512
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500513 rootfs_alignment = int(d.getVar('IMAGE_ROOTFS_ALIGNMENT'))
514 overhead_factor = float(d.getVar('IMAGE_OVERHEAD_FACTOR'))
515 rootfs_req_size = int(d.getVar('IMAGE_ROOTFS_SIZE'))
516 rootfs_extra_space = eval(d.getVar('IMAGE_ROOTFS_EXTRA_SPACE'))
517 rootfs_maxsize = d.getVar('IMAGE_ROOTFS_MAXSIZE')
518 image_fstypes = d.getVar('IMAGE_FSTYPES') or ''
519 initramfs_fstypes = d.getVar('INITRAMFS_FSTYPES') or ''
520 initramfs_maxsize = d.getVar('INITRAMFS_MAXSIZE')
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500521
522 output = subprocess.check_output(['du', '-ks',
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500523 d.getVar('IMAGE_ROOTFS')])
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500524 size_kb = int(output.split()[0])
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500525
Brad Bishop316dfdd2018-06-25 12:45:53 -0400526 base_size = size_kb * overhead_factor
527 bb.debug(1, '%f = %d * %f' % (base_size, size_kb, overhead_factor))
528 base_size2 = max(base_size, rootfs_req_size) + rootfs_extra_space
529 bb.debug(1, '%f = max(%f, %d)[%f] + %d' % (base_size2, base_size, rootfs_req_size, max(base_size, rootfs_req_size), overhead_factor))
530
531 base_size = base_size2
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500532 if base_size != int(base_size):
533 base_size = int(base_size + 1)
534 else:
535 base_size = int(base_size)
Brad Bishop316dfdd2018-06-25 12:45:53 -0400536 bb.debug(1, '%f = int(%f)' % (base_size, base_size2))
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500537
Brad Bishop316dfdd2018-06-25 12:45:53 -0400538 base_size_saved = base_size
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500539 base_size += rootfs_alignment - 1
540 base_size -= base_size % rootfs_alignment
Brad Bishop316dfdd2018-06-25 12:45:53 -0400541 bb.debug(1, '%d = aligned(%d)' % (base_size, base_size_saved))
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500542
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600543 # Do not check image size of the debugfs image. This is not supposed
544 # to be deployed, etc. so it doesn't make sense to limit the size
545 # of the debug.
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500546 if (d.getVar('IMAGE_BUILDING_DEBUGFS') or "") == "true":
Brad Bishop316dfdd2018-06-25 12:45:53 -0400547 bb.debug(1, 'returning debugfs size %d' % (base_size))
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600548 return base_size
549
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500550 # Check the rootfs size against IMAGE_ROOTFS_MAXSIZE (if set)
551 if rootfs_maxsize:
552 rootfs_maxsize_int = int(rootfs_maxsize)
553 if base_size > rootfs_maxsize_int:
554 bb.fatal("The rootfs size %d(K) overrides IMAGE_ROOTFS_MAXSIZE: %d(K)" % \
555 (base_size, rootfs_maxsize_int))
556
557 # Check the initramfs size against INITRAMFS_MAXSIZE (if set)
558 if image_fstypes == initramfs_fstypes != '' and initramfs_maxsize:
559 initramfs_maxsize_int = int(initramfs_maxsize)
560 if base_size > initramfs_maxsize_int:
561 bb.error("The initramfs size %d(K) overrides INITRAMFS_MAXSIZE: %d(K)" % \
562 (base_size, initramfs_maxsize_int))
563 bb.error("You can set INITRAMFS_MAXSIZE a larger value. Usually, it should")
564 bb.fatal("be less than 1/2 of ram size, or you may fail to boot it.\n")
Brad Bishop316dfdd2018-06-25 12:45:53 -0400565
566 bb.debug(1, 'returning %d' % (base_size))
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500567 return base_size
568
569python set_image_size () {
570 rootfs_size = get_rootfs_size(d)
571 d.setVar('ROOTFS_SIZE', str(rootfs_size))
572 d.setVarFlag('ROOTFS_SIZE', 'export', '1')
573}
574
575#
576# Create symlinks to the newly created image
577#
578python create_symlinks() {
579
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500580 deploy_dir = d.getVar('IMGDEPLOYDIR')
581 img_name = d.getVar('IMAGE_NAME')
582 link_name = d.getVar('IMAGE_LINK_NAME')
583 manifest_name = d.getVar('IMAGE_MANIFEST')
584 taskname = d.getVar("BB_CURRENTTASK")
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500585 subimages = (d.getVarFlag("do_" + taskname, 'subimages', False) or "").split()
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500586 imgsuffix = d.getVarFlag("do_" + taskname, 'imgsuffix') or d.expand("${IMAGE_NAME_SUFFIX}.")
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500587
588 if not link_name:
589 return
590 for type in subimages:
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600591 dst = os.path.join(deploy_dir, link_name + "." + type)
592 src = img_name + imgsuffix + type
593 if os.path.exists(os.path.join(deploy_dir, src)):
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500594 bb.note("Creating symlink: %s -> %s" % (dst, src))
595 if os.path.islink(dst):
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500596 os.remove(dst)
597 os.symlink(src, dst)
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600598 else:
599 bb.note("Skipping symlink, source does not exist: %s -> %s" % (dst, src))
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500600}
601
602MULTILIBRE_ALLOW_REP =. "${base_bindir}|${base_sbindir}|${bindir}|${sbindir}|${libexecdir}|${sysconfdir}|${nonarch_base_libdir}/udev|/lib/modules/[^/]*/modules.*|"
603MULTILIB_CHECK_FILE = "${WORKDIR}/multilib_check.py"
604MULTILIB_TEMP_ROOTFS = "${WORKDIR}/multilib"
605
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500606do_fetch[noexec] = "1"
607do_unpack[noexec] = "1"
608do_patch[noexec] = "1"
609do_configure[noexec] = "1"
610do_compile[noexec] = "1"
611do_install[noexec] = "1"
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500612deltask do_populate_sysroot
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500613do_package[noexec] = "1"
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500614deltask do_package_qa
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500615do_packagedata[noexec] = "1"
Brad Bishop316dfdd2018-06-25 12:45:53 -0400616deltask do_package_write_ipk
617deltask do_package_write_deb
618deltask do_package_write_rpm
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500619
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500620# Prepare the root links to point to the /usr counterparts.
621create_merged_usr_symlinks() {
622 root="$1"
623 install -d $root${base_bindir} $root${base_sbindir} $root${base_libdir}
624 lnr $root${base_bindir} $root/bin
625 lnr $root${base_sbindir} $root/sbin
626 lnr $root${base_libdir} $root/${baselib}
627
628 if [ "${nonarch_base_libdir}" != "${base_libdir}" ]; then
629 install -d $root${nonarch_base_libdir}
630 lnr $root${nonarch_base_libdir} $root/lib
631 fi
632
633 # create base links for multilibs
634 multi_libdirs="${@d.getVar('MULTILIB_VARIANTS')}"
635 for d in $multi_libdirs; do
636 install -d $root${exec_prefix}/$d
637 lnr $root${exec_prefix}/$d $root/$d
638 done
639}
640
641create_merged_usr_symlinks_rootfs() {
642 create_merged_usr_symlinks ${IMAGE_ROOTFS}
643}
644
645create_merged_usr_symlinks_sdk() {
646 create_merged_usr_symlinks ${SDK_OUTPUT}${SDKTARGETSYSROOT}
647}
648
649ROOTFS_PREPROCESS_COMMAND += "${@bb.utils.contains('DISTRO_FEATURES', 'usrmerge', 'create_merged_usr_symlinks_rootfs; ', '',d)}"
650POPULATE_SDK_PRE_TARGET_COMMAND += "${@bb.utils.contains('DISTRO_FEATURES', 'usrmerge', 'create_merged_usr_symlinks_sdk; ', '',d)}"
651
652reproducible_final_image_task () {
Brad Bishop316dfdd2018-06-25 12:45:53 -0400653 if [ "${BUILD_REPRODUCIBLE_BINARIES}" = "1" ]; then
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500654 if [ "$REPRODUCIBLE_TIMESTAMP_ROOTFS" = "" ]; then
Brad Bishop1a4b7ee2018-12-16 17:11:34 -0800655 REPRODUCIBLE_TIMESTAMP_ROOTFS=`git -C "${COREBASE}" log -1 --pretty=%ct 2>/dev/null` || true
656 if [ "${REPRODUCIBLE_TIMESTAMP_ROOTFS}" = "" ]; then
657 REPRODUCIBLE_TIMESTAMP_ROOTFS=`stat -c%Y ${@bb.utils.which(d.getVar("BBPATH"), "conf/bitbake.conf")}`
658 fi
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500659 fi
660 # Set mtime of all files to a reproducible value
661 bbnote "reproducible_final_image_task: mtime set to $REPRODUCIBLE_TIMESTAMP_ROOTFS"
662 find ${IMAGE_ROOTFS} -exec touch -h --date=@$REPRODUCIBLE_TIMESTAMP_ROOTFS {} \;
663 fi
664}
Brad Bishopc342db32019-05-15 21:57:59 -0400665
666systemd_preset_all () {
Brad Bishop96ff1982019-08-19 13:50:42 -0400667 if [ -e ${IMAGE_ROOTFS}${root_prefix}/lib/systemd/systemd ]; then
668 systemctl --root="${IMAGE_ROOTFS}" --preset-mode=enable-only preset-all
669 fi
Brad Bishopc342db32019-05-15 21:57:59 -0400670}
671
Brad Bishopc342db32019-05-15 21:57:59 -0400672IMAGE_PREPROCESS_COMMAND_append = " ${@ 'systemd_preset_all;' if bb.utils.contains('DISTRO_FEATURES', 'systemd', True, False, d) and not bb.utils.contains('IMAGE_FEATURES', 'stateless-rootfs', True, False, d) else ''} reproducible_final_image_task; "
Brad Bishop316dfdd2018-06-25 12:45:53 -0400673
674CVE_PRODUCT = ""