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