2 * Copyright (c) 2016 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.groupbasedpolicy.renderer.vpp.policy;
11 import java.util.Collection;
12 import java.util.Collections;
13 import java.util.concurrent.ExecutionException;
14 import java.util.concurrent.TimeoutException;
16 import javax.annotation.Nonnull;
17 import javax.annotation.Nullable;
19 import org.opendaylight.controller.md.sal.binding.api.ClusteredDataTreeChangeListener;
20 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
21 import org.opendaylight.controller.md.sal.binding.api.DataObjectModification;
22 import org.opendaylight.controller.md.sal.binding.api.DataObjectModification.ModificationType;
23 import org.opendaylight.controller.md.sal.binding.api.DataTreeIdentifier;
24 import org.opendaylight.controller.md.sal.binding.api.DataTreeModification;
25 import org.opendaylight.controller.md.sal.binding.api.ReadOnlyTransaction;
26 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
27 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
28 import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
29 import org.opendaylight.groupbasedpolicy.renderer.vpp.api.BridgeDomainManager;
30 import org.opendaylight.groupbasedpolicy.renderer.vpp.util.VppIidFactory;
31 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.vpp_renderer.rev160425.Config;
32 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.vpp_renderer.rev160425.bridge.domain.base.attributes.PhysicalLocationRef;
33 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.vpp_renderer.rev160425.config.GbpBridgeDomain;
34 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.vpp_renderer.rev160425.config.GbpBridgeDomainKey;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.l2.types.rev130827.VlanId;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.VxlanVni;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.vpp.state.bridge.domains.BridgeDomain;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.vpp.state.bridge.domains.BridgeDomainKey;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vbridge.status.rev161005.BridgeDomainStatusAugmentation;
40 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vbridge.status.rev161005.BridgeDomainStatusFields.BridgeDomainStatus;
41 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vbridge.topology.rev160129.NodeVbridgeAugment;
42 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vbridge.topology.rev160129.TopologyTypesVbridgeAugment;
43 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vbridge.topology.rev160129.TopologyTypesVbridgeAugmentBuilder;
44 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vbridge.topology.rev160129.TopologyVbridgeAugment;
45 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vbridge.topology.rev160129.TopologyVbridgeAugmentBuilder;
46 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vbridge.topology.rev160129.network.topology.topology.node.BridgeMember;
47 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vbridge.topology.rev160129.network.topology.topology.topology.types.VbridgeTopologyBuilder;
48 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vbridge.tunnel.vlan.rev160429.NodeVbridgeVlanAugment;
49 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vbridge.tunnel.vlan.rev160429.NodeVbridgeVlanAugmentBuilder;
50 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vbridge.tunnel.vlan.rev160429.TunnelTypeVlan;
51 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vbridge.tunnel.vlan.rev160429.network.topology.topology.tunnel.parameters.VlanNetworkParametersBuilder;
52 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vbridge.tunnel.vxlan.rev160429.TunnelTypeVxlan;
53 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vbridge.tunnel.vxlan.rev160429.network.topology.topology.tunnel.parameters.VxlanTunnelParametersBuilder;
54 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.vlan.rev161214._802dot1q;
55 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
56 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.TopologyId;
57 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.Topology;
58 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.TopologyBuilder;
59 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.TopologyKey;
60 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
61 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeBuilder;
62 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeKey;
63 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.TopologyTypes;
64 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.TopologyTypesBuilder;
65 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.node.attributes.SupportingNodeBuilder;
66 import org.opendaylight.yangtools.concepts.ListenerRegistration;
67 import org.opendaylight.yangtools.yang.binding.DataObject;
68 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
69 import org.slf4j.Logger;
70 import org.slf4j.LoggerFactory;
72 import com.google.common.base.Optional;
73 import com.google.common.base.Preconditions;
74 import com.google.common.util.concurrent.AsyncFunction;
75 import com.google.common.util.concurrent.CheckedFuture;
76 import com.google.common.util.concurrent.FutureCallback;
77 import com.google.common.util.concurrent.Futures;
78 import com.google.common.util.concurrent.ListenableFuture;
79 import com.google.common.util.concurrent.SettableFuture;
81 public class BridgeDomainManagerImpl implements BridgeDomainManager {
83 private static final Logger LOG = LoggerFactory.getLogger(BridgeDomainManagerImpl.class);
84 private static final TopologyId SUPPORTING_TOPOLOGY_NETCONF = new TopologyId("topology-netconf");
85 private static final TopologyTypes VBRIDGE_TOPOLOGY_TYPE = new TopologyTypesBuilder().addAugmentation(
86 TopologyTypesVbridgeAugment.class,
87 new TopologyTypesVbridgeAugmentBuilder().setVbridgeTopology(new VbridgeTopologyBuilder().build()).build())
89 private final DataBroker dataProvider;
91 private static final class ListenableFutureSetter<T extends DataObject>
92 implements ClusteredDataTreeChangeListener<T> {
94 private static final Logger LOG = LoggerFactory.getLogger(ListenableFutureSetter.class);
95 private final SettableFuture<Void> future;
96 private final ModificationType modificationForFutureSet;
97 private final DataTreeIdentifier<T> iid;
98 private final ListenerRegistration<ListenableFutureSetter<T>> registeredListener;
100 private ListenableFutureSetter(DataBroker dataProvider, SettableFuture<Void> future,
101 DataTreeIdentifier<T> iid, ModificationType modificationForFutureSet) {
102 this.future = Preconditions.checkNotNull(future);
103 Preconditions.checkArgument(!future.isDone());
104 this.modificationForFutureSet = Preconditions.checkNotNull(modificationForFutureSet);
105 this.iid = Preconditions.checkNotNull(iid);
106 registeredListener = dataProvider.registerDataTreeChangeListener(iid, this);
107 LOG.debug("Registered listener for path {}", iid.getRootIdentifier());
111 public void onDataTreeChanged(@Nonnull final Collection<DataTreeModification<T>> changes) {
112 changes.forEach(modification -> {
113 final DataObjectModification<T> rootNode = modification.getRootNode();
114 final ModificationType modificationType = rootNode.getModificationType();
115 if (modificationType == modificationForFutureSet) {
116 LOG.debug("{} in OPER DS: {}", modificationType.name(), iid.getRootIdentifier());
117 final T data = rootNode.getDataAfter();
118 // If waiting for bridge domain creation, do more specific check about BD status
119 if (data != null && data instanceof BridgeDomain) {
120 final BridgeDomain domain = (BridgeDomain) data;
121 final BridgeDomainStatusAugmentation statusAugment =
122 domain.getAugmentation(BridgeDomainStatusAugmentation.class);
123 final BridgeDomainStatus status = statusAugment.getBridgeDomainStatus();
126 LOG.debug("Bridge domain {} started", domain.getName());
127 unregister(future.set(null));
131 LOG.warn("Bridge domain {} failed to start", domain.getName());
132 unregister(future.set(null));
137 LOG.debug("Bridge domain {} status changed to {}", domain.getName(), status.getName());
142 unregister(future.set(null));
148 private void unregister(boolean _true) {
150 LOG.debug("Unregistering listener for path {}", iid.getRootIdentifier());
151 if (registeredListener != null) {
152 registeredListener.close();
158 public BridgeDomainManagerImpl(DataBroker dataProvider) {
159 this.dataProvider = Preconditions.checkNotNull(dataProvider);
162 private static NodeBuilder createBasicVppNodeBuilder(NodeId nodeId) {
163 return new NodeBuilder().setNodeId(nodeId).setSupportingNode(Collections.singletonList(
164 new SupportingNodeBuilder().setTopologyRef(SUPPORTING_TOPOLOGY_NETCONF).setNodeRef(nodeId).build()));
168 public ListenableFuture<Void> createVxlanBridgeDomainOnVppNode(@Nonnull final String bridgeDomainName,
169 @Nonnull final VxlanVni vni,
170 @Nonnull final NodeId vppNodeId) {
171 TopologyVbridgeAugment topologyAug = new TopologyVbridgeAugmentBuilder().setTunnelType(TunnelTypeVxlan.class)
172 .setArpTermination(false)
176 .setUnknownUnicastFlood(true)
177 .setTunnelParameters(new VxlanTunnelParametersBuilder().setVni(vni).build())
179 return createBridgeDomainOnVppNode(bridgeDomainName, topologyAug,
180 createBasicVppNodeBuilder(vppNodeId).build());
184 public ListenableFuture<Void> createVlanBridgeDomainOnVppNode(@Nonnull final String bridgeDomainName,
185 @Nonnull final VlanId vlanId,
186 @Nonnull final NodeId vppNodeId) {
187 TopologyVbridgeAugment topologyAug = new TopologyVbridgeAugmentBuilder().setTunnelType(TunnelTypeVlan.class)
188 .setArpTermination(false)
192 .setUnknownUnicastFlood(true)
193 .setTunnelParameters(
194 new VlanNetworkParametersBuilder().setVlanId(vlanId).setVlanType(_802dot1q.class).build())
196 InstanceIdentifier<GbpBridgeDomain> bridgeDomainConfigIid = InstanceIdentifier.builder(Config.class)
197 .child(GbpBridgeDomain.class, new GbpBridgeDomainKey(bridgeDomainName))
199 ReadOnlyTransaction rTx = dataProvider.newReadOnlyTransaction();
200 CheckedFuture<Optional<GbpBridgeDomain>, ReadFailedException> futureTopology =
201 rTx.read(LogicalDatastoreType.CONFIGURATION, bridgeDomainConfigIid);
203 return Futures.transform(futureTopology, new AsyncFunction<Optional<GbpBridgeDomain>, Void>() {
206 public ListenableFuture<Void> apply(@Nonnull Optional<GbpBridgeDomain> optBridgeDomainConf) throws Exception {
207 if (optBridgeDomainConf.isPresent() && optBridgeDomainConf.get().getPhysicalLocationRef() != null) {
208 for (PhysicalLocationRef ref : optBridgeDomainConf.get().getPhysicalLocationRef()) {
209 if (!ref.getNodeId().equals(vppNodeId)) {
210 LOG.debug("Node {} is not referenced node, skipping", ref.getNodeId());
213 if (ref.getInterface() != null && ref.getInterface().size() > 0) {
214 NodeVbridgeVlanAugment vppNodeVlanAug = new NodeVbridgeVlanAugmentBuilder()
215 .setSuperInterface(ref.getInterface().get(0)).build();
216 Node vppNode = createBasicVppNodeBuilder(vppNodeId)
217 .addAugmentation(NodeVbridgeVlanAugment.class, vppNodeVlanAug).build();
218 return createBridgeDomainOnVppNode(bridgeDomainName, topologyAug, vppNode);
222 return Futures.immediateFailedFuture(
223 new Throwable("Failed to apply config for VLAN bridge domain " + bridgeDomainName));
229 * Method checks whether bridge domain already exists in topology under its {@link TopologyId}. If not, BD is
230 * written into CONF DS (request for VBD) and registers listener which awaits result from VBD. Result can be
231 * checked in OPER DS as a {@link BridgeDomainStatus}. If status is {@link BridgeDomainStatus#Started}, listener
232 * unregisters itself and bridge domain creation in VBD is considered successful.
234 * Next part creates request for {@link BridgeMember} in topology CONF DS and registers listener listening on
235 * topology OPER DS. If bridge member is created in VBD, listener is closed.
237 * This process has limited time, limit is defined in {@link ForwardingManager#WAIT_FOR_BD_PROCESSING} to prevent
238 * stuck if VBD processing fails in some point.
240 * @param bridgeDomainName serving as a topology-id
241 * @param vBridgeAug augmented data in BD
242 * @param vppNode transformed into bridge member
243 * @return composed future which serves as a marker for caller method that the computation is done. If future is
244 * not returned in time, {@link TimeoutException} will be thrown there.
246 private ListenableFuture<Void> createBridgeDomainOnVppNode(@Nonnull final String bridgeDomainName,
247 @Nonnull final TopologyVbridgeAugment vBridgeAug,
248 @Nonnull final Node vppNode) {
249 final TopologyKey topologyKey = new TopologyKey(new TopologyId(bridgeDomainName));
250 final ReadOnlyTransaction rTx = dataProvider.newReadOnlyTransaction();
251 final InstanceIdentifier<Topology> topologyIid = VppIidFactory.getTopologyIid(topologyKey);
252 final CheckedFuture<Optional<Topology>, ReadFailedException> optTopology =
253 rTx.read(LogicalDatastoreType.CONFIGURATION, topologyIid);
255 return Futures.transform(optTopology, new AsyncFunction<Optional<Topology>, Void>() {
257 public ListenableFuture<Void> apply(@Nonnull final Optional<Topology> optTopology)
258 throws InterruptedException, ExecutionException {
260 final SettableFuture<Void> topologyFuture = SettableFuture.create();
261 if (!optTopology.isPresent()) {
262 final WriteTransaction wTx = dataProvider.newWriteOnlyTransaction();
263 final Topology topology = new TopologyBuilder().setKey(topologyKey)
264 .setTopologyTypes(VBRIDGE_TOPOLOGY_TYPE)
265 .addAugmentation(TopologyVbridgeAugment.class, vBridgeAug)
267 wTx.put(LogicalDatastoreType.CONFIGURATION, topologyIid, topology, true);
268 Futures.addCallback(wTx.submit(), new FutureCallback<Void>() {
271 public void onSuccess(@Nullable final Void result) {
272 final InstanceIdentifier<BridgeDomain> bridgeDomainStateIid =
273 VppIidFactory.getBridgeDomainStateIid(new BridgeDomainKey(bridgeDomainName));
274 final DataTreeIdentifier<BridgeDomain> bridgeDomainStateIidDTI = new DataTreeIdentifier<>(LogicalDatastoreType.OPERATIONAL,
275 bridgeDomainStateIid);
276 new ListenableFutureSetter<>(dataProvider, topologyFuture, bridgeDomainStateIidDTI, ModificationType.WRITE);
280 public void onFailure(@Nonnull Throwable t) {
281 LOG.warn("Request create topology for VBD was not stored to CONF DS. {}", topologyIid, t);
282 topologyFuture.setException(new Exception("Cannot send request to VBD."));
286 topologyFuture.set(null);
288 return Futures.transform(topologyFuture, new AsyncFunction<Void, Void>() {
290 public ListenableFuture<Void> apply(@Nonnull Void topologyInput) throws Exception {
292 final SettableFuture<Void> futureBridgeMember = SettableFuture.create();
293 final InstanceIdentifier<Node> nodeIid = VppIidFactory.getNodeIid(topologyKey, vppNode.getKey());
294 final WriteTransaction wTx = dataProvider.newWriteOnlyTransaction();
295 wTx.put(LogicalDatastoreType.CONFIGURATION, nodeIid, vppNode);
296 Futures.addCallback(wTx.submit(), new FutureCallback<Void>() {
299 public void onSuccess(@Nullable final Void _void) {
300 final DataTreeIdentifier<BridgeMember> bridgeMemberIid =
301 new DataTreeIdentifier<>(LogicalDatastoreType.OPERATIONAL,
302 nodeIid.augmentation(NodeVbridgeAugment.class).child(BridgeMember.class));
303 LOG.debug("Request create node in topology for VBD was stored to CONF DS. {}", nodeIid);
304 new ListenableFutureSetter<>(dataProvider, futureBridgeMember, bridgeMemberIid,
305 ModificationType.WRITE);
309 public void onFailure(@Nonnull final Throwable t) {
310 LOG.warn("Request create node in topology for VBD was not stored to CONF DS. {}", nodeIid, t);
311 futureBridgeMember.setException(new Exception("Cannot send request to VBD."));
314 return futureBridgeMember;
322 public ListenableFuture<Void> removeBridgeDomainFromVppNode(@Nonnull final String bridgeDomainName,
323 @Nonnull final NodeId vppNode) {
324 WriteTransaction wTx = dataProvider.newWriteOnlyTransaction();
325 InstanceIdentifier<Node> nodeIid =
326 VppIidFactory.getNodeIid(new TopologyKey(new TopologyId(bridgeDomainName)), new NodeKey(vppNode));
327 wTx.delete(LogicalDatastoreType.CONFIGURATION, nodeIid);
328 SettableFuture<Void> future = SettableFuture.create();
329 Futures.addCallback(wTx.submit(), new FutureCallback<Void>() {
332 public void onSuccess(Void result) {
333 DataTreeIdentifier<BridgeMember> bridgeMemberIid =
334 new DataTreeIdentifier<>(LogicalDatastoreType.OPERATIONAL,
335 nodeIid.augmentation(NodeVbridgeAugment.class).child(BridgeMember.class));
336 LOG.debug("Request delete node in topology for VBD was stored to CONF DS. {}", nodeIid);
337 new ListenableFutureSetter<>(dataProvider, future, bridgeMemberIid, ModificationType.DELETE);
341 public void onFailure(@Nonnull Throwable t) {
342 LOG.warn("Request delete node in topology for VBD was not stored to CONF DS. {}", nodeIid, t);
343 future.setException(new Exception("Cannot send request to VBD."));