m_debug_clip.c revision cdc920a0 
1/*
2 * Mesa 3-D graphics library
3 * Version:  6.1
4 *
5 * Copyright (C) 1999-2005  Brian Paul   All Rights Reserved.
6 *
7 * Permission is hereby granted, free of charge, to any person obtaining a
8 * copy of this software and associated documentation files (the "Software"),
9 * to deal in the Software without restriction, including without limitation
10 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
11 * and/or sell copies of the Software, and to permit persons to whom the
12 * Software is furnished to do so, subject to the following conditions:
13 *
14 * The above copyright notice and this permission notice shall be included
15 * in all copies or substantial portions of the Software.
16 *
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
18 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
20 * BRIAN PAUL BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
21 * AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
22 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
23 *
24 * Authors:
25 *    Gareth Hughes
26 */
27
28#include "main/glheader.h"
29#include "main/context.h"
30#include "main/macros.h"
31#include "main/imports.h"
32
33#include "m_matrix.h"
34#include "m_xform.h"
35
36#include "m_debug.h"
37#include "m_debug_util.h"
38
39#ifdef __UNIXOS2__
40/* The linker doesn't like empty files */
41static char dummy;
42#endif
43
44#ifdef DEBUG_MATH  /* This code only used for debugging */
45
46static clip_func *clip_tab[2] = {
47   _mesa_clip_tab,
48   _mesa_clip_np_tab
49};
50static char *cnames[2] = {
51   "_mesa_clip_tab",
52   "_mesa_clip_np_tab"
53};
54#ifdef RUN_DEBUG_BENCHMARK
55static char *cstrings[2] = {
56   "clip, perspective divide",
57   "clip, no divide"
58};
59#endif
60
61
62/* =============================================================
63 * Reference cliptests
64 */
65
66static GLvector4f *ref_cliptest_points4( GLvector4f *clip_vec,
67					 GLvector4f *proj_vec,
68					 GLubyte clipMask[],
69					 GLubyte *orMask,
70					 GLubyte *andMask,
71					 GLboolean viewport_z_clip )
72{
73   const GLuint stride = clip_vec->stride;
74   const GLuint count = clip_vec->count;
75   const GLfloat *from = (GLfloat *)clip_vec->start;
76   GLuint c = 0;
77   GLfloat (*vProj)[4] = (GLfloat (*)[4])proj_vec->start;
78   GLubyte tmpAndMask = *andMask;
79   GLubyte tmpOrMask = *orMask;
80   GLuint i;
81   for ( i = 0 ; i < count ; i++, STRIDE_F(from, stride) ) {
82      const GLfloat cx = from[0];
83      const GLfloat cy = from[1];
84      const GLfloat cz = from[2];
85      const GLfloat cw = from[3];
86      GLubyte mask = 0;
87      if ( -cx + cw < 0 ) mask |= CLIP_RIGHT_BIT;
88      if (  cx + cw < 0 ) mask |= CLIP_LEFT_BIT;
89      if ( -cy + cw < 0 ) mask |= CLIP_TOP_BIT;
90      if (  cy + cw < 0 ) mask |= CLIP_BOTTOM_BIT;
91      if (viewport_z_clip) {
92	 if ( -cz + cw < 0 ) mask |= CLIP_FAR_BIT;
93	 if (  cz + cw < 0 ) mask |= CLIP_NEAR_BIT;
94      }
95      clipMask[i] = mask;
96      if ( mask ) {
97	 c++;
98	 tmpAndMask &= mask;
99	 tmpOrMask |= mask;
100	 vProj[i][0] = 0;
101	 vProj[i][1] = 0;
102	 vProj[i][2] = 0;
103	 vProj[i][3] = 1;
104      } else {
105	 GLfloat oow = 1.0F / cw;
106	 vProj[i][0] = cx * oow;
107	 vProj[i][1] = cy * oow;
108	 vProj[i][2] = cz * oow;
109	 vProj[i][3] = oow;
110      }
111   }
112
113   *orMask = tmpOrMask;
114   *andMask = (GLubyte) (c < count ? 0 : tmpAndMask);
115
116   proj_vec->flags |= VEC_SIZE_4;
117   proj_vec->size = 4;
118   proj_vec->count = clip_vec->count;
119   return proj_vec;
120}
121
122/* Keep these here for now, even though we don't use them...
123 */
124static GLvector4f *ref_cliptest_points3( GLvector4f *clip_vec,
125					 GLvector4f *proj_vec,
126					 GLubyte clipMask[],
127					 GLubyte *orMask,
128					 GLubyte *andMask,
129                                         GLboolean viewport_z_clip )
130{
131   const GLuint stride = clip_vec->stride;
132   const GLuint count = clip_vec->count;
133   const GLfloat *from = (GLfloat *)clip_vec->start;
134
135   GLubyte tmpOrMask = *orMask;
136   GLubyte tmpAndMask = *andMask;
137   GLuint i;
138   for ( i = 0 ; i < count ; i++, STRIDE_F(from, stride) ) {
139      const GLfloat cx = from[0], cy = from[1], cz = from[2];
140      GLubyte mask = 0;
141      if ( cx >  1.0 )		mask |= CLIP_RIGHT_BIT;
142      else if ( cx < -1.0 )	mask |= CLIP_LEFT_BIT;
143      if ( cy >  1.0 )		mask |= CLIP_TOP_BIT;
144      else if ( cy < -1.0 )	mask |= CLIP_BOTTOM_BIT;
145      if (viewport_z_clip) {
146         if ( cz >  1.0 )		mask |= CLIP_FAR_BIT;
147         else if ( cz < -1.0 )	mask |= CLIP_NEAR_BIT;
148      }
149      clipMask[i] = mask;
150      tmpOrMask |= mask;
151      tmpAndMask &= mask;
152   }
153
154   *orMask = tmpOrMask;
155   *andMask = tmpAndMask;
156   return clip_vec;
157}
158
159static GLvector4f * ref_cliptest_points2( GLvector4f *clip_vec,
160					  GLvector4f *proj_vec,
161					  GLubyte clipMask[],
162					  GLubyte *orMask,
163					  GLubyte *andMask,
164                                          GLboolean viewport_z_clip )
165{
166   const GLuint stride = clip_vec->stride;
167   const GLuint count = clip_vec->count;
168   const GLfloat *from = (GLfloat *)clip_vec->start;
169
170   GLubyte tmpOrMask = *orMask;
171   GLubyte tmpAndMask = *andMask;
172   GLuint i;
173
174   (void) viewport_z_clip;
175
176   for ( i = 0 ; i < count ; i++, STRIDE_F(from, stride) ) {
177      const GLfloat cx = from[0], cy = from[1];
178      GLubyte mask = 0;
179      if ( cx >  1.0 )		mask |= CLIP_RIGHT_BIT;
180      else if ( cx < -1.0 )	mask |= CLIP_LEFT_BIT;
181      if ( cy >  1.0 )		mask |= CLIP_TOP_BIT;
182      else if ( cy < -1.0 )	mask |= CLIP_BOTTOM_BIT;
183      clipMask[i] = mask;
184      tmpOrMask |= mask;
185      tmpAndMask &= mask;
186   }
187
188   *orMask = tmpOrMask;
189   *andMask = tmpAndMask;
190   return clip_vec;
191}
192
193static clip_func ref_cliptest[5] = {
194   0,
195   0,
196   ref_cliptest_points2,
197   ref_cliptest_points3,
198   ref_cliptest_points4
199};
200
201
202/* =============================================================
203 * Cliptest tests
204 */
205
206ALIGN16(static GLfloat, s[TEST_COUNT][4]);
207ALIGN16(static GLfloat, d[TEST_COUNT][4]);
208ALIGN16(static GLfloat, r[TEST_COUNT][4]);
209
210
211static int test_cliptest_function( clip_func func, int np,
212				   int psize, long *cycles )
213{
214   GLvector4f source[1], dest[1], ref[1];
215   GLubyte dm[TEST_COUNT], dco, dca;
216   GLubyte rm[TEST_COUNT], rco, rca;
217   int i, j;
218#ifdef  RUN_DEBUG_BENCHMARK
219   int cycle_i;                /* the counter for the benchmarks we run */
220#endif
221   GLboolean viewport_z_clip = GL_TRUE;
222
223   (void) cycles;
224
225   if ( psize > 4 ) {
226      _mesa_problem( NULL, "test_cliptest_function called with psize > 4\n" );
227      return 0;
228   }
229
230   for ( i = 0 ; i < TEST_COUNT ; i++) {
231      ASSIGN_4V( d[i], 0.0, 0.0, 0.0, 1.0 );
232      ASSIGN_4V( s[i], 0.0, 0.0, 0.0, 1.0 );
233      for ( j = 0 ; j < psize ; j++ )
234         s[i][j] = rnd();
235   }
236
237   source->data = (GLfloat(*)[4])s;
238   source->start = (GLfloat *)s;
239   source->count = TEST_COUNT;
240   source->stride = sizeof(s[0]);
241   source->size = 4;
242   source->flags = 0;
243
244   dest->data = (GLfloat(*)[4])d;
245   dest->start = (GLfloat *)d;
246   dest->count = TEST_COUNT;
247   dest->stride = sizeof(float[4]);
248   dest->size = 0;
249   dest->flags = 0;
250
251   ref->data = (GLfloat(*)[4])r;
252   ref->start = (GLfloat *)r;
253   ref->count = TEST_COUNT;
254   ref->stride = sizeof(float[4]);
255   ref->size = 0;
256   ref->flags = 0;
257
258   dco = rco = 0;
259   dca = rca = CLIP_FRUSTUM_BITS;
260
261   ref_cliptest[psize]( source, ref, rm, &rco, &rca, viewport_z_clip );
262
263   if ( mesa_profile ) {
264      BEGIN_RACE( *cycles );
265      func( source, dest, dm, &dco, &dca, viewport_z_clip );
266      END_RACE( *cycles );
267   }
268   else {
269      func( source, dest, dm, &dco, &dca, viewport_z_clip );
270   }
271
272   if ( dco != rco ) {
273      printf( "\n-----------------------------\n" );
274      printf( "dco = 0x%02x   rco = 0x%02x\n", dco, rco );
275      return 0;
276   }
277   if ( dca != rca ) {
278      printf( "\n-----------------------------\n" );
279      printf( "dca = 0x%02x   rca = 0x%02x\n", dca, rca );
280      return 0;
281   }
282   for ( i = 0 ; i < TEST_COUNT ; i++ ) {
283      if ( dm[i] != rm[i] ) {
284	 printf( "\n-----------------------------\n" );
285	 printf( "(i = %i)\n", i );
286	 printf( "dm = 0x%02x   rm = 0x%02x\n", dm[i], rm[i] );
287	 return 0;
288      }
289   }
290
291   /* Only verify output on projected points4 case.  FIXME: Do we need
292    * to test other cases?
293    */
294   if ( np || psize < 4 )
295      return 1;
296
297   for ( i = 0 ; i < TEST_COUNT ; i++ ) {
298      for ( j = 0 ; j < 4 ; j++ ) {
299         if ( significand_match( d[i][j], r[i][j] ) < REQUIRED_PRECISION ) {
300            printf( "\n-----------------------------\n" );
301            printf( "(i = %i, j = %i)  dm = 0x%02x   rm = 0x%02x\n",
302		    i, j, dm[i], rm[i] );
303            printf( "%f \t %f \t [diff = %e - %i bit missed]\n",
304		    d[i][0], r[i][0], r[i][0]-d[i][0],
305		    MAX_PRECISION - significand_match( d[i][0], r[i][0] ) );
306            printf( "%f \t %f \t [diff = %e - %i bit missed]\n",
307		    d[i][1], r[i][1], r[i][1]-d[i][1],
308		    MAX_PRECISION - significand_match( d[i][1], r[i][1] ) );
309            printf( "%f \t %f \t [diff = %e - %i bit missed]\n",
310		    d[i][2], r[i][2], r[i][2]-d[i][2],
311		    MAX_PRECISION - significand_match( d[i][2], r[i][2] ) );
312            printf( "%f \t %f \t [diff = %e - %i bit missed]\n",
313		    d[i][3], r[i][3], r[i][3]-d[i][3],
314		    MAX_PRECISION - significand_match( d[i][3], r[i][3] ) );
315            return 0;
316         }
317      }
318   }
319
320   return 1;
321}
322
323void _math_test_all_cliptest_functions( char *description )
324{
325   int np, psize;
326   long benchmark_tab[2][4];
327   static int first_time = 1;
328
329   if ( first_time ) {
330      first_time = 0;
331      mesa_profile = _mesa_getenv( "MESA_PROFILE" );
332   }
333
334#ifdef RUN_DEBUG_BENCHMARK
335   if ( mesa_profile ) {
336      if ( !counter_overhead ) {
337	 INIT_COUNTER();
338	 printf( "counter overhead: %ld cycles\n\n", counter_overhead );
339      }
340      printf( "cliptest results after hooking in %s functions:\n", description );
341   }
342#endif
343
344#ifdef RUN_DEBUG_BENCHMARK
345   if ( mesa_profile ) {
346      printf( "\n\t" );
347      for ( psize = 2 ; psize <= 4 ; psize++ ) {
348	 printf( " p%d\t", psize );
349      }
350      printf( "\n--------------------------------------------------------\n\t" );
351   }
352#endif
353
354   for ( np = 0 ; np < 2 ; np++ ) {
355      for ( psize = 2 ; psize <= 4 ; psize++ ) {
356	 clip_func func = clip_tab[np][psize];
357	 long *cycles = &(benchmark_tab[np][psize-1]);
358
359	 if ( test_cliptest_function( func, np, psize, cycles ) == 0 ) {
360	    char buf[100];
361	    sprintf( buf, "%s[%d] failed test (%s)",
362		     cnames[np], psize, description );
363	    _mesa_problem( NULL, buf );
364	 }
365#ifdef RUN_DEBUG_BENCHMARK
366	 if ( mesa_profile )
367	    printf( " %li\t", benchmark_tab[np][psize-1] );
368#endif
369      }
370#ifdef RUN_DEBUG_BENCHMARK
371      if ( mesa_profile )
372	 printf( " | [%s]\n\t", cstrings[np] );
373#endif
374   }
375#ifdef RUN_DEBUG_BENCHMARK
376   if ( mesa_profile )
377      printf( "\n" );
378#endif
379}
380
381
382#endif /* DEBUG_MATH */
383