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

   1 /**************************************************************************
   2  *
   3  * Copyright 2011 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 void
  88 addRegion(unsigned long long address, void *buffer, unsigned long long size);
  89
  90 void
  91 delRegionByPointer(void *ptr);
  92
  93 void *
  94 toPointer(trace::Value &value, bool bind = false);
  95
  96
  97 /**
  98  * Output verbosity when retracing files.
  99  */
 100 extern int verbosity;
 101
 102 /**
 103  * Add profiling data to the dump when retracing.
 104  */
 105 extern bool profiling;
 106
 107
 108 std::ostream &warning(trace::Call &call);
 109
 110
 111 void ignore(trace::Call &call);
 112 void unsupported(trace::Call &call);
 113
 114
 115 typedef void (*Callback)(trace::Call &call);
 116
 117 struct Entry {
 118     const char *name;
 119     Callback callback;
 120 };
 121
 122
 123 struct stringComparer {
 124   bool operator() (const char *a, const  char *b) const {
 125     return strcmp(a, b) < 0;
 126   }
 127 };
 128
 129
 130 extern const Entry stdc_callbacks[];
 131
 132
 133 class Retracer
 134 {
 135     typedef std::map<const char *, Callback, stringComparer> Map;
 136     Map map;
 137
 138     std::vector<Callback> callbacks;
 139
 140 public:
 141     Retracer() {
 142         addCallbacks(stdc_callbacks);
 143     }
 144
 145     virtual ~Retracer() {}
 146
 147     void addCallback(const Entry *entry);
 148     void addCallbacks(const Entry *entries);
 149
 150     void retrace(trace::Call &call);
 151 };
 152
 153
 154 } /* namespace retrace */
 155
 156 #endif /* _RETRACE_HPP_ */