meta/classes-global/sanity.bbclass

4 # SPDX-License-Identifier: MIT
43 SANITY_DIFF_TOOL ?= "diff -u"
52 local.conf.sample and there have been updates made to this file. Please compare the two
53 files and merge any changes before continuing.
72 site.conf.sample and there have been updates made to this file. Please compare the two
73 files and merge any changes before continuing.
93 Please compare your file against bblayers.conf.sample and merge any changes before continuing.
110     if current_lconf == 4 and lconf_version > 4:
115             if start != -1 and (len(bbpath_line) != (start + 1)):
137     elif current_lconf == 5 and lconf_version > 5:
138         # Null update, to avoid issues with people switching between poky and other distros
146     elif current_lconf == 6 and lconf_version > 6:
147         # Handle rename of meta-yocto -> meta-poky
148         # This marks the start of separate version numbers but code is needed in OE-Core
152         if 'meta-yocto' in layers:
155                 index, meta_yocto_line = sanity_conf_find_line(r'.*meta-yocto[\'"\s\n]', lines)
157                     lines[index] = meta_yocto_line.replace('meta-yocto', 'meta-poky')
188     bb.fatal(""" OE-core's config sanity checker detected a potential misconfiguration.
202         overrides = localdata.getVar("OVERRIDES", False) + ":virtclass-multilib-" + multilib
204     bb.debug(2, "Sanity-checking tuning '%s' (%s) features:" % (tune, multilib))
205     features = (localdata.getVar("TUNE_FEATURES:tune-%s" % tune) or "").split()
207         return "Tuning '%s' has no defined features, and cannot be used." % tune
248             tune = data.getVar("DEFAULTTUNE:virtclass-multilib-%s" % lib)
304 …return "Non-ASCII character(s) in %s path (\"%s\") detected. This would cause build failures as we…
310         return subprocess.check_output(["stat", "-f", "-c", "%t", path]).decode('utf-8').strip()
322 # Check that the path is on a case-sensitive file system
327             return "The %s (%s) can't be on a case-insensitive file system.\n" % (name, path)
332     if os.path.islink(lnk) and not os.path.exists(lnk):
346     # Only check connectivity if network enabled and the
350     if check_enabled and network_enabled:
351         # Take a copy of the data store and unset MIRRORS and PREMIRRORS
365 …  msg += "    Please ensure CONNECTIVITY_CHECK_URIS is correct and specified URIs are available.\n"
394 …bb.warn('Host distribution "%s" has not been validated with this version of the build system; you …
432 # Patch before 2.7 can't handle all the features in git-style diffs.  Some
433 # patches may incorrectly apply, and others won't apply at all.
438 … result = subprocess.check_output(["patch", "--version"], stderr=subprocess.STDOUT).decode('utf-8')
439         version = re.search(r"[0-9.]+", result.splitlines()[0]).group()
441 …return "Your version of patch is older than 2.7 and has bugs which will break builds. Please insta…
445         return "Unable to execute patch --version, exit code %d:\n%s\n" % (e.returncode, e.output)
452 …  result = subprocess.check_output(['make', '--version'], stderr=subprocess.STDOUT).decode('utf-8')
454         return "Unable to execute make --version, exit code %d\n%s\n" % (e.returncode, e.output)
461         if "ubuntu" in distro or "debian" in distro or "linuxmint" in distro:
463 …2.1 is known to have issues on Centos/OpenSUSE and other non-Ubuntu systems. Please use a buildtoo…
472 # https://docs.microsoft.com/en-us/windows/wsl/wsl2-install
505 …ee https://discourse.ubuntu.com/t/ubuntu-24-04-lts-noble-numbat-release-notes/39890#unprivileged-u…
510 # This can be fixed on CentOS-7 with devtoolset-6+
511 # https://www.softwarecollections.org/en/scls/rhscl/devtoolset-6/
513 # A less invasive fix is with scripts/install-buildtools (or with user
514 # built buildtools-extended-tarball)
522 …n 8.0 and will break builds. Please install a newer version of gcc (you could use the project's bu…
525 # Tar version 1.24 and onwards handle overwriting symlinks correctly
527 # Version 1.28 is needed so opkg-build works correctly when reproducible builds are enabled
532 …   result = subprocess.check_output(["tar", "--version"], stderr=subprocess.STDOUT).decode('utf-8')
534         return "Unable to execute tar --version, exit code %d\n%s\n" % (e.returncode, e.output)
536 …tall gtar (you could use the project's buildtools-tarball from our last release or use scripts/ins…
539 …and does not have the support needed to enable reproducible builds. Please install a newer version…
542 …      result = subprocess.check_output(["tar", "--help"], stderr=subprocess.STDOUT).decode('utf-8')
543         if "--xattrs" not in result:
544             return "Your tar doesn't support --xattrs, please use GNU tar.\n"
546         return "Unable to execute tar --help, exit code %d\n%s\n" % (e.returncode, e.output)
550 # We use git parameters and functionality only found in 1.7.8 or later
551 # The kernel tools assume git >= 1.8.3.1 (verified needed > 1.7.9.5) see #6162
556 …  result = subprocess.check_output(["git", "--version"], stderr=subprocess.DEVNULL).decode('utf-8')
558         return "Unable to execute git --version, exit code %d\n%s\n" % (e.returncode, e.output)
561 …return "Your version of git is older than 1.8.3.1 and has bugs which will break builds. Please ins…
572             subprocess.check_output(["perl", "-e", "use %s" % m])
584         if check_conf_exists(conffile, d) and d.getVar(current_version) is not None and \
587                 bb.build.exec_func(func, d)
594     indexes = glob.glob(d.expand("${SSTATE_MANIFESTS}/index-${BUILD_ARCH}_*"))
625     cmd = shlex.split(d.getVar("BUILD_CXX")) + ["-x", "c++","-", "-o", "/dev/null", flag]
646         elif int(abi) <= 11 and current_abi == "12":
647 …MPDIR changed for Recipe Specific Sysroots.\nConversion doesn't make sense and this change will re…
648         elif int(abi) <= 13 and current_abi == "14":
650         elif int(abi) == 14 and current_abi == "15":
656 …status.addresult("Error, TMPDIR has changed its layout version number (%s to %s) and you need to e…
679     # In other words, these tests run once in a given build directory and then
683     # minimal installations: glib-2.0-natives requires xml.parsers.expat
721     if "diffstat-native" not in assume_provided:
731         status.addresult("TMPDIR is setgid, please don't build in a setgid directory")
733         status.addresult("TMPDIR is setuid, please don't build in a setuid directory")
739         if i and workdir.startswith(i):
740 …n a path included in PSEUDO_IGNORE_PATHS " + str(i) + " please locate the build outside this path.…
742     # Check if PSEUDO_IGNORE_PATHS and paths under pseudo control overlap
748             if i and j:
750 …in PSEUDO_IGNORE_PATHS " + str(i) + " and the path " + str(j) + " overlap and this will break pseu…
752     # Some third-party software apparently relies on chmod etc. being suid root (!!)
759             if bin_stat.st_uid == 0 and bin_stat.st_mode & stat.S_ISUID:
760 … has the setuid bit set. This interferes with pseudo and may cause other issues that break the bui…
771         if os.path.exists('/lib64') and ( os.path.islink('/lib64') or os.path.islink('/lib') ):
774 …if os.path.exists('%s/libc.so.6' % lib32path) and not os.path.exists('/usr/include/gnu/stubs-32.h'…
775 …status.addresult("You have a 32-bit libc, but no 32-bit headers.  You must install the 32-bit libc…
780                 "an empty entry, a './' or a '.'.\n\t This is unsafe and means your "\
782                 "Please check your layer.conf files and other BBPATH "        \
794 …at TOPDIR does not contain non ascii chars (perl_5.40.0, Perl-native and shadow-native build failu…
800     # Check for case-insensitive file systems (such as Linux in Docker on
805     status.addresult(check_cpp_toolchain_flag(d, "-lstdc++"))
807     # Check if the C++ toochain support the "--std=gnu++20" flag
808     status.addresult(check_cpp_toolchain_flag(d, "--std=gnu++20",
809         "An error occurred during checking the C++ toolchain for '--std=gnu++20' support. "
814     Currently bitbake switches locale to en_US.UTF-8 so check that this locale actually exists.
818         locale.setlocale(locale.LC_ALL, "en_US.UTF-8")
820         raise_sanity_error("Your system needs to support the en_US.UTF-8 locale.", d)
824     # Sanity tests which test the users environment so need to run at each build (or are so cheap
838 …status.addresult('Bitbake version %s is required and version %s was found\n' % (minversion, bb.__v…
844 …status.addresult("PATH contains '.', './' or '' (empty element), which will break the build, pleas…
855 …ective in your local.conf. The directive is supposed to be used in classes and recipes only to inh…
860     if distro and distro != "nodistro":
864     # Check that these variables don't use tilde-expansion as we don't do that
869 …# Check that DL_DIR is set, exists and is writable. In theory, we should never even hit the check …
873 …R is not set. Your environment is misconfigured, check that DL_DIR is set, and if the directory ex…
874     if os.path.exists(dldir) and not os.access(dldir, os.W_OK):
894         if not check_conf_exists("conf/machine-sdk/${SDKMACHINE}.conf", d):
897 …status.addresult('SDKMACHINE is set, but SDK_ARCH has not been changed as a result - SDKMACHINE ma…
899     # If SDK_VENDOR looks like "-my-sdk" then the triples are badly formed so fail early
901     if not (sdkvendor.startswith("-") and sdkvendor.count("-") == 1):
902 …status.addresult("SDK_VENDOR should be of the form '-foosdk' with a single dash; found '%s'\n" % s…
908         status.addresult("Please use a umask which allows a+rx and u+rwx\n")
916         # This path is no longer user-readable in modern (very recent) Linux
930         if val.find('..') != -1:
932         if val.find('+') != -1:
934         if val.find('@') != -1:
936         if val.find(' ') != -1:
938         if val.find('%') != -1:
941     # Check the format of MIRRORS, PREMIRRORS and SSTATE_MIRRORS
982                     mirror_base = urllib.parse.urlparse(mirror[:-1*len('/PATH')]).path
985     # Check sstate mirrors aren't being used with a local hash server and no remote
987 …if d.getVar("SSTATE_MIRRORS") and hashserv and hashserv.startswith("unix://") and not d.getVar("BB…
997 …R has changed location. You need to either move it back to %s or delete it and rebuild\n" % saved_…
1000         # Remove setuid, setgid and sticky bits from TMPDIR
1013         # Due to update-alternatives, the shell name may take various
1015         if '/dash' not in real_sh and '/bash' not in real_sh:
1058     # get actual host distribution id and version
1067     if os.path.exists(os.path.dirname(sanityverfile)) and not status.messages: