net.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/data_container.h"
#include "hal_core/netlist/event_system/event_handler.h"
#include "hal_core/netlist/pins/gate_pin.h"
#include "hal_core/netlist/pins/pin_group.h"
#include "hal_core/utilities/result.h"
 
#include <functional>
#include <map>
#include <memory>
#include <set>
#include <string>
#include <tuple>
#include <vector>
 
namespace hal
{
    /* forward declaration */
    class Netlist;
    class Gate;
    class Grouping;
    class NetlistInternalManager;
    class Endpoint;
 
    class NETLIST_API Net : public DataContainer
    {
    public:
        bool operator==(const Net& other) const;
 
        bool operator!=(const Net& other) const;
 
        ssize_t get_hash() const;
 
        u32 get_id() const;
 
        Netlist* get_netlist() const;
 
        const std::string& get_name() const;
 
        void set_name(const std::string& name);
 
        Grouping* get_grouping() const;
 
        /*
         *      src specific functions
         */
 
        Endpoint* add_source(Gate* gate, const std::string& pin_name);
 
        Endpoint* add_source(Gate* gate, GatePin* pin);
 
        bool remove_source(Gate* gate, const std::string& pin_name);
 
        bool remove_source(Gate* gate, const GatePin* pin);
 
        bool remove_source(Endpoint* ep);
 
        bool is_a_source(const Gate* gate) const;
 
        bool is_a_source(const Gate* gate, const std::string& pin_name) const;
 
        bool is_a_source(const Gate* gate, const GatePin* pin) const;
 
        bool is_a_source(const Endpoint* ep) const;
 
        u32 get_num_of_sources(const std::function<bool(Endpoint* ep)>& filter = nullptr) const;
 
        std::vector<Endpoint*> get_sources(const std::function<bool(Endpoint* ep)>& filter = nullptr) const;
 
        /*
         *      dst specific functions
         */
 
        Endpoint* add_destination(Gate* gate, const std::string& pin_name);
 
        Endpoint* add_destination(Gate* gate, GatePin* pin);
 
        bool remove_destination(Gate* gate, const std::string& pin_name);
 
        bool remove_destination(Gate* gate, const GatePin* pin);
 
        bool remove_destination(Endpoint* ep);
 
        bool is_a_destination(const Gate* gate) const;
 
        bool is_a_destination(const Gate* gate, const std::string& pin_name) const;
 
        bool is_a_destination(const Gate* gate, const GatePin* pin) const;
 
        bool is_a_destination(const Endpoint* ep) const;
 
        u32 get_num_of_destinations(const std::function<bool(Endpoint* ep)>& filter = nullptr) const;
 
        std::vector<Endpoint*> get_destinations(const std::function<bool(Endpoint* ep)>& filter = nullptr) const;
 
        bool is_unrouted() const;
 
        bool is_gnd_net() const;
 
        bool is_vcc_net() const;
 
        bool mark_global_input_net();
 
        bool mark_global_output_net();
 
        bool unmark_global_input_net();
 
        bool unmark_global_output_net();
 
        bool is_global_input_net() const;
 
        bool is_global_output_net() const;
 
    private:
        friend class NetlistInternalManager;
        explicit Net(NetlistInternalManager* internal_manager, EventHandler* event_handler, const u32 id, const std::string& name = "");
 
        Net(const Net&)            = delete;
        Net(Net&&)                 = delete;
        Net& operator=(const Net&) = delete;
        Net& operator=(Net&&)      = delete;
 
        NetlistInternalManager* m_internal_manager;
 
        /* stores the id of the net */
        u32 m_id;
 
        /* stores the name of the net */
        std::string m_name;
 
        /* grouping */
        Grouping* m_grouping = nullptr;
 
        /* stores the dst gate and pin id of the dst gate */
        std::vector<std::unique_ptr<Endpoint>> m_destinations;
        std::vector<std::unique_ptr<Endpoint>> m_sources;
        std::vector<Endpoint*> m_destinations_raw;
        std::vector<Endpoint*> m_sources_raw;
 
        EventHandler* m_event_handler;
    };
}    // namespace hal