From patchwork Thu Apr 22 06:18:59 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Mike Rapoport X-Patchwork-Id: 12217703 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-17.0 required=3.0 tests=BAYES_00,DKIMWL_WL_HIGH, DKIM_SIGNED,DKIM_VALID,INCLUDES_CR_TRAILER,INCLUDES_PATCH,MAILING_LIST_MULTI, SPF_HELO_NONE,SPF_PASS,USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 7CC32C433B4 for ; Thu, 22 Apr 2021 06:21:32 +0000 (UTC) Received: from desiato.infradead.org (desiato.infradead.org [90.155.92.199]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id 2A39260FD7 for ; Thu, 22 Apr 2021 06:21:32 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 2A39260FD7 Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=kernel.org Authentication-Results: mail.kernel.org; spf=none smtp.mailfrom=linux-arm-kernel-bounces+linux-arm-kernel=archiver.kernel.org@lists.infradead.org DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=lists.infradead.org; s=desiato.20200630; h=Sender:Content-Transfer-Encoding :Content-Type:List-Subscribe:List-Help:List-Post:List-Archive: List-Unsubscribe:List-Id:MIME-Version:References:In-Reply-To:Message-Id:Date: Subject:Cc:To:From:Reply-To:Content-ID:Content-Description:Resent-Date: Resent-From:Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID:List-Owner; bh=f4gb9TwJVpIAPsNcnHvSSF/5/OQUB07PYjbMiQfggl0=; b=SYWMh8GMCa98HtROKh+J6cz1Y g56viZKk0ju74ShHM0kqw/4nUDTeXrVGcezZJRB/sudjCct4PIbykxSyHZmzheV7bkGf88qPp4CQP BnR+ai1S6B0NCCQW1CxHShKQfJ0Et/W03UWhcKxwnxTZZN6JlZrzw6L1he4nXTh58gml6Q46KMgtU VDm8a4Ug9KGod++YuohhE20U7AcUJ4Z55JLP5IOAqerEBvMSspcMLWmrzEYkaxSgpbc0XquqbeiBQ lNbXg/mD1vskLRc0wd5ciMJLWCWWRn9jTYhgT7QuQrKh1WrpZNLSCvI7FpgxNLQO1fHpdu1bOEqza O8g+9YWBQ==; Received: from localhost ([::1] helo=desiato.infradead.org) by desiato.infradead.org with esmtp (Exim 4.94 #2 (Red Hat Linux)) id 1lZSgW-00FyLr-0Q; Thu, 22 Apr 2021 06:19:32 +0000 Received: from bombadil.infradead.org ([2607:7c80:54:e::133]) by desiato.infradead.org with esmtps (Exim 4.94 #2 (Red Hat Linux)) id 1lZSgI-00FyK6-FI for linux-arm-kernel@desiato.infradead.org; Thu, 22 Apr 2021 06:19:18 +0000 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:References:In-Reply-To:Message-Id:Date:Subject:Cc:To:From:Sender :Reply-To:Content-Type:Content-ID:Content-Description; bh=3ulNwrU85zrE10Xr//2x6C328KKH8Itb2ZqL71DkfwI=; b=rsH7FeID3PCIa9UNlAPCTIViVH E9OtC6soMOyzOku2Go8P5tpZNEX/F94H4zGFCFDQlSA7wpGgXGtugg8uxWgBHZeHrBqyAE3/nVZN+ qK8GULfHZPcDzMWAPIN0a+pZ4FSPk3lg4YijNemVDcj1ivYxy1SpOwZzSWeJ/eYcDvhay8c8al8zN Weo6iXVo22mBa89BBOOIESyzcXOq5VjOkFGKGPJ819kiKB49a45B9fqu32CB7eYfXyDQi+GQluDLs g5AuMQJWH0eYZlAd/ETCY5yQFVJote5+VtaahhXjLMBWO5qVNpRBTD/DrRTuLPoXi91zPYMU6uzWp uIwQkefA==; Received: from mail.kernel.org ([198.145.29.99]) by bombadil.infradead.org with esmtps (Exim 4.94 #2 (Red Hat Linux)) id 1lZSgG-00DPCM-1T for linux-arm-kernel@lists.infradead.org; Thu, 22 Apr 2021 06:19:17 +0000 Received: by mail.kernel.org (Postfix) with ESMTPSA id 15B886113C; Thu, 22 Apr 2021 06:19:11 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1619072355; bh=E81akF1BinjHKMvNozvRyjwjqZ1X1qBHHvRxS2i48PI=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=uhF/ObuaXIspDxBYAAvqiR9bZWwB6AgoMlH014SLQhtOLankdq4B/GD3Yo0udRpVN V4O7zfQeYj3d3MsrkeqVdql8uSygos1lTLK7EI4LL+45XgG1WXnQAKKoqc+MSynyv8 RPTss4obNwjyO+I1nhKkRsUpm+BVzxRIOv8H69n8pyGU9MgJmnC8MVR812ygWZw88d IMPinfocfipp01RqC8gTj6sHqEEC14mHm4WBMVnRmpjfqnBGjgfwVLky+NEAH/sLGz ymht+5Lg6VmPoy5sPouM6ey44RYSp1fUy1r+DOgpc2ZVwQZt/vzKXsMWS96M//CVtD HCIHPVRr+SEcQ== From: Mike Rapoport To: linux-arm-kernel@lists.infradead.org Cc: Andrew Morton , Anshuman Khandual , Ard Biesheuvel , Catalin Marinas , David Hildenbrand , Marc Zyngier , Mark Rutland , Mike Rapoport , Mike Rapoport , Will Deacon , kvmarm@lists.cs.columbia.edu, linux-kernel@vger.kernel.org, linux-mm@kvack.org Subject: [PATCH v3 1/4] include/linux/mmzone.h: add documentation for pfn_valid() Date: Thu, 22 Apr 2021 09:18:59 +0300 Message-Id: <20210422061902.21614-2-rppt@kernel.org> X-Mailer: git-send-email 2.28.0 In-Reply-To: <20210422061902.21614-1-rppt@kernel.org> References: <20210422061902.21614-1-rppt@kernel.org> MIME-Version: 1.0 X-CRM114-Version: 20100106-BlameMichelson ( TRE 0.8.0 (BSD) ) MR-646709E3 X-CRM114-CacheID: sfid-20210421_231916_143695_606538D2 X-CRM114-Status: GOOD ( 12.81 ) X-BeenThere: linux-arm-kernel@lists.infradead.org X-Mailman-Version: 2.1.34 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: "linux-arm-kernel" Errors-To: linux-arm-kernel-bounces+linux-arm-kernel=archiver.kernel.org@lists.infradead.org From: Mike Rapoport Add comment describing the semantics of pfn_valid() that clarifies that pfn_valid() only checks for availability of a memory map entry (i.e. struct page) for a PFN rather than availability of usable memory backing that PFN. The most "generic" version of pfn_valid() used by the configurations with SPARSEMEM enabled resides in include/linux/mmzone.h so this is the most suitable place for documentation about semantics of pfn_valid(). Suggested-by: Anshuman Khandual Signed-off-by: Mike Rapoport Reviewed-by: Anshuman Khandual --- include/linux/mmzone.h | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/include/linux/mmzone.h b/include/linux/mmzone.h index 47946cec7584..961f0eeefb62 100644 --- a/include/linux/mmzone.h +++ b/include/linux/mmzone.h @@ -1410,6 +1410,17 @@ static inline int pfn_section_valid(struct mem_section *ms, unsigned long pfn) #endif #ifndef CONFIG_HAVE_ARCH_PFN_VALID +/** + * pfn_valid - check if there is a valid memory map entry for a PFN + * @pfn: the page frame number to check + * + * Check if there is a valid memory map entry aka struct page for the @pfn. + * Note, that availability of the memory map entry does not imply that + * there is actual usable memory at that @pfn. The struct page may + * represent a hole or an unusable page frame. + * + * Return: 1 for PFNs that have memory map entries and 0 otherwise + */ static inline int pfn_valid(unsigned long pfn) { struct mem_section *ms;