ViewVC Help
View File | Revision Log | Show Annotations | Download File | Root Listing
root/radiance/src/rt/rxcmain.cpp
Revision: 2.19
Committed: Thu Oct 16 18:36:23 2025 UTC (3 weeks, 6 days ago) by greg
Branch: MAIN
Changes since 2.18: +9 -7 lines
Log Message:
fix: Added missing error diagnostics

File Contents

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