vcd_parser.hpp

Go to the documentation of this file.

/*
 *
 *                   _/_/_/    _/_/   _/    _/ _/_/_/    _/_/
 *                  _/   _/ _/    _/ _/_/  _/ _/   _/ _/    _/
 *                 _/_/_/  _/_/_/_/ _/  _/_/ _/   _/ _/_/_/_/
 *                _/      _/    _/ _/    _/ _/   _/ _/    _/
 *               _/      _/    _/ _/    _/ _/_/_/  _/    _/
 *
 *             ***********************************************
 *                              PandA Project
 *                     URL: http://panda.dei.polimi.it
 *                       Politecnico di Milano - DEIB
 *                        System Architectures Group
 *             ***********************************************
 *              Copyright (C) 2004-2024 Politecnico di Milano
 *
 *   This file is part of the PandA framework.
 *
 *   The PandA framework 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 <http://www.gnu.org/licenses/>.
 *
 */
#ifndef VCD_PARSER_HPP
#define VCD_PARSER_HPP

// include from STL
#include <list>
#include <stack>
#include <string>
#include <utility>

#include "custom_map.hpp"
#include "custom_set.hpp"

// include from parser/vcd/
#include "sig_variation.hpp"

// include from utility/
#include "refcount.hpp"

// forward declarations
CONSTREF_FORWARD_DECL(Parameter);

class vcd_sig_info
{
 public:
   std::string type;
   bool is_vec;
   size_t msb;
   size_t lsb;
   /*
    * if the signal is a vector, this puts in relationship every bit in the
    * vector with the vcd_id related to that bit. the size of this map can
    * be: 0 if the signal is not a vector, 1 if the signal is a bit vector
    * but in the vcd the variations are already grouped together, or (msb -
    * lsb + 1) if the signal is a vector and in the vcd a different id is
    * used for every bit
    */
   CustomUnorderedMap<std::string, size_t> vcd_id_to_bit;

   vcd_sig_info(const std::string& _type, const bool _is_vec, const size_t _msb, const size_t _lsb)
       : type(_type), is_vec(_is_vec), msb(_msb), lsb(_lsb)
   {
   }
};

class vcd_parser
{
 public:
   explicit vcd_parser(const ParameterConstRef& params);

   using vcd_filter_t = UnorderedMapStd<std::string, UnorderedSetStdStable<std::string>>;

   using vcd_trace_t = UnorderedMapStd<std::string, CustomUnorderedMapStable<std::string, std::list<sig_variation>>>;

   vcd_trace_t parse_vcd(const std::string& vcd_file_to_parse, const vcd_parser::vcd_filter_t& selected_signals);

 private:
   const int debug_level;

   // ---- METADATA ON THE PARSED FILE ----

   std::string vcd_filename;

   FILE* vcd_fp;

   unsigned long sig_n;

   vcd_filter_t filtered_signals;

   // ---- LOCAL MEMBERS TO HOLD INTERMEDIATE RESULTS DURING PARSE ----

   vcd_trace_t parse_result;

   std::map<std::pair<std::string, std::string>, vcd_sig_info> scope_and_name_to_sig_info;

   std::map<std::string, CustomUnorderedSet<std::pair<std::string, std::string>>> vcd_id_to_scope_and_name;

   /* Parses the simulation part in the vcd_file */
   int vcd_parse_sim();

   /* Parses the definition part in the vcd_file */
   int vcd_parse_def();

   /* Parses and ignore useless token */
   int vcd_parse_skip_to_end();

   /* Parses $var token */
   int vcd_parse_def_var(const std::string& scope);

   void vcd_push_def_scope(std::stack<std::string>& scope);

   void vcd_pop_def_scope(std::stack<std::string>& scope);

   /* Parses vector in simulation part */
   int vcd_parse_sim_vector(char* value, unsigned long timestamp);

   /* Parses real in sumlation part (actually unused)*/
   int vcd_parse_sim_real(char* value, unsigned long timestamp);

   bool check_filter_list(const std::string& scope_str, const std::string& name);

   void vcd_add_signal(const std::string& scope, const std::string& name, const std::string& vcd_id,
                       const std::string& type, const bool isvect, const unsigned int msb, const unsigned int lsb);

   bool check_signals() const;

   /* initializes the variations before parsing */
   void init_variations();

   /* add the parsed variation to the proper signal */
   void add_variation(const std::string& id, const std::string& value, unsigned long long ts);
};
#endif