candidate_context.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/decorators/boolean_function_decorator.h"
#include "hal_core/netlist/decorators/boolean_function_net_decorator.h"
#include "hal_core/netlist/decorators/subgraph_netlist_decorator.h"
#include "hal_core/utilities/log.h"
#include "hal_core/utilities/result.h"
 
#include <map>
#include <vector>
 
// #define Z3_CANDIDATE_CONTEXT
#define HAL_CANDIDATE_CONTEXT
 
#ifdef Z3_CANDIDATE_CONTEXT
#include "z3_utils/simplification.h"
#include "z3_utils/subgraph_function_generation.h"
#include "z3_utils/z3_utils.h"
#endif
 
namespace hal
{
    class Gate;
 
    namespace module_identification
    {
        struct CandidateContext
        {
            CandidateContext(const Netlist* nl, const std::vector<Gate*>& gates);
 
#ifdef HAL_CANDIDATE_CONTEXT
            hal::Result<std::monostate> populate_boolean_function_cache(const std::vector<Net*> nets);
 
            hal::Result<const BooleanFunction> get_boolean_function_const(const Net* n, const std::map<Net*, BooleanFunction::Value>& ctrl_mapping) const;
 
            hal::Result<std::vector<BooleanFunction>> get_boolean_functions_const(const std::vector<Net*> nets, const std::map<Net*, BooleanFunction::Value>& ctrl_mapping) const;
 
            hal::Result<const BooleanFunction> get_boolean_function(const Net* n, const std::map<Net*, BooleanFunction::Value>& ctrl_mapping);
 
            hal::Result<std::vector<BooleanFunction>> get_boolean_functions(const std::vector<Net*> nets, const std::map<Net*, BooleanFunction::Value>& ctrl_mapping);
 
            hal::Result<const std::set<std::string>> get_variable_names(const Net* n, const std::map<Net*, BooleanFunction::Value>& ctrl_mapping);
 
            hal::Result<const std::set<Net*>> get_variable_nets(const Net* n, const std::map<Net*, BooleanFunction::Value>& ctrl_mapping);
 
            hal::Result<std::unordered_map<std::string, double>> get_boolean_influence(const Net* n, const std::map<Net*, BooleanFunction::Value>& ctrl_mapping);
 
            hal::Result<std::vector<BooleanFunction::Value>>
                evaluate(const Net* n, const std::map<Net*, BooleanFunction::Value>& ctrl_mapping, const std::map<std::string, BooleanFunction::Value>& eval_mapping);
 
            std::vector<Gate*> m_gates;
 
            const Netlist* m_netlist;
 
        private:
            std::map<std::pair<const Net*, std::map<Net*, BooleanFunction::Value>>, BooleanFunction> m_boolean_function_cache;
 
            std::map<std::pair<const Net*, std::map<Net*, BooleanFunction::Value>>, std::set<std::string>> m_boolean_vars_cache;
 
            std::map<std::pair<const Net*, std::map<Net*, BooleanFunction::Value>>, std::unordered_map<std::string, double>> m_boolean_influence_cache;
#endif
 
#ifdef Z3_CANDIDATE_CONTEXT
            hal::Result<std::monostate> populate_boolean_function_cache(const std::vector<Net*> nets);
 
            hal::Result<z3::expr> get_boolean_function(const Net* n, const std::map<Net*, BooleanFunction::Value>& ctrl_mapping);
 
            hal::Result<z3::expr> get_boolean_function_const(const Net* n, const std::map<Net*, BooleanFunction::Value>& ctrl_mapping) const;
 
            hal::Result<BooleanFunction> get_hal_boolean_function(const Net* n, const std::map<Net*, BooleanFunction::Value>& ctrl_mapping);
 
            hal::Result<BooleanFunction> get_hal_boolean_function_const(const Net* n, const std::map<Net*, BooleanFunction::Value>& ctrl_mapping);
 
            hal::Result<std::vector<BooleanFunction>> get_boolean_functions(const std::vector<Net*>& nets, const std::map<Net*, BooleanFunction::Value>& ctrl_mapping);
 
            hal::Result<std::vector<BooleanFunction>> get_boolean_functions_const(const std::vector<Net*>& nets, const std::map<Net*, BooleanFunction::Value>& ctrl_mapping);
 
            hal::Result<std::set<std::string>> get_variable_names(const Net* n, const std::map<Net*, BooleanFunction::Value>& ctrl_mapping);
 
            hal::Result<std::set<Net*>> get_variable_nets(const Net* n, const std::map<Net*, BooleanFunction::Value>& ctrl_mapping);
 
            hal::Result<std::unordered_map<std::string, double>> get_boolean_influence(const Net* n, const std::map<Net*, BooleanFunction::Value>& ctrl_mapping);
 
            hal::Result<std::vector<BooleanFunction::Value>>
                evaluate(const Net* n, const std::map<Net*, BooleanFunction::Value>& ctrl_mapping, const std::map<std::string, BooleanFunction::Value>& eval_mapping);
 
            std::vector<Gate*> m_gates;
 
            z3::context m_ctx;
 
        private:
            const Netlist* m_netlist;
 
            std::map<std::pair<const Net*, std::map<Net*, BooleanFunction::Value>>, BooleanFunction> m_boolean_function_hal_cache;
 
            std::map<std::pair<const Net*, std::map<Net*, BooleanFunction::Value>>, z3::expr> m_boolean_function_cache;
 
            std::map<std::pair<const Net*, std::map<Net*, BooleanFunction::Value>>, std::set<std::string>> m_boolean_vars_cache;
 
            std::map<std::pair<const Net*, std::map<Net*, BooleanFunction::Value>>, std::unordered_map<std::string, double>> m_boolean_influence_cache;
#endif
        };
    }    // namespace module_identification
}    // namespace hal