netlist_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/netlist.h"
#include "hal_core/utilities/result.h"
 
#include <functional>
#include <igraph/igraph.h>
#include <set>
#include <unordered_map>
 
namespace hal
{
    class Netlist;
    class Gate;
    class Net;
 
    namespace graph_algorithm
    {
        class NetlistGraph
        {
        public:
            enum class Direction
            {
                NONE,
 
                IN,
 
                OUT,
 
                ALL
            };
 
            NetlistGraph(Netlist* nl, igraph_t&& graph, std::unordered_map<u32, Gate*>&& nodes_to_gates);
 
            ~NetlistGraph();
 
            NetlistGraph(const NetlistGraph&) = delete;
 
            NetlistGraph& operator=(const NetlistGraph&) = delete;
 
            static Result<std::unique_ptr<NetlistGraph>> from_netlist(Netlist* nl, bool create_dummy_vertices = false, const std::function<bool(const Net*)>& filter = nullptr);
 
            static Result<std::unique_ptr<NetlistGraph>> from_netlist_no_edges(Netlist* nl, const std::vector<Gate*>& gates = {});
 
            static Result<std::unique_ptr<NetlistGraph>>
                from_gates(const std::vector<Gate*>& gates, const std::set<Gate*>& split_gates = {}, const std::function<bool(const Net*)>& filter = nullptr);
 
            Result<std::unique_ptr<NetlistGraph>> copy() const;
 
            Netlist* get_netlist() const;
 
            igraph_t* get_graph() const;
 
            Result<std::vector<Gate*>> get_gates_from_vertices(const std::vector<u32>& vertices) const;
 
            Result<std::vector<Gate*>> get_gates_from_vertices(const std::set<u32>& vertices) const;
 
            Result<std::vector<Gate*>> get_gates_from_vertices_igraph(const igraph_vector_int_t* vertices) const;
 
            Result<std::set<Gate*>> get_gates_set_from_vertices(const std::vector<u32>& vertices) const;
 
            Result<std::set<Gate*>> get_gates_set_from_vertices(const std::set<u32>& vertices) const;
 
            Result<std::set<Gate*>> get_gates_set_from_vertices_igraph(const igraph_vector_int_t* vertices) const;
 
            Result<Gate*> get_gate_from_vertex(const u32 vertex) const;
 
            Result<std::vector<u32>> get_vertices_from_gates(const std::vector<Gate*>& gates) const;
 
            Result<std::vector<u32>> get_vertices_from_gates(const std::set<Gate*>& gates) const;
 
            Result<igraph_vector_int_t> get_vertices_from_gates_igraph(const std::vector<Gate*>& gates) const;
 
            Result<igraph_vector_int_t> get_vertices_from_gates_igraph(const std::set<Gate*>& gates) const;
 
            Result<u32> get_vertex_from_gate(Gate* g) const;
 
            bool is_shadow_vertex(const u32 vertex) const;
 
            Result<std::vector<u32>> get_all_vertices_from_gate(Gate* g) const;
 
            u32 get_num_vertices(bool only_connected = false) const;
 
            u32 get_num_edges() const;
 
            Result<std::vector<u32>> get_vertices(bool only_connected = false) const;
 
            Result<std::vector<std::pair<u32, u32>>> get_edges() const;
 
            Result<std::vector<std::pair<Gate*, Gate*>>> get_edges_in_netlist() const;
 
            Result<std::monostate> add_edges(const std::vector<std::pair<Gate*, Gate*>>& edges);
 
            Result<std::monostate> add_edges(const std::vector<std::pair<u32, u32>>& edges);
 
            Result<std::monostate> add_edges(const std::map<Gate*, std::set<Gate*>>& edges);
 
            Result<std::monostate> delete_edges(const std::vector<std::pair<Gate*, Gate*>>& edges);
 
            Result<std::monostate> delete_edges(const std::vector<std::pair<u32, u32>>& edges);
 
            void print() const;
 
        private:
            NetlistGraph() = delete;
 
            NetlistGraph(Netlist* nl);
 
            Netlist* m_nl;
 
            igraph_t m_graph;
 
            bool m_graph_initialized = false;
 
            igraph_t* m_graph_ptr = nullptr;
 
            std::unordered_map<u32, Gate*> m_nodes_to_gates;
 
            std::unordered_map<Gate*, u32> m_gates_to_nodes;
 
            std::unordered_map<u32, u32> m_shadow_nodes_to_nodes;
        };
    }    // namespace graph_algorithm
 
    template<>
    std::map<graph_algorithm::NetlistGraph::Direction, std::string> EnumStrings<graph_algorithm::NetlistGraph::Direction>::data;
}    // namespace hal