Skip to content

Commit 3afde67

Browse files
committed
Merge bitcoin/bitcoin#32296: refactor: reenable implicit-integer-sign-change check for serialize.h
516f068 refactor: re-enable UBSan implicit-sign-change in serialize.h (Lőrinc) 5827e93 refactor: use consistent size type for serialization template parameters (Lőrinc) Pull request description: Inspired by bitcoin/bitcoin#32154, the main goal of this PR is to reenable sanitizer checks for `serialize.h` since it's modified in a few other PRs. ACKs for top commit: maflcko: review ACK 516f068 🎈 stickies-v: ACK 516f068, nice cleanup! Tree-SHA512: 63da9bf1988a5b68e3c053b0ed786b8735f8f75b05763511522d1601b728b55798006e063137447615c266582622642d3226318fa83e488bd363f1756f8811e8
2 parents 5af757b + 516f068 commit 3afde67

File tree

2 files changed

+31
-30
lines changed

2 files changed

+31
-30
lines changed

src/serialize.h

Lines changed: 31 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -244,46 +244,48 @@ const Out& AsBase(const In& x)
244244
// Templates for serializing to anything that looks like a stream,
245245
// i.e. anything that supports .read(std::span<std::byte>) and .write(std::span<const std::byte>)
246246
//
247-
// clang-format off
248247

249248
// Typically int8_t and char are distinct types, but some systems may define int8_t
250249
// in terms of char. Forbid serialization of char in the typical case, but allow it if
251250
// it's the only way to describe an int8_t.
252251
template<class T>
253252
concept CharNotInt8 = std::same_as<T, char> && !std::same_as<T, int8_t>;
254253

254+
// clang-format off
255255
template <typename Stream, CharNotInt8 V> void Serialize(Stream&, V) = delete; // char serialization forbidden. Use uint8_t or int8_t
256256
template <typename Stream> void Serialize(Stream& s, std::byte a) { ser_writedata8(s, uint8_t(a)); }
257-
template<typename Stream> inline void Serialize(Stream& s, int8_t a ) { ser_writedata8(s, a); }
258-
template<typename Stream> inline void Serialize(Stream& s, uint8_t a ) { ser_writedata8(s, a); }
259-
template<typename Stream> inline void Serialize(Stream& s, int16_t a ) { ser_writedata16(s, a); }
260-
template<typename Stream> inline void Serialize(Stream& s, uint16_t a) { ser_writedata16(s, a); }
261-
template<typename Stream> inline void Serialize(Stream& s, int32_t a ) { ser_writedata32(s, a); }
262-
template<typename Stream> inline void Serialize(Stream& s, uint32_t a) { ser_writedata32(s, a); }
263-
template<typename Stream> inline void Serialize(Stream& s, int64_t a ) { ser_writedata64(s, a); }
264-
template<typename Stream> inline void Serialize(Stream& s, uint64_t a) { ser_writedata64(s, a); }
265-
template <typename Stream, BasicByte B, int N> void Serialize(Stream& s, const B (&a)[N]) { s.write(MakeByteSpan(a)); }
266-
template <typename Stream, BasicByte B, std::size_t N> void Serialize(Stream& s, const std::array<B, N>& a) { s.write(MakeByteSpan(a)); }
267-
template <typename Stream, BasicByte B, std::size_t N> void Serialize(Stream& s, std::span<B, N> span) { s.write(std::as_bytes(span)); }
268-
template <typename Stream, BasicByte B> void Serialize(Stream& s, std::span<B> span) { s.write(std::as_bytes(span)); }
257+
template <typename Stream> void Serialize(Stream& s, int8_t a) { ser_writedata8(s, uint8_t(a)); }
258+
template <typename Stream> void Serialize(Stream& s, uint8_t a) { ser_writedata8(s, a); }
259+
template <typename Stream> void Serialize(Stream& s, int16_t a) { ser_writedata16(s, uint16_t(a)); }
260+
template <typename Stream> void Serialize(Stream& s, uint16_t a) { ser_writedata16(s, a); }
261+
template <typename Stream> void Serialize(Stream& s, int32_t a) { ser_writedata32(s, uint32_t(a)); }
262+
template <typename Stream> void Serialize(Stream& s, uint32_t a) { ser_writedata32(s, a); }
263+
template <typename Stream> void Serialize(Stream& s, int64_t a) { ser_writedata64(s, uint64_t(a)); }
264+
template <typename Stream> void Serialize(Stream& s, uint64_t a) { ser_writedata64(s, a); }
265+
266+
template <typename Stream, BasicByte B, size_t N> void Serialize(Stream& s, const B (&a)[N]) { s.write(MakeByteSpan(a)); }
267+
template <typename Stream, BasicByte B, size_t N> void Serialize(Stream& s, const std::array<B, N>& a) { s.write(MakeByteSpan(a)); }
268+
template <typename Stream, BasicByte B, size_t N> void Serialize(Stream& s, std::span<B, N> span) { s.write(std::as_bytes(span)); }
269+
template <typename Stream, BasicByte B> void Serialize(Stream& s, std::span<B> span) { s.write(std::as_bytes(span)); }
269270

270271
template <typename Stream, CharNotInt8 V> void Unserialize(Stream&, V) = delete; // char serialization forbidden. Use uint8_t or int8_t
271-
template <typename Stream> void Unserialize(Stream& s, std::byte& a) { a = std::byte{ser_readdata8(s)}; }
272-
template<typename Stream> inline void Unserialize(Stream& s, int8_t& a ) { a = ser_readdata8(s); }
273-
template<typename Stream> inline void Unserialize(Stream& s, uint8_t& a ) { a = ser_readdata8(s); }
274-
template<typename Stream> inline void Unserialize(Stream& s, int16_t& a ) { a = ser_readdata16(s); }
275-
template<typename Stream> inline void Unserialize(Stream& s, uint16_t& a) { a = ser_readdata16(s); }
276-
template<typename Stream> inline void Unserialize(Stream& s, int32_t& a ) { a = ser_readdata32(s); }
277-
template<typename Stream> inline void Unserialize(Stream& s, uint32_t& a) { a = ser_readdata32(s); }
278-
template<typename Stream> inline void Unserialize(Stream& s, int64_t& a ) { a = ser_readdata64(s); }
279-
template<typename Stream> inline void Unserialize(Stream& s, uint64_t& a) { a = ser_readdata64(s); }
280-
template <typename Stream, BasicByte B, int N> void Unserialize(Stream& s, B (&a)[N]) { s.read(MakeWritableByteSpan(a)); }
281-
template <typename Stream, BasicByte B, std::size_t N> void Unserialize(Stream& s, std::array<B, N>& a) { s.read(MakeWritableByteSpan(a)); }
282-
template <typename Stream, BasicByte B, std::size_t N> void Unserialize(Stream& s, std::span<B, N> span) { s.read(std::as_writable_bytes(span)); }
283-
template <typename Stream, BasicByte B> void Unserialize(Stream& s, std::span<B> span) { s.read(std::as_writable_bytes(span)); }
284-
285-
template <typename Stream> inline void Serialize(Stream& s, bool a) { uint8_t f = a; ser_writedata8(s, f); }
286-
template <typename Stream> inline void Unserialize(Stream& s, bool& a) { uint8_t f = ser_readdata8(s); a = f; }
272+
template <typename Stream> void Unserialize(Stream& s, std::byte& a) { a = std::byte(ser_readdata8(s)); }
273+
template <typename Stream> void Unserialize(Stream& s, int8_t& a) { a = int8_t(ser_readdata8(s)); }
274+
template <typename Stream> void Unserialize(Stream& s, uint8_t& a) { a = ser_readdata8(s); }
275+
template <typename Stream> void Unserialize(Stream& s, int16_t& a) { a = int16_t(ser_readdata16(s)); }
276+
template <typename Stream> void Unserialize(Stream& s, uint16_t& a) { a = ser_readdata16(s); }
277+
template <typename Stream> void Unserialize(Stream& s, int32_t& a) { a = int32_t(ser_readdata32(s)); }
278+
template <typename Stream> void Unserialize(Stream& s, uint32_t& a) { a = ser_readdata32(s); }
279+
template <typename Stream> void Unserialize(Stream& s, int64_t& a) { a = int64_t(ser_readdata64(s)); }
280+
template <typename Stream> void Unserialize(Stream& s, uint64_t& a) { a = ser_readdata64(s); }
281+
282+
template <typename Stream, BasicByte B, size_t N> void Unserialize(Stream& s, B (&a)[N]) { s.read(MakeWritableByteSpan(a)); }
283+
template <typename Stream, BasicByte B, size_t N> void Unserialize(Stream& s, std::array<B, N>& a) { s.read(MakeWritableByteSpan(a)); }
284+
template <typename Stream, BasicByte B, size_t N> void Unserialize(Stream& s, std::span<B, N> span) { s.read(std::as_writable_bytes(span)); }
285+
template <typename Stream, BasicByte B> void Unserialize(Stream& s, std::span<B> span) { s.read(std::as_writable_bytes(span)); }
286+
287+
template <typename Stream> void Serialize(Stream& s, bool a) { uint8_t f = a; ser_writedata8(s, f); }
288+
template <typename Stream> void Unserialize(Stream& s, bool& a) { uint8_t f = ser_readdata8(s); a = f; }
287289
// clang-format on
288290

289291

test/sanitizer_suppressions/ubsan

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,6 @@ implicit-integer-sign-change:crypto/
6363
implicit-integer-sign-change:TxConfirmStats::removeTx
6464
implicit-integer-sign-change:verify_flags
6565
implicit-integer-sign-change:EvalScript
66-
implicit-integer-sign-change:serialize.h
6766
implicit-signed-integer-truncation:crypto/
6867
implicit-unsigned-integer-truncation:crypto/
6968
shift-base:arith_uint256.cpp

0 commit comments

Comments
 (0)