1/****************************************************************************
2**
3** Copyright (C) 2014 Klaralvdalens Datakonsult AB (KDAB).
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the Qt3D module of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL$
9** Commercial License Usage
10** Licensees holding valid commercial Qt licenses may use this file in
11** accordance with the commercial license agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and The Qt Company. For licensing terms
14** and conditions see https://www.qt.io/terms-conditions. For further
15** information use the contact form at https://www.qt.io/contact-us.
16**
17** GNU Lesser General Public License Usage
18** Alternatively, this file may be used under the terms of the GNU Lesser
19** General Public License version 3 as published by the Free Software
20** Foundation and appearing in the file LICENSE.LGPL3 included in the
21** packaging of this file. Please review the following information to
22** ensure the GNU Lesser General Public License version 3 requirements
23** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24**
25** GNU General Public License Usage
26** Alternatively, this file may be used under the terms of the GNU
27** General Public License version 2.0 or (at your option) the GNU General
28** Public license version 3 or any later version approved by the KDE Free
29** Qt Foundation. The licenses are as published by the Free Software
30** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31** included in the packaging of this file. Please review the following
32** information to ensure the GNU General Public License requirements will
33** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34** https://www.gnu.org/licenses/gpl-3.0.html.
35**
36** $QT_END_LICENSE$
37**
38****************************************************************************/
39
40#include "qscheduler_p.h"
41
42#include <Qt3DCore/qabstractaspect.h>
43
44#include <Qt3DCore/private/qabstractaspect_p.h>
45#include <Qt3DCore/private/qaspectmanager_p.h>
46#include <Qt3DCore/private/qaspectjob_p.h>
47#include <Qt3DCore/private/qabstractaspectjobmanager_p.h>
48
49#include <QtCore/QCoreApplication>
50#include <QtCore/QDateTime>
51#include <QtCore/QRegularExpression>
52
53QT_BEGIN_NAMESPACE
54
55namespace {
56
57// Creates a graphviz dot file. To view online: https://dreampuf.github.io/GraphvizOnline/
58void dumpJobs(QVector<Qt3DCore::QAspectJobPtr> jobs) {
59 const QString fileName = QStringLiteral("qt3djobs_") + QCoreApplication::applicationName() +
60 QDateTime::currentDateTime().toString(QStringLiteral("_yyMMdd-hhmmss")) + QStringLiteral(".dot");
61
62 QFile f(fileName);
63 if (!f.open(flags: QFile::WriteOnly))
64 return;
65
66 auto formatJob = [](Qt3DCore::QAspectJob *job) -> QString {
67 auto jobId = Qt3DCore::QAspectJobPrivate::get(job)->m_jobId;
68 auto type = Qt3DCore::QAspectJobPrivate::get(job)->m_jobName.replace(re: QRegularExpression(QLatin1String("(^.*::)")), after: QLatin1String(""));
69 return QString(QLatin1String("\"%1_%2\"")).arg(a: type).arg(a: jobId.typeAndInstance[1]);
70 };
71
72 QTextStream stream(&f);
73 stream << "digraph qt3d_jobs {" << Qt::endl;
74
75 for (const auto &job: jobs) {
76 if (!Qt3DCore::QAspectJobPrivate::get(job: job.data())->isRequired())
77 stream << QLatin1String("\t") << formatJob(job.data()) << QLatin1String(" [style=dotted]") << Qt::endl;
78 }
79
80 for (const auto &job: jobs) {
81 auto dependencies = job->dependencies();
82 for (const auto &dependency: dependencies)
83 stream << QLatin1String("\t") << formatJob(dependency.toStrongRef().data()) << QLatin1String(" -> ") << formatJob(job.data()) << Qt::endl;
84 }
85
86 stream << "}" << Qt::endl;
87}
88
89}
90
91namespace Qt3DCore {
92
93QScheduler::QScheduler(QObject *parent)
94 : QObject(parent)
95 , m_aspectManager(nullptr)
96{
97}
98
99QScheduler::~QScheduler()
100{
101}
102
103void QScheduler::setAspectManager(QAspectManager *aspectManager)
104{
105 m_aspectManager = aspectManager;
106}
107
108QAspectManager *QScheduler::aspectManager() const
109{
110 return m_aspectManager;
111}
112
113int QScheduler::scheduleAndWaitForFrameAspectJobs(qint64 time, bool dumpJobs)
114{
115 QVector<QAspectJobPtr> jobQueue;
116
117 // TODO: Allow clocks with custom scale factors and independent control
118 // over running / paused / stopped status
119 // TODO: Advance all clocks registered with the engine
120
121 // TODO: Set up dependencies between jobs as needed
122 // For now just queue them up as they are
123 const QVector<QAbstractAspect *> &aspects = m_aspectManager->aspects();
124 for (QAbstractAspect *aspect : aspects) {
125 const QVector<QAspectJobPtr> aspectJobs = QAbstractAspectPrivate::get(aspect)->jobsToExecute(time);
126 jobQueue << aspectJobs;
127 }
128
129 if (dumpJobs)
130 ::dumpJobs(jobs: jobQueue);
131
132 m_aspectManager->jobManager()->enqueueJobs(jobQueue);
133
134 // Do any other work here that the aspect thread can usefully be doing
135 // whilst the threadpool works its way through the jobs
136
137 int totalJobs = m_aspectManager->jobManager()->waitForAllJobs();
138
139 {
140 QTaskLogger logger(m_aspectManager->serviceLocator()->systemInformation(), 4097, 0, QTaskLogger::AspectJob);
141
142 for (auto &job : qAsConst(t&: jobQueue))
143 QAspectJobPrivate::get(job: job.data())->postFrame(aspectManager: m_aspectManager);
144
145 for (QAbstractAspect *aspect : aspects)
146 QAbstractAspectPrivate::get(aspect)->jobsDone();
147 }
148
149 return totalJobs;
150}
151
152} // namespace Qt3DCore
153
154QT_END_NAMESPACE
155

source code of qt3d/src/core/qscheduler.cpp