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_resource *templat)
 259 {
 260    if(!templat) {
 261       util_dump_null(stream);
 262       return;
 263    }
 264
 265    util_dump_struct_begin(stream, "pipe_resource");
 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, usage);
 284    util_dump_member(stream, uint, templat, bind);
 285    util_dump_member(stream, uint, templat, flags);
 286
 287    util_dump_struct_end(stream);
 288 }
 289
 290
 291 void
 292 util_dump_rasterizer_state(struct os_stream *stream, const struct pipe_rasterizer_state *state)
 293 {
 294    if(!state) {
 295       util_dump_null(stream);
 296       return;
 297    }
 298
 299    util_dump_struct_begin(stream, "pipe_rasterizer_state");
 300
 301    util_dump_member(stream, bool, state, flatshade);
 302    util_dump_member(stream, bool, state, light_twoside);
 303    util_dump_member(stream, uint, state, front_ccw);
 304    util_dump_member(stream, uint, state, cull_face);
 305    util_dump_member(stream, uint, state, fill_front);
 306    util_dump_member(stream, uint, state, fill_back);
 307    util_dump_member(stream, bool, state, offset_point);
 308    util_dump_member(stream, bool, state, offset_line);
 309    util_dump_member(stream, bool, state, offset_tri);
 310    util_dump_member(stream, bool, state, scissor);
 311    util_dump_member(stream, bool, state, poly_smooth);
 312    util_dump_member(stream, bool, state, poly_stipple_enable);
 313    util_dump_member(stream, bool, state, point_smooth);
 314    util_dump_member(stream, uint, state, sprite_coord_enable);
 315    util_dump_member(stream, bool, state, sprite_coord_mode);
 316    util_dump_member(stream, bool, state, point_quad_rasterization);
 317    util_dump_member(stream, bool, state, point_size_per_vertex);
 318    util_dump_member(stream, bool, state, multisample);
 319    util_dump_member(stream, bool, state, line_smooth);
 320    util_dump_member(stream, bool, state, line_stipple_enable);
 321    util_dump_member(stream, uint, state, line_stipple_factor);
 322    util_dump_member(stream, uint, state, line_stipple_pattern);
 323    util_dump_member(stream, bool, state, line_last_pixel);
 324    util_dump_member(stream, bool, state, flatshade_first);
 325    util_dump_member(stream, bool, state, gl_rasterization_rules);
 326
 327    util_dump_member(stream, float, state, line_width);
 328    util_dump_member(stream, float, state, point_size);
 329    util_dump_member(stream, float, state, offset_units);
 330    util_dump_member(stream, float, state, offset_scale);
 331
 332    util_dump_struct_end(stream);
 333 }
 334
 335
 336 void
 337 util_dump_poly_stipple(struct os_stream *stream, const struct pipe_poly_stipple *state)
 338 {
 339    if(!state) {
 340       util_dump_null(stream);
 341       return;
 342    }
 343
 344    util_dump_struct_begin(stream, "pipe_poly_stipple");
 345
 346    util_dump_member_begin(stream, "stipple");
 347    util_dump_member_array(stream, uint, state, stipple);
 348    util_dump_member_end(stream);
 349
 350    util_dump_struct_end(stream);
 351 }
 352
 353
 354 void
 355 util_dump_viewport_state(struct os_stream *stream, const struct pipe_viewport_state *state)
 356 {
 357    if(!state) {
 358       util_dump_null(stream);
 359       return;
 360    }
 361
 362    util_dump_struct_begin(stream, "pipe_viewport_state");
 363
 364    util_dump_member_array(stream, float, state, scale);
 365    util_dump_member_array(stream, float, state, translate);
 366
 367    util_dump_struct_end(stream);
 368 }
 369
 370
 371 void
 372 util_dump_scissor_state(struct os_stream *stream, const struct pipe_scissor_state *state)
 373 {
 374    if(!state) {
 375       util_dump_null(stream);
 376       return;
 377    }
 378
 379    util_dump_struct_begin(stream, "pipe_scissor_state");
 380
 381    util_dump_member(stream, uint, state, minx);
 382    util_dump_member(stream, uint, state, miny);
 383    util_dump_member(stream, uint, state, maxx);
 384    util_dump_member(stream, uint, state, maxy);
 385
 386    util_dump_struct_end(stream);
 387 }
 388
 389
 390 void
 391 util_dump_clip_state(struct os_stream *stream, const struct pipe_clip_state *state)
 392 {
 393    unsigned i;
 394
 395    if(!state) {
 396       util_dump_null(stream);
 397       return;
 398    }
 399
 400    util_dump_struct_begin(stream, "pipe_clip_state");
 401
 402    util_dump_member_begin(stream, "ucp");
 403    util_dump_array_begin(stream);
 404    for(i = 0; i < PIPE_MAX_CLIP_PLANES; ++i) {
 405       util_dump_elem_begin(stream);
 406       util_dump_array(stream, float, state->ucp[i], 4);
 407       util_dump_elem_end(stream);
 408    }
 409    util_dump_array_end(stream);
 410    util_dump_member_end(stream);
 411
 412    util_dump_member(stream, uint, state, nr);
 413
 414    util_dump_struct_end(stream);
 415 }
 416
 417
 418 void
 419 util_dump_shader_state(struct os_stream *stream, const struct pipe_shader_state *state)
 420 {
 421    char str[8192];
 422
 423    if(!state) {
 424       util_dump_null(stream);
 425       return;
 426    }
 427
 428    tgsi_dump_str(state->tokens, 0, str, sizeof(str));
 429
 430    util_dump_struct_begin(stream, "pipe_shader_state");
 431
 432    util_dump_member_begin(stream, "tokens");
 433    util_dump_string(stream, str);
 434    util_dump_member_end(stream);
 435
 436    util_dump_struct_end(stream);
 437 }
 438
 439
 440 void
 441 util_dump_depth_stencil_alpha_state(struct os_stream *stream, const struct pipe_depth_stencil_alpha_state *state)
 442 {
 443    unsigned i;
 444
 445    if(!state) {
 446       util_dump_null(stream);
 447       return;
 448    }
 449
 450    util_dump_struct_begin(stream, "pipe_depth_stencil_alpha_state");
 451
 452    util_dump_member_begin(stream, "depth");
 453    util_dump_struct_begin(stream, "pipe_depth_state");
 454    util_dump_member(stream, bool, &state->depth, enabled);
 455    if (state->depth.enabled) {
 456       util_dump_member(stream, bool, &state->depth, writemask);
 457       util_dump_member(stream, enum_func, &state->depth, func);
 458    }
 459    util_dump_struct_end(stream);
 460    util_dump_member_end(stream);
 461
 462    util_dump_member_begin(stream, "stencil");
 463    util_dump_array_begin(stream);
 464    for(i = 0; i < Elements(state->stencil); ++i) {
 465       util_dump_elem_begin(stream);
 466       util_dump_struct_begin(stream, "pipe_stencil_state");
 467       util_dump_member(stream, bool, &state->stencil[i], enabled);
 468       if (state->stencil[i].enabled) {
 469          util_dump_member(stream, enum_func, &state->stencil[i], func);
 470          util_dump_member(stream, uint, &state->stencil[i], fail_op);
 471          util_dump_member(stream, uint, &state->stencil[i], zpass_op);
 472          util_dump_member(stream, uint, &state->stencil[i], zfail_op);
 473          util_dump_member(stream, uint, &state->stencil[i], valuemask);
 474          util_dump_member(stream, uint, &state->stencil[i], writemask);
 475       }
 476       util_dump_struct_end(stream);
 477       util_dump_elem_end(stream);
 478    }
 479    util_dump_array_end(stream);
 480    util_dump_member_end(stream);
 481
 482    util_dump_member_begin(stream, "alpha");
 483    util_dump_struct_begin(stream, "pipe_alpha_state");
 484    util_dump_member(stream, bool, &state->alpha, enabled);
 485    if (state->alpha.enabled) {
 486       util_dump_member(stream, enum_func, &state->alpha, func);
 487       util_dump_member(stream, float, &state->alpha, ref_value);
 488    }
 489    util_dump_struct_end(stream);
 490    util_dump_member_end(stream);
 491
 492    util_dump_struct_end(stream);
 493 }
 494
 495 void
 496 util_dump_rt_blend_state(struct os_stream *stream, const struct pipe_rt_blend_state *state)
 497 {
 498    util_dump_struct_begin(stream, "pipe_rt_blend_state");
 499
 500    util_dump_member(stream, uint, state, blend_enable);
 501    if (state->blend_enable) {
 502       util_dump_member(stream, enum_blend_func, state, rgb_func);
 503       util_dump_member(stream, enum_blend_factor, state, rgb_src_factor);
 504       util_dump_member(stream, enum_blend_factor, state, rgb_dst_factor);
 505
 506       util_dump_member(stream, enum_blend_func, state, alpha_func);
 507       util_dump_member(stream, enum_blend_factor, state, alpha_src_factor);
 508       util_dump_member(stream, enum_blend_factor, state, alpha_dst_factor);
 509    }
 510
 511    util_dump_member(stream, uint, state, colormask);
 512
 513    util_dump_struct_end(stream);
 514 }
 515
 516 void
 517 util_dump_blend_state(struct os_stream *stream, const struct pipe_blend_state *state)
 518 {
 519    unsigned valid_entries = 1;
 520
 521    if(!state) {
 522       util_dump_null(stream);
 523       return;
 524    }
 525
 526    util_dump_struct_begin(stream, "pipe_blend_state");
 527
 528    util_dump_member(stream, bool, state, dither);
 529
 530    util_dump_member(stream, bool, state, logicop_enable);
 531    if (state->logicop_enable) {
 532       util_dump_member(stream, enum_func, state, logicop_func);
 533    }
 534    else {
 535       util_dump_member(stream, bool, state, independent_blend_enable);
 536
 537       util_dump_member_begin(stream, "rt");
 538       if (state->independent_blend_enable)
 539          valid_entries = PIPE_MAX_COLOR_BUFS;
 540       util_dump_struct_array(stream, rt_blend_state, state->rt, valid_entries);
 541       util_dump_member_end(stream);
 542    }
 543
 544    util_dump_struct_end(stream);
 545 }
 546
 547
 548 void
 549 util_dump_blend_color(struct os_stream *stream, const struct pipe_blend_color *state)
 550 {
 551    if(!state) {
 552       util_dump_null(stream);
 553       return;
 554    }
 555
 556    util_dump_struct_begin(stream, "pipe_blend_color");
 557
 558    util_dump_member_array(stream, float, state, color);
 559
 560    util_dump_struct_end(stream);
 561 }
 562
 563 void
 564 util_dump_stencil_ref(struct os_stream *stream, const struct pipe_stencil_ref *state)
 565 {
 566    if(!state) {
 567       util_dump_null(stream);
 568       return;
 569    }
 570
 571    util_dump_struct_begin(stream, "pipe_stencil_ref");
 572
 573    util_dump_member_array(stream, uint, state, ref_value);
 574
 575    util_dump_struct_end(stream);
 576 }
 577
 578 void
 579 util_dump_framebuffer_state(struct os_stream *stream, const struct pipe_framebuffer_state *state)
 580 {
 581    util_dump_struct_begin(stream, "pipe_framebuffer_state");
 582
 583    util_dump_member(stream, uint, state, width);
 584    util_dump_member(stream, uint, state, height);
 585    util_dump_member(stream, uint, state, nr_cbufs);
 586    util_dump_member_array(stream, ptr, state, cbufs);
 587    util_dump_member(stream, ptr, state, zsbuf);
 588
 589    util_dump_struct_end(stream);
 590 }
 591
 592
 593 void
 594 util_dump_sampler_state(struct os_stream *stream, const struct pipe_sampler_state *state)
 595 {
 596    if(!state) {
 597       util_dump_null(stream);
 598       return;
 599    }
 600
 601    util_dump_struct_begin(stream, "pipe_sampler_state");
 602
 603    util_dump_member(stream, uint, state, wrap_s);
 604    util_dump_member(stream, uint, state, wrap_t);
 605    util_dump_member(stream, uint, state, wrap_r);
 606    util_dump_member(stream, uint, state, min_img_filter);
 607    util_dump_member(stream, uint, state, min_mip_filter);
 608    util_dump_member(stream, uint, state, mag_img_filter);
 609    util_dump_member(stream, uint, state, compare_mode);
 610    util_dump_member(stream, enum_func, state, compare_func);
 611    util_dump_member(stream, bool, state, normalized_coords);
 612    util_dump_member(stream, uint, state, max_anisotropy);
 613    util_dump_member(stream, float, state, lod_bias);
 614    util_dump_member(stream, float, state, min_lod);
 615    util_dump_member(stream, float, state, max_lod);
 616    util_dump_member_array(stream, float, state, border_color);
 617
 618    util_dump_struct_end(stream);
 619 }
 620
 621
 622 void
 623 util_dump_surface(struct os_stream *stream, const struct pipe_surface *state)
 624 {
 625    if(!state) {
 626       util_dump_null(stream);
 627       return;
 628    }
 629
 630    util_dump_struct_begin(stream, "pipe_surface");
 631
 632    util_dump_member(stream, format, state, format);
 633    util_dump_member(stream, uint, state, width);
 634    util_dump_member(stream, uint, state, height);
 635
 636    util_dump_member(stream, uint, state, layout);
 637    util_dump_member(stream, uint, state, offset);
 638    util_dump_member(stream, uint, state, usage);
 639
 640    util_dump_member(stream, ptr, state, texture);
 641    util_dump_member(stream, uint, state, face);
 642    util_dump_member(stream, uint, state, level);
 643    util_dump_member(stream, uint, state, zslice);
 644
 645    util_dump_struct_end(stream);
 646 }
 647
 648
 649 void
 650 util_dump_transfer(struct os_stream *stream, const struct pipe_transfer *state)
 651 {
 652    if(!state) {
 653       util_dump_null(stream);
 654       return;
 655    }
 656
 657    util_dump_struct_begin(stream, "pipe_transfer");
 658
 659    util_dump_member(stream, ptr, state, resource);
 660    /*util_dump_member(stream, uint, state, box);*/
 661
 662    util_dump_member(stream, uint, state, stride);
 663    util_dump_member(stream, uint, state, slice_stride);
 664
 665    /*util_dump_member(stream, ptr, state, data);*/
 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 }