Currently job artifacts in CI/CD pipelines on LRZ GitLab never expire. Starting from Wed 26.1.2022 the default expiration time will be 30 days (GitLab default). Currently existing artifacts in already completed jobs will not be affected by the change. The latest artifacts for all jobs in the latest successful pipelines will be kept. More information: https://gitlab.lrz.de/help/user/admin_area/settings/continuous_integration.html#default-artifacts-expiration

opengljobprocessor.cpp 8.99 KB
Newer Older
1
2
// ================================================================================================
// 
schultezub's avatar
schultezub committed
3
// This file is part of the CAMPVis Software Framework.
4
// 
5
// If not explicitly stated otherwise: Copyright (C) 2012-2013, all rights reserved,
schultezub's avatar
schultezub committed
6
//      Christian Schulte zu Berge <christian.szb@in.tum.de>
7
//      Chair for Computer Aided Medical Procedures
8
9
//      Technische Universität München
//      Boltzmannstr. 3, 85748 Garching b. München, Germany
10
// 
schultezub's avatar
schultezub committed
11
// For a full list of authors and contributors, please refer to the file "AUTHORS.txt".
12
// 
13
14
15
16
// Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file 
// except in compliance with the License. You may obtain a copy of the License at
// 
// http://www.apache.org/licenses/LICENSE-2.0
17
// 
18
19
20
21
// Unless required by applicable law or agreed to in writing, software distributed under the 
// License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, 
// either express or implied. See the License for the specific language governing permissions 
// and limitations under the License.
22
23
24
25
26
27
// 
// ================================================================================================

#include "opengljobprocessor.h"

#include "tgt/assert.h"
28
29
#include "tgt/logmanager.h"
#include "tgt/openglgarbagecollector.h"
30
#include "tgt/glcontextmanager.h"
31
32
#include "core/tools/job.h"

schultezub's avatar
schultezub committed
33
namespace campvis {
34

35
36
    std::thread::id OpenGLJobProcessor::_this_thread_id;

37
38
    OpenGLJobProcessor::OpenGLJobProcessor()
    {
39
        _pause = 0;
40
        _currentContext = 0;
41
42
43
    }

    OpenGLJobProcessor::~OpenGLJobProcessor() {
schultezub's avatar
schultezub committed
44
45
46
47
48
49
50
        // delete all per-context job queues and unfinished jobs
        for (tbb::concurrent_vector<tgt::GLCanvas*>::const_iterator it = _contexts.begin(); it != _contexts.end(); ++it) {
            tbb::concurrent_hash_map<tgt::GLCanvas*, PerContextJobQueue*>::const_accessor a;
            if (_contextQueueMap.find(a, *it)) {
                delete a->second;
            }
        }
51

schultezub's avatar
schultezub committed
52
53
        _contextQueueMap.clear();
        _contexts.clear();
54
55
56
57
58
59
60
61
    }

    void OpenGLJobProcessor::stop() {
        _stopExecution = true;
        _evaluationCondition.notify_all();
    }

    void OpenGLJobProcessor::run() {
62
63
        _this_thread_id = std::this_thread::get_id();

64
        std::unique_lock<tbb::mutex> lock(tgt::GlContextManager::getRef().getGlMutex());
65
        clock_t lastCleanupTime = clock() * 1000 / CLOCKS_PER_SEC;
66
67

        while (! _stopExecution) {
68
69
            // this is a simple round-robing scheduling between all contexts:
            bool hadWork = false;
schultezub's avatar
schultezub committed
70
            // TODO: consider only non-empty context queues here
71
            clock_t maxTimePerContext = static_cast<clock_t>(30 / _contexts.size());
72
73

            for (size_t i = 0; i < _contexts.size(); ++i) {
74
                clock_t startTimeCurrentContext = clock() * 1000 / CLOCKS_PER_SEC;
75
76
77
78
                tgt::GLCanvas* context = _contexts[i];

                tbb::concurrent_hash_map<tgt::GLCanvas*, PerContextJobQueue*>::const_accessor a;
                if (!_contextQueueMap.find(a, context)) {
79
80
                    //tgtAssert(false, "Should not reach this: Did not find context in contextQueueMap!");
                    continue;
81
82
                }

83
                // avoid expensive context-switches for contexts without pending jobs.
84
85
86
                if (a->second->empty())
                    continue;

87
88
89
                // we will have work, so update the flag
                hadWork = true;

schultezub's avatar
schultezub committed
90
                // perform context switch if necessary
91
                if (_currentContext != context) {
92
93
94
95
                    if (_currentContext != 0) {
                        glFinish();
                        LGL_ERROR;
                    }
96
                    tgt::GlContextManager::getRef().acquireContext(context);
97
98
99
100
101
102
                    _currentContext = context;
                }

                // now comes the per-context scheduling strategy:
                // first: perform as much serial jobs as possible:
                AbstractJob* jobToDo = 0;
103
                while ((clock() * 1000 / CLOCKS_PER_SEC) - startTimeCurrentContext < maxTimePerContext) {
104
105
106
107
108
109
110
111
112
113
114
115
116
117
                    // try fetch a job
                    if (! a->second->_serialJobs.try_pop(jobToDo)) {
                        // no job to do, exit the while loop
                        break;
                    }
                    // execute and delete the job
                    jobToDo->execute();
                    delete jobToDo;
                }

                // second: execute one low-prio job if existant
                if (a->second->_lowPriorityJobs.try_pop(jobToDo)) {
                    jobToDo->execute();
                    delete jobToDo;
118
119
                }

120
                // third: execute paint job
121
122
                jobToDo = a->second->_paintJob.fetch_and_store(0);
                if (jobToDo != 0) {
123
124
125
                    jobToDo->execute();
                    delete jobToDo;
                }
126
127
128
129
130
131
132


                // fourth: start the GC if it's time
                if (clock() * 1000 / CLOCKS_PER_SEC - lastCleanupTime > 250) {
                    GLGC.deleteGarbage();
                    lastCleanupTime = clock();
                }
133
            }
134
135
            
            while (_pause > 0) {
136
137
                GLGC.deleteGarbage();
                lastCleanupTime = clock();
138
                tgt::GlContextManager::getRef().releaseCurrentContext();
139
                _evaluationCondition.wait(lock);
140
                tgt::GlContextManager::getRef().acquireContext(_currentContext);
141
142
                hadWork = true;
            }
143

144
            if (! hadWork) {
145
146
147
148
                if (_currentContext != 0) {
                    GLGC.deleteGarbage();
                    lastCleanupTime = clock();
                }
149
                tgt::GlContextManager::getRef().releaseCurrentContext();
150
                _evaluationCondition.wait(lock);
151
                tgt::GlContextManager::getRef().acquireContext(_currentContext);
152
            }
153
154
155
        }

        // release OpenGL context, so that other threads can access it
156
        tgt::GlContextManager::getRef().releaseCurrentContext();
157
158
    }

159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
    void OpenGLJobProcessor::pause() {
        ++_pause;
    }

    void OpenGLJobProcessor::resume() {
        if (_pause == 0) {
            tgtAssert(false, "Called resume on non-paused job processor!");
            return;
        }

        --_pause;
        if (_pause == 0)
            _evaluationCondition.notify_all();
    }

174
175
176
177
178
    void OpenGLJobProcessor::enqueueJob(tgt::GLCanvas* canvas, AbstractJob* job, JobType priority) {
        tbb::concurrent_hash_map<tgt::GLCanvas*, PerContextJobQueue*>::const_accessor a;
        if (_contextQueueMap.find(a, canvas)) {
            switch (priority) {
            case PaintJob:
179
180
181
182
183
184
                {
                    AbstractJob* oldJob = a->second->_paintJob.fetch_and_store(job);
                    if (oldJob != 0)
                        delete oldJob;
                    break;
                }
185
186
187
188
189
190
191
192
193
194
195
196
            case SerialJob:
                a->second->_serialJobs.push(job);
                break;
            case LowPriorityJob:
                a->second->_lowPriorityJobs.push(job);
                break;
            default:
                tgtAssert(false, "Should not reach this - wrong job type!");
                break;
            } 
        }
        else {
197
            tgtAssert(false, "Specified context not found. Contexts must be registered before they can have jobs.");
198
        }
199
200
201

        _evaluationCondition.notify_all();
    }
202
203

    void OpenGLJobProcessor::registerContext(tgt::GLCanvas* context) {
schultezub's avatar
schultezub committed
204
#ifdef CAMPVIS_DEBUG
205
206
207
208
209
210
211
212
213
214
        tbb::concurrent_hash_map<tgt::GLCanvas*, PerContextJobQueue*>::const_accessor a;
        if (_contextQueueMap.find(a, context))
            tgtAssert(false, "Contexts shall only be registered once!");
#endif

        PerContextJobQueue* newQueue = new PerContextJobQueue;
        _contextQueueMap.insert(std::make_pair(context, newQueue));
        _contexts.push_back(context);
    }

215
    void OpenGLJobProcessor::deregisterContext(tgt::GLCanvas* context) {
216
        tbb::concurrent_hash_map<tgt::GLCanvas*, PerContextJobQueue*>::accessor a;
217
218
219
220
        if (_contextQueueMap.find(a, context)) {
            delete a->second;
            _contextQueueMap.erase(a);
        }
221
222
223

        if (_currentContext == context)
            _currentContext.compare_and_swap(0, context);
224
225
    }

226
227
228
229
230
231
232
233
234
235
236
    tgt::GLCanvas* OpenGLJobProcessor::iKnowWhatImDoingGetArbitraryContext() {
        if (_currentContext != 0)
            return _currentContext;
        else if (!_contexts.empty())
            return _contexts.front();
        else {
            tgtAssert(false, "No Contexts registered!");
            return 0;
        }
    }

237
238
239
240
    bool OpenGLJobProcessor::isCurrentThreadOpenGlThread() const {
        return std::this_thread::get_id() == _this_thread_id;
    }

241
242
}