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]) by smtp.lore.kernel.org (Postfix) with ESMTP id 711E9C3DA64 for ; Thu, 1 Aug 2024 12:30:17 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id 04E466B0089; Thu, 1 Aug 2024 08:30:17 -0400 (EDT) Received: by kanga.kvack.org (Postfix, from userid 40) id F40D56B008A; Thu, 1 Aug 2024 08:30:16 -0400 (EDT) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id E2FF46B008C; Thu, 1 Aug 2024 08:30:16 -0400 (EDT) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (smtprelay0013.hostedemail.com [216.40.44.13]) by kanga.kvack.org (Postfix) with ESMTP id C5B886B0089 for ; Thu, 1 Aug 2024 08:30:16 -0400 (EDT) Received: from smtpin10.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay06.hostedemail.com (Postfix) with ESMTP id 4157AA76FA for ; Thu, 1 Aug 2024 12:30:16 +0000 (UTC) X-FDA: 82403609232.10.2B3537D Received: from sin.source.kernel.org (sin.source.kernel.org [145.40.73.55]) by imf09.hostedemail.com (Postfix) with ESMTP id C8897140010 for ; Thu, 1 Aug 2024 12:30:13 +0000 (UTC) Authentication-Results: imf09.hostedemail.com; dkim=pass header.d=kernel.org header.s=k20201202 header.b=tHSKZqva; spf=pass (imf09.hostedemail.com: domain of dakr@kernel.org designates 145.40.73.55 as permitted sender) smtp.mailfrom=dakr@kernel.org; dmarc=pass (policy=none) header.from=kernel.org ARC-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1722515385; a=rsa-sha256; cv=none; b=57iMA0Jt6+kExRkQZTrVy9K25eDEoIf1w7ZC6q9fbiNj1U5xdb6KEs+8m5j/WohjdxY6ai YeFhflFODJ+U4Rtjmxr2FC4Ea9MWCz9qNj2fYcL0KuPK/Jx7LEem966ZjArK7HhXpyuRgi /8iWytdOmTLYus5ktN5EmCGeywjkRcw= ARC-Authentication-Results: i=1; imf09.hostedemail.com; dkim=pass header.d=kernel.org header.s=k20201202 header.b=tHSKZqva; spf=pass (imf09.hostedemail.com: domain of dakr@kernel.org designates 145.40.73.55 as permitted sender) smtp.mailfrom=dakr@kernel.org; dmarc=pass (policy=none) header.from=kernel.org ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=hostedemail.com; s=arc-20220608; t=1722515385; 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=oibLG+89eIfY1AA1KFH0Ur3aja5aR9HxmFJX0bCnUe8=; b=7JvCcRVYpEaurS1EurP1Ge93oZ37nzpnItlsy8u6TA+AbjJ6uXilXcAJ44KkdUO8WLNeyw fIHhyH3svqSgRNerRL8xykY2o+VKCqp0P2MS9sD/z3ZAx2/DILr6cT3dkK1xR5z+OUvWQK 3U4qh8lEDFOkrzlkH12Wkr8dXHFAA40= Received: from smtp.kernel.org (transwarp.subspace.kernel.org [100.75.92.58]) by sin.source.kernel.org (Postfix) with ESMTP id 99371CE1929; Thu, 1 Aug 2024 12:30:10 +0000 (UTC) Received: by smtp.kernel.org (Postfix) with ESMTPSA id C91E0C32786; Thu, 1 Aug 2024 12:30:04 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1722515409; bh=6p5xxN4jqmS6heldWZ6mqD4FJ8Kzrt2Vjy/8twVNGdg=; h=Date:From:To:Cc:Subject:References:In-Reply-To:From; b=tHSKZqvaSaU/vZsgYgrYCkHt+Lf3VicjqVa4khmV29VPQk4fd5sIe9q6y59MoApQ/ YwTIGM/aecr8uXmAk55C5qqzbkbQxzyhE0kFNNyNGI4sPelUtV61VWAXmbCB4erhG5 O2CfvfsDHXqs7LNdSEDoFSfzNlVysZkUMcbkuFk5XMy96q0wJXs3KTJ+1teVadVkai qoBhK1Wtf8kmlz+rzp6q6sk1iCb1PkvFKlxBqvhrhpaoN0j97m0/+2qrbkjSmkSpjK 7xOaHyG9dcvHz6HGDNAkPuwXj4pIzkImpozSauhuVhldZ7bYmQWxrDt+yvG8Z9es50 MB/Uf/7bzuS3Q== Date: Thu, 1 Aug 2024 14:30:01 +0200 From: Danilo Krummrich To: Alice Ryhl Cc: ojeda@kernel.org, alex.gaynor@gmail.com, wedsonaf@gmail.com, boqun.feng@gmail.com, gary@garyguo.net, bjorn3_gh@protonmail.com, benno.lossin@proton.me, a.hindborg@samsung.com, akpm@linux-foundation.org, daniel.almeida@collabora.com, faith.ekstrand@collabora.com, boris.brezillon@collabora.com, lina@asahilina.net, mcanal@igalia.com, zhiw@nvidia.com, acurrid@nvidia.com, cjia@nvidia.com, jhubbard@nvidia.com, airlied@redhat.com, ajanulgu@redhat.com, lyude@redhat.com, linux-kernel@vger.kernel.org, rust-for-linux@vger.kernel.org, linux-mm@kvack.org Subject: Re: [PATCH v3 04/25] rust: alloc: implement `Allocator` for `Kmalloc` Message-ID: References: <20240801000641.1882-1-dakr@kernel.org> <20240801000641.1882-5-dakr@kernel.org> MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Disposition: inline Content-Transfer-Encoding: 8bit In-Reply-To: X-Stat-Signature: 3sahpaif7jtqny36hijzk7cdh5x84zdb X-Rspamd-Queue-Id: C8897140010 X-Rspam-User: X-Rspamd-Server: rspam10 X-HE-Tag: 1722515413-91469 X-HE-Meta: U2FsdGVkX1+Nfxvo/4JHSrvkw0JIupU/gGCFchPC5FGsZqebf27oaosPHWEolBm6cEFNpTq5Ep7Ho6YdxWRwL3HMmGtL95Eah+1BeEGlnF2bmLAa/8J/EpzGaBXA15yqAHqCSQoPnfF6OTagUZfPiin23zhpH6JA1rxjjpoePtmK8lDogF3w+nLFg9xYMBzVqJQCOkuPjxKu4EgB3qhpEfBsXb3sf8+gV8jMUnQnBu0vGtlpEZLapCdobKvvZxi1ygZvChhpkxtssS0XRYxQg46ZmFRst8pJn15MZ1HKxwjZYPvcYvmbhYB+9Osqts7rCut0VEsd2qqu4cGQ+iudPhthZT/Oecfo3dlmgdWNXSKQFD/ksQEfeDjpT7Fq4sT3sXwykyyb/HrR7B4k4tdsSki9rEh8JqxNPHrr4rKGzjp/EjYqDY7BGDbYf0IjAEcs8psIB5sdX44/TigscWmbW4AybFD7L0p0RfoWRk30iT70u6K1End1Ao/5KgwedEF54qmlM2ggYQdUo3rLqmitrZi0z7MRXslBheBNQRc9qMasYUHhXvfF3/bkR/tavi7vlleV078rKUzmZ+k1SqRU/pk/9KPKQ/4fAXTwOC85lsiy2wvCAWqgDzGcIJnOD0SVF2A+yF8mHl54CEcAkJEjOVXhbmrh6BIL/tPK9PvnWFL9lSKPXXmdAba9e/k6gyysHm39W59yc8bg1YXdjislw5NseDLJcmkU7lEtR+cfX2jlakwlIm65xX8c8fpwXupmUBgnIoxmxjRvyqC7v2feawKI2JW8xDbb2/cmWLHAXOB91AGJkpzadrjs0vbREyn20A5GcOT5jr+wC0waiwojd1vI87VrlveNJXjHAxRtgnNd6ofOnCAJIbi+zX8TZrBbXQJbApPokNUCPY7JwkIfn+S0y3CJJC6uU5p4JIt2V831223TgTc768FcI2W145xJgv10t/+SgftcykJvEDf mW6jPqdh tRL8/Vm08TjGo7whLi4pToOm+SubDMCGozcxrNVpCpXxasu7ZHrRxCpuyN9ysNBcfqqiaemrfbjzvzhkvS9ytlbrnFQtZB9B6P0fKXSFdLIa/yVufGoCBuFf99XEeOnziDtbMlxbdZUakQmEVlGlZtl4EAeMAoNm3M44Q+6cQPtfLMH1OZB6H84Sw9MakyjCGokw+QBgjzEyDRt55O0GlODL7DseXOtMFKIISemn5xafjt29s+3dmeBx+r0O76fOlEvepxSw3S986H11dYUHgf8NxyXVjbH1rZ9Um3FeewZoQIFHxxf7A/2M/38NxjQIOy3mbAiK4DLIMxC2KJsdxE7d86t93bI0bgxX+ZkfZAjsIQVz94JlQD15efw== X-Bogosity: Ham, tests=bogofilter, spamicity=0.000000, version=1.2.4 Sender: owner-linux-mm@kvack.org Precedence: bulk X-Loop: owner-majordomo@kvack.org List-ID: List-Subscribe: List-Unsubscribe: On Thu, Aug 01, 2024 at 10:28:09AM +0200, Alice Ryhl wrote: > On Thu, Aug 1, 2024 at 2:07 AM Danilo Krummrich wrote: > > +/// Returns a proper size to alloc a new object aligned to `new_layout`'s alignment. > > fn aligned_size(new_layout: Layout) -> usize { > > This comment could potentially be moved to the previous patch that > defined the function. > > > +struct ReallocFunc( > > + // INVARIANT: One of the following `krealloc`, `vrealloc`, `kvrealloc`. > > + unsafe extern "C" fn(*const core::ffi::c_void, usize, u32) -> *mut core::ffi::c_void, > > +); > > In this case, the comment would usually be formatted with markdown. > > /// # Invariants > /// > /// Must contain one of the following: `krealloc`, `vrealloc`, `kvrealloc`. > > The // INVARIANT: syntax is used when constructing an instance to > argue why the documentented invariants are satisfied. > > > +impl ReallocFunc { > > + fn krealloc() -> Self { > > + Self(bindings::krealloc) > > + } > > Technically this should have an // INVARIANT: explaining why the > invariants are satisfied by this new value. > > > + > > + // SAFETY: `call` has the exact same safety requirements as `Allocator::realloc`. > > + unsafe fn call( > > Similarly to the above, the // SAFETY: syntax is used when arguing why > the preconditions are satisfied, but when explaining what the > preconditions are, we usually use this syntax instead: > > /// # Safety > /// > /// This method has the same safety requirements as `Allocator::realloc`. Agreed, I will change this one and the above. > > > + &self, > > + ptr: Option>, > > + layout: Layout, > > + flags: Flags, > > + ) -> Result, AllocError> { > > + let size = aligned_size(layout); > > + let ptr = match ptr { > > + Some(ptr) => ptr.as_ptr(), > > + None => ptr::null(), > > + }; > > + > > + // SAFETY: `ptr` is valid by the safety requirements of this function. > > + let raw_ptr = unsafe { > > + // If `size == 0` and `ptr != NULL` the memory behind the pointer is freed. > > + self.0(ptr.cast(), size, flags.0).cast() > > + }; > > + > > + let ptr = if size == 0 { > > + NonNull::dangling() > > + } else { > > + NonNull::new(raw_ptr).ok_or(AllocError)? > > + }; > > + > > + Ok(NonNull::slice_from_raw_parts(ptr, size)) > > + } > > +} > > + > > +unsafe impl Allocator for Kmalloc { > > + unsafe fn realloc( > > + ptr: Option>, > > + layout: Layout, > > + flags: Flags, > > + ) -> Result, AllocError> { > > + let realloc = ReallocFunc::krealloc(); > > + > > + // SAFETY: If not `None`, `ptr` is guaranteed to point to valid memory, which was previously > > + // allocated with this `Allocator`. > > + unsafe { realloc.call(ptr, layout, flags) } > > + } > > +} > > + > > unsafe impl GlobalAlloc for Kmalloc { > > unsafe fn alloc(&self, layout: Layout) -> *mut u8 { > > // SAFETY: `ptr::null_mut()` is null and `layout` has a non-zero size by the function safety > > -- > > 2.45.2 > > >