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 "enums.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 "texgetimage.h"
  38 #include "texobj.h"
  39 #include "texformat.h"
  40
  41
  42 /**
  43  * Primitive names
  44  */
  45 const char *_mesa_prim_name[GL_POLYGON+4] = {
  46    "GL_POINTS",
  47    "GL_LINES",
  48    "GL_LINE_LOOP",
  49    "GL_LINE_STRIP",
  50    "GL_TRIANGLES",
  51    "GL_TRIANGLE_STRIP",
  52    "GL_TRIANGLE_FAN",
  53    "GL_QUADS",
  54    "GL_QUAD_STRIP",
  55    "GL_POLYGON",
  56    "outside begin/end",
  57    "inside unkown primitive",
  58    "unknown state"
  59 };
  60
  61 void
  62 _mesa_print_state( const char *msg, GLuint state )
  63 {
  64    _mesa_debug(NULL,
  65            "%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",
  66            msg,
  67            state,
  68            (state & _NEW_MODELVIEW)       ? "ctx->ModelView, " : "",
  69            (state & _NEW_PROJECTION)      ? "ctx->Projection, " : "",
  70            (state & _NEW_TEXTURE_MATRIX)  ? "ctx->TextureMatrix, " : "",
  71            (state & _NEW_COLOR_MATRIX)    ? "ctx->ColorMatrix, " : "",
  72            (state & _NEW_ACCUM)           ? "ctx->Accum, " : "",
  73            (state & _NEW_COLOR)           ? "ctx->Color, " : "",
  74            (state & _NEW_DEPTH)           ? "ctx->Depth, " : "",
  75            (state & _NEW_EVAL)            ? "ctx->Eval/EvalMap, " : "",
  76            (state & _NEW_FOG)             ? "ctx->Fog, " : "",
  77            (state & _NEW_HINT)            ? "ctx->Hint, " : "",
  78            (state & _NEW_LIGHT)           ? "ctx->Light, " : "",
  79            (state & _NEW_LINE)            ? "ctx->Line, " : "",
  80            (state & _NEW_PIXEL)           ? "ctx->Pixel, " : "",
  81            (state & _NEW_POINT)           ? "ctx->Point, " : "",
  82            (state & _NEW_POLYGON)         ? "ctx->Polygon, " : "",
  83            (state & _NEW_POLYGONSTIPPLE)  ? "ctx->PolygonStipple, " : "",
  84            (state & _NEW_SCISSOR)         ? "ctx->Scissor, " : "",
  85            (state & _NEW_TEXTURE)         ? "ctx->Texture, " : "",
  86            (state & _NEW_TRANSFORM)       ? "ctx->Transform, " : "",
  87            (state & _NEW_VIEWPORT)        ? "ctx->Viewport, " : "",
  88            (state & _NEW_PACKUNPACK)      ? "ctx->Pack/Unpack, " : "",
  89            (state & _NEW_ARRAY)           ? "ctx->Array, " : "",
  90            (state & _NEW_RENDERMODE)      ? "ctx->RenderMode, " : "",
  91            (state & _NEW_BUFFERS)         ? "ctx->Visual, ctx->DrawBuffer,, " : "");
  92 }
  93
  94
  95
  96 void
  97 _mesa_print_tri_caps( const char *name, GLuint flags )
  98 {
  99    _mesa_debug(NULL,
 100            "%s: (0x%x) %s%s%s%s%s%s%s%s%s%s%s%s%s%s%s\n",
 101            name,
 102            flags,
 103            (flags & DD_FLATSHADE)           ? "flat-shade, " : "",
 104            (flags & DD_SEPARATE_SPECULAR)   ? "separate-specular, " : "",
 105            (flags & DD_TRI_LIGHT_TWOSIDE)   ? "tri-light-twoside, " : "",
 106            (flags & DD_TRI_TWOSTENCIL)      ? "tri-twostencil, " : "",
 107            (flags & DD_TRI_UNFILLED)        ? "tri-unfilled, " : "",
 108            (flags & DD_TRI_STIPPLE)         ? "tri-stipple, " : "",
 109            (flags & DD_TRI_OFFSET)          ? "tri-offset, " : "",
 110            (flags & DD_TRI_SMOOTH)          ? "tri-smooth, " : "",
 111            (flags & DD_LINE_SMOOTH)         ? "line-smooth, " : "",
 112            (flags & DD_LINE_STIPPLE)        ? "line-stipple, " : "",
 113            (flags & DD_LINE_WIDTH)          ? "line-wide, " : "",
 114            (flags & DD_POINT_SMOOTH)        ? "point-smooth, " : "",
 115            (flags & DD_POINT_SIZE)          ? "point-size, " : "",
 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 (_mesa_strstr(debug, debug_opt[i].name))
 187          MESA_VERBOSE |= debug_opt[i].flag;
 188    }
 189
 190    /* Debug flag:
 191     */
 192    if (_mesa_strstr(debug, "flush"))
 193       MESA_DEBUG_FLAGS |= DEBUG_ALWAYS_FLUSH;
 194
 195 #if defined(_FPU_GETCW) && defined(_FPU_SETCW)
 196    if (_mesa_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( GLcontext *ctx )
 214 {
 215    char *c;
 216
 217    /* Dither disable */
 218    ctx->NoDither = _mesa_getenv("MESA_NO_DITHER") ? GL_TRUE : GL_FALSE;
 219    if (ctx->NoDither) {
 220       if (_mesa_getenv("MESA_DEBUG")) {
 221          _mesa_debug(ctx, "MESA_NO_DITHER set - dithering disabled\n");
 222       }
 223       ctx->Color.DitherFlag = GL_FALSE;
 224    }
 225
 226    c = _mesa_getenv("MESA_DEBUG");
 227    if (c)
 228       add_debug_flags(c);
 229
 230    c = _mesa_getenv("MESA_VERBOSE");
 231    if (c)
 232       add_debug_flags(c);
 233 }
 234
 235
 236 /*
 237  * Write ppm file
 238  */
 239 static void
 240 write_ppm(const char *filename, const GLubyte *buffer, int width, int height,
 241           int comps, int rcomp, int gcomp, int bcomp, GLboolean invert)
 242 {
 243    FILE *f = fopen( filename, "w" );
 244    if (f) {
 245       int x, y;
 246       const GLubyte *ptr = buffer;
 247       fprintf(f,"P6\n");
 248       fprintf(f,"# ppm-file created by osdemo.c\n");
 249       fprintf(f,"%i %i\n", width,height);
 250       fprintf(f,"255\n");
 251       fclose(f);
 252       f = fopen( filename, "ab" );  /* reopen in binary append mode */
 253       for (y=0; y < height; y++) {
 254          for (x = 0; x < width; x++) {
 255             int yy = invert ? (height - 1 - y) : y;
 256             int i = (yy * width + x) * comps;
 257             fputc(ptr[i+rcomp], f); /* write red */
 258             fputc(ptr[i+gcomp], f); /* write green */
 259             fputc(ptr[i+bcomp], f); /* write blue */
 260          }
 261       }
 262       fclose(f);
 263    }
 264 }
 265
 266
 267 /**
 268  * Write a texture image to a ppm file.
 269  * \param face  cube face in [0,5]
 270  * \param level  mipmap level
 271  */
 272 static void
 273 write_texture_image(struct gl_texture_object *texObj,
 274                     GLuint face, GLuint level)
 275 {
 276    struct gl_texture_image *img = texObj->Image[face][level];
 277    if (img) {
 278       GET_CURRENT_CONTEXT(ctx);
 279       struct gl_pixelstore_attrib store;
 280       GLubyte *buffer;
 281       char s[100];
 282
 283       buffer = (GLubyte *) _mesa_malloc(img->Width * img->Height
 284                                         * img->Depth * 4);
 285
 286       store = ctx->Pack; /* save */
 287       ctx->Pack = ctx->DefaultPacking;
 288
 289       ctx->Driver.GetTexImage(ctx, texObj->Target, level,
 290                               GL_RGBA, GL_UNSIGNED_BYTE,
 291                               buffer, texObj, img);
 292
 293       /* make filename */
 294       _mesa_sprintf(s, "/tmp/teximage%u.ppm", texObj->Name);
 295
 296       _mesa_printf("  Writing image level %u to %s\n", level, s);
 297       write_ppm(s, buffer, img->Width, img->Height, 4, 0, 1, 2, GL_FALSE);
 298
 299       ctx->Pack = store; /* restore */
 300
 301       _mesa_free(buffer);
 302    }
 303 }
 304
 305
 306 /**
 307  * Write renderbuffer image to a ppm file.
 308  */
 309 static void
 310 write_renderbuffer_image(const struct gl_renderbuffer *rb)
 311 {
 312    GET_CURRENT_CONTEXT(ctx);
 313    GLubyte *buffer;
 314    char s[100];
 315    GLenum format, type;
 316
 317    if (rb->_BaseFormat == GL_RGB ||
 318        rb->_BaseFormat == GL_RGBA) {
 319       format = GL_RGBA;
 320       type = GL_UNSIGNED_BYTE;
 321    }
 322    else if (rb->_BaseFormat == GL_DEPTH_STENCIL) {
 323       format = GL_DEPTH_STENCIL;
 324       type = GL_UNSIGNED_INT_24_8;
 325    }
 326    else {
 327       return;
 328    }
 329
 330    buffer = (GLubyte *) _mesa_malloc(rb->Width * rb->Height * 4);
 331
 332    ctx->Driver.ReadPixels(ctx, 0, 0, rb->Width, rb->Height,
 333                           format, type, &ctx->DefaultPacking, buffer);
 334
 335    /* make filename */
 336    _mesa_sprintf(s, "/tmp/renderbuffer%u.ppm", rb->Name);
 337
 338    _mesa_printf("  Writing renderbuffer image to %s\n", s);
 339    write_ppm(s, buffer, rb->Width, rb->Height, 4, 0, 1, 2, GL_TRUE);
 340
 341    _mesa_free(buffer);
 342 }
 343
 344
 345 static GLboolean DumpImages;
 346
 347
 348 static void
 349 dump_texture(struct gl_texture_object *texObj)
 350 {
 351    int i;
 352    GLboolean written = GL_FALSE;
 353
 354    _mesa_printf("Texture %u\n", texObj->Name);
 355    _mesa_printf("  Target 0x%x\n", texObj->Target);
 356    for (i = 0; i < MAX_TEXTURE_LEVELS; i++) {
 357       struct gl_texture_image *texImg = texObj->Image[0][i];
 358       if (texImg) {
 359          _mesa_printf("  Image %u: %d x %d x %d, format %u at %p\n", i,
 360                       texImg->Width, texImg->Height, texImg->Depth,
 361                       texImg->TexFormat->MesaFormat, texImg->Data);
 362          if (DumpImages && !written) {
 363             GLuint face = 0;
 364             write_texture_image(texObj, face, i);
 365             written = GL_TRUE;
 366          }
 367       }
 368    }
 369 }
 370
 371
 372 /**
 373  * Dump a single texture.
 374  */
 375 void
 376 _mesa_dump_texture(GLuint texture, GLboolean dumpImages)
 377 {
 378    GET_CURRENT_CONTEXT(ctx);
 379    struct gl_texture_object *texObj = _mesa_lookup_texture(ctx, texture);
 380    if (texObj) {
 381       DumpImages = dumpImages;
 382       dump_texture(texObj);
 383    }
 384 }
 385
 386
 387 static void
 388 dump_texture_cb(GLuint id, void *data, void *userData)
 389 {
 390    struct gl_texture_object *texObj = (struct gl_texture_object *) data;
 391    (void) userData;
 392    dump_texture(texObj);
 393 }
 394
 395
 396 /**
 397  * Print basic info about all texture objext to stdout.
 398  * If dumpImages is true, write PPM of level[0] image to a file.
 399  */
 400 void
 401 _mesa_dump_textures(GLboolean dumpImages)
 402 {
 403    GET_CURRENT_CONTEXT(ctx);
 404    DumpImages = dumpImages;
 405    _mesa_HashWalk(ctx->Shared->TexObjects, dump_texture_cb, ctx);
 406 }
 407
 408
 409 static void
 410 dump_renderbuffer_cb(GLuint id, void *data, void *userData)
 411 {
 412    const struct gl_renderbuffer *rb = (const struct gl_renderbuffer *) data;
 413    (void) userData;
 414
 415    _mesa_printf("Renderbuffer %u: %u x %u  IntFormat = %s\n",
 416                 rb->Name, rb->Width, rb->Height,
 417                 _mesa_lookup_enum_by_nr(rb->InternalFormat));
 418    if (DumpImages) {
 419       write_renderbuffer_image(rb);
 420    }
 421 }
 422
 423
 424 /**
 425  * Print basic info about all renderbuffers to stdout.
 426  * If dumpImages is true, write PPM of level[0] image to a file.
 427  */
 428 void
 429 _mesa_dump_renderbuffers(GLboolean dumpImages)
 430 {
 431    GET_CURRENT_CONTEXT(ctx);
 432    DumpImages = dumpImages;
 433    _mesa_HashWalk(ctx->Shared->RenderBuffers, dump_renderbuffer_cb, ctx);
 434 }
 435
 436
 437
 438 void
 439 _mesa_dump_color_buffer(const char *filename)
 440 {
 441    GET_CURRENT_CONTEXT(ctx);
 442    const GLuint w = ctx->DrawBuffer->Width;
 443    const GLuint h = ctx->DrawBuffer->Height;
 444    GLubyte *buf;
 445
 446    buf = (GLubyte *) _mesa_malloc(w * h * 4);
 447
 448    _mesa_PushClientAttrib(GL_CLIENT_PIXEL_STORE_BIT);
 449    _mesa_PixelStorei(GL_PACK_ALIGNMENT, 1);
 450    _mesa_PixelStorei(GL_PACK_INVERT_MESA, GL_TRUE);
 451
 452    _mesa_ReadPixels(0, 0, w, h, GL_RGBA, GL_UNSIGNED_BYTE, buf);
 453
 454    _mesa_printf("ReadBuffer %p 0x%x  DrawBuffer %p 0x%x\n",
 455                 ctx->ReadBuffer->_ColorReadBuffer,
 456                 ctx->ReadBuffer->ColorReadBuffer,
 457                 ctx->DrawBuffer->_ColorDrawBuffers[0],
 458                 ctx->DrawBuffer->ColorDrawBuffer[0]);
 459    _mesa_printf("Writing %d x %d color buffer to %s\n", w, h, filename);
 460    write_ppm(filename, buf, w, h, 4, 0, 1, 2, GL_TRUE);
 461
 462    _mesa_PopClientAttrib();
 463
 464    _mesa_free(buf);
 465 }
 466
 467
 468 void
 469 _mesa_dump_depth_buffer(const char *filename)
 470 {
 471    GET_CURRENT_CONTEXT(ctx);
 472    const GLuint w = ctx->DrawBuffer->Width;
 473    const GLuint h = ctx->DrawBuffer->Height;
 474    GLuint *buf;
 475    GLubyte *buf2;
 476    GLuint i;
 477
 478    buf = (GLuint *) _mesa_malloc(w * h * 4);  /* 4 bpp */
 479    buf2 = (GLubyte *) _mesa_malloc(w * h * 3); /* 3 bpp */
 480
 481    _mesa_PushClientAttrib(GL_CLIENT_PIXEL_STORE_BIT);
 482    _mesa_PixelStorei(GL_PACK_ALIGNMENT, 1);
 483    _mesa_PixelStorei(GL_PACK_INVERT_MESA, GL_TRUE);
 484
 485    _mesa_ReadPixels(0, 0, w, h, GL_DEPTH_COMPONENT, GL_UNSIGNED_INT, buf);
 486
 487    /* spread 24 bits of Z across R, G, B */
 488    for (i = 0; i < w * h; i++) {
 489       buf2[i*3+0] = (buf[i] >> 24) & 0xff;
 490       buf2[i*3+1] = (buf[i] >> 16) & 0xff;
 491       buf2[i*3+2] = (buf[i] >>  8) & 0xff;
 492    }
 493
 494    _mesa_printf("Writing %d x %d depth buffer to %s\n", w, h, filename);
 495    write_ppm(filename, buf2, w, h, 3, 0, 1, 2, GL_TRUE);
 496
 497    _mesa_PopClientAttrib();
 498
 499    _mesa_free(buf);
 500    _mesa_free(buf2);
 501 }
 502
 503
 504 void
 505 _mesa_dump_stencil_buffer(const char *filename)
 506 {
 507    GET_CURRENT_CONTEXT(ctx);
 508    const GLuint w = ctx->DrawBuffer->Width;
 509    const GLuint h = ctx->DrawBuffer->Height;
 510    GLubyte *buf;
 511    GLubyte *buf2;
 512    GLuint i;
 513
 514    buf = (GLubyte *) _mesa_malloc(w * h);  /* 1 bpp */
 515    buf2 = (GLubyte *) _mesa_malloc(w * h * 3); /* 3 bpp */
 516
 517    _mesa_PushClientAttrib(GL_CLIENT_PIXEL_STORE_BIT);
 518    _mesa_PixelStorei(GL_PACK_ALIGNMENT, 1);
 519    _mesa_PixelStorei(GL_PACK_INVERT_MESA, GL_TRUE);
 520
 521    _mesa_ReadPixels(0, 0, w, h, GL_STENCIL_INDEX, GL_UNSIGNED_BYTE, buf);
 522
 523    for (i = 0; i < w * h; i++) {
 524       buf2[i*3+0] = buf[i];
 525       buf2[i*3+1] = (buf[i] & 127) * 2;
 526       buf2[i*3+2] = (buf[i] - 128) * 2;
 527    }
 528
 529    _mesa_printf("Writing %d x %d stencil buffer to %s\n", w, h, filename);
 530    write_ppm(filename, buf2, w, h, 3, 0, 1, 2, GL_TRUE);
 531
 532    _mesa_PopClientAttrib();
 533
 534    _mesa_free(buf);
 535    _mesa_free(buf2);
 536 }