git.cworth.org Git - apitrace/blob - retrace.hpp

   1 /**************************************************************************
   2  *
   3  * Copyright 2011-2012 Jose Fonseca
   4  * All Rights Reserved.
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a copy
   7  * of this software and associated documentation files (the "Software"), to deal
   8  * in the Software without restriction, including without limitation the rights
   9  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  10  * copies of the Software, and to permit persons to whom the Software is
  11  * furnished to do so, subject to the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be included in
  14  * all copies or substantial portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  22  * THE SOFTWARE.
  23  *
  24  **************************************************************************/
  25
  26 #ifndef _RETRACE_HPP_
  27 #define _RETRACE_HPP_
  28
  29 #include <string.h>
  30
  31 #include <list>
  32 #include <map>
  33 #include <ostream>
  34
  35 #include "trace_model.hpp"
  36 #include "trace_parser.hpp"
  37
  38
  39 namespace retrace {
  40
  41
  42 extern trace::Parser parser;
  43
  44
  45 /**
  46  * Handle map.
  47  *
  48  * It is just like a regular std::map<T, T> container, but lookups of missing
  49  * keys return the key instead of default constructor.
  50  *
  51  * This is necessary for several GL named objects, where one can either request
  52  * the implementation to generate an unique name, or pick a value never used
  53  * before.
  54  *
  55  * XXX: In some cases, instead of returning the key, it would make more sense
  56  * to return an unused data value (e.g., container count).
  57  */
  58 template <class T>
  59 class map
  60 {
  61 private:
  62     typedef std::map<T, T> base_type;
  63     base_type base;
  64
  65 public:
  66
  67     T & operator[] (const T &key) {
  68         typename base_type::iterator it;
  69         it = base.find(key);
  70         if (it == base.end()) {
  71             return (base[key] = key);
  72         }
  73         return it->second;
  74     }
  75
  76     const T & operator[] (const T &key) const {
  77         typename base_type::const_iterator it;
  78         it = base.find(key);
  79         if (it == base.end()) {
  80             return (base[key] = key);
  81         }
  82         return it->second;
  83     }
  84 };
  85
  86
  87 /**
  88  * Similar to alloca(), but implemented with malloc.
  89  */
  90 class ScopedAllocator
  91 {
  92 private:
  93     void *next;
  94
  95 public:
  96     ScopedAllocator() :
  97         next(NULL) {
  98     }
  99
 100     inline void *
 101     alloc(size_t size) {
 102         if (!size) {
 103             return NULL;
 104         }
 105
 106         void * * buf = static_cast<void **>(malloc(sizeof(void *) + size));
 107         if (!buf) {
 108             return NULL;
 109         }
 110
 111         *buf = next;
 112         next = buf;
 113
 114         return &buf[1];
 115     }
 116
 117     template< class T >
 118     inline T *
 119     alloc(size_t n = 1) {
 120         return static_cast<T *>(alloc(sizeof(T) * n));
 121     }
 122
 123     /**
 124      * Allocate an array with the same dimensions as the specified value.
 125      */
 126     template< class T >
 127     inline T *
 128     alloc(const trace::Value *value) {
 129         const trace::Array *array = dynamic_cast<const trace::Array *>(value);
 130         if (array) {
 131             return alloc<T>(array->size());
 132         }
 133         const trace::Null *null = dynamic_cast<const trace::Null *>(value);
 134         if (null) {
 135             return NULL;
 136         }
 137         assert(0);
 138         return NULL;
 139     }
 140
 141     inline
 142     ~ScopedAllocator() {
 143         while (next) {
 144             void *temp = *static_cast<void **>(next);
 145             free(next);
 146             next = temp;
 147         }
 148     }
 149 };
 150
 151
 152 void
 153 addRegion(unsigned long long address, void *buffer, unsigned long long size);
 154
 155 void
 156 delRegionByPointer(void *ptr);
 157
 158 void *
 159 toPointer(trace::Value &value, bool bind = false);
 160
 161
 162 /**
 163  * Output verbosity when retracing files.
 164  */
 165 extern int verbosity;
 166
 167 /**
 168  * Add profiling data to the dump when retracing.
 169  */
 170 extern bool profiling;
 171
 172
 173 std::ostream &warning(trace::Call &call);
 174
 175
 176 void ignore(trace::Call &call);
 177 void unsupported(trace::Call &call);
 178
 179
 180 typedef void (*Callback)(trace::Call &call);
 181
 182 struct Entry {
 183     const char *name;
 184     Callback callback;
 185 };
 186
 187
 188 struct stringComparer {
 189   bool operator() (const char *a, const  char *b) const {
 190     return strcmp(a, b) < 0;
 191   }
 192 };
 193
 194
 195 extern const Entry stdc_callbacks[];
 196
 197
 198 class Retracer
 199 {
 200     typedef std::map<const char *, Callback, stringComparer> Map;
 201     Map map;
 202
 203     std::vector<Callback> callbacks;
 204
 205 public:
 206     Retracer() {
 207         addCallbacks(stdc_callbacks);
 208     }
 209
 210     virtual ~Retracer() {}
 211
 212     void addCallback(const Entry *entry);
 213     void addCallbacks(const Entry *entries);
 214
 215     void retrace(trace::Call &call);
 216 };
 217
 218
 219 } /* namespace retrace */
 220
 221 #endif /* _RETRACE_HPP_ */