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