From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from mail-yb1-f201.google.com (mail-yb1-f201.google.com [209.85.219.201]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 5000C1B2ED0 for ; Wed, 21 Aug 2024 17:42:10 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.219.201 ARC-Seal:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1724262131; cv=none; b=Vf/vMqUC+XhtvShghoTxXWI+yZabhWp3SZyBcp/4n2/NzXPxEqznIZ3WUSFWN8jj+FXesgiv6BK6aEW6+YkrUNQmGdMgxF/H3BgLHNptgrBe3kPYpSSuffiyoFV+PlEpo3SkGGvMltby3i0eE+K79mApuKX766y+pe3t/+ZRCv0= ARC-Message-Signature:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1724262131; c=relaxed/simple; bh=KmRFi1FwSRS9v1Ei0rzLK1xkSHaz7WOPSbWTpc52UJs=; h=Date:Mime-Version:Message-ID:Subject:From:To:Cc:Content-Type; b=ioAaKhn2siQrALFXAL/yWk8OjmfqLPW5+rTKvbDvhutX4xb5ifxjU89hg7YmPkq1+TJdlQU2MTQ6soK6tGyBYLq95StejtwGip0CZ5SH1Hh7lopKoJjEfYyngd6PMHPzSg/XCe3JPNWek4E5Cem9yjS10fEG6lvzNqHwUfcAg4Y= ARC-Authentication-Results:i=1; smtp.subspace.kernel.org; dmarc=pass (p=reject dis=none) header.from=google.com; spf=pass smtp.mailfrom=flex--mattgilbride.bounces.google.com; dkim=pass (2048-bit key) header.d=google.com header.i=@google.com header.b=4ibvJcJG; arc=none smtp.client-ip=209.85.219.201 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=reject dis=none) header.from=google.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=flex--mattgilbride.bounces.google.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=google.com header.i=@google.com header.b="4ibvJcJG" Received: by mail-yb1-f201.google.com with SMTP id 3f1490d57ef6-e164e64efb6so4019828276.3 for ; Wed, 21 Aug 2024 10:42:10 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20230601; t=1724262129; x=1724866929; darn=vger.kernel.org; h=cc:to:from:subject:message-id:mime-version:date:from:to:cc:subject :date:message-id:reply-to; bh=AB4KoZC16fhRtFUGOboRbdVF+tSsgpZU8UUX7dT390U=; b=4ibvJcJGpBFe9VpwYwysTlsH8NpAkW00Y8cGGpTvmaq7luqiyqgXxNMQ9UzsWgwvf5 ajvAbpfbBXXExYxQe3bTKbekG70Te/H8QqF5s/sGkfB623eaA7U2WnEr/7vRYAzn5xMM 3YHEty8/u7PpoYnJ3kesVRSxTZ/tfd1pwdLxCgGFpWJ4lehS1FaVhhswHWSn8n5YQRZ+ rlMJLTdavWBNo2GdTQk9rL9y9gB91GJtgX9anXZRoXLPalgjjDEVGBsIErV+kuWgHhQp 60i4lbQqtn9dGxCAbjtlvLjHgDfzmDkgeSpt19mintyKQEljnzE0VfvyxVxoH+A87tiT 4B7Q== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1724262129; x=1724866929; h=cc:to:from:subject:message-id:mime-version:date:x-gm-message-state :from:to:cc:subject:date:message-id:reply-to; bh=AB4KoZC16fhRtFUGOboRbdVF+tSsgpZU8UUX7dT390U=; b=kD+DbcbUFCqm1EpxN2GOSthIij/ZFGwLMuzMZUzvK1MZ57m4f1fozRw6pxCKYNm81Y PmLw43yHOVfqJuL4OrKZDsjpPKuseYgxlxNPi3Z8x1lPzLOZ+2Og9iUaQHEZ3EwjAV9f MhUUBwmIT3MIWmgoYdpA3vBvdkFbj+y9xnq0z3k/f3OxPtAp/OBjvT0jgWBSYgDMB1ZM aEHc81pRyh290oxpHeJtljeJJB5eQbyGZlpMDvrYkRncU15BAgpdkz1bUtMxOg4LXzoO DP3XUvLJiAnUKvNgm26l1hrgztI62rz+sotYHAPV752VYfAdHSA0oaek8kW6ZTiPnyEW WrjQ== X-Forwarded-Encrypted: i=1; AJvYcCVUNhTHtQkuwakW7NFUIaTlp8R1841y7IlzxuXCFdyv6y/xnzZEho5RprrECqzfcLFzZBuILnxxMcOry0I=@vger.kernel.org X-Gm-Message-State: AOJu0YxjE22TPlf1vfRSNO4GSTSebPTTp1dhK/SKs1UX0+PQKRdQCQF5 FpZ+rTIIuqYi4kFHB8gbWsGMDDBcNL1Rtlam3opRGqKahqaBuukppDRgcJIjbxAAE1DBbVNCKq0 O0qp+RZeCIYft99oqDVqsT7thng== X-Google-Smtp-Source: AGHT+IEuZFs2yLPO126ZoD1OOKLmQAzVNFN3ySgktNgHgcHzmovvL1Kwb11KLLL/liOHk3YChgVsLRGCrMhJ1F23JXs= X-Received: from mattgilbride.c.googlers.com ([fda3:e722:ac3:cc00:2b:7d90:c0a8:2ac5]) (user=mattgilbride job=sendgmr) by 2002:a5b:4c2:0:b0:e13:e775:5a3c with SMTP id 3f1490d57ef6-e1665418144mr4904276.2.1724262129201; Wed, 21 Aug 2024 10:42:09 -0700 (PDT) Date: Wed, 21 Aug 2024 17:42:06 +0000 Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: Mime-Version: 1.0 X-B4-Tracking: v=1; b=H4sIAO4mxmYC/23RwU7DMAwG4FeZcqbIjt0k5cR7IA5O6myVgKJ2q kDT3p10l6Yqx1j5fsfOzcw6DTqbl9PNTLoM8zB+lQPi08mki3ydtRn6UjAWLKGFtoncTPE6qTY SIwqgyyBgyv3vSfPw8wh7ey/nyzBfx+n3kb3gWl1TGPYpCzbQdF2rpKoUEryex/H8oc9p/DRrz GIril1NbaEQEUkkEkF/oLRRxlBTKpQsKRJTB0kPlDfqgGrKK4WgTL2TmNOBtjV1NW3XWV3Wsjf t/D+zuo16xJq6QpGjZpSQ+igH6itqd119oaIaQhLJpe2Bhpr6mob1wS06AOmFiQ+022jAXdeuU LZtZLaSvbYHilDb3ccirDuOFG3i3pPkHb7f73/+O1K+uQIAAA== X-Mailer: b4 0.13.0 Message-ID: <20240821-b4-rbtree-v11-0-2ddc66f26972@google.com> Subject: [PATCH v11 0/5] Red-black tree abstraction needed by Rust Binder From: Matt Gilbride To: Miguel Ojeda , Alex Gaynor , Wedson Almeida Filho , Boqun Feng , Gary Guo , "=?utf-8?q?Bj=C3=B6rn_Roy_Baron?=" , Benno Lossin , Andreas Hindborg , Alice Ryhl , Greg Kroah-Hartman , "=?utf-8?q?Arve_Hj=C3=B8nnev=C3=A5g?=" , Todd Kjos , Martijn Coenen , Joel Fernandes , Carlos Llamas , Suren Baghdasaryan , Christian Brauner Cc: Rob Landley , Davidlohr Bueso , Michel Lespinasse , rust-for-linux@vger.kernel.org, linux-kernel@vger.kernel.org, Matt Gilbride Content-Type: text/plain; charset="utf-8" This patchset contains the red-black tree abstractions needed by the Rust implementation of the Binder driver. Binder driver benefits from O(log n) search/insertion/deletion of key/value mappings in various places, including `process.rs` and `range_alloc.rs`. In `range_alloc.rs`, the ability to store and search by a generic key type is also useful. Please see the Rust Binder RFC for usage examples [1]. Note that the `container_of` macro is currently used only by `rbtree` itself. Users of "rust: rbtree: add red-black tree implementation backed by the C version" [PATCH RFC 03/20] rust_binder: add threading support [PATCH RFC 05/20] rust_binder: add nodes and context managers [PATCH RFC 06/20] rust_binder: add oneway transactions Users of "rust: rbtree: add iterator" [PATCH RFC 17/20] rust_binder: add oneway spam detection Users of "rust: rbtree: add mutable iterator" [PATCH RFC 06/20] rust_binder: add oneway transactions Users of "rust: rbtree: add `RBTreeCursor`" [PATCH RFC 06/20] rust_binder: add oneway transactions Users of "rust: rbtree: add RBTree::entry" Not used in the original RFC, but introduced after further code review. See: https://r.android.com/2849906 The Rust Binder RFC addresses the upstream deprecation of red-black tree. Quoted here for convenience: "This RFC uses the kernel's red-black tree for key/value mappings, but we are aware that the red-black tree is deprecated. We did this to make the performance comparison more fair, since C binder also uses rbtree for this. We intend to replace these with XArrays instead. That said, we don't think that XArray is a good fit for the range allocator, and we propose to continue using the red-black tree for the range allocator." Link: https://lore.kernel.org/rust-for-linux/20231101-rust-binder-v1-0-08ba9197f637@google.com/ [1] Signed-off-by: Matt Gilbride --- Changes in v11: - Address feedback from v10 - Link to v10: https://lore.kernel.org/r/20240819-b4-rbtree-v10-0-3b3b2c4d73af@google.com Changes in v10: - Rebase on top of rust-for-linux/rust-next (e26fa546042add70944d018b930530d16b3cf626) - Adapt to changes from "rust: kbuild: split up helpers.c" (876346536c1b59a5b1b5e44477b1b3ece77647fd) - Rebase on top of "rust: kernel: add `drop_contents` to `BoxExt`" instead of including it in the patch series - https://lore.kernel.org/all/CAH5fLgj2urZ6OD2ki6E=6EuPqW3Z8BGg8jd6Bgo4OOrNiptnDw@mail.gmail.com/ - Link to v9: https://lore.kernel.org/r/20240816-b4-rbtree-v9-0-425b442af7e5@google.com Changes in v9: - Rebase on top of Linux 6.11-rc2 - Address feedback from v8 - Link to v8: https://lore.kernel.org/r/20240727-b4-rbtree-v8-0-951600ada434@google.com Changes in v8: - Fix small style nit (use ? operator) - Fix doc comment pointing at a private item - Link to v7: https://lore.kernel.org/r/20240726-b4-rbtree-v7-0-aee88caaf97c@google.com Changes in v7: - make `RawVacantEntry.rbtree` a raw pointer like `RawVacantEntry.child_field_of_parent`, since the latter can technically point at a field of the former. We prefer that the implementation be explicit about the safety guarantees of both because of the relationship between them. - Link to v6: https://lore.kernel.org/r/20240711-b4-rbtree-v6-0-14bef1a8cdba@google.com Changes in v6: - Minimize usage of `*mut bindings::rb_node`, replacing with `NonNull`. Specifically, changing `RBTreeCursor.current` to be `NonNull` and updating the corresponding functions. - Update `RBTreeCursor:to_key_value` helpers to have their own lifetime (they are not instance methods, using a different lifetime than that of the `impl` block they are in makes things more clear. - Fix misplaced semicolon in `cursor_lower_bound`. - Link to v5: https://lore.kernel.org/r/20240606-b4-rbtree-v5-0-96fe1a0e97c0@google.com Changes in v5: - Used `Box::write` in `RBTreeNodeReservation::into_node`, removing unnecessary `unsafe` blocks. - Updated `RBTreeCursor::remove_current` to return the removed node. - Link to v4: https://lore.kernel.org/r/20240603-b4-rbtree-v4-0-308e43d6abfc@google.com Changes in v4: - rebased onto the tip of rust-for-linux/rust-next (97ab3e8eec0ce79d9e265e6c9e4c480492180409) - addressed comments from draft PR on GitHub: https://github.com/Rust-for-Linux/linux/pull/1081 - Link to v3: https://lore.kernel.org/r/20240418-b4-rbtree-v3-0-323e134390ce@google.com Changes in v3: - Address various feedback re: SAFETY and INVARIANT comments from v2. - Update variable naming and add detailed comments for the `RBTree::insert` (later moved to `RBTree::raw_entry`) implementation. - Link to v2: https://lore.kernel.org/r/20240219-b4-rbtree-v2-0-0b113aab330d@google.com Changes in v2: - Update documentation link to the C header file - Use `core::convert::Infallible` in try_reserve_node - Link to v1: https://lore.kernel.org/r/20240205-b4-rbtree-v1-0-995e3eee38c0@google.com --- Alice Ryhl (1): rust: rbtree: add `RBTree::entry` Matt Gilbride (1): rust: rbtree: add cursor Wedson Almeida Filho (3): rust: rbtree: add red-black tree implementation backed by the C version rust: rbtree: add iterator rust: rbtree: add mutable iterator rust/helpers/helpers.c | 1 + rust/helpers/rbtree.c | 9 + rust/kernel/lib.rs | 1 + rust/kernel/rbtree.rs | 1285 ++++++++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 1296 insertions(+) --- base-commit: 68ad5e31ad2ccab128468e829f53191cf60f601f change-id: 20231205-b4-rbtree-abb1a016f0a0 Best regards, -- Matt Gilbride