Rust for Linux List
 help / color / mirror / Atom feed
From: "Gary Guo" <gary@garyguo.net>
To: jahnavimn@google.com,
	"Greg Kroah-Hartman" <gregkh@linuxfoundation.org>,
	"Arve Hjønnevåg" <arve@android.com>,
	"Todd Kjos" <tkjos@android.com>,
	"Christian Brauner" <brauner@kernel.org>,
	"Carlos Llamas" <cmllamas@google.com>,
	"Alice Ryhl" <aliceryhl@google.com>,
	"Miguel Ojeda" <ojeda@kernel.org>,
	"Boqun Feng" <boqun@kernel.org>, "Gary Guo" <gary@garyguo.net>,
	"Björn Roy Baron" <bjorn3_gh@protonmail.com>,
	"Benno Lossin" <lossin@kernel.org>,
	"Andreas Hindborg" <a.hindborg@kernel.org>,
	"Trevor Gross" <tmgross@umich.edu>,
	"Danilo Krummrich" <dakr@kernel.org>,
	"Daniel Almeida" <daniel.almeida@collabora.com>,
	"Tamir Duberstein" <tamird@kernel.org>,
	"Alexandre Courbot" <acourbot@nvidia.com>,
	"Onur Özkan" <work@onurozkan.dev>
Cc: <linux-kernel@vger.kernel.org>, <rust-for-linux@vger.kernel.org>
Subject: Re: [PATCH 1/7] rust_binder: Add dynamic debug logging mask
Date: Fri, 03 Jul 2026 17:23:31 +0100	[thread overview]
Message-ID: <DJP2PNJVLPC7.1RXQS9RMFFYM9@garyguo.net> (raw)
In-Reply-To: <20260703-rust_binder_debug_mask-v1-1-9bdf12b5325c@google.com>

On Fri Jul 3, 2026 at 4:29 PM BST, Jahnavi MN via B4 Relay wrote:
> From: Jahnavi MN <jahnavimn@google.com>
>
> Implement a dynamic debug logging mask (`debug_mask`) for the
> `rust_binder` module to allow dynamic runtime configuration of log
> levels. This enables parity with the legacy C driver's debug mask.
>
> Since the Rust `module!` macro in the current kernel build does not yet
> support declaring module parameters directly in Rust, we define the
> `debug_mask` variable in a C companion file to expose it to the kernel
> runtime and import it using FFI with volatile reads.
>
> To verify the setup, instrument process lifecycle events (open, flush,
> and release) in `process.rs` under the new `BINDER_DEBUG_OPEN_CLOSE`
> logging mask. These entry-point events are chosen for initial validation
> because they represent the start of the Binder lifecycle and occur
> at low frequency, allowing simple runtime verification of the dynamic
> toggle without log noise.
>
> Signed-off-by: Jahnavi MN <jahnavimn@google.com>
> ---
>  drivers/android/binder/debug.rs            | 49 ++++++++++++++++++++++++++++++
>  drivers/android/binder/process.rs          | 15 +++++++--
>  drivers/android/binder/rust_binder_main.rs |  2 ++
>  drivers/android/binder/rust_binderfs.c     |  3 ++
>  drivers/android/binder/thread.rs           |  1 +
>  drivers/android/binder/transaction.rs      |  5 +--
>  6 files changed, 71 insertions(+), 4 deletions(-)
>
> diff --git a/drivers/android/binder/debug.rs b/drivers/android/binder/debug.rs
> new file mode 100644
> index 000000000000..5e4daa823377
> --- /dev/null
> +++ b/drivers/android/binder/debug.rs
> @@ -0,0 +1,49 @@
> +// SPDX-License-Identifier: GPL-2.0
> +
> +// Copyright (C) 2026 Google LLC.
> +
> +//! Binder debugging helpers.
> +
> +#![allow(dead_code)]
> +
> +pub(crate) const BINDER_DEBUG_USER_ERROR: u32 = 1 << 0;
> +pub(crate) const BINDER_DEBUG_FAILED_TRANSACTION: u32 = 1 << 1;
> +pub(crate) const BINDER_DEBUG_DEAD_TRANSACTION: u32 = 1 << 2;
> +pub(crate) const BINDER_DEBUG_OPEN_CLOSE: u32 = 1 << 3;
> +pub(crate) const BINDER_DEBUG_DEAD_BINDER: u32 = 1 << 4;
> +pub(crate) const BINDER_DEBUG_DEATH_NOTIFICATION: u32 = 1 << 5;
> +pub(crate) const BINDER_DEBUG_READ_WRITE: u32 = 1 << 6;
> +pub(crate) const BINDER_DEBUG_USER_REFS: u32 = 1 << 7;
> +pub(crate) const BINDER_DEBUG_THREADS: u32 = 1 << 8;
> +pub(crate) const BINDER_DEBUG_TRANSACTION: u32 = 1 << 9;
> +pub(crate) const BINDER_DEBUG_TRANSACTION_COMPLETE: u32 = 1 << 10;
> +pub(crate) const BINDER_DEBUG_FREE_BUFFER: u32 = 1 << 11;
> +pub(crate) const BINDER_DEBUG_INTERNAL_REFS: u32 = 1 << 12;
> +pub(crate) const BINDER_DEBUG_PRIORITY_CAP: u32 = 1 << 13;
> +pub(crate) const BINDER_DEBUG_SPINLOCKS: u32 = 1 << 14;

This should be defined as bitflags:
https://rust.docs.kernel.org/next/kernel/macro.impl_flags.html

> +
> +extern "C" {
> +    static rust_binder_debug_mask: u32;

It's UB for this to be mutated. This should either be `static mut` or
`Atomic<u32>`.

> +}
> +
> +/// Checks if the given debug logging category is enabled in the mask.
> +pub(crate) fn debug_mask_enabled(mask: u32) -> bool {
> +    let ptr = &raw const rust_binder_debug_mask;
> +    // SAFETY: `rust_binder_debug_mask` is defined in the companion C code linked in the module.
> +    let current_mask = unsafe { core::ptr::read_volatile(ptr) };
> +    (current_mask & mask) != 0
> +}
> +
> +/// Prints a debug log if the specified mask category is enabled.
> +#[macro_export]
> +macro_rules! binder_debug {
> +    ($mask:expr, $fmt:literal $(, $($arg:tt)*)?) => {
> +        if $crate::debug::debug_mask_enabled($mask) {

The mask should probably just be an identifier and then the macro builds the
full mask, so crate::debug::... is not needed.

Best,
Gary

> +            kernel::pr_info!(
> +                "{}: {}\n",
> +                kernel::current!().pid(),
> +                format_args!($fmt $(, $($arg)*)?)
> +            );
> +        }
> +    };
> +}


  reply	other threads:[~2026-07-03 16:23 UTC|newest]

Thread overview: 12+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-07-03 15:29 [PATCH 0/7] rust_binder : Implement dynamic debug logging mask Jahnavi MN via B4 Relay
2026-07-03 15:29 ` [PATCH 1/7] rust_binder: Add " Jahnavi MN via B4 Relay
2026-07-03 16:23   ` Gary Guo [this message]
2026-07-04 21:03   ` Alice Ryhl
2026-07-03 15:29 ` [PATCH 2/7] rust_binder: Implement the BINDER_DEBUG_USER_ERROR logging mask for freezer-related operation Jahnavi MN via B4 Relay
2026-07-03 15:29 ` [PATCH 3/7] rust_binder: Implement the BINDER_DEBUG_USER_ERROR logging mask for reference counting and death notification operations Jahnavi MN via B4 Relay
2026-07-04 21:14   ` Alice Ryhl
2026-07-03 15:29 ` [PATCH 4/7] rust_binder: Implement the BINDER_DEBUG_USER_ERROR logging mask for transaction parsing and protocol validation failures Jahnavi MN via B4 Relay
2026-07-03 15:29 ` [PATCH 5/7] rust_binder: Implement the BINDER_DEBUG_FAILED_TRANSACTION logging mask for transaction parsing and routing failures Jahnavi MN via B4 Relay
2026-07-03 15:29 ` [PATCH 6/7] rust_binder: Implement BINDER_DEBUG_FAILED_TRANSACTION logging for death notification allocation failures Jahnavi MN via B4 Relay
2026-07-04 21:17   ` Alice Ryhl
2026-07-03 15:29 ` [PATCH 7/7] rust_binder: Implement the BINDER_DEBUG_DEAD_TRANSACTION logging mask to trace in-flight cancellations during teardown Jahnavi MN via B4 Relay

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=DJP2PNJVLPC7.1RXQS9RMFFYM9@garyguo.net \
    --to=gary@garyguo.net \
    --cc=a.hindborg@kernel.org \
    --cc=acourbot@nvidia.com \
    --cc=aliceryhl@google.com \
    --cc=arve@android.com \
    --cc=bjorn3_gh@protonmail.com \
    --cc=boqun@kernel.org \
    --cc=brauner@kernel.org \
    --cc=cmllamas@google.com \
    --cc=dakr@kernel.org \
    --cc=daniel.almeida@collabora.com \
    --cc=gregkh@linuxfoundation.org \
    --cc=jahnavimn@google.com \
    --cc=linux-kernel@vger.kernel.org \
    --cc=lossin@kernel.org \
    --cc=ojeda@kernel.org \
    --cc=rust-for-linux@vger.kernel.org \
    --cc=tamird@kernel.org \
    --cc=tkjos@android.com \
    --cc=tmgross@umich.edu \
    --cc=work@onurozkan.dev \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox