From patchwork Thu Mar 30 06:08:02 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Manish Mandlik X-Patchwork-Id: 13193422 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id E9744C6FD1D for ; Thu, 30 Mar 2023 06:08:10 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S230123AbjC3GIK (ORCPT ); Thu, 30 Mar 2023 02:08:10 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:36932 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S230054AbjC3GIJ (ORCPT ); Thu, 30 Mar 2023 02:08:09 -0400 Received: from mail-yb1-xb4a.google.com (mail-yb1-xb4a.google.com [IPv6:2607:f8b0:4864:20::b4a]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id A06F840C6 for ; Wed, 29 Mar 2023 23:08:07 -0700 (PDT) Received: by mail-yb1-xb4a.google.com with SMTP id 4-20020a251904000000b00b7f75c3cafdso2524077ybz.16 for ; Wed, 29 Mar 2023 23:08:07 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20210112; t=1680156487; h=cc:to:from:subject:message-id:mime-version:date:from:to:cc:subject :date:message-id:reply-to; bh=GucA/TicppslztYc/WfsOHum2FhKG0FA+lcCDeFNths=; b=MQSmfc6YyC+HvRLaZm8rfVEXFBYmrJmgNL9qaYqYOLp88nWB/XkVvgOarm2BUc5v29 ymRpAuGrjCMYVVlh37GNWMXRR0/30kbqKGZI0cmeSz42aZxf8mjJUh1p/ryF0oZ36/oE xaxR1hDeJ2PuZ7jBlE6V8vr624wLriep5VhwZHrgqUm+y2xHKycFnr81AC+nkyJu9ZQ4 EG0MoiEDdtgVzTX1NFn/XnyqHjwqKDpYrIy0P/U4lNkiuyZYtvwGj+9Atb6I3E0i1+wK a0m5NMLRA3Wqi2sxdnfc2XOasNmV7WBXg9E6S0EyoM3PGuVQG3mRWynWwVEA3HyDyKiv mKqA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; t=1680156487; h=cc:to:from:subject:message-id:mime-version:date:x-gm-message-state :from:to:cc:subject:date:message-id:reply-to; bh=GucA/TicppslztYc/WfsOHum2FhKG0FA+lcCDeFNths=; b=vNCToUwCPxtIz5pKY2q/6QArpiwTjYzNXZKoGLoPdizgOqgVc+2D91l5662Pp8DgzR xSLfGU8w18Oqv1KBlsr+CuYwaPtqyRzU9fPOPXZH4du33QlC5+c5sEAdaPRIZ279NMcp LR6X0cna4Uasi/tMYY21CjaTarlZu4YKOdIQvyZKEhk5WlT+tqKOYRYVsI7ajtSc+wHB 6quSNTCtunuE60wmtNKEnvEwN7CbX/Djzo1JZ0VvLRDzbL//ny3EA8kGD4/7/lo3E0X7 PBgRE8/SfoF5WAiUAoXqm7eNlRN1AuL7XfSe3IY6z96pMdKxt4jkKKi9ZNO038YSpOZ3 KNlg== X-Gm-Message-State: AAQBX9del9ftKxkmtoWAECxS99qhmdJBEQawD4fQQ44G2KCksHH49QmA 5MlaPo5Offf9voxkar9Jwb7WeZI6OIddbg== X-Google-Smtp-Source: AKy350ZuUo04vO9lUTdNAlxkVsQjrqin53BD3q8xfk84x5arbFXUjYfr0MfcUOKxbsWmVIW/ftLc9/8ABEkf9Q== X-Received: from mmandlik-cloudtop.c.googlers.com ([fda3:e722:ac3:cc00:24:72f4:c0a8:2893]) (user=mmandlik job=sendgmr) by 2002:a81:ac64:0:b0:544:b9b2:5c32 with SMTP id z36-20020a81ac64000000b00544b9b25c32mr10577610ywj.7.1680156486942; Wed, 29 Mar 2023 23:08:06 -0700 (PDT) Date: Wed, 29 Mar 2023 23:08:02 -0700 Mime-Version: 1.0 X-Mailer: git-send-email 2.40.0.348.gf938b09366-goog Message-ID: <20230329230734.BlueZ.v5.1.I21ac5a143b0e42eef4ff71ef04ef0e53a294932a@changeid> Subject: [BlueZ PATCH v5 1/2] vhci: Add support to trigger devcoredump and read the dump file From: Manish Mandlik To: marcel@holtmann.org, luiz.dentz@gmail.com Cc: linux-bluetooth@vger.kernel.org, chromeos-bluetooth-upstreaming@chromium.org, Manish Mandlik Precedence: bulk List-ID: X-Mailing-List: linux-bluetooth@vger.kernel.org Add vhci support to trigger the hci devcoredump by writing to force_devcoredump debugfs entry and read the generated devcoredump file. --- Changes in v5: - Refactor vhci_read_devcd() Changes in v4: - Split into two patches - vhci patch and mgmt-tester patch Changes in v3: - Fix compiler warning for signed comparision in test_hci_devcd() Changes in v2: - Rename function names to *_devcd emulator/vhci.c | 61 ++++++++++++++++++++++++++++++++++++++++++++++++- emulator/vhci.h | 2 ++ 2 files changed, 62 insertions(+), 1 deletion(-) diff --git a/emulator/vhci.c b/emulator/vhci.c index a12b11e0f..ecf1db3c7 100644 --- a/emulator/vhci.c +++ b/emulator/vhci.c @@ -22,6 +22,7 @@ #include #include #include +#include #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; @@ -184,7 +186,7 @@ struct btdev *vhci_get_btdev(struct vhci *vhci) return vhci->btdev; } -static int vhci_debugfs_write(struct vhci *vhci, char *option, void *data, +static int vhci_debugfs_write(struct vhci *vhci, char *option, const void *data, size_t len) { char path[64]; @@ -267,3 +269,60 @@ 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_devcd(struct vhci *vhci, const void *data, size_t len) +{ + return vhci_debugfs_write(vhci, "force_devcoredump", data, len); +} + +int vhci_read_devcd(struct vhci *vhci, void *buf, size_t size) +{ + DIR *dir; + struct dirent *entry; + char filename[PATH_MAX]; + int fd; + int ret; + + dir = opendir(DEVCORE_PATH); + if (dir == NULL) + return -errno; + + while ((entry = readdir(dir)) != NULL) { + if (strstr(entry->d_name, "devcd")) + break; + } + + if (entry == NULL) { + ret = -ENOENT; + goto close_dir; + } + + sprintf(filename, DEVCORE_PATH "/%s/data", entry->d_name); + fd = open(filename, O_RDWR); + if (fd < 0) { + ret = -errno; + goto close_dir; + } + + ret = read(fd, buf, size); + if (ret < 0) { + ret = -errno; + goto close_file; + } + + /* Once the devcoredump is read, write anything to it to mark it for + * cleanup. + */ + if (write(fd, "0", 1) < 0) { + ret = -errno; + goto close_file; + } + +close_file: + close(fd); + +close_dir: + closedir(dir); + + return ret; +} diff --git a/emulator/vhci.h b/emulator/vhci.h index 6da56cb58..68eae4c4a 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_devcd(struct vhci *vhci, const void *data, size_t len); +int vhci_read_devcd(struct vhci *vhci, void *buf, size_t size); From patchwork Thu Mar 30 06:08:03 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Manish Mandlik X-Patchwork-Id: 13193423 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id C15D6C761AF for ; Thu, 30 Mar 2023 06:08:12 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S230129AbjC3GIM (ORCPT ); Thu, 30 Mar 2023 02:08:12 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:37018 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S230091AbjC3GIL (ORCPT ); Thu, 30 Mar 2023 02:08:11 -0400 Received: from mail-pg1-x549.google.com (mail-pg1-x549.google.com [IPv6:2607:f8b0:4864:20::549]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 968D855AA for ; Wed, 29 Mar 2023 23:08:09 -0700 (PDT) Received: by mail-pg1-x549.google.com with SMTP id t12-20020a65608c000000b005091ec4f2d4so5156917pgu.20 for ; Wed, 29 Mar 2023 23:08:09 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20210112; t=1680156489; h=cc:to:from:subject:message-id:references:mime-version:in-reply-to :date:from:to:cc:subject:date:message-id:reply-to; bh=DKMfx70vP8aOdUGwEndKdp+7fg6o7JbmUDyHHJ9sQSs=; b=b57nSnAUXIXdYRos2BqkofyrDsYfiAjm1itPtpNJY5/0ymuFjJJpqPv6o9GVuCWBjH f2risgO/BMoX+OH1EbKij3eKhwXmfNiv0oTwzmx5VAJ6ejIOuuLaC8OnMZDBWUZcQDsz hgpiwr7UJjPtJLcLg5Ewi39BO9PHPvgGgtGfe7nxWNvKBqwXcFFXTHc13IbUJoJOTGmo aKluRX5iaJYXazzS3wkYdqaS0GDOE2wfaHHu1FDByAwdIe7wvZw8EERhhjYyktx/ThIN XCfMfnr5aBu0WTaKzzbBu01yOjBGFOtVtZXoIbVSAwuoZOMg6/LwNRGfoz+mlz2Qctjk NM5Q== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; t=1680156489; h=cc:to:from:subject:message-id:references:mime-version:in-reply-to :date:x-gm-message-state:from:to:cc:subject:date:message-id:reply-to; bh=DKMfx70vP8aOdUGwEndKdp+7fg6o7JbmUDyHHJ9sQSs=; b=jRVORreQvweEJ0i8bFmxDBpZ0Z24vdKtfyj0O1q2VF5HpVM6wBMHYEByHcwWz/RAl/ eRfLKHkCeregJfJlqyQG3czNuR7OxjImXQjEAmkVHxH289izNwzkgX0i5bBldr9ZLrrE e46DobdkcNKw7SWbQYCwsBfrFS3fZSCqjqYditNqN8/fO5ieH/+5F/80SxlGyijjw50P a229aANIFnNsOCBiNC+Cs5bwIVPEt7KDl1kUYH/dqC/thOxIWOTfL3pS1NzLLzmRlryA 8UAcuuFp3VsHLtyeeQx4rLuJNqlgUggtb4rzFAifNeUamGYaiLiE0TRgWDUvoUBUTpkI Rqkw== X-Gm-Message-State: AAQBX9eYRbMCDmTMjYGln4dWlVFPGD/pU9ckCgqbvbj3WRno2Ri3UrlL IToIKRBwc7r5+5yTRp5KDrT8/vF8cmaF7w== X-Google-Smtp-Source: AKy350bvryDCxkdoT/6T2nZDjHmYb8Nqyr77x2IN3iAoIn/l6bYgoph+1vKfVCt7j910RgD6epNOlYVVWkn54A== X-Received: from mmandlik-cloudtop.c.googlers.com ([fda3:e722:ac3:cc00:24:72f4:c0a8:2893]) (user=mmandlik job=sendgmr) by 2002:a17:90a:c8f:b0:240:18c9:66ba with SMTP id v15-20020a17090a0c8f00b0024018c966bamr6616394pja.6.1680156488932; Wed, 29 Mar 2023 23:08:08 -0700 (PDT) Date: Wed, 29 Mar 2023 23:08:03 -0700 In-Reply-To: <20230329230734.BlueZ.v5.1.I21ac5a143b0e42eef4ff71ef04ef0e53a294932a@changeid> Mime-Version: 1.0 References: <20230329230734.BlueZ.v5.1.I21ac5a143b0e42eef4ff71ef04ef0e53a294932a@changeid> X-Mailer: git-send-email 2.40.0.348.gf938b09366-goog Message-ID: <20230329230734.BlueZ.v5.2.I6b8d9794fa661c63824306ccc8eecf6479040b1a@changeid> Subject: [BlueZ PATCH v5 2/2] mgmt-tester: Add devcoredump tests From: Manish Mandlik To: marcel@holtmann.org, luiz.dentz@gmail.com Cc: linux-bluetooth@vger.kernel.org, chromeos-bluetooth-upstreaming@chromium.org, Manish Mandlik Precedence: bulk List-ID: X-Mailing-List: linux-bluetooth@vger.kernel.org Add mgmt-tester tests for hci devcoredump. These testa trigger the devcoredump with a test data and verifies the generated devcoredump file for the test data and correct devcoredump header fields. --- Changes in v5: - Refactor test_hci_devcd() - Add tests for devcoredump abort and timeout Changes in v4: - New patch in the series tools/mgmt-tester.c | 173 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 173 insertions(+) diff --git a/tools/mgmt-tester.c b/tools/mgmt-tester.c index a56c38173..1a8cff999 100644 --- a/tools/mgmt-tester.c +++ b/tools/mgmt-tester.c @@ -290,6 +290,20 @@ static void index_removed_callback(uint16_t index, uint16_t length, tester_post_teardown_complete(); } +#define MAX_COREDUMP_LINE_LEN 40 + +struct devcoredump_test_data { + enum devcoredump_state { + HCI_DEVCOREDUMP_IDLE, + HCI_DEVCOREDUMP_ACTIVE, + HCI_DEVCOREDUMP_DONE, + HCI_DEVCOREDUMP_ABORT, + HCI_DEVCOREDUMP_TIMEOUT, + } state; + unsigned int timeout; + char data[MAX_COREDUMP_LINE_LEN]; +}; + struct hci_cmd_data { uint16_t opcode; uint8_t len; @@ -362,6 +376,8 @@ struct generic_data { bool set_adv; const uint8_t *adv_data; uint8_t adv_data_len; + const struct devcoredump_test_data *dump_data; + const char (*expect_dump_data)[MAX_COREDUMP_LINE_LEN]; }; static const uint8_t set_exp_feat_param_debug[] = { @@ -12511,6 +12527,139 @@ static void test_suspend_resume_success_10(const void *test_data) tester_wait(2, trigger_force_resume, NULL); } +#define MAX_COREDUMP_BUF_LEN 512 + +static const struct devcoredump_test_data data_complete_dump = { + .state = HCI_DEVCOREDUMP_DONE, + .data = "test data", +}; + +static const char expected_complete_dump[][MAX_COREDUMP_LINE_LEN] = { + "Bluetooth devcoredump", + "State: 2", + "Controller Name: vhci_ctrl", + "Firmware Version: vhci_fw", + "Driver: vhci_drv", + "Vendor: vhci", + "--- Start dump ---", + "", /* end of header data */ +}; + +static const struct generic_data dump_complete = { + .dump_data = &data_complete_dump, + .expect_dump_data = expected_complete_dump, +}; + +static const struct devcoredump_test_data data_abort_dump = { + .state = HCI_DEVCOREDUMP_ABORT, + .data = "test data", +}; + +static const char expected_abort_dump[][MAX_COREDUMP_LINE_LEN] = { + "Bluetooth devcoredump", + "State: 3", + "Controller Name: vhci_ctrl", + "Firmware Version: vhci_fw", + "Driver: vhci_drv", + "Vendor: vhci", + "--- Start dump ---", + "", /* end of header data */ +}; + +static const struct generic_data dump_abort = { + .dump_data = &data_abort_dump, + .expect_dump_data = expected_abort_dump, +}; + +static const struct devcoredump_test_data data_timeout_dump = { + .state = HCI_DEVCOREDUMP_TIMEOUT, + .timeout = 1, + .data = "test data", +}; + +static const char expected_timeout_dump[][MAX_COREDUMP_LINE_LEN] = { + "Bluetooth devcoredump", + "State: 4", + "Controller Name: vhci_ctrl", + "Firmware Version: vhci_fw", + "Driver: vhci_drv", + "Vendor: vhci", + "--- Start dump ---", + "", /* end of header data */ +}; + +static const struct generic_data dump_timeout = { + .dump_data = &data_timeout_dump, + .expect_dump_data = expected_timeout_dump, +}; + +static void verify_devcd(void *user_data) +{ + struct test_data *data = tester_get_data(); + const struct generic_data *test = data->test_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; + + /* Read the generated devcoredump file */ + if (vhci_read_devcd(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 (strlen(test->expect_dump_data[i])) { + if (!line || strcmp(line, test->expect_dump_data[i])) { + tester_warn("Incorrect coredump data: %s (expected %s)", + line, test->expect_dump_data[i]); + tester_test_failed(); + return; + } + + if (!strcmp(strtok(line, ":"), "State")) { + /* 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, test->dump_data->data)) { + tester_warn("Incorrect coredump data: %s (expected %s)", line, + test->dump_data->data); + tester_test_failed(); + return; + } + + tester_test_passed(); +} + +static void test_hci_devcd(const void *test_data) +{ + struct test_data *data = tester_get_data(); + const struct generic_data *test = data->test_data; + struct vhci *vhci = hciemu_get_vhci(data->hciemu); + + /* Triggers the devcoredump */ + if (vhci_force_devcd(vhci, test->dump_data, sizeof(*test->dump_data))) { + tester_warn("Unable to set force_devcoredump"); + tester_test_failed(); + return; + } + + tester_wait(test->dump_data->timeout + 1, verify_devcd, NULL); +} + int main(int argc, char *argv[]) { tester_init(&argc, &argv); @@ -14651,5 +14800,29 @@ 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 - Dump Complete", &dump_complete, NULL, + test_hci_devcd); + + /* HCI Devcoredump + * Setup : Power on + * Run: Trigger devcoredump via force_devcoredump + * Expect: Devcoredump is generated with correct data + */ + test_bredrle("HCI Devcoredump - Dump Abort", &dump_abort, NULL, + test_hci_devcd); + + /* HCI Devcoredump + * Setup : Power on + * Run: Trigger devcoredump via force_devcoredump + * Expect: Devcoredump is generated with correct data + */ + test_bredrle_full("HCI Devcoredump - Dump Timeout", &dump_timeout, NULL, + test_hci_devcd, 3); + return tester_run(); }