probe.hh

Go to the documentation of this file.

/*
 * Copyright (c) 2013 ARM Limited
 * Copyright (c) 2022-2023 The University of Edinburgh
 * All rights reserved
 *
 * The license below extends only to copyright in the software and shall
 * not be construed as granting a license to any other intellectual
 * property including but not limited to intellectual property relating
 * to a hardware implementation of the functionality of the software
 * licensed hereunder.  You may use the software subject to the license
 * terms below provided that you ensure that this notice is replicated
 * unmodified and in its entirety in all distributions of the software,
 * modified or unmodified, in source code or in binary form.
 *
 * Copyright (c) 2020 Inria
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met: redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer;
 * redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the distribution;
 * neither the name of the copyright holders nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

 
#ifndef __SIM_PROBE_PROBE_HH__
#define __SIM_PROBE_PROBE_HH__
 
#include <string>
#include <vector>
 
#include "base/compiler.hh"
#include "base/named.hh"
#include "base/trace.hh"
 
namespace gem5
{

class ProbeManager;
class ProbeListener;

namespace probing
{
/* Note: This is only here for documentation purposes, new probe
 * points should normally be declared in their own header files. See
 * for example pmu.hh.
 */
}

class ProbeListener
{
  public:
    ProbeListener(std::string _name) : name(std::move(_name)) {}
 
    virtual ~ProbeListener() = default;
    ProbeListener(const ProbeListener& other) = delete;
    ProbeListener& operator=(const ProbeListener& other) = delete;
    ProbeListener(ProbeListener&& other) noexcept = delete;
    ProbeListener &operator=(ProbeListener &&other) noexcept = delete;
    const std::string &getName() const { return name; }
 
  protected:
    const std::string name;
};

class ProbePoint
{
  protected:
    const std::string name;
  public:
    ProbePoint(ProbeManager *manager, const std::string &name);
    virtual ~ProbePoint() {}
 
    virtual void addListener(ProbeListener *listener) = 0;
    virtual void removeListener(ProbeListener *listener) = 0;
    const std::string &getName() const { return name; }
};
 
struct ProbeListenerCleanup
{
    ProbeListenerCleanup() : manager(nullptr) {};
    explicit ProbeListenerCleanup(ProbeManager *m) : manager(m) {};
    void operator()(ProbeListener *listener) const;
 
  private:
    ProbeManager *manager;
};

template <typename Listener = ProbeListener>
using ProbeListenerPtr = std::unique_ptr<Listener, ProbeListenerCleanup>;

class ProbeManager : public Named
{
  private:
    std::vector<ProbePoint *> points;
 
  public:
    ProbeManager(const std::string &obj_name) : Named(obj_name) {}
    virtual ~ProbeManager() {}

    bool addListener(std::string_view point_name, ProbeListener &listener);

    bool removeListener(std::string_view point_name, ProbeListener &listener);

    void addPoint(ProbePoint &point);
    ProbePoint *getFirstProbePoint(std::string_view point_name) const;
 
    template <typename Listener, typename... Args>
    ProbeListenerPtr<Listener> connect(Args &&...args)
    {
        ProbeListenerPtr<Listener> result(
            new Listener(std::forward<Args>(args)...),
            ProbeListenerCleanup(this));
        addListener(result->getName(), *result);
        return result;
    }
};
 
inline void
ProbeListenerCleanup::operator()(ProbeListener *listener) const
{
    manager->removeListener(listener->getName(), *listener);
    delete listener;
}

template <class Arg>
class ProbeListenerArgBase : public ProbeListener
{
  public:
    ProbeListenerArgBase(std::string name) : ProbeListener(std::move(name)) {}
    virtual void notify(const Arg &val) = 0;
};

template <class T, class Arg>
class ProbeListenerArg : public ProbeListenerArgBase<Arg>
{
  private:
    T *object;
    void (T::* function)(const Arg &);
 
  public:
    ProbeListenerArg(T *obj, std::string name, void (T::*func)(const Arg &))
        : ProbeListenerArgBase<Arg>(std::move(name)),
          object(obj),
          function(func)
    {}

    void notify(const Arg &val) override { (object->*function)(val); }
};

template <typename Arg>
class ProbePointArg : public ProbePoint
{
    std::vector<ProbeListenerArgBase<Arg> *> listeners;
 
  public:
    ProbePointArg(ProbeManager *manager, std::string name)
        : ProbePoint(manager, name)
    {
    }

    bool hasListeners() const { return listeners.size() > 0; }

    void
    addListener(ProbeListener *l_base) override
    {
        auto *l = dynamic_cast<ProbeListenerArgBase<Arg> *>(l_base);
        panic_if(!l, "Wrong type of listener: expected %s got %s",
                 typeid(ProbeListenerArgBase<Arg>).name(),
                 typeid(*l_base).name());
        // check listener not already added
        if (std::find(listeners.begin(), listeners.end(), l) ==
            listeners.end()) {
            listeners.push_back(l);
        }
    }

    void
    removeListener(ProbeListener *l_base) override
    {
        auto *l = dynamic_cast<ProbeListenerArgBase<Arg> *>(l_base);
        panic_if(!l, "Wrong type of listener expected %s got %s",
                 typeid(ProbeListenerArgBase<Arg>).name(),
                 typeid(*l_base).name());
        listeners.erase(std::remove(listeners.begin(), listeners.end(), l),
                        listeners.end());
    }

    void
    notify(const Arg &arg)
    {
        for (auto *l : listeners) {
            l->notify(arg);
        }
    }
};
 

template <class Arg>
class ProbeListenerArgFunc : public ProbeListenerArgBase<Arg>
{
  typedef std::function<void(const Arg &)> NotifyFunction;
  private:
    NotifyFunction function;
 
  public:
    ProbeListenerArgFunc(const std::string &name, const NotifyFunction &func)
        : ProbeListenerArgBase<Arg>(name), function(func)
    {}

    void notify(const Arg &val) override { function(val); }
};
 
 
} // namespace gem5
 
#endif//__SIM_PROBE_PROBE_HH__