HDDS-16093. [Ozone versioning] [T6] Reclamation

hadoop-hdds/common/src/main/java/org/apache/hadoop/ozone/OzoneConsts.java

@@ -180,6 +180,15 @@ public final class OzoneConsts {
 
   public static final String OM_KEY_PREFIX = "/";
   public static final String DOUBLE_SLASH_OM_KEY_PREFIX  = "//";
+  /**
+   * Separates a key name from the versionId suffix in versionedKeyTable DB keys.
+   * OM_KEY_PREFIX cannot be used: OBJECT_STORE key names contain '/' verbatim, so
+   * a key's versions would interleave with the versions of keys nested under it.
+   * 0x00 is the minimum byte value, so {keyName} + this separator can never be a
+   * prefix of {keyName} + "/". Written as an octal escape because a literal
+   * unicode escape for NUL is expanded by the Java lexer before parsing.
+   */
+  public static final String OM_VERSIONED_KEY_SEPARATOR = "\0";
   public static final String OM_USER_PREFIX = "$";
   public static final String OM_S3_PREFIX = "S3:";
   public static final String OM_S3_CALLER_CONTEXT_PREFIX = "S3Auth:S3G|";
@@ -299,6 +308,10 @@ public final class OzoneConsts {
   public static final String STORAGE_TYPE = "storageType";
   public static final String RESOURCE_TYPE = "resourceType";
   public static final String IS_VERSION_ENABLED = "isVersionEnabled";
+  public static final String VERSIONING_STATUS = "versioningStatus";
+  public static final String MAX_VERSIONS = "maxVersions";
+  public static final String NONCURRENT_VERSION_EXPIRATION_DAYS = "noncurrentVersionExpirationDays";
+  public static final String EXPIRED_DELETE_MARKER_CLEANUP = "expiredDeleteMarkerCleanup";
   public static final String CREATION_TIME = "creationTime";
   public static final String MODIFICATION_TIME = "modificationTime";
   public static final String DATA_SIZE = "dataSize";

hadoop-hdds/common/src/main/resources/ozone-default.xml

@@ -5163,4 +5163,64 @@
     <tag>OZONE, RATIS, OM</tag>
     <description>The maximum number of events that can be pending in OM Ratis.</description>
   </property>
+  <property>
+    <name>ozone.om.versioning.version-id-generator</name>
+    <value>org.apache.hadoop.ozone.om.helpers.TransactionIndexVersionIdGenerator</value>
+    <tag>OZONE, OM</tag>
+    <description>
+      Implementation of org.apache.hadoop.ozone.om.helpers.VersionIdGenerator used to assign the
+      versionId of an object version. The default uses the index of the committing transaction;
+      PinnedFirstVersionIdGenerator additionally pins the first version of every key to a reserved
+      sentinel, so that it can be referenced without listing the key's versions first.
+      The setting is cluster-wide and may be changed on a running cluster; a write whose generated
+      versionId already exists on the key is rejected, and the existing version has to be deleted
+      before that id can be written again.
+    </description>
+  </property>
+  <property>
+    <name>ozone.om.versioning.max.versions</name>
+    <value>100</value>
+    <tag>OZONE, OM</tag>
+    <description>
+      Maximum number of versions retained per key on a bucket that does not set maxVersions of its
+      own, counting the key's current version and its delete markers. Versions beyond the limit are
+      reclaimed oldest-first by VersionCleanupService. 0 means unlimited.
+    </description>
+  </property>
+  <property>
+    <name>ozone.om.version.cleanup.service.interval</name>
+    <value>1h</value>
+    <tag>OZONE, OM, PERFORMANCE</tag>
+    <description>
+      Time interval of the OM VersionCleanupService, which reclaims the noncurrent object versions
+      of a key that exceed the bucket's maxVersions. Unit could be defined with postfix (ns,ms,s,m,h,d).
+    </description>
+  </property>
+  <property>
+    <name>ozone.om.version.cleanup.service.timeout</name>
+    <value>300s</value>
+    <tag>OZONE, OM, PERFORMANCE</tag>
+    <description>
+      Timeout value of a VersionCleanupService run. Unit could be defined with postfix (ns,ms,s,m,h,d).
+    </description>
+  </property>
+  <property>
+    <name>ozone.om.version.cleanup.limit.per.task</name>
+    <value>1000</value>
+    <tag>OZONE, OM, PERFORMANCE</tag>
+    <description>
+      The maximum number of object versions VersionCleanupService submits for reclamation in one run.
+    </description>
+  </property>
+  <property>
+    <name>ozone.om.version.cleanup.marker.scan.budget</name>
+    <value>100000</value>
+    <tag>OZONE, OM, PERFORMANCE</tag>
+    <description>
+      The maximum number of keyTable entries VersionCleanupService examines in one run while looking
+      for keys left with only a delete marker. There is no index of delete markers, so they are found
+      by walking the keyTable; each run walks at most this many entries and the next one resumes where
+      it stopped, so no single run iterates the whole table.
+    </description>
+  </property>
 </configuration>

hadoop-ozone/common/src/main/java/org/apache/hadoop/ozone/OmUtils.java

@@ -320,6 +320,7 @@ public static boolean isReadOnly(OMRequest omRequest) {
     case RecoverLease:
     case SetTimes:
     case AbortExpiredMultiPartUploads:
+    case ReclaimObjectVersions:
     case SetSnapshotProperty:
     case QuotaRepair:
     case PutObjectTagging:
@@ -440,6 +441,7 @@ public static boolean shouldSendToFollower(OMRequest omRequest) {
     case RecoverLease:
     case SetTimes:
     case AbortExpiredMultiPartUploads:
+    case ReclaimObjectVersions:
     case SetSnapshotProperty:
     case QuotaRepair:
     case PutObjectTagging:

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

@@ -21,6 +21,8 @@
 import org.apache.hadoop.hdds.client.ReplicationFactor;
 import org.apache.hadoop.hdds.client.ReplicationType;
 import org.apache.hadoop.ozone.om.helpers.BucketLayout;
+import org.apache.hadoop.ozone.om.helpers.TransactionIndexVersionIdGenerator;
+import org.apache.hadoop.ozone.om.helpers.VersionIdGenerator;
 import org.apache.ratis.util.TimeDuration;
 
 /**
@@ -715,6 +717,35 @@ public final class OMConfigKeys {
       "ozone.om.ratis.events.max.limit";
   public static final int OZONE_OM_RATIS_EVENTS_MAX_LIMIT_DEFAULT = 100;
 
+  public static final String OZONE_OM_VERSIONING_VERSION_ID_GENERATOR =
+      "ozone.om.versioning.version-id-generator";
+  public static final Class<? extends VersionIdGenerator>
+      OZONE_OM_VERSIONING_VERSION_ID_GENERATOR_DEFAULT = TransactionIndexVersionIdGenerator.class;
+
+  public static final String OZONE_OM_VERSIONING_MAX_VERSIONS =
+      "ozone.om.versioning.max.versions";
+  public static final int OZONE_OM_VERSIONING_MAX_VERSIONS_DEFAULT = 100;
+
+  public static final String OZONE_OM_VERSION_CLEANUP_SERVICE_INTERVAL =
+      "ozone.om.version.cleanup.service.interval";
+  public static final String
+      OZONE_OM_VERSION_CLEANUP_SERVICE_INTERVAL_DEFAULT = "1h";
+
+  public static final String OZONE_OM_VERSION_CLEANUP_SERVICE_TIMEOUT =
+      "ozone.om.version.cleanup.service.timeout";
+  public static final String OZONE_OM_VERSION_CLEANUP_SERVICE_TIMEOUT_DEFAULT
+      = "300s";
+
+  public static final String OZONE_OM_VERSION_CLEANUP_LIMIT_PER_TASK =
+      "ozone.om.version.cleanup.limit.per.task";
+  public static final int OZONE_OM_VERSION_CLEANUP_LIMIT_PER_TASK_DEFAULT =
+      1000;
+
+  public static final String OZONE_OM_VERSION_CLEANUP_MARKER_SCAN_BUDGET =
+      "ozone.om.version.cleanup.marker.scan.budget";
+  public static final int OZONE_OM_VERSION_CLEANUP_MARKER_SCAN_BUDGET_DEFAULT =
+      100000;
+
   /**
    * Never constructed.
    */

hadoop-ozone/common/src/main/java/org/apache/hadoop/ozone/om/exceptions/OMException.java

@@ -281,5 +281,11 @@ public enum ResultCodes {
     ETAG_NOT_AVAILABLE,
 
     ATOMIC_WRITE_CONFLICT,
+
+    /**
+     * The addressed version exists but is a delete marker. Kept distinct from
+     * KEY_NOT_FOUND because S3 answers 405 rather than 404 for it.
+     */
+    KEY_IS_DELETE_MARKER,
   }
 }

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

@@ -0,0 +1,68 @@
+/*
+ * 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.ozone.om.helpers;
+
+import org.apache.hadoop.ozone.protocol.proto.OzoneManagerProtocolProtos.BucketVersioningStatusProto;
+
+/**
+ * S3-compatible bucket versioning state machine:
+ * UNVERSIONED -> ENABLED <-> SUSPENDED.
+ * Once versioning has been enabled, a bucket can never return to UNVERSIONED.
+ */
+public enum BucketVersioningStatus {
+  UNVERSIONED,
+  ENABLED,
+  SUSPENDED;
+
+  public static BucketVersioningStatus fromProto(BucketVersioningStatusProto proto) {
+    switch (proto) {
+    case VERSIONING_ENABLED:
+      return ENABLED;
+    case VERSIONING_SUSPENDED:
+      return SUSPENDED;
+    case UNVERSIONED:
+    default:
+      return UNVERSIONED;
+    }
+  }
+
+  public BucketVersioningStatusProto toProto() {
+    switch (this) {
+    case ENABLED:
+      return BucketVersioningStatusProto.VERSIONING_ENABLED;
+    case SUSPENDED:
+      return BucketVersioningStatusProto.VERSIONING_SUSPENDED;
+    default:
+      return BucketVersioningStatusProto.UNVERSIONED;
+    }
+  }
+
+  /** The legacy isVersionEnabled flag value kept in sync with this status. */
+  public boolean toVersionEnabledFlag() {
+    return this == ENABLED;
+  }
+
+  /**
+   * Whether a bucket may transition from this status to {@code target}.
+   * The only forbidden transition is back to UNVERSIONED after versioning
+   * has been enabled or suspended (matches the S3 state machine).
+   */
+  public boolean canTransitionTo(BucketVersioningStatus target) {
+    return this == UNVERSIONED || target != UNVERSIONED;
+  }
+}