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 #include "event_attr.h"
18
19 #include <inttypes.h>
20 #include <stdio.h>
21 #include <string>
22 #include <unordered_map>
23
24 #include <android-base/logging.h>
25
26 #include "environment.h"
27 #include "event_type.h"
28 #include "utils.h"
29
30 namespace simpleperf {
31
BitsToString(const std::string & name,uint64_t bits,const std::vector<std::pair<int,std::string>> & bit_names)32 static std::string BitsToString(const std::string& name, uint64_t bits,
33 const std::vector<std::pair<int, std::string>>& bit_names) {
34 std::string result;
35 for (auto& p : bit_names) {
36 if (bits & p.first) {
37 bits &= ~p.first;
38 if (!result.empty()) {
39 result += ", ";
40 }
41 result += p.second;
42 }
43 }
44 if (bits != 0) {
45 LOG(DEBUG) << "unknown " << name << " bits: " << std::hex << bits;
46 }
47 return result;
48 }
49
SampleTypeToString(uint64_t sample_type)50 static std::string SampleTypeToString(uint64_t sample_type) {
51 static std::vector<std::pair<int, std::string>> sample_type_names = {
52 {PERF_SAMPLE_ADDR, "addr"},
53 {PERF_SAMPLE_BRANCH_STACK, "branch_stack"},
54 {PERF_SAMPLE_CALLCHAIN, "callchain"},
55 {PERF_SAMPLE_CPU, "cpu"},
56 {PERF_SAMPLE_ID, "id"},
57 {PERF_SAMPLE_IP, "ip"},
58 {PERF_SAMPLE_PERIOD, "period"},
59 {PERF_SAMPLE_RAW, "raw"},
60 {PERF_SAMPLE_READ, "read"},
61 {PERF_SAMPLE_REGS_USER, "regs_user"},
62 {PERF_SAMPLE_STACK_USER, "stack_user"},
63 {PERF_SAMPLE_STREAM_ID, "stream_id"},
64 {PERF_SAMPLE_TID, "tid"},
65 {PERF_SAMPLE_TIME, "time"},
66 };
67 return BitsToString("sample_type", sample_type, sample_type_names);
68 }
69
ReadFormatToString(uint64_t read_format)70 static std::string ReadFormatToString(uint64_t read_format) {
71 static std::vector<std::pair<int, std::string>> read_format_names = {
72 {PERF_FORMAT_TOTAL_TIME_ENABLED, "total_time_enabled"},
73 {PERF_FORMAT_TOTAL_TIME_RUNNING, "total_time_running"},
74 {PERF_FORMAT_ID, "id"},
75 {PERF_FORMAT_GROUP, "group"},
76 };
77 return BitsToString("read_format", read_format, read_format_names);
78 }
79
CreateDefaultPerfEventAttr(const EventType & event_type)80 perf_event_attr CreateDefaultPerfEventAttr(const EventType& event_type) {
81 perf_event_attr attr;
82 memset(&attr, 0, sizeof(attr));
83 attr.size = sizeof(perf_event_attr);
84 attr.type = event_type.type;
85 attr.config = event_type.config;
86 attr.disabled = 0;
87 // Changing read_format affects the layout of the data read from perf_event_file, namely
88 // PerfCounter in event_fd.h.
89 attr.read_format =
90 PERF_FORMAT_TOTAL_TIME_ENABLED | PERF_FORMAT_TOTAL_TIME_RUNNING | PERF_FORMAT_ID;
91 attr.sample_type |= PERF_SAMPLE_IP | PERF_SAMPLE_TID | PERF_SAMPLE_TIME | PERF_SAMPLE_PERIOD |
92 PERF_SAMPLE_CPU | PERF_SAMPLE_ID;
93
94 if (attr.type == PERF_TYPE_TRACEPOINT) {
95 // Tracepoint information are stored in raw data in sample records.
96 if (CanRecordRawData()) {
97 attr.sample_type |= PERF_SAMPLE_RAW;
98 }
99 }
100 return attr;
101 }
102
DumpPerfEventAttr(const perf_event_attr & attr,size_t indent)103 void DumpPerfEventAttr(const perf_event_attr& attr, size_t indent) {
104 std::string event_name = GetEventNameByAttr(attr);
105 PrintIndented(indent, "event_attr: for event type %s\n", event_name.c_str());
106
107 PrintIndented(indent + 1, "type %u, size %u, config %llu\n", attr.type, attr.size, attr.config);
108
109 if (attr.freq != 0) {
110 PrintIndented(indent + 1, "sample_freq %llu\n", attr.sample_freq);
111 } else {
112 PrintIndented(indent + 1, "sample_period %llu\n", attr.sample_period);
113 }
114
115 PrintIndented(indent + 1, "sample_type (0x%llx) %s\n", attr.sample_type,
116 SampleTypeToString(attr.sample_type).c_str());
117
118 PrintIndented(indent + 1, "read_format (0x%llx) %s\n", attr.read_format,
119 ReadFormatToString(attr.read_format).c_str());
120
121 PrintIndented(indent + 1, "disabled %u, inherit %u, pinned %u, exclusive %u\n", attr.disabled,
122 attr.inherit, attr.pinned, attr.exclusive);
123
124 PrintIndented(indent + 1, "exclude_user %u, exclude_kernel %u, exclude_hv %u\n",
125 attr.exclude_user, attr.exclude_kernel, attr.exclude_hv);
126
127 PrintIndented(indent + 1, "exclude_idle %u, mmap %u, mmap2 %u, comm %u, freq %u\n",
128 attr.exclude_idle, attr.mmap, attr.mmap2, attr.comm, attr.freq);
129
130 PrintIndented(indent + 1, "inherit_stat %u, enable_on_exec %u, task %u\n", attr.inherit_stat,
131 attr.enable_on_exec, attr.task);
132
133 PrintIndented(indent + 1, "watermark %u, precise_ip %u, mmap_data %u\n", attr.watermark,
134 attr.precise_ip, attr.mmap_data);
135
136 PrintIndented(indent + 1, "sample_id_all %u, exclude_host %u, exclude_guest %u\n",
137 attr.sample_id_all, attr.exclude_host, attr.exclude_guest);
138 PrintIndented(indent + 1, "config2 0x%llx\n", attr.config2);
139 PrintIndented(indent + 1, "branch_sample_type 0x%" PRIx64 "\n", attr.branch_sample_type);
140 PrintIndented(indent + 1, "exclude_callchain_kernel %u, exclude_callchain_user %u\n",
141 attr.exclude_callchain_kernel, attr.exclude_callchain_user);
142 PrintIndented(indent + 1, "comm_exec %u, use_clockid %u, context_switch %u\n", attr.comm_exec,
143 attr.use_clockid, attr.context_switch);
144 PrintIndented(indent + 1, "sample_regs_user 0x%" PRIx64 "\n", attr.sample_regs_user);
145 PrintIndented(indent + 1, "sample_stack_user 0x%" PRIx64 "\n", attr.sample_stack_user);
146 }
147
GetCommonEventIdPositionsForAttrs(const EventAttrIds & attrs,size_t * event_id_pos_in_sample_records,size_t * event_id_reverse_pos_in_non_sample_records)148 bool GetCommonEventIdPositionsForAttrs(const EventAttrIds& attrs,
149 size_t* event_id_pos_in_sample_records,
150 size_t* event_id_reverse_pos_in_non_sample_records) {
151 // When there are more than one perf_event_attrs, we need to read event id
152 // in each record to decide current record should use which attr. So
153 // we need to determine the event id position in a record here.
154 std::vector<uint64_t> sample_types;
155 for (const auto& attr : attrs) {
156 sample_types.push_back(attr.attr.sample_type);
157 }
158 // First determine event_id_pos_in_sample_records.
159 // If PERF_SAMPLE_IDENTIFIER is enabled, it is just after perf_event_header.
160 // If PERF_SAMPLE_ID is enabled, then PERF_SAMPLE_IDENTIFIER | IP | TID | TIME | ADDR
161 // should also be the same.
162 bool identifier_enabled = true;
163 bool id_enabled = true;
164 uint64_t flags_before_id_mask = PERF_SAMPLE_IDENTIFIER | PERF_SAMPLE_IP | PERF_SAMPLE_TID |
165 PERF_SAMPLE_TIME | PERF_SAMPLE_ADDR;
166 uint64_t flags_before_id = sample_types[0] & flags_before_id_mask;
167 bool flags_before_id_are_the_same = true;
168 for (auto type : sample_types) {
169 identifier_enabled &= (type & PERF_SAMPLE_IDENTIFIER) != 0;
170 id_enabled &= (type & PERF_SAMPLE_ID) != 0;
171 flags_before_id_are_the_same &= (type & flags_before_id_mask) == flags_before_id;
172 }
173 if (identifier_enabled) {
174 *event_id_pos_in_sample_records = sizeof(perf_event_header);
175 } else if (id_enabled && flags_before_id_are_the_same) {
176 uint64_t pos = sizeof(perf_event_header);
177 while (flags_before_id != 0) {
178 // Each flags takes 8 bytes in sample records.
179 flags_before_id &= flags_before_id - 1;
180 pos += 8;
181 }
182 *event_id_pos_in_sample_records = pos;
183 } else {
184 LOG(ERROR) << "perf_event_attrs don't have a common event id position in sample records";
185 return false;
186 }
187
188 // Secondly determine event_id_reverse_pos_in_non_sample_record.
189 // If sample_id_all is not enabled, there is no event id in non sample records.
190 // If PERF_SAMPLE_IDENTIFIER is enabled, it is at the last 8 bytes of the record.
191 // If PERF_SAMPLE_ID is enabled, then PERF_SAMPLE_IDENTIFIER | CPU | STREAM_ID should
192 // also be the same.
193 bool sample_id_all_enabled = true;
194 for (const auto& attr : attrs) {
195 if (attr.attr.sample_id_all == 0) {
196 sample_id_all_enabled = false;
197 }
198 }
199 if (!sample_id_all_enabled) {
200 LOG(ERROR) << "there are perf_event_attrs not enabling sample_id_all, so can't determine "
201 << "perf_event_attr for non sample records";
202 return false;
203 }
204 uint64_t flags_after_id_mask = PERF_SAMPLE_IDENTIFIER | PERF_SAMPLE_CPU | PERF_SAMPLE_STREAM_ID;
205 uint64_t flags_after_id = sample_types[0] & flags_after_id_mask;
206 bool flags_after_id_are_the_same = true;
207 for (auto type : sample_types) {
208 flags_after_id_are_the_same &= (type & flags_after_id_mask) == flags_after_id;
209 }
210 if (identifier_enabled) {
211 *event_id_reverse_pos_in_non_sample_records = 8;
212 } else if (id_enabled && flags_after_id_are_the_same) {
213 uint64_t pos = 8;
214 while (flags_after_id != 0) {
215 // Each flag takes 8 bytes in sample_id of non sample records.
216 flags_after_id &= flags_after_id - 1;
217 pos += 8;
218 }
219 *event_id_reverse_pos_in_non_sample_records = pos;
220 } else {
221 LOG(ERROR)
222 << "perf_event_attrs don't have a common event id reverse position in non sample records";
223 return false;
224 }
225 return true;
226 }
227
IsTimestampSupported(const perf_event_attr & attr)228 bool IsTimestampSupported(const perf_event_attr& attr) {
229 return attr.sample_id_all && (attr.sample_type & PERF_SAMPLE_TIME);
230 }
231
IsCpuSupported(const perf_event_attr & attr)232 bool IsCpuSupported(const perf_event_attr& attr) {
233 return attr.sample_id_all && (attr.sample_type & PERF_SAMPLE_CPU);
234 }
235
GetEventNameByAttr(const perf_event_attr & attr)236 std::string GetEventNameByAttr(const perf_event_attr& attr) {
237 std::string name = "unknown";
238 auto callback = [&](const EventType& event_type) {
239 // An event type uses both type and config value to define itself. But etm event type
240 // only uses type value (whose config value is used to set etm options).
241 if (event_type.type == attr.type &&
242 (event_type.config == attr.config || event_type.IsEtmEvent())) {
243 name = event_type.name;
244 if (attr.exclude_user && !attr.exclude_kernel) {
245 name += ":k";
246 } else if (attr.exclude_kernel && !attr.exclude_user) {
247 name += ":u";
248 }
249 return false;
250 }
251 return true;
252 };
253 EventTypeManager::Instance().ForEachType(callback);
254 return name;
255 }
256
ReplaceRegAndStackWithCallChain(perf_event_attr & attr)257 void ReplaceRegAndStackWithCallChain(perf_event_attr& attr) {
258 attr.sample_type &= ~(PERF_SAMPLE_REGS_USER | PERF_SAMPLE_STACK_USER);
259 attr.exclude_callchain_user = 0;
260 attr.sample_regs_user = 0;
261 attr.sample_stack_user = 0;
262 }
263
264 } // namespace simpleperf
265