[otbn] Move trace collation to the otbn_tracer core file
This code shouldn't be in otbn_top_sim.cc: it's going to be needed for
the UVM-based test machinery too. This patch defines a new class
called OtbnTraceSource. It's a singleton, whose instance listens to a
DPI function and broadcasts calls to all listeners.
Signed-off-by: Rupert Swarbrick <rswarbrick@lowrisc.org>
diff --git a/hw/ip/otbn/dv/tracer/cpp/otbn_trace_source.cc b/hw/ip/otbn/dv/tracer/cpp/otbn_trace_source.cc
new file mode 100644
index 0000000..76fba15
--- /dev/null
+++ b/hw/ip/otbn/dv/tracer/cpp/otbn_trace_source.cc
@@ -0,0 +1,41 @@
+// Copyright lowRISC contributors.
+// Licensed under the Apache License, Version 2.0, see LICENSE for details.
+// SPDX-License-Identifier: Apache-2.0
+
+#include "otbn_trace_source.h"
+
+#include <algorithm>
+#include <cassert>
+#include <memory>
+
+static std::unique_ptr<OtbnTraceSource> trace_source;
+
+OtbnTraceSource &OtbnTraceSource::get() {
+ if (!trace_source) {
+ trace_source.reset(new OtbnTraceSource());
+ }
+ return *trace_source;
+}
+
+void OtbnTraceSource::AddListener(OtbnTraceListener *listener) {
+ listeners_.push_back(listener);
+}
+
+void OtbnTraceSource::RemoveListener(const OtbnTraceListener *listener) {
+ auto it = std::find(listeners_.begin(), listeners_.end(), listener);
+ assert(it != listeners_.end());
+ listeners_.erase(it);
+}
+
+void OtbnTraceSource::Broadcast(const std::string &trace,
+ unsigned cycle_count) {
+ for (OtbnTraceListener *listener : listeners_) {
+ listener->AcceptTraceString(trace, cycle_count);
+ }
+}
+
+extern "C" void accept_otbn_trace_string(const char *trace,
+ unsigned int cycle_count) {
+ assert(trace != nullptr);
+ OtbnTraceSource::get().Broadcast(trace, cycle_count);
+}
diff --git a/hw/ip/otbn/dv/tracer/cpp/otbn_trace_source.h b/hw/ip/otbn/dv/tracer/cpp/otbn_trace_source.h
new file mode 100644
index 0000000..534c1cb
--- /dev/null
+++ b/hw/ip/otbn/dv/tracer/cpp/otbn_trace_source.h
@@ -0,0 +1,36 @@
+// Copyright lowRISC contributors.
+// Licensed under the Apache License, Version 2.0, see LICENSE for details.
+// SPDX-License-Identifier: Apache-2.0
+
+#pragma once
+
+#include <vector>
+
+#include "otbn_trace_listener.h"
+
+// A source for simulation trace data.
+//
+// This is a singleton class, which will be constructed on the first call to
+// get() or the first trace data that comes back from the simulation.
+//
+// The object is in charge of taking trace data from the simulation (which is
+// sent by calling the accept_otbn_trace_string DPI function) and passing it
+// out to registered listeners.
+
+class OtbnTraceSource {
+ public:
+ // Get the (singleton) OtbnTraceSource object
+ static OtbnTraceSource &get();
+
+ // Add a listener to the source
+ void AddListener(OtbnTraceListener *listener);
+
+ // Remove a listener from the source
+ void RemoveListener(const OtbnTraceListener *listener);
+
+ // Send a trace string to all listeners
+ void Broadcast(const std::string &trace, unsigned cycle_count);
+
+ private:
+ std::vector<OtbnTraceListener *> listeners_;
+};
diff --git a/hw/ip/otbn/dv/tracer/otbn_tracer.core b/hw/ip/otbn/dv/tracer/otbn_tracer.core
index f6f420f..89f7ebe 100644
--- a/hw/ip/otbn/dv/tracer/otbn_tracer.core
+++ b/hw/ip/otbn/dv/tracer/otbn_tracer.core
@@ -11,6 +11,8 @@
- lowrisc:ip:otbn_pkg
files:
- cpp/otbn_trace_listener.h: { is_include_file: true, file_type: cppSource }
+ - cpp/otbn_trace_source.h: { is_include_file: true, file_type: cppSource }
+ - cpp/otbn_trace_source.cc: { file_type: cppSource }
- cpp/log_trace_listener.h: { is_include_file: true, file_type: cppSource }
- cpp/log_trace_listener.cc: { file_type: cppSource }
- rtl/otbn_tracer.sv: { file_type: systemVerilogSource }
diff --git a/hw/ip/otbn/dv/verilator/otbn_top_sim.cc b/hw/ip/otbn/dv/verilator/otbn_top_sim.cc
index 58ffabe..286253d 100644
--- a/hw/ip/otbn/dv/verilator/otbn_top_sim.cc
+++ b/hw/ip/otbn/dv/verilator/otbn_top_sim.cc
@@ -2,56 +2,26 @@
// Licensed under the Apache License, Version 2.0, see LICENSE for details.
// SPDX-License-Identifier: Apache-2.0
-#include <algorithm>
-#include <cassert>
#include <fstream>
#include <getopt.h>
#include <iomanip>
#include <iostream>
#include <memory>
-#include <sstream>
#include <string>
#include <svdpi.h>
-#include <vector>
#include "log_trace_listener.h"
#include "otbn_memutil.h"
-#include "otbn_trace_listener.h"
+#include "otbn_trace_source.h"
#include "verilated_toplevel.h"
#include "verilator_memutil.h"
#include "verilator_sim_ctrl.h"
-std::vector<OtbnTraceListener *> otbn_trace_listeners;
-
-void AddOtbnTraceListener(OtbnTraceListener *l) {
- otbn_trace_listeners.push_back(l);
-}
-
-void RemoveOtbnTraceListener(OtbnTraceListener *l) {
- auto l_iter =
- std::find(otbn_trace_listeners.begin(), otbn_trace_listeners.end(), l);
-
- if (l_iter != otbn_trace_listeners.end()) {
- otbn_trace_listeners.erase(l_iter);
- }
-}
-
extern "C" {
extern unsigned int otbn_base_call_stack_get_size();
extern unsigned int otbn_base_call_stack_get_element(int index);
extern unsigned int otbn_base_reg_get(int index);
extern unsigned int otbn_bignum_reg_get(int index, int quarter);
-
-extern void accept_otbn_trace_string(const char *trace,
- unsigned int cycle_count) {
- assert(trace != nullptr);
-
- std::string trace_str(trace);
-
- for (auto l : otbn_trace_listeners) {
- l->AcceptTraceString(trace, cycle_count);
- }
-}
}
/**
@@ -66,7 +36,7 @@
bool SetupTraceLog(const std::string &log_filename) {
try {
log_trace_listener_ = std::make_unique<LogTraceListener>(log_filename);
- AddOtbnTraceListener(log_trace_listener_.get());
+ OtbnTraceSource::get().AddListener(log_trace_listener_.get());
return true;
} catch (const std::runtime_error &err) {
std::cerr << "ERROR: Failed to set up trace log: " << err.what()
@@ -113,7 +83,10 @@
return true;
}
- ~OtbnTraceUtil() { RemoveOtbnTraceListener(log_trace_listener_.get()); }
+ ~OtbnTraceUtil() {
+ if (log_trace_listener_)
+ OtbnTraceSource::get().RemoveListener(log_trace_listener_.get());
+ }
};
int main(int argc, char **argv) {
