VCD.h

Go to the documentation of this file.

// SPDX-License-Identifier: BSD-3-Clause
//
// This file is part of ETISS. It is licensed under the BSD 3-Clause License; you may not use this file except in
// compliance with the License. You should have received a copy of the license along with this project. If not, see the
// LICENSE file.
#ifndef ETISS_INTERFACES_VCD_H
#define ETISS_INTERFACES_VCD_H
 
#include "etiss/Misc.h"
 
#include <fstream>
#include <iostream>
#include <vector>
 
#define ETISS_INTERFACES_VCD_DECLARE(LOG, VAR, WIDTH)                   \
    {                                                                   \
        (VAR).vcd = &(LOG);                                             \
        (LOG).declare((VAR), ETISS_TOSTRING(VAR), WIDTH, (VAR).errval); \
    }
 
namespace etiss
{
namespace interfaces
{
 
class VCD : public etiss::ToString
{
  public:
    class Signal
    {
      public:
        inline Signal() : valid(false) {}
        std::string name;
        // std::string module;
        bool valid;
        uint64_t value;
        unsigned width;
        std::string ident;
        uint64_t undefined;
    };
    etiss_del_como(VCD)
 
        VCD(const std::string &file, const std::string &comment = std::string());
    virtual ~VCD();
 
    template <typename T>
    inline bool declare(T &variable, const std::string &name, unsigned width, uint64_t initialvalue,
                        uint64_t undefined = -1)
    {
        return declare((void *)&variable, name, width, initialvalue, undefined);
    }
 
    template <typename T>
    inline void update(double time_s, const T &variable, uint64_t value, uint64_t undefined = 0)
    {
        update((uint64_t)(time_s * 1000000000000.0), (void *)&variable, value, undefined);
    }
 
    inline std::string toString() const { return std::string("VCD { file=\"") + file + "\"}"; }
 
    void close();
 
  protected:
    bool declare(void *variable, const std::string &name, unsigned width, uint64_t initialvalue, uint64_t undefined);
    void update(uint64_t time_ps, void *variable, uint64_t value, uint64_t undefined);
    void flush();
 
  private:
    std::ofstream out_;
    bool valid_;
    bool dumpstarted_;
    std::vector<Signal> sigs_;
    uint64_t lasttime_ps;
    std::map<void *, int> ptr2index_; 
    std::string dumpvar;
    std::string file;
};
 
} // namespace interfaces
} // namespace etiss
 
#endif // ETISS_INTERFACES_VCD_H