Rename some vars for clarity.
[gem5.git] / src / cpu / profile.hh
1 /*
2 * Copyright (c) 2005 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: Nathan Binkert
29 */
30
31 #ifndef __CPU_PROFILE_HH__
32 #define __CPU_PROFILE_HH__
33
34 #include <map>
35
36 #include "cpu/static_inst.hh"
37 #include "sim/host.hh"
38 #include "arch/stacktrace.hh"
39
40 class ThreadContext;
41
42 class ProfileNode
43 {
44 private:
45 friend class FunctionProfile;
46
47 typedef std::map<Addr, ProfileNode *> ChildList;
48 ChildList children;
49
50 public:
51 Counter count;
52
53 public:
54 ProfileNode();
55
56 void dump(const std::string &symbol, uint64_t id,
57 const SymbolTable *symtab, std::ostream &os) const;
58 void clear();
59 };
60
61 class Callback;
62 class FunctionProfile
63 {
64 private:
65 Callback *reset;
66 const SymbolTable *symtab;
67 ProfileNode top;
68 std::map<Addr, Counter> pc_count;
69 StackTrace trace;
70
71 public:
72 FunctionProfile(const SymbolTable *symtab);
73 ~FunctionProfile();
74
75 ProfileNode *consume(ThreadContext *tc, StaticInstPtr inst);
76 ProfileNode *consume(const std::vector<Addr> &stack);
77 void clear();
78 void dump(ThreadContext *tc, std::ostream &out) const;
79 void sample(ProfileNode *node, Addr pc);
80 };
81
82 inline ProfileNode *
83 FunctionProfile::consume(ThreadContext *tc, StaticInstPtr inst)
84 {
85 if (!trace.trace(tc, inst))
86 return NULL;
87 trace.dprintf();
88 return consume(trace.getstack());
89 }
90
91 #endif // __CPU_PROFILE_HH__