src/base/statistics.cc

   1 /*
   2  * Copyright (c) 2003-2005 The Regents of The University of Michigan
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions are
   7  * met: redistributions of source code must retain the above copyright
   8  * notice, this list of conditions and the following disclaimer;
   9  * redistributions in binary form must reproduce the above copyright
  10  * notice, this list of conditions and the following disclaimer in the
  11  * documentation and/or other materials provided with the distribution;
  12  * neither the name of the copyright holders nor the names of its
  13  * contributors may be used to endorse or promote products derived from
  14  * this software without specific prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  17  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  18  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  19  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  20  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  21  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  22  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  26  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  *
  28  * Authors: Nathan Binkert
  29  */
  30
  31 #include <iomanip>
  32 #include <fstream>
  33 #include <list>
  34 #include <map>
  35 #include <string>
  36
  37 #include "base/callback.hh"
  38 #include "base/cprintf.hh"
  39 #include "base/debug.hh"
  40 #include "base/hostinfo.hh"
  41 #include "base/misc.hh"
  42 #include "base/statistics.hh"
  43 #include "base/str.hh"
  44 #include "base/time.hh"
  45 #include "base/trace.hh"
  46
  47 using namespace std;
  48
  49 namespace Stats {
  50
  51 typedef map<const void *, Info *> MapType;
  52
  53 // We wrap these in a function to make sure they're built in time.
  54 list<Info *> &
  55 statsList()
  56 {
  57     static list<Info *> the_list;
  58     return the_list;
  59 }
  60
  61 MapType &
  62 statsMap()
  63 {
  64     static MapType the_map;
  65     return the_map;
  66 }
  67
  68 void
  69 InfoAccess::setInfo(Info *info)
  70 {
  71     if (statsMap().find(this) != statsMap().end())
  72         panic("shouldn't register stat twice!");
  73
  74     statsList().push_back(info);
  75
  76 #ifndef NDEBUG
  77     pair<MapType::iterator, bool> result =
  78 #endif
  79         statsMap().insert(make_pair(this, info));
  80     assert(result.second && "this should never fail");
  81     assert(statsMap().find(this) != statsMap().end());
  82 }
  83
  84 void
  85 InfoAccess::setParams(const StorageParams *params)
  86 {
  87     info()->storageParams = params;
  88 }
  89
  90 void
  91 InfoAccess::setInit()
  92 {
  93     info()->flags.set(init);
  94 }
  95
  96 Info *
  97 InfoAccess::info()
  98 {
  99     MapType::const_iterator i = statsMap().find(this);
 100     assert(i != statsMap().end());
 101     return (*i).second;
 102 }
 103
 104 const Info *
 105 InfoAccess::info() const
 106 {
 107     MapType::const_iterator i = statsMap().find(this);
 108     assert(i != statsMap().end());
 109     return (*i).second;
 110 }
 111
 112 StorageParams::~StorageParams()
 113 {
 114 }
 115
 116 typedef map<std::string, Info *> NameMapType;
 117 NameMapType &
 118 nameMap()
 119 {
 120     static NameMapType the_map;
 121     return the_map;
 122 }
 123
 124 int Info::id_count = 0;
 125
 126 int debug_break_id = -1;
 127
 128 Info::Info()
 129     : flags(none), precision(-1), prereq(0), storageParams(NULL)
 130 {
 131     id = id_count++;
 132     if (debug_break_id >= 0 and debug_break_id == id)
 133         debug_break();
 134 }
 135
 136 Info::~Info()
 137 {
 138 }
 139
 140 void
 141 Info::setName(const string &name)
 142 {
 143     pair<NameMapType::iterator, bool> p =
 144         nameMap().insert(make_pair(name, this));
 145
 146     Info *other = p.first->second;
 147     bool result = p.second;
 148
 149     if (!result) {
 150         // using other->name instead of just name to avoid a compiler
 151         // warning.  They should be the same.
 152         panic("same statistic name used twice! name=%s\n", other->name);
 153     }
 154
 155     this->name = name;
 156 }
 157
 158 bool
 159 Info::less(Info *stat1, Info *stat2)
 160 {
 161     const string &name1 = stat1->name;
 162     const string &name2 = stat2->name;
 163
 164     vector<string> v1;
 165     vector<string> v2;
 166
 167     tokenize(v1, name1, '.');
 168     tokenize(v2, name2, '.');
 169
 170     size_type last = min(v1.size(), v2.size()) - 1;
 171     for (off_type i = 0; i < last; ++i)
 172         if (v1[i] != v2[i])
 173             return v1[i] < v2[i];
 174
 175     // Special compare for last element.
 176     if (v1[last] == v2[last])
 177         return v1.size() < v2.size();
 178     else
 179         return v1[last] < v2[last];
 180
 181     return false;
 182 }
 183
 184 bool
 185 Info::baseCheck() const
 186 {
 187     if (!(flags & Stats::init)) {
 188 #ifdef DEBUG
 189         cprintf("this is stat number %d\n", id);
 190 #endif
 191         panic("Not all stats have been initialized");
 192         return false;
 193     }
 194
 195     if ((flags & display) && name.empty()) {
 196         panic("all printable stats must be named");
 197         return false;
 198     }
 199
 200     return true;
 201 }
 202
 203 void
 204 Info::enable()
 205 {
 206 }
 207
 208 void
 209 VectorInfo::enable()
 210 {
 211     size_type s = size();
 212     if (subnames.size() < s)
 213         subnames.resize(s);
 214     if (subdescs.size() < s)
 215         subdescs.resize(s);
 216 }
 217
 218 void
 219 VectorDistInfo::enable()
 220 {
 221     size_type s = size();
 222     if (subnames.size() < s)
 223         subnames.resize(s);
 224     if (subdescs.size() < s)
 225         subdescs.resize(s);
 226 }
 227
 228 void
 229 Vector2dInfo::enable()
 230 {
 231     if (subnames.size() < x)
 232         subnames.resize(x);
 233     if (subdescs.size() < x)
 234         subdescs.resize(x);
 235     if (y_subnames.size() < y)
 236         y_subnames.resize(y);
 237 }
 238
 239 void
 240 HistStor::grow_out()
 241 {
 242     int size = cvec.size();
 243     int zero = size / 2; // round down!
 244     int top_half = zero + (size - zero + 1) / 2; // round up!
 245     int bottom_half = (size - zero) / 2; // round down!
 246
 247     // grow down
 248     int low_pair = zero - 1;
 249     for (int i = zero - 1; i >= bottom_half; i--) {
 250         cvec[i] = cvec[low_pair];
 251         if (low_pair - 1 >= 0)
 252             cvec[i] += cvec[low_pair - 1];
 253         low_pair -= 2;
 254     }
 255     assert(low_pair == 0 || low_pair == -1 || low_pair == -2);
 256
 257     for (int i = bottom_half - 1; i >= 0; i--)
 258         cvec[i] = Counter();
 259
 260     // grow up
 261     int high_pair = zero;
 262     for (int i = zero; i < top_half; i++) {
 263         cvec[i] = cvec[high_pair];
 264         if (high_pair + 1 < size)
 265             cvec[i] += cvec[high_pair + 1];
 266         high_pair += 2;
 267     }
 268     assert(high_pair == size || high_pair == size + 1);
 269
 270     for (int i = top_half; i < size; i++)
 271         cvec[i] = Counter();
 272
 273     max_bucket *= 2;
 274     min_bucket *= 2;
 275     bucket_size *= 2;
 276 }
 277
 278 void
 279 HistStor::grow_convert()
 280 {
 281     int size = cvec.size();
 282     int half = (size + 1) / 2; // round up!
 283     //bool even = (size & 1) == 0;
 284
 285     int pair = size - 1;
 286     for (int i = size - 1; i >= half; --i) {
 287         cvec[i] = cvec[pair];
 288         if (pair - 1 >= 0)
 289             cvec[i] += cvec[pair - 1];
 290         pair -= 2;
 291     }
 292
 293     for (int i = half - 1; i >= 0; i--)
 294         cvec[i] = Counter();
 295
 296     min_bucket = -max_bucket;// - (even ? bucket_size : 0);
 297     bucket_size *= 2;
 298 }
 299
 300 void
 301 HistStor::grow_up()
 302 {
 303     int size = cvec.size();
 304     int half = (size + 1) / 2; // round up!
 305
 306     int pair = 0;
 307     for (int i = 0; i < half; i++) {
 308         cvec[i] = cvec[pair];
 309         if (pair + 1 < size)
 310             cvec[i] += cvec[pair + 1];
 311         pair += 2;
 312     }
 313     assert(pair == size || pair == size + 1);
 314
 315     for (int i = half; i < size; i++)
 316         cvec[i] = Counter();
 317
 318     max_bucket *= 2;
 319     bucket_size *= 2;
 320 }
 321
 322 Formula::Formula()
 323 {
 324 }
 325
 326 Formula::Formula(Temp r)
 327 {
 328     root = r;
 329     setInit();
 330     assert(size());
 331 }
 332
 333 const Formula &
 334 Formula::operator=(Temp r)
 335 {
 336     assert(!root && "Can't change formulas");
 337     root = r;
 338     setInit();
 339     assert(size());
 340     return *this;
 341 }
 342
 343 const Formula &
 344 Formula::operator+=(Temp r)
 345 {
 346     if (root)
 347         root = NodePtr(new BinaryNode<std::plus<Result> >(root, r));
 348     else {
 349         root = r;
 350         setInit();
 351     }
 352
 353     assert(size());
 354     return *this;
 355 }
 356
 357 void
 358 Formula::result(VResult &vec) const
 359 {
 360     if (root)
 361         vec = root->result();
 362 }
 363
 364 Result
 365 Formula::total() const
 366 {
 367     return root ? root->total() : 0.0;
 368 }
 369
 370 size_type
 371 Formula::size() const
 372 {
 373     if (!root)
 374         return 0;
 375     else
 376         return root->size();
 377 }
 378
 379 void
 380 Formula::reset()
 381 {
 382 }
 383
 384 bool
 385 Formula::zero() const
 386 {
 387     VResult vec;
 388     result(vec);
 389     for (VResult::size_type i = 0; i < vec.size(); ++i)
 390         if (vec[i] != 0.0)
 391             return false;
 392     return true;
 393 }
 394
 395 string
 396 Formula::str() const
 397 {
 398     return root ? root->str() : "";
 399 }
 400
 401 void
 402 enable()
 403 {
 404     typedef list<Info *>::iterator iter_t;
 405
 406     iter_t i, end = statsList().end();
 407     for (i = statsList().begin(); i != end; ++i) {
 408         Info *info = *i;
 409         assert(info);
 410         if (!info->check() || !info->baseCheck())
 411             panic("stat check failed for '%s' %d\n", info->name, info->id);
 412     }
 413
 414     off_t j = 0;
 415     for (i = statsList().begin(); i != end; ++i) {
 416         Info *info = *i;
 417         if (!(info->flags & display))
 418             info->name = "__Stat" + to_string(j++);
 419     }
 420
 421     statsList().sort(Info::less);
 422
 423     for (i = statsList().begin(); i != end; ++i) {
 424         Info *info = *i;
 425         info->enable();
 426     }
 427 }
 428
 429 void
 430 prepare()
 431 {
 432     list<Info *>::iterator i = statsList().begin();
 433     list<Info *>::iterator end = statsList().end();
 434     while (i != end) {
 435         Info *info = *i;
 436         info->prepare();
 437         ++i;
 438     }
 439 }
 440
 441 CallbackQueue resetQueue;
 442
 443 void
 444 reset()
 445 {
 446     list<Info *>::iterator i = statsList().begin();
 447     list<Info *>::iterator end = statsList().end();
 448     while (i != end) {
 449         Info *info = *i;
 450         info->reset();
 451         ++i;
 452     }
 453
 454     resetQueue.process();
 455 }
 456
 457 void
 458 registerResetCallback(Callback *cb)
 459 {
 460     resetQueue.add(cb);
 461 }
 462
 463 } // namespace Stats