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_EVENT_H_
18 #define SIMPLE_PERF_EVENT_H_
19 
20 #include <stdint.h>
21 #include <strings.h>
22 #include <memory>
23 #include <set>
24 #include <string>
25 #include <vector>
26 
27 // A uint32_t value far from 0 is picked, so it is unlikely to conflict with further
28 // PERF_TYPE_* events.
29 static constexpr uint32_t SIMPLEPERF_TYPE_USER_SPACE_SAMPLERS = 32768;
30 
31 enum {
32   SIMPLEPERF_CONFIG_INPLACE_SAMPLER,
33 };
34 
35 // EventType represents one type of event, like cpu_cycle_event, cache_misses_event.
36 // The user knows one event type by its name, and the kernel knows one event type by its
37 // (type, config) pair. EventType connects the two representations, and tells the user if
38 // the event type is supported by the kernel.
39 
40 struct EventType {
EventTypeEventType41   EventType(const std::string& name, uint32_t type, uint64_t config,
42             const std::string& description, const std::string& limited_arch)
43       : name(name), type(type), config(config), description(description),
44         limited_arch(limited_arch) {
45   }
46 
EventTypeEventType47   EventType() : type(0), config(0) {
48   }
49 
50   bool operator<(const EventType& other) const {
51     return strcasecmp(name.c_str(), other.name.c_str()) < 0;
52   }
53 
54   std::string name;
55   uint32_t type;
56   uint64_t config;
57   std::string description;
58   std::string limited_arch;
59 };
60 
61 bool SetTracepointEventsFilePath(const std::string& filepath);
62 std::string GetTracepointEvents();
63 
64 // Used to temporarily change event types returned by GetAllEventTypes().
65 class ScopedEventTypes {
66  public:
67   static std::string BuildString(const std::vector<const EventType*>& event_types);
68 
69   ScopedEventTypes(const std::string& event_type_str);
70   ~ScopedEventTypes();
71 
72  private:
73   std::set<EventType> saved_event_types_;
74 };
75 
76 const std::set<EventType>& GetAllEventTypes();
77 const EventType* FindEventTypeByName(const std::string& name, bool report_error = true);
78 
79 struct EventTypeAndModifier {
80   std::string name;
81   EventType event_type;
82   std::string modifier;
83   bool exclude_user;
84   bool exclude_kernel;
85   bool exclude_hv;
86   bool exclude_host;
87   bool exclude_guest;
88   int precise_ip : 2;
89 
EventTypeAndModifierEventTypeAndModifier90   EventTypeAndModifier()
91       : exclude_user(false),
92         exclude_kernel(false),
93         exclude_hv(false),
94         exclude_host(false),
95         exclude_guest(false),
96         precise_ip(0) {
97   }
98 };
99 
100 std::unique_ptr<EventTypeAndModifier> ParseEventType(const std::string& event_type_str);
101 bool IsEtmEventType(uint32_t type);
102 
103 #endif  // SIMPLE_PERF_EVENT_H_
104