xref: /gem5/src/mem/ruby/structures/DirectoryMemory.cc

/*
 * 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.
 */

#include "base/intmath.hh"
#include "mem/ruby/slicc_interface/RubySlicc_Util.hh"
#include "mem/ruby/system/DirectoryMemory.hh"
#include "mem/ruby/system/System.hh"

using namespace std;

int DirectoryMemory::m_num_directories = 0;
int DirectoryMemory::m_num_directories_bits = 0;
uint64_t DirectoryMemory::m_total_size_bytes = 0;
int DirectoryMemory::m_numa_high_bit = 0;

DirectoryMemory::DirectoryMemory(const Params *p)
    : SimObject(p)
{
    m_version = p->version;
    m_size_bytes = p->size;
    m_size_bits = floorLog2(m_size_bytes);
    m_num_entries = 0;
    m_use_map = p->use_map;
    m_map_levels = p->map_levels;
    m_numa_high_bit = p->numa_high_bit;
}

void
DirectoryMemory::init()
{
    m_num_entries = m_size_bytes / RubySystem::getBlockSizeBytes();

    if (m_use_map) {
        int entry_bits = floorLog2(m_num_entries);
        assert(entry_bits >= m_map_levels);
        m_sparseMemory = new SparseMemory(entry_bits, m_map_levels);
    } else {
        m_entries = new Directory_Entry*[m_num_entries];
        for (int i = 0; i < m_num_entries; i++)
            m_entries[i] = NULL;
        m_ram = g_system_ptr->getMemoryVector();
    }

    m_num_directories++;
    m_num_directories_bits = floorLog2(m_num_directories);
    m_total_size_bytes += m_size_bytes;

    if (m_numa_high_bit == 0) {
        m_numa_high_bit = RubySystem::getMemorySizeBits();
    }
    assert(m_numa_high_bit != 0);
}

DirectoryMemory::~DirectoryMemory()
{
    // free up all the directory entries
    if (m_entries != NULL) {
        for (uint64 i = 0; i < m_num_entries; i++) {
            if (m_entries[i] != NULL) {
                delete m_entries[i];
            }
        }
        delete [] m_entries;
    } else if (m_use_map) {
        delete m_sparseMemory;
    }
}

void
DirectoryMemory::printConfig(ostream& out) const
{
    out << "DirectoryMemory module config: " << m_name << endl
        << "  version: " << m_version << endl
        << "  memory_bits: " << m_size_bits << endl
        << "  memory_size_bytes: " << m_size_bytes << endl
        << "  memory_size_Kbytes: " << double(m_size_bytes) / (1<<10) << endl
        << "  memory_size_Mbytes: " << double(m_size_bytes) / (1<<20) << endl
        << "  memory_size_Gbytes: " << double(m_size_bytes) / (1<<30) << endl;
}

// Static method
void
DirectoryMemory::printGlobalConfig(ostream & out)
{
    out << "DirectoryMemory Global Config: " << endl;
    out << "  number of directory memories: " << m_num_directories << endl;
    if (m_num_directories > 1) {
        out << "  number of selection bits: " << m_num_directories_bits << endl
            << "  selection bits: " << m_numa_high_bit
            << "-" << m_numa_high_bit-m_num_directories_bits
            << endl;
    }
    out << "  total memory size bytes: " << m_total_size_bytes << endl;
    out << "  total memory bits: " << floorLog2(m_total_size_bytes) << endl;
}

uint64
DirectoryMemory::mapAddressToDirectoryVersion(PhysAddress address)
{
    if (m_num_directories_bits == 0)
        return 0;

    uint64 ret = address.bitSelect(m_numa_high_bit - m_num_directories_bits,
                                   m_numa_high_bit);
    return ret;
}

bool
DirectoryMemory::isPresent(PhysAddress address)
{
    bool ret = (mapAddressToDirectoryVersion(address) == m_version);
    return ret;
}

uint64
DirectoryMemory::mapAddressToLocalIdx(PhysAddress address)
{
    uint64 ret = address.bitRemove(m_numa_high_bit - m_num_directories_bits,
                                   m_numa_high_bit)
        >> (RubySystem::getBlockSizeBits());
    return ret;
}

Directory_Entry&
DirectoryMemory::lookup(PhysAddress address)
{
    assert(isPresent(address));
    Directory_Entry* entry;
    uint64 idx;
    DEBUG_EXPR(CACHE_COMP, HighPrio, address);

    if (m_use_map) {
        if (m_sparseMemory->exist(address)) {
            entry = m_sparseMemory->lookup(address);
            assert(entry != NULL);
        } else {
            // Note: SparseMemory internally creates a new Directory Entry
            m_sparseMemory->add(address);
            entry = m_sparseMemory->lookup(address);
        }
    } else {
        idx = mapAddressToLocalIdx(address);
        assert(idx < m_num_entries);
        entry = m_entries[idx];

        if (entry == NULL) {
            entry = new Directory_Entry();
            entry->getDataBlk().assign(m_ram->getBlockPtr(address));
            m_entries[idx] = entry;
        }
    }

    return *entry;
}

#if 0
Directory_Entry&
DirectoryMemory::lookup(PhysAddress address)
{
    assert(isPresent(address));
    Index index = address.memoryModuleIndex();

    if (index < 0 || index > m_size) {
        WARN_EXPR(address.getAddress());
        WARN_EXPR(index);
        WARN_EXPR(m_size);
        ERROR_MSG("Directory Memory Assertion: accessing memory out of range");
    }
    Directory_Entry* entry = m_entries[index];

    // allocate the directory entry on demand.
    if (entry == NULL) {
        entry = new Directory_Entry;
        entry->getDataBlk().assign(m_ram->getBlockPtr(address));

        // store entry to the table
        m_entries[index] = entry;
    }

    return *entry;
}
#endif

void
DirectoryMemory::invalidateBlock(PhysAddress address)
{
    if (m_use_map) {
        assert(m_sparseMemory->exist(address));
        m_sparseMemory->remove(address);
    }
#if 0
    else {
        assert(isPresent(address));

        Index index = address.memoryModuleIndex();

        if (index < 0 || index > m_size) {
            ERROR_MSG("Directory Memory Assertion: "
                      "accessing memory out of range.");
        }

        if (m_entries[index] != NULL){
            delete m_entries[index];
            m_entries[index] = NULL;
        }
    }
#endif
}

void
DirectoryMemory::print(ostream& out) const
{
}

void
DirectoryMemory::printStats(ostream& out) const
{
    if (m_use_map) {
        m_sparseMemory->printStats(out);
    }
}

DirectoryMemory *
RubyDirectoryMemoryParams::create()
{
    return new DirectoryMemory(this);
}