memory-metrics.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_MEM_METRICS_H
#define IMPALA_UTIL_MEM_METRICS_H

#include "util/metrics.h"

#include <boost/thread/mutex.hpp>
#include <boost/bind.hpp>
#include <google/malloc_extension.h>

#include "util/debug-util.h"
#include "gen-cpp/Frontend_types.h"

namespace impala {

class Thread;

class TcmallocMetric : public UIntGauge {
 public:
  static TcmallocMetric* BYTES_IN_USE;

  static TcmallocMetric* TOTAL_BYTES_RESERVED;

  static TcmallocMetric* PAGEHEAP_FREE_BYTES;

  static TcmallocMetric* PAGEHEAP_UNMAPPED_BYTES;

  class PhysicalBytesMetric : public UIntGauge {
   public:
    PhysicalBytesMetric(const std::string& key)
        : UIntGauge(key, TUnit::BYTES) { }

   private:
    virtual void CalculateValue() {
      value_ = TOTAL_BYTES_RESERVED->value() - PAGEHEAP_UNMAPPED_BYTES->value();
    }
  };

  static PhysicalBytesMetric* PHYSICAL_BYTES_RESERVED;

  TcmallocMetric(const std::string& key, const std::string& tcmalloc_var)
      : UIntGauge(key, TUnit::BYTES), tcmalloc_var_(tcmalloc_var) { }

 private:
  const std::string tcmalloc_var_;

  virtual void CalculateValue() {
    MallocExtension::instance()->GetNumericProperty(tcmalloc_var_.c_str(), &value_);
  }
};

class JvmMetric : public IntGauge {
 public:
  static Status InitMetrics(MetricGroup* metrics);

 protected:
  virtual void CalculateValue();

 private:
  enum JvmMetricType {
    MAX,
    INIT,
    COMMITTED,
    CURRENT,
    PEAK_MAX,
    PEAK_INIT,
    PEAK_COMMITTED,
    PEAK_CURRENT
  };

  JvmMetric(const std::string& key, const std::string& mempool_name, JvmMetricType type);

  std::string mempool_name_;

  JvmMetricType metric_type_;
};

Status RegisterMemoryMetrics(MetricGroup* metrics, bool register_jvm_metrics);

}

#endif