From 42887f769a3ac57963110925a1c2965c2b25bac6 Mon Sep 17 00:00:00 2001 From: Robert Varga Date: Sat, 30 Jan 2016 15:25:19 +0100 Subject: Add Virtual Bridge Domain implementation Change-Id: I427b709ac0af1ade365bc60148ddf778f7be458a Signed-off-by: Robert Varga --- .../io/fd/honeycomb/vbd/impl/BridgeDomain.java | 169 +++++++++++++++++++++ .../io/fd/honeycomb/vbd/impl/TopologyMonitor.java | 159 +++++++++++++++++++ .../vbd/impl/VirtualBridgeDomainManager.java | 65 ++++++++ 3 files changed, 393 insertions(+) create mode 100644 vbd/impl/src/main/java/io/fd/honeycomb/vbd/impl/BridgeDomain.java create mode 100644 vbd/impl/src/main/java/io/fd/honeycomb/vbd/impl/TopologyMonitor.java create mode 100644 vbd/impl/src/main/java/io/fd/honeycomb/vbd/impl/VirtualBridgeDomainManager.java (limited to 'vbd/impl/src/main/java/io') diff --git a/vbd/impl/src/main/java/io/fd/honeycomb/vbd/impl/BridgeDomain.java b/vbd/impl/src/main/java/io/fd/honeycomb/vbd/impl/BridgeDomain.java new file mode 100644 index 000000000..aff03b2a6 --- /dev/null +++ b/vbd/impl/src/main/java/io/fd/honeycomb/vbd/impl/BridgeDomain.java @@ -0,0 +1,169 @@ +/* + * 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 io.fd.honeycomb.vbd.impl; + +import com.google.common.base.Preconditions; +import java.util.Collection; +import javax.annotation.concurrent.GuardedBy; +import org.opendaylight.controller.md.sal.binding.api.BindingTransactionChain; +import org.opendaylight.controller.md.sal.binding.api.DataBroker; +import org.opendaylight.controller.md.sal.binding.api.DataObjectModification; +import org.opendaylight.controller.md.sal.binding.api.DataObjectModification.ModificationType; +import org.opendaylight.controller.md.sal.binding.api.DataTreeChangeListener; +import org.opendaylight.controller.md.sal.binding.api.DataTreeIdentifier; +import org.opendaylight.controller.md.sal.binding.api.DataTreeModification; +import org.opendaylight.controller.md.sal.binding.api.WriteTransaction; +import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType; +import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vbridge.topology.rev160129.Topology1; +import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.Topology; +import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.TopologyKey; +import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node; +import org.opendaylight.yangtools.concepts.ListenerRegistration; +import org.opendaylight.yangtools.yang.binding.DataObject; +import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +/** + * Implementation of a single Virtual Bridge Domain. It is bound to a particular network topology instance, manages + * bridge members and projects state into the operational data store. + */ +final class BridgeDomain implements DataTreeChangeListener { + private static final Logger LOG = LoggerFactory.getLogger(BridgeDomain.class); + private final KeyedInstanceIdentifier topology; + + @GuardedBy("this") + private final BindingTransactionChain chain; + private final ListenerRegistration reg; + private Topology1 config; + + private BridgeDomain(final DataBroker dataBroker, final KeyedInstanceIdentifier topology, + final BindingTransactionChain chain) { + this.topology = Preconditions.checkNotNull(topology); + this.chain = Preconditions.checkNotNull(chain); + + reg = dataBroker.registerDataTreeChangeListener( + new DataTreeIdentifier<>(LogicalDatastoreType.CONFIGURATION, topology), this); + } + + static BridgeDomain create(final DataBroker dataBroker, + final KeyedInstanceIdentifier topology, final BindingTransactionChain chain) { + + LOG.debug("Wiping operational state of {}", topology); + + final WriteTransaction tx = chain.newWriteOnlyTransaction(); + tx.delete(LogicalDatastoreType.OPERATIONAL, topology); + tx.submit(); + + return new BridgeDomain(dataBroker, topology, chain); + } + + synchronized void forceStop() { + LOG.info("Bridge domain {} for {} going down", this, topology); + reg.close(); + chain.close(); + LOG.info("Bridge domain {} for {} is down", this, topology); + } + + synchronized void stop() { + LOG.debug("Bridge domain {} for {} shutting down", this, topology); + + final WriteTransaction tx = chain.newWriteOnlyTransaction(); + tx.delete(LogicalDatastoreType.OPERATIONAL, topology); + tx.submit(); + chain.close(); + } + + @Override + public synchronized void onDataTreeChanged(final Collection> changes) { + for (DataTreeModification c : changes) { + LOG.debug("Domain {} for {} processing change {}", this, topology, c); + + final DataObjectModification mod = c.getRootNode(); + switch (mod.getModificationType()) { + case DELETE: + LOG.debug("Topology {} deleted, expecting shutdown", topology); + break; + case SUBTREE_MODIFIED: + // First check if the configuration has changed + final DataObjectModification newConfig = mod.getModifiedAugmentation(Topology1.class); + if (newConfig != null) { + if (newConfig.getModificationType() != ModificationType.DELETE) { + LOG.debug("Topology {} modified configuration {}", topology, newConfig); + updateConfiguration(newConfig); + } else { + // FIXME: okay, what can we do about this one? + LOG.error("Topology {} configuration deleted, good luck!", topology); + } + } + + for (DataObjectModification child : mod.getModifiedChildren()) { + LOG.debug("Topology {} modified child {}", topology, child); + + if (Node.class.isAssignableFrom(child.getDataType())) { + modifyNode((DataObjectModification) child); + } + } + + break; + case WRITE: + final Topology data = mod.getDataAfter(); + + // Read configuration + final Topology1 config = data.getAugmentation(Topology1.class); + if (config != null) { + setConfiguration(config); + } else { + LOG.error("Topology {} has no configuration, good luck!", topology); + } + + // FIXME: deal with nodes + + break; + default: + LOG.warn("Unhandled topology modification {}", mod); + break; + } + } + } + + private void modifyNode(final DataObjectModification child) { + switch (child.getModificationType()) { + case DELETE: + LOG.debug("Topology {} node {} deleted", topology, child.getIdentifier()); + // FIXME: do something + break; + case SUBTREE_MODIFIED: + LOG.debug("Topology {} node {} modified", topology, child.getIdentifier()); + // FIXME: do something + break; + case WRITE: + LOG.debug("Topology {} node {} created", topology, child.getIdentifier()); + // FIXME: do something + break; + default: + LOG.warn("Unhandled node modification {} in topology {}", child, topology); + break; + } + } + + private void setConfiguration(final Topology1 config) { + LOG.debug("Topology {} configuration set to {}", topology, config); + + this.config = config; + } + + @GuardedBy("this") + private void updateConfiguration(final DataObjectModification mod) { + LOG.debug("Topology {} configuration changed", topology); + + // FIXME: do something smarter + setConfiguration(mod.getDataAfter()); + } +} diff --git a/vbd/impl/src/main/java/io/fd/honeycomb/vbd/impl/TopologyMonitor.java b/vbd/impl/src/main/java/io/fd/honeycomb/vbd/impl/TopologyMonitor.java new file mode 100644 index 000000000..b2e52c37e --- /dev/null +++ b/vbd/impl/src/main/java/io/fd/honeycomb/vbd/impl/TopologyMonitor.java @@ -0,0 +1,159 @@ +/* + * 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 io.fd.honeycomb.vbd.impl; + +import com.google.common.base.Preconditions; +import java.util.Collection; +import java.util.HashMap; +import java.util.Map; +import java.util.Map.Entry; +import javax.annotation.concurrent.GuardedBy; +import org.opendaylight.controller.md.sal.binding.api.BindingTransactionChain; +import org.opendaylight.controller.md.sal.binding.api.DataBroker; +import org.opendaylight.controller.md.sal.binding.api.DataObjectModification; +import org.opendaylight.controller.md.sal.binding.api.DataTreeChangeListener; +import org.opendaylight.controller.md.sal.binding.api.DataTreeModification; +import org.opendaylight.controller.md.sal.common.api.data.AsyncTransaction; +import org.opendaylight.controller.md.sal.common.api.data.TransactionChain; +import org.opendaylight.controller.md.sal.common.api.data.TransactionChainListener; +import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vbridge.topology.rev160129.network.topology.topology.topology.types.VbridgeTopology; +import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.Topology; +import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.TopologyKey; +import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +/** + * Class responsible for monitoring /network-topology/topology and activating a {@link BridgeDomain} when a particular + * topology is marked as a bridge domain. + */ +final class TopologyMonitor implements DataTreeChangeListener, AutoCloseable { + private static final Logger LOG = LoggerFactory.getLogger(TopologyMonitor.class); + + @GuardedBy("this") + private final Map domains = new HashMap<>(); + private final DataBroker dataBroker; + + TopologyMonitor(final DataBroker dataBroker) { + this.dataBroker = Preconditions.checkNotNull(dataBroker); + } + + @Override + public synchronized void onDataTreeChanged(final Collection> changes) { + for (DataTreeModification c : changes) { + @SuppressWarnings("unchecked") + final KeyedInstanceIdentifier topology = + (KeyedInstanceIdentifier) c.getRootPath().getRootIdentifier() + .firstIdentifierOf(Topology.class); + + Preconditions.checkArgument(!topology.isWildcarded(), "Wildcard topology %s is not supported", topology); + + final DataObjectModification mod = c.getRootNode(); + switch (mod.getModificationType()) { + case DELETE: + LOG.debug("Topology {} removed", topology); + stopDomain(topology); + break; + case WRITE: + LOG.debug("Topology {} added", topology); + startDomain(topology); + break; + default: + LOG.warn("Ignoring unhandled modification type {}", mod.getModificationType()); + break; + } + } + } + + private synchronized void completeDomain(final KeyedInstanceIdentifier topology) { + LOG.debug("Bridge domain for {} completed operation", topology); + domains.remove(topology); + + synchronized (domains) { + domains.notify(); + } + } + + private synchronized void restartDomain(final KeyedInstanceIdentifier topology) { + final BridgeDomain prev = domains.remove(topology); + if (prev == null) { + LOG.warn("No domain for {}, not restarting", topology); + return; + } + + prev.forceStop(); + startDomain(topology); + } + + @GuardedBy("this") + private void startDomain(final KeyedInstanceIdentifier topology) { + final BridgeDomain prev = domains.get(topology.getKey()); + if (prev != null) { + LOG.warn("Bridge domain {} for {} already started", prev, topology); + return; + } + + LOG.debug("Starting bridge domain for {}", topology); + + final BindingTransactionChain chain = dataBroker.createTransactionChain(new TransactionChainListener() { + @Override + public void onTransactionChainSuccessful(final TransactionChain chain) { + completeDomain(topology); + } + + @Override + public void onTransactionChainFailed(final TransactionChain chain, + final AsyncTransaction transaction, final Throwable cause) { + LOG.warn("Bridge domain for {} failed, restarting it", cause); + restartDomain(topology); + } + }); + + final BridgeDomain domain = BridgeDomain.create(dataBroker, topology, chain); + domains.put(topology.getKey(), domain); + + LOG.debug("Bridge domain {} for {} started", domain, topology); + } + + @GuardedBy("this") + private void stopDomain(final KeyedInstanceIdentifier topology) { + final BridgeDomain domain = domains.remove(topology.getKey()); + if (domain == null) { + LOG.warn("Bridge domain for {} not present", topology); + return; + } + + domain.stop(); + } + + @Override + public synchronized void close() { + LOG.debug("Topology monitor {} shut down started", this); + + for (Entry e : domains.entrySet()) { + LOG.debug("Shutting down bridge domain {} (key {})", e.getValue(), e.getKey()); + e.getValue().stop(); + } + + while (!domains.isEmpty()) { + LOG.debug("Waiting for domains for {} to complete", domains.keySet()); + synchronized (domains) { + try { + domains.wait(); + } catch (InterruptedException e) { + LOG.warn("Interrupted while waiting for domain shutdown, {} have not completed yet", + domains.keySet(), e); + break; + } + } + } + + LOG.debug("Topology monitor {} shut down completed", this); + } +} diff --git a/vbd/impl/src/main/java/io/fd/honeycomb/vbd/impl/VirtualBridgeDomainManager.java b/vbd/impl/src/main/java/io/fd/honeycomb/vbd/impl/VirtualBridgeDomainManager.java new file mode 100644 index 000000000..37da73159 --- /dev/null +++ b/vbd/impl/src/main/java/io/fd/honeycomb/vbd/impl/VirtualBridgeDomainManager.java @@ -0,0 +1,65 @@ +/* + * 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 io.fd.honeycomb.vbd.impl; + +import com.google.common.base.Preconditions; +import javax.annotation.Nonnull; +import org.opendaylight.controller.md.sal.binding.api.DataBroker; +import org.opendaylight.controller.md.sal.binding.api.DataTreeIdentifier; +import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType; +import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vbridge.topology.rev160129.TopologyTypes1; +import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vbridge.topology.rev160129.network.topology.topology.topology.types.VbridgeTopology; +import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NetworkTopology; +import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.Topology; +import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.TopologyTypes; +import org.opendaylight.yangtools.concepts.ListenerRegistration; +import org.opendaylight.yangtools.yang.binding.InstanceIdentifier; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +/** + * Tip for the Virtual Bridge Domain implementation. This class is instantiated when the application is started + * and {@link #close()}d when it is shut down. + */ +public final class VirtualBridgeDomainManager implements AutoCloseable { + private static final Logger LOG = LoggerFactory.getLogger(VirtualBridgeDomainManager.class); + private static final DataTreeIdentifier LISTEN_TREE = + new DataTreeIdentifier<>(LogicalDatastoreType.CONFIGURATION, + InstanceIdentifier.builder(NetworkTopology.class).child(Topology.class).child(TopologyTypes.class) + .augmentation(TopologyTypes1.class).child(VbridgeTopology.class).build()); + + private final ListenerRegistration reg; + private boolean closed; + + private VirtualBridgeDomainManager(final ListenerRegistration reg) { + this.reg = Preconditions.checkNotNull(reg); + } + + public static VirtualBridgeDomainManager create(@Nonnull final DataBroker dataBroker) { + final ListenerRegistration reg = + dataBroker.registerDataTreeChangeListener(LISTEN_TREE, new TopologyMonitor(dataBroker)); + + return new VirtualBridgeDomainManager(reg); + } + + @Override + public void close() { + if (!closed) { + LOG.debug("Virtual Bridge Domain manager shut down started"); + + final TopologyMonitor monitor = reg.getInstance(); + reg.close(); + LOG.debug("Topology monitor {} unregistered", monitor); + monitor.close(); + + closed = true; + LOG.debug("Virtual Bridge Domain manager shut down completed"); + } + } +} -- cgit 1.2.3-korg