diff options
author | Cronet Mainline Eng <cronet-mainline-eng+copybara@google.com> | 2023-03-20 09:24:50 -0800 |
---|---|---|
committer | Patrick Rohr <prohr@google.com> | 2023-03-20 10:25:51 -0700 |
commit | 14c9064f78517fd0e9366547030c0493aa075b47 (patch) | |
tree | 6e03046ec4055bb9881ff0341716266b5d53782b /base/big_endian.h | |
parent | d1add53d6e90815f363c91d433735556ce79b0d2 (diff) | |
download | cronet-14c9064f78517fd0e9366547030c0493aa075b47.tar.gz |
Import Cronet version 108.0.5359.128
Project import generated by Copybara.
FolderOrigin-RevId: /tmp/copybara-origin/src
Test: none
Change-Id: I98ebcd5784650764c7cd70ab175dd4e1cc790dff
Diffstat (limited to 'base/big_endian.h')
-rw-r--r-- | base/big_endian.h | 147 |
1 files changed, 147 insertions, 0 deletions
diff --git a/base/big_endian.h b/base/big_endian.h new file mode 100644 index 000000000..c8a1dcfde --- /dev/null +++ b/base/big_endian.h @@ -0,0 +1,147 @@ +// Copyright 2014 The Chromium Authors +// Use of this source code is governed by a BSD-style license that can be +// found in the LICENSE file. + +#ifndef BASE_BIG_ENDIAN_H_ +#define BASE_BIG_ENDIAN_H_ + +#include <stddef.h> +#include <stdint.h> +#include <type_traits> + +#include "base/base_export.h" +#include "base/containers/span.h" +#include "base/memory/raw_ptr.h" +#include "base/strings/string_piece.h" + +namespace base { + +// Read an integer (signed or unsigned) from |buf| in Big Endian order. +// Note: this loop is unrolled with -O1 and above. +// NOTE(szym): glibc dns-canon.c use ntohs(*(uint16_t*)ptr) which is +// potentially unaligned. +// This would cause SIGBUS on ARMv5 or earlier and ARMv6-M. +template <typename T> +inline void ReadBigEndian(const uint8_t buf[], T* out) { + static_assert(std::is_integral<T>::value, "T has to be an integral type."); + // Make an unsigned version of the output type to make shift possible + // without UB. + typename std::make_unsigned<T>::type unsigned_result = buf[0]; + for (size_t i = 1; i < sizeof(T); ++i) { + unsigned_result <<= 8; + // Must cast to uint8_t to avoid clobbering by sign extension. + unsigned_result |= buf[i]; + } + *out = unsigned_result; +} + +// Write an integer (signed or unsigned) |val| to |buf| in Big Endian order. +// Note: this loop is unrolled with -O1 and above. +template<typename T> +inline void WriteBigEndian(char buf[], T val) { + static_assert(std::is_integral<T>::value, "T has to be an integral type."); + auto unsigned_val = static_cast<typename std::make_unsigned<T>::type>(val); + for (size_t i = 0; i < sizeof(T); ++i) { + buf[sizeof(T) - i - 1] = static_cast<char>(unsigned_val & 0xFF); + unsigned_val >>= 8; + } +} + +// Specializations to make clang happy about the (dead code) shifts above. +template <> +inline void ReadBigEndian<uint8_t>(const uint8_t buf[], uint8_t* out) { + *out = buf[0]; +} + +template <> +inline void WriteBigEndian<uint8_t>(char buf[], uint8_t val) { + buf[0] = static_cast<char>(val); +} + +template <> +inline void ReadBigEndian<int8_t>(const uint8_t buf[], int8_t* out) { + *out = static_cast<int8_t>(buf[0]); +} + +template <> +inline void WriteBigEndian<int8_t>(char buf[], int8_t val) { + buf[0] = static_cast<char>(val); +} + +// Allows reading integers in network order (big endian) while iterating over +// an underlying buffer. All the reading functions advance the internal pointer. +class BASE_EXPORT BigEndianReader { + public: + static BigEndianReader FromStringPiece(base::StringPiece string_piece); + + BigEndianReader(const uint8_t* buf, size_t len); + explicit BigEndianReader(base::span<const uint8_t> buf); + + const uint8_t* ptr() const { return ptr_; } + size_t remaining() const { return static_cast<size_t>(end_ - ptr_); } + + bool Skip(size_t len); + bool ReadBytes(void* out, size_t len); + // Creates a StringPiece in |out| that points to the underlying buffer. + bool ReadPiece(base::StringPiece* out, size_t len); + bool ReadSpan(base::span<const uint8_t>* out, size_t len); + + bool ReadU8(uint8_t* value); + bool ReadU16(uint16_t* value); + bool ReadU32(uint32_t* value); + bool ReadU64(uint64_t* value); + + // Reads a length-prefixed region: + // 1. reads a big-endian length L from the buffer; + // 2. sets |*out| to a StringPiece over the next L many bytes + // of the buffer (beyond the end of the bytes encoding the length); and + // 3. skips the main reader past this L-byte substring. + // + // Fails if reading a U8 or U16 fails, or if the parsed length is greater + // than the number of bytes remaining in the stream. + // + // On failure, leaves the stream at the same position + // as before the call. + bool ReadU8LengthPrefixed(base::StringPiece* out); + bool ReadU16LengthPrefixed(base::StringPiece* out); + + private: + // Hidden to promote type safety. + template<typename T> + bool Read(T* v); + template <typename T> + bool ReadLengthPrefixed(base::StringPiece* out); + + const uint8_t* ptr_; + const uint8_t* end_; +}; + +// Allows writing integers in network order (big endian) while iterating over +// an underlying buffer. All the writing functions advance the internal pointer. +class BASE_EXPORT BigEndianWriter { + public: + BigEndianWriter(char* buf, size_t len); + + char* ptr() const { return ptr_; } + size_t remaining() const { return static_cast<size_t>(end_ - ptr_); } + + bool Skip(size_t len); + bool WriteBytes(const void* buf, size_t len); + bool WriteU8(uint8_t value); + bool WriteU16(uint16_t value); + bool WriteU32(uint32_t value); + bool WriteU64(uint64_t value); + + private: + // Hidden to promote type safety. + template<typename T> + bool Write(T v); + + // TODO(crbug.com/1298696): Breaks net_unittests. + raw_ptr<char, DegradeToNoOpWhenMTE> ptr_; + raw_ptr<char, DegradeToNoOpWhenMTE> end_; +}; + +} // namespace base + +#endif // BASE_BIG_ENDIAN_H_ |