diff mbox series

[BlueZ,v5,2/4] error: BR/EDR and LE connection failure reasons

Message ID 20210806164624.BlueZ.v5.2.If79c3f0720cc893be1770c6853fe2fbe626f2caa@changeid (mailing list archive)
State New, archived
Headers show
Series Detailed error string | expand

Commit Message

Miao-chen Chou Aug. 6, 2021, 11:47 p.m. UTC 
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 <alainm@chromium.org>
Reviewed-by: Howard Chung <howardchung@google.com>
---

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 |  59 +++++++++++++++++++++++++++++++
 2 files changed, 159 insertions(+)

Comments

Marcel Holtmann Aug. 9, 2021, 1:32 p.m. UTC | #1 
Hi Miao-chen,

> 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 <alainm@chromium.org>
> Reviewed-by: Howard Chung <howardchung@google.com>
> ---
> 
> 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 |  59 +++++++++++++++++++++++++++++++
> 2 files changed, 159 insertions(+)
> 
> diff --git a/src/error.c b/src/error.c
> index 89517075e..411f36fcb 100644
> --- a/src/error.c
> +++ b/src/error.c
> @@ -27,6 +27,8 @@
> #include <config.h>
> #endif
> 
> +#include <error.h>
> +#include <stdio.h>
> #include "gdbus/gdbus.h"
> 
> #include "error.h"
> @@ -79,12 +81,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",
> @@ -121,8 +135,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 7c8cad066..91a02654a 100644
> --- a/src/error.h
> +++ b/src/error.h
> @@ -24,9 +24,62 @@
>  */
> 
> #include <dbus/dbus.h>
> +#include <stdint.h>
> 
> #define ERROR_INTERFACE "org.bluez.Error"
> 
> +/* BR/EDR connection failure reasons */
> +#define ERR_BREDR_CONN_ALREADY_CONNECTED	"BR/EDR connection already "\
> +						"connected"
> +#define ERR_BREDR_CONN_PAGE_TIMEOUT		"BR/EDR connection page timeout"
> +#define ERR_BREDR_CONN_PROFILE_UNAVAILABLE	"BR/EDR connection profile "\
> +						"unavailable"
> +#define ERR_BREDR_CONN_SDP_SEARCH		"BR/EDR connection SDP search"
> +#define ERR_BREDR_CONN_CREATE_SOCKET		"BR/EDR connection create "\
> +						"socket"
> +#define ERR_BREDR_CONN_INVALID_ARGUMENTS	"BR/EDR connection invalid "\
> +						"argument"
> +#define ERR_BREDR_CONN_ADAPTER_NOT_POWERED	"BR/EDR connection adapter "\
> +						"not powered"
> +#define ERR_BREDR_CONN_NOT_SUPPORTED		"BR/EDR connection not "\
> +						"suuported"
> +#define ERR_BREDR_CONN_BAD_SOCKET		"BR/EDR connection bad socket"
> +#define ERR_BREDR_CONN_MEMORY_ALLOC		"BR/EDR connection memory "\
> +						"allocation"
> +#define ERR_BREDR_CONN_BUSY			"BR/EDR connection busy"
> +#define ERR_BREDR_CONN_CNCR_CONNECT_LIMIT	"BR/EDR connection concurrent "\
> +						"connection limit"
> +#define ERR_BREDR_CONN_TIMEOUT			"BR/EDR connection timeout"
> +#define ERR_BREDR_CONN_REFUSED			"BR/EDR connection refused"
> +#define ERR_BREDR_CONN_ABORT_BY_REMOTE		"BR/EDR connection aborted by "\
> +						"remote"
> +#define ERR_BREDR_CONN_ABORT_BY_LOCAL		"BR/EDR connection aborted by "\
> +						"local"
> +#define ERR_BREDR_CONN_LMP_PROTO_ERROR		"BR/EDR connection LMP "\
> +						"protocol error"
> +#define ERR_BREDR_CONN_CANCELED			"BR/EDR connection canceled"
> +#define ERR_BREDR_CONN_UNKNOWN			"BR/EDR 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"

I rather have you use strings like “le-connection-not-supported” to make this similar to what we are using for other strings in the API.

And I am always torn between using “bredr-“ and just using “br-“.

Regards

Marcel
diff mbox series

Patch

diff --git a/src/error.c b/src/error.c
index 89517075e..411f36fcb 100644
--- a/src/error.c
+++ b/src/error.c
@@ -27,6 +27,8 @@ 
 #include <config.h>
 #endif
 
+#include <error.h>
+#include <stdio.h>
 #include "gdbus/gdbus.h"
 
 #include "error.h"
@@ -79,12 +81,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",
@@ -121,8 +135,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 7c8cad066..91a02654a 100644
--- a/src/error.h
+++ b/src/error.h
@@ -24,9 +24,62 @@ 
  */
 
 #include <dbus/dbus.h>
+#include <stdint.h>
 
 #define ERROR_INTERFACE "org.bluez.Error"
 
+/* BR/EDR connection failure reasons */
+#define ERR_BREDR_CONN_ALREADY_CONNECTED	"BR/EDR connection already "\
+						"connected"
+#define ERR_BREDR_CONN_PAGE_TIMEOUT		"BR/EDR connection page timeout"
+#define ERR_BREDR_CONN_PROFILE_UNAVAILABLE	"BR/EDR connection profile "\
+						"unavailable"
+#define ERR_BREDR_CONN_SDP_SEARCH		"BR/EDR connection SDP search"
+#define ERR_BREDR_CONN_CREATE_SOCKET		"BR/EDR connection create "\
+						"socket"
+#define ERR_BREDR_CONN_INVALID_ARGUMENTS	"BR/EDR connection invalid "\
+						"argument"
+#define ERR_BREDR_CONN_ADAPTER_NOT_POWERED	"BR/EDR connection adapter "\
+						"not powered"
+#define ERR_BREDR_CONN_NOT_SUPPORTED		"BR/EDR connection not "\
+						"suuported"
+#define ERR_BREDR_CONN_BAD_SOCKET		"BR/EDR connection bad socket"
+#define ERR_BREDR_CONN_MEMORY_ALLOC		"BR/EDR connection memory "\
+						"allocation"
+#define ERR_BREDR_CONN_BUSY			"BR/EDR connection busy"
+#define ERR_BREDR_CONN_CNCR_CONNECT_LIMIT	"BR/EDR connection concurrent "\
+						"connection limit"
+#define ERR_BREDR_CONN_TIMEOUT			"BR/EDR connection timeout"
+#define ERR_BREDR_CONN_REFUSED			"BR/EDR connection refused"
+#define ERR_BREDR_CONN_ABORT_BY_REMOTE		"BR/EDR connection aborted by "\
+						"remote"
+#define ERR_BREDR_CONN_ABORT_BY_LOCAL		"BR/EDR connection aborted by "\
+						"local"
+#define ERR_BREDR_CONN_LMP_PROTO_ERROR		"BR/EDR connection LMP "\
+						"protocol error"
+#define ERR_BREDR_CONN_CANCELED			"BR/EDR connection canceled"
+#define ERR_BREDR_CONN_UNKNOWN			"BR/EDR 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);
@@ -35,11 +88,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);