mesa: convert macros to inline functions
[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 "enums.h"
30 #include "formats.h"
31 #include "hash.h"
32 #include "imports.h"
33 #include "debug.h"
34 #include "get.h"
35 #include "pixelstore.h"
36 #include "readpix.h"
37 #include "texobj.h"
38
39
40 static const char *
41 tex_target_name(GLenum tgt)
42 {
43 static const struct {
44 GLenum target;
45 const char *name;
46 } tex_targets[] = {
47 { GL_TEXTURE_1D, "GL_TEXTURE_1D" },
48 { GL_TEXTURE_2D, "GL_TEXTURE_2D" },
49 { GL_TEXTURE_3D, "GL_TEXTURE_3D" },
50 { GL_TEXTURE_CUBE_MAP, "GL_TEXTURE_CUBE_MAP" },
51 { GL_TEXTURE_RECTANGLE, "GL_TEXTURE_RECTANGLE" },
52 { GL_TEXTURE_1D_ARRAY_EXT, "GL_TEXTURE_1D_ARRAY" },
53 { GL_TEXTURE_2D_ARRAY_EXT, "GL_TEXTURE_2D_ARRAY" }
54 };
55 GLuint i;
56 for (i = 0; i < Elements(tex_targets); i++) {
57 if (tex_targets[i].target == tgt)
58 return tex_targets[i].name;
59 }
60 return "UNKNOWN TEX TARGET";
61 }
62
63
64 void
65 _mesa_print_state( const char *msg, GLuint state )
66 {
67 _mesa_debug(NULL,
68 "%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\n",
69 msg,
70 state,
71 (state & _NEW_MODELVIEW) ? "ctx->ModelView, " : "",
72 (state & _NEW_PROJECTION) ? "ctx->Projection, " : "",
73 (state & _NEW_TEXTURE_MATRIX) ? "ctx->TextureMatrix, " : "",
74 (state & _NEW_COLOR) ? "ctx->Color, " : "",
75 (state & _NEW_DEPTH) ? "ctx->Depth, " : "",
76 (state & _NEW_EVAL) ? "ctx->Eval/EvalMap, " : "",
77 (state & _NEW_FOG) ? "ctx->Fog, " : "",
78 (state & _NEW_HINT) ? "ctx->Hint, " : "",
79 (state & _NEW_LIGHT) ? "ctx->Light, " : "",
80 (state & _NEW_LINE) ? "ctx->Line, " : "",
81 (state & _NEW_PIXEL) ? "ctx->Pixel, " : "",
82 (state & _NEW_POINT) ? "ctx->Point, " : "",
83 (state & _NEW_POLYGON) ? "ctx->Polygon, " : "",
84 (state & _NEW_POLYGONSTIPPLE) ? "ctx->PolygonStipple, " : "",
85 (state & _NEW_SCISSOR) ? "ctx->Scissor, " : "",
86 (state & _NEW_STENCIL) ? "ctx->Stencil, " : "",
87 (state & _NEW_TEXTURE) ? "ctx->Texture, " : "",
88 (state & _NEW_TRANSFORM) ? "ctx->Transform, " : "",
89 (state & _NEW_VIEWPORT) ? "ctx->Viewport, " : "",
90 (state & _NEW_PACKUNPACK) ? "ctx->Pack/Unpack, " : "",
91 (state & _NEW_ARRAY) ? "ctx->Array, " : "",
92 (state & _NEW_RENDERMODE) ? "ctx->RenderMode, " : "",
93 (state & _NEW_BUFFERS) ? "ctx->Visual, ctx->DrawBuffer,, " : "");
94 }
95
96
97
98 void
99 _mesa_print_tri_caps( const char *name, GLuint flags )
100 {
101 _mesa_debug(NULL,
102 "%s: (0x%x) %s%s%s%s%s%s%s%s%s%s%s%s%s\n",
103 name,
104 flags,
105 (flags & DD_FLATSHADE) ? "flat-shade, " : "",
106 (flags & DD_SEPARATE_SPECULAR) ? "separate-specular, " : "",
107 (flags & DD_TRI_LIGHT_TWOSIDE) ? "tri-light-twoside, " : "",
108 (flags & DD_TRI_TWOSTENCIL) ? "tri-twostencil, " : "",
109 (flags & DD_TRI_UNFILLED) ? "tri-unfilled, " : "",
110 (flags & DD_TRI_STIPPLE) ? "tri-stipple, " : "",
111 (flags & DD_TRI_OFFSET) ? "tri-offset, " : "",
112 (flags & DD_TRI_SMOOTH) ? "tri-smooth, " : "",
113 (flags & DD_LINE_SMOOTH) ? "line-smooth, " : "",
114 (flags & DD_LINE_STIPPLE) ? "line-stipple, " : "",
115 (flags & DD_POINT_SMOOTH) ? "point-smooth, " : "",
116 (flags & DD_POINT_ATTEN) ? "point-atten, " : "",
117 (flags & DD_TRI_CULL_FRONT_BACK) ? "cull-all, " : ""
118 );
119 }
120
121
122 /**
123 * Print information about this Mesa version and build options.
124 */
125 void _mesa_print_info( void )
126 {
127 _mesa_debug(NULL, "Mesa GL_VERSION = %s\n",
128 (char *) _mesa_GetString(GL_VERSION));
129 _mesa_debug(NULL, "Mesa GL_RENDERER = %s\n",
130 (char *) _mesa_GetString(GL_RENDERER));
131 _mesa_debug(NULL, "Mesa GL_VENDOR = %s\n",
132 (char *) _mesa_GetString(GL_VENDOR));
133 _mesa_debug(NULL, "Mesa GL_EXTENSIONS = %s\n",
134 (char *) _mesa_GetString(GL_EXTENSIONS));
135 #if defined(THREADS)
136 _mesa_debug(NULL, "Mesa thread-safe: YES\n");
137 #else
138 _mesa_debug(NULL, "Mesa thread-safe: NO\n");
139 #endif
140 #if defined(USE_X86_ASM)
141 _mesa_debug(NULL, "Mesa x86-optimized: YES\n");
142 #else
143 _mesa_debug(NULL, "Mesa x86-optimized: NO\n");
144 #endif
145 #if defined(USE_SPARC_ASM)
146 _mesa_debug(NULL, "Mesa sparc-optimized: YES\n");
147 #else
148 _mesa_debug(NULL, "Mesa sparc-optimized: NO\n");
149 #endif
150 }
151
152
153 /**
154 * Set the debugging flags.
155 *
156 * \param debug debug string
157 *
158 * If compiled with debugging support then search for keywords in \p debug and
159 * enables the verbose debug output of the respective feature.
160 */
161 static void add_debug_flags( const char *debug )
162 {
163 #ifdef DEBUG
164 struct debug_option {
165 const char *name;
166 GLbitfield flag;
167 };
168 static const struct debug_option debug_opt[] = {
169 { "varray", VERBOSE_VARRAY },
170 { "tex", VERBOSE_TEXTURE },
171 { "mat", VERBOSE_MATERIAL },
172 { "pipe", VERBOSE_PIPELINE },
173 { "driver", VERBOSE_DRIVER },
174 { "state", VERBOSE_STATE },
175 { "api", VERBOSE_API },
176 { "list", VERBOSE_DISPLAY_LIST },
177 { "lighting", VERBOSE_LIGHTING },
178 { "disassem", VERBOSE_DISASSEM },
179 { "draw", VERBOSE_DRAW },
180 { "swap", VERBOSE_SWAPBUFFERS }
181 };
182 GLuint i;
183
184 MESA_VERBOSE = 0x0;
185 for (i = 0; i < Elements(debug_opt); i++) {
186 if (strstr(debug, debug_opt[i].name))
187 MESA_VERBOSE |= debug_opt[i].flag;
188 }
189
190 /* Debug flag:
191 */
192 if (strstr(debug, "flush"))
193 MESA_DEBUG_FLAGS |= DEBUG_ALWAYS_FLUSH;
194
195 #if defined(_FPU_GETCW) && defined(_FPU_SETCW)
196 if (strstr(debug, "fpexceptions")) {
197 /* raise FP exceptions */
198 fpu_control_t mask;
199 _FPU_GETCW(mask);
200 mask &= ~(_FPU_MASK_IM | _FPU_MASK_DM | _FPU_MASK_ZM
201 | _FPU_MASK_OM | _FPU_MASK_UM);
202 _FPU_SETCW(mask);
203 }
204 #endif
205
206 #else
207 (void) debug;
208 #endif
209 }
210
211
212 void
213 _mesa_init_debug( struct gl_context *ctx )
214 {
215 char *c;
216 c = _mesa_getenv("MESA_DEBUG");
217 if (c)
218 add_debug_flags(c);
219
220 c = _mesa_getenv("MESA_VERBOSE");
221 if (c)
222 add_debug_flags(c);
223 }
224
225
226 /*
227 * Write ppm file
228 */
229 static void
230 write_ppm(const char *filename, const GLubyte *buffer, int width, int height,
231 int comps, int rcomp, int gcomp, int bcomp, GLboolean invert)
232 {
233 FILE *f = fopen( filename, "w" );
234 if (f) {
235 int x, y;
236 const GLubyte *ptr = buffer;
237 fprintf(f,"P6\n");
238 fprintf(f,"# ppm-file created by osdemo.c\n");
239 fprintf(f,"%i %i\n", width,height);
240 fprintf(f,"255\n");
241 fclose(f);
242 f = fopen( filename, "ab" ); /* reopen in binary append mode */
243 for (y=0; y < height; y++) {
244 for (x = 0; x < width; x++) {
245 int yy = invert ? (height - 1 - y) : y;
246 int i = (yy * width + x) * comps;
247 fputc(ptr[i+rcomp], f); /* write red */
248 fputc(ptr[i+gcomp], f); /* write green */
249 fputc(ptr[i+bcomp], f); /* write blue */
250 }
251 }
252 fclose(f);
253 }
254 }
255
256
257 /**
258 * Write a texture image to a ppm file.
259 * \param face cube face in [0,5]
260 * \param level mipmap level
261 */
262 static void
263 write_texture_image(struct gl_texture_object *texObj,
264 GLuint face, GLuint level)
265 {
266 struct gl_texture_image *img = texObj->Image[face][level];
267 if (img) {
268 GET_CURRENT_CONTEXT(ctx);
269 struct gl_pixelstore_attrib store;
270 GLubyte *buffer;
271 char s[100];
272
273 buffer = (GLubyte *) malloc(img->Width * img->Height
274 * img->Depth * 4);
275
276 store = ctx->Pack; /* save */
277 ctx->Pack = ctx->DefaultPacking;
278
279 ctx->Driver.GetTexImage(ctx, texObj->Target, level,
280 GL_RGBA, GL_UNSIGNED_BYTE,
281 buffer, texObj, img);
282
283 /* make filename */
284 _mesa_snprintf(s, sizeof(s), "/tmp/tex%u.l%u.f%u.ppm", texObj->Name, level, face);
285
286 printf(" Writing image level %u to %s\n", level, s);
287 write_ppm(s, buffer, img->Width, img->Height, 4, 0, 1, 2, GL_FALSE);
288
289 ctx->Pack = store; /* restore */
290
291 free(buffer);
292 }
293 }
294
295
296 /**
297 * Write renderbuffer image to a ppm file.
298 */
299 void
300 _mesa_write_renderbuffer_image(const struct gl_renderbuffer *rb)
301 {
302 GET_CURRENT_CONTEXT(ctx);
303 GLubyte *buffer;
304 char s[100];
305 GLenum format, type;
306
307 if (rb->_BaseFormat == GL_RGB ||
308 rb->_BaseFormat == GL_RGBA) {
309 format = GL_RGBA;
310 type = GL_UNSIGNED_BYTE;
311 }
312 else if (rb->_BaseFormat == GL_DEPTH_STENCIL) {
313 format = GL_DEPTH_STENCIL;
314 type = GL_UNSIGNED_INT_24_8;
315 }
316 else {
317 _mesa_debug(NULL,
318 "Unsupported BaseFormat 0x%x in "
319 "_mesa_write_renderbuffer_image()\n",
320 rb->_BaseFormat);
321 return;
322 }
323
324 buffer = (GLubyte *) malloc(rb->Width * rb->Height * 4);
325
326 ctx->Driver.ReadPixels(ctx, 0, 0, rb->Width, rb->Height,
327 format, type, &ctx->DefaultPacking, buffer);
328
329 /* make filename */
330 _mesa_snprintf(s, sizeof(s), "/tmp/renderbuffer%u.ppm", rb->Name);
331 _mesa_snprintf(s, sizeof(s), "C:\\renderbuffer%u.ppm", rb->Name);
332
333 printf(" Writing renderbuffer image to %s\n", s);
334
335 _mesa_debug(NULL, " Writing renderbuffer image to %s\n", s);
336
337 write_ppm(s, buffer, rb->Width, rb->Height, 4, 0, 1, 2, GL_TRUE);
338
339 free(buffer);
340 }
341
342
343 /** How many texture images (mipmap levels, faces) to write to files */
344 #define WRITE_NONE 0
345 #define WRITE_ONE 1
346 #define WRITE_ALL 2
347
348 static GLuint WriteImages;
349
350
351 static void
352 dump_texture(struct gl_texture_object *texObj, GLuint writeImages)
353 {
354 const GLuint numFaces = texObj->Target == GL_TEXTURE_CUBE_MAP ? 6 : 1;
355 GLboolean written = GL_FALSE;
356 GLuint i, j;
357
358 printf("Texture %u\n", texObj->Name);
359 printf(" Target %s\n", tex_target_name(texObj->Target));
360 for (i = 0; i < MAX_TEXTURE_LEVELS; i++) {
361 for (j = 0; j < numFaces; j++) {
362 struct gl_texture_image *texImg = texObj->Image[j][i];
363 if (texImg) {
364 printf(" Face %u level %u: %d x %d x %d, format %s at %p\n",
365 j, i,
366 texImg->Width, texImg->Height, texImg->Depth,
367 _mesa_get_format_name(texImg->TexFormat),
368 texImg->Data);
369 if (writeImages == WRITE_ALL ||
370 (writeImages == WRITE_ONE && !written)) {
371 write_texture_image(texObj, j, i);
372 written = GL_TRUE;
373 }
374 }
375 }
376 }
377 }
378
379
380 /**
381 * Dump a single texture.
382 */
383 void
384 _mesa_dump_texture(GLuint texture, GLuint writeImages)
385 {
386 GET_CURRENT_CONTEXT(ctx);
387 struct gl_texture_object *texObj = _mesa_lookup_texture(ctx, texture);
388 if (texObj) {
389 dump_texture(texObj, writeImages);
390 }
391 }
392
393
394 static void
395 dump_texture_cb(GLuint id, void *data, void *userData)
396 {
397 struct gl_texture_object *texObj = (struct gl_texture_object *) data;
398 (void) userData;
399 dump_texture(texObj, WriteImages);
400 }
401
402
403 /**
404 * Print basic info about all texture objext to stdout.
405 * If dumpImages is true, write PPM of level[0] image to a file.
406 */
407 void
408 _mesa_dump_textures(GLuint writeImages)
409 {
410 GET_CURRENT_CONTEXT(ctx);
411 WriteImages = writeImages;
412 _mesa_HashWalk(ctx->Shared->TexObjects, dump_texture_cb, ctx);
413 }
414
415
416 static void
417 dump_renderbuffer(const struct gl_renderbuffer *rb, GLboolean writeImage)
418 {
419 printf("Renderbuffer %u: %u x %u IntFormat = %s\n",
420 rb->Name, rb->Width, rb->Height,
421 _mesa_lookup_enum_by_nr(rb->InternalFormat));
422 if (writeImage) {
423 _mesa_write_renderbuffer_image(rb);
424 }
425 }
426
427
428 static void
429 dump_renderbuffer_cb(GLuint id, void *data, void *userData)
430 {
431 const struct gl_renderbuffer *rb = (const struct gl_renderbuffer *) data;
432 (void) userData;
433 dump_renderbuffer(rb, WriteImages);
434 }
435
436
437 /**
438 * Print basic info about all renderbuffers to stdout.
439 * If dumpImages is true, write PPM of level[0] image to a file.
440 */
441 void
442 _mesa_dump_renderbuffers(GLboolean writeImages)
443 {
444 GET_CURRENT_CONTEXT(ctx);
445 WriteImages = writeImages;
446 _mesa_HashWalk(ctx->Shared->RenderBuffers, dump_renderbuffer_cb, ctx);
447 }
448
449
450
451 void
452 _mesa_dump_color_buffer(const char *filename)
453 {
454 GET_CURRENT_CONTEXT(ctx);
455 const GLuint w = ctx->DrawBuffer->Width;
456 const GLuint h = ctx->DrawBuffer->Height;
457 GLubyte *buf;
458
459 buf = (GLubyte *) malloc(w * h * 4);
460
461 _mesa_PushClientAttrib(GL_CLIENT_PIXEL_STORE_BIT);
462 _mesa_PixelStorei(GL_PACK_ALIGNMENT, 1);
463 _mesa_PixelStorei(GL_PACK_INVERT_MESA, GL_TRUE);
464
465 _mesa_ReadPixels(0, 0, w, h, GL_RGBA, GL_UNSIGNED_BYTE, buf);
466
467 printf("ReadBuffer %p 0x%x DrawBuffer %p 0x%x\n",
468 (void *) ctx->ReadBuffer->_ColorReadBuffer,
469 ctx->ReadBuffer->ColorReadBuffer,
470 (void *) ctx->DrawBuffer->_ColorDrawBuffers[0],
471 ctx->DrawBuffer->ColorDrawBuffer[0]);
472 printf("Writing %d x %d color buffer to %s\n", w, h, filename);
473 write_ppm(filename, buf, w, h, 4, 0, 1, 2, GL_TRUE);
474
475 _mesa_PopClientAttrib();
476
477 free(buf);
478 }
479
480
481 void
482 _mesa_dump_depth_buffer(const char *filename)
483 {
484 GET_CURRENT_CONTEXT(ctx);
485 const GLuint w = ctx->DrawBuffer->Width;
486 const GLuint h = ctx->DrawBuffer->Height;
487 GLuint *buf;
488 GLubyte *buf2;
489 GLuint i;
490
491 buf = (GLuint *) malloc(w * h * 4); /* 4 bpp */
492 buf2 = (GLubyte *) malloc(w * h * 3); /* 3 bpp */
493
494 _mesa_PushClientAttrib(GL_CLIENT_PIXEL_STORE_BIT);
495 _mesa_PixelStorei(GL_PACK_ALIGNMENT, 1);
496 _mesa_PixelStorei(GL_PACK_INVERT_MESA, GL_TRUE);
497
498 _mesa_ReadPixels(0, 0, w, h, GL_DEPTH_COMPONENT, GL_UNSIGNED_INT, buf);
499
500 /* spread 24 bits of Z across R, G, B */
501 for (i = 0; i < w * h; i++) {
502 buf2[i*3+0] = (buf[i] >> 24) & 0xff;
503 buf2[i*3+1] = (buf[i] >> 16) & 0xff;
504 buf2[i*3+2] = (buf[i] >> 8) & 0xff;
505 }
506
507 printf("Writing %d x %d depth buffer to %s\n", w, h, filename);
508 write_ppm(filename, buf2, w, h, 3, 0, 1, 2, GL_TRUE);
509
510 _mesa_PopClientAttrib();
511
512 free(buf);
513 free(buf2);
514 }
515
516
517 void
518 _mesa_dump_stencil_buffer(const char *filename)
519 {
520 GET_CURRENT_CONTEXT(ctx);
521 const GLuint w = ctx->DrawBuffer->Width;
522 const GLuint h = ctx->DrawBuffer->Height;
523 GLubyte *buf;
524 GLubyte *buf2;
525 GLuint i;
526
527 buf = (GLubyte *) malloc(w * h); /* 1 bpp */
528 buf2 = (GLubyte *) malloc(w * h * 3); /* 3 bpp */
529
530 _mesa_PushClientAttrib(GL_CLIENT_PIXEL_STORE_BIT);
531 _mesa_PixelStorei(GL_PACK_ALIGNMENT, 1);
532 _mesa_PixelStorei(GL_PACK_INVERT_MESA, GL_TRUE);
533
534 _mesa_ReadPixels(0, 0, w, h, GL_STENCIL_INDEX, GL_UNSIGNED_BYTE, buf);
535
536 for (i = 0; i < w * h; i++) {
537 buf2[i*3+0] = buf[i];
538 buf2[i*3+1] = (buf[i] & 127) * 2;
539 buf2[i*3+2] = (buf[i] - 128) * 2;
540 }
541
542 printf("Writing %d x %d stencil buffer to %s\n", w, h, filename);
543 write_ppm(filename, buf2, w, h, 3, 0, 1, 2, GL_TRUE);
544
545 _mesa_PopClientAttrib();
546
547 free(buf);
548 free(buf2);
549 }
550
551
552 /**
553 * Quick and dirty function to "print" a texture to stdout.
554 */
555 void
556 _mesa_print_texture(struct gl_context *ctx, const struct gl_texture_image *img)
557 {
558 #if CHAN_TYPE != GL_UNSIGNED_BYTE
559 _mesa_problem(NULL, "PrintTexture not supported");
560 #else
561 GLuint i, j, c;
562 const GLubyte *data = (const GLubyte *) img->Data;
563
564 if (!data) {
565 printf("No texture data\n");
566 return;
567 }
568
569 /* XXX add more formats or make into a new format utility function */
570 switch (img->TexFormat) {
571 case MESA_FORMAT_A8:
572 case MESA_FORMAT_L8:
573 case MESA_FORMAT_I8:
574 case MESA_FORMAT_CI8:
575 c = 1;
576 break;
577 case MESA_FORMAT_AL88:
578 case MESA_FORMAT_AL88_REV:
579 c = 2;
580 break;
581 case MESA_FORMAT_RGB888:
582 case MESA_FORMAT_BGR888:
583 c = 3;
584 break;
585 case MESA_FORMAT_RGBA8888:
586 case MESA_FORMAT_ARGB8888:
587 c = 4;
588 break;
589 default:
590 _mesa_problem(NULL, "error in PrintTexture\n");
591 return;
592 }
593
594 for (i = 0; i < img->Height; i++) {
595 for (j = 0; j < img->Width; j++) {
596 if (c==1)
597 printf("%02x ", data[0]);
598 else if (c==2)
599 printf("%02x%02x ", data[0], data[1]);
600 else if (c==3)
601 printf("%02x%02x%02x ", data[0], data[1], data[2]);
602 else if (c==4)
603 printf("%02x%02x%02x%02x ", data[0], data[1], data[2], data[3]);
604 data += (img->RowStride - img->Width) * c;
605 }
606 /* XXX use img->ImageStride here */
607 printf("\n");
608 }
609 #endif
610 }