[FLINK-38336][state/forst] Avoid data copy during failover for ForSt statebackend #27042
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,193 @@ | ||
| /* | ||
| * 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.flink.state.forst; | ||
|
|
||
| import org.apache.flink.core.fs.Path; | ||
|
|
||
| import org.slf4j.Logger; | ||
| import org.slf4j.LoggerFactory; | ||
|
|
||
| import javax.annotation.Nullable; | ||
|
|
||
| import java.util.Objects; | ||
|
|
||
| /** Container for ForSt paths. */ | ||
|
There was a problem hiding this comment. it would be worth describing each path here. The text talks of Forst paths , but there are only 2 of the 6 that mention Forst - There was a problem hiding this comment. Comments have been added to the code. |
||
| public class ForStPathContainer { | ||
|
|
||
| private static final Logger LOG = LoggerFactory.getLogger(ForStResourceContainer.class); | ||
| public static final String DB_DIR_STRING = "db"; | ||
|
|
||
| /** | ||
| * Local job path. This indicates the parent directory of ForSt, which ends with the Flink | ||
| * JobID. | ||
| */ | ||
| @Nullable private final Path localJobPath; | ||
|
|
||
| /** | ||
| * Local base path. This includes the information of the subtask that holds ForSt, such as the | ||
| * Operator Identifier and subtask index. | ||
| */ | ||
| @Nullable private final Path localBasePath; | ||
|
|
||
| /** Local ForSt path. This is the directory of ForSt DB, which ends with 'db'. */ | ||
| @Nullable private final Path localForStPath; | ||
|
|
||
| /** | ||
| * Remote paths of ForSt. Similar to the respective Path mentioned above, but located under the | ||
| * remote parent path. | ||
| */ | ||
| @Nullable private final Path remoteJobPath; | ||
|
|
||
| @Nullable private final Path remoteBasePath; | ||
| @Nullable private final Path remoteForStPath; | ||
|
|
||
| public static ForStPathContainer empty() { | ||
| return of(null, null, null, null); | ||
| } | ||
|
|
||
| public static ForStPathContainer ofLocal( | ||
| @Nullable Path localJobPath, @Nullable Path localBasePath) { | ||
| return new ForStPathContainer(localJobPath, localBasePath, null, null); | ||
| } | ||
|
|
||
| public static ForStPathContainer of( | ||
| @Nullable Path localJobPath, | ||
| @Nullable Path localBasePath, | ||
| @Nullable Path remoteJobPath, | ||
| @Nullable Path remoteBasePath) { | ||
| return new ForStPathContainer(localJobPath, localBasePath, remoteJobPath, remoteBasePath); | ||
| } | ||
|
|
||
| public ForStPathContainer( | ||
| @Nullable Path localJobPath, | ||
| @Nullable Path localBasePath, | ||
| @Nullable Path remoteJobPath, | ||
| @Nullable Path remoteBasePath) { | ||
| this.localJobPath = localJobPath; | ||
| this.localBasePath = localBasePath; | ||
| this.localForStPath = localBasePath != null ? new Path(localBasePath, DB_DIR_STRING) : null; | ||
|
There was a problem hiding this comment. we have localJobPath, localBasePath and localForStPath which is derived from localBasePath. I was expecting localJobpath to be a subfolder of localBasePath, is this true? Is this the bean to validate that? I see localBasePath can be null, in this case localForStPath is set to null, but localJobPath can have a value. What does this mean? The code indicates that it is possible to run without Forst but have a . Have I understood this correctly? There was a problem hiding this comment. Yes, localJobpath is a subfolder of localBasePath.
|
||
|
|
||
| this.remoteJobPath = remoteJobPath; | ||
| this.remoteBasePath = remoteBasePath; | ||
| this.remoteForStPath = | ||
| remoteBasePath != null ? new Path(remoteBasePath, DB_DIR_STRING) : null; | ||
|
|
||
| LOG.info( | ||
| "ForStPathContainer: localJobPath: {}, localBasePath: {}, localForStPath:{}, remoteJobPath: {}, remoteBasePath: {}, remoteForStPath: {}", | ||
| localJobPath, | ||
| localBasePath, | ||
| localForStPath, | ||
| remoteJobPath, | ||
| remoteBasePath, | ||
| remoteForStPath); | ||
| } | ||
|
|
||
| public @Nullable Path getLocalJobPath() { | ||
| return localJobPath; | ||
| } | ||
|
|
||
| public @Nullable Path getLocalBasePath() { | ||
| return localBasePath; | ||
| } | ||
|
|
||
| public @Nullable Path getLocalForStPath() { | ||
| return localForStPath; | ||
| } | ||
|
|
||
| public @Nullable Path getRemoteJobPath() { | ||
| return remoteJobPath; | ||
| } | ||
|
|
||
| public @Nullable Path getRemoteBasePath() { | ||
| return remoteBasePath; | ||
| } | ||
|
|
||
| public @Nullable Path getRemoteForStPath() { | ||
| return remoteForStPath; | ||
| } | ||
|
|
||
| public Path getJobPath() { | ||
| if (remoteJobPath != null) { | ||
| return remoteJobPath; | ||
| } else { | ||
| return localJobPath; | ||
| } | ||
| } | ||
|
|
||
| public Path getBasePath() { | ||
| if (remoteBasePath != null) { | ||
| return remoteBasePath; | ||
| } else { | ||
| return localBasePath; | ||
| } | ||
| } | ||
|
|
||
| public Path getDbPath() { | ||
| if (remoteForStPath != null) { | ||
| return remoteForStPath; | ||
| } else { | ||
| return localForStPath; | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| public String toString() { | ||
AlexYinHan marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| return "ForStPathContainer(localJobPath = [" | ||
| + localJobPath | ||
| + "] localBasePath = [" | ||
| + localBasePath | ||
| + "] localForStPath = [" | ||
| + localForStPath | ||
| + "] remoteJobPath = [" | ||
| + remoteJobPath | ||
| + "] remoteBasePath = [" | ||
| + remoteBasePath | ||
| + "] remoteForStPath = [" | ||
| + remoteForStPath | ||
| + "])"; | ||
| } | ||
|
|
||
| @Override | ||
| public boolean equals(Object o) { | ||
| if (this == o) { | ||
| return true; | ||
| } | ||
| if (o == null || getClass() != o.getClass()) { | ||
| return false; | ||
| } | ||
| ForStPathContainer that = (ForStPathContainer) o; | ||
| return Objects.equals(localJobPath, that.localJobPath) | ||
| && Objects.equals(localBasePath, that.localBasePath) | ||
| && Objects.equals(localForStPath, that.localForStPath) | ||
| && Objects.equals(remoteJobPath, that.remoteJobPath) | ||
| && Objects.equals(remoteBasePath, that.remoteBasePath) | ||
| && Objects.equals(remoteForStPath, that.remoteForStPath); | ||
| } | ||
|
|
||
| @Override | ||
| public int hashCode() { | ||
| return Objects.hash( | ||
| localJobPath, | ||
| localBasePath, | ||
| localForStPath, | ||
| remoteJobPath, | ||
| remoteBasePath, | ||
| remoteForStPath); | ||
| } | ||
| } | ||
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.
is optionsContainer.getPathContainer() ever null?
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.
No. pathContainer is final and it should never be null