forked from FoundationDB/fdb-record-layer
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Resolve FoundationDB#2984: Associate index scrubbing with index maint…
…ainers Create a generic index scrubbing, uses specific index maintainer tools. Step 1: Support scrubbing missing index entrie by index maitainer
- Loading branch information
Showing
10 changed files
with
506 additions
and
7 deletions.
There are no files selected for viewing
This file contains 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 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
222 changes: 222 additions & 0 deletions
222
...ore/src/main/java/com/apple/foundationdb/record/provider/foundationdb/IndexScrubbing.java
This file contains 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,222 @@ | ||
| /* | ||
| * IndexScrubbing.java | ||
| * | ||
| * This source file is part of the FoundationDB open source project | ||
| * | ||
| * Copyright 2015-2024 Apple Inc. and the FoundationDB project authors | ||
| * | ||
| * Licensed 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 com.apple.foundationdb.record.provider.foundationdb; | ||
|
|
||
| import com.apple.foundationdb.annotation.API; | ||
| import com.apple.foundationdb.async.AsyncUtil; | ||
| import com.apple.foundationdb.async.RangeSet; | ||
| import com.apple.foundationdb.record.IndexBuildProto; | ||
| import com.apple.foundationdb.record.IndexState; | ||
| import com.apple.foundationdb.record.RecordCursor; | ||
| import com.apple.foundationdb.record.RecordCursorResult; | ||
| import com.apple.foundationdb.record.RecordMetaData; | ||
| import com.apple.foundationdb.record.RecordMetaDataProvider; | ||
| import com.apple.foundationdb.record.TupleRange; | ||
| import com.apple.foundationdb.record.logging.LogMessageKeys; | ||
| import com.apple.foundationdb.record.metadata.Index; | ||
| import com.apple.foundationdb.record.metadata.MetaDataException; | ||
| import com.apple.foundationdb.record.provider.foundationdb.indexing.IndexingRangeSet; | ||
| import com.apple.foundationdb.subspace.Subspace; | ||
| import com.apple.foundationdb.tuple.Tuple; | ||
| import com.google.protobuf.Message; | ||
| import org.slf4j.Logger; | ||
| import org.slf4j.LoggerFactory; | ||
|
|
||
| import javax.annotation.Nonnull; | ||
| import java.util.Arrays; | ||
| import java.util.LinkedList; | ||
| import java.util.List; | ||
| import java.util.concurrent.CompletableFuture; | ||
| import java.util.concurrent.atomic.AtomicBoolean; | ||
| import java.util.concurrent.atomic.AtomicLong; | ||
| import java.util.concurrent.atomic.AtomicReference; | ||
|
|
||
| /** | ||
| * Manifesto: | ||
| * Scrub a readable index to validate its consistency. Repair when needed. | ||
| * This general scrubber will use index maintainer to get specific index scrubbing functionality. | ||
| */ | ||
| @API(API.Status.INTERNAL) | ||
| public class IndexScrubbing extends IndexingBase { | ||
| @Nonnull | ||
| private static final Logger LOGGER = LoggerFactory.getLogger(IndexScrubbing.class); | ||
| @Nonnull private static final IndexBuildProto.IndexBuildIndexingStamp myIndexingTypeStamp = compileIndexingTypeStamp(); | ||
|
|
||
| @Nonnull private final OnlineIndexScrubber.ScrubbingPolicy scrubbingPolicy; | ||
| @Nonnull private final AtomicLong issueCounter; | ||
| private long scanCounter = 0; | ||
| private int logWarningCounter; | ||
| private final IndexScrubbingTools.ScrubbingType scrubbingType; | ||
|
|
||
| public IndexScrubbing(@Nonnull final IndexingCommon common, | ||
| @Nonnull final OnlineIndexer.IndexingPolicy policy, | ||
| @Nonnull final OnlineIndexScrubber.ScrubbingPolicy scrubbingPolicy, | ||
| @Nonnull final AtomicLong issueCounter, | ||
| IndexScrubbingTools.ScrubbingType scrubbingType) { | ||
| super(common, policy, true); | ||
| this.scrubbingPolicy = scrubbingPolicy; | ||
| this.logWarningCounter = scrubbingPolicy.getLogWarningsLimit(); | ||
| this.issueCounter = issueCounter; | ||
| this.scrubbingType = scrubbingType; | ||
| } | ||
|
|
||
| @Override | ||
| List<Object> indexingLogMessageKeyValues() { | ||
| return Arrays.asList( | ||
| LogMessageKeys.INDEXING_METHOD, "index scrub " + scrubbingType, | ||
| LogMessageKeys.ALLOW_REPAIR, scrubbingPolicy.allowRepair(), | ||
| LogMessageKeys.LIMIT, scrubbingPolicy.getEntriesScanLimit() | ||
| ); | ||
| } | ||
|
|
||
| @Nonnull | ||
| @Override | ||
| IndexBuildProto.IndexBuildIndexingStamp getIndexingTypeStamp(final FDBRecordStore store) { | ||
| return myIndexingTypeStamp; | ||
| } | ||
|
|
||
| @Nonnull | ||
| static IndexBuildProto.IndexBuildIndexingStamp compileIndexingTypeStamp() { | ||
| return | ||
| IndexBuildProto.IndexBuildIndexingStamp.newBuilder() | ||
| .setMethod(IndexBuildProto.IndexBuildIndexingStamp.Method.SCRUB_REPAIR) | ||
| .build(); | ||
| } | ||
|
|
||
| @Override | ||
| CompletableFuture<Void> buildIndexInternalAsync() { | ||
| return getRunner().runAsync(context -> | ||
| context.getReadVersionAsync() | ||
| .thenCompose(vignore -> { | ||
| SubspaceProvider subspaceProvider = common.getRecordStoreBuilder().getSubspaceProvider(); | ||
| return subspaceProvider.getSubspaceAsync(context) | ||
| .thenCompose(subspace -> | ||
| indexScrub(subspaceProvider, subspace)); | ||
| }), | ||
| common.indexLogMessageKeyValues("IndexScrubbing::buildIndexInternalAsync")); | ||
| } | ||
|
|
||
| @Nonnull | ||
| private CompletableFuture<Void> indexScrub(@Nonnull SubspaceProvider subspaceProvider, @Nonnull Subspace subspace) { | ||
|
|
||
| final List<Object> additionalLogMessageKeyValues = Arrays.asList(LogMessageKeys.CALLING_METHOD, "indexScrub"); | ||
|
|
||
| return iterateAllRanges(additionalLogMessageKeyValues, | ||
| this::indexScrubRangeOnly, | ||
| subspaceProvider, subspace); | ||
| } | ||
|
|
||
| @Nonnull | ||
| private CompletableFuture<Boolean> indexScrubRangeOnly(@Nonnull FDBRecordStore store, @Nonnull AtomicLong recordsScanned) { | ||
| // return false when done | ||
| Index index = common.getIndex(); | ||
| final RecordMetaData metaData = store.getRecordMetaData(); | ||
| final RecordMetaDataProvider recordMetaDataProvider = common.getRecordStoreBuilder().getMetaDataProvider(); | ||
| if (recordMetaDataProvider == null || !metaData.equals(recordMetaDataProvider.getRecordMetaData())) { | ||
| throw new MetaDataException("Store does not have the same metadata"); | ||
| } | ||
| final IndexMaintainer maintainer = store.getIndexMaintainer(index); | ||
| final IndexScrubbingTools<?> tools = maintainer.getIndexScrubbingTools(scrubbingType); | ||
| final boolean isIdempotent = maintainer.isIdempotent(); | ||
| if (tools == null) { | ||
| throw new UnsupportedOperationException("This index does not support scrubbing type " + scrubbingType); | ||
| } | ||
|
|
||
| return indexScrubRangeOnly(store, recordsScanned, index, tools, isIdempotent); | ||
| } | ||
|
|
||
| private <T> CompletableFuture<Boolean> indexScrubRangeOnly(final @Nonnull FDBRecordStore store, final @Nonnull AtomicLong recordsScanned, final Index index, final IndexScrubbingTools<T> tools, boolean isIdempotent) { | ||
| // scrubbing only readable | ||
| validateOrThrowEx(store.getIndexState(index) == IndexState.READABLE, "scrubbed index is not readable"); | ||
|
|
||
| final IndexingRangeSet rangeSet = IndexingRangeSet.forScrubbingRecords(store, index); | ||
| tools.setParams(index, scrubbingPolicy.allowRepair(), common.getIndexContext().isSynthetic, common.getAllRecordTypes()); | ||
|
|
||
| return rangeSet.firstMissingRangeAsync().thenCompose(range -> { | ||
| if (range == null) { | ||
| // Here: no more missing ranges - all done | ||
| // To avoid stale metadata, we'll keep the scrubbed-ranges indicator empty until the next scrub call. | ||
| rangeSet.clear(); | ||
| return AsyncUtil.READY_FALSE; | ||
| } | ||
| final Tuple rangeStart = RangeSet.isFirstKey(range.begin) ? null : Tuple.fromBytes(range.begin); | ||
| final Tuple rangeEnd = RangeSet.isFinalKey(range.end) ? null : Tuple.fromBytes(range.end); | ||
| final TupleRange tupleRange = TupleRange.between(rangeStart, rangeEnd); | ||
|
|
||
| final RecordCursor<T> cursor = tools.getIterator(tupleRange, store, getLimit() + 1); | ||
| final AtomicBoolean hasMore = new AtomicBoolean(true); | ||
| final AtomicReference<RecordCursorResult<T>> lastResult = new AtomicReference<>(RecordCursorResult.exhausted()); | ||
| final long scanLimit = scrubbingPolicy.getEntriesScanLimit(); | ||
| List<IndexScrubbingTools.Issue> issueList = new LinkedList<>(); | ||
|
|
||
| return iterateRangeOnly(store, cursor, (recordStore, result) -> handleOneItem(recordStore, result, tools, issueList), | ||
| lastResult, hasMore, recordsScanned, isIdempotent) | ||
| .thenApply(vignore -> hasMore.get() ? tools.getContinuation(lastResult.get()) : | ||
| rangeEnd) | ||
| .thenCompose(cont -> rangeSet.insertRangeAsync(packOrNull(rangeStart), packOrNull(cont), true) | ||
| .thenApply(ignore -> { | ||
| reportIssues(issueList); | ||
| if (scanLimit > 0) { | ||
| scanCounter += recordsScanned.get(); | ||
| if (scanLimit <= scanCounter) { | ||
| return false; | ||
| } | ||
| } | ||
| return notAllRangesExhausted(cont, rangeEnd); | ||
| })); | ||
| }); | ||
| } | ||
|
|
||
|
|
||
| private <T> CompletableFuture<FDBStoredRecord<Message>> handleOneItem(FDBRecordStore store, final RecordCursorResult<T> result, final IndexScrubbingTools<T> tools, List<IndexScrubbingTools.Issue> issueList) { | ||
| return tools.handleOneItem(store, | ||
| store.getIndexMaintainer(common.getIndex()).state.transaction, | ||
| result) | ||
| .thenApply(issue -> { | ||
| if (issue == null) { | ||
| return null; | ||
| } | ||
| issueList.add(issue); | ||
| return issue.recordToIndex; | ||
| }); | ||
| } | ||
|
|
||
| private void reportIssues(List<IndexScrubbingTools.Issue> issueList) { | ||
| // report these issues only after their transaction was completed successfully | ||
| for (IndexScrubbingTools.Issue issue: issueList) { | ||
| issueCounter.incrementAndGet(); | ||
| if (issue.logMessage != null && LOGGER.isWarnEnabled() && logWarningCounter > 0) { | ||
| logWarningCounter --; | ||
| LOGGER.warn(issue.logMessage | ||
| .addKeysAndValues(common.indexLogMessageKeyValues()) | ||
| .toString()); | ||
| } | ||
| if (issue.timerCounter != null) { | ||
| timerIncrement(issue.timerCounter); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| CompletableFuture<Void> rebuildIndexInternalAsync(final FDBRecordStore store) { | ||
| throw new UnsupportedOperationException(); | ||
| } | ||
| } |
76 changes: 76 additions & 0 deletions
76
...rc/main/java/com/apple/foundationdb/record/provider/foundationdb/IndexScrubbingTools.java
This file contains 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,76 @@ | ||
| /* | ||
| * IndexScrubbingTools.java | ||
| * | ||
| * This source file is part of the FoundationDB open source project | ||
| * | ||
| * Copyright 2015-2024 Apple Inc. and the FoundationDB project authors | ||
| * | ||
| * Licensed 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 com.apple.foundationdb.record.provider.foundationdb; | ||
|
|
||
| import com.apple.foundationdb.Transaction; | ||
| import com.apple.foundationdb.record.RecordCursor; | ||
| import com.apple.foundationdb.record.RecordCursorResult; | ||
| import com.apple.foundationdb.record.TupleRange; | ||
| import com.apple.foundationdb.record.logging.KeyValueLogMessage; | ||
| import com.apple.foundationdb.record.metadata.Index; | ||
| import com.apple.foundationdb.record.metadata.RecordType; | ||
| import com.apple.foundationdb.tuple.Tuple; | ||
| import com.google.protobuf.Message; | ||
|
|
||
| import java.util.Collection; | ||
| import java.util.concurrent.CompletableFuture; | ||
|
|
||
| /** | ||
| * Index Scrubbing Toolbox for a specific index maintainer. | ||
| * @param <T> the iteration type | ||
| */ | ||
| public interface IndexScrubbingTools<T> { | ||
|
|
||
| /** | ||
| * The specific type of scrubbing. | ||
| */ | ||
| enum ScrubbingType { | ||
| DANGLING, | ||
| MISSING | ||
| } | ||
|
|
||
| /** | ||
| * A single issue reported by {@link #handleOneItem}. | ||
| */ | ||
| class Issue { | ||
| final KeyValueLogMessage logMessage; | ||
| final FDBStoreTimer.Counts timerCounter; | ||
| final FDBStoredRecord<Message> recordToIndex; | ||
|
|
||
| public Issue(final KeyValueLogMessage logMessage, final FDBStoreTimer.Counts timerCounter, final FDBStoredRecord<Message> recordToIndex) { | ||
| this.logMessage = logMessage; | ||
| this.timerCounter = timerCounter; | ||
| this.recordToIndex = recordToIndex; | ||
| } | ||
| } | ||
|
|
||
| String getName(); | ||
|
|
||
| RecordCursor<T> getIterator(TupleRange range, FDBRecordStore store, int limit); | ||
|
|
||
| Tuple getContinuation(RecordCursorResult<T> result); | ||
|
|
||
| CompletableFuture<Issue> handleOneItem(FDBRecordStore store, Transaction transaction, RecordCursorResult<T> result); | ||
|
|
||
| default void setParams(Index index, boolean allowRepair, boolean isSynthetic, Collection<RecordType> types) { | ||
| // no-op | ||
| } | ||
| } |
This file contains 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 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
Oops, something went wrong.