configuration.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 "module_identification/types/candidate_types.h"
#include "module_identification/types/multithreading_types.h"
 
#include <set>
#include <thread>
#include <vector>
 
namespace hal
{
    class Netlist;
    class Gate;
 
    namespace module_identification
    {
        struct Configuration
        {
            Configuration(Netlist* nl);
 
            Configuration();
 
            Netlist* m_netlist;
 
            std::vector<std::vector<Gate*>> m_known_registers = {};
 
            std::vector<module_identification::CandidateType> m_types_to_check = all_checkable_candidate_types;
 
            u32 m_max_thread_count = 1;
 
            u32 m_max_control_signals = 3;
 
            std::vector<std::vector<Gate*>> m_already_classified_candidates = {};
 
            std::vector<std::set<Gate*>> m_blocked_base_candidates = {};
 
            MultithreadingPriority m_multithreading_priority = MultithreadingPriority::memory_priority;
 
            Configuration& with_known_registers(const std::vector<std::vector<Gate*>>& registers);
 
            Configuration& with_max_thread_count(const u32& max_thread_count);
 
            Configuration& with_max_control_signals(const u32& max_control_signals);
 
            Configuration& with_multithreading_priority(const MultithreadingPriority& priority);
 
            Configuration& with_types_to_check(const std::vector<module_identification::CandidateType>& types_to_check);
 
            Configuration& with_already_classified_candidates(const std::vector<std::vector<Gate*>>& already_classified_candidates);
 
            Configuration& with_blocked_base_candidates(const std::vector<std::set<Gate*>>& blocked_base_candidates);
        };
    }    // namespace module_identification
}    // namespace hal