src/gallium/drivers/trace/tr_dump.h

   1 /**************************************************************************
   2  *
   3  * Copyright 2008 Tungsten Graphics, Inc., Cedar Park, Texas.
   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 TUNGSTEN GRAPHICS 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  * @file
  30  * Trace data dumping primitives.
  31  */
  32
  33 #ifndef TR_DUMP_H
  34 #define TR_DUMP_H
  35
  36
  37 #include "pipe/p_compiler.h"
  38
  39
  40 struct pipe_buffer;
  41 struct pipe_texture;
  42 struct pipe_surface;
  43 struct pipe_transfer;
  44
  45 boolean trace_dump_trace_begin(void);
  46 boolean trace_dump_enabled(void);
  47 void trace_dump_trace_end(void);
  48 void trace_dump_call_begin(const char *klass, const char *method);
  49 void trace_dump_call_end(void);
  50 void trace_dump_arg_begin(const char *name);
  51 void trace_dump_arg_end(void);
  52 void trace_dump_ret_begin(void);
  53 void trace_dump_ret_end(void);
  54 void trace_dump_bool(int value);
  55 void trace_dump_int(long long int value);
  56 void trace_dump_uint(long long unsigned value);
  57 void trace_dump_float(double value);
  58 void trace_dump_bytes(const void *data, long unsigned size);
  59 void trace_dump_string(const char *str);
  60 void trace_dump_enum(const char *value);
  61 void trace_dump_array_begin(void);
  62 void trace_dump_array_end(void);
  63 void trace_dump_elem_begin(void);
  64 void trace_dump_elem_end(void);
  65 void trace_dump_struct_begin(const char *name);
  66 void trace_dump_struct_end(void);
  67 void trace_dump_member_begin(const char *name);
  68 void trace_dump_member_end(void);
  69 void trace_dump_null(void);
  70 void trace_dump_ptr(const void *value);
  71 /* will turn a wrapped object into the real one and dump ptr */
  72 void trace_dump_buffer_ptr(struct pipe_buffer *_buffer);
  73 void trace_dump_texture_ptr(struct pipe_texture *_texture);
  74 void trace_dump_surface_ptr(struct pipe_surface *_surface);
  75 void trace_dump_transfer_ptr(struct pipe_transfer *_transfer);
  76
  77 /*
  78  * Code saving macros.
  79  */
  80
  81 #define trace_dump_arg(_type, _arg) \
  82    do { \
  83       trace_dump_arg_begin(#_arg); \
  84       trace_dump_##_type(_arg); \
  85       trace_dump_arg_end(); \
  86    } while(0)
  87
  88 #define trace_dump_ret(_type, _arg) \
  89    do { \
  90       trace_dump_ret_begin(); \
  91       trace_dump_##_type(_arg); \
  92       trace_dump_ret_end(); \
  93    } while(0)
  94
  95 #define trace_dump_array(_type, _obj, _size) \
  96    do { \
  97       unsigned long idx; \
  98       trace_dump_array_begin(); \
  99       for(idx = 0; idx < (_size); ++idx) { \
 100          trace_dump_elem_begin(); \
 101          trace_dump_##_type((_obj)[idx]); \
 102          trace_dump_elem_end(); \
 103       } \
 104       trace_dump_array_end(); \
 105    } while(0)
 106
 107 #define trace_dump_struct_array(_type, _obj, _size) \
 108    do { \
 109       unsigned long idx; \
 110       trace_dump_array_begin(); \
 111       for(idx = 0; idx < (_size); ++idx) { \
 112          trace_dump_elem_begin(); \
 113          trace_dump_##_type(&(_obj)[idx]); \
 114          trace_dump_elem_end(); \
 115       } \
 116       trace_dump_array_end(); \
 117    } while(0)
 118
 119 #define trace_dump_member(_type, _obj, _member) \
 120    do { \
 121       trace_dump_member_begin(#_member); \
 122       trace_dump_##_type((_obj)->_member); \
 123       trace_dump_member_end(); \
 124    } while(0)
 125
 126 #define trace_dump_arg_array(_type, _arg, _size) \
 127    do { \
 128       trace_dump_arg_begin(#_arg); \
 129       trace_dump_array(_type, _arg, _size); \
 130       trace_dump_arg_end(); \
 131    } while(0)
 132
 133 #define trace_dump_member_array(_type, _obj, _member) \
 134    do { \
 135       trace_dump_member_begin(#_member); \
 136       trace_dump_array(_type, (_obj)->_member, sizeof((_obj)->_member)/sizeof((_obj)->_member[0])); \
 137       trace_dump_member_end(); \
 138    } while(0)
 139
 140
 141 #endif /* TR_DUMP_H */