src/mem/ruby/system/AbstractMemOrCache.hh

   1 /*
   2  * Copyright (c) 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 /*
  30  * AbstractMemOrCache.hh
  31  *
  32  * Description:
  33  *
  34  *
  35  */
  36
  37 #ifndef ABSTRACT_MEM_OR_CACHE_H
  38 #define ABSTRACT_MEM_OR_CACHE_H
  39
  40 #include "mem/ruby/common/Global.hh"
  41 #include "mem/ruby/common/Address.hh"
  42
  43 class AbstractMemOrCache {
  44 public:
  45
  46   virtual ~AbstractMemOrCache() {};
  47   virtual void setConsumer(Consumer* consumer_ptr) = 0;
  48   virtual Consumer* getConsumer() = 0;
  49
  50   virtual void enqueue (const MsgPtr& message, int latency ) = 0;
  51   virtual void enqueueMemRef (MemoryNode& memRef) = 0;
  52   virtual void dequeue () = 0;
  53   virtual const Message* peek () = 0;
  54   virtual bool isReady () = 0;
  55   virtual MemoryNode peekNode () = 0;
  56   virtual bool areNSlotsAvailable (int n) = 0;
  57   virtual void printConfig (ostream& out) = 0;
  58   virtual void print (ostream& out) const = 0;
  59   virtual void setDebug (int debugFlag) = 0;
  60
  61 private:
  62
  63 };
  64
  65
  66 #endif
  67