pandora: implement L2CAP pandora service

Co-authored-by: Josh Wu <[email protected]>

bumble/pandora/__init__.py

@@ -26,11 +26,13 @@
 from .device import PandoraDevice
 from .host import HostService
 from .security import SecurityService, SecurityStorageService
+from .l2cap import L2CAPService
 from pandora.host_grpc_aio import add_HostServicer_to_server
 from pandora.security_grpc_aio import (
     add_SecurityServicer_to_server,
     add_SecurityStorageServicer_to_server,
 )
+from pandora.l2cap_grpc_aio import add_L2CAPServicer_to_server
 from typing import Callable, List, Optional
 
 # public symbols
@@ -77,6 +79,7 @@ async def serve(
             add_SecurityStorageServicer_to_server(
                 SecurityStorageService(bumble.device, config), server
             )
+            add_L2CAPServicer_to_server(L2CAPService(bumble.device, config), server)
 
             # call hooks if any.
             for hook in _SERVICERS_HOOKS:

bumble/pandora/l2cap.py

@@ -0,0 +1,289 @@
+# Copyright 2023 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import asyncio
+import dataclasses
+import grpc
+import struct
+
+from bumble import device
+from bumble import l2cap
+from bumble.pandora import config
+from bumble.pandora import utils
+from bumble.utils import EventWatcher
+from google.protobuf import any_pb2  # pytype: disable=pyi-error
+from google.protobuf import empty_pb2  # pytype: disable=pyi-error
+from pandora import l2cap_pb2
+from pandora import l2cap_grpc_aio
+from typing import Any, AsyncGenerator, AsyncIterator, Dict, List, Union
+
+
+@dataclasses.dataclass
+class ChannelProxy:
+    channel: Union[l2cap.ClassicChannel, l2cap.LeCreditBasedChannel, None]
+
+    def __post_init__(self) -> None:
+        assert self.channel
+        self.rx: asyncio.Queue[bytes] = asyncio.Queue()
+        self._disconnection_result: asyncio.Future[None] = asyncio.Future()
+        self.channel.sink = self.rx.put_nowait
+
+        def on_close() -> None:
+            assert not self._disconnection_result.done()
+            self.channel = None
+            self._disconnection_result.set_result(None)
+
+        self.channel.on('close', on_close)
+
+    def send(self, data: bytes) -> None:
+        assert self.channel
+        if isinstance(self.channel, l2cap.ClassicChannel):
+            self.channel.send_pdu(data)
+        else:
+            self.channel.write(data)
+
+    async def disconnect(self) -> None:
+        assert self.channel
+        await self.channel.disconnect()
+
+    async def wait_disconnect(self) -> None:
+        await self._disconnection_result
+        assert not self.channel
+
+
+@dataclasses.dataclass
+class ChannelIndex:
+    connection_handle: int
+    cid: int
+
+    @classmethod
+    def from_token(cls, token: l2cap_pb2.Channel) -> 'ChannelIndex':
+        connection_handle, cid = struct.unpack('>HH', token.cookie.value)
+        return cls(connection_handle, cid)
+
+    def into_token(self) -> l2cap_pb2.Channel:
+        return l2cap_pb2.Channel(
+            cookie=any_pb2.Any(
+                value=struct.pack('>HH', self.connection_handle, self.cid)
+            )
+        )
+
+    def __hash__(self):
+        return hash(self.connection_handle | (self.cid << 12))
+
+
+class L2CAPService(l2cap_grpc_aio.L2CAPServicer):
+    channels: Dict[ChannelIndex, ChannelProxy] = {}
+    pending: List[l2cap.IncomingConnection.Any] = []
+    accepts: List[asyncio.Queue[l2cap.IncomingConnection.Any]] = []
+
+    def __init__(self, dev: device.Device, config: config.Config) -> None:
+        self.device = dev
+        self.config = config
+
+        def on_connection(incoming: l2cap.IncomingConnection.Any) -> None:
+            self.pending.append(incoming)
+            for acceptor in self.accepts:
+                acceptor.put_nowait(incoming)
+
+        # Make sure our listener is called before the builtins ones.
+        self.device.l2cap_channel_manager.listeners.insert(0, on_connection)
+
+    def register(self, index: ChannelIndex, proxy: ChannelProxy) -> None:
+        self.channels[index] = proxy
+
+        def on_close(*_: Any) -> None:
+            # TODO: Fix Bumble L2CAP which emit `close` event twice.
+            if index in self.channels:
+                del self.channels[index]
+
+        # Listen for disconnection.
+        assert proxy.channel
+        proxy.channel.on('close', on_close)
+
+    async def listen(self) -> AsyncIterator[l2cap.IncomingConnection.Any]:
+        for incoming in self.pending:
+            if incoming.future.done():
+                self.pending.remove(incoming)
+                continue
+            yield incoming
+        queue: asyncio.Queue[l2cap.IncomingConnection.Any] = asyncio.Queue()
+        self.accepts.append(queue)
+        try:
+            while incoming := await queue.get():
+                yield incoming
+        finally:
+            self.accepts.remove(queue)
+
+    @utils.rpc
+    async def Connect(
+        self, request: l2cap_pb2.ConnectRequest, context: grpc.ServicerContext
+    ) -> l2cap_pb2.ConnectResponse:
+        # Retrieve Bumble `Connection` from request.
+        connection_handle = int.from_bytes(request.connection.cookie.value, 'big')
+        connection = self.device.lookup_connection(connection_handle)
+        if connection is None:
+            raise RuntimeError(f'{connection_handle}: not connection for handle')
+
+        channel: Union[l2cap.ClassicChannel, l2cap.LeCreditBasedChannel]
+        if request.type_variant() == 'basic':
+            assert request.basic
+            channel = await connection.create_l2cap_channel(
+                spec=l2cap.ClassicChannelSpec(
+                    psm=request.basic.psm, mtu=request.basic.mtu
+                )
+            )
+        elif request.type_variant() == 'le_credit_based':
+            assert request.le_credit_based
+            channel = await connection.create_l2cap_channel(
+                spec=l2cap.LeCreditBasedChannelSpec(
+                    psm=request.le_credit_based.spsm,
+                    max_credits=request.le_credit_based.initial_credit,
+                    mtu=request.le_credit_based.mtu,
+                    mps=request.le_credit_based.mps,
+                )
+            )
+        else:
+            raise NotImplementedError(f"{request.type_variant()}: unsupported type")
+
+        index = ChannelIndex(channel.connection.handle, channel.source_cid)
+        self.register(index, ChannelProxy(channel))
+        return l2cap_pb2.ConnectResponse(channel=index.into_token())
+
+    @utils.rpc
+    async def WaitConnection(
+        self, request: l2cap_pb2.WaitConnectionRequest, context: grpc.ServicerContext
+    ) -> l2cap_pb2.WaitConnectionResponse:
+        iter = self.listen()
+        fut: asyncio.Future[
+            Union[l2cap.ClassicChannel, l2cap.LeCreditBasedChannel]
+        ] = asyncio.Future()
+
+        # Filter by connection.
+        if request.connection:
+            handle = int.from_bytes(request.connection.cookie.value, 'big')
+            iter = (it async for it in iter if it.connection.handle == handle)
+
+        if request.type_variant() == 'basic':
+            assert request.basic
+            basic = l2cap.PendingConnection.Basic(
+                fut.set_result,
+                request.basic.mtu or l2cap.L2CAP_MIN_BR_EDR_MTU,
+            )
+            async for i in (
+                it
+                async for it in iter
+                if isinstance(it, l2cap.IncomingConnection.Basic)
+            ):
+                if not i.future.done() and i.psm == request.basic.psm:
+                    i.future.set_result(basic)
+                    break
+        elif request.type_variant() == 'le_credit_based':
+            assert request.le_credit_based
+            le_credit_based = l2cap.PendingConnection.LeCreditBased(
+                fut.set_result,
+                request.le_credit_based.mtu
+                or l2cap.L2CAP_LE_CREDIT_BASED_CONNECTION_DEFAULT_MTU,
+                request.le_credit_based.mps
+                or l2cap.L2CAP_LE_CREDIT_BASED_CONNECTION_DEFAULT_MPS,
+                request.le_credit_based.initial_credit
+                or l2cap.L2CAP_LE_CREDIT_BASED_CONNECTION_DEFAULT_INITIAL_CREDITS,
+            )
+            async for j in (
+                it
+                async for it in iter
+                if isinstance(it, l2cap.IncomingConnection.LeCreditBased)
+            ):
+                if not j.future.done() and j.psm == request.le_credit_based.spsm:
+                    j.future.set_result(le_credit_based)
+                    break
+        else:
+            raise NotImplementedError(f"{request.type_variant()}: unsupported type")
+
+        channel = await fut
+        index = ChannelIndex(channel.connection.handle, channel.source_cid)
+        self.register(index, ChannelProxy(channel))
+        return l2cap_pb2.WaitConnectionResponse(channel=index.into_token())
+
+    @utils.rpc
+    async def Disconnect(
+        self, request: l2cap_pb2.DisconnectRequest, context: grpc.ServicerContext
+    ) -> l2cap_pb2.DisconnectResponse:
+        channel = self.channels[ChannelIndex.from_token(request.channel)]
+        await channel.disconnect()
+        return l2cap_pb2.DisconnectResponse(success=empty_pb2.Empty())
+
+    @utils.rpc
+    async def WaitDisconnection(
+        self, request: l2cap_pb2.WaitDisconnectionRequest, context: grpc.ServicerContext
+    ) -> l2cap_pb2.WaitDisconnectionResponse:
+        channel = self.channels[ChannelIndex.from_token(request.channel)]
+        await channel.wait_disconnect()
+        return l2cap_pb2.WaitDisconnectionResponse(success=empty_pb2.Empty())
+
+    @utils.rpc
+    async def Receive(
+        self, request: l2cap_pb2.ReceiveRequest, context: grpc.ServicerContext
+    ) -> AsyncGenerator[l2cap_pb2.ReceiveResponse, None]:
+        watcher = EventWatcher()
+        if request.source_variant() == 'channel':
+            assert request.channel
+            channel = self.channels[ChannelIndex.from_token(request.channel)]
+            rx = channel.rx
+        elif request.source_variant() == 'fixed_channel':
+            assert request.fixed_channel
+            rx = asyncio.Queue()
+            handle = request.fixed_channel.connection is not None and int.from_bytes(
+                request.fixed_channel.connection.cookie.value, 'big'
+            )
+
+            @watcher.on(self.device.host, 'l2cap_pdu')
+            def _(connection: device.Connection, cid: int, pdu: bytes) -> None:
+                assert request.fixed_channel
+                if cid == request.fixed_channel.cid and (
+                    handle is None or handle == connection.handle
+                ):
+                    rx.put_nowait(pdu)
+
+        else:
+            raise NotImplementedError(f"{request.source_variant()}: unsupported type")
+        try:
+            while data := await rx.get():
+                yield l2cap_pb2.ReceiveResponse(data=data)
+        finally:
+            watcher.close()
+
+    @utils.rpc
+    async def Send(
+        self, request: l2cap_pb2.SendRequest, context: grpc.ServicerContext
+    ) -> l2cap_pb2.SendResponse:
+        if request.sink_variant() == 'channel':
+            assert request.channel
+            channel = self.channels[ChannelIndex.from_token(request.channel)]
+            channel.send(request.data)
+        elif request.sink_variant() == 'fixed_channel':
+            assert request.fixed_channel
+            # Retrieve Bumble `Connection` from request.
+            connection_handle = int.from_bytes(
+                request.fixed_channel.connection.cookie.value, 'big'
+            )
+            connection = self.device.lookup_connection(connection_handle)
+            if connection is None:
+                raise RuntimeError(f'{connection_handle}: not connection for handle')
+            self.device.l2cap_channel_manager.send_pdu(
+                connection, request.fixed_channel.cid, request.data
+            )
+        else:
+            raise NotImplementedError(f"{request.sink_variant()}: unsupported type")
+        return l2cap_pb2.SendResponse(success=empty_pb2.Empty())

setup.cfg

@@ -33,7 +33,7 @@ include_package_data = True
 install_requires =
     aiohttp ~= 3.8; platform_system!='Emscripten'
     appdirs >= 1.4; platform_system!='Emscripten'
-    bt-test-interfaces >= 0.0.2; platform_system!='Emscripten'
+    bt-test-interfaces >= 0.0.5; platform_system!='Emscripten'
     click == 8.1.3; platform_system!='Emscripten'
     cryptography == 39; platform_system!='Emscripten'
     # Pyodide bundles a version of cryptography that is built for wasm, which may not match the