• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (C) 2015 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 #ifndef SIMPLE_PERF_THREAD_TREE_H_
18 #define SIMPLE_PERF_THREAD_TREE_H_
19 
20 #include <stdint.h>
21 
22 #include <limits>
23 #include <memory>
24 #include <set>
25 
26 #include "dso.h"
27 
28 struct Record;
29 
30 constexpr char DEFAULT_KERNEL_MMAP_NAME[] = "[kernel.kallsyms]";
31 // Seen in perf.data file generated by perf.
32 constexpr char DEFAULT_KERNEL_MMAP_NAME_PERF[] = "[kernel.kallsyms]_text";
33 constexpr char DEFAULT_EXECNAME_FOR_THREAD_MMAP[] = "//anon";
34 
35 namespace simpleperf {
36 
37 struct MapEntry {
38   uint64_t start_addr;
39   uint64_t len;
40   uint64_t pgoff;
41   uint64_t time;  // Map creation time.
42   Dso* dso;
43   bool in_kernel;
44 
MapEntryMapEntry45   MapEntry(uint64_t start_addr, uint64_t len, uint64_t pgoff, uint64_t time,
46            Dso* dso, bool in_kernel)
47       : start_addr(start_addr),
48         len(len),
49         pgoff(pgoff),
50         time(time),
51         dso(dso),
52         in_kernel(in_kernel) {}
MapEntryMapEntry53   MapEntry() {}
54 
get_end_addrMapEntry55   uint64_t get_end_addr() const { return start_addr + len; }
56 };
57 
58 struct MapComparator {
59   bool operator()(const MapEntry* map1, const MapEntry* map2) const;
60 };
61 
62 struct MapSet {
63   std::set<MapEntry*, MapComparator> maps;
64   uint64_t version = 0u;  // incremented each time changing maps
65 };
66 
67 struct ThreadEntry {
68   int pid;
69   int tid;
70   const char* comm;  // It always refers to the latest comm.
71   MapSet* maps;
72 };
73 
74 // ThreadTree contains thread information (in ThreadEntry) and mmap information
75 // (in MapEntry) of the monitored threads. It also has interface to access
76 // symbols in executable binaries mapped in the monitored threads.
77 class ThreadTree {
78  public:
ThreadTree()79   ThreadTree()
80       : show_ip_for_unknown_symbol_(false),
81         show_mark_for_unknown_symbol_(false),
82         unknown_symbol_("unknown", 0,
83                         std::numeric_limits<unsigned long long>::max()) {
84     unknown_dso_ = Dso::CreateDso(DSO_ELF_FILE, "unknown");
85     unknown_map_ = MapEntry(0, std::numeric_limits<unsigned long long>::max(),
86                             0, 0, unknown_dso_.get(), false);
87     kernel_dso_ = Dso::CreateDso(DSO_KERNEL, DEFAULT_KERNEL_MMAP_NAME);
88     // We can't dump comm for pid 0 from /proc, so add it's name here.
89     SetThreadName(0, 0, "swapper");
90   }
91 
92   void SetThreadName(int pid, int tid, const std::string& comm);
93   void ForkThread(int pid, int tid, int ppid, int ptid);
94   ThreadEntry* FindThreadOrNew(int pid, int tid);
95   void AddKernelMap(uint64_t start_addr, uint64_t len, uint64_t pgoff,
96                     uint64_t time, const std::string& filename);
97   void AddThreadMap(int pid, int tid, uint64_t start_addr, uint64_t len,
98                     uint64_t pgoff, uint64_t time, const std::string& filename);
99   const MapEntry* FindMap(const ThreadEntry* thread, uint64_t ip,
100                           bool in_kernel);
101   // Find map for an ip address when we don't know whether it is in kernel.
102   const MapEntry* FindMap(const ThreadEntry* thread, uint64_t ip);
103   const Symbol* FindSymbol(const MapEntry* map, uint64_t ip,
104                            uint64_t* pvaddr_in_file, Dso** pdso = nullptr);
105   const Symbol* FindKernelSymbol(uint64_t ip);
IsUnknownDso(const Dso * dso)106   bool IsUnknownDso(const Dso* dso) const { return dso == unknown_dso_.get(); }
UnknownSymbol()107   const Symbol* UnknownSymbol() const { return &unknown_symbol_; }
108 
ShowIpForUnknownSymbol()109   void ShowIpForUnknownSymbol() { show_ip_for_unknown_symbol_ = true; }
ShowMarkForUnknownSymbol()110   void ShowMarkForUnknownSymbol() {
111     show_mark_for_unknown_symbol_ = true;
112     unknown_symbol_ = Symbol("*unknown", 0, ULLONG_MAX);
113   }
114   // Clear thread and map information, but keep loaded dso information. It saves
115   // the time to reload dso information.
116   void ClearThreadAndMap();
117 
118   void AddDsoInfo(const std::string& file_path, uint32_t file_type,
119                   uint64_t min_vaddr, std::vector<Symbol>* symbols);
120 
121   // Update thread tree with information provided by record.
122   void Update(const Record& record);
123 
124   std::vector<Dso*> GetAllDsos() const;
125   std::vector<const ThreadEntry*> GetAllThreads() const;
126 
127  private:
128   ThreadEntry* CreateThread(int pid, int tid);
129   Dso* FindKernelDsoOrNew(const std::string& filename);
130   Dso* FindUserDsoOrNew(const std::string& filename, uint64_t start_addr = 0);
131   MapEntry* AllocateMap(const MapEntry& value);
132   void FixOverlappedMap(MapSet* maps, const MapEntry* map);
133 
134   std::unordered_map<int, std::unique_ptr<ThreadEntry>> thread_tree_;
135   std::vector<std::unique_ptr<std::string>> thread_comm_storage_;
136 
137   std::vector<std::unique_ptr<MapSet>> map_set_storage_;
138   MapSet kernel_maps_;
139   std::vector<std::unique_ptr<MapEntry>> map_storage_;
140   MapEntry unknown_map_;
141 
142   std::unique_ptr<Dso> kernel_dso_;
143   std::unordered_map<std::string, std::unique_ptr<Dso>> module_dso_tree_;
144   std::unordered_map<std::string, std::unique_ptr<Dso>> user_dso_tree_;
145   std::unique_ptr<Dso> unknown_dso_;
146   bool show_ip_for_unknown_symbol_;
147   bool show_mark_for_unknown_symbol_;
148   Symbol unknown_symbol_;
149 };
150 
151 }  // namespace simpleperf
152 
153 using MapEntry = simpleperf::MapEntry;
154 using ThreadEntry = simpleperf::ThreadEntry;
155 using ThreadTree = simpleperf::ThreadTree;
156 
157 #endif  // SIMPLE_PERF_THREAD_TREE_H_
158