ViewVC Help
View File | Revision Log | Show Annotations | Download File | Root Listing
root/radiance/ray/src/rt/rxcmain.cpp
Revision: 2.9
Committed: Tue Dec 3 17:39:42 2024 UTC (4 months, 4 weeks ago) by greg
Branch: MAIN
Changes since 2.8: +1 -13 lines
Log Message:
refactor(rxcontrib): Moved definition of formstr() to make it more accessible

File Contents

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