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 "hal_core/netlist/gate.h"
#include "hal_core/netlist/module.h"
#include "hal_core/netlist/net.h"
#include "hal_core/netlist/netlist.h"
#include "hal_core/utilities/log.h"
#include "module_identification/candidates/base_candidate.h"
#include "module_identification/candidates/verified_candidate.h"
 
#include <set>
 
namespace hal
{
    namespace module_identification
    {
        struct Result
        {
            Result(Netlist* nl, const std::vector<std::pair<BaseCandidate, VerifiedCandidate>>& result, const std::string& timing_stats_json = "");
 
            Netlist* get_netlist() const;
 
            std::map<u32, std::vector<Gate*>> get_verified_candidate_gates() const;
 
            std::map<u32, VerifiedCandidate> get_verified_candidates() const;
 
            std::map<u32, std::vector<Gate*>> get_candidate_gates() const;
 
            std::map<u32, VerifiedCandidate> get_candidates() const;
 
            hal::Result<std::vector<Gate*>> get_candidate_gates_by_id(const u32 id) const;
 
            hal::Result<VerifiedCandidate> get_candidate_by_id(const u32 id) const;
 
            std::set<Gate*> get_all_gates() const;
 
            std::set<Gate*> get_all_verified_gates() const;
 
            hal::Result<std::monostate> create_modules_in_netlist();
 
            std::string get_timing_stats() const;
 
            hal::Result<Result> merge(const Result& other, const std::vector<std::vector<Gate*>>& registers) const;
 
            static std::vector<std::vector<std::set<Gate*>>> assign_base_candidates_to_iterations(const std::vector<Result>& iteration_results, const bool create_block_lists = false);
 
        private:
            Netlist* m_netlist;
 
            std::vector<std::pair<BaseCandidate, VerifiedCandidate>> m_candidates;
 
            std::string m_timing_stats_json = "";
        };
 
    }    // namespace module_identification
}    // namespace hal