thread_state.hh revision 9382 
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    /* This variable controls if writes to a thread context should cause a all
65     * dynamic/speculative state to be thrown away. Nominally this is the
66     * desired behavior because the external thread context write has updated
67     * some state that could be used by an inflight instruction, however there
68     * are some cases like in a fault/trap handler where this behavior would
69     * lead to successive restarts and forward progress couldn't be made. This
70     * variable controls if the squashing will occur.
71     */
72    bool noSquashFromTC;
73
74    /** Whether or not the thread is currently waiting on a trap, and
75     * thus able to be externally updated without squashing.
76     */
77    bool trapPending;
78
79    O3ThreadState(O3CPU *_cpu, int _thread_num, Process *_process)
80        : ThreadState(_cpu, _thread_num, _process),
81          cpu(_cpu), noSquashFromTC(false), trapPending(false)
82    {
83        if (!FullSystem)
84            return;
85
86        if (cpu->params()->profile) {
87            profile = new FunctionProfile(
88                    cpu->params()->system->kernelSymtab);
89            Callback *cb =
90                new MakeCallback<O3ThreadState,
91                &O3ThreadState::dumpFuncProfile>(this);
92            registerExitCallback(cb);
93        }
94
95        // let's fill with a dummy node for now so we don't get a segfault
96        // on the first cycle when there's no node available.
97        static ProfileNode dummyNode;
98        profileNode = &dummyNode;
99        profilePC = 3;
100    }
101
102    /** Pointer to the ThreadContext of this thread. */
103    ThreadContext *tc;
104
105    /** Returns a pointer to the TC of this thread. */
106    ThreadContext *getTC() { return tc; }
107
108    /** Handles the syscall. */
109    void syscall(int64_t callnum) { process->syscall(callnum, tc); }
110
111    void dumpFuncProfile()
112    {
113        std::ostream *os = simout.create(csprintf("profile.%s.dat", cpu->name()));
114        profile->dump(tc, *os);
115    }
116};
117
118#endif // __CPU_O3_THREAD_STATE_HH__
119