xref: /linux/tools/perf/check-headers.sh (revision 8dc364fa484df22d301a16148d1b356931d0cbb0)
1#!/bin/bash
2# SPDX-License-Identifier: GPL-2.0
3
4YELLOW='\033[0;33m'
5NC='\033[0m' # No Color
6
7declare -a FILES=(
8  "include/uapi/linux/const.h"
9  "include/uapi/drm/drm.h"
10  "include/uapi/drm/i915_drm.h"
11  "include/uapi/linux/bits.h"
12  "include/uapi/linux/fadvise.h"
13  "include/uapi/linux/fscrypt.h"
14  "include/uapi/linux/kcmp.h"
15  "include/uapi/linux/kvm.h"
16  "include/uapi/linux/in.h"
17  "include/uapi/linux/perf_event.h"
18  "include/uapi/linux/seccomp.h"
19  "include/uapi/linux/stat.h"
20  "include/linux/bits.h"
21  "include/vdso/bits.h"
22  "include/linux/cfi_types.h"
23  "include/linux/const.h"
24  "include/vdso/const.h"
25  "include/vdso/unaligned.h"
26  "include/linux/hash.h"
27  "include/linux/list-sort.h"
28  "include/uapi/linux/hw_breakpoint.h"
29  "arch/x86/include/asm/cpufeatures.h"
30  "arch/x86/include/asm/inat_types.h"
31  "arch/x86/include/asm/emulate_prefix.h"
32  "arch/x86/include/asm/msr-index.h"
33  "arch/x86/lib/x86-opcode-map.txt"
34  "arch/x86/tools/gen-insn-attr-x86.awk"
35  "arch/arm/include/uapi/asm/perf_regs.h"
36  "arch/arm64/include/uapi/asm/perf_regs.h"
37  "arch/loongarch/include/uapi/asm/perf_regs.h"
38  "arch/mips/include/uapi/asm/perf_regs.h"
39  "arch/powerpc/include/uapi/asm/perf_regs.h"
40  "arch/s390/include/uapi/asm/perf_regs.h"
41  "arch/x86/include/uapi/asm/perf_regs.h"
42  "arch/x86/include/uapi/asm/kvm.h"
43  "arch/x86/include/uapi/asm/svm.h"
44  "arch/x86/include/uapi/asm/unistd.h"
45  "arch/x86/include/uapi/asm/vmx.h"
46  "arch/powerpc/include/uapi/asm/kvm.h"
47  "arch/s390/include/uapi/asm/kvm.h"
48  "arch/s390/include/uapi/asm/sie.h"
49  "arch/arm64/include/uapi/asm/kvm.h"
50  "arch/arm64/include/uapi/asm/unistd.h"
51  "arch/alpha/include/uapi/asm/errno.h"
52  "arch/mips/include/asm/errno.h"
53  "arch/mips/include/uapi/asm/errno.h"
54  "arch/parisc/include/uapi/asm/errno.h"
55  "arch/powerpc/include/uapi/asm/errno.h"
56  "arch/sparc/include/uapi/asm/errno.h"
57  "arch/x86/include/uapi/asm/errno.h"
58  "include/asm-generic/bitops/arch_hweight.h"
59  "include/asm-generic/bitops/const_hweight.h"
60  "include/asm-generic/bitops/__fls.h"
61  "include/asm-generic/bitops/fls.h"
62  "include/asm-generic/bitops/fls64.h"
63  "include/linux/coresight-pmu.h"
64  "include/uapi/asm-generic/errno.h"
65  "include/uapi/asm-generic/errno-base.h"
66  "include/uapi/asm-generic/ioctls.h"
67  "include/uapi/asm-generic/mman-common.h"
68  "include/uapi/asm-generic/unistd.h"
69  "scripts/syscall.tbl"
70)
71
72declare -a SYNC_CHECK_FILES=(
73  "arch/x86/include/asm/inat.h"
74  "arch/x86/include/asm/insn.h"
75  "arch/x86/lib/inat.c"
76  "arch/x86/lib/insn.c"
77)
78
79# These copies are under tools/perf/trace/beauty/ as they are not used to in
80# building object files only by scripts in tools/perf/trace/beauty/ to generate
81# tables that then gets included in .c files for things like id->string syscall
82# tables (and the reverse lookup as well: string -> id)
83
84declare -a BEAUTY_FILES=(
85  "arch/x86/include/asm/irq_vectors.h"
86  "arch/x86/include/uapi/asm/prctl.h"
87  "include/linux/socket.h"
88  "include/uapi/linux/fcntl.h"
89  "include/uapi/linux/fs.h"
90  "include/uapi/linux/mount.h"
91  "include/uapi/linux/prctl.h"
92  "include/uapi/linux/sched.h"
93  "include/uapi/linux/stat.h"
94  "include/uapi/linux/usbdevice_fs.h"
95  "include/uapi/linux/vhost.h"
96  "include/uapi/sound/asound.h"
97)
98
99declare -a FAILURES
100
101check_2 () {
102  tools_file=$1
103  orig_file=$2
104
105  shift
106  shift
107
108  cmd="diff $* $tools_file $orig_file > /dev/null"
109
110  if [ -f "$orig_file" ] && ! eval "$cmd"
111  then
112    FAILURES+=(
113      "$tools_file $orig_file"
114    )
115  fi
116}
117
118check () {
119  file=$1
120
121  shift
122
123  check_2 "tools/$file" "$file" "$@"
124}
125
126beauty_check () {
127  file=$1
128
129  shift
130
131  check_2 "tools/perf/trace/beauty/$file" "$file" "$@"
132}
133
134check_ignore_some_hunks () {
135  orig_file="$1"
136  tools_file="tools/$orig_file"
137  hunks_to_ignore="tools/perf/check-header_ignore_hunks/$orig_file"
138
139  if [ ! -f "$hunks_to_ignore" ]; then
140    echo "$hunks_to_ignore not found. Skipping $orig_file check."
141    FAILURES+=(
142      "$tools_file $orig_file"
143    )
144    return
145  fi
146
147  cmd="diff -u \"$tools_file\" \"$orig_file\" | grep -vf \"$hunks_to_ignore\" | wc -l | grep -qw 0"
148
149  if [ -f "$orig_file" ] && ! eval "$cmd"
150  then
151    FAILURES+=(
152      "$tools_file $orig_file"
153    )
154  fi
155}
156
157
158# Check if we have the kernel headers (tools/perf/../../include), else
159# we're probably on a detached tarball, so no point in trying to check
160# differences.
161if ! [ -d ../../include ]
162then
163  echo -e "${YELLOW}Warning${NC}: Skipped check-headers due to missing ../../include"
164  exit 0
165fi
166
167cd ../..
168
169# simple diff check
170for i in "${FILES[@]}"
171do
172  check "$i" -B
173done
174
175for i in "${SYNC_CHECK_FILES[@]}"
176do
177  check "$i" '-I "^.*\/\*.*__ignore_sync_check__.*\*\/.*$"'
178done
179
180# diff with extra ignore lines
181check arch/x86/lib/memcpy_64.S        '-I "^EXPORT_SYMBOL" -I "^#include <asm/export.h>" -I"^SYM_FUNC_START\(_LOCAL\)*(memcpy_\(erms\|orig\))" -I"^#include <linux/cfi_types.h>"'
182check arch/x86/lib/memset_64.S        '-I "^EXPORT_SYMBOL" -I "^#include <asm/export.h>" -I"^SYM_FUNC_START\(_LOCAL\)*(memset_\(erms\|orig\))"'
183check arch/x86/include/asm/amd/ibs.h  '-I "^#include .*/msr-index.h"'
184check arch/arm64/include/asm/cputype.h '-I "^#include [<\"]\(asm/\)*sysreg.h"'
185check include/linux/unaligned.h '-I "^#include <linux/unaligned/packed_struct.h>" -I "^#include <asm/byteorder.h>" -I "^#pragma GCC diagnostic"'
186check include/uapi/asm-generic/mman.h '-I "^#include <\(uapi/\)*asm-generic/mman-common\(-tools\)*.h>"'
187check include/uapi/linux/mman.h       '-I "^#include <\(uapi/\)*asm/mman.h>"'
188check include/linux/build_bug.h       '-I "^#\(ifndef\|endif\)\( \/\/\)* static_assert$"'
189check include/linux/ctype.h	      '-I "isdigit("'
190check lib/ctype.c		      '-I "^EXPORT_SYMBOL" -I "^#include <linux/export.h>" -B'
191
192# diff non-symmetric files
193check_2 tools/perf/arch/x86/entry/syscalls/syscall_32.tbl arch/x86/entry/syscalls/syscall_32.tbl
194check_2 tools/perf/arch/x86/entry/syscalls/syscall_64.tbl arch/x86/entry/syscalls/syscall_64.tbl
195check_2 tools/perf/arch/powerpc/entry/syscalls/syscall.tbl arch/powerpc/kernel/syscalls/syscall.tbl
196check_2 tools/perf/arch/s390/entry/syscalls/syscall.tbl arch/s390/kernel/syscalls/syscall.tbl
197check_2 tools/perf/arch/mips/entry/syscalls/syscall_n64.tbl arch/mips/kernel/syscalls/syscall_n64.tbl
198check_2 tools/perf/arch/arm/entry/syscalls/syscall.tbl arch/arm/tools/syscall.tbl
199check_2 tools/perf/arch/sh/entry/syscalls/syscall.tbl arch/sh/kernel/syscalls/syscall.tbl
200check_2 tools/perf/arch/sparc/entry/syscalls/syscall.tbl arch/sparc/kernel/syscalls/syscall.tbl
201check_2 tools/perf/arch/xtensa/entry/syscalls/syscall.tbl arch/xtensa/kernel/syscalls/syscall.tbl
202check_2 tools/perf/arch/alpha/entry/syscalls/syscall.tbl arch/alpha/entry/syscalls/syscall.tbl
203check_2 tools/perf/arch/parisc/entry/syscalls/syscall.tbl arch/parisc/entry/syscalls/syscall.tbl
204check_2 tools/perf/arch/arm64/entry/syscalls/syscall_32.tbl arch/arm64/entry/syscalls/syscall_32.tbl
205check_2 tools/perf/arch/arm64/entry/syscalls/syscall_64.tbl arch/arm64/entry/syscalls/syscall_64.tbl
206
207for i in "${BEAUTY_FILES[@]}"
208do
209  beauty_check "$i" -B
210done
211
212# check duplicated library files
213check_2 tools/perf/util/hashmap.h tools/lib/bpf/hashmap.h
214check_2 tools/perf/util/hashmap.c tools/lib/bpf/hashmap.c
215
216# Files with larger differences
217
218check_ignore_some_hunks lib/list_sort.c
219
220cd tools/perf || exit
221
222if [ ${#FAILURES[@]} -gt 0 ]
223then
224  echo -e "${YELLOW}Warning${NC}: Kernel ABI header differences:"
225  for i in "${FAILURES[@]}"
226  do
227    echo "  diff -u $i"
228  done
229fi
230