/****************************************************************************** * * Copyright 2014 Google, Inc. * * 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: * * http://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. * ******************************************************************************/ #define LOG_TAG "bt_hci_packet_fragmenter" #include "packet_fragmenter.h" #include #include #include #include "bt_target.h" #include "buffer_allocator.h" #include "device/include/controller.h" #include "hci_internals.h" #include "osi/include/log.h" #include "osi/include/osi.h" #define APPLY_CONTINUATION_FLAG(handle) (((handle)&0xCFFF) | 0x1000) #define APPLY_START_FLAG(handle) (((handle)&0xCFFF) | 0x2000) #define SUB_EVENT(event) ((event)&MSG_SUB_EVT_MASK) #define GET_BOUNDARY_FLAG(handle) (((handle) >> 12) & 0x0003) #define GET_BROADCAST_FLAG(handle) (((handle) >> 14) & 0x0003) #define HANDLE_MASK 0x0FFF #define START_PACKET_BOUNDARY 2 #define POINT_TO_POINT 0 #define L2CAP_HEADER_PDU_LEN_SIZE 2 #define L2CAP_HEADER_CID_SIZE 2 #define L2CAP_HEADER_SIZE (L2CAP_HEADER_PDU_LEN_SIZE + L2CAP_HEADER_CID_SIZE) // Our interface and callbacks static const allocator_t* buffer_allocator; static const controller_t* controller; static const packet_fragmenter_callbacks_t* callbacks; static std::unordered_map partial_packets; static std::unordered_map partial_iso_packets; static void init(const packet_fragmenter_callbacks_t* result_callbacks) { callbacks = result_callbacks; } static void cleanup() { partial_packets.clear(); partial_iso_packets.clear(); } static bool check_uint16_overflow(uint16_t a, uint16_t b) { return (UINT16_MAX - a) < b; } static void fragment_and_dispatch_acl(BT_HDR* packet); static void fragment_and_dispatch_iso(BT_HDR* packet); static void fragment_and_dispatch(BT_HDR* packet) { CHECK(packet != NULL); uint16_t event = packet->event & MSG_EVT_MASK; if (event == MSG_STACK_TO_HC_HCI_ACL) { fragment_and_dispatch_acl(packet); } else if (event == MSG_STACK_TO_HC_HCI_ISO) { fragment_and_dispatch_iso(packet); } else { callbacks->fragmented(packet, true); } } static void fragment_and_dispatch_acl(BT_HDR* packet) { uint16_t max_data_size = SUB_EVENT(packet->event) == LOCAL_BR_EDR_CONTROLLER_ID ? controller->get_acl_data_size_classic() : controller->get_acl_data_size_ble(); uint16_t max_packet_size = max_data_size + HCI_ACL_PREAMBLE_SIZE; uint16_t remaining_length = packet->len; uint8_t* stream = packet->data + packet->offset; uint16_t continuation_handle; STREAM_TO_UINT16(continuation_handle, stream); continuation_handle = APPLY_CONTINUATION_FLAG(continuation_handle); while (remaining_length > max_packet_size) { // Make sure we use the right ACL packet size stream = packet->data + packet->offset; STREAM_SKIP_UINT16(stream); UINT16_TO_STREAM(stream, max_data_size); packet->len = max_packet_size; callbacks->fragmented(packet, false); packet->offset += max_data_size; remaining_length -= max_data_size; packet->len = remaining_length; // Write the ACL header for the next fragment stream = packet->data + packet->offset; UINT16_TO_STREAM(stream, continuation_handle); UINT16_TO_STREAM(stream, remaining_length - HCI_ACL_PREAMBLE_SIZE); // Apparently L2CAP can set layer_specific to a max number of segments to // transmit if (packet->layer_specific) { packet->layer_specific--; if (packet->layer_specific == 0) { packet->event = BT_EVT_TO_BTU_L2C_SEG_XMIT; callbacks->transmit_finished(packet, false); return; } } } callbacks->fragmented(packet, true); } static void fragment_and_dispatch_iso(BT_HDR* packet) { uint8_t* stream = packet->data + packet->offset; uint16_t max_data_size = controller->get_iso_data_size(); uint16_t max_packet_size = max_data_size + HCI_ISO_PREAMBLE_SIZE; uint16_t remaining_length = packet->len; uint16_t handle; STREAM_TO_UINT16(handle, stream); if (packet->layer_specific & BT_ISO_HDR_CONTAINS_TS) { // First packet might have timestamp handle = HCI_ISO_SET_TIMESTAMP_FLAG(handle); } if (remaining_length <= max_packet_size) { stream = packet->data + packet->offset; UINT16_TO_STREAM(stream, HCI_ISO_SET_COMPLETE_FLAG(handle)); } else { while (remaining_length > max_packet_size) { // Make sure we use the right ISO packet size stream = packet->data + packet->offset; STREAM_SKIP_UINT16(stream); UINT16_TO_STREAM(stream, max_data_size); packet->len = max_packet_size; callbacks->fragmented(packet, false); packet->offset += max_data_size; remaining_length -= max_data_size; packet->len = remaining_length; // Write the ISO header for the next fragment stream = packet->data + packet->offset; if (remaining_length > max_packet_size) { UINT16_TO_STREAM(stream, HCI_ISO_SET_CONTINUATION_FLAG(handle & HANDLE_MASK)); } else { UINT16_TO_STREAM(stream, HCI_ISO_SET_END_FRAG_FLAG(handle & HANDLE_MASK)); } UINT16_TO_STREAM(stream, remaining_length - HCI_ISO_PREAMBLE_SIZE); } } callbacks->fragmented(packet, true); } static void reassemble_and_dispatch_iso(UNUSED_ATTR BT_HDR* packet) { uint8_t* stream = packet->data; uint16_t handle; uint16_t iso_length; uint8_t iso_hdr_len = HCI_ISO_HEADER_LEN_WITHOUT_TS; BT_HDR* partial_packet; uint16_t iso_full_len; STREAM_TO_UINT16(handle, stream); STREAM_TO_UINT16(iso_length, stream); // last 2 bits is RFU iso_length = iso_length & 0x3FFF; CHECK(iso_length == packet->len - HCI_ISO_PREAMBLE_SIZE); uint8_t boundary_flag = GET_BOUNDARY_FLAG(handle); uint8_t ts_flag = HCI_ISO_GET_TS_FLAG(handle); handle = handle & HANDLE_MASK; auto map_iter = partial_iso_packets.find(handle); switch (boundary_flag) { case HCI_ISO_BF_COMPLETE_PACKET: case HCI_ISO_BF_FIRST_FRAGMENTED_PACKET: uint16_t iso_sdu_length; uint8_t packet_status_flags; if (map_iter != partial_iso_packets.end()) { LOG_WARN( "%s found unfinished packet for the iso handle with start packet. " "Dropping old.", __func__); BT_HDR* hdl = map_iter->second; partial_iso_packets.erase(map_iter); buffer_allocator->free(hdl); } if (ts_flag) { /* Skip timestamp u32 */ STREAM_SKIP_UINT32(stream); packet->layer_specific |= BT_ISO_HDR_CONTAINS_TS; iso_hdr_len = HCI_ISO_HEADER_LEN_WITH_TS; } if (iso_length < iso_hdr_len) { LOG_WARN("%s ISO packet too small (%d < %d). Dropping it.", __func__, packet->len, iso_hdr_len); buffer_allocator->free(packet); return; } /* Skip packet_seq. */ STREAM_SKIP_UINT16(stream); STREAM_TO_UINT16(iso_sdu_length, stream); /* Silently ignore empty report if there's no 'lost data' flag set. */ if (iso_sdu_length == 0) { buffer_allocator->free(packet); return; } packet_status_flags = HCI_ISO_GET_PACKET_STATUS_FLAGS(iso_sdu_length); iso_sdu_length = iso_sdu_length & HCI_ISO_SDU_LENGTH_MASK; if (packet_status_flags) LOG_ERROR("%s packet status flags: 0x%02x", __func__, packet_status_flags); iso_full_len = iso_sdu_length + iso_hdr_len + HCI_ISO_PREAMBLE_SIZE; if ((iso_full_len + sizeof(BT_HDR)) > BT_DEFAULT_BUFFER_SIZE) { LOG_ERROR("%s Dropping ISO packet with invalid length (%d).", __func__, iso_sdu_length); buffer_allocator->free(packet); return; } if (((boundary_flag == HCI_ISO_BF_COMPLETE_PACKET) && (iso_full_len != packet->len)) || ((boundary_flag == HCI_ISO_BF_FIRST_FRAGMENTED_PACKET) && (iso_full_len <= packet->len))) { LOG_ERROR("%s corrupted ISO frame", __func__); return; } partial_packet = (BT_HDR*)buffer_allocator->alloc(iso_full_len + sizeof(BT_HDR)); if (!partial_packet) { LOG_ERROR("%s cannot allocate partial packet", __func__); buffer_allocator->free(packet); return; } partial_packet->event = packet->event; partial_packet->len = iso_full_len; partial_packet->layer_specific = packet->layer_specific; memcpy(partial_packet->data, packet->data, packet->len); // Update the ISO data size to indicate the full expected length stream = partial_packet->data; STREAM_SKIP_UINT16(stream); // skip the ISO handle UINT16_TO_STREAM(stream, iso_full_len - HCI_ISO_PREAMBLE_SIZE); if (boundary_flag == HCI_ISO_BF_FIRST_FRAGMENTED_PACKET) { partial_packet->offset = packet->len; partial_iso_packets[handle] = partial_packet; } else { packet->layer_specific |= BT_ISO_HDR_OFFSET_POINTS_DATA; partial_packet->offset = iso_hdr_len + HCI_ISO_PREAMBLE_SIZE; callbacks->reassembled(partial_packet); } buffer_allocator->free(packet); break; case HCI_ISO_BF_CONTINUATION_FRAGMENT_PACKET: // pass-through case HCI_ISO_BF_LAST_FRAGMENT_PACKET: if (map_iter == partial_iso_packets.end()) { LOG_WARN("%s got continuation for unknown packet. Dropping it.", __func__); buffer_allocator->free(packet); return; } partial_packet = map_iter->second; if (partial_packet->len < (partial_packet->offset + packet->len - HCI_ISO_PREAMBLE_SIZE)) { LOG_ERROR( "%s got packet which would exceed expected length of %d. " "dropping full packet", __func__, partial_packet->len); buffer_allocator->free(packet); partial_iso_packets.erase(map_iter); buffer_allocator->free(partial_packet); return; } memcpy(partial_packet->data + partial_packet->offset, packet->data + HCI_ISO_PREAMBLE_SIZE, packet->len - HCI_ISO_PREAMBLE_SIZE); if (boundary_flag == HCI_ISO_BF_CONTINUATION_FRAGMENT_PACKET) { partial_packet->offset += packet->len - HCI_ISO_PREAMBLE_SIZE; buffer_allocator->free(packet); return; } if (partial_packet->len != partial_packet->offset + packet->len - HCI_ISO_PREAMBLE_SIZE) { LOG_ERROR( "%s got last fragment, but it doesn't fill up the whole packet of " "size %d", __func__, partial_packet->len); buffer_allocator->free(packet); partial_iso_packets.erase(map_iter); buffer_allocator->free(partial_packet); return; } partial_packet->layer_specific |= BT_ISO_HDR_OFFSET_POINTS_DATA; partial_packet->offset = HCI_ISO_PREAMBLE_SIZE; if (partial_packet->layer_specific & BT_ISO_HDR_CONTAINS_TS) partial_packet->offset += HCI_ISO_HEADER_LEN_WITH_TS; else partial_packet->offset += HCI_ISO_HEADER_LEN_WITHOUT_TS; buffer_allocator->free(packet); partial_iso_packets.erase(map_iter); callbacks->reassembled(partial_packet); break; default: LOG_ERROR("%s Unexpected packet, dropping full packet", __func__); buffer_allocator->free(packet); break; } } static void reassemble_and_dispatch(BT_HDR* packet) { if ((packet->event & MSG_EVT_MASK) == MSG_HC_TO_STACK_HCI_ACL) { uint8_t* stream = packet->data; uint16_t handle; uint16_t acl_length; STREAM_TO_UINT16(handle, stream); STREAM_TO_UINT16(acl_length, stream); CHECK(acl_length == packet->len - HCI_ACL_PREAMBLE_SIZE); uint8_t boundary_flag = GET_BOUNDARY_FLAG(handle); uint8_t broadcast_flag = GET_BROADCAST_FLAG(handle); handle = handle & HANDLE_MASK; if (broadcast_flag != POINT_TO_POINT) { LOG_WARN("dropping broadcast packet"); android_errorWriteLog(0x534e4554, "169327567"); buffer_allocator->free(packet); return; } if (boundary_flag == START_PACKET_BOUNDARY) { if (acl_length < 2) { LOG_WARN("%s invalid acl_length %d", __func__, acl_length); buffer_allocator->free(packet); return; } uint16_t l2cap_length; STREAM_TO_UINT16(l2cap_length, stream); auto map_iter = partial_packets.find(handle); if (map_iter != partial_packets.end()) { LOG_WARN( "%s found unfinished packet for handle with start packet. " "Dropping old.", __func__); BT_HDR* hdl = map_iter->second; partial_packets.erase(map_iter); buffer_allocator->free(hdl); } if (acl_length < L2CAP_HEADER_PDU_LEN_SIZE) { LOG_WARN("%s L2CAP packet too small (%d < %d). Dropping it.", __func__, packet->len, L2CAP_HEADER_PDU_LEN_SIZE); buffer_allocator->free(packet); return; } uint16_t full_length = l2cap_length + L2CAP_HEADER_SIZE + HCI_ACL_PREAMBLE_SIZE; // Check for buffer overflow and that the full packet size + BT_HDR size // is less than the max buffer size if (check_uint16_overflow(l2cap_length, (L2CAP_HEADER_SIZE + HCI_ACL_PREAMBLE_SIZE)) || ((full_length + sizeof(BT_HDR)) > BT_DEFAULT_BUFFER_SIZE)) { LOG_ERROR("%s Dropping L2CAP packet with invalid length (%d).", __func__, l2cap_length); buffer_allocator->free(packet); return; } if (full_length <= packet->len) { if (full_length < packet->len) LOG_WARN("%s found l2cap full length %d less than the hci length %d.", __func__, l2cap_length, packet->len); callbacks->reassembled(packet); return; } BT_HDR* partial_packet = (BT_HDR*)buffer_allocator->alloc(full_length + sizeof(BT_HDR)); partial_packet->event = packet->event; partial_packet->len = full_length; partial_packet->offset = packet->len; memcpy(partial_packet->data, packet->data, packet->len); // Update the ACL data size to indicate the full expected length stream = partial_packet->data; STREAM_SKIP_UINT16(stream); // skip the handle UINT16_TO_STREAM(stream, full_length - HCI_ACL_PREAMBLE_SIZE); partial_packets[handle] = partial_packet; // Free the old packet buffer, since we don't need it anymore buffer_allocator->free(packet); } else { auto map_iter = partial_packets.find(handle); if (map_iter == partial_packets.end()) { LOG_WARN("%s got continuation for unknown packet. Dropping it.", __func__); buffer_allocator->free(packet); return; } BT_HDR* partial_packet = map_iter->second; packet->offset = HCI_ACL_PREAMBLE_SIZE; uint16_t projected_offset = partial_packet->offset + (packet->len - HCI_ACL_PREAMBLE_SIZE); if ((packet->len - packet->offset) > (partial_packet->len - partial_packet->offset)) { LOG_WARN( "%s got packet which would exceed expected length of %d. " "Truncating.", __func__, partial_packet->len); packet->len = (partial_packet->len - partial_packet->offset) + packet->offset; projected_offset = partial_packet->len; } memcpy(partial_packet->data + partial_packet->offset, packet->data + packet->offset, packet->len - packet->offset); // Free the old packet buffer, since we don't need it anymore buffer_allocator->free(packet); partial_packet->offset = projected_offset; if (partial_packet->offset == partial_packet->len) { partial_packets.erase(handle); partial_packet->offset = 0; callbacks->reassembled(partial_packet); } } } else if ((packet->event & MSG_EVT_MASK) == MSG_HC_TO_STACK_HCI_ISO) { reassemble_and_dispatch_iso(packet); } else { callbacks->reassembled(packet); } } static const packet_fragmenter_t interface = {init, cleanup, fragment_and_dispatch, reassemble_and_dispatch}; const packet_fragmenter_t* packet_fragmenter_get_interface() { controller = controller_get_interface(); buffer_allocator = buffer_allocator_get_interface(); return &interface; } const packet_fragmenter_t* packet_fragmenter_get_test_interface( const controller_t* controller_interface, const allocator_t* buffer_allocator_interface) { controller = controller_interface; buffer_allocator = buffer_allocator_interface; return &interface; }