From 7278d9ccf1ff64c895e71c0844e228af08740d22 Mon Sep 17 00:00:00 2001
From: ndimiduk <ndimiduk@unknown>
Date: Wed, 19 Mar 2014 23:59:44 +0000
Subject: [PATCH] HBASE-10792 RingBufferTruck does not release its payload

git-svn-id: https://svn.apache.org/repos/asf/hbase/trunk@1579475 13f79535-47bb-0310-9956-ffa450edef68
---
 .../hadoop/hbase/regionserver/wal/FSHLog.java | 10 +--
 .../regionserver/wal/RingBufferTruck.java     | 61 ++++++++++++++++---
 2 files changed, 59 insertions(+), 12 deletions(-)

diff --git a/hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/wal/FSHLog.java b/hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/wal/FSHLog.java
index f66f8c45501..6525dc256ae 100644
--- a/hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/wal/FSHLog.java
+++ b/hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/wal/FSHLog.java
@@ -1779,15 +1779,15 @@ class FSHLog implements HLog, Syncable {
 
       // TODO: Trace only working for appends, not for syncs.
       TraceScope scope =
-        truck.getSpanPayload() != null? Trace.continueSpan(truck.getSpanPayload()): null;
+        truck.hasSpanPayload() ? Trace.continueSpan(truck.unloadSpanPayload()) : null;
       try {
-        if (truck.getSyncFuturePayload() != null) {
-          this.syncFutures[this.syncFuturesCount++] = truck.getSyncFuturePayload();
+        if (truck.hasSyncFuturePayload()) {
+          this.syncFutures[this.syncFuturesCount++] = truck.unloadSyncFuturePayload();
           // Force flush of syncs if we are carrying a full complement of syncFutures.
           if (this.syncFuturesCount == this.syncFutures.length) endOfBatch = true;
-        } else if (truck.getFSWALEntryPayload() != null) {
+        } else if (truck.hasFSWALEntryPayload()) {
           try {
-            append(truck.getFSWALEntryPayload());
+            append(truck.unloadFSWALEntryPayload());
           } catch (Exception e) {
             // If append fails, presume any pending syncs will fail too; let all waiting handlers
             // know of the exception.
diff --git a/hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/wal/RingBufferTruck.java b/hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/wal/RingBufferTruck.java
index 197cefb80b2..6bddc0049fe 100644
--- a/hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/wal/RingBufferTruck.java
+++ b/hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/wal/RingBufferTruck.java
@@ -26,7 +26,9 @@ import com.lmax.disruptor.EventFactory;
 /**
  * A 'truck' to carry a payload across the {@link FSHLog} ring buffer from Handler to WAL.
  * Has EITHER a {@link FSWALEntry} for making an append OR it has a {@link SyncFuture} to
- * represent a 'sync' invocation. Immutable but instances get recycled on the ringbuffer.
+ * represent a 'sync' invocation. Truck instances are reused by the disruptor when it gets
+ * around to it so their payload references must be discarded on consumption to release them
+ * to GC.
  */
 @InterfaceAudience.Private
 class RingBufferTruck {
@@ -42,28 +44,73 @@ class RingBufferTruck {
    */
   private Span span;
 
+  /**
+   * Load the truck with a {@link FSWALEntry} and associated {@link Span}.
+   */
   void loadPayload(final FSWALEntry entry, final Span span) {
     this.entry = entry;
     this.span = span;
     this.syncFuture = null;
   }
 
+  /**
+   * Load the truck with a {@link SyncFuture}.
+   */
   void loadPayload(final SyncFuture syncFuture) {
     this.syncFuture = syncFuture;
     this.entry = null;
     this.span = null;
   }
 
-  FSWALEntry getFSWALEntryPayload() {
-    return this.entry;
+  /**
+   * return {@code true} when this truck is carrying a {@link FSWALEntry},
+   * {@code false} otherwise.
+   */
+  boolean hasFSWALEntryPayload() {
+    return this.entry != null;
   }
 
-  SyncFuture getSyncFuturePayload() {
-    return this.syncFuture;
+  /**
+   * return {@code true} when this truck is carrying a {@link SyncFuture},
+   * {@code false} otherwise.
+   */
+  boolean hasSyncFuturePayload() {
+    return this.syncFuture != null;
   }
 
-  Span getSpanPayload() {
-    return this.span;
+  /**
+   * return {@code true} when this truck is carrying a {@link Span},
+   * {@code false} otherwise.
+   */
+  boolean hasSpanPayload() {
+    return this.span != null;
+  }
+
+  /**
+   * Unload the truck of its {@link FSWALEntry} payload. The internal refernce is released.
+   */
+  FSWALEntry unloadFSWALEntryPayload() {
+    FSWALEntry ret = this.entry;
+    this.entry = null;
+    return ret;
+  }
+
+  /**
+   * Unload the truck of its {@link SyncFuture} payload. The internal refernce is released.
+   */
+  SyncFuture unloadSyncFuturePayload() {
+    SyncFuture ret = this.syncFuture;
+    this.syncFuture = null;
+    return ret;
+  }
+
+  /**
+   * Unload the truck of its {@link Span} payload. The internal refernce is released.
+   */
+  Span unloadSpanPayload() {
+    Span ret = this.span;
+    this.span = null;
+    return ret;
   }
 
   /**