2 * Copyright (c) 2017 Cisco 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
9 package org.opendaylight.controller.cluster.sharding;
11 import com.google.common.util.concurrent.AsyncFunction;
12 import com.google.common.util.concurrent.Futures;
13 import com.google.common.util.concurrent.ListenableFuture;
14 import java.util.Collection;
15 import java.util.concurrent.ExecutionException;
16 import org.opendaylight.controller.cluster.access.concepts.MemberName;
17 import org.opendaylight.controller.cluster.databroker.actors.dds.ClientLocalHistory;
18 import org.opendaylight.controller.cluster.databroker.actors.dds.ClientSnapshot;
19 import org.opendaylight.controller.cluster.databroker.actors.dds.ClientTransaction;
20 import org.opendaylight.controller.cluster.databroker.actors.dds.DataStoreClient;
21 import org.opendaylight.controller.cluster.datastore.utils.ClusterUtils;
22 import org.opendaylight.mdsal.common.api.ReadFailedException;
23 import org.opendaylight.mdsal.dom.api.DOMDataTreeWriteCursor;
24 import org.opendaylight.mdsal.dom.spi.store.DOMStoreThreePhaseCommitCohort;
25 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
26 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
27 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
28 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeWithValue;
29 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
30 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetEntryNode;
31 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
32 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.ListNodeBuilder;
33 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableContainerNodeBuilder;
34 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableLeafNodeBuilder;
35 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableLeafSetEntryNodeBuilder;
36 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableLeafSetNodeBuilder;
37 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableMapEntryNodeBuilder;
38 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableMapNodeBuilder;
39 import org.slf4j.Logger;
40 import org.slf4j.LoggerFactory;
43 * Writes and removes prefix-based shards' configuration
44 * to prefix-shard-configuration. This classed is meant to be utilized
45 * by {@link DistributedShardedDOMDataTree} for updating
46 * prefix-shard-configuration upon creating and de-spawning prefix-based shards.
48 class PrefixedShardConfigWriter {
50 private static final Logger LOG = LoggerFactory.getLogger(PrefixedShardConfigWriter.class);
52 private final ClientLocalHistory history;
54 PrefixedShardConfigWriter(final DataStoreClient client) {
55 history = client.createLocalHistory();
59 ListenableFuture<Void> writeConfig(final YangInstanceIdentifier path, final Collection<MemberName> replicas) {
60 LOG.debug("Writing config for {}, replicas {}", path, replicas);
62 return doSubmit(doWrite(path, replicas));
65 ListenableFuture<Void> removeConfig(final YangInstanceIdentifier path) {
66 LOG.debug("Removing config for {}.", path);
68 return doSubmit(doDelete(path));
71 private void writeInitialParent() {
72 final ClientTransaction tx = history.createTransaction();
74 final DOMDataTreeWriteCursor cursor = tx.openCursor();
76 final ContainerNode root = ImmutableContainerNodeBuilder.create()
77 .withNodeIdentifier(new NodeIdentifier(ClusterUtils.PREFIX_SHARDS_QNAME))
78 .withChild(ImmutableMapNodeBuilder.create()
79 .withNodeIdentifier(new NodeIdentifier(ClusterUtils.SHARD_LIST_QNAME))
83 cursor.merge(ClusterUtils.PREFIX_SHARDS_PATH.getLastPathArgument(), root);
86 final DOMStoreThreePhaseCommitCohort cohort = tx.ready();
88 submitBlocking(cohort);
91 private void submitBlocking(final DOMStoreThreePhaseCommitCohort cohort) {
93 doSubmit(cohort).get();
94 } catch (final InterruptedException | ExecutionException e) {
95 LOG.error("Unable to write initial shard config parent.", e);
99 private ListenableFuture<Void> doSubmit(final DOMStoreThreePhaseCommitCohort cohort) {
100 final AsyncFunction<Boolean, Void> validateFunction = input -> cohort.preCommit();
101 final AsyncFunction<Void, Void> prepareFunction = input -> cohort.commit();
103 final ListenableFuture<Void> prepareFuture = Futures.transform(cohort.canCommit(), validateFunction);
104 return Futures.transform(prepareFuture, prepareFunction);
107 boolean checkDefaultIsPresent() {
108 final NodeIdentifierWithPredicates pag =
109 new NodeIdentifierWithPredicates(ClusterUtils.SHARD_LIST_QNAME, ClusterUtils.SHARD_PREFIX_QNAME,
110 YangInstanceIdentifier.EMPTY);
112 final YangInstanceIdentifier defaultId = ClusterUtils.SHARD_LIST_PATH.node(pag);
114 final ClientSnapshot snapshot = history.takeSnapshot();
116 return snapshot.exists(defaultId).checkedGet();
117 } catch (final ReadFailedException e) {
118 LOG.error("Presence check of default shard in configuration failed.", e);
123 private DOMStoreThreePhaseCommitCohort doWrite(final YangInstanceIdentifier path,
124 final Collection<MemberName> replicas) {
126 final ListNodeBuilder<Object, LeafSetEntryNode<Object>> replicaListBuilder =
127 ImmutableLeafSetNodeBuilder.create().withNodeIdentifier(
128 new NodeIdentifier(ClusterUtils.SHARD_REPLICA_QNAME));
130 replicas.forEach(name -> replicaListBuilder.withChild(
131 ImmutableLeafSetEntryNodeBuilder.create()
132 .withNodeIdentifier(new NodeWithValue<>(ClusterUtils.SHARD_REPLICA_QNAME, name.getName()))
133 .withValue(name.getName())
136 final MapEntryNode newEntry = ImmutableMapEntryNodeBuilder.create()
138 new NodeIdentifierWithPredicates(ClusterUtils.SHARD_LIST_QNAME, ClusterUtils.SHARD_PREFIX_QNAME,
140 .withChild(ImmutableLeafNodeBuilder.create()
141 .withNodeIdentifier(new NodeIdentifier(ClusterUtils.SHARD_PREFIX_QNAME))
144 .withChild(ImmutableContainerNodeBuilder.create()
145 .withNodeIdentifier(new NodeIdentifier(ClusterUtils.SHARD_REPLICAS_QNAME))
146 .withChild(replicaListBuilder.build())
150 final ClientTransaction tx = history.createTransaction();
151 final DOMDataTreeWriteCursor cursor = tx.openCursor();
153 ClusterUtils.SHARD_LIST_PATH.getPathArguments().forEach(cursor::enter);
155 cursor.write(newEntry.getIdentifier(), newEntry);
161 private DOMStoreThreePhaseCommitCohort doDelete(final YangInstanceIdentifier path) {
163 final ClientTransaction tx = history.createTransaction();
164 final DOMDataTreeWriteCursor cursor = tx.openCursor();
166 ClusterUtils.SHARD_LIST_PATH.getPathArguments().forEach(cursor::enter);
169 new NodeIdentifierWithPredicates(ClusterUtils.SHARD_LIST_QNAME, ClusterUtils.SHARD_PREFIX_QNAME, path));