summaryrefslogtreecommitdiffstats
path: root/check-kabi
diff options
context:
space:
mode:
authorJeremy Cline <jcline@redhat.com>2020-04-14 17:53:23 -0400
committerJeremy Cline <jcline@redhat.com>2020-04-14 17:53:23 -0400
commit0310b312a7e5dffcdf24ae835ed732f7a6a9c471 (patch)
treeca12edc19a6f6e05ef31919d65adf895a39d12c0 /check-kabi
parent48b75e92d6f4024e7f99442334f6969345516a72 (diff)
downloadkernel-0310b312a7e5dffcdf24ae835ed732f7a6a9c471.tar.gz
kernel-0310b312a7e5dffcdf24ae835ed732f7a6a9c471.tar.xz
kernel-0310b312a7e5dffcdf24ae835ed732f7a6a9c471.zip
kernel-5.7.0-0.rc1.20200414git8632e9b5645b.1
This is an automated commit generated from the kernel-5.7.0-0.rc1.20200414git8632e9b5645b.1 tag in https://gitlab.com/cki-project/kernel-ark.git
Diffstat (limited to 'check-kabi')
-rwxr-xr-x[-rw-r--r--]check-kabi149
1 files changed, 149 insertions, 0 deletions
diff --git a/check-kabi b/check-kabi
index e69de29bb..f9d4dcb84 100644..100755
--- a/check-kabi
+++ b/check-kabi
@@ -0,0 +1,149 @@
+#!/usr/bin/python3
+#
+# check-kabi - Red Hat kABI reference checking tool
+#
+# We use this script to check against reference Module.kabi files.
+#
+# Author: Jon Masters <jcm@redhat.com>
+# Copyright (C) 2007-2009 Red Hat, Inc.
+#
+# This software may be freely redistributed under the terms of the GNU
+# General Public License (GPL).
+
+# Changelog:
+#
+# 2018/06/01 - Update for python3 by Petr Oros.
+# 2009/08/15 - Updated for use in RHEL6.
+# 2007/06/13 - Initial rewrite in python by Jon Masters.
+
+__author__ = "Jon Masters <jcm@redhat.com>"
+__version__ = "2.0"
+__date__ = "2009/08/15"
+__copyright__ = "Copyright (C) 2007-2009 Red Hat, Inc"
+__license__ = "GPL"
+
+import getopt
+import string
+import sys
+
+true = 1
+false = 0
+
+
+def load_symvers(symvers, filename):
+ """Load a Module.symvers file."""
+
+ symvers_file = open(filename, "r")
+
+ while true:
+ in_line = symvers_file.readline()
+ if in_line == "":
+ break
+ if in_line == "\n":
+ continue
+ checksum, symbol, directory, type = in_line.split()
+
+ symvers[symbol] = in_line[0:-1]
+
+
+def load_kabi(kabi, filename):
+ """Load a Module.kabi file."""
+
+ kabi_file = open(filename, "r")
+
+ while true:
+ in_line = kabi_file.readline()
+ if in_line == "":
+ break
+ if in_line == "\n":
+ continue
+ checksum, symbol, directory, type = in_line.split()
+
+ kabi[symbol] = in_line[0:-1]
+
+
+def check_kabi(symvers, kabi):
+ """Check Module.kabi and Module.symvers files."""
+
+ fail = 0
+ warn = 0
+ changed_symbols = []
+ moved_symbols = []
+
+ for symbol in kabi:
+ abi_hash, abi_sym, abi_dir, abi_type = kabi[symbol].split()
+ if symbol in symvers:
+ sym_hash, sym_sym, sym_dir, sym_type = symvers[symbol].split()
+ if abi_hash != sym_hash:
+ fail = 1
+ changed_symbols.append(symbol)
+
+ if abi_dir != sym_dir:
+ warn = 1
+ moved_symbols.append(symbol)
+ else:
+ fail = 1
+ changed_symbols.append(symbol)
+
+ if fail:
+ print("*** ERROR - ABI BREAKAGE WAS DETECTED ***")
+ print("")
+ print("The following symbols have been changed (this will cause an ABI breakage):")
+ print("")
+ for symbol in changed_symbols:
+ print(symbol)
+ print("")
+
+ if warn:
+ print("*** WARNING - ABI SYMBOLS MOVED ***")
+ print("")
+ print("The following symbols moved (typically caused by moving a symbol from being")
+ print("provided by the kernel vmlinux out to a loadable module):")
+ print("")
+ for symbol in moved_symbols:
+ print(symbol)
+ print("")
+
+ """Halt the build, if we got errors and/or warnings. In either case,
+ double-checkig is required to avoid introducing / concealing
+ KABI inconsistencies."""
+ if fail or warn:
+ sys.exit(1)
+ sys.exit(0)
+
+
+def usage():
+ print("""
+check-kabi: check Module.kabi and Module.symvers files.
+
+ check-kabi [ -k Module.kabi ] [ -s Module.symvers ]
+
+""")
+
+
+if __name__ == "__main__":
+
+ symvers_file = ""
+ kabi_file = ""
+
+ opts, args = getopt.getopt(sys.argv[1:], 'hk:s:')
+
+ for o, v in opts:
+ if o == "-s":
+ symvers_file = v
+ if o == "-h":
+ usage()
+ sys.exit(0)
+ if o == "-k":
+ kabi_file = v
+
+ if (symvers_file == "") or (kabi_file == ""):
+ usage()
+ sys.exit(1)
+
+ symvers = {}
+ kabi = {}
+
+ load_symvers(symvers, symvers_file)
+ load_kabi(kabi, kabi_file)
+ check_kabi(symvers, kabi)