From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from kanga.kvack.org (kanga.kvack.org [205.233.56.17]) (using TLSv1 with cipher DHE-RSA-AES256-SHA (256/256 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id DD5ECC79F9F for ; Thu, 10 Sep 2026 09:02:04 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id 050276B009D; Thu, 10 Sep 2026 05:02:04 -0400 (EDT) Received: by kanga.kvack.org (Postfix, from userid 40) id 000AC6B009E; Thu, 10 Sep 2026 05:02:03 -0400 (EDT) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id E0B4C6B009F; Thu, 10 Sep 2026 05:02:03 -0400 (EDT) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (smtprelay0015.hostedemail.com [216.40.44.15]) by kanga.kvack.org (Postfix) with ESMTP id B45BF6B009D for ; Thu, 10 Sep 2026 05:02:03 -0400 (EDT) Received: from smtpin17.hostedemail.com (lb01a-stub [10.200.18.249]) by unirelay02.hostedemail.com (Postfix) with ESMTP id B968012045B for ; Thu, 10 Sep 2026 09:02:02 +0000 (UTC) X-FDA: 85197260484.17.1B0A102 Received: from sea.source.kernel.org (sea.source.kernel.org [172.234.252.31]) by imf28.hostedemail.com (Postfix) with ESMTP id E3B5AC0008 for ; Thu, 10 Sep 2026 09:02:00 +0000 (UTC) Authentication-Results: imf28.hostedemail.com; dkim=pass header.d=kernel.org header.s=k20260515 header.b=OLZ5B3fu; spf=pass (imf28.hostedemail.com: domain of a.hindborg@kernel.org designates 172.234.252.31 as permitted sender) smtp.mailfrom=a.hindborg@kernel.org; dmarc=pass (policy=quarantine) header.from=kernel.org ARC-Seal: i=1; a=rsa-sha256; d=hostedemail.com; s=arc-20220608; cv=none; t=1789030921; b=gqeHFf+WOjxRp5FaBpyr8P4Cj5g+Fas43jJFbLMieZdGpOyRVNtWN2gqkb3B3eVZPXC7rS yFStwEVjz15oqcQUg0hD4Buym68mlxrhuPDX5S+kDYAz802Gb98V9MGOVyZwS18bcINZJK iqC+Dhpkqfbmya+5F8yFJRCjLUuzoMY= ARC-Authentication-Results: i=1; imf28.hostedemail.com; dkim=pass header.d=kernel.org header.s=k20260515 header.b=OLZ5B3fu; spf=pass (imf28.hostedemail.com: domain of a.hindborg@kernel.org designates 172.234.252.31 as permitted sender) smtp.mailfrom=a.hindborg@kernel.org; dmarc=pass (policy=quarantine) header.from=kernel.org ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=hostedemail.com; s=arc-20220608; t=1789030921; h=from:from:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:dkim-signature; bh=yt5UAGueNm32iTeFR6jcKBb+FhJxYmboaOihvjd/LlU=; b=kBQd0mkmDRH5otClseDTnxXX+B05P0ZgCreNZAWPdfKVXPMHj2ppzHjldQnV7pk48Ya3Yi hO0nTN+dugQGEQXfkVUjj8AtodehHTCcIcNaHxhk7EPG2zsrfNARluZkTy5iSZhiIv5Y9j PAcgLYcMreluZpNysRkNhpqNYEPPxi8= Received: from smtp.kernel.org (quasi.space.kernel.org [100.103.45.18]) by sea.source.kernel.org (Postfix) with ESMTP id 38F49409E3; Thu, 10 Sep 2026 09:01:59 +0000 (UTC) Received: by smtp.kernel.org (Postfix) with ESMTPSA id 2C0B21F000FF; Thu, 10 Sep 2026 09:01:47 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=kernel.org; s=k20260515; t=1789030919; bh=yt5UAGueNm32iTeFR6jcKBb+FhJxYmboaOihvjd/LlU=; h=From:Date:Subject:References:In-Reply-To:To:Cc; b=OLZ5B3fuSqJeJziVml2J7+SuEmvWItkOgOQyjncwSG2DimnGwv4KyDQJlXLXW5sxM nvCLV+4THEj2dC4voriGeaOEl5QiGheN3Z2q+ABMVBOmnvBJ8FuiomSDYgcAkjYXpC WmtKW9WFO9JI1P3g0nUTzXvMxX7Fg2E2spCP2GDThib+uN4W2ZmGUi3s7tMBahhhib nssJ+bxC5fSWQ5nIEawiqdv8AluaXKDpA29tlDrzi1jNgnhNaksN5SQ2CgBz20IqKC z8oV75B01Z2KKl9IwRK3SOYnF1oqFwMJIWTDbyu/FS6hpLcCRVklw5rhUr6Y6iWJ7g 7BtR/7T+ldmkw== From: Andreas Hindborg Date: Thu, 10 Sep 2026 11:00:09 +0200 Subject: [PATCH v21 5/9] rust: Add missing SAFETY documentation for `ARef` example MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: 7bit Message-Id: <20260910-unique-ref-v21-5-e83257373062@kernel.org> References: <20260910-unique-ref-v21-0-e83257373062@kernel.org> In-Reply-To: <20260910-unique-ref-v21-0-e83257373062@kernel.org> To: Danilo Krummrich , Lorenzo Stoakes , Vlastimil Babka , "Liam R. Howlett" , Uladzislau Rezki , Miguel Ojeda , Boqun Feng , Gary Guo , =?utf-8?q?Bj=C3=B6rn_Roy_Baron?= , Benno Lossin , Alice Ryhl , Trevor Gross , Daniel Almeida , Tamir Duberstein , Alexandre Courbot , =?utf-8?q?Onur_=C3=96zkan?= , Lyude Paul , Greg Kroah-Hartman , =?utf-8?q?Arve_Hj=C3=B8nnev=C3=A5g?= , Todd Kjos , Christian Brauner , Carlos Llamas , "Rafael J. Wysocki" , Dave Ertman , Leon Romanovsky , Paul Moore , Serge Hallyn , David Airlie , Simona Vetter , Alexander Viro , Jan Kara , Igor Korotin , Viresh Kumar , Nishanth Menon , Stephen Boyd , Bjorn Helgaas , =?utf-8?q?Krzysztof_Wilczy=C5=84ski?= , Pavel Tikhomirov , Michal Wilczynski , Ira Weiny , Matthew Brost , =?utf-8?q?Thomas_Hellstr=C3=B6m?= , Ira Weiny Cc: Andreas Hindborg , Philipp Stanner , rust-for-linux@vger.kernel.org, linux-kernel@vger.kernel.org, linux-mm@kvack.org, driver-core@lists.linux.dev, linux-block@vger.kernel.org, linux-security-module@vger.kernel.org, dri-devel@lists.freedesktop.org, linux-fsdevel@vger.kernel.org, linux-pm@vger.kernel.org, linux-pci@vger.kernel.org, linux-pwm@vger.kernel.org, linux-usb@vger.kernel.org, Oliver Mangold X-Mailer: b4 0.16.0 X-Developer-Signature: v=1; a=openpgp-sha256; l=1957; i=a.hindborg@kernel.org; h=from:subject:message-id; bh=BNWtmHgpjNUhrCkbsOHEBA7MTI0LVX3SSpIhyT98+Ow=; b=owEBbQKS/ZANAwAKAfpQKQiqxb3QAcsmYgBqonGlMsJOOFdosQ0jUhYoghNsqo0y4sSrnWOtC 1TQjvbumFuJAjMEAAEKAB0WIQRXitnI2WZ2JirAaob6UCkIqsW90AUCaqJxpQAKCRD6UCkIqsW9 0Cd+D/9nAUfqKWaGoqKv7nfm0hhF9sliL+paN7BmyiCqXpgYuTMfax03XP7wuBLX+p1hrdviAhE H1PrBfVWfd3V3zHdCH/GokxiWtF4Uwki/PnMnl8bXFvJby5yN9P2wz1Bzr+ZoeZXdPlcAVwaUYf lAZgSE0szcxSq5yZYh5NZ5e1derfpNSOMIS6F/k3KTRFoPA6OpW6thdkVIXZOTacMnm6Gc0ZZW3 cEKyHvTgntPVD4mYH2VewLR6LRt/3un9vJT2T5oj7/dHNQAaLmguQFggWup1xYA6a65I2dHc7Ol 9mPIKE0Rc+s8IJMPX7bLzDvoNu/uBR4+qJTEQbtS5fzpYL/VubrnZpOqDkG+WdgWDbHYS29hpv1 hOaNVXWUzxLlqPWyXJb0Kxq7nMnROnusibYCYRrnu6y588044SLI8D4h+WprDXV5ikecb+C3oVT uZbiWr2DcD406Wq9a1ctobdItGN7JO8tuPmepticFVhV3cd9xwr10q29wJ3DNgWY7Z00GxtadFk CxEV8zx8CkgTamGEaSpsZns8tdzXSdPz3lC5bnjzKC33CPk8iUrRGERISKT/xET9BJxqZjEAuHU tjAeZT75VZmxlGKiT22VwccqR12Y9eQ580MdcvGQVWbtb5BDrxCo6ka0p9YA+acEkL89XEl3Ljw 4AK7zgNZG4eUFqg== X-Developer-Key: i=a.hindborg@kernel.org; a=openpgp; fpr=3108C10F46872E248D1FB221376EB100563EF7A7 X-Rspam-User: X-Rspamd-Server: rspam08 X-Rspamd-Queue-Id: E3B5AC0008 X-Stat-Signature: 8dykcmibi8oxf6mreczpun8ggxacjswc X-HE-Tag: 1789030920-148088 X-HE-Meta: U2FsdGVkX1/olCXj7Fl2GbR3J++psD1icwVeDQFFkW/AXT7ybiqRQJ+1K8b7KXAk5159sqvORH9WhFzhG1ja7b0c3XrvUErPD1Lbu6b7dL2a4fVlMIBNh3Nm61h5OQSL5USYEuv4PgOAnNu8E6FF1XzGEwDacsIwk0Y9ziAsSUse7LNoJrhkM5XQX4TLi1iUjBpsUeSSvLXO4w2b3tGzsXtbgsCgeka2zrStfqfjk3t8LLaE7sUGh8TZp8w8sTwYzbDDcY1jQ0jlUCcOUIpxPeqCcKceVVxUnctEQ+6aNyZCDoKsPypXt7mMdhe6DaUO/ZlqJDkDA3kKN+D6FRviCaKIrBEMqWy0NXq5xsDjCaqjbY377m+VWUHzx0wDLbzId4YaXDOupylCngpWZWn6H+FfYt+tbHwkk0lr4h6wqwm3bpzgDwPlaAQLoY0rT0jTFf7PLxYUHB0eykHCup8piYp2eW9TQKP8tnJy692KWcbXecLuMAcOxr+HnetII6H2K0+6PtVCeTx+SQc6sW8r5rbXDYaW3p+YNCuk2yh3ZevoPxlC1dEWwwWsWR4rvqeAGvVpcSjRg6I3/0CmoRIPbONyzw4tSZw9Y/EcwFClZv5Z4tDGclafwl5/puY0JzNtAIMHgRT9ookA2IzAlb17onOw113At3Mtf0EVfuVutcEFNScq9JvvKicobpUiWyrz3dRrLFZIRCDipEKomDTVB76qj9WqhFYp19orcNRKGnmIdkDLv0iwg/USrlbfZabe+xakbJU7TrkM6NjniUhPu5/OUXhRhAaXIvvPFrSdUnnO6TkojjKao1rhKq6r8kj++LhcvbTYoEmftOaH/UUrWCeM3AT0IBr2vxxCJTnMAYsOtHArwtUWXrgSXYIS9kAdgyV5Hl1pMOQu/XQRwV4Y1ppgnzxB269lz0I/gCxk8qtDgYN9ryDZ1yiKZYkwdKrdT9LCj9l6XHDc3MOVjmr BUH4SXOi c6ljFs+vt5ezi2Ud8OlfxxWakTuhSJ/BXY3+eLzOszsgzhdjL0k4vsOkFkE10VrY125D7fcyJPEx+Y4M3NgkafwBmMMnkWMkGWHkLWVTmHCR1jE+Ze7F+HU0SKvZgrhEiC3t3f9Xi8G1KALGnpLlV2NDsi8lRflZWGwNb5Jc2mRhYJjj9Nvso5QwVAX8+8/98YZNNATc7poPevCVK8IcDUm6PuWgSg5cOvmZHgt6TL1n6KlNQ+i15wT6qA1TRzhe5zPZjpVHGMXMeONQS/kzjxLK80OkhcfVFRY6ijyvgGIDLIg+QKHf25PTehQ7rHusLvcCrjEhvxxiSi7xYS/7vMG8p4Jc1OUz2A2yyphwFT+OtjWM= Sender: owner-linux-mm@kvack.org Precedence: bulk X-Loop: owner-majordomo@kvack.org List-ID: List-Subscribe: List-Unsubscribe: From: Oliver Mangold SAFETY comment in rustdoc example was just 'TODO'. Fixed. Link: https://github.com/Rust-for-Linux/linux/issues/351 Signed-off-by: Oliver Mangold Reviewed-by: Daniel Almeida Assisted-by: LLM Co-developed-by: Andreas Hindborg Signed-off-by: Andreas Hindborg --- rust/kernel/sync/aref.rs | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/rust/kernel/sync/aref.rs b/rust/kernel/sync/aref.rs index 215e7eb139fa..ae76bd9b6c1c 100644 --- a/rust/kernel/sync/aref.rs +++ b/rust/kernel/sync/aref.rs @@ -147,7 +147,10 @@ pub unsafe fn from_raw(ptr: NonNull) -> Self { /// /// struct Empty {} /// - /// # // SAFETY: TODO. + /// // SAFETY: The `RefCounted` implementation for `Empty` does not count references, and + /// // `dec_ref` never frees the underlying object, so a decrement cannot invalidate it. The + /// // object instead lives as long as the `Empty` value itself, so creators of `ARef` + /// // must guarantee that the value outlives every `ARef` derived from it (as done below). /// unsafe impl RefCounted for Empty { /// fn inc_ref(&self) {} /// unsafe fn dec_ref(_obj: NonNull) {} @@ -155,7 +158,9 @@ pub unsafe fn from_raw(ptr: NonNull) -> Self { /// /// let mut data = Empty {}; /// let ptr = NonNull::::new(&mut data).unwrap(); - /// # // SAFETY: TODO. + /// // SAFETY: As the refcount operations of `Empty` are no-ops, we can treat `ptr` as owning + /// // an increment on the refcount. `data` outlives the created `ARef`, upholding the + /// // liveness guarantee required by the `RefCounted` implementation above. /// let data_ref: ARef = unsafe { ARef::from_raw(ptr) }; /// let raw_ptr: NonNull = ARef::into_raw(data_ref); /// -- 2.51.2