510 lines
12 KiB
C++
510 lines
12 KiB
C++
// OpenSTA, Static Timing Analyzer
|
||
// Copyright (c) 2022, Parallax Software, Inc.
|
||
//
|
||
// This program is free software: you can redistribute it and/or modify
|
||
// it under the terms of the GNU General Public License as published by
|
||
// the Free Software Foundation, either version 3 of the License, or
|
||
// (at your option) any later version.
|
||
//
|
||
// This program is distributed in the hope that it will be useful,
|
||
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||
// GNU General Public License for more details.
|
||
//
|
||
// You should have received a copy of the GNU General Public License
|
||
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||
|
||
#include <string>
|
||
#include <cctype>
|
||
#include <vector>
|
||
#include <map>
|
||
#include <algorithm>
|
||
|
||
#include "ReadVcd.hh"
|
||
|
||
#include "Zlib.hh"
|
||
#include "Report.hh"
|
||
#include "StringUtil.hh"
|
||
#include "StaState.hh"
|
||
|
||
namespace sta {
|
||
|
||
using std::string;
|
||
using std::isspace;
|
||
using std::vector;
|
||
using std::map;
|
||
using std::max;
|
||
using std::min;
|
||
|
||
class VcdVar;
|
||
class VcdValue;
|
||
typedef vector<VcdValue> VcdValues;
|
||
typedef int64_t VarTime;
|
||
typedef vector<string> VcdScope;
|
||
|
||
// Very imprecise syntax definition
|
||
// https://en.wikipedia.org/wiki/Value_change_dump#Structure.2FSyntax
|
||
// Much better syntax definition
|
||
// https://web.archive.org/web/20120323132708/http://www.beyondttl.com/vcd.php
|
||
|
||
class VcdReader : public StaState
|
||
{
|
||
public:
|
||
VcdReader(StaState *sta);
|
||
void read(const char *filename);
|
||
void reportWaveforms();
|
||
|
||
private:
|
||
void parseTimescale();
|
||
void parseVar();
|
||
void parseScope();
|
||
void parseUpscope();
|
||
void parseVarValues();
|
||
void makeVarIdMap();
|
||
void appendVarValue(string id,
|
||
char value);
|
||
string getToken();
|
||
string readStmtString();
|
||
vector<string> readStmtTokens();
|
||
VcdValues &values(VcdVar &var);
|
||
|
||
gzFile stream_;
|
||
string token_;
|
||
const char *filename_;
|
||
int file_line_;
|
||
int stmt_line_;
|
||
|
||
string date_;
|
||
string comment_;
|
||
string version_;
|
||
double time_scale_;
|
||
string time_unit_;
|
||
double time_unit_scale_;
|
||
vector<VcdVar> vars_;
|
||
size_t max_var_name_length_;
|
||
int max_var_width_;
|
||
map<string, VcdValues> id_values_map_;
|
||
VarTime time_;
|
||
VarTime prev_time_;
|
||
VarTime min_delta_time_;
|
||
VarTime time_max_;
|
||
VcdScope scope_;
|
||
};
|
||
|
||
class VcdVar
|
||
{
|
||
public:
|
||
enum VarType {wire, reg, parameter};
|
||
VcdVar(string name,
|
||
VarType type,
|
||
int width,
|
||
string id);
|
||
const string& name() const { return name_; }
|
||
VarType type() const { return type_; }
|
||
int width() const { return width_; }
|
||
const string& id() const { return id_; }
|
||
|
||
private:
|
||
string name_;
|
||
VarType type_;
|
||
int width_;
|
||
string id_;
|
||
};
|
||
|
||
class VcdValue
|
||
{
|
||
public:
|
||
VcdValue(VarTime time,
|
||
char value,
|
||
uint64_t bus_value);
|
||
VarTime time() const { return time_; }
|
||
char value() const { return value_; }
|
||
uint64_t busValue() const { return bus_value_; }
|
||
|
||
private:
|
||
VarTime time_;
|
||
// 01XUZ or '\0' when width > 1 to use bus_value_.
|
||
char value_;
|
||
uint64_t bus_value_;
|
||
};
|
||
|
||
void
|
||
readVcdFile(const char *filename,
|
||
StaState *sta)
|
||
|
||
{
|
||
VcdReader reader(sta);
|
||
reader.read(filename);
|
||
reader.reportWaveforms();
|
||
}
|
||
|
||
void
|
||
VcdReader::read(const char *filename)
|
||
{
|
||
stream_ = gzopen(filename, "r");
|
||
if (stream_) {
|
||
filename_ = filename;
|
||
file_line_ = 1;
|
||
stmt_line_ = 1;
|
||
string token = getToken();
|
||
while (!token.empty()) {
|
||
if (token == "$date")
|
||
date_ = readStmtString();
|
||
else if (token == "$comment")
|
||
comment_ = readStmtString();
|
||
else if (token == "$version")
|
||
version_ = readStmtString();
|
||
else if (token == "$timescale")
|
||
parseTimescale();
|
||
else if (token == "$var")
|
||
parseVar();
|
||
else if (token == "$scope")
|
||
parseScope();
|
||
else if (token == "$upscope")
|
||
parseUpscope();
|
||
else if (token == "$enddefinitions") {
|
||
// empty body
|
||
readStmtString();
|
||
makeVarIdMap();
|
||
}
|
||
else if (token == "$dumpall")
|
||
parseVarValues();
|
||
else if (token == "$dumpvars")
|
||
// Initial values.
|
||
parseVarValues();
|
||
else if (token[0] == '$')
|
||
report_->fileError(800, filename_, stmt_line_, "unhandled vcd command.");
|
||
else
|
||
parseVarValues();
|
||
token = getToken();
|
||
}
|
||
gzclose(stream_);
|
||
}
|
||
}
|
||
|
||
VcdReader::VcdReader(StaState *sta) :
|
||
StaState(sta),
|
||
stmt_line_(0),
|
||
time_unit_scale_(0.0),
|
||
max_var_name_length_(0),
|
||
max_var_width_(0),
|
||
time_(0),
|
||
prev_time_(0),
|
||
min_delta_time_(std::numeric_limits<VarTime>::max()),
|
||
time_max_(0)
|
||
{
|
||
}
|
||
|
||
void
|
||
VcdReader::parseTimescale()
|
||
{
|
||
vector<string> tokens = readStmtTokens();
|
||
if (tokens.size() == 1) {
|
||
size_t last;
|
||
time_scale_ = std::stod(tokens[0], &last);
|
||
time_unit_ = tokens[0].substr(last);
|
||
}
|
||
else if (tokens.size() == 2) {
|
||
time_scale_ = std::stod(tokens[0]);
|
||
time_unit_ = tokens[1];
|
||
}
|
||
else
|
||
report_->fileError(800, filename_, stmt_line_, "timescale syntax error.");
|
||
|
||
if (time_unit_ == "fs")
|
||
time_unit_scale_ = 1e-15;
|
||
else if (time_unit_ == "ps")
|
||
time_unit_scale_ = 1e-12;
|
||
else if (time_unit_ == "ns")
|
||
time_unit_scale_ = 1e-9;
|
||
else
|
||
report_->fileError(801, filename_, stmt_line_, "Unknown timescale unit.");
|
||
}
|
||
|
||
void
|
||
VcdReader::parseVar()
|
||
{
|
||
vector<string> tokens = readStmtTokens();
|
||
if (tokens.size() == 4
|
||
|| tokens.size() == 5) {
|
||
string type_name = tokens[0];
|
||
VcdVar::VarType type = VcdVar::wire;
|
||
if (type_name == "wire")
|
||
type = VcdVar::wire;
|
||
else if (type_name == "reg")
|
||
type = VcdVar::reg;
|
||
else if (type_name == "parameter")
|
||
type = VcdVar::parameter;
|
||
else
|
||
report_->fileError(803, filename_, stmt_line_,
|
||
"Unknown variable type %s.",
|
||
type_name.c_str());
|
||
|
||
int width = stoi(tokens[1]);
|
||
string id = tokens[2];
|
||
string name;
|
||
|
||
int level = 0;
|
||
for (string &context : scope_) {
|
||
// Skip the first 2 levels of scope.
|
||
// -test bench module
|
||
// -design instance
|
||
if (level > 1) {
|
||
name += context;
|
||
name += '/';
|
||
}
|
||
level++;
|
||
}
|
||
name += tokens[3];
|
||
// iverilog separates bus base name from bit range.
|
||
if (tokens.size() == 5)
|
||
name += tokens[4];
|
||
|
||
vars_.push_back(VcdVar(name, type, width, id));
|
||
max_var_name_length_ = std::max(max_var_name_length_, name.size());
|
||
max_var_width_ = std::max(max_var_width_, width);
|
||
}
|
||
else
|
||
report_->fileError(802, filename_, stmt_line_, "Variable syntax error.");
|
||
}
|
||
|
||
void
|
||
VcdReader::parseScope()
|
||
{
|
||
vector<string> tokens = readStmtTokens();
|
||
string &scope = tokens[1];
|
||
scope_.push_back(scope);
|
||
}
|
||
|
||
void
|
||
VcdReader::parseUpscope()
|
||
{
|
||
readStmtTokens();
|
||
scope_.pop_back();
|
||
}
|
||
|
||
// Make entries for each ID used by variables.
|
||
void
|
||
VcdReader::makeVarIdMap()
|
||
{
|
||
for (VcdVar &var : vars_) {
|
||
const string &id = var.id();
|
||
id_values_map_[id].clear();
|
||
}
|
||
}
|
||
|
||
void
|
||
VcdReader::parseVarValues()
|
||
{
|
||
string token = getToken();
|
||
while (!token.empty()) {
|
||
if (token[0] == '#') {
|
||
prev_time_ = time_;
|
||
time_ = stoll(token.substr(1));
|
||
if (time_ > prev_time_)
|
||
min_delta_time_ = min(time_ - prev_time_, min_delta_time_);
|
||
}
|
||
else if (token[0] == '0'
|
||
|| token[0] == '1'
|
||
|| token[0] == 'X'
|
||
|| token[0] == 'U'
|
||
|| token[0] == 'Z')
|
||
appendVarValue(token.substr(1), token[0]);
|
||
else if (token[0] == 'b') {
|
||
if (token[1] == 'X'
|
||
|| token[1] == 'U'
|
||
|| token[1] == 'Z') {
|
||
string id = getToken();
|
||
// Mixed 0/1/X/U not supported.
|
||
appendVarValue(id, token[1]);
|
||
}
|
||
else {
|
||
string bin = token.substr(1);
|
||
char *end;
|
||
int64_t bus_value = strtol(bin.c_str(), &end, 2);
|
||
string id = getToken();
|
||
auto values_itr = id_values_map_.find(id);
|
||
if (values_itr == id_values_map_.end())
|
||
report_->fileError(804, filename_, stmt_line_,
|
||
"unknown variable %s", id.c_str());
|
||
VcdValues &values = values_itr->second;
|
||
values.push_back(VcdValue(time_, '\0', bus_value));
|
||
}
|
||
}
|
||
token = getToken();
|
||
}
|
||
time_max_ = time_;
|
||
}
|
||
|
||
void
|
||
VcdReader::appendVarValue(string id,
|
||
char value)
|
||
{
|
||
auto values_itr = id_values_map_.find(id);
|
||
if (values_itr == id_values_map_.end())
|
||
report_->fileError(805, filename_, stmt_line_,
|
||
"Unknown variable %s", id.c_str());
|
||
VcdValues &values = values_itr->second;
|
||
values.push_back(VcdValue(time_, value, 0));
|
||
}
|
||
|
||
VcdValues &
|
||
VcdReader::values(VcdVar &var)
|
||
{
|
||
if (id_values_map_.find(var.id()) == id_values_map_.end()) {
|
||
report_->error(805, "Unknown variable %s ID %s",
|
||
var.name().c_str(),
|
||
var.id().c_str());
|
||
static VcdValues empty;
|
||
return empty;
|
||
}
|
||
else
|
||
return id_values_map_[var.id()];
|
||
}
|
||
|
||
string
|
||
VcdReader::readStmtString()
|
||
{
|
||
stmt_line_ = file_line_;
|
||
string line;
|
||
string token = getToken();
|
||
while (!token.empty() && token != "$end") {
|
||
if (!line.empty())
|
||
line += " ";
|
||
line += token;
|
||
token = getToken();
|
||
}
|
||
return line;
|
||
}
|
||
|
||
vector<string>
|
||
VcdReader::readStmtTokens()
|
||
{
|
||
stmt_line_ = file_line_;
|
||
vector<string> tokens;
|
||
string token = getToken();
|
||
while (!token.empty() && token != "$end") {
|
||
tokens.push_back(token);
|
||
token = getToken();
|
||
}
|
||
return tokens;
|
||
}
|
||
|
||
string
|
||
VcdReader::getToken()
|
||
{
|
||
string token;
|
||
int ch = gzgetc(stream_);
|
||
if (ch == '\n')
|
||
file_line_++;
|
||
// skip whitespace
|
||
while (ch != EOF && isspace(ch)) {
|
||
ch = gzgetc(stream_);
|
||
if (ch == '\n')
|
||
file_line_++;
|
||
}
|
||
while (ch != EOF && !isspace(ch)) {
|
||
token.push_back(ch);
|
||
ch = gzgetc(stream_);
|
||
if (ch == '\n')
|
||
file_line_++;
|
||
}
|
||
if (ch == EOF)
|
||
return "";
|
||
else
|
||
return token;
|
||
}
|
||
|
||
void
|
||
VcdReader::reportWaveforms()
|
||
{
|
||
report_->reportLine("Date: %s", date_.c_str());
|
||
report_->reportLine("Timescale: %.2f%s", time_scale_, time_unit_.c_str());
|
||
// Characters per time sample.
|
||
int zoom = (max_var_width_ + 7) / 4;
|
||
int time_delta = min_delta_time_;
|
||
|
||
for (VcdVar &var : vars_) {
|
||
string line;
|
||
stringPrint(line, " %-*s",
|
||
static_cast<int>(max_var_name_length_),
|
||
var.name().c_str());
|
||
const VcdValues &var_values = values(var);
|
||
if (!var_values.empty()) {
|
||
size_t value_index = 0;
|
||
VcdValue var_value = var_values[value_index];
|
||
VcdValue prev_var_value = var_values[value_index];
|
||
VarTime next_value_time = var_values[value_index + 1].time();
|
||
for (double time = 0.0; time < time_max_; time += time_delta) {
|
||
if (time >= next_value_time) {
|
||
if (value_index < var_values.size() - 1)
|
||
value_index++;
|
||
var_value = var_values[value_index];
|
||
if (value_index < var_values.size())
|
||
next_value_time = var_values[value_index + 1].time();
|
||
}
|
||
if (var_value.value()) {
|
||
// 01UZX
|
||
char value = var_value.value();
|
||
char prev_value = prev_var_value.value();
|
||
if (var.width() == 1) {
|
||
if (value == '0' || value == '1') {
|
||
for (int z = 0; z < zoom; z++) {
|
||
if (z == 0
|
||
&& value != prev_value
|
||
&& (prev_value == '0'
|
||
|| prev_value == '1'))
|
||
line += (prev_value == '1') ? "╲" : "╱";
|
||
else
|
||
line += (value == '1') ? "▔" : "▁";
|
||
}
|
||
}
|
||
else {
|
||
string field;
|
||
stringPrint(field, "%-*c", zoom, value);
|
||
line += field;
|
||
}
|
||
}
|
||
else {
|
||
string field;
|
||
stringPrint(field, "%-*c", zoom, value);
|
||
line += field;
|
||
}
|
||
}
|
||
else {
|
||
// bus
|
||
string field;
|
||
stringPrint(field, "%-*llX", zoom, var_value.busValue());
|
||
line += field;
|
||
}
|
||
prev_var_value = var_value;
|
||
}
|
||
}
|
||
report_->reportLineString(line);
|
||
}
|
||
}
|
||
|
||
////////////////////////////////////////////////////////////////
|
||
|
||
VcdVar::VcdVar(string name,
|
||
VarType type,
|
||
int width,
|
||
string id) :
|
||
name_(name),
|
||
type_(type),
|
||
width_(width),
|
||
id_(id)
|
||
{
|
||
}
|
||
|
||
VcdValue::VcdValue(VarTime time,
|
||
char value,
|
||
uint64_t bus_value) :
|
||
time_(time),
|
||
value_(value),
|
||
bus_value_(bus_value)
|
||
{
|
||
}
|
||
|
||
}
|