From patchwork Thu Sep 30 22:37:24 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Miao-chen Chou X-Patchwork-Id: 12529431 X-Patchwork-Delegate: luiz.dentz@gmail.com 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 mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id F3524C433F5 for ; Thu, 30 Sep 2021 22:38:44 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id CD53761882 for ; Thu, 30 Sep 2021 22:38:44 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S230129AbhI3Wk1 (ORCPT ); Thu, 30 Sep 2021 18:40:27 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:36276 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229522AbhI3Wk0 (ORCPT ); Thu, 30 Sep 2021 18:40:26 -0400 Received: from mail-pl1-x62d.google.com (mail-pl1-x62d.google.com [IPv6:2607:f8b0:4864:20::62d]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 83DC4C06176A for ; Thu, 30 Sep 2021 15:38:43 -0700 (PDT) Received: by mail-pl1-x62d.google.com with SMTP id j4so3572483plx.4 for ; Thu, 30 Sep 2021 15:38:43 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=chromium.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=j2Je87Vko3wyit+AstzMdPsC02va0SIXWyF/CRHJwac=; b=LOoeiM7cGU2DqP97GzXbibf6u6J0hggjSnoIsXaGPHRFMUVGswmCYFbuQbzR0t1m0W ycKbjROv1x3dLobtUPuWQ91mRHRFBQjodTIQSZ18CFvVFP0+W6OlZmXYODKpDOMD4qc8 cpAizxoEXFgJH0/0CrWQ2gy33X2/eCiMhYn/Q= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=j2Je87Vko3wyit+AstzMdPsC02va0SIXWyF/CRHJwac=; b=fnqXxpcCSZgAHntBzTFgqEXNKxawfyroHTKXK40ToezoEJmo0DO5Uvbek4B9pXOL0V A+WjPHX/n6OTH2kyzDIpBU+v2eUK1F7Ul7Hs3WpeexwT88SfWfyvxxWwz8kVzikv2BPh 1Q23t8xQj14NBWV5j9vDpjpqPxJPCxyKhYHZhukA34XYozd0w5QvAPR0wNQW3P/1WMAq If1TKAjkUH6RmobkgKNTbUsuIGg6J+r6mKJsRim3JReyoEwsHiqOnNTLXg4eD2qP5L+V pCtg/suKHVHgwQw63McaWGrkGoLzlruuRhWgae7s61a7RTKr52GoziQx8VVJSycs8w7F 13nQ== X-Gm-Message-State: AOAM530VyZrk+qQ7/zTuGRREaRiDtdaYcxhJnyaahEBKEgTTduSGE70M y9RFQRAa6yzsoXoys8kuUWu5m3TL04NBkw== X-Google-Smtp-Source: ABdhPJy4mChvIS4uYZ0An1hWTWP/kb5Hr1y2NMQzr01Fv9TEMHBZTVOBQygpWHR9bpkJTrA+y6EFMw== X-Received: by 2002:a17:90a:4801:: with SMTP id a1mr15478468pjh.156.1633041522489; Thu, 30 Sep 2021 15:38:42 -0700 (PDT) Received: from localhost ([2620:15c:202:201:eb71:bb5c:56a6:693f]) by smtp.gmail.com with UTF8SMTPSA id i15sm4044220pgo.4.2021.09.30.15.38.41 (version=TLS1_3 cipher=TLS_AES_128_GCM_SHA256 bits=128/128); Thu, 30 Sep 2021 15:38:42 -0700 (PDT) From: Miao-chen Chou To: Bluetooth Kernel Mailing List Cc: Luiz Augusto von Dentz , Howard Chung , Alain Michaud , Marcel Holtmann , Miao-chen Chou Subject: [BlueZ PATCH v7 1/4] doc: Add errors.txt to describe errors of D-Bus method returns Date: Thu, 30 Sep 2021 15:37:24 -0700 Message-Id: <20210930153703.BlueZ.v7.1.Ide6362da19898d001b053656ee8bf76e183633d8@changeid> X-Mailer: git-send-email 2.33.0.800.g4c38ced690-goog In-Reply-To: <20210930223726.2886139-1-mcchou@chromium.org> References: <20210930223726.2886139-1-mcchou@chromium.org> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: linux-bluetooth@vger.kernel.org --- (no changes since v5) Changes in v5: - Remove the use of error codes. doc/errors.txt | 233 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 233 insertions(+) create mode 100644 doc/errors.txt diff --git a/doc/errors.txt b/doc/errors.txt new file mode 100644 index 000000000..047610c74 --- /dev/null +++ b/doc/errors.txt @@ -0,0 +1,233 @@ +D-Bus Method Return Error Codes +=============================== + +The motivation of having detailed error is to provide context-based failure +reasons along with D-Bus method return so that D-Bus clients can build metrics +and optimize their application based on these failure reasons. For instance, a +client can build retry mechanism for a connection failure or improve the +bottleneck of use scenario based on actionable metrics. + +These error codes are context-based but not necessarily tied to interface or +method calls. For instance, if a pairing request failed due to connection +failure, connection error would be attached to the method return of Pair(). + +BR/EDR connection already connected +=================================== + errno: EALREADY, EISCONN + + Either the profile is already connected or ACL connection is in place. + +BR/EDR connection page timeout +============================== + errno: EHOSTDOWN + + Failed due to page timeout. + +BR/EDR connection profile unavailable +===================================== + errno: ENOPROTOOPT + + Failed to find connectable services or the target service. + +BR/EDR connection SDP search +============================ + errno: none + + Failed to complete the SDP search. + +BR/EDR connection create socket +=============================== + errno: EIO + + Failed to create or connect to BT IO socket. This can also indicate + hardware failure in the controller. + +BR/EDR connection invalid arguments +=================================== + errno: EHOSTUNREACH + + Failed due to invalid arguments. + +BR/EDR connection not powered +============================= + errno: EHOSTUNREACH + + Failed due to adapter not powered. + +BR/EDR connection not supported +=============================== + errno: EOPNOTSUPP, EPROTONOSUPPORT + + Failed due to unsupported state transition of L2CAP channel or other + features either by the local host or the remote. + +BR/EDR connection bad socket +============================ + errno: EBADFD + + Failed due to the socket is in bad state. + +BR/EDR connection memory allocation +=================================== + errno: ENOMEM + + Failed to allocate memory in either host stack or controller. + +BR/EDR connection busy +====================== + errno: EBUSY + + Failed due to other ongoing operations, such as pairing, busy L2CAP + channel or the operation disallowed by the controller. + +BR/EDR connection concurrent connection limit +============================================= + errno: EMLINK + + Failed due to reaching the concurrent connection limit to a device. + +BR/EDR connection timeout +========================= + errno: ETIMEDOUT + + Failed due to connection timeout + +BR/EDR connection refused +========================= + errno: ECONNREFUSED + + Refused by the remote device due to limited resource, security reason + or unacceptable address type. + +BR/EDR connection aborted by remote +=================================== + errno: ECONNRESET + + Terminated by the remote device due to limited resource or power off. + +BR/EDR connection aborted by local +================================== + errno: ECONNABORTED + + Aborted by the local host. + +BR/EDR connection LMP protocol error +==================================== + errno: EPROTO + + Failed due to LMP protocol error. + +BR/EDR connection canceled +========================== + errno: none + + Failed due to cancellation caused by adapter drop, unexpected device + drop, orincoming disconnection request before connection request is + completed. + +BR/EDR connection unknown error +=============================== + errno: ENOSYS + + Failed due to unknown reason. + +LE connection invalid arguments +=============================== + errno: EINVAL + + Failed due to invalid arguments. + +LE connection not powered +========================= + errno: EHOSTUNREACH + + Failed due to adapter not powered. + +LE connection not supported +=========================== + errno: EOPNOTSUPP, EPROTONOSUPPORT + + Failed due to unsupported state transition of L2CAP channel or other + features (e.g. LE features) either by the local host or the remote. + +LE connection already connected +=============================== + errno: EALREADY, EISCONN + + Either the BT IO is already connected or LE link connection in place. + +LE connection bad socket +======================== + errno: EBADFD + + Failed due to the socket is in bad state. + +LE connection memory allocation +=============================== + errno: ENOMEM + + Failed to allocate memory in either host stack or controller. + +LE connection busy +================== + errno: EBUSY + + Failed due to other ongoing operations, such as pairing, connecting, + busy L2CAP channel or the operation disallowed by the controller. + +LE connection refused +===================== + errno: ECONNREFUSED + + Failed due to that LE is not enabled or the attempt is refused by the + remote device due to limited resource, security reason or unacceptable + address type. + +LE connection create socket +=========================== + errno: EIO + + Failed to create or connect to BT IO socket. This can also indicate + hardware failure in the controller. + +LE connection timeout +===================== + errno: ETIMEDOUT + + Failed due to connection timeout + +LE connection concurrent connection limit +========================================= + errno: EMLINK + + Failed due to reaching the synchronous connection limit to a device. + +LE connection abort by remote +============================= + errno: ECONNRESET + + Aborted by the remote device due to limited resource or power off. + +LE connection abort by local +============================ + errno: ECONNABORTED + + Aborted by the local host. + +LE connection link layer protocol error +======================================= + errno: EPROTO + + Failed due to link layer protocol error. + +LE connection GATT browsing +=========================== + errno: none + + Failed to complete the GATT browsing. + +LE connection unknown error +=========================== + errno: ENOSYS + + Failed due to unknown reason. From patchwork Thu Sep 30 22:37:26 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Miao-chen Chou X-Patchwork-Id: 12529433 X-Patchwork-Delegate: luiz.dentz@gmail.com 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 mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 2008AC433F5 for ; Thu, 30 Sep 2021 22:39:30 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 0433D61881 for ; Thu, 30 Sep 2021 22:39:29 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S230147AbhI3WlM (ORCPT ); Thu, 30 Sep 2021 18:41:12 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:36438 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229522AbhI3WlL (ORCPT ); Thu, 30 Sep 2021 18:41:11 -0400 Received: from mail-pg1-x531.google.com (mail-pg1-x531.google.com [IPv6:2607:f8b0:4864:20::531]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 9EC1CC06176A for ; Thu, 30 Sep 2021 15:39:28 -0700 (PDT) Received: by mail-pg1-x531.google.com with SMTP id 133so7680504pgb.1 for ; Thu, 30 Sep 2021 15:39:28 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=chromium.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=c7sAOsooiNrbffPynCXP0BPJZ3H+m+UWlU/LC7Z3WkU=; b=ijSF2nYTezF5fK07PLnZxyzKT+C5DIZUSE3Lxqa4rMgQZH0Dqtnicm5QZXAQ9Mv9fw V/PaQ9CQqt9kcRqYf5l+B/XXbbC9OcBUzM2A3XOQtBXIfe2LQZ7H/qLp/i4u9Olv9cCY VPk43D1Esmb3DzK4fVe/u5Mx5+j0ESOdZl2To= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=c7sAOsooiNrbffPynCXP0BPJZ3H+m+UWlU/LC7Z3WkU=; b=LpXeZIheu7VXdewVbgDyqHuiHzTwpuc7c6ZJ4cog4bP47hkg8Xxz3kB/ae0KCXQeFL wcLjwBV15doORG2hDjZiFdlTA0SyaWc1wtDH4kfRFVMHTbj7olZ+ja8JPrTN6hijxucR OU64jU40euK9CO+QT6mu4q9ztaMKrtJbbP77X3ncCsgx0I9LrhTofM/RLXqa1PQPxkSp jE6E0OgDfwJ38DFtuomV4VnyHJb/XYQWp41wmISJcWRgPrncbP/3VJ8Wxqyhg89jZ4C9 jQxQe+f/mHFjic6mWmO2q8cOQ64TQa0pfVba5b7PVUqz88ZHwt0uDpXOObe4oyWd1rv8 K0Vg== X-Gm-Message-State: AOAM530HdpV5VJ2QtKXQUwH9NoaEII4gs2nXlespWpXI/K0AF2ATqjCF O2PppHHFNLVOeOmFxJAeL26vzY3E2yQdHA== X-Google-Smtp-Source: ABdhPJwZS6egLzb0wT6u4+ASf/7piSQLSJ0o4I78IapBifVBgRcFCChrN4XJI2CZjJnUT8htDP2DeQ== X-Received: by 2002:a05:6a00:130c:b0:444:f9d4:d800 with SMTP id j12-20020a056a00130c00b00444f9d4d800mr8062707pfu.38.1633041567733; Thu, 30 Sep 2021 15:39:27 -0700 (PDT) Received: from localhost ([2620:15c:202:201:eb71:bb5c:56a6:693f]) by smtp.gmail.com with UTF8SMTPSA id 18sm3996860pfi.60.2021.09.30.15.39.26 (version=TLS1_3 cipher=TLS_AES_128_GCM_SHA256 bits=128/128); Thu, 30 Sep 2021 15:39:27 -0700 (PDT) From: Miao-chen Chou To: Bluetooth Kernel Mailing List Cc: Luiz Augusto von Dentz , Howard Chung , Alain Michaud , Marcel Holtmann , Miao-chen Chou Subject: [BlueZ PATCH v7 2/4] error: BR/EDR and LE connection failure reasons Date: Thu, 30 Sep 2021 15:37:26 -0700 Message-Id: <20210930153703.BlueZ.v7.2.If79c3f0720cc893be1770c6853fe2fbe626f2caa@changeid> X-Mailer: git-send-email 2.33.0.800.g4c38ced690-goog In-Reply-To: <20210930223726.2886139-1-mcchou@chromium.org> References: <20210930223726.2886139-1-mcchou@chromium.org> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: linux-bluetooth@vger.kernel.org The source of Connect() failures can be divided into the following three. - bluetoothd's device interface state transition and profile state transition - Kernel's L2CAP layer state transition - Potential HCI error codes returned by the remote device Reviewed-by: Alain Michaud Reviewed-by: Howard Chung --- Changes in v7: - Fix nits. Changes in v6: - Rephrase error strings. Changes in v5: - Replace uint16_t error code with string Changes in v4: - Address make errors Changes in v3: - Separate error-code.txt into its own commit Changes in v2: - Add error-code.txt - Remove BtdError from return string src/error.c | 100 ++++++++++++++++++++++++++++++++++++++++++++++++++++ src/error.h | 57 ++++++++++++++++++++++++++++++ 2 files changed, 157 insertions(+) diff --git a/src/error.c b/src/error.c index dd85cd288..29c071067 100644 --- a/src/error.c +++ b/src/error.c @@ -14,6 +14,8 @@ #include #endif +#include +#include #include "gdbus/gdbus.h" #include "error.h" @@ -66,12 +68,24 @@ DBusMessage *btd_error_in_progress(DBusMessage *msg) "In Progress"); } +DBusMessage *btd_error_in_progress_str(DBusMessage *msg, const char *str) +{ + return g_dbus_create_error(msg, ERROR_INTERFACE ".InProgress", + "%s", str); +} + DBusMessage *btd_error_not_available(DBusMessage *msg) { return g_dbus_create_error(msg, ERROR_INTERFACE ".NotAvailable", "Operation currently not available"); } +DBusMessage *btd_error_not_available_str(DBusMessage *msg, const char *str) +{ + return g_dbus_create_error(msg, ERROR_INTERFACE ".NotAvailable", + "%s", str); +} + DBusMessage *btd_error_does_not_exist(DBusMessage *msg) { return g_dbus_create_error(msg, ERROR_INTERFACE ".DoesNotExist", @@ -108,8 +122,94 @@ DBusMessage *btd_error_not_ready(DBusMessage *msg) "Resource Not Ready"); } +DBusMessage *btd_error_not_ready_str(DBusMessage *msg, const char *str) +{ + return g_dbus_create_error(msg, ERROR_INTERFACE ".NotReady", + "%s", str); +} + DBusMessage *btd_error_failed(DBusMessage *msg, const char *str) { return g_dbus_create_error(msg, ERROR_INTERFACE ".Failed", "%s", str); } + +const char *btd_error_bredr_conn_from_errno(int errno_code) +{ + switch (-errno_code) { + case EALREADY: + case EISCONN: + return ERR_BREDR_CONN_ALREADY_CONNECTED; + case EHOSTDOWN: + return ERR_BREDR_CONN_PAGE_TIMEOUT; + case ENOPROTOOPT: + return ERR_BREDR_CONN_PROFILE_UNAVAILABLE; + case EIO: + return ERR_BREDR_CONN_CREATE_SOCKET; + case EINVAL: + return ERR_BREDR_CONN_INVALID_ARGUMENTS; + case EHOSTUNREACH: + return ERR_BREDR_CONN_ADAPTER_NOT_POWERED; + case EOPNOTSUPP: + case EPROTONOSUPPORT: + return ERR_BREDR_CONN_NOT_SUPPORTED; + case EBADFD: + return ERR_BREDR_CONN_BAD_SOCKET; + case ENOMEM: + return ERR_BREDR_CONN_MEMORY_ALLOC; + case EBUSY: + return ERR_BREDR_CONN_BUSY; + case EMLINK: + return ERR_BREDR_CONN_CNCR_CONNECT_LIMIT; + case ETIMEDOUT: + return ERR_BREDR_CONN_TIMEOUT; + case ECONNREFUSED: + return ERR_BREDR_CONN_REFUSED; + case ECONNRESET: + return ERR_BREDR_CONN_ABORT_BY_REMOTE; + case ECONNABORTED: + return ERR_BREDR_CONN_ABORT_BY_LOCAL; + case EPROTO: + return ERR_BREDR_CONN_LMP_PROTO_ERROR; + default: + return ERR_BREDR_CONN_UNKNOWN; + } +} + +const char *btd_error_le_conn_from_errno(int errno_code) +{ + switch (-errno_code) { + case EINVAL: + return ERR_LE_CONN_INVALID_ARGUMENTS; + case EHOSTUNREACH: + return ERR_LE_CONN_ADAPTER_NOT_POWERED; + case EOPNOTSUPP: + case EPROTONOSUPPORT: + return ERR_LE_CONN_NOT_SUPPORTED; + case EALREADY: + case EISCONN: + return ERR_LE_CONN_ALREADY_CONNECTED; + case EBADFD: + return ERR_LE_CONN_BAD_SOCKET; + case ENOMEM: + return ERR_LE_CONN_MEMORY_ALLOC; + case EBUSY: + return ERR_LE_CONN_BUSY; + case ECONNREFUSED: + return ERR_LE_CONN_REFUSED; + case EIO: + return ERR_LE_CONN_CREATE_SOCKET; + case ETIMEDOUT: + return ERR_LE_CONN_TIMEOUT; + case EMLINK: + return ERR_LE_CONN_SYNC_CONNECT_LIMIT; + case ECONNRESET: + return ERR_LE_CONN_ABORT_BY_REMOTE; + case ECONNABORTED: + return ERR_LE_CONN_ABORT_BY_LOCAL; + case EPROTO: + return ERR_LE_CONN_LL_PROTO_ERROR; + default: + return ERR_LE_CONN_UNKNOWN; + } +} diff --git a/src/error.h b/src/error.h index 7fcddaf4a..dded9f93d 100644 --- a/src/error.h +++ b/src/error.h @@ -11,9 +11,60 @@ */ #include +#include #define ERROR_INTERFACE "org.bluez.Error" +/* BR/EDR connection failure reasons */ +#define ERR_BREDR_CONN_ALREADY_CONNECTED "br-connection-already-"\ + "connected" +#define ERR_BREDR_CONN_PAGE_TIMEOUT "br-connection-page-timeout" +#define ERR_BREDR_CONN_PROFILE_UNAVAILABLE "br-connection-profile-"\ + "unavailable" +#define ERR_BREDR_CONN_SDP_SEARCH "br-connection-sdp-search" +#define ERR_BREDR_CONN_CREATE_SOCKET "br-connection-create-socket" +#define ERR_BREDR_CONN_INVALID_ARGUMENTS "br-connection-invalid-"\ + "argument" +#define ERR_BREDR_CONN_ADAPTER_NOT_POWERED "br-connection-adapter-not-"\ + "powered" +#define ERR_BREDR_CONN_NOT_SUPPORTED "br-connection-not-suuported" +#define ERR_BREDR_CONN_BAD_SOCKET "br-connection-bad-socket" +#define ERR_BREDR_CONN_MEMORY_ALLOC "br-connection-memory-"\ + "allocation" +#define ERR_BREDR_CONN_BUSY "br-connection-busy" +#define ERR_BREDR_CONN_CNCR_CONNECT_LIMIT "br-connection-concurrent-"\ + "connection-limit" +#define ERR_BREDR_CONN_TIMEOUT "br-connection-timeout" +#define ERR_BREDR_CONN_REFUSED "br-connection-refused" +#define ERR_BREDR_CONN_ABORT_BY_REMOTE "br-connection-aborted-by-"\ + "remote" +#define ERR_BREDR_CONN_ABORT_BY_LOCAL "br-connection-aborted-by-"\ + "local" +#define ERR_BREDR_CONN_LMP_PROTO_ERROR "br-connection-lmp-protocol-"\ + "error" +#define ERR_BREDR_CONN_CANCELED "br-connection-canceled" +#define ERR_BREDR_CONN_UNKNOWN "br-connection-unknown" + +/* LE connection failure reasons */ +#define ERR_LE_CONN_INVALID_ARGUMENTS "le-connection-invalid-arguments" +#define ERR_LE_CONN_ADAPTER_NOT_POWERED "le-connection-adapter-not-powered" +#define ERR_LE_CONN_NOT_SUPPORTED "le-connection-not-supported" +#define ERR_LE_CONN_ALREADY_CONNECTED "le-connection-already-connected" +#define ERR_LE_CONN_BAD_SOCKET "le-connection-bad-socket" +#define ERR_LE_CONN_MEMORY_ALLOC "le-connection-memory-allocation" +#define ERR_LE_CONN_BUSY "le-connection-busy" +#define ERR_LE_CONN_REFUSED "le-connection-refused" +#define ERR_LE_CONN_CREATE_SOCKET "le-connection-create-socket" +#define ERR_LE_CONN_TIMEOUT "le-connection-timeout" +#define ERR_LE_CONN_SYNC_CONNECT_LIMIT "le-connection-concurrent-connection-"\ + "limit" +#define ERR_LE_CONN_ABORT_BY_REMOTE "le-connection-abort-by-remote" +#define ERR_LE_CONN_ABORT_BY_LOCAL "le-connection-abort-by-local" +#define ERR_LE_CONN_LL_PROTO_ERROR "le-connection-link-layer-protocol-"\ + "error" +#define ERR_LE_CONN_GATT_BROWSE "le-connection-gatt-browsing" +#define ERR_LE_CONN_UNKNOWN "le-connection-unknown" + DBusMessage *btd_error_invalid_args(DBusMessage *msg); DBusMessage *btd_error_invalid_args_str(DBusMessage *msg, const char *str); DBusMessage *btd_error_busy(DBusMessage *msg); @@ -22,11 +73,17 @@ DBusMessage *btd_error_not_supported(DBusMessage *msg); DBusMessage *btd_error_not_connected(DBusMessage *msg); DBusMessage *btd_error_already_connected(DBusMessage *msg); DBusMessage *btd_error_not_available(DBusMessage *msg); +DBusMessage *btd_error_not_available_str(DBusMessage *msg, const char *str); DBusMessage *btd_error_in_progress(DBusMessage *msg); +DBusMessage *btd_error_in_progress_str(DBusMessage *msg, const char *str); DBusMessage *btd_error_does_not_exist(DBusMessage *msg); DBusMessage *btd_error_not_authorized(DBusMessage *msg); DBusMessage *btd_error_not_permitted(DBusMessage *msg, const char *str); DBusMessage *btd_error_no_such_adapter(DBusMessage *msg); DBusMessage *btd_error_agent_not_available(DBusMessage *msg); DBusMessage *btd_error_not_ready(DBusMessage *msg); +DBusMessage *btd_error_not_ready_str(DBusMessage *msg, const char *str); DBusMessage *btd_error_failed(DBusMessage *msg, const char *str); + +const char *btd_error_bredr_conn_from_errno(int errno_code); +const char *btd_error_le_conn_from_errno(int errno_code); From patchwork Thu Sep 30 22:37:28 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Miao-chen Chou X-Patchwork-Id: 12529435 X-Patchwork-Delegate: luiz.dentz@gmail.com 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 mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 9F20FC433F5 for ; Thu, 30 Sep 2021 22:40:03 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 8458461881 for ; Thu, 30 Sep 2021 22:40:03 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1346643AbhI3Wlp (ORCPT ); Thu, 30 Sep 2021 18:41:45 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:36578 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1346146AbhI3Wlp (ORCPT ); Thu, 30 Sep 2021 18:41:45 -0400 Received: from mail-pg1-x535.google.com (mail-pg1-x535.google.com [IPv6:2607:f8b0:4864:20::535]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 10AC2C06176A for ; Thu, 30 Sep 2021 15:40:02 -0700 (PDT) Received: by mail-pg1-x535.google.com with SMTP id s11so7645162pgr.11 for ; Thu, 30 Sep 2021 15:40:02 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=chromium.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=/VyUR7d30EIw3pm2R8uPCDjdAE0eBCZ4IJjyqGZIsN0=; b=HAtAMPFgkXHBcrKDLR6e8FaKH/DssOme/MEIm+RE3IpAVTDSAHc5sfd5f5pJB1jaHg vPucixhijbL9LqFikIVkxq5TyS9ivDNnVB6m9e5h+ywbPxzq1XqXXOO7ydnMy/fuHx0v M0MVnDauL66cARrz2BOw+BHy0cT/9A7p6hCRI= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=/VyUR7d30EIw3pm2R8uPCDjdAE0eBCZ4IJjyqGZIsN0=; b=BVffoR0rpZQiHEv9zHbdiqIaEgrdVUxr9At4A8skw27iAaFQdVgGARWPLkjqexsZeA ThyypAAwk0++1SmGBLF3wLlMB02J9LLCHGy95sxIeZjlCtZMf9UrZXjjDegTZKhWWPid WoDQJLa6ujsqiOUam9zYTVxOXBbiOEOxkinPygH3DCWWCK2WVmCoFiqifBCyyrUWf/Bd qeCxhC393fQFKsStLZ7KrvE290BfxOWMy9OtAGLwgcQAO85h2buDeUTbPtexbMb9iEW/ E9rVwkAJQ/wduFL3YHY/r6AscvORlJRkOGqoTosU1wiEWjg+VXtqhTIgLjjEBcW/LPj/ mxww== X-Gm-Message-State: AOAM531OoRxySueTY/A508rMHm+yOtQLQhAQ3bK1NcdWVNhPh4/8sjOD fdbuarydYmiK2ZG2y4nCdcdBNu5DUyaPvg== X-Google-Smtp-Source: ABdhPJw8rA+QU83NWK4qm0DC8cpTgZFQ+soHu55gwxAYFyxbRGftGgAurLcxvcUOCq7RhXhIrtPn5Q== X-Received: by 2002:aa7:92d2:0:b0:44b:566e:ec5 with SMTP id k18-20020aa792d2000000b0044b566e0ec5mr6653017pfa.30.1633041601238; Thu, 30 Sep 2021 15:40:01 -0700 (PDT) Received: from localhost ([2620:15c:202:201:eb71:bb5c:56a6:693f]) by smtp.gmail.com with UTF8SMTPSA id g22sm4999328pfj.15.2021.09.30.15.40.00 (version=TLS1_3 cipher=TLS_AES_128_GCM_SHA256 bits=128/128); Thu, 30 Sep 2021 15:40:00 -0700 (PDT) From: Miao-chen Chou To: Bluetooth Kernel Mailing List Cc: Luiz Augusto von Dentz , Howard Chung , Alain Michaud , Marcel Holtmann , Miao-chen Chou Subject: [BlueZ PATCH v7 3/4] device: Include detailed error string in Connect() return Date: Thu, 30 Sep 2021 15:37:28 -0700 Message-Id: <20210930153703.BlueZ.v7.3.Idd761b9b9f4620480db8889e7885a17952c2c13a@changeid> X-Mailer: git-send-email 2.33.0.800.g4c38ced690-goog In-Reply-To: <20210930223726.2886139-1-mcchou@chromium.org> References: <20210930223726.2886139-1-mcchou@chromium.org> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: linux-bluetooth@vger.kernel.org This replaces generic strerror message with context detailed error string to better indicate the detailed failure reason so that the D-Bus clients can optimize their application to work better with BlueZ, e.g. introducing retry mechanism or building metrics. Reviewed-by: Alain Michaud Reviewed-by: Howard Chung --- (no changes since v5) Changes in v5: - Address the changes from error code to string src/device.c | 46 ++++++++++++++++++++++++++++++---------------- 1 file changed, 30 insertions(+), 16 deletions(-) diff --git a/src/device.c b/src/device.c index b29aa195d..230274ee1 100644 --- a/src/device.c +++ b/src/device.c @@ -1605,7 +1605,7 @@ void device_request_disconnect(struct btd_device *device, DBusMessage *msg) if (device->connect) { DBusMessage *reply = btd_error_failed(device->connect, - "Cancelled"); + ERR_BREDR_CONN_CANCELED); g_dbus_send_message(dbus_conn, reply); dbus_message_unref(device->connect); device->connect = NULL; @@ -1799,7 +1799,8 @@ done: } g_dbus_send_message(dbus_conn, - btd_error_failed(dev->connect, strerror(-err))); + btd_error_failed(dev->connect, + btd_error_bredr_conn_from_errno(err))); } else { /* Start passive SDP discovery to update known services */ if (dev->bredr && !dev->svc_refreshed && dev->refresh_discovery) @@ -2000,10 +2001,12 @@ static DBusMessage *connect_profiles(struct btd_device *dev, uint8_t bdaddr_type dbus_message_get_sender(msg)); if (dev->pending || dev->connect || dev->browse) - return btd_error_in_progress(msg); + return btd_error_in_progress_str(msg, ERR_BREDR_CONN_BUSY); - if (!btd_adapter_get_powered(dev->adapter)) - return btd_error_not_ready(msg); + if (!btd_adapter_get_powered(dev->adapter)) { + return btd_error_not_ready_str(msg, + ERR_BREDR_CONN_ADAPTER_NOT_POWERED); + } btd_device_set_temporary(dev, false); @@ -2016,10 +2019,12 @@ static DBusMessage *connect_profiles(struct btd_device *dev, uint8_t bdaddr_type if (dbus_message_is_method_call(msg, DEVICE_INTERFACE, "Connect") && find_service_with_state(dev->services, - BTD_SERVICE_STATE_CONNECTED)) + BTD_SERVICE_STATE_CONNECTED)) { return dbus_message_new_method_return(msg); - else - return btd_error_not_available(msg); + } else { + return btd_error_not_available_str(msg, + ERR_BREDR_CONN_PROFILE_UNAVAILABLE); + } } goto resolve_services; @@ -2029,7 +2034,8 @@ static DBusMessage *connect_profiles(struct btd_device *dev, uint8_t bdaddr_type if (err < 0) { if (err == -EALREADY) return dbus_message_new_method_return(msg); - return btd_error_failed(msg, strerror(-err)); + return btd_error_failed(msg, + btd_error_bredr_conn_from_errno(err)); } dev->connect = dbus_message_ref(msg); @@ -2043,8 +2049,10 @@ resolve_services: err = device_browse_sdp(dev, msg); else err = device_browse_gatt(dev, msg); - if (err < 0) - return btd_error_failed(msg, strerror(-err)); + if (err < 0) { + return btd_error_failed(msg, bdaddr_type == BDADDR_BREDR ? + ERR_BREDR_CONN_SDP_SEARCH : ERR_LE_CONN_GATT_BROWSE); + } return NULL; } @@ -2154,8 +2162,10 @@ static DBusMessage *connect_profile(DBusConnection *conn, DBusMessage *msg, DBusMessage *reply; if (!dbus_message_get_args(msg, NULL, DBUS_TYPE_STRING, &pattern, - DBUS_TYPE_INVALID)) - return btd_error_invalid_args(msg); + DBUS_TYPE_INVALID)) { + return btd_error_invalid_args_str(msg, + ERR_BREDR_CONN_INVALID_ARGUMENTS); + } uuid = bt_name2string(pattern); reply = connect_profiles(dev, BDADDR_BREDR, msg, uuid); @@ -2538,7 +2548,10 @@ static void browse_request_complete(struct browse_req *req, uint8_t type, if (err == 0) goto done; } - reply = btd_error_failed(req->msg, strerror(-err)); + reply = btd_error_failed(req->msg, + bdaddr_type == BDADDR_BREDR ? + btd_error_bredr_conn_from_errno(err) : + btd_error_le_conn_from_errno(err)); goto done; } @@ -3030,7 +3043,8 @@ void device_remove_connection(struct btd_device *device, uint8_t bdaddr_type) */ if (device->connect) { DBG("connection removed while Connect() is waiting reply"); - reply = btd_error_failed(device->connect, "Disconnected early"); + reply = btd_error_failed(device->connect, + ERR_BREDR_CONN_CANCELED); g_dbus_send_message(dbus_conn, reply); dbus_message_unref(device->connect); device->connect = NULL; @@ -5454,7 +5468,7 @@ done: if (device->connect) { if (err < 0) reply = btd_error_failed(device->connect, - strerror(-err)); + btd_error_le_conn_from_errno(err)); else reply = dbus_message_new_method_return(device->connect); From patchwork Thu Sep 30 22:37:30 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Miao-chen Chou X-Patchwork-Id: 12529437 X-Patchwork-Delegate: luiz.dentz@gmail.com 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 mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 26616C433EF for ; Thu, 30 Sep 2021 22:40:21 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 0D3C761881 for ; Thu, 30 Sep 2021 22:40:21 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1347011AbhI3WmD (ORCPT ); Thu, 30 Sep 2021 18:42:03 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:36662 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1344223AbhI3WmC (ORCPT ); Thu, 30 Sep 2021 18:42:02 -0400 Received: from mail-pj1-x1033.google.com (mail-pj1-x1033.google.com [IPv6:2607:f8b0:4864:20::1033]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 38404C06176A for ; Thu, 30 Sep 2021 15:40:19 -0700 (PDT) Received: by mail-pj1-x1033.google.com with SMTP id d13-20020a17090ad3cd00b0019e746f7bd4so7879997pjw.0 for ; Thu, 30 Sep 2021 15:40:19 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=chromium.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=rjn9c0A5xnGmuwQVHBsbF23LWzIh1tZ303XgwzxsFVo=; b=k6dI6bo1ZhPKLy3t7nJcqP/fPMjhac+aeEcFAw1zIcuXvPrjqfv3pJKXDMXvuzzN5b o8GvaaEalL2RHMrjlYZ+DLTjmwFNUhRxscy5GHv+tQVYhYzUnLfriy9BfN1QZruS1kfA 1YFarVxEIAPmxujSmoe6WLbPlT8GnJ0i/vZrs= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=rjn9c0A5xnGmuwQVHBsbF23LWzIh1tZ303XgwzxsFVo=; b=6ecXmO0Nu2VmekMaFHxyvB90/Pe7ojjb9VKhYZrzX8fI8hWGdg6q014M0bCUdEdkNa aS3QVRAW1xyD6FrnqsxNcrWe7T6EvArZKgvyTIPyDPOEpHi4ThwvtwLA79eq1bUNdbsU 7oFaT22slE/Gu2y4JwCX7fKF0DF63f18q6zRZjELhdo+RxAdIbit260MPQ341HZ998G3 WTp6dHov2qPE3L1mQdHe5tS3ar3XbFxnqWjcp5a5pNJ7L2G0QE6uAZ6areMS2/RtYt+S 9ICBi/1WVGcMyYZxIr9FdJ/3fVYshFS3ar6Awebkql6mwwQReNprp6MQnFAiI5JbHYhR uBtg== X-Gm-Message-State: AOAM533JoS8AVbuJfXat1I5ThlmbSfPueMlbqS/Y+sLf2cCRrzHCIB93 5LbkqTj4tzfpkweSRIvmlc2nQIjyeKb7Ag== X-Google-Smtp-Source: ABdhPJxwyO/aDLcO8Ucea5buNmsf2ADivgQQ3SHwdbGFFRYsUSE9X8CUFskUk6bZev065O6Xp1ltrQ== X-Received: by 2002:a17:90a:de83:: with SMTP id n3mr12361821pjv.29.1633041618438; Thu, 30 Sep 2021 15:40:18 -0700 (PDT) Received: from localhost ([2620:15c:202:201:eb71:bb5c:56a6:693f]) by smtp.gmail.com with UTF8SMTPSA id 26sm4541206pgx.72.2021.09.30.15.40.17 (version=TLS1_3 cipher=TLS_AES_128_GCM_SHA256 bits=128/128); Thu, 30 Sep 2021 15:40:17 -0700 (PDT) From: Miao-chen Chou To: Bluetooth Kernel Mailing List Cc: Luiz Augusto von Dentz , Howard Chung , Alain Michaud , Marcel Holtmann , Miao-chen Chou Subject: [BlueZ PATCH v7 4/4] client: Print error code for connect methods Date: Thu, 30 Sep 2021 15:37:30 -0700 Message-Id: <20210930153703.BlueZ.v7.4.I226fdcdd12b13e4875c8cd03b42fc52283920cc4@changeid> X-Mailer: git-send-email 2.33.0.800.g4c38ced690-goog In-Reply-To: <20210930223726.2886139-1-mcchou@chromium.org> References: <20210930223726.2886139-1-mcchou@chromium.org> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: linux-bluetooth@vger.kernel.org The following steps were performed. - Issuing repeated commands to connect the same BLE device. - Verifying the print in bluetoothctl console Reviewed-by: Alain Michaud Reviewed-by: Howard Chung --- Changes in v7: - Fix nits Changes in v6: - Rephrase error string Changes in v5: - Replace error code with error string Changes in v4: - Address make errors. Changes in v3: - Correct error-codes.txt. Changes in v2: - Add documentation for error codes client/main.c | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/client/main.c b/client/main.c index c1a62edb7..61650c289 100644 --- a/client/main.c +++ b/client/main.c @@ -1966,7 +1966,8 @@ static void connect_reply(DBusMessage *message, void *user_data) dbus_error_init(&error); if (dbus_set_error_from_message(&error, message) == TRUE) { - bt_shell_printf("Failed to connect: %s\n", error.name); + bt_shell_printf("Failed to connect: %s %s\n", error.name, + error.message); dbus_error_free(&error); return bt_shell_noninteractive_quit(EXIT_FAILURE); }