result.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 "dataflow_analysis/common/grouping.h"
#include "hal_core/netlist/gate_library/enums/gate_type_property.h"
#include "hal_core/netlist/gate_library/enums/pin_direction.h"
#include "hal_core/netlist/gate_library/enums/pin_type.h"
#include "hal_core/utilities/result.h"
 
namespace hal
{
    class Gate;
    class Net;
    class Module;
    class GateType;
 
    namespace dataflow
    {
        class Result
        {
        public:
            Result(Netlist* nl, const Grouping& grouping);
 
            Netlist* get_netlist() const;
 
            const std::unordered_map<u32, std::unordered_set<Gate*>>& get_groups() const;
 
            std::vector<Gate*> get_gates() const;
 
            hal::Result<std::unordered_set<Gate*>> get_gates_of_group(const u32 group_id) const;
 
            hal::Result<u32> get_group_id_of_gate(const Gate* gate) const;
 
            hal::Result<std::unordered_set<Net*>> get_group_control_nets(const u32 group_id, const PinType type) const;
 
            hal::Result<std::unordered_set<Net*>> get_gate_control_nets(const Gate* gate, const PinType type) const;
 
            hal::Result<std::unordered_set<u32>> get_group_successors(const u32 group_id) const;
 
            hal::Result<std::unordered_set<Gate*>> get_gate_successors(const Gate* gate) const;
 
            hal::Result<std::unordered_set<u32>> get_group_predecessors(const u32 group_id) const;
 
            hal::Result<std::unordered_set<Gate*>> get_gate_predecessors(const Gate* gate) const;
 
            hal::Result<std::monostate> write_dot(const std::filesystem::path& out_path, const std::unordered_set<u32>& group_ids = {}) const;
 
            hal::Result<std::monostate> write_txt(const std::filesystem::path& out_path, const std::unordered_set<u32>& group_ids = {}) const;
 
            hal::Result<std::unordered_map<u32, Module*>> create_modules(const std::unordered_set<u32>& group_ids = {}) const;
 
            hal::Result<std::unordered_map<u32, Module*>> create_modules(const std::map<const GateType*, std::string>& module_suffixes,
                                                                         const std::map<std::pair<PinDirection, std::string>, std::string>& pin_prefixes,
                                                                         const std::unordered_set<u32>& group_ids) const;
 
            hal::Result<std::unordered_map<u32, Module*>> create_modules(const std::map<GateTypeProperty, std::string>& module_suffixes,
                                                                         const std::map<std::pair<PinDirection, std::string>, std::string>& pin_prefixes,
                                                                         const std::unordered_set<u32>& group_ids) const;
 
            std::vector<std::vector<Gate*>> get_groups_as_list(const std::unordered_set<u32>& group_ids = {}) const;
 
            hal::Result<u32> merge_groups(const std::vector<u32>& group_ids);
 
            hal::Result<std::vector<u32>> split_group(u32 group_id, const std::vector<std::unordered_set<Gate*>>& new_groups);
 
        private:
            Netlist* m_netlist;
 
            u32 m_last_id = 0;
 
            std::unordered_map<u32, std::unordered_set<Gate*>> m_gates_of_group;
 
            std::unordered_map<const Gate*, u32> m_parent_group_of_gate;
 
            std::unordered_map<const Gate*, std::unordered_map<PinType, std::unordered_set<Net*>>> m_gate_signals;
 
            std::unordered_map<const Gate*, std::unordered_set<Gate*>> m_gate_successors;
 
            std::unordered_map<const Gate*, std::unordered_set<Gate*>> m_gate_predecessors;
 
            std::unordered_map<u32, std::unordered_map<PinType, std::unordered_set<Net*>>> m_group_signals;
 
            std::unordered_map<u32, std::unordered_set<u32>> m_group_successors;
 
            std::unordered_map<u32, std::unordered_set<u32>> m_group_predecessors;
        };
    }    // namespace dataflow
}    // namespace hal