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 361D4C3ABBF for ; Wed, 7 May 2025 23:54:39 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id AC1936B0082; Wed, 7 May 2025 19:54:38 -0400 (EDT) Received: by kanga.kvack.org (Postfix, from userid 40) id A978B6B0083; Wed, 7 May 2025 19:54:38 -0400 (EDT) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 9378F6B0085; Wed, 7 May 2025 19:54:38 -0400 (EDT) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (smtprelay0012.hostedemail.com [216.40.44.12]) by kanga.kvack.org (Postfix) with ESMTP id 733E06B0082 for ; Wed, 7 May 2025 19:54:38 -0400 (EDT) Received: from smtpin28.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay09.hostedemail.com (Postfix) with ESMTP id C2EEF8162D for ; Wed, 7 May 2025 23:54:38 +0000 (UTC) X-FDA: 83417769036.28.669E236 Received: from mail-pf1-f177.google.com (mail-pf1-f177.google.com [209.85.210.177]) by imf22.hostedemail.com (Postfix) with ESMTP id DA2BEC0005 for ; Wed, 7 May 2025 23:54:36 +0000 (UTC) Authentication-Results: imf22.hostedemail.com; dkim=pass header.d=gmail.com header.s=20230601 header.b=F48qGfjO; dmarc=pass (policy=none) header.from=gmail.com; spf=pass (imf22.hostedemail.com: domain of bagasdotme@gmail.com designates 209.85.210.177 as permitted sender) smtp.mailfrom=bagasdotme@gmail.com ARC-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1746662076; a=rsa-sha256; cv=none; b=8Uy1yfkurSsLHaTE65ecF/OtKTDgqU9eduSjeW+pq4MA84B07obMruvGzEkmGUBD6NDc86 oPwlLOI0vics8wflyvMnojNbHz1UG6hizBs4/uL/5vuhH8sywNcQ4UzrmGMXANYobOmij3 09XsgFure4fUUZateqbW6Idro8mvgWA= ARC-Authentication-Results: i=1; imf22.hostedemail.com; dkim=pass header.d=gmail.com header.s=20230601 header.b=F48qGfjO; dmarc=pass (policy=none) header.from=gmail.com; spf=pass (imf22.hostedemail.com: domain of bagasdotme@gmail.com designates 209.85.210.177 as permitted sender) smtp.mailfrom=bagasdotme@gmail.com ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=hostedemail.com; s=arc-20220608; t=1746662076; 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: in-reply-to:in-reply-to:references:references:dkim-signature; bh=fLNwEV8SgZJkGHrUBzZ9lp1C8q+dL6Ko3cbg0++18Zo=; b=DRT1n21WZ0MPWNqrTmFp+O4JdMNOHSrcaU8WkCw9kOsTpKM/u33qk7I1qmdajLOWBmTzsn KDEAv4zAkyaJWfge6HDlZ4bhuPjEGkkMTwmiEjAKcXtvtptl3A2Bwm14UePfG4btK5sWsU O230YIQTe5VWm4wlTlR8UdocANUyFAo= Received: by mail-pf1-f177.google.com with SMTP id d2e1a72fcca58-736c277331eso1477364b3a.1 for ; Wed, 07 May 2025 16:54:36 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1746662076; x=1747266876; darn=kvack.org; h=in-reply-to:content-disposition:mime-version:references:message-id :subject:cc:to:from:date:from:to:cc:subject:date:message-id:reply-to; bh=fLNwEV8SgZJkGHrUBzZ9lp1C8q+dL6Ko3cbg0++18Zo=; b=F48qGfjODFHYoQLPoW0RcURIqPI684NOuyP0ZDstkuDlOsHKsBLQ8JagOGwr16Evzi 0+rshBzpgsALUHv26foXMYVrG112VVqf3yAITuKvcuClgERGWAwDEc8jj4cdPuAjUwXD KNw64gBGfkk+qWEakbxo7gLpPClfq6P5bpfangpZMvmuqR5ivw+NGbr5T9m9VaxuRJ+M D0Nw7tlLBgdLjIg7SDZ4Hd02mDcgtkSXPLaRMfbSSrjhh+D+Mb7GLLy1f0SCdVxxQCD3 IBrxrdZ9pLgsmvTDvb2ONYWscrtDOrSvMoC4lXzxmmgi33sOaCYOsYxsvAsGyQ2Gy0OJ zB+g== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1746662076; x=1747266876; h=in-reply-to:content-disposition:mime-version:references:message-id :subject:cc:to:from:date:x-gm-message-state:from:to:cc:subject:date :message-id:reply-to; bh=fLNwEV8SgZJkGHrUBzZ9lp1C8q+dL6Ko3cbg0++18Zo=; b=CxAWyLptHC5jMNxMUers3+Uj21Dk5JEYNl+f8d/N8fU7I9/wqsLUNzxdpGmY8sEvst VeIavsNxZeyXGpxYJL1jf5WWDSAPwwdBQpFT+HLmXlQPfiBNl/OaNwxoVfyJMqwjsC56 gmt7vf43DRtRX3tNRWID9X5w6L4jR5scORSUC5hSnQMplICh0eUYzXRPrvNd0+BPJGgo olrjPFRQU+uXJkS6BQJPxzCVEDh4T+VZXPK6+PjRl6nQ0qoUC5ktOMe/MMMuezgdB3Sg 6flXSvxzTQvR5Mdm1bndtkAwmJJveCLYio73uooJSI0+vt7KnkDJCLbTWL72VFwjqCfw 5rGQ== X-Forwarded-Encrypted: i=1; AJvYcCWEVayOPYbKDYQO/lj+q2BK5/sJff+wHQ9yVP77qLc1Jxc1jTRGsvFB6eu9K+HZLe+snuNyvIk4UA==@kvack.org X-Gm-Message-State: AOJu0YzzsEQbspWFPqFzrWxxR/U+jJgFGWVSKy5fWgcX/mzUe5SY4jek H/H9Qb46eKKdfUDmXfzxvlIpt3bWHiXtiRmTGBYFVC+sY2zge7BJ X-Gm-Gg: ASbGncufsglCBYrgDxJykRZpwB/uoPIlcwTNGvOBTRc5Vh0OTTNUgbNZu6J+4S6gQ2K UzJKcWjlwi55nwcrqLUsBR+vPIpXISAd88LSTEslhW1nXtZjTpyjqKB8bwcNv9W71zKGIzrnMdt k+GzNHzvwTf34aknQTYYA+Mq2RWp8CsJ/F3LpSHwiPf494mM3ubG0qmNOQO6L8SAIm/AZa/5xut EYmkMBRmIP2VQ9e+hPoXRXwLBVeccDF+MlczkpLTs0BS32O3VWONItuv6NLU/I4waREtKOoV9vl d39msj7MTFgwDIuZdPjoIYtXHbrWOxdmW5wSloe9 X-Google-Smtp-Source: AGHT+IHhK4fQ0eXffxWp3og4eay8JmyRcAaEmd9mi0QFw/ybw320/zjs9kUfsYWXYw9PozpDfctKkQ== X-Received: by 2002:a05:6a21:32a6:b0:20a:942:47e9 with SMTP id adf61e73a8af0-21599fcc6admr2320890637.6.1746662075529; Wed, 07 May 2025 16:54:35 -0700 (PDT) Received: from archie.me ([103.124.138.155]) by smtp.gmail.com with ESMTPSA id d2e1a72fcca58-74058d7a225sm11870093b3a.23.2025.05.07.16.54.33 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 07 May 2025 16:54:34 -0700 (PDT) Received: by archie.me (Postfix, from userid 1000) id 5AB6041E8D47; Thu, 08 May 2025 06:54:32 +0700 (WIB) Date: Thu, 8 May 2025 06:54:32 +0700 From: Bagas Sanjaya To: Changyuan Lyu , akpm@linux-foundation.org Cc: anthony.yznaga@oracle.com, arnd@arndb.de, ashish.kalra@amd.com, benh@kernel.crashing.org, bp@alien8.de, catalin.marinas@arm.com, corbet@lwn.net, dave.hansen@linux.intel.com, devicetree@vger.kernel.org, dwmw2@infradead.org, ebiederm@xmission.com, graf@amazon.com, hpa@zytor.com, jgowans@amazon.com, kexec@lists.infradead.org, krzk@kernel.org, linux-arm-kernel@lists.infradead.org, linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org, linux-mm@kvack.org, luto@kernel.org, mark.rutland@arm.com, mingo@redhat.com, pasha.tatashin@soleen.com, pbonzini@redhat.com, peterz@infradead.org, ptyadav@amazon.de, robh@kernel.org, rostedt@goodmis.org, rppt@kernel.org, saravanak@google.com, skinsburskii@linux.microsoft.com, tglx@linutronix.de, thomas.lendacky@amd.com, will@kernel.org, x86@kernel.org Subject: Re: [PATCH v7 17/18] Documentation: add documentation for KHO Message-ID: References: <20250507173840.2541517-1-changyuanl@google.com> MIME-Version: 1.0 Content-Type: multipart/signed; micalg=pgp-sha512; protocol="application/pgp-signature"; boundary="zRFld30/pgx52G1k" Content-Disposition: inline In-Reply-To: <20250507173840.2541517-1-changyuanl@google.com> X-Rspamd-Server: rspam03 X-Rspamd-Queue-Id: DA2BEC0005 X-Stat-Signature: 639zcour5hx7dg5z3sz4k9158tezufc4 X-Rspam-User: X-HE-Tag: 1746662076-274566 X-HE-Meta: U2FsdGVkX1/BUH14xApEAnoTWnop8EBUCGoXEtX6IbMRL1Oxhuj1dy9GwMuqeKg+vbz9Hi1WG7VfvONXlcgA3aPR6P5f3H2Cxih1zYpHcCSZCCA8vZ2lj+1r5SPSAOgmOfc8UJV2B20m6zOCVL6x+MKHgmuHPImgnq9s7S/km+yOPmMLPoBBRF18hn81JMIqJviucpsWMLxe/bbVj6tdI3GwPzWV9ixlkAHwA6yuHxCMRmfiaCC086C2utk0K6qb95dDQtZdta5ULo7xXwNlt7aPMwJaZVfOLLfCBviLMSm/FPVeyZ2205InYJzKTmuAkPHbeYWCOp8xzLnbsuQ4lAFyn13bDSxVIP2gRm8rLQE1BGmx8hCzCqoU3G/A/J8blmZ7qPgdcOTrKWO8Zj8SjQ+lPI+94o5Qy824RhsMWpMQ/vJCmA56ETz5jYlYEvTg4RPaWOBviN88UQOSLc9QWNpULfm/pk9L2AdG5bAliEqCCquy0kbtIG+Tst+/KS2GssaooeBrdxLBfJh8pTbbNTXXaRwn4NpbLN2OTXd1sxdoIwqRrzucu977GIJnsoz4E/vAFt6c+EjRv9wEa1P/jCT4trRJQTzhtyhqnHzfdYjiz8+/0VQ7LeHr5bVcEBbXJQEfdri34OOx0vgm6X0En9JUqCtgdKq1outVbzU6kXLidp2eVbop9Q9l/uwWFSDbTvY48gTsIrTSBWXZsskDbqkwk5ePmLZl3yei7DENEU16S22pQIHDIyuDAH0IJqTngKGN8tY3+A30VVYPOxy3LtcTFJykBH6gK4USQ/a6l60LSOUmF/c65cFl7FL2N/jDBu4cuUWmmrR9d9xu/s7N8RhXfy5Y0vqKqACvSP+kzdiZ9i8bSAXA5vybfii7otofG8GM7Els1CortX7h9DpMqUg8CM7SHGx33pWoih2zP0IUHzfwdMFhWWUeuUCDzPAxF9L0v3kPRp0wm5VAHFO VlWecsEx 5isJxbEMOuf5xlDwhXV5K1RUAJITAz0pmrp5Sh9wsPqmOxaXMsIUSDpDjip/z5ltuq6SL6MNChMsMthGSaa1wXP/t71tcObVwzlQn/Ggchm30Z9DGsti3mE0k/27BmMYfJnycMq5ag22OYiLaw8RgGOMxfE88fyJhMDzFbm5Z82oAGjs+k2lflApKL3lFTnJweRckZZyQ6zgYg+aPIYEMkibXost14M9tJ6OQH5R6l6k9AGUtUYrcQzq5nngXvt16KsE+k+EB2y3JQaIWhcx+tJCoKtsxfxgu0e2D+NVvbjWJPql8iGAet+yeSAJ2nhGMbHioIB1dVmBMMh1JnfbWgaw9GMyVGa9GZAUYa5vCZRysQhoQxYKYXQrBoSROhG0vqock5IUSdDatFo3KkuayNmzsvGXd4viham6zchyeP7yp47Q7NuzBW2KTD+jpd5+jORROJNOu5ZwONPArb9ifD+a3e3POECDiUHt2 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: --zRFld30/pgx52G1k Content-Type: text/plain; charset=utf-8 Content-Disposition: inline Content-Transfer-Encoding: quoted-printable On Wed, May 07, 2025 at 10:38:40AM -0700, Changyuan Lyu wrote: > From: Changyuan Lyu > Date: Wed, 7 May 2025 10:14:34 -0700 > Subject: [PATCH] fixup! Documentation: add documentation for KHO >=20 > Signed-off-by: Changyuan Lyu > --- > Documentation/admin-guide/mm/kho.rst | 29 ++++++++++--------------- > Documentation/core-api/kho/concepts.rst | 4 ++-- > Documentation/core-api/kho/fdt.rst | 2 +- > 3 files changed, 15 insertions(+), 20 deletions(-) >=20 > diff --git a/Documentation/admin-guide/mm/kho.rst b/Documentation/admin-g= uide/mm/kho.rst > index c64aa7aadb300..6dc18ed4b8861 100644 > --- a/Documentation/admin-guide/mm/kho.rst > +++ b/Documentation/admin-guide/mm/kho.rst > @@ -8,14 +8,14 @@ Kexec HandOver (KHO) is a mechanism that allows Linux t= o preserve memory > regions, which could contain serialized system states, across kexec. >=20 > This document expects that you are familiar with the base KHO > -:ref:`concepts `. If you have not read > +:ref:`concepts `. If you have not read > them yet, please do so now. >=20 > Prerequisites > =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D >=20 > -KHO is available when the ``CONFIG_KEXEC_HANDOVER`` config option is set= to y > -at compile time. Every KHO producer may have its own config option that = you > +KHO is available when the kernel is compiled with ``CONFIG_KEXEC_HANDOVE= R`` > +set to y. Every KHO producer may have its own config option that you > need to enable if you would like to preserve their respective state acro= ss > kexec. >=20 > @@ -29,7 +29,7 @@ Perform a KHO kexec > =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D >=20 > First, before you perform a KHO kexec, you need to move the system into > -the :ref:`KHO finalization phase ` :: > +the :ref:`KHO finalization phase ` :: >=20 > $ echo 1 > /sys/kernel/debug/kho/out/finalize >=20 > @@ -43,7 +43,7 @@ use the ``-s`` parameter to use the in-kernel kexec fil= e loader, as user > space kexec tooling currently has no support for KHO with the user space > based file loader :: >=20 > - # kexec -l Image --initrd=3Dinitrd -s > + # kexec -l /path/to/Image --initrd /path/to/initrd -s > # kexec -e >=20 > The new kernel will boot up and contain some of the previous kernel's st= ate. > @@ -89,20 +89,15 @@ stabilized. > as input file for the KHO payload image. >=20 > ``/sys/kernel/debug/kho/out/scratch_len`` > - To support continuous KHO kexecs, we need to reserve > - physically contiguous memory regions that will always stay > - available for future kexec allocations. This file describes > - the length of these memory regions. Kexec user space tooling > - can use this to determine where it should place its payload > - images. > + Lengths of KHO scratch regions, which are physically contiguous > + memory regions that will always stay available for future kexec > + allocations. Kexec user space tools can use this file to determine > + where it should place its payload images. >=20 > ``/sys/kernel/debug/kho/out/scratch_phys`` > - To support continuous KHO kexecs, we need to reserve > - physically contiguous memory regions that will always stay > - available for future kexec allocations. This file describes > - the physical location of these memory regions. Kexec user space > - tooling can use this to determine where it should place its > - payload images. > + Physical locations of KHO scratch regions. Kexec user space tools > + can use this file in conjunction to scratch_phys to determine where > + it should place its payload images. >=20 > ``/sys/kernel/debug/kho/out/sub_fdts/`` > In the KHO finalization phase, KHO producers register their own > diff --git a/Documentation/core-api/kho/concepts.rst b/Documentation/core= -api/kho/concepts.rst > index f1826ac10da75..36d5c05cfb307 100644 > --- a/Documentation/core-api/kho/concepts.rst > +++ b/Documentation/core-api/kho/concepts.rst > @@ -1,5 +1,5 @@ > .. SPDX-License-Identifier: GPL-2.0-or-later > -.. _concepts: > +.. _kho-concepts: >=20 > =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D > Kexec Handover Concepts > @@ -56,7 +56,7 @@ for boot memory allocations and as target memory for ke= xec blobs, some parts > of that memory region may be reserved. These reservations are irrelevant= for > the next KHO, because kexec can overwrite even the original kernel. >=20 > -.. _finalization_phase: > +.. _kho-finalization-phase: >=20 > KHO finalization phase > =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D > diff --git a/Documentation/core-api/kho/fdt.rst b/Documentation/core-api/= kho/fdt.rst > index 4a5d53c670d4b..62505285d60d6 100644 > --- a/Documentation/core-api/kho/fdt.rst > +++ b/Documentation/core-api/kho/fdt.rst > @@ -32,7 +32,7 @@ KHO process will be bypassed. > Property ``fdt`` > ---------------- >=20 > -Generally, A KHO user serialize its state into its own FDT and instructs > +Generally, a KHO user serialize its state into its own FDT and instructs > KHO to preserve the underlying memory, such that after kexec, the new ke= rnel > can recover its state from the preserved FDT. >=20 Looks good. Thanks. --=20 An old man doll... just what I always wanted! - Clara --zRFld30/pgx52G1k Content-Type: application/pgp-signature; name=signature.asc -----BEGIN PGP SIGNATURE----- iHUEABYKAB0WIQSSYQ6Cy7oyFNCHrUH2uYlJVVFOowUCaBvyuAAKCRD2uYlJVVFO o38OAP0S2nuy3loMuC8zH7tkpPoIY66aWe/gz0KYX9I9KbADyAEAiwNKd6K9jY8l qW+w4NnoiMRcH659o8/VFU3sEV3Tegw= =bbPy -----END PGP SIGNATURE----- --zRFld30/pgx52G1k--