src/mem/ruby/common/Driver.hh

   1 /*
   2  * Copyright (c) 1999-2008 Mark D. Hill and David A. Wood
   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
  29 #ifndef __MEM_RUBY_COMMON_DRIVER_HH__
  30 #define __MEM_RUBY_COMMON_DRIVER_HH__
  31
  32 #include <iostream>
  33
  34 #include "mem/ruby/common/Address.hh"
  35 #include "mem/ruby/common/Consumer.hh"
  36 #include "mem/ruby/common/Global.hh"
  37 #include "mem/ruby/system/NodeID.hh"
  38
  39 class Driver
  40 {
  41   public:
  42     Driver();
  43     virtual ~Driver() = 0;
  44
  45     // Public Methods
  46     virtual void get_network_config() {}
  47     virtual void dmaHitCallback() {};
  48     virtual void hitCallback(int64_t id) = 0; // Called by sequencer
  49     virtual void go() = 0;
  50     virtual integer_t getInstructionCount(int procID) const;
  51     virtual integer_t getCycleCount(int procID) const;
  52     virtual void addThreadDependency(int procID, int requestor_thread,
  53                                      int conflict_thread) const;
  54     virtual void printDebug(); //called by Sequencer
  55
  56     virtual void printStats(std::ostream& out) const = 0;
  57     virtual void clearStats() = 0;
  58
  59     virtual void printConfig(std::ostream& out) const = 0;
  60
  61     virtual integer_t readPhysicalMemory(int procID, physical_address_t addr,
  62                                          int len);
  63     virtual void writePhysicalMemory(int procID, physical_address_t addr,
  64                                      integer_t value, int len);
  65 };
  66
  67 #endif //__MEM_RUBY_COMMON_DRIVER_HH__