src/mem/probes/mem_trace.hh

   1 /*
   2  * Copyright (c) 2015 ARM Limited
   3  * All rights reserved
   4  *
   5  * The license below extends only to copyright in the software and shall
   6  * not be construed as granting a license to any other intellectual
   7  * property including but not limited to intellectual property relating
   8  * to a hardware implementation of the functionality of the software
   9  * licensed hereunder.  You may use the software subject to the license
  10  * terms below provided that you ensure that this notice is replicated
  11  * unmodified and in its entirety in all distributions of the software,
  12  * modified or unmodified, in source code or in binary form.
  13  *
  14  * Redistribution and use in source and binary forms, with or without
  15  * modification, are permitted provided that the following conditions are
  16  * met: redistributions of source code must retain the above copyright
  17  * notice, this list of conditions and the following disclaimer;
  18  * redistributions in binary form must reproduce the above copyright
  19  * notice, this list of conditions and the following disclaimer in the
  20  * documentation and/or other materials provided with the distribution;
  21  * neither the name of the copyright holders nor the names of its
  22  * contributors may be used to endorse or promote products derived from
  23  * this software without specific prior written permission.
  24  *
  25  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  26  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  27  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  28  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  29  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  30  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  31  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  32  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  33  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  34  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  35  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  36  */
  37
  38 #ifndef __MEM_PROBES_MEM_TRACE_HH__
  39 #define __MEM_PROBES_MEM_TRACE_HH__
  40
  41 #include "mem/packet.hh"
  42 #include "mem/probes/base.hh"
  43 #include "proto/protoio.hh"
  44
  45 struct MemTraceProbeParams;
  46 class System;
  47
  48 class MemTraceProbe : public BaseMemProbe
  49 {
  50   public:
  51     MemTraceProbe(const MemTraceProbeParams &params);
  52
  53   protected:
  54     void handleRequest(const ProbePoints::PacketInfo &pkt_info) override;
  55
  56     /**
  57      * Callback to flush and close all open output streams on exit. If
  58      * we were calling the destructor it could be done there.
  59      */
  60     void closeStreams();
  61
  62     void startup() override;
  63
  64   protected:
  65
  66     /** Trace output stream */
  67     ProtoOutputStream *traceStream;
  68
  69     System *system;
  70
  71   private:
  72
  73     /** Include the Program Counter in the memory trace */
  74     const bool withPC;
  75 };
  76
  77 #endif //__MEM_PROBES_MEM_TRACE_HH__