Address stack size issues in Mac OS builds.

Author: c-lipka

changes.txt

@@ -29,6 +29,22 @@ should be located in the same directory as this file is.
 ------------------------------------------------------------------------------
 
 
+Changes between 3.7.0.7 and 3.7.0.8
+===================================
+
+(Note: This version has not been released in binary form, as it does not
+feature any changes in functionality over the original 3.7.0 binaries.)
+
+This version constitutes a maintenance update of the POV-Ray 3.7.0 source
+code, focused on improving compatibility with Mac OS builds.
+
+Fixed or Mitigated Bugs
+-----------------------
+
+  - Modify thread creation code to more easily address thread stack size issues
+    in Mac OS builds (requires Boost 1.50 or later to be effective).
+
+
 Changes between 3.7.0.6 and 3.7.0.7
 ===================================
 

source/backend/configbackend.h

@@ -278,6 +278,22 @@
 	#define POV_ALLOW_FILE_WRITE(f,t) (1)
 #endif
 
+/// @def POV_THREAD_STACK_SIZE
+/// Default thread stack size.
+///
+#ifndef POV_THREAD_STACK_SIZE
+	#define POV_THREAD_STACK_SIZE (2 * 1024 * 1024)
+#endif
+
+/// @def HAVE_BOOST_THREAD_ATTRIBUTES
+/// Whether boost::thread::attributes is available (and can be used to set a thread's stack size).
+///
+#if BOOST_VERSION >= 105000
+	#define HAVE_BOOST_THREAD_ATTRIBUTES 1
+#else
+	#define HAVE_BOOST_THREAD_ATTRIBUTES 0
+#endif
+
 #include "syspovprotobackend.h"
 
 #endif

source/backend/povray.cpp

@@ -47,6 +47,7 @@
 #include "backend/povray.h"
 #include "backend/control/renderbackend.h"
 #include "backend/support/msgutil.h"
+#include "backend/support/task.h"
 #include "backend/texture/texture.h"
 
 #ifndef DONT_SHOW_IMAGE_LIB_VERSIONS
@@ -593,11 +594,7 @@ boost::thread *povray_init(const boost::function0<void>& threadExit, POVMSAddres
 		Initialize_Noise();
 		pov::InitializePatternGenerators();
 
-#ifndef USE_OFFICIAL_BOOST
-		POV_MainThread = new boost::thread(boost::bind(&MainThreadFunction, threadExit), 1024 * 64);
-#else
-		POV_MainThread = new boost::thread(boost::bind(&MainThreadFunction, threadExit));
-#endif
+		POV_MainThread = Task::NewBoostThread(boost::bind(&MainThreadFunction, threadExit), POV_THREAD_STACK_SIZE);
 
 		// we can't depend on boost::thread::yield here since under windows it is not
 		// guaranteed to give up a time slice [see API docs for Sleep(0)]

source/backend/scene/scene.cpp

@@ -45,6 +45,7 @@
 #include "backend/control/renderbackend.h"
 #include "backend/scene/scene.h"
 #include "backend/scene/objects.h"
+#include "backend/support/task.h"
 #include "backend/parser/parse.h"
 #include "backend/bounding/boundingtask.h"
 #include "backend/texture/texture.h"
@@ -438,11 +439,7 @@ void Scene::StartParser(POVMS_Object& parseOptions)
 {
 	// A scene can only be parsed once
 	if(parserControlThread == NULL)
-#ifndef USE_OFFICIAL_BOOST
-		parserControlThread = new boost::thread(boost::bind(&Scene::ParserControlThread, this), 1024 * 64);
-#else
-		parserControlThread = new boost::thread(boost::bind(&Scene::ParserControlThread, this));
-#endif
+		parserControlThread = Task::NewBoostThread(boost::bind(&Scene::ParserControlThread, this), POV_THREAD_STACK_SIZE);
 	else
 		return;
 

source/backend/scene/view.cpp

@@ -48,6 +48,7 @@
 #include "backend/scene/view.h"
 #include "backend/render/tracetask.h"
 #include "backend/render/radiositytask.h"
+#include "backend/support/task.h"
 #include "backend/lighting/photons.h"
 #include "backend/lighting/radiosity.h"
 
@@ -681,11 +682,7 @@ void View::StartRender(POVMS_Object& renderOptions)
 	shared_ptr<std::set<unsigned int> > blockskiplist(new std::set<unsigned int>());
 
 	if(renderControlThread == NULL)
-#ifndef USE_OFFICIAL_BOOST
-		renderControlThread = new thread(boost::bind(&View::RenderControlThread, this), 1024 * 64);
-#else
-		renderControlThread = new boost::thread(boost::bind(&View::RenderControlThread, this));
-#endif
+		renderControlThread = Task::NewBoostThread(boost::bind(&View::RenderControlThread, this), POV_THREAD_STACK_SIZE);
 
 	viewData.qualitySettings.Quality = clip(renderOptions.TryGetInt(kPOVAttrib_Quality, 9), 0, 9);
 	viewData.qualitySettings.Quality_Flags = QualityValues[viewData.qualitySettings.Quality];

source/backend/support/task.cpp

@@ -102,11 +102,7 @@ POV_LONG Task::ConsumedCPUTime() const
 void Task::Start(const boost::function0<void>& completion)
 {
 	if((done == false) && (taskThread == NULL))
-#ifndef USE_OFFICIAL_BOOST
-		taskThread = new boost::thread(boost::bind(&Task::TaskThread, this, completion), 1024 * 1024 * 2); // TODO - make stack size definable
-#else
-		taskThread = new boost::thread(boost::bind(&Task::TaskThread, this, completion));
-#endif
+		taskThread = NewBoostThread(boost::bind(&Task::TaskThread, this, completion), POV_THREAD_STACK_SIZE);
 }
 
 void Task::RequestStop()

source/backend/support/task.h

@@ -112,6 +112,25 @@ class Task
 		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;

vfe/unix/syspovconfigbackend.h

@@ -39,4 +39,6 @@
 #define NEW_LINE_STRING "\n"  // default
 #define SYS_DEF_EXT     ""
 
+#define POV_THREAD_STACK_SIZE (4 * 1024 * 1024) // twice the usual default
+
 #endif