src/gallium/auxiliary/util/u_debug.c

   1 /**************************************************************************
   2  *
   3  * Copyright 2008 Tungsten Graphics, Inc., Cedar Park, Texas.
   4  * Copyright (c) 2008 VMware, Inc.
   5  * 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
   9  * "Software"), to deal in the Software without restriction, including
  10  * without limitation the rights to use, copy, modify, merge, publish,
  11  * distribute, sub license, and/or sell copies of the Software, and to
  12  * permit persons to whom the Software is furnished to do so, subject to
  13  * the following conditions:
  14  *
  15  * The above copyright notice and this permission notice (including the
  16  * next paragraph) shall be included in all copies or substantial portions
  17  * of the Software.
  18  *
  19  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  20  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  21  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
  22  * IN NO EVENT SHALL TUNGSTEN GRAPHICS AND/OR ITS SUPPLIERS BE LIABLE FOR
  23  * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
  24  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
  25  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  26  *
  27  **************************************************************************/
  28
  29
  30 #include "pipe/p_config.h"
  31
  32 #include "pipe/p_compiler.h"
  33 #include "os/os_stream.h"
  34 #include "util/u_debug.h"
  35 #include "pipe/p_format.h"
  36 #include "pipe/p_state.h"
  37 #include "util/u_inlines.h"
  38 #include "util/u_format.h"
  39 #include "util/u_memory.h"
  40 #include "util/u_string.h"
  41 #include "util/u_math.h"
  42 #include "util/u_tile.h"
  43 #include "util/u_prim.h"
  44 #include "util/u_surface.h"
  45
  46 #include <limits.h> /* CHAR_BIT */
  47
  48 void _debug_vprintf(const char *format, va_list ap)
  49 {
  50 #if defined(PIPE_OS_WINDOWS) || defined(PIPE_OS_EMBEDDED)
  51    /* We buffer until we find a newline. */
  52    static char buf[4096] = {'\0'};
  53    size_t len = strlen(buf);
  54    int ret = util_vsnprintf(buf + len, sizeof(buf) - len, format, ap);
  55    if(ret > (int)(sizeof(buf) - len - 1) || util_strchr(buf + len, '\n')) {
  56       os_log_message(buf);
  57       buf[0] = '\0';
  58    }
  59 #else
  60    /* Just print as-is to stderr */
  61    vfprintf(stderr, format, ap);
  62 #endif
  63 }
  64
  65
  66 #ifdef DEBUG
  67 void debug_print_blob( const char *name,
  68                        const void *blob,
  69                        unsigned size )
  70 {
  71    const unsigned *ublob = (const unsigned *)blob;
  72    unsigned i;
  73
  74    debug_printf("%s (%d dwords%s)\n", name, size/4,
  75                 size%4 ? "... plus a few bytes" : "");
  76
  77    for (i = 0; i < size/4; i++) {
  78       debug_printf("%d:\t%08x\n", i, ublob[i]);
  79    }
  80 }
  81 #endif
  82
  83
  84 static boolean
  85 debug_get_option_should_print(void)
  86 {
  87    static boolean first = TRUE;
  88    static boolean value = FALSE;
  89
  90    if (!first)
  91       return value;
  92
  93    /* Oh hey this will call into this function,
  94     * but its cool since we set first to false
  95     */
  96    first = FALSE;
  97    value = debug_get_bool_option("GALLIUM_PRINT_OPTIONS", FALSE);
  98    /* XXX should we print this option? Currently it wont */
  99    return value;
 100 }
 101
 102 const char *
 103 debug_get_option(const char *name, const char *dfault)
 104 {
 105    const char *result;
 106
 107    result = os_get_option(name);
 108    if(!result)
 109       result = dfault;
 110
 111    if (debug_get_option_should_print())
 112       debug_printf("%s: %s = %s\n", __FUNCTION__, name, result ? result : "(null)");
 113
 114    return result;
 115 }
 116
 117 boolean
 118 debug_get_bool_option(const char *name, boolean dfault)
 119 {
 120    const char *str = os_get_option(name);
 121    boolean result;
 122
 123    if(str == NULL)
 124       result = dfault;
 125    else if(!util_strcmp(str, "n"))
 126       result = FALSE;
 127    else if(!util_strcmp(str, "no"))
 128       result = FALSE;
 129    else if(!util_strcmp(str, "0"))
 130       result = FALSE;
 131    else if(!util_strcmp(str, "f"))
 132       result = FALSE;
 133    else if(!util_strcmp(str, "F"))
 134       result = FALSE;
 135    else if(!util_strcmp(str, "false"))
 136       result = FALSE;
 137    else if(!util_strcmp(str, "FALSE"))
 138       result = FALSE;
 139    else
 140       result = TRUE;
 141
 142    if (debug_get_option_should_print())
 143       debug_printf("%s: %s = %s\n", __FUNCTION__, name, result ? "TRUE" : "FALSE");
 144
 145    return result;
 146 }
 147
 148
 149 long
 150 debug_get_num_option(const char *name, long dfault)
 151 {
 152    long result;
 153    const char *str;
 154
 155    str = os_get_option(name);
 156    if(!str)
 157       result = dfault;
 158    else {
 159       long sign;
 160       char c;
 161       c = *str++;
 162       if(c == '-') {
 163          sign = -1;
 164          c = *str++;
 165       }
 166       else {
 167          sign = 1;
 168       }
 169       result = 0;
 170       while('0' <= c && c <= '9') {
 171          result = result*10 + (c - '0');
 172          c = *str++;
 173       }
 174       result *= sign;
 175    }
 176
 177    if (debug_get_option_should_print())
 178       debug_printf("%s: %s = %li\n", __FUNCTION__, name, result);
 179
 180    return result;
 181 }
 182
 183
 184 unsigned long
 185 debug_get_flags_option(const char *name,
 186                        const struct debug_named_value *flags,
 187                        unsigned long dfault)
 188 {
 189    unsigned long result;
 190    const char *str;
 191    const struct debug_named_value *orig = flags;
 192    int namealign = 0;
 193
 194    str = os_get_option(name);
 195    if(!str)
 196       result = dfault;
 197    else if (!util_strcmp(str, "help")) {
 198       result = dfault;
 199       _debug_printf("%s: help for %s:\n", __FUNCTION__, name);
 200       for (; flags->name; ++flags)
 201          namealign = MAX2(namealign, strlen(flags->name));
 202       for (flags = orig; flags->name; ++flags)
 203          _debug_printf("| %*s [0x%0*lx]%s%s\n", namealign, flags->name,
 204                       (int)sizeof(unsigned long)*CHAR_BIT/4, flags->value,
 205                       flags->desc ? " " : "", flags->desc ? flags->desc : "");
 206    }
 207    else {
 208       result = 0;
 209       while( flags->name ) {
 210          if (!util_strcmp(str, "all") || util_strstr(str, flags->name ))
 211             result |= flags->value;
 212          ++flags;
 213       }
 214    }
 215
 216    if (debug_get_option_should_print()) {
 217       if (str) {
 218          debug_printf("%s: %s = 0x%lx (%s)\n", __FUNCTION__, name, result, str);
 219       } else {
 220          debug_printf("%s: %s = 0x%lx\n", __FUNCTION__, name, result);
 221       }
 222    }
 223
 224    return result;
 225 }
 226
 227
 228 void _debug_assert_fail(const char *expr,
 229                         const char *file,
 230                         unsigned line,
 231                         const char *function)
 232 {
 233    _debug_printf("%s:%u:%s: Assertion `%s' failed.\n", file, line, function, expr);
 234 #if defined(PIPE_OS_WINDOWS) && !defined(PIPE_SUBSYSTEM_WINDOWS_USER)
 235    if (debug_get_bool_option("GALLIUM_ABORT_ON_ASSERT", FALSE))
 236 #else
 237    if (debug_get_bool_option("GALLIUM_ABORT_ON_ASSERT", TRUE))
 238 #endif
 239       os_abort();
 240    else
 241       _debug_printf("continuing...\n");
 242 }
 243
 244
 245 const char *
 246 debug_dump_enum(const struct debug_named_value *names,
 247                 unsigned long value)
 248 {
 249    static char rest[64];
 250
 251    while(names->name) {
 252       if(names->value == value)
 253          return names->name;
 254       ++names;
 255    }
 256
 257    util_snprintf(rest, sizeof(rest), "0x%08lx", value);
 258    return rest;
 259 }
 260
 261
 262 const char *
 263 debug_dump_enum_noprefix(const struct debug_named_value *names,
 264                          const char *prefix,
 265                          unsigned long value)
 266 {
 267    static char rest[64];
 268
 269    while(names->name) {
 270       if(names->value == value) {
 271          const char *name = names->name;
 272          while (*name == *prefix) {
 273             name++;
 274             prefix++;
 275          }
 276          return name;
 277       }
 278       ++names;
 279    }
 280
 281
 282
 283    util_snprintf(rest, sizeof(rest), "0x%08lx", value);
 284    return rest;
 285 }
 286
 287
 288 const char *
 289 debug_dump_flags(const struct debug_named_value *names,
 290                  unsigned long value)
 291 {
 292    static char output[4096];
 293    static char rest[256];
 294    int first = 1;
 295
 296    output[0] = '\0';
 297
 298    while(names->name) {
 299       if((names->value & value) == names->value) {
 300          if (!first)
 301             util_strncat(output, "|", sizeof(output));
 302          else
 303             first = 0;
 304          util_strncat(output, names->name, sizeof(output) - 1);
 305          output[sizeof(output) - 1] = '\0';
 306          value &= ~names->value;
 307       }
 308       ++names;
 309    }
 310
 311    if (value) {
 312       if (!first)
 313          util_strncat(output, "|", sizeof(output));
 314       else
 315          first = 0;
 316
 317       util_snprintf(rest, sizeof(rest), "0x%08lx", value);
 318       util_strncat(output, rest, sizeof(output) - 1);
 319       output[sizeof(output) - 1] = '\0';
 320    }
 321
 322    if(first)
 323       return "0";
 324
 325    return output;
 326 }
 327
 328
 329 #ifdef DEBUG
 330 void debug_print_format(const char *msg, unsigned fmt )
 331 {
 332    debug_printf("%s: %s\n", msg, util_format_name(fmt));
 333 }
 334 #endif
 335
 336
 337
 338 static const struct debug_named_value pipe_prim_names[] = {
 339 #ifdef DEBUG
 340    DEBUG_NAMED_VALUE(PIPE_PRIM_POINTS),
 341    DEBUG_NAMED_VALUE(PIPE_PRIM_LINES),
 342    DEBUG_NAMED_VALUE(PIPE_PRIM_LINE_LOOP),
 343    DEBUG_NAMED_VALUE(PIPE_PRIM_LINE_STRIP),
 344    DEBUG_NAMED_VALUE(PIPE_PRIM_TRIANGLES),
 345    DEBUG_NAMED_VALUE(PIPE_PRIM_TRIANGLE_STRIP),
 346    DEBUG_NAMED_VALUE(PIPE_PRIM_TRIANGLE_FAN),
 347    DEBUG_NAMED_VALUE(PIPE_PRIM_QUADS),
 348    DEBUG_NAMED_VALUE(PIPE_PRIM_QUAD_STRIP),
 349    DEBUG_NAMED_VALUE(PIPE_PRIM_POLYGON),
 350 #endif
 351    DEBUG_NAMED_VALUE_END
 352 };
 353
 354
 355 const char *u_prim_name( unsigned prim )
 356 {
 357    return debug_dump_enum(pipe_prim_names, prim);
 358 }
 359
 360
 361
 362
 363 #ifdef DEBUG
 364 /**
 365  * Dump an image to a .raw or .ppm file (depends on OS).
 366  * \param format  PIPE_FORMAT_x
 367  * \param cpp  bytes per pixel
 368  * \param width  width in pixels
 369  * \param height height in pixels
 370  * \param stride  row stride in bytes
 371  */
 372 void debug_dump_image(const char *prefix,
 373                       unsigned format, unsigned cpp,
 374                       unsigned width, unsigned height,
 375                       unsigned stride,
 376                       const void *data)
 377 {
 378 #ifdef PIPE_SUBSYSTEM_WINDOWS_DISPLAY
 379    static unsigned no = 0;
 380    char filename[256];
 381    WCHAR wfilename[sizeof(filename)];
 382    ULONG_PTR iFile = 0;
 383    struct {
 384       unsigned format;
 385       unsigned cpp;
 386       unsigned width;
 387       unsigned height;
 388    } header;
 389    unsigned char *pMap = NULL;
 390    unsigned i;
 391
 392    util_snprintf(filename, sizeof(filename), "\\??\\c:\\%03u%s.raw", ++no, prefix);
 393    for(i = 0; i < sizeof(filename); ++i)
 394       wfilename[i] = (WCHAR)filename[i];
 395
 396    pMap = (unsigned char *)EngMapFile(wfilename, sizeof(header) + height*width*cpp, &iFile);
 397    if(!pMap)
 398       return;
 399
 400    header.format = format;
 401    header.cpp = cpp;
 402    header.width = width;
 403    header.height = height;
 404    memcpy(pMap, &header, sizeof(header));
 405    pMap += sizeof(header);
 406
 407    for(i = 0; i < height; ++i) {
 408       memcpy(pMap, (unsigned char *)data + stride*i, cpp*width);
 409       pMap += cpp*width;
 410    }
 411
 412    EngUnmapFile(iFile);
 413 #elif defined(PIPE_OS_UNIX)
 414    /* write a ppm file */
 415    char filename[256];
 416    FILE *f;
 417
 418    util_snprintf(filename, sizeof(filename), "%s.ppm", prefix);
 419
 420    f = fopen(filename, "w");
 421    if (f) {
 422       int i, x, y;
 423       int r, g, b;
 424       const uint8_t *ptr = (uint8_t *) data;
 425
 426       /* XXX this is a hack */
 427       switch (format) {
 428       case PIPE_FORMAT_B8G8R8A8_UNORM:
 429          r = 2;
 430          g = 1;
 431          b = 0;
 432          break;
 433       default:
 434          r = 0;
 435          g = 1;
 436          b = 1;
 437       }
 438
 439       fprintf(f, "P6\n");
 440       fprintf(f, "# ppm-file created by osdemo.c\n");
 441       fprintf(f, "%i %i\n", width, height);
 442       fprintf(f, "255\n");
 443       fclose(f);
 444
 445       f = fopen(filename, "ab");  /* reopen in binary append mode */
 446       for (y = 0; y < height; y++) {
 447          for (x = 0; x < width; x++) {
 448             i = y * stride + x * cpp;
 449             fputc(ptr[i + r], f); /* write red */
 450             fputc(ptr[i + g], f); /* write green */
 451             fputc(ptr[i + b], f); /* write blue */
 452          }
 453       }
 454       fclose(f);
 455    }
 456    else {
 457       fprintf(stderr, "Can't open %s for writing\n", filename);
 458    }
 459 #endif
 460 }
 461
 462 /* FIXME: dump resources, not surfaces... */
 463 void debug_dump_surface(struct pipe_context *pipe,
 464                         const char *prefix,
 465                         struct pipe_surface *surface)
 466 {
 467    struct pipe_resource *texture;
 468    struct pipe_transfer *transfer;
 469    void *data;
 470
 471    if (!surface)
 472       return;
 473
 474    /* XXX: this doesn't necessarily work, as the driver may be using
 475     * temporary storage for the surface which hasn't been propagated
 476     * back into the texture.  Need to nail down the semantics of views
 477     * and transfers a bit better before we can say if extra work needs
 478     * to be done here:
 479     */
 480    texture = surface->texture;
 481
 482    transfer = pipe_get_transfer(pipe, texture, surface->u.tex.level,
 483                                 surface->u.tex.first_layer,
 484                                 PIPE_TRANSFER_READ,
 485                                 0, 0, surface->width, surface->height);
 486
 487    data = pipe->transfer_map(pipe, transfer);
 488    if(!data)
 489       goto error;
 490
 491    debug_dump_image(prefix,
 492                     texture->format,
 493                     util_format_get_blocksize(texture->format),
 494                     util_format_get_nblocksx(texture->format, surface->width),
 495                     util_format_get_nblocksy(texture->format, surface->height),
 496                     transfer->stride,
 497                     data);
 498
 499    pipe->transfer_unmap(pipe, transfer);
 500 error:
 501    pipe->transfer_destroy(pipe, transfer);
 502 }
 503
 504
 505 void debug_dump_texture(struct pipe_context *pipe,
 506                         const char *prefix,
 507                         struct pipe_resource *texture)
 508 {
 509    struct pipe_surface *surface, surf_tmpl;
 510
 511    if (!texture)
 512       return;
 513
 514    /* XXX for now, just dump image for layer=0, level=0 */
 515    memset(&surf_tmpl, 0, sizeof(surf_tmpl));
 516    u_surface_default_template(&surf_tmpl, texture, 0 /* no bind flag - not a surface */);
 517    surface = pipe->create_surface(pipe, texture, &surf_tmpl);
 518    if (surface) {
 519       debug_dump_surface(pipe, prefix, surface);
 520       pipe->surface_destroy(pipe, surface);
 521    }
 522 }
 523
 524
 525 #pragma pack(push,2)
 526 struct bmp_file_header {
 527    uint16_t bfType;
 528    uint32_t bfSize;
 529    uint16_t bfReserved1;
 530    uint16_t bfReserved2;
 531    uint32_t bfOffBits;
 532 };
 533 #pragma pack(pop)
 534
 535 struct bmp_info_header {
 536    uint32_t biSize;
 537    int32_t biWidth;
 538    int32_t biHeight;
 539    uint16_t biPlanes;
 540    uint16_t biBitCount;
 541    uint32_t biCompression;
 542    uint32_t biSizeImage;
 543    int32_t biXPelsPerMeter;
 544    int32_t biYPelsPerMeter;
 545    uint32_t biClrUsed;
 546    uint32_t biClrImportant;
 547 };
 548
 549 struct bmp_rgb_quad {
 550    uint8_t rgbBlue;
 551    uint8_t rgbGreen;
 552    uint8_t rgbRed;
 553    uint8_t rgbAlpha;
 554 };
 555
 556 void
 557 debug_dump_surface_bmp(struct pipe_context *pipe,
 558                        const char *filename,
 559                        struct pipe_surface *surface)
 560 {
 561 #ifndef PIPE_SUBSYSTEM_WINDOWS_MINIPORT
 562    struct pipe_transfer *transfer;
 563    struct pipe_resource *texture = surface->texture;
 564
 565    transfer = pipe_get_transfer(pipe, texture, surface->u.tex.level,
 566                                 surface->u.tex.first_layer, PIPE_TRANSFER_READ,
 567                                 0, 0, surface->width, surface->height);
 568
 569    debug_dump_transfer_bmp(pipe, filename, transfer);
 570
 571    pipe->transfer_destroy(pipe, transfer);
 572 #endif
 573 }
 574
 575 void
 576 debug_dump_transfer_bmp(struct pipe_context *pipe,
 577                         const char *filename,
 578                         struct pipe_transfer *transfer)
 579 {
 580 #ifndef PIPE_SUBSYSTEM_WINDOWS_MINIPORT
 581    float *rgba;
 582
 583    if (!transfer)
 584       goto error1;
 585
 586    rgba = MALLOC(transfer->box.width *
 587                  transfer->box.height *
 588                  transfer->box.depth *
 589                  4*sizeof(float));
 590    if(!rgba)
 591       goto error1;
 592
 593    pipe_get_tile_rgba(pipe, transfer, 0, 0,
 594                       transfer->box.width, transfer->box.height,
 595                       rgba);
 596
 597    debug_dump_float_rgba_bmp(filename,
 598                              transfer->box.width, transfer->box.height,
 599                              rgba, transfer->box.width);
 600
 601    FREE(rgba);
 602 error1:
 603    ;
 604 #endif
 605 }
 606
 607 void
 608 debug_dump_float_rgba_bmp(const char *filename,
 609                           unsigned width, unsigned height,
 610                           float *rgba, unsigned stride)
 611 {
 612 #ifndef PIPE_SUBSYSTEM_WINDOWS_MINIPORT
 613    struct os_stream *stream;
 614    struct bmp_file_header bmfh;
 615    struct bmp_info_header bmih;
 616    unsigned x, y;
 617
 618    if(!rgba)
 619       goto error1;
 620
 621    bmfh.bfType = 0x4d42;
 622    bmfh.bfSize = 14 + 40 + height*width*4;
 623    bmfh.bfReserved1 = 0;
 624    bmfh.bfReserved2 = 0;
 625    bmfh.bfOffBits = 14 + 40;
 626
 627    bmih.biSize = 40;
 628    bmih.biWidth = width;
 629    bmih.biHeight = height;
 630    bmih.biPlanes = 1;
 631    bmih.biBitCount = 32;
 632    bmih.biCompression = 0;
 633    bmih.biSizeImage = height*width*4;
 634    bmih.biXPelsPerMeter = 0;
 635    bmih.biYPelsPerMeter = 0;
 636    bmih.biClrUsed = 0;
 637    bmih.biClrImportant = 0;
 638
 639    stream = os_file_stream_create(filename);
 640    if(!stream)
 641       goto error1;
 642
 643    os_stream_write(stream, &bmfh, 14);
 644    os_stream_write(stream, &bmih, 40);
 645
 646    y = height;
 647    while(y--) {
 648       float *ptr = rgba + (stride * y * 4);
 649       for(x = 0; x < width; ++x)
 650       {
 651          struct bmp_rgb_quad pixel;
 652          pixel.rgbRed   = float_to_ubyte(ptr[x*4 + 0]);
 653          pixel.rgbGreen = float_to_ubyte(ptr[x*4 + 1]);
 654          pixel.rgbBlue  = float_to_ubyte(ptr[x*4 + 2]);
 655          pixel.rgbAlpha = 255;
 656          os_stream_write(stream, &pixel, 4);
 657       }
 658    }
 659
 660    os_stream_close(stream);
 661 error1:
 662    ;
 663 #endif
 664 }
 665
 666 #endif