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