opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/ShardRecoveryCoordinator.java

   1 /*
   2  * Copyright (c) 2014 Brocade Communications Systems, Inc. and others.  All rights reserved.
   3  *
   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
   7  */
   8 package org.opendaylight.controller.cluster.datastore;
   9
  10 import com.google.common.base.Preconditions;
  11 import com.google.common.base.Throwables;
  12 import java.io.File;
  13 import org.opendaylight.controller.cluster.datastore.persisted.ShardDataTreeSnapshot;
  14 import org.opendaylight.controller.cluster.datastore.utils.NormalizedNodeXMLOutput;
  15 import org.opendaylight.controller.cluster.raft.RaftActorRecoveryCohort;
  16 import org.opendaylight.controller.cluster.raft.protobuff.client.messages.Payload;
  17 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  18 import org.slf4j.Logger;
  19
  20 /**
  21  * Coordinates persistence recovery of journal log entries and snapshots for a shard. Each snapshot
  22  * and journal log entry batch are de-serialized and applied to their own write transaction
  23  * instance in parallel on a thread pool for faster recovery time. However the transactions are
  24  * committed to the data store in the order the corresponding snapshot or log batch are received
  25  * to preserve data store integrity.
  26  *
  27  * @author Thomas Pantelis
  28  */
  29 class ShardRecoveryCoordinator implements RaftActorRecoveryCohort {
  30     private final ShardDataTree store;
  31     private final String shardName;
  32     private final Logger log;
  33     private final byte[] restoreFromSnapshot;
  34
  35     private boolean open;
  36
  37     ShardRecoveryCoordinator(final ShardDataTree store,  final byte[] restoreFromSnapshot, final String shardName, final Logger log) {
  38         this.store = Preconditions.checkNotNull(store);
  39         this.shardName = Preconditions.checkNotNull(shardName);
  40         this.log = Preconditions.checkNotNull(log);
  41
  42         this.restoreFromSnapshot = restoreFromSnapshot;
  43     }
  44
  45     @Override
  46     public void startLogRecoveryBatch(final int maxBatchSize) {
  47         log.debug("{}: starting log recovery batch with max size {}", shardName, maxBatchSize);
  48         open = true;
  49     }
  50
  51     @Override
  52     public void appendRecoveredLogEntry(final Payload payload) {
  53         Preconditions.checkState(open, "call startLogRecovery before calling appendRecoveredLogEntry");
  54
  55         try {
  56             store.applyRecoveryPayload(payload);
  57         } catch (Exception e) {
  58             log.error("{}: failed to apply payload {}", shardName, payload, e);
  59             throw new IllegalStateException(String.format("%s: Failed to apply recovery payload %s",
  60                 shardName, payload), e);
  61         }
  62     }
  63
  64     /**
  65      * Applies the current batched log entries to the data store.
  66      */
  67     @Override
  68     public void applyCurrentLogRecoveryBatch() {
  69         Preconditions.checkState(open, "call startLogRecovery before calling applyCurrentLogRecoveryBatch");
  70         open = false;
  71     }
  72
  73     private File writeRoot(final String kind, final NormalizedNode<?, ?> node) {
  74         final File file = new File(System.getProperty("karaf.data", "."),
  75             "failed-" + kind + "-snapshot-" + shardName + ".xml");
  76         NormalizedNodeXMLOutput.toFile(file, node);
  77         return file;
  78     }
  79
  80     /**
  81      * Applies a recovered snapshot to the data store.
  82      *
  83      * @param snapshotBytes the serialized snapshot
  84      */
  85     @Override
  86     public void applyRecoverySnapshot(final byte[] snapshotBytes) {
  87         log.debug("{}: Applying recovered snapshot", shardName);
  88
  89         final ShardDataTreeSnapshot snapshot;
  90         try {
  91             snapshot = ShardDataTreeSnapshot.deserialize(snapshotBytes);
  92         } catch (Exception e) {
  93             log.error("{}: failed to deserialize snapshot", shardName, e);
  94             throw Throwables.propagate(e);
  95         }
  96
  97         try {
  98             store.applyRecoverySnapshot(snapshot);
  99         } catch (Exception e) {
 100             log.error("{}: failed to apply snapshot {}", shardName, snapshot, e);
 101
 102             final File f = writeRoot("recovery", snapshot.getRootNode().orElse(null));
 103             throw new IllegalStateException(String.format(
 104                     "%s: Failed to apply recovery snapshot. Node data was written to file %s", shardName, f), e);
 105         }
 106     }
 107
 108     @Override
 109     public byte[] getRestoreFromSnapshot() {
 110         return restoreFromSnapshot;
 111     }
 112 }