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