summaryrefslogtreecommitdiffstats
path: root/src/core/jobs/dependencyhandler.cpp
blob: d39b04ba430403a743c1de7cb1b6d4582972c539 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
/****************************************************************************
**
** Copyright (C) 2015 The Qt Company Ltd.
** Contact: http://www.qt.io/licensing/
**
** This file is part of the Qt3D module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL3$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see http://www.qt.io/terms-conditions. For further
** information use the contact form at http://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPLv3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or later as published by the Free
** Software Foundation and appearing in the file LICENSE.GPL included in
** the packaging of this file. Please review the following information to
** ensure the GNU General Public License version 2.0 requirements will be
** met: http://www.gnu.org/licenses/gpl-2.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/

#include <iterator>

#include "dependencyhandler_p.h"

QT_BEGIN_NAMESPACE

namespace Qt3DCore {

namespace {
    template <template <typename T> class Op>
    struct ByDepender {
        typedef bool result_type;

        bool operator()(const RunnableInterface *lhs, const RunnableInterface *rhs) const Q_DECL_NOTHROW
        { return Op<const RunnableInterface *>()(lhs, rhs); }

        bool operator()(const RunnableInterface *lhs, const Dependency &rhs) const Q_DECL_NOTHROW
        { return operator()(lhs, rhs.depender); }

        bool operator()(const Dependency &lhs, const RunnableInterface *rhs) const Q_DECL_NOTHROW
        { return operator()(lhs.depender, rhs); }

        bool operator()(const Dependency &lhs, const Dependency &rhs) const Q_DECL_NOTHROW
        { return operator()(lhs.depender, rhs.depender); }
    };

    struct DependeeEquals : std::unary_function<Dependency, bool>
    {
        const RunnableInterface *dependee;
        QVector<RunnableInterface *> *freedList;
        explicit DependeeEquals(const RunnableInterface *dependee, QVector<RunnableInterface *> *freedList)
            : dependee(qMove(dependee)), freedList(qMove(freedList)) {}
        bool operator()(const Dependency &candidate) const
        {
            if (dependee == candidate.dependee) {
                if (!candidate.depender->reserved())
                    freedList->append(candidate.depender);
                return true;
            }
            return false;
        }
    };

    struct DependerEquals : std::unary_function<Dependency, bool>
    {
        const RunnableInterface *depender;
        explicit DependerEquals(const RunnableInterface *depender)
            : depender(qMove(depender)) {}
        bool operator()(const Dependency &candidate) const
        {
            return depender == candidate.depender;
        }
    };

    struct ByDependerThenDependee : std::binary_function<Dependency, Dependency, bool>
    {
        // Defines a lexicographical order (depender first).
        bool operator()(const Dependency &lhs, const Dependency &rhs)
        {
            if (lhs.depender < rhs.depender) return true;
            if (rhs.depender < lhs.depender) return false;
            return lhs.dependee < rhs.dependee;
        }
    };
}

DependencyHandler::DependencyHandler()
{
}

void DependencyHandler::addDependencies(QVector<Dependency> dependencies)
{
    std::sort(dependencies.begin(), dependencies.end(), ByDependerThenDependee());

    const QMutexLocker locker(m_mutex);

    QVector<Dependency> newDependencyMap;
    newDependencyMap.reserve(dependencies.size() + m_dependencyMap.size());
    std::set_union(m_dependencyMap.begin(), m_dependencyMap.end(),
                   dependencies.begin(), dependencies.end(),
                   std::back_inserter(newDependencyMap), ByDependerThenDependee());
    m_dependencyMap.swap(newDependencyMap); // commit
}

bool DependencyHandler::hasDependency(const RunnableInterface *depender)
{
    // The caller has to set the mutex, which is QThreadPooler::enqueueTasks

    return std::binary_search(m_dependencyMap.begin(), m_dependencyMap.end(),
                              depender, ByDepender<std::less>());
}

/*
 * Removes all the entries on the m_dependencyMap that have given task as a dependee,
 * i.e. entries where the dependency is on the given task.
 */
QVector<RunnableInterface *> DependencyHandler::freeDependencies(const RunnableInterface *task)
{
    // The caller has to set the mutex, which is QThreadPooler::taskFinished

    m_dependencyMap.erase(std::remove_if(m_dependencyMap.begin(),
                                         m_dependencyMap.end(),
                                         DependerEquals(task)),
                          m_dependencyMap.end());

    QVector<RunnableInterface *> freedList;
    m_dependencyMap.erase(std::remove_if(m_dependencyMap.begin(),
                                         m_dependencyMap.end(),
                                         DependeeEquals(task, &freedList)),
                          m_dependencyMap.end());

    return freedList;
}

} // namespace Qt3DCore

QT_END_NAMESPACE