HDDS-1730. Implement File CreateDirectory Request to use Cache and Do… #1026
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,282 @@ | ||
| /** | ||
| * 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 | ||
| * <p> | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * <p> | ||
| * 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.request.file; | ||
|
|
||
| import java.io.IOException; | ||
| import java.nio.file.Path; | ||
| import java.nio.file.Paths; | ||
| import java.util.ArrayList; | ||
| import java.util.Collections; | ||
| import java.util.Map; | ||
|
|
||
| import com.google.common.base.Optional; | ||
| import com.google.common.base.Preconditions; | ||
| import org.slf4j.Logger; | ||
| import org.slf4j.LoggerFactory; | ||
|
|
||
| import org.apache.hadoop.fs.FileEncryptionInfo; | ||
| import org.apache.hadoop.hdds.protocol.proto.HddsProtos; | ||
| import org.apache.hadoop.ozone.audit.AuditLogger; | ||
| import org.apache.hadoop.ozone.audit.OMAction; | ||
| import org.apache.hadoop.ozone.om.OMMetadataManager; | ||
| import org.apache.hadoop.ozone.om.OMMetrics; | ||
| import org.apache.hadoop.ozone.om.OzoneManager; | ||
| import org.apache.hadoop.ozone.om.exceptions.OMException; | ||
| import org.apache.hadoop.ozone.om.helpers.OmBucketInfo; | ||
| import org.apache.hadoop.ozone.om.helpers.OmKeyInfo; | ||
| import org.apache.hadoop.ozone.om.helpers.OmKeyLocationInfoGroup; | ||
| import org.apache.hadoop.ozone.om.helpers.OzoneFSUtils; | ||
| import org.apache.hadoop.ozone.om.request.OMClientRequest; | ||
| import org.apache.hadoop.ozone.om.request.key.OMKeyRequest; | ||
| import org.apache.hadoop.ozone.om.response.OMClientResponse; | ||
| import org.apache.hadoop.ozone.om.response.file.OMDirectoryCreateResponse; | ||
| import org.apache.hadoop.ozone.protocol.proto.OzoneManagerProtocolProtos; | ||
| import org.apache.hadoop.ozone.protocol.proto.OzoneManagerProtocolProtos | ||
| .CreateDirectoryRequest; | ||
| import org.apache.hadoop.ozone.protocol.proto.OzoneManagerProtocolProtos | ||
| .CreateDirectoryResponse; | ||
| import org.apache.hadoop.ozone.protocol.proto.OzoneManagerProtocolProtos | ||
| .KeyArgs; | ||
| import org.apache.hadoop.ozone.protocol.proto.OzoneManagerProtocolProtos | ||
| .OMRequest; | ||
| import org.apache.hadoop.ozone.protocol.proto.OzoneManagerProtocolProtos | ||
| .OMResponse; | ||
| import org.apache.hadoop.ozone.security.acl.IAccessAuthorizer; | ||
| import org.apache.hadoop.ozone.security.acl.OzoneObj; | ||
| import org.apache.hadoop.util.Time; | ||
| import org.apache.hadoop.utils.db.cache.CacheKey; | ||
| import org.apache.hadoop.utils.db.cache.CacheValue; | ||
|
|
||
|
|
||
| import static org.apache.hadoop.ozone.om.exceptions.OMException.ResultCodes.BUCKET_NOT_FOUND; | ||
| import static org.apache.hadoop.ozone.om.exceptions.OMException.ResultCodes.FILE_ALREADY_EXISTS; | ||
| import static org.apache.hadoop.ozone.om.lock.OzoneManagerLock.Resource.BUCKET_LOCK; | ||
| /** | ||
| * Handle create directory request. | ||
| */ | ||
| public class OMDirectoryCreateRequest extends OMClientRequest | ||
| implements OMKeyRequest { | ||
|
|
||
| private static final Logger LOG = | ||
| LoggerFactory.getLogger(OMDirectoryCreateRequest.class); | ||
|
|
||
| public OMDirectoryCreateRequest(OMRequest omRequest) { | ||
| super(omRequest); | ||
| } | ||
|
|
||
| @Override | ||
| public OMRequest preExecute(OzoneManager ozoneManager) { | ||
| CreateDirectoryRequest createDirectoryRequest = | ||
| getOmRequest().getCreateDirectoryRequest(); | ||
| Preconditions.checkNotNull(createDirectoryRequest); | ||
|
|
||
| KeyArgs.Builder newKeyArgs = createDirectoryRequest.getKeyArgs() | ||
| .toBuilder().setModificationTime(Time.now()); | ||
|
|
||
| CreateDirectoryRequest.Builder newCreateDirectoryRequest = | ||
| createDirectoryRequest.toBuilder().setKeyArgs(newKeyArgs); | ||
|
|
||
| return getOmRequest().toBuilder().setCreateDirectoryRequest( | ||
| newCreateDirectoryRequest).build(); | ||
|
|
||
| } | ||
|
|
||
| @Override | ||
| public OMClientResponse validateAndUpdateCache(OzoneManager ozoneManager, | ||
| long transactionLogIndex) { | ||
|
|
||
| KeyArgs keyArgs = getOmRequest().getCreateDirectoryRequest().getKeyArgs(); | ||
|
|
||
| String volumeName = keyArgs.getVolumeName(); | ||
| String bucketName = keyArgs.getBucketName(); | ||
| String keyName = keyArgs.getKeyName(); | ||
|
|
||
| OMResponse.Builder omResponse = | ||
| OzoneManagerProtocolProtos.OMResponse.newBuilder().setCmdType( | ||
| OzoneManagerProtocolProtos.Type.CreateDirectory).setStatus( | ||
| OzoneManagerProtocolProtos.Status.OK); | ||
|
|
||
| OMMetrics omMetrics = ozoneManager.getMetrics(); | ||
| omMetrics.incNumCreateDirectory(); | ||
|
|
||
| AuditLogger auditLogger = ozoneManager.getAuditLogger(); | ||
| OzoneManagerProtocolProtos.UserInfo userInfo = getOmRequest().getUserInfo(); | ||
|
|
||
| Map<String, String> auditMap = buildKeyArgsAuditMap(keyArgs); | ||
| OMMetadataManager omMetadataManager = ozoneManager.getMetadataManager(); | ||
| boolean acquiredLock = false; | ||
| IOException exception = null; | ||
| OmKeyInfo dirKeyInfo = null; | ||
|
|
||
| try { | ||
| // check Acl | ||
| if (ozoneManager.getAclsEnabled()) { | ||
| checkAcls(ozoneManager, OzoneObj.ResourceType.BUCKET, | ||
| OzoneObj.StoreType.OZONE, IAccessAuthorizer.ACLType.WRITE, | ||
| volumeName, bucketName, keyName); | ||
| } | ||
|
|
||
| // Check if this is the root of the filesystem. | ||
| if (keyName.length() == 0) { | ||
| return new OMDirectoryCreateResponse(null, | ||
|
Contributor
There was a problem hiding this comment. A future improvement unrelated to your patch - replace null with Optional. Or at least add @nullable annotation on the parameter.
Contributor
Author
There was a problem hiding this comment. Added @nullable. Will open a new jira to do the same for Other OMResponse classes.
Contributor
Author
There was a problem hiding this comment. |
||
| omResponse.setCreateDirectoryResponse( | ||
| CreateDirectoryResponse.newBuilder()).build()); | ||
| } | ||
| // acquire lock | ||
| acquiredLock = omMetadataManager.getLock().acquireLock(BUCKET_LOCK, | ||
| volumeName, bucketName); | ||
|
|
||
| // TODO: Not checking volume exist here, once we have full cache we can | ||
|
Contributor
There was a problem hiding this comment. Let's file a blocker Jira for this so it doesn't slip somehow.
Contributor
Author
There was a problem hiding this comment. This check is to throw a specific error like volume not found. |
||
| // add volume exist check also. | ||
|
|
||
| OmBucketInfo omBucketInfo = omMetadataManager.getBucketTable().get( | ||
| omMetadataManager.getBucketKey(volumeName, bucketName)); | ||
|
|
||
| if (omBucketInfo == null) { | ||
| throw new OMException("Bucket not found " + bucketName, | ||
| BUCKET_NOT_FOUND); | ||
| } | ||
|
|
||
|
|
||
| // Need to check if any files exist in the given path, if they exist we | ||
| // cannot create a directory with the given key. | ||
| OMDirectoryResult omDirectoryResult = verifyFilesInPath(omMetadataManager, | ||
| volumeName, bucketName, omMetadataManager.getOzoneDirKey(volumeName, | ||
| bucketName, keyName), Paths.get(keyName)); | ||
|
|
||
| if (omDirectoryResult == OMDirectoryResult.FILE_ALREADY_EXISTS) { | ||
| throw new OMException("Unable to create directory: " +keyName | ||
| + " in volume/bucket: " + volumeName + "/" + bucketName, | ||
| FILE_ALREADY_EXISTS); | ||
| } else if (omDirectoryResult == OMDirectoryResult.SUB_DIRECTORY_EXISTS || | ||
| omDirectoryResult == OMDirectoryResult.NONE) { | ||
| dirKeyInfo = createDirectoryKeyInfo(ozoneManager, omBucketInfo, | ||
| volumeName, bucketName, keyName, keyArgs); | ||
|
|
||
| omMetadataManager.getKeyTable().addCacheEntry( | ||
| new CacheKey<>(omMetadataManager.getOzoneKey(volumeName, bucketName, | ||
| dirKeyInfo.getKeyName())), | ||
| new CacheValue<>(Optional.of(dirKeyInfo), transactionLogIndex)); | ||
| } | ||
| // if directory already exists do nothing or do we need to throw | ||
| // exception? Current KeyManagerImpl code does just return, following | ||
| // similar approach. | ||
|
|
||
| } catch (IOException ex) { | ||
| exception = ex; | ||
| } finally { | ||
| if (acquiredLock) { | ||
| omMetadataManager.getLock().releaseLock(BUCKET_LOCK, volumeName, | ||
| bucketName); | ||
| } | ||
| } | ||
|
|
||
| auditLog(auditLogger, buildAuditMessage(OMAction.CREATE_DIRECTORY, | ||
| auditMap, exception, userInfo)); | ||
|
|
||
| if (exception == null) { | ||
| LOG.debug("Directory is successfully created for Key: {} in " + | ||
| "volume/bucket:{}/{}", keyName, volumeName, bucketName); | ||
| omResponse.setCreateDirectoryResponse( | ||
| CreateDirectoryResponse.newBuilder()); | ||
| return new OMDirectoryCreateResponse(dirKeyInfo, | ||
| omResponse.build()); | ||
| } else { | ||
| LOG.error("CreateDirectory failed for Key: {} in volume/bucket:{}/{}", | ||
| keyName, volumeName, bucketName, exception); | ||
| omMetrics.incNumCreateDirectoryFails(); | ||
| return new OMDirectoryCreateResponse(null, | ||
| createErrorOMResponse(omResponse, exception)); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Verify any files exist in the given path in the specified volume/bucket. | ||
| * @param omMetadataManager | ||
| * @param volumeName | ||
| * @param bucketName | ||
| * @param keyPath | ||
| * @return true - if file exist in the given path, else false. | ||
| * @throws IOException | ||
| */ | ||
| private OMDirectoryResult verifyFilesInPath( | ||
| OMMetadataManager omMetadataManager, String volumeName, String bucketName, | ||
| String directoryName, Path keyPath) throws IOException { | ||
|
|
||
| while (keyPath != null) { | ||
| String keyName = keyPath.toString(); | ||
|
|
||
| String dbKeyName = omMetadataManager.getOzoneKey(volumeName, | ||
| bucketName, keyName); | ||
| String dbDirKeyName = omMetadataManager.getOzoneDirKey(volumeName, | ||
| bucketName, keyName); | ||
|
|
||
| if (omMetadataManager.getKeyTable().get(dbKeyName) != null) { | ||
| // Found a file in the given path. | ||
| return OMDirectoryResult.FILE_ALREADY_EXISTS; | ||
| } else if (omMetadataManager.getKeyTable().get(dbDirKeyName) != null) { | ||
| if (dbDirKeyName.equals(directoryName)) { | ||
| return OMDirectoryResult.DIRECTORY_ALREADY_EXISTS; | ||
| } else { | ||
| return OMDirectoryResult.SUB_DIRECTORY_EXISTS; | ||
| } | ||
| } | ||
| keyPath = keyPath.getParent(); | ||
| } | ||
|
|
||
| // Found no files/ directories in the given path. | ||
| return OMDirectoryResult.NONE; | ||
| } | ||
|
|
||
|
|
||
| private OmKeyInfo createDirectoryKeyInfo(OzoneManager ozoneManager, | ||
| OmBucketInfo omBucketInfo, String volumeName, String bucketName, | ||
| String keyName, KeyArgs keyArgs) | ||
| throws IOException { | ||
| FileEncryptionInfo encryptionInfo = getFileEncryptionInfo(ozoneManager, | ||
| omBucketInfo); | ||
| String dirName = OzoneFSUtils.addTrailingSlashIfNeeded(keyName); | ||
|
|
||
| return new OmKeyInfo.Builder() | ||
| .setVolumeName(volumeName) | ||
| .setBucketName(bucketName) | ||
| .setKeyName(dirName) | ||
| .setOmKeyLocationInfos(Collections.singletonList( | ||
| new OmKeyLocationInfoGroup(0, new ArrayList<>()))) | ||
| .setCreationTime(keyArgs.getModificationTime()) | ||
| .setModificationTime(keyArgs.getModificationTime()) | ||
| .setDataSize(0) | ||
| .setReplicationType(HddsProtos.ReplicationType.RATIS) | ||
| .setReplicationFactor(HddsProtos.ReplicationFactor.ONE) | ||
| .setFileEncryptionInfo(encryptionInfo) | ||
| .setAcls(keyArgs.getAclsList()) | ||
| .build(); | ||
| } | ||
|
|
||
| /** | ||
| * Return codes used by verifyFilesInPath method. | ||
| */ | ||
| enum OMDirectoryResult { | ||
| DIRECTORY_ALREADY_EXISTS, | ||
| FILE_ALREADY_EXISTS, | ||
| SUB_DIRECTORY_EXISTS, | ||
| NONE | ||
| } | ||
|
|
||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| /* | ||
| * 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 contains classes related to file requests. | ||
| */ | ||
| package org.apache.hadoop.ozone.om.request.file; |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Unnecessary import changes?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done.