2 * Copyright (c) 2014 Brocade Communications Systems, Inc. and others. All rights reserved.
4 * This program and the accompanying materials are made available under the
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
8 package org.opendaylight.controller.cluster.datastore;
10 import com.google.common.base.Preconditions;
11 import com.google.common.base.Throwables;
13 import java.io.IOException;
14 import org.opendaylight.controller.cluster.datastore.persisted.ShardDataTreeSnapshot;
15 import org.opendaylight.controller.cluster.datastore.persisted.ShardSnapshotState;
16 import org.opendaylight.controller.cluster.datastore.utils.NormalizedNodeXMLOutput;
17 import org.opendaylight.controller.cluster.raft.RaftActorRecoveryCohort;
18 import org.opendaylight.controller.cluster.raft.persisted.Snapshot;
19 import org.opendaylight.controller.cluster.raft.persisted.Snapshot.State;
20 import org.opendaylight.controller.cluster.raft.protobuff.client.messages.Payload;
21 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
22 import org.slf4j.Logger;
25 * Coordinates persistence recovery of journal log entries and snapshots for a shard. Each snapshot
26 * and journal log entry batch are de-serialized and applied to their own write transaction
27 * instance in parallel on a thread pool for faster recovery time. However the transactions are
28 * committed to the data store in the order the corresponding snapshot or log batch are received
29 * to preserve data store integrity.
31 * @author Thomas Pantelis
33 class ShardRecoveryCoordinator implements RaftActorRecoveryCohort {
34 private final ShardDataTree store;
35 private final String shardName;
36 private final Logger log;
37 private final Snapshot restoreFromSnapshot;
41 ShardRecoveryCoordinator(final ShardDataTree store, final Snapshot restoreFromSnapshot, final String shardName,
43 this.store = Preconditions.checkNotNull(store);
44 this.shardName = Preconditions.checkNotNull(shardName);
45 this.log = Preconditions.checkNotNull(log);
47 this.restoreFromSnapshot = restoreFromSnapshot;
51 public void startLogRecoveryBatch(final int maxBatchSize) {
52 log.debug("{}: starting log recovery batch with max size {}", shardName, maxBatchSize);
57 @SuppressWarnings("checkstyle:IllegalCatch")
58 public void appendRecoveredLogEntry(final Payload payload) {
59 Preconditions.checkState(open, "call startLogRecovery before calling appendRecoveredLogEntry");
62 store.applyRecoveryPayload(payload);
63 } catch (Exception e) {
64 log.error("{}: failed to apply payload {}", shardName, payload, e);
65 throw new IllegalStateException(String.format("%s: Failed to apply recovery payload %s",
66 shardName, payload), e);
71 * Applies the current batched log entries to the data store.
74 public void applyCurrentLogRecoveryBatch() {
75 Preconditions.checkState(open, "call startLogRecovery before calling applyCurrentLogRecoveryBatch");
79 private File writeRoot(final String kind, final NormalizedNode<?, ?> node) {
80 final File file = new File(System.getProperty("karaf.data", "."),
81 "failed-recovery-" + kind + "-" + shardName + ".xml");
82 NormalizedNodeXMLOutput.toFile(file, node);
87 * Applies a recovered snapshot to the data store.
89 * @param snapshotState the serialized snapshot
92 @SuppressWarnings("checkstyle:IllegalCatch")
93 public void applyRecoverySnapshot(final Snapshot.State snapshotState) {
94 if (!(snapshotState instanceof ShardSnapshotState)) {
95 log.debug("{}: applyRecoverySnapshot ignoring snapshot: {}", snapshotState);
98 log.debug("{}: Applying recovered snapshot", shardName);
100 ShardDataTreeSnapshot shardSnapshot = ((ShardSnapshotState)snapshotState).getSnapshot();
102 store.applyRecoverySnapshot(shardSnapshot);
103 } catch (Exception e) {
104 final File f = writeRoot("snapshot", shardSnapshot.getRootNode().orElse(null));
105 throw new IllegalStateException(String.format(
106 "%s: Failed to apply recovery snapshot %s. Node data was written to file %s",
107 shardName, shardSnapshot, f), e);
112 public Snapshot getRestoreFromSnapshot() {
113 return restoreFromSnapshot;
118 public State deserializePreCarbonSnapshot(final byte[] from) {
120 return new ShardSnapshotState(ShardDataTreeSnapshot.deserializePreCarbon(from));
121 } catch (IOException e) {
122 log.error("{}: failed to deserialize snapshot", shardName, e);
123 throw Throwables.propagate(e);