src/base/annotate.hh

   1 /*
   2  * Copyright (c) 2006 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: Ali Saidi
  29  */
  30
  31 #ifndef __BASE__ANNOTATE_HH__
  32 #define __BASE__ANNOTATE_HH__
  33
  34 #include "sim/host.hh"
  35
  36 #include <string>
  37 #include <list>
  38 #include <map>
  39
  40
  41 class System;
  42
  43 namespace Annotate {
  44
  45
  46 class Annotate {
  47
  48   protected:
  49     struct AnnotateData {
  50         Tick time;
  51         std::string system;
  52         Addr stack;
  53         uint32_t stateMachine;
  54         uint32_t curState;
  55         uint32_t waitMachine;
  56         uint32_t waitState;
  57     };
  58
  59     std::list<AnnotateData*> data;
  60     std::map<System*, std::string> nameCache;
  61
  62   public:
  63    Annotate();
  64    void add(System *sys, Addr stack, uint32_t sm, uint32_t st, uint32_t
  65            wm, uint32_t ws);
  66    void dump();
  67 };
  68
  69 extern Annotate annotations;
  70 } //namespace Annotate
  71
  72 #endif //__BASE__ANNOTATE_HH__
  73