Received-SPF: pass (google.com: domain of linux-kernel+bounces-59879-linux.lists.archive=gmail.com@vger.kernel.org designates 147.75.48.161 as permitted sender) client-ip=147.75.48.161;
Message-ID: <45395395-9bbe-4ee8-9a4f-f1890cd85752@gmail.com>
Date: Fri, 9 Feb 2024 16:27:38 -0300
Precedence: bulk
MIME-Version: 1.0
User-Agent: Mozilla Thunderbird
Subject: Re: [PATCH] rust: locks: Add `get_mut` method to `Lock`
To: Mathys Gasnier <mathys35.gasnier@gmail.com>,
 Miguel Ojeda <ojeda@kernel.org>, Alex Gaynor <alex.gaynor@gmail.com>,
 Wedson Almeida Filho <wedsonaf@gmail.com>, Boqun Feng
 <boqun.feng@gmail.com>, Gary Guo <gary@garyguo.net>,
 =?UTF-8?Q?Bj=C3=B6rn_Roy_Baron?= <bjorn3_gh@protonmail.com>,
 Benno Lossin <benno.lossin@proton.me>,
 Andreas Hindborg <a.hindborg@samsung.com>, Alice Ryhl <aliceryhl@google.com>
Cc: rust-for-linux@vger.kernel.org, linux-kernel@vger.kernel.org
References: <20240209-rust-locks-get-mut-v1-1-ce351fc3de47@gmail.com>
Content-Language: en-US
From: Martin Rodriguez Reboredo <yakoyoku@gmail.com>
In-Reply-To: <20240209-rust-locks-get-mut-v1-1-ce351fc3de47@gmail.com>
Content-Type: text/plain; charset=UTF-8; format=flowed
Content-Transfer-Encoding: 7bit

On 2/9/24 13:22, Mathys-Gasnier wrote:
> From: Mathys-Gasnier <mathys35.gasnier@gmail.com>
> 
> Having a mutable reference guarantees that no other threads have
> access to the lock, so we can take advantage of that to grant callers
> access to the protected data without the the cost of acquiring and
> releasing the locks. Since the lifetime of the data is tied to the
> mutable reference, the borrow checker guarantees that the usage is safe.
> 
> Signed-off-by: Mathys-Gasnier <mathys35.gasnier@gmail.com>
> ---
> [...]
> +    /// Gets the data contained in the lock

I wish that this doc comment mentioned what you've said about having a
mutable reference avoids locking, much like the documentation on
`std::sync::Mutex::get_mut`. If you do so then you can add my reviewed.

Reviewed-by: Martin Rodriguez Reboredo <yakoyoku@gmail.com>

> +    pub fn get_mut(&mut self) -> &mut T {
> +        self.data.get_mut()
> +    }
>   }
> [...]