device.h

Go to the documentation of this file.

// -*- mode: C++; c-file-style: "virtutech-c++" -*-
 
/*
  © 2015 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_SYSTEMC_DEVICE_H
#define SIMICS_SYSTEMC_DEVICE_H
 
 
#include <systemc>
 
#include <simics/systemc/context.h>
#include <simics/systemc/device_access.h>
#include <simics/systemc/iface/simulation_interface.h>
 
#include <string>
#include <utility>
 
namespace simics {
namespace systemc {
 
template <typename T>
class Device {
  public:
    enum ownership_t {
        DONT_TAKE_OWNERSHIP,
        TAKE_OWNERSHIP
    };
 
    Device() : simulation_(NULL), device_(NULL), is_device_owner_(false) {}
 
    Device(Device &other)
        : simulation_(NULL), device_(NULL), is_device_owner_(false) {
        *this = other;
    }
 
    explicit Device(iface::SimulationInterface *simulation)
        : simulation_(simulation), device_(new T), is_device_owner_(true) {
    }
 
    Device(iface::SimulationInterface *simulation,
           const std::string &device_name)
        : simulation_(simulation), device_(new T(device_name.c_str())),
          is_device_owner_(true) {
    }
 
    Device(iface::SimulationInterface *simulation, T *device_model,
           ownership_t ownership = TAKE_OWNERSHIP)
        : simulation_(simulation), device_(device_model),
          is_device_owner_(ownership == TAKE_OWNERSHIP) {
    }
 
 
    Device& operator=(Device &other) {  // NOLINT(runtime/references)
        FATAL_ERROR_IF(device_, "Changing the device is not allowed");
        FATAL_ERROR_IF(simulation_, "Changing the simulation is not allowed");
 
        std::swap(device_, other.device_);
        std::swap(simulation_, other.simulation_);
        std::swap(is_device_owner_, other.is_device_owner_);
        return *this;
    }
 
    DeviceAccess<T> operator->() {
        return DeviceAccess<T>(simulation_, device_);
    }
 
    const DeviceAccess<T> operator->() const {
        return DeviceAccess<T>(simulation_, device_);
    }
 
    T *pointer() {
        return device_;
    }
 
    const T *pointer() const {
        return device_;
    }
 
    virtual ~Device() {
        if (is_device_owner_) {
            simics::systemc::Context c(simulation_);
            delete device_;
        }
    }
 
  private:
    iface::SimulationInterface *simulation_;
    T *device_;
    bool is_device_owner_;
};
 
}  // namespace systemc
}  // namespace simics
 
#endif