bitorder_propagation.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 "bitorder_propagation/bit_order.h"
#include "hal_core/defines.h"
#include "hal_core/netlist/pins/pin_group.h"
#include "hal_core/utilities/result.h"
 
#include <map>
 
namespace hal
{
    class Net;
    class Netlist;
    class Module;
    class ModulePin;
 
    namespace bitorder_propagation
    {
        Result<BitOrderResult>
            propagate_module_pingroup_bitorder(const BitOrderResult& src,
                                               const std::set<std::pair<Module*, PinGroup<ModulePin>*>>& dst,
                                               const bool enforce_continuous_bitorders = true);
 
        Result<std::monostate> reorder_module_pin_groups(const BitOrderResult& ordered_module_pin_groups);
 
        Result<BitOrderResult> propagate_bitorder(Netlist* nl, const std::pair<u32, std::string>& src, const std::pair<u32, std::string>& dst);
 
        Result<BitOrderResult> propagate_bitorder(const std::pair<Module*, PinGroup<ModulePin>*>& src,
                                                                                                           const std::pair<Module*, PinGroup<ModulePin>*>& dst);
 
        Result<BitOrderResult>
            propagate_bitorder(Netlist* nl, const std::vector<std::pair<u32, std::string>>& src, const std::vector<std::pair<u32, std::string>>& dst);
 
        Result<BitOrderResult> propagate_bitorder(const std::vector<std::pair<Module*, PinGroup<ModulePin>*>>& src,
                                                                                                           const std::vector<std::pair<Module*, PinGroup<ModulePin>*>>& dst);
 
        Result<std::map<std::pair<Module*, PinGroup<ModulePin>*>, WordIndex>> export_bitorder_propagation_information(const std::vector<std::pair<Module*, PinGroup<ModulePin>*>>& src,
                                                                                                                const std::vector<std::pair<Module*, PinGroup<ModulePin>*>>& dst,
                                                                                                                const std::string& export_filepath);
        Result<std::map<std::pair<Module*, PinGroup<ModulePin>*>, WordIndex>> export_bitorder_propagation_information(const BitOrderResult& src,
                                                                                                                const std::set<std::pair<Module*, PinGroup<ModulePin>*>>& dst,
                                                                                                                const std::string& export_filepath);
 
    }    // namespace bitorder_propagation
}    // namespace hal