This repository has been archived by the owner on Nov 14, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 15
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Revert "Revert "Clock went backwards corruption check (#5131)" (#5181)" This reverts commit 7f6c373. * Timestamps dont have to be strictly increasing * Add test * Add generated changelog entries
- Loading branch information
1 parent
76e85f0
commit 00eb359
Showing
9 changed files
with
320 additions
and
11 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| type: improvement | ||
| improvement: | ||
| description: TimeLock now validates the expected invariant for its timestamp bounds | ||
| i.e. the timestamp bound must not decrease with increasing sequence numbers. | ||
| links: | ||
| - https://github.com/palantir/atlasdb/pull/5182 |
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
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
129 changes: 129 additions & 0 deletions
129
...ain/java/com/palantir/timelock/corruption/detection/LocalTimestampInvariantsVerifier.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,129 @@ | ||
| /* | ||
| * (c) Copyright 2020 Palantir Technologies Inc. All rights reserved. | ||
| * | ||
| * 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.palantir.timelock.corruption.detection; | ||
|
|
||
| import com.google.common.annotations.VisibleForTesting; | ||
| import com.google.common.collect.Maps; | ||
| import com.google.common.collect.SetMultimap; | ||
| import com.palantir.atlasdb.encoding.PtBytes; | ||
| import com.palantir.common.streams.KeyedStream; | ||
| import com.palantir.paxos.ImmutableNamespaceAndUseCase; | ||
| import com.palantir.paxos.NamespaceAndUseCase; | ||
| import com.palantir.paxos.PaxosValue; | ||
| import com.palantir.timelock.history.models.LearnerUseCase; | ||
| import com.palantir.timelock.history.sqlite.SqlitePaxosStateLogHistory; | ||
| import com.palantir.timelock.history.util.UseCaseUtils; | ||
| import java.util.Collections; | ||
| import java.util.Comparator; | ||
| import java.util.Map; | ||
| import java.util.Objects; | ||
| import java.util.Set; | ||
| import java.util.concurrent.ConcurrentHashMap; | ||
| import java.util.stream.Collectors; | ||
| import java.util.stream.Stream; | ||
| import javax.sql.DataSource; | ||
| import one.util.streamex.StreamEx; | ||
|
|
||
| /** | ||
| * This class validates that timestamp bounds increase with increasing sequence numbers. | ||
| * | ||
| * The validation is done batch wise, e.g. [1, n], [n, 2 * n - 1] and so on. Two consecutive batches share | ||
| * boundaries, this is expected and is done to catch inversion at batch end. | ||
| * */ | ||
| public class LocalTimestampInvariantsVerifier { | ||
| @VisibleForTesting | ||
| public static final int LEARNER_LOG_BATCH_SIZE_LIMIT = 250; | ||
|
|
||
| public static final long MIN_SEQUENCE_TO_BE_VERIFIED = Long.MIN_VALUE; | ||
|
|
||
| private final SqlitePaxosStateLogHistory sqlitePaxosStateLogHistory; | ||
| private Map<NamespaceAndUseCase, Long> minInclusiveSeqBoundsToBeVerified = new ConcurrentHashMap<>(); | ||
|
|
||
| public LocalTimestampInvariantsVerifier(DataSource dataSource) { | ||
| this.sqlitePaxosStateLogHistory = SqlitePaxosStateLogHistory.create(dataSource); | ||
| } | ||
|
|
||
| public CorruptionHealthReport timestampInvariantsHealthReport() { | ||
| SetMultimap<CorruptionCheckViolation, NamespaceAndUseCase> namespacesExhibitingViolations = KeyedStream.of( | ||
| getNamespaceAndUseCaseTuples()) | ||
| .map(this::timestampInvariantsViolationLevel) | ||
| .filter(CorruptionCheckViolation::raiseErrorAlert) | ||
| .mapEntries((k, v) -> Maps.immutableEntry(v, k)) | ||
| .collectToSetMultimap(); | ||
| return ImmutableCorruptionHealthReport.builder() | ||
| .violatingStatusesToNamespaceAndUseCase(namespacesExhibitingViolations) | ||
| .build(); | ||
| } | ||
|
|
||
| private CorruptionCheckViolation timestampInvariantsViolationLevel(NamespaceAndUseCase namespaceAndUseCase) { | ||
| Stream<Long> expectedSortedTimestamps = KeyedStream.stream(getLearnerLogs(namespaceAndUseCase)) | ||
| .map(PaxosValue::getData) | ||
| .filter(Objects::nonNull) | ||
| .mapEntries((sequence, timestamp) -> Maps.immutableEntry(sequence, PtBytes.toLong(timestamp))) | ||
| .entries() | ||
| .sorted(Comparator.comparingLong(Map.Entry::getKey)) | ||
| .map(Map.Entry::getValue); | ||
| return StreamEx.of(expectedSortedTimestamps) | ||
| .pairMap((first, second) -> first > second) | ||
| .anyMatch(x -> x) | ||
| ? CorruptionCheckViolation.CLOCK_WENT_BACKWARDS | ||
| : CorruptionCheckViolation.NONE; | ||
| } | ||
|
|
||
| private Map<Long, PaxosValue> getLearnerLogs(NamespaceAndUseCase namespaceAndUseCase) { | ||
| long minSeqToBeVerified = getMinSeqToBeVerified(namespaceAndUseCase); | ||
| LearnerUseCase useCase = LearnerUseCase.createLearnerUseCase(namespaceAndUseCase.useCase()); | ||
|
|
||
| Map<Long, PaxosValue> learnerLogsSince = sqlitePaxosStateLogHistory.getLearnerLogsSince( | ||
| namespaceAndUseCase.namespace(), useCase, minSeqToBeVerified, LEARNER_LOG_BATCH_SIZE_LIMIT); | ||
|
|
||
| if (notEnoughLogsForVerification(learnerLogsSince)) { | ||
| resetMinSequenceToBeVerified(namespaceAndUseCase); | ||
| } else { | ||
| updateMinSeqToBeVerified(namespaceAndUseCase, learnerLogsSince); | ||
| } | ||
| return learnerLogsSince; | ||
| } | ||
|
|
||
| private boolean notEnoughLogsForVerification(Map<Long, PaxosValue> learnerLogsSince) { | ||
| return learnerLogsSince.size() <= 1; | ||
| } | ||
|
|
||
| private void updateMinSeqToBeVerified(NamespaceAndUseCase namespaceAndUseCase, Map<Long, PaxosValue> minSeq) { | ||
| minInclusiveSeqBoundsToBeVerified.put(namespaceAndUseCase, Collections.max(minSeq.keySet())); | ||
| } | ||
|
|
||
| private long getMinSeqToBeVerified(NamespaceAndUseCase namespaceAndUseCase) { | ||
| return minInclusiveSeqBoundsToBeVerified.computeIfAbsent( | ||
| namespaceAndUseCase, _u -> MIN_SEQUENCE_TO_BE_VERIFIED); | ||
| } | ||
|
|
||
| private void resetMinSequenceToBeVerified(NamespaceAndUseCase namespaceAndUseCase) { | ||
| minInclusiveSeqBoundsToBeVerified.put(namespaceAndUseCase, MIN_SEQUENCE_TO_BE_VERIFIED); | ||
| } | ||
|
|
||
| private ImmutableNamespaceAndUseCase getNamespaceAndUseCasePrefix(NamespaceAndUseCase namespaceAndUseCase) { | ||
| return ImmutableNamespaceAndUseCase.of( | ||
| namespaceAndUseCase.namespace(), UseCaseUtils.getPaxosUseCasePrefix(namespaceAndUseCase.useCase())); | ||
| } | ||
|
|
||
| private Set<NamespaceAndUseCase> getNamespaceAndUseCaseTuples() { | ||
| return sqlitePaxosStateLogHistory.getAllNamespaceAndUseCaseTuples().stream() | ||
| .map(this::getNamespaceAndUseCasePrefix) | ||
| .collect(Collectors.toSet()); | ||
| } | ||
| } |
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
117 changes: 117 additions & 0 deletions
117
...java/com/palantir/timelock/corruption/detection/LocalTimestampInvariantsVerifierTest.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,117 @@ | ||
| /* | ||
| * (c) Copyright 2020 Palantir Technologies Inc. All rights reserved. | ||
| * | ||
| * 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.palantir.timelock.corruption.detection; | ||
|
|
||
| import static com.palantir.timelock.corruption.detection.LocalTimestampInvariantsVerifier.LEARNER_LOG_BATCH_SIZE_LIMIT; | ||
|
|
||
| import com.palantir.timelock.corruption.detection.TimeLockCorruptionTestSetup.StateLogComponents; | ||
| import com.palantir.timelock.history.utils.PaxosSerializationTestUtils; | ||
| import java.util.stream.IntStream; | ||
| import org.junit.Rule; | ||
| import org.junit.Test; | ||
|
|
||
| public class LocalTimestampInvariantsVerifierTest { | ||
| @Rule | ||
| public TimeLockCorruptionDetectionHelper helper = new TimeLockCorruptionDetectionHelper(); | ||
|
|
||
| @Test | ||
| public void isHealthyIfTimestampsAreIncreasing() { | ||
| // write increasing timestamp values in range [1, LEARNER_LOG_BATCH_SIZE_LIMIT - 1] | ||
| helper.writeLogsOnDefaultLocalServer(1, LEARNER_LOG_BATCH_SIZE_LIMIT - 1); | ||
| helper.assertLocalTimestampInvariantsStandInNextBatch(); | ||
| } | ||
|
|
||
| @Test | ||
| public void isHealthyIfTimestampsAreNonDecreasing() { | ||
| StateLogComponents localServer = helper.getDefaultLocalServer(); | ||
| // write a constant timestamp value in range [1, LEARNER_LOG_BATCH_SIZE_LIMIT - 1] | ||
| IntStream.rangeClosed(1, LEARNER_LOG_BATCH_SIZE_LIMIT - 1) | ||
| .boxed() | ||
| .forEach(round -> PaxosSerializationTestUtils.writePaxosValue( | ||
| localServer.learnerLog(), | ||
| round, | ||
| PaxosSerializationTestUtils.createPaxosValueForRoundAndData(round, 5))); | ||
| helper.assertLocalTimestampInvariantsStandInNextBatch(); | ||
| } | ||
|
|
||
| @Test | ||
| public void detectsClockWentBackwardsOnNode() { | ||
| helper.writeLogsOnDefaultLocalServer(1, LEARNER_LOG_BATCH_SIZE_LIMIT - 1); | ||
| helper.createTimestampInversion(5); | ||
| helper.assertClockGoesBackwardsInNextBatch(); | ||
| } | ||
|
|
||
| @Test | ||
| public void detectsClockWentBackwardsForDiscontinuousLogs() { | ||
| helper.writeLogsOnDefaultLocalServer(1, 27); | ||
| helper.writeLogsOnDefaultLocalServer(LEARNER_LOG_BATCH_SIZE_LIMIT, LEARNER_LOG_BATCH_SIZE_LIMIT + 97); | ||
|
|
||
| helper.createTimestampInversion(72); | ||
| helper.assertClockGoesBackwardsInNextBatch(); | ||
| } | ||
|
|
||
| @Test | ||
| public void detectsClockWentBackwardsAtBatchStart() { | ||
| helper.writeLogsOnDefaultLocalServer(1, LEARNER_LOG_BATCH_SIZE_LIMIT); | ||
| helper.createTimestampInversion(1); | ||
| helper.assertClockGoesBackwardsInNextBatch(); | ||
| } | ||
|
|
||
| @Test | ||
| public void detectsClockWentBackwardsAtBatchEnd() { | ||
| helper.writeLogsOnDefaultLocalServer(1, LEARNER_LOG_BATCH_SIZE_LIMIT); | ||
| helper.createTimestampInversion(LEARNER_LOG_BATCH_SIZE_LIMIT - 1); | ||
| helper.assertClockGoesBackwardsInNextBatch(); | ||
| } | ||
|
|
||
| @Test | ||
| public void detectsClockWentBackwardsStartOfNextBatch() { | ||
| helper.writeLogsOnDefaultLocalServer(1, 2 * LEARNER_LOG_BATCH_SIZE_LIMIT); | ||
| helper.createTimestampInversion(LEARNER_LOG_BATCH_SIZE_LIMIT); | ||
|
|
||
| // No signs of corruption in the first batch | ||
| helper.assertLocalTimestampInvariantsStandInNextBatch(); | ||
|
|
||
| // Detects signs of corruption in the second batch | ||
| helper.assertClockGoesBackwardsInNextBatch(); | ||
| } | ||
|
|
||
| @Test | ||
| public void detectsClockWentBackwardsInLaterBatch() { | ||
| helper.writeLogsOnDefaultLocalAndRemote(1, 2 * LEARNER_LOG_BATCH_SIZE_LIMIT); | ||
| helper.createTimestampInversion(3 * LEARNER_LOG_BATCH_SIZE_LIMIT / 2); | ||
|
|
||
| // No signs of corruption in the first batch | ||
| helper.assertLocalTimestampInvariantsStandInNextBatch(); | ||
|
|
||
| // Detects signs of corruption in the second batch | ||
| helper.assertClockGoesBackwardsInNextBatch(); | ||
| } | ||
|
|
||
| @Test | ||
| public void resetsProgressIfNotEnoughLogsForVerification() { | ||
| helper.createTimestampInversion(1); | ||
|
|
||
| // No signs of corruption since there aren't enough logs | ||
| helper.assertLocalTimestampInvariantsStandInNextBatch(); | ||
|
|
||
| helper.writeLogsOnDefaultLocalServer(2, LEARNER_LOG_BATCH_SIZE_LIMIT); | ||
|
|
||
| // Detects signs of corruption in the now corrupt first batch of logs | ||
| helper.assertClockGoesBackwardsInNextBatch(); | ||
| } | ||
| } |
Oops, something went wrong.