1#!/bin/sh
2# SPDX-License-Identifier: GPL-2.0
3
4if [ $# -ne 2 ]
5then
6	echo "Usage: headers_install.sh INFILE OUTFILE"
7	echo
8	echo "Prepares kernel header files for use by user space, by removing"
9	echo "all compiler.h definitions and #includes, removing any"
10	echo "#ifdef __KERNEL__ sections, and putting __underscores__ around"
11	echo "asm/inline/volatile keywords."
12	echo
13	echo "INFILE: header file to operate on"
14	echo "OUTFILE: output file which the processed header is writen to"
15
16	exit 1
17fi
18
19# Grab arguments
20INFILE=$1
21OUTFILE=$2
22TMPFILE=$OUTFILE.tmp
23
24trap 'rm -f $OUTFILE $TMPFILE' EXIT
25
26# SPDX-License-Identifier with GPL variants must have "WITH Linux-syscall-note"
27if [ -n "$(sed -n -e "/SPDX-License-Identifier:.*GPL-/{/WITH Linux-syscall-note/!p}" $INFILE)" ]; then
28	echo "error: $INFILE: missing \"WITH Linux-syscall-note\" for SPDX-License-Identifier" >&2
29	exit 1
30fi
31
32sed -E -e '
33	s/([[:space:](])(__user|__force|__iomem)[[:space:]]/\1/g
34	s/__attribute_const__([[:space:]]|$)/\1/g
35	s@^#include <linux/compiler(|_types).h>@@
36	s/(^|[^a-zA-Z0-9])__packed([^a-zA-Z0-9_]|$)/\1__attribute__((packed))\2/g
37	s/(^|[[:space:](])(inline|asm|volatile)([[:space:](]|$)/\1__\2__\3/g
38	s@#(ifndef|define|endif[[:space:]]*/[*])[[:space:]]*_UAPI@#\1 @
39' $INFILE > $TMPFILE || exit 1
40
41scripts/unifdef -U__KERNEL__ -D__EXPORTED_HEADERS__ $TMPFILE > $OUTFILE
42[ $? -gt 1 ] && exit 1
43
44# Remove /* ... */ style comments, and find CONFIG_ references in code
45configs=$(sed -e '
46:comment
47	s:/\*[^*][^*]*:/*:
48	s:/\*\*\**\([^/]\):/*\1:
49	t comment
50	s:/\*\*/: :
51	t comment
52	/\/\*/! b check
53	N
54	b comment
55:print
56	P
57	D
58:check
59	s:^\(CONFIG_[[:alnum:]_]*\):\1\n:
60	t print
61	s:^[[:alnum:]_][[:alnum:]_]*::
62	s:^[^[:alnum:]_][^[:alnum:]_]*::
63	t check
64	d
65' $OUTFILE)
66
67# The entries in the following list are not warned.
68# Please do not add a new entry. This list is only for existing ones.
69# The list will be reduced gradually, and deleted eventually. (hopefully)
70#
71# The format is <file-name>:<CONFIG-option> in each line.
72config_leak_ignores="
73arch/alpha/include/uapi/asm/setup.h:CONFIG_ALPHA_LEGACY_START_ADDRESS
74arch/arc/include/uapi/asm/page.h:CONFIG_ARC_PAGE_SIZE_16K
75arch/arc/include/uapi/asm/page.h:CONFIG_ARC_PAGE_SIZE_4K
76arch/arc/include/uapi/asm/swab.h:CONFIG_ARC_HAS_SWAPE
77arch/arm/include/uapi/asm/ptrace.h:CONFIG_CPU_ENDIAN_BE8
78arch/hexagon/include/uapi/asm/ptrace.h:CONFIG_HEXAGON_ARCH_VERSION
79arch/hexagon/include/uapi/asm/user.h:CONFIG_HEXAGON_ARCH_VERSION
80arch/ia64/include/uapi/asm/cmpxchg.h:CONFIG_IA64_DEBUG_CMPXCHG
81arch/m68k/include/uapi/asm/ptrace.h:CONFIG_COLDFIRE
82arch/nios2/include/uapi/asm/swab.h:CONFIG_NIOS2_CI_SWAB_NO
83arch/nios2/include/uapi/asm/swab.h:CONFIG_NIOS2_CI_SWAB_SUPPORT
84arch/sh/include/uapi/asm/ptrace.h:CONFIG_CPU_SH5
85arch/sh/include/uapi/asm/sigcontext.h:CONFIG_CPU_SH5
86arch/sh/include/uapi/asm/stat.h:CONFIG_CPU_SH5
87arch/x86/include/uapi/asm/auxvec.h:CONFIG_IA32_EMULATION
88arch/x86/include/uapi/asm/auxvec.h:CONFIG_X86_64
89arch/x86/include/uapi/asm/mman.h:CONFIG_X86_INTEL_MEMORY_PROTECTION_KEYS
90include/uapi/asm-generic/fcntl.h:CONFIG_64BIT
91include/uapi/linux/atmdev.h:CONFIG_COMPAT
92include/uapi/linux/elfcore.h:CONFIG_BINFMT_ELF_FDPIC
93include/uapi/linux/eventpoll.h:CONFIG_PM_SLEEP
94include/uapi/linux/hw_breakpoint.h:CONFIG_HAVE_MIXED_BREAKPOINTS_REGS
95include/uapi/linux/pktcdvd.h:CONFIG_CDROM_PKTCDVD_WCACHE
96include/uapi/linux/raw.h:CONFIG_MAX_RAW_DEVS
97"
98
99for c in $configs
100do
101	warn=1
102
103	for ignore in $config_leak_ignores
104	do
105		if echo "$INFILE:$c" | grep -q "$ignore$"; then
106			warn=
107			break
108		fi
109	done
110
111	if [ "$warn" = 1 ]; then
112		echo "warning: $INFILE: leak $c to user-space" >&2
113	fi
114done
115
116rm -f $TMPFILE
117trap - EXIT
118