ext/sst/gem5.hh

   1 // Copyright (c) 2015 ARM Limited
   2 // All rights reserved.
   3 //
   4 // The license below extends only to copyright in the software and shall
   5 // not be construed as granting a license to any other intellectual
   6 // property including but not limited to intellectual property relating
   7 // to a hardware implementation of the functionality of the software
   8 // licensed hereunder.  You may use the software subject to the license
   9 // terms below provided that you ensure that this notice is replicated
  10 // unmodified and in its entirety in all distributions of the software,
  11 // modified or unmodified, in source code or in binary form.
  12 //
  13 // Redistribution and use in source and binary forms, with or without
  14 // modification, are permitted provided that the following conditions are
  15 // met: redistributions of source code must retain the above copyright
  16 // notice, this list of conditions and the following disclaimer;
  17 // redistributions in binary form must reproduce the above copyright
  18 // notice, this list of conditions and the following disclaimer in the
  19 // documentation and/or other materials provided with the distribution;
  20 // neither the name of the copyright holders nor the names of its
  21 // contributors may be used to endorse or promote products derived from
  22 // this software without specific prior written permission.
  23 //
  24 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  25 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  26 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  27 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  28 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  29 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  30 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  31 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  32 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  33 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  34 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  35
  36 // Copyright 2009-2014 Sandia Coporation.  Under the terms
  37 // of Contract DE-AC04-94AL85000 with Sandia Corporation, the U.S.
  38 // Government retains certain rights in this software.
  39 //
  40 // Copyright (c) 2009-2014, Sandia Corporation
  41 // All rights reserved.
  42 //
  43 // For license information, see the LICENSE file in the current directory.
  44
  45 #ifndef EXT_SST_GEM5_HH
  46 #define EXT_SST_GEM5_HH
  47
  48 #include <string>
  49 #include <vector>
  50
  51 #include <core/sst_config.h>
  52 #include <core/component.h>
  53
  54 #include <sim/simulate.hh>
  55
  56 #include "ExtMaster.hh"
  57 #include "ExtSlave.hh"
  58
  59 namespace SST {
  60 namespace gem5 {
  61
  62 class gem5Component : public SST::Component,
  63                       public ExternalSlave::Handler,
  64                       public ExternalMaster::Handler {
  65 private:
  66
  67     Output dbg;
  68     Output info;
  69     uint64_t sim_cycles;
  70     uint64_t clocks_processed;
  71
  72     std::vector<ExtMaster*> masters;
  73     std::vector<ExtSlave*> slaves;
  74
  75     void splitCommandArgs(std::string &cmd, std::vector<char*> &args);
  76     void initPython(int argc, char *argv[]);
  77
  78 public:
  79     gem5Component(ComponentId_t id, Params &params);
  80     ~gem5Component();
  81     virtual void init(unsigned);
  82     virtual void setup();
  83     virtual void finish();
  84     bool clockTick(Cycle_t);
  85
  86     virtual ExternalMaster::Port *getExternalPort(
  87         const std::string &name, ExternalMaster &owner,
  88         const std::string &port_data);
  89
  90     virtual ExternalSlave::Port *getExternalPort(
  91         const std::string &name, ExternalSlave &owner,
  92         const std::string &port_data);
  93 };
  94
  95 }
  96 }
  97
  98 #endif