HDDS-13830. Snapshot Rocks DB directory path computation based on local version of snapshot

hadoop-ozone/client/src/main/java/org/apache/hadoop/ozone/client/OzoneSnapshot.java

@@ -192,7 +192,7 @@ public static OzoneSnapshot fromSnapshotInfo(SnapshotInfo snapshotInfo) {
         snapshotInfo.getSnapshotStatus(),
         snapshotInfo.getSnapshotId(),
         snapshotInfo.getSnapshotPath(),
-        snapshotInfo.getCheckpointDir(),
+        snapshotInfo.getCheckpointDirName(0),
         snapshotInfo.getReferencedSize(),
         snapshotInfo.getReferencedReplicatedSize(),
         snapshotInfo.getExclusiveSize() + snapshotInfo.getExclusiveSizeDeltaFromDirDeepCleaning(),
@@ -222,4 +222,22 @@ public int hashCode() {
     return Objects.hash(volumeName, bucketName, name, creationTime, snapshotStatus, snapshotId, snapshotPath,
         checkpointDir, referencedSize, referencedReplicatedSize, exclusiveSize, exclusiveReplicatedSize);
   }
+
+  @Override
+  public String toString() {
+    return "OzoneSnapshot{" +
+        "bucketName='" + bucketName + '\'' +
+        ", volumeName='" + volumeName + '\'' +
+        ", name='" + name + '\'' +
+        ", creationTime=" + creationTime +
+        ", snapshotStatus=" + snapshotStatus +
+        ", snapshotId=" + snapshotId +
+        ", snapshotPath='" + snapshotPath + '\'' +
+        ", checkpointDir='" + checkpointDir + '\'' +
+        ", referencedSize=" + referencedSize +
+        ", referencedReplicatedSize=" + referencedReplicatedSize +
+        ", exclusiveSize=" + exclusiveSize +
+        ", exclusiveReplicatedSize=" + exclusiveReplicatedSize +
+        '}';
+  }
 }

hadoop-ozone/client/src/test/java/org/apache/hadoop/ozone/client/TestOzoneSnapshot.java

@@ -19,6 +19,7 @@
 
 import static org.apache.hadoop.ozone.om.helpers.SnapshotInfo.SnapshotStatus.SNAPSHOT_ACTIVE;
 import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.mockito.ArgumentMatchers.eq;
 import static org.mockito.Mockito.when;
 
 import java.util.UUID;
@@ -40,7 +41,7 @@ private SnapshotInfo getMockedSnapshotInfo(UUID snapshotId) {
     when(snapshotInfo.getSnapshotStatus()).thenReturn(SNAPSHOT_ACTIVE);
     when(snapshotInfo.getSnapshotId()).thenReturn(snapshotId);
     when(snapshotInfo.getSnapshotPath()).thenReturn("volume/bucket");
-    when(snapshotInfo.getCheckpointDir()).thenReturn("checkpointDir");
+    when(snapshotInfo.getCheckpointDirName(eq(0))).thenReturn("checkpointDir");
     when(snapshotInfo.getReferencedSize()).thenReturn(1000L);
     when(snapshotInfo.getReferencedReplicatedSize()).thenReturn(3000L);
     when(snapshotInfo.getExclusiveSize()).thenReturn(4000L);

hadoop-ozone/common/src/main/java/org/apache/hadoop/ozone/om/helpers/SnapshotInfo.java

@@ -71,7 +71,6 @@ public final class SnapshotInfo implements Auditable, CopyObject<SnapshotInfo> {
   private UUID pathPreviousSnapshotId;
   private UUID globalPreviousSnapshotId;
   private String snapshotPath; // snapshot mask
-  private String checkpointDir;
   /**
    * RocksDB's transaction sequence number at the time of checkpoint creation.
    */
@@ -99,7 +98,6 @@ private SnapshotInfo(Builder b) {
     this.pathPreviousSnapshotId = b.pathPreviousSnapshotId;
     this.globalPreviousSnapshotId = b.globalPreviousSnapshotId;
     this.snapshotPath = b.snapshotPath;
-    this.checkpointDir = b.checkpointDir;
     this.dbTxSequenceNumber = b.dbTxSequenceNumber;
     this.deepClean = b.deepClean;
     this.sstFiltered = b.sstFiltered;
@@ -150,10 +148,6 @@ public void setSnapshotPath(String snapshotPath) {
     this.snapshotPath = snapshotPath;
   }
 
-  public void setCheckpointDir(String checkpointDir) {
-    this.checkpointDir = checkpointDir;
-  }
-
   public boolean isDeepCleaned() {
     return deepClean;
   }
@@ -202,10 +196,6 @@ public String getSnapshotPath() {
     return snapshotPath;
   }
 
-  public String getCheckpointDir() {
-    return checkpointDir;
-  }
-
   public boolean isSstFiltered() {
     return sstFiltered;
   }
@@ -231,7 +221,6 @@ public SnapshotInfo.Builder toBuilder() {
         .setPathPreviousSnapshotId(pathPreviousSnapshotId)
         .setGlobalPreviousSnapshotId(globalPreviousSnapshotId)
         .setSnapshotPath(snapshotPath)
-        .setCheckpointDir(checkpointDir)
         .setDbTxSequenceNumber(dbTxSequenceNumber)
         .setDeepClean(deepClean)
         .setSstFiltered(sstFiltered)
@@ -260,7 +249,6 @@ public static class Builder {
     private UUID pathPreviousSnapshotId;
     private UUID globalPreviousSnapshotId;
     private String snapshotPath;
-    private String checkpointDir;
     private long dbTxSequenceNumber;
     private boolean deepClean;
     private boolean sstFiltered;
@@ -339,12 +327,6 @@ public Builder setSnapshotPath(String snapshotPath) {
       return this;
     }
 
-    /** @param checkpointDir - Snapshot checkpoint directory. */
-    public Builder setCheckpointDir(String checkpointDir) {
-      this.checkpointDir = checkpointDir;
-      return this;
-    }
-
     /** @param dbTxSequenceNumber - RDB latest transaction sequence number. */
     public Builder setDbTxSequenceNumber(long dbTxSequenceNumber) {
       this.dbTxSequenceNumber = dbTxSequenceNumber;
@@ -459,7 +441,6 @@ public OzoneManagerProtocolProtos.SnapshotInfo getProtobuf() {
     }
 
     sib.setSnapshotPath(snapshotPath)
-        .setCheckpointDir(checkpointDir)
         .setDbTxSequenceNumber(dbTxSequenceNumber)
         .setDeepClean(deepClean);
     return sib.build();
@@ -544,7 +525,6 @@ public static SnapshotInfo getFromProtobuf(
     }
 
     osib.setSnapshotPath(snapshotInfoProto.getSnapshotPath())
-        .setCheckpointDir(snapshotInfoProto.getCheckpointDir())
         .setDbTxSequenceNumber(snapshotInfoProto.getDbTxSequenceNumber());
 
     return osib.build();
@@ -562,17 +542,20 @@ public Map<String, String> toAuditMap() {
   /**
    * Get the name of the checkpoint directory.
    */
-  public static String getCheckpointDirName(UUID snapshotId) {
+  public static String getCheckpointDirName(UUID snapshotId, int version) {
     Objects.requireNonNull(snapshotId,
         "SnapshotId is needed to create checkpoint directory");
-    return OM_SNAPSHOT_SEPARATOR + snapshotId;
+    if (version == 0) {
+      return OM_SNAPSHOT_SEPARATOR + snapshotId;
+    }
+    return OM_SNAPSHOT_SEPARATOR + snapshotId + OM_SNAPSHOT_SEPARATOR + version;
   }
 
   /**
    * Get the name of the checkpoint directory, (non-static).
    */
-  public String getCheckpointDirName() {
-    return getCheckpointDirName(getSnapshotId());
+  public String getCheckpointDirName(int version) {
+    return getCheckpointDirName(getSnapshotId(), version);
   }
 
   public long getDbTxSequenceNumber() {
@@ -703,10 +686,6 @@ public static SnapshotInfo newInstance(String volumeName,
         .setBucketName(bucketName)
         .setDeepClean(false)
         .setDeepCleanedDeletedDir(false);
-
-    if (snapshotId != null) {
-      builder.setCheckpointDir(getCheckpointDirName(snapshotId));
-    }
     return builder.build();
   }
 
@@ -729,7 +708,6 @@ public boolean equals(Object o) {
         Objects.equals(
             globalPreviousSnapshotId, that.globalPreviousSnapshotId) &&
         snapshotPath.equals(that.snapshotPath) &&
-        checkpointDir.equals(that.checkpointDir) &&
         deepClean == that.deepClean &&
         sstFiltered == that.sstFiltered &&
         referencedSize == that.referencedSize &&
@@ -746,7 +724,7 @@ public int hashCode() {
     return Objects.hash(snapshotId, name, volumeName, bucketName,
         snapshotStatus,
         creationTime, deletionTime, pathPreviousSnapshotId,
-        globalPreviousSnapshotId, snapshotPath, checkpointDir,
+        globalPreviousSnapshotId, snapshotPath,
         deepClean, sstFiltered,
         referencedSize, referencedReplicatedSize,
         exclusiveSize, exclusiveReplicatedSize, deepCleanedDeletedDir, lastTransactionInfo, createTransactionInfo);
@@ -773,7 +751,6 @@ public String toString() {
         ", pathPreviousSnapshotId: '" + pathPreviousSnapshotId + '\'' +
         ", globalPreviousSnapshotId: '" + globalPreviousSnapshotId + '\'' +
         ", snapshotPath: '" + snapshotPath + '\'' +
-        ", checkpointDir: '" + checkpointDir + '\'' +
         ", dbTxSequenceNumber: '" + dbTxSequenceNumber + '\'' +
         ", deepClean: '" + deepClean + '\'' +
         ", sstFiltered: '" + sstFiltered + '\'' +

hadoop-ozone/common/src/test/java/org/apache/hadoop/ozone/om/helpers/TestOmSnapshotInfo.java

@@ -45,7 +45,6 @@ public class TestOmSnapshotInfo {
   private static final UUID GLOBAL_PREVIOUS_SNAPSHOT_ID =
       PATH_PREVIOUS_SNAPSHOT_ID;
   private static final String SNAPSHOT_PATH = "test/path";
-  private static final String CHECKPOINT_DIR = "checkpoint.testdir";
   private static final long DB_TX_SEQUENCE_NUMBER = 12345L;
 
   private SnapshotInfo createSnapshotInfo() {
@@ -60,7 +59,6 @@ private SnapshotInfo createSnapshotInfo() {
         .setPathPreviousSnapshotId(PATH_PREVIOUS_SNAPSHOT_ID)
         .setGlobalPreviousSnapshotId(GLOBAL_PREVIOUS_SNAPSHOT_ID)
         .setSnapshotPath(SNAPSHOT_PATH)
-        .setCheckpointDir(CHECKPOINT_DIR)
         .setDbTxSequenceNumber(DB_TX_SEQUENCE_NUMBER)
         .setDeepClean(false)
         .setSstFiltered(false)
@@ -86,7 +84,6 @@ private OzoneManagerProtocolProtos.SnapshotInfo createSnapshotInfoProto() {
         .setPathPreviousSnapshotID(toProtobuf(PATH_PREVIOUS_SNAPSHOT_ID))
         .setGlobalPreviousSnapshotID(toProtobuf(GLOBAL_PREVIOUS_SNAPSHOT_ID))
         .setSnapshotPath(SNAPSHOT_PATH)
-        .setCheckpointDir(CHECKPOINT_DIR)
         .setDbTxSequenceNumber(DB_TX_SEQUENCE_NUMBER)
         .setDeepClean(false)
         .setSstFiltered(false)

hadoop-ozone/integration-test/src/test/java/org/apache/hadoop/fs/ozone/TestOzoneFsSnapshot.java

@@ -547,7 +547,7 @@ private String createSnapshot() throws Exception {
     SnapshotInfo snapshotInfo = ozoneManager.getMetadataManager()
         .getSnapshotInfoTable()
         .get(SnapshotInfo.getTableKey(VOLUME, BUCKET, snapshotName));
-    String snapshotDirName = getSnapshotPath(conf, snapshotInfo) +
+    String snapshotDirName = getSnapshotPath(conf, snapshotInfo, 0) +
         OM_KEY_PREFIX + "CURRENT";
     GenericTestUtils.waitFor(() -> new File(snapshotDirName).exists(),
         1000, 100000);

hadoop-ozone/integration-test/src/test/java/org/apache/hadoop/ozone/freon/TestOMSnapshotDAG.java

@@ -130,7 +130,7 @@ public static void shutdown() {
   }
 
   private String getDBCheckpointAbsolutePath(SnapshotInfo snapshotInfo) {
-    return OmSnapshotManager.getSnapshotPath(conf, snapshotInfo);
+    return OmSnapshotManager.getSnapshotPath(conf, snapshotInfo, 0);
   }
 
   private static String getSnapshotDBKey(String volumeName, String bucketName,

hadoop-ozone/integration-test/src/test/java/org/apache/hadoop/ozone/om/TestOMDbCheckpointServlet.java

@@ -733,7 +733,7 @@ private String createSnapshot(String vname, String bname)
     writeClient.createSnapshot(vname, bname, snapshotName);
     SnapshotInfo snapshotInfo = om.getMetadataManager().getSnapshotInfoTable()
         .get(SnapshotInfo.getTableKey(vname, bname, snapshotName));
-    String snapshotPath = getSnapshotPath(conf, snapshotInfo)
+    String snapshotPath = getSnapshotPath(conf, snapshotInfo, 0)
         + OM_KEY_PREFIX;
     GenericTestUtils.waitFor(() -> new File(snapshotPath).exists(),
         100, 30000);

hadoop-ozone/integration-test/src/test/java/org/apache/hadoop/ozone/om/TestOMDbCheckpointServletInodeBasedXfer.java

@@ -240,7 +240,7 @@ public void write(int b) throws IOException {
     doCallRealMethod().when(omDbCheckpointServletMock)
         .transferSnapshotData(anySet(), any(), anySet(), any(), any(), anyMap());
     doCallRealMethod().when(omDbCheckpointServletMock).createAndPrepareCheckpoint(anyBoolean());
-    doCallRealMethod().when(omDbCheckpointServletMock).getSnapshotDirsFromDB(any());
+    doCallRealMethod().when(omDbCheckpointServletMock).getSnapshotDirsFromDB(any(), any(), any());
   }
 
   @ParameterizedTest
@@ -748,7 +748,7 @@ private void setupClusterAndMocks(String volumeName, String bucketName,
     // Init the mock with the spyDbstore
     doCallRealMethod().when(omDbCheckpointServletMock).initialize(any(), any(),
         eq(false), any(), any(), eq(false));
-    doCallRealMethod().when(omDbCheckpointServletMock).getSnapshotDirsFromDB(any());
+    doCallRealMethod().when(omDbCheckpointServletMock).getSnapshotDirsFromDB(any(), any(), any());
     omDbCheckpointServletMock.initialize(spyDbStore, om.getMetrics().getDBCheckpointMetrics(),
         false,
         om.getOmAdminUsernames(), om.getOmAdminGroups(), false);

hadoop-ozone/integration-test/src/test/java/org/apache/hadoop/ozone/om/TestOMRatisSnapshots.java

@@ -337,11 +337,11 @@ private void checkSnapshot(OzoneManager leaderOM, OzoneManager followerOM,
     File followerMetaDir = OMStorage.getOmDbDir(followerOM.getConfiguration());
     Path followerActiveDir = Paths.get(followerMetaDir.toString(), OM_DB_NAME);
     Path followerSnapshotDir =
-        Paths.get(getSnapshotPath(followerOM.getConfiguration(), snapshotInfo));
+        Paths.get(getSnapshotPath(followerOM.getConfiguration(), snapshotInfo, 0));
     File leaderMetaDir = OMStorage.getOmDbDir(leaderOM.getConfiguration());
     Path leaderActiveDir = Paths.get(leaderMetaDir.toString(), OM_DB_NAME);
     Path leaderSnapshotDir =
-        Paths.get(getSnapshotPath(leaderOM.getConfiguration(), snapshotInfo));
+        Paths.get(getSnapshotPath(leaderOM.getConfiguration(), snapshotInfo, 0));
 
     // Get list of live files on the leader.
     RocksDB activeRocksDB = ((RDBStore) leaderOM.getMetadataManager().getStore())
@@ -1056,7 +1056,7 @@ private SnapshotInfo createOzoneSnapshot(OzoneManager leaderOM, String name)
         .get(tableKey);
     // Allow the snapshot to be written to disk
     String fileName =
-        getSnapshotPath(leaderOM.getConfiguration(), snapshotInfo);
+        getSnapshotPath(leaderOM.getConfiguration(), snapshotInfo, 0);
     File snapshotDir = new File(fileName);
     if (!RDBCheckpointUtils
         .waitForCheckpointDirectoryExist(snapshotDir)) {

hadoop-ozone/integration-test/src/test/java/org/apache/hadoop/ozone/om/snapshot/TestOmSnapshot.java

@@ -1990,7 +1990,7 @@ private String createSnapshot(String volName, String buckName,
         .get(SnapshotInfo.getTableKey(volName, linkedBuckets.getOrDefault(buckName, buckName), snapshotName));
     String snapshotDirName =
         OmSnapshotManager.getSnapshotPath(ozoneManager.getConfiguration(),
-            snapshotInfo) + OM_KEY_PREFIX + "CURRENT";
+            snapshotInfo, 0) + OM_KEY_PREFIX + "CURRENT";
     GenericTestUtils
         .waitFor(() -> new File(snapshotDirName).exists(), 1000, 120000);
     return snapshotKeyPrefix;

hadoop-ozone/integration-test/src/test/java/org/apache/hadoop/ozone/om/snapshot/TestOmSnapshotFileSystem.java

@@ -709,7 +709,7 @@ private String createSnapshot(String snapshotName)
     SnapshotInfo snapshotInfo = ozoneManager.getMetadataManager()
         .getSnapshotInfoTable()
         .get(SnapshotInfo.getTableKey(snapshot.getVolumeName(), snapshot.getBucketName(), snapshotName));
-    String snapshotDirName = getSnapshotPath(conf, snapshotInfo) +
+    String snapshotDirName = getSnapshotPath(conf, snapshotInfo, 0) +
         OM_KEY_PREFIX + "CURRENT";
     GenericTestUtils.waitFor(() -> new File(snapshotDirName).exists(),
         1000, 120000);

hadoop-ozone/integration-test/src/test/java/org/apache/hadoop/ozone/om/snapshot/TestOzoneManagerHASnapshot.java

@@ -410,7 +410,7 @@ private void createSnapshot(String volName, String buckName, String snapName) th
 
     String tableKey = SnapshotInfo.getTableKey(volName, buckName, snapName);
     SnapshotInfo snapshotInfo = SnapshotUtils.getSnapshotInfo(cluster.getOMLeader(), tableKey);
-    String fileName = getSnapshotPath(cluster.getOMLeader().getConfiguration(), snapshotInfo);
+    String fileName = getSnapshotPath(cluster.getOMLeader().getConfiguration(), snapshotInfo, 0);
     File snapshotDir = new File(fileName);
     if (!RDBCheckpointUtils.waitForCheckpointDirectoryExist(snapshotDir)) {
       throw new IOException("Snapshot directory doesn't exist");

hadoop-ozone/integration-test/src/test/java/org/apache/hadoop/ozone/om/snapshot/TestOzoneManagerSnapshotAcl.java

@@ -685,7 +685,7 @@ private void createSnapshot()
         .get(SnapshotInfo.getTableKey(volumeName, bucketName, snapshotName));
     // Allow the snapshot to be written to disk
     String fileName =
-        getSnapshotPath(ozoneManager.getConfiguration(), snapshotInfo);
+        getSnapshotPath(ozoneManager.getConfiguration(), snapshotInfo, 0);
     File snapshotDir = new File(fileName);
     if (!RDBCheckpointUtils
         .waitForCheckpointDirectoryExist(snapshotDir)) {

hadoop-ozone/integration-test/src/test/java/org/apache/hadoop/ozone/om/snapshot/TestOzoneSnapshotRestore.java

@@ -159,7 +159,7 @@ private String createSnapshot(String volName, String buckName,
             .getSnapshotInfoTable()
             .get(SnapshotInfo.getTableKey(volName, buckName, snapshotName));
     String snapshotDirName = OmSnapshotManager
-        .getSnapshotPath(clientConf, snapshotInfo) + OM_KEY_PREFIX + "CURRENT";
+        .getSnapshotPath(clientConf, snapshotInfo, 0) + OM_KEY_PREFIX + "CURRENT";
     GenericTestUtils.waitFor(() -> new File(snapshotDirName).exists(),
             1000, 120000);
     return snapshotKeyPrefix;

hadoop-ozone/integration-test/src/test/java/org/apache/hadoop/ozone/om/snapshot/TestSnapshotBackgroundServices.java

@@ -633,7 +633,7 @@ private SnapshotInfo createOzoneSnapshot(OzoneManager leaderOM, String name) thr
         .getSnapshotInfoTable()
         .get(tableKey);
     // Allow the snapshot to be written to disk
-    String fileName = getSnapshotPath(leaderOM.getConfiguration(), snapshotInfo);
+    String fileName = getSnapshotPath(leaderOM.getConfiguration(), snapshotInfo, 0);
     File snapshotDir = new File(fileName);
     if (!RDBCheckpointUtils.waitForCheckpointDirectoryExist(snapshotDir)) {
       throw new IOException("snapshot directory doesn't exist");

hadoop-ozone/interface-client/src/main/proto/OmClientProtocol.proto

@@ -880,7 +880,7 @@ message SnapshotInfo {
   optional hadoop.hdds.UUID pathPreviousSnapshotID = 8;
   optional hadoop.hdds.UUID globalPreviousSnapshotID = 9;
   optional string snapshotPath = 10;
-  optional string checkpointDir = 11;
+  optional string checkpointDir = 11 [deprecated = true];
   optional int64 dbTxSequenceNumber = 12;
   optional bool deepClean = 13;
   optional bool sstFiltered = 14;

hadoop-ozone/ozone-manager/src/main/java/org/apache/hadoop/ozone/om/OMDBCheckpointServlet.java

@@ -69,6 +69,7 @@
 import org.apache.hadoop.ozone.lock.BootstrapStateHandler;
 import org.apache.hadoop.ozone.om.helpers.SnapshotInfo;
 import org.apache.hadoop.ozone.om.snapshot.OMDBCheckpointUtils;
+import org.apache.hadoop.ozone.om.snapshot.OmSnapshotLocalDataManager;
 import org.apache.hadoop.ozone.om.snapshot.OmSnapshotUtils;
 import org.apache.hadoop.security.UserGroupInformation;
 import org.apache.hadoop.util.Time;
@@ -347,7 +348,8 @@ private Set<Path> getSnapshotDirs(DBCheckpoint checkpoint, boolean waitForDir)
     OzoneConfiguration conf = getConf();
 
     Set<Path> snapshotPaths = new HashSet<>();
-
+    OzoneManager om = (OzoneManager) getServletContext().getAttribute(OzoneConsts.OM_CONTEXT_ATTRIBUTE);
+    OmSnapshotLocalDataManager snapshotLocalDataManager = om.getOmSnapshotManager().getSnapshotLocalDataManager();
     // get snapshotInfo entries
     OmMetadataManagerImpl checkpointMetadataManager =
         OmMetadataManagerImpl.createCheckpointMetadataManager(
@@ -359,11 +361,14 @@ private Set<Path> getSnapshotDirs(DBCheckpoint checkpoint, boolean waitForDir)
       // For each entry, wait for corresponding directory.
       while (iterator.hasNext()) {
         Table.KeyValue<String, SnapshotInfo> entry = iterator.next();
-        Path path = Paths.get(getSnapshotPath(conf, entry.getValue()));
-        if (waitForDir) {
-          waitForDirToExist(path);
+        try (OmSnapshotLocalDataManager.ReadableOmSnapshotLocalDataMetaProvider snapMetaProvider =
+                 snapshotLocalDataManager.getOmSnapshotLocalDataMeta(entry.getValue())) {
+          Path path = Paths.get(getSnapshotPath(conf, entry.getValue(), snapMetaProvider.getMeta().getVersion()));
+          if (waitForDir) {
+            waitForDirToExist(path);
+          }
+          snapshotPaths.add(path);
         }
-        snapshotPaths.add(path);
       }
     } finally {
       checkpointMetadataManager.stop();