diff mbox series

[1/2] Bluetooth: fix debugfs registration

Message ID 20230424124852.12625-2-johan+linaro@kernel.org (mailing list archive)
State Awaiting Upstream
Delegated to: Netdev Maintainers
Headers show
Series Bluetooth: fix debugfs registration | expand

Checks

Context Check Description
netdev/series_format success Posting correctly formatted
netdev/tree_selection success Guessed tree name to be net-next
netdev/fixes_present success Fixes tag not required for -next series
netdev/header_inline success No static functions without inline keyword in header files
netdev/build_32bit success Errors and warnings before: 36 this patch: 36
netdev/cc_maintainers success CCed 9 of 9 maintainers
netdev/build_clang fail Errors and warnings before: 13 this patch: 13
netdev/verify_signedoff success Signed-off-by tag matches author and committer
netdev/deprecated_api success None detected
netdev/check_selftest success No net selftest shell script
netdev/verify_fixes success Fixes tag looks correct
netdev/build_allmodconfig_warn fail Errors and warnings before: 14 this patch: 14
netdev/checkpatch success total: 0 errors, 0 warnings, 0 checks, 16 lines checked
netdev/kdoc success Errors and warnings before: 0 this patch: 0
netdev/source_inline success Was 0 now: 0

Commit Message

Johan Hovold April 24, 2023, 12:48 p.m. UTC
Since commit ec6cef9cd98d ("Bluetooth: Fix SMP channel registration for
unconfigured controllers") the debugfs interface for unconfigured
controllers will be created when the controller is configured.

There is however currently nothing preventing a controller from being
configured multiple time (e.g. setting the device address using btmgmt)
which results in failed attempts to register the already registered
debugfs entries:

	debugfs: File 'features' in directory 'hci0' already present!
	debugfs: File 'manufacturer' in directory 'hci0' already present!
	debugfs: File 'hci_version' in directory 'hci0' already present!
	...
	debugfs: File 'quirk_simultaneous_discovery' in directory 'hci0' already present!

Add a controller flag to avoid trying to register the debugfs interface
more than once.

Fixes: ec6cef9cd98d ("Bluetooth: Fix SMP channel registration for unconfigured controllers")
Cc: stable@vger.kernel.org      # 4.0
Signed-off-by: Johan Hovold <johan+linaro@kernel.org>
---
 include/net/bluetooth/hci.h | 1 +
 net/bluetooth/hci_sync.c    | 3 +++
 2 files changed, 4 insertions(+)

Comments

Luiz Augusto von Dentz May 2, 2023, 11:37 p.m. UTC | #1
Hi Johan,

On Mon, Apr 24, 2023 at 5:50 AM Johan Hovold <johan+linaro@kernel.org> wrote:
>
> Since commit ec6cef9cd98d ("Bluetooth: Fix SMP channel registration for
> unconfigured controllers") the debugfs interface for unconfigured
> controllers will be created when the controller is configured.
>
> There is however currently nothing preventing a controller from being
> configured multiple time (e.g. setting the device address using btmgmt)
> which results in failed attempts to register the already registered
> debugfs entries:
>
>         debugfs: File 'features' in directory 'hci0' already present!
>         debugfs: File 'manufacturer' in directory 'hci0' already present!
>         debugfs: File 'hci_version' in directory 'hci0' already present!
>         ...
>         debugfs: File 'quirk_simultaneous_discovery' in directory 'hci0' already present!
>
> Add a controller flag to avoid trying to register the debugfs interface
> more than once.
>
> Fixes: ec6cef9cd98d ("Bluetooth: Fix SMP channel registration for unconfigured controllers")
> Cc: stable@vger.kernel.org      # 4.0
> Signed-off-by: Johan Hovold <johan+linaro@kernel.org>
> ---
>  include/net/bluetooth/hci.h | 1 +
>  net/bluetooth/hci_sync.c    | 3 +++
>  2 files changed, 4 insertions(+)
>
> diff --git a/include/net/bluetooth/hci.h b/include/net/bluetooth/hci.h
> index 400f8a7d0c3f..b8bca65bcd79 100644
> --- a/include/net/bluetooth/hci.h
> +++ b/include/net/bluetooth/hci.h
> @@ -335,6 +335,7 @@ enum {
>  enum {
>         HCI_SETUP,
>         HCI_CONFIG,
> +       HCI_DEBUGFS_CREATED,
>         HCI_AUTO_OFF,
>         HCI_RFKILLED,
>         HCI_MGMT,
> diff --git a/net/bluetooth/hci_sync.c b/net/bluetooth/hci_sync.c
> index 632be1267288..a8785126df75 100644
> --- a/net/bluetooth/hci_sync.c
> +++ b/net/bluetooth/hci_sync.c
> @@ -4501,6 +4501,9 @@ static int hci_init_sync(struct hci_dev *hdev)
>             !hci_dev_test_flag(hdev, HCI_CONFIG))
>                 return 0;
>
> +       if (hci_dev_test_and_set_flag(hdev, HCI_DEBUGFS_CREATED))
> +               return 0;

Can't we just use HCI_SETUP like we do with in create_basic:

    if (hci_dev_test_flag(hdev, HCI_SETUP))
        hci_debugfs_create_basic(hdev);

Actually we might as well move these checks directly inside the
hci_debugfs function to make sure these only take effect during the
setup/first init.

>         hci_debugfs_create_common(hdev);
>
>         if (lmp_bredr_capable(hdev))
> --
> 2.39.2
>
Johan Hovold May 3, 2023, 7:04 a.m. UTC | #2
On Tue, May 02, 2023 at 04:37:51PM -0700, Luiz Augusto von Dentz wrote:
> Hi Johan,
> 
> On Mon, Apr 24, 2023 at 5:50 AM Johan Hovold <johan+linaro@kernel.org> wrote:
> >
> > Since commit ec6cef9cd98d ("Bluetooth: Fix SMP channel registration for
> > unconfigured controllers") the debugfs interface for unconfigured
> > controllers will be created when the controller is configured.
> >
> > There is however currently nothing preventing a controller from being
> > configured multiple time (e.g. setting the device address using btmgmt)
> > which results in failed attempts to register the already registered
> > debugfs entries:
> >
> >         debugfs: File 'features' in directory 'hci0' already present!
> >         debugfs: File 'manufacturer' in directory 'hci0' already present!
> >         debugfs: File 'hci_version' in directory 'hci0' already present!
> >         ...
> >         debugfs: File 'quirk_simultaneous_discovery' in directory 'hci0' already present!
> >
> > Add a controller flag to avoid trying to register the debugfs interface
> > more than once.
> >
> > Fixes: ec6cef9cd98d ("Bluetooth: Fix SMP channel registration for unconfigured controllers")
> > Cc: stable@vger.kernel.org      # 4.0
> > Signed-off-by: Johan Hovold <johan+linaro@kernel.org>
> > ---

> > diff --git a/net/bluetooth/hci_sync.c b/net/bluetooth/hci_sync.c
> > index 632be1267288..a8785126df75 100644
> > --- a/net/bluetooth/hci_sync.c
> > +++ b/net/bluetooth/hci_sync.c
> > @@ -4501,6 +4501,9 @@ static int hci_init_sync(struct hci_dev *hdev)
> >             !hci_dev_test_flag(hdev, HCI_CONFIG))
> >                 return 0;
> >
> > +       if (hci_dev_test_and_set_flag(hdev, HCI_DEBUGFS_CREATED))
> > +               return 0;
> 
> Can't we just use HCI_SETUP like we do with in create_basic:
> 
>     if (hci_dev_test_flag(hdev, HCI_SETUP))
>         hci_debugfs_create_basic(hdev);
> 
> Actually we might as well move these checks directly inside the
> hci_debugfs function to make sure these only take effect during the
> setup/first init.

The problem is that commit ec6cef9cd98d ("Bluetooth: Fix SMP channel
registration for unconfigured controllers") started deferring creation
of most parts of the debugfs interface until the controller is
configured (e.g. as some information is not available until then).

Moving everything back to setup-time would effectively revert that.

Perhaps the interface can be changed in some way so that everything is
again registered at setup-time (e.g. with placeholder values instead of
conditionally created attributes), but that would at least not be
something that we could backport.

> >         hci_debugfs_create_common(hdev);
> >
> >         if (lmp_bredr_capable(hdev))

Johan
Luiz Augusto von Dentz May 3, 2023, 5:34 p.m. UTC | #3
Hi Johan,

On Wed, May 3, 2023 at 12:04 AM Johan Hovold <johan@kernel.org> wrote:
>
> On Tue, May 02, 2023 at 04:37:51PM -0700, Luiz Augusto von Dentz wrote:
> > Hi Johan,
> >
> > On Mon, Apr 24, 2023 at 5:50 AM Johan Hovold <johan+linaro@kernel.org> wrote:
> > >
> > > Since commit ec6cef9cd98d ("Bluetooth: Fix SMP channel registration for
> > > unconfigured controllers") the debugfs interface for unconfigured
> > > controllers will be created when the controller is configured.
> > >
> > > There is however currently nothing preventing a controller from being
> > > configured multiple time (e.g. setting the device address using btmgmt)
> > > which results in failed attempts to register the already registered
> > > debugfs entries:
> > >
> > >         debugfs: File 'features' in directory 'hci0' already present!
> > >         debugfs: File 'manufacturer' in directory 'hci0' already present!
> > >         debugfs: File 'hci_version' in directory 'hci0' already present!
> > >         ...
> > >         debugfs: File 'quirk_simultaneous_discovery' in directory 'hci0' already present!
> > >
> > > Add a controller flag to avoid trying to register the debugfs interface
> > > more than once.
> > >
> > > Fixes: ec6cef9cd98d ("Bluetooth: Fix SMP channel registration for unconfigured controllers")
> > > Cc: stable@vger.kernel.org      # 4.0
> > > Signed-off-by: Johan Hovold <johan+linaro@kernel.org>
> > > ---
>
> > > diff --git a/net/bluetooth/hci_sync.c b/net/bluetooth/hci_sync.c
> > > index 632be1267288..a8785126df75 100644
> > > --- a/net/bluetooth/hci_sync.c
> > > +++ b/net/bluetooth/hci_sync.c
> > > @@ -4501,6 +4501,9 @@ static int hci_init_sync(struct hci_dev *hdev)
> > >             !hci_dev_test_flag(hdev, HCI_CONFIG))
> > >                 return 0;
> > >
> > > +       if (hci_dev_test_and_set_flag(hdev, HCI_DEBUGFS_CREATED))
> > > +               return 0;
> >
> > Can't we just use HCI_SETUP like we do with in create_basic:
> >
> >     if (hci_dev_test_flag(hdev, HCI_SETUP))
> >         hci_debugfs_create_basic(hdev);
> >
> > Actually we might as well move these checks directly inside the
> > hci_debugfs function to make sure these only take effect during the
> > setup/first init.
>
> The problem is that commit ec6cef9cd98d ("Bluetooth: Fix SMP channel
> registration for unconfigured controllers") started deferring creation
> of most parts of the debugfs interface until the controller is
> configured (e.g. as some information is not available until then).
>
> Moving everything back to setup-time would effectively revert that.

Not moving back but just doing something like:

diff --git a/net/bluetooth/hci_debugfs.c b/net/bluetooth/hci_debugfs.c
index ec0df2f9188e..a6e94c29fc5a 100644
--- a/net/bluetooth/hci_debugfs.c
+++ b/net/bluetooth/hci_debugfs.c
@@ -310,6 +310,9 @@ DEFINE_INFO_ATTRIBUTE(firmware_info, fw_info);

 void hci_debugfs_create_common(struct hci_dev *hdev)
 {
+       if (!hci_dev_test_flag(hdev, HCI_SETUP))
+               return;
+
        debugfs_create_file("features", 0444, hdev->debugfs, hdev,
                            &features_fops);
        debugfs_create_u16("manufacturer", 0444, hdev->debugfs,

> Perhaps the interface can be changed in some way so that everything is
> again registered at setup-time (e.g. with placeholder values instead of
> conditionally created attributes), but that would at least not be
> something that we could backport.
>
> > >         hci_debugfs_create_common(hdev);
> > >
> > >         if (lmp_bredr_capable(hdev))
>
> Johan
Johan Hovold May 4, 2023, 8:26 a.m. UTC | #4
On Wed, May 03, 2023 at 10:34:06AM -0700, Luiz Augusto von Dentz wrote:
> Hi Johan,
> 
> On Wed, May 3, 2023 at 12:04 AM Johan Hovold <johan@kernel.org> wrote:
> >
> > On Tue, May 02, 2023 at 04:37:51PM -0700, Luiz Augusto von Dentz wrote:
> > > Hi Johan,
> > >
> > > On Mon, Apr 24, 2023 at 5:50 AM Johan Hovold <johan+linaro@kernel.org> wrote:
> > > >
> > > > Since commit ec6cef9cd98d ("Bluetooth: Fix SMP channel registration for
> > > > unconfigured controllers") the debugfs interface for unconfigured
> > > > controllers will be created when the controller is configured.
> > > >
> > > > There is however currently nothing preventing a controller from being
> > > > configured multiple time (e.g. setting the device address using btmgmt)
> > > > which results in failed attempts to register the already registered
> > > > debugfs entries:
> > > >
> > > >         debugfs: File 'features' in directory 'hci0' already present!
> > > >         debugfs: File 'manufacturer' in directory 'hci0' already present!
> > > >         debugfs: File 'hci_version' in directory 'hci0' already present!
> > > >         ...
> > > >         debugfs: File 'quirk_simultaneous_discovery' in directory 'hci0' already present!
> > > >
> > > > Add a controller flag to avoid trying to register the debugfs interface
> > > > more than once.
> > > >
> > > > Fixes: ec6cef9cd98d ("Bluetooth: Fix SMP channel registration for unconfigured controllers")
> > > > Cc: stable@vger.kernel.org      # 4.0
> > > > Signed-off-by: Johan Hovold <johan+linaro@kernel.org>
> > > > ---
> >
> > > > diff --git a/net/bluetooth/hci_sync.c b/net/bluetooth/hci_sync.c
> > > > index 632be1267288..a8785126df75 100644
> > > > --- a/net/bluetooth/hci_sync.c
> > > > +++ b/net/bluetooth/hci_sync.c
> > > > @@ -4501,6 +4501,9 @@ static int hci_init_sync(struct hci_dev *hdev)
> > > >             !hci_dev_test_flag(hdev, HCI_CONFIG))
> > > >                 return 0;
> > > >
> > > > +       if (hci_dev_test_and_set_flag(hdev, HCI_DEBUGFS_CREATED))
> > > > +               return 0;
> > >
> > > Can't we just use HCI_SETUP like we do with in create_basic:
> > >
> > >     if (hci_dev_test_flag(hdev, HCI_SETUP))
> > >         hci_debugfs_create_basic(hdev);
> > >
> > > Actually we might as well move these checks directly inside the
> > > hci_debugfs function to make sure these only take effect during the
> > > setup/first init.
> >
> > The problem is that commit ec6cef9cd98d ("Bluetooth: Fix SMP channel
> > registration for unconfigured controllers") started deferring creation
> > of most parts of the debugfs interface until the controller is
> > configured (e.g. as some information is not available until then).
> >
> > Moving everything back to setup-time would effectively revert that.
> 
> Not moving back but just doing something like:
> 
> diff --git a/net/bluetooth/hci_debugfs.c b/net/bluetooth/hci_debugfs.c
> index ec0df2f9188e..a6e94c29fc5a 100644
> --- a/net/bluetooth/hci_debugfs.c
> +++ b/net/bluetooth/hci_debugfs.c
> @@ -310,6 +310,9 @@ DEFINE_INFO_ATTRIBUTE(firmware_info, fw_info);
> 
>  void hci_debugfs_create_common(struct hci_dev *hdev)
>  {
> +       if (!hci_dev_test_flag(hdev, HCI_SETUP))
> +               return;
> +
>         debugfs_create_file("features", 0444, hdev->debugfs, hdev,
>                             &features_fops);
>         debugfs_create_u16("manufacturer", 0444, hdev->debugfs,
> 

What I tried to explain above is that doing this would always create
the attributes as setup-time rather than at config-time, which
effectively reverts commit ec6cef9cd98d ("Bluetooth: Fix SMP channel
registration for unconfigured controllers"). And doing so looks like it
would amount to a regression.

Johan
diff mbox series

Patch

diff --git a/include/net/bluetooth/hci.h b/include/net/bluetooth/hci.h
index 400f8a7d0c3f..b8bca65bcd79 100644
--- a/include/net/bluetooth/hci.h
+++ b/include/net/bluetooth/hci.h
@@ -335,6 +335,7 @@  enum {
 enum {
 	HCI_SETUP,
 	HCI_CONFIG,
+	HCI_DEBUGFS_CREATED,
 	HCI_AUTO_OFF,
 	HCI_RFKILLED,
 	HCI_MGMT,
diff --git a/net/bluetooth/hci_sync.c b/net/bluetooth/hci_sync.c
index 632be1267288..a8785126df75 100644
--- a/net/bluetooth/hci_sync.c
+++ b/net/bluetooth/hci_sync.c
@@ -4501,6 +4501,9 @@  static int hci_init_sync(struct hci_dev *hdev)
 	    !hci_dev_test_flag(hdev, HCI_CONFIG))
 		return 0;
 
+	if (hci_dev_test_and_set_flag(hdev, HCI_DEBUGFS_CREATED))
+		return 0;
+
 	hci_debugfs_create_common(hdev);
 
 	if (lmp_bredr_capable(hdev))