Merge branch 'mesa_7_5_branch' into mesa_7_6_branch
[mesa.git] / src / mesa / main / debug.c
1 /*
2 * Mesa 3-D graphics library
3 * Version: 6.5
4 *
5 * Copyright (C) 1999-2005 Brian Paul All Rights Reserved.
6 * Copyright (C) 2009 VMware, Inc. All Rights Reserved.
7 *
8 * Permission is hereby granted, free of charge, to any person obtaining a
9 * copy of this software and associated documentation files (the "Software"),
10 * to deal in the Software without restriction, including without limitation
11 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
12 * and/or sell copies of the Software, and to permit persons to whom the
13 * Software is furnished to do so, subject to the following conditions:
14 *
15 * The above copyright notice and this permission notice shall be included
16 * in all copies or substantial portions of the Software.
17 *
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
19 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
21 * BRIAN PAUL BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
22 * AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
23 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
24 */
25
26 #include "mtypes.h"
27 #include "attrib.h"
28 #include "colormac.h"
29 #include "context.h"
30 #include "hash.h"
31 #include "imports.h"
32 #include "debug.h"
33 #include "get.h"
34 #include "pixelstore.h"
35 #include "readpix.h"
36 #include "texgetimage.h"
37 #include "texobj.h"
38 #include "texformat.h"
39
40
41 /**
42 * Primitive names
43 */
44 const char *_mesa_prim_name[GL_POLYGON+4] = {
45 "GL_POINTS",
46 "GL_LINES",
47 "GL_LINE_LOOP",
48 "GL_LINE_STRIP",
49 "GL_TRIANGLES",
50 "GL_TRIANGLE_STRIP",
51 "GL_TRIANGLE_FAN",
52 "GL_QUADS",
53 "GL_QUAD_STRIP",
54 "GL_POLYGON",
55 "outside begin/end",
56 "inside unkown primitive",
57 "unknown state"
58 };
59
60 void
61 _mesa_print_state( const char *msg, GLuint state )
62 {
63 _mesa_debug(NULL,
64 "%s: (0x%x) %s%s%s%s%s%s%s%s%s%s%s%s%s%s%s%s%s%s%s%s%s%s%s%s\n",
65 msg,
66 state,
67 (state & _NEW_MODELVIEW) ? "ctx->ModelView, " : "",
68 (state & _NEW_PROJECTION) ? "ctx->Projection, " : "",
69 (state & _NEW_TEXTURE_MATRIX) ? "ctx->TextureMatrix, " : "",
70 (state & _NEW_COLOR_MATRIX) ? "ctx->ColorMatrix, " : "",
71 (state & _NEW_ACCUM) ? "ctx->Accum, " : "",
72 (state & _NEW_COLOR) ? "ctx->Color, " : "",
73 (state & _NEW_DEPTH) ? "ctx->Depth, " : "",
74 (state & _NEW_EVAL) ? "ctx->Eval/EvalMap, " : "",
75 (state & _NEW_FOG) ? "ctx->Fog, " : "",
76 (state & _NEW_HINT) ? "ctx->Hint, " : "",
77 (state & _NEW_LIGHT) ? "ctx->Light, " : "",
78 (state & _NEW_LINE) ? "ctx->Line, " : "",
79 (state & _NEW_PIXEL) ? "ctx->Pixel, " : "",
80 (state & _NEW_POINT) ? "ctx->Point, " : "",
81 (state & _NEW_POLYGON) ? "ctx->Polygon, " : "",
82 (state & _NEW_POLYGONSTIPPLE) ? "ctx->PolygonStipple, " : "",
83 (state & _NEW_SCISSOR) ? "ctx->Scissor, " : "",
84 (state & _NEW_TEXTURE) ? "ctx->Texture, " : "",
85 (state & _NEW_TRANSFORM) ? "ctx->Transform, " : "",
86 (state & _NEW_VIEWPORT) ? "ctx->Viewport, " : "",
87 (state & _NEW_PACKUNPACK) ? "ctx->Pack/Unpack, " : "",
88 (state & _NEW_ARRAY) ? "ctx->Array, " : "",
89 (state & _NEW_RENDERMODE) ? "ctx->RenderMode, " : "",
90 (state & _NEW_BUFFERS) ? "ctx->Visual, ctx->DrawBuffer,, " : "");
91 }
92
93
94
95 void
96 _mesa_print_tri_caps( const char *name, GLuint flags )
97 {
98 _mesa_debug(NULL,
99 "%s: (0x%x) %s%s%s%s%s%s%s%s%s%s%s%s%s%s%s\n",
100 name,
101 flags,
102 (flags & DD_FLATSHADE) ? "flat-shade, " : "",
103 (flags & DD_SEPARATE_SPECULAR) ? "separate-specular, " : "",
104 (flags & DD_TRI_LIGHT_TWOSIDE) ? "tri-light-twoside, " : "",
105 (flags & DD_TRI_TWOSTENCIL) ? "tri-twostencil, " : "",
106 (flags & DD_TRI_UNFILLED) ? "tri-unfilled, " : "",
107 (flags & DD_TRI_STIPPLE) ? "tri-stipple, " : "",
108 (flags & DD_TRI_OFFSET) ? "tri-offset, " : "",
109 (flags & DD_TRI_SMOOTH) ? "tri-smooth, " : "",
110 (flags & DD_LINE_SMOOTH) ? "line-smooth, " : "",
111 (flags & DD_LINE_STIPPLE) ? "line-stipple, " : "",
112 (flags & DD_LINE_WIDTH) ? "line-wide, " : "",
113 (flags & DD_POINT_SMOOTH) ? "point-smooth, " : "",
114 (flags & DD_POINT_SIZE) ? "point-size, " : "",
115 (flags & DD_POINT_ATTEN) ? "point-atten, " : "",
116 (flags & DD_TRI_CULL_FRONT_BACK) ? "cull-all, " : ""
117 );
118 }
119
120
121 /**
122 * Print information about this Mesa version and build options.
123 */
124 void _mesa_print_info( void )
125 {
126 _mesa_debug(NULL, "Mesa GL_VERSION = %s\n",
127 (char *) _mesa_GetString(GL_VERSION));
128 _mesa_debug(NULL, "Mesa GL_RENDERER = %s\n",
129 (char *) _mesa_GetString(GL_RENDERER));
130 _mesa_debug(NULL, "Mesa GL_VENDOR = %s\n",
131 (char *) _mesa_GetString(GL_VENDOR));
132 _mesa_debug(NULL, "Mesa GL_EXTENSIONS = %s\n",
133 (char *) _mesa_GetString(GL_EXTENSIONS));
134 #if defined(THREADS)
135 _mesa_debug(NULL, "Mesa thread-safe: YES\n");
136 #else
137 _mesa_debug(NULL, "Mesa thread-safe: NO\n");
138 #endif
139 #if defined(USE_X86_ASM)
140 _mesa_debug(NULL, "Mesa x86-optimized: YES\n");
141 #else
142 _mesa_debug(NULL, "Mesa x86-optimized: NO\n");
143 #endif
144 #if defined(USE_SPARC_ASM)
145 _mesa_debug(NULL, "Mesa sparc-optimized: YES\n");
146 #else
147 _mesa_debug(NULL, "Mesa sparc-optimized: NO\n");
148 #endif
149 }
150
151
152 /**
153 * Set the debugging flags.
154 *
155 * \param debug debug string
156 *
157 * If compiled with debugging support then search for keywords in \p debug and
158 * enables the verbose debug output of the respective feature.
159 */
160 static void add_debug_flags( const char *debug )
161 {
162 #ifdef DEBUG
163 struct debug_option {
164 const char *name;
165 GLbitfield flag;
166 };
167 static const struct debug_option debug_opt[] = {
168 { "varray", VERBOSE_VARRAY },
169 { "tex", VERBOSE_TEXTURE },
170 { "imm", VERBOSE_IMMEDIATE },
171 { "pipe", VERBOSE_PIPELINE },
172 { "driver", VERBOSE_DRIVER },
173 { "state", VERBOSE_STATE },
174 { "api", VERBOSE_API },
175 { "list", VERBOSE_DISPLAY_LIST },
176 { "lighting", VERBOSE_LIGHTING },
177 { "disassem", VERBOSE_DISASSEM }
178 };
179 GLuint i;
180
181 MESA_VERBOSE = 0x0;
182 for (i = 0; i < Elements(debug_opt); i++) {
183 if (_mesa_strstr(debug, debug_opt[i].name))
184 MESA_VERBOSE |= debug_opt[i].flag;
185 }
186
187 /* Debug flag:
188 */
189 if (_mesa_strstr(debug, "flush"))
190 MESA_DEBUG_FLAGS |= DEBUG_ALWAYS_FLUSH;
191
192 #if defined(_FPU_GETCW) && defined(_FPU_SETCW)
193 if (_mesa_strstr(debug, "fpexceptions")) {
194 /* raise FP exceptions */
195 fpu_control_t mask;
196 _FPU_GETCW(mask);
197 mask &= ~(_FPU_MASK_IM | _FPU_MASK_DM | _FPU_MASK_ZM
198 | _FPU_MASK_OM | _FPU_MASK_UM);
199 _FPU_SETCW(mask);
200 }
201 #endif
202
203 #else
204 (void) debug;
205 #endif
206 }
207
208
209 void
210 _mesa_init_debug( GLcontext *ctx )
211 {
212 char *c;
213
214 /* Dither disable */
215 ctx->NoDither = _mesa_getenv("MESA_NO_DITHER") ? GL_TRUE : GL_FALSE;
216 if (ctx->NoDither) {
217 if (_mesa_getenv("MESA_DEBUG")) {
218 _mesa_debug(ctx, "MESA_NO_DITHER set - dithering disabled\n");
219 }
220 ctx->Color.DitherFlag = GL_FALSE;
221 }
222
223 c = _mesa_getenv("MESA_DEBUG");
224 if (c)
225 add_debug_flags(c);
226
227 c = _mesa_getenv("MESA_VERBOSE");
228 if (c)
229 add_debug_flags(c);
230 }
231
232
233 /*
234 * Write ppm file
235 */
236 static void
237 write_ppm(const char *filename, const GLubyte *buffer, int width, int height,
238 int comps, int rcomp, int gcomp, int bcomp, GLboolean invert)
239 {
240 FILE *f = fopen( filename, "w" );
241 if (f) {
242 int x, y;
243 const GLubyte *ptr = buffer;
244 fprintf(f,"P6\n");
245 fprintf(f,"# ppm-file created by osdemo.c\n");
246 fprintf(f,"%i %i\n", width,height);
247 fprintf(f,"255\n");
248 fclose(f);
249 f = fopen( filename, "ab" ); /* reopen in binary append mode */
250 for (y=0; y < height; y++) {
251 for (x = 0; x < width; x++) {
252 int yy = invert ? (height - 1 - y) : y;
253 int i = (yy * width + x) * comps;
254 fputc(ptr[i+rcomp], f); /* write red */
255 fputc(ptr[i+gcomp], f); /* write green */
256 fputc(ptr[i+bcomp], f); /* write blue */
257 }
258 }
259 fclose(f);
260 }
261 }
262
263
264 /**
265 * Write level[0] image to a ppm file.
266 */
267 static void
268 write_texture_image(struct gl_texture_object *texObj, GLuint face, GLuint level)
269 {
270 struct gl_texture_image *img = texObj->Image[face][level];
271 if (img) {
272 GET_CURRENT_CONTEXT(ctx);
273 struct gl_pixelstore_attrib store;
274 GLubyte *buffer;
275 char s[100];
276
277 buffer = (GLubyte *) _mesa_malloc(img->Width * img->Height
278 * img->Depth * 4);
279
280 store = ctx->Pack; /* save */
281 ctx->Pack = ctx->DefaultPacking;
282
283 ctx->Driver.GetTexImage(ctx, texObj->Target, level,
284 GL_RGBA, GL_UNSIGNED_BYTE,
285 buffer, texObj, img);
286
287 /* make filename */
288 _mesa_sprintf(s, "/tmp/teximage%u.ppm", texObj->Name);
289
290 _mesa_printf(" Writing image level %u to %s\n", level, s);
291 write_ppm(s, buffer, img->Width, img->Height, 4, 0, 1, 2, GL_FALSE);
292
293 ctx->Pack = store; /* restore */
294
295 _mesa_free(buffer);
296 }
297 }
298
299
300 static GLboolean DumpImages;
301
302
303 static void
304 dump_texture_cb(GLuint id, void *data, void *userData)
305 {
306 struct gl_texture_object *texObj = (struct gl_texture_object *) data;
307 int i;
308 GLboolean written = GL_FALSE;
309 (void) userData;
310
311 _mesa_printf("Texture %u\n", texObj->Name);
312 _mesa_printf(" Target 0x%x\n", texObj->Target);
313 for (i = 0; i < MAX_TEXTURE_LEVELS; i++) {
314 struct gl_texture_image *texImg = texObj->Image[0][i];
315 if (texImg) {
316 _mesa_printf(" Image %u: %d x %d x %d, format %u at %p\n", i,
317 texImg->Width, texImg->Height, texImg->Depth,
318 texImg->TexFormat->MesaFormat, texImg->Data);
319 if (DumpImages && !written) {
320 GLuint face = 0;
321 write_texture_image(texObj, face, i);
322 written = GL_TRUE;
323 }
324 }
325 }
326 }
327
328
329 /**
330 * Print basic info about all texture objext to stdout.
331 * If dumpImages is true, write PPM of level[0] image to a file.
332 */
333 void
334 _mesa_dump_textures(GLboolean dumpImages)
335 {
336 GET_CURRENT_CONTEXT(ctx);
337 DumpImages = dumpImages;
338 _mesa_HashWalk(ctx->Shared->TexObjects, dump_texture_cb, ctx);
339 }
340
341
342 void
343 _mesa_dump_color_buffer(const char *filename)
344 {
345 GET_CURRENT_CONTEXT(ctx);
346 const GLuint w = ctx->DrawBuffer->Width;
347 const GLuint h = ctx->DrawBuffer->Height;
348 GLubyte *buf;
349
350 buf = (GLubyte *) _mesa_malloc(w * h * 4);
351
352 _mesa_PushClientAttrib(GL_CLIENT_PIXEL_STORE_BIT);
353 _mesa_PixelStorei(GL_PACK_ALIGNMENT, 1);
354 _mesa_PixelStorei(GL_PACK_INVERT_MESA, GL_TRUE);
355
356 _mesa_ReadPixels(0, 0, w, h, GL_RGBA, GL_UNSIGNED_BYTE, buf);
357
358 _mesa_printf("ReadBuffer %p 0x%x DrawBuffer %p 0x%x\n",
359 ctx->ReadBuffer->_ColorReadBuffer,
360 ctx->ReadBuffer->ColorReadBuffer,
361 ctx->DrawBuffer->_ColorDrawBuffers[0],
362 ctx->DrawBuffer->ColorDrawBuffer[0]);
363 _mesa_printf("Writing %d x %d color buffer to %s\n", w, h, filename);
364 write_ppm(filename, buf, w, h, 4, 0, 1, 2, GL_TRUE);
365
366 _mesa_PopClientAttrib();
367
368 _mesa_free(buf);
369 }
370
371
372 void
373 _mesa_dump_depth_buffer(const char *filename)
374 {
375 GET_CURRENT_CONTEXT(ctx);
376 const GLuint w = ctx->DrawBuffer->Width;
377 const GLuint h = ctx->DrawBuffer->Height;
378 GLuint *buf;
379 GLubyte *buf2;
380 GLuint i;
381
382 buf = (GLuint *) _mesa_malloc(w * h * 4); /* 4 bpp */
383 buf2 = (GLubyte *) _mesa_malloc(w * h * 3); /* 3 bpp */
384
385 _mesa_PushClientAttrib(GL_CLIENT_PIXEL_STORE_BIT);
386 _mesa_PixelStorei(GL_PACK_ALIGNMENT, 1);
387 _mesa_PixelStorei(GL_PACK_INVERT_MESA, GL_TRUE);
388
389 _mesa_ReadPixels(0, 0, w, h, GL_DEPTH_COMPONENT, GL_UNSIGNED_INT, buf);
390
391 /* spread 24 bits of Z across R, G, B */
392 for (i = 0; i < w * h; i++) {
393 buf2[i*3+0] = (buf[i] >> 24) & 0xff;
394 buf2[i*3+1] = (buf[i] >> 16) & 0xff;
395 buf2[i*3+2] = (buf[i] >> 8) & 0xff;
396 }
397
398 _mesa_printf("Writing %d x %d depth buffer to %s\n", w, h, filename);
399 write_ppm(filename, buf2, w, h, 3, 0, 1, 2, GL_TRUE);
400
401 _mesa_PopClientAttrib();
402
403 _mesa_free(buf);
404 _mesa_free(buf2);
405 }
406
407
408 void
409 _mesa_dump_stencil_buffer(const char *filename)
410 {
411 GET_CURRENT_CONTEXT(ctx);
412 const GLuint w = ctx->DrawBuffer->Width;
413 const GLuint h = ctx->DrawBuffer->Height;
414 GLubyte *buf;
415 GLubyte *buf2;
416 GLuint i;
417
418 buf = (GLubyte *) _mesa_malloc(w * h); /* 1 bpp */
419 buf2 = (GLubyte *) _mesa_malloc(w * h * 3); /* 3 bpp */
420
421 _mesa_PushClientAttrib(GL_CLIENT_PIXEL_STORE_BIT);
422 _mesa_PixelStorei(GL_PACK_ALIGNMENT, 1);
423 _mesa_PixelStorei(GL_PACK_INVERT_MESA, GL_TRUE);
424
425 _mesa_ReadPixels(0, 0, w, h, GL_STENCIL_INDEX, GL_UNSIGNED_BYTE, buf);
426
427 for (i = 0; i < w * h; i++) {
428 buf2[i*3+0] = buf[i];
429 buf2[i*3+1] = (buf[i] & 127) * 2;
430 buf2[i*3+2] = (buf[i] - 128) * 2;
431 }
432
433 _mesa_printf("Writing %d x %d stencil buffer to %s\n", w, h, filename);
434 write_ppm(filename, buf2, w, h, 3, 0, 1, 2, GL_TRUE);
435
436 _mesa_PopClientAttrib();
437
438 _mesa_free(buf);
439 _mesa_free(buf2);
440 }