grouping.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/event_system/event_handler.h"
#include "hal_core/netlist/netlist_internal_manager.h"
#include "hal_core/utilities/utils.h"
 
#include <functional>
#include <unordered_map>
#include <vector>
 
namespace hal
{
    class Gate;
    class Net;
    class Module;
 
    class NETLIST_API Grouping
    {
    public:
        u32 get_id() const;
 
        void set_name(std::string name);
 
        std::string get_name() const;
 
        void set_color(utils::Color c);
 
        utils::Color get_color() const;
 
        utils::Color next_color();
 
        Netlist* get_netlist() const;
 
        /*
         * ################################################################
         *      gate functions
         * ################################################################
         */
 
        bool assign_gate(Gate* gate, bool force = false);
 
        bool assign_gate_by_id(const u32 gate_id, bool force = false);
 
        const std::vector<Gate*>& get_gates() const;
 
        std::vector<Gate*> get_gates(const std::function<bool(Gate*)>& filter) const;
 
        std::vector<u32> get_gate_ids(const std::function<bool(Gate*)>& filter = nullptr) const;
 
        bool remove_gate(Gate* gate);
 
        bool remove_gate_by_id(const u32 gate_id);
 
        bool contains_gate(Gate* gate) const;
 
        bool contains_gate_by_id(const u32 gate_id) const;
 
        /*
         * ################################################################
         *      net functions
         * ################################################################
         */
 
        bool assign_net(Net* net, bool force = false);
 
        bool assign_net_by_id(const u32 net_id, bool force = false);
 
        const std::vector<Net*>& get_nets() const;
 
        std::vector<Net*> get_nets(const std::function<bool(Net*)>& filter) const;
 
        std::vector<u32> get_net_ids(const std::function<bool(Net*)>& filter = nullptr) const;
 
        bool remove_net(Net* net);
 
        bool remove_net_by_id(const u32 net_id);
 
        bool contains_net(Net* net) const;
 
        bool contains_net_by_id(const u32 net_id) const;
 
        /*
         * ################################################################
         *      module functions
         * ################################################################
         */
 
        bool assign_module(Module* module, bool force = false);
 
        bool assign_module_by_id(const u32 module_id, bool force = false);
 
        const std::vector<Module*>& get_modules() const;
 
        std::vector<Module*> get_modules(const std::function<bool(Module*)>& filter) const;
 
        std::vector<u32> get_module_ids(const std::function<bool(Module*)>& filter = nullptr) const;
 
        bool remove_module(Module* module);
 
        bool remove_module_by_id(const u32 module_id);
 
        bool contains_module(Module* module) const;
 
        bool contains_module_by_id(const u32 module_id) const;
 
    private:
        friend class NetlistInternalManager;
 
        Grouping(NetlistInternalManager* internal_manager, EventHandler* event_handler, u32 id, std::string name);
 
        u32 m_id;
        std::string m_name;
        utils::Color m_color;
        NetlistInternalManager* m_internal_manager;
 
        std::vector<Gate*> m_gates;
        std::unordered_map<u32, Gate*> m_gates_map;
        std::vector<Net*> m_nets;
        std::unordered_map<u32, Net*> m_nets_map;
        std::vector<Module*> m_modules;
        std::unordered_map<u32, Module*> m_modules_map;
 
        EventHandler* m_event_handler;
    };
}    // namespace hal