opengljobprocessor.h 7.46 KB
Newer Older
1
2
// ================================================================================================
// 
schultezub's avatar
schultezub committed
3
// This file is part of the CAMPVis Visualization Framework.
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
// 
// If not explicitly stated otherwise: Copyright (C) 2012, all rights reserved,
//      Christian Schulte zu Berge (christian.szb@in.tum.de)
//      Chair for Computer Aided Medical Procedures
//      Technische Universität München
//      Boltzmannstr. 3, 85748 Garching b. München, Germany
// 
// The licensing of this softare is not yet resolved. Until then, redistribution in source or
// binary forms outside the CAMP chair is not permitted, unless explicitly stated in legal form.
// However, the names of the original authors and the above copyright notice must retain in its
// original state in any case.
// 
// Legal disclaimer provided by the BSD license:
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR
// IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY 
// AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR 
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 
// SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR 
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.
// 
// ================================================================================================

#ifndef OPENGLJOBPROCESSOR_H__
#define OPENGLJOBPROCESSOR_H__

#include "sigslot/sigslot.h"
#include "tgt/singleton.h"
#include "tbb/include/tbb/atomic.h"
35
36
37
#include "tbb/include/tbb/concurrent_queue.h"
#include "tbb/include/tbb/concurrent_hash_map.h"
#include "tbb/include/tbb/concurrent_vector.h"
38
#include "tbb/include/tbb/compat/condition_variable"
39
#include "core/tools/job.h"
40
41
#include "core/tools/runnable.h"

42
43
44
#include <ctime>


45
46
47
48
namespace tgt {
    class GLCanvas;
}

schultezub's avatar
schultezub committed
49
namespace campvis {
50
    /**
schultezub's avatar
schultezub committed
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
     * Singleton class for managing and executing work items (jobs) that need an active OpenGL context.
     * After an OpenGL context has been registered you can enqueue jobs that are to be executed within that 
     * context to the job queue. Enqueued jobs are executed asynchroniously using a specific scheduling 
     * strategy, depending on the given JobType:
     * 
     * OpenGLJobProcessor implements a round-robin scheduling strategy for the registered OpenGL contexts, 
     * meaning that each context gets roughly the same computing time. Thereby, it tries to maintain an update
     * frequency of 30fps for each context.
     * The jobs for each contexts are scheduled using the following technique: As mentioned above, each context
     * has a time slot of \a n milliseconds. At first, as much serial jobs are executed as possible until their
     * queue is empty or or the time is up. Then, one low priority job is executed. Finally, the PaintJob is
     * executed (if existant) before switching to the next context.
     * 
     * This class implements the Runnable interface, hence, runs in its own thread. Furthermore, it uses 
     * conditional wait, when there are currently no jobs to process.
     * 
     * This class is to be considered as thread-safe.
68
69
70
71
72
     */
    class OpenGLJobProcessor : public tgt::Singleton<OpenGLJobProcessor>, public Runnable, public sigslot::has_slots<> {
        friend class tgt::Singleton<OpenGLJobProcessor>;

    public:
73
74
75
76
        /**
         * Enumeration of the different priorities of items.
         */
        enum JobType {
schultezub's avatar
schultezub committed
77
            PaintJob,           ///< PaintJobs have the highest priority, there can only be one paint job per context at a time.
78
79
            SerialJob,          ///< SerialJobs have a lower priority than PaintJobs, but are guaranteed to be executed in order.
            LowPriorityJob      ///< Low priority jobs have the lowest priority, can be executed at any time. The only guarantee is that thay won't starve.
80
81
        };

schultezub's avatar
schultezub committed
82
83
84
        /**
         * Destructor, deletes all unfinished jobs.
         */
85
86
87
        virtual ~OpenGLJobProcessor();


schultezub's avatar
schultezub committed
88
89
90
91
        /**
         * Registers the given OpenGL context, so that it gets its own job queue.
         * \param   context     OpenGL context to register.
         */
92
93
        void registerContext(tgt::GLCanvas* context);

94
95
96
97
98
99
        /**
         * Deregisters the given OpenGL context, so that it has no longer its own job queue.
         * \param   context     OpenGL context to deregister.
         */
        void deregisterContext(tgt::GLCanvas* context);

100
101
102
103
        /// \see Runnable::stop
        void stop();
        
        /**
schultezub's avatar
schultezub committed
104
         * Performs the job processing using conditional wait.
105
106
107
108
109
110
111
112
         * \sa Runnable::run
         */
        void run();

        /**
         * Enqueues the given Job with the given priority.
         * 
         * \note    OpenGLJobProcessor takes ownership of \a job.
schultezub's avatar
schultezub committed
113
         * \param   canvas      OpenGL context for which to enqueue the job, must be registered.
114
115
116
         * \param   job         Job to enqueue, PriorityPool takes ownership of this Job!
         * \param   priority    Priority of the job to enqueue
         */
117
        void enqueueJob(tgt::GLCanvas* canvas, AbstractJob* job, JobType priority);
118
119
120


    protected:
schultezub's avatar
schultezub committed
121
122
123
        /**
         * Struct encapsulating the job queue for a single OpenGL context.
         */
124
        struct PerContextJobQueue {
schultezub's avatar
schultezub committed
125
126
127
            /**
             * Creates an empty PerContextJobQueue.
             */
128
129
130
            PerContextJobQueue() {
                _paintJob = 0;
            }
schultezub's avatar
schultezub committed
131
132
133
134
135
136
137
138
139
140
141
142
143

            /**
             * Destructor, deletes all enqueued jobs.
             */
            ~PerContextJobQueue() {
                if (_paintJob != 0)
                    delete _paintJob;

                AbstractJob* jobToDelete = 0;
                while (_serialJobs.try_pop(jobToDelete))
                    delete jobToDelete;
                while (_lowPriorityJobs.try_pop(jobToDelete))
                    delete jobToDelete;
144
145
            }

146
            tbb::atomic<AbstractJob*> _paintJob;                    ///< PaintJob of the context
schultezub's avatar
schultezub committed
147
148
            tbb::concurrent_queue<AbstractJob*> _serialJobs;        ///< Queue of serial jobs for the context
            tbb::concurrent_queue<AbstractJob*> _lowPriorityJobs;   ///< Queue of jow priority jobs for the context
149

schultezub's avatar
schultezub committed
150
151
152
153
            /**
             * Checks, whether there is any job to do for this context.
             * \return (_serialJobs.empty() && _lowPriorityJobs.empty() && (_paintJob == 0))
             */
154
155
156
157
158
            bool empty() const {
                return (_serialJobs.empty() && _lowPriorityJobs.empty() && (_paintJob == 0));
            }
        };

159
160
        OpenGLJobProcessor();

161
162
163
        tbb::concurrent_hash_map<tgt::GLCanvas*, PerContextJobQueue*> _contextQueueMap;
        tbb::concurrent_vector<tgt::GLCanvas*> _contexts;

164
        std::condition_variable _evaluationCondition;   ///< conditional wait to be used when there are currently no jobs to process
165

166
167
168
169
170
171
172
173
        tgt::GLCanvas* _currentContext;         ///< current active OpenGL context
    };

}

#define GLJobProc tgt::Singleton<OpenGLJobProcessor>::getRef()

#endif // OPENGLJOBPROCESSOR_H__