netlist_preprocessing.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/utilities/result.h"
 
#include <map>
#include <vector>
 
namespace hal
{
    class Gate;
    class Netlist;
    class GateType;
    class GateLibrary;
    class Module;
    class Net;
 
    namespace netlist_preprocessing
    {
        Result<u32> remove_unused_lut_inputs(Netlist* nl);
 
        Result<u32> remove_buffers(Netlist* nl);
 
        Result<u32> remove_redundant_gates(Netlist* nl, const std::function<bool(const Gate*)>& filter = nullptr);
 
        Result<u32> remove_redundant_loops(Netlist* nl);
 
        Result<u32> remove_redundant_logic_trees(Netlist* nl);
 
        Result<u32> remove_unconnected_gates(Netlist* nl);
 
        Result<u32> remove_unconnected_nets(Netlist* nl);
 
        Result<u32> remove_unconnected_looped(Netlist* nl);
 
        Result<u32> manual_mux_optimizations(Netlist* nl, GateLibrary* mux_inv_gl);
 
        Result<u32> propagate_constants(Netlist* nl);
 
        Result<u32> remove_consecutive_inverters(Netlist* nl);
 
        Result<u32> simplify_lut_inits(Netlist* nl);
 
        Result<u32> reconstruct_indexed_ff_identifiers(Netlist* nl);
 
        Result<u32> reconstruct_top_module_pin_groups(Netlist* nl);
 
        Result<std::monostate> parse_def_file(Netlist* nl, const std::filesystem::path& def_file);
 
        Result<std::vector<Module*>> create_multi_bit_gate_modules(Netlist* nl, const std::map<std::string, std::map<std::string, std::vector<std::string>>>& concatenated_pin_groups);
 
        Result<std::vector<Net*>> create_nets_at_unconnected_pins(Netlist* nl);
 
        Result<u32> unify_ff_outputs(Netlist* nl, const std::vector<Gate*>& ffs = {}, GateType* inverter_type = nullptr);
    }    // namespace netlist_preprocessing
}    // namespace hal