configuration.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/gate_library/enums/gate_type_property.h"
#include "hal_core/netlist/gate_library/enums/pin_type.h"
#include "hal_core/netlist/pins/module_pin.h"
#include "hal_core/netlist/pins/pin_group.h"
 
#include <set>
#include <unordered_set>
#include <vector>
 
namespace hal
{
    class Gate;
    class Module;
    class Grouping;
    class Netlist;
    class Net;
    class GateType;
 
    namespace dataflow
    {
        struct Configuration
        {
            Configuration(Netlist* nl);
 
            Netlist* netlist;
 
            u32 min_group_size = 8;
 
            std::vector<u32> expected_sizes = {};
 
            std::vector<std::vector<Gate*>> known_gate_groups = {};
 
            std::vector<std::vector<Net*>> known_net_groups = {};
 
            std::set<const GateType*> gate_types = {};
 
            std::set<PinType> control_pin_types = {};
 
            bool enable_stages = false;
 
            bool enforce_type_consistency = false;
 
            Configuration& with_min_group_size(u32 size);
 
            Configuration& with_expected_sizes(const std::vector<u32>& sizes);
 
            Configuration& with_known_structures(const std::vector<Module*>& structures, bool overwrite = false);
 
            Configuration& with_known_structures(const std::vector<std::pair<Module*, std::vector<PinGroup<ModulePin>*>>>& structures, bool overwrite = false);
 
            Configuration& with_known_structures(const std::vector<Gate*>& structures, bool overwrite = false);
 
            Configuration& with_known_structures(const std::vector<std::pair<Gate*, std::vector<PinGroup<GatePin>*>>>& structures, bool overwrite = false);
 
            Configuration& with_known_structures(const std::unordered_set<const GateType*>& structures, bool overwrite = false);
 
            Configuration& with_known_structures(const std::unordered_map<const GateType*, std::vector<PinGroup<GatePin>*>>& structures, bool overwrite = false);
 
            Configuration& with_known_groups(const std::vector<Module*>& groups, bool overwrite = false);
 
            Configuration& with_known_groups(const std::vector<std::vector<Gate*>>& groups, bool overwrite = false);
 
            Configuration& with_known_groups(const std::vector<std::vector<u32>>& groups, bool overwrite = false);
 
            Configuration& with_known_groups(const std::unordered_map<u32, std::unordered_set<Gate*>>& groups, bool overwrite = false);
 
            Configuration& with_gate_types(const std::set<const GateType*>& types, bool overwrite = false);
 
            Configuration& with_gate_types(const std::set<GateTypeProperty>& type_properties, bool overwrite = false);
 
            Configuration& with_control_pin_types(const std::set<PinType>& types, bool overwrite = false);
 
            Configuration& with_flip_flops();
 
            Configuration& with_stage_identification(bool enable = true);
 
            Configuration& with_type_consistency(bool enable = true);
        };
    }    // namespace dataflow
}    // namespace hal