HBASE-29240: Backup ancestry trees should have the ability to be invalidated

Author: Hernan Gelaf-Romer

hbase-backup/src/main/java/org/apache/hadoop/hbase/backup/BackupClientFactory.java

@@ -18,15 +18,24 @@
 package org.apache.hadoop.hbase.backup;
 
 import java.io.IOException;
+import java.util.List;
+import java.util.Objects;
 import org.apache.hadoop.conf.Configuration;
+import org.apache.hadoop.hbase.backup.impl.BackupAdminImpl;
+import org.apache.hadoop.hbase.backup.impl.BackupManager;
 import org.apache.hadoop.hbase.backup.impl.FullTableBackupClient;
+import org.apache.hadoop.hbase.backup.impl.IncrementalBackupsDisallowedException;
 import org.apache.hadoop.hbase.backup.impl.IncrementalTableBackupClient;
 import org.apache.hadoop.hbase.backup.impl.TableBackupClient;
 import org.apache.hadoop.hbase.client.Connection;
 import org.apache.yetus.audience.InterfaceAudience;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 @InterfaceAudience.Private
 public final class BackupClientFactory {
+  private static final Logger LOG = LoggerFactory.getLogger(BackupClientFactory.class);
+
   private BackupClientFactory() {
   }
 
@@ -49,8 +58,44 @@ public static TableBackupClient create(Connection conn, String backupId, BackupR
     BackupType type = request.getBackupType();
     if (type == BackupType.FULL) {
       return new FullTableBackupClient(conn, backupId, request);
-    } else {
-      return new IncrementalTableBackupClient(conn, backupId, request);
     }
+
+    String latestFullBackup = getLatestFullBackupId(conn, request);
+
+    try (BackupAdmin admin = new BackupAdminImpl(conn)) {
+      boolean isInvalidAncestry =
+        admin.getBackupInfo(latestFullBackup).isDisallowFurtherIncrementals();
+
+      if (!isInvalidAncestry) {
+        return new IncrementalTableBackupClient(conn, backupId, request);
+      }
+
+      if (request.getFailOnDisallowedIncrementals()) {
+        throw new IncrementalBackupsDisallowedException(request);
+      }
+
+      LOG.info("Ancestry is invalid for backupId {}, creating a full backup", latestFullBackup);
+      return new FullTableBackupClient(conn, backupId, request);
+    }
+  }
+
+  private static String getLatestFullBackupId(Connection conn, BackupRequest request)
+    throws IOException {
+    try (BackupManager backupManager = new BackupManager(conn, conn.getConfiguration())) {
+      // Sorted in desc order by time
+      List<BackupInfo> backups = backupManager.getBackupHistory(true);
+
+      for (BackupInfo info : backups) {
+        if (
+          info.getType() == BackupType.FULL
+            && Objects.equals(info.getBackupRootDir(), request.getTargetRootDir())
+        ) {
+          return info.getBackupId();
+        }
+      }
+    }
+    throw new RuntimeException(
+      "Could not find a valid full backup for incremental request for tables"
+        + request.getTableList());
   }
 }

hbase-backup/src/main/java/org/apache/hadoop/hbase/backup/BackupInfo.java

@@ -170,6 +170,8 @@ public enum BackupPhase {
    */
   private boolean noChecksumVerify;
 
+  private boolean disallowFurtherIncrementals = false;
+
   public BackupInfo() {
     backupTableInfoMap = new HashMap<>();
   }
@@ -203,6 +205,14 @@ public void setBandwidth(long bandwidth) {
     this.bandwidth = bandwidth;
   }
 
+  public void setDisallowFurtherIncrementals(boolean disallowFurtherIncrementals) {
+    this.disallowFurtherIncrementals = disallowFurtherIncrementals;
+  }
+
+  public boolean isDisallowFurtherIncrementals() {
+    return disallowFurtherIncrementals;
+  }
+
   public void setNoChecksumVerify(boolean noChecksumVerify) {
     this.noChecksumVerify = noChecksumVerify;
   }
@@ -423,6 +433,7 @@ public BackupProtos.BackupInfo toProtosBackupInfo() {
     builder.setBackupType(BackupProtos.BackupType.valueOf(getType().name()));
     builder.setWorkersNumber(workers);
     builder.setBandwidth(bandwidth);
+    builder.setDisallowFurtherIncrementals(disallowFurtherIncrementals);
     return builder.build();
   }
 
@@ -518,6 +529,7 @@ public static BackupInfo fromProto(BackupProtos.BackupInfo proto) {
     context.setType(BackupType.valueOf(proto.getBackupType().name()));
     context.setWorkers(proto.getWorkersNumber());
     context.setBandwidth(proto.getBandwidth());
+    context.setDisallowFurtherIncrementals(proto.getDisallowFurtherIncrementals());
     return context;
   }
 

hbase-backup/src/main/java/org/apache/hadoop/hbase/backup/BackupMasterObserver.java

@@ -0,0 +1,70 @@
+/*
+ * 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.backup;
+
+import java.io.IOException;
+import java.util.Optional;
+import org.apache.hadoop.conf.Configuration;
+import org.apache.hadoop.hbase.HBaseInterfaceAudience;
+import org.apache.hadoop.hbase.TableName;
+import org.apache.hadoop.hbase.backup.impl.BackupManager;
+import org.apache.hadoop.hbase.backup.impl.BackupSystemTable;
+import org.apache.hadoop.hbase.coprocessor.MasterCoprocessor;
+import org.apache.hadoop.hbase.coprocessor.MasterCoprocessorEnvironment;
+import org.apache.hadoop.hbase.coprocessor.MasterObserver;
+import org.apache.hadoop.hbase.coprocessor.ObserverContext;
+import org.apache.yetus.audience.InterfaceAudience;
+
+@InterfaceAudience.LimitedPrivate(HBaseInterfaceAudience.CONFIG)
+public class BackupMasterObserver implements MasterObserver, MasterCoprocessor {
+
+  @Override
+  public void preTruncateTable(ObserverContext<MasterCoprocessorEnvironment> ctx,
+    TableName tableName) throws IOException {
+    disallowIncrementalBackups(ctx.getEnvironment(), tableName);
+  }
+
+  @Override
+  public void postTruncateTable(ObserverContext<MasterCoprocessorEnvironment> ctx,
+    TableName tableName) throws IOException {
+    disallowIncrementalBackups(ctx.getEnvironment(), tableName);
+  }
+
+  @Override
+  public Optional<MasterObserver> getMasterObserver() {
+    return Optional.of(this);
+  }
+
+  private static void disallowIncrementalBackups(MasterCoprocessorEnvironment env,
+    TableName tableName) throws IOException {
+    Configuration conf = env.getConfiguration();
+    if (
+      tableName.equals(BackupSystemTable.getTableName(conf)) || !BackupManager.isBackupEnabled(conf)
+    ) {
+      return;
+    }
+
+    BackupSystemTable table = new BackupSystemTable(env.getConnection());
+    try {
+      table.startBackupExclusiveOperation();
+      table.disallowFurtherIncrementals(tableName);
+    } finally {
+      table.finishBackupExclusiveOperation();
+    }
+  }
+}

hbase-backup/src/main/java/org/apache/hadoop/hbase/backup/BackupRequest.java

@@ -35,6 +35,11 @@ public Builder() {
       request = new BackupRequest();
     }
 
+    public Builder withFailOnDisallowedIncrementals(boolean failOnDisallowedIncrementals) {
+      request.failOnDisallowedIncrementals = failOnDisallowedIncrementals;
+      return this;
+    }
+
     public Builder withBackupType(BackupType type) {
       request.setBackupType(type);
       return this;
@@ -89,10 +94,15 @@ public BackupRequest build() {
   private boolean noChecksumVerify = false;
   private String backupSetName;
   private String yarnPoolName;
+  private boolean failOnDisallowedIncrementals = false;
 
   private BackupRequest() {
   }
 
+  public boolean getFailOnDisallowedIncrementals() {
+    return failOnDisallowedIncrementals;
+  }
+
   private BackupRequest setBackupType(BackupType type) {
     this.type = type;
     return this;

hbase-backup/src/main/java/org/apache/hadoop/hbase/backup/impl/BackupManager.java

@@ -30,6 +30,7 @@
 import org.apache.hadoop.hbase.backup.BackupHFileCleaner;
 import org.apache.hadoop.hbase.backup.BackupInfo;
 import org.apache.hadoop.hbase.backup.BackupInfo.BackupState;
+import org.apache.hadoop.hbase.backup.BackupMasterObserver;
 import org.apache.hadoop.hbase.backup.BackupObserver;
 import org.apache.hadoop.hbase.backup.BackupRestoreConstants;
 import org.apache.hadoop.hbase.backup.BackupType;
@@ -125,6 +126,10 @@ public static void decorateMasterConfiguration(Configuration conf) {
           + "Added master procedure manager: {}",
         cleanerClass, masterProcedureClass, BackupHFileCleaner.class.getName());
     }
+
+    String observers = conf.get(CoprocessorHost.MASTER_COPROCESSOR_CONF_KEY);
+    conf.set(CoprocessorHost.MASTER_COPROCESSOR_CONF_KEY,
+      (observers == null ? "" : observers + ",") + BackupMasterObserver.class.getName());
   }
 
   /**

hbase-backup/src/main/java/org/apache/hadoop/hbase/backup/impl/BackupSystemTable.java

@@ -277,6 +277,32 @@ public void close() {
     // do nothing
   }
 
+  public void disallowFurtherIncrementals(TableName toInvalidate) throws IOException {
+    List<BackupInfo> fullTableBackups = getCompletedFullBackupsSortedByHistoryDesc();
+    List<Put> invalidatePuts = new ArrayList<>(fullTableBackups.size());
+    Set<String> backupRootDirsSeen = new HashSet<>(fullTableBackups.size());
+
+    for (BackupInfo backupInfo : fullTableBackups) {
+      // to minimize the amount of mutations against the backup system table, we only
+      // need to update full backups that currently have a valid ancestry line
+      if (
+        backupInfo.getTables().contains(toInvalidate) && backupInfo.getType() == BackupType.FULL
+          && !backupInfo.isDisallowFurtherIncrementals()
+          && !backupRootDirsSeen.contains(backupInfo.getBackupRootDir())
+      ) {
+        backupInfo.setDisallowFurtherIncrementals(true);
+        backupRootDirsSeen.add(backupInfo.getBackupRootDir());
+        invalidatePuts.add(createPutForBackupInfo(backupInfo));
+        LOG.info("Invalidating ancestry for backup {} due to table {}", backupInfo.getBackupId(),
+          toInvalidate);
+      }
+    }
+
+    try (BufferedMutator mutator = connection.getBufferedMutator(tableName)) {
+      mutator.mutate(invalidatePuts);
+    }
+  }
+
   /**
    * Updates status (state) of a backup session in backup system table table
    * @param info backup info
@@ -841,6 +867,24 @@ public ArrayList<BackupInfo> getBackupInfos(BackupState state) throws IOExceptio
     }
   }
 
+  private List<BackupInfo> getCompletedFullBackupsSortedByHistoryDesc() throws IOException {
+    Scan scan = createScanForBackupHistory();
+    List<BackupInfo> backups = new ArrayList<>();
+
+    try (Table table = connection.getTable(tableName)) {
+      ResultScanner scanner = table.getScanner(scan);
+      Result res;
+      while ((res = scanner.next()) != null) {
+        res.advance();
+        BackupInfo context = cellToBackupInfo(res.current());
+        if (context.getState() == BackupState.COMPLETE && context.getType() == BackupType.FULL) {
+          backups.add(context);
+        }
+      }
+    }
+    return BackupUtils.sortHistoryListDesc(backups);
+  }
+
   /**
    * Write the current timestamps for each regionserver to backup system table after a successful
    * full or incremental backup. The saved timestamp is of the last log file that was backed up

hbase-backup/src/main/java/org/apache/hadoop/hbase/backup/impl/IncrementalBackupsDisallowedException.java

@@ -0,0 +1,33 @@
+/*
+ * 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.backup.impl;
+
+import org.apache.hadoop.hbase.HBaseIOException;
+import org.apache.hadoop.hbase.backup.BackupRequest;
+import org.apache.yetus.audience.InterfaceAudience;
+import org.apache.yetus.audience.InterfaceStability;
+
+@InterfaceAudience.Public
+@InterfaceStability.Evolving
+public class IncrementalBackupsDisallowedException extends HBaseIOException {
+  public IncrementalBackupsDisallowedException(BackupRequest request) {
+    super(
+      "Could not take incremental backup for tables %s because is disallowed, please take a full backup instead"
+        .formatted(request.getTableList()));
+  }
+}

hbase-backup/src/main/java/org/apache/hadoop/hbase/backup/util/BackupUtils.java

@@ -496,7 +496,7 @@ public static String getTableBackupDir(String backupRootDir, String backupId,
    * @param historyList history list
    * @return sorted list of BackupCompleteData
    */
-  public static ArrayList<BackupInfo> sortHistoryListDesc(ArrayList<BackupInfo> historyList) {
+  public static ArrayList<BackupInfo> sortHistoryListDesc(List<BackupInfo> historyList) {
     ArrayList<BackupInfo> list = new ArrayList<>();
     TreeMap<String, BackupInfo> map = new TreeMap<>();
     for (BackupInfo h : historyList) {

hbase-backup/src/test/java/org/apache/hadoop/hbase/backup/TestBackupSystemTable.java

@@ -18,6 +18,7 @@
 package org.apache.hadoop.hbase.backup;
 
 import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertFalse;
 import static org.junit.Assert.assertNotNull;
 import static org.junit.Assert.assertNull;
 import static org.junit.Assert.assertTrue;
@@ -53,6 +54,8 @@
 import org.junit.Test;
 import org.junit.experimental.categories.Category;
 
+import org.apache.hbase.thirdparty.com.google.common.collect.Lists;
+
 /**
  * Test cases for backup system table API
  */
@@ -479,6 +482,43 @@ public void testBackupSetList() throws IOException {
     }
   }
 
+  @Test
+  public void testInvalidateAncestry() throws Exception {
+    try (BackupSystemTable table = new BackupSystemTable(conn)) {
+      TableName toInvalidate = TableName.valueOf("t1");
+      List<TableName> t1 = Lists.newArrayList(toInvalidate, TableName.valueOf("t2"));
+      List<TableName> t2 = Lists.newArrayList(toInvalidate, TableName.valueOf("t3"));
+      List<TableName> t3 = Lists.newArrayList(TableName.valueOf("t2"), TableName.valueOf("t3"));
+
+      BackupInfo backup = createBackupInfo();
+      backup.setState(BackupState.COMPLETE);
+
+      backup.setTables(t1);
+      backup.setBackupId("backup1");
+      table.updateBackupInfo(backup);
+
+      backup.setTables(t2);
+      backup.setBackupId("backup2");
+      table.updateBackupInfo(backup);
+
+      backup.setTables(t3);
+      backup.setBackupId("backup3");
+      table.updateBackupInfo(backup);
+
+      table.disallowFurtherIncrementals(toInvalidate);
+      BackupInfo result = table.readBackupInfo("backup1");
+      assertTrue(result.isDisallowFurtherIncrementals());
+
+      table.disallowFurtherIncrementals(toInvalidate);
+      result = table.readBackupInfo("backup2");
+      assertTrue(result.isDisallowFurtherIncrementals());
+
+      table.disallowFurtherIncrementals(toInvalidate);
+      result = table.readBackupInfo("backup3");
+      assertFalse(result.isDisallowFurtherIncrementals());
+    }
+  }
+
   private boolean compare(BackupInfo one, BackupInfo two) {
     return one.getBackupId().equals(two.getBackupId()) && one.getType().equals(two.getType())
       && one.getBackupRootDir().equals(two.getBackupRootDir())