HADOOP-14837: Glacier read restored objects support

Author: Bhavay Pahuja

hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/Constants.java

@@ -1519,6 +1519,12 @@ private Constants() {
    */
   public static final int DEFAULT_PREFETCH_MAX_BLOCKS_COUNT = 4;
 
+  /**
+   * Read Restored Glacier objects config.
+   * Value = {@value}
+   */
+  public static final String READ_RESTORED_GLACIER_OBJECTS = "fs.s3a.glacier.read.restored.objects";
+
   /**
    * The bucket region header.
    */

hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/Listing.java

@@ -76,6 +76,7 @@ public class Listing extends AbstractStoreOperation {
 
   private static final Logger LOG = S3AFileSystem.LOG;
   private final boolean isCSEEnabled;
+  private final S3ObjectStorageClassFilter s3ObjectStorageClassFilter;
 
   static final FileStatusAcceptor ACCEPT_ALL_BUT_S3N =
       new AcceptAllButS3nDirs();
@@ -87,6 +88,7 @@ public Listing(ListingOperationCallbacks listingOperationCallbacks,
     super(storeContext);
     this.listingOperationCallbacks = listingOperationCallbacks;
     this.isCSEEnabled = storeContext.isCSEEnabled();
+    this.s3ObjectStorageClassFilter = storeContext.getS3ObjectsStorageClassFilter();
   }
 
   /**
@@ -462,7 +464,8 @@ private boolean buildNextStatusBatch(S3ListResult objects) {
           LOG.debug("{}: {}", keyPath, stringify(s3Object));
         }
         // Skip over keys that are ourselves and old S3N _$folder$ files
-        if (acceptor.accept(keyPath, s3Object) && filter.accept(keyPath)) {
+        // Handle Glacier Storage Class objects based on the config fs.s3a.glacier.read.restored.objects value set
+        if ( s3ObjectStorageClassFilter.getFilter().apply(s3Object) &&  acceptor.accept(keyPath, s3Object) && filter.accept(keyPath)) {
           S3AFileStatus status = createFileStatus(keyPath, s3Object,
                   listingOperationCallbacks.getDefaultBlockSize(keyPath),
                   getStoreContext().getUsername(),

hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/S3AFileSystem.java

@@ -441,6 +441,12 @@ public class S3AFileSystem extends FileSystem implements StreamCapabilities,
    */
   private boolean isCSEEnabled;
 
+  /**
+   * {@link S3ObjectStorageClassFilter} will filter the S3 files based on the
+   * {@code fs.s3a.glacier.read.restored.objects} configuration.
+   */
+  private S3ObjectStorageClassFilter s3ObjectStorageClassFilter;
+
   /**
    * Bucket AccessPoint.
    */
@@ -577,6 +583,11 @@ public void initialize(URI name, Configuration originalConf)
 
       s3aInternals = createS3AInternals();
 
+      s3ObjectStorageClassFilter = Optional.of(conf.getTrimmed(READ_RESTORED_GLACIER_OBJECTS,
+              S3ObjectStorageClassFilter.READ_ALL.toString()))
+          .map(String::toUpperCase)
+          .map(S3ObjectStorageClassFilter::valueOf).get();
+
       // look for encryption data
       // DT Bindings may override this
       setEncryptionSecrets(
@@ -5658,6 +5669,7 @@ public StoreContext createStoreContext() {
         .setContextAccessors(new ContextAccessorsImpl())
         .setAuditor(getAuditor())
         .setEnableCSE(isCSEEnabled)
+        .setS3ObjectStorageClassFilter(s3ObjectStorageClassFilter)
         .build();
   }
 

hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/S3ObjectStorageClassFilter.java

@@ -0,0 +1,84 @@
+/*
+ * 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.fs.s3a;
+
+import org.apache.hadoop.thirdparty.com.google.common.collect.Sets;
+import java.util.Set;
+import java.util.function.Function;
+import software.amazon.awssdk.services.s3.model.ObjectStorageClass;
+import software.amazon.awssdk.services.s3.model.S3Object;
+
+
+/**
+ * <pre>
+ * {@link S3ObjectStorageClassFilter} will filter the S3 files based on the {@code fs.s3a.glacier.read.restored.objects} configuration set in {@link S3AFileSystem}
+ * The config can have 3 values:
+ * {@code READ_ALL}: Retrieval of Glacier files will fail with InvalidObjectStateException: The operation is not valid for the object's storage class.
+ * {@code SKIP_ALL_GLACIER}: If this value is set then this will ignore any S3 Objects which are tagged with Glacier storage classes and retrieve the others.
+ * {@code READ_RESTORED_GLACIER_OBJECTS}: If this value is set then restored status of the Glacier object will be checked, if restored the objects would be read like normal S3 objects else they will be ignored as the objects would not have been retrieved from the S3 Glacier.
+ * </pre>
+ */
+public enum S3ObjectStorageClassFilter {
+  READ_ALL(o -> true),
+  SKIP_ALL_GLACIER(S3ObjectStorageClassFilter::isNotGlacierObject),
+  READ_RESTORED_GLACIER_OBJECTS(S3ObjectStorageClassFilter::isCompletedRestoredObject);
+
+  private static final Set<ObjectStorageClass> GLACIER_STORAGE_CLASSES = Sets.newHashSet(ObjectStorageClass.GLACIER, ObjectStorageClass.DEEP_ARCHIVE);
+
+  private final Function<S3Object, Boolean> filter;
+
+  S3ObjectStorageClassFilter(Function<S3Object, Boolean> filter) {
+    this.filter = filter;
+  }
+
+  /**
+   * Checks if the s3 object is not an object with a storage class of glacier/deep_archive
+   * @param object s3 object
+   * @return if the s3 object is not an object with a storage class of glacier/deep_archive
+   */
+  private static boolean isNotGlacierObject(S3Object object) {
+    return !GLACIER_STORAGE_CLASSES.contains(object.storageClass());
+  }
+
+  /**
+   * Checks if the s3 object is an object with a storage class of glacier/deep_archive
+   * @param object s3 object
+   * @return if the s3 object is an object with a storage class of glacier/deep_archive
+   */
+  private static boolean isGlacierObject(S3Object object) {
+    return GLACIER_STORAGE_CLASSES.contains(object.storageClass());
+  }
+
+  /**
+   * Checks if the s3 object is completely restored
+   * @param object s3 object
+   * @return if the s3 object is completely restored
+   */
+  private static boolean isCompletedRestoredObject(S3Object object) {
+    if(isGlacierObject(object)) {
+      return object.restoreStatus() != null && !object.restoreStatus().isRestoreInProgress();
+    }
+    return true;
+  }
+
+  public Function<S3Object, Boolean> getFilter() {
+    return filter;
+  }
+
+}

hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/api/RequestFactory.java

@@ -37,7 +37,9 @@
 import software.amazon.awssdk.services.s3.model.ListObjectsV2Request;
 import software.amazon.awssdk.services.s3.model.ObjectIdentifier;
 import software.amazon.awssdk.services.s3.model.PutObjectRequest;
+import software.amazon.awssdk.services.s3.model.RestoreObjectRequest;
 import software.amazon.awssdk.services.s3.model.StorageClass;
+import software.amazon.awssdk.services.s3.model.Tier;
 import software.amazon.awssdk.services.s3.model.UploadPartRequest;
 
 import org.apache.hadoop.classification.InterfaceAudience;
@@ -251,4 +253,15 @@ ListObjectsV2Request.Builder newListObjectsV2RequestBuilder(String key,
   DeleteObjectsRequest.Builder newBulkDeleteRequestBuilder(
           List<ObjectIdentifier> keysToDelete);
 
+  /**
+   * Create a request builder to initiate a restore of Glacier object
+   * @param key object to restore
+   * @param tier glacier retrieval tier at which the restore will be processed.
+   * @param expirationDays lifetime of the active restored copy in days.
+   * @return the request builder
+   */
+  RestoreObjectRequest.Builder newRestoreObjectRequestBuilder(String key,
+      Tier tier,
+      int expirationDays);
+
 }

hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/impl/RequestFactoryImpl.java

@@ -34,6 +34,7 @@
 import software.amazon.awssdk.services.s3.model.DeleteObjectsRequest;
 import software.amazon.awssdk.services.s3.model.GetObjectRequest;
 import software.amazon.awssdk.services.s3.model.CreateMultipartUploadRequest;
+import software.amazon.awssdk.services.s3.model.GlacierJobParameters;
 import software.amazon.awssdk.services.s3.model.HeadBucketRequest;
 import software.amazon.awssdk.services.s3.model.HeadObjectRequest;
 import software.amazon.awssdk.services.s3.model.HeadObjectResponse;
@@ -42,9 +43,13 @@
 import software.amazon.awssdk.services.s3.model.ListObjectsV2Request;
 import software.amazon.awssdk.services.s3.model.MetadataDirective;
 import software.amazon.awssdk.services.s3.model.ObjectIdentifier;
+import software.amazon.awssdk.services.s3.model.OptionalObjectAttributes;
 import software.amazon.awssdk.services.s3.model.PutObjectRequest;
+import software.amazon.awssdk.services.s3.model.RestoreObjectRequest;
+import software.amazon.awssdk.services.s3.model.RestoreRequest;
 import software.amazon.awssdk.services.s3.model.ServerSideEncryption;
 import software.amazon.awssdk.services.s3.model.StorageClass;
+import software.amazon.awssdk.services.s3.model.Tier;
 import software.amazon.awssdk.services.s3.model.UploadPartRequest;
 import software.amazon.awssdk.utils.Md5Utils;
 import org.apache.hadoop.util.Preconditions;
@@ -609,6 +614,7 @@ public ListObjectsV2Request.Builder newListObjectsV2RequestBuilder(
     final ListObjectsV2Request.Builder requestBuilder = ListObjectsV2Request.builder()
         .bucket(bucket)
         .maxKeys(maxKeys)
+        .optionalObjectAttributes(OptionalObjectAttributes.RESTORE_STATUS) // Optional Attribute to get the Restored Status of the Glacier Objects
         .prefix(key);
 
     if (delimiter != null) {
@@ -632,6 +638,21 @@ public DeleteObjectsRequest.Builder newBulkDeleteRequestBuilder(
         .delete(d -> d.objects(keysToDelete).quiet(!LOG.isTraceEnabled())));
   }
 
+  @Override
+  public RestoreObjectRequest.Builder newRestoreObjectRequestBuilder(String key,
+      Tier tier,
+      int expirationDays) {
+    return prepareRequest(RestoreObjectRequest
+        .builder()
+        .bucket(bucket)
+        .key(key)
+        .restoreRequest(RestoreRequest
+            .builder()
+            .days(expirationDays)
+            .glacierJobParameters(GlacierJobParameters.builder().tier(tier).build())
+            .build()));
+  }
+
   @Override
   public void setEncryptionSecrets(final EncryptionSecrets secrets) {
     encryptionSecrets = secrets;

hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/impl/StoreContext.java

@@ -26,7 +26,6 @@
 import java.util.concurrent.ExecutorService;
 
 import org.apache.hadoop.thirdparty.com.google.common.util.concurrent.ListeningExecutorService;
-
 import org.apache.hadoop.thirdparty.com.google.common.util.concurrent.MoreExecutors;
 import org.apache.hadoop.classification.InterfaceAudience;
 import org.apache.hadoop.classification.InterfaceStability;
@@ -38,6 +37,7 @@
 import org.apache.hadoop.fs.s3a.S3AFileStatus;
 import org.apache.hadoop.fs.s3a.S3AInputPolicy;
 import org.apache.hadoop.fs.s3a.S3AStorageStatistics;
+import org.apache.hadoop.fs.s3a.S3ObjectStorageClassFilter;
 import org.apache.hadoop.fs.s3a.Statistic;
 import org.apache.hadoop.fs.s3a.statistics.S3AStatisticsContext;
 import org.apache.hadoop.fs.store.audit.ActiveThreadSpanSource;
@@ -117,6 +117,8 @@ public class StoreContext implements ActiveThreadSpanSource<AuditSpan> {
   /** Is client side encryption enabled? */
   private final boolean isCSEEnabled;
 
+  private final S3ObjectStorageClassFilter s3ObjectStorageClassFilter;
+
   /**
    * Instantiate.
    */
@@ -137,7 +139,8 @@ public class StoreContext implements ActiveThreadSpanSource<AuditSpan> {
       final boolean useListV1,
       final ContextAccessors contextAccessors,
       final AuditSpanSource<AuditSpanS3A> auditor,
-      final boolean isCSEEnabled) {
+      final boolean isCSEEnabled,
+      final S3ObjectStorageClassFilter s3ObjectStorageClassFilter) {
     this.fsURI = fsURI;
     this.bucket = bucket;
     this.configuration = configuration;
@@ -158,6 +161,7 @@ public class StoreContext implements ActiveThreadSpanSource<AuditSpan> {
     this.contextAccessors = contextAccessors;
     this.auditor = auditor;
     this.isCSEEnabled = isCSEEnabled;
+    this.s3ObjectStorageClassFilter = s3ObjectStorageClassFilter;
   }
 
   public URI getFsURI() {
@@ -411,4 +415,12 @@ public RequestFactory getRequestFactory() {
   public boolean isCSEEnabled() {
     return isCSEEnabled;
   }
+
+  /**
+   * Return the S3ObjectStorageClassFilter object for S3A, whose value is set according to the config {@code fs.s3a.glacier.read.restored.objects}
+   * @return  {@link S3ObjectStorageClassFilter} object
+   */
+  public S3ObjectStorageClassFilter getS3ObjectsStorageClassFilter() {
+    return s3ObjectStorageClassFilter;
+  }
 }

hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/impl/StoreContextBuilder.java

@@ -25,6 +25,7 @@
 import org.apache.hadoop.fs.s3a.Invoker;
 import org.apache.hadoop.fs.s3a.S3AInputPolicy;
 import org.apache.hadoop.fs.s3a.S3AStorageStatistics;
+import org.apache.hadoop.fs.s3a.S3ObjectStorageClassFilter;
 import org.apache.hadoop.fs.s3a.audit.AuditSpanS3A;
 import org.apache.hadoop.fs.s3a.statistics.S3AStatisticsContext;
 import org.apache.hadoop.fs.store.audit.AuditSpanSource;
@@ -69,6 +70,8 @@ public class StoreContextBuilder {
 
   private boolean isCSEEnabled;
 
+  private S3ObjectStorageClassFilter s3ObjectStorageClassFilter;
+
   public StoreContextBuilder setFsURI(final URI fsURI) {
     this.fsURI = fsURI;
     return this;
@@ -175,6 +178,12 @@ public StoreContextBuilder setEnableCSE(
     return this;
   }
 
+  public StoreContextBuilder setS3ObjectStorageClassFilter(
+      S3ObjectStorageClassFilter value) {
+    s3ObjectStorageClassFilter = value;
+    return this;
+  }
+
   public StoreContext build() {
     return new StoreContext(fsURI,
         bucket,
@@ -192,6 +201,7 @@ public StoreContext build() {
         useListV1,
         contextAccessors,
         auditor,
-        isCSEEnabled);
+        isCSEEnabled,
+        s3ObjectStorageClassFilter);
   }
 }

hadoop-tools/hadoop-aws/src/site/markdown/tools/hadoop-aws/index.md

@@ -1309,6 +1309,20 @@ The switch to turn S3A auditing on or off.
   </description>
 </property>
 
+<!--
+The switch to control how S3A handles glacier storage classes.
+-->
+<property>
+<name>fs.s3a.glacier.read.restored.objects</name>
+<value>READ_ALL</value>
+<description>
+  The config can have 3 values:
+
+  * READ_ALL: Retrieval of Glacier files will fail with InvalidObjectStateException: The operation is not valid for the object's storage class.
+  * SKIP_ALL_GLACIER: If this value is set then this will ignore any S3 Objects which are tagged with Glacier storage classes and retrieve the others.
+  * READ_RESTORED_GLACIER_OBJECTS: If this value is set then restored status of the Glacier object will be checked, if restored the objects would be read like normal S3 objects else they will be ignored as the objects would not have been retrieved from the S3 Glacier.
+</description>
+</property>
 ```
 ## <a name="retry_and_recovery"></a>Retry and Recovery