LUMIERA.clone/tests/library/incidence-count-test.cpp
Ichthyostega 9f0878f885 Scheduler-test: implement accounting for concurrency for instrumentation
...since we've established already an integration over the event timeline,
it is just one simple further step to determine the concurrency level
on each individual segment of the timeline. Based on this attribution

- the averaged concurrenty within the observation range can be computed as weighted mean
- moreover we can account for the precise cumulated time spent at each concurrency level
2024-02-14 04:18:43 +01:00

264 lines
9 KiB
C++

/*
IncidenceCount(Test) - observe and evaluate concurrent activations
Copyright (C) Lumiera.org
2024, Hermann Vosseler <Ichthyostega@web.de>
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License as
published by the Free Software Foundation; either version 2 of
the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
* *****************************************************/
/** @file incidence-count-test.cpp
** unit test \ref IncidenceCount_test
*/
#include "lib/test/run.hpp"
#include "lib/test/diagnostic-output.hpp"//////////////TODO RLY?
#include "lib/test/microbenchmark.hpp"
#include "lib/incidence-count.hpp"
#include "lib/thread.hpp"
#include "lib/util.hpp"
//#include <string>
#include <thread>
//using std::string;
using util::isLimited;
using std::this_thread::sleep_for;
using std::chrono_literals::operator ""ms;
using std::chrono::microseconds;
namespace lib {
namespace test{
/***************************************************************************//**
* @test verifies capturing and restoring of std::ostream formatting state.
* @see ios-savepoint.hpp
*/
class IncidenceCount_test
: public Test
{
void
run (Arg)
{
demonstrate_usage();
verify_incidentCount();
verify_concurrencyStatistic();
perform_multithreadStressTest();
}
/** @test watch time spent in code bracketed by measurement calls.
* @todo WIP 2/24 ✔ define ⟶ ✔ implement
*/
void
demonstrate_usage()
{
IncidenceCount watch;
watch.markEnter();
sleep_for (1ms);
watch.markLeave();
//
sleep_for (5ms);
//
watch.markEnter();
sleep_for (1ms);
watch.markLeave();
double time = watch.calcCumulatedTime();
CHECK (time > 1900);
CHECK (time < 2500);
}
/** @test verify proper counting of possibly overlapping incidences
* @todo WIP 2/24 ✔ define ⟶ ✔ implement
*/
void
verify_incidentCount()
{
IncidenceCount watch;
watch.expectThreads(1)
.expectIncidents(20);
watch.markEnter(1);
sleep_for (1ms);
watch.markEnter(3);
sleep_for (2ms);
watch.markEnter(2);
watch.markLeave(3);
sleep_for (1ms);
watch.markLeave(1);
watch.markEnter(3);
sleep_for (3ms);
watch.markEnter(1);
watch.markLeave(2);
sleep_for (1ms);
watch.markLeave(3);
sleep_for (1ms);
watch.markLeave(1);
auto stat = watch.evaluate();
SHOW_EXPR(stat.cumulatedTime);
SHOW_EXPR(stat.coveredTime);
SHOW_EXPR(stat.eventCnt);
SHOW_EXPR(stat.activationCnt);
SHOW_EXPR(stat.cntCase(0));
SHOW_EXPR(stat.cntCase(1));
SHOW_EXPR(stat.cntCase(2));
SHOW_EXPR(stat.cntCase(3));
SHOW_EXPR(stat.cntCase(4));
SHOW_EXPR(stat.timeCase(0));
SHOW_EXPR(stat.timeCase(1));
SHOW_EXPR(stat.timeCase(2));
SHOW_EXPR(stat.timeCase(3));
SHOW_EXPR(stat.timeCase(4));
SHOW_EXPR(stat.cntThread(0));
SHOW_EXPR(stat.cntThread(1));
SHOW_EXPR(stat.timeThread(0));
SHOW_EXPR(stat.timeThread(1));
CHECK (isLimited (15500, stat.cumulatedTime, 17500)); // ≈ 16ms
CHECK (isLimited ( 8500, stat.coveredTime, 10000)); // ≈ 9ms
CHECK (10== stat.eventCnt);
CHECK (5 == stat.activationCnt);
CHECK (0 == stat.cntCase(0));
CHECK (2 == stat.cntCase(1));
CHECK (1 == stat.cntCase(2));
CHECK (2 == stat.cntCase(3));
CHECK (0 == stat.cntCase(4));
CHECK (0 == stat.timeCase(0));
CHECK (isLimited ( 5500, stat.timeCase(1), 6800)); // ≈ 6ms
CHECK (isLimited ( 3500, stat.timeCase(2), 4500)); // ≈ 4ms
CHECK (isLimited ( 5500, stat.timeCase(3), 6800)); // ≈ 6ms
CHECK (0 == stat.timeCase(4));
CHECK (5 == stat.cntThread(0));
CHECK (0 == stat.cntThread(1));
CHECK (stat.cumulatedTime == stat.timeThread(0));
CHECK (0 == stat.timeThread(1));
CHECK (1 > abs(stat.cumulatedTime - (stat.timeCase(1) + stat.timeCase(2) + stat.timeCase(3))));
}
/** @test TODO verify observation of concurrency degree
* @todo WIP 2/24 ✔ define ⟶ ✔ implement
*/
void
verify_concurrencyStatistic()
{
MARK_TEST_FUN
const size_t CONCURR = std::thread::hardware_concurrency();
IncidenceCount watch;
watch.expectThreads(CONCURR)
.expectIncidents(5000);
auto act = [&]{ // two nested activities with random delay
uint delay = 100 + rand() % 800;
watch.markEnter();
sleep_for (microseconds(delay));
watch.markEnter(2);
sleep_for (microseconds(delay));
watch.markLeave(2);
watch.markLeave();
};
auto run_parallel = [&]
{
ThreadJoinable t1("test-1", act);
ThreadJoinable t2("test-2", act);
t1.join();
t2.join();
};
double runTime = test::benchmarkTime (run_parallel);
// join ensures visibility of all data changes from within threads,
// which is a prerequisite for performing the data evaluation safely.
auto stat = watch.evaluate();
SHOW_EXPR(runTime)
SHOW_EXPR(stat.cumulatedTime);
SHOW_EXPR(stat.coveredTime);
SHOW_EXPR(stat.eventCnt);
SHOW_EXPR(stat.activationCnt);
SHOW_EXPR(stat.cntCase(0));
SHOW_EXPR(stat.cntCase(1));
SHOW_EXPR(stat.cntCase(2));
SHOW_EXPR(stat.cntCase(3));
SHOW_EXPR(stat.timeCase(0));
SHOW_EXPR(stat.timeCase(1));
SHOW_EXPR(stat.timeCase(2));
SHOW_EXPR(stat.timeCase(3));
SHOW_EXPR(stat.cntThread(0));
SHOW_EXPR(stat.cntThread(1));
SHOW_EXPR(stat.cntThread(2));
SHOW_EXPR(stat.timeThread(0));
SHOW_EXPR(stat.timeThread(1));
SHOW_EXPR(stat.timeThread(2));
SHOW_EXPR(stat.avgConcurrency);
SHOW_EXPR(stat.timeAtConc(0));
SHOW_EXPR(stat.timeAtConc(1));
SHOW_EXPR(stat.timeAtConc(2));
CHECK (runTime > stat.coveredTime);
CHECK (stat.coveredTime < stat.cumulatedTime);
CHECK (8 == stat.eventCnt);
CHECK (4 == stat.activationCnt);
CHECK (2 == stat.cntCase(0));
CHECK (0 == stat.cntCase(1));
CHECK (2 == stat.cntCase(2));
CHECK (0 == stat.cntCase(3));
CHECK (2 == stat.cntThread(0));
CHECK (2 == stat.cntThread(1));
CHECK (0 == stat.cntThread(3));
CHECK (isLimited(0, stat.avgConcurrency, 2));
CHECK (stat.timeAtConc(0) == 0.0);
CHECK (stat.timeAtConc(1) < stat.coveredTime);
CHECK (stat.timeAtConc(2) < stat.coveredTime);
auto isNumEq = [](double d1, double d2){ return 0,001 > abs(d1-d2); };
CHECK (isNumEq (stat.avgConcurrency, (1*stat.timeAtConc(1) + 2*stat.timeAtConc(2)) // average concurrency is a weighted mean
/ stat.coveredTime)); // of the times spent at each concurrency level
CHECK (isNumEq (stat.cumulatedTime , stat.timeThread(0) + stat.timeThread(1))); // cumulated time is spent in both threads
CHECK (isNumEq (stat.cumulatedTime , stat.timeCase(0) + stat.timeCase(2))); // and likewise in all cases together
CHECK (isNumEq (stat.coveredTime , stat.timeAtConc(1) + stat.timeAtConc(2))); // the covered time happens at any non-zero concurrency level
CHECK (stat.timeCase(2) < stat.timeCase(0)); // Note: case-2 is nested into case-0
CHECK (isNumEq (stat.coveredTime , stat.timeCase(0) - stat.timeAtConc(2))); // Thus, case-0 brackets all time, minus the overlapping segment
}
/** @test TODO verify thread-safe operation under pressure
* @todo WIP 2/24 🔁 define ⟶ implement
*/
void
perform_multithreadStressTest()
{
UNIMPLEMENTED("verify thread-safe operation under pressure");
}
};
LAUNCHER (IncidenceCount_test, "unit common");
}} // namespace lib::test