thread_state.hh revision 8806:669e93d79ed9 
1/*
2 * Copyright (c) 2006 The Regents of The University of Michigan
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are
7 * met: redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer;
9 * redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution;
12 * neither the name of the copyright holders nor the names of its
13 * contributors may be used to endorse or promote products derived from
14 * this software without specific prior written permission.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
17 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
18 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
19 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
20 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
26 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 *
28 * Authors: Kevin Lim
29 */
30
31#ifndef __CPU_O3_THREAD_STATE_HH__
32#define __CPU_O3_THREAD_STATE_HH__
33
34#include "base/callback.hh"
35#include "base/output.hh"
36#include "cpu/thread_context.hh"
37#include "cpu/thread_state.hh"
38#include "sim/full_system.hh"
39#include "sim/sim_exit.hh"
40
41class EndQuiesceEvent;
42class Event;
43class FunctionalMemory;
44class FunctionProfile;
45class Process;
46class ProfileNode;
47
48/**
49 * Class that has various thread state, such as the status, the
50 * current instruction being processed, whether or not the thread has
51 * a trap pending or is being externally updated, the ThreadContext
52 * pointer, etc.  It also handles anything related to a specific
53 * thread's process, such as syscalls and checking valid addresses.
54 */
55template <class Impl>
56struct O3ThreadState : public ThreadState {
57    typedef ThreadContext::Status Status;
58    typedef typename Impl::O3CPU O3CPU;
59
60  private:
61    /** Pointer to the CPU. */
62    O3CPU *cpu;
63  public:
64    /** Whether or not the thread is currently in syscall mode, and
65     * thus able to be externally updated without squashing.
66     */
67    bool inSyscall;
68
69    /** Whether or not the thread is currently waiting on a trap, and
70     * thus able to be externally updated without squashing.
71     */
72    bool trapPending;
73
74    O3ThreadState(O3CPU *_cpu, int _thread_num, Process *_process)
75        : ThreadState(_cpu, _thread_num, _process),
76          cpu(_cpu), inSyscall(0), trapPending(0)
77    {
78        if (!FullSystem)
79            return;
80
81        if (cpu->params()->profile) {
82            profile = new FunctionProfile(
83                    cpu->params()->system->kernelSymtab);
84            Callback *cb =
85                new MakeCallback<O3ThreadState,
86                &O3ThreadState::dumpFuncProfile>(this);
87            registerExitCallback(cb);
88        }
89
90        // let's fill with a dummy node for now so we don't get a segfault
91        // on the first cycle when there's no node available.
92        static ProfileNode dummyNode;
93        profileNode = &dummyNode;
94        profilePC = 3;
95    }
96
97    /** Pointer to the ThreadContext of this thread. */
98    ThreadContext *tc;
99
100    /** Returns a pointer to the TC of this thread. */
101    ThreadContext *getTC() { return tc; }
102
103    /** Handles the syscall. */
104    void syscall(int64_t callnum) { process->syscall(callnum, tc); }
105
106    void dumpFuncProfile()
107    {
108        std::ostream *os = simout.create(csprintf("profile.%s.dat", cpu->name()));
109        profile->dump(tc, *os);
110    }
111};
112
113#endif // __CPU_O3_THREAD_STATE_HH__
114