[PATCH v5] driver core: platform: set numa_node before platform_add_device()

[PATCH v5] driver core: platform: set numa_node before platform_add_device()

[Jinhui Guo]

platform_add_device() creates the numa_node attribute of sysfs according
to whether dev_to_node(dev) is equal to NUMA_NO_NODE. So set the numa node
of device before creating numa_node attribute of sysfs.

Fixes: 4a60406d3592 ("driver core: platform: expose numa_node to users in sysfs")
Cc: stable@vger.kernel.org
Reported-by: kernel test robot <lkp@intel.com>
Closes: https://lore.kernel.org/oe-kbuild-all/202309122309.mbxAnAIe-lkp@intel.com/
Signed-off-by: Jinhui Guo <guojinhui.liam@bytedance.com>
---
V4 -> V5: Add Cc: stable line and changes from the previous submited
patches
V3 -> V4: Refactor code to be an ACPI function call
V2 -> V3: Fix Signed-off name
V1 -> V2: Fix compile error without enabling CONFIG_ACPI

 drivers/acpi/acpi_platform.c | 4 +---
 drivers/base/platform.c      | 1 +
 include/linux/acpi.h         | 5 +++++
 3 files changed, 7 insertions(+), 3 deletions(-)

diff --git a/drivers/acpi/acpi_platform.c b/drivers/acpi/acpi_platform.c
index 48d15dd785f6..adcbfbdc343f 100644
--- a/drivers/acpi/acpi_platform.c
+++ b/drivers/acpi/acpi_platform.c
@@ -178,11 +178,9 @@ struct platform_device *acpi_create_platform_device(struct acpi_device *adev,
 	if (IS_ERR(pdev))
 		dev_err(&adev->dev, "platform device creation failed: %ld\n",
 			PTR_ERR(pdev));
-	else {
-		set_dev_node(&pdev->dev, acpi_get_node(adev->handle));
+	else
 		dev_dbg(&adev->dev, "created platform device %s\n",
 			dev_name(&pdev->dev));
-	}
 
 	kfree(resources);
 
diff --git a/drivers/base/platform.c b/drivers/base/platform.c
index 76bfcba25003..35c891075d95 100644
--- a/drivers/base/platform.c
+++ b/drivers/base/platform.c
@@ -841,6 +841,7 @@ struct platform_device *platform_device_register_full(
 			goto err;
 	}
 
+	set_dev_node(&pdev->dev, ACPI_NODE_GET(ACPI_COMPANION(&pdev->dev)));
 	ret = platform_device_add(pdev);
 	if (ret) {
 err:
diff --git a/include/linux/acpi.h b/include/linux/acpi.h
index a73246c3c35e..6a349d53f19e 100644
--- a/include/linux/acpi.h
+++ b/include/linux/acpi.h
@@ -477,6 +477,10 @@ static inline int acpi_get_node(acpi_handle handle)
 	return 0;
 }
 #endif
+
+#define ACPI_NODE_GET(adev) ((adev) && (adev)->handle ? \
+	acpi_get_node((adev)->handle) : NUMA_NO_NODE)
+
 extern int pnpacpi_disabled;
 
 #define PXM_INVAL	(-1)
@@ -770,6 +774,7 @@ const char *acpi_get_subsystem_id(acpi_handle handle);
 #define ACPI_COMPANION_SET(dev, adev)	do { } while (0)
 #define ACPI_HANDLE(dev)		(NULL)
 #define ACPI_HANDLE_FWNODE(fwnode)	(NULL)
+#define ACPI_NODE_GET(adev)		NUMA_NO_NODE
 
 #include <acpi/acpi_numa.h>
 
-- 
2.20.1

Re: [PATCH v5] driver core: platform: set numa_node before platform_add_device()

[Rafael J. Wysocki]

On Thu, Sep 14, 2023 at 11:32 PM Jinhui Guo
<guojinhui.liam@bytedance.com> wrote:
>
> platform_add_device()

According to "git grep" this function is not present in 6.6-rc2.

If you mean platform_device_add(), please update the patch subject and
changelog accordingly.

> creates the numa_node attribute of sysfs according
> to whether dev_to_node(dev) is equal to NUMA_NO_NODE. So set the numa node
> of device before creating numa_node attribute of sysfs.

It would be good to also say that this needs to be done in
platform_device_register_full(), because that's where the platform
device object is allocated.

However, what about adding the NUMA node information to pdevinfo?  It
would be more straightforward to handle it then AFAICS.

> Fixes: 4a60406d3592 ("driver core: platform: expose numa_node to users in sysfs")
> Cc: stable@vger.kernel.org
> Reported-by: kernel test robot <lkp@intel.com>
> Closes: https://lore.kernel.org/oe-kbuild-all/202309122309.mbxAnAIe-lkp@intel.com/
> Signed-off-by: Jinhui Guo <guojinhui.liam@bytedance.com>
> ---
> V4 -> V5: Add Cc: stable line and changes from the previous submited
> patches
> V3 -> V4: Refactor code to be an ACPI function call
> V2 -> V3: Fix Signed-off name
> V1 -> V2: Fix compile error without enabling CONFIG_ACPI
>
>  drivers/acpi/acpi_platform.c | 4 +---
>  drivers/base/platform.c      | 1 +
>  include/linux/acpi.h         | 5 +++++
>  3 files changed, 7 insertions(+), 3 deletions(-)
>
> diff --git a/drivers/acpi/acpi_platform.c b/drivers/acpi/acpi_platform.c
> index 48d15dd785f6..adcbfbdc343f 100644
> --- a/drivers/acpi/acpi_platform.c
> +++ b/drivers/acpi/acpi_platform.c
> @@ -178,11 +178,9 @@ struct platform_device *acpi_create_platform_device(struct acpi_device *adev,
>         if (IS_ERR(pdev))
>                 dev_err(&adev->dev, "platform device creation failed: %ld\n",
>                         PTR_ERR(pdev));
> -       else {
> -               set_dev_node(&pdev->dev, acpi_get_node(adev->handle));
> +       else
>                 dev_dbg(&adev->dev, "created platform device %s\n",
>                         dev_name(&pdev->dev));
> -       }
>
>         kfree(resources);
>
> diff --git a/drivers/base/platform.c b/drivers/base/platform.c
> index 76bfcba25003..35c891075d95 100644
> --- a/drivers/base/platform.c
> +++ b/drivers/base/platform.c
> @@ -841,6 +841,7 @@ struct platform_device *platform_device_register_full(
>                         goto err;
>         }
>
> +       set_dev_node(&pdev->dev, ACPI_NODE_GET(ACPI_COMPANION(&pdev->dev)));
>         ret = platform_device_add(pdev);
>         if (ret) {
>  err:
> diff --git a/include/linux/acpi.h b/include/linux/acpi.h
> index a73246c3c35e..6a349d53f19e 100644
> --- a/include/linux/acpi.h
> +++ b/include/linux/acpi.h
> @@ -477,6 +477,10 @@ static inline int acpi_get_node(acpi_handle handle)
>         return 0;
>  }
>  #endif
> +
> +#define ACPI_NODE_GET(adev) ((adev) && (adev)->handle ? \
> +       acpi_get_node((adev)->handle) : NUMA_NO_NODE)
> +
>  extern int pnpacpi_disabled;
>
>  #define PXM_INVAL      (-1)
> @@ -770,6 +774,7 @@ const char *acpi_get_subsystem_id(acpi_handle handle);
>  #define ACPI_COMPANION_SET(dev, adev)  do { } while (0)
>  #define ACPI_HANDLE(dev)               (NULL)
>  #define ACPI_HANDLE_FWNODE(fwnode)     (NULL)
> +#define ACPI_NODE_GET(adev)            NUMA_NO_NODE
>
>  #include <acpi/acpi_numa.h>
>
> --
> 2.20.1
>

Re: [PATCH] driver core: platform: set numa_node before platform_add_device()

[Jinhui Guo]

On Mon, 18 Sep 2023 12:30:58 +0200, Rafael J. Wysocki wrote:
> On Thu, Sep 14, 2023 at 11:32 PM Jinhui Guo
> <guojinhui.liam@bytedance.com> wrote:
> >
> > platform_add_device()
> 
> According to "git grep" this function is not present in 6.6-rc2.
> 
> If you mean platform_device_add(), please update the patch subject and
> changelog accordingly.
> 

This is my mistake, the function name was written wrong.
I will fix it in the next patch.

> > creates the numa_node attribute of sysfs according
> > to whether dev_to_node(dev) is equal to NUMA_NO_NODE. So set the numa node
> > of device before creating numa_node attribute of sysfs.
> 
> It would be good to also say that this needs to be done in
> platform_device_register_full(), because that's where the platform
> device object is allocated.
> 

Thaks for your suggestion. I will modify my decription soon.

> However, what about adding the NUMA node information to pdevinfo?  It
> would be more straightforward to handle it then AFAICS.
> 

I have tried three potential solutions to fix the bug:
1. The first one is what the current patch do.

2. Add a new function interface only for acpi_create_platform_device() call.
   But the code will be a bit redundant.

3. Add an member "numa_node" in `struct platform_device_info`, just as what
   `struct device` done:

```
struct platform_device_info {
	...;
#ifdef CONFIG_NUMA
	int		numa_node;
#endif
```

But not all the call to platform_device_register_full() would set numa_node,
and many of them use ` memset(&pdevinfo, 0, sizeof(pdevinfo));` to initialize
`struct platform_device_info`. It could initialize numa_node to zero and
result in wrong numa_node information in sysfs.

```
struct platform_device *platform_device_register_full(
		const struct platform_device_info *pdevinfo) {
	...;
	/*
	 * (1) It will initialize numa_node in `struct device` to NUMA_NO_NODE.
	 *     NUMA_NO_NODE is -1.
	 */
	pdev = platform_device_alloc(pdevinfo->name, pdevinfo->id);
	...;
	/*
	 * (2) If we add set_dev_node() here, we have to make sure pdevinfo->numa_node
	 *     is correct. But It is difficult to do so, especially drivers don't want to
	 *     set numa_node. Instead of initializing pdevinfo->numa_node to NUMA_NO_NODE,
	 *     they are accustomed to memset `struct platform_device_info` to be zero.
	 */
	set_dev_node(&pdev->dev, pdevinfo->numa_node);
	...;
	/*
	 * (3) The sysfs attribute numa_node will create here.
	 */
	ret = platform_device_add(pdev);
	...;
}
```

> > Fixes: 4a60406d3592 ("driver core: platform: expose numa_node to users in sysfs")
> > Cc: stable@vger.kernel.org
> > Reported-by: kernel test robot <lkp@intel.com>
> > Closes: https://lore.kernel.org/oe-kbuild-all/202309122309.mbxAnAIe-lkp@intel.com/
> > Signed-off-by: Jinhui Guo <guojinhui.liam@bytedance.com>
> > ---
> > V4 -> V5: Add Cc: stable line and changes from the previous submited
> > patches
> > V3 -> V4: Refactor code to be an ACPI function call
> > V2 -> V3: Fix Signed-off name
> > V1 -> V2: Fix compile error without enabling CONFIG_ACPI
> >
> >  drivers/acpi/acpi_platform.c | 4 +---
> >  drivers/base/platform.c      | 1 +
> >  include/linux/acpi.h         | 5 +++++
> >  3 files changed, 7 insertions(+), 3 deletions(-)
> >
> > diff --git a/drivers/acpi/acpi_platform.c b/drivers/acpi/acpi_platform.c
> > index 48d15dd785f6..adcbfbdc343f 100644
> > --- a/drivers/acpi/acpi_platform.c
> > +++ b/drivers/acpi/acpi_platform.c
> > @@ -178,11 +178,9 @@ struct platform_device *acpi_create_platform_device(struct acpi_device *adev,
> >         if (IS_ERR(pdev))
> >                 dev_err(&adev->dev, "platform device creation failed: %ld\n",
> >                         PTR_ERR(pdev));
> > -       else {
> > -               set_dev_node(&pdev->dev, acpi_get_node(adev->handle));
> > +       else
> >                 dev_dbg(&adev->dev, "created platform device %s\n",
> >                         dev_name(&pdev->dev));
> > -       }
> >
> >         kfree(resources);
> >
> > diff --git a/drivers/base/platform.c b/drivers/base/platform.c
> > index 76bfcba25003..35c891075d95 100644
> > --- a/drivers/base/platform.c
> > +++ b/drivers/base/platform.c
> > @@ -841,6 +841,7 @@ struct platform_device *platform_device_register_full(
> >                         goto err;
> >         }
> >
> > +       set_dev_node(&pdev->dev, ACPI_NODE_GET(ACPI_COMPANION(&pdev->dev)));
> >         ret = platform_device_add(pdev);
> >         if (ret) {
> >  err:
> > diff --git a/include/linux/acpi.h b/include/linux/acpi.h
> > index a73246c3c35e..6a349d53f19e 100644
> > --- a/include/linux/acpi.h
> > +++ b/include/linux/acpi.h
> > @@ -477,6 +477,10 @@ static inline int acpi_get_node(acpi_handle handle)
> >         return 0;
> >  }
> >  #endif
> > +
> > +#define ACPI_NODE_GET(adev) ((adev) && (adev)->handle ? \
> > +       acpi_get_node((adev)->handle) : NUMA_NO_NODE)
> > +
> >  extern int pnpacpi_disabled;
> >
> >  #define PXM_INVAL      (-1)
> > @@ -770,6 +774,7 @@ const char *acpi_get_subsystem_id(acpi_handle handle);
> >  #define ACPI_COMPANION_SET(dev, adev)  do { } while (0)
> >  #define ACPI_HANDLE(dev)               (NULL)
> >  #define ACPI_HANDLE_FWNODE(fwnode)     (NULL)
> > +#define ACPI_NODE_GET(adev)            NUMA_NO_NODE
> >
> >  #include <acpi/acpi_numa.h>
> >
> > --
> > 2.20.1
> >

Thanks,

Jinhui Guo

Re: [PATCH] driver core: platform: set numa_node before platform_add_device()

[Rafael J. Wysocki]

On Mon, Sep 18, 2023 at 2:41 PM Jinhui Guo <guojinhui.liam@bytedance.com> wrote:
>
> On Mon, 18 Sep 2023 12:30:58 +0200, Rafael J. Wysocki wrote:
> > On Thu, Sep 14, 2023 at 11:32 PM Jinhui Guo
> > <guojinhui.liam@bytedance.com> wrote:
> > >
> > > platform_add_device()
> >
> > According to "git grep" this function is not present in 6.6-rc2.
> >
> > If you mean platform_device_add(), please update the patch subject and
> > changelog accordingly.
> >
>
> This is my mistake, the function name was written wrong.
> I will fix it in the next patch.
>
> > > creates the numa_node attribute of sysfs according
> > > to whether dev_to_node(dev) is equal to NUMA_NO_NODE. So set the numa node
> > > of device before creating numa_node attribute of sysfs.
> >
> > It would be good to also say that this needs to be done in
> > platform_device_register_full(), because that's where the platform
> > device object is allocated.
> >
>
> Thaks for your suggestion. I will modify my decription soon.
>
> > However, what about adding the NUMA node information to pdevinfo?  It
> > would be more straightforward to handle it then AFAICS.
> >
>
> I have tried three potential solutions to fix the bug:
> 1. The first one is what the current patch do.
>
> 2. Add a new function interface only for acpi_create_platform_device() call.
>    But the code will be a bit redundant.
>
> 3. Add an member "numa_node" in `struct platform_device_info`, just as what
>    `struct device` done:
>
> ```
> struct platform_device_info {
>         ...;
> #ifdef CONFIG_NUMA
>         int             numa_node;
> #endif
> ```
>
> But not all the call to platform_device_register_full() would set numa_node,
> and many of them use ` memset(&pdevinfo, 0, sizeof(pdevinfo));` to initialize
> `struct platform_device_info`. It could initialize numa_node to zero and
> result in wrong numa_node information in sysfs.

Well, platform_device_register_full() need not take that value as the
numa node number directly.  It may, for example, take the number from
pdevinfo, subtract 1 from it and use the result of that as the numa
node number, if not negative.