org.apache.hadoop.hbase.util.DirectMemoryUtils Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of hbase-server Show documentation
Server functionality for HBase
There is a newer version: 3.0.0-beta-1
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.
 */
package org.apache.hadoop.hbase.util;

import java.lang.management.ManagementFactory;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import java.nio.ByteBuffer;
import javax.management.JMException;
import javax.management.MBeanServer;
import javax.management.MalformedObjectNameException;
import javax.management.ObjectName;
import org.apache.yetus.audience.InterfaceAudience;
import org.apache.yetus.audience.InterfaceStability;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import org.apache.hbase.thirdparty.com.google.common.base.Preconditions;
import org.apache.hbase.thirdparty.io.netty.buffer.ByteBufAllocatorMetric;
import org.apache.hbase.thirdparty.io.netty.buffer.ByteBufAllocatorMetricProvider;
import org.apache.hbase.thirdparty.io.netty.buffer.PooledByteBufAllocator;
import org.apache.hbase.thirdparty.io.netty.util.internal.PlatformDependent;

/**
 * Utilities for interacting with and monitoring DirectByteBuffer allocations.
 */
@InterfaceAudience.Private
@InterfaceStability.Evolving
public class DirectMemoryUtils {
  private static final Logger LOG = LoggerFactory.getLogger(DirectMemoryUtils.class);
  private static final String MEMORY_USED = "MemoryUsed";
  private static final MBeanServer BEAN_SERVER;
  private static final ObjectName NIO_DIRECT_POOL;
  private static final boolean HAS_MEMORY_USED_ATTRIBUTE;
  private static final long MAX_DIRECT_MEMORY = PlatformDependent.estimateMaxDirectMemory();

  static {
    // initialize singletons. Only maintain a reference to the MBeanServer if
    // we're able to consume it -- hence convoluted logic.
    ObjectName n = null;
    MBeanServer s = null;
    Object a = null;
    try {
      n = new ObjectName("java.nio:type=BufferPool,name=direct");
    } catch (MalformedObjectNameException e) {
      LOG.warn("Unable to initialize ObjectName for DirectByteBuffer allocations.");
    } finally {
      NIO_DIRECT_POOL = n;
    }
    if (NIO_DIRECT_POOL != null) {
      s = ManagementFactory.getPlatformMBeanServer();
    }
    BEAN_SERVER = s;
    if (BEAN_SERVER != null) {
      try {
        a = BEAN_SERVER.getAttribute(NIO_DIRECT_POOL, MEMORY_USED);
      } catch (JMException e) {
        LOG.debug("Failed to retrieve nio.BufferPool direct MemoryUsed attribute: " + e);
      }
    }
    HAS_MEMORY_USED_ATTRIBUTE = a != null;
  }

  /** Returns the direct memory limit of the current progress */
  public static long getDirectMemorySize() {
    return MAX_DIRECT_MEMORY;
  }

  /** Returns the current amount of direct memory used. */
  public static long getDirectMemoryUsage() {
    if (BEAN_SERVER == null || NIO_DIRECT_POOL == null || !HAS_MEMORY_USED_ATTRIBUTE) return 0;
    try {
      Long value = (Long) BEAN_SERVER.getAttribute(NIO_DIRECT_POOL, MEMORY_USED);
      return value == null ? 0 : value;
    } catch (JMException e) {
      // should print further diagnostic information?
      return 0;
    }
  }

  /** Returns the current amount of direct memory used by netty module. */
  public static long getNettyDirectMemoryUsage() {

    ByteBufAllocatorMetric metric =
      ((ByteBufAllocatorMetricProvider) PooledByteBufAllocator.DEFAULT).metric();
    return metric.usedDirectMemory();
  }

  /**
   * DirectByteBuffers are garbage collected by using a phantom reference and a reference queue.
   * Every once a while, the JVM checks the reference queue and cleans the DirectByteBuffers.
   * However, as this doesn't happen immediately after discarding all references to a
   * DirectByteBuffer, it's easy to OutOfMemoryError yourself using DirectByteBuffers. This function
   * explicitly calls the Cleaner method of a DirectByteBuffer. The DirectByteBuffer that will be
   * "cleaned". Utilizes reflection.
   */
  public static void destroyDirectByteBuffer(ByteBuffer toBeDestroyed)
    throws IllegalArgumentException, IllegalAccessException, InvocationTargetException,
    SecurityException, NoSuchMethodException {

    Preconditions.checkArgument(toBeDestroyed.isDirect(), "toBeDestroyed isn't direct!");

    Method cleanerMethod = toBeDestroyed.getClass().getMethod("cleaner");
    cleanerMethod.setAccessible(true);
    Object cleaner = cleanerMethod.invoke(toBeDestroyed);
    Method cleanMethod = cleaner.getClass().getMethod("clean");
    cleanMethod.setAccessible(true);
    cleanMethod.invoke(cleaner);
  }
}