src/rt/RtraceSimulManager.h

/* RCSid $Id: RtraceSimulManager.h,v 2.13 2024/08/14 20:05:23 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"

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