9d683959c6646124a8e05ad3f4c2fb2f0bed6804
[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 "arch/stacktrace.hh"
37 #include "base/types.hh"
38 #include "config/the_isa.hh"
39 #include "cpu/static_inst.hh"
40
41 class ThreadContext;
42
43 class ProfileNode
44 {
45 private:
46 friend class FunctionProfile;
47
48 typedef std::map<Addr, ProfileNode *> ChildList;
49 ChildList children;
50
51 public:
52 Counter count;
53
54 public:
55 ProfileNode();
56
57 void dump(const std::string &symbol, uint64_t id,
58 const SymbolTable *symtab, std::ostream &os) const;
59 void clear();
60 };
61
62 class Callback;
63 class FunctionProfile
64 {
65 private:
66 Callback *reset;
67 const SymbolTable *symtab;
68 ProfileNode top;
69 std::map<Addr, Counter> pc_count;
70 TheISA::StackTrace trace;
71
72 public:
73 FunctionProfile(const SymbolTable *symtab);
74 ~FunctionProfile();
75
76 ProfileNode *consume(ThreadContext *tc, const StaticInstPtr &inst);
77 ProfileNode *consume(const std::vector<Addr> &stack);
78 void clear();
79 void dump(ThreadContext *tc, std::ostream &out) const;
80 void sample(ProfileNode *node, Addr pc);
81 };
82
83 inline ProfileNode *
84 FunctionProfile::consume(ThreadContext *tc, const StaticInstPtr &inst)
85 {
86 if (!trace.trace(tc, inst))
87 return NULL;
88 trace.dprintf();
89 return consume(trace.getstack());
90 }
91
92 #endif // __CPU_PROFILE_HH__