state_transition_graph.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/boolean_function.h"
#include "hal_core/utilities/result.h"
 
#include <filesystem>
#include <map>
#include <string>
#include <utility>
#include <vector>
 
namespace hal
{
    class Gate;
    class Net;
    class Netlist;
 
    namespace solve_fsm
    {
        struct StateTransitionGraph
        {
            Netlist* netlist = nullptr;
 
            std::vector<Gate*> state_register;
 
            std::vector<std::pair<std::string, std::vector<Net*>>> output_nets;
 
            std::map<u64, std::map<u64, BooleanFunction>> transitions;
 
            std::map<u64, std::vector<std::pair<std::string, BooleanFunction>>> outputs;
 
            u32 get_state_size() const;
 
            Result<std::string> generate_dot_graph(const std::filesystem::path& graph_path = "", const u32 max_condition_length = 128, const u32 base = 10) const;
 
            Result<std::string> to_string(const u32 base = 10) const;
 
            Result<std::monostate> write_txt(const std::filesystem::path& file_path, const u32 base = 10) const;
        };
    }    // namespace solve_fsm
}    // namespace hal