tarmac_tracer.hh

Go to the documentation of this file.

/*
 * Copyright (c) 2017-2018, 2022 Arm Limited
 * All rights reserved
 *
 * The license below extends only to copyright in the software and shall
 * not be construed as granting a license to any other intellectual
 * property including but not limited to intellectual property relating
 * to a hardware implementation of the functionality of the software
 * licensed hereunder.  You may use the software subject to the license
 * terms below provided that you ensure that this notice is replicated
 * unmodified and in its entirety in all distributions of the software,
 * modified or unmodified, in source code or in binary form.
 *
 * 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 __ARCH_ARM_TRACERS_TARMAC_TRACER_HH__
#define __ARCH_ARM_TRACERS_TARMAC_TRACER_HH__
 
#include <memory>
 
#include "arch/arm/tracers/tarmac_record.hh"
#include "arch/arm/tracers/tarmac_record_v8.hh"
#include "params/TarmacTracer.hh"
#include "sim/insttracer.hh"
 
namespace gem5
{
 
class ThreadContext;
class OutputStream;
 
namespace trace {
 
class TarmacTracer;
 
class TarmacContext
{
  public:
    TarmacContext(const TarmacTracer &_tracer,
                  ThreadContext* _thread,
                  const StaticInstPtr _staticInst,
                  const PCStateBase &_pc)
      : tracer(_tracer), thread(_thread), staticInst(_staticInst),
        pc(_pc.clone())
    {}
 
    std::string tarmacCpuName() const;
 
  public:
    const TarmacTracer &tracer;
    ThreadContext* thread;
    const StaticInstPtr staticInst;
    std::unique_ptr<PCStateBase> pc;
};
 
class TarmacTracer : public InstTracer
{
    friend class TarmacTracerRecord;
    friend class TarmacTracerRecordV8;
 
  public:
    typedef TarmacTracerParams Params;
 
    TarmacTracer(const Params &p);
 
    InstRecord* getInstRecord(Tick when, ThreadContext *tc,
            const StaticInstPtr staticInst, const PCStateBase &pc,
            const StaticInstPtr macroStaticInst=nullptr) override;
 
    std::ostream& output();
 
  protected:
    typedef std::unique_ptr<Printable> PEntryPtr;
    typedef TarmacTracerRecord::InstPtr InstPtr;
    typedef TarmacTracerRecord::MemPtr MemPtr;
    typedef TarmacTracerRecord::RegPtr RegPtr;
 
    OutputStream *outstream;
 
    Tick startTick;
    Tick endTick;
 
    std::vector<InstPtr> instQueue;
    std::vector<MemPtr> memQueue;
    std::vector<RegPtr> regQueue;
};
 
} // namespace trace
} // namespace gem5
 
#endif // __ARCH_ARM_TRACERS_TARMAC_TRACER_HH__