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
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
|
/*******************************************************************************
* task.h
*
* ---------------------------------------------------------------------------
* Persistence of Vision Ray Tracer ('POV-Ray') version 3.7.
* Copyright 1991-2013 Persistence of Vision Raytracer Pty. Ltd.
*
* POV-Ray is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* POV-Ray is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
* ---------------------------------------------------------------------------
* POV-Ray is based on the popular DKB raytracer version 2.12.
* DKBTrace was originally written by David K. Buck.
* DKBTrace Ver 2.0-2.12 were written by David K. Buck & Aaron A. Collins.
* ---------------------------------------------------------------------------
* $File: //depot/public/povray/3.x/source/backend/support/task.h $
* $Revision: #1 $
* $Change: 6069 $
* $DateTime: 2013/11/06 11:59:40 $
* $Author: chrisc $
*******************************************************************************/
#ifndef POVRAY_BACKEND_TASK_H
#define POVRAY_BACKEND_TASK_H
#include <vector>
#include <queue>
#include <boost/thread.hpp>
#include <boost/function.hpp>
#include "backend/frame.h"
#include "base/timer.h"
#include "base/pov_err.h"
namespace pov
{
using namespace pov_base;
class Task;
class Task
{
struct StopThreadException { };
public:
class TaskData
{
friend class Task;
public:
TaskData() { }
virtual ~TaskData() { }
private:
Task *task;
};
Task(TaskData *td, const boost::function1<void, Exception&>& f);
virtual ~Task();
inline bool IsPaused() { return !done && paused; }
inline bool IsRunning() { return !done && !paused && !stopRequested && (taskThread != NULL); }
inline bool IsDone() { return done; }
inline bool Failed() { return done && (failed != kNoError); }
int FailureCode(int defval = kNoError);
POV_LONG ConsumedRealTime() const;
POV_LONG ConsumedCPUTime() const;
void Start(const boost::function0<void>& completion);
void RequestStop();
void Stop();
void Pause();
void Resume();
inline void Cooperate()
{
if(stopRequested == true)
throw StopThreadException();
else if(paused == true)
{
while(paused == true)
{
boost::thread::yield();
Delay(100);
if(stopRequested == true)
throw StopThreadException();
}
}
}
inline static void CurrentTaskCooperate()
{
TaskData *td = Task::GetTLSDataPtr();
if((td != NULL) && (td->task != NULL))
td->task->Cooperate();
}
inline static TaskData *GetTLSDataPtr() { return GET_THREAD_LOCAL_PTR(taskDataPtr); }
inline TaskData *GetDataPtr() { return taskData; }
inline POVMSContext GetPOVMSContext() { return povmsContext; }
/// Start a new thread with a given stack size.
template<typename CALLABLE_T>
inline static boost::thread* NewBoostThread(CALLABLE_T func, int stackSize)
{
#if HAVE_BOOST_THREAD_ATTRIBUTES
// boost 1.50 and later provide an official mechanism to set the stack size.
boost::thread::attributes attr;
attr.set_stack_size (stackSize);
return new boost::thread(attr, func);
#elif !defined(USE_OFFICIAL_BOOST)
// Prior to boost 1.50, for some platforms we used an unofficial hacked version of boost to set the stack size.
return new boost::thread(func, stackSize);
#else
// For some platforms the default stack size of older boost versions may suffice.
return new boost::thread(func);
#endif
}
protected:
virtual void Run() = 0;
virtual void Stopped() = 0;
virtual void Finish() = 0;
POV_LONG ElapsedRealTime() const;
POV_LONG ElapsedCPUTime() const;
private:
/// task data pointer
TaskData *taskData;
/// task data pointer - TLS version
static DECLARE_THREAD_LOCAL_PTR(TaskData, taskDataPtr);
/// task fatal error handler
boost::function1<void, Exception&> fatalErrorHandler;
/// stop request flag
volatile bool stopRequested;
/// paused flag
volatile bool paused;
/// done flag
volatile bool done;
/// failed code
volatile int failed;
// pointer to timer or NULL
Timer *timer;
// real time spend in task
POV_LONG realTime;
// CPU time spend in task
POV_LONG cpuTime;
/// task thread
boost::thread *taskThread;
/// POVMS message receiving context
POVMSContext povmsContext;
inline void FatalErrorHandler(const Exception& e)
{
Exception pe(e);
fatalErrorHandler(pe);
}
inline void FatalErrorHandler(Exception& e) { fatalErrorHandler(e); }
/// not available
Task();
/// not available
Task(const Task&);
/// not available
Task& operator=(const Task&);
void TaskThread(const boost::function0<void>& completion);
static void TaskDataCleanup(Task::TaskData *) { }
};
}
#endif // POVRAY_BACKEND_TASK_H
|
