xref: /gem5/util/statetrace/base/tracechild.hh

/*
 * Copyright (c) 2006-2007 The Regents of The University of Michigan
 * 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.
 *
 * Authors: Gabe Black
 */

#ifndef TRACECHILD_HH
#define TRACECHILD_HH

#include "regstate.hh"

class TraceChild : public RegState
{
  protected:
    int pid;
    uint64_t instructions;
    bool tracing;
  public:
    TraceChild() : tracing(false), instructions(0)
    {;}
    virtual bool sendState(int socket) = 0;
    virtual bool startTracing(const char * pathToFile, char * const argv[]);
    virtual bool stopTracing();
    virtual bool step();
    virtual uint64_t getPC() = 0;
    virtual uint64_t getSP() = 0;
    virtual std::ostream & outputStartState(std::ostream & os) = 0;
    int
    getPid()
    {
        return pid;
    }
    bool
    isTracing()
    {
        return tracing;
    }
  protected:
    bool ptraceSingleStep();
    bool doWait();
};

TraceChild * genTraceChild();

#endif