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
11 obj-$(CONFIG_RUST) += helpers/helpers.o
12 CFLAGS_REMOVE_helpers/helpers.o = -Wmissing-prototypes -Wmissing-declarations
14 always-$(CONFIG_RUST) += bindings/bindings_generated.rs bindings/bindings_helpers_generated.rs
15 obj-$(CONFIG_RUST) += bindings.o pin_init.o kernel.o
16 always-$(CONFIG_RUST) += exports_helpers_generated.h \
19 always-$(CONFIG_RUST) += uapi/uapi_generated.rs
20 obj-$(CONFIG_RUST) += uapi.o
23 obj-$(CONFIG_RUST) += build_error.o
25 always-$(CONFIG_RUST) += build_error.o
28 obj-$(CONFIG_RUST) += exports.o
30 always-$(CONFIG_RUST) += libproc_macro2.rlib libquote.rlib libsyn.rlib
32 always-$(CONFIG_RUST_KERNEL_DOCTESTS) += doctests_kernel_generated.rs
33 always-$(CONFIG_RUST_KERNEL_DOCTESTS) += doctests_kernel_generated_kunit.c
35 obj-$(CONFIG_RUST_KERNEL_DOCTESTS) += doctests_kernel_generated.o
36 obj-$(CONFIG_RUST_KERNEL_DOCTESTS) += doctests_kernel_generated_kunit.o
38 always-$(subst y,$(CONFIG_RUST),$(CONFIG_JUMP_LABEL)) += kernel/generated_arch_static_branch_asm.rs
40 always-$(subst y,$(CONFIG_RUST),$(CONFIG_BUG)) += kernel/generated_arch_warn_asm.rs kernel/generate…
46 …bmacros_name := $(shell MAKEFLAGS= $(RUSTC) --print file-names --crate-name macros --crate-type pr…
49 …al_name := $(shell MAKEFLAGS= $(RUSTC) --print file-names --crate-name pin_init_internal --crate-t…
52 always-$(CONFIG_RUST) += $(libmacros_name) $(libpin_init_internal_name)
54 # `$(rust_flags)` is passed in case the user added `--sysroot`.
55 rustc_sysroot := $(shell MAKEFLAGS= $(RUSTC) $(rust_flags) --print sysroot)
56 rustc_host_target := $(shell $(RUSTC) --version --verbose | grep -F 'host: ' | cut -d' ' -f2)
60 rust_test_quiet=-q
61 rustdoc_test_quiet=--test-args -q
65 cfgs-to-flags = $(patsubst %,--cfg='%',$1)
67 core-cfgs := \
70 core-edition := $(if $(call rustc-min-version,108700),2024,2021)
72 core-skip_flags := \
73 --edition=2021 \
74 -Wunreachable_pub \
75 -Wrustdoc::unescaped_backticks
77 core-flags := \
78 --edition=$(core-edition) \
79 $(call cfgs-to-flags,$(core-cfgs))
81 proc_macro2-cfgs := \
82 feature="proc-macro" \
84 $(if $(call rustc-min-version,108800),proc_macro_span_file proc_macro_span_location)
87 proc_macro2-flags := \
88 --cap-lints=allow \
89 -Zcrate-attr='feature(proc_macro_byte_character,proc_macro_c_str_literals)' \
90 $(call cfgs-to-flags,$(proc_macro2-cfgs))
92 quote-cfgs := \
93 feature="proc-macro"
95 quote-skip_flags := \
96 --edition=2021
98 quote-flags := \
99 --edition=2018 \
100 --cap-lints=allow \
101 --extern proc_macro2 \
102 $(call cfgs-to-flags,$(quote-cfgs))
104 # `extra-traits`, `fold` and `visit` may be enabled if needed.
105 syn-cfgs := \
106 feature="clone-impls" \
111 feature="proc-macro" \
112 feature="visit-mut"
114 syn-flags := \
115 --cap-lints=allow \
116 --extern proc_macro2 \
117 --extern quote \
118 $(call cfgs-to-flags,$(syn-cfgs))
121 # the time being (https://github.com/rust-lang/rust/issues/144521).
122 rustdoc_modifiers_workaround := $(if $(call rustc-min-version,108800),-Cunsafe-allow-abi-mismatch=f…
124 # Similarly, for doctests (https://github.com/rust-lang/rust/issues/146465).
125 doctests_modifiers_workaround := $(rustdoc_modifiers_workaround)$(if $(call rustc-min-version,10910…
127 # `rustc` recognizes `--remap-path-prefix` since 1.26.0, but `rustdoc` only
128 # since Rust 1.81.0. Moreover, `rustdoc` ICEs on out-of-tree builds since Rust
129 # 1.82.0 (https://github.com/rust-lang/rust/issues/138520). Thus workaround both
134 …$(RUSTDOC) $(filter-out $(skip_flags) --remap-path-prefix=%,$(if $(rustdoc_host),$(rust_common_fla…
135 $(rustc_target_flags) -L$(objtree)/$(obj) \
136 -Zunstable-options --generate-link-to-definition \
137 --output $(rustdoc_output) \
138 --crate-name $(subst rustdoc-,,$@) \
140 $(if $(rustdoc_host),,--sysroot=/dev/null) \
145 # - The given value is used as-is, thus it cannot be relative or a local file
146 # (unlike the non-custom case) since the generated docs have subfolders.
147 # - It requires adding it to every crate.
148 # - It requires changing `core` which comes from the sysroot.
150 # Using `-Zcrate-attr` would solve the last two points, but not the first.
151 # The https://github.com/rust-lang/rfcs/pull/3226 RFC suggests two new
152 # command-like flags to solve the issue. Meanwhile, we use the non-custom case
154 rustdoc: rustdoc-core rustdoc-macros rustdoc-compiler_builtins \
155 rustdoc-kernel rustdoc-pin_init
156 $(Q)grep -Ehro '<a href="srctree/([^"]+)"' $(rustdoc_output) | \
157 cut -d'"' -f2 | cut -d/ -f2- | while read f; do \
158 if [ ! -e "$(srctree)/$$f" ]; then \
163 $(Q)cp $(srctree)/Documentation/images/COPYING-logo $(rustdoc_output)/static.files/
164 $(Q)find $(rustdoc_output) -name '*.html' -type f -print0 | xargs -0 sed -Ei \
165 -e 's:rust-logo-[0-9a-f]+\.svg:logo.svg:g' \
166 -e 's:favicon-[0-9a-f]+\.svg:logo.svg:g' \
167 …-e 's:<link rel="alternate icon" type="image/png" href="[/.]+/static\.files/favicon-(16x16|32x32)-…
168 -e 's:<a href="srctree/([^"]+)">:<a href="$(realpath $(srctree))/\1">:g'
169 $(Q)for f in $(rustdoc_output)/static.files/rustdoc-*.css; do \
170 echo ".logo-container > img { object-fit: contain; }" >> $$f; done
172 rustdoc-proc_macro2: private rustdoc_host = yes
173 rustdoc-proc_macro2: private rustc_target_flags = $(proc_macro2-flags)
174 rustdoc-proc_macro2: $(src)/proc-macro2/lib.rs rustdoc-clean FORCE
177 rustdoc-quote: private rustdoc_host = yes
178 rustdoc-quote: private rustc_target_flags = $(quote-flags)
179 rustdoc-quote: private skip_flags = $(quote-skip_flags)
180 rustdoc-quote: $(src)/quote/lib.rs rustdoc-clean rustdoc-proc_macro2 FORCE
183 rustdoc-syn: private rustdoc_host = yes
184 rustdoc-syn: private rustc_target_flags = $(syn-flags)
185 rustdoc-syn: $(src)/syn/lib.rs rustdoc-clean rustdoc-quote FORCE
188 rustdoc-macros: private rustdoc_host = yes
189 rustdoc-macros: private rustc_target_flags = --crate-type proc-macro \
190 --extern proc_macro --extern proc_macro2 --extern quote --extern syn
191 rustdoc-macros: $(src)/macros/lib.rs rustdoc-clean rustdoc-proc_macro2 \
192 rustdoc-quote rustdoc-syn FORCE
195 # Starting with Rust 1.82.0, skipping `-Wrustdoc::unescaped_backticks` should
196 # not be needed -- see https://github.com/rust-lang/rust/pull/128307.
197 rustdoc-core: private skip_flags = $(core-skip_flags)
198 rustdoc-core: private rustc_target_flags = $(core-flags)
199 rustdoc-core: $(RUST_LIB_SRC)/core/src/lib.rs rustdoc-clean FORCE
205 rustdoc-compiler_builtins: private is-kernel-object := y
206 rustdoc-compiler_builtins: $(src)/compiler_builtins.rs rustdoc-core FORCE
209 rustdoc-ffi: private is-kernel-object := y
210 rustdoc-ffi: $(src)/ffi.rs rustdoc-core FORCE
213 rustdoc-pin_init_internal: private rustdoc_host = yes
214 rustdoc-pin_init_internal: private rustc_target_flags = --cfg kernel \
215 --extern proc_macro --crate-type proc-macro
216 rustdoc-pin_init_internal: $(src)/pin-init/internal/src/lib.rs \
217 rustdoc-clean FORCE
220 rustdoc-pin_init: private rustdoc_host = yes
221 rustdoc-pin_init: private rustc_target_flags = --extern pin_init_internal \
222 --extern macros --extern alloc --cfg kernel --cfg feature=\"alloc\"
223 rustdoc-pin_init: $(src)/pin-init/src/lib.rs rustdoc-pin_init_internal \
224 rustdoc-macros FORCE
227 rustdoc-kernel: private is-kernel-object := y
228 rustdoc-kernel: private rustc_target_flags = --extern ffi --extern pin_init \
229 --extern build_error --extern macros \
230 --extern bindings --extern uapi
231 rustdoc-kernel: $(src)/kernel/lib.rs rustdoc-core rustdoc-ffi rustdoc-macros \
232 rustdoc-pin_init rustdoc-compiler_builtins $(obj)/$(libmacros_name) \
236 rustdoc-clean: FORCE
237 $(Q)rm -rf $(rustdoc_output)
242 $(RUSTC_OR_CLIPPY) $(filter-out $(skip_flags),$(rust_common_flags) $(rustc_target_flags)) \
244 --crate-type $(if $(rustc_test_library_proc),proc-macro,rlib) \
245 --out-dir $(objtree)/$(obj)/test --cfg testlib \
246 -L$(objtree)/$(obj)/test \
247 --crate-name $(subst rusttest-,,$(subst rusttestlib-,,$@)) $<
249 rusttestlib-build_error: $(src)/build_error.rs FORCE
252 rusttestlib-ffi: $(src)/ffi.rs FORCE
255 rusttestlib-proc_macro2: private rustc_target_flags = $(proc_macro2-flags)
256 rusttestlib-proc_macro2: $(src)/proc-macro2/lib.rs FORCE
259 rusttestlib-quote: private skip_flags = $(quote-skip_flags)
260 rusttestlib-quote: private rustc_target_flags = $(quote-flags)
261 rusttestlib-quote: $(src)/quote/lib.rs rusttestlib-proc_macro2 FORCE
264 rusttestlib-syn: private rustc_target_flags = $(syn-flags)
265 rusttestlib-syn: $(src)/syn/lib.rs rusttestlib-quote FORCE
268 rusttestlib-macros: private rustc_target_flags = --extern proc_macro \
269 --extern proc_macro2 --extern quote --extern syn
270 rusttestlib-macros: private rustc_test_library_proc = yes
271 rusttestlib-macros: $(src)/macros/lib.rs \
272 rusttestlib-proc_macro2 rusttestlib-quote rusttestlib-syn FORCE
275 rusttestlib-pin_init_internal: private rustc_target_flags = --cfg kernel \
276 --extern proc_macro
277 rusttestlib-pin_init_internal: private rustc_test_library_proc = yes
278 rusttestlib-pin_init_internal: $(src)/pin-init/internal/src/lib.rs FORCE
281 rusttestlib-pin_init: private rustc_target_flags = --extern pin_init_internal \
282 --extern macros --cfg kernel
283 rusttestlib-pin_init: $(src)/pin-init/src/lib.rs rusttestlib-macros \
284 rusttestlib-pin_init_internal $(obj)/$(libpin_init_internal_name) FORCE
287 rusttestlib-kernel: private rustc_target_flags = --extern ffi \
288 --extern build_error --extern macros --extern pin_init \
289 --extern bindings --extern uapi
290 rusttestlib-kernel: $(src)/kernel/lib.rs rusttestlib-bindings rusttestlib-uapi \
291 rusttestlib-build_error rusttestlib-pin_init $(obj)/$(libmacros_name) \
295 rusttestlib-bindings: private rustc_target_flags = --extern ffi --extern pin_init
296 rusttestlib-bindings: $(src)/bindings/lib.rs rusttestlib-ffi rusttestlib-pin_init FORCE
299 rusttestlib-uapi: private rustc_target_flags = --extern ffi --extern pin_init
300 rusttestlib-uapi: $(src)/uapi/lib.rs rusttestlib-ffi rusttestlib-pin_init FORCE
305 RUST_MODFILE=test.rs \
307 $(RUSTDOC) --test $(rust_common_flags) \
308 -Zcrate-attr='feature(used_with_arg)' \
312 -L$(objtree)/$(obj)/test --output $(rustdoc_output) \
313 --crate-name $(subst rusttest-,,$@) $<
317 rm -rf $(objtree)/$(obj)/test/doctests/kernel; \
318 mkdir -p $(objtree)/$(obj)/test/doctests/kernel; \
320 $(RUSTDOC) --test $(filter-out --remap-path-prefix=%,$(rust_flags)) \
321 -L$(objtree)/$(obj) --extern ffi --extern pin_init \
322 --extern kernel --extern build_error --extern macros \
323 --extern bindings --extern uapi \
324 --no-run --crate-name kernel -Zunstable-options \
325 --sysroot=/dev/null \
327 --test-builder $(objtree)/scripts/rustdoc_test_builder \
337 # We cannot use `-Zpanic-abort-tests` because some tests are dynamic,
338 # so for the moment we skip `-Cpanic=abort`.
342 $(RUSTC_OR_CLIPPY) --test $(rust_common_flags) \
344 $(rustc_target_flags) --out-dir $(objtree)/$(obj)/test \
345 -L$(objtree)/$(obj)/test \
346 --crate-name $(subst rusttest-,,$@) $<; \
347 $(objtree)/$(obj)/test/$(subst rusttest-,,$@) $(rust_test_quiet) \
350 rusttest: rusttest-macros
352 rusttest-macros: private rustc_target_flags = --extern proc_macro \
353 --extern macros --extern kernel --extern pin_init \
354 --extern proc_macro2 --extern quote --extern syn
355 rusttest-macros: private rustdoc_test_target_flags = --crate-type proc-macro
356 rusttest-macros: $(src)/macros/lib.rs \
357 rusttestlib-macros rusttestlib-kernel rusttestlib-pin_init FORCE
370 bindgen_skip_c_flags := -mno-fp-ret-in-387 -mpreferred-stack-boundary=% \
371 -mskip-rax-setup -mgeneral-regs-only -msign-return-address=% \
372 -mindirect-branch=thunk-extern -mindirect-branch-register \
373 -mfunction-return=thunk-extern -mrecord-mcount -mabi=lp64 \
374 -mindirect-branch-cs-prefix -mstack-protector-guard% -mtraceback=no \
375 -mno-pointers-to-nested-functions -mno-string \
376 -mno-strict-align -mstrict-align -mdirect-extern-access \
377 -mexplicit-relocs -mno-check-zero-division \
378 -fconserve-stack -falign-jumps=% -falign-loops=% \
379 -femit-struct-debug-baseonly -fno-ipa-cp-clone -fno-ipa-sra \
380 -fno-partial-inlining -fplugin-arg-arm_ssp_per_task_plugin-% \
381 -fno-reorder-blocks -fno-allow-store-data-races -fasan-shadow-offset=% \
382 -fzero-call-used-regs=% -fno-stack-clash-protection \
383 -fno-inline-functions-called-once -fsanitize=bounds-strict \
384 -fstrict-flex-arrays=% -fmin-function-alignment=% \
385 -fzero-init-padding-bits=% -mno-fdpic \
386 --param=% --param asan-% -fno-isolate-erroneous-paths-dereference
389 BINDGEN_TARGET_x86 := x86_64-linux-gnu
390 BINDGEN_TARGET_arm64 := aarch64-linux-gnu
391 BINDGEN_TARGET_arm := arm-linux-gnueabi
392 BINDGEN_TARGET_loongarch := loongarch64-linux-gnusf
399 bindgen_extra_c_flags = -w --target=$(BINDGEN_TARGET)
401 # Auto variable zero-initialization requires an additional special option with
403 # clang-18), so make sure to pass this option only if clang supports it
406 # https://github.com/llvm/llvm-project/issues/44842
407 # https://github.com/llvm/llvm-project/blob/llvmorg-16.0.0-rc2/clang/docs/ReleaseNotes.rst#deprecat…
409 …tree)/scripts/rust_is_available_bindgen_libclang.h 2>&1 | sed -ne 's/.*clang version \([0-9]*\).*/…
411 bindgen_extra_c_flags += -enable-trivial-auto-var-init-zero-knowing-it-will-be-removed-from-clang
415 bindgen_c_flags = $(filter-out $(bindgen_skip_c_flags), $(c_flags)) \
420 bindgen_c_flags_lto = $(filter-out $(CC_FLAGS_LTO), $(bindgen_c_flags))
425 # `-fno-builtin` is passed to avoid `bindgen` from using `clang` builtin
426 # prototypes for functions like `memcpy` -- if this flag is not passed,
427 # `bindgen`-generated prototypes use `c_ulong` or `c_uint` depending on
429 bindgen_c_flags_final = $(bindgen_c_flags_lto) -fno-builtin -D__BINDGEN__
433 # a `--rust-target` to avoid future `bindgen` releases emitting code that
440 # is, if we do not test the actual `rustc`/`bindgen` versions running).
446 $(BINDGEN) $< $(bindgen_target_flags) --rust-target 1.68 \
447 --use-core --with-derive-default --ctypes-prefix ffi --no-layout-tests \
448 --no-debug '.*' --enable-function-attribute-detection \
449 -o $@ -- $(bindgen_c_flags_final) -DMODULE \
453 $(shell grep -Ev '^#|^$$' $(src)/bindgen_parameters)
455 sed -Ei 's/pub const RUST_CONST_HELPER_([a-zA-Z0-9_]*)/pub const \1/g' $@
461 $(shell grep -Ev '^#|^$$' $(src)/bindgen_parameters)
467 # with `-Wmissing-declarations` (unlike GCC), so it is not strictly needed here
471 --blocklist-type '.*' --allowlist-var '' \
472 --allowlist-function 'rust_helper_.*'
474 -I$(objtree)/$(obj) -Wno-missing-prototypes -Wno-missing-declarations
476 sed -Ei 's/pub fn rust_helper_([a-zA-Z0-9_]*)/#[link_name="rust_helper_\1"]\n pub fn \1/g' $@
480 rust_exports = $(NM) -p --defined-only $(1) | awk '$$2~/(T|R|D|B)/ && $$3!~/__(pfx|cfi|odr_asan)/ {…
492 # in the crate where they are defined. Other helpers, called from non-inline
494 # compiler does not guarantee codegen will be performed for a non-inline
510 $(filter-out $(skip_flags),$(rust_common_flags) $(rustc_target_flags)) \
511 --emit=dep-info,link --crate-type rlib -O \
512 --out-dir $(objtree)/$(obj) -L$(objtree)/$(obj) \
513 --crate-name $(patsubst lib%.rlib,%,$(notdir $@)) $<; \
515 sed -i '/^\#/d' $(depfile)
518 $(obj)/libproc_macro2.rlib: private rustc_target_flags = $(proc_macro2-flags)
519 $(obj)/libproc_macro2.rlib: $(src)/proc-macro2/lib.rs FORCE
523 $(obj)/libquote.rlib: private skip_flags = $(quote-skip_flags)
524 $(obj)/libquote.rlib: private rustc_target_flags = $(quote-flags)
529 $(obj)/libsyn.rlib: private rustc_target_flags = $(syn-flags)
536 -Clinker-flavor=gcc -Clinker=$(HOSTCC) \
537 -Clink-args='$(call escsq,$(KBUILD_PROCMACROLDFLAGS))' \
538 --emit=dep-info=$(depfile) --emit=link=$@ --extern proc_macro \
539 --crate-type proc-macro -L$(objtree)/$(obj) \
540 --crate-name $(patsubst lib%.$(libmacros_extension),%,$(notdir $@)) \
545 --extern proc_macro2 --extern quote --extern syn
550 $(obj)/$(libpin_init_internal_name): private rustc_target_flags = --cfg kernel
551 $(obj)/$(libpin_init_internal_name): $(src)/pin-init/internal/src/lib.rs FORCE
558 $(filter-out $(skip_flags),$(rust_flags)) $(rustc_target_flags) \
559 --emit=dep-info=$(depfile) --emit=obj=$@ \
560 --emit=metadata=$(dir $@)$(patsubst %.o,lib%.rmeta,$(notdir $@)) \
561 --crate-type rlib -L$(objtree)/$(obj) \
562 --crate-name $(patsubst %.o,%,$(notdir $@)) $< \
563 --sysroot=/dev/null \
567 rust-analyzer:
569 --cfgs='core=$(core-cfgs)' $(core-edition) \
570 --cfgs='proc_macro2=$(proc_macro2-cfgs)' \
571 --cfgs='quote=$(quote-cfgs)' \
572 --cfgs='syn=$(syn-cfgs)' \
575 > rust-project.json
577 redirect-intrinsics = \
584 # Add eabi initrinsics for ARM 32-bit
585 redirect-intrinsics += \
592 redirect-intrinsics += \
601 $(if $(KBUILD_GENDWARFKSYMS_STABLE), --stable) \
602 $(if $(KBUILD_SYMTYPES), --symtypes $(@:.o=.symtypes),) \
603 $@ >> $(dot-target).cmd)
628 $(obj)/core.o: private skip_flags = $(core-skip_flags)
629 $(obj)/core.o: private rustc_objcopy = $(foreach sym,$(redirect-intrinsics),--redefine-sym $(sym)=_…
630 $(obj)/core.o: private rustc_target_flags = $(core-flags)
640 $(obj)/compiler_builtins.o: private rustc_objcopy = -w -W '__*'
645 $(obj)/pin_init.o: private rustc_target_flags = --extern pin_init_internal \
646 --extern macros --cfg kernel
647 $(obj)/pin_init.o: $(src)/pin-init/src/lib.rs $(obj)/compiler_builtins.o \
654 $(obj)/build_error.o: private is-kernel-object := y
663 $(obj)/bindings.o: private rustc_target_flags = --extern ffi --extern pin_init
671 $(obj)/uapi.o: private rustc_target_flags = --extern ffi --extern pin_init
679 $(obj)/kernel.o: private rustc_target_flags = --extern ffi --extern pin_init \
680 --extern build_error --extern macros --extern bindings --extern uapi