feedc0de/qt-creator
1
0
Fork 0
forked from qt-creator/qt-creator
Code Pull Requests Activity
Files
003b43aee73018cecb2baae74e3e76576f9fa691
qt-creator/src/libs/solutions/tasking/tasktree.cpp
Jarek Kobus 003b43aee7 TaskTree: Rename setupRoot into setRecipe 
The passed Group root element is a recipe with
a full description on how to execute the tasks
and how to handle finished tasks.

We have already virtual methods / setters called like:
deployRecipe, refreshRecipe, reloadRecipe. So, the
common "recipe" is kind of consistent.

Fix typos in warnings.

Addresses the 11th point in the task below.

Task-number: QTCREATORBUG-28741
Change-Id: I1c80f4838b6a3e5ed113eaf8e42b59746d098efe
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org>
Reviewed-by: hjk <hjk@qt.io>
Reviewed-by: Marcus Tillmanns <marcus.tillmanns@qt.io>
2023-06-08 11:31:57 +00:00

1982 lines
75 KiB
C++
Raw Blame History

// Copyright (C) 2023 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0
#include "tasktree.h"
#include <QEventLoop>
#include <QFutureWatcher>
#include <QPromise>
#include <QSet>
#include <QTimer>
using namespace std::chrono;
namespace Tasking {
// That's cut down qtcassert.{c,h} to avoid the dependency.
#define QTC_STRINGIFY_HELPER(x) #x
#define QTC_STRINGIFY(x) QTC_STRINGIFY_HELPER(x)
#define QTC_STRING(cond) qDebug("SOFT ASSERT: \"%s\" in %s: %s", cond, __FILE__, QTC_STRINGIFY(__LINE__))
#define QTC_ASSERT(cond, action) if (Q_LIKELY(cond)) {} else { QTC_STRING(#cond); action; } do {} while (0)
#define QTC_CHECK(cond) if (cond) {} else { QTC_STRING(#cond); } do {} while (0)
class Guard
{
Q_DISABLE_COPY(Guard)
public:
Guard() = default;
~Guard() { QTC_CHECK(m_lockCount == 0); }
bool isLocked() const { return m_lockCount; }
private:
int m_lockCount = 0;
friend class GuardLocker;
};
class GuardLocker
{
Q_DISABLE_COPY(GuardLocker)
public:
GuardLocker(Guard &guard) : m_guard(guard) { ++m_guard.m_lockCount; }
~GuardLocker() { --m_guard.m_lockCount; }
private:
Guard &m_guard;
};
/*!
\class Tasking::GroupItem
\inheaderfile solutions/tasking/tasktree.h
\inmodule QtCreator
\ingroup mainclasses
\brief The GroupItem class represents the basic element for composing nested tree structures.
*/
/*!
\enum Tasking::WorkflowPolicy
This enum describes the possible behavior of the Group element when any group's child task
finishes its execution. It's also used when the running Group is stopped.
\value StopOnError
Default. Corresponds to the stopOnError global element.
If any child task finishes with an error, the group stops and finishes with an error.
If all child tasks finished with success, the group finishes with success.
If a group is empty, it finishes with success.
\value ContinueOnError
Corresponds to the continueOnError global element.
Similar to stopOnError, but in case any child finishes with an error,
the execution continues until all tasks finish, and the group reports an error
afterwards, even when some other tasks in the group finished with success.
If all child tasks finish successfully, the group finishes with success.
If a group is empty, it finishes with success.
\value StopOnDone
Corresponds to the stopOnDone global element.
If any child task finishes with success, the group stops and finishes with success.
If all child tasks finished with an error, the group finishes with an error.
If a group is empty, it finishes with an error.
\value ContinueOnDone
Corresponds to the continueOnDone global element.
Similar to stopOnDone, but in case any child finishes successfully,
the execution continues until all tasks finish, and the group reports success
afterwards, even when some other tasks in the group finished with an error.
If all child tasks finish with an error, the group finishes with an error.
If a group is empty, it finishes with an error.
\value StopOnFinished
Corresponds to the stopOnFinished global element.
The group starts as many tasks as it can. When any task finishes,
the group stops and reports the task's result.
Useful only in parallel mode.
In sequential mode, only the first task is started, and when finished,
the group finishes too, so the other tasks are always skipped.
If a group is empty, it finishes with an error.
\value FinishAllAndDone
Corresponds to the finishAllAndDone global element.
The group executes all tasks and ignores their return results. When all
tasks finished, the group finishes with success.
If a group is empty, it finishes with success.
\value FinishAllAndError
Corresponds to the finishAllAndError global element.
The group executes all tasks and ignores their return results. When all
tasks finished, the group finishes with an error.
If a group is empty, it finishes with an error.
Whenever a child task's result causes the Group to stop,
i.e. in case of StopOnError, StopOnDone, or StopOnFinished policies,
the Group stops the other running child tasks (if any - for example in parallel mode),
and skips executing tasks it has not started yet (for example, in the sequential mode -
those, that are placed after the failed task). Both stopping and skipping child tasks
may happen when parallelLimit is used.
The table below summarizes the differences between various workflow policies:
\table
\header
\li \l WorkflowPolicy
\li Executes all child tasks
\li Result
\li Result when the group is empty
\row
\li StopOnError
\li Stops when any child task finished with an error and reports an error
\li An error when at least one child task failed, success otherwise
\li Success
\row
\li ContinueOnError
\li Yes
\li An error when at least one child task failed, success otherwise
\li Success
\row
\li StopOnDone
\li Stops when any child task finished with success and reports success
\li Success when at least one child task succeeded, an error otherwise
\li An error
\row
\li ContinueOnDone
\li Yes
\li Success when at least one child task succeeded, an error otherwise
\li An error
\row
\li StopOnFinished
\li Stops when any child task finished and reports child task's result
\li Success or an error, depending on the finished child task's result
\li An error
\row
\li FinishAllAndDone
\li Yes
\li Success
\li Success
\row
\li FinishAllAndError
\li Yes
\li An error
\li An error
\endtable
If a child of a group is also a group, the child group runs its tasks according to its own
workflow policy. When a parent group stops the running child group because
of parent group's workflow policy, i.e. when the StopOnError, StopOnDone, or StopOnFinished
policy was used for the parent, the child group's result is reported according to the
\b Result column and to the \b {child group's workflow policy} row in the table above.
*/
/*!
\variable sequential
A convenient global group's element describing the sequential execution mode.
This is the default execution mode of the Group element.
When a Group has no execution mode, it runs in the sequential mode.
All the direct child tasks of a group are started in a chain, so that when one task finishes,
the next one starts. This enables you to pass the results from the previous task
as input to the next task before it starts. This mode guarantees that the next task
is started only after the previous task finishes.
\sa parallel, parallelLimit
*/
/*!
\variable parallel
A convenient global group's element describing the parallel execution mode.
All the direct child tasks of a group are started after the group is started,
without waiting for the previous child tasks to finish.
In this mode, all child tasks run simultaneously.
\sa sequential, parallelLimit
*/
/*!
\variable stopOnError
A convenient global group's element describing the StopOnError workflow policy.
This is the default workflow policy of the Group element.
*/
/*!
\variable continueOnError
A convenient global group's element describing the ContinueOnError workflow policy.
*/
/*!
\variable stopOnDone
A convenient global group's element describing the StopOnDone workflow policy.
*/
/*!
\variable continueOnDone
A convenient global group's element describing the ContinueOnDone workflow policy.
*/
/*!
\variable stopOnFinished
A convenient global group's element describing the StopOnFinished workflow policy.
*/
/*!
\variable finishAllAndDone
A convenient global group's element describing the FinishAllAndDone workflow policy.
*/
/*!
\variable finishAllAndError
A convenient global group's element describing the FinishAllAndError workflow policy.
*/
/*!
\enum Tasking::TaskAction
This enum is optionally returned from the group's or task's setup handler function.
It instructs the running task tree on how to proceed after the setup handler's execution
finished.
\value Continue
Default. The group's or task's execution continues nomally.
When a group's or task's setup handler returns void, it's assumed that
it returned Continue.
\value StopWithDone
The group's or task's execution stops immediately with success.
When returned from the group's setup handler, all child tasks are skipped,
and the group's onGroupDone handler is invoked (if provided).
When returned from the task's setup handler, the task isn't started,
its done handler isn't invoked, and the task reports success to its parent.
\value StopWithError
The group's or task's execution stops immediately with an error.
When returned from the group's setup handler, all child tasks are skipped,
and the group's onGroupError handler is invoked (if provided).
When returned from the task's setup handler, the task isn't started,
its error handler isn't invoked, and the task reports an error to its parent.
*/
/*!
\typealias GroupItem::GroupSetupHandler
Type alias for \c std::function<TaskAction()>.
The GroupSetupHandler is used when constructing the onGroupSetup element.
Any function with the above signature, when passed as a group setup handler,
will be called by the running task tree when the group executions starts.
The return value of the handler instructs the running group on how to proceed
after the handler's invocation is finished. The default return value of TaskAction::Continue
instructs the group to continue running, i.e. to start executing its child tasks.
The return value of TaskAction::StopWithDone or TaskAction::StopWithError
instructs the group to skip the child tasks' execution and finish immediately with
success or an error, respectively.
When the return type is either TaskAction::StopWithDone
of TaskAction::StopWithError, the group's done or error handler (if provided)
is called synchronously immediately afterwards.
\note Even if the group setup handler returns StopWithDone or StopWithError,
one of the group's done or error handlers is invoked. This behavior differs
from that of task handlers and might change in the future.
The onGroupSetup accepts also functions in the shortened form of \c std::function<void()>,
i.e. the return value is void. In this case it's assumed that the return value
is TaskAction::Continue by default.
\sa onGroupSetup
*/
/*!
\typealias GroupItem::GroupEndHandler
Type alias for \c std::function\<void()\>.
The GroupEndHandler is used when constructing the onGroupDone and onGroupError elements.
Any function with the above signature, when passed as a group done or error handler,
will be called by the running task tree when the group ends with success or an error,
respectively.
\sa onGroupDone, onGroupError
*/
/*!
\fn template <typename SetupHandler> GroupItem onGroupSetup(SetupHandler &&handler)
Constructs a group's element holding the group setup handler.
The \a handler is invoked whenever the group starts.
The passed \a handler is either of \c std::function<TaskAction()> or \c std::function<void()>
type. For more information on possible argument type, refer to
\l {GroupItem::GroupSetupHandler}.
When the \a handler is invoked, none of the group's child tasks are running yet.
If a group contains the Storage elements, the \a handler is invoked
after the storages are constructed, so that the \a handler may already
perform some initial modifications to the active storages.
\sa GroupItem::GroupSetupHandler, onGroupDone, onGroupError
*/
/*!
Constructs a group's element holding the group done handler.
The \a handler is invoked whenever the group finishes with success.
Depending on the group's workflow policy, this handler may also be called
when the running group is stopped (e.g. when finishAllAndDone element was used).
When the \a handler is invoked, all of the group's child tasks are already finished.
If a group contains the Storage elements, the \a handler is invoked
before the storages are destructed, so that the \a handler may still
perform a last read of the active storages' data.
\sa GroupItem::GroupEndHandler, onGroupSetup, onGroupError
*/
GroupItem onGroupDone(const GroupItem::GroupEndHandler &handler)
{
return Group::onGroupDone(handler);
}
/*!
Constructs a group's element holding the group error handler.
The \a handler is invoked whenever the group finishes with an error.
Depending on the group's workflow policy, this handler may also be called
when the running group is stopped (e.g. when stopOnError element was used).
When the \a handler is invoked, all of the group's child tasks are already finished.
If a group contains the Storage elements, the \a handler is invoked
before the storages are destructed, so that the \a handler may still
perform a last read of the active storages' data.
\sa GroupItem::GroupEndHandler, onGroupSetup, onGroupDone
*/
GroupItem onGroupError(const GroupItem::GroupEndHandler &handler)
{
return Group::onGroupError(handler);
}
/*!
Constructs a group's element describing the \l{Execution Mode}{execution mode}.
The execution mode element in a Group specifies how the direct child tasks of
the Group are started.
For convenience, when appropriate, the \l sequential or \l parallel global elements
may be used instead.
The \a limit defines the maximum number of direct child tasks running in parallel:
\list
\li When \a limit equals to 0, there is no limit, and all direct child tasks are started
together, in the oder in which they appear in a group. This means the fully parallel
execution, and the \l parallel element may be used instead.
\li When \a limit equals to 1, it means that only one child task may run at the time.
This means the sequential execution, and the \l sequential element may be used instead.
In this case child tasks run in chain, so the next child task starts after
the previous child task has finished.
\li When other positive number is passed as \a limit, the group's child tasks run
in parallel, but with a limited number of tasks running simultanously.
The \e limit defines the maximum number of tasks running in parallel in a group.
When the group is started, the first batch of tasks is started
(the number of tasks in a batch equals to the passed \a limit, at most),
while the others are kept waiting. When any running task finishes,
the group starts the next remaining one, so that the \e limit of simultaneously
running tasks inside a group isn't exceeded. This repeats on every child task's
finish until all child tasks are started. This enables you to limit the maximum
number of tasks that run simultaneously, for example if running too many processes might
block the machine for a long time.
\endlist
In all execution modes, a group starts tasks in the oder in which they appear.
If a child of a group is also a group, the child group runs its tasks according
to its own execution mode.
\sa sequential, parallel
*/
GroupItem parallelLimit(int limit)
{
return Group::parallelLimit(qMax(limit, 0));
}
/*!
Constructs a group's workflow policy element for a given \a policy.
For convenience, global elements may be used instead.
\sa stopOnError, continueOnError, stopOnDone, continueOnDone, stopOnFinished, finishAllAndDone,
finishAllAndError, WorkflowPolicy
*/
GroupItem workflowPolicy(WorkflowPolicy policy)
{
return Group::workflowPolicy(policy);
}
const GroupItem sequential = parallelLimit(1);
const GroupItem parallel = parallelLimit(0);
const GroupItem stopOnError = workflowPolicy(WorkflowPolicy::StopOnError);
const GroupItem continueOnError = workflowPolicy(WorkflowPolicy::ContinueOnError);
const GroupItem stopOnDone = workflowPolicy(WorkflowPolicy::StopOnDone);
const GroupItem continueOnDone = workflowPolicy(WorkflowPolicy::ContinueOnDone);
const GroupItem stopOnFinished = workflowPolicy(WorkflowPolicy::StopOnFinished);
const GroupItem finishAllAndDone = workflowPolicy(WorkflowPolicy::FinishAllAndDone);
const GroupItem finishAllAndError = workflowPolicy(WorkflowPolicy::FinishAllAndError);
static TaskAction toTaskAction(bool success)
{
return success ? TaskAction::StopWithDone : TaskAction::StopWithError;
}
bool TreeStorageBase::isValid() const
{
return m_storageData && m_storageData->m_constructor && m_storageData->m_destructor;
}
TreeStorageBase::TreeStorageBase(StorageConstructor ctor, StorageDestructor dtor)
: m_storageData(new StorageData{ctor, dtor}) { }
TreeStorageBase::StorageData::~StorageData()
{
QTC_CHECK(m_storageHash.isEmpty());
for (void *ptr : std::as_const(m_storageHash))
m_destructor(ptr);
}
void *TreeStorageBase::activeStorageVoid() const
{
QTC_ASSERT(m_storageData->m_activeStorage, qWarning(
"The referenced storage is not reachable in the running tree. "
"A nullptr will be returned which might lead to a crash in the calling code. "
"It is possible that no storage was added to the tree, "
"or the storage is not reachable from where it is referenced.");
return nullptr);
const auto it = m_storageData->m_storageHash.constFind(m_storageData->m_activeStorage);
QTC_ASSERT(it != m_storageData->m_storageHash.constEnd(), return nullptr);
return it.value();
}
int TreeStorageBase::createStorage() const
{
QTC_ASSERT(m_storageData->m_constructor, return 0); // TODO: add isValid()?
QTC_ASSERT(m_storageData->m_destructor, return 0);
QTC_ASSERT(m_storageData->m_activeStorage == 0, return 0); // TODO: should be allowed?
const int newId = ++m_storageData->m_storageCounter;
m_storageData->m_storageHash.insert(newId, m_storageData->m_constructor());
return newId;
}
void TreeStorageBase::deleteStorage(int id) const
{
QTC_ASSERT(m_storageData->m_constructor, return); // TODO: add isValid()?
QTC_ASSERT(m_storageData->m_destructor, return);
QTC_ASSERT(m_storageData->m_activeStorage == 0, return); // TODO: should be allowed?
const auto it = m_storageData->m_storageHash.constFind(id);
QTC_ASSERT(it != m_storageData->m_storageHash.constEnd(), return);
m_storageData->m_destructor(it.value());
m_storageData->m_storageHash.erase(it);
}
// passing 0 deactivates currently active storage
void TreeStorageBase::activateStorage(int id) const
{
if (id == 0) {
QTC_ASSERT(m_storageData->m_activeStorage, return);
m_storageData->m_activeStorage = 0;
return;
}
QTC_ASSERT(m_storageData->m_activeStorage == 0, return);
const auto it = m_storageData->m_storageHash.find(id);
QTC_ASSERT(it != m_storageData->m_storageHash.end(), return);
m_storageData->m_activeStorage = id;
}
void GroupItem::addChildren(const QList<GroupItem> &children)
{
QTC_ASSERT(m_type == Type::Group, qWarning("Only Group may have children, skipping...");
return);
for (const GroupItem &child : children) {
switch (child.m_type) {
case Type::Group:
m_children.append(child);
break;
case Type::GroupData:
if (child.m_groupData.m_groupHandler.m_setupHandler) {
QTC_ASSERT(!m_groupData.m_groupHandler.m_setupHandler,
qWarning("Group Setup Handler redefinition, overriding..."));
m_groupData.m_groupHandler.m_setupHandler
= child.m_groupData.m_groupHandler.m_setupHandler;
}
if (child.m_groupData.m_groupHandler.m_doneHandler) {
QTC_ASSERT(!m_groupData.m_groupHandler.m_doneHandler,
qWarning("Group Done Handler redefinition, overriding..."));
m_groupData.m_groupHandler.m_doneHandler
= child.m_groupData.m_groupHandler.m_doneHandler;
}
if (child.m_groupData.m_groupHandler.m_errorHandler) {
QTC_ASSERT(!m_groupData.m_groupHandler.m_errorHandler,
qWarning("Group Error Handler redefinition, overriding..."));
m_groupData.m_groupHandler.m_errorHandler
= child.m_groupData.m_groupHandler.m_errorHandler;
}
if (child.m_groupData.m_parallelLimit) {
QTC_ASSERT(!m_groupData.m_parallelLimit,
qWarning("Group Execution Mode redefinition, overriding..."));
m_groupData.m_parallelLimit = child.m_groupData.m_parallelLimit;
}
if (child.m_groupData.m_workflowPolicy) {
QTC_ASSERT(!m_groupData.m_workflowPolicy,
qWarning("Group Workflow Policy redefinition, overriding..."));
m_groupData.m_workflowPolicy = child.m_groupData.m_workflowPolicy;
}
break;
case Type::TaskHandler:
QTC_ASSERT(child.m_taskHandler.m_createHandler,
qWarning("Task Create Handler can't be null, skipping..."); return);
m_children.append(child);
break;
case Type::Storage:
m_storageList.append(child.m_storageList);
break;
}
}
}
void GroupItem::setTaskSetupHandler(const TaskSetupHandler &handler)
{
if (!handler) {
qWarning("Setting empty Setup Handler is no-op, skipping...");
return;
}
if (m_taskHandler.m_setupHandler)
qWarning("Setup Handler redefinition, overriding...");
m_taskHandler.m_setupHandler = handler;
}
void GroupItem::setTaskDoneHandler(const TaskEndHandler &handler)
{
if (!handler) {
qWarning("Setting empty Done Handler is no-op, skipping...");
return;
}
if (m_taskHandler.m_doneHandler)
qWarning("Done Handler redefinition, overriding...");
m_taskHandler.m_doneHandler = handler;
}
void GroupItem::setTaskErrorHandler(const TaskEndHandler &handler)
{
if (!handler) {
qWarning("Setting empty Error Handler is no-op, skipping...");
return;
}
if (m_taskHandler.m_errorHandler)
qWarning("Error Handler redefinition, overriding...");
m_taskHandler.m_errorHandler = handler;
}
GroupItem GroupItem::withTimeout(const GroupItem &item, milliseconds timeout,
const GroupEndHandler &handler)
{
const TimeoutTask::EndHandler taskHandler = handler
? [handler](const milliseconds &) { handler(); } : TimeoutTask::EndHandler();
return Group {
parallel,
stopOnFinished,
Group {
finishAllAndError,
TimeoutTask([timeout](milliseconds &timeoutData) { timeoutData = timeout; },
taskHandler)
},
item
};
}
class TaskTreePrivate;
class TaskNode;
class TaskTreePrivate
{
Q_DISABLE_COPY_MOVE(TaskTreePrivate)
public:
TaskTreePrivate(TaskTree *taskTree)
: q(taskTree) {}
void start();
void stop();
void advanceProgress(int byValue);
void emitStartedAndProgress();
void emitProgress();
void emitDone();
void emitError();
QList<TreeStorageBase> addStorages(const QList<TreeStorageBase> &storages);
void callSetupHandler(TreeStorageBase storage, int storageId) {
callStorageHandler(storage, storageId, &StorageHandler::m_setupHandler);
}
void callDoneHandler(TreeStorageBase storage, int storageId) {
callStorageHandler(storage, storageId, &StorageHandler::m_doneHandler);
}
struct StorageHandler {
TaskTree::StorageVoidHandler m_setupHandler = {};
TaskTree::StorageVoidHandler m_doneHandler = {};
};
typedef TaskTree::StorageVoidHandler StorageHandler::*HandlerPtr; // ptr to class member
void callStorageHandler(TreeStorageBase storage, int storageId, HandlerPtr ptr)
{
const auto it = m_storageHandlers.constFind(storage);
if (it == m_storageHandlers.constEnd())
return;
GuardLocker locker(m_guard);
const StorageHandler storageHandler = *it;
storage.activateStorage(storageId);
if (storageHandler.*ptr)
(storageHandler.*ptr)(storage.activeStorageVoid());
storage.activateStorage(0);
}
TaskTree *q = nullptr;
Guard m_guard;
int m_progressValue = 0;
QSet<TreeStorageBase> m_storages;
QHash<TreeStorageBase, StorageHandler> m_storageHandlers;
std::unique_ptr<TaskNode> m_root = nullptr; // Keep me last in order to destruct first
};
class TaskContainer
{
Q_DISABLE_COPY_MOVE(TaskContainer)
public:
TaskContainer(TaskTreePrivate *taskTreePrivate, const GroupItem &task,
TaskNode *parentNode, TaskContainer *parentContainer)
: m_constData(taskTreePrivate, task, parentNode, parentContainer, this) {}
TaskAction start();
TaskAction continueStart(TaskAction startAction, int nextChild);
TaskAction startChildren(int nextChild);
TaskAction childDone(bool success);
void stop();
void invokeEndHandler();
bool isRunning() const { return m_runtimeData.has_value(); }
bool isStarting() const { return isRunning() && m_runtimeData->m_startGuard.isLocked(); }
struct ConstData {
ConstData(TaskTreePrivate *taskTreePrivate, const GroupItem &task, TaskNode *parentNode,
TaskContainer *parentContainer, TaskContainer *thisContainer);
~ConstData() { qDeleteAll(m_children); }
TaskTreePrivate * const m_taskTreePrivate = nullptr;
TaskNode * const m_parentNode = nullptr;
TaskContainer * const m_parentContainer = nullptr;
const int m_parallelLimit = 1;
const WorkflowPolicy m_workflowPolicy = WorkflowPolicy::StopOnError;
const GroupItem::GroupHandler m_groupHandler;
const QList<TreeStorageBase> m_storageList;
const QList<TaskNode *> m_children;
const int m_taskCount = 0;
};
struct RuntimeData {
RuntimeData(const ConstData &constData);
~RuntimeData();
static QList<int> createStorages(const TaskContainer::ConstData &constData);
void callStorageDoneHandlers();
bool updateSuccessBit(bool success);
int currentLimit() const;
const ConstData &m_constData;
const QList<int> m_storageIdList;
bool m_successBit = true;
int m_doneCount = 0;
Guard m_startGuard;
};
const ConstData m_constData;
std::optional<RuntimeData> m_runtimeData;
};
class TaskNode
{
Q_DISABLE_COPY_MOVE(TaskNode)
public:
TaskNode(TaskTreePrivate *taskTreePrivate, const GroupItem &task,
TaskContainer *parentContainer)
: m_taskHandler(task.taskHandler())
, m_container(taskTreePrivate, task, this, parentContainer)
{}
// If returned value != Continue, childDone() needs to be called in parent container (in caller)
// in order to unwind properly.
TaskAction start();
void stop();
void invokeEndHandler(bool success);
bool isRunning() const { return m_task || m_container.isRunning(); }
bool isTask() const { return bool(m_taskHandler.m_createHandler); }
int taskCount() const { return isTask() ? 1 : m_container.m_constData.m_taskCount; }
TaskContainer *parentContainer() const { return m_container.m_constData.m_parentContainer; }
TaskTree *taskTree() const { return m_container.m_constData.m_taskTreePrivate->q; }
private:
const GroupItem::TaskHandler m_taskHandler;
TaskContainer m_container;
std::unique_ptr<TaskInterface> m_task;
};
void TaskTreePrivate::start()
{
QTC_ASSERT(m_root, return);
m_progressValue = 0;
emitStartedAndProgress();
// TODO: check storage handlers for not existing storages in tree
for (auto it = m_storageHandlers.cbegin(); it != m_storageHandlers.cend(); ++it) {
QTC_ASSERT(m_storages.contains(it.key()), qWarning("The registered storage doesn't "
"exist in task tree. Its handlers will never be called."));
}
m_root->start();
}
void TaskTreePrivate::stop()
{
QTC_ASSERT(m_root, return);
if (!m_root->isRunning())
return;
// TODO: should we have canceled flag (passed to handler)?
// Just one done handler with result flag:
// FinishedWithSuccess, FinishedWithError, Canceled, TimedOut.
// Canceled either directly by user, or by workflow policy - doesn't matter, in both
// cases canceled from outside.
m_root->stop();
emitError();
}
void TaskTreePrivate::advanceProgress(int byValue)
{
if (byValue == 0)
return;
QTC_CHECK(byValue > 0);
QTC_CHECK(m_progressValue + byValue <= m_root->taskCount());
m_progressValue += byValue;
emitProgress();
}
void TaskTreePrivate::emitStartedAndProgress()
{
GuardLocker locker(m_guard);
emit q->started();
emit q->progressValueChanged(m_progressValue);
}
void TaskTreePrivate::emitProgress()
{
GuardLocker locker(m_guard);
emit q->progressValueChanged(m_progressValue);
}
void TaskTreePrivate::emitDone()
{
QTC_CHECK(m_progressValue == m_root->taskCount());
GuardLocker locker(m_guard);
emit q->done();
}
void TaskTreePrivate::emitError()
{
QTC_CHECK(m_progressValue == m_root->taskCount());
GuardLocker locker(m_guard);
emit q->errorOccurred();
}
QList<TreeStorageBase> TaskTreePrivate::addStorages(const QList<TreeStorageBase> &storages)
{
QList<TreeStorageBase> addedStorages;
for (const TreeStorageBase &storage : storages) {
QTC_ASSERT(!m_storages.contains(storage), qWarning("Can't add the same storage into "
"one TaskTree twice, skipping..."); continue);
addedStorages << storage;
m_storages << storage;
}
return addedStorages;
}
class ExecutionContextActivator
{
public:
ExecutionContextActivator(TaskContainer *container)
: m_container(container) { activateContext(m_container); }
~ExecutionContextActivator() { deactivateContext(m_container); }
private:
static void activateContext(TaskContainer *container)
{
QTC_ASSERT(container && container->isRunning(), return);
const TaskContainer::ConstData &constData = container->m_constData;
if (constData.m_parentContainer)
activateContext(constData.m_parentContainer);
for (int i = 0; i < constData.m_storageList.size(); ++i)
constData.m_storageList[i].activateStorage(container->m_runtimeData->m_storageIdList.value(i));
}
static void deactivateContext(TaskContainer *container)
{
QTC_ASSERT(container && container->isRunning(), return);
const TaskContainer::ConstData &constData = container->m_constData;
for (int i = constData.m_storageList.size() - 1; i >= 0; --i) // iterate in reverse order
constData.m_storageList[i].activateStorage(0);
if (constData.m_parentContainer)
deactivateContext(constData.m_parentContainer);
}
TaskContainer *m_container = nullptr;
};
template <typename Handler, typename ...Args,
typename ReturnType = typename std::invoke_result_t<Handler, Args...>>
ReturnType invokeHandler(TaskContainer *container, Handler &&handler, Args &&...args)
{
ExecutionContextActivator activator(container);
GuardLocker locker(container->m_constData.m_taskTreePrivate->m_guard);
return std::invoke(std::forward<Handler>(handler), std::forward<Args>(args)...);
}
static QList<TaskNode *> createChildren(TaskTreePrivate *taskTreePrivate, TaskContainer *container,
const GroupItem &task)
{
QList<TaskNode *> result;
const QList<GroupItem> &children = task.children();
for (const GroupItem &child : children)
result.append(new TaskNode(taskTreePrivate, child, container));
return result;
}
TaskContainer::ConstData::ConstData(TaskTreePrivate *taskTreePrivate, const GroupItem &task,
TaskNode *parentNode, TaskContainer *parentContainer,
TaskContainer *thisContainer)
: m_taskTreePrivate(taskTreePrivate)
, m_parentNode(parentNode)
, m_parentContainer(parentContainer)
, m_parallelLimit(task.groupData().m_parallelLimit.value_or(1))
, m_workflowPolicy(task.groupData().m_workflowPolicy.value_or(WorkflowPolicy::StopOnError))
, m_groupHandler(task.groupData().m_groupHandler)
, m_storageList(taskTreePrivate->addStorages(task.storageList()))
, m_children(createChildren(taskTreePrivate, thisContainer, task))
, m_taskCount(std::accumulate(m_children.cbegin(), m_children.cend(), 0,
[](int r, TaskNode *n) { return r + n->taskCount(); }))
{}
QList<int> TaskContainer::RuntimeData::createStorages(const TaskContainer::ConstData &constData)
{
QList<int> storageIdList;
for (const TreeStorageBase &storage : constData.m_storageList) {
const int storageId = storage.createStorage();
storageIdList.append(storageId);
constData.m_taskTreePrivate->callSetupHandler(storage, storageId);
}
return storageIdList;
}
void TaskContainer::RuntimeData::callStorageDoneHandlers()
{
for (int i = m_constData.m_storageList.size() - 1; i >= 0; --i) { // iterate in reverse order
const TreeStorageBase storage = m_constData.m_storageList[i];
const int storageId = m_storageIdList.value(i);
m_constData.m_taskTreePrivate->callDoneHandler(storage, storageId);
}
}
static bool initialSuccessBit(WorkflowPolicy workflowPolicy)
{
switch (workflowPolicy) {
case WorkflowPolicy::StopOnError:
case WorkflowPolicy::ContinueOnError:
case WorkflowPolicy::FinishAllAndDone:
return true;
case WorkflowPolicy::StopOnDone:
case WorkflowPolicy::ContinueOnDone:
case WorkflowPolicy::StopOnFinished:
case WorkflowPolicy::FinishAllAndError:
return false;
}
QTC_CHECK(false);
return false;
}
TaskContainer::RuntimeData::RuntimeData(const ConstData &constData)
: m_constData(constData)
, m_storageIdList(createStorages(constData))
, m_successBit(initialSuccessBit(m_constData.m_workflowPolicy))
{}
TaskContainer::RuntimeData::~RuntimeData()
{
for (int i = m_constData.m_storageList.size() - 1; i >= 0; --i) { // iterate in reverse order
const TreeStorageBase storage = m_constData.m_storageList[i];
const int storageId = m_storageIdList.value(i);
storage.deleteStorage(storageId);
}
}
bool TaskContainer::RuntimeData::updateSuccessBit(bool success)
{
if (m_constData.m_workflowPolicy == WorkflowPolicy::FinishAllAndDone
|| m_constData.m_workflowPolicy == WorkflowPolicy::FinishAllAndError
|| m_constData.m_workflowPolicy == WorkflowPolicy::StopOnFinished) {
if (m_constData.m_workflowPolicy == WorkflowPolicy::StopOnFinished)
m_successBit = success;
return m_successBit;
}
const bool donePolicy = m_constData.m_workflowPolicy == WorkflowPolicy::StopOnDone
|| m_constData.m_workflowPolicy == WorkflowPolicy::ContinueOnDone;
m_successBit = donePolicy ? (m_successBit || success) : (m_successBit && success);
return m_successBit;
}
int TaskContainer::RuntimeData::currentLimit() const
{
const int childCount = m_constData.m_children.size();
return m_constData.m_parallelLimit
? qMin(m_doneCount + m_constData.m_parallelLimit, childCount) : childCount;
}
TaskAction TaskContainer::start()
{
QTC_CHECK(!isRunning());
m_runtimeData.emplace(m_constData);
TaskAction startAction = TaskAction::Continue;
if (m_constData.m_groupHandler.m_setupHandler) {
startAction = invokeHandler(this, m_constData.m_groupHandler.m_setupHandler);
if (startAction != TaskAction::Continue)
m_constData.m_taskTreePrivate->advanceProgress(m_constData.m_taskCount);
}
if (startAction == TaskAction::Continue) {
if (m_constData.m_children.isEmpty())
startAction = toTaskAction(m_runtimeData->m_successBit);
}
return continueStart(startAction, 0);
}
TaskAction TaskContainer::continueStart(TaskAction startAction, int nextChild)
{
const TaskAction groupAction = startAction == TaskAction::Continue ? startChildren(nextChild)
: startAction;
QTC_CHECK(isRunning()); // TODO: superfluous
if (groupAction != TaskAction::Continue) {
const bool success = m_runtimeData->updateSuccessBit(groupAction == TaskAction::StopWithDone);
invokeEndHandler();
if (TaskContainer *parentContainer = m_constData.m_parentContainer) {
QTC_CHECK(parentContainer->isRunning());
if (!parentContainer->isStarting())
parentContainer->childDone(success);
} else if (success) {
m_constData.m_taskTreePrivate->emitDone();
} else {
m_constData.m_taskTreePrivate->emitError();
}
}
return groupAction;
}
TaskAction TaskContainer::startChildren(int nextChild)
{
QTC_CHECK(isRunning());
GuardLocker locker(m_runtimeData->m_startGuard);
for (int i = nextChild; i < m_constData.m_children.size(); ++i) {
const int limit = m_runtimeData->currentLimit();
if (i >= limit)
break;
const TaskAction startAction = m_constData.m_children.at(i)->start();
if (startAction == TaskAction::Continue)
continue;
const TaskAction finalizeAction = childDone(startAction == TaskAction::StopWithDone);
if (finalizeAction == TaskAction::Continue)
continue;
int skippedTaskCount = 0;
// Skip scheduled but not run yet. The current (i) was already notified.
for (int j = i + 1; j < limit; ++j)
skippedTaskCount += m_constData.m_children.at(j)->taskCount();
m_constData.m_taskTreePrivate->advanceProgress(skippedTaskCount);
return finalizeAction;
}
return TaskAction::Continue;
}
TaskAction TaskContainer::childDone(bool success)
{
QTC_CHECK(isRunning());
const int limit = m_runtimeData->currentLimit(); // Read before bumping m_doneCount and stop()
const bool shouldStop = m_constData.m_workflowPolicy == WorkflowPolicy::StopOnFinished
|| (m_constData.m_workflowPolicy == WorkflowPolicy::StopOnDone && success)
|| (m_constData.m_workflowPolicy == WorkflowPolicy::StopOnError && !success);
if (shouldStop)
stop();
++m_runtimeData->m_doneCount;
const bool updatedSuccess = m_runtimeData->updateSuccessBit(success);
const TaskAction startAction
= (shouldStop || m_runtimeData->m_doneCount == m_constData.m_children.size())
? toTaskAction(updatedSuccess) : TaskAction::Continue;
if (isStarting())
return startAction;
return continueStart(startAction, limit);
}
void TaskContainer::stop()
{
if (!isRunning())
return;
const int limit = m_runtimeData->currentLimit();
for (int i = 0; i < limit; ++i)
m_constData.m_children.at(i)->stop();
int skippedTaskCount = 0;
for (int i = limit; i < m_constData.m_children.size(); ++i)
skippedTaskCount += m_constData.m_children.at(i)->taskCount();
m_constData.m_taskTreePrivate->advanceProgress(skippedTaskCount);
}
void TaskContainer::invokeEndHandler()
{
const GroupItem::GroupHandler &groupHandler = m_constData.m_groupHandler;
if (m_runtimeData->m_successBit && groupHandler.m_doneHandler)
invokeHandler(this, groupHandler.m_doneHandler);
else if (!m_runtimeData->m_successBit && groupHandler.m_errorHandler)
invokeHandler(this, groupHandler.m_errorHandler);
m_runtimeData->callStorageDoneHandlers();
m_runtimeData.reset();
}
TaskAction TaskNode::start()
{
QTC_CHECK(!isRunning());
if (!isTask())
return m_container.start();
m_task.reset(m_taskHandler.m_createHandler());
const TaskAction startAction = m_taskHandler.m_setupHandler
? invokeHandler(parentContainer(), m_taskHandler.m_setupHandler, *m_task.get())
: TaskAction::Continue;
if (startAction != TaskAction::Continue) {
m_container.m_constData.m_taskTreePrivate->advanceProgress(1);
m_task.reset();
return startAction;
}
const std::shared_ptr<TaskAction> unwindAction
= std::make_shared<TaskAction>(TaskAction::Continue);
QObject::connect(m_task.get(), &TaskInterface::done, taskTree(), [=](bool success) {
invokeEndHandler(success);
QObject::disconnect(m_task.get(), &TaskInterface::done, taskTree(), nullptr);
m_task.release()->deleteLater();
QTC_ASSERT(parentContainer() && parentContainer()->isRunning(), return);
if (parentContainer()->isStarting())
*unwindAction = toTaskAction(success);
else
parentContainer()->childDone(success);
});
m_task->start();
return *unwindAction;
}
void TaskNode::stop()
{
if (!isRunning())
return;
if (!m_task) {
m_container.stop();
m_container.m_runtimeData->updateSuccessBit(false);
m_container.invokeEndHandler();
return;
}
// TODO: cancelHandler?
// TODO: call TaskInterface::stop() ?
invokeEndHandler(false);
m_task.reset();
}
void TaskNode::invokeEndHandler(bool success)
{
if (success && m_taskHandler.m_doneHandler)
invokeHandler(parentContainer(), m_taskHandler.m_doneHandler, *m_task.get());
else if (!success && m_taskHandler.m_errorHandler)
invokeHandler(parentContainer(), m_taskHandler.m_errorHandler, *m_task.get());
m_container.m_constData.m_taskTreePrivate->advanceProgress(1);
}
/*!
\namespace Tasking
\inmodule QtCreator
\brief The Tasking namespace contains a general purpose TaskTree solution.
The Tasking namespace depends on Qt only, and doesn't depend on any \QC
specific code.
*/
/*!
\class Tasking::TaskTree
\inheaderfile solutions/tasking/tasktree.h
\inmodule QtCreator
\ingroup mainclasses
\brief The TaskTree class runs an async task tree structure defined in a
declarative way.
Use the Tasking namespace to build extensible, declarative task tree
structures that contain possibly asynchronous tasks, such as Process,
FileTransfer, or Async<ReturnType>. TaskTree structures enable you
to create a sophisticated mixture of a parallel or sequential flow of tasks
in the form of a tree and to run it any time later.
\section1 Root Element and Tasks
The TaskTree has a mandatory Group root element, which may contain
any number of tasks of various types, such as ProcessTask, FileTransferTask,
or AsyncTask<ReturnType>:
\code
using namespace Tasking;
const Group root {
ProcessTask(...),
AsyncTask<int>(...),
FileTransferTask(...)
};
TaskTree *taskTree = new TaskTree(root);
connect(taskTree, &TaskTree::done, ...); // a successfully finished handler
connect(taskTree, &TaskTree::errorOccurred, ...); // an erroneously finished handler
taskTree->start();
\endcode
The task tree above has a top level element of the Group type that contains
tasks of the type ProcessTask, FileTransferTask, and AsyncTask<int>.
After taskTree->start() is called, the tasks are run in a chain, starting
with ProcessTask. When the ProcessTask finishes successfully, the AsyncTask<int> task is
started. Finally, when the asynchronous task finishes successfully, the
FileTransferTask task is started.
When the last running task finishes with success, the task tree is considered
to have run successfully and the TaskTree::done() signal is emitted.
When a task finishes with an error, the execution of the task tree is stopped
and the remaining tasks are skipped. The task tree finishes with an error and
sends the TaskTree::errorOccurred() signal.
\section1 Groups
The parent of the Group sees it as a single task. Like other tasks,
the group can be started and it can finish with success or an error.
The Group elements can be nested to create a tree structure:
\code
const Group root {
Group {
parallel,
ProcessTask(...),
AsyncTask<int>(...)
},
FileTransferTask(...)
};
\endcode
The example above differs from the first example in that the root element has
a subgroup that contains the ProcessTask and AsyncTask<int>. The subgroup is a
sibling element of the FileTransferTask in the root. The subgroup contains an
additional \e parallel element that instructs its Group to execute its tasks
in parallel.
So, when the tree above is started, the ProcessTask and AsyncTask<int> start
immediately and run in parallel. Since the root group doesn't contain a
\e parallel element, its direct child tasks are run in sequence. Thus, the
FileTransferTask starts when the whole subgroup finishes. The group is
considered as finished when all its tasks have finished. The order in which
the tasks finish is not relevant.
So, depending on which task lasts longer (ProcessTask or AsyncTask<int>), the
following scenarios can take place:
\table
\header
\li Scenario 1
\li Scenario 2
\row
\li Root Group starts
\li Root Group starts
\row
\li Sub Group starts
\li Sub Group starts
\row
\li ProcessTask starts
\li ProcessTask starts
\row
\li AsyncTask<int> starts
\li AsyncTask<int> starts
\row
\li ...
\li ...
\row
\li \b {ProcessTask finishes}
\li \b {AsyncTask<int> finishes}
\row
\li ...
\li ...
\row
\li \b {AsyncTask<int> finishes}
\li \b {ProcessTask finishes}
\row
\li Sub Group finishes
\li Sub Group finishes
\row
\li FileTransferTask starts
\li FileTransferTask starts
\row
\li ...
\li ...
\row
\li FileTransferTask finishes
\li FileTransferTask finishes
\row
\li Root Group finishes
\li Root Group finishes
\endtable
The differences between the scenarios are marked with bold. Three dots mean
that an unspecified amount of time passes between previous and next events
(a task or tasks continue to run). No dots between events
means that they occur synchronously.
The presented scenarios assume that all tasks run successfully. If a task
fails during execution, the task tree finishes with an error. In particular,
when ProcessTask finishes with an error while AsyncTask<int> is still being executed,
the AsyncTask<int> is automatically stopped, the subgroup finishes with an error,
the FileTransferTask is skipped, and the tree finishes with an error.
\section1 Task Types
Each task type is associated with its corresponding task class that executes
the task. For example, a ProcessTask inside a task tree is associated with
the Process class that executes the process. The associated objects are
automatically created, started, and destructed exclusively by the task tree
at the appropriate time.
If a root group consists of five sequential ProcessTask tasks, and the task tree
executes the group, it creates an instance of Process for the first
ProcessTask and starts it. If the Process instance finishes successfully,
the task tree destructs it and creates a new Process instance for the
second ProcessTask, and so on. If the first task finishes with an error, the task
tree stops creating Process instances, and the root group finishes with an
error.
The following table shows examples of task types and their corresponding task
classes:
\table
\header
\li Task Type (Tasking Namespace)
\li Associated Task Class
\li Brief Description
\row
\li ProcessTask
\li Utils::Process
\li Starts processes.
\row
\li AsyncTask<ReturnType>
\li Utils::Async<ReturnType>
\li Starts asynchronous tasks; run in separate thread.
\row
\li TaskTreeTask
\li Utils::TaskTree
\li Starts a nested task tree.
\row
\li FileTransferTask
\li ProjectExplorer::FileTransfer
\li Starts file transfer between different devices.
\endtable
\section1 Task Handlers
Use Task handlers to set up a task for execution and to enable reading
the output data from the task when it finishes with success or an error.
\section2 Task's Start Handler
When a corresponding task class object is created and before it's started,
the task tree invokes a mandatory user-provided setup handler. The setup
handler should always take a \e reference to the associated task class object:
\code
const auto onSetup = [](Process &process) {
process.setCommand({"sleep", {"3"}});
};
const Group root {
ProcessTask(onSetup)
};
\endcode
You can modify the passed Process in the setup handler, so that the task
tree can start the process according to your configuration.
You should not call \e {process.start();} in the setup handler,
as the task tree calls it when needed. The setup handler is optional. When used,
it must be the first argument of the task's constructor.
Optionally, the setup handler may return a TaskAction. The returned
TaskAction influences the further start behavior of a given task. The
possible values are:
\table
\header
\li TaskAction Value
\li Brief Description
\row
\li Continue
\li The task will be started normally. This is the default behavior when the
setup handler doesn't return TaskAction (that is, its return type is
void).
\row
\li StopWithDone
\li The task won't be started and it will report success to its parent.
\row
\li StopWithError
\li The task won't be started and it will report an error to its parent.
\endtable
This is useful for running a task only when a condition is met and the data
needed to evaluate this condition is not known until previously started tasks
finish. In this way, the setup handler dynamically decides whether to start the
corresponding task normally or skip it and report success or an error.
For more information about inter-task data exchange, see \l Storage.
\section2 Task's Done and Error Handlers
When a running task finishes, the task tree invokes an optionally provided
done or error handler. Both handlers should always take a \e {const reference}
to the associated task class object:
\code
const auto onSetup = [](Process &process) {
process.setCommand({"sleep", {"3"}});
};
const auto onDone = [](const Process &process) {
qDebug() << "Success" << process.cleanedStdOut();
};
const auto onError = [](const Process &process) {
qDebug() << "Failure" << process.cleanedStdErr();
};
const Group root {
ProcessTask(onSetup, onDone, onError)
};
\endcode
The done and error handlers may collect output data from Process, and store it
for further processing or perform additional actions. The done handler is optional.
When used, it must be the second argument of the task's constructor.
The error handler is also optional. When used, it must always be the third argument.
You can omit the handlers or substitute the ones that you do not need with curly braces ({}).
\note If the task setup handler returns StopWithDone or StopWithError,
neither the done nor error handler is invoked.
\section1 Group Handlers
Similarly to task handlers, group handlers enable you to set up a group to
execute and to apply more actions when the whole group finishes with
success or an error.
\section2 Group's Start Handler
The task tree invokes the group start handler before it starts the child
tasks. The group handler doesn't take any arguments:
\code
const auto onSetup = [] {
qDebug() << "Entering the group";
};
const Group root {
onGroupSetup(onSetup),
ProcessTask(...)
};
\endcode
The group setup handler is optional. To define a group setup handler, add an
onGroupSetup element to a group. The argument of onGroupSetup is a user
handler. If you add more than one onGroupSetup element to a group, an assert
is triggered at runtime that includes an error message.
Like the task's start handler, the group start handler may return TaskAction.
The returned TaskAction value affects the start behavior of the
whole group. If you do not specify a group start handler or its return type
is void, the default group's action is TaskAction::Continue, so that all
tasks are started normally. Otherwise, when the start handler returns
TaskAction::StopWithDone or TaskAction::StopWithError, the tasks are not
started (they are skipped) and the group itself reports success or failure,
depending on the returned value, respectively.
\code
const Group root {
onGroupSetup([] { qDebug() << "Root setup"; }),
Group {
onGroupSetup([] { qDebug() << "Group 1 setup"; return TaskAction::Continue; }),
ProcessTask(...) // Process 1
},
Group {
onGroupSetup([] { qDebug() << "Group 2 setup"; return TaskAction::StopWithDone; }),
ProcessTask(...) // Process 2
},
Group {
onGroupSetup([] { qDebug() << "Group 3 setup"; return TaskAction::StopWithError; }),
ProcessTask(...) // Process 3
},
ProcessTask(...) // Process 4
};
\endcode
In the above example, all subgroups of a root group define their setup handlers.
The following scenario assumes that all started processes finish with success:
\table
\header
\li Scenario
\li Comment
\row
\li Root Group starts
\li Doesn't return TaskAction, so its tasks are executed.
\row
\li Group 1 starts
\li Returns Continue, so its tasks are executed.
\row
\li Process 1 starts
\li
\row
\li ...
\li ...
\row
\li Process 1 finishes (success)
\li
\row
\li Group 1 finishes (success)
\li
\row
\li Group 2 starts
\li Returns StopWithDone, so Process 2 is skipped and Group 2 reports
success.
\row
\li Group 2 finishes (success)
\li
\row
\li Group 3 starts
\li Returns StopWithError, so Process 3 is skipped and Group 3 reports
an error.
\row
\li Group 3 finishes (error)
\li
\row
\li Root Group finishes (error)
\li Group 3, which is a direct child of the root group, finished with an
error, so the root group stops executing, skips Process 4, which has
not started yet, and reports an error.
\endtable
\section2 Groups's Done and Error Handlers
A Group's done or error handler is executed after the successful or failed
execution of its tasks, respectively. The final value reported by the
group depends on its \l {Workflow Policy}. The handlers can apply other
necessary actions. The done and error handlers are defined inside the
onGroupDone and onGroupError elements of a group, respectively. They do not
take arguments:
\code
const Group root {
onGroupSetup([] { qDebug() << "Root setup"; }),
ProcessTask(...),
onGroupDone([] { qDebug() << "Root finished with success"; }),
onGroupError([] { qDebug() << "Root finished with error"; })
};
\endcode
The group done and error handlers are optional. If you add more than one
onGroupDone or onGroupError each to a group, an assert is triggered at
runtime that includes an error message.
\note Even if the group setup handler returns StopWithDone or StopWithError,
one of the group's done or error handlers is invoked. This behavior differs
from that of task handlers and might change in the future.
\section1 Other Group Elements
A group can contain other elements that describe the processing flow, such as
the execution mode or workflow policy. It can also contain storage elements
that are responsible for collecting and sharing custom common data gathered
during group execution.
\section2 Execution Mode
The execution mode element in a Group specifies how the direct child tasks of
the Group are started. The most common execution modes are \l sequential and
\l parallel. It's also possible to specify the limit of tasks running
in parallel by using the parallelLimit function.
In all execution modes, a group starts tasks in the oder in which they appear.
If a child of a group is also a group, the child group runs its tasks
according to its own execution mode.
\section2 Workflow Policy
The workflow policy element in a Group specifies how the group should behave
when any of its \e direct child's tasks finish. For a detailed description of possible
policies, refer to WorkflowPolicy.
If a child of a group is also a group, the child group runs its tasks
according to its own workflow policy.
\section2 Storage
Use the Storage element to exchange information between tasks. Especially,
in the sequential execution mode, when a task needs data from another,
already finished task, before it can start. For example, a task tree that copies data by reading
it from a source and writing it to a destination might look as follows:
\code
static QByteArray load(const QString &fileName) { ... }
static void save(const QString &fileName, const QByteArray &array) { ... }
static GroupItem copyRecipe(const QString &source, const QString &destination)
{
struct CopyStorage { // [1] custom inter-task struct
QByteArray content; // [2] custom inter-task data
};
// [3] instance of custom inter-task struct manageable by task tree
const TreeStorage<CopyStorage> storage;
const auto onLoaderSetup = [source](Async<QByteArray> &async) {
async.setConcurrentCallData(&load, source);
};
// [4] runtime: task tree activates the instance from [7] before invoking handler
const auto onLoaderDone = [storage](const Async<QByteArray> &async) {
storage->content = async.result(); // [5] loader stores the result in storage
};
// [4] runtime: task tree activates the instance from [7] before invoking handler
const auto onSaverSetup = [storage, destination](Async<void> &async) {
const QByteArray content = storage->content; // [6] saver takes data from storage
async.setConcurrentCallData(&save, destination, content);
};
const auto onSaverDone = [](const Async<void> &async) {
qDebug() << "Save done successfully";
};
const Group root {
// [7] runtime: task tree creates an instance of CopyStorage when root is entered
Storage(storage),
AsyncTask<QByteArray>(onLoaderSetup, onLoaderDone),
AsyncTask<void>(onSaverSetup, onSaverDone)
};
return root;
}
const QString source = ...;
const QString destination = ...;
TaskTree taskTree(copyRecipe(source, destination));
connect(&taskTree, &TaskTree::done,
&taskTree, [] { qDebug() << "The copying finished successfully."; });
tasktree.start();
\endcode
In the example above, the inter-task data consists of a QByteArray content
variable [2] enclosed in a CopyStorage custom struct [1]. If the loader
finishes successfully, it stores the data in a CopyStorage::content
variable [5]. The saver then uses the variable to configure the saving task [6].
To enable a task tree to manage the CopyStorage struct, an instance of
TreeStorage<CopyStorage> is created [3]. If a copy of this object is
inserted as group's child task [7], an instance of CopyStorage struct is
created dynamically when the task tree enters this group. When the task
tree leaves this group, the existing instance of CopyStorage struct is
destructed as it's no longer needed.
If several task trees that hold a copy of the common TreeStorage<CopyStorage>
instance run simultaneously, each task tree contains its own copy of the
CopyStorage struct.
You can access CopyStorage from any handler in the group with a storage object.
This includes all handlers of all descendant tasks of the group with
a storage object. To access the custom struct in a handler, pass the
copy of the TreeStorage<CopyStorage> object to the handler (for example, in
a lambda capture) [4].
When the task tree invokes a handler in a subtree containing the storage [7],
the task tree activates its own CopyStorage instance inside the
TreeStorage<CopyStorage> object. Therefore, the CopyStorage struct may be
accessed only from within the handler body. To access the currently active
CopyStorage from within TreeStorage<CopyStorage>, use the TreeStorage::operator->(),
TreeStorage::operator*() or TreeStorage::activeStorage() method.
The following list summarizes how to employ a Storage object into the task
tree:
\list 1
\li Define the custom structure MyStorage with custom data [1], [2]
\li Create an instance of TreeStorage<MyStorage> storage [3]
\li Pass the TreeStorage<MyStorage> instance to handlers [4]
\li Access the MyStorage instance in handlers [5], [6]
\li Insert the TreeStorage<MyStorage> instance into a group [7]
\endlist
\note The current implementation assumes that all running task trees
containing copies of the same TreeStorage run in the same thread. Otherwise,
the behavior is undefined.
\section1 TaskTree
TaskTree executes the tree structure of asynchronous tasks according to the
recipe described by the Group root element.
As TaskTree is also an asynchronous task, it can be a part of another TaskTree.
To place a nested TaskTree inside another TaskTree, insert the TaskTreeTask
element into other tree's Group element.
TaskTree reports progress of completed tasks when running. The progress value
is increased when a task finishes or is skipped or stopped.
When TaskTree is finished and the TaskTree::done() or TaskTree::errorOccurred()
signal is emitted, the current value of the progress equals the maximum
progress value. Maximum progress equals the total number of tasks in a tree.
A nested TaskTree is counted as a single task, and its child tasks are not
counted in the top level tree. Groups themselves are not counted as tasks,
but their tasks are counted.
To set additional initial data for the running tree, modify the storage
instances in a tree when it creates them by installing a storage setup
handler:
\code
TreeStorage<CopyStorage> storage;
Group root = ...; // storage placed inside root's group and inside handlers
TaskTree taskTree(root);
auto initStorage = [](CopyStorage *storage){
storage->content = "initial content";
};
taskTree.onStorageSetup(storage, initStorage);
taskTree.start();
\endcode
When the running task tree creates a CopyStorage instance, and before any
handler inside a tree is called, the task tree calls the initStorage handler,
to enable setting up initial data of the storage, unique to this particular
run of taskTree.
Similarly, to collect some additional result data from the running tree,
read it from storage instances in the tree when they are about to be
destroyed. To do this, install a storage done handler:
\code
TreeStorage<CopyStorage> storage;
Group root = ...; // storage placed inside root's group and inside handlers
TaskTree taskTree(root);
auto collectStorage = [](CopyStorage *storage){
qDebug() << "final content" << storage->content;
};
taskTree.onStorageDone(storage, collectStorage);
taskTree.start();
\endcode
When the running task tree is about to destroy a CopyStorage instance, the
task tree calls the collectStorage handler, to enable reading the final data
from the storage, unique to this particular run of taskTree.
\section1 Task Adapters
To extend a TaskTree with new a task type, implement a simple adapter class
derived from the TaskAdapter class template. The following class is an
adapter for a single shot timer, which may be considered as a new
asynchronous task:
\code
class TimeoutTaskAdapter : public Tasking::TaskAdapter<QTimer>
{
public:
TimeoutTaskAdapter() {
task()->setSingleShot(true);
task()->setInterval(1000);
connect(task(), &QTimer::timeout, this, [this] { emit done(true); });
}
void start() final { task()->start(); }
};
QTC_DECLARE_CUSTOM_TASK(TimeoutTask, TimeoutTaskAdapter);
\endcode
You must derive the custom adapter from the TaskAdapter class template
instantiated with a template parameter of the class implementing a running
task. The code above uses QTimer to run the task. This class appears
later as an argument to the task's handlers. The instance of this class
parameter automatically becomes a member of the TaskAdapter template, and is
accessible through the TaskAdapter::task() method. The constructor
of TimeoutTaskAdapter initially configures the QTimer object and connects
to the QTimer::timeout signal. When the signal is triggered, TimeoutTaskAdapter
emits the done(true) signal to inform the task tree that the task finished
successfully. If it emits done(false), the task finished with an error.
The TaskAdapter::start() method starts the timer.
To make QTimer accessible inside TaskTree under the \e TimeoutTask name,
register it with QTC_DECLARE_CUSTOM_TASK(TimeoutTask, TimeoutTaskAdapter).
TimeoutTask becomes a new task type inside Tasking namespace, using TimeoutTaskAdapter.
The new task type is now registered, and you can use it in TaskTree:
\code
const auto onTimeoutSetup = [](QTimer &task) {
task.setInterval(2000);
};
const auto onTimeoutDone = [](const QTimer &task) {
qDebug() << "timeout triggered";
};
const Group root {
TimeoutTask(onTimeoutSetup, onTimeoutDone)
};
\endcode
When a task tree containing the root from the above example is started, it
prints a debug message within two seconds and then finishes successfully.
\note The class implementing the running task should have a default constructor,
and objects of this class should be freely destructible. It should be allowed
to destroy a running object, preferably without waiting for the running task
to finish (that is, safe non-blocking destructor of a running task).
*/
TaskTree::TaskTree()
: d(new TaskTreePrivate(this))
{
}
TaskTree::TaskTree(const Group &recipe) : TaskTree()
{
setRecipe(recipe);
}
TaskTree::~TaskTree()
{
QTC_ASSERT(!d->m_guard.isLocked(), qWarning("Deleting TaskTree instance directly from "
"one of its handlers will lead to crash!"));
// TODO: delete storages explicitly here?
delete d;
}
void TaskTree::setRecipe(const Group &recipe)
{
QTC_ASSERT(!isRunning(), qWarning("The TaskTree is already running, ignoring..."); return);
QTC_ASSERT(!d->m_guard.isLocked(), qWarning("The setRecipe() is called from one of the"
"TaskTree handlers, ignoring..."); return);
d->m_storages.clear();
d->m_root.reset(new TaskNode(d, recipe, nullptr));
}
void TaskTree::start()
{
QTC_ASSERT(!isRunning(), qWarning("The TaskTree is already running, ignoring..."); return);
QTC_ASSERT(!d->m_guard.isLocked(), qWarning("The start() is called from one of the"
"TaskTree handlers, ignoring..."); return);
d->start();
}
void TaskTree::stop()
{
QTC_ASSERT(!d->m_guard.isLocked(), qWarning("The stop() is called from one of the"
"TaskTree handlers, ignoring..."); return);
d->stop();
}
bool TaskTree::isRunning() const
{
return d->m_root && d->m_root->isRunning();
}
bool TaskTree::runBlocking()
{
QPromise<void> dummy;
dummy.start();
return runBlocking(dummy.future());
}
bool TaskTree::runBlocking(const QFuture<void> &future)
{
if (future.isCanceled())
return false;
bool ok = false;
QEventLoop loop;
const auto finalize = [&loop, &ok](bool success) {
ok = success;
// Otherwise, the tasks from inside the running tree that were deleteLater()
// will be leaked. Refer to the QObject::deleteLater() docs.
QMetaObject::invokeMethod(&loop, [&loop] { loop.quit(); }, Qt::QueuedConnection);
};
QFutureWatcher<void> watcher;
connect(&watcher, &QFutureWatcherBase::canceled, this, &TaskTree::stop);
watcher.setFuture(future);
connect(this, &TaskTree::done, &loop, [finalize] { finalize(true); });
connect(this, &TaskTree::errorOccurred, &loop, [finalize] { finalize(false); });
QTimer::singleShot(0, this, &TaskTree::start);
loop.exec(QEventLoop::ExcludeUserInputEvents);
if (!ok) {
auto nonConstFuture = future;
nonConstFuture.cancel();
}
return ok;
}
bool TaskTree::runBlocking(const Group &recipe, milliseconds timeout)
{
QPromise<void> dummy;
dummy.start();
return TaskTree::runBlocking(recipe, dummy.future(), timeout);
}
bool TaskTree::runBlocking(const Group &recipe, const QFuture<void> &future, milliseconds timeout)
{
const Group root = timeout == milliseconds::max() ? recipe
: Group { recipe.withTimeout(timeout) };
TaskTree taskTree(root);
return taskTree.runBlocking(future);
}
int TaskTree::taskCount() const
{
return d->m_root ? d->m_root->taskCount() : 0;
}
int TaskTree::progressValue() const
{
return d->m_progressValue;
}
void TaskTree::setupStorageHandler(const TreeStorageBase &storage,
StorageVoidHandler setupHandler,
StorageVoidHandler doneHandler)
{
auto it = d->m_storageHandlers.find(storage);
if (it == d->m_storageHandlers.end()) {
d->m_storageHandlers.insert(storage, {setupHandler, doneHandler});
return;
}
if (setupHandler) {
QTC_ASSERT(!it->m_setupHandler,
qWarning("The storage has its setup handler defined, overriding..."));
it->m_setupHandler = setupHandler;
}
if (doneHandler) {
QTC_ASSERT(!it->m_doneHandler,
qWarning("The storage has its done handler defined, overriding..."));
it->m_doneHandler = doneHandler;
}
}
TaskTreeTaskAdapter::TaskTreeTaskAdapter()
{
connect(task(), &TaskTree::done, this, [this] { emit done(true); });
connect(task(), &TaskTree::errorOccurred, this, [this] { emit done(false); });
}
void TaskTreeTaskAdapter::start()
{
task()->start();
}
using TimeoutCallback = std::function<void()>;
struct TimerData
{
system_clock::time_point m_deadline;
QPointer<QObject> m_context;
TimeoutCallback m_callback;
};
QMutex s_mutex;
std::atomic_int s_timerId = 0;
QHash<int, TimerData> s_timerIdToTimerData = {};
QMultiMap<system_clock::time_point, int> s_deadlineToTimerId = {};
static QList<TimerData> prepareForActivation(int timerId)
{
QMutexLocker lock(&s_mutex);
const auto it = s_timerIdToTimerData.constFind(timerId);
if (it == s_timerIdToTimerData.cend())
return {}; // the timer was already activated
const system_clock::time_point deadline = it->m_deadline;
QList<TimerData> toActivate;
auto itMap = s_deadlineToTimerId.cbegin();
while (itMap != s_deadlineToTimerId.cend()) {
if (itMap.key() > deadline)
break;
const auto it = s_timerIdToTimerData.constFind(itMap.value());
if (it != s_timerIdToTimerData.cend()) {
toActivate.append(it.value());
s_timerIdToTimerData.erase(it);
}
itMap = s_deadlineToTimerId.erase(itMap);
}
return toActivate;
}
static void removeTimerId(int timerId)
{
QMutexLocker lock(&s_mutex);
const auto it = s_timerIdToTimerData.constFind(timerId);
QTC_ASSERT(it != s_timerIdToTimerData.cend(),
qWarning("Removing active timerId failed."); return);
const system_clock::time_point deadline = it->m_deadline;
s_timerIdToTimerData.erase(it);
const int removedCount = s_deadlineToTimerId.remove(deadline, timerId);
QTC_ASSERT(removedCount == 1, qWarning("Removing active timerId failed."); return);
}
static void handleTimeout(int timerId)
{
const QList<TimerData> toActivate = prepareForActivation(timerId);
for (const TimerData &timerData : toActivate) {
if (timerData.m_context)
QMetaObject::invokeMethod(timerData.m_context.get(), timerData.m_callback);
}
}
static int scheduleTimeout(milliseconds timeout, QObject *context, const TimeoutCallback &callback)
{
const int timerId = s_timerId.fetch_add(1) + 1;
const system_clock::time_point deadline = system_clock::now() + timeout;
QTimer::singleShot(timeout, context, [timerId] { handleTimeout(timerId); });
QMutexLocker lock(&s_mutex);
s_timerIdToTimerData.emplace(timerId, TimerData{deadline, context, callback});
s_deadlineToTimerId.insert(deadline, timerId);
return timerId;
}
TimeoutTaskAdapter::TimeoutTaskAdapter()
{
*task() = std::chrono::milliseconds::zero();
}
TimeoutTaskAdapter::~TimeoutTaskAdapter()
{
if (m_timerId)
removeTimerId(*m_timerId);
}
void TimeoutTaskAdapter::start()
{
if (*task() == milliseconds::zero())
QTimer::singleShot(0, this, [this] { emit done(true); });
else
m_timerId = scheduleTimeout(*task(), this, [this] { m_timerId = {}; emit done(true); });
}
} // namespace Tasking
View Git Blame Copy Permalink