src/gallium/auxiliary/util/u_dump_state.c

   1 /**************************************************************************
   2  *
   3  * Copyright 2008-2010 VMware, Inc.
   4  * All Rights Reserved.
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a
   7  * copy of this software and associated documentation files (the
   8  * "Software"), to deal in the Software without restriction, including
   9  * without limitation the rights to use, copy, modify, merge, publish,
  10  * distribute, sub license, and/or sell copies of the Software, and to
  11  * permit persons to whom the Software is furnished to do so, subject to
  12  * the following conditions:
  13  *
  14  * The above copyright notice and this permission notice (including the
  15  * next paragraph) shall be included in all copies or substantial portions
  16  * 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
  20  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
  21  * IN NO EVENT SHALL VMWARE AND/OR ITS SUPPLIERS BE LIABLE FOR
  22  * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
  23  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
  24  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  25  *
  26  **************************************************************************/
  27
  28
  29 #include "pipe/p_compiler.h"
  30 #include "os/os_stream.h"
  31 #include "util/u_memory.h"
  32 #include "util/u_string.h"
  33 #include "util/u_format.h"
  34 #include "tgsi/tgsi_dump.h"
  35
  36 #include "u_dump.h"
  37
  38
  39 /*
  40  * Dump primitives
  41  */
  42
  43 static INLINE void
  44 util_stream_writef(struct os_stream *stream, const char *format, ...)
  45 {
  46    static char buf[1024];
  47    unsigned len;
  48    va_list ap;
  49    va_start(ap, format);
  50    len = util_vsnprintf(buf, sizeof(buf), format, ap);
  51    va_end(ap);
  52    os_stream_write(stream, buf, len);
  53 }
  54
  55 static void
  56 util_dump_bool(struct os_stream *stream, int value)
  57 {
  58    util_stream_writef(stream, "%c", value ? '1' : '0');
  59 }
  60
  61 static void
  62 util_dump_int(struct os_stream *stream, long long int value)
  63 {
  64    util_stream_writef(stream, "%lli", value);
  65 }
  66
  67 static void
  68 util_dump_uint(struct os_stream *stream, long long unsigned value)
  69 {
  70    util_stream_writef(stream, "%llu", value);
  71 }
  72
  73 static void
  74 util_dump_float(struct os_stream *stream, double value)
  75 {
  76    util_stream_writef(stream, "%g", value);
  77 }
  78
  79 static void
  80 util_dump_string(struct os_stream *stream, const char *str)
  81 {
  82    os_stream_write_str(stream, "\"");
  83    os_stream_write_str(stream, str);
  84    os_stream_write_str(stream, "\"");
  85 }
  86
  87 static void
  88 util_dump_enum(struct os_stream *stream, const char *value)
  89 {
  90    os_stream_write_str(stream, value);
  91 }
  92
  93 static void
  94 util_dump_array_begin(struct os_stream *stream)
  95 {
  96    os_stream_write_str(stream, "{");
  97 }
  98
  99 static void
 100 util_dump_array_end(struct os_stream *stream)
 101 {
 102    os_stream_write_str(stream, "}");
 103 }
 104
 105 static void
 106 util_dump_elem_begin(struct os_stream *stream)
 107 {
 108 }
 109
 110 static void
 111 util_dump_elem_end(struct os_stream *stream)
 112 {
 113    os_stream_write_str(stream, ", ");
 114 }
 115
 116 static void
 117 util_dump_struct_begin(struct os_stream *stream, const char *name)
 118 {
 119    os_stream_write_str(stream, "{");
 120 }
 121
 122 static void
 123 util_dump_struct_end(struct os_stream *stream)
 124 {
 125    os_stream_write_str(stream, "}");
 126 }
 127
 128 static void
 129 util_dump_member_begin(struct os_stream *stream, const char *name)
 130 {
 131    util_stream_writef(stream, "%s = ", name);
 132 }
 133
 134 static void
 135 util_dump_member_end(struct os_stream *stream)
 136 {
 137    os_stream_write_str(stream, ", ");
 138 }
 139
 140 static void
 141 util_dump_null(struct os_stream *stream)
 142 {
 143    os_stream_write_str(stream, "NULL");
 144 }
 145
 146 static void
 147 util_dump_ptr(struct os_stream *stream, const void *value)
 148 {
 149    if(value)
 150       util_stream_writef(stream, "0x%08lx", (unsigned long)(uintptr_t)value);
 151    else
 152       util_dump_null(stream);
 153 }
 154
 155
 156 /*
 157  * Code saving macros.
 158  */
 159
 160 #define util_dump_arg(_stream, _type, _arg) \
 161    do { \
 162       util_dump_arg_begin(_stream, #_arg); \
 163       util_dump_##_type(_stream, _arg); \
 164       util_dump_arg_end(_stream); \
 165    } while(0)
 166
 167 #define util_dump_ret(_stream, _type, _arg) \
 168    do { \
 169       util_dump_ret_begin(_stream); \
 170       util_dump_##_type(_stream, _arg); \
 171       util_dump_ret_end(_stream); \
 172    } while(0)
 173
 174 #define util_dump_array(_stream, _type, _obj, _size) \
 175    do { \
 176       size_t idx; \
 177       util_dump_array_begin(_stream); \
 178       for(idx = 0; idx < (_size); ++idx) { \
 179          util_dump_elem_begin(_stream); \
 180          util_dump_##_type(_stream, (_obj)[idx]); \
 181          util_dump_elem_end(_stream); \
 182       } \
 183       util_dump_array_end(_stream); \
 184    } while(0)
 185
 186 #define util_dump_struct_array(_stream, _type, _obj, _size) \
 187    do { \
 188       size_t idx; \
 189       util_dump_array_begin(_stream); \
 190       for(idx = 0; idx < (_size); ++idx) { \
 191          util_dump_elem_begin(_stream); \
 192          util_dump_##_type(_stream, &(_obj)[idx]); \
 193          util_dump_elem_end(_stream); \
 194       } \
 195       util_dump_array_end(_stream); \
 196    } while(0)
 197
 198 #define util_dump_member(_stream, _type, _obj, _member) \
 199    do { \
 200       util_dump_member_begin(_stream, #_member); \
 201       util_dump_##_type(_stream, (_obj)->_member); \
 202       util_dump_member_end(_stream); \
 203    } while(0)
 204
 205 #define util_dump_arg_array(_stream, _type, _arg, _size) \
 206    do { \
 207       util_dump_arg_begin(_stream, #_arg); \
 208       util_dump_array(_stream, _type, _arg, _size); \
 209       util_dump_arg_end(_stream); \
 210    } while(0)
 211
 212 #define util_dump_member_array(_stream, _type, _obj, _member) \
 213    do { \
 214       util_dump_member_begin(_stream, #_member); \
 215       util_dump_array(_stream, _type, (_obj)->_member, sizeof((_obj)->_member)/sizeof((_obj)->_member[0])); \
 216       util_dump_member_end(_stream); \
 217    } while(0)
 218
 219
 220
 221 /*
 222  * Wrappers for enum -> string dumpers.
 223  */
 224
 225
 226 static void
 227 util_dump_format(struct os_stream *stream, enum pipe_format format)
 228 {
 229    util_dump_enum(stream, util_format_name(format));
 230 }
 231
 232
 233 static void
 234 util_dump_enum_blend_factor(struct os_stream *stream, unsigned value)
 235 {
 236    util_dump_enum(stream, util_dump_blend_factor(value, TRUE));
 237 }
 238
 239 static void
 240 util_dump_enum_blend_func(struct os_stream *stream, unsigned value)
 241 {
 242    util_dump_enum(stream, util_dump_blend_func(value, TRUE));
 243 }
 244
 245 static void
 246 util_dump_enum_func(struct os_stream *stream, unsigned value)
 247 {
 248    util_dump_enum(stream, util_dump_func(value, TRUE));
 249 }
 250
 251
 252 /*
 253  * Public functions
 254  */
 255
 256
 257 void
 258 util_dump_template(struct os_stream *stream, const struct pipe_texture *templat)
 259 {
 260    if(!templat) {
 261       util_dump_null(stream);
 262       return;
 263    }
 264
 265    util_dump_struct_begin(stream, "pipe_texture");
 266
 267    util_dump_member(stream, int, templat, target);
 268    util_dump_member(stream, format, templat, format);
 269
 270    util_dump_member_begin(stream, "width");
 271    util_dump_uint(stream, templat->width0);
 272    util_dump_member_end(stream);
 273
 274    util_dump_member_begin(stream, "height");
 275    util_dump_uint(stream, templat->height0);
 276    util_dump_member_end(stream);
 277
 278    util_dump_member_begin(stream, "depth");
 279    util_dump_uint(stream, templat->depth0);
 280    util_dump_member_end(stream);
 281
 282    util_dump_member(stream, uint, templat, last_level);
 283    util_dump_member(stream, uint, templat, tex_usage);
 284
 285    util_dump_struct_end(stream);
 286 }
 287
 288
 289 void
 290 util_dump_rasterizer_state(struct os_stream *stream, const struct pipe_rasterizer_state *state)
 291 {
 292    if(!state) {
 293       util_dump_null(stream);
 294       return;
 295    }
 296
 297    util_dump_struct_begin(stream, "pipe_rasterizer_state");
 298
 299    util_dump_member(stream, bool, state, flatshade);
 300    util_dump_member(stream, bool, state, light_twoside);
 301    util_dump_member(stream, uint, state, front_winding);
 302    util_dump_member(stream, uint, state, cull_mode);
 303    util_dump_member(stream, uint, state, fill_cw);
 304    util_dump_member(stream, uint, state, fill_ccw);
 305    util_dump_member(stream, bool, state, offset_cw);
 306    util_dump_member(stream, bool, state, offset_ccw);
 307    util_dump_member(stream, bool, state, scissor);
 308    util_dump_member(stream, bool, state, poly_smooth);
 309    util_dump_member(stream, bool, state, poly_stipple_enable);
 310    util_dump_member(stream, bool, state, point_smooth);
 311    util_dump_member(stream, uint, state, sprite_coord_enable);
 312    util_dump_member(stream, bool, state, sprite_coord_mode);
 313    util_dump_member(stream, bool, state, point_quad_rasterization);
 314    util_dump_member(stream, bool, state, point_size_per_vertex);
 315    util_dump_member(stream, bool, state, multisample);
 316    util_dump_member(stream, bool, state, line_smooth);
 317    util_dump_member(stream, bool, state, line_stipple_enable);
 318    util_dump_member(stream, uint, state, line_stipple_factor);
 319    util_dump_member(stream, uint, state, line_stipple_pattern);
 320    util_dump_member(stream, bool, state, line_last_pixel);
 321    util_dump_member(stream, bool, state, bypass_vs_clip_and_viewport);
 322    util_dump_member(stream, bool, state, flatshade_first);
 323    util_dump_member(stream, bool, state, gl_rasterization_rules);
 324
 325    util_dump_member(stream, float, state, line_width);
 326    util_dump_member(stream, float, state, point_size);
 327    util_dump_member(stream, float, state, offset_units);
 328    util_dump_member(stream, float, state, offset_scale);
 329
 330    util_dump_struct_end(stream);
 331 }
 332
 333
 334 void
 335 util_dump_poly_stipple(struct os_stream *stream, const struct pipe_poly_stipple *state)
 336 {
 337    if(!state) {
 338       util_dump_null(stream);
 339       return;
 340    }
 341
 342    util_dump_struct_begin(stream, "pipe_poly_stipple");
 343
 344    util_dump_member_begin(stream, "stipple");
 345    util_dump_member_array(stream, uint, state, stipple);
 346    util_dump_member_end(stream);
 347
 348    util_dump_struct_end(stream);
 349 }
 350
 351
 352 void
 353 util_dump_viewport_state(struct os_stream *stream, const struct pipe_viewport_state *state)
 354 {
 355    if(!state) {
 356       util_dump_null(stream);
 357       return;
 358    }
 359
 360    util_dump_struct_begin(stream, "pipe_viewport_state");
 361
 362    util_dump_member_array(stream, float, state, scale);
 363    util_dump_member_array(stream, float, state, translate);
 364
 365    util_dump_struct_end(stream);
 366 }
 367
 368
 369 void
 370 util_dump_scissor_state(struct os_stream *stream, const struct pipe_scissor_state *state)
 371 {
 372    if(!state) {
 373       util_dump_null(stream);
 374       return;
 375    }
 376
 377    util_dump_struct_begin(stream, "pipe_scissor_state");
 378
 379    util_dump_member(stream, uint, state, minx);
 380    util_dump_member(stream, uint, state, miny);
 381    util_dump_member(stream, uint, state, maxx);
 382    util_dump_member(stream, uint, state, maxy);
 383
 384    util_dump_struct_end(stream);
 385 }
 386
 387
 388 void
 389 util_dump_clip_state(struct os_stream *stream, const struct pipe_clip_state *state)
 390 {
 391    unsigned i;
 392
 393    if(!state) {
 394       util_dump_null(stream);
 395       return;
 396    }
 397
 398    util_dump_struct_begin(stream, "pipe_clip_state");
 399
 400    util_dump_member_begin(stream, "ucp");
 401    util_dump_array_begin(stream);
 402    for(i = 0; i < PIPE_MAX_CLIP_PLANES; ++i) {
 403       util_dump_elem_begin(stream);
 404       util_dump_array(stream, float, state->ucp[i], 4);
 405       util_dump_elem_end(stream);
 406    }
 407    util_dump_array_end(stream);
 408    util_dump_member_end(stream);
 409
 410    util_dump_member(stream, uint, state, nr);
 411
 412    util_dump_struct_end(stream);
 413 }
 414
 415
 416 void
 417 util_dump_shader_state(struct os_stream *stream, const struct pipe_shader_state *state)
 418 {
 419    char str[8192];
 420
 421    if(!state) {
 422       util_dump_null(stream);
 423       return;
 424    }
 425
 426    tgsi_dump_str(state->tokens, 0, str, sizeof(str));
 427
 428    util_dump_struct_begin(stream, "pipe_shader_state");
 429
 430    util_dump_member_begin(stream, "tokens");
 431    util_dump_string(stream, str);
 432    util_dump_member_end(stream);
 433
 434    util_dump_struct_end(stream);
 435 }
 436
 437
 438 void
 439 util_dump_depth_stencil_alpha_state(struct os_stream *stream, const struct pipe_depth_stencil_alpha_state *state)
 440 {
 441    unsigned i;
 442
 443    if(!state) {
 444       util_dump_null(stream);
 445       return;
 446    }
 447
 448    util_dump_struct_begin(stream, "pipe_depth_stencil_alpha_state");
 449
 450    util_dump_member_begin(stream, "depth");
 451    util_dump_struct_begin(stream, "pipe_depth_state");
 452    util_dump_member(stream, bool, &state->depth, enabled);
 453    if (state->depth.enabled) {
 454       util_dump_member(stream, bool, &state->depth, writemask);
 455       util_dump_member(stream, enum_func, &state->depth, func);
 456    }
 457    util_dump_struct_end(stream);
 458    util_dump_member_end(stream);
 459
 460    util_dump_member_begin(stream, "stencil");
 461    util_dump_array_begin(stream);
 462    for(i = 0; i < Elements(state->stencil); ++i) {
 463       util_dump_elem_begin(stream);
 464       util_dump_struct_begin(stream, "pipe_stencil_state");
 465       util_dump_member(stream, bool, &state->stencil[i], enabled);
 466       if (state->stencil[i].enabled) {
 467          util_dump_member(stream, enum_func, &state->stencil[i], func);
 468          util_dump_member(stream, uint, &state->stencil[i], fail_op);
 469          util_dump_member(stream, uint, &state->stencil[i], zpass_op);
 470          util_dump_member(stream, uint, &state->stencil[i], zfail_op);
 471          util_dump_member(stream, uint, &state->stencil[i], valuemask);
 472          util_dump_member(stream, uint, &state->stencil[i], writemask);
 473       }
 474       util_dump_struct_end(stream);
 475       util_dump_elem_end(stream);
 476    }
 477    util_dump_array_end(stream);
 478    util_dump_member_end(stream);
 479
 480    util_dump_member_begin(stream, "alpha");
 481    util_dump_struct_begin(stream, "pipe_alpha_state");
 482    util_dump_member(stream, bool, &state->alpha, enabled);
 483    if (state->alpha.enabled) {
 484       util_dump_member(stream, enum_func, &state->alpha, func);
 485       util_dump_member(stream, float, &state->alpha, ref_value);
 486    }
 487    util_dump_struct_end(stream);
 488    util_dump_member_end(stream);
 489
 490    util_dump_struct_end(stream);
 491 }
 492
 493 void
 494 util_dump_rt_blend_state(struct os_stream *stream, const struct pipe_rt_blend_state *state)
 495 {
 496    util_dump_struct_begin(stream, "pipe_rt_blend_state");
 497
 498    util_dump_member(stream, uint, state, blend_enable);
 499    if (state->blend_enable) {
 500       util_dump_member(stream, enum_blend_func, state, rgb_func);
 501       util_dump_member(stream, enum_blend_factor, state, rgb_src_factor);
 502       util_dump_member(stream, enum_blend_factor, state, rgb_dst_factor);
 503
 504       util_dump_member(stream, enum_blend_func, state, alpha_func);
 505       util_dump_member(stream, enum_blend_factor, state, alpha_src_factor);
 506       util_dump_member(stream, enum_blend_factor, state, alpha_dst_factor);
 507    }
 508
 509    util_dump_member(stream, uint, state, colormask);
 510
 511    util_dump_struct_end(stream);
 512 }
 513
 514 void
 515 util_dump_blend_state(struct os_stream *stream, const struct pipe_blend_state *state)
 516 {
 517    unsigned valid_entries = 1;
 518
 519    if(!state) {
 520       util_dump_null(stream);
 521       return;
 522    }
 523
 524    util_dump_struct_begin(stream, "pipe_blend_state");
 525
 526    util_dump_member(stream, bool, state, dither);
 527
 528    util_dump_member(stream, bool, state, logicop_enable);
 529    if (state->logicop_enable) {
 530       util_dump_member(stream, enum_func, state, logicop_func);
 531    }
 532    else {
 533       util_dump_member(stream, bool, state, independent_blend_enable);
 534
 535       util_dump_member_begin(stream, "rt");
 536       if (state->independent_blend_enable)
 537          valid_entries = PIPE_MAX_COLOR_BUFS;
 538       util_dump_struct_array(stream, rt_blend_state, state->rt, valid_entries);
 539       util_dump_member_end(stream);
 540    }
 541
 542    util_dump_struct_end(stream);
 543 }
 544
 545
 546 void
 547 util_dump_blend_color(struct os_stream *stream, const struct pipe_blend_color *state)
 548 {
 549    if(!state) {
 550       util_dump_null(stream);
 551       return;
 552    }
 553
 554    util_dump_struct_begin(stream, "pipe_blend_color");
 555
 556    util_dump_member_array(stream, float, state, color);
 557
 558    util_dump_struct_end(stream);
 559 }
 560
 561 void
 562 util_dump_stencil_ref(struct os_stream *stream, const struct pipe_stencil_ref *state)
 563 {
 564    if(!state) {
 565       util_dump_null(stream);
 566       return;
 567    }
 568
 569    util_dump_struct_begin(stream, "pipe_stencil_ref");
 570
 571    util_dump_member_array(stream, uint, state, ref_value);
 572
 573    util_dump_struct_end(stream);
 574 }
 575
 576 void
 577 util_dump_framebuffer_state(struct os_stream *stream, const struct pipe_framebuffer_state *state)
 578 {
 579    util_dump_struct_begin(stream, "pipe_framebuffer_state");
 580
 581    util_dump_member(stream, uint, state, width);
 582    util_dump_member(stream, uint, state, height);
 583    util_dump_member(stream, uint, state, nr_cbufs);
 584    util_dump_member_array(stream, ptr, state, cbufs);
 585    util_dump_member(stream, ptr, state, zsbuf);
 586
 587    util_dump_struct_end(stream);
 588 }
 589
 590
 591 void
 592 util_dump_sampler_state(struct os_stream *stream, const struct pipe_sampler_state *state)
 593 {
 594    if(!state) {
 595       util_dump_null(stream);
 596       return;
 597    }
 598
 599    util_dump_struct_begin(stream, "pipe_sampler_state");
 600
 601    util_dump_member(stream, uint, state, wrap_s);
 602    util_dump_member(stream, uint, state, wrap_t);
 603    util_dump_member(stream, uint, state, wrap_r);
 604    util_dump_member(stream, uint, state, min_img_filter);
 605    util_dump_member(stream, uint, state, min_mip_filter);
 606    util_dump_member(stream, uint, state, mag_img_filter);
 607    util_dump_member(stream, uint, state, compare_mode);
 608    util_dump_member(stream, enum_func, state, compare_func);
 609    util_dump_member(stream, bool, state, normalized_coords);
 610    util_dump_member(stream, uint, state, max_anisotropy);
 611    util_dump_member(stream, float, state, lod_bias);
 612    util_dump_member(stream, float, state, min_lod);
 613    util_dump_member(stream, float, state, max_lod);
 614    util_dump_member_array(stream, float, state, border_color);
 615
 616    util_dump_struct_end(stream);
 617 }
 618
 619
 620 void
 621 util_dump_surface(struct os_stream *stream, const struct pipe_surface *state)
 622 {
 623    if(!state) {
 624       util_dump_null(stream);
 625       return;
 626    }
 627
 628    util_dump_struct_begin(stream, "pipe_surface");
 629
 630    util_dump_member(stream, format, state, format);
 631    util_dump_member(stream, uint, state, width);
 632    util_dump_member(stream, uint, state, height);
 633
 634    util_dump_member(stream, uint, state, layout);
 635    util_dump_member(stream, uint, state, offset);
 636    util_dump_member(stream, uint, state, usage);
 637
 638    util_dump_member(stream, ptr, state, texture);
 639    util_dump_member(stream, uint, state, face);
 640    util_dump_member(stream, uint, state, level);
 641    util_dump_member(stream, uint, state, zslice);
 642
 643    util_dump_struct_end(stream);
 644 }
 645
 646
 647 void
 648 util_dump_transfer(struct os_stream *stream, const struct pipe_transfer *state)
 649 {
 650    if(!state) {
 651       util_dump_null(stream);
 652       return;
 653    }
 654
 655    util_dump_struct_begin(stream, "pipe_transfer");
 656
 657    util_dump_member(stream, uint, state, width);
 658    util_dump_member(stream, uint, state, height);
 659
 660    util_dump_member(stream, uint, state, stride);
 661    util_dump_member(stream, uint, state, usage);
 662
 663    util_dump_member(stream, ptr, state, texture);
 664    util_dump_member(stream, uint, state, face);
 665    util_dump_member(stream, uint, state, level);
 666    util_dump_member(stream, uint, state, zslice);
 667
 668    util_dump_struct_end(stream);
 669 }
 670
 671
 672 void
 673 util_dump_vertex_buffer(struct os_stream *stream, const struct pipe_vertex_buffer *state)
 674 {
 675    if(!state) {
 676       util_dump_null(stream);
 677       return;
 678    }
 679
 680    util_dump_struct_begin(stream, "pipe_vertex_buffer");
 681
 682    util_dump_member(stream, uint, state, stride);
 683    util_dump_member(stream, uint, state, max_index);
 684    util_dump_member(stream, uint, state, buffer_offset);
 685    util_dump_member(stream, ptr, state, buffer);
 686
 687    util_dump_struct_end(stream);
 688 }
 689
 690
 691 void
 692 util_dump_vertex_element(struct os_stream *stream, const struct pipe_vertex_element *state)
 693 {
 694    if(!state) {
 695       util_dump_null(stream);
 696       return;
 697    }
 698
 699    util_dump_struct_begin(stream, "pipe_vertex_element");
 700
 701    util_dump_member(stream, uint, state, src_offset);
 702
 703    util_dump_member(stream, uint, state, vertex_buffer_index);
 704    util_dump_member(stream, uint, state, nr_components);
 705
 706    util_dump_member(stream, format, state, src_format);
 707
 708    util_dump_struct_end(stream);
 709 }