src/rt/RtraceSimulManager.h

/* RCSid $Id: RtraceSimulManager.h,v 2.16 2024/10/23 23:40:41 greg Exp $ */
/*
 *  RtraceSimulManager.h
 *
 *      Rtrace simulation manager class declaration (along with base class)
 *      Enqueuing rays will block caller iff #rays >= ThreadsAvail()
 *      Reporting call-backs made from EnqueBundle() and FlushQueue()
 *
 *  Created by Greg Ward on 11/10/22.
 */

#ifndef RtraceSimulManager_h
#define RtraceSimulManager_h

#include "ray.h"
#include "abitmap.h"

extern char *   octname;        // global octree name

extern int      castonly;       // doing ray-casting only?

/// Ray reporting callback method -- returns # successfully reported, -1 to abort
typedef int     RayReportCall(RAY *r, void *cd);

/// Multi-threaded simulation manager base class
class RadSimulManager {
        char *                  header;                 // header (less intro and format)
        int                     hlen;                   // header string length
protected:
        bool                    SplitRay(RAY *r) {
                                        return (ray_pnprocs && ray_psend(r) > 0);
                                }
public:
                                RadSimulManager(const char *octn = NULL) {
                                        header = NULL; hlen = 0;
                                        LoadOctree(octn);
                                }
                                ~RadSimulManager() {
                                        Cleanup();
                                }
                                /// Load octree and prepare renderer
        bool                    LoadOctree(const char *octn);
                                /// Prepare header from previous input (or clear)
                                /// Normally called during octree load
        bool                    NewHeader(const char *inspec = NULL);
                                /// Add a line to header (adds newline if none)
        bool                    AddHeader(const char *str);
                                /// Append program line to header
        bool                    AddHeader(int ac, char *av[]);
                                /// Get current header length in bytes
        int                     GetHeadLen() const {
                                        return hlen;
                                }
                                /// Get header lines or empty string
        const char *            GetHeadStr() const {
                                        return hlen ? header : "";
                                }
                                /// Look for specific header keyword, return value
        const char *            GetHeadStr(const char *key, bool inOK = false) const;
                                /// How many cores are available?
        static int              GetNCores();
                                /// Set number of computation threads (0 => #cores)
        int                     SetThreadCount(int nt = 0);
                                /// Check thread count (1 means no multi-threading)
        int                     NThreads() const {
                                        return ray_pnprocs + !ray_pnprocs;
                                }
                                /// How many threads are currently unoccupied?
        int                     ThreadsAvailable() const {
                                        return ray_pnprocs ? ray_pnidle : 1;
                                }
                                /// Are we ready?
        bool                    Ready() const {
                                        return (octname && nobjects > 0);
                                }
                                /// Process a ray (in subthread), optional result
        int                     ProcessRay(RAY *r);
                                /// Wait for next result (or fail)
        bool                    WaitResult(RAY *r);
                                /// Close octree, free data, return status
        int                     Cleanup(bool everything = false);
};

/// Flags to control rendering operations
enum {RTdoFIFO=1, RTtraceSources=2, RTlimDist=4, RTimmIrrad=8, RTmask=15};

/// rtrace-like simulation manager (at most one such object)
class RtraceSimulManager : public RadSimulManager {
        RayReportCall *         cookedCall;     // callback for cooked primary rays
        void *                  ccData;         // client data for cooked primary rays
        RayReportCall *         traceCall;      // call for every ray in tree
        void *                  tcData;         // client data for traced rays
        int                     curFlags;       // current operating flags
        ABitMap                 srcFollowed;    // source flags changed
                                // Call-back for global ray-tracing context
        static void             RTracer(RAY *r);
                                // Call-back for FIFO
        static int              Rfifout(RAY *r);
                                // Check for changes to render flags, etc.
        bool                    UpdateMode();
protected:
        RNUMBER                 lastRayID;      // last ray ID assigned
public:
        int                     rtFlags;        // operation (RT*) flags
                                RtraceSimulManager(RayReportCall *cb = NULL, void *cd = NULL,
                                                const char *octn = NULL) : RadSimulManager(octn) {
                                        lastRayID = 0;
                                        rtFlags = curFlags = 0;
                                        SetCookedCall(cb, cd);
                                        traceCall = NULL; tcData = NULL;
                                }
                                ~RtraceSimulManager() {
                                        FlushQueue();
                                }
                                /// Set number of computation threads (0 => #cores)
        int                     SetThreadCount(int nt = 0) {
                                        if (nt <= 0) nt = castonly ? 1 : GetNCores();
                                        if (nt == NThreads()) return nt;
                                        if (nt < NThreads() && FlushQueue() < 0) return 0;
                                        return RadSimulManager::SetThreadCount(nt);
                                }
                                /// Add ray bundle to queue w/ optional 1st ray ID
        int                     EnqueueBundle(const FVECT orig_direc[], int n,
                                                RNUMBER rID0 = 0);
                                /// Enqueue a single ray w/ optional ray ID
        int                     EnqueueRay(const FVECT org, const FVECT dir,
                                                RNUMBER rID = 0) {
                                        if (dir == org+1)
                                                return(EnqueueBundle((const FVECT *)org, 1, rID) > 0);
                                        FVECT   orgdir[2];
                                        VCOPY(orgdir[0], org); VCOPY(orgdir[1], dir);
                                        return EnqueueBundle(orgdir, 1, rID);
                                }
                                /// Set/change cooked ray callback
        void                    SetCookedCall(RayReportCall *cb, void *cd = NULL) {
                                        if (cookedCall && (cookedCall != cb) | (ccData != cd))
                                                FlushQueue();
                                        cookedCall = cb;
                                        ccData = cb ? cd : NULL;
                                }
                                /// Set/change trace callback (before threading)
        void                    SetTraceCall(RayReportCall *cb, void *cd = NULL) {
                                        traceCall = cb;
                                        tcData = cb ? cd : NULL;
                                }
                                /// Are we ready?
        bool                    Ready() const {
                                        return (cookedCall != NULL) | (traceCall != NULL) &&
                                                RadSimulManager::Ready();
                                }
                                /// Finish pending rays and complete callbacks (return #sent)
        int                     FlushQueue();
                                /// Close octree, free data, return status
        int                     Cleanup(bool everything = false) {
                                        SetCookedCall(NULL);
                                        SetTraceCall(NULL);
                                        rtFlags = 0;
                                        UpdateMode();
                                        lastRayID = 0;
                                        return RadSimulManager::Cleanup(everything);
                                }
};

/// Determine if vector is all zeroes
inline bool
IsZeroVec(const FVECT vec)
{
        return (vec[0] == 0.0) & (vec[1] == 0.0) & (vec[2] == 0.0);
}

#endif /* RtraceSimulManager_h */
Revision:	2.17
Committed:	Wed Nov 13 02:43:51 2024 UTC (5 months, 2 weeks ago) by greg
Content type:	text/plain
Branch:	MAIN
Changes since 2.16:	+10 -7 lines
Log Message:	feat: Improved error-handling in base simulation manager classes
#	User	Rev	Content
1	greg	2.17	/* RCSid $Id: RtraceSimulManager.h,v 2.16 2024/10/23 23:40:41 greg Exp $ */
2	greg	2.1	/*
3			* RtraceSimulManager.h
4			*
5			* Rtrace simulation manager class declaration (along with base class)
6			* Enqueuing rays will block caller iff #rays >= ThreadsAvail()
7			* Reporting call-backs made from EnqueBundle() and FlushQueue()
8			*
9			* Created by Greg Ward on 11/10/22.
10			*/
11
12			#ifndef RtraceSimulManager_h
13			#define RtraceSimulManager_h
14
15			#include "ray.h"
16	greg	2.15	#include "abitmap.h"
17	greg	2.1
18			extern char * octname; // global octree name
19
20	greg	2.6	extern int castonly; // doing ray-casting only?
21
22			/// Ray reporting callback method -- returns # successfully reported, -1 to abort
23			typedef int RayReportCall(RAY r, void cd);
24	greg	2.1
25			/// Multi-threaded simulation manager base class
26			class RadSimulManager {
27	greg	2.9	char * header; // header (less intro and format)
28	greg	2.10	int hlen; // header string length
29	greg	2.4	protected:
30	greg	2.17	bool SplitRay(RAY *r) {
31			return (ray_pnprocs && ray_psend(r) > 0);
32			}
33	greg	2.1	public:
34			RadSimulManager(const char *octn = NULL) {
35	greg	2.10	header = NULL; hlen = 0;
36	greg	2.1	LoadOctree(octn);
37			}
38			~RadSimulManager() {
39			Cleanup();
40			}
41			/// Load octree and prepare renderer
42			bool LoadOctree(const char *octn);
43	greg	2.9	/// Prepare header from previous input (or clear)
44			/// Normally called during octree load
45	greg	2.15	bool NewHeader(const char *inspec = NULL);
46	greg	2.10	/// Add a line to header (adds newline if none)
47	greg	2.9	bool AddHeader(const char *str);
48			/// Append program line to header
49	greg	2.13	bool AddHeader(int ac, char *av[]);
50	greg	2.16	/// Get current header length in bytes
51			int GetHeadLen() const {
52			return hlen;
53			}
54	greg	2.11	/// Get header lines or empty string
55	greg	2.14	const char * GetHeadStr() const {
56	greg	2.11	return hlen ? header : "";
57	greg	2.9	}
58	greg	2.14	/// Look for specific header keyword, return value
59			const char * GetHeadStr(const char *key, bool inOK = false) const;
60	greg	2.5	/// How many cores are available?
61	greg	2.3	static int GetNCores();
62	greg	2.1	/// Set number of computation threads (0 => #cores)
63			int SetThreadCount(int nt = 0);
64			/// Check thread count (1 means no multi-threading)
65			int NThreads() const {
66	greg	2.6	return ray_pnprocs + !ray_pnprocs;
67	greg	2.1	}
68			/// How many threads are currently unoccupied?
69	greg	2.17	int ThreadsAvailable() const {
70			return ray_pnprocs ? ray_pnidle : 1;
71			}
72	greg	2.1	/// Are we ready?
73			bool Ready() const {
74	greg	2.6	return (octname && nobjects > 0);
75	greg	2.1	}
76	greg	2.4	/// Process a ray (in subthread), optional result
77	greg	2.17	int ProcessRay(RAY *r);
78	greg	2.4	/// Wait for next result (or fail)
79			bool WaitResult(RAY *r);
80	greg	2.1	/// Close octree, free data, return status
81	greg	2.3	int Cleanup(bool everything = false);
82	greg	2.1	};
83
84			/// Flags to control rendering operations
85			enum {RTdoFIFO=1, RTtraceSources=2, RTlimDist=4, RTimmIrrad=8, RTmask=15};
86
87			/// rtrace-like simulation manager (at most one such object)
88			class RtraceSimulManager : public RadSimulManager {
89			RayReportCall * cookedCall; // callback for cooked primary rays
90			void * ccData; // client data for cooked primary rays
91			RayReportCall * traceCall; // call for every ray in tree
92			void * tcData; // client data for traced rays
93			int curFlags; // current operating flags
94	greg	2.15	ABitMap srcFollowed; // source flags changed
95	greg	2.1	// Call-back for global ray-tracing context
96			static void RTracer(RAY *r);
97	greg	2.6	// Call-back for FIFO
98			static int Rfifout(RAY *r);
99	greg	2.1	// Check for changes to render flags, etc.
100			bool UpdateMode();
101			protected:
102			RNUMBER lastRayID; // last ray ID assigned
103			public:
104			int rtFlags; // operation (RT*) flags
105			RtraceSimulManager(RayReportCall cb = NULL, void cd = NULL,
106			const char *octn = NULL) : RadSimulManager(octn) {
107			lastRayID = 0;
108			rtFlags = curFlags = 0;
109			SetCookedCall(cb, cd);
110			traceCall = NULL; tcData = NULL;
111			}
112	greg	2.3	~RtraceSimulManager() {
113			FlushQueue();
114			}
115	greg	2.2	/// Set number of computation threads (0 => #cores)
116			int SetThreadCount(int nt = 0) {
117	greg	2.6	if (nt <= 0) nt = castonly ? 1 : GetNCores();
118	greg	2.2	if (nt == NThreads()) return nt;
119	greg	2.12	if (nt < NThreads() && FlushQueue() < 0) return 0;
120	greg	2.2	return RadSimulManager::SetThreadCount(nt);
121			}
122	greg	2.1	/// Add ray bundle to queue w/ optional 1st ray ID
123			int EnqueueBundle(const FVECT orig_direc[], int n,
124			RNUMBER rID0 = 0);
125			/// Enqueue a single ray w/ optional ray ID
126	greg	2.17	int EnqueueRay(const FVECT org, const FVECT dir,
127	greg	2.1	RNUMBER rID = 0) {
128			if (dir == org+1)
129	greg	2.3	return(EnqueueBundle((const FVECT *)org, 1, rID) > 0);
130	greg	2.1	FVECT orgdir[2];
131			VCOPY(orgdir[0], org); VCOPY(orgdir[1], dir);
132	greg	2.17	return EnqueueBundle(orgdir, 1, rID);
133	greg	2.1	}
134	greg	2.6	/// Set/change cooked ray callback
135	greg	2.1	void SetCookedCall(RayReportCall cb, void cd = NULL) {
136			if (cookedCall && (cookedCall != cb) \| (ccData != cd))
137			FlushQueue();
138			cookedCall = cb;
139	greg	2.6	ccData = cb ? cd : NULL;
140	greg	2.1	}
141	greg	2.15	/// Set/change trace callback (before threading)
142	greg	2.1	void SetTraceCall(RayReportCall cb, void cd = NULL) {
143			traceCall = cb;
144	greg	2.6	tcData = cb ? cd : NULL;
145	greg	2.1	}
146			/// Are we ready?
147			bool Ready() const {
148			return (cookedCall != NULL) \| (traceCall != NULL) &&
149			RadSimulManager::Ready();
150			}
151	greg	2.4	/// Finish pending rays and complete callbacks (return #sent)
152			int FlushQueue();
153	greg	2.1	/// Close octree, free data, return status
154	greg	2.3	int Cleanup(bool everything = false) {
155	greg	2.1	SetCookedCall(NULL);
156			SetTraceCall(NULL);
157			rtFlags = 0;
158			UpdateMode();
159			lastRayID = 0;
160	greg	2.3	return RadSimulManager::Cleanup(everything);
161	greg	2.1	}
162			};
163
164			/// Determine if vector is all zeroes
165			inline bool
166			IsZeroVec(const FVECT vec)
167			{
168			return (vec[0] == 0.0) & (vec[1] == 0.0) & (vec[2] == 0.0);
169			}
170
171			#endif /* RtraceSimulManager_h */