src/rt/RtraceSimulManager.cpp

#ifndef lint
static const char RCSid[] = "$Id: RtraceSimulManager.cpp,v 2.13 2024/08/03 15:38:06 greg Exp $";
#endif
/*
 *  RtraceSimulManager.cpp
 *
 *      Rtrace simulation manager class implementation
 *
 *  Created by Greg Ward on 2/2/2023.
 */

#include <unistd.h>
#include <ctype.h>
#include "RtraceSimulManager.h"
#include "source.h"

// Load octree and prepare renderer
bool
RadSimulManager::LoadOctree(const char *octn)
{
        if (octname) {          // already running?
                if (octn && !strcmp(octn, octname))
                        return true;
                Cleanup();
        }
        if (!octn)              // don't support stdin octree
                return false;

        NewHeader(octn);        // get octree header
        ray_init((char *)octn);
        return true;
}

// callback function for loading header
static int
add2header(char *str, void *p)
{
        if (isheadid(str))
                return 0;
        if (isformat(str))
                return 0;

        return (*(RadSimulManager *)p).AddHeader(str);
}

// Prepare header from previous input (or clear)
// Normally called during octree load
bool
RadSimulManager::NewHeader(const char *inspec)
{
        if (hlen) {
                free(header); header = NULL; hlen = 0;
        }
        if (!inspec || !*inspec)
                return false;
        if (inspec[0] == '!')           // save command as header?
                return AddHeader(inspec+1);
                                        // attempt to read from file
        FILE    *fp = fopen(inspec, "rb");
        if (!fp) return false;
        bool    ok = (getheader(fp, add2header, this) >= 0);
        fclose(fp);
        return ok;
}

// Add a string to header (adds newline if missing)
bool
RadSimulManager::AddHeader(const char *str)
{
        if (!str) return false;
        int     len = strlen(str);
        while (len && (str[len-1] == '\n') | (str[len-1] == '\r'))
                --len;                  // don't copy EOL(s)
        if (!len)
                return false;
        if (hlen)
                header = (char *)realloc(header, hlen+len+2);
        else
                header = (char *)malloc(len+2);
        if (!header) {
                hlen = 0;               // XXX should report?
                return false;
        }
        memcpy(header+hlen, str, len);
        hlen += len;
        header[hlen++] = '\n';          // add single EOL
        header[hlen] = '\0';
        return true;
}

// helper function to check for white-space and quotations
static int
check_special(const char *s)
{
        int     space_found = 0;

        while (*s) {
                if ((*s == '"') | (*s == '\''))
                        return *s;      // quotes have priority
                if (isspace(*s))
                        space_found = *s;
                s++;
        }
        return space_found;
}

// Append program line to header
bool
RadSimulManager::AddHeader(int ac, const char *av[])
{
        if ((ac <= 0) | !av) return false;
        int     len = 0;
        int     n;
        for (n = 0; n < ac; n++) {
                if (!av[n]) return false;
                len += strlen(av[n]) + 3;
        }
        if (hlen)                       // add to header
                header = (char *)realloc(header, hlen+len+1);
        else
                header = (char *)malloc(len+1);

        for (n = 0; n < ac; n++) {
                int     c = check_special(av[n]);
                len = strlen(av[n]);
                if (c | !len) {         // need to quote argument?
                        if ((c == '"') | (c == '\n')) c = '\'';
                        else c = '"';
                        header[hlen++] = c;
                        strcpy(header+hlen, av[n]);
                        hlen += len;
                        header[hlen++] = c;
                } else {
                        strcpy(header+hlen, av[n]);
                        hlen += len;
                }
                header[hlen++] = ' ';
        }
        header[hlen-1] = '\n';          // terminate line
        header[hlen] = '\0';
        return true;
}

// How many processors are available?
int
RadSimulManager::GetNCores()
{
        return sysconf(_SC_NPROCESSORS_ONLN);
}

// Set number of computation threads (0 => #cores)
int
RadSimulManager::SetThreadCount(int nt)
{
        if (!Ready())
                return 0;

        if (nt <= 0) nt = castonly ? 1 : GetNCores();

        if (nt == 1)
                ray_pclose(ray_pnprocs);
        else if (nt < ray_pnprocs)
                ray_pclose(ray_pnprocs - nt);
        else if (nt > ray_pnprocs)
                ray_popen(nt - ray_pnprocs);

        return NThreads();
}

// Assign ray to subthread (fails if NThreads()<2)
bool
RadSimulManager::SplitRay(RAY *r)
{
        if (!ray_pnprocs || ThreadsAvailable() < 1)
                return false;

        return (ray_psend(r) > 0);
}

// Process a ray (in subthread), optional result
bool
RadSimulManager::ProcessRay(RAY *r)
{
        if (!Ready()) return false;

        if (!ray_pnprocs) {     // single-threaded mode?
                samplendx++;
                rayvalue(r);
                return true;
        }
        int     rv = ray_pqueue(r);
        if (rv < 0) {
                error(WARNING, "ray tracing process(es) died");
                return false;
        }
        return (rv > 0);
}

// Wait for next result (or fail)
bool
RadSimulManager::WaitResult(RAY *r)
{
        if (!ray_pnprocs)
                return false;

        return (ray_presult(r, 0) > 0);
}

// Close octree, free data, return status
int
RadSimulManager::Cleanup(bool everything)
{
        NewHeader();
        if (!ray_pnprocs)
                ray_done(everything);
        else
                ray_pdone(everything);
        return 0;
}

// How many threads are currently unoccupied?
int
RadSimulManager::ThreadsAvailable() const
{
        if (!ray_pnprocs) return 1;

        return ray_pnidle;
}

// Global pointer to simulation manager for trace call-back (only one)
static const RtraceSimulManager *       ourRTsimMan = NULL;

// Call-back for trace output
void
RtraceSimulManager::RTracer(RAY *r)
{
        (*ourRTsimMan->traceCall)(r, ourRTsimMan->tcData);
}

// Call-back for FIFO output
int
RtraceSimulManager::Rfifout(RAY *r)
{
        return (*ourRTsimMan->cookedCall)(r, ourRTsimMan->ccData);
}

// Check for changes to render flags & adjust accordingly
bool
RtraceSimulManager::UpdateMode()
{
        rtFlags &= RTmask;
        if (!cookedCall)
                rtFlags &= ~RTdoFIFO;
        if (!traceCall)
                rtFlags &= ~RTtraceSources;
        if (rtFlags & RTimmIrrad)
                rtFlags &= ~RTlimDist;

        int     misMatch = rtFlags ^ curFlags;
                                // updates based on toggled flags
        if (misMatch & RTtraceSources) {
                if (rtFlags & RTtraceSources) {
                        for (int sn = 0; sn < nsources; sn++)
                                source[sn].sflags |= SFOLLOW;
                } else          // cannot undo this...
                        rtFlags |= RTtraceSources;
        }
        if (misMatch & RTdoFIFO && FlushQueue() < 0)
                return false;
        curFlags = rtFlags;
                                // update callbacks
        if (traceCall)
                trace = RTracer;
        else if (trace == RTracer)
                trace = NULL;
        if (rtFlags & RTdoFIFO)
                ray_fifo_out = Rfifout;
        else if (ray_fifo_out == Rfifout)
                ray_fifo_out = NULL;
        if ((trace != RTracer) & (ray_fifo_out != Rfifout)) {
                ourRTsimMan = NULL;
        } else if (ourRTsimMan != this) {
                if (ourRTsimMan)
                        error(WARNING, "Competing top-level simulation managers?");
                ourRTsimMan = this;
        }
        return true;
}

extern "C" int  m_normal(OBJREC *m, RAY *r);

// compute irradiance rather than radiance
static void
rayirrad(RAY *r)
{
                                        /* pretend we hit surface */
        r->rxt = r->rot = 1e-5;
        VSUM(r->rop, r->rorg, r->rdir, r->rot);
        r->ron[0] = -r->rdir[0];
        r->ron[1] = -r->rdir[1];
        r->ron[2] = -r->rdir[2];
        r->rod = 1.0;
                                        /* compute result */
        r->revf = raytrace;
        m_normal(&Lamb, r);
        r->revf = rayirrad;
}

// compute first ray intersection only
static void
raycast(RAY *r)
{
        if (!localhit(r, &thescene)) {
                if (r->ro == &Aftplane) {       /* clipped */
                        r->ro = NULL;
                        r->rot = FHUGE;
                } else
                        sourcehit(r);
        }
}

// Add ray bundle to queue w/ optional 1st ray ID
int
RtraceSimulManager::EnqueueBundle(const FVECT orig_direc[], int n, RNUMBER rID0)
{
        int     nqueued = 0;
        RAY     res;

        if (!Ready())
                return -1;

        if (castonly && !cookedCall)
                error(INTERNAL, "EnqueueBundle() called in castonly mode without cookedCall");

        if (!UpdateMode())              // update rendering mode if requested
                return -1;

        if (rID0 && curFlags&RTdoFIFO)
                error(INTERNAL, "Ray number assignment unsupported with FIFO");

        while (n-- > 0) {               // queue each ray
                VCOPY(res.rorg, orig_direc[0]);
                VCOPY(res.rdir, orig_direc[1]);
                orig_direc += 2;
                rayorigin(&res, PRIMARY, NULL, NULL);
                res.rno = rID0 ? (lastRayID = rID0++) : ++lastRayID;
                if (curFlags & RTimmIrrad)
                        res.revf = rayirrad;
                else if (castonly)
                        res.revf = raycast;
                double  d = normalize(res.rdir);
                bool    sendRes = (cookedCall != NULL);
                if (d > .0) {           // direction vector is valid?
                        if (curFlags & RTlimDist)
                                res.rmax = d;
                        if (((curFlags&RTdoFIFO) != 0) & (ray_pnprocs > 0)) {
                                if (ray_fifo_in(&res) < 0)
                                        return -1;
                                sendRes = false;
                        } else
                                sendRes &= ProcessRay(&res);
                } else if (ThreadsAvailable() < NThreads() &&
                                FlushQueue() < 0)
                        return -1;
                                        // may be dummy ray
                if (sendRes && (*cookedCall)(&res, ccData) < 0)
                        return -1;
                nqueued++;
        }
        return nqueued;
}

// Finish pending rays and complete callbacks
int
RtraceSimulManager::FlushQueue()
{
        if (curFlags & RTdoFIFO) {
                if (ray_pnprocs)
                        return ray_fifo_flush();
                return 0;
        }
        int     nsent = 0;
        RAY     res;

        while (WaitResult(&res)) {
                if (!cookedCall) continue;
                int     rv = (*cookedCall)(&res, ccData);
                if (rv < 0) return -1;
                nsent += rv;
        }
        return nsent;
}
Revision:	2.14
Committed:	Mon Aug 5 19:51:18 2024 UTC (15 months ago) by greg
Branch:	MAIN
Changes since 2.13:	+2 -2 lines
Log Message:	perf(rxtrace): Eliminated unnecessary queue flushing when adding processes
#	User	Rev	Content
1	greg	2.1	#ifndef lint
2	greg	2.14	static const char RCSid[] = "$Id: RtraceSimulManager.cpp,v 2.13 2024/08/03 15:38:06 greg Exp $";
3	greg	2.1	#endif
4			/*
5			* RtraceSimulManager.cpp
6			*
7			* Rtrace simulation manager class implementation
8			*
9			* Created by Greg Ward on 2/2/2023.
10			*/
11
12	greg	2.5	#include <unistd.h>
13	greg	2.12	#include <ctype.h>
14	greg	2.1	#include "RtraceSimulManager.h"
15			#include "source.h"
16
17			// Load octree and prepare renderer
18			bool
19			RadSimulManager::LoadOctree(const char *octn)
20			{
21			if (octname) { // already running?
22			if (octn && !strcmp(octn, octname))
23			return true;
24	greg	2.6	Cleanup();
25	greg	2.1	}
26	greg	2.12	if (!octn) // don't support stdin octree
27	greg	2.1	return false;
28
29	greg	2.13	NewHeader(octn); // get octree header
30	greg	2.1	ray_init((char *)octn);
31			return true;
32			}
33
34	greg	2.12	// callback function for loading header
35			static int
36			add2header(char str, void p)
37			{
38			if (isheadid(str))
39			return 0;
40			if (isformat(str))
41			return 0;
42
43			return ((RadSimulManager )p).AddHeader(str);
44			}
45
46			// Prepare header from previous input (or clear)
47			// Normally called during octree load
48			bool
49	greg	2.13	RadSimulManager::NewHeader(const char *inspec)
50	greg	2.12	{
51	greg	2.13	if (hlen) {
52			free(header); header = NULL; hlen = 0;
53	greg	2.12	}
54	greg	2.13	if (!inspec \|\| !*inspec)
55	greg	2.12	return false;
56	greg	2.13	if (inspec[0] == '!') // save command as header?
57			return AddHeader(inspec+1);
58			// attempt to read from file
59			FILE *fp = fopen(inspec, "rb");
60			if (!fp) return false;
61	greg	2.12	bool ok = (getheader(fp, add2header, this) >= 0);
62			fclose(fp);
63			return ok;
64			}
65
66	greg	2.13	// Add a string to header (adds newline if missing)
67	greg	2.12	bool
68			RadSimulManager::AddHeader(const char *str)
69			{
70			if (!str) return false;
71			int len = strlen(str);
72	greg	2.14	while (len && (str[len-1] == '\n') \| (str[len-1] == '\r'))
73	greg	2.13	--len; // don't copy EOL(s)
74			if (!len)
75			return false;
76			if (hlen)
77			header = (char *)realloc(header, hlen+len+2);
78			else
79	greg	2.12	header = (char *)malloc(len+2);
80	greg	2.13	if (!header) {
81			hlen = 0; // XXX should report?
82			return false;
83	greg	2.12	}
84	greg	2.13	memcpy(header+hlen, str, len);
85			hlen += len;
86			header[hlen++] = '\n'; // add single EOL
87			header[hlen] = '\0';
88	greg	2.12	return true;
89			}
90
91			// helper function to check for white-space and quotations
92			static int
93			check_special(const char *s)
94			{
95			int space_found = 0;
96
97			while (*s) {
98			if ((s == '"') \| (s == '\''))
99			return *s; // quotes have priority
100			if (isspace(*s))
101			space_found = *s;
102			s++;
103			}
104			return space_found;
105			}
106
107			// Append program line to header
108			bool
109			RadSimulManager::AddHeader(int ac, const char *av[])
110			{
111			if ((ac <= 0) \| !av) return false;
112			int len = 0;
113			int n;
114			for (n = 0; n < ac; n++) {
115			if (!av[n]) return false;
116			len += strlen(av[n]) + 3;
117			}
118	greg	2.13	if (hlen) // add to header
119	greg	2.12	header = (char *)realloc(header, hlen+len+1);
120	greg	2.13	else
121	greg	2.12	header = (char *)malloc(len+1);
122	greg	2.13
123	greg	2.12	for (n = 0; n < ac; n++) {
124			int c = check_special(av[n]);
125	greg	2.13	len = strlen(av[n]);
126			if (c \| !len) { // need to quote argument?
127			if ((c == '"') \| (c == '\n')) c = '\'';
128	greg	2.12	else c = '"';
129			header[hlen++] = c;
130			strcpy(header+hlen, av[n]);
131	greg	2.13	hlen += len;
132	greg	2.12	header[hlen++] = c;
133			} else {
134			strcpy(header+hlen, av[n]);
135	greg	2.13	hlen += len;
136	greg	2.12	}
137			header[hlen++] = ' ';
138			}
139			header[hlen-1] = '\n'; // terminate line
140			header[hlen] = '\0';
141			return true;
142			}
143
144	greg	2.5	// How many processors are available?
145	greg	2.2	int
146			RadSimulManager::GetNCores()
147			{
148	greg	2.6	return sysconf(_SC_NPROCESSORS_ONLN);
149	greg	2.2	}
150
151	greg	2.1	// Set number of computation threads (0 => #cores)
152			int
153			RadSimulManager::SetThreadCount(int nt)
154			{
155	greg	2.6	if (!Ready())
156			return 0;
157
158			if (nt <= 0) nt = castonly ? 1 : GetNCores();
159
160			if (nt == 1)
161			ray_pclose(ray_pnprocs);
162			else if (nt < ray_pnprocs)
163			ray_pclose(ray_pnprocs - nt);
164			else if (nt > ray_pnprocs)
165			ray_popen(nt - ray_pnprocs);
166	greg	2.5
167	greg	2.6	return NThreads();
168	greg	2.1	}
169
170	greg	2.4	// Assign ray to subthread (fails if NThreads()<2)
171			bool
172			RadSimulManager::SplitRay(RAY *r)
173			{
174	greg	2.6	if (!ray_pnprocs \|\| ThreadsAvailable() < 1)
175	greg	2.4	return false;
176
177	greg	2.6	return (ray_psend(r) > 0);
178	greg	2.4	}
179
180			// Process a ray (in subthread), optional result
181			bool
182			RadSimulManager::ProcessRay(RAY *r)
183			{
184	greg	2.6	if (!Ready()) return false;
185
186			if (!ray_pnprocs) { // single-threaded mode?
187	greg	2.4	samplendx++;
188			rayvalue(r);
189			return true;
190			}
191	greg	2.6	int rv = ray_pqueue(r);
192			if (rv < 0) {
193			error(WARNING, "ray tracing process(es) died");
194	greg	2.4	return false;
195			}
196	greg	2.6	return (rv > 0);
197	greg	2.4	}
198
199			// Wait for next result (or fail)
200			bool
201			RadSimulManager::WaitResult(RAY *r)
202			{
203	greg	2.6	if (!ray_pnprocs)
204			return false;
205
206			return (ray_presult(r, 0) > 0);
207	greg	2.4	}
208
209	greg	2.1	// Close octree, free data, return status
210			int
211	greg	2.3	RadSimulManager::Cleanup(bool everything)
212	greg	2.1	{
213	greg	2.13	NewHeader();
214	greg	2.6	if (!ray_pnprocs)
215	greg	2.11	ray_done(everything);
216			else
217	greg	2.5	ray_pdone(everything);
218	greg	2.1	return 0;
219			}
220
221			// How many threads are currently unoccupied?
222			int
223			RadSimulManager::ThreadsAvailable() const
224			{
225	greg	2.6	if (!ray_pnprocs) return 1;
226
227	greg	2.5	return ray_pnidle;
228	greg	2.1	}
229
230			// Global pointer to simulation manager for trace call-back (only one)
231			static const RtraceSimulManager * ourRTsimMan = NULL;
232
233	greg	2.7	// Call-back for trace output
234			void
235	greg	2.1	RtraceSimulManager::RTracer(RAY *r)
236			{
237			(*ourRTsimMan->traceCall)(r, ourRTsimMan->tcData);
238			}
239
240	greg	2.6	// Call-back for FIFO output
241			int
242			RtraceSimulManager::Rfifout(RAY *r)
243			{
244			return (*ourRTsimMan->cookedCall)(r, ourRTsimMan->ccData);
245			}
246
247	greg	2.1	// Check for changes to render flags & adjust accordingly
248			bool
249			RtraceSimulManager::UpdateMode()
250			{
251			rtFlags &= RTmask;
252			if (!cookedCall)
253			rtFlags &= ~RTdoFIFO;
254			if (!traceCall)
255			rtFlags &= ~RTtraceSources;
256			if (rtFlags & RTimmIrrad)
257			rtFlags &= ~RTlimDist;
258
259			int misMatch = rtFlags ^ curFlags;
260			// updates based on toggled flags
261			if (misMatch & RTtraceSources) {
262			if (rtFlags & RTtraceSources) {
263			for (int sn = 0; sn < nsources; sn++)
264			source[sn].sflags \|= SFOLLOW;
265			} else // cannot undo this...
266			rtFlags \|= RTtraceSources;
267			}
268	greg	2.4	if (misMatch & RTdoFIFO && FlushQueue() < 0)
269			return false;
270	greg	2.1	curFlags = rtFlags;
271	greg	2.6	// update callbacks
272			if (traceCall)
273	greg	2.1	trace = RTracer;
274	greg	2.6	else if (trace == RTracer)
275	greg	2.1	trace = NULL;
276	greg	2.6	if (rtFlags & RTdoFIFO)
277			ray_fifo_out = Rfifout;
278			else if (ray_fifo_out == Rfifout)
279			ray_fifo_out = NULL;
280			if ((trace != RTracer) & (ray_fifo_out != Rfifout)) {
281	greg	2.1	ourRTsimMan = NULL;
282	greg	2.6	} else if (ourRTsimMan != this) {
283			if (ourRTsimMan)
284			error(WARNING, "Competing top-level simulation managers?");
285			ourRTsimMan = this;
286	greg	2.1	}
287			return true;
288			}
289
290			extern "C" int m_normal(OBJREC m, RAY r);
291
292	greg	2.6	// compute irradiance rather than radiance
293	greg	2.1	static void
294			rayirrad(RAY *r)
295			{
296			/* pretend we hit surface */
297			r->rxt = r->rot = 1e-5;
298			VSUM(r->rop, r->rorg, r->rdir, r->rot);
299			r->ron[0] = -r->rdir[0];
300			r->ron[1] = -r->rdir[1];
301			r->ron[2] = -r->rdir[2];
302			r->rod = 1.0;
303			/* compute result */
304			r->revf = raytrace;
305			m_normal(&Lamb, r);
306			r->revf = rayirrad;
307			}
308
309	greg	2.6	// compute first ray intersection only
310	greg	2.1	static void
311			raycast(RAY *r)
312			{
313			if (!localhit(r, &thescene)) {
314			if (r->ro == &Aftplane) { /* clipped */
315			r->ro = NULL;
316			r->rot = FHUGE;
317			} else
318			sourcehit(r);
319			}
320			}
321
322			// Add ray bundle to queue w/ optional 1st ray ID
323			int
324			RtraceSimulManager::EnqueueBundle(const FVECT orig_direc[], int n, RNUMBER rID0)
325			{
326			int nqueued = 0;
327			RAY res;
328
329			if (!Ready())
330			return -1;
331
332			if (castonly && !cookedCall)
333	greg	2.8	error(INTERNAL, "EnqueueBundle() called in castonly mode without cookedCall");
334	greg	2.1
335			if (!UpdateMode()) // update rendering mode if requested
336			return -1;
337
338	greg	2.9	if (rID0 && curFlags&RTdoFIFO)
339			error(INTERNAL, "Ray number assignment unsupported with FIFO");
340
341	greg	2.1	while (n-- > 0) { // queue each ray
342			VCOPY(res.rorg, orig_direc[0]);
343			VCOPY(res.rdir, orig_direc[1]);
344			orig_direc += 2;
345			rayorigin(&res, PRIMARY, NULL, NULL);
346	greg	2.9	res.rno = rID0 ? (lastRayID = rID0++) : ++lastRayID;
347	greg	2.1	if (curFlags & RTimmIrrad)
348			res.revf = rayirrad;
349			else if (castonly)
350			res.revf = raycast;
351	greg	2.4	double d = normalize(res.rdir);
352			bool sendRes = (cookedCall != NULL);
353	greg	2.10	if (d > .0) { // direction vector is valid?
354	greg	2.1	if (curFlags & RTlimDist)
355			res.rmax = d;
356	greg	2.7	if (((curFlags&RTdoFIFO) != 0) & (ray_pnprocs > 0)) {
357			if (ray_fifo_in(&res) < 0)
358			return -1;
359	greg	2.4	sendRes = false;
360	greg	2.6	} else
361			sendRes &= ProcessRay(&res);
362	greg	2.1	} else if (ThreadsAvailable() < NThreads() &&
363	greg	2.4	FlushQueue() < 0)
364	greg	2.1	return -1;
365	greg	2.6	// may be dummy ray
366			if (sendRes && (*cookedCall)(&res, ccData) < 0)
367			return -1;
368	greg	2.3	nqueued++;
369	greg	2.1	}
370			return nqueued;
371			}
372
373			// Finish pending rays and complete callbacks
374	greg	2.4	int
375	greg	2.1	RtraceSimulManager::FlushQueue()
376			{
377	greg	2.7	if (curFlags & RTdoFIFO) {
378			if (ray_pnprocs)
379			return ray_fifo_flush();
380			return 0;
381			}
382	greg	2.4	int nsent = 0;
383			RAY res;
384
385			while (WaitResult(&res)) {
386			if (!cookedCall) continue;
387	greg	2.6	int rv = (*cookedCall)(&res, ccData);
388			if (rv < 0) return -1;
389			nsent += rv;
390	greg	2.4	}
391			return nsent;
392	greg	2.1	}