sim,mem,dev: Merge eventq_impl.hh into eventq.hh.

Having some methods (which are supposed to be inline) defined in another
file which is only included sometimes creates a lot of opportunities for
errors. They no longer need to be separate, so merge them together.

Change-Id: I5846e55f53f59b9c2081680a6441659265a765f7
Reviewed-on: https://gem5-review.googlesource.com/c/public/gem5/+/29409
Maintainer: Gabe Black <gabeblack@google.com>
Reviewed-by: Gabe Black <gabeblack@google.com>
Tested-by: kokoro <noreply+kokoro@google.com>

src/dev/intel_8254_timer.hh

@@ -36,7 +36,7 @@
 #include "base/types.hh"
 #include "base/trace.hh"
 #include "debug/Intel8254Timer.hh"
-#include "sim/eventq_impl.hh"
+#include "sim/eventq.hh"
 #include "sim/serialize.hh"
 
 /** Programmable Interval Timer (Intel 8254) */

src/dev/mc146818.hh

@@ -32,7 +32,7 @@
 #include "base/bitunion.hh"
 #include "base/logging.hh"
 #include "sim/core.hh"
-#include "sim/eventq_impl.hh"
+#include "sim/eventq.hh"
 
 /** Real-Time Clock (MC146818) */
 class MC146818 : public EventManager

src/mem/packet_queue.hh

@@ -53,7 +53,7 @@
 
 #include "mem/port.hh"
 #include "sim/drain.hh"
-#include "sim/eventq_impl.hh"
+#include "sim/eventq.hh"
 
 /**
  * A packet queue is a class that holds deferred packets and later

src/sim/debug.cc

@@ -33,7 +33,7 @@
 
 #include "base/debug.hh"
 #include "cpu/pc_event.hh"
-#include "sim/eventq_impl.hh"
+#include "sim/eventq.hh"
 #include "sim/global_event.hh"
 #include "sim/kernel_workload.hh"
 #include "sim/sim_events.hh"

src/sim/dvfs_handler.cc

@@ -45,7 +45,7 @@
 #include "debug/DVFS.hh"
 #include "params/DVFSHandler.hh"
 #include "sim/clock_domain.hh"
-#include "sim/eventq_impl.hh"
+#include "sim/eventq.hh"
 #include "sim/stat_control.hh"
 #include "sim/voltage_domain.hh"
 

src/sim/eventq.cc

@@ -28,6 +28,8 @@
  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
+#include "sim/eventq.hh"
+
 #include <cassert>
 #include <iostream>
 #include <string>
@@ -39,7 +41,6 @@
 #include "cpu/smt.hh"
 #include "debug/Checkpoint.hh"
 #include "sim/core.hh"
-#include "sim/eventq_impl.hh"
 
 using namespace std;
 

src/sim/eventq.hh

@@ -44,6 +44,7 @@
 #include <mutex>
 #include <string>
 
+#include "base/debug.hh"
 #include "base/flags.hh"
 #include "base/types.hh"
 #include "debug/Event.hh"
@@ -750,14 +751,56 @@ class EventQueue
      *
      * @ingroup api_eventq
      */
-    void schedule(Event *event, Tick when, bool global = false);
+    void
+    schedule(Event *event, Tick when, bool global=false)
+    {
+        assert(when >= getCurTick());
+        assert(!event->scheduled());
+        assert(event->initialized());
+
+        event->setWhen(when, this);
+
+        // The check below is to make sure of two things
+        // a. A thread schedules local events on other queues through the
+        //    asyncq.
+        // b. A thread schedules global events on the asyncq, whether or not
+        //    this event belongs to this eventq. This is required to maintain
+        //    a total order amongst the global events. See global_event.{cc,hh}
+        //    for more explanation.
+        if (inParallelMode && (this != curEventQueue() || global)) {
+            asyncInsert(event);
+        } else {
+            insert(event);
+        }
+        event->flags.set(Event::Scheduled);
+        event->acquire();
+
+        if (DTRACE(Event))
+            event->trace("scheduled");
+    }
 
     /**
      * Deschedule the specified event. Should be called only from the owning
      * thread.
      * @ingroup api_eventq
      */
-    void deschedule(Event *event);
+    void
+    deschedule(Event *event)
+    {
+        assert(event->scheduled());
+        assert(event->initialized());
+        assert(!inParallelMode || this == curEventQueue());
+
+        remove(event);
+
+        event->flags.clear(Event::Squashed);
+        event->flags.clear(Event::Scheduled);
+
+        if (DTRACE(Event))
+            event->trace("descheduled");
+
+        event->release();
+    }
 
     /**
      * Reschedule the specified event. Should be called only from the owning
@@ -765,7 +808,28 @@ class EventQueue
      *
      * @ingroup api_eventq
      */
-    void reschedule(Event *event, Tick when, bool always = false);
+    void
+    reschedule(Event *event, Tick when, bool always=false)
+    {
+        assert(when >= getCurTick());
+        assert(always || event->scheduled());
+        assert(event->initialized());
+        assert(!inParallelMode || this == curEventQueue());
+
+        if (event->scheduled()) {
+            remove(event);
+        } else {
+            event->acquire();
+        }
+
+        event->setWhen(when, this);
+        insert(event);
+        event->flags.clear(Event::Squashed);
+        event->flags.set(Event::Scheduled);
+
+        if (DTRACE(Event))
+            event->trace("rescheduled");
+    }
 
     Tick nextTick() const { return head->when(); }
     void setCurTick(Tick newVal) { _curTick = newVal; }

src/sim/eventq_impl.hh

@@ -1,105 +0,0 @@
-/*
- * Copyright (c) 2012 The Regents of The University of Michigan
- * Copyright (c) 2012-2013 Mark D. Hill and David A. Wood
- * Copyright (c) 2013 Advanced Micro Devices, Inc.
- * 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_EVENTQ_IMPL_HH__
-#define __SIM_EVENTQ_IMPL_HH__
-
-#include "base/debug.hh"
-#include "sim/eventq.hh"
-
-inline void
-EventQueue::schedule(Event *event, Tick when, bool global)
-{
-    assert(when >= getCurTick());
-    assert(!event->scheduled());
-    assert(event->initialized());
-
-    event->setWhen(when, this);
-
-    // The check below is to make sure of two things
-    // a. a thread schedules local events on other queues through the asyncq
-    // b. a thread schedules global events on the asyncq, whether or not
-    //    this event belongs to this eventq. This is required to maintain
-    //    a total order amongst the global events. See global_event.{cc,hh}
-    //    for more explanation.
-    if (inParallelMode && (this != curEventQueue() || global)) {
-        asyncInsert(event);
-    } else {
-        insert(event);
-    }
-    event->flags.set(Event::Scheduled);
-    event->acquire();
-
-    if (DTRACE(Event))
-        event->trace("scheduled");
-}
-
-inline void
-EventQueue::deschedule(Event *event)
-{
-    assert(event->scheduled());
-    assert(event->initialized());
-    assert(!inParallelMode || this == curEventQueue());
-
-    remove(event);
-
-    event->flags.clear(Event::Squashed);
-    event->flags.clear(Event::Scheduled);
-
-    if (DTRACE(Event))
-        event->trace("descheduled");
-
-    event->release();
-}
-
-inline void
-EventQueue::reschedule(Event *event, Tick when, bool always)
-{
-    assert(when >= getCurTick());
-    assert(always || event->scheduled());
-    assert(event->initialized());
-    assert(!inParallelMode || this == curEventQueue());
-
-    if (event->scheduled()) {
-        remove(event);
-    } else {
-        event->acquire();
-    }
-
-    event->setWhen(when, this);
-    insert(event);
-    event->flags.clear(Event::Squashed);
-    event->flags.set(Event::Scheduled);
-
-    if (DTRACE(Event))
-        event->trace("rescheduled");
-}
-
-#endif // __SIM_EVENTQ_IMPL_HH__

src/sim/global_event.hh

@@ -34,7 +34,7 @@
 #include <vector>
 
 #include "base/barrier.hh"
-#include "sim/eventq_impl.hh"
+#include "sim/eventq.hh"
 
 /**
  * @file sim/global_event.hh

src/sim/root.cc

@@ -31,7 +31,7 @@
 #include "base/trace.hh"
 #include "config/the_isa.hh"
 #include "debug/TimeSync.hh"
-#include "sim/eventq_impl.hh"
+#include "sim/eventq.hh"
 #include "sim/full_system.hh"
 #include "sim/root.hh"
 

src/sim/sim_events.cc

@@ -46,7 +46,7 @@
 
 #include "base/callback.hh"
 #include "base/hostinfo.hh"
-#include "sim/eventq_impl.hh"
+#include "sim/eventq.hh"
 #include "sim/sim_exit.hh"
 #include "sim/stats.hh"
 

src/sim/sim_object.hh

@@ -53,7 +53,6 @@
 #include "params/SimObject.hh"
 #include "sim/drain.hh"
 #include "sim/eventq.hh"
-#include "sim/eventq_impl.hh"
 #include "sim/port.hh"
 #include "sim/serialize.hh"
 

src/sim/simulate.cc

@@ -37,7 +37,7 @@
 #include "base/pollevent.hh"
 #include "base/types.hh"
 #include "sim/async.hh"
-#include "sim/eventq_impl.hh"
+#include "sim/eventq.hh"
 #include "sim/sim_events.hh"
 #include "sim/sim_exit.hh"
 #include "sim/stat_control.hh"