bgp/topology-provider/src/main/java/org/opendaylight/bgpcep/bgp/topology/provider/AbstractTopologyBuilder.java

   1 /*
   2  * Copyright (c) 2013 Cisco 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.bgpcep.bgp.topology.provider;
   9
  10 import com.google.common.base.Optional;
  11 import com.google.common.base.Preconditions;
  12 import com.google.common.util.concurrent.FutureCallback;
  13 import com.google.common.util.concurrent.Futures;
  14 import java.util.Collections;
  15 import java.util.HashSet;
  16 import java.util.Map;
  17 import java.util.Set;
  18 import java.util.concurrent.ExecutionException;
  19 import javax.annotation.concurrent.GuardedBy;
  20 import org.opendaylight.bgpcep.topology.TopologyReference;
  21 import org.opendaylight.controller.md.sal.binding.api.BindingTransactionChain;
  22 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  23 import org.opendaylight.controller.md.sal.binding.api.DataChangeListener;
  24 import org.opendaylight.controller.md.sal.binding.api.ReadWriteTransaction;
  25 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
  26 import org.opendaylight.controller.md.sal.common.api.data.AsyncDataChangeEvent;
  27 import org.opendaylight.controller.md.sal.common.api.data.AsyncTransaction;
  28 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  29 import org.opendaylight.controller.md.sal.common.api.data.TransactionChain;
  30 import org.opendaylight.controller.md.sal.common.api.data.TransactionChainListener;
  31 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
  32 import org.opendaylight.protocol.bgp.rib.RibReference;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.Route;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.bgp.rib.rib.LocRib;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.rib.Tables;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.rib.TablesKey;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.AddressFamily;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.SubsequentAddressFamily;
  39 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NetworkTopology;
  40 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.TopologyId;
  41 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.Topology;
  42 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.TopologyBuilder;
  43 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.TopologyKey;
  44 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Link;
  45 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
  46 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.TopologyTypes;
  47 import org.opendaylight.yangtools.yang.binding.DataObject;
  48 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  49 import org.slf4j.Logger;
  50 import org.slf4j.LoggerFactory;
  51
  52 public abstract class AbstractTopologyBuilder<T extends Route> implements AutoCloseable, DataChangeListener, LocRIBListener, TopologyReference, TransactionChainListener {
  53     private static final Logger LOG = LoggerFactory.getLogger(AbstractTopologyBuilder.class);
  54     private final InstanceIdentifier<Topology> topology;
  55     private final BindingTransactionChain chain;
  56     private final RibReference locRibReference;
  57     private final Class<T> idClass;
  58
  59     @GuardedBy("this")
  60     private boolean closed = false;
  61
  62     protected AbstractTopologyBuilder(final DataBroker dataProvider, final RibReference locRibReference,
  63             final TopologyId topologyId, final TopologyTypes types, final Class<T> idClass) {
  64         this.locRibReference = Preconditions.checkNotNull(locRibReference);
  65         this.idClass = Preconditions.checkNotNull(idClass);
  66         this.chain = dataProvider.createTransactionChain(this);
  67
  68         final TopologyKey tk = new TopologyKey(Preconditions.checkNotNull(topologyId));
  69         this.topology = InstanceIdentifier.builder(NetworkTopology.class).child(Topology.class, tk).toInstance();
  70
  71         LOG.debug("Initiating topology builder from {} at {}", locRibReference, this.topology);
  72
  73         final ReadWriteTransaction t = this.chain.newReadWriteTransaction();
  74         final Optional<Topology> o;
  75         try {
  76             o = t.read(LogicalDatastoreType.OPERATIONAL, this.topology).get();
  77         } catch (InterruptedException | ExecutionException e) {
  78             throw new IllegalStateException("Failed to read topology " + this.topology, e);
  79         }
  80         Preconditions.checkState(!o.isPresent(), "Data provider conflict detected on object {}", this.topology);
  81
  82         t.put(LogicalDatastoreType.OPERATIONAL, this.topology,
  83                 new TopologyBuilder().setKey(tk).setServerProvided(Boolean.TRUE).setTopologyTypes(types)
  84                     .setLink(Collections.<Link>emptyList()).setNode(Collections.<Node>emptyList()).build());
  85         Futures.addCallback(t.submit(), new FutureCallback<Void>() {
  86             @Override
  87             public void onSuccess(final Void result) {
  88                 LOG.trace("Transaction {} committed successfully", t.getIdentifier());
  89             }
  90
  91             @Override
  92             public void onFailure(final Throwable t) {
  93                 LOG.error("Failed to initiate topology {} by listener {}", AbstractTopologyBuilder.this.topology,
  94                         AbstractTopologyBuilder.this, t);
  95             }
  96         });
  97     }
  98
  99     public final InstanceIdentifier<Tables> tableInstanceIdentifier(final Class<? extends AddressFamily> afi,
 100             final Class<? extends SubsequentAddressFamily> safi) {
 101         return this.locRibReference.getInstanceIdentifier().builder().child(LocRib.class).child(Tables.class, new TablesKey(afi, safi)).toInstance();
 102     }
 103
 104     protected abstract void createObject(ReadWriteTransaction trans, InstanceIdentifier<T> id, T value);
 105
 106     protected abstract void removeObject(ReadWriteTransaction trans, InstanceIdentifier<T> id, T value);
 107
 108     @Override
 109     public final InstanceIdentifier<Topology> getInstanceIdentifier() {
 110         return this.topology;
 111     }
 112
 113     private void addIdentifier(final InstanceIdentifier<?> i, final String set, final Set<InstanceIdentifier<T>> out) {
 114         final InstanceIdentifier<T> id = i.firstIdentifierOf(this.idClass);
 115         if (id != null) {
 116             out.add(id);
 117         } else {
 118             LOG.debug("Identifier {} in {} set does not contain listening class {}, ignoring it", i, set, this.idClass);
 119         }
 120     }
 121
 122     @Override
 123     public synchronized final void onLocRIBChange(final ReadWriteTransaction trans,
 124             final AsyncDataChangeEvent<InstanceIdentifier<?>, DataObject> event) {
 125         LOG.debug("Received data change {} event with transaction {}", event, trans.getIdentifier());
 126         if (this.closed) {
 127             LOG.trace("Transaction chain was already closed, skipping update.");
 128             return;
 129         }
 130
 131         // FIXME: speed this up
 132         final Set<InstanceIdentifier<T>> ids = new HashSet<>();
 133         for (final InstanceIdentifier<?> i : event.getRemovedPaths()) {
 134             addIdentifier(i, "remove", ids);
 135         }
 136         for (final InstanceIdentifier<?> i : event.getUpdatedData().keySet()) {
 137             addIdentifier(i, "update", ids);
 138         }
 139         for (final InstanceIdentifier<?> i : event.getCreatedData().keySet()) {
 140             addIdentifier(i, "create", ids);
 141         }
 142
 143         final Map<InstanceIdentifier<?>, ? extends DataObject> o = event.getOriginalData();
 144         final Map<InstanceIdentifier<?>, DataObject> u = event.getUpdatedData();
 145         final Map<InstanceIdentifier<?>, DataObject> c = event.getCreatedData();
 146         for (final InstanceIdentifier<T> i : ids) {
 147             final T oldValue = this.idClass.cast(o.get(i));
 148             T newValue = this.idClass.cast(u.get(i));
 149             if (newValue == null) {
 150                 newValue = this.idClass.cast(c.get(i));
 151             }
 152
 153             LOG.debug("Updating object {} value {} -> {}", i, oldValue, newValue);
 154             if (oldValue != null) {
 155                 removeObject(trans, i, oldValue);
 156             }
 157             if (newValue != null) {
 158                 createObject(trans, i, newValue);
 159             }
 160         }
 161
 162         Futures.addCallback(trans.submit(), new FutureCallback<Void>() {
 163             @Override
 164             public void onSuccess(final Void result) {
 165                 LOG.trace("Transaction {} committed successfully", trans.getIdentifier());
 166             }
 167
 168             @Override
 169             public void onFailure(final Throwable t) {
 170                 LOG.error("Failed to propagate change by listener {}", AbstractTopologyBuilder.this);
 171             }
 172         });
 173     }
 174
 175     @Override
 176     public synchronized final void close() throws TransactionCommitFailedException {
 177         LOG.info("Shutting down builder for {}", getInstanceIdentifier());
 178         final WriteTransaction trans = this.chain.newWriteOnlyTransaction();
 179         trans.delete(LogicalDatastoreType.OPERATIONAL, getInstanceIdentifier());
 180         trans.submit().checkedGet();
 181         this.chain.close();
 182         this.closed = true;
 183     }
 184
 185     @Override
 186     public final void onDataChanged(final AsyncDataChangeEvent<InstanceIdentifier<?>, DataObject> change) {
 187         final ReadWriteTransaction trans = this.chain.newReadWriteTransaction();
 188
 189         try {
 190             onLocRIBChange(trans, change);
 191         } catch (final RuntimeException e) {
 192             LOG.warn("Data change {} was not completely propagated to listener {}", change, this, e);
 193             return;
 194         }
 195     }
 196
 197     @Override
 198     public final void onTransactionChainFailed(final TransactionChain<?, ?> chain, final AsyncTransaction<?, ?> transaction, final Throwable cause) {
 199         // TODO: restart?
 200         LOG.error("Topology builder for {} failed in transaction {}", getInstanceIdentifier(), transaction.getIdentifier(), cause);
 201     }
 202
 203     @Override
 204     public final void onTransactionChainSuccessful(final TransactionChain<?, ?> chain) {
 205         LOG.info("Topology builder for {} shut down", getInstanceIdentifier());
 206     }
 207 }