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, flatshade_first);
 322    util_dump_member(stream, bool, state, gl_rasterization_rules);
 323
 324    util_dump_member(stream, float, state, line_width);
 325    util_dump_member(stream, float, state, point_size);
 326    util_dump_member(stream, float, state, offset_units);
 327    util_dump_member(stream, float, state, offset_scale);
 328
 329    util_dump_struct_end(stream);
 330 }
 331
 332
 333 void
 334 util_dump_poly_stipple(struct os_stream *stream, const struct pipe_poly_stipple *state)
 335 {
 336    if(!state) {
 337       util_dump_null(stream);
 338       return;
 339    }
 340
 341    util_dump_struct_begin(stream, "pipe_poly_stipple");
 342
 343    util_dump_member_begin(stream, "stipple");
 344    util_dump_member_array(stream, uint, state, stipple);
 345    util_dump_member_end(stream);
 346
 347    util_dump_struct_end(stream);
 348 }
 349
 350
 351 void
 352 util_dump_viewport_state(struct os_stream *stream, const struct pipe_viewport_state *state)
 353 {
 354    if(!state) {
 355       util_dump_null(stream);
 356       return;
 357    }
 358
 359    util_dump_struct_begin(stream, "pipe_viewport_state");
 360
 361    util_dump_member_array(stream, float, state, scale);
 362    util_dump_member_array(stream, float, state, translate);
 363
 364    util_dump_struct_end(stream);
 365 }
 366
 367
 368 void
 369 util_dump_scissor_state(struct os_stream *stream, const struct pipe_scissor_state *state)
 370 {
 371    if(!state) {
 372       util_dump_null(stream);
 373       return;
 374    }
 375
 376    util_dump_struct_begin(stream, "pipe_scissor_state");
 377
 378    util_dump_member(stream, uint, state, minx);
 379    util_dump_member(stream, uint, state, miny);
 380    util_dump_member(stream, uint, state, maxx);
 381    util_dump_member(stream, uint, state, maxy);
 382
 383    util_dump_struct_end(stream);
 384 }
 385
 386
 387 void
 388 util_dump_clip_state(struct os_stream *stream, const struct pipe_clip_state *state)
 389 {
 390    unsigned i;
 391
 392    if(!state) {
 393       util_dump_null(stream);
 394       return;
 395    }
 396
 397    util_dump_struct_begin(stream, "pipe_clip_state");
 398
 399    util_dump_member_begin(stream, "ucp");
 400    util_dump_array_begin(stream);
 401    for(i = 0; i < PIPE_MAX_CLIP_PLANES; ++i) {
 402       util_dump_elem_begin(stream);
 403       util_dump_array(stream, float, state->ucp[i], 4);
 404       util_dump_elem_end(stream);
 405    }
 406    util_dump_array_end(stream);
 407    util_dump_member_end(stream);
 408
 409    util_dump_member(stream, uint, state, nr);
 410
 411    util_dump_struct_end(stream);
 412 }
 413
 414
 415 void
 416 util_dump_shader_state(struct os_stream *stream, const struct pipe_shader_state *state)
 417 {
 418    char str[8192];
 419
 420    if(!state) {
 421       util_dump_null(stream);
 422       return;
 423    }
 424
 425    tgsi_dump_str(state->tokens, 0, str, sizeof(str));
 426
 427    util_dump_struct_begin(stream, "pipe_shader_state");
 428
 429    util_dump_member_begin(stream, "tokens");
 430    util_dump_string(stream, str);
 431    util_dump_member_end(stream);
 432
 433    util_dump_struct_end(stream);
 434 }
 435
 436
 437 void
 438 util_dump_depth_stencil_alpha_state(struct os_stream *stream, const struct pipe_depth_stencil_alpha_state *state)
 439 {
 440    unsigned i;
 441
 442    if(!state) {
 443       util_dump_null(stream);
 444       return;
 445    }
 446
 447    util_dump_struct_begin(stream, "pipe_depth_stencil_alpha_state");
 448
 449    util_dump_member_begin(stream, "depth");
 450    util_dump_struct_begin(stream, "pipe_depth_state");
 451    util_dump_member(stream, bool, &state->depth, enabled);
 452    if (state->depth.enabled) {
 453       util_dump_member(stream, bool, &state->depth, writemask);
 454       util_dump_member(stream, enum_func, &state->depth, func);
 455    }
 456    util_dump_struct_end(stream);
 457    util_dump_member_end(stream);
 458
 459    util_dump_member_begin(stream, "stencil");
 460    util_dump_array_begin(stream);
 461    for(i = 0; i < Elements(state->stencil); ++i) {
 462       util_dump_elem_begin(stream);
 463       util_dump_struct_begin(stream, "pipe_stencil_state");
 464       util_dump_member(stream, bool, &state->stencil[i], enabled);
 465       if (state->stencil[i].enabled) {
 466          util_dump_member(stream, enum_func, &state->stencil[i], func);
 467          util_dump_member(stream, uint, &state->stencil[i], fail_op);
 468          util_dump_member(stream, uint, &state->stencil[i], zpass_op);
 469          util_dump_member(stream, uint, &state->stencil[i], zfail_op);
 470          util_dump_member(stream, uint, &state->stencil[i], valuemask);
 471          util_dump_member(stream, uint, &state->stencil[i], writemask);
 472       }
 473       util_dump_struct_end(stream);
 474       util_dump_elem_end(stream);
 475    }
 476    util_dump_array_end(stream);
 477    util_dump_member_end(stream);
 478
 479    util_dump_member_begin(stream, "alpha");
 480    util_dump_struct_begin(stream, "pipe_alpha_state");
 481    util_dump_member(stream, bool, &state->alpha, enabled);
 482    if (state->alpha.enabled) {
 483       util_dump_member(stream, enum_func, &state->alpha, func);
 484       util_dump_member(stream, float, &state->alpha, ref_value);
 485    }
 486    util_dump_struct_end(stream);
 487    util_dump_member_end(stream);
 488
 489    util_dump_struct_end(stream);
 490 }
 491
 492 void
 493 util_dump_rt_blend_state(struct os_stream *stream, const struct pipe_rt_blend_state *state)
 494 {
 495    util_dump_struct_begin(stream, "pipe_rt_blend_state");
 496
 497    util_dump_member(stream, uint, state, blend_enable);
 498    if (state->blend_enable) {
 499       util_dump_member(stream, enum_blend_func, state, rgb_func);
 500       util_dump_member(stream, enum_blend_factor, state, rgb_src_factor);
 501       util_dump_member(stream, enum_blend_factor, state, rgb_dst_factor);
 502
 503       util_dump_member(stream, enum_blend_func, state, alpha_func);
 504       util_dump_member(stream, enum_blend_factor, state, alpha_src_factor);
 505       util_dump_member(stream, enum_blend_factor, state, alpha_dst_factor);
 506    }
 507
 508    util_dump_member(stream, uint, state, colormask);
 509
 510    util_dump_struct_end(stream);
 511 }
 512
 513 void
 514 util_dump_blend_state(struct os_stream *stream, const struct pipe_blend_state *state)
 515 {
 516    unsigned valid_entries = 1;
 517
 518    if(!state) {
 519       util_dump_null(stream);
 520       return;
 521    }
 522
 523    util_dump_struct_begin(stream, "pipe_blend_state");
 524
 525    util_dump_member(stream, bool, state, dither);
 526
 527    util_dump_member(stream, bool, state, logicop_enable);
 528    if (state->logicop_enable) {
 529       util_dump_member(stream, enum_func, state, logicop_func);
 530    }
 531    else {
 532       util_dump_member(stream, bool, state, independent_blend_enable);
 533
 534       util_dump_member_begin(stream, "rt");
 535       if (state->independent_blend_enable)
 536          valid_entries = PIPE_MAX_COLOR_BUFS;
 537       util_dump_struct_array(stream, rt_blend_state, state->rt, valid_entries);
 538       util_dump_member_end(stream);
 539    }
 540
 541    util_dump_struct_end(stream);
 542 }
 543
 544
 545 void
 546 util_dump_blend_color(struct os_stream *stream, const struct pipe_blend_color *state)
 547 {
 548    if(!state) {
 549       util_dump_null(stream);
 550       return;
 551    }
 552
 553    util_dump_struct_begin(stream, "pipe_blend_color");
 554
 555    util_dump_member_array(stream, float, state, color);
 556
 557    util_dump_struct_end(stream);
 558 }
 559
 560 void
 561 util_dump_stencil_ref(struct os_stream *stream, const struct pipe_stencil_ref *state)
 562 {
 563    if(!state) {
 564       util_dump_null(stream);
 565       return;
 566    }
 567
 568    util_dump_struct_begin(stream, "pipe_stencil_ref");
 569
 570    util_dump_member_array(stream, uint, state, ref_value);
 571
 572    util_dump_struct_end(stream);
 573 }
 574
 575 void
 576 util_dump_framebuffer_state(struct os_stream *stream, const struct pipe_framebuffer_state *state)
 577 {
 578    util_dump_struct_begin(stream, "pipe_framebuffer_state");
 579
 580    util_dump_member(stream, uint, state, width);
 581    util_dump_member(stream, uint, state, height);
 582    util_dump_member(stream, uint, state, nr_cbufs);
 583    util_dump_member_array(stream, ptr, state, cbufs);
 584    util_dump_member(stream, ptr, state, zsbuf);
 585
 586    util_dump_struct_end(stream);
 587 }
 588
 589
 590 void
 591 util_dump_sampler_state(struct os_stream *stream, const struct pipe_sampler_state *state)
 592 {
 593    if(!state) {
 594       util_dump_null(stream);
 595       return;
 596    }
 597
 598    util_dump_struct_begin(stream, "pipe_sampler_state");
 599
 600    util_dump_member(stream, uint, state, wrap_s);
 601    util_dump_member(stream, uint, state, wrap_t);
 602    util_dump_member(stream, uint, state, wrap_r);
 603    util_dump_member(stream, uint, state, min_img_filter);
 604    util_dump_member(stream, uint, state, min_mip_filter);
 605    util_dump_member(stream, uint, state, mag_img_filter);
 606    util_dump_member(stream, uint, state, compare_mode);
 607    util_dump_member(stream, enum_func, state, compare_func);
 608    util_dump_member(stream, bool, state, normalized_coords);
 609    util_dump_member(stream, uint, state, max_anisotropy);
 610    util_dump_member(stream, float, state, lod_bias);
 611    util_dump_member(stream, float, state, min_lod);
 612    util_dump_member(stream, float, state, max_lod);
 613    util_dump_member_array(stream, float, state, border_color);
 614
 615    util_dump_struct_end(stream);
 616 }
 617
 618
 619 void
 620 util_dump_surface(struct os_stream *stream, const struct pipe_surface *state)
 621 {
 622    if(!state) {
 623       util_dump_null(stream);
 624       return;
 625    }
 626
 627    util_dump_struct_begin(stream, "pipe_surface");
 628
 629    util_dump_member(stream, format, state, format);
 630    util_dump_member(stream, uint, state, width);
 631    util_dump_member(stream, uint, state, height);
 632
 633    util_dump_member(stream, uint, state, layout);
 634    util_dump_member(stream, uint, state, offset);
 635    util_dump_member(stream, uint, state, usage);
 636
 637    util_dump_member(stream, ptr, state, texture);
 638    util_dump_member(stream, uint, state, face);
 639    util_dump_member(stream, uint, state, level);
 640    util_dump_member(stream, uint, state, zslice);
 641
 642    util_dump_struct_end(stream);
 643 }
 644
 645
 646 void
 647 util_dump_transfer(struct os_stream *stream, const struct pipe_transfer *state)
 648 {
 649    if(!state) {
 650       util_dump_null(stream);
 651       return;
 652    }
 653
 654    util_dump_struct_begin(stream, "pipe_transfer");
 655
 656    util_dump_member(stream, uint, state, width);
 657    util_dump_member(stream, uint, state, height);
 658
 659    util_dump_member(stream, uint, state, stride);
 660    util_dump_member(stream, uint, state, usage);
 661
 662    util_dump_member(stream, ptr, state, texture);
 663    util_dump_member(stream, uint, state, face);
 664    util_dump_member(stream, uint, state, level);
 665    util_dump_member(stream, uint, state, zslice);
 666
 667    util_dump_struct_end(stream);
 668 }
 669
 670
 671 void
 672 util_dump_vertex_buffer(struct os_stream *stream, const struct pipe_vertex_buffer *state)
 673 {
 674    if(!state) {
 675       util_dump_null(stream);
 676       return;
 677    }
 678
 679    util_dump_struct_begin(stream, "pipe_vertex_buffer");
 680
 681    util_dump_member(stream, uint, state, stride);
 682    util_dump_member(stream, uint, state, max_index);
 683    util_dump_member(stream, uint, state, buffer_offset);
 684    util_dump_member(stream, ptr, state, buffer);
 685
 686    util_dump_struct_end(stream);
 687 }
 688
 689
 690 void
 691 util_dump_vertex_element(struct os_stream *stream, const struct pipe_vertex_element *state)
 692 {
 693    if(!state) {
 694       util_dump_null(stream);
 695       return;
 696    }
 697
 698    util_dump_struct_begin(stream, "pipe_vertex_element");
 699
 700    util_dump_member(stream, uint, state, src_offset);
 701
 702    util_dump_member(stream, uint, state, vertex_buffer_index);
 703
 704    util_dump_member(stream, format, state, src_format);
 705
 706    util_dump_struct_end(stream);
 707 }