simpleperf/event_fd.h

   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_FD_H_
  18 #define SIMPLE_PERF_EVENT_FD_H_
  19
  20 #include <sys/types.h>
  21
  22 #include <memory>
  23 #include <string>
  24
  25 #include <base/macros.h>
  26
  27 #include "perf_event.h"
  28
  29 class EventAttr;
  30
  31 struct PerfCounter {
  32   uint64_t value;         // The value of the event specified by the perf_event_file.
  33   uint64_t time_enabled;  // The enabled time.
  34   uint64_t time_running;  // The running time.
  35   uint64_t id;            // The id of the perf_event_file.
  36 };
  37
  38 // EventFd represents an opened perf_event_file.
  39 class EventFd {
  40  public:
  41   static std::unique_ptr<EventFd> OpenEventFileForProcess(const EventAttr& attr, pid_t pid);
  42   static std::unique_ptr<EventFd> OpenEventFileForCpu(const EventAttr& attr, int cpu);
  43   static std::unique_ptr<EventFd> OpenEventFile(const EventAttr& attr, pid_t pid, int cpu);
  44
  45   ~EventFd();
  46
  47   // Give information about this perf_event_file, like (event_name, pid, cpu).
  48   std::string Name() const;
  49
  50   // It tells the kernel to start counting and recording events specified by this file.
  51   bool EnableEvent();
  52
  53   // It tells the kernel to stop counting and recording events specified by this file.
  54   bool DisableEvent();
  55
  56   bool ReadCounter(PerfCounter* counter);
  57
  58  private:
  59   EventFd(int perf_event_fd, const std::string& event_name, pid_t pid, int cpu)
  60       : perf_event_fd_(perf_event_fd), event_name_(event_name), pid_(pid), cpu_(cpu) {
  61   }
  62
  63   int perf_event_fd_;
  64   const std::string event_name_;
  65   pid_t pid_;
  66   int cpu_;
  67
  68   DISALLOW_COPY_AND_ASSIGN(EventFd);
  69 };
  70
  71 #endif  // SIMPLE_PERF_EVENT_FD_H_