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;
Date:   Mon, 14 Nov 2022 14:34:05 +0000
From:   Gary Guo <gary@garyguo.net>
To:     Miguel Ojeda <ojeda@kernel.org>
Cc:     Wedson Almeida Filho <wedsonaf@gmail.com>,
        Alex Gaynor <alex.gaynor@gmail.com>,
        Boqun Feng <boqun.feng@gmail.com>,
        =?UTF-8?B?QmrDtnJu?= Roy Baron <bjorn3_gh@protonmail.com>,
        rust-for-linux@vger.kernel.org, linux-kernel@vger.kernel.org,
        patches@lists.linux.dev
Subject: Re: [PATCH v1 12/28] rust: alloc: add
 `RawVec::try_with_capacity_in()` constructor
Message-ID: <20221114143405.2334ed8b@GaryWorkstation>
In-Reply-To: <20221110164152.26136-13-ojeda@kernel.org>
References: <20221110164152.26136-1-ojeda@kernel.org>
        <20221110164152.26136-13-ojeda@kernel.org>
Content-Type: text/plain; charset=US-ASCII
Content-Transfer-Encoding: 7bit
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?us-ascii?Q?fv+Kl5DfDStcU+xNQOCGQcgjfOBfazNuCMVgX4dfyC4aCczMMgkPU6IQGEpC?=
 =?us-ascii?Q?27O3w+5EOLJgXuWDaNxFP43859+oxJ57yXbYe9DPh/MTK2p/bou5sgVic5nN?=
 =?us-ascii?Q?Q8dduBzesRzZqi/yOMHz3yEdVyDMu9qqLUSBVX/NBNj3B4ERdEPvWE0MGudq?=
 =?us-ascii?Q?ngtbyC23chyOkarI5iED3VxmIxFzhqC3AHNUnweJQNKzZj8JXM6DBn+eQ3XR?=
 =?us-ascii?Q?rQMlxCQ1oC47rdJYYUh0s0KXmFUb6ZI3RfydqWtwdvgZAkjSP0uBg69+tT6w?=
 =?us-ascii?Q?LArMOvdhXFa/ZS6AOrkayzXdarJnsLcLssYhGlea1sEBJALRlgWkY171Wr9V?=
 =?us-ascii?Q?lYlogh9jgT2ufXOMgl4w6ICddvo47LofjO+VrPSLQ1zVHUivSUPLXvAGqRA0?=
 =?us-ascii?Q?HogH5zP46yHg9utFHe4ahe6Unm27scXMD5dHdEiM9uAkMQea0bjrsiEvQCCb?=
 =?us-ascii?Q?C0VU0TPq/9MTcK/zyEOv0CqKHFeHnVJezs2i2bXhU78QUx1r4qs9gPPevo1R?=
 =?us-ascii?Q?GMUPOxKv1RHf7LTmBh/+P/kM41rbOI7fZjgNtuTZI6aqOHRMVP+doitS2C1O?=
 =?us-ascii?Q?bX8AHWm1YiECvgSteU948AtatWNNE3tLPbDqotJbIFLg52MvfmtYTojWjLS8?=
 =?us-ascii?Q?IGxv6SG8OMrkCGWyYyzYkrVYrObdN/+KPm4q+MPIa5UuC6T9MhAcEmVcJ1OL?=
 =?us-ascii?Q?1ZrrTYtyowQg1TsnbDVy/5rGOFrsHLropearBqC1FpERw0ZafcMu27JogwFL?=
 =?us-ascii?Q?XsoVfV95s5x83Cp4RdagsartTqPcpF4O9F+4RyM8MF9M0OqW7UZvDTwW9eC/?=
 =?us-ascii?Q?YLfmIHU6/QQkY9WH/jemlIYZVw6ylg0plU3fEnV2x7F4OLslK97mj4flabBb?=
 =?us-ascii?Q?OEbUzstCS9X5bFBdIIjLxbV+acISWGB0MKQIK/3QIgsMQ+GzEnyJCU2aTQyS?=
 =?us-ascii?Q?5+FXCmOXUyDWAIbw85uEU7J7COR7TBJB3YndSJsONpETFsFJJM4k8PZt/mNg?=
 =?us-ascii?Q?gwbC14TsF+4wv7XE+nU/o70mEVk+u0DDVs1NTXA4zRA0EvuSITil6NmHiwjP?=
 =?us-ascii?Q?WJ9+1/poD6XAGid5vqchMTp+s4h+4hscw1IoGUrLzGEJ5ov1Y+GGqTS4PU+H?=
 =?us-ascii?Q?EDgPCSzl6g+gr4nY3mFv1jXFoi/+5IHDeHH0y1kv4VTkiDc/jtgm9cCwKDgS?=
 =?us-ascii?Q?goS8RPSeu/DbMH1gB5H+NhycS7LKT8D60seJtXtxt1fKSt2Vm4iswMmLLcFt?=
 =?us-ascii?Q?YYnGzz0eDJtN3RCBfuNpkYuoqMZb0d2Ut/GWThearoYJHgsGkKT0wFBZAZYZ?=
 =?us-ascii?Q?R4IFlSVYY5QccgHFIFlpPqMJuJfU1zYo0CBbY9ZCaRXbPlUH5j6YAj4zEtWY?=
 =?us-ascii?Q?RgXv9lKzyNjHW5PH8mviqenNqOTC7Hnm9HJWUmN/dUbwcHhPUsYVEXgFG3b4?=
 =?us-ascii?Q?ntlKHrTyOgDaP25odBdvHo5od5vAp8eNkmHQCJenMKClZp+UQgKDOrD2vfCM?=
 =?us-ascii?Q?hrAi7+YAeqU8k4m8L7RRGwyNDyV4uYNC3zw5yi5QwU6Ki2CfFumHFXzr8VjD?=
 =?us-ascii?Q?8c86Hc3RXsEdpXMek5sN/09Eo8TNYnpZNtBo0uSjz5D4Fzz9sE3sUxlm1zYQ?=
 =?us-ascii?Q?iuxIcqMKvQulhGjucCVeoN1NpErMhyjwpysWSA8AVkkJ?=
X-OriginatorOrg: garyguo.net
X-MS-Exchange-CrossTenant-Network-Message-Id: 1388a9c1-d94e-4e21-7898-08dac64d48f9
X-MS-Exchange-CrossTenant-AuthSource: LO2P265MB5183.GBRP265.PROD.OUTLOOK.COM
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 14 Nov 2022 14:34:06.6374
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: bbc898ad-b10f-4e10-8552-d9377b823d45
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: UPgjk1S7GF3BpLnRa1zaqsw+nFTxC2i61txHcMn96vXIfFEtNl400qcBbDWBWxE2E20InPkQirgMnIBtgfGQDQ==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: LO0P265MB5572
X-Spam-Status: No, score=-2.1 required=5.0 tests=BAYES_00,DKIM_SIGNED,
        DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,RCVD_IN_DNSWL_NONE,
        RCVD_IN_MSPIKE_H2,SPF_HELO_PASS,SPF_PASS autolearn=ham
        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: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org

On Thu, 10 Nov 2022 17:41:24 +0100
Miguel Ojeda <ojeda@kernel.org> wrote:

> Add the `RawVec::try_with_capacity_in()` constructor as the fallible
> version of `RawVec::with_capacity_in()`.
> 
> The implementation follows the original.
> 
> The infallible constructor is implemented in terms of the private
> `RawVec::allocate_in()` constructor, thus also add the private
> `RawVec::try_allocate_in()` constructor following the other.
> 
> It will be used to implement `Vec::try_with_capacity{,_in}()` in
> the next patch.
> 
> Signed-off-by: Miguel Ojeda <ojeda@kernel.org>

Reviewed-by: Gary Guo <gary@garyguo.net>

> ---
>  rust/alloc/raw_vec.rs | 34 +++++++++++++++++++++++++++++++++-
>  1 file changed, 33 insertions(+), 1 deletion(-)
> 
> diff --git a/rust/alloc/raw_vec.rs b/rust/alloc/raw_vec.rs
> index daf5f2da7168..c342f3843972 100644
> --- a/rust/alloc/raw_vec.rs
> +++ b/rust/alloc/raw_vec.rs
> @@ -20,11 +20,11 @@ use crate::collections::TryReserveErrorKind::*;
>  #[cfg(test)]
>  mod tests;
>  
> -#[cfg(not(no_global_oom_handling))]
>  enum AllocInit {
>      /// The contents of the new memory are uninitialized.
>      Uninitialized,
>      /// The new memory is guaranteed to be zeroed.
> +    #[allow(dead_code)]
>      Zeroed,
>  }
>  
> @@ -133,6 +133,14 @@ impl<T, A: Allocator> RawVec<T, A> {
>          Self::allocate_in(capacity, AllocInit::Uninitialized, alloc)
>      }
>  
> +    /// Like `try_with_capacity`, but parameterized over the choice of
> +    /// allocator for the returned `RawVec`.
> +    #[allow(dead_code)]
> +    #[inline]
> +    pub fn try_with_capacity_in(capacity: usize, alloc: A) -> Result<Self, TryReserveError> {
> +        Self::try_allocate_in(capacity, AllocInit::Uninitialized, alloc)
> +    }
> +
>      /// Like `with_capacity_zeroed`, but parameterized over the choice
>      /// of allocator for the returned `RawVec`.
>      #[cfg(not(no_global_oom_handling))]
> @@ -203,6 +211,30 @@ impl<T, A: Allocator> RawVec<T, A> {
>          }
>      }
>  
> +    fn try_allocate_in(capacity: usize, init: AllocInit, alloc: A) -> Result<Self, TryReserveError> {
> +        // Don't allocate here because `Drop` will not deallocate when `capacity` is 0.
> +        if mem::size_of::<T>() == 0 || capacity == 0 {
> +            return Ok(Self::new_in(alloc));
> +        }
> +
> +        let layout = Layout::array::<T>(capacity).map_err(|_| CapacityOverflow)?;
> +        alloc_guard(layout.size())?;
> +        let result = match init {
> +            AllocInit::Uninitialized => alloc.allocate(layout),
> +            AllocInit::Zeroed => alloc.allocate_zeroed(layout),
> +        };
> +        let ptr = result.map_err(|_| AllocError { layout, non_exhaustive: () })?;
> +
> +        // Allocators currently return a `NonNull<[u8]>` whose length
> +        // matches the size requested. If that ever changes, the capacity
> +        // here should change to `ptr.len() / mem::size_of::<T>()`.
> +        Ok(Self {
> +            ptr: unsafe { Unique::new_unchecked(ptr.cast().as_ptr()) },
> +            cap: capacity,
> +            alloc,
> +        })
> +    }
> +
>      /// Reconstitutes a `RawVec` from a pointer, capacity, and allocator.
>      ///
>      /// # Safety