From: Andreas Sandberg <Andreas.Sandberg@ARM.com>
Date: Thu, 16 Oct 2014 09:49:38 +0000 (-0400)
Subject: sim: Add typedefs for PMU probe points
X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=132ea6319ab9292bef7c0ea87f396ef9de2db0fe;p=gem5.git

sim: Add typedefs for PMU probe points

In order to show make PMU probe points usable across different PMU
implementations, we want a common probe interface. This patch the
namespace ProbePoins that contains typedefs for probe points that are
shared between multiple SimObjects. It also adds typedefs for the PMU
probe interface.
---

diff --git a/src/sim/probe/pmu.hh b/src/sim/probe/pmu.hh
new file mode 100644
index 000000000..0cb2298d3
--- /dev/null
+++ b/src/sim/probe/pmu.hh
@@ -0,0 +1,61 @@
+/*
+ * Copyright (c) 2014 ARM Limited
+ * 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.
+ *
+ * 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.
+ *
+ * Authors: Andreas Sandberg
+ */
+#ifndef __SIM_PROBE_PMU_HH__
+#define __SIM_PROBE_PMU_HH__
+
+#include <memory>
+
+#include "sim/probe/probe.hh"
+
+namespace ProbePoints {
+
+/**
+ * PMU probe point
+ *
+ * This probe point provides a unified interface for PMU
+ * instrumentation of SimObjects. SimObjects that need PMU
+ * instrumentation should implement probes of this type call the
+ * notify method with the event count increment as its only parameter.
+ */
+typedef ProbePointArg<uint64_t> PMU;
+typedef std::unique_ptr<PMU> PMUUPtr;
+
+}
+
+#endif
diff --git a/src/sim/probe/probe.hh b/src/sim/probe/probe.hh
index 2946f4664..8f68c0441 100644
--- a/src/sim/probe/probe.hh
+++ b/src/sim/probe/probe.hh
@@ -72,6 +72,21 @@
 class ProbeManager;
 class ProbeListener;
 
+/**
+ * Name space containing shared probe point declarations.
+ *
+ * Probe types that are shared between multiple types of SimObjects
+ * should live in this name space. This makes it possible to use a
+ * common instrumentation interface for devices such as PMUs that have
+ * different implementations in different ISAs.
+ */
+namespace ProbePoints {
+/* 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.
+ */
+}
+
 /**
  * This class is a minimal wrapper around SimObject. It is used to declare
  * a python derived object that can be added as a ProbeListener to any other