From patchwork Tue Apr 11 05:45:38 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Wedson Almeida Filho X-Patchwork-Id: 81743 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a59:b0ea:0:b0:3b6:4342:cba0 with SMTP id b10csp2351793vqo; Mon, 10 Apr 2023 22:55:29 -0700 (PDT) X-Google-Smtp-Source: AKy350ZV8+dVOBuMdHnqBwmBb4WOggMnmoSb6hyUC+eNpSlLfjXeUIGX6/MrJCxR1jhIofOKi+Kp X-Received: by 2002:a17:906:2e85:b0:94d:a2c2:9aeb with SMTP id o5-20020a1709062e8500b0094da2c29aebmr2549723eji.49.1681192529252; Mon, 10 Apr 2023 22:55:29 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1681192529; cv=none; d=google.com; s=arc-20160816; b=U0K8YF11T+3JLP171QkRfT1UdAwAB1hwXkJn8ydT+L6UhPmjnKPtLLktDzRcWF8HfY G8CX2MoH0L1Jnn+6puNPOqipcFptE05ih2KiVfvOOh5diMuLgadOCRBhq2hCvXxr6eLl CvIk4Ld+2BKdh1FnHhDOzp4PgLXHsUyRcAyPREQj5dYGoMO2aien1c6zJIyB4mkeIU+C 8JkfW2WtR3N0se4SM94FdQnQdGEPPZS6X0T1FrrGWng2/6fVSFr9MSwPNnLKLtYXLOO3 QR5b9DtAlA5rlBS2rxtUH3It48/eMonRPhCaGx5+8jgcpsGWN+4HG5+FclMw7Xb58h+t b+dw== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:content-transfer-encoding:mime-version :references:in-reply-to:message-id:date:subject:cc:to:from :dkim-signature; bh=lNoumsGmcTI11a3EyviqrqaE0Uj9EE9DrxAixIJSJC0=; b=qmxB9IlAGCEbplh5WBS3tKwejN0L4nm3KdpJXpwLRUe9R+DpwQRlHQiHY4YcMMCM10 cYnTly6/I4/6uK+JMSYfXdh0LFoeVnz9tfzAik96zHIRsTs1dq8Yp7mRSN/pyg3W85Hl zgYPlbBvlPyi02jpA+yvTYNM9IEC8pkkUUNIi6MlQhKKG2onTpEkA1bk3ksUHVft2uAC KtPmlLSEZhawU+KnLvHubGJIEiy9lkSKArtahLyPWK7i15XEKyOzTosj1MMHdNlP8fYm s0bTLyQsRjPbYxM/vtm6FySd+GUn02etnnYEZalBytK7hcbCyRiI4wG4Q/tTCbOymTG/ 2SBQ== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@gmail.com header.s=20210112 header.b=J2yJ1jws; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=gmail.com Received: from out1.vger.email (out1.vger.email. [2620:137:e000::1:20]) by mx.google.com with ESMTP id e8-20020a170906c00800b00946872f37c6si8698161ejz.450.2023.04.10.22.55.04; Mon, 10 Apr 2023 22:55:29 -0700 (PDT) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20; Authentication-Results: mx.google.com; dkim=pass header.i=@gmail.com header.s=20210112 header.b=J2yJ1jws; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=gmail.com Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S230167AbjDKFrB (ORCPT + 99 others); Tue, 11 Apr 2023 01:47:01 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:56106 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S230113AbjDKFqr (ORCPT ); Tue, 11 Apr 2023 01:46:47 -0400 Received: from mail-oa1-x31.google.com (mail-oa1-x31.google.com [IPv6:2001:4860:4864:20::31]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 35D943AB5; Mon, 10 Apr 2023 22:46:23 -0700 (PDT) Received: by mail-oa1-x31.google.com with SMTP id 586e51a60fabf-1842cddca49so8681820fac.1; Mon, 10 Apr 2023 22:46:23 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; t=1681191982; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=lNoumsGmcTI11a3EyviqrqaE0Uj9EE9DrxAixIJSJC0=; b=J2yJ1jwsNzIMBz5LAw//6l/1EI6gA2yewEhLtusaC728F+hmsWLU2lNQ0DnrD8zKVw Bsvei8W0IG6PlJVKavmzkDC4QEi0FnbNWV6FTmnEd3IPhGFMvXr2Z1vUP8kzikEqiJsL ZFT9BB9EycLpk4ZAooerfaKYdKIZZEVUF7Y/EvfhRfO19tsnbs167Z5VNzL4ZZQEtp2E oCL1EwIqKyuS/GfKlpKOLicZSuMDOfmurSCh5TlqdUzQNwaYoQoUf016jqd6l8JLenhj rKF+MT5OP45eitRYcIXVo1uacl6SHbiRS16xGl35JyHnMm6HiH6kOVqpkdYLa0q8ioXT tJig== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; t=1681191982; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=lNoumsGmcTI11a3EyviqrqaE0Uj9EE9DrxAixIJSJC0=; b=GMmFhKkdPsCDaV43+oTD6uQWRmbwGn8AXb0DZlxUvqxVF/vm0du2vovO9/fP/QbFrI RbxU67VHdKSVw813hjoLlSp3di3ob1zGm0zU323jmUv7F4Ev/6vZIZuqA47sXtzXEki8 t0FSwHLiCVAh2QRUL+JQBf6yS1MC1lcQg5w1dSSgFjDTSUHjX/fgHmxs8pViIcEqPWQG 6qdhCPItI+st8w/Ibjf8BQHBqqmTbfNizOA+e1oinjOzk848h17za1a3zRYbwzBbahBo 7IUmGue/OQzdOBEqMz2TuFmzM0bvCQtDc2BI3Sg5RQ6W+bOmenfz90ssR0rW9ZvhctMQ pxfw== X-Gm-Message-State: AAQBX9eqpo08G6Le0uFaPHKcfXWTIOSL1Mw0geFOso0sq82l/Ruy6cUh LyvBi9HW3M84zP/KPfDcpxkXnsgCvfc= X-Received: by 2002:a05:6870:40d4:b0:181:d654:30c5 with SMTP id l20-20020a05687040d400b00181d65430c5mr5638095oal.4.1681191982433; Mon, 10 Apr 2023 22:46:22 -0700 (PDT) Received: from wedsonaf-dev.home.lan ([189.124.190.154]) by smtp.googlemail.com with ESMTPSA id z186-20020a4a49c3000000b005252d376caesm5440706ooa.22.2023.04.10.22.46.19 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 10 Apr 2023 22:46:22 -0700 (PDT) From: Wedson Almeida Filho To: rust-for-linux@vger.kernel.org Cc: Miguel Ojeda , Alex Gaynor , Boqun Feng , Gary Guo , =?utf-8?q?B?= =?utf-8?q?j=C3=B6rn_Roy_Baron?= , linux-kernel@vger.kernel.org, Wedson Almeida Filho , Martin Rodriguez Reboredo Subject: [PATCH v4 08/13] rust: introduce `ARef` Date: Tue, 11 Apr 2023 02:45:38 -0300 Message-Id: <20230411054543.21278-8-wedsonaf@gmail.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20230411054543.21278-1-wedsonaf@gmail.com> References: <20230411054543.21278-1-wedsonaf@gmail.com> MIME-Version: 1.0 X-Spam-Status: No, score=-0.2 required=5.0 tests=DKIM_SIGNED,DKIM_VALID, DKIM_VALID_AU,DKIM_VALID_EF,FREEMAIL_FROM,RCVD_IN_DNSWL_NONE, SPF_HELO_NONE,SPF_PASS autolearn=unavailable autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on lindbergh.monkeyblade.net Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org X-getmail-retrieved-from-mailbox: =?utf-8?q?INBOX?= X-GMAIL-THRID: =?utf-8?q?1762858137328728838?= X-GMAIL-MSGID: =?utf-8?q?1762858137328728838?= From: Wedson Almeida Filho This is an owned reference to an object that is always ref-counted. This is meant to be used in wrappers for C types that have their own ref counting functions, for example, tasks, files, inodes, dentries, etc. Reviewed-by: Martin Rodriguez Reboredo Signed-off-by: Wedson Almeida Filho Reviewed-by: Gary Guo --- v1 -> v2: No changes v2 -> v3: No changes v3 -> v4: No changes rust/kernel/types.rs | 107 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 107 insertions(+) diff --git a/rust/kernel/types.rs b/rust/kernel/types.rs index a4b1e3778da7..29db59d6119a 100644 --- a/rust/kernel/types.rs +++ b/rust/kernel/types.rs @@ -6,8 +6,10 @@ use crate::init::{self, PinInit}; use alloc::boxed::Box; use core::{ cell::UnsafeCell, + marker::PhantomData, mem::MaybeUninit, ops::{Deref, DerefMut}, + ptr::NonNull, }; /// Used to transfer ownership to and from foreign (non-Rust) languages. @@ -268,6 +270,111 @@ impl Opaque { } } +/// Types that are _always_ reference counted. +/// +/// It allows such types to define their own custom ref increment and decrement functions. +/// Additionally, it allows users to convert from a shared reference `&T` to an owned reference +/// [`ARef`]. +/// +/// This is usually implemented by wrappers to existing structures on the C side of the code. For +/// Rust code, the recommendation is to use [`Arc`](crate::sync::Arc) to create reference-counted +/// instances of a type. +/// +/// # Safety +/// +/// Implementers must ensure that increments to the reference count keep the object alive in memory +/// at least until matching decrements are performed. +/// +/// Implementers must also ensure that all instances are reference-counted. (Otherwise they +/// won't be able to honour the requirement that [`AlwaysRefCounted::inc_ref`] keep the object +/// alive.) +pub unsafe trait AlwaysRefCounted { + /// Increments the reference count on the object. + fn inc_ref(&self); + + /// Decrements the reference count on the object. + /// + /// Frees the object when the count reaches zero. + /// + /// # Safety + /// + /// Callers must ensure that there was a previous matching increment to the reference count, + /// and that the object is no longer used after its reference count is decremented (as it may + /// result in the object being freed), unless the caller owns another increment on the refcount + /// (e.g., it calls [`AlwaysRefCounted::inc_ref`] twice, then calls + /// [`AlwaysRefCounted::dec_ref`] once). + unsafe fn dec_ref(obj: NonNull); +} + +/// An owned reference to an always-reference-counted object. +/// +/// The object's reference count is automatically decremented when an instance of [`ARef`] is +/// dropped. It is also automatically incremented when a new instance is created via +/// [`ARef::clone`]. +/// +/// # Invariants +/// +/// The pointer stored in `ptr` is non-null and valid for the lifetime of the [`ARef`] instance. In +/// particular, the [`ARef`] instance owns an increment on the underlying object's reference count. +pub struct ARef { + ptr: NonNull, + _p: PhantomData, +} + +impl ARef { + /// Creates a new instance of [`ARef`]. + /// + /// It takes over an increment of the reference count on the underlying object. + /// + /// # Safety + /// + /// Callers must ensure that the reference count was incremented at least once, and that they + /// are properly relinquishing one increment. That is, if there is only one increment, callers + /// must not use the underlying object anymore -- it is only safe to do so via the newly + /// created [`ARef`]. + pub unsafe fn from_raw(ptr: NonNull) -> Self { + // INVARIANT: The safety requirements guarantee that the new instance now owns the + // increment on the refcount. + Self { + ptr, + _p: PhantomData, + } + } +} + +impl Clone for ARef { + fn clone(&self) -> Self { + self.inc_ref(); + // SAFETY: We just incremented the refcount above. + unsafe { Self::from_raw(self.ptr) } + } +} + +impl Deref for ARef { + type Target = T; + + fn deref(&self) -> &Self::Target { + // SAFETY: The type invariants guarantee that the object is valid. + unsafe { self.ptr.as_ref() } + } +} + +impl From<&T> for ARef { + fn from(b: &T) -> Self { + b.inc_ref(); + // SAFETY: We just incremented the refcount above. + unsafe { Self::from_raw(NonNull::from(b)) } + } +} + +impl Drop for ARef { + fn drop(&mut self) { + // SAFETY: The type invariants guarantee that the `ARef` owns the reference we're about to + // decrement. + unsafe { T::dec_ref(self.ptr) }; + } +} + /// A sum type that always holds either a value of type `L` or `R`. pub enum Either { /// Constructs an instance of [`Either`] containing a value of type `L`.