[ndctl PATCH 1/2] README.md: add CONFIG_s missing to pass NFIT tests

[ndctl PATCH 1/2] README.md: add CONFIG_s missing to pass NFIT tests

[marc.herbert]

From: Marc Herbert <marc.herbert@linux.intel.com>

Found by trial and error. As of kernel v6.15, the CONFIG_s in this
version are enough to give to ./scripts/kconfig/merge_config.sh and pass
`meson test --suite=ndctl:ndctl` and `meson test --suite=ndctl:dax`

This has been manually tested with only `make defconfig ARCH=x86_64` as
a starting point. This is admittedly incomplete test coverage but still
a massively better starting point for other ARCHs and a big time
saver. There's a good chance it's enough for other ARCHs too.

Link: https://lore.kernel.org/nvdimm/aed71134-1029-4b88-ab20-8dfa527a7438@linux.intel.com/
Signed-off-by: Marc Herbert <marc.herbert@linux.intel.com>
---
 README.md | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/README.md b/README.md
index db25a9114402..a37991ccefa2 100644
--- a/README.md
+++ b/README.md
@@ -69,10 +69,20 @@ loaded.  To build and install nfit_test.ko:
    CONFIG_NVDIMM_PFN=y
    CONFIG_NVDIMM_DAX=y
    CONFIG_DEV_DAX_PMEM=m
+   CONFIG_FS_DAX=y
+   CONFIG_XFS_FS=y
+   CONFIG_DAX=m
+   CONFIG_DEV_DAX=m
    CONFIG_ENCRYPTED_KEYS=y
    CONFIG_NVDIMM_SECURITY_TEST=y
    CONFIG_STRICT_DEVMEM=y
    CONFIG_IO_STRICT_DEVMEM=y
+   CONFIG_ACPI_NFIT=m
+   CONFIG_NFIT_SECURITY_DEBUG=y
+   CONFIG_MEMORY_FAILURE=y
+   CONFIG_MEMORY_HOTPLUG=y
+   CONFIG_MEMORY_HOTREMOVE=y
+   CONFIG_TRANSPARENT_HUGEPAGE=y
    ```
 
 1. Build and install the unit test enabled libnvdimm modules in the
-- 
2.49.0

[ndctl PATCH 2/2] README.md: add CONFIG_s missing to pass CXL tests

[marc.herbert]

From: Marc Herbert <marc.herbert@linux.intel.com>

Found by trial and error. As of kernel v6.15, the CONFIG_s in this
version are enough to give to ./scripts/kconfig/merge_config.sh and pass
`meson test --suite=cxl`.

This fragment is being regularly tested in
https://github.com/pmem/run_qemu/actions with `make defconfig
ARCH=x86_64` as a starting point. This is admittedly incomplete test
coverage but still a massively better starting point for other ARCHs and
a time-saver. There's a good chance it's enough for other ARCHs too.

Link: https://lore.kernel.org/nvdimm/aed71134-1029-4b88-ab20-8dfa527a7438@linux.intel.com/
Signed-off-by: Marc Herbert <marc.herbert@linux.intel.com>
---
 README.md | 11 ++++++++++-
 1 file changed, 10 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index a37991ccefa2..c4c499f803af 100644
--- a/README.md
+++ b/README.md
@@ -103,17 +103,26 @@ loaded.  To build and install nfit_test.ko:
    Obtain the CXL kernel source(optional).  For example,
    `git clone -b pending git://git.kernel.org/pub/scm/linux/kernel/git/cxl/cxl.git`
 
-   Enable CXL-related kernel configuration options.
+   Enable configuration options required by CXL tests:
    ```
    CONFIG_CXL_BUS=m
    CONFIG_CXL_PCI=m
    CONFIG_CXL_ACPI=m
+   CONFIG_LIBNVDIMM=m
    CONFIG_CXL_PMEM=m
    CONFIG_CXL_MEM=m
    CONFIG_CXL_PORT=m
    CONFIG_CXL_REGION=y
    CONFIG_CXL_REGION_INVALIDATION_TEST=y
+   CONFIG_DAX=m
+   CONFIG_TRANSPARENT_HUGEPAGE=y
+   CONFIG_DEV_DAX=m
    CONFIG_DEV_DAX_CXL=m
+   CONFIG_MEMORY_HOTPLUG=y
+   CONFIG_MEMORY_HOTREMOVE=y
+   CONFIG_NVDIMM_SECURITY_TEST=y
+   CONFIG_ENCRYPTED_KEYS=y
+   CONFIG_NVDIMM_KEYS=y
    ```
 1. Install cxl_test and related mock modules.
    ```
-- 
2.49.0

Re: [ndctl PATCH 1/2] README.md: add CONFIG_s missing to pass NFIT tests

[Alison Schofield]

On Wed, May 21, 2025 at 12:26:39AM +0000, marc.herbert@linux.intel.com wrote:
> From: Marc Herbert <marc.herbert@linux.intel.com>
> 
> Found by trial and error. As of kernel v6.15, the CONFIG_s in this
> version are enough to give to ./scripts/kconfig/merge_config.sh and pass
> `meson test --suite=ndctl:ndctl` and `meson test --suite=ndctl:dax`
> 
> This has been manually tested with only `make defconfig ARCH=x86_64` as
> a starting point. This is admittedly incomplete test coverage but still
> a massively better starting point for other ARCHs and a big time
> saver. There's a good chance it's enough for other ARCHs too.

Thanks for doing this Marc! 

I'm wondering about the need to delineate between what is needed to load
and use the cxl-test or nfit-test modules as opposed to what is required to
run all the unit tests.

I believe my environment, and yours, and most other folks using these
environments are doing so in a VM so it's no big deal to load up all the
things.

Maybe just a gentle separator in the list showing required and optional.
I would NOT go so far as to pick apart which ones are needed for which
test because that is a slippery slope. If a user is in test running mode
they need all the things.

> 
> Link: https://lore.kernel.org/nvdimm/aed71134-1029-4b88-ab20-8dfa527a7438@linux.intel.com/
> Signed-off-by: Marc Herbert <marc.herbert@linux.intel.com>
> ---
>  README.md | 10 ++++++++++
>  1 file changed, 10 insertions(+)
> 
> diff --git a/README.md b/README.md
> index db25a9114402..a37991ccefa2 100644
> --- a/README.md
> +++ b/README.md
> @@ -69,10 +69,20 @@ loaded.  To build and install nfit_test.ko:
>     CONFIG_NVDIMM_PFN=y
>     CONFIG_NVDIMM_DAX=y
>     CONFIG_DEV_DAX_PMEM=m
> +   CONFIG_FS_DAX=y
> +   CONFIG_XFS_FS=y
> +   CONFIG_DAX=m
> +   CONFIG_DEV_DAX=m
>     CONFIG_ENCRYPTED_KEYS=y
>     CONFIG_NVDIMM_SECURITY_TEST=y
>     CONFIG_STRICT_DEVMEM=y
>     CONFIG_IO_STRICT_DEVMEM=y
> +   CONFIG_ACPI_NFIT=m
> +   CONFIG_NFIT_SECURITY_DEBUG=y
> +   CONFIG_MEMORY_FAILURE=y
> +   CONFIG_MEMORY_HOTPLUG=y
> +   CONFIG_MEMORY_HOTREMOVE=y
> +   CONFIG_TRANSPARENT_HUGEPAGE=y
>     ```
>  
>  1. Build and install the unit test enabled libnvdimm modules in the
> -- 
> 2.49.0
> 

Re: [ndctl PATCH 1/2] README.md: add CONFIG_s missing to pass NFIT tests

[Marc Herbert]

On 2025-05-21 21:47, Alison Schofield wrote:

> Thanks for doing this Marc! 
> 
> I'm wondering about the need to delineate between what is needed to load
> and use the cxl-test or nfit-test modules as opposed to what is required to
> run all the unit tests.
> 
> I believe my environment, and yours, and most other folks using these
> environments are doing so in a VM so it's no big deal to load up all the
> things.
> 
> Maybe just a gentle separator in the list showing required and optional.

I unfortunately don't know and understand these enough to remember that
and it would be very time-consuming to re-test them one by one.

More generally speaking, this sort of list looks deceptively simple but
it almost never is. That's basically why I initially asked in
https://lore.kernel.org/nvdimm/aed71134-1029-4b88-ab20-8dfa527a7438@linux.intel.com/
if someone more knowledgeable could do this (based on the
run_qemu.git/.github/workflows/*.cfg files) Also, this stuff tends to
evolve.

Now that tested versions can be found in run_qemu.bit, it's less
critical to update this README.md file. The current README.md version is
inconveniently non working but at least some functional versions can be
found somewhere else.

Cheers,

Marc

Re: [ndctl PATCH 1/2] README.md: add CONFIG_s missing to pass NFIT tests

[Alison Schofield]

On Thu, May 22, 2025 at 07:47:56AM -0700, Marc Herbert wrote:
> On 2025-05-21 21:47, Alison Schofield wrote:
> 
> > Thanks for doing this Marc! 
> > 
> > I'm wondering about the need to delineate between what is needed to load
> > and use the cxl-test or nfit-test modules as opposed to what is required to
> > run all the unit tests.
> > 
> > I believe my environment, and yours, and most other folks using these
> > environments are doing so in a VM so it's no big deal to load up all the
> > things.
> > 
> > Maybe just a gentle separator in the list showing required and optional.
> 
> I unfortunately don't know and understand these enough to remember that
> and it would be very time-consuming to re-test them one by one.
> 
> More generally speaking, this sort of list looks deceptively simple but
> it almost never is. That's basically why I initially asked in
> https://lore.kernel.org/nvdimm/aed71134-1029-4b88-ab20-8dfa527a7438@linux.intel.com/
> if someone more knowledgeable could do this (based on the
> run_qemu.git/.github/workflows/*.cfg files) Also, this stuff tends to
> evolve.
> 
> Now that tested versions can be found in run_qemu.bit, it's less
> critical to update this README.md file. The current README.md version is
> inconveniently non working but at least some functional versions can be
> found somewhere else.

Hi Marc,

As you probably just got notified, I went ahead and massaged this one and
applied to pending:
https://github.com/pmem/ndctl/commit/fb2f28cd280c69a978753e54a0f67267e54ffbda

There is clear agreement on the great need for this as we encourage
more folks to join the cxl-test club. My comment about module vs unit
test was a no-op because the README, it turns out, made no mention of
that. I did pause a few times on the README and say to myself, 'oh that
needs updating' but decided to get this out and come back around for
better later.

I'm going to ping Dan directly for an ACK, since he promised :)

If there is any issue on pending I'm happy to fix it up. I'm planning
to make the v82 release June 11-ish.

-- Alison

> 
> Cheers,
> 
> Marc