1 # SPDX-License-Identifier: GPL-2.0 1 # SPDX-License-Identifier: GPL-2.0
2 2
3 # Where to place rustdoc generated documentati 3 # Where to place rustdoc generated documentation
4 rustdoc_output := $(objtree)/Documentation/out 4 rustdoc_output := $(objtree)/Documentation/output/rust/rustdoc
5 5
6 obj-$(CONFIG_RUST) += core.o compiler_builtins 6 obj-$(CONFIG_RUST) += core.o compiler_builtins.o
7 always-$(CONFIG_RUST) += exports_core_generate 7 always-$(CONFIG_RUST) += exports_core_generated.h
8 8
9 # Missing prototypes are expected in the helpe 9 # Missing prototypes are expected in the helpers since these are exported
10 # for Rust only, thus there is no header nor p 10 # for Rust only, thus there is no header nor prototypes.
11 obj-$(CONFIG_RUST) += helpers/helpers.o !! 11 obj-$(CONFIG_RUST) += helpers.o
12 CFLAGS_REMOVE_helpers/helpers.o = -Wmissing-pr !! 12 CFLAGS_REMOVE_helpers.o = -Wmissing-prototypes -Wmissing-declarations
13 13
14 always-$(CONFIG_RUST) += libmacros.so 14 always-$(CONFIG_RUST) += libmacros.so
15 no-clean-files += libmacros.so 15 no-clean-files += libmacros.so
16 16
17 always-$(CONFIG_RUST) += bindings/bindings_gen 17 always-$(CONFIG_RUST) += bindings/bindings_generated.rs bindings/bindings_helpers_generated.rs
18 obj-$(CONFIG_RUST) += alloc.o bindings.o kerne 18 obj-$(CONFIG_RUST) += alloc.o bindings.o kernel.o
19 always-$(CONFIG_RUST) += exports_alloc_generat !! 19 always-$(CONFIG_RUST) += exports_alloc_generated.h exports_bindings_generated.h \
20 exports_bindings_generated.h exports_kerne !! 20 exports_kernel_generated.h
21 21
22 always-$(CONFIG_RUST) += uapi/uapi_generated.r 22 always-$(CONFIG_RUST) += uapi/uapi_generated.rs
23 obj-$(CONFIG_RUST) += uapi.o 23 obj-$(CONFIG_RUST) += uapi.o
24 24
25 ifdef CONFIG_RUST_BUILD_ASSERT_ALLOW 25 ifdef CONFIG_RUST_BUILD_ASSERT_ALLOW
26 obj-$(CONFIG_RUST) += build_error.o 26 obj-$(CONFIG_RUST) += build_error.o
27 else 27 else
28 always-$(CONFIG_RUST) += build_error.o 28 always-$(CONFIG_RUST) += build_error.o
29 endif 29 endif
30 30
31 obj-$(CONFIG_RUST) += exports.o 31 obj-$(CONFIG_RUST) += exports.o
32 32
33 always-$(CONFIG_RUST_KERNEL_DOCTESTS) += docte 33 always-$(CONFIG_RUST_KERNEL_DOCTESTS) += doctests_kernel_generated.rs
34 always-$(CONFIG_RUST_KERNEL_DOCTESTS) += docte 34 always-$(CONFIG_RUST_KERNEL_DOCTESTS) += doctests_kernel_generated_kunit.c
35 35
36 obj-$(CONFIG_RUST_KERNEL_DOCTESTS) += doctests 36 obj-$(CONFIG_RUST_KERNEL_DOCTESTS) += doctests_kernel_generated.o
37 obj-$(CONFIG_RUST_KERNEL_DOCTESTS) += doctests 37 obj-$(CONFIG_RUST_KERNEL_DOCTESTS) += doctests_kernel_generated_kunit.o
38 38
39 # Avoids running `$(RUSTC)` for the sysroot wh 39 # Avoids running `$(RUSTC)` for the sysroot when it may not be available.
40 ifdef CONFIG_RUST 40 ifdef CONFIG_RUST
41 41
42 # `$(rust_flags)` is passed in case the user a 42 # `$(rust_flags)` is passed in case the user added `--sysroot`.
43 rustc_sysroot := $(shell MAKEFLAGS= $(RUSTC) $ 43 rustc_sysroot := $(shell MAKEFLAGS= $(RUSTC) $(rust_flags) --print sysroot)
44 rustc_host_target := $(shell $(RUSTC) --versio 44 rustc_host_target := $(shell $(RUSTC) --version --verbose | grep -F 'host: ' | cut -d' ' -f2)
45 RUST_LIB_SRC ?= $(rustc_sysroot)/lib/rustlib/s 45 RUST_LIB_SRC ?= $(rustc_sysroot)/lib/rustlib/src/rust/library
46 46
47 ifneq ($(quiet),) !! 47 ifeq ($(quiet),silent_)
>> 48 cargo_quiet=-q
48 rust_test_quiet=-q 49 rust_test_quiet=-q
49 rustdoc_test_quiet=--test-args -q 50 rustdoc_test_quiet=--test-args -q
50 rustdoc_test_kernel_quiet=>/dev/null 51 rustdoc_test_kernel_quiet=>/dev/null
>> 52 else ifeq ($(quiet),quiet_)
>> 53 rust_test_quiet=-q
>> 54 rustdoc_test_quiet=--test-args -q
>> 55 rustdoc_test_kernel_quiet=>/dev/null
>> 56 else
>> 57 cargo_quiet=--verbose
51 endif 58 endif
52 59
53 core-cfgs = \ 60 core-cfgs = \
54 --cfg no_fp_fmt_parse 61 --cfg no_fp_fmt_parse
55 62
56 alloc-cfgs = \ 63 alloc-cfgs = \
57 --cfg no_global_oom_handling \ 64 --cfg no_global_oom_handling \
58 --cfg no_rc \ 65 --cfg no_rc \
59 --cfg no_sync 66 --cfg no_sync
60 67
61 quiet_cmd_rustdoc = RUSTDOC $(if $(rustdoc_hos 68 quiet_cmd_rustdoc = RUSTDOC $(if $(rustdoc_host),H, ) $<
62 cmd_rustdoc = \ 69 cmd_rustdoc = \
63 OBJTREE=$(abspath $(objtree)) \ 70 OBJTREE=$(abspath $(objtree)) \
64 $(RUSTDOC) $(if $(rustdoc_host),$(rust 71 $(RUSTDOC) $(if $(rustdoc_host),$(rust_common_flags),$(rust_flags)) \
65 $(rustc_target_flags) -L$(objt 72 $(rustc_target_flags) -L$(objtree)/$(obj) \
66 -Zunstable-options --generate- <<
67 --output $(rustdoc_output) \ 73 --output $(rustdoc_output) \
68 --crate-name $(subst rustdoc-, 74 --crate-name $(subst rustdoc-,,$@) \
69 $(if $(rustdoc_host),,--sysroo 75 $(if $(rustdoc_host),,--sysroot=/dev/null) \
70 @$(objtree)/include/generated/ 76 @$(objtree)/include/generated/rustc_cfg $<
71 77
72 # The `html_logo_url` and `html_favicon_url` f 78 # The `html_logo_url` and `html_favicon_url` forms of the `doc` attribute
73 # can be used to specify a custom logo. Howeve 79 # can be used to specify a custom logo. However:
74 # - The given value is used as-is, thus it c 80 # - The given value is used as-is, thus it cannot be relative or a local file
75 # (unlike the non-custom case) since the g 81 # (unlike the non-custom case) since the generated docs have subfolders.
76 # - It requires adding it to every crate. 82 # - It requires adding it to every crate.
77 # - It requires changing `core` which comes 83 # - It requires changing `core` which comes from the sysroot.
78 # 84 #
79 # Using `-Zcrate-attr` would solve the last tw 85 # Using `-Zcrate-attr` would solve the last two points, but not the first.
80 # The https://github.com/rust-lang/rfcs/pull/3 86 # The https://github.com/rust-lang/rfcs/pull/3226 RFC suggests two new
81 # command-like flags to solve the issue. Meanw 87 # command-like flags to solve the issue. Meanwhile, we use the non-custom case
82 # and then retouch the generated files. 88 # and then retouch the generated files.
83 rustdoc: rustdoc-core rustdoc-macros rustdoc-c 89 rustdoc: rustdoc-core rustdoc-macros rustdoc-compiler_builtins \
84 rustdoc-alloc rustdoc-kernel 90 rustdoc-alloc rustdoc-kernel
85 $(Q)cp $(srctree)/Documentation/images 91 $(Q)cp $(srctree)/Documentation/images/logo.svg $(rustdoc_output)/static.files/
86 $(Q)cp $(srctree)/Documentation/images 92 $(Q)cp $(srctree)/Documentation/images/COPYING-logo $(rustdoc_output)/static.files/
87 $(Q)find $(rustdoc_output) -name '*.ht 93 $(Q)find $(rustdoc_output) -name '*.html' -type f -print0 | xargs -0 sed -Ei \
88 -e 's:rust-logo-[0-9a-f]+\.svg 94 -e 's:rust-logo-[0-9a-f]+\.svg:logo.svg:g' \
89 -e 's:favicon-[0-9a-f]+\.svg:l 95 -e 's:favicon-[0-9a-f]+\.svg:logo.svg:g' \
90 -e 's:<link rel="alternate ico 96 -e 's:<link rel="alternate icon" type="image/png" href="[/.]+/static\.files/favicon-(16x16|32x32)-[0-9a-f]+\.png">::g' \
91 -e 's:<a href="srctree/([^"]+) 97 -e 's:<a href="srctree/([^"]+)">:<a href="$(realpath $(srctree))/\1">:g'
92 $(Q)for f in $(rustdoc_output)/static. 98 $(Q)for f in $(rustdoc_output)/static.files/rustdoc-*.css; do \
93 echo ".logo-container > img { 99 echo ".logo-container > img { object-fit: contain; }" >> $$f; done
94 100
95 rustdoc-macros: private rustdoc_host = yes 101 rustdoc-macros: private rustdoc_host = yes
96 rustdoc-macros: private rustc_target_flags = - 102 rustdoc-macros: private rustc_target_flags = --crate-type proc-macro \
97 --extern proc_macro 103 --extern proc_macro
98 rustdoc-macros: $(src)/macros/lib.rs FORCE 104 rustdoc-macros: $(src)/macros/lib.rs FORCE
99 +$(call if_changed,rustdoc) 105 +$(call if_changed,rustdoc)
100 106
101 rustdoc-core: private rustc_target_flags = $(c 107 rustdoc-core: private rustc_target_flags = $(core-cfgs)
102 rustdoc-core: $(RUST_LIB_SRC)/core/src/lib.rs 108 rustdoc-core: $(RUST_LIB_SRC)/core/src/lib.rs FORCE
103 +$(call if_changed,rustdoc) 109 +$(call if_changed,rustdoc)
104 110
105 rustdoc-compiler_builtins: $(src)/compiler_bui 111 rustdoc-compiler_builtins: $(src)/compiler_builtins.rs rustdoc-core FORCE
106 +$(call if_changed,rustdoc) 112 +$(call if_changed,rustdoc)
107 113
108 # We need to allow `rustdoc::broken_intra_doc_ 114 # We need to allow `rustdoc::broken_intra_doc_links` because some
109 # `no_global_oom_handling` functions refer to 115 # `no_global_oom_handling` functions refer to non-`no_global_oom_handling`
110 # functions. Ideally `rustdoc` would have a wa 116 # functions. Ideally `rustdoc` would have a way to distinguish broken links
111 # due to things that are "configured out" vs. 117 # due to things that are "configured out" vs. entirely non-existing ones.
112 rustdoc-alloc: private rustc_target_flags = $( 118 rustdoc-alloc: private rustc_target_flags = $(alloc-cfgs) \
113 -Arustdoc::broken_intra_doc_links 119 -Arustdoc::broken_intra_doc_links
114 rustdoc-alloc: $(RUST_LIB_SRC)/alloc/src/lib.r 120 rustdoc-alloc: $(RUST_LIB_SRC)/alloc/src/lib.rs rustdoc-core rustdoc-compiler_builtins FORCE
115 +$(call if_changed,rustdoc) 121 +$(call if_changed,rustdoc)
116 122
117 rustdoc-kernel: private rustc_target_flags = - 123 rustdoc-kernel: private rustc_target_flags = --extern alloc \
118 --extern build_error --extern macros=$(obj 124 --extern build_error --extern macros=$(objtree)/$(obj)/libmacros.so \
119 --extern bindings --extern uapi 125 --extern bindings --extern uapi
120 rustdoc-kernel: $(src)/kernel/lib.rs rustdoc-c 126 rustdoc-kernel: $(src)/kernel/lib.rs rustdoc-core rustdoc-macros \
121 rustdoc-compiler_builtins rustdoc-alloc $( 127 rustdoc-compiler_builtins rustdoc-alloc $(obj)/libmacros.so \
122 $(obj)/bindings.o FORCE 128 $(obj)/bindings.o FORCE
123 +$(call if_changed,rustdoc) 129 +$(call if_changed,rustdoc)
124 130
125 quiet_cmd_rustc_test_library = RUSTC TL $< 131 quiet_cmd_rustc_test_library = RUSTC TL $<
126 cmd_rustc_test_library = \ 132 cmd_rustc_test_library = \
127 OBJTREE=$(abspath $(objtree)) \ 133 OBJTREE=$(abspath $(objtree)) \
128 $(RUSTC) $(rust_common_flags) \ 134 $(RUSTC) $(rust_common_flags) \
129 @$(objtree)/include/generated/ 135 @$(objtree)/include/generated/rustc_cfg $(rustc_target_flags) \
130 --crate-type $(if $(rustc_test 136 --crate-type $(if $(rustc_test_library_proc),proc-macro,rlib) \
131 --out-dir $(objtree)/$(obj)/te 137 --out-dir $(objtree)/$(obj)/test --cfg testlib \
>> 138 --sysroot $(objtree)/$(obj)/test/sysroot \
132 -L$(objtree)/$(obj)/test \ 139 -L$(objtree)/$(obj)/test \
133 --crate-name $(subst rusttest- 140 --crate-name $(subst rusttest-,,$(subst rusttestlib-,,$@)) $<
134 141
135 rusttestlib-build_error: $(src)/build_error.rs !! 142 rusttestlib-build_error: $(src)/build_error.rs rusttest-prepare FORCE
136 +$(call if_changed,rustc_test_library) 143 +$(call if_changed,rustc_test_library)
137 144
138 rusttestlib-macros: private rustc_target_flags 145 rusttestlib-macros: private rustc_target_flags = --extern proc_macro
139 rusttestlib-macros: private rustc_test_library 146 rusttestlib-macros: private rustc_test_library_proc = yes
140 rusttestlib-macros: $(src)/macros/lib.rs FORCE !! 147 rusttestlib-macros: $(src)/macros/lib.rs rusttest-prepare FORCE
141 +$(call if_changed,rustc_test_library) 148 +$(call if_changed,rustc_test_library)
142 149
143 rusttestlib-bindings: $(src)/bindings/lib.rs F !! 150 rusttestlib-bindings: $(src)/bindings/lib.rs rusttest-prepare FORCE
144 +$(call if_changed,rustc_test_library) 151 +$(call if_changed,rustc_test_library)
145 152
146 rusttestlib-uapi: $(src)/uapi/lib.rs FORCE !! 153 rusttestlib-uapi: $(src)/uapi/lib.rs rusttest-prepare FORCE
147 +$(call if_changed,rustc_test_library) 154 +$(call if_changed,rustc_test_library)
148 155
149 quiet_cmd_rustdoc_test = RUSTDOC T $< 156 quiet_cmd_rustdoc_test = RUSTDOC T $<
150 cmd_rustdoc_test = \ 157 cmd_rustdoc_test = \
151 OBJTREE=$(abspath $(objtree)) \ 158 OBJTREE=$(abspath $(objtree)) \
152 $(RUSTDOC) --test $(rust_common_flags) 159 $(RUSTDOC) --test $(rust_common_flags) \
153 @$(objtree)/include/generated/ 160 @$(objtree)/include/generated/rustc_cfg \
154 $(rustc_target_flags) $(rustdo 161 $(rustc_target_flags) $(rustdoc_test_target_flags) \
155 $(rustdoc_test_quiet) \ !! 162 --sysroot $(objtree)/$(obj)/test/sysroot $(rustdoc_test_quiet) \
156 -L$(objtree)/$(obj)/test --out 163 -L$(objtree)/$(obj)/test --output $(rustdoc_output) \
157 --crate-name $(subst rusttest- 164 --crate-name $(subst rusttest-,,$@) $<
158 165
159 quiet_cmd_rustdoc_test_kernel = RUSTDOC TK $< 166 quiet_cmd_rustdoc_test_kernel = RUSTDOC TK $<
160 cmd_rustdoc_test_kernel = \ 167 cmd_rustdoc_test_kernel = \
161 rm -rf $(objtree)/$(obj)/test/doctests 168 rm -rf $(objtree)/$(obj)/test/doctests/kernel; \
162 mkdir -p $(objtree)/$(obj)/test/doctes 169 mkdir -p $(objtree)/$(obj)/test/doctests/kernel; \
163 OBJTREE=$(abspath $(objtree)) \ 170 OBJTREE=$(abspath $(objtree)) \
164 $(RUSTDOC) --test $(rust_flags) \ 171 $(RUSTDOC) --test $(rust_flags) \
165 -L$(objtree)/$(obj) --extern a 172 -L$(objtree)/$(obj) --extern alloc --extern kernel \
166 --extern build_error --extern 173 --extern build_error --extern macros \
167 --extern bindings --extern uap 174 --extern bindings --extern uapi \
168 --no-run --crate-name kernel - 175 --no-run --crate-name kernel -Zunstable-options \
169 --sysroot=/dev/null \ 176 --sysroot=/dev/null \
170 --test-builder $(objtree)/scri 177 --test-builder $(objtree)/scripts/rustdoc_test_builder \
171 $< $(rustdoc_test_kernel_quiet 178 $< $(rustdoc_test_kernel_quiet); \
172 $(objtree)/scripts/rustdoc_test_gen 179 $(objtree)/scripts/rustdoc_test_gen
173 180
174 %/doctests_kernel_generated.rs %/doctests_kern 181 %/doctests_kernel_generated.rs %/doctests_kernel_generated_kunit.c: \
175 $(src)/kernel/lib.rs $(obj)/kernel.o \ 182 $(src)/kernel/lib.rs $(obj)/kernel.o \
176 $(objtree)/scripts/rustdoc_test_builder \ 183 $(objtree)/scripts/rustdoc_test_builder \
177 $(objtree)/scripts/rustdoc_test_gen FORCE 184 $(objtree)/scripts/rustdoc_test_gen FORCE
178 +$(call if_changed,rustdoc_test_kernel 185 +$(call if_changed,rustdoc_test_kernel)
179 186
180 # We cannot use `-Zpanic-abort-tests` because 187 # We cannot use `-Zpanic-abort-tests` because some tests are dynamic,
181 # so for the moment we skip `-Cpanic=abort`. 188 # so for the moment we skip `-Cpanic=abort`.
182 quiet_cmd_rustc_test = RUSTC T $< 189 quiet_cmd_rustc_test = RUSTC T $<
183 cmd_rustc_test = \ 190 cmd_rustc_test = \
184 OBJTREE=$(abspath $(objtree)) \ 191 OBJTREE=$(abspath $(objtree)) \
185 $(RUSTC) --test $(rust_common_flags) \ 192 $(RUSTC) --test $(rust_common_flags) \
186 @$(objtree)/include/generated/ 193 @$(objtree)/include/generated/rustc_cfg \
187 $(rustc_target_flags) --out-di 194 $(rustc_target_flags) --out-dir $(objtree)/$(obj)/test \
>> 195 --sysroot $(objtree)/$(obj)/test/sysroot \
188 -L$(objtree)/$(obj)/test \ 196 -L$(objtree)/$(obj)/test \
189 --crate-name $(subst rusttest- 197 --crate-name $(subst rusttest-,,$@) $<; \
190 $(objtree)/$(obj)/test/$(subst rusttes 198 $(objtree)/$(obj)/test/$(subst rusttest-,,$@) $(rust_test_quiet) \
191 $(rustc_test_run_flags) 199 $(rustc_test_run_flags)
192 200
193 rusttest: rusttest-macros rusttest-kernel 201 rusttest: rusttest-macros rusttest-kernel
194 202
>> 203 # This prepares a custom sysroot with our custom `alloc` instead of
>> 204 # the standard one.
>> 205 #
>> 206 # This requires several hacks:
>> 207 # - Unlike `core` and `alloc`, `std` depends on more than a dozen crates,
>> 208 # including third-party crates that need to be downloaded, plus custom
>> 209 # `build.rs` steps. Thus hardcoding things here is not maintainable.
>> 210 # - `cargo` knows how to build the standard library, but it is an unstable
>> 211 # feature so far (`-Zbuild-std`).
>> 212 # - `cargo` only considers the use case of building the standard library
>> 213 # to use it in a given package. Thus we need to create a dummy package
>> 214 # and pick the generated libraries from there.
>> 215 # - The usual ways of modifying the dependency graph in `cargo` do not seem
>> 216 # to apply for the `-Zbuild-std` steps, thus we have to mislead it
>> 217 # by modifying the sources in the sysroot.
>> 218 # - To avoid messing with the user's Rust installation, we create a clone
>> 219 # of the sysroot. However, `cargo` ignores `RUSTFLAGS` in the `-Zbuild-std`
>> 220 # steps, thus we use a wrapper binary passed via `RUSTC` to pass the flag.
>> 221 #
>> 222 # In the future, we hope to avoid the whole ordeal by either:
>> 223 # - Making the `test` crate not depend on `std` (either improving upstream
>> 224 # or having our own custom crate).
>> 225 # - Making the tests run in kernel space (requires the previous point).
>> 226 # - Making `std` and friends be more like a "normal" crate, so that
>> 227 # `-Zbuild-std` and related hacks are not needed.
>> 228 quiet_cmd_rustsysroot = RUSTSYSROOT
>> 229 cmd_rustsysroot = \
>> 230 rm -rf $(objtree)/$(obj)/test; \
>> 231 mkdir -p $(objtree)/$(obj)/test; \
>> 232 cp -a $(rustc_sysroot) $(objtree)/$(obj)/test/sysroot; \
>> 233 echo '\#!/bin/sh' > $(objtree)/$(obj)/test/rustc_sysroot; \
>> 234 echo "$(RUSTC) --sysroot=$(abspath $(objtree)/$(obj)/test/sysroot) \"\$$@\"" \
>> 235 >> $(objtree)/$(obj)/test/rustc_sysroot; \
>> 236 chmod u+x $(objtree)/$(obj)/test/rustc_sysroot; \
>> 237 $(CARGO) -q new $(objtree)/$(obj)/test/dummy; \
>> 238 RUSTC=$(objtree)/$(obj)/test/rustc_sysroot $(CARGO) $(cargo_quiet) \
>> 239 test -Zbuild-std --target $(rustc_host_target) \
>> 240 --manifest-path $(objtree)/$(obj)/test/dummy/Cargo.toml; \
>> 241 rm $(objtree)/$(obj)/test/sysroot/lib/rustlib/$(rustc_host_target)/lib/*; \
>> 242 cp $(objtree)/$(obj)/test/dummy/target/$(rustc_host_target)/debug/deps/* \
>> 243 $(objtree)/$(obj)/test/sysroot/lib/rustlib/$(rustc_host_target)/lib
>> 244
>> 245 rusttest-prepare: FORCE
>> 246 +$(call if_changed,rustsysroot)
>> 247
195 rusttest-macros: private rustc_target_flags = 248 rusttest-macros: private rustc_target_flags = --extern proc_macro
196 rusttest-macros: private rustdoc_test_target_f 249 rusttest-macros: private rustdoc_test_target_flags = --crate-type proc-macro
197 rusttest-macros: $(src)/macros/lib.rs FORCE !! 250 rusttest-macros: $(src)/macros/lib.rs rusttest-prepare FORCE
198 +$(call if_changed,rustc_test) 251 +$(call if_changed,rustc_test)
199 +$(call if_changed,rustdoc_test) 252 +$(call if_changed,rustdoc_test)
200 253
201 rusttest-kernel: private rustc_target_flags = 254 rusttest-kernel: private rustc_target_flags = --extern alloc \
202 --extern build_error --extern macros --ext 255 --extern build_error --extern macros --extern bindings --extern uapi
203 rusttest-kernel: $(src)/kernel/lib.rs \ !! 256 rusttest-kernel: $(src)/kernel/lib.rs rusttest-prepare \
204 rusttestlib-build_error rusttestlib-macros 257 rusttestlib-build_error rusttestlib-macros rusttestlib-bindings \
205 rusttestlib-uapi FORCE 258 rusttestlib-uapi FORCE
206 +$(call if_changed,rustc_test) 259 +$(call if_changed,rustc_test)
207 +$(call if_changed,rustc_test_library) 260 +$(call if_changed,rustc_test_library)
208 261
209 ifdef CONFIG_CC_IS_CLANG 262 ifdef CONFIG_CC_IS_CLANG
210 bindgen_c_flags = $(c_flags) 263 bindgen_c_flags = $(c_flags)
211 else 264 else
212 # bindgen relies on libclang to parse C. Ideal 265 # bindgen relies on libclang to parse C. Ideally, bindgen would support a GCC
213 # plugin backend and/or the Clang driver would 266 # plugin backend and/or the Clang driver would be perfectly compatible with GCC.
214 # 267 #
215 # For the moment, here we are tweaking the fla 268 # For the moment, here we are tweaking the flags on the fly. This is a hack,
216 # and some kernel configurations may not work 269 # and some kernel configurations may not work (e.g. `GCC_PLUGIN_RANDSTRUCT`
217 # if we end up using one of those structs). 270 # if we end up using one of those structs).
218 bindgen_skip_c_flags := -mno-fp-ret-in-387 -mp 271 bindgen_skip_c_flags := -mno-fp-ret-in-387 -mpreferred-stack-boundary=% \
219 -mskip-rax-setup -mgeneral-regs-only - 272 -mskip-rax-setup -mgeneral-regs-only -msign-return-address=% \
220 -mindirect-branch=thunk-extern -mindir 273 -mindirect-branch=thunk-extern -mindirect-branch-register \
221 -mfunction-return=thunk-extern -mrecor 274 -mfunction-return=thunk-extern -mrecord-mcount -mabi=lp64 \
222 -mindirect-branch-cs-prefix -mstack-pr 275 -mindirect-branch-cs-prefix -mstack-protector-guard% -mtraceback=no \
223 -mno-pointers-to-nested-functions -mno 276 -mno-pointers-to-nested-functions -mno-string \
224 -mno-strict-align -mstrict-align \ 277 -mno-strict-align -mstrict-align \
225 -fconserve-stack -falign-jumps=% -fali 278 -fconserve-stack -falign-jumps=% -falign-loops=% \
226 -femit-struct-debug-baseonly -fno-ipa- 279 -femit-struct-debug-baseonly -fno-ipa-cp-clone -fno-ipa-sra \
227 -fno-partial-inlining -fplugin-arg-arm 280 -fno-partial-inlining -fplugin-arg-arm_ssp_per_task_plugin-% \
228 -fno-reorder-blocks -fno-allow-store-d 281 -fno-reorder-blocks -fno-allow-store-data-races -fasan-shadow-offset=% \
229 -fzero-call-used-regs=% -fno-stack-cla 282 -fzero-call-used-regs=% -fno-stack-clash-protection \
230 -fno-inline-functions-called-once -fsa 283 -fno-inline-functions-called-once -fsanitize=bounds-strict \
231 -fstrict-flex-arrays=% -fmin-function- !! 284 -fstrict-flex-arrays=% \
232 --param=% --param asan-% 285 --param=% --param asan-%
233 286
234 # Derived from `scripts/Makefile.clang`. 287 # Derived from `scripts/Makefile.clang`.
235 BINDGEN_TARGET_x86 := x86_64-linux-gnu 288 BINDGEN_TARGET_x86 := x86_64-linux-gnu
236 BINDGEN_TARGET_arm64 := aarch64-linux-gnu 289 BINDGEN_TARGET_arm64 := aarch64-linux-gnu
237 BINDGEN_TARGET := $(BINDGEN_TARGET_$( 290 BINDGEN_TARGET := $(BINDGEN_TARGET_$(SRCARCH))
238 291
239 # All warnings are inhibited since GCC builds 292 # All warnings are inhibited since GCC builds are very experimental,
240 # many GCC warnings are not supported by Clang 293 # many GCC warnings are not supported by Clang, they may only appear in
241 # some configurations, with new GCC versions, 294 # some configurations, with new GCC versions, etc.
242 bindgen_extra_c_flags = -w --target=$(BINDGEN_ 295 bindgen_extra_c_flags = -w --target=$(BINDGEN_TARGET)
243 296
244 # Auto variable zero-initialization requires a 297 # Auto variable zero-initialization requires an additional special option with
245 # clang that is going to be removed sometime i 298 # clang that is going to be removed sometime in the future (likely in
246 # clang-18), so make sure to pass this option 299 # clang-18), so make sure to pass this option only if clang supports it
247 # (libclang major version < 16). 300 # (libclang major version < 16).
248 # 301 #
249 # https://github.com/llvm/llvm-project/issues/ 302 # https://github.com/llvm/llvm-project/issues/44842
250 # https://github.com/llvm/llvm-project/blob/ll 303 # https://github.com/llvm/llvm-project/blob/llvmorg-16.0.0-rc2/clang/docs/ReleaseNotes.rst#deprecated-compiler-flags
251 ifdef CONFIG_INIT_STACK_ALL_ZERO 304 ifdef CONFIG_INIT_STACK_ALL_ZERO
252 libclang_maj_ver=$(shell $(BINDGEN) $(srctree) 305 libclang_maj_ver=$(shell $(BINDGEN) $(srctree)/scripts/rust_is_available_bindgen_libclang.h 2>&1 | sed -ne 's/.*clang version \([0-9]*\).*/\1/p')
253 ifeq ($(shell expr $(libclang_maj_ver) \< 16), 306 ifeq ($(shell expr $(libclang_maj_ver) \< 16), 1)
254 bindgen_extra_c_flags += -enable-trivial-auto- 307 bindgen_extra_c_flags += -enable-trivial-auto-var-init-zero-knowing-it-will-be-removed-from-clang
255 endif 308 endif
256 endif 309 endif
257 310
258 bindgen_c_flags = $(filter-out $(bindgen_skip_ 311 bindgen_c_flags = $(filter-out $(bindgen_skip_c_flags), $(c_flags)) \
259 $(bindgen_extra_c_flags) 312 $(bindgen_extra_c_flags)
260 endif 313 endif
261 314
262 ifdef CONFIG_LTO 315 ifdef CONFIG_LTO
263 bindgen_c_flags_lto = $(filter-out $(CC_FLAGS_ 316 bindgen_c_flags_lto = $(filter-out $(CC_FLAGS_LTO), $(bindgen_c_flags))
264 else 317 else
265 bindgen_c_flags_lto = $(bindgen_c_flags) 318 bindgen_c_flags_lto = $(bindgen_c_flags)
266 endif 319 endif
267 320
268 bindgen_c_flags_final = $(bindgen_c_flags_lto) 321 bindgen_c_flags_final = $(bindgen_c_flags_lto) -D__BINDGEN__
269 322
270 quiet_cmd_bindgen = BINDGEN $@ 323 quiet_cmd_bindgen = BINDGEN $@
271 cmd_bindgen = \ 324 cmd_bindgen = \
272 $(BINDGEN) $< $(bindgen_target_flags) 325 $(BINDGEN) $< $(bindgen_target_flags) \
273 --use-core --with-derive-defau 326 --use-core --with-derive-default --ctypes-prefix core::ffi --no-layout-tests \
274 --no-debug '.*' --enable-funct !! 327 --no-debug '.*' \
275 -o $@ -- $(bindgen_c_flags_fin 328 -o $@ -- $(bindgen_c_flags_final) -DMODULE \
276 $(bindgen_target_cflags) $(bin 329 $(bindgen_target_cflags) $(bindgen_target_extra)
277 330
278 $(obj)/bindings/bindings_generated.rs: private 331 $(obj)/bindings/bindings_generated.rs: private bindgen_target_flags = \
279 $(shell grep -Ev '^#|^$$' $(src)/bindgen_p 332 $(shell grep -Ev '^#|^$$' $(src)/bindgen_parameters)
280 $(obj)/bindings/bindings_generated.rs: private 333 $(obj)/bindings/bindings_generated.rs: private bindgen_target_extra = ; \
281 sed -Ei 's/pub const RUST_CONST_HELPER_([a 334 sed -Ei 's/pub const RUST_CONST_HELPER_([a-zA-Z0-9_]*)/pub const \1/g' $@
282 $(obj)/bindings/bindings_generated.rs: $(src)/ 335 $(obj)/bindings/bindings_generated.rs: $(src)/bindings/bindings_helper.h \
283 $(src)/bindgen_parameters FORCE 336 $(src)/bindgen_parameters FORCE
284 $(call if_changed_dep,bindgen) 337 $(call if_changed_dep,bindgen)
285 338
286 $(obj)/uapi/uapi_generated.rs: private bindgen 339 $(obj)/uapi/uapi_generated.rs: private bindgen_target_flags = \
287 $(shell grep -Ev '^#|^$$' $(src)/bindgen_p 340 $(shell grep -Ev '^#|^$$' $(src)/bindgen_parameters)
288 $(obj)/uapi/uapi_generated.rs: $(src)/uapi/uap 341 $(obj)/uapi/uapi_generated.rs: $(src)/uapi/uapi_helper.h \
289 $(src)/bindgen_parameters FORCE 342 $(src)/bindgen_parameters FORCE
290 $(call if_changed_dep,bindgen) 343 $(call if_changed_dep,bindgen)
291 344
292 # See `CFLAGS_REMOVE_helpers.o` above. In addi 345 # See `CFLAGS_REMOVE_helpers.o` above. In addition, Clang on C does not warn
293 # with `-Wmissing-declarations` (unlike GCC), 346 # with `-Wmissing-declarations` (unlike GCC), so it is not strictly needed here
294 # given it is `libclang`; but for consistency, 347 # given it is `libclang`; but for consistency, future Clang changes and/or
295 # a potential future GCC backend for `bindgen` 348 # a potential future GCC backend for `bindgen`, we disable it too.
296 $(obj)/bindings/bindings_helpers_generated.rs: 349 $(obj)/bindings/bindings_helpers_generated.rs: private bindgen_target_flags = \
297 --blocklist-type '.*' --allowlist-var '' \ 350 --blocklist-type '.*' --allowlist-var '' \
298 --allowlist-function 'rust_helper_.*' 351 --allowlist-function 'rust_helper_.*'
299 $(obj)/bindings/bindings_helpers_generated.rs: 352 $(obj)/bindings/bindings_helpers_generated.rs: private bindgen_target_cflags = \
300 -I$(objtree)/$(obj) -Wno-missing-prototype 353 -I$(objtree)/$(obj) -Wno-missing-prototypes -Wno-missing-declarations
301 $(obj)/bindings/bindings_helpers_generated.rs: 354 $(obj)/bindings/bindings_helpers_generated.rs: private bindgen_target_extra = ; \
302 sed -Ei 's/pub fn rust_helper_([a-zA-Z0-9_ 355 sed -Ei 's/pub fn rust_helper_([a-zA-Z0-9_]*)/#[link_name="rust_helper_\1"]\n pub fn \1/g' $@
303 $(obj)/bindings/bindings_helpers_generated.rs: !! 356 $(obj)/bindings/bindings_helpers_generated.rs: $(src)/helpers.c FORCE
304 $(call if_changed_dep,bindgen) 357 $(call if_changed_dep,bindgen)
305 358
306 quiet_cmd_exports = EXPORTS $@ 359 quiet_cmd_exports = EXPORTS $@
307 cmd_exports = \ 360 cmd_exports = \
308 $(NM) -p --defined-only $< \ 361 $(NM) -p --defined-only $< \
309 | awk '$$2~/(T|R|D|B)/ && $$3! !! 362 | awk '/ (T|R|D|B) / {printf "EXPORT_SYMBOL_RUST_GPL(%s);\n",$$3}' > $@
310 363
311 $(obj)/exports_core_generated.h: $(obj)/core.o 364 $(obj)/exports_core_generated.h: $(obj)/core.o FORCE
312 $(call if_changed,exports) 365 $(call if_changed,exports)
313 366
314 $(obj)/exports_alloc_generated.h: $(obj)/alloc 367 $(obj)/exports_alloc_generated.h: $(obj)/alloc.o FORCE
315 $(call if_changed,exports) 368 $(call if_changed,exports)
316 369
317 # Even though Rust kernel modules should never <<
318 # symbols from the `bindings` crate and the C <<
319 # because Rust generics and inlined functions <<
320 # in the crate where they are defined. Other h <<
321 # functions, may not be exported, in principle <<
322 # compiler does not guarantee codegen will be <<
323 # function either. Therefore, we export all sy <<
324 # In the future, this may be revisited to redu <<
325 # the compiler is informed about the places co <<
326 $(obj)/exports_helpers_generated.h: $(obj)/hel <<
327 $(call if_changed,exports) <<
328 <<
329 $(obj)/exports_bindings_generated.h: $(obj)/bi 370 $(obj)/exports_bindings_generated.h: $(obj)/bindings.o FORCE
330 $(call if_changed,exports) 371 $(call if_changed,exports)
331 372
332 $(obj)/exports_kernel_generated.h: $(obj)/kern 373 $(obj)/exports_kernel_generated.h: $(obj)/kernel.o FORCE
333 $(call if_changed,exports) 374 $(call if_changed,exports)
334 375
335 quiet_cmd_rustc_procmacro = $(RUSTC_OR_CLIPPY_ 376 quiet_cmd_rustc_procmacro = $(RUSTC_OR_CLIPPY_QUIET) P $@
336 cmd_rustc_procmacro = \ 377 cmd_rustc_procmacro = \
337 $(RUSTC_OR_CLIPPY) $(rust_common_flags 378 $(RUSTC_OR_CLIPPY) $(rust_common_flags) \
338 -Clinker-flavor=gcc -Clinker=$ 379 -Clinker-flavor=gcc -Clinker=$(HOSTCC) \
339 -Clink-args='$(call escsq,$(KB 380 -Clink-args='$(call escsq,$(KBUILD_HOSTLDFLAGS))' \
340 --emit=dep-info=$(depfile) --e 381 --emit=dep-info=$(depfile) --emit=link=$@ --extern proc_macro \
341 --crate-type proc-macro \ 382 --crate-type proc-macro \
342 --crate-name $(patsubst lib%.s 383 --crate-name $(patsubst lib%.so,%,$(notdir $@)) $<
343 384
344 # Procedural macros can only be used with the 385 # Procedural macros can only be used with the `rustc` that compiled it.
345 $(obj)/libmacros.so: $(src)/macros/lib.rs FORC !! 386 # Therefore, to get `libmacros.so` automatically recompiled when the compiler
>> 387 # version changes, we add `core.o` as a dependency (even if it is not needed).
>> 388 $(obj)/libmacros.so: $(src)/macros/lib.rs $(obj)/core.o FORCE
346 +$(call if_changed_dep,rustc_procmacro 389 +$(call if_changed_dep,rustc_procmacro)
347 390
348 quiet_cmd_rustc_library = $(if $(skip_clippy), 391 quiet_cmd_rustc_library = $(if $(skip_clippy),RUSTC,$(RUSTC_OR_CLIPPY_QUIET)) L $@
349 cmd_rustc_library = \ 392 cmd_rustc_library = \
350 OBJTREE=$(abspath $(objtree)) \ 393 OBJTREE=$(abspath $(objtree)) \
351 $(if $(skip_clippy),$(RUSTC),$(RUSTC_O 394 $(if $(skip_clippy),$(RUSTC),$(RUSTC_OR_CLIPPY)) \
352 $(filter-out $(skip_flags),$(r 395 $(filter-out $(skip_flags),$(rust_flags) $(rustc_target_flags)) \
353 --emit=dep-info=$(depfile) --e 396 --emit=dep-info=$(depfile) --emit=obj=$@ \
354 --emit=metadata=$(dir $@)$(pat 397 --emit=metadata=$(dir $@)$(patsubst %.o,lib%.rmeta,$(notdir $@)) \
355 --crate-type rlib -L$(objtree) 398 --crate-type rlib -L$(objtree)/$(obj) \
356 --crate-name $(patsubst %.o,%, 399 --crate-name $(patsubst %.o,%,$(notdir $@)) $< \
357 --sysroot=/dev/null \ 400 --sysroot=/dev/null \
358 $(if $(rustc_objcopy),;$(OBJCOPY) $(ru !! 401 $(if $(rustc_objcopy),;$(OBJCOPY) $(rustc_objcopy) $@)
359 $(cmd_objtool) <<
360 402
361 rust-analyzer: 403 rust-analyzer:
362 $(Q)$(srctree)/scripts/generate_rust_a 404 $(Q)$(srctree)/scripts/generate_rust_analyzer.py \
363 --cfgs='core=$(core-cfgs)' --c 405 --cfgs='core=$(core-cfgs)' --cfgs='alloc=$(alloc-cfgs)' \
364 $(realpath $(srctree)) $(realp 406 $(realpath $(srctree)) $(realpath $(objtree)) \
365 $(rustc_sysroot) $(RUST_LIB_SR !! 407 $(RUST_LIB_SRC) $(KBUILD_EXTMOD) > \
366 $(if $(KBUILD_EXTMOD),$(extmod 408 $(if $(KBUILD_EXTMOD),$(extmod_prefix),$(objtree))/rust-project.json
367 409
368 redirect-intrinsics = \ 410 redirect-intrinsics = \
369 __addsf3 __eqsf2 __extendsfdf2 __gesf2 !! 411 __addsf3 __eqsf2 __gesf2 __lesf2 __ltsf2 __mulsf3 __nesf2 __unordsf2 \
370 __adddf3 __eqdf2 __ledf2 __ltdf2 __mul !! 412 __adddf3 __ledf2 __ltdf2 __muldf3 __unorddf2 \
371 __muloti4 __multi3 \ 413 __muloti4 __multi3 \
372 __udivmodti4 __udivti3 __umodti3 414 __udivmodti4 __udivti3 __umodti3
373 415
374 ifneq ($(or $(CONFIG_ARM64),$(and $(CONFIG_RIS 416 ifneq ($(or $(CONFIG_ARM64),$(and $(CONFIG_RISCV),$(CONFIG_64BIT))),)
375 # These intrinsics are defined for ARM 417 # These intrinsics are defined for ARM64 and RISCV64
376 redirect-intrinsics += \ 418 redirect-intrinsics += \
377 __ashrti3 \ 419 __ashrti3 \
378 __ashlti3 __lshrti3 420 __ashlti3 __lshrti3
379 endif 421 endif
380 422
381 define rule_rustc_library <<
382 $(call cmd_and_fixdep,rustc_library) <<
383 $(call cmd,gen_objtooldep) <<
384 endef <<
385 <<
386 $(obj)/core.o: private skip_clippy = 1 423 $(obj)/core.o: private skip_clippy = 1
387 $(obj)/core.o: private skip_flags = -Wunreacha !! 424 $(obj)/core.o: private skip_flags = -Dunreachable_pub
388 $(obj)/core.o: private rustc_objcopy = $(forea 425 $(obj)/core.o: private rustc_objcopy = $(foreach sym,$(redirect-intrinsics),--redefine-sym $(sym)=__rust$(sym))
389 $(obj)/core.o: private rustc_target_flags = $( 426 $(obj)/core.o: private rustc_target_flags = $(core-cfgs)
390 $(obj)/core.o: $(RUST_LIB_SRC)/core/src/lib.rs !! 427 $(obj)/core.o: $(RUST_LIB_SRC)/core/src/lib.rs FORCE
391 $(wildcard $(objtree)/include/config/RUSTC !! 428 +$(call if_changed_dep,rustc_library)
392 +$(call if_changed_rule,rustc_library) !! 429 ifdef CONFIG_X86_64
393 ifneq ($(or $(CONFIG_X86_64),$(CONFIG_X86_32)) <<
394 $(obj)/core.o: scripts/target.json 430 $(obj)/core.o: scripts/target.json
395 endif 431 endif
396 432
397 $(obj)/compiler_builtins.o: private rustc_objc 433 $(obj)/compiler_builtins.o: private rustc_objcopy = -w -W '__*'
398 $(obj)/compiler_builtins.o: $(src)/compiler_bu 434 $(obj)/compiler_builtins.o: $(src)/compiler_builtins.rs $(obj)/core.o FORCE
399 +$(call if_changed_rule,rustc_library) !! 435 +$(call if_changed_dep,rustc_library)
400 436
401 $(obj)/alloc.o: private skip_clippy = 1 437 $(obj)/alloc.o: private skip_clippy = 1
402 $(obj)/alloc.o: private skip_flags = -Wunreach !! 438 $(obj)/alloc.o: private skip_flags = -Dunreachable_pub
403 $(obj)/alloc.o: private rustc_target_flags = $ 439 $(obj)/alloc.o: private rustc_target_flags = $(alloc-cfgs)
404 $(obj)/alloc.o: $(RUST_LIB_SRC)/alloc/src/lib. 440 $(obj)/alloc.o: $(RUST_LIB_SRC)/alloc/src/lib.rs $(obj)/compiler_builtins.o FORCE
405 +$(call if_changed_rule,rustc_library) !! 441 +$(call if_changed_dep,rustc_library)
406 442
407 $(obj)/build_error.o: $(src)/build_error.rs $( 443 $(obj)/build_error.o: $(src)/build_error.rs $(obj)/compiler_builtins.o FORCE
408 +$(call if_changed_rule,rustc_library) !! 444 +$(call if_changed_dep,rustc_library)
409 445
410 $(obj)/bindings.o: $(src)/bindings/lib.rs \ 446 $(obj)/bindings.o: $(src)/bindings/lib.rs \
411 $(obj)/compiler_builtins.o \ 447 $(obj)/compiler_builtins.o \
412 $(obj)/bindings/bindings_generated.rs \ 448 $(obj)/bindings/bindings_generated.rs \
413 $(obj)/bindings/bindings_helpers_generated 449 $(obj)/bindings/bindings_helpers_generated.rs FORCE
414 +$(call if_changed_rule,rustc_library) !! 450 +$(call if_changed_dep,rustc_library)
415 451
416 $(obj)/uapi.o: $(src)/uapi/lib.rs \ 452 $(obj)/uapi.o: $(src)/uapi/lib.rs \
417 $(obj)/compiler_builtins.o \ 453 $(obj)/compiler_builtins.o \
418 $(obj)/uapi/uapi_generated.rs FORCE 454 $(obj)/uapi/uapi_generated.rs FORCE
419 +$(call if_changed_rule,rustc_library) !! 455 +$(call if_changed_dep,rustc_library)
420 456
421 $(obj)/kernel.o: private rustc_target_flags = 457 $(obj)/kernel.o: private rustc_target_flags = --extern alloc \
422 --extern build_error --extern macros --ext 458 --extern build_error --extern macros --extern bindings --extern uapi
423 $(obj)/kernel.o: $(src)/kernel/lib.rs $(obj)/a 459 $(obj)/kernel.o: $(src)/kernel/lib.rs $(obj)/alloc.o $(obj)/build_error.o \
424 $(obj)/libmacros.so $(obj)/bindings.o $(ob 460 $(obj)/libmacros.so $(obj)/bindings.o $(obj)/uapi.o FORCE
425 +$(call if_changed_rule,rustc_library) !! 461 +$(call if_changed_dep,rustc_library)
426 462
427 endif # CONFIG_RUST 463 endif # CONFIG_RUST
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.