xref: /gem5/util/statetrace/base/statetrace.cc

/*
 * Copyright (c) 2006 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
 */

#include <iostream>
#include <fstream>
#include <string>
#include <sys/types.h>
#include <sys/wait.h>
#include <sys/ptrace.h>
#include <unistd.h>

#include "tracechild.hh"
#include "printer.hh"

using namespace std;

void printUsage(const char * execName)
{
        cout << execName << " -f <output format file> | -h | -r -- <command> <arguments>" << endl;
}

int main(int argc, char * argv[], char * envp[])
{
        TraceChild * child = genTraceChild();
        NestingPrinter printer(child);
        string args;
        int startProgramArgs;

        //Parse the command line arguments
        bool formatStringSet = false;
        bool printInitial = false;
        bool printTrace = true;
        string format;
        for(int x = 1; x < argc; x++)
        {
                if(!strcmp(argv[x], "-f"))
                {
                        if(formatStringSet)
                        {
                                cerr << "Attempted to set format twice!"
                                        << endl;
                                printUsage(argv[0]);
                                return 1;
                        }
                        formatStringSet = true;
                        x++;
                        if(x >= argc)
                        {
                                cerr << "Incorrect usage.\n" << endl;
                                printUsage(argv[0]);
                                return 1;
                        }
                        ifstream formatFile(argv[x]);
                        if(!formatFile)
                        {
                                cerr << "Problem opening file "
                                        << argv[x] << "." << endl;
                                return 1;
                        }
                        format = "";
                        while(formatFile)
                        {
                                string line;
                                getline(formatFile, line);
                                if(formatFile.eof())
                                {
                                        format += line;
                                        break;
                                }
                                if(!formatFile)
                                {
                                        cerr << "Problem reading from file "
                                                << argv[x] << "." << endl;
                                        return 1;
                                }
                                format += line + '\n';
                        }
                }
                else if(!strcmp(argv[x], "-h"))
                {
                        printUsage(argv[0]);
                        return 0;
                }
                else if(!strcmp(argv[x], "-r"))
                {
                        cout << "Legal register names:" << endl;
                        int numRegs = child->getNumRegs();
                        for(unsigned int x = 0; x < numRegs; x++)
                        {
                                cout << "\t" << child->getRegName(x) << endl;
                        }
                        return 0;
                }
                else if(!strcmp(argv[x], "-i"))
                {
                    printInitial = true;
                }
                else if(!strcmp(argv[x], "-nt"))
                {
                    printTrace = false;
                }
                else if(!strcmp(argv[x], "--"))
                {
                        x++;
                        if(x >= argc)
                        {
                                cerr << "Incorrect usage.\n" << endl;
                                printUsage(argv[0]);
                                return 1;
                        }
                        startProgramArgs = x;
                        break;
                }
                else
                {
                        cerr << "Incorrect usage.\n" << endl;
                        printUsage(argv[0]);
                        return 1;
                }
        }
        for(unsigned int x = startProgramArgs; x < argc; x++)
            args += argv[x];
        if(!child->startTracing(argv[startProgramArgs], args.c_str()))
        {
                cerr << "Couldn't start target program" << endl;
                return 1;
        }
        if(printInitial)
        {
            child->outputStartState(cout);
        }
        if(printTrace)
        {
            if(!formatStringSet)
            {
                    cerr << "No output format set!" << endl;
                    child->stopTracing();
                    printUsage(argv[0]);
                    return 1;
            }
            if(!printer.configure(format))
            {
                    cerr << "Problem in the output format" << endl;
                    child->stopTracing();
                    return 1;
            }
            child->step();
            while(child->isTracing())
            {
                    cout << printer;
                    child->step();
            }
            cout << printer;
        }
        if(!child->stopTracing())
        {
                cerr << "Couldn't stop child" << endl;
                return 1;
        }
        return 0;
}