org.bluez.Device1: Add GetServiceRecords method to get a device's SDP records.
cover org.bluez.Device1: Add GetServiceRecords method to get a device's SDP records.
This series adds an experimental DBus API to get BR/EDR service records for devices. The method will be used to implement a part of the Windows Bluetooth API in Wine, which allows accessing a device's service records. The documentation clarifies that the method is only meant for compatibility purposes, and purposefully returns raw SDP records to discourage general applications from using the API.
Vibhav Pant (2):
device: Add method GetServiceRecords org.bluez.Device: Add documentation for GetServiceRecords()
doc/org.bluez.Device.rst | 19 +++++++++ src/device.c | 83 ++++++++++++++++++++++++++++++++++++++++ 2 files changed, 102 insertions(+)
Signature · 1 line
2.46.0
PATCH 1/2 device: Add method GetServiceRecords
GetServiceRecords returns all currently known BR/EDR service records for the device, as an array of array of bytes. Each individual byte array represents a raw SDP record, as defined by the Bluetooth Service Discovery Protocol spec.
This method is intended to be only used by compatibility layers like Wine, that need to provide access to raw SDP records to implement the Win32 Bluetooth API. Applications should instead use the Profile API for services-related functionality.
--- src/device.c | 83 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 83 insertions(+)
src/device.c +83 -0
@@ -3215,6 +3215,86 @@ static DBusMessage *cancel_pairing(DBusConnection *conn, DBusMessage *msg,return dbus_message_new_method_return (msg); } +static sdp_list_t *read_device_records (struct btd_device *device); + +static DBusMessage *get_service_records (DBusConnection *conn,DBusMessage *msg, +void *data) +{ +DBusMessage *reply; +DBusMessageIter records_arr, record; +struct btd_device *device = data; +sdp_list_t *cur; + +if (!btd_adapter_get_powered (device->adapter)) +return btd_error_not_ready (msg); + +if (!btd_device_is_connected (device)) +return btd_error_not_connected (msg); + +if (!device->bredr_state.svc_resolved) +return btd_error_not_ready (msg); + +if (!device->tmp_records) { + device->tmp_records =read_device_records (device); +if (!device->tmp_records) +return btd_error_does_not_exist (msg); + } + + reply =dbus_message_new_method_return (msg); +if (!reply) +return btd_error_failed (msg,"Could not create method reply" ); + +dbus_message_iter_init_append (reply, &records_arr); +if (!dbus_message_iter_open_container (&records_arr,DBUS_TYPE_ARRAY , +"ay" , &record)) { +dbus_message_unref (reply); +return btd_error_failed (msg,"Could not initialize iterator" ); + } + +for (cur = device->tmp_records; cur; cur = cur->next) { +DBusMessageIter record_bytes; +sdp_record_t *rec = cur->data; +sdp_buf_t buf; +int result; + + result =sdp_gen_record_pdu (rec, &buf); +if (result) { +dbus_message_iter_abandon_container (&records_arr, + &record); +dbus_message_unref (reply); +return btd_error_failed ( + msg,"Could not marshal service record" ); + } +if (!dbus_message_iter_open_container (&record,DBUS_TYPE_ARRAY , +"y" , &record_bytes)) { +bt_free (buf.data); +dbus_message_iter_abandon_container (&records_arr, + &record); +dbus_message_unref (reply); +return btd_error_failed ( + msg,"Could not initialize iterator" ); + } +if (!dbus_message_iter_append_fixed_array ( + &record_bytes,DBUS_TYPE_BYTE , &buf.data, + buf.data_size)) { +bt_free (buf.data); +dbus_message_iter_abandon_container (&record, + &record_bytes); +dbus_message_iter_abandon_container (&records_arr, + &record); +dbus_message_unref (reply); +return btd_error_failed ( + msg,"Could not append record data to reply" ); + } +dbus_message_iter_close_container (&record, &record_bytes); +bt_free (buf.data); + } + +dbus_message_iter_close_container (&records_arr, &record); + +return reply; +} +static const GDBusMethodTable device_methods[] = { {GDBUS_ASYNC_METHOD ("Disconnect" ,NULL ,NULL , dev_disconnect) }, {GDBUS_ASYNC_METHOD ("Connect" ,NULL ,NULL , dev_connect) },
@@ -3224,6 +3304,9 @@ static const GDBusMethodTable device_methods[] = { NULL, disconnect_profile) }, { GDBUS_ASYNC_METHOD("Pair", NULL, NULL, pair_device) }, { GDBUS_METHOD("CancelPairing", NULL, NULL, cancel_pairing) }, + { GDBUS_EXPERIMENTAL_METHOD("GetServiceRecords", NULL, + GDBUS_ARGS({ "Records", "aay" }), + get_service_records) }, { } };
Signature · 1 line
2.46.0
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=888047
---Test result---
Test Summary:
CheckPatch PASS 1.05 seconds GitLint PASS 0.66 seconds BuildEll PASS 24.72 seconds BluezMake PASS 1682.04 seconds MakeCheck PASS 13.55 seconds MakeDistcheck PASS 178.67 seconds CheckValgrind PASS 252.77 seconds CheckSmatch PASS 356.35 seconds bluezmakeextell PASS 119.86 seconds IncrementalBuild PASS 2978.48 seconds ScanBuild PASS 1001.94 seconds
---
Regards,
Linux Bluetooth
Luiz Augusto von Dentz
maintainerRe: [PATCH BlueZ 1/2] device: Add method GetServiceRecords
In reply to Vibhav PantHi Vibhav,
Quoted 9 lines · Vibhav Pant
GetServiceRecords returns all currently known BR/EDR service records for the device, as an array of array of bytes. Each individual byte array represents a raw SDP record, as defined by the Bluetooth Service Discovery Protocol spec.
This method is intended to be only used by compatibility layers like Wine, that need to provide access to raw SDP records to implement the Win32 Bluetooth API. Applications should instead use the Profile API for services-related functionality.
Is this the best format though? I'm afraid this would require an upper level to implement SDP record parsing as well or is that what Windows exposes as well?
Quoted 109 lines
--- src/device.c | 83 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 83 insertions(+)src/device.c +83
-1@@ -3215,6 +3215,86 @@ static DBusMessage *cancel_pairing(DBusConnection *conn, DBusMessage *msg,return dbus_message_new_method_return (msg); } +static sdp_list_t *read_device_records (struct btd_device *device); + +static DBusMessage *get_service_records (DBusConnection *conn,DBusMessage *msg, +void *data) +{ +DBusMessage *reply; +DBusMessageIter records_arr, record; +struct btd_device *device = data; +sdp_list_t *cur; + +if (!btd_adapter_get_powered (device->adapter)) +return btd_error_not_ready (msg); + +if (!btd_device_is_connected (device)) +return btd_error_not_connected (msg); + +if (!device->bredr_state.svc_resolved) +return btd_error_not_ready (msg); + +if (!device->tmp_records) { + device->tmp_records =read_device_records (device); +if (!device->tmp_records) +return btd_error_does_not_exist (msg); + } + + reply =dbus_message_new_method_return (msg); +if (!reply) +return btd_error_failed (msg,"Could not create method reply" ); + +dbus_message_iter_init_append (reply, &records_arr); +if (!dbus_message_iter_open_container (&records_arr,DBUS_TYPE_ARRAY , +"ay" , &record)) { +dbus_message_unref (reply); +return btd_error_failed (msg,"Could not initialize iterator" ); + } + +for (cur = device->tmp_records; cur; cur = cur->next) { +DBusMessageIter record_bytes; +sdp_record_t *rec = cur->data; +sdp_buf_t buf; +int result; + + result =sdp_gen_record_pdu (rec, &buf); +if (result) { +dbus_message_iter_abandon_container (&records_arr, + &record); +dbus_message_unref (reply); +return btd_error_failed ( + msg,"Could not marshal service record" ); + } +if (!dbus_message_iter_open_container (&record,DBUS_TYPE_ARRAY , +"y" , &record_bytes)) { +bt_free (buf.data); +dbus_message_iter_abandon_container (&records_arr, + &record); +dbus_message_unref (reply); +return btd_error_failed ( + msg,"Could not initialize iterator" ); + } +if (!dbus_message_iter_append_fixed_array ( + &record_bytes,DBUS_TYPE_BYTE , &buf.data, + buf.data_size)) { +bt_free (buf.data); +dbus_message_iter_abandon_container (&record, + &record_bytes); +dbus_message_iter_abandon_container (&records_arr, + &record); +dbus_message_unref (reply); +return btd_error_failed ( + msg,"Could not append record data to reply" ); + } +dbus_message_iter_close_container (&record, &record_bytes); +bt_free (buf.data); + } + +dbus_message_iter_close_container (&records_arr, &record); + +return reply; +} +static const GDBusMethodTable device_methods[] = { {GDBUS_ASYNC_METHOD ("Disconnect" ,NULL ,NULL , dev_disconnect) }, {GDBUS_ASYNC_METHOD ("Connect" ,NULL ,NULL , dev_connect) },@@ -3224,6 +3304,9 @@ static const GDBusMethodTable device_methods[] = { NULL, disconnect_profile) }, { GDBUS_ASYNC_METHOD("Pair", NULL, NULL, pair_device) }, { GDBUS_METHOD("CancelPairing", NULL, NULL, cancel_pairing) }, + { GDBUS_EXPERIMENTAL_METHOD("GetServiceRecords", NULL, + GDBUS_ARGS({ "Records", "aay" }), + get_service_records) }, { } }; --2.46.0
Signature · 1 line
Luiz Augusto von Dentz
Re: [PATCH BlueZ 1/2] device: Add method GetServiceRecords
Hi Luiz,
Quoted 3 lines · Luiz Augusto von Dentz
Is this the best format though? I'm afraid this would require an upper level to implement SDP record parsing as well or is that what Windows exposes as well?
Yes, the service discovery related interfaces on Windows return a raw SDP byte stream, which the user is expected to further parse with methods like BluetoothSdpEnumAttributes[1]. That being said, my primary motivation for returning the raw SDP data was to also discourage other applications from using this instead of the Profile API.
Essentially, the Windows kernel and usermode Bluetooth APIs let you make SDP queries to Bluetooth devices (including service and service + attribute queries). From my understanding, exposing raw SDP is an antipattern in BlueZ that was discarded with BlueZ 5, so I did not want to re-introduce the entire concept again over DBus. Instead, the current design of the Wine bluetooth driver is to rely on the cached records stored by BlueZ, and perform any and all queries by searching through them.
The other option was to rely on sdp_lib.h, but having two SDP local servers (is it a local server if it's only being used for device queries?) for every machine sounds like a recipe for eventual breakage, and letting BlueZ be the authoritative source of truth for device-related information is a common pattern in Wine.
Signature · 3 lines
Vibhav Pant [email protected] GPG: 7ED1 D48C 513C A024 BE3A 785F E3FB 28CB 6AB5 9598
PATCH 2/2 org.bluez.Device: Add documentation for GetServiceRecords()
In reply to Vibhav Pant--- doc/org.bluez.Device.rst | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+)
doc/org.bluez.Device.rst +19 -0
@@ -135,6 +135,25 @@ void CancelPairing() :org.bluez.Error.DoesNotExist: :org.bluez.Error.Failed: +array{array{byte}} GetServiceRecords() [experimental] +````````````````````````````````````````````````````` + + Returns all currently known BR/EDR service records for the device. Each + individual byte array represents a raw SDP record, as defined by the + Bluetooth Service Discovery Protocol specification. + + This method is intended to be only used by compatibility layers like + Wine, that need to provide access to raw SDP records to support foreign + Bluetooth APIs. General applications should instead use the Profile API + for services-related functionality. + + Possible errors: + + :org.bluez.Error.Failed: + :org.bluez.Error.NotReady: + :org.bluez.Error.NotConnected: + :org.bluez.Error.DoesNotExist: + Properties ----------
Signature · 1 line
2.46.0
This series was applied to bluetooth/bluez.git (master) by Luiz Augusto von Dentz <[email protected]>:
Hello:
This series was applied to bluetooth/bluez.git (master) by Luiz Augusto von Dentz <[email protected]>:
Quoted 8 lines · On Sun, 8 Sep 2024 03:02:59 +0530 you wrote:
This series adds an experimental DBus API to get BR/EDR service records for devices. The method will be used to implement a part of the Windows Bluetooth API in Wine, which allows accessing a device's service records. The documentation clarifies that the method is only meant for compatibility purposes, and purposefully returns raw SDP records to discourage general applications from using the API.
[...]
Here is the summary with links:
- [BlueZ,1/2] device: Add method GetServiceRecords
https://git.kernel.org/pub/scm/bluetooth/bluez.git/?id=95eb34ee2ee2 - [BlueZ,2/2] org.bluez.Device: Add documentation for GetServiceRecords() https://git.kernel.org/pub/scm/bluetooth/bluez.git/?id=44a1930479b7
You are awesome, thank you!
Signature · 2 lines
Deet-doot-dot, I am a bot. https://korg.docs.kernel.org/patchwork/pwbot.html