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 10151C369DC for ; Wed, 7 May 2025 05:14:54 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id 247336B000A; Wed, 7 May 2025 01:14:54 -0400 (EDT) Received: by kanga.kvack.org (Postfix, from userid 40) id 1D1026B0083; Wed, 7 May 2025 01:14:54 -0400 (EDT) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 071616B0085; Wed, 7 May 2025 01:14:54 -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 DAD546B000A for ; Wed, 7 May 2025 01:14:53 -0400 (EDT) Received: from smtpin16.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay10.hostedemail.com (Postfix) with ESMTP id A0B16C11B0 for ; Wed, 7 May 2025 05:14:53 +0000 (UTC) X-FDA: 83414947266.16.6E68F2D Received: from bombadil.infradead.org (bombadil.infradead.org [198.137.202.133]) by imf09.hostedemail.com (Postfix) with ESMTP id 08A00140002 for ; Wed, 7 May 2025 05:14:50 +0000 (UTC) Authentication-Results: imf09.hostedemail.com; dkim=pass header.d=infradead.org header.s=bombadil.20210309 header.b=JEmjG03T; dmarc=fail reason="No valid SPF, DKIM not aligned (relaxed)" header.from=lst.de (policy=none); spf=none (imf09.hostedemail.com: domain of BATV+7eeb2026bdc60d152e49+7927+infradead.org+hch@bombadil.srs.infradead.org has no SPF policy when checking 198.137.202.133) smtp.mailfrom=BATV+7eeb2026bdc60d152e49+7927+infradead.org+hch@bombadil.srs.infradead.org ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=hostedemail.com; s=arc-20220608; t=1746594892; 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-transfer-encoding:content-transfer-encoding: in-reply-to:references:dkim-signature; bh=2h+qoCR/BCm/MM0PRcNEUyyKVzmW4NposRNWGIf220g=; b=yNyaMS501CFinhpFYUu6u37b8xT77oKJLhPOH4PM435K7oElS14beEnTowkn8Rlvilu+ig 0Tx64yFIPkHYte+sxUvdZvMLK8gqeVddDg3xZoiWTgTaaCIQ42ahhHtX+zxBoFFZ+VaGLY IVejHY+YQG3PllQhjACMB/BW+2MB7Xk= ARC-Authentication-Results: i=1; imf09.hostedemail.com; dkim=pass header.d=infradead.org header.s=bombadil.20210309 header.b=JEmjG03T; dmarc=fail reason="No valid SPF, DKIM not aligned (relaxed)" header.from=lst.de (policy=none); spf=none (imf09.hostedemail.com: domain of BATV+7eeb2026bdc60d152e49+7927+infradead.org+hch@bombadil.srs.infradead.org has no SPF policy when checking 198.137.202.133) smtp.mailfrom=BATV+7eeb2026bdc60d152e49+7927+infradead.org+hch@bombadil.srs.infradead.org ARC-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1746594892; a=rsa-sha256; cv=none; b=4fQp4AMrIIbSPcW9/4QH23pr5u3046L68bjZAp/8va0qIQYm0aCqs+F18o2pQ+EqocYqeZ Qo72/BTgB6yqWeikL8AkUwaXAnkgCzL2kj6JpJQOneZJtA4D0e1/Jv508hT5K6vegRhlcr GZAtLfRv09XXag9oi/SKoDulLqSYB1s= DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=infradead.org; s=bombadil.20210309; h=Content-Transfer-Encoding: MIME-Version:Message-ID:Date:Subject:Cc:To:From:Sender:Reply-To:Content-Type: Content-ID:Content-Description:In-Reply-To:References; bh=2h+qoCR/BCm/MM0PRcNEUyyKVzmW4NposRNWGIf220g=; b=JEmjG03TTppfgHid93mDIG922f 5xeiPZqLNZBpYiX5ScFN+Yhvao+88mTBbdxxr1TScgaJjoTsidrDVUtrcIO9byrqe5d8PlccK0nro 6AK6OsPf7tTvX2BrqRfgwahSullLfAKELa/MHcm/K2yJhmN5duX2xA/l74ydE7fb62zWNJpc1kxTy QykHJn6O6OyUsbGIlVMUEGf/265i4+EdTMWwWxuS+aQUzBK4GUvifs87Vx5iVPDHn9NlCDsqr3ACD aynSPgQH8Xe3bKkyE5xN4AJwKJN6artMvlOsLR4SpUpFN/GSJHeecLhNyev7Tc9mC9T2TCrkpLNX1 qvXq+Log==; Received: from 2a02-8389-2341-5b80-3ba7-83fe-7065-4f0b.cable.dynamic.v6.surfer.at ([2a02:8389:2341:5b80:3ba7:83fe:7065:4f0b] helo=localhost) by bombadil.infradead.org with esmtpsa (Exim 4.98.2 #2 (Red Hat Linux)) id 1uCX7I-0000000EFE2-2nGd; Wed, 07 May 2025 05:14:49 +0000 From: Christoph Hellwig To: willy@infradead.org Cc: akpm@linux-foundation.org, linux-kernel@vger.kernel.org, linux-fsdevel@vger.kernel.org, linux-mm@kvack.org Subject: [PATCH] xarray: fix kerneldoc for __xa_cmpxchg Date: Wed, 7 May 2025 07:14:46 +0200 Message-ID: <20250507051446.3898790-1-hch@lst.de> X-Mailer: git-send-email 2.47.2 MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-SRS-Rewrite: SMTP reverse-path rewritten from by bombadil.infradead.org. See http://www.infradead.org/rpr.html X-Stat-Signature: qepnfzg7cndi4y97rjzz699s7u8msdgg X-Rspamd-Queue-Id: 08A00140002 X-Rspam-User: X-Rspamd-Server: rspam05 X-HE-Tag: 1746594890-444950 X-HE-Meta: U2FsdGVkX18rZ86hUOHk9G71h+0t293xbxDL6nXCWMdVCAaGLjCre4RfvZ+7s0QkndYFuX/rP+AfZdeHG/P8BRe9MibLP8P89VjRxkr9a8L2AwuR8tbo+bulQUFWlsTFuWGLNRhPoVRpQRqvWM5xrfQSBESTAPdulfHZYmDliYj0cvZ6Lq0kr8rreifb/wHc7XMUO++C5I9vXfHhaMzvn5KtgiddN1rYvFDwGS79neOXxu8MPLHiCQ9Jwa6UztJ60ZbncYQrQqqz/18e9Gis1yrPK5XVic6gKIjdni4ygO3j2E2mXJooN2qf5m5SDLsJrFCuGTgDz4WYk3pdozREbYLiE7m5vU8GiOX6kxNIHGMoxVhYm2fE5oq2VTaAwv41oQvSuuduSefU4Kzge4n3qiLF5ASm8AfIAIqpC6Ewa2lMUWbeVWdYMbyAqrI/ZFMpf25ogYnt5MJsDZcntMsdd1qJfb7tG/JB1lSBicvgjvdvd7H50xoZs0IJ+TAI0ELR+v9WVriflQLKTAbST7KD/IZ+DZjYnnDZJjFSMePuQgTyH1wT3Ktzy6YxV7W+hJonMC3cUPSzJ7YaYt8d9LuIxZZG6dzwgR2tuuWDsbA5143FYBad+VAwnwuXw9BTjII+1659NRo0hZg88SHkv/4upK2XVohKdA6Sy4qw4VCPKneL/5uYSXtGVaOiiYoTvjkn14XTslYtXvKSffTzEZUNR/NIipeOr8ZJxGErmjTqwMBghOQHeJJ/KdPt1XmjLuGHpCWt6PlDvyQWBW0i07jqcLkn43V5MsgSdR8E5u7LkIgozBpGuZsEY09dRVGTaE9uFvOuYjsMKQzX03Qr8964ZC2HgnXmjsuyhmoHZjjpy7NXKseqH83EGzJXtLesdkDCM8FO3meveWa77jOPF3St6nvoQUQ4W1n++P20Ej5d7PqtITczG3dZhtC/OvR7C6AyBf+F4FGMfp5bTxjatGM dXrbCpew nRsH1/pg+rEQImUuf5DnzjbAE7ONnWLXWzhkggaRv0mjMawBZQ+5lflDZ2iNKwozQlGyZPxgOqBCITyFcEkUDKwgH1dB1yp7DDZcRv3+2lZEKdxrmT+/agyEng2/wDDUNklS5izMKg0hoM9Jn6Y29k4ScM6710oZrNT+RYNzN4M3BqYSyxFPWI0XD/pkjvNF+2+S/XYBpIAZJqksnaTGBJJcQhg8daYRc65XbD8VJ55UXYb3lkuJXS+DVJR1rU+U9CjMzzlBL8g08WsRBjxa4E6D3uydrOnhyTnPNCFCTYnmIi6oBoc1W31m9QgYj+A02S7s2BfIzOg0+OCAtjHdNFTiDTVZwaMQfhrvv9N8W1rc1Xz085pjjCPnWe10JefMffSmBtVSQN2U06xSTYKtl3ZfaJ45bH0qu8fm9oSHJ2KKyutrsTAourdRM4ZbTyr97GEd9waAA/jNUG+i8BL7bC/bIJbyM4Rs2KGr0XBb7ZRHB825wjK8+zvQ1vlwvDXx9ONWtgTknWUfaf1U9yzIXPPfFx7MeKcwwb1svk4yzHeYLC8m7Yh0x5WT9AngxD50Dvt6CxAAQvI0r43m6wI0zzYkwmhHkuqnuuN+X 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: Fix the documentation for __xa_cmpxchg to actually describe the cmpxch-like semantics correctly, based on the version for xa_cmpxchg. Signed-off-by: Christoph Hellwig --- lib/xarray.c | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/lib/xarray.c b/lib/xarray.c index 9644b18af18d..13a0781365ca 100644 --- a/lib/xarray.c +++ b/lib/xarray.c @@ -1742,21 +1742,27 @@ static inline void *__xa_cmpxchg_raw(struct xarray *xa, unsigned long index, void *old, void *entry, gfp_t gfp); /** - * __xa_cmpxchg() - Store this entry in the XArray. + * __xa_cmpxchg() - Conditionally replace an entry in the XArray. * @xa: XArray. * @index: Index into array. * @old: Old value to test against. - * @entry: New entry. + * @entry: New value to place in array. * @gfp: Memory allocation flags. * * You must already be holding the xa_lock when calling this function. * It will drop the lock if needed to allocate memory, and then reacquire * it afterwards. * + * If the entry at @index is the same as @old, replace it with @entry. + * If the return value is equal to @old, then the exchange was successful. + * * Context: Any context. Expects xa_lock to be held on entry. May * release and reacquire xa_lock if @gfp flags permit. - * Return: The old entry at this index or xa_err() if an error happened. + * Return: The old value at this index or xa_err() if an error happened. */ +static inline void *xa_cmpxchg(struct xarray *xa, unsigned long index, + void *old, void *entry, gfp_t gfp) +{ void *__xa_cmpxchg(struct xarray *xa, unsigned long index, void *old, void *entry, gfp_t gfp) { -- 2.47.2