register_candidate.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/utilities/result.h"
 
#include <set>
 
namespace hal
{
    class Netlist;
    class Gate;
    class Net;
 
    namespace hawkeye
    {
        class RegisterCandidate
        {
        public:
            RegisterCandidate() = default;
 
            ~RegisterCandidate() = default;
 
            RegisterCandidate(const std::set<Gate*>& round_reg);
 
            RegisterCandidate(std::set<Gate*>&& round_reg);
 
            RegisterCandidate(const std::set<Gate*>& in_reg, const std::set<Gate*>& out_reg);
 
            RegisterCandidate(std::set<Gate*>&& in_reg, std::set<Gate*>&& out_reg);
 
            bool operator==(const RegisterCandidate& rhs) const;
 
            bool operator<(const RegisterCandidate& rhs) const;
 
            Netlist* get_netlist() const;
 
            u32 get_size() const;
 
            bool is_round_based() const;
 
            const std::set<Gate*>& get_input_reg() const;
 
            const std::set<Gate*>& get_output_reg() const;
 
        private:
            Netlist* m_netlist;
 
            u32 m_size;
 
            bool m_is_round_based;
 
            std::set<Gate*> m_in_reg;
 
            std::set<Gate*> m_out_reg;
        };
    }    // namespace hawkeye
}    // namespace hal