sim: SystemC hosting
authorAndrew Bardsley <Andrew.Bardsley@arm.com>
Thu, 16 Oct 2014 09:49:54 +0000 (05:49 -0400)
committerAndrew Bardsley <Andrew.Bardsley@arm.com>
Thu, 16 Oct 2014 09:49:54 +0000 (05:49 -0400)
commit83f7e7afaf962a6f7967c3ace00a85c58508e2e9
tree3963c8cf4189ffa2c3e0f55ac3496d45626d4c99
parente2a13386e543901ba81b52f6cbd48d561ccb2b6d
sim: SystemC hosting

This patch hosts gem5 onto SystemC scheduler. There's already an upstream
review board patch that does something similar but this patch ...:

 1) is less obtrusive to the existing gem5 code organisation. It's divided
 into the 'generic' preparatory patches (already submitted) and this patch
 which affects no existing files

 2) does not try to exactly track the gem5 event queue with notifys into
 SystemC and so doesn't requive the event queue to be modified for
 anything other than 'out of event queue' scheduling events

 3) supports debug logging with SC_REPORT

The patch consists of the files:
    util/systemc/
        sc_gem5_control.{cc,hh} -- top level objects to use to
                                   instantiate gem5 Systems within
                                   larger SystemC test harnesses as
                                   sc_module objects
        sc_logger.{cc,hh}       -- logging support
        sc_module.{cc,hh}       -- a separated event loop specific to
                                   SystemC
        stats.{cc,hh}           -- example Stats handling for the sample
                                   top level
        main.{cc,hh}            -- a sample top level

On the downside this patch is only currently functional with C++
configuration at the top level.

The above sc_... files are indended to be compiled alongside gem5 (as a
library, see main.cc for a command line and util/systemc/README for
more details.)

The top-level system instantiation in sc_gem5_control.{cc,hh} provides
two classes: Gem5Control and Gem5System

Gem5Control is a simulation control class (from which a singleton
object should be created) derived from Gem5SystemC::Module which
carries the top level simulation control interface for gem5.  This
includes hosting a system-building configuration file and
instantiating the Root object from that file.

Gem5System is a base class for instantiating renamed gem5 Systems
from the config file hosted by the Gem5Control object.  In use, a
SystemC module class should be made which represents the desired,
instantiable gem5 System.  That class's instances should create
a Gem5System during their construction, set the parameters of that
system and then call instantiate to build that system.  If this
is all carried out in the sc_core::sc_module-derived classes
constructor, the System's external ports will become children of
that module and can then be recovered by name using sc_core::
sc_find_object.

It is intended that this interface is used with dlopen.  To that
end, the header file sc_gem5_control.hh includes no other header
files from gem5 (and so can be easily copied into another project).
The classes Gem5System and Gem5Control have all their member
functions declared `virtual' so that those functions can be called
through the vtable acquired by building the top level Gem5Control
using dlsym(..., "makeGem5Control") and `makeSystem' on the
Gem5Control.
util/systemc/Makefile [new file with mode: 0644]
util/systemc/README [new file with mode: 0644]
util/systemc/main.cc [new file with mode: 0644]
util/systemc/sc_gem5_control.cc [new file with mode: 0644]
util/systemc/sc_gem5_control.hh [new file with mode: 0644]
util/systemc/sc_logger.cc [new file with mode: 0644]
util/systemc/sc_logger.hh [new file with mode: 0644]
util/systemc/sc_module.cc [new file with mode: 0644]
util/systemc/sc_module.hh [new file with mode: 0644]
util/systemc/stats.cc [new file with mode: 0644]
util/systemc/stats.hh [new file with mode: 0644]