conf-object.h

Go to the documentation of this file.

// -*- mode: C++; c-file-style: "virtutech-c++" -*-
 
/*
  © 2021 Intel Corporation
 
  This software and the related documents are Intel copyrighted materials, and
  your use of them is governed by the express license under which they were
  provided to you ("License"). Unless the License provides otherwise, you may
  not use, modify, copy, publish, distribute, disclose or transmit this software
  or the related documents without Intel's prior written permission.
 
  This software and the related documents are provided as is, with no express or
  implied warranties, other than those that are expressly stated in the License.
*/
 
#ifndef SIMICS_CONF_OBJECT_H
#define SIMICS_CONF_OBJECT_H
 
#include <simics/base/conf-object.h>
#include <simics/simulator/conf-object.h>
 
#include <cassert>
#include <stdexcept>
#include <string>
#include <unordered_map>
 
#include "simics/conf-object-interface.h"
 
namespace simics {
 
class ConfObject;
 
class ConfObjectRef {
  public:
    ConfObjectRef(conf_object_t *obj = nullptr)  // NOLINT(runtime/explicit)
        : o_(obj) {}
    virtual ~ConfObjectRef() = default;
 
 
    conf_object_t *object() const { return o_; }
    operator conf_object_t *() const { return o_; }
 
 
    const std::string &port_name() const { return port_name_; }
    void set_port_name(const std::string &name) { port_name_ = name; }
 
    void *data() const;
 
    std::string name() const;
 
    void require() const;
 
    bool configured() const;
 
    conf_object_t *port_obj_parent() const;
 
    ConfObject &as_conf_object() const;
 
    const interface_t *get_interface(const std::string &name) const;
 
    [[deprecated("Use GROUP_ID or ConfClass::getGroupId instead")]]
    uint64 group_id(const std::string &name) const;
 
  private:
    conf_object_t *o_ {nullptr};
    std::string port_name_;
};
 
bool operator==(const ConfObjectRef &lhs, const ConfObjectRef &rhs);
bool operator!=(const ConfObjectRef &lhs, const ConfObjectRef &rhs);
 
class ConfObject : public ConfObjectInterface {
  public:
    explicit ConfObject(const ConfObjectRef &obj) : obj_(obj) {}
    virtual ~ConfObject() = default;
 
    // iface::ConfObjectInterface
    void finalize() override {}
    void objects_finalized() override {}
 
    ConfObjectRef obj() const { return obj_; }
 
    virtual bool finalized() {
        return SIM_object_is_configured(obj_);
    }
 
  private:
#if defined INTC_EXT
    [[deprecated("Dead function to maintain ABI compatibility with "
                 "Simics Base version 6.0.215")]]
    void init_log_groups();
#endif
 
    ConfObjectRef obj_;
#if defined INTC_EXT
    std::unordered_map<std::string, uint64> groups_;
#endif
};
 
template <typename T> inline
T *from_obj(conf_object_t *obj) {
    static_assert(std::is_base_of<ConfObject, T>::value,
                  "type T is not derived from type ConfObject");
    auto *d = static_cast<ConfObject *>(SIM_object_data(obj));
    assert(d);
    return static_cast<T*>(d);
}
 
}  // namespace simics
#endif