netlist_traversal_decorator.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 <optional>
 
namespace hal
{
    enum class TraversalDirection
    {
        forward,  
        backward, 
        both,     
    };
 
    enum class TraversalStop
    {
        at_match,
 
        at_mismatch,
 
        never,
    };
 
    class NETLIST_API TraversalCache
    {
    public:
        TraversalCache(TraversalCache&&)            = default;
        TraversalCache& operator=(TraversalCache&&) = default;
        TraversalCache(const TraversalCache&)       = delete;
        TraversalCache& operator=(const TraversalCache&) = delete;
 
    private:
        friend class NetlistTraversalDecorator;
 
        TraversalCache(const Netlist* netlist,
                       TraversalDirection direction,
                       std::function<bool(const Gate*)> match,
                       TraversalStop stop,
                       std::function<bool(const Endpoint*)> exit_endpoint_filter,
                       std::function<bool(const Endpoint*)> entry_endpoint_filter)
            : m_netlist(netlist), m_direction(direction), m_match(std::move(match)), m_stop(stop), m_exit_endpoint_filter(std::move(exit_endpoint_filter)),
              m_entry_endpoint_filter(std::move(entry_endpoint_filter))
        {
        }
 
        const Netlist* m_netlist;
        TraversalDirection m_direction;
        std::function<bool(const Gate*)> m_match;
        TraversalStop m_stop;
        std::function<bool(const Endpoint*)> m_exit_endpoint_filter;
        std::function<bool(const Endpoint*)> m_entry_endpoint_filter;
        std::unordered_map<const Net*, std::set<Gate*>> m_store;
    };
 
    class NETLIST_API NetlistTraversalDecorator
    {
    public:
        NetlistTraversalDecorator(const Netlist& netlist);
 
        Result<std::set<Gate*>> get_gates(const Net* net,
                                          TraversalDirection direction,
                                          const std::function<bool(const Gate*)>& match,
                                          TraversalStop stop,
                                          u32 max_depth                                                                                = 0,
                                          const std::function<bool(const Endpoint*, u32 current_depth)>& exit_endpoint_filter  = nullptr,
                                          const std::function<bool(const Endpoint*, u32 current_depth)>& entry_endpoint_filter = nullptr) const;
 
        Result<std::set<Gate*>> get_gates(const Gate* gate,
                                          TraversalDirection direction,
                                          const std::function<bool(const Gate*)>& match,
                                          TraversalStop stop,
                                          u32 max_depth                                                                                = 0,
                                          const std::function<bool(const Endpoint*, u32 current_depth)>& exit_endpoint_filter  = nullptr,
                                          const std::function<bool(const Endpoint*, u32 current_depth)>& entry_endpoint_filter = nullptr) const;
 
        Result<std::set<Gate*>> get_next_matching_gates(const Net* net,
                                                        bool successors,
                                                        const std::function<bool(const Gate*)>& target_gate_filter,
                                                        bool continue_on_match                                                                     = false,
                                                        const std::function<bool(const Endpoint*, u32 current_depth)>& exit_endpoint_filter  = nullptr,
                                                        const std::function<bool(const Endpoint*, u32 current_depth)>& entry_endpoint_filter = nullptr) const;
 
        Result<std::set<Gate*>> get_next_matching_gates(const Gate* gate,
                                                        bool successors,
                                                        const std::function<bool(const Gate*)>& target_gate_filter,
                                                        bool continue_on_match                                                                     = false,
                                                        const std::function<bool(const Endpoint*, u32 current_depth)>& exit_endpoint_filter  = nullptr,
                                                        const std::function<bool(const Endpoint*, u32 current_depth)>& entry_endpoint_filter = nullptr) const;
 
        Result<std::set<Gate*>> get_next_matching_gates_until(const Net* net,
                                                              bool successors,
                                                              const std::function<bool(const Gate*)>& target_gate_filter,
                                                              bool continue_on_mismatch                                                                  = false,
                                                              const std::function<bool(const Endpoint*, u32 current_depth)>& exit_endpoint_filter  = nullptr,
                                                              const std::function<bool(const Endpoint*, u32 current_depth)>& entry_endpoint_filter = nullptr) const;
 
        Result<std::set<Gate*>> get_next_matching_gates_until(const Gate* gate,
                                                              bool successors,
                                                              const std::function<bool(const Gate*)>& target_gate_filter,
                                                              bool continue_on_mismatch                                                                  = false,
                                                              const std::function<bool(const Endpoint*, u32 current_depth)>& exit_endpoint_filter  = nullptr,
                                                              const std::function<bool(const Endpoint*, u32 current_depth)>& entry_endpoint_filter = nullptr) const;
 
        Result<std::set<Gate*>> get_next_matching_gates_until_depth(const Net* net, bool successors, u32 max_depth, const std::function<bool(const Gate*)>& target_gate_filter = nullptr) const;
 
        Result<std::set<Gate*>> get_next_matching_gates_until_depth(const Gate* gate, bool successors, u32 max_depth, const std::function<bool(const Gate*)>& target_gate_filter = nullptr) const;
 
        Result<std::set<Gate*>> get_next_sequential_gates(const Net* net, bool successors, const std::set<PinType>& forbidden_pins = {}) const;
 
        Result<std::set<Gate*>> get_next_sequential_gates(const Gate* gate, bool successors, const std::set<PinType>& forbidden_pins = {}) const;
 
        Result<std::map<Gate*, std::set<Gate*>>> get_next_sequential_gates_map(bool successors, const std::set<PinType>& forbidden_pins) const;
 
        Result<std::set<Gate*>> get_combinational_cone(const Net* net, bool successors, const std::set<PinType>& forbidden_pins = {}) const;
 
        Result<std::set<Gate*>> get_combinational_cone(const Gate* gate, bool successors, const std::set<PinType>& forbidden_pins = {}) const;
 
        Result<std::optional<u32>> get_shortest_path_distance(const Gate* start_gate,
                                                              const Gate* end_gate,
                                                              const PinDirection& direction,
                                                              const std::function<bool(const Endpoint*, u32 current_depth)>& exit_endpoint_filter  = nullptr,
                                                              const std::function<bool(const Endpoint*, u32 current_depth)>& entry_endpoint_filter = nullptr) const;
 
        Result<std::optional<std::vector<Gate*>>> get_shortest_path(const Gate* start_gate,
                                                                    const Gate* end_gate,
                                                                    const PinDirection& direction,
                                                                    const std::function<bool(const Endpoint*, u32 current_depth)>& exit_endpoint_filter  = nullptr,
                                                                    const std::function<bool(const Endpoint*, u32 current_depth)>& entry_endpoint_filter = nullptr) const;
 
        Result<std::optional<std::vector<Gate*>>> get_shortest_path(const Gate* start_gate,
                                                                    const Module* end_module,
                                                                    const PinDirection& direction,
                                                                    const std::function<bool(const Endpoint*, u32 current_depth)>& exit_endpoint_filter  = nullptr,
                                                                    const std::function<bool(const Endpoint*, u32 current_depth)>& entry_endpoint_filter = nullptr) const;
 
        Result<std::vector<std::vector<Gate*>>> get_shortest_path(const Module* start_module,
                                                                  const Module* end_module,
                                                                  const PinDirection& direction,
                                                                  const std::function<bool(const Endpoint*, u32 current_depth)>& exit_endpoint_filter  = nullptr,
                                                                  const std::function<bool(const Endpoint*, u32 current_depth)>& entry_endpoint_filter = nullptr) const;
 
        Result<std::vector<Gate*>> get_gate_chain(Gate* start_gate,
                                                  const std::vector<const GatePin*>& input_pins  = {},
                                                  const std::vector<const GatePin*>& output_pins = {},
                                                  const std::function<bool(const Gate*)>& filter = nullptr) const;
 
        Result<std::vector<Gate*>> get_complex_gate_chain(Gate* start_gate,
                                                          const std::vector<GateType*>& chain_types,
                                                          const std::map<GateType*, std::vector<const GatePin*>>& input_pins  = {},
                                                          const std::map<GateType*, std::vector<const GatePin*>>& output_pins = {},
                                                          const std::function<bool(const Gate*)>& filter                      = nullptr) const;
 
        Result<std::vector<Net*>> get_common_inputs(const std::vector<Gate*>& gates, u32 threshold = 0) const;
 
        TraversalCache make_traversal_cache(TraversalDirection direction,
                                            std::function<bool(const Gate*)> match,
                                            TraversalStop stop,
                                            std::function<bool(const Endpoint*)> exit_endpoint_filter  = nullptr,
                                            std::function<bool(const Endpoint*)> entry_endpoint_filter = nullptr) const;
 
        Result<std::set<Gate*>> get_gates(const Net* net, TraversalCache& cache) const;
 
        Result<std::set<Gate*>> get_gates(const Gate* gate, TraversalCache& cache) const;
 
    private:
        Result<std::set<Gate*>> get_gates_memoized(const Net* start,
                                                   bool successors,
                                                   const std::function<bool(const Gate*)>& match,
                                                   TraversalStop stop,
                                                   const std::function<bool(const Endpoint*)>& exit_endpoint_filter,
                                                   const std::function<bool(const Endpoint*)>& entry_endpoint_filter,
                                                   std::unordered_map<const Net*, std::set<Gate*>>& store) const;
 
        Result<std::optional<std::vector<Gate*>>> get_shortest_path_to(const Gate* start_gate,
                                                                       const std::function<bool(const Gate*)>& is_target,
                                                                       const PinDirection& direction,
                                                                       const std::function<bool(const Endpoint*, u32 current_depth)>& exit_endpoint_filter,
                                                                       const std::function<bool(const Endpoint*, u32 current_depth)>& entry_endpoint_filter) const;
 
        const Netlist& m_netlist;
    };
}    // namespace hal