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