cci_broker.h

/*******************************************************************************
 * Copyright 2022 MINRES Technologies GmbH
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *******************************************************************************/
 
#ifndef _SYSC_SCC_CCI_BROKER_H_
#define _SYSC_SCC_CCI_BROKER_H_
 
#include <cci_configuration>
#if CCI_VERSION_MAJOR == 1 && CCI_VERSION_MINOR == 0 && CCI_VERSION_PATCH == 0
#include <cci_utils/consuming_broker.h>
#endif
#include <regex>
#include <string>
#include <unordered_map>
#include <unordered_set>
#include <vector>
 
namespace scc {
class cci_broker : public cci_utils::consuming_broker {
    std::unordered_set<std::string> expose;
 
    bool has_parent;
    cci::cci_broker_if& m_parent;
 
    cci::cci_broker_if& get_parent_broker() {
        if(sc_core::sc_get_current_object()) {
            has_parent = true;
            return unwrap_broker(cci::cci_get_broker());
        } else {
            // We ARE the global broker
            has_parent = false;
            return *this;
        }
    }
 
    bool sendToParent(const std::string& parname) const;
 
    void insert_matching_preset_value(const std::string& parname);
 
    struct wildcard_entry {
        std::regex rr;
        cci::cci_value value;
        cci::cci_originator originator;
    };
    std::unordered_map<std::string, wildcard_entry> wildcard_presets;
    std::unordered_map<std::string, std::regex> wildcard_locks;
 
public:
    cci::cci_originator get_value_origin(const std::string& parname) const override;
 
    cci_broker(const std::string& name);
 
    ~cci_broker();
 
    bool has_preset_value(const std::string& parname) const override;
 
    cci::cci_originator get_preset_value_origin(const std::string& parname) const override;
 
    cci::cci_value get_preset_cci_value(const std::string& parname) const override;
    void set_preset_cci_value(const std::string& parname, const cci::cci_value& cci_value, const cci::cci_originator& originator) override;

    void lock_preset_value(const std::string& parname) override;
 
    cci::cci_value get_cci_value(const std::string& parname, const cci::cci_originator& originator = cci::cci_originator()) const override;
 
    cci::cci_param_untyped_handle get_param_handle(const std::string& parname, const cci::cci_originator& originator) const override;
 
    std::vector<cci::cci_param_untyped_handle> get_param_handles(const cci::cci_originator& originator) const override;
 
    void add_param(cci::cci_param_if* par) override;
 
    void remove_param(cci::cci_param_if* par) override;
 
    bool is_global_broker() const override;
};
 
} // namespace scc
#endif // _SYSC_SCC_CCI_BROKER_H_