linux/scripts/check_extable.sh

148 lines
4.9 KiB
Bash
Raw Normal View History

#! /bin/bash
License cleanup: add SPDX GPL-2.0 license identifier to files with no license Many source files in the tree are missing licensing information, which makes it harder for compliance tools to determine the correct license. By default all files without license information are under the default license of the kernel, which is GPL version 2. Update the files which contain no license information with the 'GPL-2.0' SPDX license identifier. The SPDX identifier is a legally binding shorthand, which can be used instead of the full boiler plate text. This patch is based on work done by Thomas Gleixner and Kate Stewart and Philippe Ombredanne. How this work was done: Patches were generated and checked against linux-4.14-rc6 for a subset of the use cases: - file had no licensing information it it. - file was a */uapi/* one with no licensing information in it, - file was a */uapi/* one with existing licensing information, Further patches will be generated in subsequent months to fix up cases where non-standard license headers were used, and references to license had to be inferred by heuristics based on keywords. The analysis to determine which SPDX License Identifier to be applied to a file was done in a spreadsheet of side by side results from of the output of two independent scanners (ScanCode & Windriver) producing SPDX tag:value files created by Philippe Ombredanne. Philippe prepared the base worksheet, and did an initial spot review of a few 1000 files. The 4.13 kernel was the starting point of the analysis with 60,537 files assessed. Kate Stewart did a file by file comparison of the scanner results in the spreadsheet to determine which SPDX license identifier(s) to be applied to the file. She confirmed any determination that was not immediately clear with lawyers working with the Linux Foundation. Criteria used to select files for SPDX license identifier tagging was: - Files considered eligible had to be source code files. - Make and config files were included as candidates if they contained >5 lines of source - File already had some variant of a license header in it (even if <5 lines). All documentation files were explicitly excluded. The following heuristics were used to determine which SPDX license identifiers to apply. - when both scanners couldn't find any license traces, file was considered to have no license information in it, and the top level COPYING file license applied. For non */uapi/* files that summary was: SPDX license identifier # files ---------------------------------------------------|------- GPL-2.0 11139 and resulted in the first patch in this series. If that file was a */uapi/* path one, it was "GPL-2.0 WITH Linux-syscall-note" otherwise it was "GPL-2.0". Results of that was: SPDX license identifier # files ---------------------------------------------------|------- GPL-2.0 WITH Linux-syscall-note 930 and resulted in the second patch in this series. - if a file had some form of licensing information in it, and was one of the */uapi/* ones, it was denoted with the Linux-syscall-note if any GPL family license was found in the file or had no licensing in it (per prior point). Results summary: SPDX license identifier # files ---------------------------------------------------|------ GPL-2.0 WITH Linux-syscall-note 270 GPL-2.0+ WITH Linux-syscall-note 169 ((GPL-2.0 WITH Linux-syscall-note) OR BSD-2-Clause) 21 ((GPL-2.0 WITH Linux-syscall-note) OR BSD-3-Clause) 17 LGPL-2.1+ WITH Linux-syscall-note 15 GPL-1.0+ WITH Linux-syscall-note 14 ((GPL-2.0+ WITH Linux-syscall-note) OR BSD-3-Clause) 5 LGPL-2.0+ WITH Linux-syscall-note 4 LGPL-2.1 WITH Linux-syscall-note 3 ((GPL-2.0 WITH Linux-syscall-note) OR MIT) 3 ((GPL-2.0 WITH Linux-syscall-note) AND MIT) 1 and that resulted in the third patch in this series. - when the two scanners agreed on the detected license(s), that became the concluded license(s). - when there was disagreement between the two scanners (one detected a license but the other didn't, or they both detected different licenses) a manual inspection of the file occurred. - In most cases a manual inspection of the information in the file resulted in a clear resolution of the license that should apply (and which scanner probably needed to revisit its heuristics). - When it was not immediately clear, the license identifier was confirmed with lawyers working with the Linux Foundation. - If there was any question as to the appropriate license identifier, the file was flagged for further research and to be revisited later in time. In total, over 70 hours of logged manual review was done on the spreadsheet to determine the SPDX license identifiers to apply to the source files by Kate, Philippe, Thomas and, in some cases, confirmation by lawyers working with the Linux Foundation. Kate also obtained a third independent scan of the 4.13 code base from FOSSology, and compared selected files where the other two scanners disagreed against that SPDX file, to see if there was new insights. The Windriver scanner is based on an older version of FOSSology in part, so they are related. Thomas did random spot checks in about 500 files from the spreadsheets for the uapi headers and agreed with SPDX license identifier in the files he inspected. For the non-uapi files Thomas did random spot checks in about 15000 files. In initial set of patches against 4.14-rc6, 3 files were found to have copy/paste license identifier errors, and have been fixed to reflect the correct identifier. Additionally Philippe spent 10 hours this week doing a detailed manual inspection and review of the 12,461 patched files from the initial patch version early this week with: - a full scancode scan run, collecting the matched texts, detected license ids and scores - reviewing anything where there was a license detected (about 500+ files) to ensure that the applied SPDX license was correct - reviewing anything where there was no detection but the patch license was not GPL-2.0 WITH Linux-syscall-note to ensure that the applied SPDX license was correct This produced a worksheet with 20 files needing minor correction. This worksheet was then exported into 3 different .csv files for the different types of files to be modified. These .csv files were then reviewed by Greg. Thomas wrote a script to parse the csv files and add the proper SPDX tag to the file, in the format that the file expected. This script was further refined by Greg based on the output to detect more types of files automatically and to distinguish between header and source .c files (which need different comment types.) Finally Greg ran the script using the .csv files to generate the patches. Reviewed-by: Kate Stewart <kstewart@linuxfoundation.org> Reviewed-by: Philippe Ombredanne <pombredanne@nexb.com> Reviewed-by: Thomas Gleixner <tglx@linutronix.de> Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
2017-11-01 15:07:57 +01:00
# SPDX-License-Identifier: GPL-2.0
# (c) 2015, Quentin Casasnovas <quentin.casasnovas@oracle.com>
obj=$1
file ${obj} | grep -q ELF || (echo "${obj} is not and ELF file." 1>&2 ; exit 0)
# Bail out early if there isn't an __ex_table section in this object file.
objdump -hj __ex_table ${obj} 2> /dev/null > /dev/null
[ $? -ne 0 ] && exit 0
white_list=.text,.fixup
suspicious_relocs=$(objdump -rj __ex_table ${obj} | tail -n +6 |
grep -v $(eval echo -e{${white_list}}) | awk '{print $3}')
# No suspicious relocs in __ex_table, jobs a good'un
[ -z "${suspicious_relocs}" ] && exit 0
# After this point, something is seriously wrong since we just found out we
# have some relocations in __ex_table which point to sections which aren't
# white listed. If you're adding a new section in the Linux kernel, and
# you're expecting this section to contain code which can fault (i.e. the
# __ex_table relocation to your new section is expected), simply add your
# new section to the white_list variable above. If not, you're probably
# doing something wrong and the rest of this code is just trying to print
# you more information about it.
function find_section_offset_from_symbol()
{
eval $(objdump -t ${obj} | grep ${1} | sed 's/\([0-9a-f]\+\) .\{7\} \([^ \t]\+\).*/section="\2"; section_offset="0x\1" /')
# addr2line takes addresses in hexadecimal...
section_offset=$(printf "0x%016x" $(( ${section_offset} + $2 )) )
}
function find_symbol_and_offset_from_reloc()
{
# Extract symbol and offset from the objdump output
eval $(echo $reloc | sed 's/\([^+]\+\)+\?\(0x[0-9a-f]\+\)\?/symbol="\1"; symbol_offset="\2"/')
# When the relocation points to the begining of a symbol or section, it
# won't print the offset since it is zero.
if [ -z "${symbol_offset}" ]; then
symbol_offset=0x0
fi
}
function find_alt_replacement_target()
{
# The target of the .altinstr_replacement is the relocation just before
# the .altinstr_replacement one.
eval $(objdump -rj .altinstructions ${obj} | grep -B1 "${section}+${section_offset}" | head -n1 | awk '{print $3}' |
sed 's/\([^+]\+\)+\(0x[0-9a-f]\+\)/alt_target_section="\1"; alt_target_offset="\2"/')
}
function handle_alt_replacement_reloc()
{
# This will define alt_target_section and alt_target_section_offset
find_alt_replacement_target ${section} ${section_offset}
echo "Error: found a reference to .altinstr_replacement in __ex_table:"
addr2line -fip -j ${alt_target_section} -e ${obj} ${alt_target_offset} | awk '{print "\t" $0}'
error=true
}
function is_executable_section()
{
objdump -hwj ${section} ${obj} | grep -q CODE
return $?
}
function handle_suspicious_generic_reloc()
{
if is_executable_section ${section}; then
# We've got a relocation to a non white listed _executable_
# section, print a warning so the developper adds the section to
# the white list or fix his code. We try to pretty-print the file
# and line number where that relocation was added.
echo "Warning: found a reference to section \"${section}\" in __ex_table:"
addr2line -fip -j ${section} -e ${obj} ${section_offset} | awk '{print "\t" $0}'
else
# Something is definitively wrong here since we've got a relocation
# to a non-executable section, there's no way this would ever be
# running in the kernel.
echo "Error: found a reference to non-executable section \"${section}\" in __ex_table at offset ${section_offset}"
error=true
fi
}
function handle_suspicious_reloc()
{
case "${section}" in
".altinstr_replacement")
handle_alt_replacement_reloc ${section} ${section_offset}
;;
*)
handle_suspicious_generic_reloc ${section} ${section_offset}
;;
esac
}
function diagnose()
{
for reloc in ${suspicious_relocs}; do
# Let's find out where the target of the relocation in __ex_table
# is, this will define ${symbol} and ${symbol_offset}
find_symbol_and_offset_from_reloc ${reloc}
# When there's a global symbol at the place of the relocation,
# objdump will use it instead of giving us a section+offset, so
# let's find out which section is this symbol in and the total
# offset withing that section.
find_section_offset_from_symbol ${symbol} ${symbol_offset}
# In this case objdump was presenting us with a reloc to a symbol
# rather than a section. Now that we've got the actual section,
# we can skip it if it's in the white_list.
if [ -z "$( echo $section | grep -v $(eval echo -e{${white_list}}))" ]; then
continue;
fi
# Will either print a warning if the relocation happens to be in a
# section we do not know but has executable bit set, or error out.
handle_suspicious_reloc
done
}
function check_debug_info() {
objdump -hj .debug_info ${obj} 2> /dev/null > /dev/null ||
echo -e "${obj} does not contain debug information, the addr2line output will be limited.\n" \
"Recompile ${obj} with CONFIG_DEBUG_INFO to get a more useful output."
}
check_debug_info
diagnose
if [ "${error}" ]; then
exit 1
fi
exit 0