Repository navigation
Version 2.0.2
[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_PGOandENABLE_LTO. Profile-guided optimization trains inpgo-instrand installs this build. Link-time optimization followsENABLE_LTO(default ON) for every build type. Both apply to Buffer. Base, Logger and System are not rebuilt.- Release archives include
THIRD-PARTY(notTHIRDPARTY: on Windows and macOS that name is the same path as thethirdparty/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=OFFandENABLE_TEST=ON, then runs ctest. Profile-guided optimization stays on the release workflow. cmake/optimizations.cmakeis the same file as Base. On Release, and only when that language was not set from the outside, it appendsOPTIMIZATION_FLAGS_LINUX,OPTIMIZATION_FLAGS_MACorOPTIMIZATION_FLAGS_WINDOWS. Linux is-O2 -march=x86-64-v3, Apple is-O2 -mcpu=apple-m1, Windows is/O2 /arch:AVX2. There is no/fp:fastand no/EHsc.cmake/pgo.cmakeis 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
buildmastersubmodule 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 withBACKEND=binary. Base is declared here: Logger and System no longer carry it as a submodule. The archive matches this OS and C++ runtime:libstdc++orlibc++on Linux and macOS, no runtime suffix on Windows. Doxygen include path is${BUILDMASTER_INSTALL_INCLUDEDIR}. - Breaking:
Buffer::Exception,ReadErrorandWriteErrorno longer format withstd::format. A message with arguments replaces literal{}throughSafe::String::ReplaceToken, the same rule as Base 2.1.0.what()staysStormByte.Buffer: message,StormByte.Buffer.Read: messageandStormByte.Buffer.Write: message. - Bumped the project version to 2.0.2.
Fixed
- Prevented
BufferedWriterfrom scheduling failed drains or calling derived origin hooks afterClose()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. BufferedLocationReaderandBufferedLocationWriterno 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 passesParameters. That bag is unpacked in the caller (it ownsSafe::Optional) and only the resulting scalars cross the DLL.m_iois 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-O2and the CPU baseline.HopperandSinkadmit an element aligned up to__STDCPP_DEFAULT_NEW_ALIGNMENT__. They used to requirealignof(std::max_align_t). Base's heap isoperator new(std::size_t), which returns 16-byte alignment on every supported platform. On macOSmax_align_tis only 8, so the 16-byteSafe::Stringwas rejected. A value aligned past whatoperator newguarantees is still rejected.- Part of the port: the DLL does not return a
std::object.std::strong_orderingis 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 areSTORMBYTE_FORCE_INLINE. A signature that must returnstd::(operator std::string) isSTORMBYTE_FORCE_INLINEin the header too. This archive must be built against that Base. cmake/pgo.cmakematches Base. MSVC PGO links with/LTCG:PGINSTRUMENTand/LTCG:PGOPTIMIZE./GENPROFILEalone fails with LNK1220 because the currentlink.exerequires an/LTCGspecification, and CMake's own/LTCGstays off so it does not replace the profile mode. The profile mode isadd_link_optionson this project, notCMAKE_EXE_LINKER_FLAGS. A nestedproject()inherits the cache and its compiler test linkscmTC_*.exe, which was never instrumented, so/LTCG:PGOPTIMIZEaborted with LNK1266 (cmTC_*.pgdmissing). The cache keeps a bare/LTCGso those/GLobjects still link. A static dependency stays LTCG and is optimized by the link that owns the.pgd.- Clang PGO drops
.profrawfiles left by compiler probes before ctest, andllvm-profdata mergeuses-failure-mode=all. A probe writes a few hundred bytes formain, with a padded empty symbol name. The default failure mode isany, so that one file aborted the merge even after the instrumented tests had passed.