netlist_simulator_controller.h

Go to the documentation of this file.

// MIT License
// 
// Copyright (c) 2019 Ruhr University Bochum, Chair for Embedded Security. All Rights reserved.
// Copyright (c) 2019 Marc Fyrbiak, Sebastian Wallat, Max Hoffmann ("ORIGINAL AUTHORS"). All rights reserved.
// Copyright (c) 2021 Max Planck Institute for Security and Privacy. All Rights reserved.
// Copyright (c) 2021 Jörn Langheinrich, Julian Speith, Nils Albartus, René Walendy, Simon Klix ("ORIGINAL AUTHORS"). All Rights reserved.
// 
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
// 
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.
 
#pragma once
 
#include "hal_core/defines.h"
#include "hal_core/netlist/gate.h"
#include "hal_core/netlist/module.h"
#include "hal_core/netlist/net.h"
#include "hal_core/netlist/netlist_writer/netlist_writer.h"
 
#include <QMap>
#include <QObject>
#include <QString>
#include <QTemporaryDir>
#include <QDir>
#include <functional>
#include <map>
#include <memory>
#include <sstream>
#include <vector>
 
#include "netlist_simulator_controller/simulation_engine.h"
#include "netlist_simulator_controller/simulation_input.h"
#include "netlist_simulator_controller/wave_data.h"
 
class QTemporaryDir;
 
namespace hal {
/* forward declaration */
class Netlist;
 
class NETLIST_API NetlistSimulatorController : public QObject {
    Q_OBJECT
 
public:
    enum SimulationState {
        NoGatesSelected,
        ParameterSetup,
        ParameterReady,
        SimulationRun,
        ShowResults,
        EngineFailed };
 
    enum FilterInputFlag {
        GlobalInputs,
        PartialNetlist,
        CompleteNetlist,
        NoFilter
    };
 
    struct InputColumnHeader
    {
        std::vector<const Net*> nets;
        std::string name;
        bool is_clock;
    };
 
    NetlistSimulatorController(u32 id, const std::string nam, const std::string& workdir, QObject* parent = nullptr);
 
    NetlistSimulatorController(u32 id, Netlist* nl, const std::string& filename, QObject* parent = nullptr);
 
    ~NetlistSimulatorController();
 
    SimulationEngine* create_simulation_engine(const std::string& name);
 
    SimulationEngine* get_simulation_engine() const;
 
    void add_clock_frequency(const Net* clock_net, u64 frequency, bool start_at_zero = true);
 
    void add_clock_period(const Net* clock_net, u64 period, bool start_at_zero = true, u64 duration=0);
 
    void set_no_clock_used();
 
    bool is_no_clock_used() const;
 
    u32 add_waveform_group(const std::string& name, const std::vector<Net*>& nets);
 
    u32 add_waveform_group(const PinGroup<ModulePin>* pin_group);
 
    u32 add_waveform_group(const Gate* gate, const PinGroup<GatePin>* pin_group);
 
    u32 add_waveform_group(const std::string& name, const PinGroup<ModulePin>* pin_group);
 
    u32 add_boolean_expression_waveform(const std::string& expression);
 
    u32 add_boolean_accept_list_waveform(const std::vector<WaveData*>& input_waves, const std::vector<int>& accepted_combination);
 
    u32 add_trigger_time(const std::vector<WaveData*>& trigger_waves, const std::vector<int>& trigger_on_values = std::vector<int>());
 
    void remove_waveform_group(u32 group_id);
 
    void add_gates(const std::vector<Gate*>& gates);
 
    void compute_waveform_groups();
 
    void load_waveform_groups(bool inputs);
 
    void set_input(const Net* net, BooleanFunction::Value value);
 
    void set_input(WaveData* wd, BooleanFunction::Value value);
 
    void set_input(const std::vector<Net*>& nets, const std::vector<BooleanFunction::Value>& values);
 
    void set_input(const WaveDataGroup* wdg, const std::vector<BooleanFunction::Value>& values);
 
    void set_input(const u32 id, const std::vector<BooleanFunction::Value>& values);
 
    void set_input(const PinGroup<ModulePin>* pin_group, const std::vector<BooleanFunction::Value>& values);
 
    void initialize();
 
    void simulate(u64 picoseconds);
 
    void reset();
 
    const std::unordered_set<const Gate*>& get_gates() const;
 
    const std::unordered_set<const Net*>& get_input_nets() const;
 
    std::vector<InputColumnHeader> get_input_column_headers() const;
 
    const std::vector<const Net*>& get_output_nets() const;
 
    const std::vector<const Net*>& get_partial_netlist_nets() const;
 
    std::vector<std::string> get_engine_names() const;
 
    //        SimulationInput* input() const { return mSimulationInput; }
 
    QString name() const { return mName; }
 
    std::string get_name() const { return mName.toStdString(); }
 
    u32 get_id() const { return mId; }
 
    bool get_results();
 
    u64 get_max_simulated_time() const;
 
    bool run_simulation();
 
    bool import_vcd(const std::string& filename, FilterInputFlag filter);
 
    void import_csv(const std::string& filename, FilterInputFlag filter, u64 timescale = 1000000000);
 
    void import_saleae(const std::string& dirname, std::unordered_map<Net*,int> lookupTable, u64 timescale = 1000000000);
 
    void import_simulation(const std::string& dirname, FilterInputFlag filter, u64 timescale = 1000000000);
 
    void set_saleae_timescale(u64 timescale = 1000000000);
 
    bool generate_vcd(const std::filesystem::path& path, u32 start_time=0, u32 end_time=0, std::set<const Net*> nets = {}) const;
 
    std::string get_working_directory() const;
 
    bool is_legal_directory_name() const;
 
    std::filesystem::path get_saleae_directory_filename() const;
 
    WaveDataList* get_waves() const { return mWaveDataList; }
 
    SimulationState get_state() const { return mState; }
 
    WaveData* get_waveform_by_net(const Net* n) const;
 
    void rename_waveform(WaveData* wd, std::string name);
 
    WaveDataGroup* get_waveform_group_by_id(u32 id) const;
 
    WaveDataBoolean* get_waveform_boolean_by_id(u32 id) const;
 
    WaveDataTrigger* get_trigger_time_by_id(u32 id) const;
 
    void set_timeframe(u64 tmin=0, u64 tmax=0);
 
    void emitLoadProgress(int percent);
 
    bool can_import_data() const;
 
    void simulate_only_probes(const std::vector<const Net*>& probes);
 
    void simulate_only_probes(const QSet<u32>& probes);
 
    bool persist() const;
 
    void setLogReceiver(SimulationLogReceiver* logrec);
 
    static const char* sPersistFile;
 
public Q_SLOTS:
    void handleOpenInputFile(const QString& filename);
    void handleSelectGates();
    void handleRunFinished(bool success);
 
Q_SIGNALS:
    void stateChanged(hal::NetlistSimulatorController::SimulationState state);
    void engineFinished(bool success);
    void parseComplete();
    void loadProgress(int percent);
 
private:
    std::vector<const Net*> getFilterNets(FilterInputFlag filter) const;
    void initSimulator();
    void setState(SimulationState stat);
    bool getResultsInternal();
 
    bool isInputSet() const;
    void checkReadyState();
    void restoreComposed(const SaleaeDirectory& sd);
    void loadStoredController(const QDir& workDir);
 
    u32 mId;
    QString mName;
 
    SimulationState mState;
    SimulationEngine* mSimulationEngine;
 
    QTemporaryDir* mTempDir;
    QString mWorkDir;
    WaveDataList* mWaveDataList;
 
    SimulationInput* mSimulationInput;
    QSet<u32> mSimulateOnlyProbes;
 
    QHash<u32,int> mBadAssignInputWarnings;
    SimulationLogReceiver* mLogReceiver;
};
 
class NetlistSimulatorControllerMap : public QObject {
    Q_OBJECT
 
    QMap<u32, NetlistSimulatorController*> mMap;
    NetlistSimulatorControllerMap() { ; }
    static NetlistSimulatorControllerMap* sInst;
 
Q_SIGNALS:
    void controllerAdded(u32 id);
    void controllerRemoved(u32 id);
 
public:
    static NetlistSimulatorControllerMap* instance();
    void addController(NetlistSimulatorController* ctrl);
    void removeController(u32 id);
    void shutdown() { mMap.clear(); }
    void clearAll();
    QList<NetlistSimulatorController*> toList() const { return mMap.values(); }
    NetlistSimulatorController* controller(u32 id) const { return mMap.value(id); }
};
} // namespace hal