dramsim2_wrapper.hh

Go to the documentation of this file.

/*
 * Copyright (c) 2013 ARM Limited
 * All rights reserved
 *
 * The license below extends only to copyright in the software and shall
 * not be construed as granting a license to any other intellectual
 * property including but not limited to intellectual property relating
 * to a hardware implementation of the functionality of the software
 * licensed hereunder.  You may use the software subject to the license
 * terms below provided that you ensure that this notice is replicated
 * unmodified and in its entirety in all distributions of the software,
 * modified or unmodified, in source code or in binary form.
 *
 * 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.
 */
 
#ifndef __MEM_DRAMSIM2_WRAPPER_HH__
#define __MEM_DRAMSIM2_WRAPPER_HH__
 
#include <string>
 
#include "DRAMSim2/Callback.h"
 
namespace DRAMSim {
 
class MultiChannelMemorySystem;
 
}
 
class DRAMSim2Wrapper
{
 
  private:
 
    DRAMSim::MultiChannelMemorySystem* dramsim;
 
    double _clockPeriod;
 
    unsigned int _queueSize;
 
    unsigned int _burstSize;
 
    template <typename T>
    T extractConfig(const std::string& field_name,
                    const std::string& file_name) const;
 
  public:
 
    DRAMSim2Wrapper(const std::string& config_file,
                    const std::string& system_file,
                    const std::string& working_dir,
                    const std::string& trace_file,
                    unsigned int memory_size_mb,
                    bool enable_debug);
    ~DRAMSim2Wrapper();
 
    void printStats();
 
    void setCallbacks(DRAMSim::TransactionCompleteCB* read_callback,
                      DRAMSim::TransactionCompleteCB* write_callback);
 
    bool canAccept() const;
 
    void enqueue(bool is_write, uint64_t addr);
 
    double clockPeriod() const;
 
    unsigned int queueSize() const;
 
    unsigned int burstSize() const;
 
    void tick();
};
 
#endif //__MEM_DRAMSIM2_WRAPPER_HH__