src/sim/probe/probe.hh

   1 /*
   2  * Copyright (c) 2013 ARM Limited
   3  * All rights reserved
   4  *
   5  * The license below extends only to copyright in the software and shall
   6  * not be construed as granting a license to any other intellectual
   7  * property including but not limited to intellectual property relating
   8  * to a hardware implementation of the functionality of the software
   9  * licensed hereunder.  You may use the software subject to the license
  10  * terms below provided that you ensure that this notice is replicated
  11  * unmodified and in its entirety in all distributions of the software,
  12  * modified or unmodified, in source code or in binary form.
  13  *
  14  * Redistribution and use in source and binary forms, with or without
  15  * modification, are permitted provided that the following conditions are
  16  * met: redistributions of source code must retain the above copyright
  17  * notice, this list of conditions and the following disclaimer;
  18  * redistributions in binary form must reproduce the above copyright
  19  * notice, this list of conditions and the following disclaimer in the
  20  * documentation and/or other materials provided with the distribution;
  21  * neither the name of the copyright holders nor the names of its
  22  * contributors may be used to endorse or promote products derived from
  23  * this software without specific prior written permission.
  24  *
  25  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  26  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  27  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  28  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  29  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  30  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  31  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  32  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  33  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  34  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  35  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  36  *
  37  * Authors: Matt Horsnell
  38   */
  39
  40 /**
  41  * @file This file describes the base components used for the probe system.
  42  * There are currently 3 components:
  43  *
  44  * ProbePoint:          an event probe point i.e. send a notify from the point
  45  *                      at which an instruction was committed.
  46  *
  47  * ProbeListener:       a listener provide a notify method that is called when
  48  *                      a probe point event occurs. Multiple ProbeListeners
  49  *                      can be added to each ProbePoint.
  50  *
  51  * ProbeListenerObject: a wrapper around a SimObject that can connect to another
  52  *                      SimObject on which is will add ProbeListeners.
  53  *
  54  * ProbeManager:        used to match up ProbeListeners and ProbePoints.
  55  *                      At <b>simulation init</b> this is handled by regProbePoints
  56  *                      followed by regProbeListeners being called on each
  57  *                      SimObject in hierarchical ordering.
  58  *                      ProbeListeners can be added/removed dynamically at runtime.
  59  */
  60
  61 #ifndef __SIM_PROBE_PROBE_HH__
  62 #define __SIM_PROBE_PROBE_HH__
  63
  64 #include <string>
  65 #include <vector>
  66
  67 #include "base/compiler.hh"
  68 #include "base/trace.hh"
  69 #include "sim/sim_object.hh"
  70
  71 /** Forward declare the ProbeManager. */
  72 class ProbeManager;
  73 class ProbeListener;
  74 class ProbeListenerObjectParams;
  75
  76 /**
  77  * Name space containing shared probe point declarations.
  78  *
  79  * Probe types that are shared between multiple types of SimObjects
  80  * should live in this name space. This makes it possible to use a
  81  * common instrumentation interface for devices such as PMUs that have
  82  * different implementations in different ISAs.
  83  */
  84 namespace ProbePoints {
  85 /* Note: This is only here for documentation purposes, new probe
  86  * points should normally be declared in their own header files. See
  87  * for example pmu.hh.
  88  */
  89 }
  90
  91 /**
  92  * This class is a minimal wrapper around SimObject. It is used to declare
  93  * a python derived object that can be added as a ProbeListener to any other
  94  * SimObject.
  95  *
  96  * It instantiates manager from a call to Parent.any.
  97  * The vector of listeners is used simply to hold onto listeners until the
  98  * ProbeListenerObject is destroyed.
  99  */
 100 class ProbeListenerObject : public SimObject
 101 {
 102   protected:
 103     ProbeManager *manager;
 104     std::vector<ProbeListener *> listeners;
 105
 106   public:
 107     ProbeListenerObject(const ProbeListenerObjectParams *params);
 108     virtual ~ProbeListenerObject();
 109     ProbeManager* getProbeManager() { return manager; }
 110 };
 111
 112 /**
 113  * ProbeListener base class; here to simplify things like containers
 114  * containing multiple types of ProbeListener.
 115  *
 116  * Note a ProbeListener is added to the ProbePoint in constructor by
 117  * using the ProbeManager passed in.
 118  */
 119 class ProbeListener
 120 {
 121   public:
 122     ProbeListener(ProbeManager *manager, const std::string &name);
 123     virtual ~ProbeListener();
 124
 125   protected:
 126     ProbeManager *const manager;
 127     const std::string name;
 128 };
 129
 130 /**
 131  * ProbeListener base class; again used to simplify use of ProbePoints
 132  * in containers and used as to define interface for adding removing
 133  * listeners to the ProbePoint.
 134  */
 135 class ProbePoint
 136 {
 137   protected:
 138     const std::string name;
 139   public:
 140     ProbePoint(ProbeManager *manager, const std::string &name);
 141     virtual ~ProbePoint() {}
 142
 143     virtual void addListener(ProbeListener *listener) = 0;
 144     virtual void removeListener(ProbeListener *listener) = 0;
 145     std::string getName() const { return name; }
 146 };
 147
 148 /**
 149  * ProbeManager is a conduit class that lives on each SimObject,
 150  *  and is used to match up probe listeners with probe points.
 151  */
 152 class ProbeManager
 153 {
 154   private:
 155     /** Required for sensible debug messages.*/
 156     const M5_CLASS_VAR_USED SimObject *object;
 157     /** Vector for name look-up. */
 158     std::vector<ProbePoint *> points;
 159
 160   public:
 161     ProbeManager(SimObject *obj)
 162         : object(obj)
 163     {}
 164     virtual ~ProbeManager() {}
 165
 166     /**
 167      * @brief Add a ProbeListener to the ProbePoint named by pointName.
 168      *        If the name doesn't resolve a ProbePoint return false.
 169      * @param pointName the name of the ProbePoint to add the ProbeListener to.
 170      * @param listener the ProbeListener to add.
 171      * @return true if added, false otherwise.
 172      */
 173     bool addListener(std::string pointName, ProbeListener &listener);
 174
 175     /**
 176      * @brief Remove a ProbeListener from the ProbePoint named by pointName.
 177      *        If the name doesn't resolve a ProbePoint return false.
 178      * @param pointName the name of the ProbePoint to remove the ProbeListener
 179      *        from.
 180      * @param listener the ProbeListener to remove.
 181      * @return true if removed, false otherwise.
 182      */
 183     bool removeListener(std::string pointName, ProbeListener &listener);
 184
 185     /**
 186      * @brief Add a ProbePoint to this SimObject ProbeManager.
 187      * @param point the ProbePoint to add.
 188      */
 189     void addPoint(ProbePoint &point);
 190 };
 191
 192 /**
 193  * ProbeListenerArgBase is used to define the base interface to a
 194  * ProbeListenerArg (i.e the notify method on specific type).
 195  *
 196  * It is necessary to split this out from ProbeListenerArg, as that
 197  * templates off the class containing the function that notify calls.
 198  */
 199 template <class Arg>
 200 class ProbeListenerArgBase : public ProbeListener
 201 {
 202   public:
 203     ProbeListenerArgBase(ProbeManager *pm, const std::string &name)
 204         : ProbeListener(pm, name)
 205     {}
 206     virtual void notify(const Arg &val) = 0;
 207 };
 208
 209 /**
 210  * ProbeListenerArg generates a listener for the class of Arg and the
 211  * class type T which is the class containing the function that notify will
 212  * call.
 213  *
 214  * Note that the function is passed as a pointer on construction.
 215  */
 216 template <class T, class Arg>
 217 class ProbeListenerArg : public ProbeListenerArgBase<Arg>
 218 {
 219   private:
 220     T *object;
 221     void (T::* function)(const Arg &);
 222
 223   public:
 224     /**
 225      * @param obj the class of type Tcontaining the method to call on notify.
 226      * @param name the name of the ProbePoint to add this listener to.
 227      * @param func a pointer to the function on obj (called on notify).
 228      */
 229     ProbeListenerArg(T *obj, const std::string &name, void (T::* func)(const Arg &))
 230         : ProbeListenerArgBase<Arg>(obj->getProbeManager(), name),
 231           object(obj),
 232           function(func)
 233     {}
 234
 235     /**
 236      * @brief called when the ProbePoint calls notify. This is a shim through to
 237      *        the function passed during construction.
 238      * @param val the argument value to pass.
 239      */
 240     virtual void notify(const Arg &val) { (object->*function)(val); }
 241 };
 242
 243 /**
 244  * ProbePointArg generates a point for the class of Arg. As ProbePointArgs talk
 245  * directly to ProbeListenerArgs of the same type, we can store the vector of
 246  * ProbeListeners as their Arg type (and not as base type).
 247  *
 248  * Methods are provided to addListener, removeListener and notify.
 249  */
 250 template <typename Arg>
 251 class ProbePointArg : public ProbePoint
 252 {
 253     /** The attached listeners. */
 254     std::vector<ProbeListenerArgBase<Arg> *> listeners;
 255
 256   public:
 257     ProbePointArg(ProbeManager *manager, std::string name)
 258         : ProbePoint(manager, name)
 259     {
 260     }
 261
 262     /**
 263      * @brief adds a ProbeListener to this ProbePoints notify list.
 264      * @param l the ProbeListener to add to the notify list.
 265      */
 266     void addListener(ProbeListener *l)
 267     {
 268         // check listener not already added
 269         if (std::find(listeners.begin(), listeners.end(), l) == listeners.end()) {
 270             listeners.push_back(static_cast<ProbeListenerArgBase<Arg> *>(l));
 271         }
 272     }
 273
 274     /**
 275      * @brief remove a ProbeListener from this ProbePoints notify list.
 276      * @param l the ProbeListener to remove from the notify list.
 277      */
 278     void removeListener(ProbeListener *l)
 279     {
 280         listeners.erase(std::remove(listeners.begin(), listeners.end(), l),
 281                         listeners.end());
 282     }
 283
 284     /**
 285      * @brief called at the ProbePoint call site, passes arg to each listener.
 286      * @param arg the argument to pass to each listener.
 287      */
 288     void notify(const Arg &arg)
 289     {
 290         for (auto l = listeners.begin(); l != listeners.end(); ++l) {
 291             (*l)->notify(arg);
 292         }
 293     }
 294 };
 295 #endif//__SIM_PROBE_PROBE_HH__