gate_library.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/gate_library/gate_type.h"
 
#include <map>
#include <set>
#include <string>
#include <vector>
 
namespace hal
{
    class NETLIST_API GateLibrary
    {
    public:
        GateLibrary(const std::filesystem::path& path, const std::string& name);
        ~GateLibrary() = default;
 
        std::string get_name() const;
 
        std::filesystem::path get_path() const;
 
        void set_path(const std::filesystem::path& modified_path);
 
        void set_name(const std::string& modified_name);
 
        void set_gate_location_data_category(const std::string& category);
 
        const std::string& get_gate_location_data_category() const;
        void set_gate_location_data_identifiers(const std::string& x_coordinate, const std::string& y_coordinate);
 
        const std::pair<std::string, std::string>& get_gate_location_data_identifiers() const;
 
        GateType* create_gate_type(const std::string& name, std::set<GateTypeProperty> properties = {GateTypeProperty::combinational}, std::unique_ptr<GateTypeComponent> component = nullptr);
 
        // TODO pybind
        GateType* replace_gate_type(u32 id, const std::string& name, std::set<GateTypeProperty> properties = {GateTypeProperty::combinational}, std::unique_ptr<GateTypeComponent> component = nullptr);
 
        bool contains_gate_type(GateType* gate_type) const;
 
        bool contains_gate_type_by_name(const std::string& name) const;
 
        GateType* get_gate_type_by_name(const std::string& name) const;
 
        std::unordered_map<std::string, GateType*> get_gate_types(const std::function<bool(const GateType*)>& filter = nullptr) const;
 
        bool mark_vcc_gate_type(GateType* gate_type);
 
        std::unordered_map<std::string, GateType*> get_vcc_gate_types() const;
 
        bool mark_gnd_gate_type(GateType* gate_type);
 
        std::unordered_map<std::string, GateType*> get_gnd_gate_types() const;
 
        void add_include(const std::string& include);
 
        std::vector<std::string> get_includes() const;
 
        void remove_gate_type(const std::string& name);
 
    private:
        std::string m_name;
        std::filesystem::path m_path;
 
        std::string m_gate_location_data_category                            = "generic";
        std::pair<std::string, std::string> m_gate_location_data_identifiers = {"X_COORDINATE", "Y_COORDINATE"};
 
        u32 m_next_gate_type_id;
 
        std::vector<std::unique_ptr<GateType>> m_gate_types;
        std::unordered_map<std::string, GateType*> m_gate_type_map;
        std::unordered_map<std::string, GateType*> m_vcc_gate_types;
        std::unordered_map<std::string, GateType*> m_gnd_gate_types;
 
        std::vector<std::string> m_includes;
 
        GateLibrary(const GateLibrary&) = delete;
        GateLibrary& operator=(const GateLibrary&) = delete;
 
        u32 get_unique_gate_type_id();
    };
}    // namespace hal