xref: /gem5/src/mem/ruby/structures/TBETable.hh

/*
 * Copyright (c) 1999-2008 Mark D. Hill and David A. Wood
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met: redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer;
 * redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the distribution;
 * neither the name of the copyright holders nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

/*
 * TBETable.h
 *
 * Description:
 *
 * $Id$
 *
 */

#ifndef TBETABLE_H
#define TBETABLE_H

#include "Global.hh"
#include "Map.hh"
#include "Address.hh"
#include "Profiler.hh"
#include "AbstractChip.hh"
#include "System.hh"

template<class ENTRY>
class TBETable {
public:

  // Constructors
  TBETable(AbstractChip* chip_ptr);

  // Destructor
  //~TBETable();

  // Public Methods

  static void printConfig(ostream& out) { out << "TBEs_per_TBETable: " << NUMBER_OF_TBES << endl; }

  bool isPresent(const Address& address) const;
  void allocate(const Address& address);
  void deallocate(const Address& address);
  bool areNSlotsAvailable(int n) const { return (NUMBER_OF_TBES - m_map.size()) >= n; }

  ENTRY& lookup(const Address& address);
  const ENTRY& lookup(const Address& address) const;

  // Print cache contents
  void print(ostream& out) const;
private:
  // Private Methods

  // Private copy constructor and assignment operator
  TBETable(const TBETable& obj);
  TBETable& operator=(const TBETable& obj);

  // Data Members (m_prefix)
  Map<Address, ENTRY> m_map;
  AbstractChip* m_chip_ptr;
};

// Output operator declaration
//ostream& operator<<(ostream& out, const TBETable<ENTRY>& obj);

// ******************* Definitions *******************

// Output operator definition
template<class ENTRY>
extern inline
ostream& operator<<(ostream& out, const TBETable<ENTRY>& obj)
{
  obj.print(out);
  out << flush;
  return out;
}


// ****************************************************************

template<class ENTRY>
extern inline
TBETable<ENTRY>::TBETable(AbstractChip* chip_ptr)
{
  m_chip_ptr = chip_ptr;
}

// PUBLIC METHODS

// tests to see if an address is present in the cache
template<class ENTRY>
extern inline
bool TBETable<ENTRY>::isPresent(const Address& address) const
{
  assert(address == line_address(address));
  assert(m_map.size() <= NUMBER_OF_TBES);
  return m_map.exist(address);
}

template<class ENTRY>
extern inline
void TBETable<ENTRY>::allocate(const Address& address)
{
  assert(isPresent(address) == false);
  assert(m_map.size() < NUMBER_OF_TBES);
  g_system_ptr->getProfiler()->L2tbeUsageSample(m_map.size());
  m_map.add(address, ENTRY());
}

template<class ENTRY>
extern inline
void TBETable<ENTRY>::deallocate(const Address& address)
{
  assert(isPresent(address) == true);
  assert(m_map.size() > 0);
  m_map.erase(address);
}

// looks an address up in the cache
template<class ENTRY>
extern inline
ENTRY& TBETable<ENTRY>::lookup(const Address& address)
{
  assert(isPresent(address) == true);
  return m_map.lookup(address);
}

// looks an address up in the cache
template<class ENTRY>
extern inline
const ENTRY& TBETable<ENTRY>::lookup(const Address& address) const
{
  assert(isPresent(address) == true);
  return m_map.lookup(address);
}

template<class ENTRY>
extern inline
void TBETable<ENTRY>::print(ostream& out) const
{
}

#endif //TBETABLE_H