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