ViewVC Help
View File | Revision Log | Show Annotations | Download File | Root Listing
root/radiance/ray/src/rt/rxcmain.cpp
Revision: 2.8
Committed: Thu Nov 7 20:56:09 2024 UTC (5 months, 3 weeks ago) by greg
Branch: MAIN
Changes since 2.7: +9 -5 lines
Log Message:
fix(rxcontrib): Improved progress reporting accuracy

File Contents

# User Rev Content
1 greg 2.1 #ifndef lint
2 greg 2.8 static const char RCSid[] = "$Id: rxcmain.cpp,v 2.7 2024/11/07 18:09:39 greg Exp $";
3 greg 2.1 #endif
4     /*
5     * rxcmain.c - main for rxcontrib ray contribution tracer
6     */
7    
8     #include "copyright.h"
9    
10     #include <signal.h>
11     #include <time.h>
12     #include <ctype.h>
13     #include "RcontribSimulManager.h"
14     #include "platform.h"
15     #include "func.h"
16    
17     const char *sigerr[NSIG]; /* signal error messages */
18    
19     int nproc = 1; /* number of processes requested */
20    
21     int inpfmt = 'a'; /* input format */
22     int outfmt = 'f'; /* output format */
23    
24     int report_intvl = 0; /* reporting interval (seconds) */
25    
26     extern char * progname; // global argv[0]
27    
28     RcontribSimulManager myRCmanager; // global rcontrib simulation manager
29    
30     #define RCONTRIB_FEATURES "Multiprocessing\n" \
31     "Accumulation\nRecovery\n" \
32     "ImmediateIrradiance\n" \
33 greg 2.2 "ProgressReporting\nDistanceLimiting\n" \
34 greg 2.1 "InputFormats=a,f,d\nOutputFormats=f,d,c\n" \
35     "Outputs=V,W\n" \
36     "OutputCS=RGB,spec\n"
37    
38     static void rxcontrib(const int rstart = 0);
39    
40     static void
41     printdefaults(void) /* print default values to stdout */
42     {
43     printf("-c %-5d\t\t\t# accumulated rays per record\n", myRCmanager.accum);
44 greg 2.6 printf(myRCmanager.HasFlag(RCcontrib) ?
45 greg 2.7 "-V+\t\t\t\t# output contributions\n" :
46     "-V-\t\t\t\t# output coefficients\n");
47 greg 2.2 if (myRCmanager.HasFlag(RTimmIrrad))
48 greg 2.1 printf("-I+\t\t\t\t# immediate irradiance on\n");
49     printf("-n %-2d\t\t\t\t# number of rendering processes\n", nproc);
50 greg 2.6 if (myRCmanager.xres > 0)
51     printf("-x %-9d\t\t\t# x resolution\n", myRCmanager.xres);
52     printf("-y %-9d\t\t\t# y resolution\n", myRCmanager.yres);
53 greg 2.2 printf(myRCmanager.HasFlag(RTlimDist) ?
54     "-ld+\t\t\t\t# limit distance on\n" :
55 greg 2.1 "-ld-\t\t\t\t# limit distance off\n");
56     printf("-f%c%c\t\t\t\t# format input/output = %s/%s\n",
57     inpfmt, outfmt, formstr(inpfmt), formstr(outfmt));
58     if (report_intvl > 0)
59     printf("-t %-9d\t\t\t# time between reports\n", report_intvl);
60     printf(erract[WARNING].pf != NULL ?
61     "-w+\t\t\t\t# warning messages on\n" :
62     "-w-\t\t\t\t# warning messages off\n");
63     print_rdefaults();
64     }
65    
66    
67     static void
68     onsig( /* fatal signal */
69     int signo
70     )
71     {
72     static int gotsig = 0;
73    
74     if (gotsig++) /* two signals and we're gone! */
75     _exit(signo);
76    
77     #ifdef SIGALRM
78 greg 2.4 alarm(180); /* allow 3 minutes to clean up */
79 greg 2.1 signal(SIGALRM, SIG_DFL); /* make certain we do die */
80     #endif
81     eputs("signal - ");
82     eputs(sigerr[signo]);
83     eputs("\n");
84     quit(3);
85     }
86    
87    
88     static void
89     sigdie( /* set fatal signal */
90     int signo,
91     const char *msg
92     )
93     {
94     if (signal(signo, onsig) == SIG_IGN)
95     signal(signo, SIG_IGN);
96     sigerr[signo] = msg;
97     }
98    
99     const char *
100     formstr(int f) // return format identifier
101     {
102     switch (f) {
103     case 'a': return("ascii");
104     case 'f': return("float");
105     case 'd': return("double");
106     case 'c': return(NCSAMP==3 ? COLRFMT : SPECFMT);
107     }
108     return("unknown");
109     }
110    
111     /* set input/output format */
112     static void
113     setformat(const char *fmt)
114     {
115     switch (fmt[0]) {
116     case 'f':
117     case 'd':
118     SET_FILE_BINARY(stdin);
119     /* fall through */
120     case 'a':
121     inpfmt = fmt[0];
122     break;
123     default:
124     goto fmterr;
125     }
126     switch (fmt[1]) {
127     case '\0':
128     if (inpfmt == 'a')
129     goto fmterr;
130     outfmt = inpfmt;
131     return;
132     case 'f':
133     case 'd':
134     case 'c':
135     outfmt = fmt[1];
136     break;
137     default:
138     goto fmterr;
139     }
140     if (!fmt[2])
141     return;
142     fmterr:
143     sprintf(errmsg, "Unsupported i/o format: -f%s", fmt);
144     error(USER, errmsg);
145     }
146    
147    
148     /* Set overriding options */
149     static void
150     override_options(void)
151     {
152     shadthresh = 0;
153     ambssamp = 0;
154     ambacc = 0;
155     }
156    
157    
158     int
159     main(int argc, char *argv[])
160     {
161     #define check(ol,al) if (argv[i][ol] || \
162     badarg(argc-i-1,argv+i+1,al)) \
163     goto badopt
164     #define check_bool(olen,var) switch (argv[i][olen]) { \
165     case '\0': var = !var; break; \
166     case 'y': case 'Y': case 't': case 'T': \
167     case '+': case '1': var = 1; break; \
168     case 'n': case 'N': case 'f': case 'F': \
169     case '-': case '0': var = 0; break; \
170     default: goto badopt; }
171     int force_open = 0;
172     int recover = 0;
173     char *curout = NULL;
174     char *prms = NULL;
175     char *binval = NULL;
176     int bincnt = 0;
177     int rval;
178     int i;
179     /* global program name */
180     progname = argv[0];
181     /* feature check only? */
182     strcat(RFeatureList, RCONTRIB_FEATURES);
183     if (argc > 1 && !strcmp(argv[1], "-features"))
184     return feature_status(argc-2, argv+2);
185     /* initialize calcomp routines early */
186     initfunc();
187     calcontext(RCCONTEXT);
188     /* option city */
189     for (i = 1; i < argc; i++) {
190     /* expand arguments */
191     while ((rval = expandarg(&argc, &argv, i)) > 0)
192     ;
193     if (rval < 0) {
194     sprintf(errmsg, "cannot expand '%s'", argv[i]);
195     error(SYSTEM, errmsg);
196     }
197     if (argv[i] == NULL || argv[i][0] != '-')
198     break; /* break from options */
199     if (!strcmp(argv[i], "-version")) {
200     puts(VersionID);
201     quit(0);
202     }
203     if (!strcmp(argv[i], "-defaults") ||
204     !strcmp(argv[i], "-help")) {
205     override_options();
206     printdefaults();
207     quit(0);
208     }
209     rval = getrenderopt(argc-i, argv+i);
210     if (rval >= 0) {
211     i += rval;
212     continue;
213     }
214     switch (argv[i][1]) {
215 greg 2.2 case 'n': /* number of processes */
216 greg 2.1 check(2,"i");
217     nproc = atoi(argv[++i]);
218     if (nproc < 0 && (nproc += RadSimulManager::GetNCores()) <= 0)
219     nproc = 1;
220     break;
221 greg 2.2 case 'V': /* output contributions? */
222 greg 2.6 rval = myRCmanager.HasFlag(RCcontrib);
223     check_bool(2,rval);
224     myRCmanager.SetFlag(RCcontrib, rval);
225 greg 2.1 break;
226     case 'x': /* x resolution */
227     check(2,"i");
228 greg 2.6 myRCmanager.xres = atoi(argv[++i]);
229 greg 2.1 break;
230     case 'y': /* y resolution */
231     check(2,"i");
232 greg 2.6 myRCmanager.yres = atoi(argv[++i]);
233 greg 2.1 break;
234 greg 2.2 case 'w': /* warnings on/off */
235 greg 2.1 rval = (erract[WARNING].pf != NULL);
236     check_bool(2,rval);
237     if (rval) erract[WARNING].pf = wputs;
238     else erract[WARNING].pf = NULL;
239     break;
240 greg 2.2 case 'e': /* .cal expression */
241 greg 2.1 check(2,"s");
242     scompile(argv[++i], NULL, 0);
243     break;
244     case 'l': /* limit distance */
245     if (argv[i][2] != 'd')
246     goto badopt;
247 greg 2.2 rval = myRCmanager.HasFlag(RTlimDist);
248     check_bool(3,rval);
249     myRCmanager.SetFlag(RTlimDist, rval);
250 greg 2.1 break;
251     case 'I': /* immed. irradiance */
252 greg 2.2 rval = myRCmanager.HasFlag(RTimmIrrad);
253     check_bool(2,rval);
254     myRCmanager.SetFlag(RTimmIrrad, rval);
255 greg 2.1 break;
256 greg 2.2 case 'f': /* .cal file or force or format */
257 greg 2.1 if (!argv[i][2]) {
258     check(2,"s");
259     loadfunc(argv[++i]);
260     break;
261     }
262     if (argv[i][2] == 'o') {
263     check_bool(3,force_open);
264     break;
265     }
266     setformat(argv[i]+2);
267     myRCmanager.SetDataFormat(outfmt);
268     break;
269 greg 2.2 case 'o': /* output file */
270 greg 2.1 check(2,"s");
271     curout = argv[++i];
272     break;
273     case 'r': /* recover output */
274     check_bool(2,recover);
275     break;
276     case 'p': /* parameter setting(s) */
277     check(2,"s");
278     set_eparams(prms = argv[++i]);
279     break;
280     case 'c': /* sample count */
281     check(2,"i");
282     myRCmanager.accum = atoi(argv[++i]);
283     break;
284     case 'b': /* bin expression/count */
285     if (argv[i][2] == 'n') {
286     check(3,"s");
287     bincnt = (int)(eval(argv[++i]) + .5);
288     break;
289     }
290     check(2,"s");
291     binval = argv[++i];
292     break;
293     case 'm': /* modifier name */
294     check(2,"s");
295     myRCmanager.AddModifier(argv[++i], curout, prms, binval, bincnt);
296     break;
297 greg 2.2 case 'M': /* file of modifier names */
298 greg 2.1 check(2,"s");
299     myRCmanager.AddModFile(argv[++i], curout, prms, binval, bincnt);
300     break;
301     case 't': /* reporting interval */
302     check(2,"i");
303     report_intvl = atoi(argv[++i]);
304     break;
305     default:
306     goto badopt;
307     }
308     }
309     if (i != argc-1)
310     error(USER, "expected single octree argument");
311 greg 2.2
312     override_options(); /* override some option settings */
313    
314     if (!myRCmanager.GetOutput()) // check that we have work to do
315     error(USER, "missing required modifier argument");
316 greg 2.1 // get ready to rock...
317     if (setspectrsamp(CNDX, WLPART) < 0)
318     error(USER, "unsupported spectral sampling");
319     /* set up signal handling */
320     sigdie(SIGINT, "Interrupt");
321     #ifdef SIGHUP
322     sigdie(SIGHUP, "Hangup");
323     #endif
324     sigdie(SIGTERM, "Terminate");
325     #ifdef SIGPIPE
326     sigdie(SIGPIPE, "Broken pipe");
327     #endif
328     #ifdef SIGALRM
329     sigdie(SIGALRM, "Alarm clock");
330     #endif
331     #ifdef SIGXCPU
332     sigdie(SIGXCPU, "CPU limit exceeded");
333     sigdie(SIGXFSZ, "File size exceeded");
334     #endif
335     #ifdef NICE
336     nice(NICE); /* lower priority */
337     #endif
338     // load octree
339     myRCmanager.LoadOctree(argv[argc-1]);
340     // add to header
341     myRCmanager.AddHeader(argc-1, argv);
342     // prepare output files
343     if (recover)
344     myRCmanager.outOp = RCOrecover;
345     else if (force_open)
346     myRCmanager.outOp = RCOforce;
347     else
348     myRCmanager.outOp = RCOnew;
349     // rval = # rows recovered
350     rval = myRCmanager.PrepOutput();
351 greg 2.2 // check if recovered everything
352 greg 2.8 if (rval >= myRCmanager.GetRowMax()) {
353 greg 2.1 error(WARNING, "nothing left to compute");
354     quit(0);
355     } // add processes as requested
356     myRCmanager.SetThreadCount(nproc);
357    
358     rxcontrib(rval); /* trace ray contributions (loop) */
359    
360     quit(0); /* exit clean */
361    
362     badopt:
363     fprintf(stderr,
364     "Usage: %s [-V][-c count][-r][-e expr][-f source][-o ospec][-p p1=V1,p2=V2][-b binv][-bn N] {-m mod | -M file} [rtrace options] octree\n",
365     progname);
366     sprintf(errmsg, "command line error at '%s'", argv[i]);
367     error(USER, errmsg);
368     return(1); /* pro forma return */
369    
370     #undef check
371     #undef check_bool
372     }
373    
374    
375     // skip specified number of bytes, return false if EOF
376     static bool
377     skipBytes(int n2skip)
378     {
379     while (n2skip-- > 0)
380     if (getchar() == EOF)
381     return false;
382     return true;
383     }
384    
385    
386     // skip specified number of whitespace-separated words, return false if EOF
387     static bool
388     skipWords(int n2skip)
389     {
390     int c;
391    
392     while (n2skip-- > 0) {
393     do {
394     c = getchar();
395     } while (isspace(c));
396     do {
397     if (c == EOF) return false;
398     c = getchar();
399     } while (!isspace(c));
400     }
401     return true;
402     }
403    
404    
405     // read a bundle of myRCmanager.accum ray origins and directions
406     static bool
407     getRayBundle(FVECT *orig_dir = NULL)
408     {
409     int n2go = myRCmanager.accum;
410    
411     switch (inpfmt) {
412     case 'a': // ASCII input
413     if (!orig_dir)
414     return skipWords(6*n2go);
415     while (n2go-- > 0) {
416     if (scanf(FVFORMAT, &orig_dir[0][0],
417     &orig_dir[0][1], &orig_dir[0][2]) != 3)
418     return false;
419     if (scanf(FVFORMAT, &orig_dir[1][0],
420     &orig_dir[1][1], &orig_dir[1][2]) != 3)
421     return false;
422     orig_dir += 2;
423     }
424     break;
425     case 'f': // float input
426     if (!orig_dir)
427     return skipBytes(6*sizeof(float)*n2go);
428     #ifdef SMLFLT
429     if (getbinary(orig_dir, sizeof(FVECT), 2*n2go, stdin) != 2*n2go)
430     return false;
431     #else
432     while (n2go-- > 0) {
433     float fvecs[6];
434     if (getbinary(fvecs, sizeof(fvecs), 1, stdin) != 1)
435     return false;
436     for (int i = 6; i--; )
437     orig_dir[0][i] = fvecs[i];
438     orig_dir += 2;
439     }
440     #endif
441     break;
442     case 'd': // double input
443     if (!orig_dir)
444     return skipBytes(6*sizeof(double)*n2go);
445     #ifndef SMLFLT
446     if (getbinary(orig_dir, sizeof(FVECT), 2*n2go, stdin) != 2*n2go)
447     return false;
448     #else
449     while (n2go-- > 0) {
450     double dvecs[6];
451     if (getbinary(dvecs, sizeof(dvecs), 1, stdin) != 1)
452     return false;
453     for (int i = 6; i--; )
454     orig_dir[0][i] = dvecs[i];
455     orig_dir += 2;
456     }
457     #endif
458     break;
459     default:
460     error(INTERNAL, "unsupported format in getRayBundle()");
461     return false;
462     }
463     int warned = 0; // normalize directions
464     n2go = myRCmanager.accum;
465     while (n2go-- > 0) {
466     orig_dir -= 2;
467     if (normalize(orig_dir[1]) == 0)
468     if (!warned++)
469     error(WARNING, "zero ray direction on input");
470     }
471     return true;
472     }
473    
474    
475     // Run loop to load data, report progress, etc.
476     void
477     rxcontrib(const int rstart)
478     {
479     const int totRows = myRCmanager.GetRowMax();
480     FVECT * odarr = (FVECT *)emalloc(sizeof(FVECT)*2*myRCmanager.accum);
481     time_t tstart, last_report;
482     int r = 0;
483    
484     while (r < rstart) { // skip input rays already done
485     if (!getRayBundle())
486     goto readerr;
487     r++;
488     }
489     if (report_intvl > 0) { // set up reporting
490     if (r > 0) {
491     sprintf(errmsg, "recovered %.2f%% of total\n",
492     100.*r/totRows);
493     eputs(errmsg);
494     }
495     last_report = tstart = time(0);
496     }
497 greg 2.8 while (r < totRows) { // loop until done
498 greg 2.1 time_t tnow;
499     if (!getRayBundle(odarr))
500     goto readerr;
501 greg 2.5 if (myRCmanager.ComputeRecord(odarr) <= 0)
502 greg 2.1 return; // error reported, hopefully...
503     r++;
504     if (report_intvl <= 0)
505     continue;
506 greg 2.8 tnow = time(0); // time to report progress?
507     if (r == totRows)
508     myRCmanager.FlushQueue();
509     else if (tnow < last_report+report_intvl)
510 greg 2.1 continue;
511     sprintf(errmsg, "%.2f%% done after %.3f hours\n",
512 greg 2.8 100.*myRCmanager.GetRowFinished()/totRows,
513     (1./3600.)*(tnow - tstart));
514 greg 2.1 eputs(errmsg);
515     last_report = tnow;
516     }
517     efree(odarr);
518     return;
519     readerr:
520     sprintf(errmsg, "unexpected EOF on standard input (record %d of %d)",
521     r, totRows);
522     error(USER, errmsg);
523     }
524    
525    
526     void
527     wputs( /* warning output function */
528     const char *s
529     )
530     {
531 greg 2.3 if (!erract[WARNING].pf) return;
532 greg 2.1 int lasterrno = errno;
533     eputs(s);
534     errno = lasterrno;
535     }
536    
537    
538     void
539     eputs( /* put string to stderr */
540     const char *s
541     )
542     {
543     static int midline = 0;
544    
545     if (!*s)
546     return;
547     if (!midline++) {
548     fputs(progname, stderr);
549     fputs(": ", stderr);
550     }
551     fputs(s, stderr);
552     if (s[strlen(s)-1] == '\n') {
553     fflush(stderr);
554     midline = 0;
555     }
556     }
557    
558    
559 greg 2.2 /* Exit program */
560 greg 2.1 void
561     quit(
562     int code
563     )
564     {
565     if (!code && myRCmanager.Ready()) // clean up on normal exit
566     code = myRCmanager.Cleanup();
567    
568     exit(code);
569     }