systemc: Import tests from the Accellera systemc distribution.

Change-Id: Iad76b398949a55d768a34d027a2d8e3739953da6
Reviewed-on: https://gem5-review.googlesource.com/10845
Reviewed-by: Giacomo Travaglini <giacomo.travaglini@arm.com>
Maintainer: Gabe Black <gabeblack@google.com>

2 files changed, 351 insertions, 0 deletions

diff --git a/src/systemc/tests/systemc/kernel/phase_callbacks/test05/golden/simulation_callbacks.log b/src/systemc/tests/systemc/kernel/phase_callbacks/test05/golden/simulation_callbacks.log
new file mode 100644
index 000000000..85fefc217
--- /dev/null
+++ b/src/systemc/tests/systemc/kernel/phase_callbacks/test05/golden/simulation_callbacks.log
@@ -0,0 +1,109 @@
+SystemC Simulation
+top.phase_tracer_0: phase callback SC_END_OF_UPDATE: 0 s -> pending activity: MAX
+top.phase_tracer_0: phase callback SC_END_OF_UPDATE: 0 s -> pending activity: 0 s
+top.timed: 0 s: 0/0
+top.phase_tracer_0: phase callback SC_END_OF_UPDATE: 0 s -> pending activity: 0 s
+top.delta: 0 s: 1/1
+top.phase_tracer_0: phase callback SC_END_OF_UPDATE: 0 s -> pending activity: 1 ns
+top.phase_tracer_0: phase callback SC_BEFORE_TIMESTEP: 0 s -> pending activity: 1 ns
+top.timed: 1 ns: 1/0
+top.phase_tracer_0: phase callback SC_END_OF_UPDATE: 1 ns -> pending activity: 0 s
+top.delta: 1 ns: 2/1
+top.phase_tracer_0: phase callback SC_END_OF_UPDATE: 1 ns -> pending activity: 1 ns
+top.phase_tracer_0: phase callback SC_BEFORE_TIMESTEP: 1 ns -> pending activity: 1 ns
+top.timed: 2 ns: 2/0
+top.phase_tracer_0: phase callback SC_END_OF_UPDATE: 2 ns -> pending activity: 0 s
+top.delta: 2 ns: 3/1
+top.phase_tracer_0: phase callback SC_END_OF_UPDATE: 2 ns -> pending activity: 1 ns
+top.phase_tracer_0: phase callback SC_BEFORE_TIMESTEP: 2 ns -> pending activity: 1 ns
+top.timed: 3 ns: 3/0
+top.phase_tracer_0: phase callback SC_END_OF_UPDATE: 3 ns -> pending activity: 0 s
+top.delta: 3 ns: 4/1
+top.phase_tracer_0: phase callback SC_END_OF_UPDATE: 3 ns -> pending activity: 1 ns
+top.phase_tracer_0: phase callback SC_BEFORE_TIMESTEP: 3 ns -> pending activity: 1 ns
+top.timed: 4 ns: 4/0
+top.phase_tracer_0: phase callback SC_END_OF_UPDATE: 4 ns -> pending activity: 0 s
+top.delta: 4 ns: 5/1
+top.phase_tracer_0: phase callback SC_END_OF_UPDATE: 4 ns -> pending activity: 1 ns
+top.phase_tracer_0: phase callback SC_BEFORE_TIMESTEP: 4 ns -> pending activity: 1 ns
+top.timed: 5 ns: 5/0
+top.phase_tracer_0: phase callback SC_END_OF_UPDATE: 5 ns -> pending activity: 0 s
+top.delta: 5 ns: 6/1
+top.phase_tracer_0: phase callback SC_END_OF_UPDATE: 5 ns -> pending activity: 1 ns
+top.phase_tracer_0: phase callback SC_BEFORE_TIMESTEP: 5 ns -> pending activity: 1 ns
+top.timed: 6 ns: 6/0
+top.phase_tracer_0: phase callback SC_END_OF_UPDATE: 6 ns -> pending activity: 0 s
+top.delta: 6 ns: 7/1
+top.phase_tracer_0: phase callback SC_END_OF_UPDATE: 6 ns -> pending activity: 1 ns
+top.phase_tracer_0: phase callback SC_BEFORE_TIMESTEP: 6 ns -> pending activity: 1 ns
+top.timed: 7 ns: 7/0
+top.phase_tracer_0: phase callback SC_END_OF_UPDATE: 7 ns -> pending activity: 0 s
+top.delta: 7 ns: 8/1
+top.phase_tracer_0: phase callback SC_END_OF_UPDATE: 7 ns -> pending activity: 1 ns
+top.phase_tracer_0: phase callback SC_BEFORE_TIMESTEP: 7 ns -> pending activity: 1 ns
+top.timed: 8 ns: 8/0
+top.phase_tracer_0: phase callback SC_END_OF_UPDATE: 8 ns -> pending activity: 0 s
+top.delta: 8 ns: 9/1
+top.phase_tracer_0: phase callback SC_END_OF_UPDATE: 8 ns -> pending activity: 1 ns
+top.phase_tracer_0: phase callback SC_BEFORE_TIMESTEP: 8 ns -> pending activity: 1 ns
+top.timed: 9 ns: 9/0
+top.phase_tracer_0: phase callback SC_END_OF_UPDATE: 9 ns -> pending activity: 0 s
+top.delta: 9 ns: 10/1
+top.phase_tracer_0: phase callback SC_END_OF_UPDATE: 9 ns -> pending activity: 1 ns
+top.phase_tracer_0: phase callback SC_BEFORE_TIMESTEP: 9 ns -> pending activity: 1 ns
+top.phase_tracer_0: phase callback SC_END_OF_UPDATE: 10 ns -> pending activity: MAX
+top.phase_tracer_0: phase callback SC_END_OF_UPDATE: 10 ns -> pending activity: 0 s
+top.timed: 10 ns: 0/0
+top.phase_tracer_0: phase callback SC_END_OF_UPDATE: 10 ns -> pending activity: 0 s
+top.delta: 10 ns: 1/1
+top.phase_tracer_0: phase callback SC_END_OF_UPDATE: 10 ns -> pending activity: 1 ns
+top.phase_tracer_0: phase callback SC_BEFORE_TIMESTEP: 10 ns -> pending activity: 1 ns
+top.timed: 11 ns: 1/0
+top.phase_tracer_0: phase callback SC_END_OF_UPDATE: 11 ns -> pending activity: 0 s
+top.delta: 11 ns: 2/1
+top.phase_tracer_0: phase callback SC_END_OF_UPDATE: 11 ns -> pending activity: 1 ns
+top.phase_tracer_0: phase callback SC_BEFORE_TIMESTEP: 11 ns -> pending activity: 1 ns
+top.timed: 12 ns: 2/0
+top.phase_tracer_0: phase callback SC_END_OF_UPDATE: 12 ns -> pending activity: 0 s
+top.delta: 12 ns: 3/1
+top.phase_tracer_0: phase callback SC_END_OF_UPDATE: 12 ns -> pending activity: 1 ns
+top.phase_tracer_0: phase callback SC_BEFORE_TIMESTEP: 12 ns -> pending activity: 1 ns
+top.timed: 13 ns: 3/0
+top.phase_tracer_0: phase callback SC_END_OF_UPDATE: 13 ns -> pending activity: 0 s
+top.delta: 13 ns: 4/1
+top.phase_tracer_0: phase callback SC_END_OF_UPDATE: 13 ns -> pending activity: 1 ns
+top.phase_tracer_0: phase callback SC_BEFORE_TIMESTEP: 13 ns -> pending activity: 1 ns
+top.timed: 14 ns: 4/0
+top.phase_tracer_0: phase callback SC_END_OF_UPDATE: 14 ns -> pending activity: 0 s
+top.delta: 14 ns: 5/1
+top.phase_tracer_0: phase callback SC_END_OF_UPDATE: 14 ns -> pending activity: 1 ns
+top.phase_tracer_0: phase callback SC_BEFORE_TIMESTEP: 14 ns -> pending activity: 1 ns
+top.timed: 15 ns: 5/0
+top.phase_tracer_0: phase callback SC_END_OF_UPDATE: 15 ns -> pending activity: 0 s
+top.delta: 15 ns: 6/1
+top.phase_tracer_0: phase callback SC_END_OF_UPDATE: 15 ns -> pending activity: 1 ns
+top.phase_tracer_0: phase callback SC_BEFORE_TIMESTEP: 15 ns -> pending activity: 1 ns
+top.timed: 16 ns: 6/0
+top.phase_tracer_0: phase callback SC_END_OF_UPDATE: 16 ns -> pending activity: 0 s
+top.delta: 16 ns: 7/1
+top.phase_tracer_0: phase callback SC_END_OF_UPDATE: 16 ns -> pending activity: 1 ns
+top.phase_tracer_0: phase callback SC_BEFORE_TIMESTEP: 16 ns -> pending activity: 1 ns
+top.timed: 17 ns: 7/0
+top.phase_tracer_0: phase callback SC_END_OF_UPDATE: 17 ns -> pending activity: 0 s
+top.delta: 17 ns: 8/1
+top.phase_tracer_0: phase callback SC_END_OF_UPDATE: 17 ns -> pending activity: 1 ns
+top.phase_tracer_0: phase callback SC_BEFORE_TIMESTEP: 17 ns -> pending activity: 1 ns
+top.timed: 18 ns: 8/0
+top.phase_tracer_0: phase callback SC_END_OF_UPDATE: 18 ns -> pending activity: 0 s
+top.delta: 18 ns: 9/1
+top.phase_tracer_0: phase callback SC_END_OF_UPDATE: 18 ns -> pending activity: 1 ns
+top.phase_tracer_0: phase callback SC_BEFORE_TIMESTEP: 18 ns -> pending activity: 1 ns
+top.timed: 19 ns: 9/0
+top.phase_tracer_0: phase callback SC_END_OF_UPDATE: 19 ns -> pending activity: 0 s
+top.delta: 19 ns: 10/1
+top.phase_tracer_0: phase callback SC_END_OF_UPDATE: 19 ns -> pending activity: 1 ns
+top.phase_tracer_0: phase callback SC_BEFORE_TIMESTEP: 19 ns -> pending activity: 1 ns
+top.phase_tracer_0: phase callback SC_END_OF_UPDATE: 20 ns -> pending activity: MAX
+
+Info: /OSCI/SystemC: Simulation stopped by user.
+top.phase_tracer_0: [destructor]: 65 callbacks called.
diff --git a/src/systemc/tests/systemc/kernel/phase_callbacks/test05/simulation_callbacks.cpp b/src/systemc/tests/systemc/kernel/phase_callbacks/test05/simulation_callbacks.cpp
new file mode 100644
index 000000000..03dde6ccc
--- /dev/null
+++ b/src/systemc/tests/systemc/kernel/phase_callbacks/test05/simulation_callbacks.cpp
@@ -0,0 +1,242 @@
+/*****************************************************************************
+
+  Licensed to Accellera Systems Initiative Inc. (Accellera) under one or
+  more contributor license agreements.  See the NOTICE file distributed
+  with this work for additional information regarding copyright ownership.
+  Accellera licenses this file to you under the Apache License, Version 2.0
+  (the "License"); you may not use this file except in compliance with the
+  License.  You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+  implied.  See the License for the specific language governing
+  permissions and limitations under the License.
+
+ *****************************************************************************/
+
+/*****************************************************************************
+
+  simulation_callbacks.cpp -- Test of simulation phase callbacks
+
+  Note: requires simulation phase callback support enabled in the kernel
+        SC_ENABLE_SIMULATION_PHASE_CALLBACKS / --enable-phase-callbacks
+
+  Original Author: Philipp A. Hartmann, OFFIS, 2013-05-17
+
+ *****************************************************************************/
+
+/*****************************************************************************
+
+  MODIFICATION LOG - modifiers, enter your name, affiliation, date and
+  changes you are making here.
+
+      Name, Affiliation, Date:
+  Description of Modification:
+
+ *****************************************************************************/
+
+#include <systemc.h>
+
+#ifdef BENCHMARK
+#  include "rusage_timer.h"
+#  define  ROUNDS 20
+#  define  NUM_TIMED_TRIGGERS 2000000
+#  define  NUM_DELTA_TRIGGERS 50
+#  define  VERBOSE 0
+#else
+#  define  ROUNDS 2
+#  define  NUM_TIMED_TRIGGERS 10
+#  define  NUM_DELTA_TRIGGERS 1
+#  define  VERBOSE 1
+#endif
+
+#ifndef REGISTER_CALLBACKS
+#  define REGISTER_CALLBACKS 1
+#endif
+#ifndef EXTRA_METHOD
+#  define EXTRA_METHOD 0
+#endif
+
+#define TIMED_THREAD 1
+
+#if TIMED_THREAD
+#  define TIMED_WAIT    wait
+#  define TIMED_PROCESS SC_THREAD
+#else
+#  define TIMED_WAIT    next_trigger
+#  define TIMED_PROCESS SC_METHOD
+#endif
+
+#if REGISTER_CALLBACKS
+//#  define CALLBACK_MASK ( SC_END_OF_EVALUATION )
+//#  define CALLBACK_MASK ( SC_END_OF_UPDATE )
+//#  define CALLBACK_MASK ( SC_BEFORE_TIMESTEP )
+#  define CALLBACK_MASK ( SC_END_OF_UPDATE | SC_BEFORE_TIMESTEP )
+#else
+// SC_RUNNING (for EXTRA_METHOD)
+#  define CALLBACK_MASK ( SC_RUNNING )
+#endif
+
+static const sc_dt::uint64 max_rounds         = ROUNDS;
+static const sc_dt::uint64 max_timed_triggers = NUM_TIMED_TRIGGERS;
+static const sc_dt::uint64 max_delta_triggers = NUM_DELTA_TRIGGERS;
+static const sc_time  delay(1, SC_NS);
+
+SC_MODULE(phase_tracer)
+{
+  SC_HAS_PROCESS(phase_tracer);
+  phase_tracer( sc_module_name = sc_core::sc_gen_unique_name("phase_tracer") )
+    : cb_mask(CALLBACK_MASK), cb_count(0)
+  {
+#if REGISTER_CALLBACKS
+    cb_mask = register_simulation_phase_callback( CALLBACK_MASK );
+#endif
+  }
+
+  virtual void simulation_phase_callback()
+  {
+    cb_count++;
+
+#   if VERBOSE
+    {
+      std::string ttp;
+      if( !sc_pending_activity() ) {
+        ttp = "MAX";
+      } else {
+        ttp = sc_time_to_pending_activity().to_string();
+      }
+      std::cout << name()
+                << ": phase callback "
+                << sc_get_status()
+                << ": " << sc_time_stamp()
+                << " -> pending activity: " << ttp
+                << std::endl;
+    }
+#   endif
+    sc_assert( cb_mask & sc_get_status() );
+  }
+
+  ~phase_tracer()
+      { print_static_phase_stats( "[destructor]" ); }
+
+  void print_static_phase_stats( const char* phase )
+  {
+#if VERBOSE
+      std::cout << name()
+                << ": " << phase << ": "
+                << cb_count << " callbacks called."
+                << std::endl;
+#endif
+  }
+
+private:
+  unsigned      cb_mask;
+  sc_dt::uint64 cb_count;
+};
+
+SC_MODULE(activities)
+{
+  SC_CTOR(activities)
+    : timed_count(), delta_count()
+  {
+    TIMED_PROCESS(timed);
+      sensitive << timed_ev;
+      dont_initialize();
+    SC_METHOD(delta);
+      sensitive << delta_ev;
+      dont_initialize();
+#if EXTRA_METHOD
+    SC_METHOD(extra);
+      sensitive << timed_ev;
+      dont_initialize();
+#endif
+  }
+
+  void notify_round()
+    { timed_ev.notify(SC_ZERO_TIME); }
+
+private:
+  void timed()
+  {
+#   if TIMED_THREAD
+    while(1)
+#   endif
+    {
+      if( timed_count >= max_timed_triggers ) {
+        timed_count = 0;
+        TIMED_WAIT();
+      } else {
+        verbose();
+        ++timed_count;
+        if( max_delta_triggers )
+          delta_ev.notify(SC_ZERO_TIME);
+        timed_ev.notify(delay);
+        TIMED_WAIT();
+      }
+    }
+  }
+
+  void delta()
+  {
+    ++delta_count;
+    verbose();
+    if( delta_count >= max_delta_triggers ) {
+      delta_count = 0;
+    } else {
+      delta_ev.notify(SC_ZERO_TIME);
+    }
+  }
+
+  void extra()
+  {
+    if( sc_pending_activity_at_current_time() ) {
+      pt.simulation_phase_callback();
+      next_trigger(SC_ZERO_TIME);
+    } else if (sc_time_to_pending_activity()== sc_max_time()-sc_time_stamp() ) {
+      next_trigger();
+    } else {
+      pt.simulation_phase_callback();
+      next_trigger(sc_time_to_pending_activity());
+    }
+  }
+
+  void verbose()
+  {
+#if VERBOSE
+    std::cout
+      << sc_get_current_process_handle().name()
+      << ": " << sc_time_stamp()
+      << ": " << timed_count << "/" << delta_count
+      << std::endl;
+#endif
+  }
+
+private:
+  phase_tracer pt;
+  sc_dt::uint64 timed_count, delta_count;
+  sc_event timed_ev, delta_ev;
+};
+
+
+int sc_main(int, char*[])
+{
+  activities   top("top");
+
+  sc_start(SC_ZERO_TIME);
+  for(unsigned i=0; i<max_rounds; ++i)
+  {
+#ifdef BENCHMARK
+    rusage_timer timer;
+#endif
+    top.notify_round();
+    sc_start();
+#ifdef BENCHMARK
+    std::cout << timer.to_seconds() << std::endl;
+#endif
+  }
+  sc_stop();
+  return 0;
+}