-
Notifications
You must be signed in to change notification settings - Fork 281
/
vfeplatform.cpp
429 lines (382 loc) · 16.2 KB
/
vfeplatform.cpp
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
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
/*******************************************************************************
* vfeplatform.cpp
*
* This module contains *nix platform-specific support code for the VFE.
*
* Based on vfe/win/vfeplatform.cpp by Christopher J. Cason
*
* ---------------------------------------------------------------------------
* 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/povray/smp/vfe/unix/vfeplatform.cpp $
* $Revision: #18 $
* $Change: 6132 $
* $DateTime: 2013/11/25 14:23:41 $
* $Author: clipka $
*******************************************************************************/
// must come first
#include "syspovconfig.h"
#include <pthread.h>
#include <stdlib.h>
#include <string.h>
#ifdef HAVE_TIME_H
# include <time.h>
#endif
#ifdef HAVE_SYS_TIME_H
# include <sys/time.h>
#endif
#include "vfe.h"
#include "unixoptions.h"
namespace vfePlatform
{
using namespace vfe;
bool gShelloutsPermittedFixThis = false;
/////////////////////////////////////////////////////////////////////////
// return a number that uniquely identifies the calling thread amongst
// all other running threads in the process (and preferably in the OS).
POVMS_Sys_Thread_Type GetThreadId ()
{
return (POVMS_Sys_Thread_Type) pthread_self();
}
//////////////////////////////////////////////////////////////
// User-interface functions
//////////////////////////////////////////////////////////////
vfeUnixSession::vfeUnixSession(int id) :
m_LastTimestamp(0), m_TimestampOffset(0), vfeSession(id)
{
m_OptionsProc = shared_ptr<UnixOptionsProcessor>(new UnixOptionsProcessor(this));
}
/////////////////////////////////////////////////////////////////////////
// this method will get called when a render completes and the image writing
// code is unable to write the requested output file for some reason (e.g.
// disk full, existing output file is read-only, or whatever). the return
// value can determine any one of several possible actions the code will take.
// it's up to you what you do here, but a typical example would be to display
// an error dialog showing the reason (which will be a short string) and the old
// path, and allow the user to browse for a new path (you may want to auto-
// suggest one). it is allowable to perform tests yourself on the path to
// obtain some OS-specific information as to why it failed in order to better
// determine what to suggest as the new path (e.g. the the output path is
// not writable due to insufficient privileges, you may want to default the
// new path to the user's home directory).
//
// any new path that is to be returned should be placed in NewPath. the parameter
// CallCount will initially be 0, and represents the number of times the
// method has been called for a given rendering; this allows you for example
// to auto-default on the first call and prompt the user on subsequent ones.
// (note that if you do this and the auto-default succeeds, it's up to you to
// notify the user that the output file is not what they originally asked for).
//
// you may want to place a timeout on this dialog if the session is running
// an animation and return in the case of a timeout a default value.
//
// the return values can be any of the following:
//
// 0 : don't try again, leave the render without an output file but preserve
// the state file (so a render with +c will reload the image data).
// 1 : reserved for later support
// 2 : don't try again and delete the state file (rendered data can't be
// recovered).
// 3 : try again with the same file (NewPath is ignored).
// 4 : try again with the new path returned in NewPath.
//
// note that if you choose to specify any of the "don't try again" options,
// and the session happens to be an animation, and it's likely the same
// error will occur again (e.g. invalid output path or something), then
// you may want to call the render cancel API so the user isn't bombarded
// with an error message for each frame of the render.
int vfeUnixSession::RequestNewOutputPath(int CallCount, const string& Reason, const UCS2String& OldPath, UCS2String& NewPath)
{
// TODO: print warning and cancel?
return 0;
}
//////////////////////////////////////////////////////////////
// File-system related support functions
//////////////////////////////////////////////////////////////
/////////////////////////////////////////////////////////////////////////
// return an absolute path including trailing path separator.
// *nix platforms might want to just return "/tmp/" here.
UCS2String vfeUnixSession::GetTemporaryPath(void) const
{
return ASCIItoUCS2String (m_OptionsProc->GetTemporaryPath().c_str());
}
/////////////////////////////////////////////////////////////////////////
// might be better called 'CreateTemporaryFileName()' since pov
// doesn't actually want the file opened; just the full path and
// name to one that it can use.
UCS2String vfeUnixSession::CreateTemporaryFile(void) const
{
char str [FILE_NAME_LENGTH] = "";
snprintf(str, FILE_NAME_LENGTH, "%spov%d", m_OptionsProc->GetTemporaryPath().c_str(), getpid ());
DELETE_FILE (str);
return ASCIItoUCS2String (str);
}
/////////////////////////////////////////////////////////////////////////
// you could check that the path given lies within the paths that
// your platform gives out for temporary files if you want; this
// example doesn't do that but it's not a bad idea to add.
void vfeUnixSession::DeleteTemporaryFile(const UCS2String& filename) const
{
DELETE_FILE (UCS2toASCIIString (filename).c_str());
}
//////////////////////////////////////////////////////////////
// vfe or POVMS related support functions
//////////////////////////////////////////////////////////////
/////////////////////////////////////////////////////////////////////////
// This method will get called on POVMS critical errors (e.g. cannot
// allocate memory, amongst other things). Note that you should not
// assume that you can e.g. allocate memory when processing this call.
//
// Before calling this function vfe sets a flag that prevents the worker
// thread from processing any more messages; it will wait for you to
// call Shutdown(). Your UI thread can find out if this method has been
// called by checking for the presence of the stCriticalError status bit
// returned from vfeSession::GetStatus() (note that this bit is not
// necessarily already set at the time the method is called though).
//
// If you are running a genuine virtual frontend (e.g. stateless HTTP
// interface), we may want to set a flag to display the message later
// rather than pop up a messagebox on the local windowstation. Otherwise
// you would probably display the message immediately.
void vfeUnixSession::NotifyCriticalError (const char *message, const char *filename, int line)
{
fprintf (stderr, "POV-Ray Critical Error: %s", message);
}
////////////////////////////////////////////////////////////////////////
// Return a timestamp to be used internally for queue sorting etc. The
// value returned must be 64-bit and in milliseconds; the origin of the
// count is not important (e.g. milliseconds since 1/1/1970, or whatever
// it doesn't matter), as long as it is consistent value (milliseconds
// since system boot is NOT a valid value since it will change each boot).
// Also please don't call time() and multiply by 1000 since vfe wants at
// least 100ms precision (so it can do sub-one-second event timing).
//
// It's also important that the count not go backwards during the life
// of a vfeSession instance; this means you should attempt to detect wall
// clock changes by caching the last value your implementation returns
// and adding an appropriate offset if you calculate a lower value later
// in the session.
POV_LONG vfeUnixSession::GetTimestamp(void) const
{
POV_LONG timestamp = 0; // in milliseconds
#ifdef HAVE_CLOCK_GETTIME
struct timespec ts;
if (clock_gettime(CLOCK_REALTIME, &ts) == 0)
timestamp = (POV_LONG) (1000)*ts.tv_sec + ts.tv_nsec/1000000;
else
#endif
#ifdef HAVE_GETTIMEOFDAY
{
struct timeval tv; // seconds + microseconds since the Epoch (1970-01-01)
if (gettimeofday(&tv, NULL) == 0)
timestamp = (POV_LONG) (1000)*tv.tv_sec + tv.tv_usec/1000;
}
#endif
// FIXME: add fallback using boost::xtime()
timestamp += m_TimestampOffset;
if (timestamp < m_LastTimestamp)
{
// perhaps the system clock has been adjusted?
m_TimestampOffset += m_LastTimestamp - timestamp;
timestamp = m_LastTimestamp;
}
else
m_LastTimestamp = timestamp;
return timestamp;
}
/////////////////////////////////////////////////////////////////////////
// called when the worker thread starts - you could if you like set the
// thread priority here.
void vfeUnixSession::WorkerThreadStartup()
{
}
/////////////////////////////////////////////////////////////////////////
// called just before the worker thread exits.
void vfeUnixSession::WorkerThreadShutdown()
{
}
/////////////////////////////////////////////////////////////////////////
// The following methods support the I/O permissions feature
/////////////////////////////////////////////////////////////////////////
/////////////////////////////////////////////////////////////////////////
// case-sensitive string comparison
bool vfeUnixSession::StrCompare (const UCS2String& lhs, const UCS2String& rhs) const
{
return lhs.compare(rhs);
}
/////////////////////////////////////////////////////////////////////////
// return true if the path component of file is equal to the path component
// of path. will also return true if recursive is true and path is a parent
// of file. does not support relative paths, and will perform case-sensitive
// comparisons.
bool vfeUnixSession::TestPath (const Path& path, const Path& file, bool recursive) const
{
// we don't support relative paths
if (path.HasVolume() == false || file.HasVolume() == false)
return (false);
if (StrCompare(path.GetVolume(), file.GetVolume()) == false)
return (false);
vector<UCS2String> pc = path.GetAllFolders();
vector<UCS2String> fc = file.GetAllFolders();
if (fc.size() < pc.size())
return (false) ;
for (int i = 0 ; i < pc.size(); i++)
if (StrCompare(fc[i], pc[i]) == false)
return (false) ;
return (fc.size() == pc.size() ? true : recursive);
}
/////////////////////////////////////////////////////////////////////////
// returns true if opening the given file in the specified mode is to
// be permitted. it is allowed to ask the user, so this method could
// take some time to return (especially if user is not at workstation ...)
//
// TODO: modify this to work fully with UCS2 strings (no conversion)
bool vfeUnixSession::TestAccessAllowed (const Path& file, bool isWrite) const
{
if (!m_OptionsProc->isIORestrictionsEnabled(isWrite))
return true;
string FullFnm = m_OptionsProc->CanonicalizePath(UCS2toASCIIString(file()));
if(FullFnm.length() == 0)
return false;
Path fullPath(FullFnm);
if (isWrite)
{
// we do special-case hard-coded exclusion test(s) here
for (IOPathVector::const_iterator it = GetExcludedPaths().begin(); it != GetExcludedPaths().end(); it++)
{
if (TestPath(it->GetPath(), fullPath, it->IsRecursive()))
{
m_OptionsProc->IORestrictionsError(UCS2toASCIIString(file()), isWrite, false);
return (false) ;
}
}
}
else
{
// it's a read
for (IOPathVector::const_iterator it = GetReadPaths().begin(); it != GetReadPaths().end(); it++)
if (TestPath(it->GetPath(), fullPath, it->IsRecursive()))
return (true) ;
// access for write implies access for read (this is by design).
// so we check the write specs below instead of giving an error here.
}
for (IOPathVector::const_iterator it = GetWritePaths().begin(); it != GetWritePaths().end(); it++)
if (TestPath(it->GetPath(), fullPath, it->IsRecursive()))
return (true) ;
m_OptionsProc->IORestrictionsError(UCS2toASCIIString(file()), isWrite, true);
return (false);
}
/////////////////////////////////////////////////////////////////////////////
// Shellout support class (UnixShelloutProcessing)
/////////////////////////////////////////////////////////////////////////////
// See the comments in source/frontend/shelloutprocessing.h for documentation
// on the requirements for these methods.
/////////////////////////////////////////////////////////////////////////////
UnixShelloutProcessing::UnixShelloutProcessing(POVMS_Object& opts, const string& scene, unsigned int width, unsigned int height): ShelloutProcessing(opts, scene, width, height)
{
m_ProcessRunning = false;
m_ProcessId = m_LastError = m_ExitCode = 0;
}
UnixShelloutProcessing::~UnixShelloutProcessing()
{
if (UnixShelloutProcessing::CommandRunning())
KillShellouts(1, true);
CollectCommand();
}
bool UnixShelloutProcessing::ExecuteCommand(const string& cmd, const string& params)
{
#if 0
if (UnixShelloutProcessing::CommandRunning())
throw POV_EXCEPTION(kNotNowErr, "Cannot create new process as previous shellout has not terminated");
CollectCommand();
m_Command = cmd;
m_Params = params;
m_ProcessId = m_LastError = m_ExitCode = 0;
// TODO: IMPLEMENT (see vfe/win/vfeplatform.cpp for example)
#else
// until we get a UNIX guy to assist, we just use system to do as simple an implementation as possible.
// no background support or output piping is done.
m_Command = cmd;
m_Params = params;
m_ProcessId = m_LastError = m_ExitCode = 0;
string command = cmd + " " + params;
boost::trim(command);
if (command.empty())
throw POV_EXCEPTION(kParamErr, "Empty shellout command");
if (*command.rbegin() == '&') // background processing not supported
throw POV_EXCEPTION(kParamErr, "Background execution of shellout commands not currently supported");
m_ProcessRunning = true;
int result = system(command.c_str());
m_ProcessRunning = false;
if (result == -1)
{
m_LastError = errno;
m_ExitCode = -1;
}
else
{
m_ExitCode = WEXITSTATUS(result);
}
#endif
return false;
}
bool UnixShelloutProcessing::CommandRunning(void)
{
// TODO: IMPLEMENT (see vfe/win/vfeplatform.cpp for example)
return m_ProcessRunning;
}
int UnixShelloutProcessing::ProcessID(void)
{
if (!UnixShelloutProcessing::CommandRunning())
return 0;
return m_ProcessId;
}
bool UnixShelloutProcessing::KillCommand(int timeout, bool force)
{
if (!UnixShelloutProcessing::CommandRunning())
return true;
// TODO: IMPLEMENT (see vfe/win/vfeplatform.cpp for example)
throw POV_EXCEPTION(kCannotHandleRequestErr, "Kill for shellout commands not currently supported");
}
int UnixShelloutProcessing::CollectCommand(void)
{
if (m_ProcessRunning == false)
return -2;
if (UnixShelloutProcessing::CommandRunning())
return -1;
// TODO: IMPLEMENT (see vfe/win/vfeplatform.cpp for example)
return m_ExitCode;
}
int UnixShelloutProcessing::CollectCommand(string& output)
{
// TODO: IMPLEMENT IF OUTPUT COLLECTION TO BE SUPPORTED
return CollectCommand();
}
bool UnixShelloutProcessing::CommandPermitted(const string& command, const string& parameters)
{
// until we get a unix support guy, this is just a hack: use a global
string cmd = command + " " + parameters;
boost::trim(cmd);
if (command.empty() || *command.rbegin() == '&')
return false;
return gShelloutsPermittedFixThis;
}
}