bgp/topology-provider/src/main/java/org/opendaylight/bgpcep/bgp/topology/provider/LinkstateTopologyBuilder.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 static java.util.Objects.requireNonNull;
  11
  12 import com.google.common.annotations.VisibleForTesting;
  13 import com.google.common.base.Preconditions;
  14 import com.google.common.collect.Collections2;
  15 import com.google.common.collect.Lists;
  16 import java.util.ArrayList;
  17 import java.util.HashMap;
  18 import java.util.HashSet;
  19 import java.util.List;
  20 import java.util.Map;
  21 import java.util.Set;
  22 import org.opendaylight.mdsal.binding.api.DataBroker;
  23 import org.opendaylight.mdsal.binding.api.ReadWriteTransaction;
  24 import org.opendaylight.mdsal.binding.api.WriteTransaction;
  25 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  26 import org.opendaylight.protocol.bgp.rib.RibReference;
  27 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.DomainName;
  28 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
  29 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev180329.Ipv4InterfaceIdentifier;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev180329.Ipv6InterfaceIdentifier;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev180329.LinkstateAddressFamily;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev180329.LinkstateSubsequentAddressFamily;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev180329.TopologyIdentifier;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev180329.bgp.rib.rib.loc.rib.tables.routes.LinkstateRoutesCase;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev180329.linkstate.ObjectType;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev180329.linkstate.object.type.LinkCase;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev180329.linkstate.object.type.NodeCase;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev180329.linkstate.object.type.PrefixCase;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev180329.linkstate.object.type.link._case.LinkDescriptors;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev180329.linkstate.path.attribute.LinkStateAttribute;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev180329.linkstate.path.attribute.link.state.attribute.LinkAttributesCase;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev180329.linkstate.path.attribute.link.state.attribute.NodeAttributesCase;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev180329.linkstate.path.attribute.link.state.attribute.PrefixAttributesCase;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev180329.linkstate.path.attribute.link.state.attribute.link.attributes._case.LinkAttributes;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev180329.linkstate.path.attribute.link.state.attribute.node.attributes._case.NodeAttributes;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev180329.linkstate.path.attribute.link.state.attribute.prefix.attributes._case.PrefixAttributes;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev180329.linkstate.routes.LinkstateRoutes;
  49 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev180329.linkstate.routes.linkstate.routes.LinkstateRoute;
  50 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev180329.linkstate.routes.linkstate.routes.linkstate.route.Attributes1;
  51 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.path.attributes.Attributes;
  52 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.rib.Tables;
  53 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.odl.bgp.topology.types.rev160524.TopologyTypes1;
  54 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.odl.bgp.topology.types.rev160524.TopologyTypes1Builder;
  55 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.odl.bgp.topology.types.rev160524.bgp.linkstate.topology.type.BgpLinkstateTopologyBuilder;
  56 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.LinkId;
  57 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
  58 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.TopologyId;
  59 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.TpId;
  60 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.link.attributes.DestinationBuilder;
  61 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.link.attributes.SourceBuilder;
  62 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Link;
  63 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.LinkBuilder;
  64 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.LinkKey;
  65 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
  66 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeBuilder;
  67 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeKey;
  68 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.TopologyTypes;
  69 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.TopologyTypesBuilder;
  70 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.node.TerminationPoint;
  71 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.node.TerminationPointBuilder;
  72 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.node.TerminationPointKey;
  73 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.nt.l3.unicast.igp.topology.rev131021.Link1;
  74 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.nt.l3.unicast.igp.topology.rev131021.Link1Builder;
  75 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.nt.l3.unicast.igp.topology.rev131021.Node1;
  76 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.nt.l3.unicast.igp.topology.rev131021.Node1Builder;
  77 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.nt.l3.unicast.igp.topology.rev131021.TerminationPoint1;
  78 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.nt.l3.unicast.igp.topology.rev131021.TerminationPoint1Builder;
  79 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.nt.l3.unicast.igp.topology.rev131021.igp.link.attributes.IgpLinkAttributesBuilder;
  80 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.nt.l3.unicast.igp.topology.rev131021.igp.node.attributes.IgpNodeAttributes;
  81 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.nt.l3.unicast.igp.topology.rev131021.igp.node.attributes.IgpNodeAttributesBuilder;
  82 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.nt.l3.unicast.igp.topology.rev131021.igp.node.attributes.igp.node.attributes.Prefix;
  83 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.nt.l3.unicast.igp.topology.rev131021.igp.node.attributes.igp.node.attributes.PrefixBuilder;
  84 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.nt.l3.unicast.igp.topology.rev131021.igp.node.attributes.igp.node.attributes.PrefixKey;
  85 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.nt.l3.unicast.igp.topology.rev131021.igp.termination.point.attributes.IgpTerminationPointAttributesBuilder;
  86 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.nt.l3.unicast.igp.topology.rev131021.igp.termination.point.attributes.igp.termination.point.attributes.TerminationPointType;
  87 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.nt.l3.unicast.igp.topology.rev131021.igp.termination.point.attributes.igp.termination.point.attributes.termination.point.type.IpBuilder;
  88 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.nt.l3.unicast.igp.topology.rev131021.igp.termination.point.attributes.igp.termination.point.attributes.termination.point.type.UnnumberedBuilder;
  89 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  90 import org.opendaylight.yangtools.yang.common.Uint32;
  91 import org.slf4j.Logger;
  92 import org.slf4j.LoggerFactory;
  93
  94 public class LinkstateTopologyBuilder extends AbstractTopologyBuilder<LinkstateRoute> {
  95     private static final TopologyTypes LINKSTATE_TOPOLOGY_TYPE = new TopologyTypesBuilder()
  96             .addAugmentation(TopologyTypes1.class, new TopologyTypes1Builder()
  97                     .setBgpLinkstateTopology(new BgpLinkstateTopologyBuilder().build()).build()).build();
  98
  99     private static final String UNHANDLED_OBJECT_CLASS = "Unhandled object class {}";
 100
 101     private static final class TpHolder {
 102         private final Set<LinkId> local = new HashSet<>();
 103         private final Set<LinkId> remote = new HashSet<>();
 104
 105         private final TerminationPoint tp;
 106
 107         TpHolder(final TerminationPoint tp) {
 108             this.tp = requireNonNull(tp);
 109         }
 110
 111         synchronized void addLink(final LinkId id, final boolean isRemote) {
 112             if (isRemote) {
 113                 this.remote.add(id);
 114             } else {
 115                 this.local.add(id);
 116             }
 117         }
 118
 119         synchronized boolean removeLink(final LinkId id, final boolean isRemote) {
 120             final boolean removed;
 121             if (isRemote) {
 122                 removed = this.remote.remove(id);
 123             } else {
 124                 removed = this.local.remove(id);
 125             }
 126             if (!removed) {
 127                 LOG.warn("Removed non-reference link {} from TP {} isRemote {}", this.tp.getTpId(), id, isRemote);
 128             }
 129
 130             return this.local.isEmpty() && this.remote.isEmpty();
 131         }
 132
 133         TerminationPoint getTp() {
 134             return this.tp;
 135         }
 136     }
 137
 138     private final class NodeHolder {
 139         private final Map<PrefixKey, Prefix> prefixes = new HashMap<>();
 140         private final Map<TpId, TpHolder> tps = new HashMap<>();
 141         private boolean advertized = false;
 142         private IgpNodeAttributesBuilder inab;
 143         private NodeBuilder nb;
 144
 145         NodeHolder(final NodeId id) {
 146             this.inab = new IgpNodeAttributesBuilder();
 147             this.nb = new NodeBuilder().withKey(new NodeKey(id)).setNodeId(id);
 148         }
 149
 150         /**
 151          * Synchronized in-core state of a node into the backing store using the transaction.
 152          *
 153          * @param trans data modification transaction which to use
 154          * @return True if the node has been purged, false otherwise.
 155          */
 156         boolean syncState(final WriteTransaction trans) {
 157             final InstanceIdentifier<Node> nid = getNodeInstanceIdentifier(this.nb.key());
 158
 159             /*
 160              * Transaction's putOperationalData() does a merge. Force it onto a replace
 161              * by removing the data. If we decide to remove the node -- we just skip the put.
 162              */
 163             trans.delete(LogicalDatastoreType.OPERATIONAL, nid);
 164
 165             if (!this.advertized) {
 166                 if (this.tps.isEmpty() && this.prefixes.isEmpty()) {
 167                     LOG.trace("Removing unadvertized unused node {}", this.nb.getNodeId());
 168                     return true;
 169                 }
 170
 171                 LOG.trace("Node {} is still implied by {} TPs and {} prefixes", this.nb.getNodeId(), this.tps.size(),
 172                         this.prefixes.size());
 173             }
 174
 175             // Re-generate termination points
 176             this.nb.setTerminationPoint(Lists.newArrayList(Collections2.transform(this.tps.values(), TpHolder::getTp)));
 177
 178             // Re-generate prefixes
 179             this.inab.setPrefix(Lists.newArrayList(this.prefixes.values()));
 180
 181             // Write the node out
 182             final Node n = this.nb.addAugmentation(Node1.class, new Node1Builder()
 183                     .setIgpNodeAttributes(this.inab.build()).build()).build();
 184             trans.put(LogicalDatastoreType.OPERATIONAL, nid, n);
 185             LOG.trace("Created node {} at {}", n, nid);
 186             return false;
 187         }
 188
 189         boolean checkForRemoval(final WriteTransaction trans) {
 190             final InstanceIdentifier<Node> nid = getNodeInstanceIdentifier(this.nb.key());
 191
 192             if (!this.advertized) {
 193                 if (this.tps.isEmpty() && this.prefixes.isEmpty()) {
 194                     trans.delete(LogicalDatastoreType.OPERATIONAL, nid);
 195                     LOG.trace("Removing unadvertized unused node {}", this.nb.getNodeId());
 196                     return true;
 197                 }
 198
 199                 LOG.trace("Node {} is still implied by {} TPs and {} prefixes", this.nb.getNodeId(),
 200                         this.tps.size(), this.prefixes.size());
 201             }
 202             return false;
 203         }
 204
 205         synchronized void removeTp(final TpId tp, final LinkId link, final boolean isRemote) {
 206             final TpHolder h = this.tps.get(tp);
 207             if (h != null) {
 208                 if (h.removeLink(link, isRemote)) {
 209                     this.tps.remove(tp);
 210                     LOG.trace("Removed TP {}", tp);
 211                 }
 212             } else {
 213                 LOG.warn("Removed non-present TP {} by link {}", tp, link);
 214             }
 215         }
 216
 217         void addTp(final TerminationPoint tp, final LinkId link, final boolean isRemote) {
 218             final TpHolder h = this.tps.computeIfAbsent(tp.getTpId(), k -> new TpHolder(tp));
 219             h.addLink(link, isRemote);
 220         }
 221
 222         void addPrefix(final Prefix pfx) {
 223             this.prefixes.put(pfx.key(), pfx);
 224         }
 225
 226         void removePrefix(final PrefixCase prefixCase) {
 227             this.prefixes.remove(new PrefixKey(prefixCase.getPrefixDescriptors().getIpReachabilityInformation()));
 228         }
 229
 230         void unadvertized() {
 231             this.inab = new IgpNodeAttributesBuilder();
 232             this.nb = new NodeBuilder().withKey(this.nb.key()).setNodeId(this.nb.getNodeId());
 233             this.advertized = false;
 234             LOG.debug("Node {} is unadvertized", this.nb.getNodeId());
 235         }
 236
 237         void advertized(final NodeBuilder nodeBuilder, final IgpNodeAttributesBuilder igpNodeAttBuilder) {
 238             this.nb = requireNonNull(nodeBuilder);
 239             this.inab = requireNonNull(igpNodeAttBuilder);
 240             this.advertized = true;
 241             LOG.debug("Node {} is advertized", nodeBuilder.getNodeId());
 242         }
 243
 244         NodeId getNodeId() {
 245             return this.nb.getNodeId();
 246         }
 247     }
 248
 249     private static final Logger LOG = LoggerFactory.getLogger(LinkstateTopologyBuilder.class);
 250     private final Map<NodeId, NodeHolder> nodes = new HashMap<>();
 251
 252     public LinkstateTopologyBuilder(final DataBroker dataProvider, final RibReference locRibReference,
 253             final TopologyId topologyId) {
 254         super(dataProvider, locRibReference, topologyId, LINKSTATE_TOPOLOGY_TYPE, LinkstateAddressFamily.class,
 255                 LinkstateSubsequentAddressFamily.class);
 256     }
 257
 258     @VisibleForTesting
 259     LinkstateTopologyBuilder(final DataBroker dataProvider, final RibReference locRibReference,
 260             final TopologyId topologyId, final long listenerResetLimitInMillsec,
 261             final int listenerResetEnforceCounter) {
 262         super(dataProvider, locRibReference, topologyId, LINKSTATE_TOPOLOGY_TYPE, LinkstateAddressFamily.class,
 263                 LinkstateSubsequentAddressFamily.class,
 264                 listenerResetLimitInMillsec, listenerResetEnforceCounter);
 265     }
 266
 267     private static LinkId buildLinkId(final UriBuilder base, final LinkCase link) {
 268         return new LinkId(new UriBuilder(base, "link").add(link).toString());
 269     }
 270
 271     private static NodeId buildNodeId(final UriBuilder base, final org.opendaylight.yang.gen.v1.urn.opendaylight
 272             .params.xml.ns.yang.bgp.linkstate.rev180329.NodeIdentifier node) {
 273         return new NodeId(new UriBuilder(base, "node").addPrefix("", node).toString());
 274     }
 275
 276     private static TpId buildTpId(final UriBuilder base, final TopologyIdentifier topologyIdentifier,
 277             final Ipv4InterfaceIdentifier ipv4InterfaceIdentifier,
 278             final Ipv6InterfaceIdentifier ipv6InterfaceIdentifier, final Uint32 id) {
 279         final UriBuilder b = new UriBuilder(base, "tp");
 280         if (topologyIdentifier != null) {
 281             b.add("mt", topologyIdentifier.getValue());
 282         }
 283         if (ipv4InterfaceIdentifier != null) {
 284             b.add("ipv4", ipv4InterfaceIdentifier.getValue());
 285         }
 286         if (ipv6InterfaceIdentifier != null) {
 287             b.add("ipv6", ipv6InterfaceIdentifier.getValue());
 288         }
 289
 290         return new TpId(b.add("id", id).toString());
 291     }
 292
 293     private static TpId buildLocalTpId(final UriBuilder base, final LinkDescriptors linkDescriptors) {
 294         return buildTpId(base, linkDescriptors.getMultiTopologyId(), linkDescriptors.getIpv4InterfaceAddress(),
 295                 linkDescriptors.getIpv6InterfaceAddress(), linkDescriptors.getLinkLocalIdentifier());
 296     }
 297
 298     private static TerminationPoint buildTp(final TpId id, final TerminationPointType type) {
 299         final TerminationPointBuilder stpb = new TerminationPointBuilder();
 300         stpb.withKey(new TerminationPointKey(id));
 301         stpb.setTpId(id);
 302
 303         if (type != null) {
 304             stpb.addAugmentation(TerminationPoint1.class, new TerminationPoint1Builder()
 305                     .setIgpTerminationPointAttributes(
 306                     new IgpTerminationPointAttributesBuilder().setTerminationPointType(type).build()).build());
 307         }
 308
 309         return stpb.build();
 310     }
 311
 312     private static TerminationPointType getTpType(final Ipv4InterfaceIdentifier ipv4InterfaceIdentifier,
 313             final Ipv6InterfaceIdentifier ipv6InterfaceIdentifier, final Uint32 id) {
 314         // Order of preference: Unnumbered first, then IP
 315         if (id != null) {
 316             LOG.debug("Unnumbered termination point type: {}", id);
 317             return new UnnumberedBuilder().setUnnumberedId(id).build();
 318         }
 319
 320         final IpAddress ip;
 321         if (ipv6InterfaceIdentifier != null) {
 322             ip = new IpAddress(ipv6InterfaceIdentifier);
 323         } else if (ipv4InterfaceIdentifier != null) {
 324             ip = new IpAddress(ipv4InterfaceIdentifier);
 325         } else {
 326             ip = null;
 327         }
 328
 329         if (ip != null) {
 330             LOG.debug("IP termination point type: {}", ip);
 331             return new IpBuilder().setIpAddress(Lists.newArrayList(ip)).build();
 332         }
 333
 334         return null;
 335     }
 336
 337     private static TerminationPoint buildLocalTp(final UriBuilder base, final LinkDescriptors linkDescriptors) {
 338         final TpId id = buildLocalTpId(base, linkDescriptors);
 339         final TerminationPointType t = getTpType(linkDescriptors.getIpv4InterfaceAddress(),
 340                 linkDescriptors.getIpv6InterfaceAddress(),
 341                 linkDescriptors.getLinkLocalIdentifier());
 342
 343         return buildTp(id, t);
 344     }
 345
 346     private static TpId buildRemoteTpId(final UriBuilder base, final LinkDescriptors linkDescriptors) {
 347         return buildTpId(base, linkDescriptors.getMultiTopologyId(), linkDescriptors.getIpv4NeighborAddress(),
 348                 linkDescriptors.getIpv6NeighborAddress(), linkDescriptors.getLinkRemoteIdentifier());
 349     }
 350
 351     private static TerminationPoint buildRemoteTp(final UriBuilder base, final LinkDescriptors linkDescriptors) {
 352         final TpId id = buildRemoteTpId(base, linkDescriptors);
 353         final TerminationPointType t = getTpType(linkDescriptors.getIpv4NeighborAddress(),
 354                 linkDescriptors.getIpv6NeighborAddress(),
 355                 linkDescriptors.getLinkRemoteIdentifier());
 356
 357         return buildTp(id, t);
 358     }
 359
 360     private InstanceIdentifier<Link> buildLinkIdentifier(final LinkId id) {
 361         return getInstanceIdentifier().child(
 362                 org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology
 363                         .topology.Link.class, new LinkKey(id));
 364     }
 365
 366     private NodeHolder getNode(final NodeId id) {
 367         return this.nodes.computeIfAbsent(id, NodeHolder::new);
 368     }
 369
 370     private void putNode(final WriteTransaction trans, final NodeHolder holder) {
 371         if (holder.syncState(trans)) {
 372             this.nodes.remove(holder.getNodeId());
 373         }
 374     }
 375
 376     private void checkNodeForRemoval(final WriteTransaction trans, final NodeHolder holder) {
 377         if (holder.checkForRemoval(trans)) {
 378             this.nodes.remove(holder.getNodeId());
 379         }
 380     }
 381
 382     private void createLink(final WriteTransaction trans, final UriBuilder base,
 383             final LinkstateRoute value, final LinkCase linkCase, final Attributes attributes) {
 384         // defensive lookup
 385         final LinkAttributes la;
 386         final Attributes1 attr = attributes.augmentation(Attributes1.class);
 387         if (attr != null) {
 388             final LinkStateAttribute attrType = attr.getLinkStateAttribute();
 389             if (attrType != null) {
 390                 la = ((LinkAttributesCase)attrType).getLinkAttributes();
 391             } else {
 392                 LOG.debug("Missing attribute type in link {} route {}, skipping it", linkCase, value);
 393                 la = null;
 394             }
 395         } else {
 396             LOG.debug("Missing attributes in link {} route {}, skipping it", linkCase, value);
 397             la = null;
 398         }
 399
 400         final IgpLinkAttributesBuilder ilab = new IgpLinkAttributesBuilder();
 401         if (la != null) {
 402             if (la.getMetric() != null) {
 403                 ilab.setMetric(la.getMetric().getValue());
 404             }
 405             ilab.setName(la.getLinkName());
 406         }
 407         ProtocolUtil.augmentProtocolId(value, ilab, la, linkCase.getLinkDescriptors());
 408
 409         final LinkBuilder lb = new LinkBuilder();
 410         lb.setLinkId(buildLinkId(base, linkCase));
 411         lb.addAugmentation(Link1.class, new Link1Builder().setIgpLinkAttributes(ilab.build()).build());
 412
 413         final NodeId srcNode = buildNodeId(base, linkCase.getLocalNodeDescriptors());
 414         LOG.trace("Link {} implies source node {}", linkCase, srcNode);
 415
 416         final NodeId dstNode = buildNodeId(base, linkCase.getRemoteNodeDescriptors());
 417         LOG.trace("Link {} implies destination node {}", linkCase, dstNode);
 418
 419         final TerminationPoint srcTp = buildLocalTp(base, linkCase.getLinkDescriptors());
 420         LOG.trace("Link {} implies source TP {}", linkCase, srcTp);
 421
 422         final TerminationPoint dstTp = buildRemoteTp(base, linkCase.getLinkDescriptors());
 423         LOG.trace("Link {} implies destination TP {}", linkCase, dstTp);
 424
 425         lb.setSource(new SourceBuilder().setSourceNode(srcNode).setSourceTp(srcTp.getTpId()).build());
 426         lb.setDestination(new DestinationBuilder().setDestNode(dstNode).setDestTp(dstTp.getTpId()).build());
 427
 428         LOG.trace("Created TP {} as link source", srcTp);
 429         NodeHolder snh = this.nodes.get(srcNode);
 430         if (snh == null) {
 431             snh = getNode(srcNode);
 432             snh.addTp(srcTp, lb.getLinkId(), false);
 433             putNode(trans, snh);
 434         } else {
 435             snh.addTp(srcTp, lb.getLinkId(), false);
 436             final InstanceIdentifier<Node> nid = getNodeInstanceIdentifier(new NodeKey(snh.getNodeId()));
 437             trans.put(LogicalDatastoreType.OPERATIONAL, nid.child(TerminationPoint.class, srcTp.key()), srcTp);
 438         }
 439
 440         LOG.debug("Created TP {} as link destination", dstTp);
 441         NodeHolder dnh = this.nodes.get(dstNode);
 442         if (dnh == null) {
 443             dnh = getNode(dstNode);
 444             dnh.addTp(dstTp, lb.getLinkId(), true);
 445             putNode(trans, dnh);
 446         } else {
 447             dnh.addTp(dstTp, lb.getLinkId(), true);
 448             final InstanceIdentifier<Node> nid = getInstanceIdentifier().child(
 449                     org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network
 450                             .topology.topology.Node.class, new NodeKey(dnh.getNodeId()));
 451             trans.put(LogicalDatastoreType.OPERATIONAL, nid.child(TerminationPoint.class, dstTp.key()), dstTp);
 452         }
 453
 454         final InstanceIdentifier<Link> lid = buildLinkIdentifier(lb.getLinkId());
 455         final Link link = lb.build();
 456
 457         trans.put(LogicalDatastoreType.OPERATIONAL, lid, link);
 458         LOG.debug("Created link {} at {} for {}", link, lid, linkCase);
 459     }
 460
 461     private void removeTp(final WriteTransaction trans, final NodeId node, final TpId tp,
 462             final LinkId link, final boolean isRemote) {
 463         final NodeHolder nh = this.nodes.get(node);
 464         if (nh != null) {
 465             final InstanceIdentifier<Node> nid = getNodeInstanceIdentifier(new NodeKey(nh.getNodeId()));
 466             trans.delete(LogicalDatastoreType.OPERATIONAL, nid.child(TerminationPoint.class,
 467                     new TerminationPointKey(tp)));
 468             nh.removeTp(tp, link, isRemote);
 469             checkNodeForRemoval(trans, nh);
 470         } else {
 471             LOG.warn("Removed non-existent node {}", node);
 472         }
 473     }
 474
 475     private void removeLink(final WriteTransaction trans, final UriBuilder base, final LinkCase linkCase) {
 476         final LinkId id = buildLinkId(base, linkCase);
 477         final InstanceIdentifier<?> lid = buildLinkIdentifier(id);
 478         trans.delete(LogicalDatastoreType.OPERATIONAL, lid);
 479         LOG.debug("Removed link {}", lid);
 480
 481         removeTp(trans, buildNodeId(base, linkCase.getLocalNodeDescriptors()),
 482                 buildLocalTpId(base, linkCase.getLinkDescriptors()), id, false);
 483         removeTp(trans, buildNodeId(base, linkCase.getRemoteNodeDescriptors()),
 484                 buildRemoteTpId(base, linkCase.getLinkDescriptors()), id, true);
 485     }
 486
 487     private void createNode(final WriteTransaction trans, final UriBuilder base,
 488             final LinkstateRoute value, final NodeCase nodeCase, final Attributes attributes) {
 489         final NodeAttributes na;
 490         //defensive lookup
 491         final Attributes1 attr = attributes.augmentation(Attributes1.class);
 492         if (attr != null) {
 493             final LinkStateAttribute attrType = attr.getLinkStateAttribute();
 494             if (attrType != null) {
 495                 na = ((NodeAttributesCase)attrType).getNodeAttributes();
 496             } else {
 497                 LOG.debug("Missing attribute type in node {} route {}, skipping it", nodeCase, value);
 498                 na = null;
 499             }
 500         } else {
 501             LOG.debug("Missing attributes in node {} route {}, skipping it", nodeCase, value);
 502             na = null;
 503         }
 504         final IgpNodeAttributesBuilder inab = new IgpNodeAttributesBuilder();
 505         final List<IpAddress> ids = new ArrayList<>();
 506         if (na != null) {
 507             if (na.getIpv4RouterId() != null) {
 508                 ids.add(new IpAddress(na.getIpv4RouterId()));
 509             }
 510             if (na.getIpv6RouterId() != null) {
 511                 ids.add(new IpAddress(na.getIpv6RouterId()));
 512             }
 513             if (na.getDynamicHostname() != null) {
 514                 inab.setName(new DomainName(na.getDynamicHostname()));
 515             }
 516         }
 517         if (!ids.isEmpty()) {
 518             inab.setRouterId(ids);
 519         }
 520         ProtocolUtil.augmentProtocolId(value, inab, na, nodeCase.getNodeDescriptors());
 521
 522         final NodeId nid = buildNodeId(base, nodeCase.getNodeDescriptors());
 523         final NodeHolder nh = getNode(nid);
 524         /*
 525          *  Eventhough the the holder creates a dummy structure, we need to duplicate it here,
 526          *  as that is the API requirement. The reason for it is the possible presence of supporting
 527          *  node -- something which the holder does not track.
 528          */
 529         final NodeBuilder nb = new NodeBuilder();
 530         nb.setNodeId(nid);
 531         nb.withKey(new NodeKey(nb.getNodeId()));
 532
 533         nh.advertized(nb, inab);
 534         putNode(trans, nh);
 535     }
 536
 537     private void removeNode(final WriteTransaction trans, final UriBuilder base, final NodeCase nodeCase) {
 538         final NodeId id = buildNodeId(base, nodeCase.getNodeDescriptors());
 539         final NodeHolder nh = this.nodes.get(id);
 540         if (nh != null) {
 541             nh.unadvertized();
 542             putNode(trans, nh);
 543         } else {
 544             LOG.warn("Node {} does not have a holder", id);
 545         }
 546     }
 547
 548     private void createPrefix(final WriteTransaction trans, final UriBuilder base,
 549             final LinkstateRoute value, final PrefixCase prefixCase, final Attributes attributes) {
 550         final IpPrefix ippfx = prefixCase.getPrefixDescriptors().getIpReachabilityInformation();
 551         if (ippfx == null) {
 552             LOG.warn("IP reachability not present in prefix {} route {}, skipping it", prefixCase, value);
 553             return;
 554         }
 555         final PrefixBuilder pb = new PrefixBuilder();
 556         final PrefixKey pk = new PrefixKey(ippfx);
 557         pb.withKey(pk);
 558         pb.setPrefix(ippfx);
 559
 560         final PrefixAttributes pa;
 561         // Very defensive lookup
 562         final Attributes1 attr = attributes.augmentation(Attributes1.class);
 563         if (attr != null) {
 564             final LinkStateAttribute attrType = attr.getLinkStateAttribute();
 565             if (attrType != null) {
 566                 pa = ((PrefixAttributesCase)attrType).getPrefixAttributes();
 567             } else {
 568                 LOG.debug("Missing attribute type in IP {} prefix {} route {}, skipping it", ippfx, prefixCase, value);
 569                 pa = null;
 570             }
 571         } else {
 572             LOG.debug("Missing attributes in IP {} prefix {} route {}, skipping it", ippfx, prefixCase, value);
 573             pa = null;
 574         }
 575         if (pa != null && pa.getPrefixMetric() != null) {
 576             pb.setMetric(pa.getPrefixMetric().getValue());
 577         }
 578         ProtocolUtil.augmentProtocolId(value, pa, pb);
 579
 580         final Prefix pfx = pb.build();
 581         LOG.debug("Created prefix {} for {}", pfx, prefixCase);
 582
 583         /*
 584          * All set, but... the hosting node may not exist, we may need to fake it.
 585          */
 586         final NodeId node = buildNodeId(base, prefixCase.getAdvertisingNodeDescriptors());
 587         NodeHolder nh = this.nodes.get(node);
 588         if (nh == null) {
 589             nh = getNode(node);
 590             nh.addPrefix(pfx);
 591             putNode(trans, nh);
 592         } else {
 593             nh.addPrefix(pfx);
 594             final InstanceIdentifier<Node> nid = getNodeInstanceIdentifier(new NodeKey(nh.getNodeId()));
 595             final InstanceIdentifier<IgpNodeAttributes> inaId = nid.builder().augmentation(Node1.class)
 596                     .child(IgpNodeAttributes.class).build();
 597             trans.put(LogicalDatastoreType.OPERATIONAL, inaId.child(Prefix.class, pk), pfx);
 598         }
 599     }
 600
 601     private void removePrefix(final WriteTransaction trans, final UriBuilder base, final PrefixCase prefixCase) {
 602         final NodeId node = buildNodeId(base, prefixCase.getAdvertisingNodeDescriptors());
 603         final NodeHolder nh = this.nodes.get(node);
 604         if (nh != null) {
 605             LOG.debug("Removed prefix {}", prefixCase);
 606             final InstanceIdentifier<Node> nid = getNodeInstanceIdentifier(new NodeKey(nh.getNodeId()));
 607             final InstanceIdentifier<IgpNodeAttributes> inaId = nid.builder().augmentation(Node1.class)
 608                     .child(IgpNodeAttributes.class).build();
 609             final IpPrefix ippfx = prefixCase.getPrefixDescriptors().getIpReachabilityInformation();
 610             if (ippfx == null) {
 611                 LOG.warn("IP reachability not present in prefix {}, skipping it", prefixCase);
 612                 return;
 613             }
 614             final PrefixKey pk = new PrefixKey(ippfx);
 615             trans.delete(LogicalDatastoreType.OPERATIONAL, inaId.child(Prefix.class, pk));
 616             nh.removePrefix(prefixCase);
 617             checkNodeForRemoval(trans, nh);
 618         } else {
 619             LOG.warn("Removing prefix from non-existing node {}", node);
 620         }
 621     }
 622
 623     private InstanceIdentifier<Node> getNodeInstanceIdentifier(final NodeKey nodeKey) {
 624         return getInstanceIdentifier().child(
 625                 org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network
 626                         .topology.topology.Node.class, nodeKey);
 627     }
 628
 629     @Override
 630     protected void createObject(final ReadWriteTransaction trans,
 631             final InstanceIdentifier<LinkstateRoute> id, final LinkstateRoute value) {
 632         final UriBuilder base = new UriBuilder(value);
 633
 634         final ObjectType t = value.getObjectType();
 635         Preconditions.checkArgument(t != null, "Route %s value %s has null object type", id, value);
 636
 637         if (t instanceof LinkCase) {
 638             createLink(trans, base, value, (LinkCase) t, value.getAttributes());
 639         } else if (t instanceof NodeCase) {
 640             createNode(trans, base, value, (NodeCase) t, value.getAttributes());
 641         } else if (t instanceof PrefixCase) {
 642             createPrefix(trans, base, value, (PrefixCase) t, value.getAttributes());
 643         } else {
 644             LOG.debug(UNHANDLED_OBJECT_CLASS, t.implementedInterface());
 645         }
 646     }
 647
 648     @Override
 649     protected void removeObject(final ReadWriteTransaction trans,
 650             final InstanceIdentifier<LinkstateRoute> id, final LinkstateRoute value) {
 651         if (value == null) {
 652             LOG.error("Empty before-data received in delete data change notification for instance id {}", id);
 653             return;
 654         }
 655
 656         final UriBuilder base = new UriBuilder(value);
 657
 658         final ObjectType t = value.getObjectType();
 659         if (t instanceof LinkCase) {
 660             removeLink(trans, base, (LinkCase) t);
 661         } else if (t instanceof NodeCase) {
 662             removeNode(trans, base, (NodeCase) t);
 663         } else if (t instanceof PrefixCase) {
 664             removePrefix(trans, base, (PrefixCase) t);
 665         } else {
 666             LOG.debug(UNHANDLED_OBJECT_CLASS, t.implementedInterface());
 667         }
 668     }
 669
 670     @Override
 671     protected InstanceIdentifier<LinkstateRoute> getRouteWildcard(final InstanceIdentifier<Tables> tablesId) {
 672         return tablesId.child(LinkstateRoutesCase.class, LinkstateRoutes.class).child(LinkstateRoute.class);
 673     }
 674
 675     @Override
 676     protected void clearTopology() {
 677         this.nodes.clear();
 678     }
 679 }