12f7ab126SMiguel Ojeda# SPDX-License-Identifier: GPL-2.0 22f7ab126SMiguel Ojeda 348fadf44SCarlos Bilbao# Where to place rustdoc generated documentation 448fadf44SCarlos Bilbaorustdoc_output := $(objtree)/Documentation/output/rust/rustdoc 548fadf44SCarlos Bilbao 6d072acdaSGary Guoobj-$(CONFIG_RUST) += core.o compiler_builtins.o ffi.o 72f7ab126SMiguel Ojedaalways-$(CONFIG_RUST) += exports_core_generated.h 82f7ab126SMiguel Ojeda 92f7ab126SMiguel Ojeda# Missing prototypes are expected in the helpers since these are exported 102f7ab126SMiguel Ojeda# for Rust only, thus there is no header nor prototypes. 1187634653SAndreas Hindborgobj-$(CONFIG_RUST) += helpers/helpers.o 1287634653SAndreas HindborgCFLAGS_REMOVE_helpers/helpers.o = -Wmissing-prototypes -Wmissing-declarations 132f7ab126SMiguel Ojeda 142f7ab126SMiguel Ojedaalways-$(CONFIG_RUST) += bindings/bindings_generated.rs bindings/bindings_helpers_generated.rs 15392e34b6SDanilo Krummrichobj-$(CONFIG_RUST) += bindings.o kernel.o 16392e34b6SDanilo Krummrichalways-$(CONFIG_RUST) += exports_helpers_generated.h \ 17e26fa546SGary Guo exports_bindings_generated.h exports_kernel_generated.h 182f7ab126SMiguel Ojeda 194e174665SAsahi Linaalways-$(CONFIG_RUST) += uapi/uapi_generated.rs 204e174665SAsahi Linaobj-$(CONFIG_RUST) += uapi.o 214e174665SAsahi Lina 22ecaa6ddfSGary Guoifdef CONFIG_RUST_BUILD_ASSERT_ALLOW 23ecaa6ddfSGary Guoobj-$(CONFIG_RUST) += build_error.o 24ecaa6ddfSGary Guoelse 25ecaa6ddfSGary Guoalways-$(CONFIG_RUST) += build_error.o 26ecaa6ddfSGary Guoendif 27ecaa6ddfSGary Guo 282f7ab126SMiguel Ojedaobj-$(CONFIG_RUST) += exports.o 292f7ab126SMiguel Ojeda 30a66d733dSMiguel Ojedaalways-$(CONFIG_RUST_KERNEL_DOCTESTS) += doctests_kernel_generated.rs 31a66d733dSMiguel Ojedaalways-$(CONFIG_RUST_KERNEL_DOCTESTS) += doctests_kernel_generated_kunit.c 32a66d733dSMiguel Ojeda 33a66d733dSMiguel Ojedaobj-$(CONFIG_RUST_KERNEL_DOCTESTS) += doctests_kernel_generated.o 34a66d733dSMiguel Ojedaobj-$(CONFIG_RUST_KERNEL_DOCTESTS) += doctests_kernel_generated_kunit.o 35a66d733dSMiguel Ojeda 368af7a501SMiguel Ojedaalways-$(subst y,$(CONFIG_RUST),$(CONFIG_JUMP_LABEL)) += kernel/generated_arch_static_branch_asm.rs 37169484abSAlice Ryhl 380730422bSTamir Duberstein# Avoids running `$(RUSTC)` when it may not be available. 392f7ab126SMiguel Ojedaifdef CONFIG_RUST 402f7ab126SMiguel Ojeda 410730422bSTamir Dubersteinlibmacros_name := $(shell MAKEFLAGS= $(RUSTC) --print file-names --crate-name macros --crate-type proc-macro - </dev/null) 420730422bSTamir Dubersteinlibmacros_extension := $(patsubst libmacros.%,%,$(libmacros_name)) 430730422bSTamir Duberstein 440730422bSTamir Dubersteinalways-$(CONFIG_RUST) += $(libmacros_name) 450730422bSTamir Duberstein 462f7ab126SMiguel Ojeda# `$(rust_flags)` is passed in case the user added `--sysroot`. 47ecab4115SMiguel Ojedarustc_sysroot := $(shell MAKEFLAGS= $(RUSTC) $(rust_flags) --print sysroot) 482f7ab126SMiguel Ojedarustc_host_target := $(shell $(RUSTC) --version --verbose | grep -F 'host: ' | cut -d' ' -f2) 492f7ab126SMiguel OjedaRUST_LIB_SRC ?= $(rustc_sysroot)/lib/rustlib/src/rust/library 502f7ab126SMiguel Ojeda 519ffc80c8SMiguel Ojedaifneq ($(quiet),) 522f7ab126SMiguel Ojedarust_test_quiet=-q 532f7ab126SMiguel Ojedarustdoc_test_quiet=--test-args -q 54a66d733dSMiguel Ojedarustdoc_test_kernel_quiet=>/dev/null 552f7ab126SMiguel Ojedaendif 562f7ab126SMiguel Ojeda 572f7ab126SMiguel Ojedacore-cfgs = \ 582f7ab126SMiguel Ojeda --cfg no_fp_fmt_parse 592f7ab126SMiguel Ojeda 60*2c8725c1SMiguel Ojeda# `rustc` recognizes `--remap-path-prefix` since 1.26.0, but `rustdoc` only 61*2c8725c1SMiguel Ojeda# since Rust 1.81.0. Moreover, `rustdoc` ICEs on out-of-tree builds since Rust 62*2c8725c1SMiguel Ojeda# 1.82.0 (https://github.com/rust-lang/rust/issues/138520). Thus workaround both 63*2c8725c1SMiguel Ojeda# issues skipping the flag. The former also applies to `RUSTDOC TK`. 642f7ab126SMiguel Ojedaquiet_cmd_rustdoc = RUSTDOC $(if $(rustdoc_host),H, ) $< 652f7ab126SMiguel Ojeda cmd_rustdoc = \ 662f7ab126SMiguel Ojeda OBJTREE=$(abspath $(objtree)) \ 67*2c8725c1SMiguel Ojeda $(RUSTDOC) $(filter-out $(skip_flags) --remap-path-prefix=%,$(if $(rustdoc_host),$(rust_common_flags),$(rust_flags))) \ 682f7ab126SMiguel Ojeda $(rustc_target_flags) -L$(objtree)/$(obj) \ 696e6efc5fSMiguel Ojeda -Zunstable-options --generate-link-to-definition \ 7048fadf44SCarlos Bilbao --output $(rustdoc_output) \ 712f7ab126SMiguel Ojeda --crate-name $(subst rustdoc-,,$@) \ 7271479eeeSMatthew Maurer $(if $(rustdoc_host),,--sysroot=/dev/null) \ 732f7ab126SMiguel Ojeda @$(objtree)/include/generated/rustc_cfg $< 742f7ab126SMiguel Ojeda 752f7ab126SMiguel Ojeda# The `html_logo_url` and `html_favicon_url` forms of the `doc` attribute 762f7ab126SMiguel Ojeda# can be used to specify a custom logo. However: 772f7ab126SMiguel Ojeda# - The given value is used as-is, thus it cannot be relative or a local file 782f7ab126SMiguel Ojeda# (unlike the non-custom case) since the generated docs have subfolders. 792f7ab126SMiguel Ojeda# - It requires adding it to every crate. 802f7ab126SMiguel Ojeda# - It requires changing `core` which comes from the sysroot. 812f7ab126SMiguel Ojeda# 822f7ab126SMiguel Ojeda# Using `-Zcrate-attr` would solve the last two points, but not the first. 832f7ab126SMiguel Ojeda# The https://github.com/rust-lang/rfcs/pull/3226 RFC suggests two new 842f7ab126SMiguel Ojeda# command-like flags to solve the issue. Meanwhile, we use the non-custom case 852f7ab126SMiguel Ojeda# and then retouch the generated files. 862f7ab126SMiguel Ojedarustdoc: rustdoc-core rustdoc-macros rustdoc-compiler_builtins \ 87392e34b6SDanilo Krummrich rustdoc-kernel 88cfd96726SMiguel Ojeda $(Q)cp $(srctree)/Documentation/images/logo.svg $(rustdoc_output)/static.files/ 89cfd96726SMiguel Ojeda $(Q)cp $(srctree)/Documentation/images/COPYING-logo $(rustdoc_output)/static.files/ 9048fadf44SCarlos Bilbao $(Q)find $(rustdoc_output) -name '*.html' -type f -print0 | xargs -0 sed -Ei \ 91cfd96726SMiguel Ojeda -e 's:rust-logo-[0-9a-f]+\.svg:logo.svg:g' \ 92cfd96726SMiguel Ojeda -e 's:favicon-[0-9a-f]+\.svg:logo.svg:g' \ 93bc2e7d5cSMiguel Ojeda -e 's:<link rel="alternate icon" type="image/png" href="[/.]+/static\.files/favicon-(16x16|32x32)-[0-9a-f]+\.png">::g' \ 94e2bad142SMasahiro Yamada -e 's:<a href="srctree/([^"]+)">:<a href="$(realpath $(srctree))/\1">:g' 95cfd96726SMiguel Ojeda $(Q)for f in $(rustdoc_output)/static.files/rustdoc-*.css; do \ 96cfd96726SMiguel Ojeda echo ".logo-container > img { object-fit: contain; }" >> $$f; done 972f7ab126SMiguel Ojeda 982f7ab126SMiguel Ojedarustdoc-macros: private rustdoc_host = yes 992f7ab126SMiguel Ojedarustdoc-macros: private rustc_target_flags = --crate-type proc-macro \ 1002f7ab126SMiguel Ojeda --extern proc_macro 1012f7ab126SMiguel Ojedarustdoc-macros: $(src)/macros/lib.rs FORCE 102ecab4115SMiguel Ojeda +$(call if_changed,rustdoc) 1032f7ab126SMiguel Ojeda 104bef83245SMiguel Ojeda# Starting with Rust 1.82.0, skipping `-Wrustdoc::unescaped_backticks` should 105bef83245SMiguel Ojeda# not be needed -- see https://github.com/rust-lang/rust/pull/128307. 106bef83245SMiguel Ojedarustdoc-core: private skip_flags = -Wrustdoc::unescaped_backticks 1072f7ab126SMiguel Ojedarustdoc-core: private rustc_target_flags = $(core-cfgs) 1082f7ab126SMiguel Ojedarustdoc-core: $(RUST_LIB_SRC)/core/src/lib.rs FORCE 109ecab4115SMiguel Ojeda +$(call if_changed,rustdoc) 1102f7ab126SMiguel Ojeda 1112f7ab126SMiguel Ojedarustdoc-compiler_builtins: $(src)/compiler_builtins.rs rustdoc-core FORCE 112ecab4115SMiguel Ojeda +$(call if_changed,rustdoc) 1132f7ab126SMiguel Ojeda 114d072acdaSGary Guorustdoc-ffi: $(src)/ffi.rs rustdoc-core FORCE 115ecab4115SMiguel Ojeda +$(call if_changed,rustdoc) 1162f7ab126SMiguel Ojeda 117d072acdaSGary Guorustdoc-kernel: private rustc_target_flags = --extern ffi \ 1180730422bSTamir Duberstein --extern build_error --extern macros \ 1194e174665SAsahi Lina --extern bindings --extern uapi 120d072acdaSGary Guorustdoc-kernel: $(src)/kernel/lib.rs rustdoc-core rustdoc-ffi rustdoc-macros \ 1210730422bSTamir Duberstein rustdoc-compiler_builtins $(obj)/$(libmacros_name) \ 1222f7ab126SMiguel Ojeda $(obj)/bindings.o FORCE 123ecab4115SMiguel Ojeda +$(call if_changed,rustdoc) 1242f7ab126SMiguel Ojeda 1252a87f8b0SMiguel Ojedaquiet_cmd_rustc_test_library = $(RUSTC_OR_CLIPPY_QUIET) TL $< 1262f7ab126SMiguel Ojeda cmd_rustc_test_library = \ 1272f7ab126SMiguel Ojeda OBJTREE=$(abspath $(objtree)) \ 1282a87f8b0SMiguel Ojeda $(RUSTC_OR_CLIPPY) $(rust_common_flags) \ 1292f7ab126SMiguel Ojeda @$(objtree)/include/generated/rustc_cfg $(rustc_target_flags) \ 1302f7ab126SMiguel Ojeda --crate-type $(if $(rustc_test_library_proc),proc-macro,rlib) \ 1312f7ab126SMiguel Ojeda --out-dir $(objtree)/$(obj)/test --cfg testlib \ 1322f7ab126SMiguel Ojeda -L$(objtree)/$(obj)/test \ 1332f7ab126SMiguel Ojeda --crate-name $(subst rusttest-,,$(subst rusttestlib-,,$@)) $< 1342f7ab126SMiguel Ojeda 1359ffc80c8SMiguel Ojedarusttestlib-build_error: $(src)/build_error.rs FORCE 136ecab4115SMiguel Ojeda +$(call if_changed,rustc_test_library) 137ecaa6ddfSGary Guo 138d072acdaSGary Guorusttestlib-ffi: $(src)/ffi.rs FORCE 139d072acdaSGary Guo +$(call if_changed,rustc_test_library) 140d072acdaSGary Guo 1412f7ab126SMiguel Ojedarusttestlib-macros: private rustc_target_flags = --extern proc_macro 1422f7ab126SMiguel Ojedarusttestlib-macros: private rustc_test_library_proc = yes 1439ffc80c8SMiguel Ojedarusttestlib-macros: $(src)/macros/lib.rs FORCE 144ecab4115SMiguel Ojeda +$(call if_changed,rustc_test_library) 1452f7ab126SMiguel Ojeda 146d072acdaSGary Guorusttestlib-kernel: private rustc_target_flags = --extern ffi \ 147b2c261faSEthan D. Twardy --extern build_error --extern macros \ 148b2c261faSEthan D. Twardy --extern bindings --extern uapi 149b2c261faSEthan D. Twardyrusttestlib-kernel: $(src)/kernel/lib.rs \ 150b2c261faSEthan D. Twardy rusttestlib-bindings rusttestlib-uapi rusttestlib-build_error \ 151b1749432STamir Duberstein $(obj)/$(libmacros_name) $(obj)/bindings.o FORCE 152ecab4115SMiguel Ojeda +$(call if_changed,rustc_test_library) 1532f7ab126SMiguel Ojeda 154d072acdaSGary Guorusttestlib-bindings: private rustc_target_flags = --extern ffi 155d072acdaSGary Guorusttestlib-bindings: $(src)/bindings/lib.rs rusttestlib-ffi FORCE 1562f7ab126SMiguel Ojeda +$(call if_changed,rustc_test_library) 1572f7ab126SMiguel Ojeda 158d072acdaSGary Guorusttestlib-uapi: private rustc_target_flags = --extern ffi 159d072acdaSGary Guorusttestlib-uapi: $(src)/uapi/lib.rs rusttestlib-ffi FORCE 160ecab4115SMiguel Ojeda +$(call if_changed,rustc_test_library) 1614e174665SAsahi Lina 1622f7ab126SMiguel Ojedaquiet_cmd_rustdoc_test = RUSTDOC T $< 1632f7ab126SMiguel Ojeda cmd_rustdoc_test = \ 1648d3f5079SEthan D. Twardy RUST_MODFILE=test.rs \ 1652f7ab126SMiguel Ojeda OBJTREE=$(abspath $(objtree)) \ 1662f7ab126SMiguel Ojeda $(RUSTDOC) --test $(rust_common_flags) \ 1672f7ab126SMiguel Ojeda @$(objtree)/include/generated/rustc_cfg \ 1682f7ab126SMiguel Ojeda $(rustc_target_flags) $(rustdoc_test_target_flags) \ 1699ffc80c8SMiguel Ojeda $(rustdoc_test_quiet) \ 17048fadf44SCarlos Bilbao -L$(objtree)/$(obj)/test --output $(rustdoc_output) \ 1712f7ab126SMiguel Ojeda --crate-name $(subst rusttest-,,$@) $< 1722f7ab126SMiguel Ojeda 173a66d733dSMiguel Ojedaquiet_cmd_rustdoc_test_kernel = RUSTDOC TK $< 174a66d733dSMiguel Ojeda cmd_rustdoc_test_kernel = \ 175a66d733dSMiguel Ojeda rm -rf $(objtree)/$(obj)/test/doctests/kernel; \ 176a66d733dSMiguel Ojeda mkdir -p $(objtree)/$(obj)/test/doctests/kernel; \ 177a66d733dSMiguel Ojeda OBJTREE=$(abspath $(objtree)) \ 178*2c8725c1SMiguel Ojeda $(RUSTDOC) --test $(filter-out --remap-path-prefix=%,$(rust_flags)) \ 179d072acdaSGary Guo -L$(objtree)/$(obj) --extern ffi --extern kernel \ 180a66d733dSMiguel Ojeda --extern build_error --extern macros \ 181a66d733dSMiguel Ojeda --extern bindings --extern uapi \ 182a66d733dSMiguel Ojeda --no-run --crate-name kernel -Zunstable-options \ 18371479eeeSMatthew Maurer --sysroot=/dev/null \ 184a66d733dSMiguel Ojeda --test-builder $(objtree)/scripts/rustdoc_test_builder \ 185a66d733dSMiguel Ojeda $< $(rustdoc_test_kernel_quiet); \ 186a66d733dSMiguel Ojeda $(objtree)/scripts/rustdoc_test_gen 187a66d733dSMiguel Ojeda 188a66d733dSMiguel Ojeda%/doctests_kernel_generated.rs %/doctests_kernel_generated_kunit.c: \ 189a66d733dSMiguel Ojeda $(src)/kernel/lib.rs $(obj)/kernel.o \ 190a66d733dSMiguel Ojeda $(objtree)/scripts/rustdoc_test_builder \ 191a66d733dSMiguel Ojeda $(objtree)/scripts/rustdoc_test_gen FORCE 192ecab4115SMiguel Ojeda +$(call if_changed,rustdoc_test_kernel) 193a66d733dSMiguel Ojeda 1942f7ab126SMiguel Ojeda# We cannot use `-Zpanic-abort-tests` because some tests are dynamic, 1952f7ab126SMiguel Ojeda# so for the moment we skip `-Cpanic=abort`. 1962a87f8b0SMiguel Ojedaquiet_cmd_rustc_test = $(RUSTC_OR_CLIPPY_QUIET) T $< 1972f7ab126SMiguel Ojeda cmd_rustc_test = \ 1982f7ab126SMiguel Ojeda OBJTREE=$(abspath $(objtree)) \ 1992a87f8b0SMiguel Ojeda $(RUSTC_OR_CLIPPY) --test $(rust_common_flags) \ 2002f7ab126SMiguel Ojeda @$(objtree)/include/generated/rustc_cfg \ 2012f7ab126SMiguel Ojeda $(rustc_target_flags) --out-dir $(objtree)/$(obj)/test \ 2022f7ab126SMiguel Ojeda -L$(objtree)/$(obj)/test \ 2032f7ab126SMiguel Ojeda --crate-name $(subst rusttest-,,$@) $<; \ 2042f7ab126SMiguel Ojeda $(objtree)/$(obj)/test/$(subst rusttest-,,$@) $(rust_test_quiet) \ 2052f7ab126SMiguel Ojeda $(rustc_test_run_flags) 2062f7ab126SMiguel Ojeda 2072f7ab126SMiguel Ojedarusttest: rusttest-macros rusttest-kernel 2082f7ab126SMiguel Ojeda 209b2c261faSEthan D. Twardyrusttest-macros: private rustc_target_flags = --extern proc_macro \ 210b2c261faSEthan D. Twardy --extern macros --extern kernel 2112f7ab126SMiguel Ojedarusttest-macros: private rustdoc_test_target_flags = --crate-type proc-macro 212b2c261faSEthan D. Twardyrusttest-macros: $(src)/macros/lib.rs \ 213b2c261faSEthan D. Twardy rusttestlib-macros rusttestlib-kernel FORCE 214ecab4115SMiguel Ojeda +$(call if_changed,rustc_test) 215ecab4115SMiguel Ojeda +$(call if_changed,rustdoc_test) 2162f7ab126SMiguel Ojeda 217d072acdaSGary Guorusttest-kernel: private rustc_target_flags = --extern ffi \ 2184e174665SAsahi Lina --extern build_error --extern macros --extern bindings --extern uapi 219d072acdaSGary Guorusttest-kernel: $(src)/kernel/lib.rs rusttestlib-ffi rusttestlib-kernel \ 2204e174665SAsahi Lina rusttestlib-build_error rusttestlib-macros rusttestlib-bindings \ 2214e174665SAsahi Lina rusttestlib-uapi FORCE 222ecab4115SMiguel Ojeda +$(call if_changed,rustc_test) 2232f7ab126SMiguel Ojeda 2242f7ab126SMiguel Ojedaifdef CONFIG_CC_IS_CLANG 2252f7ab126SMiguel Ojedabindgen_c_flags = $(c_flags) 2262f7ab126SMiguel Ojedaelse 2272f7ab126SMiguel Ojeda# bindgen relies on libclang to parse C. Ideally, bindgen would support a GCC 2282f7ab126SMiguel Ojeda# plugin backend and/or the Clang driver would be perfectly compatible with GCC. 2292f7ab126SMiguel Ojeda# 2302f7ab126SMiguel Ojeda# For the moment, here we are tweaking the flags on the fly. This is a hack, 2312f7ab126SMiguel Ojeda# and some kernel configurations may not work (e.g. `GCC_PLUGIN_RANDSTRUCT` 2322f7ab126SMiguel Ojeda# if we end up using one of those structs). 2332f7ab126SMiguel Ojedabindgen_skip_c_flags := -mno-fp-ret-in-387 -mpreferred-stack-boundary=% \ 2342f7ab126SMiguel Ojeda -mskip-rax-setup -mgeneral-regs-only -msign-return-address=% \ 2352f7ab126SMiguel Ojeda -mindirect-branch=thunk-extern -mindirect-branch-register \ 2362f7ab126SMiguel Ojeda -mfunction-return=thunk-extern -mrecord-mcount -mabi=lp64 \ 2372f7ab126SMiguel Ojeda -mindirect-branch-cs-prefix -mstack-protector-guard% -mtraceback=no \ 2382f7ab126SMiguel Ojeda -mno-pointers-to-nested-functions -mno-string \ 2392f7ab126SMiguel Ojeda -mno-strict-align -mstrict-align \ 2402f7ab126SMiguel Ojeda -fconserve-stack -falign-jumps=% -falign-loops=% \ 2412f7ab126SMiguel Ojeda -femit-struct-debug-baseonly -fno-ipa-cp-clone -fno-ipa-sra \ 2422f7ab126SMiguel Ojeda -fno-partial-inlining -fplugin-arg-arm_ssp_per_task_plugin-% \ 2432f7ab126SMiguel Ojeda -fno-reorder-blocks -fno-allow-store-data-races -fasan-shadow-offset=% \ 2442f7ab126SMiguel Ojeda -fzero-call-used-regs=% -fno-stack-clash-protection \ 245b0554488SAndrea Righi -fno-inline-functions-called-once -fsanitize=bounds-strict \ 246869b5016SZehui Xu -fstrict-flex-arrays=% -fmin-function-alignment=% \ 247a9c621a2SJustin M. Forbes -fzero-init-padding-bits=% \ 2482f7ab126SMiguel Ojeda --param=% --param asan-% 2492f7ab126SMiguel Ojeda 2502f7ab126SMiguel Ojeda# Derived from `scripts/Makefile.clang`. 2512f7ab126SMiguel OjedaBINDGEN_TARGET_x86 := x86_64-linux-gnu 252724a75acSJamie CunliffeBINDGEN_TARGET_arm64 := aarch64-linux-gnu 2532f7ab126SMiguel OjedaBINDGEN_TARGET := $(BINDGEN_TARGET_$(SRCARCH)) 2542f7ab126SMiguel Ojeda 2552f7ab126SMiguel Ojeda# All warnings are inhibited since GCC builds are very experimental, 2562f7ab126SMiguel Ojeda# many GCC warnings are not supported by Clang, they may only appear in 2572f7ab126SMiguel Ojeda# some configurations, with new GCC versions, etc. 2582f7ab126SMiguel Ojedabindgen_extra_c_flags = -w --target=$(BINDGEN_TARGET) 2592f7ab126SMiguel Ojeda 260d966c3caSAndrea Righi# Auto variable zero-initialization requires an additional special option with 261d966c3caSAndrea Righi# clang that is going to be removed sometime in the future (likely in 262d966c3caSAndrea Righi# clang-18), so make sure to pass this option only if clang supports it 263d966c3caSAndrea Righi# (libclang major version < 16). 264d966c3caSAndrea Righi# 265d966c3caSAndrea Righi# https://github.com/llvm/llvm-project/issues/44842 266d966c3caSAndrea Righi# https://github.com/llvm/llvm-project/blob/llvmorg-16.0.0-rc2/clang/docs/ReleaseNotes.rst#deprecated-compiler-flags 267d966c3caSAndrea Righiifdef CONFIG_INIT_STACK_ALL_ZERO 268d966c3caSAndrea Righilibclang_maj_ver=$(shell $(BINDGEN) $(srctree)/scripts/rust_is_available_bindgen_libclang.h 2>&1 | sed -ne 's/.*clang version \([0-9]*\).*/\1/p') 269d966c3caSAndrea Righiifeq ($(shell expr $(libclang_maj_ver) \< 16), 1) 270d966c3caSAndrea Righibindgen_extra_c_flags += -enable-trivial-auto-var-init-zero-knowing-it-will-be-removed-from-clang 271d966c3caSAndrea Righiendif 272d966c3caSAndrea Righiendif 273d966c3caSAndrea Righi 2742f7ab126SMiguel Ojedabindgen_c_flags = $(filter-out $(bindgen_skip_c_flags), $(c_flags)) \ 2752f7ab126SMiguel Ojeda $(bindgen_extra_c_flags) 2762f7ab126SMiguel Ojedaendif 2772f7ab126SMiguel Ojeda 2782f7ab126SMiguel Ojedaifdef CONFIG_LTO 2792f7ab126SMiguel Ojedabindgen_c_flags_lto = $(filter-out $(CC_FLAGS_LTO), $(bindgen_c_flags)) 2802f7ab126SMiguel Ojedaelse 2812f7ab126SMiguel Ojedabindgen_c_flags_lto = $(bindgen_c_flags) 2822f7ab126SMiguel Ojedaendif 2832f7ab126SMiguel Ojeda 28475c1fd41SGary Guo# `-fno-builtin` is passed to avoid `bindgen` from using `clang` builtin 28575c1fd41SGary Guo# prototypes for functions like `memcpy` -- if this flag is not passed, 28675c1fd41SGary Guo# `bindgen`-generated prototypes use `c_ulong` or `c_uint` depending on 28775c1fd41SGary Guo# architecture instead of generating `usize`. 28875c1fd41SGary Guobindgen_c_flags_final = $(bindgen_c_flags_lto) -fno-builtin -D__BINDGEN__ 2892f7ab126SMiguel Ojeda 2907a5f93eaSMiguel Ojeda# Each `bindgen` release may upgrade the list of Rust target versions. By 2917a5f93eaSMiguel Ojeda# default, the highest stable release in their list is used. Thus we need to set 2927a5f93eaSMiguel Ojeda# a `--rust-target` to avoid future `bindgen` releases emitting code that 2937a5f93eaSMiguel Ojeda# `rustc` may not understand. On top of that, `bindgen` does not support passing 2947a5f93eaSMiguel Ojeda# an unknown Rust target version. 2957a5f93eaSMiguel Ojeda# 2967a5f93eaSMiguel Ojeda# Therefore, the Rust target for `bindgen` can be only as high as the minimum 2977a5f93eaSMiguel Ojeda# Rust version the kernel supports and only as high as the greatest stable Rust 2987a5f93eaSMiguel Ojeda# target supported by the minimum `bindgen` version the kernel supports (that 2997a5f93eaSMiguel Ojeda# is, if we do not test the actual `rustc`/`bindgen` versions running). 3007a5f93eaSMiguel Ojeda# 3017a5f93eaSMiguel Ojeda# Starting with `bindgen` 0.71.0, we will be able to set any future Rust version 3027a5f93eaSMiguel Ojeda# instead, i.e. we will be able to set here our minimum supported Rust version. 3032f7ab126SMiguel Ojedaquiet_cmd_bindgen = BINDGEN $@ 3042f7ab126SMiguel Ojeda cmd_bindgen = \ 3057a5f93eaSMiguel Ojeda $(BINDGEN) $< $(bindgen_target_flags) --rust-target 1.68 \ 306d072acdaSGary Guo --use-core --with-derive-default --ctypes-prefix ffi --no-layout-tests \ 30776501d19SMiguel Ojeda --no-debug '.*' --enable-function-attribute-detection \ 30808ab7865SAakash Sen Sharma -o $@ -- $(bindgen_c_flags_final) -DMODULE \ 3092f7ab126SMiguel Ojeda $(bindgen_target_cflags) $(bindgen_target_extra) 3102f7ab126SMiguel Ojeda 3112f7ab126SMiguel Ojeda$(obj)/bindings/bindings_generated.rs: private bindgen_target_flags = \ 312b1992c37SMasahiro Yamada $(shell grep -Ev '^#|^$$' $(src)/bindgen_parameters) 31374376656SGary Guo$(obj)/bindings/bindings_generated.rs: private bindgen_target_extra = ; \ 31474376656SGary Guo sed -Ei 's/pub const RUST_CONST_HELPER_([a-zA-Z0-9_]*)/pub const \1/g' $@ 3152f7ab126SMiguel Ojeda$(obj)/bindings/bindings_generated.rs: $(src)/bindings/bindings_helper.h \ 3162f7ab126SMiguel Ojeda $(src)/bindgen_parameters FORCE 3172f7ab126SMiguel Ojeda $(call if_changed_dep,bindgen) 3182f7ab126SMiguel Ojeda 3194e174665SAsahi Lina$(obj)/uapi/uapi_generated.rs: private bindgen_target_flags = \ 320b1992c37SMasahiro Yamada $(shell grep -Ev '^#|^$$' $(src)/bindgen_parameters) 3214e174665SAsahi Lina$(obj)/uapi/uapi_generated.rs: $(src)/uapi/uapi_helper.h \ 3224e174665SAsahi Lina $(src)/bindgen_parameters FORCE 3234e174665SAsahi Lina $(call if_changed_dep,bindgen) 3244e174665SAsahi Lina 3252f7ab126SMiguel Ojeda# See `CFLAGS_REMOVE_helpers.o` above. In addition, Clang on C does not warn 3262f7ab126SMiguel Ojeda# with `-Wmissing-declarations` (unlike GCC), so it is not strictly needed here 3272f7ab126SMiguel Ojeda# given it is `libclang`; but for consistency, future Clang changes and/or 3282f7ab126SMiguel Ojeda# a potential future GCC backend for `bindgen`, we disable it too. 3292f7ab126SMiguel Ojeda$(obj)/bindings/bindings_helpers_generated.rs: private bindgen_target_flags = \ 33008ab7865SAakash Sen Sharma --blocklist-type '.*' --allowlist-var '' \ 33108ab7865SAakash Sen Sharma --allowlist-function 'rust_helper_.*' 3322f7ab126SMiguel Ojeda$(obj)/bindings/bindings_helpers_generated.rs: private bindgen_target_cflags = \ 3332f7ab126SMiguel Ojeda -I$(objtree)/$(obj) -Wno-missing-prototypes -Wno-missing-declarations 3342f7ab126SMiguel Ojeda$(obj)/bindings/bindings_helpers_generated.rs: private bindgen_target_extra = ; \ 3352f7ab126SMiguel Ojeda sed -Ei 's/pub fn rust_helper_([a-zA-Z0-9_]*)/#[link_name="rust_helper_\1"]\n pub fn \1/g' $@ 33687634653SAndreas Hindborg$(obj)/bindings/bindings_helpers_generated.rs: $(src)/helpers/helpers.c FORCE 3372f7ab126SMiguel Ojeda $(call if_changed_dep,bindgen) 3382f7ab126SMiguel Ojeda 3390e446e31SMatthew Maurerrust_exports = $(NM) -p --defined-only $(1) | awk '$$2~/(T|R|D|B)/ && $$3!~/__cfi/ && $$3!~/__odr_asan/ { printf $(2),$$3 }' 340ac61506bSSami Tolvanen 3412f7ab126SMiguel Ojedaquiet_cmd_exports = EXPORTS $@ 3422f7ab126SMiguel Ojeda cmd_exports = \ 343ac61506bSSami Tolvanen $(call rust_exports,$<,"EXPORT_SYMBOL_RUST_GPL(%s);\n") > $@ 3442f7ab126SMiguel Ojeda 3452f7ab126SMiguel Ojeda$(obj)/exports_core_generated.h: $(obj)/core.o FORCE 3462f7ab126SMiguel Ojeda $(call if_changed,exports) 3472f7ab126SMiguel Ojeda 348e26fa546SGary Guo# Even though Rust kernel modules should never use the bindings directly, 349e26fa546SGary Guo# symbols from the `bindings` crate and the C helpers need to be exported 350e26fa546SGary Guo# because Rust generics and inlined functions may not get their code generated 351e26fa546SGary Guo# in the crate where they are defined. Other helpers, called from non-inline 352e26fa546SGary Guo# functions, may not be exported, in principle. However, in general, the Rust 353e26fa546SGary Guo# compiler does not guarantee codegen will be performed for a non-inline 354e26fa546SGary Guo# function either. Therefore, we export all symbols from helpers and bindings. 355e26fa546SGary Guo# In the future, this may be revisited to reduce the number of exports after 356e26fa546SGary Guo# the compiler is informed about the places codegen is required. 357e26fa546SGary Guo$(obj)/exports_helpers_generated.h: $(obj)/helpers/helpers.o FORCE 358e26fa546SGary Guo $(call if_changed,exports) 359e26fa546SGary Guo 3602f7ab126SMiguel Ojeda$(obj)/exports_bindings_generated.h: $(obj)/bindings.o FORCE 3612f7ab126SMiguel Ojeda $(call if_changed,exports) 3622f7ab126SMiguel Ojeda 3632f7ab126SMiguel Ojeda$(obj)/exports_kernel_generated.h: $(obj)/kernel.o FORCE 3642f7ab126SMiguel Ojeda $(call if_changed,exports) 3652f7ab126SMiguel Ojeda 3662f7ab126SMiguel Ojedaquiet_cmd_rustc_procmacro = $(RUSTC_OR_CLIPPY_QUIET) P $@ 3672f7ab126SMiguel Ojeda cmd_rustc_procmacro = \ 3682f7ab126SMiguel Ojeda $(RUSTC_OR_CLIPPY) $(rust_common_flags) \ 36980bac83aSMatthew Maurer -Clinker-flavor=gcc -Clinker=$(HOSTCC) \ 370ceff0757SHONG Yifan -Clink-args='$(call escsq,$(KBUILD_PROCMACROLDFLAGS))' \ 371295d8398SMasahiro Yamada --emit=dep-info=$(depfile) --emit=link=$@ --extern proc_macro \ 372295d8398SMasahiro Yamada --crate-type proc-macro \ 3730730422bSTamir Duberstein --crate-name $(patsubst lib%.$(libmacros_extension),%,$(notdir $@)) $< 3742f7ab126SMiguel Ojeda 3752f7ab126SMiguel Ojeda# Procedural macros can only be used with the `rustc` that compiled it. 3760730422bSTamir Duberstein$(obj)/$(libmacros_name): $(src)/macros/lib.rs FORCE 377ecab4115SMiguel Ojeda +$(call if_changed_dep,rustc_procmacro) 3782f7ab126SMiguel Ojeda 3792f7ab126SMiguel Ojedaquiet_cmd_rustc_library = $(if $(skip_clippy),RUSTC,$(RUSTC_OR_CLIPPY_QUIET)) L $@ 3802f7ab126SMiguel Ojeda cmd_rustc_library = \ 3812f7ab126SMiguel Ojeda OBJTREE=$(abspath $(objtree)) \ 3822f7ab126SMiguel Ojeda $(if $(skip_clippy),$(RUSTC),$(RUSTC_OR_CLIPPY)) \ 3832f7ab126SMiguel Ojeda $(filter-out $(skip_flags),$(rust_flags) $(rustc_target_flags)) \ 384295d8398SMasahiro Yamada --emit=dep-info=$(depfile) --emit=obj=$@ \ 385295d8398SMasahiro Yamada --emit=metadata=$(dir $@)$(patsubst %.o,lib%.rmeta,$(notdir $@)) \ 386295d8398SMasahiro Yamada --crate-type rlib -L$(objtree)/$(obj) \ 3872185242fSMasahiro Yamada --crate-name $(patsubst %.o,%,$(notdir $@)) $< \ 38871479eeeSMatthew Maurer --sysroot=/dev/null \ 389c4d7f546SMiguel Ojeda $(if $(rustc_objcopy),;$(OBJCOPY) $(rustc_objcopy) $@) \ 390c4d7f546SMiguel Ojeda $(cmd_objtool) 3912f7ab126SMiguel Ojeda 3922f7ab126SMiguel Ojedarust-analyzer: 3930730422bSTamir Duberstein $(Q)MAKEFLAGS= $(srctree)/scripts/generate_rust_analyzer.py \ 394392e34b6SDanilo Krummrich --cfgs='core=$(core-cfgs)' \ 395e2bad142SMasahiro Yamada $(realpath $(srctree)) $(realpath $(objtree)) \ 39613b25489SMasahiro Yamada $(rustc_sysroot) $(RUST_LIB_SRC) $(if $(KBUILD_EXTMOD),$(srcroot)) \ 39713b25489SMasahiro Yamada > rust-project.json 3982f7ab126SMiguel Ojeda 399cb7d9defSGary Guoredirect-intrinsics = \ 40002dfd63aSMiguel Ojeda __addsf3 __eqsf2 __extendsfdf2 __gesf2 __lesf2 __ltsf2 __mulsf3 __nesf2 __truncdfsf2 __unordsf2 \ 40102dfd63aSMiguel Ojeda __adddf3 __eqdf2 __ledf2 __ltdf2 __muldf3 __unorddf2 \ 402cb7d9defSGary Guo __muloti4 __multi3 \ 403cb7d9defSGary Guo __udivmodti4 __udivti3 __umodti3 404cb7d9defSGary Guo 405cb7d9defSGary Guoifneq ($(or $(CONFIG_ARM64),$(and $(CONFIG_RISCV),$(CONFIG_64BIT))),) 406cb7d9defSGary Guo # These intrinsics are defined for ARM64 and RISCV64 407cb7d9defSGary Guo redirect-intrinsics += \ 408cb7d9defSGary Guo __ashrti3 \ 409cb7d9defSGary Guo __ashlti3 __lshrti3 410cb7d9defSGary Guoendif 411cb7d9defSGary Guo 412ac61506bSSami Tolvanenifdef CONFIG_MODVERSIONS 413ac61506bSSami Tolvanencmd_gendwarfksyms = $(if $(skip_gendwarfksyms),, \ 414ac61506bSSami Tolvanen $(call rust_exports,$@,"%s\n") | \ 415ac61506bSSami Tolvanen scripts/gendwarfksyms/gendwarfksyms \ 416ac61506bSSami Tolvanen $(if $(KBUILD_GENDWARFKSYMS_STABLE), --stable) \ 417ac61506bSSami Tolvanen $(if $(KBUILD_SYMTYPES), --symtypes $(@:.o=.symtypes),) \ 418ac61506bSSami Tolvanen $@ >> $(dot-target).cmd) 419ac61506bSSami Tolvanenendif 420ac61506bSSami Tolvanen 421c4d7f546SMiguel Ojedadefine rule_rustc_library 422c4d7f546SMiguel Ojeda $(call cmd_and_fixdep,rustc_library) 423c4d7f546SMiguel Ojeda $(call cmd,gen_objtooldep) 424ac61506bSSami Tolvanen $(call cmd,gendwarfksyms) 425c4d7f546SMiguel Ojedaendef 426c4d7f546SMiguel Ojeda 427ac61506bSSami Tolvanendefine rule_rust_cc_library 428ac61506bSSami Tolvanen $(call if_changed_rule,cc_o_c) 429ac61506bSSami Tolvanen $(call cmd,force_checksrc) 430ac61506bSSami Tolvanen $(call cmd,gendwarfksyms) 431ac61506bSSami Tolvanenendef 432ac61506bSSami Tolvanen 433ac61506bSSami Tolvanen# helpers.o uses the same export mechanism as Rust libraries, so ensure symbol 434ac61506bSSami Tolvanen# versions are calculated for the helpers too. 435ac61506bSSami Tolvanen$(obj)/helpers/helpers.o: $(src)/helpers/helpers.c $(recordmcount_source) FORCE 436ac61506bSSami Tolvanen +$(call if_changed_rule,rust_cc_library) 437ac61506bSSami Tolvanen 438ac61506bSSami Tolvanen# Disable symbol versioning for exports.o to avoid conflicts with the actual 439ac61506bSSami Tolvanen# symbol versions generated from Rust objects. 440ac61506bSSami Tolvanen$(obj)/exports.o: private skip_gendwarfksyms = 1 441ac61506bSSami Tolvanen 4422f7ab126SMiguel Ojeda$(obj)/core.o: private skip_clippy = 1 443f8f88aa2SMiguel Ojeda$(obj)/core.o: private skip_flags = -Wunreachable_pub 444cb7d9defSGary Guo$(obj)/core.o: private rustc_objcopy = $(foreach sym,$(redirect-intrinsics),--redefine-sym $(sym)=__rust$(sym)) 4452f7ab126SMiguel Ojeda$(obj)/core.o: private rustc_target_flags = $(core-cfgs) 446ac3e9726SMiguel Ojeda$(obj)/core.o: $(RUST_LIB_SRC)/core/src/lib.rs \ 447ac3e9726SMiguel Ojeda $(wildcard $(objtree)/include/config/RUSTC_VERSION_TEXT) FORCE 448c4d7f546SMiguel Ojeda +$(call if_changed_rule,rustc_library) 449ab0f4cedSDavid Gowifneq ($(or $(CONFIG_X86_64),$(CONFIG_X86_32)),) 450f82811e2SJamie Cunliffe$(obj)/core.o: scripts/target.json 451f82811e2SJamie Cunliffeendif 4522f7ab126SMiguel Ojeda 453ac61506bSSami Tolvanen$(obj)/compiler_builtins.o: private skip_gendwarfksyms = 1 4542f7ab126SMiguel Ojeda$(obj)/compiler_builtins.o: private rustc_objcopy = -w -W '__*' 4552f7ab126SMiguel Ojeda$(obj)/compiler_builtins.o: $(src)/compiler_builtins.rs $(obj)/core.o FORCE 456c4d7f546SMiguel Ojeda +$(call if_changed_rule,rustc_library) 4572f7ab126SMiguel Ojeda 458ac61506bSSami Tolvanen$(obj)/build_error.o: private skip_gendwarfksyms = 1 459ecaa6ddfSGary Guo$(obj)/build_error.o: $(src)/build_error.rs $(obj)/compiler_builtins.o FORCE 460c4d7f546SMiguel Ojeda +$(call if_changed_rule,rustc_library) 461ecaa6ddfSGary Guo 462ac61506bSSami Tolvanen$(obj)/ffi.o: private skip_gendwarfksyms = 1 463d072acdaSGary Guo$(obj)/ffi.o: $(src)/ffi.rs $(obj)/compiler_builtins.o FORCE 464d072acdaSGary Guo +$(call if_changed_rule,rustc_library) 465d072acdaSGary Guo 466d072acdaSGary Guo$(obj)/bindings.o: private rustc_target_flags = --extern ffi 4672f7ab126SMiguel Ojeda$(obj)/bindings.o: $(src)/bindings/lib.rs \ 468d072acdaSGary Guo $(obj)/ffi.o \ 4692f7ab126SMiguel Ojeda $(obj)/bindings/bindings_generated.rs \ 4702f7ab126SMiguel Ojeda $(obj)/bindings/bindings_helpers_generated.rs FORCE 471c4d7f546SMiguel Ojeda +$(call if_changed_rule,rustc_library) 4722f7ab126SMiguel Ojeda 473d072acdaSGary Guo$(obj)/uapi.o: private rustc_target_flags = --extern ffi 474ac61506bSSami Tolvanen$(obj)/uapi.o: private skip_gendwarfksyms = 1 4754e174665SAsahi Lina$(obj)/uapi.o: $(src)/uapi/lib.rs \ 476d072acdaSGary Guo $(obj)/ffi.o \ 4774e174665SAsahi Lina $(obj)/uapi/uapi_generated.rs FORCE 478c4d7f546SMiguel Ojeda +$(call if_changed_rule,rustc_library) 4794e174665SAsahi Lina 480d072acdaSGary Guo$(obj)/kernel.o: private rustc_target_flags = --extern ffi \ 4814e174665SAsahi Lina --extern build_error --extern macros --extern bindings --extern uapi 482392e34b6SDanilo Krummrich$(obj)/kernel.o: $(src)/kernel/lib.rs $(obj)/build_error.o \ 4830730422bSTamir Duberstein $(obj)/$(libmacros_name) $(obj)/bindings.o $(obj)/uapi.o FORCE 484c4d7f546SMiguel Ojeda +$(call if_changed_rule,rustc_library) 4852f7ab126SMiguel Ojeda 486169484abSAlice Ryhlifdef CONFIG_JUMP_LABEL 4878af7a501SMiguel Ojeda$(obj)/kernel.o: $(obj)/kernel/generated_arch_static_branch_asm.rs 488169484abSAlice Ryhlendif 489169484abSAlice Ryhl 4902f7ab126SMiguel Ojedaendif # CONFIG_RUST 491