[v1,1/1] PNP: Export pnp_bus_type for modules

Commit Message

Andy Shevchenko May 27, 2024, 8:24 p.m. UTC

Since we have dev_is_pnp() macro that utilises the address of pnp_bus_type
variable, the users, which can be compiled as modules, will be failed to
build. Export the variable to the modules to prevent build breakage.

Reported-by: Woody Suwalski <[e-mail]>
Closes: https://lore.kernel.org/r/[e-mail]
Fixes: 2a49b45cd0e7 ("PNP: Add dev_is_pnp() macro")
Signed-off-by: Andy Shevchenko <[e-mail]>
---
 drivers/pnp/driver.c | 1 +
 1 file changed, 1 insertion(+)

Comments

Woody Suwalski May 27, 2024, 10:20 p.m. UTC | #1

Andy Shevchenko wrote:
> Since we have dev_is_pnp() macro that utilises the address of pnp_bus_type
> variable, the users, which can be compiled as modules, will be failed to
> build. Export the variable to the modules to prevent build breakage.
>
> Reported-by: Woody Suwalski <[e-mail]>
> Closes: https://lore.kernel.org/r/[e-mail]
> Fixes: 2a49b45cd0e7 ("PNP: Add dev_is_pnp() macro")
> Signed-off-by: Andy Shevchenko <[e-mail]>
> ---
>   drivers/pnp/driver.c | 1 +
>   1 file changed, 1 insertion(+)
>
> diff --git a/drivers/pnp/driver.c b/drivers/pnp/driver.c
> index 0a5d0d8befa8..1394d17bd6f7 100644
> --- a/drivers/pnp/driver.c
> +++ b/drivers/pnp/driver.c
> @@ -265,6 +265,7 @@ const struct bus_type pnp_bus_type = {
>   	.pm	 = &pnp_bus_dev_pm_ops,
>   	.dev_groups = pnp_dev_groups,
>   };
> +EXPORT_SYMBOL(pnp_bus_type);
>   
>   int pnp_register_driver(struct pnp_driver *drv)
>   {
Confirm the patch works OK.

Tested-by: Woody Suwalski <[e-mail]>

Thanks, Woody

Christoph Hellwig May 28, 2024, 4:58 a.m. UTC | #2

On Mon, May 27, 2024 at 11:24:24PM +0300, Andy Shevchenko wrote:
> Since we have dev_is_pnp() macro that utilises the address of pnp_bus_type
> variable, the users, which can be compiled as modules, will be failed to
> build. Export the variable to the modules to prevent build breakage.

NAK.  Please move dev_is_pnp out of line and export it (as
EXPORT_SYMBOL_GPL), please.  bus types should be private unless we have
really good reasons for them not to be private.

Andy Shevchenko May 28, 2024, 7:10 a.m. UTC | #3

On Tue, May 28, 2024 at 7:58 AM Christoph Hellwig <[e-mail]> wrote:
>
> On Mon, May 27, 2024 at 11:24:24PM +0300, Andy Shevchenko wrote:
> > Since we have dev_is_pnp() macro that utilises the address of pnp_bus_type
> > variable, the users, which can be compiled as modules, will be failed to
> > build. Export the variable to the modules to prevent build breakage.
>
> NAK.  Please move dev_is_pnp out of line and export it (as
> EXPORT_SYMBOL_GPL), please.  bus types should be private unless we have
> really good reasons for them not to be private.

Works for me, I'll redo it in the v2, thank you for the review.

Andy Shevchenko May 28, 2024, 7:12 a.m. UTC | #4

On Tue, May 28, 2024 at 7:58 AM Christoph Hellwig <[e-mail]> wrote:
>
> On Mon, May 27, 2024 at 11:24:24PM +0300, Andy Shevchenko wrote:
> > Since we have dev_is_pnp() macro that utilises the address of pnp_bus_type
> > variable, the users, which can be compiled as modules, will be failed to
> > build. Export the variable to the modules to prevent build breakage.
>
> NAK.  Please move dev_is_pnp out of line and export it (as
> EXPORT_SYMBOL_GPL), please.  bus types should be private unless we have
> really good reasons for them not to be private.

FWIW, it's not private, it's just not exported to the modules. Are you
suggesting to hide the bus type completely to make it static? If so,
this is out of scope of this fix.

Christoph Hellwig May 28, 2024, 7:14 a.m. UTC | #5

On Tue, May 28, 2024 at 10:12:31AM +0300, Andy Shevchenko wrote:
> > NAK.  Please move dev_is_pnp out of line and export it (as
> > EXPORT_SYMBOL_GPL), please.  bus types should be private unless we have
> > really good reasons for them not to be private.
> 
> FWIW, it's not private, it's just not exported to the modules. Are you
> suggesting to hide the bus type completely to make it static? If so,
> this is out of scope of this fix.

Not exporting it is the most important bit.  Making it private would
be even better of course.

Rafael J. Wysocki May 28, 2024, 9:42 a.m. UTC | #6

On Mon, May 27, 2024 at 10:24 PM Andy Shevchenko
<[e-mail]> wrote:
>
> Since we have dev_is_pnp() macro that utilises the address of pnp_bus_type
> variable, the users, which can be compiled as modules, will be failed to
> build. Export the variable to the modules to prevent build breakage.
>
> Reported-by: Woody Suwalski <[e-mail]>
> Closes: https://lore.kernel.org/r/[e-mail]
> Fixes: 2a49b45cd0e7 ("PNP: Add dev_is_pnp() macro")
> Signed-off-by: Andy Shevchenko <[e-mail]>
> ---
>  drivers/pnp/driver.c | 1 +
>  1 file changed, 1 insertion(+)
>
> diff --git a/drivers/pnp/driver.c b/drivers/pnp/driver.c
> index 0a5d0d8befa8..1394d17bd6f7 100644
> --- a/drivers/pnp/driver.c
> +++ b/drivers/pnp/driver.c
> @@ -265,6 +265,7 @@ const struct bus_type pnp_bus_type = {
>         .pm      = &pnp_bus_dev_pm_ops,
>         .dev_groups = pnp_dev_groups,
>  };
> +EXPORT_SYMBOL(pnp_bus_type);

Why not EXPORT_SYMBOL_GPL()?

>  int pnp_register_driver(struct pnp_driver *drv)
>  {
> --
> 2.45.1
>
>

Andy Shevchenko May 28, 2024, 9:52 a.m. UTC | #7

On Tue, May 28, 2024 at 12:42 PM Rafael J. Wysocki <[e-mail]> wrote:
> On Mon, May 27, 2024 at 10:24 PM Andy Shevchenko
> <[e-mail]> wrote:
> >
> > Since we have dev_is_pnp() macro that utilises the address of pnp_bus_type
> > variable, the users, which can be compiled as modules, will be failed to
> > build. Export the variable to the modules to prevent build breakage.

...

> > +EXPORT_SYMBOL(pnp_bus_type);
>
> Why not EXPORT_SYMBOL_GPL()?

To be consistent with the rest, but in any case Christoph suggested
something else, where _GPL is assumed to be.

Rafael J. Wysocki May 28, 2024, 9:58 a.m. UTC | #8

On Tue, May 28, 2024 at 11:53 AM Andy Shevchenko
<[e-mail]> wrote:
>
> On Tue, May 28, 2024 at 12:42 PM Rafael J. Wysocki <[e-mail]> wrote:
> > On Mon, May 27, 2024 at 10:24 PM Andy Shevchenko
> > <[e-mail]> wrote:
> > >
> > > Since we have dev_is_pnp() macro that utilises the address of pnp_bus_type
> > > variable, the users, which can be compiled as modules, will be failed to
> > > build. Export the variable to the modules to prevent build breakage.
>
> ...
>
> > > +EXPORT_SYMBOL(pnp_bus_type);
> >
> > Why not EXPORT_SYMBOL_GPL()?
>
> To be consistent with the rest, but in any case Christoph suggested
> something else, where _GPL is assumed to be.

Yes, that's even better.

Patch

diff --git a/drivers/pnp/driver.c b/drivers/pnp/driver.c
index 0a5d0d8befa8..1394d17bd6f7 100644
--- a/drivers/pnp/driver.c
+++ b/drivers/pnp/driver.c
@@ -265,6 +265,7 @@  const struct bus_type pnp_bus_type = {
 	.pm	 = &pnp_bus_dev_pm_ops,
 	.dev_groups = pnp_dev_groups,
 };
+EXPORT_SYMBOL(pnp_bus_type);
 
 int pnp_register_driver(struct pnp_driver *drv)
 {