xref: /linux/rust/Makefile (revision 1260ed77798502de9c98020040d2995008de10cc)
1# SPDX-License-Identifier: GPL-2.0
2
3# Where to place rustdoc generated documentation
4rustdoc_output := $(objtree)/Documentation/output/rust/rustdoc
5
6obj-$(CONFIG_RUST) += core.o compiler_builtins.o ffi.o
7always-$(CONFIG_RUST) += exports_core_generated.h
8
9# Missing prototypes are expected in the helpers since these are exported
10# for Rust only, thus there is no header nor prototypes.
11obj-$(CONFIG_RUST) += helpers/helpers.o
12CFLAGS_REMOVE_helpers/helpers.o = -Wmissing-prototypes -Wmissing-declarations
13
14always-$(CONFIG_RUST) += bindings/bindings_generated.rs bindings/bindings_helpers_generated.rs
15obj-$(CONFIG_RUST) += bindings.o pin_init.o kernel.o
16always-$(CONFIG_RUST) += exports_helpers_generated.h \
17    exports_bindings_generated.h exports_kernel_generated.h
18
19always-$(CONFIG_RUST) += uapi/uapi_generated.rs
20obj-$(CONFIG_RUST) += uapi.o
21
22ifdef CONFIG_RUST_BUILD_ASSERT_ALLOW
23obj-$(CONFIG_RUST) += build_error.o
24else
25always-$(CONFIG_RUST) += build_error.o
26endif
27
28obj-$(CONFIG_RUST) += exports.o
29
30always-$(CONFIG_RUST_KERNEL_DOCTESTS) += doctests_kernel_generated.rs
31always-$(CONFIG_RUST_KERNEL_DOCTESTS) += doctests_kernel_generated_kunit.c
32
33obj-$(CONFIG_RUST_KERNEL_DOCTESTS) += doctests_kernel_generated.o
34obj-$(CONFIG_RUST_KERNEL_DOCTESTS) += doctests_kernel_generated_kunit.o
35
36always-$(subst y,$(CONFIG_RUST),$(CONFIG_JUMP_LABEL)) += kernel/generated_arch_static_branch_asm.rs
37
38# Avoids running `$(RUSTC)` when it may not be available.
39ifdef CONFIG_RUST
40
41libmacros_name := $(shell MAKEFLAGS= $(RUSTC) --print file-names --crate-name macros --crate-type proc-macro - </dev/null)
42libmacros_extension := $(patsubst libmacros.%,%,$(libmacros_name))
43
44libpin_init_internal_name := $(shell MAKEFLAGS= $(RUSTC) --print file-names --crate-name pin_init_internal --crate-type proc-macro - </dev/null)
45libpin_init_internal_extension := $(patsubst libpin_init_internal.%,%,$(libpin_init_internal_name))
46
47always-$(CONFIG_RUST) += $(libmacros_name) $(libpin_init_internal_name)
48
49# `$(rust_flags)` is passed in case the user added `--sysroot`.
50rustc_sysroot := $(shell MAKEFLAGS= $(RUSTC) $(rust_flags) --print sysroot)
51rustc_host_target := $(shell $(RUSTC) --version --verbose | grep -F 'host: ' | cut -d' ' -f2)
52RUST_LIB_SRC ?= $(rustc_sysroot)/lib/rustlib/src/rust/library
53
54ifneq ($(quiet),)
55rust_test_quiet=-q
56rustdoc_test_quiet=--test-args -q
57rustdoc_test_kernel_quiet=>/dev/null
58endif
59
60core-cfgs = \
61    --cfg no_fp_fmt_parse
62
63# `rustc` recognizes `--remap-path-prefix` since 1.26.0, but `rustdoc` only
64# since Rust 1.81.0. Moreover, `rustdoc` ICEs on out-of-tree builds since Rust
65# 1.82.0 (https://github.com/rust-lang/rust/issues/138520). Thus workaround both
66# issues skipping the flag. The former also applies to `RUSTDOC TK`.
67quiet_cmd_rustdoc = RUSTDOC $(if $(rustdoc_host),H, ) $<
68      cmd_rustdoc = \
69	OBJTREE=$(abspath $(objtree)) \
70	$(RUSTDOC) $(filter-out $(skip_flags) --remap-path-prefix=%,$(if $(rustdoc_host),$(rust_common_flags),$(rust_flags))) \
71		$(rustc_target_flags) -L$(objtree)/$(obj) \
72		-Zunstable-options --generate-link-to-definition \
73		--output $(rustdoc_output) \
74		--crate-name $(subst rustdoc-,,$@) \
75		$(if $(rustdoc_host),,--sysroot=/dev/null) \
76		@$(objtree)/include/generated/rustc_cfg $<
77
78# The `html_logo_url` and `html_favicon_url` forms of the `doc` attribute
79# can be used to specify a custom logo. However:
80#   - The given value is used as-is, thus it cannot be relative or a local file
81#     (unlike the non-custom case) since the generated docs have subfolders.
82#   - It requires adding it to every crate.
83#   - It requires changing `core` which comes from the sysroot.
84#
85# Using `-Zcrate-attr` would solve the last two points, but not the first.
86# The https://github.com/rust-lang/rfcs/pull/3226 RFC suggests two new
87# command-like flags to solve the issue. Meanwhile, we use the non-custom case
88# and then retouch the generated files.
89rustdoc: rustdoc-core rustdoc-macros rustdoc-compiler_builtins \
90    rustdoc-kernel rustdoc-pin_init
91	$(Q)cp $(srctree)/Documentation/images/logo.svg $(rustdoc_output)/static.files/
92	$(Q)cp $(srctree)/Documentation/images/COPYING-logo $(rustdoc_output)/static.files/
93	$(Q)find $(rustdoc_output) -name '*.html' -type f -print0 | xargs -0 sed -Ei \
94		-e 's:rust-logo-[0-9a-f]+\.svg:logo.svg:g' \
95		-e 's:favicon-[0-9a-f]+\.svg:logo.svg:g' \
96		-e 's:<link rel="alternate icon" type="image/png" href="[/.]+/static\.files/favicon-(16x16|32x32)-[0-9a-f]+\.png">::g' \
97		-e 's:<a href="srctree/([^"]+)">:<a href="$(realpath $(srctree))/\1">:g'
98	$(Q)for f in $(rustdoc_output)/static.files/rustdoc-*.css; do \
99		echo ".logo-container > img { object-fit: contain; }" >> $$f; done
100
101rustdoc-macros: private rustdoc_host = yes
102rustdoc-macros: private rustc_target_flags = --crate-type proc-macro \
103    --extern proc_macro
104rustdoc-macros: $(src)/macros/lib.rs FORCE
105	+$(call if_changed,rustdoc)
106
107# Starting with Rust 1.82.0, skipping `-Wrustdoc::unescaped_backticks` should
108# not be needed -- see https://github.com/rust-lang/rust/pull/128307.
109rustdoc-core: private skip_flags = -Wrustdoc::unescaped_backticks
110rustdoc-core: private rustc_target_flags = $(core-cfgs)
111rustdoc-core: $(RUST_LIB_SRC)/core/src/lib.rs FORCE
112	+$(call if_changed,rustdoc)
113
114rustdoc-compiler_builtins: $(src)/compiler_builtins.rs rustdoc-core FORCE
115	+$(call if_changed,rustdoc)
116
117rustdoc-ffi: $(src)/ffi.rs rustdoc-core FORCE
118	+$(call if_changed,rustdoc)
119
120rustdoc-pin_init_internal: private rustdoc_host = yes
121rustdoc-pin_init_internal: private rustc_target_flags = --cfg kernel \
122    --extern proc_macro --crate-type proc-macro
123rustdoc-pin_init_internal: $(src)/pin-init/internal/src/lib.rs FORCE
124	+$(call if_changed,rustdoc)
125
126rustdoc-pin_init: private rustdoc_host = yes
127rustdoc-pin_init: private rustc_target_flags = --extern pin_init_internal \
128    --extern macros --extern alloc --cfg kernel --cfg feature=\"alloc\"
129rustdoc-pin_init: $(src)/pin-init/src/lib.rs rustdoc-pin_init_internal \
130    rustdoc-macros FORCE
131	+$(call if_changed,rustdoc)
132
133rustdoc-kernel: private rustc_target_flags = --extern ffi --extern pin_init \
134    --extern build_error --extern macros \
135    --extern bindings --extern uapi
136rustdoc-kernel: $(src)/kernel/lib.rs rustdoc-core rustdoc-ffi rustdoc-macros \
137    rustdoc-pin_init rustdoc-compiler_builtins $(obj)/$(libmacros_name) \
138    $(obj)/bindings.o FORCE
139	+$(call if_changed,rustdoc)
140
141quiet_cmd_rustc_test_library = $(RUSTC_OR_CLIPPY_QUIET) TL $<
142      cmd_rustc_test_library = \
143	OBJTREE=$(abspath $(objtree)) \
144	$(RUSTC_OR_CLIPPY) $(rust_common_flags) \
145		@$(objtree)/include/generated/rustc_cfg $(rustc_target_flags) \
146		--crate-type $(if $(rustc_test_library_proc),proc-macro,rlib) \
147		--out-dir $(objtree)/$(obj)/test --cfg testlib \
148		-L$(objtree)/$(obj)/test \
149		--crate-name $(subst rusttest-,,$(subst rusttestlib-,,$@)) $<
150
151rusttestlib-build_error: $(src)/build_error.rs FORCE
152	+$(call if_changed,rustc_test_library)
153
154rusttestlib-ffi: $(src)/ffi.rs FORCE
155	+$(call if_changed,rustc_test_library)
156
157rusttestlib-macros: private rustc_target_flags = --extern proc_macro
158rusttestlib-macros: private rustc_test_library_proc = yes
159rusttestlib-macros: $(src)/macros/lib.rs FORCE
160	+$(call if_changed,rustc_test_library)
161
162rusttestlib-pin_init_internal: private rustc_target_flags = --cfg kernel \
163    --extern proc_macro
164rusttestlib-pin_init_internal: private rustc_test_library_proc = yes
165rusttestlib-pin_init_internal: $(src)/pin-init/internal/src/lib.rs FORCE
166	+$(call if_changed,rustc_test_library)
167
168rusttestlib-pin_init: private rustc_target_flags = --extern pin_init_internal \
169    --extern macros --cfg kernel
170rusttestlib-pin_init: $(src)/pin-init/src/lib.rs rusttestlib-macros \
171    rusttestlib-pin_init_internal $(obj)/$(libpin_init_internal_name) FORCE
172	+$(call if_changed,rustc_test_library)
173
174rusttestlib-kernel: private rustc_target_flags = --extern ffi \
175    --extern build_error --extern macros --extern pin_init \
176    --extern bindings --extern uapi
177rusttestlib-kernel: $(src)/kernel/lib.rs rusttestlib-bindings rusttestlib-uapi \
178    rusttestlib-build_error rusttestlib-pin_init $(obj)/$(libmacros_name) \
179    $(obj)/bindings.o FORCE
180	+$(call if_changed,rustc_test_library)
181
182rusttestlib-bindings: private rustc_target_flags = --extern ffi
183rusttestlib-bindings: $(src)/bindings/lib.rs rusttestlib-ffi FORCE
184	+$(call if_changed,rustc_test_library)
185
186rusttestlib-uapi: private rustc_target_flags = --extern ffi
187rusttestlib-uapi: $(src)/uapi/lib.rs rusttestlib-ffi FORCE
188	+$(call if_changed,rustc_test_library)
189
190quiet_cmd_rustdoc_test = RUSTDOC T $<
191      cmd_rustdoc_test = \
192	RUST_MODFILE=test.rs \
193	OBJTREE=$(abspath $(objtree)) \
194	$(RUSTDOC) --test $(rust_common_flags) \
195		@$(objtree)/include/generated/rustc_cfg \
196		$(rustc_target_flags) $(rustdoc_test_target_flags) \
197		$(rustdoc_test_quiet) \
198		-L$(objtree)/$(obj)/test --output $(rustdoc_output) \
199		--crate-name $(subst rusttest-,,$@) $<
200
201quiet_cmd_rustdoc_test_kernel = RUSTDOC TK $<
202      cmd_rustdoc_test_kernel = \
203	rm -rf $(objtree)/$(obj)/test/doctests/kernel; \
204	mkdir -p $(objtree)/$(obj)/test/doctests/kernel; \
205	OBJTREE=$(abspath $(objtree)) \
206	$(RUSTDOC) --test $(filter-out --remap-path-prefix=%,$(rust_flags)) \
207		-L$(objtree)/$(obj) --extern ffi --extern pin_init \
208		--extern kernel --extern build_error --extern macros \
209		--extern bindings --extern uapi \
210		--no-run --crate-name kernel -Zunstable-options \
211		--sysroot=/dev/null \
212		--test-builder $(objtree)/scripts/rustdoc_test_builder \
213		$< $(rustdoc_test_kernel_quiet); \
214	$(objtree)/scripts/rustdoc_test_gen
215
216%/doctests_kernel_generated.rs %/doctests_kernel_generated_kunit.c: \
217    $(src)/kernel/lib.rs $(obj)/kernel.o \
218    $(objtree)/scripts/rustdoc_test_builder \
219    $(objtree)/scripts/rustdoc_test_gen FORCE
220	+$(call if_changed,rustdoc_test_kernel)
221
222# We cannot use `-Zpanic-abort-tests` because some tests are dynamic,
223# so for the moment we skip `-Cpanic=abort`.
224quiet_cmd_rustc_test = $(RUSTC_OR_CLIPPY_QUIET) T  $<
225      cmd_rustc_test = \
226	OBJTREE=$(abspath $(objtree)) \
227	$(RUSTC_OR_CLIPPY) --test $(rust_common_flags) \
228		@$(objtree)/include/generated/rustc_cfg \
229		$(rustc_target_flags) --out-dir $(objtree)/$(obj)/test \
230		-L$(objtree)/$(obj)/test \
231		--crate-name $(subst rusttest-,,$@) $<; \
232	$(objtree)/$(obj)/test/$(subst rusttest-,,$@) $(rust_test_quiet) \
233		$(rustc_test_run_flags)
234
235rusttest: rusttest-macros rusttest-kernel
236
237rusttest-macros: private rustc_target_flags = --extern proc_macro \
238	--extern macros --extern kernel --extern pin_init
239rusttest-macros: private rustdoc_test_target_flags = --crate-type proc-macro
240rusttest-macros: $(src)/macros/lib.rs \
241    rusttestlib-macros rusttestlib-kernel rusttestlib-pin_init FORCE
242	+$(call if_changed,rustc_test)
243	+$(call if_changed,rustdoc_test)
244
245rusttest-kernel: private rustc_target_flags = --extern ffi --extern pin_init \
246    --extern build_error --extern macros --extern bindings --extern uapi
247rusttest-kernel: $(src)/kernel/lib.rs rusttestlib-ffi rusttestlib-kernel \
248    rusttestlib-build_error rusttestlib-macros rusttestlib-bindings \
249    rusttestlib-uapi rusttestlib-pin_init FORCE
250	+$(call if_changed,rustc_test)
251
252ifdef CONFIG_CC_IS_CLANG
253bindgen_c_flags = $(c_flags)
254else
255# bindgen relies on libclang to parse C. Ideally, bindgen would support a GCC
256# plugin backend and/or the Clang driver would be perfectly compatible with GCC.
257#
258# For the moment, here we are tweaking the flags on the fly. This is a hack,
259# and some kernel configurations may not work (e.g. `GCC_PLUGIN_RANDSTRUCT`
260# if we end up using one of those structs).
261bindgen_skip_c_flags := -mno-fp-ret-in-387 -mpreferred-stack-boundary=% \
262	-mskip-rax-setup -mgeneral-regs-only -msign-return-address=% \
263	-mindirect-branch=thunk-extern -mindirect-branch-register \
264	-mfunction-return=thunk-extern -mrecord-mcount -mabi=lp64 \
265	-mindirect-branch-cs-prefix -mstack-protector-guard% -mtraceback=no \
266	-mno-pointers-to-nested-functions -mno-string \
267	-mno-strict-align -mstrict-align -mdirect-extern-access \
268	-mexplicit-relocs -mno-check-zero-division \
269	-fconserve-stack -falign-jumps=% -falign-loops=% \
270	-femit-struct-debug-baseonly -fno-ipa-cp-clone -fno-ipa-sra \
271	-fno-partial-inlining -fplugin-arg-arm_ssp_per_task_plugin-% \
272	-fno-reorder-blocks -fno-allow-store-data-races -fasan-shadow-offset=% \
273	-fzero-call-used-regs=% -fno-stack-clash-protection \
274	-fno-inline-functions-called-once -fsanitize=bounds-strict \
275	-fstrict-flex-arrays=% -fmin-function-alignment=% \
276	-fzero-init-padding-bits=% \
277	--param=% --param asan-%
278
279# Derived from `scripts/Makefile.clang`.
280BINDGEN_TARGET_x86	:= x86_64-linux-gnu
281BINDGEN_TARGET_arm64	:= aarch64-linux-gnu
282BINDGEN_TARGET_arm	:= arm-linux-gnueabi
283BINDGEN_TARGET_loongarch	:= loongarch64-linux-gnusf
284BINDGEN_TARGET_um	:= $(BINDGEN_TARGET_$(SUBARCH))
285BINDGEN_TARGET		:= $(BINDGEN_TARGET_$(SRCARCH))
286
287# All warnings are inhibited since GCC builds are very experimental,
288# many GCC warnings are not supported by Clang, they may only appear in
289# some configurations, with new GCC versions, etc.
290bindgen_extra_c_flags = -w --target=$(BINDGEN_TARGET)
291
292# Auto variable zero-initialization requires an additional special option with
293# clang that is going to be removed sometime in the future (likely in
294# clang-18), so make sure to pass this option only if clang supports it
295# (libclang major version < 16).
296#
297# https://github.com/llvm/llvm-project/issues/44842
298# https://github.com/llvm/llvm-project/blob/llvmorg-16.0.0-rc2/clang/docs/ReleaseNotes.rst#deprecated-compiler-flags
299ifdef CONFIG_INIT_STACK_ALL_ZERO
300libclang_maj_ver=$(shell $(BINDGEN) $(srctree)/scripts/rust_is_available_bindgen_libclang.h 2>&1 | sed -ne 's/.*clang version \([0-9]*\).*/\1/p')
301ifeq ($(shell expr $(libclang_maj_ver) \< 16), 1)
302bindgen_extra_c_flags += -enable-trivial-auto-var-init-zero-knowing-it-will-be-removed-from-clang
303endif
304endif
305
306bindgen_c_flags = $(filter-out $(bindgen_skip_c_flags), $(c_flags)) \
307	$(bindgen_extra_c_flags)
308endif
309
310ifdef CONFIG_LTO
311bindgen_c_flags_lto = $(filter-out $(CC_FLAGS_LTO), $(bindgen_c_flags))
312else
313bindgen_c_flags_lto = $(bindgen_c_flags)
314endif
315
316# `-fno-builtin` is passed to avoid `bindgen` from using `clang` builtin
317# prototypes for functions like `memcpy` -- if this flag is not passed,
318# `bindgen`-generated prototypes use `c_ulong` or `c_uint` depending on
319# architecture instead of generating `usize`.
320bindgen_c_flags_final = $(bindgen_c_flags_lto) -fno-builtin -D__BINDGEN__
321
322# Each `bindgen` release may upgrade the list of Rust target versions. By
323# default, the highest stable release in their list is used. Thus we need to set
324# a `--rust-target` to avoid future `bindgen` releases emitting code that
325# `rustc` may not understand. On top of that, `bindgen` does not support passing
326# an unknown Rust target version.
327#
328# Therefore, the Rust target for `bindgen` can be only as high as the minimum
329# Rust version the kernel supports and only as high as the greatest stable Rust
330# target supported by the minimum `bindgen` version the kernel supports (that
331# is, if we do not test the actual `rustc`/`bindgen` versions running).
332#
333# Starting with `bindgen` 0.71.0, we will be able to set any future Rust version
334# instead, i.e. we will be able to set here our minimum supported Rust version.
335quiet_cmd_bindgen = BINDGEN $@
336      cmd_bindgen = \
337	$(BINDGEN) $< $(bindgen_target_flags) --rust-target 1.68 \
338		--use-core --with-derive-default --ctypes-prefix ffi --no-layout-tests \
339		--no-debug '.*' --enable-function-attribute-detection \
340		-o $@ -- $(bindgen_c_flags_final) -DMODULE \
341		$(bindgen_target_cflags) $(bindgen_target_extra)
342
343$(obj)/bindings/bindings_generated.rs: private bindgen_target_flags = \
344    $(shell grep -Ev '^#|^$$' $(src)/bindgen_parameters)
345$(obj)/bindings/bindings_generated.rs: private bindgen_target_extra = ; \
346    sed -Ei 's/pub const RUST_CONST_HELPER_([a-zA-Z0-9_]*)/pub const \1/g' $@
347$(obj)/bindings/bindings_generated.rs: $(src)/bindings/bindings_helper.h \
348    $(src)/bindgen_parameters FORCE
349	$(call if_changed_dep,bindgen)
350
351$(obj)/uapi/uapi_generated.rs: private bindgen_target_flags = \
352    $(shell grep -Ev '^#|^$$' $(src)/bindgen_parameters)
353$(obj)/uapi/uapi_generated.rs: $(src)/uapi/uapi_helper.h \
354    $(src)/bindgen_parameters FORCE
355	$(call if_changed_dep,bindgen)
356
357# See `CFLAGS_REMOVE_helpers.o` above. In addition, Clang on C does not warn
358# with `-Wmissing-declarations` (unlike GCC), so it is not strictly needed here
359# given it is `libclang`; but for consistency, future Clang changes and/or
360# a potential future GCC backend for `bindgen`, we disable it too.
361$(obj)/bindings/bindings_helpers_generated.rs: private bindgen_target_flags = \
362    --blocklist-type '.*' --allowlist-var '' \
363    --allowlist-function 'rust_helper_.*'
364$(obj)/bindings/bindings_helpers_generated.rs: private bindgen_target_cflags = \
365    -I$(objtree)/$(obj) -Wno-missing-prototypes -Wno-missing-declarations
366$(obj)/bindings/bindings_helpers_generated.rs: private bindgen_target_extra = ; \
367    sed -Ei 's/pub fn rust_helper_([a-zA-Z0-9_]*)/#[link_name="rust_helper_\1"]\n    pub fn \1/g' $@
368$(obj)/bindings/bindings_helpers_generated.rs: $(src)/helpers/helpers.c FORCE
369	$(call if_changed_dep,bindgen)
370
371rust_exports = $(NM) -p --defined-only $(1) | awk '$$2~/(T|R|D|B)/ && $$3!~/__cfi/ && $$3!~/__odr_asan/ { printf $(2),$$3 }'
372
373quiet_cmd_exports = EXPORTS $@
374      cmd_exports = \
375	$(call rust_exports,$<,"EXPORT_SYMBOL_RUST_GPL(%s);\n") > $@
376
377$(obj)/exports_core_generated.h: $(obj)/core.o FORCE
378	$(call if_changed,exports)
379
380# Even though Rust kernel modules should never use the bindings directly,
381# symbols from the `bindings` crate and the C helpers need to be exported
382# because Rust generics and inlined functions may not get their code generated
383# in the crate where they are defined. Other helpers, called from non-inline
384# functions, may not be exported, in principle. However, in general, the Rust
385# compiler does not guarantee codegen will be performed for a non-inline
386# function either. Therefore, we export all symbols from helpers and bindings.
387# In the future, this may be revisited to reduce the number of exports after
388# the compiler is informed about the places codegen is required.
389$(obj)/exports_helpers_generated.h: $(obj)/helpers/helpers.o FORCE
390	$(call if_changed,exports)
391
392$(obj)/exports_bindings_generated.h: $(obj)/bindings.o FORCE
393	$(call if_changed,exports)
394
395$(obj)/exports_kernel_generated.h: $(obj)/kernel.o FORCE
396	$(call if_changed,exports)
397
398quiet_cmd_rustc_procmacro = $(RUSTC_OR_CLIPPY_QUIET) P $@
399      cmd_rustc_procmacro = \
400	$(RUSTC_OR_CLIPPY) $(rust_common_flags) $(rustc_target_flags) \
401		-Clinker-flavor=gcc -Clinker=$(HOSTCC) \
402		-Clink-args='$(call escsq,$(KBUILD_PROCMACROLDFLAGS))' \
403		--emit=dep-info=$(depfile) --emit=link=$@ --extern proc_macro \
404		--crate-type proc-macro \
405		--crate-name $(patsubst lib%.$(libmacros_extension),%,$(notdir $@)) $<
406
407# Procedural macros can only be used with the `rustc` that compiled it.
408$(obj)/$(libmacros_name): $(src)/macros/lib.rs FORCE
409	+$(call if_changed_dep,rustc_procmacro)
410
411$(obj)/$(libpin_init_internal_name): private rustc_target_flags = --cfg kernel
412$(obj)/$(libpin_init_internal_name): $(src)/pin-init/internal/src/lib.rs FORCE
413	+$(call if_changed_dep,rustc_procmacro)
414
415quiet_cmd_rustc_library = $(if $(skip_clippy),RUSTC,$(RUSTC_OR_CLIPPY_QUIET)) L $@
416      cmd_rustc_library = \
417	OBJTREE=$(abspath $(objtree)) \
418	$(if $(skip_clippy),$(RUSTC),$(RUSTC_OR_CLIPPY)) \
419		$(filter-out $(skip_flags),$(rust_flags) $(rustc_target_flags)) \
420		--emit=dep-info=$(depfile) --emit=obj=$@ \
421		--emit=metadata=$(dir $@)$(patsubst %.o,lib%.rmeta,$(notdir $@)) \
422		--crate-type rlib -L$(objtree)/$(obj) \
423		--crate-name $(patsubst %.o,%,$(notdir $@)) $< \
424		--sysroot=/dev/null \
425	$(if $(rustc_objcopy),;$(OBJCOPY) $(rustc_objcopy) $@) \
426	$(cmd_objtool)
427
428rust-analyzer:
429	$(Q)MAKEFLAGS= $(srctree)/scripts/generate_rust_analyzer.py \
430		--cfgs='core=$(core-cfgs)' \
431		$(realpath $(srctree)) $(realpath $(objtree)) \
432		$(rustc_sysroot) $(RUST_LIB_SRC) $(if $(KBUILD_EXTMOD),$(srcroot)) \
433		> rust-project.json
434
435redirect-intrinsics = \
436	__addsf3 __eqsf2 __extendsfdf2 __gesf2 __lesf2 __ltsf2 __mulsf3 __nesf2 __truncdfsf2 __unordsf2 \
437	__adddf3 __eqdf2 __ledf2 __ltdf2 __muldf3 __unorddf2 \
438	__muloti4 __multi3 \
439	__udivmodti4 __udivti3 __umodti3
440
441ifdef CONFIG_ARM
442	# Add eabi initrinsics for ARM 32-bit
443	redirect-intrinsics += \
444		__aeabi_fadd __aeabi_fmul __aeabi_fcmpeq __aeabi_fcmple __aeabi_fcmplt __aeabi_fcmpun \
445		__aeabi_dadd __aeabi_dmul __aeabi_dcmple __aeabi_dcmplt __aeabi_dcmpun \
446		__aeabi_uldivmod
447endif
448ifneq ($(or $(CONFIG_ARM64),$(and $(CONFIG_RISCV),$(CONFIG_64BIT))),)
449	# These intrinsics are defined for ARM64 and RISCV64
450	redirect-intrinsics += \
451		__ashrti3 \
452		__ashlti3 __lshrti3
453endif
454
455ifdef CONFIG_MODVERSIONS
456cmd_gendwarfksyms = $(if $(skip_gendwarfksyms),, \
457	$(call rust_exports,$@,"%s\n") | \
458	scripts/gendwarfksyms/gendwarfksyms \
459		$(if $(KBUILD_GENDWARFKSYMS_STABLE), --stable) \
460		$(if $(KBUILD_SYMTYPES), --symtypes $(@:.o=.symtypes),) \
461		$@ >> $(dot-target).cmd)
462endif
463
464define rule_rustc_library
465	$(call cmd_and_fixdep,rustc_library)
466	$(call cmd,gen_objtooldep)
467	$(call cmd,gendwarfksyms)
468endef
469
470define rule_rust_cc_library
471	$(call if_changed_rule,cc_o_c)
472	$(call cmd,force_checksrc)
473	$(call cmd,gendwarfksyms)
474endef
475
476# helpers.o uses the same export mechanism as Rust libraries, so ensure symbol
477# versions are calculated for the helpers too.
478$(obj)/helpers/helpers.o: $(src)/helpers/helpers.c $(recordmcount_source) FORCE
479	+$(call if_changed_rule,rust_cc_library)
480
481# Disable symbol versioning for exports.o to avoid conflicts with the actual
482# symbol versions generated from Rust objects.
483$(obj)/exports.o: private skip_gendwarfksyms = 1
484
485$(obj)/core.o: private skip_clippy = 1
486$(obj)/core.o: private skip_flags = -Wunreachable_pub
487$(obj)/core.o: private rustc_objcopy = $(foreach sym,$(redirect-intrinsics),--redefine-sym $(sym)=__rust$(sym))
488$(obj)/core.o: private rustc_target_flags = $(core-cfgs)
489$(obj)/core.o: $(RUST_LIB_SRC)/core/src/lib.rs \
490    $(wildcard $(objtree)/include/config/RUSTC_VERSION_TEXT) FORCE
491	+$(call if_changed_rule,rustc_library)
492ifneq ($(or $(CONFIG_X86_64),$(CONFIG_X86_32)),)
493$(obj)/core.o: scripts/target.json
494endif
495
496$(obj)/compiler_builtins.o: private skip_gendwarfksyms = 1
497$(obj)/compiler_builtins.o: private rustc_objcopy = -w -W '__*'
498$(obj)/compiler_builtins.o: $(src)/compiler_builtins.rs $(obj)/core.o FORCE
499	+$(call if_changed_rule,rustc_library)
500
501$(obj)/pin_init.o: private skip_gendwarfksyms = 1
502$(obj)/pin_init.o: private rustc_target_flags = --extern pin_init_internal \
503    --extern macros --cfg kernel
504$(obj)/pin_init.o: $(src)/pin-init/src/lib.rs $(obj)/compiler_builtins.o \
505    $(obj)/$(libpin_init_internal_name) $(obj)/$(libmacros_name) FORCE
506	+$(call if_changed_rule,rustc_library)
507
508$(obj)/build_error.o: private skip_gendwarfksyms = 1
509$(obj)/build_error.o: $(src)/build_error.rs $(obj)/compiler_builtins.o FORCE
510	+$(call if_changed_rule,rustc_library)
511
512$(obj)/ffi.o: private skip_gendwarfksyms = 1
513$(obj)/ffi.o: $(src)/ffi.rs $(obj)/compiler_builtins.o FORCE
514	+$(call if_changed_rule,rustc_library)
515
516$(obj)/bindings.o: private rustc_target_flags = --extern ffi
517$(obj)/bindings.o: $(src)/bindings/lib.rs \
518    $(obj)/ffi.o \
519    $(obj)/bindings/bindings_generated.rs \
520    $(obj)/bindings/bindings_helpers_generated.rs FORCE
521	+$(call if_changed_rule,rustc_library)
522
523$(obj)/uapi.o: private rustc_target_flags = --extern ffi
524$(obj)/uapi.o: private skip_gendwarfksyms = 1
525$(obj)/uapi.o: $(src)/uapi/lib.rs \
526    $(obj)/ffi.o \
527    $(obj)/uapi/uapi_generated.rs FORCE
528	+$(call if_changed_rule,rustc_library)
529
530$(obj)/kernel.o: private rustc_target_flags = --extern ffi --extern pin_init \
531    --extern build_error --extern macros --extern bindings --extern uapi
532$(obj)/kernel.o: $(src)/kernel/lib.rs $(obj)/build_error.o $(obj)/pin_init.o \
533    $(obj)/$(libmacros_name) $(obj)/bindings.o $(obj)/uapi.o FORCE
534	+$(call if_changed_rule,rustc_library)
535
536ifdef CONFIG_JUMP_LABEL
537$(obj)/kernel.o: $(obj)/kernel/generated_arch_static_branch_asm.rs
538endif
539
540endif # CONFIG_RUST
541