jetbrains.exodus.env.ReadWriteTransaction Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of sonarlint-core Show documentation
Show all versions of sonarlint-core Show documentation
Common library used by some SonarLint flavors
/**
* Copyright 2010 - 2022 JetBrains s.r.o.
*
* 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
*
* https://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 jetbrains.exodus.env;
import jetbrains.exodus.ExodusException;
import jetbrains.exodus.core.dataStructures.Pair;
import jetbrains.exodus.core.dataStructures.decorators.HashMapDecorator;
import jetbrains.exodus.core.dataStructures.hash.LongHashMap;
import jetbrains.exodus.tree.ExpiredLoggableCollection;
import jetbrains.exodus.tree.ITree;
import jetbrains.exodus.tree.ITreeMutable;
import jetbrains.exodus.tree.TreeMetaInfo;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import java.util.*;
public class ReadWriteTransaction extends TransactionBase {
@NotNull
private final Map mutableTrees;
@NotNull
private final LongHashMap> removedStores;
@NotNull
private final Map createdStores;
@Nullable
private final Runnable beginHook;
@Nullable
private Runnable commitHook;
private int replayCount;
private int acquiredPermits;
ReadWriteTransaction(@NotNull final EnvironmentImpl env,
@Nullable final Runnable beginHook,
final boolean isExclusive,
final boolean cloneMeta) {
super(env, isExclusive);
mutableTrees = new TreeMap<>();
removedStores = new LongHashMap<>();
createdStores = new HashMapDecorator<>();
this.beginHook = () -> {
final MetaTreeImpl currentMetaTree = env.getMetaTreeInternal();
setMetaTree(cloneMeta ? currentMetaTree.getClone() : currentMetaTree);
env.registerTransaction(ReadWriteTransaction.this);
if (beginHook != null) {
beginHook.run();
}
};
replayCount = 0;
setExclusive(isExclusive() | env.shouldTransactionBeExclusive(this));
env.holdNewestSnapshotBy(this);
}
ReadWriteTransaction(@NotNull final TransactionBase origin, @Nullable final Runnable beginHook) {
super(origin.getEnvironment(), false);
mutableTrees = new TreeMap<>();
removedStores = new LongHashMap<>();
createdStores = new HashMapDecorator<>();
final EnvironmentImpl env = getEnvironment();
this.beginHook = getWrappedBeginHook(beginHook);
replayCount = 0;
setMetaTree(origin.getMetaTree());
setExclusive(env.shouldTransactionBeExclusive(this));
env.acquireTransaction(this);
env.registerTransaction(this);
}
public boolean isIdempotent() {
return mutableTrees.isEmpty() && removedStores.isEmpty() && createdStores.isEmpty();
}
@Override
public void abort() {
checkIsFinished();
clearImmutableTrees();
doRevert();
getEnvironment().finishTransaction(this);
}
@Override
public boolean commit() {
checkIsFinished();
return getEnvironment().commitTransaction(this);
}
@Override
public boolean flush() {
checkIsFinished();
final EnvironmentImpl env = getEnvironment();
final boolean result = env.flushTransaction(this, false);
if (result) {
// if the transaction was upgraded to exclusive during re-playing
// then it should be downgraded back after successful flush().
if (!wasCreatedExclusive() && isExclusive() && env.getEnvironmentConfig().getEnvTxnDowngradeAfterFlush()) {
env.downgradeTransaction(this);
setExclusive(false);
}
setStarted(System.currentTimeMillis());
} else {
incReplayCount();
}
return result;
}
@Override
public void revert() {
checkIsFinished();
if (isReadonly()) {
throw new ExodusException("Attempt to revert read-only transaction");
}
final long oldRoot = getMetaTree().root;
final boolean wasExclusive = isExclusive();
final EnvironmentImpl env = getEnvironment();
if (isIdempotent()) {
env.holdNewestSnapshotBy(this, false);
} else {
doRevert();
if (wasExclusive || !env.shouldTransactionBeExclusive(this)) {
env.holdNewestSnapshotBy(this, false);
} else {
env.releaseTransaction(this);
setExclusive(true);
env.holdNewestSnapshotBy(this);
}
}
if (!env.isRegistered(this)) {
throw new ExodusException("Transaction should remain registered after revert");
}
if (!checkVersion(oldRoot)) {
clearImmutableTrees();
env.runTransactionSafeTasks();
}
setStarted(System.currentTimeMillis());
}
@Override
public void setCommitHook(@Nullable final Runnable hook) {
commitHook = hook;
}
@Override
public boolean isReadonly() {
return false;
}
public boolean forceFlush() {
checkIsFinished();
return getEnvironment().flushTransaction(this, true);
}
@NotNull
public StoreImpl openStoreByStructureId(final int structureId) {
checkIsFinished();
final EnvironmentImpl env = getEnvironment();
final String storeName = getMetaTree().getStoreNameByStructureId(structureId, env);
return storeName == null ?
new TemporaryEmptyStore(env) :
env.openStoreImpl(storeName, StoreConfig.USE_EXISTING, this, getTreeMetaInfo(storeName));
}
@NotNull
@Override
public ITree getTree(@NotNull final StoreImpl store) {
checkIsFinished();
final ITreeMutable result = mutableTrees.get(store.getStructureId());
if (result == null) {
return super.getTree(store);
}
return result;
}
@Nullable
@Override
TreeMetaInfo getTreeMetaInfo(@NotNull final String name) {
checkIsFinished();
final TreeMetaInfo result = createdStores.get(name);
return result == null ? super.getTreeMetaInfo(name) : result;
}
void storeRemoved(@NotNull final StoreImpl store) {
checkIsFinished();
super.storeRemoved(store);
final int structureId = store.getStructureId();
final ITree tree = store.openImmutableTree(getMetaTree());
removedStores.put(structureId, new Pair<>(store.getName(), tree));
mutableTrees.remove(structureId);
}
void storeOpened(@NotNull final StoreImpl store) {
removedStores.remove(store.getStructureId());
}
void storeCreated(@NotNull final StoreImpl store) {
getMutableTree(store);
createdStores.put(store.getName(), store.getMetaInfo());
}
int getReplayCount() {
return replayCount;
}
void incReplayCount() {
++replayCount;
}
int getAcquiredPermits() {
return acquiredPermits;
}
void setAcquiredPermits(final int acquiredPermits) {
this.acquiredPermits = acquiredPermits;
}
boolean isStoreNew(@NotNull final String name) {
return createdStores.containsKey(name);
}
ExpiredLoggableCollection doCommit(@NotNull final MetaTreeImpl.Proto[] out) {
final Set> entries = mutableTrees.entrySet();
final Set>> removedEntries = removedStores.entrySet();
ExpiredLoggableCollection expiredLoggables = ExpiredLoggableCollection.getEMPTY();
final ITreeMutable metaTreeMutable = getMetaTree().tree.getMutableCopy();
for (final Map.Entry> entry : removedEntries) {
final Pair value = entry.getValue();
MetaTreeImpl.removeStore(metaTreeMutable, value.getFirst(), entry.getKey());
expiredLoggables = expiredLoggables.mergeWith(TreeMetaInfo.getTreeLoggables(value.getSecond()).trimToSize());
}
removedStores.clear();
for (final Map.Entry entry : createdStores.entrySet()) {
MetaTreeImpl.addStore(metaTreeMutable, entry.getKey(), entry.getValue());
}
createdStores.clear();
for (final Map.Entry entry : entries) {
final ITreeMutable treeMutable = entry.getValue();
expiredLoggables = expiredLoggables.mergeWith(treeMutable.getExpiredLoggables().trimToSize());
MetaTreeImpl.saveTree(metaTreeMutable, treeMutable);
}
clearImmutableTrees();
mutableTrees.clear();
expiredLoggables = expiredLoggables.mergeWith(metaTreeMutable.getExpiredLoggables().trimToSize());
out[0] = MetaTreeImpl.saveMetaTree(metaTreeMutable, getEnvironment(), expiredLoggables);
return expiredLoggables;
}
void executeCommitHook() {
if (commitHook != null) {
commitHook.run();
}
}
@NotNull
ITreeMutable getMutableTree(@NotNull final StoreImpl store) {
checkIsFinished();
if (getEnvironment().getEnvironmentConfig().getEnvTxnSingleThreadWrites()) {
final Thread creatingThread = getCreatingThread();
if (!creatingThread.equals(Thread.currentThread())) {
throw new ExodusException("Can't create mutable tree in a thread different from the one which transaction was created in");
}
}
final int structureId = store.getStructureId();
ITreeMutable result = mutableTrees.get(structureId);
if (result == null) {
result = getTree(store).getMutableCopy();
mutableTrees.put(structureId, result);
}
return result;
}
/**
* @param store opened store.
* @return whether a mutable tree is created for specified store.
*/
boolean hasTreeMutable(@NotNull final StoreImpl store) {
return mutableTrees.containsKey(store.getStructureId());
}
void removeTreeMutable(@NotNull final StoreImpl store) {
mutableTrees.remove(store.getStructureId());
}
@NotNull
@Override
List getAllStoreNames() {
List result = super.getAllStoreNames();
if (createdStores.isEmpty()) return result;
if (result.isEmpty()) {
result = new ArrayList<>();
}
result.addAll(createdStores.keySet());
Collections.sort(result);
return result;
}
@Nullable
@Override
Runnable getBeginHook() {
return beginHook;
}
@Override
protected boolean setIsFinished() {
if (super.setIsFinished()) {
mutableTrees.clear();
return true;
}
return false;
}
private void doRevert() {
mutableTrees.clear();
removedStores.clear();
createdStores.clear();
}
}