xref: /linux/scripts/headers_install.sh (revision b8d312aa075f33282565467662c4628dae0a2aff)
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
44rm -f $TMPFILE
45trap - EXIT
46