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