Skip to content

Version 2.0.2

Choose a tag to compare

@StormBytePP StormBytePP released this 20 Oct 14:27
· 6 commits to master since this release

[Summary]

StormByte Buffer is the byte-buffer module of the StormByte C++ suite.

It depends on StormByte Base 2.1.0, StormByte-Logger 2.0.2 and StormByte-System 2.0.2. Base is its own archive: Logger and System no longer bring it. This repository is not Base, Config, Crypto, Database, Logger, Multimedia, Network or System.

Public headers under StormByte/buffer/ cover FIFO, SharedFIFO, Ring, Producer/Consumer, Hopper, Sink, Bridge, Pipeline and StormByte::Buffer::IO (buffered binary sources and sinks). Octet payloads are StormByte::Safe::Binary. Byte lengths are StormByte::ByteSize. Hopper and Sink count items with StormByte::Size.

If you landed here from a release link and have not read the tree:

  • What this module is, how to build it, and short examples: README.md
  • License: GNU Lesser General Public License version 3 or later, LICENSE

Added

  • ENABLE_PGO and ENABLE_LTO. Profile-guided optimization trains in pgo-instr and installs this build. Link-time optimization follows ENABLE_LTO (default ON) for every build type. Both apply to Buffer. Base, Logger and System are not rebuilt.
  • Release archives include THIRD-PARTY (not THIRDPARTY: on Windows and macOS that name is the same path as the thirdparty/ directory, so the file never landed in those zips). No third-party object code is compiled into this shared library. Base, Logger and System are linked at run time and keep their own notices.

Changed

  • CI builds with ENABLE_LTO=ON, ENABLE_PGO=OFF and ENABLE_TEST=ON, then runs ctest. Profile-guided optimization stays on the release workflow.
  • cmake/optimizations.cmake is the same file as Base. On Release, and only when that language was not set from the outside, it appends OPTIMIZATION_FLAGS_LINUX, OPTIMIZATION_FLAGS_MAC or OPTIMIZATION_FLAGS_WINDOWS. Linux is -O2 -march=x86-64-v3, Apple is -O2 -mcpu=apple-m1, Windows is /O2 /arch:AVX2. There is no /fp:fast and no /EHsc. cmake/pgo.cmake is the same file as Base, so a forwarded list keeps its semicolons.
  • Requires StormByte-BuildMaster >= 2.1.0. An older install is not used; the buildmaster submodule supplies 2.1.2.
  • Requires StormByte Base 2.1.0, StormByte-Logger 2.0.2 and StormByte-System 2.0.2. Each is a release archive (stormbyte_component_url) linked with BACKEND=binary. Base is declared here: Logger and System no longer carry it as a submodule. The archive matches this OS and C++ runtime: libstdc++ or libc++ on Linux and macOS, no runtime suffix on Windows. Doxygen include path is ${BUILDMASTER_INSTALL_INCLUDEDIR}.
  • Breaking: Buffer::Exception, ReadError and WriteError no longer format with std::format. A message with arguments replaces literal {} through Safe::String::ReplaceToken, the same rule as Base 2.1.0. what() stays StormByte.Buffer: message, StormByte.Buffer.Read: message and StormByte.Buffer.Write: message.
  • Bumped the project version to 2.0.2.

Fixed

  • Prevented BufferedWriter from scheduling failed drains or calling derived origin hooks after Close() returns. Flush() now also wakes and fails when a concurrent close shuts the writer. Serialized reader prefetch with origin close to prevent post-close origin calls.
  • BufferedLocationReader and BufferedLocationWriter no longer use a delegating constructor. Both classes are abstract, so GCC does not emit the complete-object constructor (C1), and the header constructor was the reference Multimedia's test library could not resolve under LTO. A leaf still passes Parameters. That bag is unpacked in the caller (it owns Safe::Optional) and only the resulting scalars cross the DLL. m_io is still created in this library.
  • -stdlib=libc++ and -stdlib=libstdc++ do not count as custom C++ flags. If either is the only extra flag, Release still gets -O2 and the CPU baseline.
  • Hopper and Sink admit an element aligned up to __STDCPP_DEFAULT_NEW_ALIGNMENT__. They used to require alignof(std::max_align_t). Base's heap is operator new(std::size_t), which returns 16-byte alignment on every supported platform. On macOS max_align_t is only 8, so the 16-byte Safe::String was rejected. A value aligned past what operator new guarantees is still rejected.
  • Part of the port: the DLL does not return a std:: object. std::strong_ordering is not a DLL ABI. clang-cl returns it through a hidden pointer and MSVC does not pass one, so a call into a clang-built Base wrote at address 0. Ordering is compiled by the caller from Base 2.1.0, where those operators are STORMBYTE_FORCE_INLINE. A signature that must return std:: (operator std::string) is STORMBYTE_FORCE_INLINE in the header too. This archive must be built against that Base.
  • cmake/pgo.cmake matches Base. MSVC PGO links with /LTCG:PGINSTRUMENT and /LTCG:PGOPTIMIZE. /GENPROFILE alone fails with LNK1220 because the current link.exe requires an /LTCG specification, and CMake's own /LTCG stays off so it does not replace the profile mode. The profile mode is add_link_options on this project, not CMAKE_EXE_LINKER_FLAGS. A nested project() inherits the cache and its compiler test links cmTC_*.exe, which was never instrumented, so /LTCG:PGOPTIMIZE aborted with LNK1266 (cmTC_*.pgd missing). The cache keeps a bare /LTCG so those /GL objects still link. A static dependency stays LTCG and is optimized by the link that owns the .pgd.
  • Clang PGO drops .profraw files left by compiler probes before ctest, and llvm-profdata merge uses -failure-mode=all. A probe writes a few hundred bytes for main, with a padded empty symbol name. The default failure mode is any, so that one file aborted the merge even after the instrumented tests had passed.