src/mem/ruby/common/Driver.hh

   1
   2 /*
   3  * Copyright (c) 1999-2008 Mark D. Hill and David A. Wood
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions are
   8  * met: redistributions of source code must retain the above copyright
   9  * notice, this list of conditions and the following disclaimer;
  10  * redistributions in binary form must reproduce the above copyright
  11  * notice, this list of conditions and the following disclaimer in the
  12  * documentation and/or other materials provided with the distribution;
  13  * neither the name of the copyright holders nor the names of its
  14  * contributors may be used to endorse or promote products derived from
  15  * this software without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  18  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  19  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  20  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  21  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  22  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  23  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  24  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  25  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  26  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  27  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28  */
  29
  30 #ifndef DRIVER_H
  31 #define DRIVER_H
  32
  33 #include "mem/ruby/common/Global.hh"
  34 #include "mem/ruby/common/Consumer.hh"
  35 #include "mem/ruby/system/NodeID.hh"
  36 #include "mem/protocol/CacheRequestType.hh"
  37 #include "mem/packet.hh"
  38
  39 class RubySystem;
  40 class SubBlock;
  41 class Address;
  42 class MachineID;
  43 class SimicsHypervisor;
  44
  45 class Driver {
  46 public:
  47   // Constructors
  48   Driver();
  49
  50   // Destructor
  51   virtual ~Driver() = 0;
  52
  53   // Public Methods
  54   virtual void get_network_config() {}
  55   virtual void hitCallback(Packet* pkt) = 0;
  56   virtual integer_t getInstructionCount(int procID) const { return 1; }
  57   virtual integer_t getCycleCount(int procID) const { return 1; }
  58
  59   virtual void printDebug(){}  //called by Sequencer
  60
  61   virtual void printStats(ostream& out) const = 0;
  62   virtual void clearStats() = 0;
  63
  64   virtual void printConfig(ostream& out) const = 0;
  65
  66   virtual integer_t readPhysicalMemory(int procID, physical_address_t address,
  67                                        int len ){ ASSERT(0); return 0; }
  68
  69   virtual void writePhysicalMemory( int procID, physical_address_t address,
  70                                     integer_t value, int len ){ ASSERT(0); }
  71
  72 protected:
  73   // accessible by subclasses
  74
  75 private:
  76   // inaccessible by subclasses
  77
  78 };
  79
  80 #endif //DRIVER_H