kABI簡介
kABI白名單
kABI白名單是內核提供的對外接口的子集。kernel研發過程中各個版本之間kABI白名單內的接口保持不變,那么只使用白名單內的內核函數的驅動就無需重新編譯,即可在新版本內核中使用。
如何創建kABI白名單
擬出需兼容的驅動列表,通過modprobe等工具得到驅動所設計的函數,篩選出其中的內核函數。
$ modprobe --dump-modversions megaraid_sas.ko
0x79d6acc4 module_layout
0x6bc3fbc0 __unregister_chrdev
0x2d3385d3 system_wq
0x99b8fd62 kmalloc_caches # 內核函數
...
再從驅動編譯版本內核的Modules.symvers篩選出函數信息即可得到kABI白名單Module.kabi
$ cat Module.symvers | grep kmalloc_caches
0x00000000 kmalloc_caches vmlinux EXPORT_SYMBOL
檢查kABI兼容性
此處使用CentOS 7.x的開源工具check-kabi,進行kABI兼容性檢查。
#!/usr/bin/python
#
# 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:
#
# 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 os
import re
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 = string.split(in_line)
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 = string.split(in_line)
kabi[symbol] = in_line[0:-1]
def check_kabi(symvers,kabi):
"""Check Module.kabi and Module.symvers files."""
fail=0
warn=0
lost=0
changed_symbols=[]
moved_symbols=[]
losted_symbols=[]
for symbol in kabi:
abi_hash,abi_sym,abi_dir,abi_type = string.split(kabi[symbol])
if symvers.has_key(symbol):
sym_hash,sym_sym,sym_dir,sym_type = string.split(symvers[symbol])
if abi_hash != sym_hash:
fail=1
changed_symbols.append(symbol)
if abi_dir != sym_dir:
warn=1
moved_symbols.append(symbol)
else:
lost=1
losted_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 "new kabi:"
for symbol in changed_symbols:
print symvers[symbol]
print "old kabi:"
for symbol in changed_symbols:
print kabi[symbol]
print ""
if lost:
print "*** ERROR - ABI BREAKAGE WAS DETECTED ***"
print ""
print "The following symbols have been losted (this will cause an ABI breakage):"
print "old kabi:"
for symbol in losted_symbols:
print kabi[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 "new kabi:"
for symbol in moved_symbols:
print symvers[symbol]
print "old kabi"
for symbol in moved_symbols:
print kabi[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 or lost:
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)
依據kABI兼容性實現原理,此python腳本將當前符號表中函數信息與kABI白名單中的函數信息進行對比。如果相關函數發生變化,將輸出對應信息且需要相對應的kabi fix進行修復;無打印信息則表示kABI驗證通過。check-kabi腳本使用方法如下。
python2 check-kabi -k Module.kabi -s Module.symvers