perf-counters.h

Go to the documentation of this file.

// Copyright 2012 Cloudera Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.


#ifndef IMPALA_UTIL_PERF_COUNTER_H
#define IMPALA_UTIL_PERF_COUNTER_H

#include <iostream>
#include <string>
#include <vector>

#include "util/debug-util.h"

//

namespace impala {

class PerfCounters {
 public:
  enum Counter {
    PERF_COUNTER_SW_CPU_CLOCK,
    PERF_COUNTER_SW_PAGE_FAULTS,
    PERF_COUNTER_SW_CONTEXT_SWITCHES,
    PERF_COUNTER_SW_CPU_MIGRATIONS,

    PERF_COUNTER_HW_CPU_CYCLES,
    PERF_COUNTER_HW_INSTRUCTIONS,
    PERF_COUNTER_HW_CACHE_HIT,
    PERF_COUNTER_HW_CACHE_MISSES,
    PERF_COUNTER_HW_BRANCHES,
    PERF_COUNTER_HW_BRANCH_MISSES,
    PERF_COUNTER_HW_BUS_CYCLES,

    PERF_COUNTER_VM_USAGE,
    PERF_COUNTER_VM_PEAK_USAGE,
    PERF_COUNTER_RESIDENT_SET_SIZE,

    PERF_COUNTER_BYTES_READ,
    PERF_COUNTER_BYTES_WRITE,
    PERF_COUNTER_DISK_READ,
    PERF_COUNTER_DISK_WRITE,
  };

  bool AddDefaultCounters();

  bool AddCounter(Counter);

  void Snapshot(const std::string& name = "");

  const std::vector<int64_t>* counters(int snapshot) const;

  const std::vector<std::string>* counter_names() const { return &counter_names_; }

  void PrettyPrint(std::ostream* out) const;

  PerfCounters();
  ~PerfCounters();

 private:
  PerfCounters(const PerfCounters&);
  PerfCounters& operator=(const PerfCounters&);

  bool InitSysCounter(Counter counter);
  bool InitProcSelfIOCounter(Counter counter);
  bool InitProcSelfStatusCounter(Counter counter);

  bool GetSysCounters(std::vector<int64_t>& snapshot);
  bool GetProcSelfIOCounters(std::vector<int64_t>& snapshot);
  bool GetProcSelfStatusCounters(std::vector<int64_t>& snapshot);

  enum DataSource {
    SYS_PERF_COUNTER,
    PROC_SELF_IO,
    PROC_SELF_STATUS,
  };

  struct CounterData {
    Counter counter;
    DataSource source;
    TUnit::type unit;

    union {
      int fd;
      int proc_io_line_number;
    };
    std::string proc_status_field;
  };

  std::vector<CounterData> counters_;
  std::vector<std::string> counter_names_;
  std::vector<std::string> snapshot_names_;
  std::vector<std::vector<int64_t> > snapshots_;
  int group_fd_;
};

}

#endif