ichthyo/LUMIERA.clone
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

BufferProvider: reshape diagnostics into a decorator

Browse source 
The intention is to build the tracking functionality from scratch,
while wrapping the old implementation as delegate. Hopefully this allows
to reduce the complexity of the existing implementation step by step,
until I'm ''able to grasp what this implementation does''.

This old implementation works, but is highly problematic code.
The Git history shows that I had already problems to understand this code
while building the DiagnosticOutputSlot, one year later.

To my defense, in both cases (2011 and 2012), I had no clear idea yet
how the processing within the engine would work, and thus I considered
that Buffer Type registry a mere implementation detail, that can be
lumped into the »code behind«.
This commit is contained in:
Fischlurch 2026-02-08 23:44:17 +01:00
parent 1ebefbe36e
commit bb6401aaf3
7 changed files with 130 additions and 131 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

67
src/steam/engine/diagnostic-buffer-provider.cpp
View file

@ -20,8 +20,9 @@
*/
#include "lib/error.hpp"
#include "lib/meta/function.hpp"
//#include "lib/error.hpp"
//#include "include/logging.h"
//#include "lib/meta/function.hpp"
#include "steam/engine/diagnostic-buffer-provider.hpp"
#include "steam/engine/heap-mem-provider.hpp"
@ -31,54 +32,14 @@ namespace steam {
namespace engine {
/** Storage for the diagnostics frontend */
lib::Depend<DiagnosticBufferProvider> DiagnosticBufferProvider::diagnostics;
DiagnosticBufferProvider::DiagnosticBufferProvider()
: pImpl_()
: BufferProvider{"Diagnostic_HeapAllocated"}
{ }
DiagnosticBufferProvider::~DiagnosticBufferProvider() { }
BufferProvider&
DiagnosticBufferProvider::build()
{
return diagnostics().reset();
}
DiagnosticBufferProvider&
DiagnosticBufferProvider::access (BufferProvider const& provider)
{
if (!diagnostics().isCurrent (provider))
throw error::Invalid("given Provider doesn't match (current) diagnostic data record."
"This might be an lifecycle error. Did you build() this instance beforehand?");
return diagnostics();
}
HeapMemProvider&
DiagnosticBufferProvider::reset()
{
if (pImpl_)
pImpl_->markAllEmitted();
pImpl_.reset(new HeapMemProvider());
return *pImpl_;
}
bool
DiagnosticBufferProvider::isCurrent (BufferProvider const& implInstance)
{
return &implInstance == pImpl_.get();
}
DiagnosticBufferProvider::~DiagnosticBufferProvider()
{
// INFO (proc_mem, "discarding %zu diagnostic buffer entries", outSeq_.size()); ////////////OOO implement based on dedicated tracking information in-object
}
@ -86,23 +47,23 @@ namespace engine {
/* === diagnostic API === */
bool
DiagnosticBufferProvider::buffer_was_used (uint bufferID) const
BufferDiagnostic::buffer_was_used (uint bufferID)
{
return pImpl_->access_emitted(bufferID).was_used();
return dbp_.heapMemProvider_.access_emitted(bufferID).was_used();
}
bool
DiagnosticBufferProvider::buffer_was_closed (uint bufferID) const
BufferDiagnostic::buffer_was_closed (uint bufferID)
{
return pImpl_->access_emitted(bufferID).was_closed();
return dbp_.heapMemProvider_.access_emitted(bufferID).was_closed();
}
void*
DiagnosticBufferProvider::accessMemory (uint bufferID) const
BufferDiagnostic::accessMemory (uint bufferID)
{
return pImpl_->access_emitted(bufferID).accessMemory();
return dbp_.heapMemProvider_.access_emitted(bufferID).accessMemory();
}

82
src/steam/engine/diagnostic-buffer-provider.hpp
View file

@ -1,5 +1,5 @@
/*
DIAGNOSTIC-BUFFER-PROVIDER.hpp - helper for testing against the BufferProvider interface
DIAGNOSTIC-BUFFER-PROVIDER.hpp - helper for testing against the BufferProvider interf,ttace
Copyright (C)
2011, Hermann Vosseler <Ichthyostega@web.de>
@ -22,10 +22,9 @@
#include "lib/error.hpp"
#include "lib/depend.hpp"
#include "lib/util.hpp"
#include "steam/engine/type-handler.hpp"
#include "steam/engine/buffer-provider.hpp"
#include "steam/engine/type-handler.hpp" ///////////////OOO warum?
#include "steam/engine/heap-mem-provider.hpp"
#include "lib/nocopy.hpp"
#include <memory>
@ -36,12 +35,8 @@ namespace engine {
namespace error = lumiera::error;
class BufferDiagnostic;
/**
* simple BufferProvider implementation
* with additional allocation tracking
*/
class HeapMemProvider;
/****************************************************************//**
@ -50,52 +45,49 @@ namespace engine {
* @todo write type comment
*/
class DiagnosticBufferProvider
: util::NonCopyable
: public BufferProvider
{
std::unique_ptr<HeapMemProvider> pImpl_;
static lib::Depend<DiagnosticBufferProvider> diagnostics;
HeapMemProvider heapMemProvider_;
HeapMemProvider& reset();
bool isCurrent (BufferProvider const&);
/* === delegate BufferProvider API === */
uint prepareBuffers (uint count, HashVal typeID) override { return heapMemProvider_.prepareBuffers (count,typeID);}
BuffHandle provideLockedBuffer (HashVal typeID) override { return heapMemProvider_.provideLockedBuffer (typeID); }
void mark_emitted (HashVal h, LocalTag const& t) override { heapMemProvider_.mark_emitted(h,t); }
void detachBuffer (HashVal h, LocalTag const& t, Buff& b) override { heapMemProvider_.detachBuffer(h,t,b); }
DiagnosticBufferProvider();
~DiagnosticBufferProvider();
friend class lib::DependencyFactory<DiagnosticBufferProvider>;
public:
/** build a new Diagnostic Buffer Provider instance,
* discard the existing one. Use the static query API
* for investigating collected data. */
static BufferProvider& build();
/** access the diagnostic API of the buffer provider
* @throw error::Invalid if the given provider doesn't allow
* for diagnostic access or wasn't registered beforehand.
*/
static DiagnosticBufferProvider&
access (BufferProvider const& );
/* === diagnostic API === */
bool buffer_was_used (uint bufferID) const;
bool buffer_was_closed (uint bufferID) const;
void* accessMemory (uint bufferID) const;
bool all_buffers_released() const;
~DiagnosticBufferProvider();
DiagnosticBufferProvider();
private:
/// „backdoor“ to watch instrumentation from tests
friend class BufferDiagnostic;
};
class BufferDiagnostic
: util::MoveOnly
{
DiagnosticBufferProvider& dbp_;
public:
BufferDiagnostic (DiagnosticBufferProvider& thePro)
: dbp_{thePro}
{ }
bool buffer_was_used (uint bufferID);
bool buffer_was_closed (uint bufferID);
void* accessMemory (uint bufferID);
bool all_buffers_released();
};
inline BufferDiagnostic
watch (BufferProvider& thePro)
{
return BufferDiagnostic{dynamic_cast<DiagnosticBufferProvider&> (thePro)};
}
}} // namespace steam::engine

8
src/steam/engine/heap-mem-provider.cpp
View file

@ -223,15 +223,13 @@ namespace engine {
* @internal create a memory tracking BufferProvider,
*/
HeapMemProvider::HeapMemProvider()
: BufferProvider ("Diagnostic_HeapAllocated")
: BufferProvider ("Naive_HeapAllocated")
, pool_(new diagn::PoolTable)
, outSeq_()
{ }
HeapMemProvider::~HeapMemProvider()
{
INFO (proc_mem, "discarding %zu diagnostic buffer entries", outSeq_.size());
}
HeapMemProvider::~HeapMemProvider() { /* emit dtor of BlockPool here */ }
/* ==== Implementation of the BufferProvider interface ==== */

2
src/steam/engine/heap-mem-provider.hpp
View file

@ -131,8 +131,8 @@ namespace engine {
virtual void detachBuffer (HashVal, LocalTag const&, Buff&) override;
public:
~HeapMemProvider();
HeapMemProvider();
virtual ~HeapMemProvider();
size_t emittedCnt() const;

24
tests/core/steam/engine/buffer-provider-protocol-test.cpp
View file

@ -91,7 +91,7 @@ namespace test {
// Create Test fixture.
// In real usage, a suitable memory/frame/buffer provider
// will be preconfigured, depending on the usage context
BufferProvider& provider = DiagnosticBufferProvider::build();
DiagnosticBufferProvider provider;
BuffHandle buff = provider.lockBufferFor<TestFrame>();
CHECK (buff.isValid());
@ -106,11 +106,11 @@ namespace test {
CHECK (!buff.isValid());
VERIFY_ERROR (LIFECYCLE, buff.accessAs<TestFrame>() );
DiagnosticBufferProvider& checker = DiagnosticBufferProvider::access(provider);
CHECK (checker.buffer_was_used (0));
CHECK (checker.buffer_was_closed (0));
auto diagnostic = watch(provider);
CHECK (diagnostic.buffer_was_used (0));
CHECK (diagnostic.buffer_was_closed (0));
CHECK (testData(0) == checker.accessMemory (0));
CHECK (testData(0) == diagnostic.accessMemory (0));
}
@ -120,7 +120,7 @@ namespace test {
verifyRenderingUsage()
{
// Test fixture: allows to track/verify allocations after the fact
BufferProvider& provider = DiagnosticBufferProvider::build();
DiagnosticBufferProvider provider;
using DataBuff = std::array<int64_t, TestFrame::BUFFSIZ>;
constexpr auto BUFFSIZ = sizeof(DataBuff);
@ -174,17 +174,17 @@ namespace test {
auto endSum = workBuff.accessAs<TestFrame>().getChecksum();
workBuff.release(); // note: not every buffer need be emitted.
DiagnosticBufferProvider& checker = DiagnosticBufferProvider::access(provider);
CHECK (checker.buffer_was_used (0));
CHECK (checker.buffer_was_closed (0));
// CHECK (checker.all_buffers_released()); ///////////////OOO do we need this API?
auto diagnostic = watch(provider);
CHECK (diagnostic.buffer_was_used (0));
CHECK (diagnostic.buffer_was_closed (0));
// CHECK (diagnostic.all_buffers_released()); ///////////////OOO do we need this API?
}
void
verifyObjectAttachment()
{
BufferProvider& provider = DiagnosticBufferProvider::build();
DiagnosticBufferProvider provider;
BuffDescr type_A = provider.getDescriptorFor(sizeof(TestFrame));
BuffDescr type_B = provider.getDescriptorFor(sizeof(int));
BuffDescr type_C = provider.getDescriptor<int>();
@ -221,7 +221,7 @@ namespace test {
void
verifyObjectAttachmentFailure()
{
BufferProvider& provider = DiagnosticBufferProvider::build();
DiagnosticBufferProvider provider;
BuffDescr type_D = provider.getDescriptorFor(sizeof(Dummy));
Dummy::checksum() = 0;

8
tests/core/steam/engine/node-feed-test.cpp
View file

@ -17,6 +17,8 @@
#include "lib/test/run.hpp"
#include "lib/depend-inject.hpp"
#include "steam/engine/engine-ctx.hpp"
#include "steam/engine/proc-node.hpp"
#include "steam/engine/node-builder.hpp"
#include "steam/engine/media-weaving-pattern.hpp"
@ -86,10 +88,10 @@ namespace test {
using WeavingPattern = MediaWeavingPattern<Prototype>;
using TurnoutWeaving = Turnout<WeavingPattern>;
BufferProvider& provider = DiagnosticBufferProvider::build();
DiagnosticBufferProvider bufferProvider;
Several<PortRef> noLeadPorts; // ◁————————— empty predecessor-port-sequence
Several<BuffDescr> outBuffDescr = makeSeveral({provider.getDescriptor<uint>()})
Several<BuffDescr> outBuffDescr = makeSeveral({bufferProvider.getDescriptor<uint>()})
.build(); // ◁————————— a single output buffer to hold an `uint`
uint resultSlot{0};
@ -229,7 +231,7 @@ namespace test {
.build()};
// Prepare result buffer for invocation
BufferProvider& provider = DiagnosticBufferProvider::build(); ////////////////OOO should rather switch whole pipeline to a DiagnosticBufferProvider here
DiagnosticBufferProvider provider; /////////////////////////OOO should rather switch whole pipeline to a DiagnosticBufferProvider here
BuffHandle buff = provider.lockBufferFor<long> (-55);
CHECK (-55 == buff.accessAs<long>());

70
wiki/thinkPad.ichthyo.mm
View file

@ -111268,8 +111268,7 @@ StM_bind(Builder&lt;R1&gt; b1, Extension&lt;R1,R2&gt; extension)
<font size="5">WER</font>&#160;<font size="4">schreibt</font>&#160;<font size="3">denn</font>&#160;<font size="2">solchen</font>&#160;<font size="1">Schei&#223;</font>&#160;<font size="1">Code</font>
</p>
</body>
</html>
</richcontent>
</html></richcontent>
</node>
<node CREATED="1770582397289" ID="ID_127254698" MODIFIED="1770582469122">
<richcontent TYPE="NODE"><html>
@ -111279,8 +111278,7 @@ StM_bind(Builder&lt;R1&gt; b1, Extension&lt;R1,R2&gt; extension)
schon das Interface <font face="Monospaced" color="#5d0ecc">BufferProvider</font>&#160;hat sehr viel &#187;code behind&#171;
</p>
</body>
</html>
</richcontent>
</html></richcontent>
<richcontent TYPE="NOTE"><html>
<head/>
<body>
@ -111403,8 +111401,7 @@ StM_bind(Builder&lt;R1&gt; b1, Extension&lt;R1,R2&gt; extension)
das w&#252;rde hei&#223;en: w&#228;hrend der Arbeit an diesen Protokollen habe ich immer in den gleichen Strukturen gedacht, die letztlich Implementierungs-Primitive waren. Dadurch sind Implementierungs-Konzepte in die Standard-Implementierung der Protokolle ge&#187;leaked&#171; &#8212; und da es nur diese eine Referenz-Implementierung gab, ist diese Vermischung auch in den &#187;code behind&#171; der Protokoll-Implementierungen eingedrungen. Damit war ich schnell fertig (und stand zudem unter Druck, weil ich nicht vorw&#228;rts gekommen bin). Infolgedessen unterblieb eine Kritik, und das herausdestilieren einer abstrakteren Form des Typ-Managers; im Fall der Output-Slots ist es sogar noch schlimmer, denn dort ist eine abstrahierte Implementierung relativ sinnnlos (und w&#252;rde Vorgriffe machen bez&#252;glich der Technologie, also z.B. dann nur gut passen f&#252;r Audio-Buffer)
</p>
</body>
</html>
</richcontent>
</html></richcontent>
<icon BUILTIN="idea"/>
</node>
</node>
@ -111416,8 +111413,7 @@ StM_bind(Builder&lt;R1&gt; b1, Extension&lt;R1,R2&gt; extension)
demnach sollte ich <b>aufr&#228;umen</b>, nicht neubauen
</p>
</body>
</html>
</richcontent>
</html></richcontent>
<node CREATED="1770588498566" ID="ID_1222578115" MODIFIED="1770588507676" TEXT="der bestehende Code ist nicht schlecht"/>
<node CREATED="1770588508728" ID="ID_1754817280" MODIFIED="1770588514881" TEXT="sondern nur verdorben"/>
</node>
@ -111437,16 +111433,66 @@ StM_bind(Builder&lt;R1&gt; b1, Extension&lt;R1,R2&gt; extension)
</node>
</node>
</node>
<node CREATED="1770588842579" ID="ID_1904463931" MODIFIED="1770588849981" TEXT="Schritt-1 : Code trennen">
<node BACKGROUND_COLOR="#c8c0b6" COLOR="#435e98" CREATED="1770588842579" ID="ID_1904463931" MODIFIED="1770595353062" TEXT="Schritt-1 : Code trennen">
<icon BUILTIN="full-1"/>
<node CREATED="1770588964880" ID="ID_692469584" MODIFIED="1770588990867" TEXT="TrackingHeapBlockProvider &#x27fc; HeapMemProvider"/>
<node CREATED="1770590017550" ID="ID_1783096429" MODIFIED="1770590027209" TEXT="einfache Verwendungen direkt darauf abstellen"/>
</node>
<node CREATED="1770590030827" ID="ID_995145745" MODIFIED="1770590039031" TEXT="Schritt-2 : Tracking abstrahieren">
<node CREATED="1770590041763" ID="ID_707087059" MODIFIED="1770590078026" TEXT="DiagnosticBufferProvider als Wrapper redefinieren"/>
<node BACKGROUND_COLOR="#eef0c5" COLOR="#990000" CREATED="1770590030827" ID="ID_995145745" MODIFIED="1770595364605" TEXT="Schritt-2 : Tracking abstrahieren">
<icon BUILTIN="pencil"/>
<node BACKGROUND_COLOR="#eef0c5" COLOR="#990000" CREATED="1770590041763" ID="ID_707087059" MODIFIED="1770602327047" TEXT="DiagnosticBufferProvider als Wrapper redefinieren">
<icon BUILTIN="pencil"/>
<node COLOR="#435e98" CREATED="1770595708980" ID="ID_1149174165" MODIFIED="1770602338550" TEXT="der PImpl kann direkt eine Subkomponente werden">
<richcontent TYPE="NOTE"><html>
<head>
</head>
<body>
<p>
wir haben hier nix zu verbergen
</p>
</body>
</html>
</richcontent>
<icon BUILTIN="yes"/>
</node>
<node COLOR="#435e98" CREATED="1770595736588" ID="ID_600664388" MODIFIED="1770602338551" TEXT="daf&#xfc;r mu&#xdf; der statische Instanz-Mechanismus weg">
<icon BUILTIN="yes"/>
</node>
<node COLOR="#338800" CREATED="1770595752923" ID="ID_671198609" MODIFIED="1770602341064" TEXT="stattdessen einen Separaten Diagnose-Kontext schaffen">
<icon BUILTIN="button_ok"/>
<node CREATED="1770598425427" ID="ID_1286763449" MODIFIED="1770598433928" TEXT="analog zu ProcNodeDiagnostics"/>
<node CREATED="1770598434991" ID="ID_1549210941" MODIFIED="1770598446402" TEXT="also free function watch(provider)"/>
</node>
<node BACKGROUND_COLOR="#fafe99" COLOR="#fa002a" CREATED="1770602342349" ID="ID_1881815645" MODIFIED="1770602353899" TEXT="Konsistenzfehler im BufferProviderProtocol_test">
<icon BUILTIN="broken-line"/>
<node CREATED="1770602368655" ID="ID_1117824947" MODIFIED="1770602374829" TEXT="&quot;Attempt to access an unknown buffer metadata entry&quot;"/>
<node CREATED="1770602551031" ID="ID_676354463" MODIFIED="1770602557156" TEXT="Beobachtungen">
<icon BUILTIN="forward"/>
<node CREATED="1770602559312" ID="ID_382452027" MODIFIED="1770602582593" TEXT="verifySimpleUsage() &#x25b6; provider.lockBufferFor&lt;TestFrame&gt;();"/>
<node CREATED="1770603040838" ID="ID_455451498" MODIFIED="1770603086284" TEXT="passiert in HeapMemProvider::provideLockedBuffer()">
<node CREATED="1770603133792" ID="ID_1371565303" MODIFIED="1770603137180" TEXT="getBlockPoolFor (typeID)"/>
<node CREATED="1770603138596" ID="ID_205556727" MODIFIED="1770603144836" TEXT="findet die typeID nicht"/>
<node BACKGROUND_COLOR="#e0ceaa" COLOR="#c50b16" CREATED="1770603145825" ID="ID_1161678376" MODIFIED="1770603165421" TEXT="&#xd83d;&#xddf2; AUA"/>
</node>
<node BACKGROUND_COLOR="#fafe99" COLOR="#fa002a" CREATED="1770603168537" ID="ID_1244643866" MODIFIED="1770603186894" TEXT="wir haben jetzt mehrere Metadata-Registries">
<icon BUILTIN="broken-line"/>
<node CREATED="1770603253041" ID="ID_413919416" MODIFIED="1770603262458" TEXT="steckt in der BufferProvider-Basisklasse">
<node CREATED="1770603292796" ID="ID_66726358" MODIFIED="1770603349010" TEXT="registriert wird im Basis-Objekt von DiagnosticBufferProvider"/>
<node CREATED="1770603312138" ID="ID_684915175" MODIFIED="1770603334946" TEXT="aufgerufen wird im Basis-Objekt von HeapMemProvider"/>
</node>
<node BACKGROUND_COLOR="#f8f1cb" COLOR="#a50125" CREATED="1770603263559" ID="ID_303293123" MODIFIED="1770603392871" TEXT="jetzt r&#xe4;cht sich, da&#xdf; das ganze Type-Handling dort eingebaut wurde">
<icon BUILTIN="messagebox_warning"/>
</node>
</node>
</node>
</node>
</node>
<node CREATED="1770590087037" ID="ID_1369431211" MODIFIED="1770590102087" TEXT="alle tats&#xe4;chlichen Diagnose-Aufrufe identifizieren"/>
<node CREATED="1770590107914" ID="ID_1076311206" MODIFIED="1770590121912" TEXT="daf&#xfc;r die Implementierung aufdoppeln"/>
</node>
<node CREATED="1770590137705" ID="ID_775309144" MODIFIED="1770590147875" TEXT="Schritt-3 : auftrennen">
<node BACKGROUND_COLOR="#d2beaf" COLOR="#5c4d6e" CREATED="1770590137705" ID="ID_775309144" MODIFIED="1770595373702" TEXT="Schritt-3 : auftrennen">
<icon BUILTIN="hourglass"/>
<node CREATED="1770590149154" ID="ID_560066313" MODIFIED="1770590174661" TEXT="das verbleibende Buffer-Provider-Interface &#xfc;berpr&#xfc;fen"/>
<node CREATED="1770590206837" ID="ID_933010628" MODIFIED="1770590228576" TEXT="den DiagnosticOutputSlot seitw&#xe4;rts abspalten"/>
<node CREATED="1770590176675" ID="ID_1189656993" MODIFIED="1770590203848" TEXT="nicht mehr ben&#xf6;tigte Instrumentierung im HeapMemProvider zur&#xfc;ckbauen"/>