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