Lines Matching +full:test +full:- +full:docs
1 # SPDX-License-Identifier: GPL-2.0
6 obj-$(CONFIG_RUST) += core.o compiler_builtins.o ffi.o
7 always-$(CONFIG_RUST) += exports_core_generated.h
10 always-$(CONFIG_RUST) += helpers/helpers.bc helpers/helpers_module.bc
12 obj-$(CONFIG_RUST) += helpers/helpers.o
13 always-$(CONFIG_RUST) += exports_helpers_generated.h
17 CFLAGS_REMOVE_helpers/helpers.o = -Wmissing-prototypes -Wmissing-declarations
19 always-$(CONFIG_RUST) += bindings/bindings_generated.rs bindings/bindings_helpers_generated.rs
20 obj-$(CONFIG_RUST) += bindings.o pin_init.o kernel.o
21 always-$(CONFIG_RUST) += exports_bindings_generated.h exports_kernel_generated.h
23 always-$(CONFIG_RUST) += uapi/uapi_generated.rs
24 obj-$(CONFIG_RUST) += uapi.o
27 obj-$(CONFIG_RUST) += build_error.o
29 always-$(CONFIG_RUST) += build_error.o
32 obj-$(CONFIG_RUST) += exports.o
34 always-$(CONFIG_RUST) += libproc_macro2.rlib libquote.rlib libsyn.rlib
36 always-$(CONFIG_RUST_KERNEL_DOCTESTS) += doctests_kernel_generated.rs
37 always-$(CONFIG_RUST_KERNEL_DOCTESTS) += doctests_kernel_generated_kunit.c
39 obj-$(CONFIG_RUST_KERNEL_DOCTESTS) += doctests_kernel_generated.o
40 obj-$(CONFIG_RUST_KERNEL_DOCTESTS) += doctests_kernel_generated_kunit.o
42 always-$(subst y,$(CONFIG_RUST),$(CONFIG_JUMP_LABEL)) += kernel/generated_arch_static_branch_asm.rs
44 always-$(subst y,$(CONFIG_RUST),$(CONFIG_BUG)) += kernel/generated_arch_warn_asm.rs kernel/generate…
50 …bmacros_name := $(shell MAKEFLAGS= $(RUSTC) --print file-names --crate-name macros --crate-type pr…
53 …al_name := $(shell MAKEFLAGS= $(RUSTC) --print file-names --crate-name pin_init_internal --crate-t…
56 always-$(CONFIG_RUST) += $(libmacros_name) $(libpin_init_internal_name)
58 # `$(rust_flags)` is passed in case the user added `--sysroot`.
59 rustc_sysroot := $(shell MAKEFLAGS= $(RUSTC) $(rust_flags) --print sysroot)
60 rustc_host_target := $(shell $(RUSTC) --version --verbose | grep -F 'host: ' | cut -d' ' -f2)
64 rust_test_quiet=-q
65 rustdoc_test_quiet=--test-args -q
69 cfgs-to-flags = $(patsubst %,--cfg='%',$1)
71 core-cfgs := \
74 core-edition := $(if $(call rustc-min-version,108700),2024,2021)
76 core-skip_flags := \
77 --edition=2021 \
78 -Wunreachable_pub
80 core-flags := \
81 --edition=$(core-edition) \
82 $(call cfgs-to-flags,$(core-cfgs))
84 proc_macro2-cfgs := \
85 feature="proc-macro" \
87 $(if $(call rustc-min-version,108800),proc_macro_span_file proc_macro_span_location)
89 proc_macro2-flags := \
90 --cap-lints=allow \
91 $(call cfgs-to-flags,$(proc_macro2-cfgs))
93 quote-cfgs := \
94 feature="proc-macro"
96 quote-skip_flags := \
97 --edition=2021
99 quote-flags := \
100 --edition=2018 \
101 --cap-lints=allow \
102 --extern proc_macro2 \
103 $(call cfgs-to-flags,$(quote-cfgs))
105 # `extra-traits`, `fold` and `visit` may be enabled if needed.
106 syn-cfgs := \
107 feature="clone-impls" \
112 feature="proc-macro" \
113 feature="visit-mut"
115 syn-flags := \
116 --cap-lints=allow \
117 --extern proc_macro2 \
118 --extern quote \
119 $(call cfgs-to-flags,$(syn-cfgs))
121 pin_init_internal-cfgs := \
124 pin_init_internal-flags := \
125 --extern proc_macro2 \
126 --extern quote \
127 --extern syn \
128 $(call cfgs-to-flags,$(pin_init_internal-cfgs))
130 pin_init-cfgs := \
133 pin_init-flags := \
134 --extern pin_init_internal \
135 --extern macros \
136 $(call cfgs-to-flags,$(pin_init-cfgs))
139 # the time being (https://github.com/rust-lang/rust/issues/144521).
140 rustdoc_modifiers_workaround := $(if $(call rustc-min-version,108800),-Cunsafe-allow-abi-mismatch=f…
142 # Similarly, for doctests (https://github.com/rust-lang/rust/issues/146465).
143 doctests_modifiers_workaround := $(rustdoc_modifiers_workaround)$(if $(call rustc-min-version,10910…
148 …$(RUSTDOC) $(filter-out $(skip_flags) --remap-path-scope=%,$(if $(rustdoc_host),$(rust_common_flag…
149 $(rustc_target_flags) -L$(objtree)/$(obj) \
150 -Zunstable-options --generate-link-to-definition \
151 --output $(rustdoc_output) \
152 --crate-name $(subst rustdoc-,,$@) \
154 $(if $(rustdoc_host),,--sysroot=/dev/null) \
159 # - The given value is used as-is, thus it cannot be relative or a local file
160 # (unlike the non-custom case) since the generated docs have subfolders.
161 # - It requires adding it to every crate.
162 # - It requires changing `core` which comes from the sysroot.
164 # Using `-Zcrate-attr` would solve the last two points, but not the first.
165 # The https://github.com/rust-lang/rfcs/pull/3226 RFC suggests two new
166 # command-like flags to solve the issue. Meanwhile, we use the non-custom case
168 rustdoc: rustdoc-core rustdoc-macros rustdoc-compiler_builtins \
169 rustdoc-kernel rustdoc-pin_init
170 $(Q)grep -Ehro '<a href="srctree/([^"]+)"' $(rustdoc_output) | \
171 cut -d'"' -f2 | cut -d/ -f2- | while read f; do \
172 if [ ! -e "$(srctree)/$$f" ]; then \
177 $(Q)cp $(srctree)/Documentation/images/COPYING-logo $(rustdoc_output)/static.files/
178 $(Q)find $(rustdoc_output) -name '*.html' -type f -print0 | xargs -0 sed -Ei \
179 -e 's:rust-logo-[0-9a-f]+\.svg:logo.svg:g' \
180 -e 's:favicon-[0-9a-f]+\.svg:logo.svg:g' \
181 …-e 's:<link rel="alternate icon" type="image/png" href="[/.]+/static\.files/favicon-(16x16|32x32)-…
182 -e 's:<a href="srctree/([^"]+)">:<a href="$(realpath $(srctree))/\1">:g'
183 $(Q)for f in $(rustdoc_output)/static.files/rustdoc-*.css; do \
184 echo ".logo-container > img { object-fit: contain; }" >> $$f; done
186 rustdoc-proc_macro2: private rustdoc_host = yes
187 rustdoc-proc_macro2: private rustc_target_flags = $(proc_macro2-flags)
188 rustdoc-proc_macro2: $(src)/proc-macro2/lib.rs rustdoc-clean FORCE
191 rustdoc-quote: private rustdoc_host = yes
192 rustdoc-quote: private rustc_target_flags = $(quote-flags)
193 rustdoc-quote: private skip_flags = $(quote-skip_flags)
194 rustdoc-quote: $(src)/quote/lib.rs rustdoc-clean rustdoc-proc_macro2 FORCE
197 rustdoc-syn: private rustdoc_host = yes
198 rustdoc-syn: private rustc_target_flags = $(syn-flags)
199 rustdoc-syn: $(src)/syn/lib.rs rustdoc-clean rustdoc-quote FORCE
202 rustdoc-macros: private rustdoc_host = yes
203 rustdoc-macros: private rustc_target_flags = --crate-type proc-macro \
204 --extern proc_macro --extern proc_macro2 --extern quote --extern syn
205 rustdoc-macros: $(src)/macros/lib.rs rustdoc-clean rustdoc-proc_macro2 \
206 rustdoc-quote rustdoc-syn FORCE
209 rustdoc-core: private skip_flags = $(core-skip_flags)
210 rustdoc-core: private rustc_target_flags = $(core-flags)
211 rustdoc-core: $(RUST_LIB_SRC)/core/src/lib.rs rustdoc-clean FORCE
217 rustdoc-compiler_builtins: private is-kernel-object := y
218 rustdoc-compiler_builtins: $(src)/compiler_builtins.rs rustdoc-core FORCE
221 rustdoc-ffi: private is-kernel-object := y
222 rustdoc-ffi: $(src)/ffi.rs rustdoc-core FORCE
225 rustdoc-pin_init_internal: private rustdoc_host = yes
226 rustdoc-pin_init_internal: private rustc_target_flags = $(pin_init_internal-flags) \
227 --extern proc_macro --crate-type proc-macro
228 rustdoc-pin_init_internal: $(src)/pin-init/internal/src/lib.rs \
229 rustdoc-clean rustdoc-proc_macro2 rustdoc-quote rustdoc-syn FORCE
232 rustdoc-pin_init: private rustdoc_host = yes
233 rustdoc-pin_init: private rustc_target_flags = $(pin_init-flags) \
234 --extern alloc --cfg feature=\"alloc\"
235 rustdoc-pin_init: $(src)/pin-init/src/lib.rs rustdoc-pin_init_internal \
236 rustdoc-macros FORCE
239 rustdoc-kernel: private is-kernel-object := y
240 rustdoc-kernel: private rustc_target_flags = --extern ffi --extern pin_init \
241 --extern build_error --extern macros \
242 --extern bindings --extern uapi
243 rustdoc-kernel: $(src)/kernel/lib.rs rustdoc-core rustdoc-ffi rustdoc-macros \
244 rustdoc-pin_init rustdoc-compiler_builtins $(obj)/$(libmacros_name) \
248 rustdoc-clean: FORCE
249 $(Q)rm -rf $(rustdoc_output)
254 $(RUSTC_OR_CLIPPY) $(filter-out $(skip_flags),$(rust_common_flags) $(rustc_target_flags)) \
256 --crate-type $(if $(rustc_test_library_proc),proc-macro,rlib) \
257 --out-dir $(objtree)/$(obj)/test --cfg testlib \
258 -L$(objtree)/$(obj)/test \
259 --crate-name $(subst rusttest-,,$(subst rusttestlib-,,$@)) $<
261 rusttestlib-build_error: $(src)/build_error.rs FORCE
264 rusttestlib-ffi: $(src)/ffi.rs FORCE
267 rusttestlib-proc_macro2: private rustc_target_flags = $(proc_macro2-flags)
268 rusttestlib-proc_macro2: $(src)/proc-macro2/lib.rs FORCE
271 rusttestlib-quote: private skip_flags = $(quote-skip_flags)
272 rusttestlib-quote: private rustc_target_flags = $(quote-flags)
273 rusttestlib-quote: $(src)/quote/lib.rs rusttestlib-proc_macro2 FORCE
276 rusttestlib-syn: private rustc_target_flags = $(syn-flags)
277 rusttestlib-syn: $(src)/syn/lib.rs rusttestlib-quote FORCE
280 rusttestlib-macros: private rustc_target_flags = --extern proc_macro \
281 --extern proc_macro2 --extern quote --extern syn
282 rusttestlib-macros: private rustc_test_library_proc = yes
283 rusttestlib-macros: $(src)/macros/lib.rs \
284 rusttestlib-proc_macro2 rusttestlib-quote rusttestlib-syn FORCE
287 rusttestlib-pin_init_internal: private rustc_target_flags = $(pin_init_internal-flags) \
288 --extern proc_macro
289 rusttestlib-pin_init_internal: private rustc_test_library_proc = yes
290 rusttestlib-pin_init_internal: $(src)/pin-init/internal/src/lib.rs \
291 rusttestlib-proc_macro2 rusttestlib-quote rusttestlib-syn FORCE
294 rusttestlib-pin_init: private rustc_target_flags = $(pin_init-flags)
295 rusttestlib-pin_init: $(src)/pin-init/src/lib.rs rusttestlib-macros \
296 rusttestlib-pin_init_internal $(obj)/$(libpin_init_internal_name) FORCE
299 rusttestlib-kernel: private rustc_target_flags = --extern ffi \
300 --extern build_error --extern macros --extern pin_init \
301 --extern bindings --extern uapi
302 rusttestlib-kernel: $(src)/kernel/lib.rs rusttestlib-bindings rusttestlib-uapi \
303 rusttestlib-build_error rusttestlib-pin_init $(obj)/$(libmacros_name) \
307 rusttestlib-bindings: private rustc_target_flags = --extern ffi --extern pin_init
308 rusttestlib-bindings: $(src)/bindings/lib.rs rusttestlib-ffi rusttestlib-pin_init FORCE
311 rusttestlib-uapi: private rustc_target_flags = --extern ffi --extern pin_init
312 rusttestlib-uapi: $(src)/uapi/lib.rs rusttestlib-ffi rusttestlib-pin_init FORCE
317 RUST_MODFILE=test.rs \
319 $(RUSTDOC) --test $(rust_common_flags) \
320 -Zcrate-attr='feature(used_with_arg)' \
324 -L$(objtree)/$(obj)/test --output $(rustdoc_output) \
325 --crate-name $(subst rusttest-,,$@) $<
329 rm -rf $(objtree)/$(obj)/test/doctests/kernel; \
330 mkdir -p $(objtree)/$(obj)/test/doctests/kernel; \
332 $(RUSTDOC) --test $(filter-out --remap-path-scope=%,$(rust_flags)) \
333 -L$(objtree)/$(obj) --extern ffi --extern pin_init \
334 --extern kernel --extern build_error --extern macros \
335 --extern bindings --extern uapi \
336 --no-run --crate-name kernel -Zunstable-options \
337 --sysroot=/dev/null \
339 --test-builder $(objtree)/scripts/rustdoc_test_builder \
349 # We cannot use `-Zpanic-abort-tests` because some tests are dynamic,
350 # so for the moment we skip `-Cpanic=abort`.
354 $(RUSTC_OR_CLIPPY) --test $(rust_common_flags) \
356 $(rustc_target_flags) --out-dir $(objtree)/$(obj)/test \
357 -L$(objtree)/$(obj)/test \
358 --crate-name $(subst rusttest-,,$@) $<; \
359 $(objtree)/$(obj)/test/$(subst rusttest-,,$@) $(rust_test_quiet) \
362 rusttest: rusttest-macros
364 rusttest-macros: private rustc_target_flags = --extern proc_macro \
365 --extern macros --extern kernel --extern pin_init \
366 --extern proc_macro2 --extern quote --extern syn
367 rusttest-macros: private rustdoc_test_target_flags = --crate-type proc-macro
368 rusttest-macros: $(src)/macros/lib.rs \
369 rusttestlib-macros rusttestlib-kernel rusttestlib-pin_init FORCE
382 bindgen_skip_c_flags := -mno-fp-ret-in-387 -mpreferred-stack-boundary=% \
383 -mskip-rax-setup -mgeneral-regs-only -msign-return-address=% \
384 -mindirect-branch=thunk-extern -mindirect-branch-register \
385 -mfunction-return=thunk-extern -mrecord-mcount -mabi=lp64 \
386 -mindirect-branch-cs-prefix -mstack-protector-guard% -mtraceback=no \
387 -mno-pointers-to-nested-functions -mno-string \
388 -mno-strict-align -mstrict-align -mdirect-extern-access \
389 -mexplicit-relocs -mno-check-zero-division \
390 -fconserve-stack -falign-jumps=% -falign-loops=% \
391 -femit-struct-debug-baseonly -fno-ipa-cp-clone -fno-ipa-sra \
392 -fno-partial-inlining -fplugin-arg-arm_ssp_per_task_plugin-% \
393 -fno-reorder-blocks -fno-allow-store-data-races -fasan-shadow-offset=% \
394 -fzero-call-used-regs=% -fno-stack-clash-protection \
395 -fno-inline-functions-called-once -fsanitize=bounds-strict \
396 -fstrict-flex-arrays=% -fmin-function-alignment=% \
397 -fzero-init-padding-bits=% -mno-fdpic \
398 -fdiagnostics-show-context -fdiagnostics-show-context=% \
399 --param=% --param asan-% -fno-isolate-erroneous-paths-dereference
402 BINDGEN_TARGET_x86 := x86_64-linux-gnu
403 BINDGEN_TARGET_arm64 := aarch64-linux-gnu
404 BINDGEN_TARGET_arm := arm-linux-gnueabi
405 BINDGEN_TARGET_loongarch := loongarch64-linux-gnusf
406 # This is only for i386 UM builds, which need the 32-bit target not -m32
407 BINDGEN_TARGET_i386 := i386-linux-gnu
414 bindgen_extra_c_flags = -w --target=$(BINDGEN_TARGET)
416 # Auto variable zero-initialization requires an additional special option with
418 # clang-18), so make sure to pass this option only if clang supports it
421 # https://github.com/llvm/llvm-project/issues/44842
422 # https://github.com/llvm/llvm-project/blob/llvmorg-16.0.0-rc2/clang/docs/ReleaseNotes.rst#deprecat…
424 …tree)/scripts/rust_is_available_bindgen_libclang.h 2>&1 | sed -ne 's/.*clang version \([0-9]*\).*/…
426 bindgen_extra_c_flags += -enable-trivial-auto-var-init-zero-knowing-it-will-be-removed-from-clang
430 bindgen_c_flags = $(filter-out $(bindgen_skip_c_flags), $(c_flags)) \
435 bindgen_c_flags_lto = $(filter-out $(CC_FLAGS_LTO), $(bindgen_c_flags))
440 # `-fno-builtin` is passed to avoid `bindgen` from using `clang` builtin
441 # prototypes for functions like `memcpy` -- if this flag is not passed,
442 # `bindgen`-generated prototypes use `c_ulong` or `c_uint` depending on
444 bindgen_c_flags_final = $(bindgen_c_flags_lto) -fno-builtin -D__BINDGEN__
446 # `--rust-target` points to our minimum supported Rust version.
449 $(BINDGEN) $< $(bindgen_target_flags) --rust-target 1.85 \
450 --use-core --with-derive-default --ctypes-prefix ffi --no-layout-tests \
451 --no-debug '.*' --enable-function-attribute-detection \
452 -o $@ -- $(bindgen_c_flags_final) -DMODULE \
456 $(shell grep -Ev '^#|^$$' $(src)/bindgen_parameters)
458 sed -Ei 's/pub const RUST_CONST_HELPER_([a-zA-Z0-9_]*)/pub const \1/g' $@
464 $(shell grep -Ev '^#|^$$' $(src)/bindgen_parameters)
470 # with `-Wmissing-declarations` (unlike GCC), so it is not strictly needed here
474 --blocklist-type '.*' --allowlist-var '' \
475 --allowlist-function 'rust_helper_.*'
477 -I$(objtree)/$(obj) -Wno-missing-prototypes -Wno-missing-declarations
479 sed -Ei 's/pub fn rust_helper_([a-zA-Z0-9_]*)/#[link_name="rust_helper_\1"]\n pub fn \1/g' $@
485 $(CC) $(filter-out $(CFLAGS_REMOVE_helpers/helpers.o), $(c_flags)) \
486 -c -g0 $< -emit-llvm -o $@
488 $(obj)/helpers/helpers.bc: private part-of-builtin := y
489 $(obj)/helpers/helpers_module.bc: private part-of-module := y
493 rust_exports = $(NM) -p --defined-only $(1) | awk '$$2~/(T|R|D|B)/ && $$3!~/__(pfx|cfi|odr_asan)/ {…
505 # in the crate where they are defined. Other helpers, called from non-inline
507 # compiler does not guarantee codegen will be performed for a non-inline
523 $(filter-out $(skip_flags),$(rust_common_flags) $(rustc_target_flags)) \
524 --emit=dep-info=$(depfile) --emit=link=$@ --crate-type rlib -O \
525 --out-dir $(objtree)/$(obj) -L$(objtree)/$(obj) \
526 --crate-name $(patsubst lib%.rlib,%,$(notdir $@)) $<
529 $(obj)/libproc_macro2.rlib: private rustc_target_flags = $(proc_macro2-flags)
530 $(obj)/libproc_macro2.rlib: $(src)/proc-macro2/lib.rs FORCE
534 $(obj)/libquote.rlib: private skip_flags = $(quote-skip_flags)
535 $(obj)/libquote.rlib: private rustc_target_flags = $(quote-flags)
540 $(obj)/libsyn.rlib: private rustc_target_flags = $(syn-flags)
547 -Clinker-flavor=gcc -Clinker=$(HOSTCC) \
548 -Clink-args='$(call escsq,$(KBUILD_PROCMACROLDFLAGS))' \
549 --emit=dep-info=$(depfile) --emit=link=$@ --extern proc_macro \
550 --crate-type proc-macro -L$(objtree)/$(obj) \
551 --crate-name $(patsubst lib%.$(libmacros_extension),%,$(notdir $@)) \
556 --extern proc_macro2 --extern quote --extern syn
561 $(obj)/$(libpin_init_internal_name): private rustc_target_flags = $(pin_init_internal-flags)
562 $(obj)/$(libpin_init_internal_name): $(src)/pin-init/internal/src/lib.rs \
566 # `rustc` requires `-Zunstable-options` to use custom target specifications
567 # since Rust 1.95.0 (https://github.com/rust-lang/rust/pull/151534).
572 $(filter-out $(skip_flags),$(rust_flags)) $(rustc_target_flags) \
573 --emit=dep-info=$(depfile) --emit=$(if $(link_helper),llvm-bc=$(patsubst %.o,%.bc,$@),obj=$@) \
574 --emit=metadata=$(dir $@)$(patsubst %.o,lib%.rmeta,$(notdir $@)) \
575 --crate-type rlib -L$(objtree)/$(obj) \
576 --crate-name $(patsubst %.o,%,$(notdir $@)) $< \
577 --sysroot=/dev/null \
578 -Zunstable-options \
579 $(if $(link_helper),;$(LLVM_LINK) --internalize --suppress-warnings $(patsubst %.o,%.bc,$@) \
580 $(obj)/helpers/helpers$(if $(part-of-module),_module).bc -o $(patsubst %.o,%.m.bc,$@); \
581 $(CC) $(CLANG_FLAGS) $(KBUILD_CFLAGS) -Wno-override-module -c $(patsubst %.o,%.m.bc,$@) -o $@ \
586 rust-analyzer:
588 --cfgs='core=$(core-cfgs)' $(core-edition) \
589 --cfgs='proc_macro2=$(proc_macro2-cfgs)' \
590 --cfgs='quote=$(quote-cfgs)' \
591 --cfgs='syn=$(syn-cfgs)' \
592 --cfgs='pin_init_internal=$(pin_init_internal-cfgs)' \
593 --cfgs='pin_init=$(pin_init-cfgs)' \
596 > rust-project.json
598 redirect-intrinsics = \
605 # Add eabi initrinsics for ARM 32-bit
606 redirect-intrinsics += \
613 redirect-intrinsics += \
622 $(if $(KBUILD_GENDWARFKSYMS_STABLE), --stable) \
623 $(if $(KBUILD_SYMTYPES), --symtypes $(@:.o=.symtypes),) \
624 $@ >> $(dot-target).cmd)
649 $(obj)/core.o: private skip_flags = $(core-skip_flags)
650 $(obj)/core.o: private rustc_objcopy = $(foreach sym,$(redirect-intrinsics),--redefine-sym $(sym)=_…
651 $(obj)/core.o: private rustc_target_flags = $(core-flags)
661 $(obj)/compiler_builtins.o: private rustc_objcopy = -w -W '__*'
666 $(obj)/pin_init.o: private rustc_target_flags = $(pin_init-flags)
667 $(obj)/pin_init.o: $(src)/pin-init/src/lib.rs $(obj)/compiler_builtins.o \
674 $(obj)/build_error.o: private is-kernel-object := y
683 $(obj)/bindings.o: private rustc_target_flags = --extern ffi --extern pin_init
691 $(obj)/uapi.o: private rustc_target_flags = --extern ffi --extern pin_init
699 $(obj)/kernel.o: private rustc_target_flags = --extern ffi --extern pin_init \
700 --extern build_error --extern macros --extern bindings --extern uapi