Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
org.opendaylight.controller.cluster.datastore.FrontendClientMetadataBuilder Maven / Gradle / Ivy
/*
* Copyright (c) 2016 Cisco Systems, Inc. and others. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v1.0 which accompanies this distribution,
* and is available at http://www.eclipse.org/legal/epl-v10.html
*/
package org.opendaylight.controller.cluster.datastore;
import static java.util.Objects.requireNonNull;
import com.google.common.base.MoreObjects;
import com.google.common.base.MoreObjects.ToStringHelper;
import com.google.common.base.VerifyException;
import com.google.common.collect.Collections2;
import com.google.common.collect.ImmutableList;
import java.util.HashMap;
import java.util.Map;
import org.eclipse.jdt.annotation.NonNull;
import org.opendaylight.controller.cluster.access.concepts.ClientIdentifier;
import org.opendaylight.controller.cluster.access.concepts.LocalHistoryIdentifier;
import org.opendaylight.controller.cluster.access.concepts.TransactionIdentifier;
import org.opendaylight.controller.cluster.datastore.persisted.FrontendClientMetadata;
import org.opendaylight.controller.cluster.datastore.utils.ImmutableUnsignedLongSet;
import org.opendaylight.controller.cluster.datastore.utils.MutableUnsignedLongSet;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* This class is NOT thread-safe.
*/
abstract sealed class FrontendClientMetadataBuilder {
static final class Disabled extends FrontendClientMetadataBuilder {
Disabled(final String shardName, final ClientIdentifier clientId) {
super(shardName, clientId);
}
@Override
FrontendClientMetadata build() {
return new FrontendClientMetadata(clientId(), ImmutableUnsignedLongSet.of(), ImmutableList.of());
}
@Override
void onHistoryCreated(final LocalHistoryIdentifier historyId) {
// No-op
}
@Override
void onHistoryClosed(final LocalHistoryIdentifier historyId) {
// No-op
}
@Override
void onHistoryPurged(final LocalHistoryIdentifier historyId) {
// No-op
}
@Override
void onTransactionAborted(final TransactionIdentifier txId) {
// No-op
}
@Override
void onTransactionCommitted(final TransactionIdentifier txId) {
// No-op
}
@Override
void onTransactionPurged(final TransactionIdentifier txId) {
// No-op
}
@Override
void onTransactionsSkipped(final LocalHistoryIdentifier historyId, final ImmutableUnsignedLongSet txIds) {
// No-op
}
@Override
LeaderFrontendState toLeaderState(final Shard shard) {
return new LeaderFrontendState.Disabled(shard.persistenceId(), clientId(), shard.getDataStore());
}
}
static final class Enabled extends FrontendClientMetadataBuilder {
private final Map currentHistories = new HashMap<>();
private final MutableUnsignedLongSet purgedHistories;
private final LocalHistoryIdentifier standaloneId;
Enabled(final String shardName, final ClientIdentifier clientId) {
super(shardName, clientId);
purgedHistories = MutableUnsignedLongSet.of();
// History for stand-alone transactions is always present
standaloneId = standaloneHistoryId();
currentHistories.put(standaloneId, new FrontendHistoryMetadataBuilder(standaloneId));
}
Enabled(final String shardName, final FrontendClientMetadata meta) {
super(shardName, meta.clientId());
purgedHistories = meta.getPurgedHistories().mutableCopy();
for (var historyMeta : meta.getCurrentHistories()) {
final var builder = new FrontendHistoryMetadataBuilder(clientId(), historyMeta);
currentHistories.put(builder.getIdentifier(), builder);
}
// Sanity check and recovery
standaloneId = standaloneHistoryId();
if (!currentHistories.containsKey(standaloneId)) {
LOG.warn("{}: Client {} recovered histories {} do not contain stand-alone history, attempting recovery",
shardName, clientId(), currentHistories);
currentHistories.put(standaloneId, new FrontendHistoryMetadataBuilder(standaloneId));
}
}
@Override
FrontendClientMetadata build() {
return new FrontendClientMetadata(clientId(), purgedHistories.immutableCopy(),
Collections2.transform(currentHistories.values(), FrontendHistoryMetadataBuilder::build));
}
@Override
void onHistoryCreated(final LocalHistoryIdentifier historyId) {
final var newMeta = new FrontendHistoryMetadataBuilder(historyId);
final var oldMeta = currentHistories.putIfAbsent(historyId, newMeta);
if (oldMeta != null) {
// This should not be happening, warn about it
LOG.warn("{}: Reused local history {}", shardName(), historyId);
} else {
LOG.debug("{}: Created local history {}", shardName(), historyId);
}
}
@Override
void onHistoryClosed(final LocalHistoryIdentifier historyId) {
final var builder = currentHistories.get(historyId);
if (builder != null) {
builder.onHistoryClosed();
LOG.debug("{}: Closed history {}", shardName(), historyId);
} else {
LOG.warn("{}: Closed unknown history {}, ignoring", shardName(), historyId);
}
}
@Override
void onHistoryPurged(final LocalHistoryIdentifier historyId) {
final var history = currentHistories.remove(historyId);
final long historyBits = historyId.getHistoryId();
if (history == null) {
if (!purgedHistories.contains(historyBits)) {
purgedHistories.add(historyBits);
LOG.warn("{}: Purging unknown history {}", shardName(), historyId);
} else {
LOG.warn("{}: Duplicate purge of history {}", shardName(), historyId);
}
} else {
purgedHistories.add(historyBits);
LOG.debug("{}: Purged history {}", shardName(), historyId);
}
}
@Override
void onTransactionAborted(final TransactionIdentifier txId) {
final var history = getHistory(txId);
if (history != null) {
history.onTransactionAborted(txId);
LOG.debug("{}: Aborted transaction {}", shardName(), txId);
} else {
LOG.warn("{}: Unknown history for aborted transaction {}, ignoring", shardName(), txId);
}
}
@Override
void onTransactionCommitted(final TransactionIdentifier txId) {
final var history = getHistory(txId);
if (history != null) {
history.onTransactionCommitted(txId);
LOG.debug("{}: Committed transaction {}", shardName(), txId);
} else {
LOG.warn("{}: Unknown history for commited transaction {}, ignoring", shardName(), txId);
}
}
@Override
void onTransactionPurged(final TransactionIdentifier txId) {
final var history = getHistory(txId);
if (history != null) {
history.onTransactionPurged(txId);
LOG.debug("{}: Purged transaction {}", shardName(), txId);
} else {
LOG.warn("{}: Unknown history for purged transaction {}, ignoring", shardName(), txId);
}
}
@Override
void onTransactionsSkipped(final LocalHistoryIdentifier historyId, final ImmutableUnsignedLongSet txIds) {
final FrontendHistoryMetadataBuilder history = getHistory(historyId);
if (history != null) {
history.onTransactionsSkipped(txIds);
LOG.debug("{}: History {} skipped transactions {}", shardName(), historyId, txIds);
} else {
LOG.warn("{}: Unknown history {} for skipped transactions, ignoring", shardName(), historyId);
}
}
@Override
LeaderFrontendState toLeaderState(final Shard shard) {
// Note: we have to make sure to *copy* all current state and not leak any views, otherwise leader/follower
// interactions would get intertwined leading to inconsistencies.
final var histories = new HashMap();
for (var historyMetaBuilder : currentHistories.values()) {
final var historyId = historyMetaBuilder.getIdentifier();
if (historyId.getHistoryId() != 0) {
final var state = historyMetaBuilder.toLeaderState(shard);
if (state instanceof LocalFrontendHistory localState) {
histories.put(historyId, localState);
} else {
throw new VerifyException("Unexpected state " + state);
}
}
}
final AbstractFrontendHistory singleHistory;
final var singleHistoryMeta = currentHistories.get(new LocalHistoryIdentifier(clientId(), 0));
if (singleHistoryMeta == null) {
final var tree = shard.getDataStore();
singleHistory = StandaloneFrontendHistory.create(shard.persistenceId(), clientId(), tree);
} else {
singleHistory = singleHistoryMeta.toLeaderState(shard);
}
return new LeaderFrontendState.Enabled(shard.persistenceId(), clientId(), shard.getDataStore(),
purgedHistories.mutableCopy(), singleHistory, histories);
}
@Override
ToStringHelper addToStringAttributes(final ToStringHelper helper) {
return super.addToStringAttributes(helper).add("current", currentHistories).add("purged", purgedHistories);
}
private FrontendHistoryMetadataBuilder getHistory(final TransactionIdentifier txId) {
return getHistory(txId.getHistoryId());
}
private FrontendHistoryMetadataBuilder getHistory(final LocalHistoryIdentifier historyId) {
final LocalHistoryIdentifier local;
if (historyId.getHistoryId() == 0 && historyId.getCookie() != 0) {
// We are pre-creating the history for free-standing transactions with a zero cookie, hence our lookup
// needs to account for that.
LOG.debug("{}: looking up {} instead of {}", shardName(), standaloneId, historyId);
local = standaloneId;
} else {
local = historyId;
}
return currentHistories.get(local);
}
private LocalHistoryIdentifier standaloneHistoryId() {
return new LocalHistoryIdentifier(clientId(), 0);
}
}
private static final Logger LOG = LoggerFactory.getLogger(FrontendClientMetadataBuilder.class);
private final @NonNull ClientIdentifier clientId;
private final @NonNull String shardName;
FrontendClientMetadataBuilder(final String shardName, final ClientIdentifier clientId) {
this.shardName = requireNonNull(shardName);
this.clientId = requireNonNull(clientId);
}
static FrontendClientMetadataBuilder of(final String shardName, final FrontendClientMetadata meta) {
// Completely empty histories imply disabled state, as otherwise we'd have a record of the single history --
// either purged or active
return meta.getCurrentHistories().isEmpty() && meta.getPurgedHistories().isEmpty()
? new Disabled(shardName, meta.clientId()) : new Enabled(shardName, meta);
}
final ClientIdentifier clientId() {
return clientId;
}
final String shardName() {
return shardName;
}
abstract FrontendClientMetadata build();
abstract void onHistoryCreated(LocalHistoryIdentifier historyId);
abstract void onHistoryClosed(LocalHistoryIdentifier historyId);
abstract void onHistoryPurged(LocalHistoryIdentifier historyId);
abstract void onTransactionAborted(TransactionIdentifier txId);
abstract void onTransactionCommitted(TransactionIdentifier txId);
abstract void onTransactionPurged(TransactionIdentifier txId);
abstract void onTransactionsSkipped(LocalHistoryIdentifier historyId, ImmutableUnsignedLongSet txIds);
/**
* Transform frontend metadata for a particular client into its {@link LeaderFrontendState} counterpart.
*
* @param shard parent shard
* @return Leader frontend state
*/
abstract @NonNull LeaderFrontendState toLeaderState(@NonNull Shard shard);
@Override
public final String toString() {
return addToStringAttributes(MoreObjects.toStringHelper(this)).toString();
}
ToStringHelper addToStringAttributes(final ToStringHelper helper) {
return helper.add("clientId", clientId);
}
}
