src/rt/RtraceSimulManager.h

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