start a draft to shape the high-level interface for the Scheduler

This commit is contained in:
Fischlurch 2013-08-19 04:12:03 +02:00
parent f9cd80560c
commit ecf65a70fb
4 changed files with 241 additions and 7 deletions

View file

@ -24,6 +24,7 @@
#ifndef PROC_ENGINE_JOB_H
#define PROC_ENGINE_JOB_H
///////////////////////////////////////////////////////////////////TICKET #926 : Job descriptor belongs into backend
#include "lib/llist.h"
#include "lib/hash-value.h"

View file

@ -57,3 +57,7 @@ END
PLANNED "source reading Node" NodeSource_test <<END
END
PLANNED "scheduler interface" SchedulerInterface_test <<END
END

View file

@ -0,0 +1,229 @@
/*
SchedulerInterface(Test) - verify invocation structure of the scheduler interface
Copyright (C) Lumiera.org
2013, 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.
* *****************************************************/
#include "lib/test/run.hpp"
#include "proc/play/timings.hpp"
#include "lib/time/timevalue.hpp"
#include "proc/engine/job.hpp" ////////////////////////////////////////////TICKET #926 : Job descriptor belongs into backend
namespace backend {
namespace engine {
namespace test {
using lib::time::Time;
using lib::time::TimeVar;
using lib::time::Duration;
using lib::time::FSecs;
using proc::engine::Job;
using proc::engine::JobClosure;
using proc::engine::JobParameter;
namespace { // test fixture: a dummy job operation...
class DummyClosure
: public JobClosure
{
void
invokeJobOperation (JobParameter parameter)
{
UNIMPLEMENTED ("conjure a verifiable dummy job operation");
}
void
signalFailure (JobParameter)
{
NOTREACHED ("Job failure is not subject of this test");
}
JobKind
getJobKind() const
{
return META_JOB;
}
bool
verify (Time nominalJobTime) const
{
UNIMPLEMENTED ("what the hell do we need to mock for this operation????");
}
};
/** actual instance of the test dummy job operation */
DummyClosure dummyClosure;
/**
* @todo this is a draft and shall be incorporated into the SchedulerFrontend
* Definition context for jobs to be scheduled.
* Allows to specify individual jobs, and to attach a transaction for prerequisite jobs
*/
class JobTransaction
{
public:
JobTransaction()
{
UNIMPLEMENTED ("suitable representation, link to the actual scheduler?");
}
// using default copy operations
/** define a render job
* for time-bound calculation
*/
void
addJob (Time deadline, Job const& job)
{
UNIMPLEMENTED ("a mock implementation for adding a single job; change this later to talk to the real scheduler");
}
/** define a job for background rendering. */
void
addBackground (Job const& job)
{
UNIMPLEMENTED ("a mock implementation for adding a single background job; change this later to talk to the real scheduler");
}
/** define a render job
* to be calculated as soon as resources permit.
* Typically this call is used for rendering final results.
*/
void
addFreewheeling (Job const& job)
{
UNIMPLEMENTED ("a mock implementation for adding a single job for immediate calculation; change this later to talk to the real scheduler");
}
void
attach (JobTransaction const& prerequisites)
{
UNIMPLEMENTED ("a mock implementation for adding a tree of prerequisite jobs; change this later to talk to the real scheduler");
}
JobTransaction startPrerequisiteTx();
};
JobTransaction
JobTransaction::startPrerequisiteTx()
{
UNIMPLEMENTED ("how to start a nested job definition context");
}
TimeVar testStartTime(Time::ZERO);
const Duration TEST_FRAME_DURATION(FSecs(1,2));
} //(End) test fixture
/***************************************************************************
* @test verify and demonstrate the organisation of the high-level interface
* for defining jobs to be invoked by the scheduler.
*
* @see SchedulerFrongend
* @see DispatcherInterface_test
*/
class SchedulerInterface_test : public Test
{
virtual void
run (Arg)
{
verify_simple_job_specification();
demonstrate_nested_job_specification();
}
void
verify_simple_job_specification ()
{
InvocationInstanceID invoKey;
invoKey.frameNumber = 111;
Job job(dummyClosure,invoKey, Time::ZERO);
JobTransaction definitionContext; ///////////////TODO: get this "somehow" from the SchedulerFrontend
definitionContext.addFreewheeling(job);
definitionContext.addBackground (job);
UNIMPLEMENTED ("find a way to verify what has been scheduled");
}
/** @test demonstrate how a tree of dependent render jobs
* can be handed over to the scheduler within a single "transaction"
*
* @see HierarchyOrientationIndicator_test#demonstrate_tree_rebuilding
*/
void
demonstrate_nested_job_specification ()
{
JobTransaction startTx;
uint dummyLevel = 5;
specifyJobs (startTx, dummyLevel);
UNIMPLEMENTED ("find a way to verify what has been scheduled");
}
/** recursive helper function to add several levels of prerequisites
* It is crucial for this function to be recursive: this allows us to represent
* a complete tree navigation as a sequence of job definitions to be "pulled"
* out from some opaque source
*/
static void
specifyJobs (JobTransaction& currentTx, uint dummyLevel)
{
InvocationInstanceID invoKey; ///////////////TODO: get this "somehow" from the SchedulerFrontend
invoKey.frameNumber = dummyLevel;
Time nominalTime(dummyLevel*TEST_FRAME_DURATION);
Time deadline(testStartTime + dummyLevel*TEST_FRAME_DURATION);
Job job(dummyClosure,invoKey, nominalTime);
currentTx.addJob (deadline, job);
if (0 < dummyLevel)
{
JobTransaction dependentTx = currentTx.startPrerequisiteTx();
specifyJobs (dependentTx, dummyLevel-1);
currentTx.attach (dependentTx);
}
}
};
/** Register this test class... */
LAUNCHER(SchedulerInterface_test, "unit common");
}}} // namespace backend::engine::test

View file

@ -1,5 +1,5 @@
/*
HierarchyOrientationIndicator(Test) - verify generation details
HierarchyOrientationIndicator(Test) - mechanism for reproducing a tree (of jobs)
Copyright (C) Lumiera.org
2013, Hermann Vosseler <Ichthyostega@web.de>
@ -273,7 +273,7 @@ namespace test {
if (direction > 0)
{
treeVisitation->orientation -= 1;
Node& refPoint = startChildTransaction();
Node* refPoint = startChildTransaction();
populateBy (treeVisitation);
commitChildTransaction(refPoint);
}
@ -293,19 +293,19 @@ namespace test {
current_ = & parent_->makeChild(id);
}
Node&
Node*
startChildTransaction()
{
Node& oldRefPoint (*parent_);
Node* oldRefPoint = parent_;
ASSERT (current_);
parent_ = current_; // set new ref point
return oldRefPoint;
}
void
commitChildTransaction(Node& refPoint)
commitChildTransaction(Node* refPoint)
{
parent_ = &refPoint;
parent_ = refPoint;
current_ = parent_;
}
};
@ -408,4 +408,4 @@ namespace test {
/** Register this test class... */
LAUNCHER(HierarchyOrientationIndicator_test, "unit common");
}} // namespace lib
}} // namespace lib::test