diff mbox series

[BlueZ,v1] mgmt-tester: Add devcoredump test

Message ID 20230302151621.BlueZ.v1.1.I21ac5a143b0e42eef4ff71ef04ef0e53a294932a@changeid (mailing list archive)
State Superseded
Headers show
Series [BlueZ,v1] mgmt-tester: Add devcoredump test | expand

Checks

Context Check Description
tedd_an/pre-ci_am success Success
tedd_an/CheckPatch success CheckPatch PASS
tedd_an/GitLint success Gitlint PASS
tedd_an/BuildEll success Build ELL PASS
tedd_an/BluezMake fail BluezMake FAIL: tools/mgmt-tester.c: In function ‘test_hci_devcoredump’: tools/mgmt-tester.c:12554:11: error: comparison of integer expressions of different signedness: ‘int’ and ‘long unsigned int’ [-Werror=sign-compare] 12554 | while (i < ARRAY_SIZE(expected)) { | ^ tools/mgmt-tester.c: In function ‘main’: tools/mgmt-tester.c:12585:5: note: variable tracking size limit exceeded with ‘-fvar-tracking-assignments’, retrying without 12585 | int main(int argc, char *argv[]) | ^~~~ cc1: all warnings being treated as errors make[1]: *** [Makefile:7558: tools/mgmt-tester.o] Error 1 make[1]: *** Waiting for unfinished jobs.... make: *** [Makefile:4489: all] Error 2
tedd_an/MakeCheck fail BlueZ Make Check FAIL:
tedd_an/MakeDistcheck success Make Distcheck PASS
tedd_an/CheckValgrind fail Check Valgrind FAIL: tools/mgmt-tester.c: In function ‘test_hci_devcoredump’: tools/mgmt-tester.c:12554:11: error: comparison of integer expressions of different signedness: ‘int’ and ‘long unsigned int’ [-Werror=sign-compare] 12554 | while (i < ARRAY_SIZE(expected)) { | ^ tools/mgmt-tester.c: In function ‘main’: tools/mgmt-tester.c:12585:5: note: variable tracking size limit exceeded with ‘-fvar-tracking-assignments’, retrying without 12585 | int main(int argc, char *argv[]) | ^~~~ cc1: all warnings being treated as errors make[1]: *** [Makefile:7558: tools/mgmt-tester.o] Error 1 make[1]: *** Waiting for unfinished jobs.... make: *** [Makefile:11697: check] Error 2
tedd_an/CheckSmatch fail CheckSparse: FAIL: src/shared/crypto.c:271:21: warning: Variable length array is used. src/shared/crypto.c:272:23: warning: Variable length array is used. src/shared/gatt-helpers.c:768:31: warning: Variable length array is used. src/shared/gatt-helpers.c:830:31: warning: Variable length array is used. src/shared/gatt-helpers.c:1323:31: warning: Variable length array is used. src/shared/gatt-helpers.c:1354:23: warning: Variable length array is used. src/shared/gatt-server.c:275:25: warning: Variable length array is used. src/shared/gatt-server.c:618:25: warning: Variable length array is used. src/shared/gatt-server.c:717:25: warning: Variable length array is used. src/shared/shell.c: note: in included file (through /usr/include/readline/readline.h): /usr/include/readline/rltypedefs.h:35:23: warning: non-ANSI function declaration of function 'Function' /usr/include/readline/rltypedefs.h:36:25: warning: non-ANSI function declaration of function 'VFunction' /usr/include/readline/rltypedefs.h:37:27: warning: non-ANSI function declaration of function 'CPFunction' /usr/include/readline/rltypedefs.h:38:29: warning: non-ANSI function declaration of function 'CPPFunction' src/shared/shell.c:609:21: warning: non-ANSI function declaration of function 'bt_shell_usage' src/shared/crypto.c:271:21: warning: Variable length array is used. src/shared/crypto.c:272:23: warning: Variable length array is used. src/shared/gatt-helpers.c:768:31: warning: Variable length array is used. src/shared/gatt-helpers.c:830:31: warning: Variable length array is used. src/shared/gatt-helpers.c:1323:31: warning: Variable length array is used. src/shared/gatt-helpers.c:1354:23: warning: Variable length array is used. src/shared/gatt-server.c:275:25: warning: Variable length array is used. src/shared/gatt-server.c:618:25: warning: Variable length array is used. src/shared/gatt-server.c:717:25: warning: Variable length array is used. src/shared/shell.c: note: in included file (through /usr/include/readline/readline.h): /usr/include/readline/rltypedefs.h:35:23: warning: non-ANSI function declaration of function 'Function' /usr/include/readline/rltypedefs.h:36:25: warning: non-ANSI function declaration of function 'VFunction' /usr/include/readline/rltypedefs.h:37:27: warning: non-ANSI function declaration of function 'CPFunction' /usr/include/readline/rltypedefs.h:38:29: warning: non-ANSI function declaration of function 'CPPFunction' src/shared/shell.c:609:21: warning: non-ANSI function declaration of function 'bt_shell_usage' tools/mesh-cfgtest.c:1453:17: warning: unknown escape sequence: '\%' tools/sco-tester.c: note: in included file: ./lib/bluetooth.h:186:15: warning: array of flexible structures ./lib/bluetooth.h:191:31: warning: array of flexible structures tools/bneptest.c:634:39: warning: unknown escape sequence: '\%' tools/seq2bseq.c:57:26: warning: Variable length array is used. tools/obex-client-tool.c: note: in included file (through /usr/include/readline/readline.h): /usr/include/readline/rltypedefs.h:35:23: warning: non-ANSI function declaration of function 'Function' /usr/include/readline/rltypedefs.h:36:25: warning: non-ANSI function declaration of function 'VFunction' /usr/include/readline/rltypedefs.h:37:27: warning: non-ANSI function declaration of function 'CPFunction' /usr/include/readline/rltypedefs.h:38:29: warning: non-ANSI function declaration of function 'CPPFunction' android/avctp.c:505:34: warning: Variable length array is used. android/avctp.c:556:34: warning: Variable length array is used. unit/test-avrcp.c:373:26: warning: Variable length array is used. unit/test-avrcp.c:398:26: warning: Variable length array is used. unit/test-avrcp.c:414:24: warning: Variable length array is used. android/avrcp-lib.c:1085:34: warning: Variable length array is used. android/avrcp-lib.c:1583:34: warning: Variable length array is used. android/avrcp-lib.c:1612:34: warning: Variable length array is used. android/avrcp-lib.c:1638:34: warning: Variable length array is used. tools/mgmt-tester.c: In function ‘test_hci_devcoredump’: tools/mgmt-tester.c:12554:11: error: comparison of integer expressions of different signedness: ‘int’ and ‘long unsigned int’ [-Werror=sign-compare] 12554 | while (i < ARRAY_SIZE(expected)) { | ^ cc1: all warnings being treated as errors make[1]: *** [Makefile:7558: tools/mgmt-tester.o] Error 1 make[1]: *** Waiting for unfinished jobs.... make: *** [Makefile:4489: all] Error 2
tedd_an/bluezmakeextell fail Make External ELL FAIL: tools/mgmt-tester.c: In function ‘test_hci_devcoredump’: tools/mgmt-tester.c:12554:11: error: comparison of integer expressions of different signedness: ‘int’ and ‘long unsigned int’ [-Werror=sign-compare] 12554 | while (i < ARRAY_SIZE(expected)) { | ^ cc1: all warnings being treated as errors make[1]: *** [Makefile:7558: tools/mgmt-tester.o] Error 1 make[1]: *** Waiting for unfinished jobs.... make: *** [Makefile:4489: all] Error 2
tedd_an/IncrementalBuild fail [BlueZ,v1] mgmt-tester: Add devcoredump test tools/mgmt-tester.c: In function ‘test_hci_devcoredump’: tools/mgmt-tester.c:12554:11: error: comparison of integer expressions of different signedness: ‘int’ and ‘long unsigned int’ [-Werror=sign-compare] 12554 | while (i < ARRAY_SIZE(expected)) { | ^ tools/mgmt-tester.c: In function ‘main’: tools/mgmt-tester.c:12585:5: note: variable tracking size limit exceeded with ‘-fvar-tracking-assignments’, retrying without 12585 | int main(int argc, char *argv[]) | ^~~~ cc1: all warnings being treated as errors make[1]: *** [Makefile:7558: tools/mgmt-tester.o] Error 1 make[1]: *** Waiting for unfinished jobs.... make: *** [Makefile:4489: all] Error 2
tedd_an/ScanBuild fail Scan Build FAIL

Commit Message

Manish Mandlik March 2, 2023, 11:16 p.m. UTC
Add mgmt-tester test for hci devcoredump.

---

 emulator/vhci.c     | 42 ++++++++++++++++++++++++
 emulator/vhci.h     |  2 ++
 tools/mgmt-tester.c | 78 +++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 122 insertions(+)

Comments

Luiz Augusto von Dentz March 3, 2023, 12:56 a.m. UTC | #1
Hi Manish,

On Thu, Mar 2, 2023 at 3:17 PM Manish Mandlik <mmandlik@google.com> wrote:
>
> Add mgmt-tester test for hci devcoredump.
>
> ---
>
>  emulator/vhci.c     | 42 ++++++++++++++++++++++++
>  emulator/vhci.h     |  2 ++
>  tools/mgmt-tester.c | 78 +++++++++++++++++++++++++++++++++++++++++++++
>  3 files changed, 122 insertions(+)
>
> diff --git a/emulator/vhci.c b/emulator/vhci.c
> index a12b11e0f..048ea08c6 100644
> --- a/emulator/vhci.c
> +++ b/emulator/vhci.c
> @@ -22,6 +22,7 @@
>  #include <sys/uio.h>
>  #include <fcntl.h>
>  #include <unistd.h>
> +#include <dirent.h>
>
>  #include "lib/bluetooth.h"
>  #include "lib/hci.h"
> @@ -32,6 +33,7 @@
>  #include "vhci.h"
>
>  #define DEBUGFS_PATH "/sys/kernel/debug/bluetooth"
> +#define DEVCORE_PATH "/sys/class/devcoredump"
>
>  struct vhci {
>         enum btdev_type type;
> @@ -267,3 +269,43 @@ int vhci_set_force_static_address(struct vhci *vhci, bool enable)
>         return vhci_debugfs_write(vhci, "force_static_address", &val,
>                                                         sizeof(val));
>  }
> +
> +int vhci_force_devcoredump(struct vhci *vhci, void *data, size_t len)
> +{
> +       return vhci_debugfs_write(vhci, "force_devcoredump", data, len);
> +}
> +
> +int vhci_read_devcoredump(struct vhci *vhci, void *buf, size_t size)
> +{
> +       DIR *dir;
> +       struct dirent *entry;
> +       char filename[PATH_MAX];
> +       int fd;
> +       int count;
> +
> +       dir = opendir(DEVCORE_PATH);
> +       if (dir == NULL)
> +               return -errno;
> +
> +       while ((entry = readdir(dir)) != NULL) {
> +               if (strstr(entry->d_name, "devcd"))

Hmm, I think I like the term devcd better then devcoredump, it is more
a cosmetic thing but it seem much better to read vhci_read_devcd than
vhci_read_devcoredump, etc.

> +                       break;
> +       }
> +
> +       if (entry == NULL) {
> +               closedir(dir);
> +               return -ENOENT;
> +       }
> +
> +       sprintf(filename, DEVCORE_PATH "/%s/data", entry->d_name);
> +       fd  = open(filename, O_RDONLY);
> +       if (fd < 0) {
> +               closedir(dir);
> +               return -errno;
> +       }
> +
> +       count = read(fd, buf, size);
> +       close(fd);
> +
> +       return count;
> +}
> diff --git a/emulator/vhci.h b/emulator/vhci.h
> index 6da56cb58..cb969911c 100644
> --- a/emulator/vhci.h
> +++ b/emulator/vhci.h
> @@ -29,3 +29,5 @@ int vhci_set_msft_opcode(struct vhci *vhci, uint16_t opcode);
>  int vhci_set_aosp_capable(struct vhci *vhci, bool enable);
>  int vhci_set_emu_opcode(struct vhci *vhci, uint16_t opcode);
>  int vhci_set_force_static_address(struct vhci *vhci, bool enable);
> +int vhci_force_devcoredump(struct vhci *vhci, void *data, size_t len);
> +int vhci_read_devcoredump(struct vhci *vhci, void *buf, size_t size);
> diff --git a/tools/mgmt-tester.c b/tools/mgmt-tester.c
> index a56c38173..70b425547 100644
> --- a/tools/mgmt-tester.c
> +++ b/tools/mgmt-tester.c
> @@ -12511,6 +12511,77 @@ static void test_suspend_resume_success_10(const void *test_data)
>         tester_wait(2, trigger_force_resume, NULL);
>  }
>
> +#define MAX_COREDUMP_BUF_LEN   512
> +#define MAX_COREDUMP_LINE_LEN  40
> +
> +static void test_hci_devcoredump(const void *test_data)
> +{
> +       struct test_data *data = tester_get_data();
> +       struct vhci *vhci = hciemu_get_vhci(data->hciemu);
> +       char buf[MAX_COREDUMP_BUF_LEN] = {0};
> +       char delim[] = "\n";
> +       char *line;
> +       char *saveptr;
> +       int i = 0;
> +
> +       char dump_data[] = "test data";
> +       char expected[][MAX_COREDUMP_LINE_LEN] = {
> +               "Bluetooth devcoredump",
> +               "State: 2",
> +               "Controller Name: vhci_ctrl",
> +               "Firmware Version: vhci_fw",
> +               "Driver: vhci_drv",
> +               "Vendor: vhci",
> +               "--- Start dump ---",
> +       };
> +
> +       /* Triggers the devcoredump */
> +       if (vhci_force_devcoredump(vhci, dump_data, sizeof(dump_data))) {
> +               tester_warn("Unable to set force_devcoredump");
> +               tester_test_failed();
> +               return;
> +       }
> +
> +       /* Read the generated devcoredump file */
> +       if (vhci_read_devcoredump(vhci, buf, sizeof(buf)) <= 0) {
> +               tester_warn("Unable to read devcoredump");
> +               tester_test_failed();
> +               return;
> +       }
> +
> +       /* Verify if all devcoredump header fields are present */
> +       line = strtok_r(buf, delim, &saveptr);
> +       while (i < ARRAY_SIZE(expected)) {
> +               if (!line || strcmp(line, expected[i])) {
> +                       tester_warn("Incorrect coredump data: %s (expected %s)",
> +                                   line, expected[i]);
> +                       tester_test_failed();
> +                       return;
> +               }
> +
> +               if (!strcmp(line, "State: 2")) {
> +                       /* After updating the devcoredump state, the HCI
> +                        * devcoredump API adds a `\0` at the end. Skip it
> +                        * before reading the next line.
> +                        */
> +                       saveptr++;
> +               }
> +
> +               line = strtok_r(NULL, delim, &saveptr);
> +               i++;
> +       }
> +
> +       /* Verify the devcoredump data */
> +       if (!line || strcmp(line, dump_data)) {
> +               tester_warn("Incorrect coredump data: %s (expected %s)", line,
> +                           dump_data);
> +               tester_test_failed();
> +               return;
> +       }
> +
> +       tester_test_passed();
> +}
> +
>  int main(int argc, char *argv[])
>  {
>         tester_init(&argc, &argv);
> @@ -14651,5 +14722,12 @@ int main(int argc, char *argv[])
>                                 setup_ll_privacy_add_device,
>                                 test_command_generic);
>
> +       /* HCI devcoredump
> +        * Setup : Power on
> +        * Run: Trigger devcoredump via force_devcoredump
> +        * Expect: Devcoredump is generated with correct data
> +        */
> +       test_bredrle("HCI devcoredump", NULL, NULL, test_hci_devcoredump);
> +

Great work, thanks for creating the test for it, lets just split the
vhci changes for the test itself then add the expected output in the
patch descriptions.

>         return tester_run();
>  }
> --
> 2.40.0.rc0.216.gc4246ad0f0-goog
>
bluez.test.bot@gmail.com March 3, 2023, 2:36 a.m. UTC | #2
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=726260

---Test result---

Test Summary:
CheckPatch                    PASS      0.50 seconds
GitLint                       PASS      0.27 seconds
BuildEll                      PASS      26.85 seconds
BluezMake                     FAIL      53.64 seconds
MakeCheck                     FAIL      185.38 seconds
MakeDistcheck                 PASS      150.65 seconds
CheckValgrind                 FAIL      46.80 seconds
CheckSmatch                   FAIL      100.49 seconds
bluezmakeextell               FAIL      24.88 seconds
IncrementalBuild              FAIL      54.06 seconds
ScanBuild                     FAIL      572.23 seconds

Details
##############################
Test: BluezMake - FAIL
Desc: Build BlueZ
Output:

tools/mgmt-tester.c: In function ‘test_hci_devcoredump’:
tools/mgmt-tester.c:12554:11: error: comparison of integer expressions of different signedness: ‘int’ and ‘long unsigned int’ [-Werror=sign-compare]
12554 |  while (i < ARRAY_SIZE(expected)) {
      |           ^
tools/mgmt-tester.c: In function ‘main’:
tools/mgmt-tester.c:12585:5: note: variable tracking size limit exceeded with ‘-fvar-tracking-assignments’, retrying without
12585 | int main(int argc, char *argv[])
      |     ^~~~
cc1: all warnings being treated as errors
make[1]: *** [Makefile:7558: tools/mgmt-tester.o] Error 1
make[1]: *** Waiting for unfinished jobs....
make: *** [Makefile:4489: all] Error 2
##############################
Test: MakeCheck - FAIL
Desc: Run Bluez Make Check
Output:

tools/mgmt-tester.c: In function ‘test_hci_devcoredump’:
tools/mgmt-tester.c:12554:11: error: comparison of integer expressions of different signedness: ‘int’ and ‘long unsigned int’ [-Werror=sign-compare]
12554 |  while (i < ARRAY_SIZE(expected)) {
      |           ^
tools/mgmt-tester.c: In function ‘main’:
tools/mgmt-tester.c:12585:5: note: variable tracking size limit exceeded with ‘-fvar-tracking-assignments’, retrying without
12585 | int main(int argc, char *argv[])
      |     ^~~~
cc1: all warnings being treated as errors
make[1]: *** [Makefile:7558: tools/mgmt-tester.o] Error 1
make: *** [Makefile:11697: check] Error 2
##############################
Test: CheckValgrind - FAIL
Desc: Run Bluez Make Check with Valgrind
Output:

tools/mgmt-tester.c: In function ‘test_hci_devcoredump’:
tools/mgmt-tester.c:12554:11: error: comparison of integer expressions of different signedness: ‘int’ and ‘long unsigned int’ [-Werror=sign-compare]
12554 |  while (i < ARRAY_SIZE(expected)) {
      |           ^
tools/mgmt-tester.c: In function ‘main’:
tools/mgmt-tester.c:12585:5: note: variable tracking size limit exceeded with ‘-fvar-tracking-assignments’, retrying without
12585 | int main(int argc, char *argv[])
      |     ^~~~
cc1: all warnings being treated as errors
make[1]: *** [Makefile:7558: tools/mgmt-tester.o] Error 1
make[1]: *** Waiting for unfinished jobs....
make: *** [Makefile:11697: check] Error 2
##############################
Test: CheckSmatch - FAIL
Desc: Run smatch tool with source
Output:

src/shared/crypto.c:271:21: warning: Variable length array is used.
src/shared/crypto.c:272:23: warning: Variable length array is used.
src/shared/gatt-helpers.c:768:31: warning: Variable length array is used.
src/shared/gatt-helpers.c:830:31: warning: Variable length array is used.
src/shared/gatt-helpers.c:1323:31: warning: Variable length array is used.
src/shared/gatt-helpers.c:1354:23: warning: Variable length array is used.
src/shared/gatt-server.c:275:25: warning: Variable length array is used.
src/shared/gatt-server.c:618:25: warning: Variable length array is used.
src/shared/gatt-server.c:717:25: warning: Variable length array is used.
src/shared/shell.c: note: in included file (through /usr/include/readline/readline.h):
/usr/include/readline/rltypedefs.h:35:23: warning: non-ANSI function declaration of function 'Function'
/usr/include/readline/rltypedefs.h:36:25: warning: non-ANSI function declaration of function 'VFunction'
/usr/include/readline/rltypedefs.h:37:27: warning: non-ANSI function declaration of function 'CPFunction'
/usr/include/readline/rltypedefs.h:38:29: warning: non-ANSI function declaration of function 'CPPFunction'
src/shared/shell.c:609:21: warning: non-ANSI function declaration of function 'bt_shell_usage'
src/shared/crypto.c:271:21: warning: Variable length array is used.
src/shared/crypto.c:272:23: warning: Variable length array is used.
src/shared/gatt-helpers.c:768:31: warning: Variable length array is used.
src/shared/gatt-helpers.c:830:31: warning: Variable length array is used.
src/shared/gatt-helpers.c:1323:31: warning: Variable length array is used.
src/shared/gatt-helpers.c:1354:23: warning: Variable length array is used.
src/shared/gatt-server.c:275:25: warning: Variable length array is used.
src/shared/gatt-server.c:618:25: warning: Variable length array is used.
src/shared/gatt-server.c:717:25: warning: Variable length array is used.
src/shared/shell.c: note: in included file (through /usr/include/readline/readline.h):
/usr/include/readline/rltypedefs.h:35:23: warning: non-ANSI function declaration of function 'Function'
/usr/include/readline/rltypedefs.h:36:25: warning: non-ANSI function declaration of function 'VFunction'
/usr/include/readline/rltypedefs.h:37:27: warning: non-ANSI function declaration of function 'CPFunction'
/usr/include/readline/rltypedefs.h:38:29: warning: non-ANSI function declaration of function 'CPPFunction'
src/shared/shell.c:609:21: warning: non-ANSI function declaration of function 'bt_shell_usage'
tools/mesh-cfgtest.c:1453:17: warning: unknown escape sequence: '\%'
tools/sco-tester.c: note: in included file:
./lib/bluetooth.h:186:15: warning: array of flexible structures
./lib/bluetooth.h:191:31: warning: array of flexible structures
tools/bneptest.c:634:39: warning: unknown escape sequence: '\%'
tools/seq2bseq.c:57:26: warning: Variable length array is used.
tools/obex-client-tool.c: note: in included file (through /usr/include/readline/readline.h):
/usr/include/readline/rltypedefs.h:35:23: warning: non-ANSI function declaration of function 'Function'
/usr/include/readline/rltypedefs.h:36:25: warning: non-ANSI function declaration of function 'VFunction'
/usr/include/readline/rltypedefs.h:37:27: warning: non-ANSI function declaration of function 'CPFunction'
/usr/include/readline/rltypedefs.h:38:29: warning: non-ANSI function declaration of function 'CPPFunction'
android/avctp.c:505:34: warning: Variable length array is used.
android/avctp.c:556:34: warning: Variable length array is used.
unit/test-avrcp.c:373:26: warning: Variable length array is used.
unit/test-avrcp.c:398:26: warning: Variable length array is used.
unit/test-avrcp.c:414:24: warning: Variable length array is used.
android/avrcp-lib.c:1085:34: warning: Variable length array is used.
android/avrcp-lib.c:1583:34: warning: Variable length array is used.
android/avrcp-lib.c:1612:34: warning: Variable length array is used.
android/avrcp-lib.c:1638:34: warning: Variable length array is used.
tools/mgmt-tester.c: In function ‘test_hci_devcoredump’:
tools/mgmt-tester.c:12554:11: error: comparison of integer expressions of different signedness: ‘int’ and ‘long unsigned int’ [-Werror=sign-compare]
12554 |  while (i < ARRAY_SIZE(expected)) {
      |           ^
cc1: all warnings being treated as errors
make[1]: *** [Makefile:7558: tools/mgmt-tester.o] Error 1
make[1]: *** Waiting for unfinished jobs....
make: *** [Makefile:4489: all] Error 2
##############################
Test: bluezmakeextell - FAIL
Desc: Build Bluez with External ELL
Output:

tools/mgmt-tester.c: In function ‘test_hci_devcoredump’:
tools/mgmt-tester.c:12554:11: error: comparison of integer expressions of different signedness: ‘int’ and ‘long unsigned int’ [-Werror=sign-compare]
12554 |  while (i < ARRAY_SIZE(expected)) {
      |           ^
cc1: all warnings being treated as errors
make[1]: *** [Makefile:7558: tools/mgmt-tester.o] Error 1
make[1]: *** Waiting for unfinished jobs....
make: *** [Makefile:4489: all] Error 2
##############################
Test: IncrementalBuild - FAIL
Desc: Incremental build with the patches in the series
Output:
[BlueZ,v1] mgmt-tester: Add devcoredump test

tools/mgmt-tester.c: In function ‘test_hci_devcoredump’:
tools/mgmt-tester.c:12554:11: error: comparison of integer expressions of different signedness: ‘int’ and ‘long unsigned int’ [-Werror=sign-compare]
12554 |  while (i < ARRAY_SIZE(expected)) {
      |           ^
tools/mgmt-tester.c: In function ‘main’:
tools/mgmt-tester.c:12585:5: note: variable tracking size limit exceeded with ‘-fvar-tracking-assignments’, retrying without
12585 | int main(int argc, char *argv[])
      |     ^~~~
cc1: all warnings being treated as errors
make[1]: *** [Makefile:7558: tools/mgmt-tester.o] Error 1
make[1]: *** Waiting for unfinished jobs....
make: *** [Makefile:4489: all] Error 2
##############################
Test: ScanBuild - FAIL
Desc: Run Scan Build
Output:

src/shared/ad.c:369:19: warning: Use of zero-allocated memory
                                buf[(*pos)++] = ad_type;
                                              ^
1 warning generated.
src/shared/gatt-client.c:440:21: warning: Use of memory after it is freed
        gatt_db_unregister(op->client->db, op->db_id);
                           ^~~~~~~~~~
src/shared/gatt-client.c:685:2: warning: Use of memory after it is freed
        discovery_op_complete(op, false, att_ecode);
        ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src/shared/gatt-client.c:982:2: warning: Use of memory after it is freed
        discovery_op_complete(op, success, att_ecode);
        ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src/shared/gatt-client.c:1088:2: warning: Use of memory after it is freed
        discovery_op_complete(op, success, att_ecode);
        ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src/shared/gatt-client.c:1280:2: warning: Use of memory after it is freed
        discovery_op_complete(op, success, att_ecode);
        ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src/shared/gatt-client.c:1345:2: warning: Use of memory after it is freed
        discovery_op_complete(op, success, att_ecode);
        ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src/shared/gatt-client.c:1616:6: warning: Use of memory after it is freed
        if (read_db_hash(op)) {
            ^~~~~~~~~~~~~~~~
src/shared/gatt-client.c:1621:2: warning: Use of memory after it is freed
        discover_all(op);
        ^~~~~~~~~~~~~~~~
src/shared/gatt-client.c:2127:6: warning: Use of memory after it is freed
        if (read_db_hash(op)) {
            ^~~~~~~~~~~~~~~~
src/shared/gatt-client.c:2135:8: warning: Use of memory after it is freed
                                                        discovery_op_ref(op),
                                                        ^~~~~~~~~~~~~~~~~~~~
src/shared/gatt-client.c:3223:2: warning: Use of memory after it is freed
        complete_write_long_op(req, success, 0, false);
        ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src/shared/gatt-client.c:3245:2: warning: Use of memory after it is freed
        request_unref(req);
        ^~~~~~~~~~~~~~~~~~
12 warnings generated.
src/shared/shell.c:1180:13: warning: Access to field 'options' results in a dereference of a null pointer (loaded from variable 'opt')
                        if (c != opt->options[index - offset].val) {
                                 ^~~~~~~~~~~~
1 warning generated.
src/shared/ad.c:369:19: warning: Use of zero-allocated memory
                                buf[(*pos)++] = ad_type;
                                              ^
1 warning generated.
src/shared/gatt-client.c:440:21: warning: Use of memory after it is freed
        gatt_db_unregister(op->client->db, op->db_id);
                           ^~~~~~~~~~
src/shared/gatt-client.c:685:2: warning: Use of memory after it is freed
        discovery_op_complete(op, false, att_ecode);
        ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src/shared/gatt-client.c:982:2: warning: Use of memory after it is freed
        discovery_op_complete(op, success, att_ecode);
        ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src/shared/gatt-client.c:1088:2: warning: Use of memory after it is freed
        discovery_op_complete(op, success, att_ecode);
        ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src/shared/gatt-client.c:1280:2: warning: Use of memory after it is freed
        discovery_op_complete(op, success, att_ecode);
        ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src/shared/gatt-client.c:1345:2: warning: Use of memory after it is freed
        discovery_op_complete(op, success, att_ecode);
        ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src/shared/gatt-client.c:1616:6: warning: Use of memory after it is freed
        if (read_db_hash(op)) {
            ^~~~~~~~~~~~~~~~
src/shared/gatt-client.c:1621:2: warning: Use of memory after it is freed
        discover_all(op);
        ^~~~~~~~~~~~~~~~
src/shared/gatt-client.c:2127:6: warning: Use of memory after it is freed
        if (read_db_hash(op)) {
            ^~~~~~~~~~~~~~~~
src/shared/gatt-client.c:2135:8: warning: Use of memory after it is freed
                                                        discovery_op_ref(op),
                                                        ^~~~~~~~~~~~~~~~~~~~
src/shared/gatt-client.c:3223:2: warning: Use of memory after it is freed
        complete_write_long_op(req, success, 0, false);
        ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
src/shared/gatt-client.c:3245:2: warning: Use of memory after it is freed
        request_unref(req);
        ^~~~~~~~~~~~~~~~~~
12 warnings generated.
src/shared/shell.c:1180:13: warning: Access to field 'options' results in a dereference of a null pointer (loaded from variable 'opt')
                        if (c != opt->options[index - offset].val) {
                                 ^~~~~~~~~~~~
1 warning generated.
tools/hciattach.c:816:7: warning: Although the value stored to 'n' is used in the enclosing expression, the value is never actually read from 'n'
        if ((n = read_hci_event(fd, resp, 10)) < 0) {
             ^   ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
tools/hciattach.c:864:7: warning: Although the value stored to 'n' is used in the enclosing expression, the value is never actually read from 'n'
        if ((n = read_hci_event(fd, resp, 4)) < 0) {
             ^   ~~~~~~~~~~~~~~~~~~~~~~~~~~~
tools/hciattach.c:886:8: warning: Although the value stored to 'n' is used in the enclosing expression, the value is never actually read from 'n'
                if ((n = read_hci_event(fd, resp, 10)) < 0) {
                     ^   ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
tools/hciattach.c:908:7: warning: Although the value stored to 'n' is used in the enclosing expression, the value is never actually read from 'n'
        if ((n = read_hci_event(fd, resp, 4)) < 0) {
             ^   ~~~~~~~~~~~~~~~~~~~~~~~~~~~
tools/hciattach.c:929:7: warning: Although the value stored to 'n' is used in the enclosing expression, the value is never actually read from 'n'
        if ((n = read_hci_event(fd, resp, 4)) < 0) {
             ^   ~~~~~~~~~~~~~~~~~~~~~~~~~~~
tools/hciattach.c:973:7: warning: Although the value stored to 'n' is used in the enclosing expression, the value is never actually read from 'n'
        if ((n = read_hci_event(fd, resp, 6)) < 0) {
             ^   ~~~~~~~~~~~~~~~~~~~~~~~~~~~
6 warnings generated.
src/oui.c:50:2: warning: Value stored to 'hwdb' is never read
        hwdb = udev_hwdb_unref(hwdb);
        ^      ~~~~~~~~~~~~~~~~~~~~~
src/oui.c:53:2: warning: Value stored to 'udev' is never read
        udev = udev_unref(udev);
        ^      ~~~~~~~~~~~~~~~~
2 warnings generated.
tools/hcidump.c:180:9: warning: Potential leak of memory pointed to by 'dp'
                                if (fds[i].fd == sock)
                                    ^~~
tools/hcidump.c:248:17: warning: Assigned value is garbage or undefined
                                dh->ts_sec  = htobl(frm.ts.tv_sec);
                                            ^ ~~~~~~~~~~~~~~~~~~~~
tools/hcidump.c:326:9: warning: 1st function call argument is an uninitialized value
                                if (be32toh(dp.flags) & 0x02) {
                                    ^~~~~~~~~~~~~~~~~
/usr/include/endian.h:46:22: note: expanded from macro 'be32toh'
#  define be32toh(x) __bswap_32 (x)
                     ^~~~~~~~~~~~~~
tools/hcidump.c:341:20: warning: 1st function call argument is an uninitialized value
                                frm.data_len = be32toh(dp.len);
                                               ^~~~~~~~~~~~~~~
/usr/include/endian.h:46:22: note: expanded from macro 'be32toh'
#  define be32toh(x) __bswap_32 (x)
                     ^~~~~~~~~~~~~~
tools/hcidump.c:346:14: warning: 1st function call argument is an uninitialized value
                                opcode = be32toh(dp.flags) & 0xffff;
                                         ^~~~~~~~~~~~~~~~~
/usr/include/endian.h:46:22: note: expanded from macro 'be32toh'
#  define be32toh(x) __bswap_32 (x)
                     ^~~~~~~~~~~~~~
tools/hcidump.c:384:17: warning: Assigned value is garbage or undefined
                        frm.data_len = btohs(dh.len);
                                     ^ ~~~~~~~~~~~~~
tools/hcidump.c:394:11: warning: Assigned value is garbage or undefined
                frm.len = frm.data_len;
                        ^ ~~~~~~~~~~~~
tools/hcidump.c:398:9: warning: 1st function call argument is an uninitialized value
                        ts = be64toh(ph.ts);
                             ^~~~~~~~~~~~~~
/usr/include/endian.h:51:22: note: expanded from macro 'be64toh'
#  define be64toh(x) __bswap_64 (x)
                     ^~~~~~~~~~~~~~
tools/hcidump.c:403:13: warning: 1st function call argument is an uninitialized value
                        frm.in = be32toh(dp.flags) & 0x01;
                                 ^~~~~~~~~~~~~~~~~
/usr/include/endian.h:46:22: note: expanded from macro 'be32toh'
#  define be32toh(x) __bswap_32 (x)
                     ^~~~~~~~~~~~~~
tools/hcidump.c:408:11: warning: Assigned value is garbage or undefined
                        frm.in = dh.in;
                               ^ ~~~~~
tools/hcidump.c:437:7: warning: Null pointer passed to 1st parameter expecting 'nonnull'
        fd = open(file, open_flags, 0644);
             ^~~~~~~~~~~~~~~~~~~~~~~~~~~~
11 warnings generated.
tools/rfcomm.c:228:3: warning: Value stored to 'i' is never read
                i = execvp(cmdargv[0], cmdargv);
                ^   ~~~~~~~~~~~~~~~~~~~~~~~~~~~
tools/rfcomm.c:228:7: warning: Null pointer passed to 1st parameter expecting 'nonnull'
                i = execvp(cmdargv[0], cmdargv);
                    ^~~~~~~~~~~~~~~~~~~~~~~~~~~
tools/rfcomm.c:348:8: warning: Although the value stored to 'fd' is used in the enclosing expression, the value is never actually read from 'fd'
                if ((fd = open(devname, O_RDONLY | O_NOCTTY)) < 0) {
                     ^    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
tools/rfcomm.c:491:14: warning: Assigned value is garbage or undefined
        req.channel = raddr.rc_channel;
                    ^ ~~~~~~~~~~~~~~~~
tools/rfcomm.c:509:8: warning: Although the value stored to 'fd' is used in the enclosing expression, the value is never actually read from 'fd'
                if ((fd = open(devname, O_RDONLY | O_NOCTTY)) < 0) {
                     ^    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5 warnings generated.
src/sdp-xml.c:126:10: warning: Assigned value is garbage or undefined
                buf[1] = data[i + 1];
                       ^ ~~~~~~~~~~~
src/sdp-xml.c:300:11: warning: Assigned value is garbage or undefined
                        buf[1] = data[i + 1];
                               ^ ~~~~~~~~~~~
src/sdp-xml.c:338:11: warning: Assigned value is garbage or undefined
                        buf[1] = data[i + 1];
                               ^ ~~~~~~~~~~~
3 warnings generated.
tools/ciptool.c:350:7: warning: 5th function call argument is an uninitialized value
        sk = do_connect(ctl, dev_id, &src, &dst, psm, (1 << CMTP_LOOPBACK));
             ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1 warning generated.
tools/mgmt-tester.c: In function ‘test_hci_devcoredump’:
tools/mgmt-tester.c:12554:11: error: comparison of integer expressions of different signedness: ‘int’ and ‘long unsigned int’ [-Werror=sign-compare]
12554 |  while (i < ARRAY_SIZE(expected)) {
      |           ^
tools/sdptool.c:941:26: warning: Result of 'malloc' is converted to a pointer of type 'uint32_t', which is incompatible with sizeof operand type 'int'
                        uint32_t *value_int = malloc(sizeof(int));
                        ~~~~~~~~~~            ^~~~~~ ~~~~~~~~~~~
tools/sdptool.c:980:4: warning: 1st function call argument is an uninitialized value
                        free(allocArray[i]);
                        ^~~~~~~~~~~~~~~~~~~
tools/sdptool.c:3777:2: warning: Potential leak of memory pointed to by 'si.name'
        return add_service(0, &si);
        ^~~~~~~~~~~~~~~~~~~~~~~~~~
tools/sdptool.c:4112:4: warning: Potential leak of memory pointed to by 'context.svc'
                        return -1;
                        ^~~~~~~~~
4 warnings generated.
cc1: all warnings being treated as errors
make[1]: *** [Makefile:7558: tools/mgmt-tester.o] Error 1
make[1]: *** Waiting for unfinished jobs....
make: *** [Makefile:4489: all] Error 2


---
Regards,
Linux Bluetooth
Luiz Augusto von Dentz March 14, 2023, 7:59 p.m. UTC | #3
Hi Manish,

On Thu, Mar 2, 2023 at 4:56 PM Luiz Augusto von Dentz
<luiz.dentz@gmail.com> wrote:
>
> Hi Manish,
>
> On Thu, Mar 2, 2023 at 3:17 PM Manish Mandlik <mmandlik@google.com> wrote:
> >
> > Add mgmt-tester test for hci devcoredump.
> >
> > ---
> >
> >  emulator/vhci.c     | 42 ++++++++++++++++++++++++
> >  emulator/vhci.h     |  2 ++
> >  tools/mgmt-tester.c | 78 +++++++++++++++++++++++++++++++++++++++++++++
> >  3 files changed, 122 insertions(+)
> >
> > diff --git a/emulator/vhci.c b/emulator/vhci.c
> > index a12b11e0f..048ea08c6 100644
> > --- a/emulator/vhci.c
> > +++ b/emulator/vhci.c
> > @@ -22,6 +22,7 @@
> >  #include <sys/uio.h>
> >  #include <fcntl.h>
> >  #include <unistd.h>
> > +#include <dirent.h>
> >
> >  #include "lib/bluetooth.h"
> >  #include "lib/hci.h"
> > @@ -32,6 +33,7 @@
> >  #include "vhci.h"
> >
> >  #define DEBUGFS_PATH "/sys/kernel/debug/bluetooth"
> > +#define DEVCORE_PATH "/sys/class/devcoredump"
> >
> >  struct vhci {
> >         enum btdev_type type;
> > @@ -267,3 +269,43 @@ int vhci_set_force_static_address(struct vhci *vhci, bool enable)
> >         return vhci_debugfs_write(vhci, "force_static_address", &val,
> >                                                         sizeof(val));
> >  }
> > +
> > +int vhci_force_devcoredump(struct vhci *vhci, void *data, size_t len)
> > +{
> > +       return vhci_debugfs_write(vhci, "force_devcoredump", data, len);
> > +}
> > +
> > +int vhci_read_devcoredump(struct vhci *vhci, void *buf, size_t size)
> > +{
> > +       DIR *dir;
> > +       struct dirent *entry;
> > +       char filename[PATH_MAX];
> > +       int fd;
> > +       int count;
> > +
> > +       dir = opendir(DEVCORE_PATH);
> > +       if (dir == NULL)
> > +               return -errno;
> > +
> > +       while ((entry = readdir(dir)) != NULL) {
> > +               if (strstr(entry->d_name, "devcd"))
>
> Hmm, I think I like the term devcd better then devcoredump, it is more
> a cosmetic thing but it seem much better to read vhci_read_devcd than
> vhci_read_devcoredump, etc.
>
> > +                       break;
> > +       }
> > +
> > +       if (entry == NULL) {
> > +               closedir(dir);
> > +               return -ENOENT;
> > +       }
> > +
> > +       sprintf(filename, DEVCORE_PATH "/%s/data", entry->d_name);
> > +       fd  = open(filename, O_RDONLY);
> > +       if (fd < 0) {
> > +               closedir(dir);
> > +               return -errno;
> > +       }
> > +
> > +       count = read(fd, buf, size);
> > +       close(fd);
> > +
> > +       return count;
> > +}
> > diff --git a/emulator/vhci.h b/emulator/vhci.h
> > index 6da56cb58..cb969911c 100644
> > --- a/emulator/vhci.h
> > +++ b/emulator/vhci.h
> > @@ -29,3 +29,5 @@ int vhci_set_msft_opcode(struct vhci *vhci, uint16_t opcode);
> >  int vhci_set_aosp_capable(struct vhci *vhci, bool enable);
> >  int vhci_set_emu_opcode(struct vhci *vhci, uint16_t opcode);
> >  int vhci_set_force_static_address(struct vhci *vhci, bool enable);
> > +int vhci_force_devcoredump(struct vhci *vhci, void *data, size_t len);
> > +int vhci_read_devcoredump(struct vhci *vhci, void *buf, size_t size);
> > diff --git a/tools/mgmt-tester.c b/tools/mgmt-tester.c
> > index a56c38173..70b425547 100644
> > --- a/tools/mgmt-tester.c
> > +++ b/tools/mgmt-tester.c
> > @@ -12511,6 +12511,77 @@ static void test_suspend_resume_success_10(const void *test_data)
> >         tester_wait(2, trigger_force_resume, NULL);
> >  }
> >
> > +#define MAX_COREDUMP_BUF_LEN   512
> > +#define MAX_COREDUMP_LINE_LEN  40
> > +
> > +static void test_hci_devcoredump(const void *test_data)
> > +{
> > +       struct test_data *data = tester_get_data();
> > +       struct vhci *vhci = hciemu_get_vhci(data->hciemu);
> > +       char buf[MAX_COREDUMP_BUF_LEN] = {0};
> > +       char delim[] = "\n";
> > +       char *line;
> > +       char *saveptr;
> > +       int i = 0;
> > +
> > +       char dump_data[] = "test data";
> > +       char expected[][MAX_COREDUMP_LINE_LEN] = {
> > +               "Bluetooth devcoredump",
> > +               "State: 2",
> > +               "Controller Name: vhci_ctrl",
> > +               "Firmware Version: vhci_fw",
> > +               "Driver: vhci_drv",
> > +               "Vendor: vhci",
> > +               "--- Start dump ---",
> > +       };
> > +
> > +       /* Triggers the devcoredump */
> > +       if (vhci_force_devcoredump(vhci, dump_data, sizeof(dump_data))) {
> > +               tester_warn("Unable to set force_devcoredump");
> > +               tester_test_failed();
> > +               return;
> > +       }
> > +
> > +       /* Read the generated devcoredump file */
> > +       if (vhci_read_devcoredump(vhci, buf, sizeof(buf)) <= 0) {
> > +               tester_warn("Unable to read devcoredump");
> > +               tester_test_failed();
> > +               return;
> > +       }
> > +
> > +       /* Verify if all devcoredump header fields are present */
> > +       line = strtok_r(buf, delim, &saveptr);
> > +       while (i < ARRAY_SIZE(expected)) {
> > +               if (!line || strcmp(line, expected[i])) {
> > +                       tester_warn("Incorrect coredump data: %s (expected %s)",
> > +                                   line, expected[i]);
> > +                       tester_test_failed();
> > +                       return;
> > +               }
> > +
> > +               if (!strcmp(line, "State: 2")) {
> > +                       /* After updating the devcoredump state, the HCI
> > +                        * devcoredump API adds a `\0` at the end. Skip it
> > +                        * before reading the next line.
> > +                        */
> > +                       saveptr++;
> > +               }
> > +
> > +               line = strtok_r(NULL, delim, &saveptr);
> > +               i++;
> > +       }
> > +
> > +       /* Verify the devcoredump data */
> > +       if (!line || strcmp(line, dump_data)) {
> > +               tester_warn("Incorrect coredump data: %s (expected %s)", line,
> > +                           dump_data);
> > +               tester_test_failed();
> > +               return;
> > +       }
> > +
> > +       tester_test_passed();
> > +}
> > +
> >  int main(int argc, char *argv[])
> >  {
> >         tester_init(&argc, &argv);
> > @@ -14651,5 +14722,12 @@ int main(int argc, char *argv[])
> >                                 setup_ll_privacy_add_device,
> >                                 test_command_generic);
> >
> > +       /* HCI devcoredump
> > +        * Setup : Power on
> > +        * Run: Trigger devcoredump via force_devcoredump
> > +        * Expect: Devcoredump is generated with correct data
> > +        */
> > +       test_bredrle("HCI devcoredump", NULL, NULL, test_hci_devcoredump);
> > +
>
> Great work, thanks for creating the test for it, lets just split the
> vhci changes for the test itself then add the expected output in the
> patch descriptions.

Do you need any feedback on this? You might want a v2 before 30 days
otherwise the pw series is removed due to inactivity.

> >         return tester_run();
> >  }
> > --
> > 2.40.0.rc0.216.gc4246ad0f0-goog
> >
>
>
> --
> Luiz Augusto von Dentz
Luiz Augusto von Dentz March 23, 2023, 11:34 p.m. UTC | #4
Hi Manish,

On Thu, Mar 23, 2023 at 2:22 PM Manish Mandlik <mmandlik@google.com> wrote:
>
> Hi Luiz,
>
>
> On Tue, Mar 14, 2023 at 1:22 PM Manish Mandlik <mmandlik@google.com> wrote:
>>
>> Hi Luiz,
>>
>> On Tue, Mar 14, 2023 at 1:00 PM Luiz Augusto von Dentz <luiz.dentz@gmail.com> wrote:
>>>
>>> Hi Manish,
>>>
>>> On Thu, Mar 2, 2023 at 4:56 PM Luiz Augusto von Dentz
>>> <luiz.dentz@gmail.com> wrote:
>>> >
>>> > Hi Manish,
>>> >
>>> > On Thu, Mar 2, 2023 at 3:17 PM Manish Mandlik <mmandlik@google.com> wrote:
>>> > >
>>> > > Add mgmt-tester test for hci devcoredump.
>>> > >
>>> > > ---
>>> > >
>>> > >  emulator/vhci.c     | 42 ++++++++++++++++++++++++
>>> > >  emulator/vhci.h     |  2 ++
>>> > >  tools/mgmt-tester.c | 78 +++++++++++++++++++++++++++++++++++++++++++++
>>> > >  3 files changed, 122 insertions(+)
>>> > >
>>> > > diff --git a/emulator/vhci.c b/emulator/vhci.c
>>> > > index a12b11e0f..048ea08c6 100644
>>> > > --- a/emulator/vhci.c
>>> > > +++ b/emulator/vhci.c
>>> > > @@ -22,6 +22,7 @@
>>> > >  #include <sys/uio.h>
>>> > >  #include <fcntl.h>
>>> > >  #include <unistd.h>
>>> > > +#include <dirent.h>
>>> > >
>>> > >  #include "lib/bluetooth.h"
>>> > >  #include "lib/hci.h"
>>> > > @@ -32,6 +33,7 @@
>>> > >  #include "vhci.h"
>>> > >
>>> > >  #define DEBUGFS_PATH "/sys/kernel/debug/bluetooth"
>>> > > +#define DEVCORE_PATH "/sys/class/devcoredump"
>>> > >
>>> > >  struct vhci {
>>> > >         enum btdev_type type;
>>> > > @@ -267,3 +269,43 @@ int vhci_set_force_static_address(struct vhci *vhci, bool enable)
>>> > >         return vhci_debugfs_write(vhci, "force_static_address", &val,
>>> > >                                                         sizeof(val));
>>> > >  }
>>> > > +
>>> > > +int vhci_force_devcoredump(struct vhci *vhci, void *data, size_t len)
>>> > > +{
>>> > > +       return vhci_debugfs_write(vhci, "force_devcoredump", data, len);
>>> > > +}
>>> > > +
>>> > > +int vhci_read_devcoredump(struct vhci *vhci, void *buf, size_t size)
>>> > > +{
>>> > > +       DIR *dir;
>>> > > +       struct dirent *entry;
>>> > > +       char filename[PATH_MAX];
>>> > > +       int fd;
>>> > > +       int count;
>>> > > +
>>> > > +       dir = opendir(DEVCORE_PATH);
>>> > > +       if (dir == NULL)
>>> > > +               return -errno;
>>> > > +
>>> > > +       while ((entry = readdir(dir)) != NULL) {
>>> > > +               if (strstr(entry->d_name, "devcd"))
>>> >
>>> > Hmm, I think I like the term devcd better then devcoredump, it is more
>>> > a cosmetic thing but it seem much better to read vhci_read_devcd than
>>> > vhci_read_devcoredump, etc.
>
> Ack. Will include in the next patch.
>
>>>
>>> >
>>> > > +                       break;
>>> > > +       }
>>> > > +
>>> > > +       if (entry == NULL) {
>>> > > +               closedir(dir);
>>> > > +               return -ENOENT;
>>> > > +       }
>>> > > +
>>> > > +       sprintf(filename, DEVCORE_PATH "/%s/data", entry->d_name);
>>> > > +       fd  = open(filename, O_RDONLY);
>>> > > +       if (fd < 0) {
>>> > > +               closedir(dir);
>>> > > +               return -errno;
>>> > > +       }
>>> > > +
>>> > > +       count = read(fd, buf, size);
>>> > > +       close(fd);
>>> > > +
>>> > > +       return count;
>>> > > +}
>>> > > diff --git a/emulator/vhci.h b/emulator/vhci.h
>>> > > index 6da56cb58..cb969911c 100644
>>> > > --- a/emulator/vhci.h
>>> > > +++ b/emulator/vhci.h
>>> > > @@ -29,3 +29,5 @@ int vhci_set_msft_opcode(struct vhci *vhci, uint16_t opcode);
>>> > >  int vhci_set_aosp_capable(struct vhci *vhci, bool enable);
>>> > >  int vhci_set_emu_opcode(struct vhci *vhci, uint16_t opcode);
>>> > >  int vhci_set_force_static_address(struct vhci *vhci, bool enable);
>>> > > +int vhci_force_devcoredump(struct vhci *vhci, void *data, size_t len);
>>> > > +int vhci_read_devcoredump(struct vhci *vhci, void *buf, size_t size);
>>> > > diff --git a/tools/mgmt-tester.c b/tools/mgmt-tester.c
>>> > > index a56c38173..70b425547 100644
>>> > > --- a/tools/mgmt-tester.c
>>> > > +++ b/tools/mgmt-tester.c
>>> > > @@ -12511,6 +12511,77 @@ static void test_suspend_resume_success_10(const void *test_data)
>>> > >         tester_wait(2, trigger_force_resume, NULL);
>>> > >  }
>>> > >
>>> > > +#define MAX_COREDUMP_BUF_LEN   512
>>> > > +#define MAX_COREDUMP_LINE_LEN  40
>>> > > +
>>> > > +static void test_hci_devcoredump(const void *test_data)
>>> > > +{
>>> > > +       struct test_data *data = tester_get_data();
>>> > > +       struct vhci *vhci = hciemu_get_vhci(data->hciemu);
>>> > > +       char buf[MAX_COREDUMP_BUF_LEN] = {0};
>>> > > +       char delim[] = "\n";
>>> > > +       char *line;
>>> > > +       char *saveptr;
>>> > > +       int i = 0;
>>> > > +
>>> > > +       char dump_data[] = "test data";
>>> > > +       char expected[][MAX_COREDUMP_LINE_LEN] = {
>>> > > +               "Bluetooth devcoredump",
>>> > > +               "State: 2",
>>> > > +               "Controller Name: vhci_ctrl",
>>> > > +               "Firmware Version: vhci_fw",
>>> > > +               "Driver: vhci_drv",
>>> > > +               "Vendor: vhci",
>>> > > +               "--- Start dump ---",
>>> > > +       };
>>> > > +
>>> > > +       /* Triggers the devcoredump */
>>> > > +       if (vhci_force_devcoredump(vhci, dump_data, sizeof(dump_data))) {
>>> > > +               tester_warn("Unable to set force_devcoredump");
>>> > > +               tester_test_failed();
>>> > > +               return;
>>> > > +       }
>>> > > +
>>> > > +       /* Read the generated devcoredump file */
>>> > > +       if (vhci_read_devcoredump(vhci, buf, sizeof(buf)) <= 0) {
>>> > > +               tester_warn("Unable to read devcoredump");
>>> > > +               tester_test_failed();
>>> > > +               return;
>>> > > +       }
>>> > > +
>>> > > +       /* Verify if all devcoredump header fields are present */
>>> > > +       line = strtok_r(buf, delim, &saveptr);
>>> > > +       while (i < ARRAY_SIZE(expected)) {
>>> > > +               if (!line || strcmp(line, expected[i])) {
>>> > > +                       tester_warn("Incorrect coredump data: %s (expected %s)",
>>> > > +                                   line, expected[i]);
>>> > > +                       tester_test_failed();
>>> > > +                       return;
>>> > > +               }
>>> > > +
>>> > > +               if (!strcmp(line, "State: 2")) {
>>> > > +                       /* After updating the devcoredump state, the HCI
>>> > > +                        * devcoredump API adds a `\0` at the end. Skip it
>>> > > +                        * before reading the next line.
>>> > > +                        */
>>> > > +                       saveptr++;
>>> > > +               }
>>> > > +
>>> > > +               line = strtok_r(NULL, delim, &saveptr);
>>> > > +               i++;
>>> > > +       }
>>> > > +
>>> > > +       /* Verify the devcoredump data */
>>> > > +       if (!line || strcmp(line, dump_data)) {
>>> > > +               tester_warn("Incorrect coredump data: %s (expected %s)", line,
>>> > > +                           dump_data);
>>> > > +               tester_test_failed();
>>> > > +               return;
>>> > > +       }
>>> > > +
>>> > > +       tester_test_passed();
>>> > > +}
>>> > > +
>>> > >  int main(int argc, char *argv[])
>>> > >  {
>>> > >         tester_init(&argc, &argv);
>>> > > @@ -14651,5 +14722,12 @@ int main(int argc, char *argv[])
>>> > >                                 setup_ll_privacy_add_device,
>>> > >                                 test_command_generic);
>>> > >
>>> > > +       /* HCI devcoredump
>>> > > +        * Setup : Power on
>>> > > +        * Run: Trigger devcoredump via force_devcoredump
>>> > > +        * Expect: Devcoredump is generated with correct data
>>> > > +        */
>>> > > +       test_bredrle("HCI devcoredump", NULL, NULL, test_hci_devcoredump);
>>> > > +
>>> >
>>> > Great work, thanks for creating the test for it, lets just split the
>>> > vhci changes for the test itself then add the expected output in the
>>> > patch descriptions.
>
> Do you suggest I split this patch into two? One for vhci changes and another for test changes? And for the expected output, should I include the expected contents of the output devcoredump file OR just the output from the test run like this:
> HCI devcoredump - init
>   Read Version callback
>     Status: Success (0x00)
>     Version 1.22
>   Read Commands callback
>     Status: Success (0x00)
>   Read Index List callback
>     Status: Success (0x00)
>   Index Added callback
>     Index: 0x0000
>   Enable management Mesh interface
>   Enabling Mesh feature
>   Read Info callback
>     Status: Success (0x00)
>     Address: 00:AA:01:00:00:00
>     Version: 0x09
>     Manufacturer: 0x05f1
>     Supported settings: 0x0001bfff
>     Current settings: 0x00000080
>     Class: 0x000000
>     Name:
>     Short name:
>   Mesh feature is enabled
> HCI devcoredump - setup
> HCI devcoredump - setup complete
> HCI devcoredump - run
> HCI devcoredump - test passed
> HCI devcoredump - teardown
>   Index Removed callback
>     Index: 0x0000
> HCI devcoredump - teardown complete
> HCI devcoredump - done

Have just the summary of the new tests you are adding but remove the
timing portion since it doesn't matter in this context.

>>>
>>> Do you need any feedback on this? You might want a v2 before 30 days
>>> otherwise the pw series is removed due to inactivity.
>>
>> I'm in the middle of addressing kernel side code changes, and got caught up in other work. I'll send a new series as soon as possible. Thanks for the 30 day inactivity heads up!
>>
>>>
>>> > >         return tester_run();
>>> > >  }
>>> > > --
>>> > > 2.40.0.rc0.216.gc4246ad0f0-goog
>>> > >
>>> >
>>> >
>>> > --
>>> > Luiz Augusto von Dentz
>>>
>>>
>>>
>>> --
>>> Luiz Augusto von Dentz
>>
>> Regards,
>> Manish.
>>
>>
>
>
> Regards,
> Manish.
diff mbox series

Patch

diff --git a/emulator/vhci.c b/emulator/vhci.c
index a12b11e0f..048ea08c6 100644
--- a/emulator/vhci.c
+++ b/emulator/vhci.c
@@ -22,6 +22,7 @@ 
 #include <sys/uio.h>
 #include <fcntl.h>
 #include <unistd.h>
+#include <dirent.h>
 
 #include "lib/bluetooth.h"
 #include "lib/hci.h"
@@ -32,6 +33,7 @@ 
 #include "vhci.h"
 
 #define DEBUGFS_PATH "/sys/kernel/debug/bluetooth"
+#define DEVCORE_PATH "/sys/class/devcoredump"
 
 struct vhci {
 	enum btdev_type type;
@@ -267,3 +269,43 @@  int vhci_set_force_static_address(struct vhci *vhci, bool enable)
 	return vhci_debugfs_write(vhci, "force_static_address", &val,
 							sizeof(val));
 }
+
+int vhci_force_devcoredump(struct vhci *vhci, void *data, size_t len)
+{
+	return vhci_debugfs_write(vhci, "force_devcoredump", data, len);
+}
+
+int vhci_read_devcoredump(struct vhci *vhci, void *buf, size_t size)
+{
+	DIR *dir;
+	struct dirent *entry;
+	char filename[PATH_MAX];
+	int fd;
+	int count;
+
+	dir = opendir(DEVCORE_PATH);
+	if (dir == NULL)
+		return -errno;
+
+	while ((entry = readdir(dir)) != NULL) {
+		if (strstr(entry->d_name, "devcd"))
+			break;
+	}
+
+	if (entry == NULL) {
+		closedir(dir);
+		return -ENOENT;
+	}
+
+	sprintf(filename, DEVCORE_PATH "/%s/data", entry->d_name);
+	fd  = open(filename, O_RDONLY);
+	if (fd < 0) {
+		closedir(dir);
+		return -errno;
+	}
+
+	count = read(fd, buf, size);
+	close(fd);
+
+	return count;
+}
diff --git a/emulator/vhci.h b/emulator/vhci.h
index 6da56cb58..cb969911c 100644
--- a/emulator/vhci.h
+++ b/emulator/vhci.h
@@ -29,3 +29,5 @@  int vhci_set_msft_opcode(struct vhci *vhci, uint16_t opcode);
 int vhci_set_aosp_capable(struct vhci *vhci, bool enable);
 int vhci_set_emu_opcode(struct vhci *vhci, uint16_t opcode);
 int vhci_set_force_static_address(struct vhci *vhci, bool enable);
+int vhci_force_devcoredump(struct vhci *vhci, void *data, size_t len);
+int vhci_read_devcoredump(struct vhci *vhci, void *buf, size_t size);
diff --git a/tools/mgmt-tester.c b/tools/mgmt-tester.c
index a56c38173..70b425547 100644
--- a/tools/mgmt-tester.c
+++ b/tools/mgmt-tester.c
@@ -12511,6 +12511,77 @@  static void test_suspend_resume_success_10(const void *test_data)
 	tester_wait(2, trigger_force_resume, NULL);
 }
 
+#define MAX_COREDUMP_BUF_LEN	512
+#define MAX_COREDUMP_LINE_LEN	40
+
+static void test_hci_devcoredump(const void *test_data)
+{
+	struct test_data *data = tester_get_data();
+	struct vhci *vhci = hciemu_get_vhci(data->hciemu);
+	char buf[MAX_COREDUMP_BUF_LEN] = {0};
+	char delim[] = "\n";
+	char *line;
+	char *saveptr;
+	int i = 0;
+
+	char dump_data[] = "test data";
+	char expected[][MAX_COREDUMP_LINE_LEN] = {
+		"Bluetooth devcoredump",
+		"State: 2",
+		"Controller Name: vhci_ctrl",
+		"Firmware Version: vhci_fw",
+		"Driver: vhci_drv",
+		"Vendor: vhci",
+		"--- Start dump ---",
+	};
+
+	/* Triggers the devcoredump */
+	if (vhci_force_devcoredump(vhci, dump_data, sizeof(dump_data))) {
+		tester_warn("Unable to set force_devcoredump");
+		tester_test_failed();
+		return;
+	}
+
+	/* Read the generated devcoredump file */
+	if (vhci_read_devcoredump(vhci, buf, sizeof(buf)) <= 0) {
+		tester_warn("Unable to read devcoredump");
+		tester_test_failed();
+		return;
+	}
+
+	/* Verify if all devcoredump header fields are present */
+	line = strtok_r(buf, delim, &saveptr);
+	while (i < ARRAY_SIZE(expected)) {
+		if (!line || strcmp(line, expected[i])) {
+			tester_warn("Incorrect coredump data: %s (expected %s)",
+				    line, expected[i]);
+			tester_test_failed();
+			return;
+		}
+
+		if (!strcmp(line, "State: 2")) {
+			/* After updating the devcoredump state, the HCI
+			 * devcoredump API adds a `\0` at the end. Skip it
+			 * before reading the next line.
+			 */
+			saveptr++;
+		}
+
+		line = strtok_r(NULL, delim, &saveptr);
+		i++;
+	}
+
+	/* Verify the devcoredump data */
+	if (!line || strcmp(line, dump_data)) {
+		tester_warn("Incorrect coredump data: %s (expected %s)", line,
+			    dump_data);
+		tester_test_failed();
+		return;
+	}
+
+	tester_test_passed();
+}
+
 int main(int argc, char *argv[])
 {
 	tester_init(&argc, &argv);
@@ -14651,5 +14722,12 @@  int main(int argc, char *argv[])
 				setup_ll_privacy_add_device,
 				test_command_generic);
 
+	/* HCI devcoredump
+	 * Setup : Power on
+	 * Run: Trigger devcoredump via force_devcoredump
+	 * Expect: Devcoredump is generated with correct data
+	 */
+	test_bredrle("HCI devcoredump", NULL, NULL, test_hci_devcoredump);
+
 	return tester_run();
 }