kbuild: treat an object as multi-used when $(foo-) is set
[linux-2.6-microblaze.git] / scripts / Makefile.lib
1 # SPDX-License-Identifier: GPL-2.0
2 # Backward compatibility
3 asflags-y  += $(EXTRA_AFLAGS)
4 ccflags-y  += $(EXTRA_CFLAGS)
5 cppflags-y += $(EXTRA_CPPFLAGS)
6 ldflags-y  += $(EXTRA_LDFLAGS)
7
8 # flags that take effect in current and sub directories
9 KBUILD_AFLAGS += $(subdir-asflags-y)
10 KBUILD_CFLAGS += $(subdir-ccflags-y)
11
12 # Figure out what we need to build from the various variables
13 # ===========================================================================
14
15 # When an object is listed to be built compiled-in and modular,
16 # only build the compiled-in version
17 obj-m := $(filter-out $(obj-y),$(obj-m))
18
19 # Libraries are always collected in one lib file.
20 # Filter out objects already built-in
21 lib-y := $(filter-out $(obj-y), $(sort $(lib-y) $(lib-m)))
22
23 # Determine modorder.
24 # Unfortunately, we don't have information about ordering between -y
25 # and -m subdirs.  Just put -y's first.
26 modorder        := $(patsubst %/,%/modules.order, $(filter %/, $(obj-y)) $(obj-m:.o=.ko))
27
28 # Handle objects in subdirs
29 # ---------------------------------------------------------------------------
30 # o if we encounter foo/ in $(obj-y), replace it by foo/built-in.a
31 #   and add the directory to the list of dirs to descend into: $(subdir-y)
32 # o if we encounter foo/ in $(obj-m), remove it from $(obj-m)
33 #   and add the directory to the list of dirs to descend into: $(subdir-m)
34 __subdir-y      := $(patsubst %/,%,$(filter %/, $(obj-y)))
35 subdir-y        += $(__subdir-y)
36 __subdir-m      := $(patsubst %/,%,$(filter %/, $(obj-m)))
37 subdir-m        += $(__subdir-m)
38 obj-y           := $(patsubst %/, %/built-in.a, $(obj-y))
39 obj-m           := $(filter-out %/, $(obj-m))
40
41 # Subdirectories we need to descend into
42 subdir-ym       := $(sort $(subdir-y) $(subdir-m))
43
44 # If $(foo-objs), $(foo-y), $(foo-m), or $(foo-) exists, foo.o is a composite object
45 multi-used-y := $(sort $(foreach m,$(obj-y), $(if $(strip $($(m:.o=-objs)) $($(m:.o=-y)) $($(m:.o=-))), $(m))))
46 multi-used-m := $(sort $(foreach m,$(obj-m), $(if $(strip $($(m:.o=-objs)) $($(m:.o=-y)) $($(m:.o=-m)) $($(m:.o=-))), $(m))))
47 multi-used   := $(multi-used-y) $(multi-used-m)
48
49 # $(subdir-obj-y) is the list of objects in $(obj-y) which uses dir/ to
50 # tell kbuild to descend
51 subdir-obj-y := $(filter %/built-in.a, $(obj-y))
52
53 # Replace multi-part objects by their individual parts,
54 # including built-in.a from subdirectories
55 real-obj-y := $(foreach m, $(obj-y), $(if $(strip $($(m:.o=-objs)) $($(m:.o=-y)) $($(m:.o=-))),$($(m:.o=-objs)) $($(m:.o=-y)),$(m)))
56 real-obj-m := $(foreach m, $(obj-m), $(if $(strip $($(m:.o=-objs)) $($(m:.o=-y)) $($(m:.o=-m)) $($(m:.o=-))),$($(m:.o=-objs)) $($(m:.o=-y)) $($(m:.o=-m)),$(m)))
57
58 # DTB
59 # If CONFIG_OF_ALL_DTBS is enabled, all DT blobs are built
60 extra-y                         += $(dtb-y)
61 extra-$(CONFIG_OF_ALL_DTBS)     += $(dtb-)
62
63 ifneq ($(CHECK_DTBS),)
64 extra-y += $(patsubst %.dtb,%.dt.yaml, $(dtb-y))
65 extra-$(CONFIG_OF_ALL_DTBS) += $(patsubst %.dtb,%.dt.yaml, $(dtb-))
66 endif
67
68 # Test self-contained headers
69
70 # Wildcard searches in $(srctree)/$(src)/, but not in $(objtree)/$(obj)/.
71 # Stale generated headers are often left over, so pattern matching should
72 # be avoided. Please notice $(srctree)/$(src)/ and $(objtree)/$(obj) point
73 # to the same location for in-tree building. So, header-test-pattern-y should
74 # be used with care.
75 header-test-y   += $(filter-out $(header-test-), \
76                 $(patsubst $(srctree)/$(src)/%, %, \
77                 $(wildcard $(addprefix $(srctree)/$(src)/, \
78                 $(header-test-pattern-y)))))
79
80 extra-$(CONFIG_HEADER_TEST) += $(addsuffix .s, $(header-test-y) $(header-test-m))
81
82 # Add subdir path
83
84 extra-y         := $(addprefix $(obj)/,$(extra-y))
85 always          := $(addprefix $(obj)/,$(always))
86 targets         := $(addprefix $(obj)/,$(targets))
87 modorder        := $(addprefix $(obj)/,$(modorder))
88 obj-m           := $(addprefix $(obj)/,$(obj-m))
89 lib-y           := $(addprefix $(obj)/,$(lib-y))
90 subdir-obj-y    := $(addprefix $(obj)/,$(subdir-obj-y))
91 real-obj-y      := $(addprefix $(obj)/,$(real-obj-y))
92 real-obj-m      := $(addprefix $(obj)/,$(real-obj-m))
93 multi-used-m    := $(addprefix $(obj)/,$(multi-used-m))
94 subdir-ym       := $(addprefix $(obj)/,$(subdir-ym))
95
96 # Finds the multi-part object the current object will be linked into.
97 # If the object belongs to two or more multi-part objects, all of them are
98 # concatenated with a colon separator.
99 modname-multi = $(subst $(space),:,$(sort $(foreach m,$(multi-used),\
100                 $(if $(filter $*.o, $($(m:.o=-objs)) $($(m:.o=-y)) $($(m:.o=-m))),$(m:.o=)))))
101
102 modname = $(if $(modname-multi),$(modname-multi),$(basetarget))
103
104 # These flags are needed for modversions and compiling, so we define them here
105 # $(modname_flags) defines KBUILD_MODNAME as the name of the module it will
106 # end up in (or would, if it gets compiled in)
107 name-fix = $(squote)$(quote)$(subst $(comma),_,$(subst -,_,$1))$(quote)$(squote)
108 basename_flags = -DKBUILD_BASENAME=$(call name-fix,$(basetarget))
109 modname_flags  = -DKBUILD_MODNAME=$(call name-fix,$(modname))
110
111 orig_c_flags   = $(KBUILD_CPPFLAGS) $(KBUILD_CFLAGS) \
112                  $(ccflags-y) $(CFLAGS_$(basetarget).o)
113 _c_flags       = $(filter-out $(CFLAGS_REMOVE_$(basetarget).o), $(orig_c_flags))
114 orig_a_flags   = $(KBUILD_CPPFLAGS) $(KBUILD_AFLAGS) \
115                  $(asflags-y) $(AFLAGS_$(basetarget).o)
116 _a_flags       = $(filter-out $(AFLAGS_REMOVE_$(basetarget).o), $(orig_a_flags))
117 _cpp_flags     = $(KBUILD_CPPFLAGS) $(cppflags-y) $(CPPFLAGS_$(@F))
118
119 #
120 # Enable gcov profiling flags for a file, directory or for all files depending
121 # on variables GCOV_PROFILE_obj.o, GCOV_PROFILE and CONFIG_GCOV_PROFILE_ALL
122 # (in this order)
123 #
124 ifeq ($(CONFIG_GCOV_KERNEL),y)
125 _c_flags += $(if $(patsubst n%,, \
126                 $(GCOV_PROFILE_$(basetarget).o)$(GCOV_PROFILE)$(CONFIG_GCOV_PROFILE_ALL)), \
127                 $(CFLAGS_GCOV))
128 endif
129
130 #
131 # Enable address sanitizer flags for kernel except some files or directories
132 # we don't want to check (depends on variables KASAN_SANITIZE_obj.o, KASAN_SANITIZE)
133 #
134 ifeq ($(CONFIG_KASAN),y)
135 _c_flags += $(if $(patsubst n%,, \
136                 $(KASAN_SANITIZE_$(basetarget).o)$(KASAN_SANITIZE)y), \
137                 $(CFLAGS_KASAN), $(CFLAGS_KASAN_NOSANITIZE))
138 endif
139
140 ifeq ($(CONFIG_UBSAN),y)
141 _c_flags += $(if $(patsubst n%,, \
142                 $(UBSAN_SANITIZE_$(basetarget).o)$(UBSAN_SANITIZE)$(CONFIG_UBSAN_SANITIZE_ALL)), \
143                 $(CFLAGS_UBSAN))
144 endif
145
146 ifeq ($(CONFIG_KCOV),y)
147 _c_flags += $(if $(patsubst n%,, \
148         $(KCOV_INSTRUMENT_$(basetarget).o)$(KCOV_INSTRUMENT)$(CONFIG_KCOV_INSTRUMENT_ALL)), \
149         $(CFLAGS_KCOV))
150 endif
151
152 # $(srctree)/$(src) for including checkin headers from generated source files
153 # $(objtree)/$(obj) for including generated headers from checkin source files
154 ifeq ($(KBUILD_EXTMOD),)
155 ifdef building_out_of_srctree
156 _c_flags   += -I $(srctree)/$(src) -I $(objtree)/$(obj)
157 _a_flags   += -I $(srctree)/$(src) -I $(objtree)/$(obj)
158 _cpp_flags += -I $(srctree)/$(src) -I $(objtree)/$(obj)
159 endif
160 endif
161
162 c_flags        = -Wp,-MD,$(depfile) $(NOSTDINC_FLAGS) $(LINUXINCLUDE)     \
163                  -include $(srctree)/include/linux/compiler_types.h       \
164                  $(_c_flags) $(modkern_cflags)                           \
165                  $(basename_flags) $(modname_flags)
166
167 a_flags        = -Wp,-MD,$(depfile) $(NOSTDINC_FLAGS) $(LINUXINCLUDE)     \
168                  $(_a_flags) $(modkern_aflags)
169
170 cpp_flags      = -Wp,-MD,$(depfile) $(NOSTDINC_FLAGS) $(LINUXINCLUDE)     \
171                  $(_cpp_flags)
172
173 ld_flags       = $(KBUILD_LDFLAGS) $(ldflags-y) $(LDFLAGS_$(@F))
174
175 DTC_INCLUDE    := $(srctree)/scripts/dtc/include-prefixes
176
177 dtc_cpp_flags  = -Wp,-MD,$(depfile).pre.tmp -nostdinc                    \
178                  $(addprefix -I,$(DTC_INCLUDE))                          \
179                  -undef -D__DTS__
180
181 # Useful for describing the dependency of composite objects
182 # Usage:
183 #   $(call multi_depend, multi_used_targets, suffix_to_remove, suffix_to_add)
184 define multi_depend
185 $(foreach m, $(notdir $1), \
186         $(eval $(obj)/$m: \
187         $(addprefix $(obj)/, $(foreach s, $3, $($(m:%$(strip $2)=%$(s)))))))
188 endef
189
190 # Shipped files
191 # ===========================================================================
192
193 quiet_cmd_shipped = SHIPPED $@
194 cmd_shipped = cat $< > $@
195
196 $(obj)/%: $(src)/%_shipped
197         $(call cmd,shipped)
198
199 # Commands useful for building a boot image
200 # ===========================================================================
201 #
202 #       Use as following:
203 #
204 #       target: source(s) FORCE
205 #               $(if_changed,ld/objcopy/gzip)
206 #
207 #       and add target to extra-y so that we know we have to
208 #       read in the saved command line
209
210 # Linking
211 # ---------------------------------------------------------------------------
212
213 quiet_cmd_ld = LD      $@
214       cmd_ld = $(LD) $(ld_flags) $(real-prereqs) -o $@
215
216 # Archive
217 # ---------------------------------------------------------------------------
218
219 quiet_cmd_ar = AR      $@
220       cmd_ar = rm -f $@; $(AR) rcsTP$(KBUILD_ARFLAGS) $@ $(real-prereqs)
221
222 # Objcopy
223 # ---------------------------------------------------------------------------
224
225 quiet_cmd_objcopy = OBJCOPY $@
226 cmd_objcopy = $(OBJCOPY) $(OBJCOPYFLAGS) $(OBJCOPYFLAGS_$(@F)) $< $@
227
228 # Gzip
229 # ---------------------------------------------------------------------------
230
231 quiet_cmd_gzip = GZIP    $@
232       cmd_gzip = cat $(real-prereqs) | gzip -n -f -9 > $@
233
234 # DTC
235 # ---------------------------------------------------------------------------
236 DTC ?= $(objtree)/scripts/dtc/dtc
237
238 # Disable noisy checks by default
239 ifeq ($(findstring 1,$(KBUILD_ENABLE_EXTRA_GCC_CHECKS)),)
240 DTC_FLAGS += -Wno-unit_address_vs_reg \
241         -Wno-unit_address_format \
242         -Wno-avoid_unnecessary_addr_size \
243         -Wno-alias_paths \
244         -Wno-graph_child_address \
245         -Wno-simple_bus_reg \
246         -Wno-unique_unit_address \
247         -Wno-pci_device_reg
248 endif
249
250 ifneq ($(findstring 2,$(KBUILD_ENABLE_EXTRA_GCC_CHECKS)),)
251 DTC_FLAGS += -Wnode_name_chars_strict \
252         -Wproperty_name_chars_strict
253 endif
254
255 DTC_FLAGS += $(DTC_FLAGS_$(basetarget))
256
257 # Generate an assembly file to wrap the output of the device tree compiler
258 quiet_cmd_dt_S_dtb= DTB     $@
259 cmd_dt_S_dtb=                                           \
260 {                                                       \
261         echo '\#include <asm-generic/vmlinux.lds.h>';   \
262         echo '.section .dtb.init.rodata,"a"';           \
263         echo '.balign STRUCT_ALIGNMENT';                \
264         echo '.global __dtb_$(subst -,_,$(*F))_begin';  \
265         echo '__dtb_$(subst -,_,$(*F))_begin:';         \
266         echo '.incbin "$<" ';                           \
267         echo '__dtb_$(subst -,_,$(*F))_end:';           \
268         echo '.global __dtb_$(subst -,_,$(*F))_end';    \
269         echo '.balign STRUCT_ALIGNMENT';                \
270 } > $@
271
272 $(obj)/%.dtb.S: $(obj)/%.dtb FORCE
273         $(call if_changed,dt_S_dtb)
274
275 quiet_cmd_dtc = DTC     $@
276 cmd_dtc = mkdir -p $(dir ${dtc-tmp}) ; \
277         $(HOSTCC) -E $(dtc_cpp_flags) -x assembler-with-cpp -o $(dtc-tmp) $< ; \
278         $(DTC) -O $(2) -o $@ -b 0 \
279                 $(addprefix -i,$(dir $<) $(DTC_INCLUDE)) $(DTC_FLAGS) \
280                 -d $(depfile).dtc.tmp $(dtc-tmp) ; \
281         cat $(depfile).pre.tmp $(depfile).dtc.tmp > $(depfile)
282
283 $(obj)/%.dtb: $(src)/%.dts $(DTC) FORCE
284         $(call if_changed_dep,dtc,dtb)
285
286 DT_CHECKER ?= dt-validate
287 DT_BINDING_DIR := Documentation/devicetree/bindings
288 DT_TMP_SCHEMA := $(objtree)/$(DT_BINDING_DIR)/processed-schema.yaml
289
290 quiet_cmd_dtb_check =   CHECK   $@
291       cmd_dtb_check =   $(DT_CHECKER) -u $(srctree)/$(DT_BINDING_DIR) -p $(DT_TMP_SCHEMA) $@ ;
292
293 define rule_dtc_dt_yaml
294         $(call cmd_and_fixdep,dtc,yaml)
295         $(call cmd,dtb_check)
296 endef
297
298 $(obj)/%.dt.yaml: $(src)/%.dts $(DTC) $(DT_TMP_SCHEMA) FORCE
299         $(call if_changed_rule,dtc_dt_yaml)
300
301 dtc-tmp = $(subst $(comma),_,$(dot-target).dts.tmp)
302
303 # Bzip2
304 # ---------------------------------------------------------------------------
305
306 # Bzip2 and LZMA do not include size in file... so we have to fake that;
307 # append the size as a 32-bit littleendian number as gzip does.
308 size_append = printf $(shell                                            \
309 dec_size=0;                                                             \
310 for F in $(real-prereqs); do                                    \
311         fsize=$$($(CONFIG_SHELL) $(srctree)/scripts/file-size.sh $$F);  \
312         dec_size=$$(expr $$dec_size + $$fsize);                         \
313 done;                                                                   \
314 printf "%08x\n" $$dec_size |                                            \
315         sed 's/\(..\)/\1 /g' | {                                        \
316                 read ch0 ch1 ch2 ch3;                                   \
317                 for ch in $$ch3 $$ch2 $$ch1 $$ch0; do                   \
318                         printf '%s%03o' '\\' $$((0x$$ch));              \
319                 done;                                                   \
320         }                                                               \
321 )
322
323 quiet_cmd_bzip2 = BZIP2   $@
324       cmd_bzip2 = { cat $(real-prereqs) | bzip2 -9; $(size_append); } > $@
325
326 # Lzma
327 # ---------------------------------------------------------------------------
328
329 quiet_cmd_lzma = LZMA    $@
330       cmd_lzma = { cat $(real-prereqs) | lzma -9; $(size_append); } > $@
331
332 quiet_cmd_lzo = LZO     $@
333       cmd_lzo = { cat $(real-prereqs) | lzop -9; $(size_append); } > $@
334
335 quiet_cmd_lz4 = LZ4     $@
336       cmd_lz4 = { cat $(real-prereqs) | lz4c -l -c1 stdin stdout; \
337                   $(size_append); } > $@
338
339 # U-Boot mkimage
340 # ---------------------------------------------------------------------------
341
342 MKIMAGE := $(srctree)/scripts/mkuboot.sh
343
344 # SRCARCH just happens to match slightly more than ARCH (on sparc), so reduces
345 # the number of overrides in arch makefiles
346 UIMAGE_ARCH ?= $(SRCARCH)
347 UIMAGE_COMPRESSION ?= $(if $(2),$(2),none)
348 UIMAGE_OPTS-y ?=
349 UIMAGE_TYPE ?= kernel
350 UIMAGE_LOADADDR ?= arch_must_set_this
351 UIMAGE_ENTRYADDR ?= $(UIMAGE_LOADADDR)
352 UIMAGE_NAME ?= 'Linux-$(KERNELRELEASE)'
353
354 quiet_cmd_uimage = UIMAGE  $@
355       cmd_uimage = $(CONFIG_SHELL) $(MKIMAGE) -A $(UIMAGE_ARCH) -O linux \
356                         -C $(UIMAGE_COMPRESSION) $(UIMAGE_OPTS-y) \
357                         -T $(UIMAGE_TYPE) \
358                         -a $(UIMAGE_LOADADDR) -e $(UIMAGE_ENTRYADDR) \
359                         -n $(UIMAGE_NAME) -d $< $@
360
361 # XZ
362 # ---------------------------------------------------------------------------
363 # Use xzkern to compress the kernel image and xzmisc to compress other things.
364 #
365 # xzkern uses a big LZMA2 dictionary since it doesn't increase memory usage
366 # of the kernel decompressor. A BCJ filter is used if it is available for
367 # the target architecture. xzkern also appends uncompressed size of the data
368 # using size_append. The .xz format has the size information available at
369 # the end of the file too, but it's in more complex format and it's good to
370 # avoid changing the part of the boot code that reads the uncompressed size.
371 # Note that the bytes added by size_append will make the xz tool think that
372 # the file is corrupt. This is expected.
373 #
374 # xzmisc doesn't use size_append, so it can be used to create normal .xz
375 # files. xzmisc uses smaller LZMA2 dictionary than xzkern, because a very
376 # big dictionary would increase the memory usage too much in the multi-call
377 # decompression mode. A BCJ filter isn't used either.
378 quiet_cmd_xzkern = XZKERN  $@
379       cmd_xzkern = { cat $(real-prereqs) | sh $(srctree)/scripts/xz_wrap.sh; \
380                      $(size_append); } > $@
381
382 quiet_cmd_xzmisc = XZMISC  $@
383       cmd_xzmisc = cat $(real-prereqs) | xz --check=crc32 --lzma2=dict=1MiB > $@
384
385 # ASM offsets
386 # ---------------------------------------------------------------------------
387
388 # Default sed regexp - multiline due to syntax constraints
389 #
390 # Use [:space:] because LLVM's integrated assembler inserts <tab> around
391 # the .ascii directive whereas GCC keeps the <space> as-is.
392 define sed-offsets
393         's:^[[:space:]]*\.ascii[[:space:]]*"\(.*\)".*:\1:; \
394         /^->/{s:->#\(.*\):/* \1 */:; \
395         s:^->\([^ ]*\) [\$$#]*\([^ ]*\) \(.*\):#define \1 \2 /* \3 */:; \
396         s:->::; p;}'
397 endef
398
399 # Use filechk to avoid rebuilds when a header changes, but the resulting file
400 # does not
401 define filechk_offsets
402          echo "#ifndef $2"; \
403          echo "#define $2"; \
404          echo "/*"; \
405          echo " * DO NOT MODIFY."; \
406          echo " *"; \
407          echo " * This file was generated by Kbuild"; \
408          echo " */"; \
409          echo ""; \
410          sed -ne $(sed-offsets) < $<; \
411          echo ""; \
412          echo "#endif"
413 endef