PDL: Factor out insert functions (96c55e83) · Commits · e / os / android_packages_modules_Bluetooth

system/gd/packet/base_struct.h

0 → 100644

+45 −0

Original line number	Diff line number	Diff line
		/*
		* Copyright 2019 The Android Open Source Project
		*
		* 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.
		*/

		#pragma once

		#include <cstdint>
		#include <forward_list>
		#include <iterator>
		#include <memory>
		#include <vector>

		#include "packet/bit_inserter.h"

		namespace bluetooth {
		namespace packet {

		// A base struct to provide Serialize() and size() to be overridden.
		class BaseStruct {
		public:
		virtual ~BaseStruct() = default;

		virtual size_t size() const = 0;

		// Write to the vector with the given iterator.
		virtual void Serialize(BitInserter& it) const = 0;

		protected:
		BaseStruct() = default;
		};

		} // namespace packet
		} // namespace bluetooth

system/gd/packet/endian_inserter.h

0 → 100644

+91 −0

Original line number	Diff line number	Diff line
		/*
		* Copyright 2019 The Android Open Source Project
		*
		* 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.
		*/

		#pragma once

		#include <cstdint>
		#include <forward_list>
		#include <iterator>
		#include <memory>
		#include <vector>

		#include "os/log.h"
		#include "packet/bit_inserter.h"

		namespace bluetooth {
		namespace packet {

		// Abstract base class that is subclassed to provide insert() functions.
		// The template parameter little_endian controls the generation of insert().
		template <bool little_endian>
		class EndianInserter {
		public:
		EndianInserter() = default;
		virtual ~EndianInserter() = default;

		protected:
		// Write sizeof(FixedWidthIntegerType) bytes using the iterator
		template <typename FixedWidthPODType, typename std::enable_if<std::is_pod<FixedWidthPODType>::value, int>::type = 0>
		void insert(FixedWidthPODType value, BitInserter& it) const {
		uint8_t* raw_bytes = (uint8_t*)&value;
		for (size_t i = 0; i < sizeof(FixedWidthPODType); i++) {
		if (little_endian == true) {
		it.insert_byte(raw_bytes[i]);
		} else {
		it.insert_byte(raw_bytes[sizeof(FixedWidthPODType) - i - 1]);
		}
		}
		}

		// Write num_bits bits using the iterator
		template <typename FixedWidthIntegerType,
		typename std::enable_if<std::is_pod<FixedWidthIntegerType>::value, int>::type = 0>
		void insert(FixedWidthIntegerType value, BitInserter& it, size_t num_bits) const {
		ASSERT(num_bits <= (sizeof(FixedWidthIntegerType) * 8));

		for (size_t i = 0; i < num_bits / 8; i++) {
		if (little_endian == true) {
		it.insert_byte(static_cast<uint8_t>(value >> (i * 8)));
		} else {
		it.insert_byte(static_cast<uint8_t>(value >> (((num_bits / 8) - i - 1) * 8)));
		}
		}
		if (num_bits % 8) {
		it.insert_bits(static_cast<uint8_t>(value >> ((num_bits / 8) * 8)), num_bits % 8);
		}
		}

		// Specialized insert that allows inserting enums without casting
		template <typename Enum, typename std::enable_if<std::is_enum_v<Enum>, int>::type = 0>
		inline void insert(Enum value, BitInserter& it) const {
		using enum_type = typename std::underlying_type_t<Enum>;
		static_assert(std::is_unsigned_v<enum_type>, "Enum type is signed. Did you forget to specify the enum size?");
		insert<enum_type>(static_cast<enum_type>(value), it);
		}

		// Write a vector of FixedWidthIntegerType using the iterator
		template <typename FixedWidthIntegerType>
		void insert_vector(const std::vector<FixedWidthIntegerType>& vec, BitInserter& it) const {
		static_assert(std::is_pod<FixedWidthIntegerType>::value,
		"EndianInserter::insert requires a vector with elements of a fixed-size.");
		for (const auto& element : vec) {
		insert(element, it);
		}
		}
		};

		} // namespace packet
		} // namespace bluetooth

system/gd/packet/packet_builder.h

+2 −51

Original line number	Diff line number	Diff line
		@@ -25,6 +25,7 @@
		#include "os/log.h"
		#include "packet/base_packet_builder.h"
		#include "packet/bit_inserter.h"
		#include "packet/endian_inserter.h"

		namespace bluetooth {
		namespace packet {
		@@ -32,63 +33,13 @@ namespace packet {
		// Abstract base class that is subclassed to build specifc packets.
		// The template parameter little_endian controls the generation of insert().
		template <bool little_endian>
		class PacketBuilder : public BasePacketBuilder {
		class PacketBuilder : public BasePacketBuilder, protected EndianInserter<little_endian> {
		public:
		PacketBuilder() = default;
		virtual ~PacketBuilder() = default;

		// Classes which need fragmentation should define a function like this:
		// std::forward_list<DerivedBuilder>& Fragment(size_t max_size);

		protected:
		// Write sizeof(FixedWidthIntegerType) bytes using the iterator
		template <typename FixedWidthPODType, typename std::enable_if<std::is_pod<FixedWidthPODType>::value, int>::type = 0>
		void insert(FixedWidthPODType value, BitInserter& it) const {
		uint8_t* raw_bytes = (uint8_t*)&value;
		for (size_t i = 0; i < sizeof(FixedWidthPODType); i++) {
		if (little_endian == true) {
		it.insert_byte(raw_bytes[i]);
		} else {
		it.insert_byte(raw_bytes[sizeof(FixedWidthPODType) - i - 1]);
		}
		}
		}

		// Write num_bits bits using the iterator
		template <typename FixedWidthIntegerType,
		typename std::enable_if<std::is_pod<FixedWidthIntegerType>::value, int>::type = 0>
		void insert(FixedWidthIntegerType value, BitInserter& it, size_t num_bits) const {
		ASSERT(num_bits <= (sizeof(FixedWidthIntegerType) * 8));

		for (size_t i = 0; i < num_bits / 8; i++) {
		if (little_endian == true) {
		it.insert_byte(static_cast<uint8_t>(value >> (i * 8)));
		} else {
		it.insert_byte(static_cast<uint8_t>(value >> (((num_bits / 8) - i - 1) * 8)));
		}
		}
		if (num_bits % 8) {
		it.insert_bits(static_cast<uint8_t>(value >> ((num_bits / 8) * 8)), num_bits % 8);
		}
		}

		// Specialized insert that allows inserting enums without casting
		template <typename Enum, typename std::enable_if<std::is_enum_v<Enum>, int>::type = 0>
		inline void insert(Enum value, BitInserter& it) const {
		using enum_type = typename std::underlying_type_t<Enum>;
		static_assert(std::is_unsigned_v<enum_type>, "Enum type is signed. Did you forget to specify the enum size?");
		insert<enum_type>(static_cast<enum_type>(value), it);
		}

		// Write a vector of FixedWidthIntegerType using the iterator
		template <typename FixedWidthIntegerType>
		void insert_vector(const std::vector<FixedWidthIntegerType>& vec, BitInserter& it) const {
		static_assert(std::is_pod<FixedWidthIntegerType>::value,
		"PacketBuilder::insert requires a vector with elements of a fixed-size.");
		for (const auto& element : vec) {
		insert(element, it);
		}
		}
		};

		} // namespace packet

system/gd/packet/packet_struct.h

0 → 100644

+43 −0

Original line number	Diff line number	Diff line
		/*
		* Copyright 2019 The Android Open Source Project
		*
		* 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.
		*/

		#pragma once

		#include <cstdint>
		#include <forward_list>
		#include <iterator>
		#include <memory>
		#include <vector>

		#include "os/log.h"
		#include "packet/base_struct.h"
		#include "packet/bit_inserter.h"
		#include "packet/endian_inserter.h"

		namespace bluetooth {
		namespace packet {

		// Abstract base class that is subclassed to build specifc structs.
		// The template parameter little_endian controls the generation of insert().
		template <bool little_endian>
		class PacketStruct : public BaseStruct, protected EndianInserter<little_endian> {
		public:
		PacketStruct() = default;
		virtual ~PacketStruct() = default;
		};

		} // namespace packet
		} // namespace bluetooth