diff mbox series

[1/2] Bluetooth: fix debugfs registration

Message ID 20230424124852.12625-2-johan+linaro@kernel.org (mailing list archive)
State New, archived
Headers show
Series Bluetooth: fix debugfs registration | expand

Checks

Context Check Description
tedd_an/pre-ci_am success Success
tedd_an/CheckPatch warning WARNING: Possible unwrapped commit description (prefer a maximum 75 chars per line) #81: debugfs: File 'quirk_simultaneous_discovery' in directory 'hci0' already present! total: 0 errors, 1 warnings, 0 checks, 16 lines checked NOTE: For some of the reported defects, checkpatch may be able to mechanically convert to the typical style using --fix or --fix-inplace. /github/workspace/src/src/13222096.patch has style problems, please review. NOTE: Ignored message types: UNKNOWN_COMMIT_ID NOTE: If any of the errors are false positives, please report them to the maintainer, see CHECKPATCH in MAINTAINERS.
tedd_an/GitLint fail WARNING: I3 - ignore-body-lines: gitlint will be switching from using Python regex 'match' (match beginning) to 'search' (match anywhere) semantics. Please review your ignore-body-lines.regex option accordingly. To remove this warning, set general.regex-style-search=True. More details: https://jorisroovers.github.io/gitlint/configuration/#regex-style-search 12: B3 Line contains hard tab characters (\t): " debugfs: File 'features' in directory 'hci0' already present!" 13: B3 Line contains hard tab characters (\t): " debugfs: File 'manufacturer' in directory 'hci0' already present!" 14: B3 Line contains hard tab characters (\t): " debugfs: File 'hci_version' in directory 'hci0' already present!" 15: B3 Line contains hard tab characters (\t): " ..." 16: B1 Line exceeds max length (82>80): " debugfs: File 'quirk_simultaneous_discovery' in directory 'hci0' already present!" 16: B3 Line contains hard tab characters (\t): " debugfs: File 'quirk_simultaneous_discovery' in directory 'hci0' already present!"
tedd_an/SubjectPrefix success Gitlint PASS
tedd_an/BuildKernel success BuildKernel PASS
tedd_an/CheckAllWarning success CheckAllWarning PASS
tedd_an/CheckSparse success CheckSparse PASS
tedd_an/CheckSmatch success CheckSparse PASS
tedd_an/BuildKernel32 success BuildKernel32 PASS
tedd_an/TestRunnerSetup success TestRunnerSetup PASS
tedd_an/TestRunner_l2cap-tester success TestRunner PASS
tedd_an/TestRunner_iso-tester success TestRunner PASS
tedd_an/TestRunner_bnep-tester success TestRunner PASS
tedd_an/TestRunner_mgmt-tester success TestRunner PASS
tedd_an/TestRunner_rfcomm-tester success TestRunner PASS
tedd_an/TestRunner_sco-tester success TestRunner PASS
tedd_an/TestRunner_ioctl-tester success TestRunner PASS
tedd_an/TestRunner_mesh-tester success TestRunner PASS
tedd_an/TestRunner_smp-tester success TestRunner PASS
tedd_an/TestRunner_userchan-tester success TestRunner PASS
tedd_an/IncrementalBuild success Incremental Build PASS

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

bluez.test.bot@gmail.com April 24, 2023, 1:36 p.m. UTC | #1
This is automated email and please do not reply to this email!

Dear submitter,

Thank you for submitting the patches to the linux bluetooth mailing list.
This is a CI test results with your patch series:
PW Link:https://patchwork.kernel.org/project/bluetooth/list/?series=742711

---Test result---

Test Summary:
CheckPatch                    FAIL      1.78 seconds
GitLint                       FAIL      0.88 seconds
SubjectPrefix                 PASS      0.20 seconds
BuildKernel                   PASS      30.05 seconds
CheckAllWarning               PASS      35.30 seconds
CheckSparse                   PASS      41.82 seconds
CheckSmatch                   PASS      100.62 seconds
BuildKernel32                 PASS      30.81 seconds
TestRunnerSetup               PASS      451.65 seconds
TestRunner_l2cap-tester       PASS      16.97 seconds
TestRunner_iso-tester         PASS      20.91 seconds
TestRunner_bnep-tester        PASS      5.13 seconds
TestRunner_mgmt-tester        PASS      110.17 seconds
TestRunner_rfcomm-tester      PASS      8.35 seconds
TestRunner_sco-tester         PASS      7.75 seconds
TestRunner_ioctl-tester       PASS      9.15 seconds
TestRunner_mesh-tester        PASS      6.65 seconds
TestRunner_smp-tester         PASS      7.59 seconds
TestRunner_userchan-tester    PASS      5.46 seconds
IncrementalBuild              PASS      33.05 seconds

Details
##############################
Test: CheckPatch - FAIL
Desc: Run checkpatch.pl script
Output:
[1/2] Bluetooth: fix debugfs registration
WARNING: Possible unwrapped commit description (prefer a maximum 75 chars per line)
#81: 
	debugfs: File 'quirk_simultaneous_discovery' in directory 'hci0' already present!

total: 0 errors, 1 warnings, 0 checks, 16 lines checked

NOTE: For some of the reported defects, checkpatch may be able to
      mechanically convert to the typical style using --fix or --fix-inplace.

/github/workspace/src/src/13222096.patch has style problems, please review.

NOTE: Ignored message types: UNKNOWN_COMMIT_ID

NOTE: If any of the errors are false positives, please report
      them to the maintainer, see CHECKPATCH in MAINTAINERS.


##############################
Test: GitLint - FAIL
Desc: Run gitlint
Output:
[1/2] Bluetooth: fix debugfs registration

WARNING: I3 - ignore-body-lines: gitlint will be switching from using Python regex 'match' (match beginning) to 'search' (match anywhere) semantics. Please review your ignore-body-lines.regex option accordingly. To remove this warning, set general.regex-style-search=True. More details: https://jorisroovers.github.io/gitlint/configuration/#regex-style-search
12: B3 Line contains hard tab characters (\t): "	debugfs: File 'features' in directory 'hci0' already present!"
13: B3 Line contains hard tab characters (\t): "	debugfs: File 'manufacturer' in directory 'hci0' already present!"
14: B3 Line contains hard tab characters (\t): "	debugfs: File 'hci_version' in directory 'hci0' already present!"
15: B3 Line contains hard tab characters (\t): "	..."
16: B1 Line exceeds max length (82>80): "	debugfs: File 'quirk_simultaneous_discovery' in directory 'hci0' already present!"
16: B3 Line contains hard tab characters (\t): "	debugfs: File 'quirk_simultaneous_discovery' in directory 'hci0' already present!"
[2/2] Bluetooth: hci_qca: fix debugfs registration

WARNING: I3 - ignore-body-lines: gitlint will be switching from using Python regex 'match' (match beginning) to 'search' (match anywhere) semantics. Please review your ignore-body-lines.regex option accordingly. To remove this warning, set general.regex-style-search=True. More details: https://jorisroovers.github.io/gitlint/configuration/#regex-style-search
10: B3 Line contains hard tab characters (\t): "	debugfs: Directory 'ibs' with parent 'hci0' already present!"
15: B3 Line contains hard tab characters (\t): "Cc: stable@vger.kernel.org	# 4.20"


---
Regards,
Linux Bluetooth
Luiz Augusto von Dentz May 2, 2023, 11:37 p.m. UTC | #2
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 | #3
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 | #4
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 | #5
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))