bit_order.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/pins/pin_group.h"
 
#include <optional>
#include <vector>
 
namespace hal
{
    class Net;
    class Module;
    class ModulePin;
 
    namespace bitorder_propagation
    {
        using WordIndex = u32;
 
        class BitOrder
        {
        public:
            BitOrder(Module* module, PinGroup<ModulePin>* pin_group, std::vector<std::pair<Net*, u32>> order);
 
            Module* get_module() const;
 
            PinGroup<ModulePin>* get_pin_group() const;
 
            const std::vector<std::pair<Net*, u32>>& get_order() const;
 
            std::optional<u32> get_index(const Net* net) const;
 
            Net* get_net_at(u32 index) const;
 
            u32 get_size() const;
 
            bool is_continuous() const;
 
            bool operator==(const BitOrder& other) const;
            bool operator!=(const BitOrder& other) const;
 
        private:
            Module* m_module;
            PinGroup<ModulePin>* m_pin_group;
            std::vector<std::pair<Net*, u32>> m_order;
        };
 
        class BitOrderResult
        {
        public:
            BitOrderResult() = default;
 
            explicit BitOrderResult(std::vector<BitOrder> bit_orders);
 
            void add(BitOrder bit_order);
 
            const std::vector<BitOrder>& get_bit_orders() const;
 
            const BitOrder* get(const Module* module, const PinGroup<ModulePin>* pin_group) const;
 
            bool contains(const Module* module, const PinGroup<ModulePin>* pin_group) const;
 
            u32 get_size() const;
 
            bool is_empty() const;
 
            std::vector<BitOrder>::const_iterator begin() const;
            std::vector<BitOrder>::const_iterator end() const;
 
        private:
            std::vector<BitOrder> m_bit_orders;
        };
    }    // namespace bitorder_propagation
}    // namespace hal