DRAMSys/DRAMSys/library/src/common/utils.cpp

/*
 * Copyright (c) 2015, Technische Universität Kaiserslautern
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 *
 * 2. 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.
 *
 * 3. Neither the name of the copyright holder 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 HOLDER
 * 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.
 *
 * Authors:
 *    Janik Schlemminger
 *    Robert Gernhardt
 *    Matthias Jung
 *    Luiza Correa
 */

#include <sstream>
#include <fstream>

#include "utils.h"

using namespace sc_core;
using namespace tlm;
using json = nlohmann::json;

bool TimeInterval::timeIsInInterval(const sc_time &time) const
{
    return (start < time && time < end);
}

bool TimeInterval::intersects(const TimeInterval &other) const
{
    return other.timeIsInInterval(this->start)
           || this->timeIsInInterval(other.start);
}

sc_time TimeInterval::getLength() const
{
    if (end > start)
        return end - start;
    else
        return start - end;
}

std::string getPhaseName(const tlm_phase &phase)
{
    std::ostringstream oss;
    oss << phase;
    return oss.str();
}

json parseJSON(const std::string &path)
{
    std::ifstream file(path);
    if (file.is_open())
    {
        json j = json::parse(file, nullptr, false);
        if (!j.is_discarded())
            return j;
        else
            throw std::invalid_argument("JSON parse error in file '" + path + "'.");
    }
    else
        throw std::invalid_argument("Failed to open file '" + path + "'.");
}

bool parseBool(json &spec, const std::string &name)
{
    json param = spec[name];
    if (!param.empty())
    {
        if (param.is_boolean())
            return param;
        else
            throw std::invalid_argument("Expected type for parameter '" + name + "': bool");
    }
    else
    {
        SC_REPORT_WARNING("utils", ("Parameter '" + name + "' does not exist, default is false.").c_str());
        return false;
    }
}

unsigned int parseUint(json &spec, const std::string &name)
{
    json param = spec[name];
    if (!param.empty())
    {
        if (param.is_number_unsigned())
            return param;
        else
            throw std::invalid_argument("Expected type for parameter '" + name + "': unsigned int");
    }
    else
    {
        SC_REPORT_WARNING("utils", ("Parameter '" + name + "' does not exist, default is 1.").c_str());
        return 1;
    }
}

double parseUdouble(json &spec, const std::string &name)
{
    json param = spec[name];
    if (!param.empty())
    {
        if (param.is_number() && (param > 0))
            return param;
        else
            throw std::invalid_argument("Expected type for parameter '" + name + "': positive double");
    }
    else
    {
        SC_REPORT_WARNING("utils", ("Parameter '" + name + "' does not exist, default is 1.").c_str());
        return 1;
    }
}

std::string parseString(json &spec, const std::string &name)
{
    json param = spec[name];
    if (!param.empty())
    {
        if (param.is_string())
            return param;
        else
            throw std::invalid_argument("Expected type for parameter '" + name + "': string");
    }
    else
    {
        SC_REPORT_WARNING("utils", ("Parameter '" + name + "' does not exist.").c_str());
        return {};
    }
}

void setUpDummy(tlm_generic_payload &payload, uint64_t channelPayloadID, Rank rank, BankGroup bankGroup, Bank bank)
{
    payload.set_address(0);
    payload.set_command(TLM_IGNORE_COMMAND);
    payload.set_data_length(0);
    payload.set_response_status(TLM_OK_RESPONSE);
    payload.set_dmi_allowed(false);
    payload.set_byte_enable_length(0);
    payload.set_streaming_width(0);
    DramExtension::setExtension(payload, Thread(UINT_MAX), Channel(0), rank, bankGroup, bank, Row(0), Column(0),
                                0, 0, channelPayloadID);
    payload.set_extension(new GenerationExtension(SC_ZERO_TIME));
}