Commit b6964fe2 authored by Linus Torvalds's avatar Linus Torvalds
Browse files

Merge tag 'rust-6.8' of https://github.com/Rust-for-Linux/linux 

Pull Rust updates from Miguel Ojeda:
 "Another routine one in terms of features. In terms of lines, this time
  the 'alloc' version upgrade is less prominent, given that it was
  fairly small (and we did not have two upgrades)

  Toolchain and infrastructure:

   - Upgrade to Rust 1.74.1

     The patch release includes a fix for an ICE that the Apple AGX GPU
     driver was hitting

   - Support 'srctree'-relative links in Rust code documentation

   - Automate part of the manual constants handling (i.e. the ones not
     recognised by 'bindgen')

   - Suppress searching builtin sysroot to avoid confusion with
     installed sysroots, needed for the to-be-merged arm64 support which
     uses a builtin target

   - Ignore '__preserve_most' functions for 'bindgen'

   - Reduce header inclusion bloat in exports

  'kernel' crate:

   - Implement 'Debug' for 'CString'

   - Make 'CondVar::wait()' an uninterruptible wait

  'macros' crate:

   - Update 'paste!' to accept string literals

   - Improve '#[vtable]' documentation

  Documentation:

   - Add testing section (KUnit and 'rusttest' target)

   - Remove 'CC=clang' mentions

   - Clarify that 'rustup override' applies to build directory"

* tag 'rust-6.8' of https://github.com/Rust-for-Linux/linux:
  docs: rust: Clarify that 'rustup override' applies to build directory
  docs: rust: Add rusttest info
  docs: rust: remove `CC=clang` mentions
  rust: support `srctree`-relative links
  rust: sync: Makes `CondVar::wait()` an uninterruptible wait
  rust: upgrade to Rust 1.74.1
  rust: Suppress searching builtin sysroot
  rust: macros: improve `#[vtable]` documentation
  rust: macros: update 'paste!' macro to accept string literals
  rust: bindings: rename const binding using sed
  rust: Ignore preserve-most functions
  rust: replace <linux/module.h> with <linux/export.h> in rust/exports.c
  rust: kernel: str: Implement Debug for CString
parents 5bad4908 711cbfc7

Documentation/process/changes.rst

+1 −1
Original line number Diff line number Diff line
@@ -31,7 +31,7 @@ you probably needn't concern yourself with pcmciautils. 
====================== ===============  ========================================

GNU C                  5.1              gcc --version

Clang/LLVM (optional)  11.0.0           clang --version

Rust (optional)        1.73.0           rustc --version

Rust (optional)        1.74.1           rustc --version

bindgen (optional)     0.65.1           bindgen --version

GNU make               3.82             make --version

bash                   4.2              bash --version

Documentation/rust/coding-guidelines.rst

+13 −0
Original line number Diff line number Diff line
@@ -177,6 +177,19 @@ please take a look at the ``rustdoc`` book at: 


	https://doc.rust-lang.org/rustdoc/how-to-write-documentation.html



In addition, the kernel supports creating links relative to the source tree by

prefixing the link destination with ``srctree/``. For instance:



.. code-block:: rust



	//! C header: [`include/linux/printk.h`](srctree/include/linux/printk.h)



or:



.. code-block:: rust



	/// [`struct mutex`]: srctree/include/linux/mutex.h





Naming

------

Documentation/rust/general-information.rst

+24 −0
Original line number Diff line number Diff line
@@ -77,3 +77,27 @@ configuration: 
	#[cfg(CONFIG_X="y")]   // Enabled as a built-in (`y`)

	#[cfg(CONFIG_X="m")]   // Enabled as a module   (`m`)

	#[cfg(not(CONFIG_X))]  // Disabled





Testing

-------



There are the tests that come from the examples in the Rust documentation

and get transformed into KUnit tests. These can be run via KUnit. For example

via ``kunit_tool`` (``kunit.py``) on the command line::



	./tools/testing/kunit/kunit.py run --make_options LLVM=1 --arch x86_64 --kconfig_add CONFIG_RUST=y



Alternatively, KUnit can run them as kernel built-in at boot. Refer to

Documentation/dev-tools/kunit/index.rst for the general KUnit documentation

and Documentation/dev-tools/kunit/architecture.rst for the details of kernel

built-in vs. command line testing.



Additionally, there are the ``#[test]`` tests. These can be run using

the ``rusttest`` Make target::



	make LLVM=1 rusttest



This requires the kernel ``.config`` and downloads external repositories.

It runs the ``#[test]`` tests on the host (currently) and thus is fairly

limited in what these tests can test.

Documentation/rust/quick-start.rst

+9 −9
Original line number Diff line number Diff line
@@ -33,14 +33,18 @@ A particular version of the Rust compiler is required. Newer versions may or 
may not work because, for the moment, the kernel depends on some unstable

Rust features.



If ``rustup`` is being used, enter the checked out source code directory

and run::

If ``rustup`` is being used, enter the kernel build directory (or use

``--path=<build-dir>`` argument to the ``set`` sub-command) and run::



	rustup override set $(scripts/min-tool-version.sh rustc)



This will configure your working directory to use the correct version of

``rustc`` without affecting your default toolchain. If you are not using

``rustup``, fetch a standalone installer from:

``rustc`` without affecting your default toolchain.



Note that the override applies to the current working directory (and its

sub-directories).



If you are not using ``rustup``, fetch a standalone installer from:



	https://forge.rust-lang.org/infra/other-installation-methods.html#standalone
@@ -76,7 +80,7 @@ libclang 


``libclang`` (part of LLVM) is used by ``bindgen`` to understand the C code

in the kernel, which means LLVM needs to be installed; like when the kernel

is compiled with ``CC=clang`` or ``LLVM=1``.

is compiled with ``LLVM=1``.



Linux distributions are likely to have a suitable one available, so it is

best to check that first.
@@ -229,10 +233,6 @@ at the moment. That is:: 


	make LLVM=1



For architectures that do not support a full LLVM toolchain, use::



	make CC=clang



Using GCC also works for some configurations, but it is very experimental at

the moment.

rust/Makefile

+7 −1
Original line number Diff line number Diff line
@@ -78,6 +78,7 @@ quiet_cmd_rustdoc = RUSTDOC $(if $(rustdoc_host),H, ) $< 
		$(rustc_target_flags) -L$(objtree)/$(obj) \

		--output $(rustdoc_output) \

		--crate-name $(subst rustdoc-,,$@) \

		$(if $(rustdoc_host),,--sysroot=/dev/null) \

		@$(objtree)/include/generated/rustc_cfg $<



# The `html_logo_url` and `html_favicon_url` forms of the `doc` attribute
@@ -98,7 +99,8 @@ rustdoc: rustdoc-core rustdoc-macros rustdoc-compiler_builtins \ 
	$(Q)find $(rustdoc_output) -name '*.html' -type f -print0 | xargs -0 sed -Ei \

		-e 's:rust-logo-[0-9a-f]+\.svg:logo.svg:g' \

		-e 's:favicon-[0-9a-f]+\.svg:logo.svg:g' \

		-e 's:<link rel="alternate icon" type="image/png" href="[/.]+/static\.files/favicon-(16x16|32x32)-[0-9a-f]+\.png">::g'

		-e 's:<link rel="alternate icon" type="image/png" href="[/.]+/static\.files/favicon-(16x16|32x32)-[0-9a-f]+\.png">::g' \

		-e 's:<a href="srctree/([^"]+)">:<a href="$(abs_srctree)/\1">:g'

	$(Q)for f in $(rustdoc_output)/static.files/rustdoc-*.css; do \

		echo ".logo-container > img { object-fit: contain; }" >> $$f; done
@@ -178,6 +180,7 @@ quiet_cmd_rustdoc_test_kernel = RUSTDOC TK $< 
		--extern build_error --extern macros \

		--extern bindings --extern uapi \

		--no-run --crate-name kernel -Zunstable-options \

		--sysroot=/dev/null \

		--test-builder $(objtree)/scripts/rustdoc_test_builder \

		$< $(rustdoc_test_kernel_quiet); \

	$(objtree)/scripts/rustdoc_test_gen
@@ -337,6 +340,8 @@ quiet_cmd_bindgen = BINDGEN $@ 


$(obj)/bindings/bindings_generated.rs: private bindgen_target_flags = \

    $(shell grep -Ev '^#|^$$' $(srctree)/$(src)/bindgen_parameters)

$(obj)/bindings/bindings_generated.rs: private bindgen_target_extra = ; \

    sed -Ei 's/pub const RUST_CONST_HELPER_([a-zA-Z0-9_]*)/pub const \1/g' $@

$(obj)/bindings/bindings_generated.rs: $(src)/bindings/bindings_helper.h \

    $(src)/bindgen_parameters FORCE

	$(call if_changed_dep,bindgen)
@@ -402,6 +407,7 @@ quiet_cmd_rustc_library = $(if $(skip_clippy),RUSTC,$(RUSTC_OR_CLIPPY_QUIET)) L 
		--emit=metadata=$(dir $@)$(patsubst %.o,lib%.rmeta,$(notdir $@)) \

		--crate-type rlib -L$(objtree)/$(obj) \

		--crate-name $(patsubst %.o,%,$(notdir $@)) $< \

		--sysroot=/dev/null \

	$(if $(rustc_objcopy),;$(OBJCOPY) $(rustc_objcopy) $@)



rust-analyzer: