VCD.cpp

Go to the documentation of this file.

/*
 
        @copyright
 
        <pre>
 
        Copyright 2018 Infineon Technologies AG
 
        This file is part of ETISS tool, see <https://github.com/tum-ei-eda/etiss>.
 
        The initial version of this software has been created with the funding support by the German Federal
        Ministry of Education and Research (BMBF) in the project EffektiV under grant 01IS13022.
 
        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.
 
        </pre>
 
        @author Marc Greim <marc.greim@mytum.de>, Chair of Electronic Design Automation, TUM
 
        @version 0.1
 
*/
 
#include "etiss/interfaces/VCD.h"
 
namespace etiss
{
namespace interfaces
{
 
static std::string val2str(uint64_t val, unsigned width, uint64_t udef)
{
    if (width == 1)
    {
        return (udef & 1) ? "x" : ((val & 1) ? "1" : "0");
    }
    else
    {
        char *ret = new char[width + 3];
        ret[0] = 'b';
        ret[width + 1] = ' ';
        ret[width + 2] = 0;
        for (unsigned i = 1; i < width + 1; i++)
        {
            ret[width + 1 - i] = (udef & 1) ? 'x' : ((val & 1) ? '1' : '0');
            val = val >> 1;
            udef = udef >> 1;
        }
        std::string r(ret);
        delete[] ret;
        return r;
    }
}
 
static std::string index2str(int index)
{
    std::string out;
    while (true)
    {
        out += static_cast<char>(index % 94) + 33;
        if (index < 94)
            break;
        index -= 94;
        index /= 94;
    }
    return out;
}
 
VCD::VCD(const std::string &file, const std::string &comment) : dumpstarted_(false), lasttime_ps(0), file(file)
{
    out_.open(file);
    valid_ = out_.is_open();
 
    if (!valid_)
    {
        etiss::log(etiss::WARNING, "Failed to open file for VCD output: " + file);
    }
    else
    {
        out_ << "$date\n"
                "       \n" 
                "$end\n"
                "$version\n"
                "       ETISS " ETISS_VERSION_FULL "\n"
                "$end\n"
                "$comment\n"
             << comment
             << "\n"
                "$end\n"
                "$timescale 1ps $end\n"; 
    }
 
    dumpvar = "$enddefinitions $end\n$dumpvars\n";
}
 
VCD::~VCD()
{
    close();
}
 
void VCD::close()
{
    if (!valid_)
        return;
    valid_ = false;
    flush();
    out_.close();
}
 
bool VCD::declare(void *variable, const std::string &name, unsigned width, uint64_t initialvalue, uint64_t undefined)
{
    if (!valid_)
        return false;
    if (name.size() == 0)
    {
        etiss::log(etiss::ERROR, "Cannot call etiss::interfaces::VCD::declare without a name.", *this);
        return false;
    }
    if (dumpstarted_)
    {
        etiss::log(etiss::ERROR, "Cannot call etiss::interfaces::VCD::declare after dump started.", *this);
        return false;
    }
    if (sigs_.size() >= (94 + 94 * 94 + 94 * 94 * 94 + 94 * 94 * 94 * 94))
    {
        etiss::log(etiss::ERROR, "etiss::interfaces::VCD::declare called for more than supported variables.", *this);
        return false;
    }
    int checked_sig_size = static_cast<int>(sigs_.size());
    sigs_.emplace_back();
    Signal &sig = sigs_.back();
 
    sig.valid = false;
    sig.name = name;
    sig.value = initialvalue;
    sig.width = width;
    sig.ident = index2str(checked_sig_size - 1);
    sig.undefined = undefined;
 
    // declare signal
    {
        // split on dots and double quotes to get the submodules and enter their scopes
        std::list<std::string> vec_bd = etiss::split(name, [](const std::string &str, size_t from, size_t &seplen) {
            size_t f1 = str.find(".", from);
            size_t f2 = str.find("::", from);
            seplen = f1 < f2 ? 1 : 2;
            return f1 < f2 ? f1 : f2;
        });
        std::vector<std::string> vec;
        vec.insert(vec.end(), vec_bd.begin(), vec_bd.end());
        if (vec.size() == 0)
            vec.push_back(name);
        for (size_t i = 1; i < vec.size(); i++)
        {
            out_ << "$scope module " << vec[i - 1] << " $end\n";
        }
        out_ << "$var wire " << width << " " << sig.ident << " " << vec[vec.size() - 1] << " $end\n";
        for (size_t i = 1; i < vec.size(); i++)
        {
            out_ << "$upscope $end\n";
        }
    }
 
    dumpvar = dumpvar + val2str(initialvalue, width, undefined) + sig.ident + "\n";
 
    ptr2index_.insert(std::make_pair(variable, (checked_sig_size - 1)));
 
    out_.flush();
 
    return true;
}
void VCD::update(uint64_t time_ps, void *variable, uint64_t value, uint64_t undefined)
{
    if (!valid_)
        return;
    if (time_ps < lasttime_ps)
    {
        etiss::log(etiss::ERROR, "etiss::interfaces::VCD::update called with decreased time value");
    }
 
    auto findex = ptr2index_.find(variable);
    if (findex != ptr2index_.end())
    {
        if (time_ps > lasttime_ps)
        {
            flush();
            lasttime_ps = time_ps;
        }
        int index = findex->second;
        Signal &sig = sigs_[index];
        sig.valid = true;
        sig.value = value;
        sig.undefined = undefined;
    }
    else
    {
        // not a declared vriable. ignore
    }
}
void VCD::flush()
{
    if (!valid_)
        return;
    dumpstarted_ = true;
    if (lasttime_ps == 0)
    {
        out_ << dumpvar;
        out_ << "$end\n"; // terminate dumpvars
    }
    bool empty = true;
    for (size_t i = 0; i < sigs_.size(); i++)
    {
        if (sigs_[i].valid)
        {
            empty = false;
            break;
        }
    }
    if (empty)
        return;
    out_ << "#" << lasttime_ps << "\n";
    for (size_t i = 0; i < sigs_.size(); i++)
    {
        Signal &s = sigs_[i];
        if (s.valid)
        {
            out_ << val2str(s.value, s.width, s.undefined) << s.ident << "\n";
            s.valid = false;
        }
    }
    // out_.flush();
}
 
} // namespace interfaces
} // namespace etiss