HBASE-26708 Netty leak detected and OutOfDirectMemoryError due to direct memory buffering with SASL implementation (#4596)

Co-authored-by: Norman Maurer <norman_maurer@apple.com>
Signed-off-by: Andrew Purtell <apurtell@apache.org>
Signed-off-by: Viraj Jasani <vjasani@apache.org>
(cherry picked from commit 816e919e95)

hbase-client/src/main/java/org/apache/hadoop/hbase/security/CryptoAESWrapHandler.java

@@ -17,81 +17,32 @@
  */
 package org.apache.hadoop.hbase.security;
 
-import org.apache.hadoop.hbase.exceptions.ConnectionClosedException;
 import org.apache.hadoop.hbase.io.crypto.aes.CryptoAES;
 import org.apache.yetus.audience.InterfaceAudience;
 
 import org.apache.hbase.thirdparty.io.netty.buffer.ByteBuf;
-import org.apache.hbase.thirdparty.io.netty.buffer.Unpooled;
 import org.apache.hbase.thirdparty.io.netty.channel.ChannelHandlerContext;
-import org.apache.hbase.thirdparty.io.netty.channel.ChannelOutboundHandlerAdapter;
+import org.apache.hbase.thirdparty.io.netty.handler.codec.MessageToByteEncoder;
-import org.apache.hbase.thirdparty.io.netty.channel.ChannelPromise;
-import org.apache.hbase.thirdparty.io.netty.channel.CoalescingBufferQueue;
-import org.apache.hbase.thirdparty.io.netty.util.ReferenceCountUtil;
-import org.apache.hbase.thirdparty.io.netty.util.concurrent.PromiseCombiner;
 
 /**
  * wrap messages with Crypto AES.
  */
 @InterfaceAudience.Private
-public class CryptoAESWrapHandler extends ChannelOutboundHandlerAdapter {
+public class CryptoAESWrapHandler extends MessageToByteEncoder<ByteBuf> {
 
   private final CryptoAES cryptoAES;
 
-  private CoalescingBufferQueue queue;
-
   public CryptoAESWrapHandler(CryptoAES cryptoAES) {
     this.cryptoAES = cryptoAES;
   }
 
   @Override
-  public void handlerAdded(ChannelHandlerContext ctx) throws Exception {
+  protected void encode(ChannelHandlerContext ctx, ByteBuf msg, ByteBuf out) throws Exception {
-    queue = new CoalescingBufferQueue(ctx.channel());
+    byte[] bytes = new byte[msg.readableBytes()];
-  }
+    msg.readBytes(bytes);
-
-  @Override
-  public void write(ChannelHandlerContext ctx, Object msg, ChannelPromise promise)
-    throws Exception {
-    if (msg instanceof ByteBuf) {
-      queue.add((ByteBuf) msg, promise);
-    } else {
-      ctx.write(msg, promise);
-    }
-  }
-
-  @Override
-  public void flush(ChannelHandlerContext ctx) throws Exception {
-    if (queue.isEmpty()) {
-      return;
-    }
-    ByteBuf buf = null;
-    try {
-      ChannelPromise promise = ctx.newPromise();
-      int readableBytes = queue.readableBytes();
-      buf = queue.remove(readableBytes, promise);
-      byte[] bytes = new byte[readableBytes];
-      buf.readBytes(bytes);
     byte[] wrapperBytes = cryptoAES.wrap(bytes, 0, bytes.length);
-      ChannelPromise lenPromise = ctx.newPromise();
+    out.ensureWritable(4 + wrapperBytes.length);
-      ctx.write(ctx.alloc().buffer(4).writeInt(wrapperBytes.length), lenPromise);
+    out.writeInt(wrapperBytes.length);
-      ChannelPromise contentPromise = ctx.newPromise();
+    out.writeBytes(wrapperBytes);
-      ctx.write(Unpooled.wrappedBuffer(wrapperBytes), contentPromise);
-      PromiseCombiner combiner = new PromiseCombiner();
-      combiner.addAll(lenPromise, contentPromise);
-      combiner.finish(promise);
-      ctx.flush();
-    } finally {
-      if (buf != null) {
-        ReferenceCountUtil.safeRelease(buf);
-      }
-    }
-  }
-
-  @Override
-  public void close(ChannelHandlerContext ctx, ChannelPromise promise) throws Exception {
-    if (!queue.isEmpty()) {
-      queue.releaseAndFailAll(new ConnectionClosedException("Connection closed"));
-    }
-    ctx.close(promise);
   }
 }

hbase-client/src/main/java/org/apache/hadoop/hbase/security/SaslWrapHandler.java

@@ -18,80 +18,31 @@
 package org.apache.hadoop.hbase.security;
 
 import javax.security.sasl.SaslClient;
-import org.apache.hadoop.hbase.exceptions.ConnectionClosedException;
 import org.apache.yetus.audience.InterfaceAudience;
 
 import org.apache.hbase.thirdparty.io.netty.buffer.ByteBuf;
-import org.apache.hbase.thirdparty.io.netty.buffer.Unpooled;
 import org.apache.hbase.thirdparty.io.netty.channel.ChannelHandlerContext;
-import org.apache.hbase.thirdparty.io.netty.channel.ChannelOutboundHandlerAdapter;
+import org.apache.hbase.thirdparty.io.netty.handler.codec.MessageToByteEncoder;
-import org.apache.hbase.thirdparty.io.netty.channel.ChannelPromise;
-import org.apache.hbase.thirdparty.io.netty.channel.CoalescingBufferQueue;
-import org.apache.hbase.thirdparty.io.netty.util.ReferenceCountUtil;
-import org.apache.hbase.thirdparty.io.netty.util.concurrent.PromiseCombiner;
 
 /**
  * wrap sasl messages.
  */
 @InterfaceAudience.Private
-public class SaslWrapHandler extends ChannelOutboundHandlerAdapter {
+public class SaslWrapHandler extends MessageToByteEncoder<ByteBuf> {
 
   private final SaslClient saslClient;
 
-  private CoalescingBufferQueue queue;
-
   public SaslWrapHandler(SaslClient saslClient) {
     this.saslClient = saslClient;
   }
 
   @Override
-  public void handlerAdded(ChannelHandlerContext ctx) throws Exception {
+  protected void encode(ChannelHandlerContext ctx, ByteBuf msg, ByteBuf out) throws Exception {
-    queue = new CoalescingBufferQueue(ctx.channel());
+    byte[] bytes = new byte[msg.readableBytes()];
-  }
+    msg.readBytes(bytes);
-
-  @Override
-  public void write(ChannelHandlerContext ctx, Object msg, ChannelPromise promise)
-    throws Exception {
-    if (msg instanceof ByteBuf) {
-      queue.add((ByteBuf) msg, promise);
-    } else {
-      ctx.write(msg, promise);
-    }
-  }
-
-  @Override
-  public void flush(ChannelHandlerContext ctx) throws Exception {
-    if (queue.isEmpty()) {
-      return;
-    }
-    ByteBuf buf = null;
-    try {
-      ChannelPromise promise = ctx.newPromise();
-      int readableBytes = queue.readableBytes();
-      buf = queue.remove(readableBytes, promise);
-      byte[] bytes = new byte[readableBytes];
-      buf.readBytes(bytes);
     byte[] wrapperBytes = saslClient.wrap(bytes, 0, bytes.length);
-      ChannelPromise lenPromise = ctx.newPromise();
+    out.ensureWritable(4 + wrapperBytes.length);
-      ctx.write(ctx.alloc().buffer(4).writeInt(wrapperBytes.length), lenPromise);
+    out.writeInt(wrapperBytes.length);
-      ChannelPromise contentPromise = ctx.newPromise();
+    out.writeBytes(wrapperBytes);
-      ctx.write(Unpooled.wrappedBuffer(wrapperBytes), contentPromise);
-      PromiseCombiner combiner = new PromiseCombiner();
-      combiner.addAll(lenPromise, contentPromise);
-      combiner.finish(promise);
-      ctx.flush();
-    } finally {
-      if (buf != null) {
-        ReferenceCountUtil.safeRelease(buf);
-      }
-    }
-  }
-
-  @Override
-  public void close(ChannelHandlerContext ctx, ChannelPromise promise) throws Exception {
-    if (!queue.isEmpty()) {
-      queue.releaseAndFailAll(new ConnectionClosedException("Connection closed"));
-    }
-    ctx.close(promise);
   }
 }

hbase-server/src/main/java/org/apache/hadoop/hbase/ipc/NettyServerRpcConnection.java

@@ -32,6 +32,7 @@ import org.apache.hbase.thirdparty.com.google.protobuf.Descriptors.MethodDescrip
 import org.apache.hbase.thirdparty.com.google.protobuf.Message;
 import org.apache.hbase.thirdparty.io.netty.buffer.ByteBuf;
 import org.apache.hbase.thirdparty.io.netty.channel.Channel;
+import org.apache.hbase.thirdparty.io.netty.util.ReferenceCountUtil;
 
 import org.apache.hadoop.hbase.shaded.protobuf.generated.RPCProtos.RequestHeader;
 
@@ -59,12 +60,15 @@ class NettyServerRpcConnection extends ServerRpcConnection {
 
   void process(final ByteBuf buf) throws IOException, InterruptedException {
     if (connectionHeaderRead) {
-      this.callCleanup = buf::release;
+      this.callCleanup = () -> ReferenceCountUtil.safeRelease(buf);
       process(new SingleByteBuff(buf.nioBuffer()));
     } else {
       ByteBuffer connectionHeader = ByteBuffer.allocate(buf.readableBytes());
+      try {
         buf.readBytes(connectionHeader);
+      } finally {
         buf.release();
+      }
       process(connectionHeader);
     }
   }
@@ -77,9 +81,7 @@ class NettyServerRpcConnection extends ServerRpcConnection {
     try {
       if (skipInitialSaslHandshake) {
         skipInitialSaslHandshake = false;
-        if (callCleanup != null) {
+        callCleanupIfNeeded();
-          callCleanup.run();
-        }
         return;
       }
 
@@ -89,9 +91,7 @@ class NettyServerRpcConnection extends ServerRpcConnection {
         processOneRpc(buf);
       }
     } catch (Exception e) {
-      if (callCleanup != null) {
+      callCleanupIfNeeded();
-        callCleanup.run();
-      }
       throw e;
     } finally {
       this.callCleanup = null;
@@ -102,7 +102,7 @@ class NettyServerRpcConnection extends ServerRpcConnection {
   public synchronized void close() {
     disposeSasl();
     channel.close();
-    callCleanup = null;
+    callCleanupIfNeeded();
   }
 
   @Override

hbase-server/src/main/java/org/apache/hadoop/hbase/ipc/ServerRpcConnection.java

@@ -333,6 +333,8 @@ abstract class ServerRpcConnection implements Closeable {
         } else {
           plaintextData = saslServer.unwrap(b, 0, b.length);
         }
+        // release the request buffer as we have already unwrapped all its content
+        callCleanupIfNeeded();
         processUnwrappedData(plaintextData);
       }
     } else {
@@ -374,6 +376,9 @@ abstract class ServerRpcConnection implements Closeable {
         RpcServer.AUDITLOG.warn("{} {}: {}", RpcServer.AUTH_FAILED_FOR, clientIP,
           saslServer.getAttemptingUser());
         throw e;
+      } finally {
+        // release the request buffer as we have already unwrapped all its content
+        callCleanupIfNeeded();
       }
       if (replyToken != null) {
         if (RpcServer.LOG.isDebugEnabled()) {
@@ -403,7 +408,9 @@ abstract class ServerRpcConnection implements Closeable {
       int count;
       if (unwrappedDataLengthBuffer.remaining() > 0) {
         count = this.rpcServer.channelRead(ch, unwrappedDataLengthBuffer);
-        if (count <= 0 || unwrappedDataLengthBuffer.remaining() > 0) return;
+        if (count <= 0 || unwrappedDataLengthBuffer.remaining() > 0) {
+          return;
+        }
       }
 
       if (unwrappedData == null) {
@@ -419,7 +426,9 @@ abstract class ServerRpcConnection implements Closeable {
       }
 
       count = this.rpcServer.channelRead(ch, unwrappedData);
-      if (count <= 0 || unwrappedData.remaining() > 0) return;
+      if (count <= 0 || unwrappedData.remaining() > 0) {
+        return;
+      }
 
       if (unwrappedData.remaining() == 0) {
         unwrappedDataLengthBuffer.clear();
@@ -696,6 +705,13 @@ abstract class ServerRpcConnection implements Closeable {
     doRespond(getErrorResponse(msg, e));
   }
 
+  protected final void callCleanupIfNeeded() {
+    if (callCleanup != null) {
+      callCleanup.run();
+      callCleanup = null;
+    }
+  }
+
   protected final boolean processPreamble(ByteBuffer preambleBuffer) throws IOException {
     assert preambleBuffer.remaining() == 6;
     for (int i = 0; i < RPC_HEADER.length; i++) {

hbase-server/src/main/java/org/apache/hadoop/hbase/ipc/SimpleServerRpcConnection.java

@@ -283,7 +283,9 @@ class SimpleServerRpcConnection extends ServerRpcConnection {
       } else {
         processOneRpc(data);
       }
-
+    } catch (Exception e) {
+      callCleanupIfNeeded();
+      throw e;
     } finally {
       dataLengthBuffer.clear(); // Clean for the next call
       data = null; // For the GC
@@ -295,8 +297,10 @@ class SimpleServerRpcConnection extends ServerRpcConnection {
   public synchronized void close() {
     disposeSasl();
     data = null;
-    callCleanup = null;
+    callCleanupIfNeeded();
-    if (!channel.isOpen()) return;
+    if (!channel.isOpen()) {
+      return;
+    }
     try {
       socket.shutdownOutput();
     } catch (Exception ignored) {