Received-SPF: pass (google.com: domain of linux-kernel+bounces-59336-linux.lists.archive=gmail.com@vger.kernel.org designates 2604:1380:45d1:ec00::1 as permitted sender) client-ip=2604:1380:45d1:ec00::1;
Date: Fri,  9 Feb 2024 13:04:26 +0000
In-Reply-To: <20240205-b4-rbtree-v1-2-995e3eee38c0@google.com>
Precedence: bulk
Mime-Version: 1.0
References: <20240205-b4-rbtree-v1-2-995e3eee38c0@google.com>
Message-ID: <20240209130426.1791631-1-aliceryhl@google.com>
Subject: Re: [PATCH 2/6] rust: rbtree: add red-black tree implementation
 backed by the C version
From: Alice Ryhl <aliceryhl@google.com>
To: mattgilbride@google.com
Cc: a.hindborg@samsung.com, alex.gaynor@gmail.com, aliceryhl@google.com, 
	arve@android.com, benno.lossin@proton.me, bjorn3_gh@protonmail.com, 
	boqun.feng@gmail.com, brauner@kernel.org, cmllamas@google.com, 
	dave@stgolabs.net, gary@garyguo.net, gregkh@linuxfoundation.org, 
	joel@joelfernandes.org, linux-kernel@vger.kernel.org, maco@android.com, 
	michel@lespinasse.org, ojeda@kernel.org, rob@landley.net, 
	rust-for-linux@vger.kernel.org, surenb@google.com, tkjos@android.com, 
	wedsonaf@gmail.com
Content-Type: text/plain; charset="utf-8"

> From: Wedson Almeida Filho <wedsonaf@gmail.com>
> 
> The rust rbtree exposes a map-like interface over keys and values,
> backed by the kernel red-black tree implementation. Values can be
> inserted, deleted, and retrieved from a `RBTree` by key.
> 
> This base abstraction is used by binder to store key/value
> pairs and perform lookups, for example the patch
> "[PATCH RFC 03/20] rust_binder: add threading support"
> in the binder RFC [1].
> 
> Link: https://lore.kernel.org/rust-for-linux/20231101-rust-binder-v1-3-08ba9197f637@google.com/ [1]
> Signed-off-by: Wedson Almeida Filho <wedsonaf@gmail.com>
> Signed-off-by: Matt Gilbride <mattgilbride@google.com>

I have looked at these bindings many times over the past year. They
look good to me, modulo a few nits included in this email.

Reviewed-by: Alice Ryhl <aliceryhl@google.com>

These abstractions have been very heavily exercised by the Rust Binder
driver.

Tested-by: Alice Ryhl <aliceryhl@google.com>

> +//! Red-black trees.
> +//!
> +//! C header: [`include/linux/rbtree.h`](../../../../include/linux/rbtree.h)
> +//!
> +//! Reference: <https://www.kernel.org/doc/html/latest/core-api/rbtree.html>

We changed these links, so it should say this instead:

[`include/linux/rbtree.h`](srctree/include/linux/rbtree.h)

> +    /// Allocates memory for a node to be eventually initialised and inserted into the tree via a
> +    /// call to [`RBTree::insert`].
> +    pub fn try_reserve_node() -> Result<RBTreeNodeReservation<K, V>> {
> +        Ok(RBTreeNodeReservation {
> +            node: Box::try_new(MaybeUninit::uninit())?,
> +        })
> +    }

This can be:

	use crate::prelude::*;
	use core::convert::Infallible;
	
	Ok(RBTreeNodeReservation {
	    node: Box::init::<Infallible>(crate::init::uninit())?,
	})

It might be slightly more verbose, but guarantees that we don't allocate
space for the value on the stack.

Alice