Merge "Floss: Implement Pandora L2CAP profile" into main (ca31d7b0) · Commits · e / os / android_packages_modules_Bluetooth

floss/pandora/floss/floss_enums.py

+1 −0

Original line number	Diff line number	Diff line
		@@ -108,6 +108,7 @@ class BtStatus(enum.IntEnum):
		JNI_ENVIRONMENT_ERROR = 12
		JNI_THREAD_ATTACH_ERROR = 13
		WAKE_LOCK_ERROR = 14
		BT_STATUS_TIMEOUT = 15


		class SocketType(enum.IntEnum):

floss/pandora/floss/socket_manager.py

+16 −164

Original line number	Diff line number	Diff line
		@@ -14,7 +14,6 @@
		"""Client class to access the Floss socket manager interface."""

		import logging
		import os

		from floss.pandora.floss import floss_enums
		from floss.pandora.floss import observer_base
		@@ -150,20 +149,6 @@ class FlossSocketManagerClient(SocketManagerCallbacks):
		self.callback_id = None
		self.objpath = self.ADAPTER_OBJECT_PATTERN.format(hci)

		# key = listener_id, val = (socket_info, status)
		self.ready_sockets = {}

		# key = listener_id, val = (socket_info, [incoming_sockets])
		# Where incoming_sockets are tuples: (socket_info, fd)
		# fds are NOT file object, they only work with low-level I/O functions
		# such as os.read() and os.write().
		self.listening_sockets = {}

		# key = connecting_id, val = (status, socket_info, fd)
		# fds are NOT file object, they only work with low-level I/O functions
		# such as os.read() and os.write().
		self.connecting_sockets = {}

		def __del__(self):
		"""Destructor."""
		del self.callbacks
		@@ -172,47 +157,16 @@ class FlossSocketManagerClient(SocketManagerCallbacks):
		def on_incoming_socket_ready(self, socket, status):
		"""Handles incoming socket ready callback."""
		logging.debug('on_incoming_socket_ready: socket: %s, status: %s', socket, status)
		socket_id = socket['id']
		self.ready_sockets[socket_id] = (socket, status)

		if floss_enums.BtStatus(status) != floss_enums.BtStatus.SUCCESS:
		return
		if socket_id in self.listening_sockets:
		logging.warn('The socket_id: %s, is already registered', socket_id)
		else:
		self.listening_sockets[socket_id] = (socket, [])

		@utils.glib_callback()
		def on_incoming_socket_closed(self, listener_id, reason):
		"""Handles incoming socket closed callback."""
		logging.debug('on_incoming_socket_closed: listener_id: %s, reason: %s', listener_id, reason)
		if listener_id in self.listening_sockets:
		self.listening_sockets.pop(listener_id)
		else:
		logging.warn('The socket_id: %s, is not registered yet', listener_id)

		@utils.glib_callback()
		def on_handle_incoming_connection(self, listener_id, connection, *, dbus_unix_fd_list=None):
		"""Handles incoming socket connection callback."""
		logging.debug('on_handle_incoming_connection: listener_id: %s, connection: %s', listener_id, connection)
		optional_fd = connection['fd']
		if not optional_fd:
		return

		if not dbus_unix_fd_list or dbus_unix_fd_list.get_length() < 1:
		logging.error('on_handle_incoming_connection: Empty fd list')
		return

		fd_handle = optional_fd['optional_value']
		if fd_handle > dbus_unix_fd_list.get_length():
		logging.error('on_handle_incoming_connection: Invalid fd handle')
		return

		fd = dbus_unix_fd_list.get(fd_handle)
		fd_dup = os.dup(fd)
		logging.debug('on_handle_incoming_connection: Got fd %s, dup to %s', fd, fd_dup)

		self.listening_sockets[listener_id][1].append((connection, fd_dup))

		@utils.glib_callback()
		def on_outgoing_connection_result(self, connecting_id, result, socket, *, dbus_unix_fd_list=None):
		@@ -220,35 +174,11 @@ class FlossSocketManagerClient(SocketManagerCallbacks):
		logging.debug('on_outgoing_connection_result: connecting_id: %s, result: %s, socket: %s', connecting_id, result,
		socket)

		self.connecting_sockets[connecting_id] = (result, socket, None)

		if not socket:
		return

		optional_fd = socket['optional_value']['fd']
		if not optional_fd:
		return

		if not dbus_unix_fd_list or dbus_unix_fd_list.get_length() < 1:
		logging.error('on_outgoing_connection_result: Empty fd list')
		return

		fd_handle = optional_fd['optional_value']
		if fd_handle > dbus_unix_fd_list.get_length():
		logging.error('on_outgoing_connection_result: Invalid fd handle')
		return

		fd = dbus_unix_fd_list.get(fd_handle)
		fd_dup = os.dup(fd)
		logging.debug('on_outgoing_connection_result: Got fd %s, dup to %s', fd, fd_dup)

		self.connecting_sockets[connecting_id] = (result, socket, fd_dup)

		def _make_dbus_device(self, address, name):
		def make_dbus_device(self, address, name):
		return {'address': GLib.Variant('s', address), 'name': GLib.Variant('s', name)}

		def _make_dbus_timeout(self, timeout):
		return utils.dbus_optional_value('i', timeout)
		return utils.dbus_optional_value('u', timeout)

		@utils.glib_call(False)
		def has_proxy(self):
		@@ -280,27 +210,25 @@ class FlossSocketManagerClient(SocketManagerCallbacks):
		self.callback_id = self.proxy().RegisterCallback(objpath)
		return True

		def wait_for_incoming_socket_ready(self, socket_id):
		"""Waits for incoming socket ready.
		def register_callback_observer(self, name, observer):
		"""Add an observer for all callbacks.

		Args:
		socket_id: Socket id.

		Returns:
		Socket, status for specific socket_id on success, (None, None) otherwise.
		name: Name of the observer.
		observer: Observer that implements all callback classes.
		"""
		try:
		utils.poll_for_condition(condition=(lambda: socket_id in self.ready_sockets),
		timeout=self.FLOSS_RESPONSE_LATENCY_SECS)
		except TimeoutError:
		logging.error('on_incoming_socket_ready not called')
		return None, None
		socket, status = self.ready_sockets[socket_id]
		if isinstance(observer, SocketManagerCallbacks):
		self.callbacks.add_observer(name, observer)

		# Consume the result here because we have no straightforward timing to drop the info.
		del self.ready_sockets[socket_id]
		def unregister_callback_observer(self, name, observer):
		"""Remove an observer for all callbacks.

		return socket, status
		Args:
		name: Name of the observer.
		observer: Observer that implements all callback classes.
		"""
		if isinstance(observer, SocketManagerCallbacks):
		self.callbacks.remove_observer(name, observer)

		@utils.glib_call(None)
		def listen_using_l2cap_channel(self):
		@@ -347,32 +275,6 @@ class FlossSocketManagerClient(SocketManagerCallbacks):
		"""
		return self.proxy().ListenUsingRfcommWithServiceRecord(self.callback_id, name, uuid)

		def listen_using_rfcomm_with_service_record_sync(self, name, uuid):
		"""Listens using RFCOMM channel with service record sync.

		Args:
		name: Service name.
		uuid: 128-bit service UUID.

		Returns:
		BluetoothServerSocket on success, None otherwise.
		"""
		socket_result = self.listen_using_rfcomm_with_service_record(name, uuid)
		# Failed if we have issue in D-bus (None) or returned non success status.
		if socket_result is None or socket_result['status'] != floss_enums.BtStatus.SUCCESS:
		logging.error('Failed to listen using rfcomm socket with service record')
		return None

		socket_id = socket_result['id']
		_, status = self.wait_for_incoming_socket_ready(socket_id)
		if status is None:
		return None

		if floss_enums.BtStatus(status) != floss_enums.BtStatus.SUCCESS:
		logging.error('Failed to start socket with id: %s, status = %s', socket_id, status)
		return None
		return socket_result

		@utils.glib_call(None)
		def create_insecure_l2cap_channel(self, device, psm):
		"""Creates insecure L2CAP channel.
		@@ -453,53 +355,3 @@ class FlossSocketManagerClient(SocketManagerCallbacks):
		if floss_enums.BtStatus(status) != floss_enums.BtStatus.SUCCESS:
		logging.error('Failed to close socket with id: %s, status = %s', socket_id, status)
		return floss_enums.BtStatus(status) == floss_enums.BtStatus.SUCCESS

		def wait_for_incoming_socket_closed(self, socket_id):
		"""Waits for incoming socket closed.

		Args:
		socket_id: Socket id.

		Returns:
		True on success, False otherwise.
		"""
		try:
		utils.poll_for_condition(condition=(lambda: socket_id not in self.listening_sockets),
		timeout=self.FLOSS_RESPONSE_LATENCY_SECS)

		return True
		except TimeoutError:
		logging.error('on_incoming_socket_closed not called')
		return False

		def close_sync(self, socket_id):
		"""Closes socket connection sync.

		Args:
		socket_id: Socket id to be closed.

		Returns:
		True on success, False otherwise.
		"""
		if not self.close(socket_id):
		return False

		return self.wait_for_incoming_socket_closed(socket_id)

		def close_all(self):
		"""Closes all sockets connections.

		Returns:
		True on success, False otherwise.
		"""
		# Copy the keys of self.listening_sockets as the following loop will pop the keys via self.close_sync().
		failed_socket_ids = []
		socket_ids = [i for i in self.listening_sockets]
		for i in socket_ids:
		if not self.close_sync(i):
		failed_socket_ids.append(i)

		if failed_socket_ids:
		logging.error('Failed to close sockets with ids: %s', ','.join(failed_socket_ids))
		return False
		return True

floss/pandora/server/bluetooth.py

+26 −0

Original line number	Diff line number	Diff line
		@@ -22,6 +22,7 @@ from floss.pandora.floss import advertising_client
		from floss.pandora.floss import manager_client
		from floss.pandora.floss import qa_client
		from floss.pandora.floss import scanner_client
		from floss.pandora.floss import socket_manager
		from floss.pandora.floss import gatt_client
		from floss.pandora.floss import gatt_server
		from floss.pandora.floss import floss_enums
		@@ -67,6 +68,7 @@ class Bluetooth(object):
		self.qa_client = qa_client.FlossQAClient(self.bus, self.DEFAULT_ADAPTER)
		self.gatt_client = gatt_client.FlossGattClient(self.bus, self.DEFAULT_ADAPTER)
		self.gatt_server = gatt_server.FlossGattServer(self.bus, self.DEFAULT_ADAPTER)
		self.socket_manager = socket_manager.FlossSocketManagerClient(self.bus, self.DEFAULT_ADAPTER)

		def __del__(self):
		if not self.is_clean:
		@@ -137,6 +139,9 @@ class Bluetooth(object):
		if not self.gatt_server.register_server(self.FAKE_GATT_APP_ID, False):
		logging.error('gatt_server: Failed to register callbacks')
		return False
		if not self.socket_manager.register_callbacks():
		logging.error('scanner_client: Failed to register callbacks')
		return False
		return True

		def is_bluetoothd_proxy_valid(self):
		@@ -150,6 +155,7 @@ class Bluetooth(object):
		self.qa_client.has_proxy(),
		self.gatt_client.has_proxy(),
		self.gatt_server.has_proxy(),
		self.socket_manager.has_proxy()
		])

		if not proxy_ready:
		@@ -185,6 +191,7 @@ class Bluetooth(object):
		self.qa_client = qa_client.FlossQAClient(self.bus, default_adapter)
		self.gatt_client = gatt_client.FlossGattClient(self.bus, default_adapter)
		self.gatt_server = gatt_server.FlossGattServer(self.bus, default_adapter)
		self.socket_manager = socket_manager.FlossSocketManagerClient(self.bus, default_adapter)

		try:
		utils.poll_for_condition(
		@@ -360,3 +367,22 @@ class Bluetooth(object):
		logging.error('Failed to get connection state for address: %s', address)
		return False
		return connection_state > floss_enums.BtConnectionState.CONNECTED_ONLY

		def listen_using_l2cap_channel(self):
		return self.socket_manager.listen_using_l2cap_channel()

		def listen_using_insecure_l2cap_channel(self):
		return self.socket_manager.listen_using_insecure_l2cap_channel()

		def create_l2cap_channel(self, address, psm):
		name = self.adapter_client.get_remote_property(address, 'Name')
		device = self.socket_manager.make_dbus_device(address, name)
		return self.socket_manager.create_l2cap_channel(device, psm)

		def create_insecure_l2cap_channel(self, address, psm):
		name = self.adapter_client.get_remote_property(address, 'Name')
		device = self.socket_manager.make_dbus_device(address, name)
		return self.socket_manager.create_insecure_l2cap_channel(device, psm)

		def accept_socket(self, socket_id, timeout_ms=None):
		return self.socket_manager.accept(socket_id, timeout_ms)

floss/pandora/server/l2cap.py

0 → 100644

+315 −0

File added.

Preview size limit exceeded, changes collapsed.

floss/pandora/server/server.py

+5 −0

Original line number	Diff line number	Diff line
		@@ -20,12 +20,14 @@ from floss.pandora.server import bluetooth as bluetooth_module
		from floss.pandora.server import gatt
		from floss.pandora.server import hid
		from floss.pandora.server import host
		from floss.pandora.server import l2cap
		from floss.pandora.server import security
		import grpc
		from pandora import host_grpc_aio
		from pandora import security_grpc_aio
		from pandora_experimental import gatt_grpc_aio
		from pandora_experimental import hid_grpc_aio
		from pandora_experimental import l2cap_grpc_aio


		async def serve(port):
		@@ -55,6 +57,9 @@ async def serve(port):
		hid_service = hid.HIDService(bluetooth)
		hid_grpc_aio.add_HIDServicer_to_server(hid_service, server)

		l2cap_service = l2cap.L2CAPService(bluetooth)
		l2cap_grpc_aio.add_L2CAPServicer_to_server(l2cap_service, server)

		server.add_insecure_port(f'[::]:{port}')

		await server.start()