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 17:07:57 +03:00
# SPDX-License-Identifier: GPL-2.0
2005-04-17 02:20:36 +04:00
# ==========================================================================
# Building
# ==========================================================================
src := $( obj)
2006-03-06 01:14:10 +03:00
PHONY := __build
2005-04-17 02:20:36 +04:00
__build :
2007-05-29 00:47:48 +04:00
# Init all relevant variables used in kbuild files so
# 1) they have correct type
# 2) they do not inherit any value from the environment
obj-y :=
obj-m :=
lib-y :=
lib-m :=
always :=
targets :=
subdir-y :=
subdir-m :=
EXTRA_AFLAGS :=
EXTRA_CFLAGS :=
EXTRA_CPPFLAGS :=
EXTRA_LDFLAGS :=
2007-10-16 00:25:06 +04:00
asflags-y :=
ccflags-y :=
cppflags-y :=
ldflags-y :=
2007-05-29 00:47:48 +04:00
2009-04-19 13:04:26 +04:00
subdir-asflags-y :=
subdir-ccflags-y :=
2008-02-18 12:48:20 +03:00
# Read auto.conf if it exists, otherwise ignore
2006-06-09 09:12:39 +04:00
- i n c l u d e i n c l u d e / c o n f i g / a u t o . c o n f
2005-04-17 02:20:36 +04:00
2006-01-22 15:34:15 +03:00
i n c l u d e s c r i p t s / K b u i l d . i n c l u d e
2008-02-18 12:48:20 +03:00
# For backward compatibility check that these variables do not change
2007-10-15 00:26:53 +04:00
save-cflags := $( CFLAGS)
2005-07-26 00:26:04 +04:00
# The filename Kbuild has precedence over Makefile
2005-07-28 00:11:01 +04:00
kbuild-dir := $( if $( filter /%,$( src) ) ,$( src) ,$( srctree) /$( src) )
2007-10-15 00:26:53 +04:00
kbuild-file := $( if $( wildcard $( kbuild-dir) /Kbuild) ,$( kbuild-dir) /Kbuild,$( kbuild-dir) /Makefile)
i n c l u d e $( kbuild -file )
# If the save-* variables changed error out
i f e q ( $( KBUILD_NOPEDANTIC ) , )
ifneq ( " $( save-cflags) " ," $( CFLAGS) " )
2011-08-15 09:07:13 +04:00
$( error CFLAGS was changed in " $( kbuild-file) " . Fix it to use ccflags-y)
2007-10-15 00:26:53 +04:00
endif
e n d i f
2011-03-01 11:35:29 +03:00
2005-04-17 02:20:36 +04:00
i n c l u d e s c r i p t s / M a k e f i l e . l i b
i f d e f h o s t - p r o g s
i f n e q ( $( hostprogs -y ) , $( host -progs ) )
$(warning kbuild : $( obj ) /Makefile - Usage of host -progs is deprecated . Please replace with hostprogs -y !)
hostprogs-y += $( host-progs)
e n d i f
e n d i f
2008-02-18 12:48:20 +03:00
# Do not include host rules unless needed
2016-05-24 01:08:25 +03:00
i f n e q ( $( hostprogs -y ) $( hostprogs -m ) $( hostlibs -y ) $( hostlibs -m ) $( hostcxxlibs -y ) $( hostcxxlibs -m ) , )
2005-04-17 02:20:36 +04:00
i n c l u d e s c r i p t s / M a k e f i l e . h o s t
e n d i f
i f n d e f o b j
$(warning kbuild : Makefile .build is included improperly )
e n d i f
# ===========================================================================
2014-09-09 14:26:21 +04:00
i f n e q ( $( strip $ ( lib -y ) $ ( lib -m ) $ ( lib -) ) , )
2005-04-17 02:20:36 +04:00
lib-target := $( obj) /lib.a
kbuild: link $(real-obj-y) instead of $(obj-y) into built-in.a
In Kbuild, Makefiles can add the same object to obj-y multiple
times. So,
obj-y += foo.o
obj-y += foo.o
is fine.
However, this is not true when the same object is added multiple
times via composite objects. For example,
obj-y += foo.o bar.o
foo-objs := foo-bar-common.o foo-only.o
bar-objs := foo-bar-common.o bar-only.o
causes build error because two instances of foo-bar-common.o are
linked into the vmlinux.
Makefiles tend to invent ugly work-around, for example
- lib/zstd/Makefile
- drivers/net/ethernet/cavium/liquidio/Makefile
The technique used in Kbuild to avoid the multiple definition error
is to use $(filter $(obj-y), $^). Here, $^ lists the names of all
the prerequisites with duplicated names removed.
By replacing it with $(filter $(real-obj-y), $^) we can do likewise
for composite objects. For built-in objects, we do not need to keep
the composite object structure. We can simply expand them, and link
$(real-obj-y) to built-in.a.
Signed-off-by: Masahiro Yamada <yamada.masahiro@socionext.com>
2018-03-19 14:26:08 +03:00
real-obj-y += $( obj) /lib-ksyms.o
2005-04-17 02:20:36 +04:00
e n d i f
kbuild: link $(real-obj-y) instead of $(obj-y) into built-in.a
In Kbuild, Makefiles can add the same object to obj-y multiple
times. So,
obj-y += foo.o
obj-y += foo.o
is fine.
However, this is not true when the same object is added multiple
times via composite objects. For example,
obj-y += foo.o bar.o
foo-objs := foo-bar-common.o foo-only.o
bar-objs := foo-bar-common.o bar-only.o
causes build error because two instances of foo-bar-common.o are
linked into the vmlinux.
Makefiles tend to invent ugly work-around, for example
- lib/zstd/Makefile
- drivers/net/ethernet/cavium/liquidio/Makefile
The technique used in Kbuild to avoid the multiple definition error
is to use $(filter $(obj-y), $^). Here, $^ lists the names of all
the prerequisites with duplicated names removed.
By replacing it with $(filter $(real-obj-y), $^) we can do likewise
for composite objects. For built-in objects, we do not need to keep
the composite object structure. We can simply expand them, and link
$(real-obj-y) to built-in.a.
Signed-off-by: Masahiro Yamada <yamada.masahiro@socionext.com>
2018-03-19 14:26:08 +03:00
i f n e q ( $( strip $ ( real -obj -y ) $ ( need -builtin ) ) , )
2018-02-10 17:25:04 +03:00
builtin-target := $( obj) /built-in.a
2005-04-17 02:20:36 +04:00
e n d i f
2007-12-07 15:04:30 +03:00
modorder-target := $( obj) /modules.order
2005-04-17 02:20:36 +04:00
# We keep a list of all modules in $(MODVERDIR)
__build : $( if $ ( KBUILD_BUILTIN ) ,$ ( builtin -target ) $ ( lib -target ) $ ( extra -y ) ) \
2007-12-07 15:04:30 +03:00
$( if $( KBUILD_MODULES) ,$( obj-m) $( modorder-target) ) \
2005-04-17 02:20:36 +04:00
$( subdir-ym) $( always)
@:
# Linus' kernel sanity checking tool
i f n e q ( $( KBUILD_CHECKSRC ) , 0 )
ifeq ( $( KBUILD_CHECKSRC) ,2)
quiet_cmd_force_checksrc = CHECK $<
cmd_force_checksrc = $( CHECK) $( CHECKFLAGS) $( c_flags) $< ;
else
quiet_cmd_checksrc = CHECK $<
cmd_checksrc = $( CHECK) $( CHECKFLAGS) $( c_flags) $< ;
endif
e n d i f
2017-11-20 21:40:40 +03:00
i f n e q ( $( KBUILD_ENABLE_EXTRA_GCC_CHECKS ) , )
cmd_checkdoc = $( srctree) /scripts/kernel-doc -none $< ;
e n d i f
2018-02-10 17:25:04 +03:00
# Do section mismatch analysis for each module/built-in.a
2008-01-21 23:31:44 +03:00
i f d e f C O N F I G _ D E B U G _ S E C T I O N _ M I S M A T C H
cmd_secanalysis = ; scripts/mod/modpost $@
e n d i f
2005-04-17 02:20:36 +04:00
# Compile C sources (.c)
# ---------------------------------------------------------------------------
# Default is built-in, unless we know otherwise
kbuild: allow assignment to {A,C,LD}FLAGS_MODULE on the command line
It is now possible to assign options to AS, CC and LD
on the command line - which is only used when building modules.
{A,C,LD}FLAGS_MODULE was all used both in the top-level Makefile
in the arch makefiles, thus users had no way to specify
additional options to AS, CC, LD when building modules
without overriding the original value.
Introduce a new set of variables KBUILD_{A,C,LD}FLAGS_MODULE
that is used by arch specific files and free up
{A,C,LD}FLAGS_MODULE so they can be assigned on
the command line.
All arch Makefiles that used the old variables has been updated.
Note: Previously we had a MODFLAGS variable for both
AS and CC. But in favour of consistency this was dropped.
So in some cases arch Makefile has one assignmnet replaced by
two assignmnets.
Note2: MODFLAGS was not documented and is dropped
without any notice. I do not expect much/any breakage
from this.
Signed-off-by: Sam Ravnborg <sam@ravnborg.org>
Cc: Denys Vlasenko <vda.linux@googlemail.com>
Cc: Haavard Skinnemoen <hskinnemoen@atmel.com>
Cc: Mike Frysinger <vapier@gentoo.org>
Cc: Tony Luck <tony.luck@intel.com>
Cc: Geert Uytterhoeven <geert@linux-m68k.org>
Cc: Ralf Baechle <ralf@linux-mips.org>
Cc: Benjamin Herrenschmidt <benh@kernel.crashing.org>
Cc: Martin Schwidefsky <schwidefsky@de.ibm.com>
Cc: Chen Liqin <liqin.chen@sunplusct.com>
Acked-by: Mike Frysinger <vapier@gentoo.org> [blackfin]
Acked-by: Haavard Skinnemoen <haavard.skinnemoen@atmel.com> [avr32]
Signed-off-by: Michal Marek <mmarek@suse.cz>
2010-07-28 19:33:09 +04:00
modkern_cflags = \
$( if $( part-of-module) , \
$( KBUILD_CFLAGS_MODULE) $( CFLAGS_MODULE) , \
2010-07-28 21:11:27 +04:00
$( KBUILD_CFLAGS_KERNEL) $( CFLAGS_KERNEL) )
2005-04-17 02:20:36 +04:00
quiet_modtag := $( empty) $( empty)
2018-03-19 14:26:07 +03:00
$(real-obj-m) : part -of -module := y
$(real-obj-m : .o =.i ) : part -of -module := y
$(real-obj-m : .o =.s ) : part -of -module := y
$(real-obj-m : .o =.lst ): part -of -module := y
2005-04-17 02:20:36 +04:00
2018-03-19 14:26:07 +03:00
$(real-obj-m) : quiet_modtag := [M ]
$(real-obj-m : .o =.i ) : quiet_modtag := [M ]
$(real-obj-m : .o =.s ) : quiet_modtag := [M ]
$(real-obj-m : .o =.lst ): quiet_modtag := [M ]
2005-04-17 02:20:36 +04:00
2018-03-19 14:26:07 +03:00
$(obj-m) : quiet_modtag := [M ]
2005-04-17 02:20:36 +04:00
quiet_cmd_cc_s_c = CC $( quiet_modtag) $@
2014-02-08 12:01:15 +04:00
cmd_cc_s_c = $( CC) $( c_flags) $( DISABLE_LTO) -fverbose-asm -S -o $@ $<
2005-04-17 02:20:36 +04:00
2007-05-06 11:23:45 +04:00
$(obj)/%.s : $( src ) /%.c FORCE
2005-04-17 02:20:36 +04:00
$( call if_changed_dep,cc_s_c)
2016-04-08 05:24:47 +03:00
quiet_cmd_cpp_i_c = CPP $( quiet_modtag) $@
cmd_cpp_i_c = $( CPP) $( c_flags) -o $@ $<
2005-04-17 02:20:36 +04:00
2007-05-06 11:23:45 +04:00
$(obj)/%.i : $( src ) /%.c FORCE
2016-04-08 05:24:47 +03:00
$( call if_changed_dep,cpp_i_c)
2005-04-17 02:20:36 +04:00
2016-11-01 04:46:19 +03:00
# These mirror gensymtypes_S and co below, keep them in synch.
cmd_gensymtypes_c = \
2008-12-19 23:38:09 +03:00
$( CPP) -D__GENKSYMS__ $( c_flags) $< | \
2013-03-18 13:08:56 +04:00
$( GENKSYMS) $( if $( 1) , -T $( 2) ) \
2017-02-03 12:54:05 +03:00
$( patsubst y,-R,$( CONFIG_MODULE_REL_CRCS) ) \
2008-12-19 23:38:09 +03:00
$( if $( KBUILD_PRESERVE) ,-p) \
2010-05-25 01:07:24 +04:00
-r $( firstword $( wildcard $( 2:.symtypes= .symref) /dev/null) )
2008-12-19 23:38:09 +03:00
kbuild: support for %.symtypes files
Here is a patch that adds a new -T option to genksyms for generating dumps of
the type definition that makes up the symbol version hashes. This allows to
trace modversion changes back to what caused them. The dump format is the
name of the type defined, followed by its definition (which is almost C):
s#list_head struct list_head { s#list_head * next , * prev ; }
The s#, u#, e#, and t# prefixes stand for struct, union, enum, and typedef.
The exported symbols do not define types, and thus do not have an x# prefix:
nfs4_acl_get_whotype int nfs4_acl_get_whotype ( char * , t#u32 )
The symbol type defintion of a single file can be generated with:
make fs/jbd/journal.symtypes
If KBUILD_SYMTYPES is defined, all the *.symtypes of all object files that
export symbols are generated.
The single *.symtypes files can be combined into a single file after a kernel
build with a script like the following:
for f in $(find -name '*.symtypes' | sort); do
f=${f#./}
echo "/* ${f%.symtypes}.o */"
cat $f
echo
done \
| sed -e '\:UNKNOWN:d' \
-e 's:[,;] }:}:g' \
-e 's:\([[({]\) :\1:g' \
-e 's: \([])},;]\):\1:g' \
-e 's: $::' \
$f \
| awk '
/^.#/ { if (defined[$1] == $0) {
print $1
next
}
defined[$1] = $0
}
{ print }
'
When the kernel ABI changes, diffing individual *.symtype files, or the
combined files, against each other will show which symbol changes caused the
ABI changes. This can save a tremendous amount of time.
Dump the types that make up modversions
Signed-off-by: Andreas Gruenbacher <agruen@suse.de>
Signed-off-by: Sam Ravnborg <sam@ravnborg.org>
2006-05-09 22:37:30 +04:00
quiet_cmd_cc_symtypes_c = SYM $( quiet_modtag) $@
2008-12-19 23:38:09 +03:00
cmd_cc_symtypes_c = \
set -e; \
2016-11-01 04:46:19 +03:00
$( call cmd_gensymtypes_c,true,$@ ) >/dev/null; \
2008-12-19 23:38:09 +03:00
test -s $@ || rm -f $@
kbuild: support for %.symtypes files
Here is a patch that adds a new -T option to genksyms for generating dumps of
the type definition that makes up the symbol version hashes. This allows to
trace modversion changes back to what caused them. The dump format is the
name of the type defined, followed by its definition (which is almost C):
s#list_head struct list_head { s#list_head * next , * prev ; }
The s#, u#, e#, and t# prefixes stand for struct, union, enum, and typedef.
The exported symbols do not define types, and thus do not have an x# prefix:
nfs4_acl_get_whotype int nfs4_acl_get_whotype ( char * , t#u32 )
The symbol type defintion of a single file can be generated with:
make fs/jbd/journal.symtypes
If KBUILD_SYMTYPES is defined, all the *.symtypes of all object files that
export symbols are generated.
The single *.symtypes files can be combined into a single file after a kernel
build with a script like the following:
for f in $(find -name '*.symtypes' | sort); do
f=${f#./}
echo "/* ${f%.symtypes}.o */"
cat $f
echo
done \
| sed -e '\:UNKNOWN:d' \
-e 's:[,;] }:}:g' \
-e 's:\([[({]\) :\1:g' \
-e 's: \([])},;]\):\1:g' \
-e 's: $::' \
$f \
| awk '
/^.#/ { if (defined[$1] == $0) {
print $1
next
}
defined[$1] = $0
}
{ print }
'
When the kernel ABI changes, diffing individual *.symtype files, or the
combined files, against each other will show which symbol changes caused the
ABI changes. This can save a tremendous amount of time.
Dump the types that make up modversions
Signed-off-by: Andreas Gruenbacher <agruen@suse.de>
Signed-off-by: Sam Ravnborg <sam@ravnborg.org>
2006-05-09 22:37:30 +04:00
2007-05-06 11:23:45 +04:00
$(obj)/%.symtypes : $( src ) /%.c FORCE
2008-12-02 01:21:01 +03:00
$( call cmd,cc_symtypes_c)
kbuild: support for %.symtypes files
Here is a patch that adds a new -T option to genksyms for generating dumps of
the type definition that makes up the symbol version hashes. This allows to
trace modversion changes back to what caused them. The dump format is the
name of the type defined, followed by its definition (which is almost C):
s#list_head struct list_head { s#list_head * next , * prev ; }
The s#, u#, e#, and t# prefixes stand for struct, union, enum, and typedef.
The exported symbols do not define types, and thus do not have an x# prefix:
nfs4_acl_get_whotype int nfs4_acl_get_whotype ( char * , t#u32 )
The symbol type defintion of a single file can be generated with:
make fs/jbd/journal.symtypes
If KBUILD_SYMTYPES is defined, all the *.symtypes of all object files that
export symbols are generated.
The single *.symtypes files can be combined into a single file after a kernel
build with a script like the following:
for f in $(find -name '*.symtypes' | sort); do
f=${f#./}
echo "/* ${f%.symtypes}.o */"
cat $f
echo
done \
| sed -e '\:UNKNOWN:d' \
-e 's:[,;] }:}:g' \
-e 's:\([[({]\) :\1:g' \
-e 's: \([])},;]\):\1:g' \
-e 's: $::' \
$f \
| awk '
/^.#/ { if (defined[$1] == $0) {
print $1
next
}
defined[$1] = $0
}
{ print }
'
When the kernel ABI changes, diffing individual *.symtype files, or the
combined files, against each other will show which symbol changes caused the
ABI changes. This can save a tremendous amount of time.
Dump the types that make up modversions
Signed-off-by: Andreas Gruenbacher <agruen@suse.de>
Signed-off-by: Sam Ravnborg <sam@ravnborg.org>
2006-05-09 22:37:30 +04:00
2017-04-24 23:04:58 +03:00
# LLVM assembly
# Generate .ll files from .c
quiet_cmd_cc_ll_c = CC $( quiet_modtag) $@
cmd_cc_ll_c = $( CC) $( c_flags) -emit-llvm -S -o $@ $<
$(obj)/%.ll : $( src ) /%.c FORCE
$( call if_changed_dep,cc_ll_c)
2005-04-17 02:20:36 +04:00
# C (.c) files
# The C file is compiled and updated dependency information is generated.
# (See cmd_cc_o_c + relevant part of rule_cc_o_c)
quiet_cmd_cc_o_c = CC $( quiet_modtag) $@
i f n d e f C O N F I G _ M O D V E R S I O N S
cmd_cc_o_c = $( CC) $( c_flags) -c -o $@ $<
e l s e
# When module versioning is enabled the following steps are executed:
2009-01-14 23:38:20 +03:00
# o compile a .tmp_<file>.o from <file>.c
# o if .tmp_<file>.o doesn't contain a __ksymtab version, i.e. does
# not export symbols, we just rename .tmp_<file>.o to <file>.o and
2005-04-17 02:20:36 +04:00
# are done.
# o otherwise, we calculate symbol versions using the good old
# genksyms on the preprocessed source and postprocess them in a way
2009-01-14 23:38:20 +03:00
# that they are usable as a linker script
# o generate <file>.o from .tmp_<file>.o using the linker to
# replace the unresolved symbols __crc_exported_symbol with
# the actual value of the checksum generated by genksyms
2005-04-17 02:20:36 +04:00
2009-01-14 23:38:20 +03:00
cmd_cc_o_c = $( CC) $( c_flags) -c -o $( @D) /.tmp_$( @F) $<
2016-11-01 04:46:19 +03:00
cmd_modversions_c = \
2010-05-25 01:07:24 +04:00
if $( OBJDUMP) -h $( @D) /.tmp_$( @F) | grep -q __ksymtab; then \
2016-11-01 04:46:19 +03:00
$( call cmd_gensymtypes_c,$( KBUILD_SYMTYPES) ,$( @:.o= .symtypes) ) \
2010-05-25 01:07:24 +04:00
> $( @D) /.tmp_$( @F:.o= .ver) ; \
\
$( LD) $( LDFLAGS) -r -o $@ $( @D) /.tmp_$( @F) \
-T $( @D) /.tmp_$( @F:.o= .ver) ; \
rm -f $( @D) /.tmp_$( @F) $( @D) /.tmp_$( @F:.o= .ver) ; \
else \
mv -f $( @D) /.tmp_$( @F) $@ ; \
2005-04-17 02:20:36 +04:00
fi ;
e n d i f
ftrace: create __mcount_loc section
This patch creates a section in the kernel called "__mcount_loc".
This will hold a list of pointers to the mcount relocation for
each call site of mcount.
For example:
objdump -dr init/main.o
[...]
Disassembly of section .text:
0000000000000000 <do_one_initcall>:
0: 55 push %rbp
[...]
000000000000017b <init_post>:
17b: 55 push %rbp
17c: 48 89 e5 mov %rsp,%rbp
17f: 53 push %rbx
180: 48 83 ec 08 sub $0x8,%rsp
184: e8 00 00 00 00 callq 189 <init_post+0xe>
185: R_X86_64_PC32 mcount+0xfffffffffffffffc
[...]
We will add a section to point to each function call.
.section __mcount_loc,"a",@progbits
[...]
.quad .text + 0x185
[...]
The offset to of the mcount call site in init_post is an offset from
the start of the section, and not the start of the function init_post.
The mcount relocation is at the call site 0x185 from the start of the
.text section.
.text + 0x185 == init_post + 0xa
We need a way to add this __mcount_loc section in a way that we do not
lose the relocations after final link. The .text section here will
be attached to all other .text sections after final link and the
offsets will be meaningless. We need to keep track of where these
.text sections are.
To do this, we use the start of the first function in the section.
do_one_initcall. We can make a tmp.s file with this function as a reference
to the start of the .text section.
.section __mcount_loc,"a",@progbits
[...]
.quad do_one_initcall + 0x185
[...]
Then we can compile the tmp.s into a tmp.o
gcc -c tmp.s -o tmp.o
And link it into back into main.o.
ld -r main.o tmp.o -o tmp_main.o
mv tmp_main.o main.o
But we have a problem. What happens if the first function in a section
is not exported, and is a static function. The linker will not let
the tmp.o use it. This case exists in main.o as well.
Disassembly of section .init.text:
0000000000000000 <set_reset_devices>:
0: 55 push %rbp
1: 48 89 e5 mov %rsp,%rbp
4: e8 00 00 00 00 callq 9 <set_reset_devices+0x9>
5: R_X86_64_PC32 mcount+0xfffffffffffffffc
The first function in .init.text is a static function.
00000000000000a8 t __setup_set_reset_devices
000000000000105f t __setup_str_set_reset_devices
0000000000000000 t set_reset_devices
The lowercase 't' means that set_reset_devices is local and is not exported.
If we simply try to link the tmp.o with the set_reset_devices we end
up with two symbols: one local and one global.
.section __mcount_loc,"a",@progbits
.quad set_reset_devices + 0x10
00000000000000a8 t __setup_set_reset_devices
000000000000105f t __setup_str_set_reset_devices
0000000000000000 t set_reset_devices
U set_reset_devices
We still have an undefined reference to set_reset_devices, and if we try
to compile the kernel, we will end up with an undefined reference to
set_reset_devices, or even worst, it could be exported someplace else,
and then we will have a reference to the wrong location.
To handle this case, we make an intermediate step using objcopy.
We convert set_reset_devices into a global exported symbol before linking
it with tmp.o and set it back afterwards.
00000000000000a8 t __setup_set_reset_devices
000000000000105f t __setup_str_set_reset_devices
0000000000000000 T set_reset_devices
00000000000000a8 t __setup_set_reset_devices
000000000000105f t __setup_str_set_reset_devices
0000000000000000 T set_reset_devices
00000000000000a8 t __setup_set_reset_devices
000000000000105f t __setup_str_set_reset_devices
0000000000000000 t set_reset_devices
Now we have a section in main.o called __mcount_loc that we can place
somewhere in the kernel using vmlinux.ld.S and access it to convert
all these locations that call mcount into nops before starting SMP
and thus, eliminating the need to do this with kstop_machine.
Note, A well documented perl script (scripts/recordmcount.pl) is used
to do all this in one location.
Signed-off-by: Steven Rostedt <srostedt@redhat.com>
Signed-off-by: Ingo Molnar <mingo@elte.hu>
2008-08-14 23:45:07 +04:00
i f d e f C O N F I G _ F T R A C E _ M C O U N T _ R E C O R D
2017-11-28 00:34:13 +03:00
# gcc 5 supports generating the mcount tables directly
i f n e q ( $( call cc -option ,-mrecord -mcount ,y ) , y )
KBUILD_CFLAGS += -mrecord-mcount
e l s e
# else do it all manually
2010-10-14 01:12:30 +04:00
i f d e f B U I L D _ C _ R E C O R D M C O U N T
2011-04-13 02:59:10 +04:00
i f e q ( "$(origin RECORDMCOUNT_WARN)" , "command line" )
RECORDMCOUNT_FLAGS = -w
e n d i f
2010-10-18 22:42:00 +04:00
# Due to recursion, we must skip empty.o.
# The empty.o file is created in the make process in order to determine
2017-08-02 05:31:06 +03:00
# the target endianness and word size. It is made before all other C
# files, including recordmcount.
ftrace: Speed up recordmcount
cmd_record_mcount is used to locate the _mcount symbols in the object
files, only the files compiled with -pg has the _mcount symbol, so, it
is only needed for such files, but the current cmd_record_mcount is used
for all of the object files, so, we need to fix it and speed it up.
Since -pg may be removed by the method used in kernel/trace/Makefile:
ORIG_CFLAGS := $(KBUILD_CFLAGS)
KBUILD_CFLAGS = $(subst -pg,,$(ORIG_CFLAGS))
Or may be removed by the method used in arch/x86/kernel/Makefile:
CFLAGS_REMOVE_file.o = -pg
So, we must check the last variable stores the compiling flags, that is
c_flags(Please refer to cmd_cc_o_c and rule_cc_o_c defined in
scripts/Makefile.build) and since the CFLAGS_REMOVE_file.o is already
filtered in _c_flags(Please refer to scripts/Makefile.lib) and _c_flags
has less symbols, therefore, we only need to check _c_flags.
---------------
Changes from v1:
o Don't touch Makefile for CONFIG_FTRACE_MCOUNT_RECORD is enough
o Use _c_flags intead of KBUILD_CFLAGS to cover CONFIG_REMOVE_file.o = -pg
(feedback from Steven Rostedt <rostedt@goodmis.org>)
Acked-by: Michal Marek <mmarek@suse.cz>
Signed-off-by: Wu Zhangjin <wuzhangjin@gmail.com>
LKML-Reference: <3dc8cddf022eb7024f9f2cf857529a15bee8999a.1288196498.git.wuzhangjin@gmail.com>
[ changed if [ .. == .. ] to if [ .. = .. ] to handle dash environments ]
Signed-off-by: Steven Rostedt <rostedt@goodmis.org>
2010-10-27 20:24:34 +04:00
sub_cmd_record_mcount = \
if [ $( @) != "scripts/mod/empty.o" ] ; then \
2011-04-13 02:59:10 +04:00
$( objtree) /scripts/recordmcount $( RECORDMCOUNT_FLAGS) " $( @) " ; \
ftrace: Speed up recordmcount
cmd_record_mcount is used to locate the _mcount symbols in the object
files, only the files compiled with -pg has the _mcount symbol, so, it
is only needed for such files, but the current cmd_record_mcount is used
for all of the object files, so, we need to fix it and speed it up.
Since -pg may be removed by the method used in kernel/trace/Makefile:
ORIG_CFLAGS := $(KBUILD_CFLAGS)
KBUILD_CFLAGS = $(subst -pg,,$(ORIG_CFLAGS))
Or may be removed by the method used in arch/x86/kernel/Makefile:
CFLAGS_REMOVE_file.o = -pg
So, we must check the last variable stores the compiling flags, that is
c_flags(Please refer to cmd_cc_o_c and rule_cc_o_c defined in
scripts/Makefile.build) and since the CFLAGS_REMOVE_file.o is already
filtered in _c_flags(Please refer to scripts/Makefile.lib) and _c_flags
has less symbols, therefore, we only need to check _c_flags.
---------------
Changes from v1:
o Don't touch Makefile for CONFIG_FTRACE_MCOUNT_RECORD is enough
o Use _c_flags intead of KBUILD_CFLAGS to cover CONFIG_REMOVE_file.o = -pg
(feedback from Steven Rostedt <rostedt@goodmis.org>)
Acked-by: Michal Marek <mmarek@suse.cz>
Signed-off-by: Wu Zhangjin <wuzhangjin@gmail.com>
LKML-Reference: <3dc8cddf022eb7024f9f2cf857529a15bee8999a.1288196498.git.wuzhangjin@gmail.com>
[ changed if [ .. == .. ] to if [ .. = .. ] to handle dash environments ]
Signed-off-by: Steven Rostedt <rostedt@goodmis.org>
2010-10-27 20:24:34 +04:00
fi ;
2011-05-17 17:36:46 +04:00
recordmcount_source := $( srctree) /scripts/recordmcount.c \
$( srctree) /scripts/recordmcount.h
2010-10-14 01:12:30 +04:00
e l s e
ftrace: Speed up recordmcount
cmd_record_mcount is used to locate the _mcount symbols in the object
files, only the files compiled with -pg has the _mcount symbol, so, it
is only needed for such files, but the current cmd_record_mcount is used
for all of the object files, so, we need to fix it and speed it up.
Since -pg may be removed by the method used in kernel/trace/Makefile:
ORIG_CFLAGS := $(KBUILD_CFLAGS)
KBUILD_CFLAGS = $(subst -pg,,$(ORIG_CFLAGS))
Or may be removed by the method used in arch/x86/kernel/Makefile:
CFLAGS_REMOVE_file.o = -pg
So, we must check the last variable stores the compiling flags, that is
c_flags(Please refer to cmd_cc_o_c and rule_cc_o_c defined in
scripts/Makefile.build) and since the CFLAGS_REMOVE_file.o is already
filtered in _c_flags(Please refer to scripts/Makefile.lib) and _c_flags
has less symbols, therefore, we only need to check _c_flags.
---------------
Changes from v1:
o Don't touch Makefile for CONFIG_FTRACE_MCOUNT_RECORD is enough
o Use _c_flags intead of KBUILD_CFLAGS to cover CONFIG_REMOVE_file.o = -pg
(feedback from Steven Rostedt <rostedt@goodmis.org>)
Acked-by: Michal Marek <mmarek@suse.cz>
Signed-off-by: Wu Zhangjin <wuzhangjin@gmail.com>
LKML-Reference: <3dc8cddf022eb7024f9f2cf857529a15bee8999a.1288196498.git.wuzhangjin@gmail.com>
[ changed if [ .. == .. ] to if [ .. = .. ] to handle dash environments ]
Signed-off-by: Steven Rostedt <rostedt@goodmis.org>
2010-10-27 20:24:34 +04:00
sub_cmd_record_mcount = set -e ; perl $( srctree) /scripts/recordmcount.pl " $( ARCH) " \
2009-11-20 15:34:31 +03:00
" $( if $( CONFIG_CPU_BIG_ENDIAN) ,big,little) " \
2008-10-29 22:30:26 +03:00
" $( if $( CONFIG_64BIT) ,64,32) " \
2010-08-10 22:39:20 +04:00
" $( OBJDUMP) " " $( OBJCOPY) " " $( CC) $( KBUILD_CFLAGS) " \
" $( LD) " " $( NM) " " $( RM) " " $( MV) " \
2009-01-12 05:00:51 +03:00
" $( if $( part-of-module) ,1,0) " " $( @) " ;
2011-05-17 17:36:46 +04:00
recordmcount_source := $( srctree) /scripts/recordmcount.pl
2017-08-02 05:31:06 +03:00
e n d i f # BUILD_C_RECORDMCOUNT
2015-01-09 15:06:33 +03:00
cmd_record_mcount = \
if [ " $( findstring $( CC_FLAGS_FTRACE) ,$( _c_flags) ) " = \
" $( CC_FLAGS_FTRACE) " ] ; then \
ftrace: Speed up recordmcount
cmd_record_mcount is used to locate the _mcount symbols in the object
files, only the files compiled with -pg has the _mcount symbol, so, it
is only needed for such files, but the current cmd_record_mcount is used
for all of the object files, so, we need to fix it and speed it up.
Since -pg may be removed by the method used in kernel/trace/Makefile:
ORIG_CFLAGS := $(KBUILD_CFLAGS)
KBUILD_CFLAGS = $(subst -pg,,$(ORIG_CFLAGS))
Or may be removed by the method used in arch/x86/kernel/Makefile:
CFLAGS_REMOVE_file.o = -pg
So, we must check the last variable stores the compiling flags, that is
c_flags(Please refer to cmd_cc_o_c and rule_cc_o_c defined in
scripts/Makefile.build) and since the CFLAGS_REMOVE_file.o is already
filtered in _c_flags(Please refer to scripts/Makefile.lib) and _c_flags
has less symbols, therefore, we only need to check _c_flags.
---------------
Changes from v1:
o Don't touch Makefile for CONFIG_FTRACE_MCOUNT_RECORD is enough
o Use _c_flags intead of KBUILD_CFLAGS to cover CONFIG_REMOVE_file.o = -pg
(feedback from Steven Rostedt <rostedt@goodmis.org>)
Acked-by: Michal Marek <mmarek@suse.cz>
Signed-off-by: Wu Zhangjin <wuzhangjin@gmail.com>
LKML-Reference: <3dc8cddf022eb7024f9f2cf857529a15bee8999a.1288196498.git.wuzhangjin@gmail.com>
[ changed if [ .. == .. ] to if [ .. = .. ] to handle dash environments ]
Signed-off-by: Steven Rostedt <rostedt@goodmis.org>
2010-10-27 20:24:34 +04:00
$( sub_cmd_record_mcount) \
fi ;
2018-06-09 00:47:46 +03:00
e n d i f # -record-mcount
2017-08-02 05:31:06 +03:00
e n d i f # CONFIG_FTRACE_MCOUNT_RECORD
ftrace: create __mcount_loc section
This patch creates a section in the kernel called "__mcount_loc".
This will hold a list of pointers to the mcount relocation for
each call site of mcount.
For example:
objdump -dr init/main.o
[...]
Disassembly of section .text:
0000000000000000 <do_one_initcall>:
0: 55 push %rbp
[...]
000000000000017b <init_post>:
17b: 55 push %rbp
17c: 48 89 e5 mov %rsp,%rbp
17f: 53 push %rbx
180: 48 83 ec 08 sub $0x8,%rsp
184: e8 00 00 00 00 callq 189 <init_post+0xe>
185: R_X86_64_PC32 mcount+0xfffffffffffffffc
[...]
We will add a section to point to each function call.
.section __mcount_loc,"a",@progbits
[...]
.quad .text + 0x185
[...]
The offset to of the mcount call site in init_post is an offset from
the start of the section, and not the start of the function init_post.
The mcount relocation is at the call site 0x185 from the start of the
.text section.
.text + 0x185 == init_post + 0xa
We need a way to add this __mcount_loc section in a way that we do not
lose the relocations after final link. The .text section here will
be attached to all other .text sections after final link and the
offsets will be meaningless. We need to keep track of where these
.text sections are.
To do this, we use the start of the first function in the section.
do_one_initcall. We can make a tmp.s file with this function as a reference
to the start of the .text section.
.section __mcount_loc,"a",@progbits
[...]
.quad do_one_initcall + 0x185
[...]
Then we can compile the tmp.s into a tmp.o
gcc -c tmp.s -o tmp.o
And link it into back into main.o.
ld -r main.o tmp.o -o tmp_main.o
mv tmp_main.o main.o
But we have a problem. What happens if the first function in a section
is not exported, and is a static function. The linker will not let
the tmp.o use it. This case exists in main.o as well.
Disassembly of section .init.text:
0000000000000000 <set_reset_devices>:
0: 55 push %rbp
1: 48 89 e5 mov %rsp,%rbp
4: e8 00 00 00 00 callq 9 <set_reset_devices+0x9>
5: R_X86_64_PC32 mcount+0xfffffffffffffffc
The first function in .init.text is a static function.
00000000000000a8 t __setup_set_reset_devices
000000000000105f t __setup_str_set_reset_devices
0000000000000000 t set_reset_devices
The lowercase 't' means that set_reset_devices is local and is not exported.
If we simply try to link the tmp.o with the set_reset_devices we end
up with two symbols: one local and one global.
.section __mcount_loc,"a",@progbits
.quad set_reset_devices + 0x10
00000000000000a8 t __setup_set_reset_devices
000000000000105f t __setup_str_set_reset_devices
0000000000000000 t set_reset_devices
U set_reset_devices
We still have an undefined reference to set_reset_devices, and if we try
to compile the kernel, we will end up with an undefined reference to
set_reset_devices, or even worst, it could be exported someplace else,
and then we will have a reference to the wrong location.
To handle this case, we make an intermediate step using objcopy.
We convert set_reset_devices into a global exported symbol before linking
it with tmp.o and set it back afterwards.
00000000000000a8 t __setup_set_reset_devices
000000000000105f t __setup_str_set_reset_devices
0000000000000000 T set_reset_devices
00000000000000a8 t __setup_set_reset_devices
000000000000105f t __setup_str_set_reset_devices
0000000000000000 T set_reset_devices
00000000000000a8 t __setup_set_reset_devices
000000000000105f t __setup_str_set_reset_devices
0000000000000000 t set_reset_devices
Now we have a section in main.o called __mcount_loc that we can place
somewhere in the kernel using vmlinux.ld.S and access it to convert
all these locations that call mcount into nops before starting SMP
and thus, eliminating the need to do this with kstop_machine.
Note, A well documented perl script (scripts/recordmcount.pl) is used
to do all this in one location.
Signed-off-by: Steven Rostedt <srostedt@redhat.com>
Signed-off-by: Ingo Molnar <mingo@elte.hu>
2008-08-14 23:45:07 +04:00
2016-02-29 07:22:42 +03:00
i f d e f C O N F I G _ S T A C K _ V A L I D A T I O N
2016-03-03 20:39:30 +03:00
i f n e q ( $( SKIP_STACK_VALIDATION ) , 1 )
2016-02-29 07:22:42 +03:00
__objtool_obj := $( objtree) /tools/objtool/objtool
2017-10-13 23:02:00 +03:00
objtool_args = $( if $( CONFIG_UNWINDER_ORC) ,orc generate,check)
2017-07-25 02:36:57 +03:00
2018-01-31 12:18:28 +03:00
objtool_args += $( if $( part-of-module) , --module,)
2016-02-29 07:22:42 +03:00
i f n d e f C O N F I G _ F R A M E _ P O I N T E R
objtool_args += --no-fp
e n d i f
2017-07-25 02:34:14 +03:00
i f d e f C O N F I G _ G C O V _ K E R N E L
objtool_args += --no-unreachable
2017-09-28 01:34:23 +03:00
e l s e
objtool_args += $( call cc-ifversion, -lt, 0405, --no-unreachable)
2017-07-25 02:34:14 +03:00
e n d i f
2018-01-16 12:24:06 +03:00
i f d e f C O N F I G _ R E T P O L I N E
2018-02-06 11:46:13 +03:00
i f n e q ( $( RETPOLINE_CFLAGS ) , )
2018-01-16 12:24:06 +03:00
objtool_args += --retpoline
e n d i f
2018-02-06 11:46:13 +03:00
e n d i f
2018-01-16 12:24:06 +03:00
2016-02-29 07:22:42 +03:00
2018-01-15 17:17:07 +03:00
i f d e f C O N F I G _ M O D V E R S I O N S
objtool_o = $( @D) /.tmp_$( @F)
e l s e
objtool_o = $( @)
e n d i f
2016-02-29 07:22:42 +03:00
# 'OBJECT_FILES_NON_STANDARD := y': skip objtool checking for a directory
# 'OBJECT_FILES_NON_STANDARD_foo.o := 'y': skip objtool checking for a file
# 'OBJECT_FILES_NON_STANDARD_foo.o := 'n': override directory skip for a file
cmd_objtool = $( if $( patsubst y%,, \
$( OBJECT_FILES_NON_STANDARD_$( basetarget) .o) $( OBJECT_FILES_NON_STANDARD) n) , \
2018-01-15 17:17:07 +03:00
$( __objtool_obj) $( objtool_args) " $( objtool_o) " ; )
2016-02-29 07:22:42 +03:00
objtool_obj = $( if $( patsubst y%,, \
$( OBJECT_FILES_NON_STANDARD_$( basetarget) .o) $( OBJECT_FILES_NON_STANDARD) n) , \
$( __objtool_obj) )
2016-03-03 20:39:30 +03:00
e n d i f # SKIP_STACK_VALIDATION
2016-02-29 07:22:42 +03:00
e n d i f # CONFIG_STACK_VALIDATION
2017-07-25 02:36:57 +03:00
# Rebuild all objects when objtool changes, or is enabled/disabled.
objtool_dep = $( objtool_obj) \
$( wildcard include/config/orc/unwinder.h \
include/config/stack/validation.h)
2005-04-17 02:20:36 +04:00
d e f i n e r u l e _ c c _ o _ c
2006-01-30 12:04:27 +03:00
$( call echo-cmd,checksrc) $( cmd_checksrc) \
2016-02-17 23:50:06 +03:00
$( call cmd_and_fixdep,cc_o_c) \
2017-11-20 21:40:40 +03:00
$( cmd_checkdoc) \
2017-04-21 18:16:20 +03:00
$( call echo-cmd,objtool) $( cmd_objtool) \
2018-01-15 17:17:07 +03:00
$( cmd_modversions_c) \
2016-02-17 23:50:06 +03:00
$( call echo-cmd,record_mcount) $( cmd_record_mcount)
2005-04-17 02:20:36 +04:00
e n d e f
2016-02-29 07:22:42 +03:00
d e f i n e r u l e _ a s _ o _ S
2016-02-17 23:50:06 +03:00
$( call cmd_and_fixdep,as_o_S) \
2018-01-15 17:17:07 +03:00
$( call echo-cmd,objtool) $( cmd_objtool) \
$( cmd_modversions_S)
2016-02-29 07:22:42 +03:00
e n d e f
2016-01-22 01:07:24 +03:00
# List module undefined symbols (or empty line if not enabled)
i f d e f C O N F I G _ T R I M _ U N U S E D _ K S Y M S
2018-02-07 09:41:17 +03:00
cmd_undef_syms = $( NM) $@ | sed -n 's/^ *U //p' | xargs echo
2016-01-22 01:07:24 +03:00
e l s e
cmd_undef_syms = echo
e n d i f
2005-04-17 02:20:36 +04:00
# Built-in and composite module parts
2017-07-25 02:36:57 +03:00
$(obj)/%.o : $( src ) /%.c $( recordmcount_source ) $( objtool_dep ) FORCE
2005-04-17 02:20:36 +04:00
$( call cmd,force_checksrc)
$( call if_changed_rule,cc_o_c)
# Single-part modules are special since we need to mark them in $(MODVERDIR)
2017-07-25 02:36:57 +03:00
$(single-used-m) : $( obj ) /%.o : $( src ) /%.c $( recordmcount_source ) $( objtool_dep ) FORCE
2005-04-17 02:20:36 +04:00
$( call cmd,force_checksrc)
$( call if_changed_rule,cc_o_c)
2016-01-22 01:07:24 +03:00
@{ echo $( @:.o= .ko) ; echo $@ ; \
$( cmd_undef_syms) ; } > $( MODVERDIR) /$( @F:.o= .mod)
2005-04-17 02:20:36 +04:00
quiet_cmd_cc_lst_c = MKLST $@
cmd_cc_lst_c = $( CC) $( c_flags) -g -c -o $* .o $< && \
$( CONFIG_SHELL) $( srctree) /scripts/makelst $* .o \
System.map $( OBJDUMP) > $@
2007-05-06 11:23:45 +04:00
$(obj)/%.lst : $( src ) /%.c FORCE
2005-04-17 02:20:36 +04:00
$( call if_changed_dep,cc_lst_c)
# Compile assembler sources (.S)
# ---------------------------------------------------------------------------
2010-07-28 21:11:27 +04:00
modkern_aflags := $( KBUILD_AFLAGS_KERNEL) $( AFLAGS_KERNEL)
2005-04-17 02:20:36 +04:00
2018-03-19 14:26:07 +03:00
$(real-obj-m) : modkern_aflags := $( KBUILD_AFLAGS_MODULE ) $( AFLAGS_MODULE )
$(real-obj-m : .o =.s ): modkern_aflags := $( KBUILD_AFLAGS_MODULE ) $( AFLAGS_MODULE )
2005-04-17 02:20:36 +04:00
2016-11-01 04:46:19 +03:00
# .S file exports must have their C prototypes defined in asm/asm-prototypes.h
# or a file that it includes, in order to get versioned symbols. We build a
# dummy C file that includes asm-prototypes and the EXPORT_SYMBOL lines from
# the .S file (with trailing ';'), and run genksyms on that, to extract vers.
#
# This is convoluted. The .S file must first be preprocessed to run guards and
# expand names, then the resulting exports must be constructed into plain
# EXPORT_SYMBOL(symbol); to build our dummy C file, and that gets preprocessed
# to make the genksyms input.
#
# These mirror gensymtypes_c and co above, keep them in synch.
cmd_gensymtypes_S = \
( echo "\#include <linux/kernel.h>" ; \
echo "\#include <asm/asm-prototypes.h>" ; \
$( CPP) $( a_flags) $< | \
2016-11-09 07:34:05 +03:00
grep "\<___EXPORT_SYMBOL\>" | \
sed 's/.*___EXPORT_SYMBOL[[:space:]]*\([a-zA-Z0-9_]*\)[[:space:]]*,.*/EXPORT_SYMBOL(\1);/' ) | \
2016-11-01 04:46:19 +03:00
$( CPP) -D__GENKSYMS__ $( c_flags) -xc - | \
$( GENKSYMS) $( if $( 1) , -T $( 2) ) \
2017-02-03 12:54:05 +03:00
$( patsubst y,-R,$( CONFIG_MODULE_REL_CRCS) ) \
2016-11-01 04:46:19 +03:00
$( if $( KBUILD_PRESERVE) ,-p) \
-r $( firstword $( wildcard $( 2:.symtypes= .symref) /dev/null) )
quiet_cmd_cc_symtypes_S = SYM $( quiet_modtag) $@
cmd_cc_symtypes_S = \
set -e; \
$( call cmd_gensymtypes_S,true,$@ ) >/dev/null; \
test -s $@ || rm -f $@
$(obj)/%.symtypes : $( src ) /%.S FORCE
$( call cmd,cc_symtypes_S)
2016-04-08 05:24:48 +03:00
quiet_cmd_cpp_s_S = CPP $( quiet_modtag) $@
cmd_cpp_s_S = $( CPP) $( a_flags) -o $@ $<
2005-04-17 02:20:36 +04:00
2007-05-06 11:23:45 +04:00
$(obj)/%.s : $( src ) /%.S FORCE
2016-04-08 05:24:48 +03:00
$( call if_changed_dep,cpp_s_S)
2005-04-17 02:20:36 +04:00
quiet_cmd_as_o_S = AS $( quiet_modtag) $@
2016-11-01 04:46:19 +03:00
i f n d e f C O N F I G _ M O D V E R S I O N S
cmd_as_o_S = $( CC) $( a_flags) -c -o $@ $<
e l s e
ASM_PROTOTYPES := $( wildcard $( srctree) /arch/$( SRCARCH) /include/asm/asm-prototypes.h)
i f e q ( $( ASM_PROTOTYPES ) , )
cmd_as_o_S = $( CC) $( a_flags) -c -o $@ $<
e l s e
# versioning matches the C process described above, with difference that
# we parse asm-prototypes.h C header to get function definitions.
cmd_as_o_S = $( CC) $( a_flags) -c -o $( @D) /.tmp_$( @F) $<
cmd_modversions_S = \
if $( OBJDUMP) -h $( @D) /.tmp_$( @F) | grep -q __ksymtab; then \
$( call cmd_gensymtypes_S,$( KBUILD_SYMTYPES) ,$( @:.o= .symtypes) ) \
> $( @D) /.tmp_$( @F:.o= .ver) ; \
\
$( LD) $( LDFLAGS) -r -o $@ $( @D) /.tmp_$( @F) \
-T $( @D) /.tmp_$( @F:.o= .ver) ; \
rm -f $( @D) /.tmp_$( @F) $( @D) /.tmp_$( @F:.o= .ver) ; \
else \
mv -f $( @D) /.tmp_$( @F) $@ ; \
fi ;
e n d i f
e n d i f
2005-04-17 02:20:36 +04:00
2017-07-25 02:36:57 +03:00
$(obj)/%.o : $( src ) /%.S $( objtool_dep ) FORCE
2016-02-29 07:22:42 +03:00
$( call if_changed_rule,as_o_S)
2005-04-17 02:20:36 +04:00
kbuild: link $(real-obj-y) instead of $(obj-y) into built-in.a
In Kbuild, Makefiles can add the same object to obj-y multiple
times. So,
obj-y += foo.o
obj-y += foo.o
is fine.
However, this is not true when the same object is added multiple
times via composite objects. For example,
obj-y += foo.o bar.o
foo-objs := foo-bar-common.o foo-only.o
bar-objs := foo-bar-common.o bar-only.o
causes build error because two instances of foo-bar-common.o are
linked into the vmlinux.
Makefiles tend to invent ugly work-around, for example
- lib/zstd/Makefile
- drivers/net/ethernet/cavium/liquidio/Makefile
The technique used in Kbuild to avoid the multiple definition error
is to use $(filter $(obj-y), $^). Here, $^ lists the names of all
the prerequisites with duplicated names removed.
By replacing it with $(filter $(real-obj-y), $^) we can do likewise
for composite objects. For built-in objects, we do not need to keep
the composite object structure. We can simply expand them, and link
$(real-obj-y) to built-in.a.
Signed-off-by: Masahiro Yamada <yamada.masahiro@socionext.com>
2018-03-19 14:26:08 +03:00
targets += $( filter-out $( subdir-obj-y) , $( real-obj-y) ) $( real-obj-m) $( lib-y)
2005-04-17 02:20:36 +04:00
targets += $( extra-y) $( MAKECMDGOALS) $( always)
# Linker scripts preprocessor (.lds.S -> .lds)
# ---------------------------------------------------------------------------
quiet_cmd_cpp_lds_S = LDS $@
Kbuild: don't pass "-C" to preprocessor when processing linker scripts
For some odd historical reason, we preprocessed the linker scripts with
"-C", which keeps comments around. That makes no sense, since the
comments are not meaningful for the build anyway.
And it actually breaks things, since linker scripts can't have C++ style
"//" comments in them, so keeping comments after preprocessing now
limits us in odd and surprising ways in our header files for no good
reason.
The -C option goes back to pre-git and pre-bitkeeper times, but seems to
have been historically used (along with "-traditional") for some
odd-ball architectures (ia64, MIPS and SH). It probably didn't matter
back then either, but might possibly have been used to minimize the
difference between the original file and the pre-processed result.
The reason for this may be lost in time, but let's not perpetuate it
only because we can't remember why we did this crazy thing.
This was triggered by the recent addition of SPDX lines to the source
tree, where people apparently were confused about why header files
couldn't use the C++ comment format.
Cc: Thomas Gleixner <tglx@linutronix.de>
Cc: Greg KH <gregkh@linuxfoundation.org>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
2017-11-03 00:10:37 +03:00
cmd_cpp_lds_S = $( CPP) $( cpp_flags) -P -U$( ARCH) \
2009-09-21 02:14:12 +04:00
-D__ASSEMBLY__ -DLINKER_SCRIPT -o $@ $<
2005-04-17 02:20:36 +04:00
2007-05-06 11:23:45 +04:00
$(obj)/%.lds : $( src ) /%.lds .S FORCE
2005-04-17 02:20:36 +04:00
$( call if_changed_dep,cpp_lds_S)
2012-09-22 02:31:13 +04:00
# ASN.1 grammar
# ---------------------------------------------------------------------------
quiet_cmd_asn1_compiler = ASN.1 $@
cmd_asn1_compiler = $( objtree) /scripts/asn1_compiler $< \
$( subst .h,.c,$@ ) $( subst .c,.h,$@ )
2018-03-23 16:04:37 +03:00
$(obj)/%.asn1.c $(obj)/%.asn1.h : $( src ) /%.asn 1 $( objtree ) /scripts /asn 1_compiler
2012-09-22 02:31:13 +04:00
$( call cmd,asn1_compiler)
2005-04-17 02:20:36 +04:00
# Build the compiled-in targets
# ---------------------------------------------------------------------------
# To build objects in subdirs, we need to descend into the directories
$(sort $(subdir-obj-y)) : $( subdir -ym ) ;
#
# Rule to compile a set of .o files into one .o file
#
i f d e f b u i l t i n - t a r g e t
kbuild: allow architectures to use thin archives instead of ld -r
ld -r is an incremental link used to create built-in.o files in build
subdirectories. It produces relocatable object files containing all
its input files, and these are are then pulled together and relocated
in the final link. Aside from the bloat, this constrains the final
link relocations, which has bitten large powerpc builds with
unresolvable relocations in the final link.
Alan Modra has recommended the kernel use thin archives for linking.
This is an alternative and means that the linker has more information
available to it when it links the kernel.
This patch enables a config option architectures can select, which
causes all built-in.o files to be built as thin archives. built-in.o
files in subdirectories do not get symbol table or index attached,
which improves speed and size. The final link pass creates a
built-in.o archive in the root output directory which includes the
symbol table and index. The linker then uses takes this file to link.
The --whole-archive linker option is required, because the linker now
has visibility to every individual object file, and it will otherwise
just completely avoid including those without external references
(consider a file with EXPORT_SYMBOL or initcall or hardware exceptions
as its only entry points). The traditional built works "by luck" as
built-in.o files are large enough that they're going to get external
references. However this optimisation is unpredictable for the kernel
(due to above external references), ineffective at culling unused, and
costly because the .o files have to be searched for references.
Superior alternatives for link-time culling should be used instead.
Build characteristics for inclink vs thinarc, on a small powerpc64le
pseries VM with a modest .config:
inclink thinarc
sizes
vmlinux 15 618 680 15 625 028
sum of all built-in.o 56 091 808 1 054 334
sum excluding root built-in.o 151 430
find -name built-in.o | xargs rm ; time make vmlinux
real 22.772s 21.143s
user 13.280s 13.430s
sys 4.310s 2.750s
- Final kernel pulled in only about 6K more, which shows how
ineffective the object file culling is.
- Build performance looks improved due to less pagecache activity.
On IO constrained systems it could be a bigger win.
- Build size saving is significant.
Side note, the toochain understands archives, so there's some tricks,
$ ar t built-in.o # list all files you linked with
$ size built-in.o # and their sizes
$ objdump -d built-in.o # disassembly (unrelocated) with filenames
Implementation by sfr, minor tweaks by npiggin.
Signed-off-by: Stephen Rothwell <sfr@canb.auug.org.au>
Signed-off-by: Nicholas Piggin <npiggin@gmail.com>
Signed-off-by: Michal Marek <mmarek@suse.com>
2016-08-24 15:29:19 +03:00
2018-02-10 17:25:04 +03:00
# built-in.a archives are made with no symbol table or index which
2018-02-10 17:25:03 +03:00
# makes them small and fast, but unable to be used by the linker.
2018-02-10 17:25:04 +03:00
# scripts/link-vmlinux.sh builds an aggregate built-in.a with a symbol
2018-02-10 17:25:03 +03:00
# table and index.
2018-03-19 14:26:12 +03:00
quiet_cmd_ar_builtin = AR $@
cmd_ar_builtin = rm -f $@ ; \
$( AR) rcSTP$( KBUILD_ARFLAGS) $@ $( filter $( real-obj-y) , $^)
2005-04-17 02:20:36 +04:00
kbuild: link $(real-obj-y) instead of $(obj-y) into built-in.a
In Kbuild, Makefiles can add the same object to obj-y multiple
times. So,
obj-y += foo.o
obj-y += foo.o
is fine.
However, this is not true when the same object is added multiple
times via composite objects. For example,
obj-y += foo.o bar.o
foo-objs := foo-bar-common.o foo-only.o
bar-objs := foo-bar-common.o bar-only.o
causes build error because two instances of foo-bar-common.o are
linked into the vmlinux.
Makefiles tend to invent ugly work-around, for example
- lib/zstd/Makefile
- drivers/net/ethernet/cavium/liquidio/Makefile
The technique used in Kbuild to avoid the multiple definition error
is to use $(filter $(obj-y), $^). Here, $^ lists the names of all
the prerequisites with duplicated names removed.
By replacing it with $(filter $(real-obj-y), $^) we can do likewise
for composite objects. For built-in objects, we do not need to keep
the composite object structure. We can simply expand them, and link
$(real-obj-y) to built-in.a.
Signed-off-by: Masahiro Yamada <yamada.masahiro@socionext.com>
2018-03-19 14:26:08 +03:00
$(builtin-target) : $( real -obj -y ) FORCE
2018-03-19 14:26:12 +03:00
$( call if_changed,ar_builtin)
2005-04-17 02:20:36 +04:00
targets += $( builtin-target)
e n d i f # builtin-target
2007-12-07 15:04:30 +03:00
#
# Rule to create modules.order file
#
# Create commands to either record .ko file or cat modules.order from
# a subdirectory
modorder-cmds = \
$( foreach m, $( modorder) , \
$( if $( filter %/modules.order, $m ) , \
cat $m ; , echo kernel/$m ; ) )
$(modorder-target) : $( subdir -ym ) FORCE
$( Q) ( cat /dev/null; $( modorder-cmds) ) > $@
2005-04-17 02:20:36 +04:00
#
# Rule to compile a set of .o files into one .a file
#
i f d e f l i b - t a r g e t
quiet_cmd_link_l_target = AR $@
kbuild: allow architectures to use thin archives instead of ld -r
ld -r is an incremental link used to create built-in.o files in build
subdirectories. It produces relocatable object files containing all
its input files, and these are are then pulled together and relocated
in the final link. Aside from the bloat, this constrains the final
link relocations, which has bitten large powerpc builds with
unresolvable relocations in the final link.
Alan Modra has recommended the kernel use thin archives for linking.
This is an alternative and means that the linker has more information
available to it when it links the kernel.
This patch enables a config option architectures can select, which
causes all built-in.o files to be built as thin archives. built-in.o
files in subdirectories do not get symbol table or index attached,
which improves speed and size. The final link pass creates a
built-in.o archive in the root output directory which includes the
symbol table and index. The linker then uses takes this file to link.
The --whole-archive linker option is required, because the linker now
has visibility to every individual object file, and it will otherwise
just completely avoid including those without external references
(consider a file with EXPORT_SYMBOL or initcall or hardware exceptions
as its only entry points). The traditional built works "by luck" as
built-in.o files are large enough that they're going to get external
references. However this optimisation is unpredictable for the kernel
(due to above external references), ineffective at culling unused, and
costly because the .o files have to be searched for references.
Superior alternatives for link-time culling should be used instead.
Build characteristics for inclink vs thinarc, on a small powerpc64le
pseries VM with a modest .config:
inclink thinarc
sizes
vmlinux 15 618 680 15 625 028
sum of all built-in.o 56 091 808 1 054 334
sum excluding root built-in.o 151 430
find -name built-in.o | xargs rm ; time make vmlinux
real 22.772s 21.143s
user 13.280s 13.430s
sys 4.310s 2.750s
- Final kernel pulled in only about 6K more, which shows how
ineffective the object file culling is.
- Build performance looks improved due to less pagecache activity.
On IO constrained systems it could be a bigger win.
- Build size saving is significant.
Side note, the toochain understands archives, so there's some tricks,
$ ar t built-in.o # list all files you linked with
$ size built-in.o # and their sizes
$ objdump -d built-in.o # disassembly (unrelocated) with filenames
Implementation by sfr, minor tweaks by npiggin.
Signed-off-by: Stephen Rothwell <sfr@canb.auug.org.au>
Signed-off-by: Nicholas Piggin <npiggin@gmail.com>
Signed-off-by: Michal Marek <mmarek@suse.com>
2016-08-24 15:29:19 +03:00
2018-02-10 17:25:03 +03:00
# lib target archives do get a symbol table and index
cmd_link_l_target = rm -f $@ ; $( AR) rcsTP$( KBUILD_ARFLAGS) $@ $( lib-y)
2005-04-17 02:20:36 +04:00
$(lib-target) : $( lib -y ) FORCE
$( call if_changed,link_l_target)
targets += $( lib-target)
2016-01-15 22:01:22 +03:00
dummy-object = $( obj) /.lib_exports.o
ksyms-lds = $( dot-target) .lds
quiet_cmd_export_list = EXPORTS $@
cmd_export_list = $( OBJDUMP) -h $< | \
2018-05-09 10:23:50 +03:00
sed -ne '/___ksymtab/s/.*+\([^ ]*\).*/EXTERN(\1)/p' >$( ksyms-lds) ; \
2016-01-15 22:01:22 +03:00
rm -f $( dummy-object) ; \
2016-11-23 19:41:40 +03:00
echo | $( CC) $( a_flags) -c -o $( dummy-object) -x assembler -; \
2016-01-15 22:01:22 +03:00
$( LD) $( ld_flags) -r -o $@ -T $( ksyms-lds) $( dummy-object) ; \
rm $( dummy-object) $( ksyms-lds)
$(obj)/lib-ksyms.o : $( lib -target ) FORCE
$( call if_changed,export_list)
2016-10-20 17:13:33 +03:00
targets += $( obj) /lib-ksyms.o
2005-04-17 02:20:36 +04:00
e n d i f
#
# Rule to link composite objects
#
# Composite objects are specified in kbuild makefile as follows:
# <composite-object>-objs := <list of .o files>
# or
# <composite-object>-y := <list of .o files>
2015-10-27 16:02:24 +03:00
# or
# <composite-object>-m := <list of .o files>
# The -m syntax only works if <composite object> is a module
2005-04-17 02:20:36 +04:00
link_multi_deps = \
$( filter $ ( addprefix $ ( obj ) /, \
$($(subst $(obj)/,,$(@ : .o =-objs ))) \
2015-10-27 16:02:24 +03:00
$($(subst $(obj)/,,$(@ : .o =-y ))) \
$($(subst $(obj)/,,$(@ : .o =-m )))), $^)
2014-04-28 11:26:18 +04:00
2005-04-17 02:20:36 +04:00
quiet_cmd_link_multi-m = LD [ M] $@
2018-03-19 14:26:13 +03:00
cmd_link_multi-m = $( LD) $( ld_flags) -r -o $@ $( link_multi_deps) $( cmd_secanalysis)
2005-04-17 02:20:36 +04:00
2014-08-19 11:34:20 +04:00
$(multi-used-m) : FORCE
2005-04-17 02:20:36 +04:00
$( call if_changed,link_multi-m)
2016-01-22 01:07:24 +03:00
@{ echo $( @:.o= .ko) ; echo $( link_multi_deps) ; \
$( cmd_undef_syms) ; } > $( MODVERDIR) /$( @F:.o= .mod)
2015-10-27 16:02:24 +03:00
$( call multi_depend , $ ( multi -used -m ) , .o , -objs -y -m )
2005-04-17 02:20:36 +04:00
kbuild: link $(real-obj-y) instead of $(obj-y) into built-in.a
In Kbuild, Makefiles can add the same object to obj-y multiple
times. So,
obj-y += foo.o
obj-y += foo.o
is fine.
However, this is not true when the same object is added multiple
times via composite objects. For example,
obj-y += foo.o bar.o
foo-objs := foo-bar-common.o foo-only.o
bar-objs := foo-bar-common.o bar-only.o
causes build error because two instances of foo-bar-common.o are
linked into the vmlinux.
Makefiles tend to invent ugly work-around, for example
- lib/zstd/Makefile
- drivers/net/ethernet/cavium/liquidio/Makefile
The technique used in Kbuild to avoid the multiple definition error
is to use $(filter $(obj-y), $^). Here, $^ lists the names of all
the prerequisites with duplicated names removed.
By replacing it with $(filter $(real-obj-y), $^) we can do likewise
for composite objects. For built-in objects, we do not need to keep
the composite object structure. We can simply expand them, and link
$(real-obj-y) to built-in.a.
Signed-off-by: Masahiro Yamada <yamada.masahiro@socionext.com>
2018-03-19 14:26:08 +03:00
targets += $( multi-used-m)
2017-11-13 13:29:36 +03:00
targets := $( filter-out $( PHONY) , $( targets) )
2005-04-17 02:20:36 +04:00
2018-03-23 16:04:33 +03:00
# Add intermediate targets:
# When building objects with specific suffix patterns, add intermediate
# targets that the final targets are derived from.
intermediate_targets = $( foreach sfx, $( 2) , \
$( patsubst %$( strip $( 1) ) ,%$( sfx) , \
$( filter %$( strip $( 1) ) , $( targets) ) ) )
kbuild: mark $(targets) as .SECONDARY and remove .PRECIOUS markers
GNU Make automatically deletes intermediate files that are updated
in a chain of pattern rules.
Example 1) %.dtb.o <- %.dtb.S <- %.dtb <- %.dts
Example 2) %.o <- %.c <- %.c_shipped
A couple of makefiles mark such targets as .PRECIOUS to prevent Make
from deleting them, but the correct way is to use .SECONDARY.
.SECONDARY
Prerequisites of this special target are treated as intermediate
files but are never automatically deleted.
.PRECIOUS
When make is interrupted during execution, it may delete the target
file it is updating if the file was modified since make started.
If you mark the file as precious, make will never delete the file
if interrupted.
Both can avoid deletion of intermediate files, but the difference is
the behavior when Make is interrupted; .SECONDARY deletes the target,
but .PRECIOUS does not.
The use of .PRECIOUS is relatively rare since we do not want to keep
partially constructed (possibly corrupted) targets.
Another difference is that .PRECIOUS works with pattern rules whereas
.SECONDARY does not.
.PRECIOUS: $(obj)/%.lex.c
works, but
.SECONDARY: $(obj)/%.lex.c
has no effect. However, for the reason above, I do not want to use
.PRECIOUS which could cause obscure build breakage.
The targets specified as .SECONDARY must be explicit. $(targets)
contains all targets that need to include .*.cmd files. So, the
intermediates you want to keep are mostly in there. Therefore, mark
$(targets) as .SECONDARY. It means primary targets are also marked
as .SECONDARY, but I do not see any drawback for this.
I replaced some .SECONDARY / .PRECIOUS markers with 'targets'. This
will make Kbuild search for non-existing .*.cmd files, but this is
not a noticeable performance issue.
Signed-off-by: Masahiro Yamada <yamada.masahiro@socionext.com>
Acked-by: Frank Rowand <frowand.list@gmail.com>
Acked-by: Ingo Molnar <mingo@kernel.org>
2018-03-23 16:04:39 +03:00
# %.asn1.o <- %.asn1.[ch] <- %.asn1
2018-03-23 16:04:34 +03:00
# %.dtb.o <- %.dtb.S <- %.dtb <- %.dts
2018-03-23 16:04:33 +03:00
# %.lex.o <- %.lex.c <- %.l
# %.tab.o <- %.tab.[ch] <- %.y
kbuild: mark $(targets) as .SECONDARY and remove .PRECIOUS markers
GNU Make automatically deletes intermediate files that are updated
in a chain of pattern rules.
Example 1) %.dtb.o <- %.dtb.S <- %.dtb <- %.dts
Example 2) %.o <- %.c <- %.c_shipped
A couple of makefiles mark such targets as .PRECIOUS to prevent Make
from deleting them, but the correct way is to use .SECONDARY.
.SECONDARY
Prerequisites of this special target are treated as intermediate
files but are never automatically deleted.
.PRECIOUS
When make is interrupted during execution, it may delete the target
file it is updating if the file was modified since make started.
If you mark the file as precious, make will never delete the file
if interrupted.
Both can avoid deletion of intermediate files, but the difference is
the behavior when Make is interrupted; .SECONDARY deletes the target,
but .PRECIOUS does not.
The use of .PRECIOUS is relatively rare since we do not want to keep
partially constructed (possibly corrupted) targets.
Another difference is that .PRECIOUS works with pattern rules whereas
.SECONDARY does not.
.PRECIOUS: $(obj)/%.lex.c
works, but
.SECONDARY: $(obj)/%.lex.c
has no effect. However, for the reason above, I do not want to use
.PRECIOUS which could cause obscure build breakage.
The targets specified as .SECONDARY must be explicit. $(targets)
contains all targets that need to include .*.cmd files. So, the
intermediates you want to keep are mostly in there. Therefore, mark
$(targets) as .SECONDARY. It means primary targets are also marked
as .SECONDARY, but I do not see any drawback for this.
I replaced some .SECONDARY / .PRECIOUS markers with 'targets'. This
will make Kbuild search for non-existing .*.cmd files, but this is
not a noticeable performance issue.
Signed-off-by: Masahiro Yamada <yamada.masahiro@socionext.com>
Acked-by: Frank Rowand <frowand.list@gmail.com>
Acked-by: Ingo Molnar <mingo@kernel.org>
2018-03-23 16:04:39 +03:00
targets += $( call intermediate_targets, .asn1.o, .asn1.c .asn1.h) \
$( call intermediate_targets, .dtb.o, .dtb.S .dtb) \
2018-03-23 16:04:34 +03:00
$( call intermediate_targets, .lex.o, .lex.c) \
2018-03-23 16:04:33 +03:00
$( call intermediate_targets, .tab.o, .tab.c .tab.h)
2005-04-17 02:20:36 +04:00
# Descending
# ---------------------------------------------------------------------------
2006-03-06 01:14:10 +03:00
PHONY += $( subdir-ym)
2005-04-17 02:20:36 +04:00
$(subdir-ym) :
2017-11-07 19:31:46 +03:00
$( Q) $( MAKE) $( build) = $@ need-builtin= $( if $( findstring $@ ,$( subdir-obj-y) ) ,1)
2005-04-17 02:20:36 +04:00
# Add FORCE to the prequisites of a target to force it to be always rebuilt.
# ---------------------------------------------------------------------------
2006-03-06 01:14:10 +03:00
PHONY += FORCE
2005-04-17 02:20:36 +04:00
FORCE :
# Read all saved command lines and dependencies for the $(targets) we
# may be building above, using $(if_changed{,_dep}). As an
# optimization, we don't need to read them if the target does not
# exist, we will rebuild anyway in that case.
2017-11-13 13:29:35 +03:00
cmd_files := $( wildcard $( foreach f,$( sort $( targets) ) ,$( dir $( f) ) .$( notdir $( f) ) .cmd) )
2005-04-17 02:20:36 +04:00
i f n e q ( $( cmd_files ) , )
include $( cmd_files)
e n d i f
2006-03-06 01:14:10 +03:00
2017-11-13 13:29:37 +03:00
i f n e q ( $( KBUILD_SRC ) , )
# Create directories for object files if they do not exist
obj-dirs := $( sort $( obj) $( patsubst %/,%, $( dir $( targets) ) ) )
2017-11-13 13:29:38 +03:00
# If cmd_files exist, their directories apparently exist. Skip mkdir.
exist-dirs := $( sort $( patsubst %/,%, $( dir $( cmd_files) ) ) )
obj-dirs := $( strip $( filter-out $( exist-dirs) , $( obj-dirs) ) )
i f n e q ( $( obj -dirs ) , )
2017-11-13 13:29:37 +03:00
$( shell mkdir -p $ ( obj -dirs ) )
e n d i f
2017-11-13 13:29:38 +03:00
e n d i f
2017-11-13 13:29:37 +03:00
kbuild: mark $(targets) as .SECONDARY and remove .PRECIOUS markers
GNU Make automatically deletes intermediate files that are updated
in a chain of pattern rules.
Example 1) %.dtb.o <- %.dtb.S <- %.dtb <- %.dts
Example 2) %.o <- %.c <- %.c_shipped
A couple of makefiles mark such targets as .PRECIOUS to prevent Make
from deleting them, but the correct way is to use .SECONDARY.
.SECONDARY
Prerequisites of this special target are treated as intermediate
files but are never automatically deleted.
.PRECIOUS
When make is interrupted during execution, it may delete the target
file it is updating if the file was modified since make started.
If you mark the file as precious, make will never delete the file
if interrupted.
Both can avoid deletion of intermediate files, but the difference is
the behavior when Make is interrupted; .SECONDARY deletes the target,
but .PRECIOUS does not.
The use of .PRECIOUS is relatively rare since we do not want to keep
partially constructed (possibly corrupted) targets.
Another difference is that .PRECIOUS works with pattern rules whereas
.SECONDARY does not.
.PRECIOUS: $(obj)/%.lex.c
works, but
.SECONDARY: $(obj)/%.lex.c
has no effect. However, for the reason above, I do not want to use
.PRECIOUS which could cause obscure build breakage.
The targets specified as .SECONDARY must be explicit. $(targets)
contains all targets that need to include .*.cmd files. So, the
intermediates you want to keep are mostly in there. Therefore, mark
$(targets) as .SECONDARY. It means primary targets are also marked
as .SECONDARY, but I do not see any drawback for this.
I replaced some .SECONDARY / .PRECIOUS markers with 'targets'. This
will make Kbuild search for non-existing .*.cmd files, but this is
not a noticeable performance issue.
Signed-off-by: Masahiro Yamada <yamada.masahiro@socionext.com>
Acked-by: Frank Rowand <frowand.list@gmail.com>
Acked-by: Ingo Molnar <mingo@kernel.org>
2018-03-23 16:04:39 +03:00
# Some files contained in $(targets) are intermediate artifacts.
# We never want them to be removed automatically.
.SECONDARY : $( targets )
2006-03-06 01:14:10 +03:00
.PHONY : $( PHONY )
