summaryrefslogtreecommitdiff
path: root/classes/insane.bbclass
diff options
context:
space:
mode:
Diffstat (limited to 'classes/insane.bbclass')
-rw-r--r--classes/insane.bbclass483
1 files changed, 439 insertions, 44 deletions
diff --git a/classes/insane.bbclass b/classes/insane.bbclass
index e30375288d..804caf06ee 100644
--- a/classes/insane.bbclass
+++ b/classes/insane.bbclass
@@ -8,100 +8,463 @@
# -Check the RUNTIME path for the $TMPDIR
# -Check if .la files wrongly point to workdir
# -Check if .pc files wrongly point to workdir
-# -Check if packages contains .debug directories or .so files where they should be in -dev or -dbg
-#
+# -Check if packages contains .debug directories or .so files
+# where they should be in -dev or -dbg
+# -Check if config.log contains traces to broken autoconf tests
#
# We need to have the scanelf utility as soon as
-# possible and this is contained within the pax-utils-native
+# possible and this is contained within the pax-utils-native.
+# The package.bbclass can help us here.
#
-
-
-# We play a special package function
inherit package
-PACKAGE_DEPENDS += "pax-utils-native"
+PACKAGE_DEPENDS += "pax-utils-native desktop-file-utils-native"
PACKAGEFUNCS += " do_package_qa "
-def package_qa_check_rpath(file,name,d):
+
+#
+# dictionary for elf headers
+#
+# feel free to add and correct.
+#
+# TARGET_OS TARGET_ARCH MACHINE, OSABI, ABIVERSION, Little Endian, 32bit?
+def package_qa_get_machine_dict():
+ return {
+ "darwin9" : {
+ "arm" : (40, 0, 0, True, True),
+ },
+ "linux" : {
+ "arm" : (40, 97, 0, True, True),
+ "armeb": (40, 97, 0, False, True),
+ "powerpc": (20, 0, 0, False, True),
+ "i386": ( 3, 0, 0, True, True),
+ "i486": ( 3, 0, 0, True, True),
+ "i586": ( 3, 0, 0, True, True),
+ "i686": ( 3, 0, 0, True, True),
+ "x86_64": (62, 0, 0, True, False),
+ "ia64": (50, 0, 0, True, False),
+ "alpha": (36902, 0, 0, True, False),
+ "hppa": (15, 3, 0, False, True),
+ "m68k": ( 4, 0, 0, False, True),
+ "mips": ( 8, 0, 0, False, True),
+ "mipsel": ( 8, 0, 0, True, True),
+ "s390": (22, 0, 0, False, True),
+ "sh4": (42, 0, 0, True, True),
+ "sparc": ( 2, 0, 0, False, True),
+ },
+ "linux-uclibc" : {
+ "arm" : ( 40, 97, 0, True, True),
+ "armeb": ( 40, 97, 0, False, True),
+ "powerpc": ( 20, 0, 0, False, True),
+ "i386": ( 3, 0, 0, True, True),
+ "i486": ( 3, 0, 0, True, True),
+ "i586": ( 3, 0, 0, True, True),
+ "i686": ( 3, 0, 0, True, True),
+ "mips": ( 8, 0, 0, False, True),
+ "mipsel": ( 8, 0, 0, True, True),
+ "avr32": (6317, 0, 0, False, True),
+ "sh4": (42, 0, 0, True, True),
+
+ },
+ "uclinux-uclibc" : {
+ "bfin": ( 106, 0, 0, True, True),
+ },
+ "linux-gnueabi" : {
+ "arm" : (40, 0, 0, True, True),
+ "armeb" : (40, 0, 0, False, True),
+ },
+ "linux-uclibceabi" : {
+ "arm" : (40, 0, 0, True, True),
+ "armeb" : (40, 0, 0, False, True),
+ },
+ "linux-gnuspe" : {
+ "powerpc": (20, 0, 0, False, True),
+ },
+ "linux-uclibcspe" : {
+ "powerpc": (20, 0, 0, False, True),
+ },
+
+ }
+
+# factory for a class, embedded in a method
+def package_qa_get_elf(path, bits32):
+ class ELFFile:
+ EI_NIDENT = 16
+
+ EI_CLASS = 4
+ EI_DATA = 5
+ EI_VERSION = 6
+ EI_OSABI = 7
+ EI_ABIVERSION = 8
+
+ # possible values for EI_CLASS
+ ELFCLASSNONE = 0
+ ELFCLASS32 = 1
+ ELFCLASS64 = 2
+
+ # possible value for EI_VERSION
+ EV_CURRENT = 1
+
+ # possible values for EI_DATA
+ ELFDATANONE = 0
+ ELFDATA2LSB = 1
+ ELFDATA2MSB = 2
+
+ def my_assert(self, expectation, result):
+ if not expectation == result:
+ #print "'%x','%x' %s" % (ord(expectation), ord(result), self.name)
+ raise Exception("This does not work as expected")
+
+ def __init__(self, name):
+ self.name = name
+
+ def open(self):
+ self.file = file(self.name, "r")
+ self.data = self.file.read(ELFFile.EI_NIDENT+4)
+
+ self.my_assert(len(self.data), ELFFile.EI_NIDENT+4)
+ self.my_assert(self.data[0], chr(0x7f) )
+ self.my_assert(self.data[1], 'E')
+ self.my_assert(self.data[2], 'L')
+ self.my_assert(self.data[3], 'F')
+ if bits32 :
+ self.my_assert(self.data[ELFFile.EI_CLASS], chr(ELFFile.ELFCLASS32))
+ else:
+ self.my_assert(self.data[ELFFile.EI_CLASS], chr(ELFFile.ELFCLASS64))
+ self.my_assert(self.data[ELFFile.EI_VERSION], chr(ELFFile.EV_CURRENT) )
+
+ self.sex = self.data[ELFFile.EI_DATA]
+ if self.sex == chr(ELFFile.ELFDATANONE):
+ raise Exception("self.sex == ELFDATANONE")
+ elif self.sex == chr(ELFFile.ELFDATA2LSB):
+ self.sex = "<"
+ elif self.sex == chr(ELFFile.ELFDATA2MSB):
+ self.sex = ">"
+ else:
+ raise Exception("Unknown self.sex")
+
+ def osAbi(self):
+ return ord(self.data[ELFFile.EI_OSABI])
+
+ def abiVersion(self):
+ return ord(self.data[ELFFile.EI_ABIVERSION])
+
+ def isLittleEndian(self):
+ return self.sex == "<"
+
+ def isBigEngian(self):
+ return self.sex == ">"
+
+ def machine(self):
+ """
+ We know the sex stored in self.sex and we
+ know the position
+ """
+ import struct
+ (a,) = struct.unpack(self.sex+"H", self.data[18:20])
+ return a
+
+ return ELFFile(path)
+
+
+# Known Error classes
+# 0 - non dev contains .so
+# 1 - package contains a dangerous RPATH
+# 2 - package depends on debug package
+# 3 - non dbg contains .so
+# 4 - wrong architecture
+# 5 - .la contains installed=yes or reference to the workdir
+# 6 - .pc contains reference to /usr/include or workdir
+# 7 - the desktop file is not valid
+# 8 - .la contains reference to the workdir
+# 9 - LDFLAGS ignored
+
+def package_qa_clean_path(path,d):
+ """ Remove the common prefix from the path. In this case it is the TMPDIR"""
+ return path.replace(bb.data.getVar('TMPDIR',d,True),"")
+
+def package_qa_make_fatal_error(error_class, name, path,d):
+ """
+ decide if an error is fatal
+
+ TODO: Load a whitelist of known errors
+ """
+ return not error_class in [0, 5, 7]
+
+def package_qa_write_error(error_class, name, path, d):
+ """
+ Log the error
+ """
+ if not bb.data.getVar('QA_LOG', d):
+ bb.note("a QA error occured but will not be logged because QA_LOG is not set")
+ return
+
+ ERROR_NAMES =[
+ "non dev contains .so",
+ "package contains RPATH",
+ "package depends on debug package",
+ "non dbg contains .debug",
+ "wrong architecture",
+ "evil hides inside the .la",
+ "evil hides inside the .pc",
+ "the desktop file is not valid",
+ ".la contains reference to the workdir",
+ "LDFLAGS ignored",
+ ]
+
+ log_path = os.path.join( bb.data.getVar('T', d, True), "log.qa_package" )
+ f = file( log_path, "a+")
+ print >> f, "%s, %s, %s" % \
+ (ERROR_NAMES[error_class], name, package_qa_clean_path(path,d))
+ f.close()
+
+def package_qa_handle_error(error_class, error_msg, name, path, d):
+ bb.error("QA Issue with %s: %s" % (name, error_msg))
+ package_qa_write_error(error_class, name, path, d)
+ return not package_qa_make_fatal_error(error_class, name, path, d)
+
+def package_qa_check_rpath(file,name,d, elf):
"""
Check for dangerous RPATHs
"""
+ if not elf:
+ return True
+
import bb, os
+ sane = True
scanelf = os.path.join(bb.data.getVar('STAGING_BINDIR_NATIVE',d,True),'scanelf')
bad_dir = bb.data.getVar('TMPDIR', d, True) + "/work"
+ bad_dir_test = bb.data.getVar('TMPDIR', d, True)
if not os.path.exists(scanelf):
- bb.note("Can not check RPATH scanelf not found")
+ bb.fatal("Can not check RPATH, scanelf (part of pax-utils-native) not found")
+
if not bad_dir in bb.data.getVar('WORKDIR', d, True):
- bb.error("This class assumed that WORKDIR is ${TMPDIR}/work... Not doing any check")
+ bb.fatal("This class assumed that WORKDIR is ${TMPDIR}/work... Not doing any check")
- output = os.popen("%s -Byr %s" % (scanelf,file))
- txt = output.readline().rsplit()
- if bad_dir in txt:
- bb.error("QA Issue package %s contains bad RPATH %s in file %s" % (name, txt, file))
+ output = os.popen("%s -B -F%%r#F '%s'" % (scanelf,file))
+ txt = output.readline().split()
+ for line in txt:
+ if bad_dir in line:
+ error_msg = "package %s contains bad RPATH %s in file %s" % (name, line, file)
+ sane = package_qa_handle_error(1, error_msg, name, file, d)
- pass
+ return sane
-def package_qa_check_devdbg(path, name,d):
+def package_qa_check_dev(path, name,d, elf):
"""
- Check for debug remains inside the binary or
- non dev packages containing
+ Check for ".so" library symlinks in non-dev packages
"""
- import bb
+ sane = True
+
+ # SDK packages are special.
+ for s in ['sdk', 'canadian-sdk']:
+ if bb.data.inherits_class(s, d):
+ return True
+
if not "-dev" in name:
- if path[-3:] == ".so":
- bb.error("QA Issue: non dev package contains .so: %s" % name)
+ if path[-3:] == ".so" and os.path.islink(path):
+ error_msg = "non -dev package contains symlink .so: %s path '%s'" % \
+ (name, package_qa_clean_path(path,d))
+ sane = package_qa_handle_error(0, error_msg, name, path, d)
+
+ return sane
+
+def package_qa_check_dbg(path, name,d, elf):
+ """
+ Check for ".debug" files or directories outside of the dbg package
+ """
+
+ sane = True
if not "-dbg" in name:
if '.debug' in path:
- bb.error("QA Issue: non debug package contains .debug directory: %s" % name)
+ error_msg = "non debug package contains .debug directory: %s path %s" % \
+ (name, package_qa_clean_path(path,d))
+ sane = package_qa_handle_error(3, error_msg, name, path, d)
-def package_qa_check_perm(path,name,d):
+ return sane
+
+def package_qa_check_perm(path,name,d, elf):
"""
Check the permission of files
"""
- pass
+ sane = True
+ return sane
-def package_qa_check_arch(path,name,d):
+def package_qa_check_arch(path,name,d, elf):
"""
Check if archs are compatible
"""
- pass
+ if not elf:
+ return True
+
+ sane = True
+ target_os = bb.data.getVar('TARGET_OS', d, True)
+ target_arch = bb.data.getVar('TARGET_ARCH', d, True)
+
+ # FIXME: Cross package confuse this check, so just skip them
+ for s in ['cross', 'sdk', 'canadian-cross', 'canadian-sdk']:
+ if bb.data.inherits_class(s, d):
+ return True
+
+ # avoid following links to /usr/bin (e.g. on udev builds)
+ # we will check the files pointed to anyway...
+ if os.path.islink(path):
+ return True
+
+ #if this will throw an exception, then fix the dict above
+ (machine, osabi, abiversion, littleendian, bits32) \
+ = package_qa_get_machine_dict()[target_os][target_arch]
+
+ # Check the architecture and endiannes of the binary
+ if not machine == elf.machine():
+ error_msg = "Architecture did not match (%d to %d) on %s" % \
+ (machine, elf.machine(), package_qa_clean_path(path,d))
+ sane = package_qa_handle_error(4, error_msg, name, path, d)
+ elif not littleendian == elf.isLittleEndian():
+ error_msg = "Endiannes did not match (%d to %d) on %s" % \
+ (littleendian, elf.isLittleEndian(), package_qa_clean_path(path,d))
+ sane = package_qa_handle_error(4, error_msg, name, path, d)
+
+ return sane
+
+def package_qa_check_desktop(path, name, d, elf):
+ """
+ Run all desktop files through desktop-file-validate.
+ """
+ sane = True
+ if path.endswith(".desktop"):
+ output = os.popen("desktop-file-validate %s" % path)
+ # This only produces output on errors
+ for l in output:
+ sane = package_qa_handle_error(7, l.strip(), name, path, d)
-def package_qa_check_pcla(path,name,d):
+ return sane
+
+def package_qa_hash_style(path, name, d, elf):
"""
- .pc and .la files should not point
+ Check if the binary has the right hash style...
"""
+ if not elf:
+ return True
+
+ if os.path.islink(path):
+ return True
+
+ gnu_hash = "--hash-style=gnu" in bb.data.getVar('LDFLAGS', d, True)
+ if not gnu_hash:
+ gnu_hash = "--hash-style=both" in bb.data.getVar('LDFLAGS', d, True)
+ if not gnu_hash:
+ return True
+
+ objdump = bb.data.getVar('OBJDUMP', d, True)
+ env_path = bb.data.getVar('PATH', d, True)
+
+ sane = True
+ elf = False
+ # A bit hacky. We do not know if path is an elf binary or not
+ # we will search for 'NEEDED' or 'INIT' as this should be printed...
+ # and come before the HASH section (guess!!!) and works on split out
+ # debug symbols too
+ for line in os.popen("LC_ALL=C PATH=%s %s -p '%s' 2> /dev/null" % (env_path, objdump, path), "r"):
+ if "NEEDED" in line or "INIT" in line:
+ sane = False
+ elf = True
+ if "GNU_HASH" in line:
+ sane = True
+ if "[mips32]" in line or "[mips64]" in line:
+ sane = True
+
+ if elf and not sane:
+ error_msg = "No GNU_HASH in the elf binary: '%s'" % path
+ return package_qa_handle_error(9, error_msg, name, path, d)
+
+ return True
+
def package_qa_check_staged(path,d):
"""
Check staged la and pc files for sanity
-e.g. installed being false
+
+ As this is run after every stage we should be able
+ to find the one responsible for the errors easily even
+ if we look at every .pc and .la file
"""
- pass
+
+ sane = True
+ tmpdir = bb.data.getVar('TMPDIR', d, True)
+ workdir = os.path.join(tmpdir, "work")
+
+ installed = "installed=yes"
+ iscrossnative = False
+ pkgconfigcheck = tmpdir
+ for s in ['cross', 'native', 'canadian-cross', 'canadian-native']:
+ if bb.data.inherits_class(s, d):
+ pkgconfigcheck = workdir
+ iscrossnative = True
+
+ # find all .la and .pc files
+ # read the content
+ # and check for stuff that looks wrong
+ for root, dirs, files in os.walk(path):
+ for file in files:
+ path = os.path.join(root,file)
+ if file[-2:] == "la":
+ file_content = open(path).read()
+ # Don't check installed status for native/cross packages
+ if not iscrossnative:
+ if installed in file_content:
+ error_msg = "%s failed sanity test (installed) in path %s" % (file,root)
+ sane = package_qa_handle_error(5, error_msg, "staging", path, d)
+ if workdir in file_content:
+ error_msg = "%s failed sanity test (workdir) in path %s" % (file,root)
+ sane = package_qa_handle_error(8, error_msg, "staging", path, d)
+ elif file[-2:] == "pc":
+ file_content = open(path).read()
+ if pkgconfigcheck in file_content:
+ error_msg = "%s failed sanity test (tmpdir) in path %s" % (file,root)
+ sane = package_qa_handle_error(6, error_msg, "staging", path, d)
+
+ return sane
# Walk over all files in a directory and call func
def package_qa_walk(path, funcs, package,d):
- import os
+ sane = True
+
+ #if this will throw an exception, then fix the dict above
+ target_os = bb.data.getVar('TARGET_OS', d, True)
+ target_arch = bb.data.getVar('TARGET_ARCH', d, True)
+ (machine, osabi, abiversion, littleendian, bits32) \
+ = package_qa_get_machine_dict()[target_os][target_arch]
+
for root, dirs, files in os.walk(path):
for file in files:
path = os.path.join(root,file)
+ elf = package_qa_get_elf(path, bits32)
+ try:
+ elf.open()
+ except:
+ elf = None
for func in funcs:
- func(path, package,d)
+ if not func(path, package,d, elf):
+ sane = False
+ return sane
-def package_qa_check_rdepends(pkg, workdir, d):
- import bb
+def package_qa_check_rdepends(pkg, pkgdest, d):
+ sane = True
if not "-dbg" in pkg and not "task-" in pkg and not "-image" in pkg:
# Copied from package_ipk.bbclass
# boiler plate to update the data
localdata = bb.data.createCopy(d)
- root = "%s/install/%s" % (workdir, pkg)
+ root = "%s/%s" % (pkgdest, pkg)
bb.data.setVar('ROOT', '', localdata)
bb.data.setVar('ROOT_%s' % pkg, root, localdata)
- pkgname = bb.data.getVar('PKG_%s' % pkg, localdata, 1)
+ pkgname = bb.data.getVar('PKG_%s' % pkg, localdata, True)
if not pkgname:
pkgname = pkg
bb.data.setVar('PKG', pkgname, localdata)
@@ -121,31 +484,63 @@ def package_qa_check_rdepends(pkg, workdir, d):
# Now do the sanity check!!!
for rdepend in rdepends:
if "-dbg" in rdepend:
- bb.error("QA issue, koen give us a better msg!!!")
+ error_msg = "%s rdepends on %s" % (pkgname,rdepend)
+ sane = package_qa_handle_error(2, error_msg, pkgname, rdepend, d)
+
+ return sane
# The PACKAGE FUNC to scan each package
python do_package_qa () {
- bb.note("DO PACKAGE QA")
- workdir = bb.data.getVar('WORKDIR', d, True)
+ bb.debug(2, "DO PACKAGE QA")
+ pkgdest = bb.data.getVar('PKGDEST', d, True)
packages = bb.data.getVar('PACKAGES',d, True)
# no packages should be scanned
if not packages:
return
+ checks = [package_qa_check_rpath, package_qa_check_dev,
+ package_qa_check_perm, package_qa_check_arch,
+ package_qa_check_desktop, package_qa_hash_style,
+ package_qa_check_dbg]
+ walk_sane = True
+ rdepends_sane = True
for package in packages.split():
- bb.note("Package: %s" % package)
- path = "%s/install/%s" % (workdir, package)
- package_qa_walk(path, [package_qa_check_rpath, package_qa_check_devdbg, package_qa_check_perm, package_qa_check_arch], package, d)
- package_qa_check_rdepends(package, workdir, d)
+ if bb.data.getVar('INSANE_SKIP_' + package, d, True):
+ bb.note("package %s skipped" % package)
+ continue
+
+ bb.debug(1, "Checking Package: %s" % package)
+ path = "%s/%s" % (pkgdest, package)
+ if not package_qa_walk(path, checks, package, d):
+ walk_sane = False
+ if not package_qa_check_rdepends(package, pkgdest, d):
+ rdepends_sane = False
+ if not walk_sane or not rdepends_sane:
+ bb.fatal("QA run found fatal errors. Please consider fixing them.")
+ bb.debug(2, "DONE with PACKAGE QA")
}
# The Staging Func, to check all staging
addtask qa_staging after do_populate_staging before do_build
python do_qa_staging() {
- bb.note("Staged!")
+ bb.debug(2, "QA checking staging")
+
+ if not package_qa_check_staged(bb.data.getVar('STAGING_LIBDIR',d,True), d):
+ bb.fatal("QA staging was broken by the package built above")
+}
- package_qa_check_staged(bb.data.getVar('STAGING_DIR',d,True), d)
+# Check broken config.log files
+addtask qa_configure after do_configure before do_compile
+python do_qa_configure() {
+ bb.debug(1, "Checking sanity of the config.log file")
+ for root, dirs, files in os.walk(bb.data.getVar('WORKDIR', d, True)):
+ statement = "grep 'CROSS COMPILE Badness:' %s > /dev/null" % \
+ os.path.join(root,"config.log")
+ if "config.log" in files:
+ if os.system(statement) == 0:
+ bb.fatal("""This autoconf log indicates errors, it looked at host includes.
+Rerun configure task after fixing this. The path was '%s'""" % root)
}
generated by cgit v1.2.3 (git 2.25.1) at 2026-06-02 00:54:42 +0000