1 |
#ifndef lint |
2 |
static const char RCSid[] = "$Id: rayfifo.c,v 2.4 2009/12/13 19:13:04 greg Exp $"; |
3 |
#endif |
4 |
/* |
5 |
* rayfifo.c - parallelize ray queue that respects order |
6 |
* |
7 |
* External symbols declared in ray.h |
8 |
*/ |
9 |
|
10 |
#include "copyright.h" |
11 |
|
12 |
/* |
13 |
* These routines are essentially an adjunct to raypcalls.c, providing |
14 |
* a convenient means to get first-in/first-out behavior from multiple |
15 |
* processor cores. The interface is quite simple, with two functions |
16 |
* and a callback, which must be defined by the calling program. The |
17 |
* hand-off for finished rays is assigned to ray_fifo_out, which takes |
18 |
* a single pointer to the finished ray and returns a non-negative |
19 |
* integer. If there is an exceptional condition where termination |
20 |
* is desired, a negative value may be returned. |
21 |
* |
22 |
* The ray_fifo_in() call takes a ray that has been initialized in |
23 |
* the same manner as for the ray_pqueue() call, i.e., rayorigin() |
24 |
* has been called and the origin, direction and maximum distance |
25 |
* have all been assigned. However, the ray number will be reset |
26 |
* by ray_fifo_in() according to the number of rays traced since the |
27 |
* last call to ray_fifo_flush(). This final call completes all |
28 |
* pending ray calculations and frees the FIFO buffer. If any of |
29 |
* the automatic calls to the ray_fifo_out callback return a |
30 |
* negative value, processing stops and -1 is returned. |
31 |
* |
32 |
* Note: The ray passed to ray_fifo_in() may be overwritten |
33 |
* arbitrarily, since it is passed to ray_pqueue(). |
34 |
*/ |
35 |
|
36 |
#include "ray.h" |
37 |
#include <string.h> |
38 |
|
39 |
#ifndef MAXFIFO |
40 |
#define MAXFIFO 4096 /* clear FIFO past this */ |
41 |
#endif |
42 |
|
43 |
int (*ray_fifo_out)(RAY *r) = NULL; /* ray output callback */ |
44 |
|
45 |
static RAY *r_fifo_buf = NULL; /* circular FIFO out buffer */ |
46 |
static int r_fifo_len = 0; /* allocated FIFO length */ |
47 |
static RNUMBER r_fifo_start = 1; /* first awaited ray */ |
48 |
static RNUMBER r_fifo_end = 1; /* one past FIFO last */ |
49 |
static RNUMBER r_fifo_next = 1; /* next ray assignment */ |
50 |
|
51 |
#define r_fifo(rn) (&r_fifo_buf[(rn)&(r_fifo_len-1)]) |
52 |
|
53 |
|
54 |
static void |
55 |
ray_fifo_growbuf(void) /* double buffer size (or set to minimum if NULL) */ |
56 |
{ |
57 |
RAY *old_buf = r_fifo_buf; |
58 |
int old_len = r_fifo_len; |
59 |
int i; |
60 |
|
61 |
if (r_fifo_buf == NULL) |
62 |
r_fifo_len = 32; |
63 |
else |
64 |
r_fifo_len = r_fifo_len*3/2; |
65 |
/* allocate new */ |
66 |
r_fifo_buf = (RAY *)calloc(r_fifo_len, sizeof(RAY)); |
67 |
if (r_fifo_buf == NULL) |
68 |
error(SYSTEM, "out of memory in ray_fifo_growbuf"); |
69 |
if (old_buf == NULL) |
70 |
return; |
71 |
/* copy old & free */ |
72 |
for (i = r_fifo_start; i < r_fifo_end; i++) |
73 |
*r_fifo(i) = old_buf[i&(old_len-1)]; |
74 |
|
75 |
free(old_buf); |
76 |
} |
77 |
|
78 |
|
79 |
static int |
80 |
ray_fifo_push( /* send finished ray to output (or queue it) */ |
81 |
RAY *r |
82 |
) |
83 |
{ |
84 |
int rv, nsent = 0; |
85 |
|
86 |
if (ray_fifo_out == NULL) |
87 |
error(INTERNAL, "ray_fifo_out is NULL"); |
88 |
if ((r->rno < r_fifo_start) | (r->rno >= r_fifo_next)) |
89 |
error(INTERNAL, "unexpected ray number in ray_fifo_push()"); |
90 |
|
91 |
if (r->rno > r_fifo_start) { /* insert into output queue */ |
92 |
while (r->rno - r_fifo_start >= r_fifo_len) |
93 |
ray_fifo_growbuf(); /* need more space */ |
94 |
*r_fifo(r->rno) = *r; |
95 |
if (r->rno >= r_fifo_end) |
96 |
r_fifo_end = r->rno + 1; |
97 |
return(0); |
98 |
} |
99 |
/* r->rno == r_fifo_start, so transfer ray(s) */ |
100 |
do { |
101 |
rv = (*ray_fifo_out)(r); |
102 |
r->rno = 0; /* flag this entry complete */ |
103 |
if (rv < 0) |
104 |
return(-1); |
105 |
nsent += rv; |
106 |
if (++r_fifo_start < r_fifo_end) |
107 |
r = r_fifo(r_fifo_start); |
108 |
else if (r_fifo_start > r_fifo_end) |
109 |
r_fifo_end = r_fifo_start; |
110 |
} while (r->rno == r_fifo_start); |
111 |
|
112 |
return(nsent); |
113 |
} |
114 |
|
115 |
|
116 |
int |
117 |
ray_fifo_in( /* add ray to FIFO */ |
118 |
RAY *r |
119 |
) |
120 |
{ |
121 |
static int incall = 0; /* prevent recursion */ |
122 |
int rv, rval = 0; |
123 |
|
124 |
if (incall++) |
125 |
error(INTERNAL, "recursive call to ray_fifo_in()"); |
126 |
|
127 |
/* need to reset our FIFO? */ |
128 |
if ((r_fifo_start >= 1L<<30) | (r_fifo_len > MAXFIFO)) { |
129 |
if ((rv = ray_fifo_flush()) < 0) |
130 |
{--incall; return(-1);} |
131 |
rval += rv; |
132 |
} |
133 |
/* queue ray */ |
134 |
r->rno = r_fifo_next++; |
135 |
if ((rv = ray_pqueue(r)) < 0) |
136 |
{--incall; return(-1);} |
137 |
|
138 |
if (!rv) /* no result this time? */ |
139 |
{--incall; return(rval);} |
140 |
|
141 |
do { /* else send/queue result */ |
142 |
if ((rv = ray_fifo_push(r)) < 0) |
143 |
{--incall; return(-1);} |
144 |
rval += rv; |
145 |
|
146 |
} while (ray_presult(r, -1) > 0); /* empty in-core queue */ |
147 |
|
148 |
--incall; return(rval); |
149 |
} |
150 |
|
151 |
|
152 |
int |
153 |
ray_fifo_flush(void) /* flush everything and release buffer */ |
154 |
{ |
155 |
RAY myRay; |
156 |
int rv, rval = 0; |
157 |
/* clear parallel queue */ |
158 |
while ((rv = ray_presult(&myRay, 0)) > 0 && |
159 |
(rv = ray_fifo_push(&myRay)) >= 0) |
160 |
rval += rv; |
161 |
|
162 |
if (rv < 0) /* check for exception */ |
163 |
return(-1); |
164 |
|
165 |
if (r_fifo_start != r_fifo_end) |
166 |
error(INTERNAL, "could not empty queue in ray_fifo_flush()"); |
167 |
|
168 |
if (r_fifo_buf != NULL) { |
169 |
free(r_fifo_buf); |
170 |
r_fifo_buf = NULL; r_fifo_len = 0; |
171 |
} |
172 |
r_fifo_next = r_fifo_end = r_fifo_start = 1; |
173 |
|
174 |
return(rval); |
175 |
} |