Skip to content

HDDS-11975. wrap TermIndex in ExecutionContext #7602

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jan 8, 2025
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
/**
* 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.ratis;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should be located in org.apache.hadoop.ozone.om instead? Since the goal is to make this independent of Ratis in the long run.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

will follow below structure,

org.apache.hadoop.ozone.om.execution
- factory/. // factory to create Execution handler
- request/. // request handling
  - obs
    - OMKeyCreateExecutor.java
    - OMKeyCommitExecutor.java
  - fso
    - OMFileCreateExecutor.java
  ..
- OMGateway.java
- PreRatisExecutionEnabler.java
- flowcontrol/
  - ExecutionContext.java
  - PoolExecutor.java
  - PostExecutionContext.java
  - DbChangeRecorder.java
  - RequestContext.java
- IndexGenerator.java. // generate unique index


import org.apache.ratis.server.protocol.TermIndex;

/**
* context required for execution of request.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* context required for execution of request.
* Context required for execution of a request.

*/
public class ExecutionContext {
private long index;
private TermIndex termIndex;

public long getIndex() {
return index;
}

public void setIndex(long index) {
this.index = index;
}

public TermIndex getTermIndex() {
if (null == termIndex) {
return TermIndex.valueOf(-1, index);
}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Move this to the constructor?

return termIndex;
}

public void setTermIndex(TermIndex termIndex) {
this.termIndex = termIndex;
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -555,8 +555,11 @@ public void close() {
*/
private OMResponse runCommand(OMRequest request, TermIndex termIndex) {
try {
ExecutionContext context = new ExecutionContext();
context.setTermIndex(termIndex);
context.setIndex(termIndex.getIndex());
final OMClientResponse omClientResponse = handler.handleWriteRequest(
request, termIndex, ozoneManagerDoubleBuffer);
request, context, ozoneManagerDoubleBuffer);
OMLockDetails omLockDetails = omClientResponse.getOmLockDetails();
OMResponse omResponse = omClientResponse.getOMResponse();
if (omLockDetails != null) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
import org.apache.commons.lang3.StringUtils;
import org.apache.hadoop.hdds.utils.TransactionInfo;
import org.apache.hadoop.ozone.om.helpers.OMAuditLogger;
import org.apache.ratis.server.protocol.TermIndex;
import org.apache.hadoop.ozone.om.ratis.ExecutionContext;
import org.apache.hadoop.ipc.ProtobufRpcEngine;
import org.apache.hadoop.ozone.OmUtils;
import org.apache.hadoop.ozone.OzoneConsts;
Expand Down Expand Up @@ -140,12 +140,15 @@ public void handleRequestFailure(OzoneManager ozoneManager) {
*
* @return the response that will be returned to the client.
*/
public abstract OMClientResponse validateAndUpdateCache(OzoneManager ozoneManager, TermIndex termIndex);
public abstract OMClientResponse validateAndUpdateCache(OzoneManager ozoneManager, ExecutionContext context);

/** For testing only. */
@VisibleForTesting
public OMClientResponse validateAndUpdateCache(OzoneManager ozoneManager, long transactionLogIndex) {
return validateAndUpdateCache(ozoneManager, TransactionInfo.getTermIndex(transactionLogIndex));
ExecutionContext context = new ExecutionContext();
context.setTermIndex(TransactionInfo.getTermIndex(transactionLogIndex));
context.setIndex(transactionLogIndex);
Copy link
Contributor

@adoroszlai adoroszlai Jan 4, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please improve safety of ExecutionContext:

  1. Remove mutators (set...)
  2. Create private constructors
  3. Make member variables final
  4. Introduce factory methods like:
  public static ExecutionContext of(long index)
  public static ExecutionContext of(TermIndex termIndex)

This reduces steps required in code that creates instances, and ensures only valid ExecutionContext can be created:

Suggested change
ExecutionContext context = new ExecutionContext();
context.setTermIndex(TransactionInfo.getTermIndex(transactionLogIndex));
context.setIndex(transactionLogIndex);
return validateAndUpdateCache(ozoneManager, ExecutionContext.of(transactionLogIndex));

If you plan to add many more members, then add builder instead of factory.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@adoroszlai updated ...

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @sumitagrawl for updating the patch.

Original suggestion simplifies callers and also ensures index and termIndex.getIndex() are consistent:

  public static ExecutionContext of(long index)
  public static ExecutionContext of(TermIndex termIndex)

Copy link
Contributor Author

@sumitagrawl sumitagrawl Jan 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@adoroszlai
This will be different in next PR, so created having together. Only this is to have most files impact to common place in this PR. So above can not be followed.

index: OM managed index -- it will be different of ratis index.
termIndex: Ratis index

But both is required to be part of ExecutionContext, used public static ExecutionContext of(long index, TermIndex termIndex)

Once number of params increases, will change to Builder pattern on need basis, which will have only few place to change.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will you have non-Ratis index and Ratis TermIndex with different values at the same time?

Copy link
Contributor Author

@sumitagrawl sumitagrawl Jan 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes,
ratis index is used in upgrade prepare and snapshot flow for specific purpose -- comparing if flush is completed or not.

Default, will be using OM managed index (non-ratis).

Once if removed ratis index in above cases with new flow, will remove this parameter in this class.

return validateAndUpdateCache(ozoneManager, context);
}

@VisibleForTesting
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@

import org.apache.hadoop.crypto.key.KeyProviderCryptoExtension;
import org.apache.hadoop.hdds.client.DefaultReplicationConfig;
import org.apache.ratis.server.protocol.TermIndex;
import org.apache.hadoop.ozone.om.ratis.ExecutionContext;
import org.apache.hadoop.hdds.utils.db.cache.CacheKey;
import org.apache.hadoop.hdds.utils.db.cache.CacheValue;
import org.apache.hadoop.ozone.ClientVersion;
Expand Down Expand Up @@ -162,8 +162,8 @@ private static void validateMaxBucket(OzoneManager ozoneManager)
}

@Override
public OMClientResponse validateAndUpdateCache(OzoneManager ozoneManager, TermIndex termIndex) {
final long transactionLogIndex = termIndex.getIndex();
public OMClientResponse validateAndUpdateCache(OzoneManager ozoneManager, ExecutionContext context) {
final long transactionLogIndex = context.getIndex();
OMMetrics omMetrics = ozoneManager.getMetrics();
omMetrics.incNumBucketCreates();

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
import java.util.Iterator;
import java.util.Map;

import org.apache.ratis.server.protocol.TermIndex;
import org.apache.hadoop.ozone.om.ratis.ExecutionContext;
import org.apache.hadoop.hdds.utils.db.Table;
import org.apache.hadoop.hdds.utils.db.TableIterator;
import org.apache.hadoop.ozone.om.exceptions.OMException.ResultCodes;
Expand Down Expand Up @@ -81,8 +81,8 @@ public OMBucketDeleteRequest(OMRequest omRequest) {
}

@Override
public OMClientResponse validateAndUpdateCache(OzoneManager ozoneManager, TermIndex termIndex) {
final long transactionLogIndex = termIndex.getIndex();
public OMClientResponse validateAndUpdateCache(OzoneManager ozoneManager, ExecutionContext context) {
final long transactionLogIndex = context.getIndex();
OMMetrics omMetrics = ozoneManager.getMetrics();
omMetrics.incNumBucketDeletes();
OMMetadataManager omMetadataManager = ozoneManager.getMetadataManager();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
package org.apache.hadoop.ozone.om.request.bucket;

import com.google.common.base.Preconditions;
import org.apache.ratis.server.protocol.TermIndex;
import org.apache.hadoop.ozone.om.ratis.ExecutionContext;
import org.apache.hadoop.hdds.utils.db.cache.CacheKey;
import org.apache.hadoop.hdds.utils.db.cache.CacheValue;
import org.apache.hadoop.ozone.audit.AuditLogger;
Expand Down Expand Up @@ -77,8 +77,8 @@ public OMRequest preExecute(OzoneManager ozoneManager)
}

@Override
public OMClientResponse validateAndUpdateCache(OzoneManager ozoneManager, TermIndex termIndex) {
final long transactionLogIndex = termIndex.getIndex();
public OMClientResponse validateAndUpdateCache(OzoneManager ozoneManager, ExecutionContext context) {
final long transactionLogIndex = context.getIndex();
SetBucketPropertyRequest setBucketPropertyRequest =
getOmRequest().getSetBucketPropertyRequest();
Preconditions.checkNotNull(setBucketPropertyRequest);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
import com.google.common.base.Preconditions;
import org.apache.hadoop.crypto.key.KeyProviderCryptoExtension;
import org.apache.hadoop.hdds.client.DefaultReplicationConfig;
import org.apache.ratis.server.protocol.TermIndex;
import org.apache.hadoop.ozone.om.ratis.ExecutionContext;
import org.apache.hadoop.ozone.OzoneConsts;
import org.apache.hadoop.ozone.audit.AuditLogger;
import org.apache.hadoop.ozone.audit.OMAction;
Expand Down Expand Up @@ -110,8 +110,8 @@ public OMRequest preExecute(OzoneManager ozoneManager)

@Override
@SuppressWarnings("methodlength")
public OMClientResponse validateAndUpdateCache(OzoneManager ozoneManager, TermIndex termIndex) {
final long transactionLogIndex = termIndex.getIndex();
public OMClientResponse validateAndUpdateCache(OzoneManager ozoneManager, ExecutionContext context) {
final long transactionLogIndex = context.getIndex();

SetBucketPropertyRequest setBucketPropertyRequest =
getOmRequest().getSetBucketPropertyRequest();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
import java.util.function.BiPredicate;

import org.apache.commons.lang3.tuple.Pair;
import org.apache.ratis.server.protocol.TermIndex;
import org.apache.hadoop.ozone.om.ratis.ExecutionContext;
import org.apache.hadoop.ozone.OzoneAcl;
import org.apache.hadoop.ozone.OzoneConsts;
import org.apache.hadoop.ozone.audit.AuditLogger;
Expand Down Expand Up @@ -63,8 +63,8 @@ public OMBucketAclRequest(OMRequest omRequest,
}

@Override
public OMClientResponse validateAndUpdateCache(OzoneManager ozoneManager, TermIndex termIndex) {
final long transactionLogIndex = termIndex.getIndex();
public OMClientResponse validateAndUpdateCache(OzoneManager ozoneManager, ExecutionContext context) {
final long transactionLogIndex = context.getIndex();

// protobuf guarantees acls are non-null.
List<OzoneAcl> ozoneAcls = getAcls();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
import java.util.Map;

import com.google.common.collect.Lists;
import org.apache.ratis.server.protocol.TermIndex;
import org.apache.hadoop.ozone.om.ratis.ExecutionContext;
import org.apache.hadoop.ozone.audit.AuditLogger;
import org.apache.hadoop.ozone.audit.OMAction;
import org.apache.hadoop.ozone.om.OMMetrics;
Expand Down Expand Up @@ -133,9 +133,9 @@ void onComplete(boolean operationResult, Exception exception,
}

@Override
public OMClientResponse validateAndUpdateCache(OzoneManager ozoneManager, TermIndex termIndex) {
public OMClientResponse validateAndUpdateCache(OzoneManager ozoneManager, ExecutionContext context) {
ozoneManager.getMetrics().incNumAddAcl();
return super.validateAndUpdateCache(ozoneManager, termIndex);
return super.validateAndUpdateCache(ozoneManager, context);
}
}

Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
import java.util.List;
import java.util.Map;

import org.apache.ratis.server.protocol.TermIndex;
import org.apache.hadoop.ozone.om.ratis.ExecutionContext;
import org.apache.hadoop.ozone.audit.AuditLogger;
import org.apache.hadoop.ozone.audit.OMAction;
import org.apache.hadoop.ozone.om.OzoneManager;
Expand Down Expand Up @@ -132,9 +132,9 @@ void onComplete(boolean operationResult, Exception exception,
}

@Override
public OMClientResponse validateAndUpdateCache(OzoneManager ozoneManager, TermIndex termIndex) {
public OMClientResponse validateAndUpdateCache(OzoneManager ozoneManager, ExecutionContext context) {
ozoneManager.getMetrics().incNumRemoveAcl();
return super.validateAndUpdateCache(ozoneManager, termIndex);
return super.validateAndUpdateCache(ozoneManager, context);
}

}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
import java.util.List;
import java.util.Map;

import org.apache.ratis.server.protocol.TermIndex;
import org.apache.hadoop.ozone.om.ratis.ExecutionContext;
import org.apache.hadoop.ozone.audit.AuditLogger;
import org.apache.hadoop.ozone.audit.OMAction;
import org.apache.hadoop.ozone.om.OzoneManager;
Expand Down Expand Up @@ -131,9 +131,9 @@ void onComplete(boolean operationResult, Exception exception,
}

@Override
public OMClientResponse validateAndUpdateCache(OzoneManager ozoneManager, TermIndex termIndex) {
public OMClientResponse validateAndUpdateCache(OzoneManager ozoneManager, ExecutionContext context) {
ozoneManager.getMetrics().incNumSetAcl();
return super.validateAndUpdateCache(ozoneManager, termIndex);
return super.validateAndUpdateCache(ozoneManager, context);
}
}

Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
import java.util.Map;

import com.google.common.base.Preconditions;
import org.apache.ratis.server.protocol.TermIndex;
import org.apache.hadoop.ozone.om.ratis.ExecutionContext;
import org.apache.hadoop.ozone.om.helpers.BucketLayout;
import org.apache.hadoop.ozone.om.helpers.OmBucketInfo;
import org.apache.hadoop.ozone.om.helpers.OmKeyInfo;
Expand Down Expand Up @@ -122,8 +122,8 @@ public OMRequest preExecute(OzoneManager ozoneManager) throws IOException {
}

@Override
public OMClientResponse validateAndUpdateCache(OzoneManager ozoneManager, TermIndex termIndex) {
final long trxnLogIndex = termIndex.getIndex();
public OMClientResponse validateAndUpdateCache(OzoneManager ozoneManager, ExecutionContext context) {
final long trxnLogIndex = context.getIndex();

CreateDirectoryRequest createDirectoryRequest = getOmRequest()
.getCreateDirectoryRequest();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@

package org.apache.hadoop.ozone.om.request.file;

import org.apache.ratis.server.protocol.TermIndex;
import org.apache.hadoop.ozone.om.ratis.ExecutionContext;
import org.apache.hadoop.ozone.audit.AuditLogger;
import org.apache.hadoop.ozone.audit.OMAction;
import org.apache.hadoop.ozone.om.OMMetadataManager;
Expand Down Expand Up @@ -76,8 +76,8 @@ public OMDirectoryCreateRequestWithFSO(OMRequest omRequest,
}

@Override
public OMClientResponse validateAndUpdateCache(OzoneManager ozoneManager, TermIndex termIndex) {
final long trxnLogIndex = termIndex.getIndex();
public OMClientResponse validateAndUpdateCache(OzoneManager ozoneManager, ExecutionContext context) {
final long trxnLogIndex = context.getIndex();

CreateDirectoryRequest createDirectoryRequest = getOmRequest()
.getCreateDirectoryRequest();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
import com.google.common.base.Preconditions;
import org.apache.commons.lang3.StringUtils;
import org.apache.hadoop.hdds.client.ReplicationConfig;
import org.apache.ratis.server.protocol.TermIndex;
import org.apache.hadoop.ozone.om.ratis.ExecutionContext;
import org.apache.hadoop.ozone.OzoneConsts;
import org.apache.hadoop.ozone.om.OzoneConfigUtil;
import org.apache.hadoop.ozone.om.helpers.BucketLayout;
Expand Down Expand Up @@ -162,8 +162,8 @@ public OMRequest preExecute(OzoneManager ozoneManager) throws IOException {

@Override
@SuppressWarnings("methodlength")
public OMClientResponse validateAndUpdateCache(OzoneManager ozoneManager, TermIndex termIndex) {
final long trxnLogIndex = termIndex.getIndex();
public OMClientResponse validateAndUpdateCache(OzoneManager ozoneManager, ExecutionContext context) {
final long trxnLogIndex = context.getIndex();

CreateFileRequest createFileRequest = getOmRequest().getCreateFileRequest();
KeyArgs keyArgs = createFileRequest.getKeyArgs();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
package org.apache.hadoop.ozone.om.request.file;

import org.apache.hadoop.hdds.client.ReplicationConfig;
import org.apache.ratis.server.protocol.TermIndex;
import org.apache.hadoop.ozone.om.ratis.ExecutionContext;
import org.apache.hadoop.ozone.audit.OMAction;
import org.apache.hadoop.ozone.om.OMMetadataManager;
import org.apache.hadoop.ozone.om.OMMetrics;
Expand Down Expand Up @@ -68,8 +68,8 @@ public OMFileCreateRequestWithFSO(OMRequest omRequest,

@Override
@SuppressWarnings("methodlength")
public OMClientResponse validateAndUpdateCache(OzoneManager ozoneManager, TermIndex termIndex) {
final long trxnLogIndex = termIndex.getIndex();
public OMClientResponse validateAndUpdateCache(OzoneManager ozoneManager, ExecutionContext context) {
final long trxnLogIndex = context.getIndex();

CreateFileRequest createFileRequest = getOmRequest().getCreateFileRequest();
KeyArgs keyArgs = createFileRequest.getKeyArgs();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@
import org.apache.hadoop.ozone.om.helpers.OmFSOFile;
import org.apache.hadoop.ozone.om.helpers.OmKeyLocationInfo;
import org.apache.hadoop.ozone.om.helpers.OmKeyLocationInfoGroup;
import org.apache.hadoop.ozone.om.ratis.ExecutionContext;
import org.apache.hadoop.ozone.om.request.key.OMKeyRequest;
import org.apache.hadoop.ozone.om.request.util.OmResponseUtil;
import org.apache.hadoop.ozone.om.response.OMClientResponse;
Expand All @@ -53,7 +54,6 @@
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.ratis.server.protocol.TermIndex;


import org.slf4j.Logger;
Expand Down Expand Up @@ -128,7 +128,7 @@ public OMRequest preExecute(OzoneManager ozoneManager) throws IOException {
}

@Override
public OMClientResponse validateAndUpdateCache(OzoneManager ozoneManager, TermIndex termIndex) {
public OMClientResponse validateAndUpdateCache(OzoneManager ozoneManager, ExecutionContext context) {
RecoverLeaseRequest recoverLeaseRequest = getOmRequest()
.getRecoverLeaseRequest();
Preconditions.checkNotNull(recoverLeaseRequest);
Expand Down Expand Up @@ -156,7 +156,7 @@ public OMClientResponse validateAndUpdateCache(OzoneManager ozoneManager, TermIn
acquiredLock = getOmLockDetails().isLockAcquired();
validateBucketAndVolume(omMetadataManager, volumeName, bucketName);

RecoverLeaseResponse recoverLeaseResponse = doWork(ozoneManager, termIndex.getIndex());
RecoverLeaseResponse recoverLeaseResponse = doWork(ozoneManager, context.getIndex());

// Prepare response
omResponse.setRecoverLeaseResponse(recoverLeaseResponse).setCmdType(RecoverLease);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@

import com.google.common.base.Preconditions;
import org.apache.hadoop.hdds.client.ReplicationConfig;
import org.apache.ratis.server.protocol.TermIndex;
import org.apache.hadoop.ozone.om.ratis.ExecutionContext;
import org.apache.hadoop.ozone.om.helpers.BucketLayout;
import org.apache.hadoop.ozone.om.helpers.OmBucketInfo;
import org.apache.hadoop.ozone.om.helpers.QuotaUtil;
Expand Down Expand Up @@ -150,8 +150,8 @@ public OMRequest preExecute(OzoneManager ozoneManager) throws IOException {
}

@Override
public OMClientResponse validateAndUpdateCache(OzoneManager ozoneManager, TermIndex termIndex) {
final long trxnLogIndex = termIndex.getIndex();
public OMClientResponse validateAndUpdateCache(OzoneManager ozoneManager, ExecutionContext context) {
final long trxnLogIndex = context.getIndex();

OzoneManagerProtocolProtos.AllocateBlockRequest allocateBlockRequest =
getOmRequest().getAllocateBlockRequest();
Expand Down
Loading
Loading