opendaylight/md-sal/topology-manager/src/main/java/org/opendaylight/md/controller/topology/manager/FlowCapableTopologyExporter.java

   1 /*
   2  * Copyright (c) 2014 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.md.controller.topology.manager;
   9
  10 import static org.opendaylight.md.controller.topology.manager.FlowCapableNodeMapping.getNodeConnectorKey;
  11 import static org.opendaylight.md.controller.topology.manager.FlowCapableNodeMapping.getNodeKey;
  12 import static org.opendaylight.md.controller.topology.manager.FlowCapableNodeMapping.toTerminationPoint;
  13 import static org.opendaylight.md.controller.topology.manager.FlowCapableNodeMapping.toTerminationPointId;
  14 import static org.opendaylight.md.controller.topology.manager.FlowCapableNodeMapping.toTopologyLink;
  15 import static org.opendaylight.md.controller.topology.manager.FlowCapableNodeMapping.toTopologyNode;
  16 import static org.opendaylight.md.controller.topology.manager.FlowCapableNodeMapping.toTopologyNodeId;
  17
  18 import java.util.Collection;
  19 import java.util.Collections;
  20 import java.util.List;
  21 import org.opendaylight.controller.md.sal.binding.api.ReadWriteTransaction;
  22 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  23 import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNodeConnectorUpdated;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNodeUpdated;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.topology.discovery.rev130819.FlowTopologyDiscoveryListener;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.topology.discovery.rev130819.LinkDiscovered;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.topology.discovery.rev130819.LinkOverutilized;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.topology.discovery.rev130819.LinkRemoved;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.topology.discovery.rev130819.LinkUtilizationNormal;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorRef;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorRemoved;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorUpdated;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRemoved;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeUpdated;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.OpendaylightInventoryListener;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnectorKey;
  39 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
  40 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.TpId;
  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.topology.Link;
  43 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
  44 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeKey;
  45 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.node.TerminationPoint;
  46 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.node.TerminationPointKey;
  47 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  48 import org.slf4j.Logger;
  49 import org.slf4j.LoggerFactory;
  50
  51 import com.google.common.base.Optional;
  52 import com.google.common.base.Preconditions;
  53 import com.google.common.collect.Lists;
  54 import com.google.common.util.concurrent.CheckedFuture;
  55 import com.google.common.util.concurrent.FutureCallback;
  56 import com.google.common.util.concurrent.Futures;
  57
  58 class FlowCapableTopologyExporter implements FlowTopologyDiscoveryListener, OpendaylightInventoryListener {
  59
  60     private static final Logger LOG = LoggerFactory.getLogger(FlowCapableTopologyExporter.class);
  61     private final InstanceIdentifier<Topology> topology;
  62     private final OperationProcessor processor;
  63
  64     FlowCapableTopologyExporter(final OperationProcessor processor,
  65             final InstanceIdentifier<Topology> topology) {
  66         this.processor = Preconditions.checkNotNull(processor);
  67         this.topology = Preconditions.checkNotNull(topology);
  68     }
  69
  70     @Override
  71     public void onNodeRemoved(final NodeRemoved notification) {
  72
  73         final NodeId nodeId = toTopologyNodeId(getNodeKey(notification.getNodeRef()).getId());
  74         final InstanceIdentifier<Node> nodeInstance = toNodeIdentifier(notification.getNodeRef());
  75
  76         processor.enqueueOperation(new TopologyOperation() {
  77             @Override
  78             public void applyOperation(ReadWriteTransaction transaction) {
  79                 removeAffectedLinks(nodeId, transaction);
  80                 transaction.delete(LogicalDatastoreType.OPERATIONAL, nodeInstance);
  81             }
  82
  83             @Override
  84             public String toString() {
  85                 return "onNodeRemoved";
  86             }
  87         });
  88     }
  89
  90     @Override
  91     public void onNodeUpdated(final NodeUpdated notification) {
  92         FlowCapableNodeUpdated fcnu = notification.getAugmentation(FlowCapableNodeUpdated.class);
  93         if (fcnu != null) {
  94             processor.enqueueOperation(new TopologyOperation() {
  95                 @Override
  96                 public void applyOperation(final ReadWriteTransaction transaction) {
  97                     final Node node = toTopologyNode(toTopologyNodeId(notification.getId()), notification.getNodeRef());
  98                     final InstanceIdentifier<Node> path = getNodePath(toTopologyNodeId(notification.getId()));
  99                     transaction.merge(LogicalDatastoreType.OPERATIONAL, path, node, true);
 100                 }
 101
 102                 @Override
 103                 public String toString() {
 104                     return "onNodeUpdated";
 105                 }
 106             });
 107         }
 108     }
 109
 110     @Override
 111     public void onNodeConnectorRemoved(final NodeConnectorRemoved notification) {
 112
 113         final InstanceIdentifier<TerminationPoint> tpInstance = toTerminationPointIdentifier(
 114                 notification.getNodeConnectorRef());
 115
 116         final TpId tpId = toTerminationPointId(getNodeConnectorKey(
 117                 notification.getNodeConnectorRef()).getId());
 118
 119         processor.enqueueOperation(new TopologyOperation() {
 120             @Override
 121             public void applyOperation(ReadWriteTransaction transaction) {
 122                 removeAffectedLinks(tpId, transaction);
 123                 transaction.delete(LogicalDatastoreType.OPERATIONAL, tpInstance);
 124             }
 125
 126             @Override
 127             public String toString() {
 128                 return "onNodeConnectorRemoved";
 129             }
 130         });
 131     }
 132
 133     @Override
 134     public void onNodeConnectorUpdated(final NodeConnectorUpdated notification) {
 135         final FlowCapableNodeConnectorUpdated fcncu = notification.getAugmentation(
 136                 FlowCapableNodeConnectorUpdated.class);
 137         if (fcncu != null) {
 138             processor.enqueueOperation(new TopologyOperation() {
 139                 @Override
 140                 public void applyOperation(final ReadWriteTransaction transaction) {
 141                     final NodeId nodeId = toTopologyNodeId(getNodeKey(notification.getNodeConnectorRef()).getId());
 142                     TerminationPoint point = toTerminationPoint(toTerminationPointId(notification.getId()),
 143                             notification.getNodeConnectorRef());
 144                     final InstanceIdentifier<TerminationPoint> path = tpPath(nodeId, point.getKey().getTpId());
 145                     transaction.merge(LogicalDatastoreType.OPERATIONAL, path, point, true);
 146                     if ((fcncu.getState() != null && fcncu.getState().isLinkDown())
 147                             || (fcncu.getConfiguration() != null && fcncu.getConfiguration().isPORTDOWN())) {
 148                         removeAffectedLinks(point.getTpId(), transaction);
 149                     }
 150                 }
 151
 152                 @Override
 153                 public String toString() {
 154                     return "onNodeConnectorUpdated";
 155                 }
 156             });
 157         }
 158     }
 159
 160     @Override
 161     public void onLinkDiscovered(final LinkDiscovered notification) {
 162         processor.enqueueOperation(new TopologyOperation() {
 163             @Override
 164             public void applyOperation(final ReadWriteTransaction transaction) {
 165                 final Link link = toTopologyLink(notification);
 166                 final InstanceIdentifier<Link> path = linkPath(link);
 167                 transaction.merge(LogicalDatastoreType.OPERATIONAL, path, link, true);
 168             }
 169
 170             @Override
 171             public String toString() {
 172                 return "onLinkDiscovered";
 173             }
 174         });
 175     }
 176
 177     @Override
 178     public void onLinkOverutilized(final LinkOverutilized notification) {
 179         // NOOP
 180     }
 181
 182     @Override
 183     public void onLinkRemoved(final LinkRemoved notification) {
 184         processor.enqueueOperation(new TopologyOperation() {
 185             @Override
 186             public void applyOperation(final ReadWriteTransaction transaction) {
 187                 transaction.delete(LogicalDatastoreType.OPERATIONAL, linkPath(toTopologyLink(notification)));
 188             }
 189
 190             @Override
 191             public String toString() {
 192                 return "onLinkRemoved";
 193             }
 194         });
 195     }
 196
 197     @Override
 198     public void onLinkUtilizationNormal(final LinkUtilizationNormal notification) {
 199         // NOOP
 200     }
 201
 202     private InstanceIdentifier<Node> toNodeIdentifier(final NodeRef ref) {
 203         org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeKey invNodeKey = getNodeKey(ref);
 204         NodeKey nodeKey = new NodeKey(toTopologyNodeId(invNodeKey.getId()));
 205         return topology.child(Node.class, nodeKey);
 206     }
 207
 208     private InstanceIdentifier<TerminationPoint> toTerminationPointIdentifier(final NodeConnectorRef ref) {
 209         org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeKey invNodeKey = getNodeKey(ref);
 210         NodeConnectorKey invNodeConnectorKey = getNodeConnectorKey(ref);
 211         return tpPath(toTopologyNodeId(invNodeKey.getId()), toTerminationPointId(invNodeConnectorKey.getId()));
 212     }
 213
 214     private void removeAffectedLinks(final NodeId id, final ReadWriteTransaction transaction) {
 215         CheckedFuture<Optional<Topology>, ReadFailedException> topologyDataFuture =
 216                 transaction.read(LogicalDatastoreType.OPERATIONAL, topology);
 217         Futures.addCallback(topologyDataFuture, new FutureCallback<Optional<Topology>>() {
 218             @Override
 219             public void onSuccess(Optional<Topology> topologyOptional) {
 220                 removeAffectedLinks(id, topologyOptional);
 221             }
 222
 223             @Override
 224             public void onFailure(Throwable throwable) {
 225                 LOG.error("Error reading topology data for topology {}", topology, throwable);
 226             }
 227         });
 228     }
 229
 230     private void removeAffectedLinks(final NodeId id, Optional<Topology> topologyOptional) {
 231         if (!topologyOptional.isPresent()) {
 232             return;
 233         }
 234
 235         List<Link> linkList = topologyOptional.get().getLink() != null ?
 236                 topologyOptional.get().getLink() : Collections.<Link> emptyList();
 237         final List<InstanceIdentifier<Link>> linkIDsToDelete = Lists.newArrayList();
 238         for (Link link : linkList) {
 239             if (id.equals(link.getSource().getSourceNode()) ||
 240                     id.equals(link.getDestination().getDestNode())) {
 241                 linkIDsToDelete.add(linkPath(link));
 242             }
 243         }
 244
 245         enqueueLinkDeletes(linkIDsToDelete);
 246     }
 247
 248     private void enqueueLinkDeletes(final Collection<InstanceIdentifier<Link>> linkIDsToDelete) {
 249         if(!linkIDsToDelete.isEmpty()) {
 250             processor.enqueueOperation(new TopologyOperation() {
 251                 @Override
 252                 public void applyOperation(ReadWriteTransaction transaction) {
 253                     for(InstanceIdentifier<Link> linkID: linkIDsToDelete) {
 254                         transaction.delete(LogicalDatastoreType.OPERATIONAL, linkID);
 255                     }
 256                 }
 257
 258                 @Override
 259                 public String toString() {
 260                     return "Delete Links " + linkIDsToDelete.size();
 261                 }
 262             });
 263         }
 264     }
 265
 266     private void removeAffectedLinks(final TpId id, final ReadWriteTransaction transaction) {
 267         CheckedFuture<Optional<Topology>, ReadFailedException> topologyDataFuture =
 268                 transaction.read(LogicalDatastoreType.OPERATIONAL, topology);
 269         Futures.addCallback(topologyDataFuture, new FutureCallback<Optional<Topology>>() {
 270             @Override
 271             public void onSuccess(Optional<Topology> topologyOptional) {
 272                 removeAffectedLinks(id, topologyOptional);
 273             }
 274
 275             @Override
 276             public void onFailure(Throwable throwable) {
 277                 LOG.error("Error reading topology data for topology {}", topology, throwable);
 278             }
 279         });
 280     }
 281
 282     private void removeAffectedLinks(final TpId id, Optional<Topology> topologyOptional) {
 283         if (!topologyOptional.isPresent()) {
 284             return;
 285         }
 286
 287         List<Link> linkList = topologyOptional.get().getLink() != null
 288                 ? topologyOptional.get().getLink() : Collections.<Link> emptyList();
 289         final List<InstanceIdentifier<Link>> linkIDsToDelete = Lists.newArrayList();
 290         for (Link link : linkList) {
 291             if (id.equals(link.getSource().getSourceTp()) ||
 292                     id.equals(link.getDestination().getDestTp())) {
 293                 linkIDsToDelete.add(linkPath(link));
 294             }
 295         }
 296
 297         enqueueLinkDeletes(linkIDsToDelete);
 298     }
 299
 300     private InstanceIdentifier<Node> getNodePath(final NodeId nodeId) {
 301         return topology.child(Node.class, new NodeKey(nodeId));
 302     }
 303
 304     private InstanceIdentifier<TerminationPoint> tpPath(final NodeId nodeId, final TpId tpId) {
 305         NodeKey nodeKey = new NodeKey(nodeId);
 306         TerminationPointKey tpKey = new TerminationPointKey(tpId);
 307         return topology.child(Node.class, nodeKey).child(TerminationPoint.class, tpKey);
 308     }
 309
 310     private InstanceIdentifier<Link> linkPath(final Link link) {
 311         return topology.child(Link.class, link.getKey());
 312     }
 313 }