opengljobprocessor.h 5.53 KB
Newer Older
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
// ================================================================================================
// 
// This file is part of the TUMVis Visualization Framework.
// 
// 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
49
50
namespace tgt {
    class GLCanvas;
}

namespace TUMVis {
    /**
schultezub's avatar
schultezub committed
51
     * \todo    Explain scheduling technique.
52
53
54
55
56
     */
    class OpenGLJobProcessor : public tgt::Singleton<OpenGLJobProcessor>, public Runnable, public sigslot::has_slots<> {
        friend class tgt::Singleton<OpenGLJobProcessor>;

    public:
57
58
59
60
        /**
         * Enumeration of the different priorities of items.
         */
        enum JobType {
schultezub's avatar
schultezub committed
61
            PaintJob,           ///< PaintJobs have the highest priority, there can only be one paint job per context at a time.
62
63
            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.
64
65
66
67
68
        };

        virtual ~OpenGLJobProcessor();


schultezub's avatar
schultezub committed
69
70
71
72
        /**
         * Registers the given OpenGL context, so that it gets its own job queue.
         * \param   context     OpenGL context to register.
         */
73
74
        void registerContext(tgt::GLCanvas* context);

75
76
77
78
        /// \see Runnable::stop
        void stop();
        
        /**
schultezub's avatar
schultezub committed
79
         * Performs the job processing using conditional wait.
80
81
82
83
84
85
86
87
         * \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
88
         * \param   canvas      OpenGL context for which to enqueue the job, must be registered.
89
90
91
         * \param   job         Job to enqueue, PriorityPool takes ownership of this Job!
         * \param   priority    Priority of the job to enqueue
         */
92
        void enqueueJob(tgt::GLCanvas* canvas, AbstractJob* job, JobType priority);
93
94
95


    protected:
schultezub's avatar
schultezub committed
96
97
98
        /**
         * Struct encapsulating the job queue for a single OpenGL context.
         */
99
        struct PerContextJobQueue {
schultezub's avatar
schultezub committed
100
101
102
            /**
             * Creates an empty PerContextJobQueue.
             */
103
104
105
106
107
            PerContextJobQueue() 
                : _paintJob(0)
            {
            }

schultezub's avatar
schultezub committed
108
109
110
            AbstractJob* _paintJob;                                 ///< PaintJob of the context
            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
111

schultezub's avatar
schultezub committed
112
113
114
115
            /**
             * Checks, whether there is any job to do for this context.
             * \return (_serialJobs.empty() && _lowPriorityJobs.empty() && (_paintJob == 0))
             */
116
117
118
119
120
            bool empty() const {
                return (_serialJobs.empty() && _lowPriorityJobs.empty() && (_paintJob == 0));
            }
        };

121
122
        OpenGLJobProcessor();

123
124
125
        tbb::concurrent_hash_map<tgt::GLCanvas*, PerContextJobQueue*> _contextQueueMap;
        tbb::concurrent_vector<tgt::GLCanvas*> _contexts;

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

128
        tgt::GLCanvas* _currentContext;         ///< current active OpenGL context
129
        clock_t _startTimeCurrentContext;       ///<
130
131
132
133
134
135
136
    };

}

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

#endif // OPENGLJOBPROCESSOR_H__