xref: /linux-6.15/scripts/link-vmlinux.sh (revision a8e35fec)
1#!/bin/sh
2# SPDX-License-Identifier: GPL-2.0
3#
4# link vmlinux
5#
6# vmlinux is linked from the objects selected by $(KBUILD_VMLINUX_OBJS) and
7# $(KBUILD_VMLINUX_LIBS). Most are built-in.a files from top-level directories
8# in the kernel tree, others are specified in arch/$(ARCH)/Makefile.
9# $(KBUILD_VMLINUX_LIBS) are archives which are linked conditionally
10# (not within --whole-archive), and do not require symbol indexes added.
11#
12# vmlinux
13#   ^
14#   |
15#   +--< $(KBUILD_VMLINUX_OBJS)
16#   |    +--< init/built-in.a drivers/built-in.a mm/built-in.a + more
17#   |
18#   +--< $(KBUILD_VMLINUX_LIBS)
19#   |    +--< lib/lib.a + more
20#   |
21#   +-< ${kallsymso} (see description in KALLSYMS section)
22#
23# vmlinux version (uname -v) cannot be updated during normal
24# descending-into-subdirs phase since we do not yet know if we need to
25# update vmlinux.
26# Therefore this step is delayed until just before final link of vmlinux.
27#
28# System.map is generated to document addresses of all kernel symbols
29
30# Error out on error
31set -e
32
33LD="$1"
34KBUILD_LDFLAGS="$2"
35LDFLAGS_vmlinux="$3"
36
37is_enabled() {
38	grep -q "^$1=y" include/config/auto.conf
39}
40
41# Nice output in kbuild format
42# Will be supressed by "make -s"
43info()
44{
45	printf "  %-7s %s\n" "${1}" "${2}"
46}
47
48# Generate a linker script to ensure correct ordering of initcalls.
49gen_initcalls()
50{
51	info GEN .tmp_initcalls.lds
52
53	${PYTHON3} ${srctree}/scripts/jobserver-exec		\
54	${PERL} ${srctree}/scripts/generate_initcall_order.pl	\
55		${KBUILD_VMLINUX_OBJS} ${KBUILD_VMLINUX_LIBS}	\
56		> .tmp_initcalls.lds
57}
58
59# If CONFIG_LTO_CLANG is selected, collect generated symbol versions into
60# .tmp_symversions.lds
61gen_symversions()
62{
63	info GEN .tmp_symversions.lds
64	rm -f .tmp_symversions.lds
65
66	for o in ${KBUILD_VMLINUX_OBJS} ${KBUILD_VMLINUX_LIBS}; do
67		if [ -f ${o}.symversions ]; then
68			cat ${o}.symversions >> .tmp_symversions.lds
69		fi
70	done
71}
72
73# Link of vmlinux.o used for section mismatch analysis
74# ${1} output file
75modpost_link()
76{
77	local objects
78	local lds=""
79
80	objects="--whole-archive				\
81		${KBUILD_VMLINUX_OBJS}				\
82		--no-whole-archive				\
83		--start-group					\
84		${KBUILD_VMLINUX_LIBS}				\
85		--end-group"
86
87	if is_enabled CONFIG_LTO_CLANG; then
88		gen_initcalls
89		lds="-T .tmp_initcalls.lds"
90
91		if is_enabled CONFIG_MODVERSIONS; then
92			gen_symversions
93			lds="${lds} -T .tmp_symversions.lds"
94		fi
95
96		# This might take a while, so indicate that we're doing
97		# an LTO link
98		info LTO ${1}
99	else
100		info LD ${1}
101	fi
102
103	${LD} ${KBUILD_LDFLAGS} -r -o ${1} ${lds} ${objects}
104}
105
106objtool_link()
107{
108	local objtoolcmd;
109	local objtoolopt;
110
111	if ! is_enabled CONFIG_OBJTOOL; then
112		return;
113	fi
114
115	if is_enabled CONFIG_LTO_CLANG || is_enabled CONFIG_X86_KERNEL_IBT; then
116
117		# For LTO and IBT, objtool doesn't run on individual
118		# translation units.  Run everything on vmlinux instead.
119
120		if is_enabled CONFIG_HAVE_JUMP_LABEL_HACK; then
121			objtoolopt="${objtoolopt} --hacks=jump_label"
122		fi
123
124		if is_enabled CONFIG_HAVE_NOINSTR_HACK; then
125			objtoolopt="${objtoolopt} --hacks=noinstr"
126		fi
127
128		if is_enabled CONFIG_X86_KERNEL_IBT; then
129			objtoolopt="${objtoolopt} --ibt"
130		fi
131
132		if is_enabled CONFIG_FTRACE_MCOUNT_USE_OBJTOOL; then
133			objtoolopt="${objtoolopt} --mcount"
134		fi
135
136		if is_enabled CONFIG_UNWINDER_ORC; then
137			objtoolopt="${objtoolopt} --orc"
138		fi
139
140		if is_enabled CONFIG_RETPOLINE; then
141			objtoolopt="${objtoolopt} --retpoline"
142		fi
143
144		if is_enabled CONFIG_SLS; then
145			objtoolopt="${objtoolopt} --sls"
146		fi
147
148		if is_enabled CONFIG_STACK_VALIDATION; then
149			objtoolopt="${objtoolopt} --stackval"
150		fi
151
152		if is_enabled CONFIG_HAVE_STATIC_CALL_INLINE; then
153			objtoolopt="${objtoolopt} --static-call"
154		fi
155
156		if is_enabled CONFIG_X86_SMAP; then
157			objtoolopt="${objtoolopt} --uaccess"
158		fi
159	fi
160
161	if is_enabled CONFIG_NOINSTR_VALIDATION; then
162		objtoolopt="${objtoolopt} --noinstr"
163	fi
164
165	if [ -n "${objtoolopt}" ]; then
166
167		if is_enabled CONFIG_GCOV_KERNEL; then
168			objtoolopt="${objtoolopt} --no-unreachable"
169		fi
170
171		objtoolopt="${objtoolopt} --link"
172
173		info OBJTOOL ${1}
174		tools/objtool/objtool ${objtoolopt} ${1}
175	fi
176}
177
178# Link of vmlinux
179# ${1} - output file
180# ${2}, ${3}, ... - optional extra .o files
181vmlinux_link()
182{
183	local output=${1}
184	local objs
185	local libs
186	local ld
187	local ldflags
188	local ldlibs
189
190	info LD ${output}
191
192	# skip output file argument
193	shift
194
195	if is_enabled CONFIG_LTO_CLANG || is_enabled CONFIG_X86_KERNEL_IBT; then
196		# Use vmlinux.o instead of performing the slow LTO link again.
197		objs=vmlinux.o
198		libs=
199	else
200		objs="${KBUILD_VMLINUX_OBJS}"
201		libs="${KBUILD_VMLINUX_LIBS}"
202	fi
203
204	if [ "${SRCARCH}" = "um" ]; then
205		wl=-Wl,
206		ld="${CC}"
207		ldflags="${CFLAGS_vmlinux}"
208		ldlibs="-lutil -lrt -lpthread"
209	else
210		wl=
211		ld="${LD}"
212		ldflags="${KBUILD_LDFLAGS} ${LDFLAGS_vmlinux}"
213		ldlibs=
214	fi
215
216	ldflags="${ldflags} ${wl}--script=${objtree}/${KBUILD_LDS}"
217
218	# The kallsyms linking does not need debug symbols included.
219	if [ "$output" != "${output#.tmp_vmlinux.kallsyms}" ] ; then
220		ldflags="${ldflags} ${wl}--strip-debug"
221	fi
222
223	if is_enabled CONFIG_VMLINUX_MAP; then
224		ldflags="${ldflags} ${wl}-Map=${output}.map"
225	fi
226
227	${ld} ${ldflags} -o ${output}					\
228		${wl}--whole-archive ${objs} ${wl}--no-whole-archive	\
229		${wl}--start-group ${libs} ${wl}--end-group		\
230		$@ ${ldlibs}
231}
232
233# generate .BTF typeinfo from DWARF debuginfo
234# ${1} - vmlinux image
235# ${2} - file to dump raw BTF data into
236gen_btf()
237{
238	local pahole_ver
239
240	if ! [ -x "$(command -v ${PAHOLE})" ]; then
241		echo >&2 "BTF: ${1}: pahole (${PAHOLE}) is not available"
242		return 1
243	fi
244
245	pahole_ver=$(${PAHOLE} --version | sed -E 's/v([0-9]+)\.([0-9]+)/\1\2/')
246	if [ "${pahole_ver}" -lt "116" ]; then
247		echo >&2 "BTF: ${1}: pahole version $(${PAHOLE} --version) is too old, need at least v1.16"
248		return 1
249	fi
250
251	vmlinux_link ${1}
252
253	info "BTF" ${2}
254	LLVM_OBJCOPY="${OBJCOPY}" ${PAHOLE} -J ${PAHOLE_FLAGS} ${1}
255
256	# Create ${2} which contains just .BTF section but no symbols. Add
257	# SHF_ALLOC because .BTF will be part of the vmlinux image. --strip-all
258	# deletes all symbols including __start_BTF and __stop_BTF, which will
259	# be redefined in the linker script. Add 2>/dev/null to suppress GNU
260	# objcopy warnings: "empty loadable segment detected at ..."
261	${OBJCOPY} --only-section=.BTF --set-section-flags .BTF=alloc,readonly \
262		--strip-all ${1} ${2} 2>/dev/null
263	# Change e_type to ET_REL so that it can be used to link final vmlinux.
264	# Unlike GNU ld, lld does not allow an ET_EXEC input.
265	printf '\1' | dd of=${2} conv=notrunc bs=1 seek=16 status=none
266}
267
268# Create ${2} .S file with all symbols from the ${1} object file
269kallsyms()
270{
271	local kallsymopt;
272
273	if is_enabled CONFIG_KALLSYMS_ALL; then
274		kallsymopt="${kallsymopt} --all-symbols"
275	fi
276
277	if is_enabled CONFIG_KALLSYMS_ABSOLUTE_PERCPU; then
278		kallsymopt="${kallsymopt} --absolute-percpu"
279	fi
280
281	if is_enabled CONFIG_KALLSYMS_BASE_RELATIVE; then
282		kallsymopt="${kallsymopt} --base-relative"
283	fi
284
285	info KSYMS ${2}
286	${NM} -n ${1} | scripts/kallsyms ${kallsymopt} > ${2}
287}
288
289# Perform one step in kallsyms generation, including temporary linking of
290# vmlinux.
291kallsyms_step()
292{
293	kallsymso_prev=${kallsymso}
294	kallsyms_vmlinux=.tmp_vmlinux.kallsyms${1}
295	kallsymso=${kallsyms_vmlinux}.o
296	kallsyms_S=${kallsyms_vmlinux}.S
297
298	vmlinux_link ${kallsyms_vmlinux} "${kallsymso_prev}" ${btf_vmlinux_bin_o}
299	kallsyms ${kallsyms_vmlinux} ${kallsyms_S}
300
301	info AS ${kallsyms_S}
302	${CC} ${NOSTDINC_FLAGS} ${LINUXINCLUDE} ${KBUILD_CPPFLAGS} \
303	      ${KBUILD_AFLAGS} ${KBUILD_AFLAGS_KERNEL} \
304	      -c -o ${kallsymso} ${kallsyms_S}
305}
306
307# Create map file with all symbols from ${1}
308# See mksymap for additional details
309mksysmap()
310{
311	${CONFIG_SHELL} "${srctree}/scripts/mksysmap" ${1} ${2}
312}
313
314sorttable()
315{
316	${objtree}/scripts/sorttable ${1}
317}
318
319# Delete output files in case of error
320cleanup()
321{
322	rm -f .btf.*
323	rm -f .tmp_System.map
324	rm -f .tmp_initcalls.lds
325	rm -f .tmp_symversions.lds
326	rm -f .tmp_vmlinux*
327	rm -f System.map
328	rm -f vmlinux
329	rm -f vmlinux.map
330	rm -f vmlinux.o
331	rm -f .vmlinux.d
332}
333
334# Use "make V=1" to debug this script
335case "${KBUILD_VERBOSE}" in
336*1*)
337	set -x
338	;;
339esac
340
341if [ "$1" = "clean" ]; then
342	cleanup
343	exit 0
344fi
345
346# Update version
347info GEN .version
348if [ -r .version ]; then
349	VERSION=$(expr 0$(cat .version) + 1)
350	echo $VERSION > .version
351else
352	rm -f .version
353	echo 1 > .version
354fi;
355
356# final build of init/
357${MAKE} -f "${srctree}/scripts/Makefile.build" obj=init need-builtin=1
358
359#link vmlinux.o
360modpost_link vmlinux.o
361objtool_link vmlinux.o
362
363# modpost vmlinux.o to check for section mismatches
364${MAKE} -f "${srctree}/scripts/Makefile.modpost" MODPOST_VMLINUX=1
365
366info MODINFO modules.builtin.modinfo
367${OBJCOPY} -j .modinfo -O binary vmlinux.o modules.builtin.modinfo
368info GEN modules.builtin
369# The second line aids cases where multiple modules share the same object.
370tr '\0' '\n' < modules.builtin.modinfo | sed -n 's/^[[:alnum:]:_]*\.file=//p' |
371	tr ' ' '\n' | uniq | sed -e 's:^:kernel/:' -e 's/$/.ko/' > modules.builtin
372
373btf_vmlinux_bin_o=""
374if is_enabled CONFIG_DEBUG_INFO_BTF; then
375	btf_vmlinux_bin_o=.btf.vmlinux.bin.o
376	if ! gen_btf .tmp_vmlinux.btf $btf_vmlinux_bin_o ; then
377		echo >&2 "Failed to generate BTF for vmlinux"
378		echo >&2 "Try to disable CONFIG_DEBUG_INFO_BTF"
379		exit 1
380	fi
381fi
382
383kallsymso=""
384kallsymso_prev=""
385kallsyms_vmlinux=""
386if is_enabled CONFIG_KALLSYMS; then
387
388	# kallsyms support
389	# Generate section listing all symbols and add it into vmlinux
390	# It's a three step process:
391	# 1)  Link .tmp_vmlinux.kallsyms1 so it has all symbols and sections,
392	#     but __kallsyms is empty.
393	#     Running kallsyms on that gives us .tmp_kallsyms1.o with
394	#     the right size
395	# 2)  Link .tmp_vmlinux.kallsyms2 so it now has a __kallsyms section of
396	#     the right size, but due to the added section, some
397	#     addresses have shifted.
398	#     From here, we generate a correct .tmp_vmlinux.kallsyms2.o
399	# 3)  That link may have expanded the kernel image enough that
400	#     more linker branch stubs / trampolines had to be added, which
401	#     introduces new names, which further expands kallsyms. Do another
402	#     pass if that is the case. In theory it's possible this results
403	#     in even more stubs, but unlikely.
404	#     KALLSYMS_EXTRA_PASS=1 may also used to debug or work around
405	#     other bugs.
406	# 4)  The correct ${kallsymso} is linked into the final vmlinux.
407	#
408	# a)  Verify that the System.map from vmlinux matches the map from
409	#     ${kallsymso}.
410
411	kallsyms_step 1
412	kallsyms_step 2
413
414	# step 3
415	size1=$(${CONFIG_SHELL} "${srctree}/scripts/file-size.sh" ${kallsymso_prev})
416	size2=$(${CONFIG_SHELL} "${srctree}/scripts/file-size.sh" ${kallsymso})
417
418	if [ $size1 -ne $size2 ] || [ -n "${KALLSYMS_EXTRA_PASS}" ]; then
419		kallsyms_step 3
420	fi
421fi
422
423vmlinux_link vmlinux "${kallsymso}" ${btf_vmlinux_bin_o}
424
425# fill in BTF IDs
426if is_enabled CONFIG_DEBUG_INFO_BTF && is_enabled CONFIG_BPF; then
427	info BTFIDS vmlinux
428	${RESOLVE_BTFIDS} vmlinux
429fi
430
431info SYSMAP System.map
432mksysmap vmlinux System.map
433
434if is_enabled CONFIG_BUILDTIME_TABLE_SORT; then
435	info SORTTAB vmlinux
436	if ! sorttable vmlinux; then
437		echo >&2 Failed to sort kernel tables
438		exit 1
439	fi
440fi
441
442# step a (see comment above)
443if is_enabled CONFIG_KALLSYMS; then
444	mksysmap ${kallsyms_vmlinux} .tmp_System.map
445
446	if ! cmp -s System.map .tmp_System.map; then
447		echo >&2 Inconsistent kallsyms data
448		echo >&2 Try "make KALLSYMS_EXTRA_PASS=1" as a workaround
449		exit 1
450	fi
451fi
452
453# For fixdep
454echo "vmlinux: $0" > .vmlinux.d
455