bgp/rib-impl/src/main/java/org/opendaylight/protocol/bgp/rib/impl/AttributeOperations.java

   1 /*
   2  * Copyright (c) 2015 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.protocol.bgp.rib.impl;
   9
  10 import com.google.common.base.Optional;
  11 import com.google.common.cache.CacheBuilder;
  12 import com.google.common.cache.CacheLoader;
  13 import com.google.common.cache.LoadingCache;
  14 import com.google.common.collect.ImmutableList;
  15 import com.google.common.collect.ImmutableSet;
  16 import java.util.Iterator;
  17 import org.opendaylight.protocol.util.Values;
  18 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address;
  19 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.path.attributes.attributes.AsPath;
  20 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.path.attributes.attributes.ClusterId;
  21 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.path.attributes.attributes.Communities;
  22 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.path.attributes.attributes.ExtendedCommunities;
  23 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.path.attributes.attributes.Origin;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.path.attributes.attributes.OriginatorId;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.path.attributes.attributes.UnrecognizedAttributes;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.path.attributes.attributes.as.path.Segments;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.ClusterIdentifier;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.next.hop.CNextHop;
  29 import org.opendaylight.yangtools.yang.common.QName;
  30 import org.opendaylight.yangtools.yang.common.QNameModule;
  31 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.AugmentationIdentifier;
  32 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  33 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeWithValue;
  34 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  35 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  36 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
  37 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
  38 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetEntryNode;
  39 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetNode;
  40 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  41 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNodes;
  42 import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListEntryNode;
  43 import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListNode;
  44 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
  45 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
  46 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.CollectionNodeBuilder;
  47 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.DataContainerNodeAttrBuilder;
  48 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.ListNodeBuilder;
  49 import org.slf4j.Logger;
  50 import org.slf4j.LoggerFactory;
  51
  52 /**
  53  * Utility class for working with route attributes in binding independent form. An instance
  54  * is always bound to a certain namespace, so it maintains cached attribute identifiers.
  55  */
  56 final class AttributeOperations {
  57     private static final Logger LOG = LoggerFactory.getLogger(AttributeOperations.class);
  58     private static final LoadingCache<QNameModule, AttributeOperations> ATTRIBUTES_CACHE = CacheBuilder.newBuilder().weakKeys().weakValues().build(
  59         new CacheLoader<QNameModule, AttributeOperations>() {
  60             @Override
  61             public AttributeOperations load(final QNameModule key) throws Exception {
  62                 return new AttributeOperations(key);
  63             }
  64         });
  65     private static final LoadingCache<QNameModule, ImmutableSet<QName>> TRANSITIVE_CACHE = CacheBuilder.newBuilder()
  66         .weakKeys()
  67         .weakValues().build(
  68             new CacheLoader<QNameModule, ImmutableSet<QName>>() {
  69                 @Override
  70                 public ImmutableSet<QName> load(final QNameModule key) {
  71                     return ImmutableSet.of(QName.create(key, Origin.QNAME.getLocalName()).intern(),
  72                         QName.create(key, AsPath.QNAME.getLocalName()).intern(),
  73                         QName.create(key, CNextHop.QNAME.getLocalName()).intern(),
  74                         QName.create(key, Communities.QNAME.getLocalName()).intern(),
  75                         QName.create(key, ExtendedCommunities.QNAME.getLocalName()).intern());
  76                 }
  77             });
  78     private final ImmutableSet<QName> transitiveCollection;
  79     private final Iterable<PathArgument> originatorIdPath;
  80     private final Iterable<PathArgument> clusterListPath;
  81     private final NodeIdentifier originatorIdContainer;
  82     private final NodeIdentifier originatorIdLeaf;
  83     private final NodeIdentifier clusterListContainer;
  84     private final NodeIdentifier clusterListLeaf;
  85     private final QName clusterQname;
  86     private final NodeIdentifier asPathContainer;
  87     private final NodeIdentifier asPathSegments;
  88     private final NodeIdentifier asPathSequence;
  89     private final QName asNumberQname;
  90     private final NodeIdentifier transitiveLeaf;
  91
  92     private AttributeOperations(final QNameModule namespace) {
  93         this.asPathContainer = new NodeIdentifier(QName.create(namespace, AsPath.QNAME.getLocalName()).intern());
  94         this.asPathSegments = new NodeIdentifier(QName.create(namespace, Segments.QNAME.getLocalName()).intern());
  95         this.asPathSequence = new NodeIdentifier(QName.create(namespace, "as-sequence").intern());
  96         this.asNumberQname = QName.create(namespace, "as-number").intern();
  97
  98         this.clusterListContainer = new NodeIdentifier(QName.create(namespace, ClusterId.QNAME.getLocalName()).intern());
  99         this.clusterQname = QName.create(namespace, "cluster").intern();
 100         this.clusterListLeaf = new NodeIdentifier(this.clusterQname);
 101         this.clusterListPath = ImmutableList.<PathArgument>of(this.clusterListContainer, this.clusterListLeaf);
 102         this.originatorIdContainer = new NodeIdentifier(QName.create(namespace, OriginatorId.QNAME.getLocalName()).intern());
 103         this.originatorIdLeaf = new NodeIdentifier(QName.create(namespace, "originator").intern());
 104         this.originatorIdPath = ImmutableList.<PathArgument>of(this.originatorIdContainer, this.originatorIdLeaf);
 105
 106         this.transitiveLeaf = new NodeIdentifier(QName.create(UnrecognizedAttributes.QNAME, "transitive").intern());
 107         this.transitiveCollection = TRANSITIVE_CACHE.getUnchecked(namespace);
 108     }
 109
 110     static AttributeOperations getInstance(final ContainerNode attributes) {
 111         return ATTRIBUTES_CACHE.getUnchecked(attributes.getNodeType().getModule());
 112     }
 113
 114     private LeafSetNode<?> reusableSegment(final UnkeyedListEntryNode segment) {
 115         final Optional<NormalizedNode<?, ?>> maybeAsSequence = NormalizedNodes.findNode(segment, this.asPathSequence);
 116         if (maybeAsSequence.isPresent()) {
 117             final LeafSetNode<?> asList = (LeafSetNode<?>) maybeAsSequence.get();
 118             if (asList.getValue().size() < Values.UNSIGNED_BYTE_MAX_VALUE) {
 119                 return asList;
 120             }
 121         }
 122         return null;
 123     }
 124
 125     ContainerNode exportedAttributes(final ContainerNode attributes, final Long localAs) {
 126         final DataContainerNodeAttrBuilder<NodeIdentifier, ContainerNode> containerBuilder = Builders.containerBuilder();
 127         containerBuilder.withNodeIdentifier(attributes.getIdentifier());
 128
 129         // First filter out non-transitive attributes
 130         // FIXME: removes MULTI_EXIT_DISC, too.
 131         spliceTransitives(containerBuilder, attributes);
 132
 133         final CollectionNodeBuilder<UnkeyedListEntryNode, UnkeyedListNode> segmentsBuilder = Builders.unkeyedListBuilder();
 134         segmentsBuilder.withNodeIdentifier(this.asPathSegments);
 135
 136         final Optional<NormalizedNode<?, ?>> maybeOldAsSegments = NormalizedNodes.findNode(attributes, this.asPathContainer, this.asPathSegments);
 137         if (maybeOldAsSegments.isPresent() && !((UnkeyedListNode) maybeOldAsSegments.get()).getValue().isEmpty()) {
 138
 139             /*
 140              * We need to check the first segment.
 141              * If it has as-set then new as-sequence with local AS is prepended.
 142              * If it has as-sequence, we may add local AS when it has less than 255 elements.
 143              * Otherwise we need to create new as-sequence for local AS.
 144              */
 145
 146             final ListNodeBuilder<Object,LeafSetEntryNode<Object>> asSequenceBuilder = Builders.orderedLeafSetBuilder();
 147             // add local AS
 148             asSequenceBuilder.withNodeIdentifier(this.asPathSequence).addChild(Builders.leafSetEntryBuilder().withNodeIdentifier(new NodeWithValue(this.asNumberQname, localAs)).withValue(localAs).build());
 149
 150             final Iterator<UnkeyedListEntryNode> oldAsSegments = ((UnkeyedListNode) maybeOldAsSegments.get()).getValue().iterator();
 151             final UnkeyedListEntryNode firstSegment = oldAsSegments.next();
 152             final LeafSetNode<?> reusableAsSeq = reusableSegment(firstSegment);
 153             // first segment contains as-sequence with less then 255 elements and it's append to local AS
 154             if (reusableAsSeq != null) {
 155                 for (final LeafSetEntryNode<?> child : reusableAsSeq.getValue())  {
 156                     asSequenceBuilder.withChild(Builders.leafSetEntryBuilder().withNodeIdentifier(new NodeWithValue(this.asNumberQname, child.getValue())).withValue(child.getValue()).build());
 157                 }
 158             }
 159             // Add the new first segment
 160             segmentsBuilder.withChild(Builders.unkeyedListEntryBuilder().withNodeIdentifier(this.asPathSegments).withChild(asSequenceBuilder.build()).build());
 161
 162             // When first segment contains as-set or full as-sequence, append it
 163             if (reusableAsSeq == null) {
 164                 segmentsBuilder.withChild(firstSegment);
 165             }
 166
 167             // Add all subsequent segments
 168             while (oldAsSegments.hasNext()) {
 169                 segmentsBuilder.withChild(oldAsSegments.next());
 170             }
 171         } else {
 172             // Segments are completely empty, create a completely new AS_PATH container with
 173             // a single entry
 174             segmentsBuilder.withChild(Builders.unkeyedListEntryBuilder().withNodeIdentifier(this.asPathSegments).withChild(
 175                 Builders.orderedLeafSetBuilder().withNodeIdentifier(this.asPathSequence).addChild(
 176                     Builders.leafSetEntryBuilder().withNodeIdentifier(new NodeWithValue(this.asNumberQname, localAs)).withValue(localAs).build()).build()).build());
 177         }
 178
 179         containerBuilder.withChild(Builders.containerBuilder().withNodeIdentifier(this.asPathContainer).withChild(segmentsBuilder.build()).build());
 180         return containerBuilder.build();
 181     }
 182
 183     /**
 184      * Attributes when reflecting a route from Internal iBGP (Application Peer)
 185      * @param attributes
 186      * @return
 187      */
 188     ContainerNode reflectedAttributes(final ContainerNode attributes) {
 189         final DataContainerNodeAttrBuilder<NodeIdentifier, ContainerNode> attributesContainer = Builders.containerBuilder(attributes);
 190
 191         // if there was a CLUSTER_LIST attribute, add it
 192         final Optional<NormalizedNode<?, ?>> maybeClusterList = NormalizedNodes.findNode(attributes, this.clusterListPath);
 193         if (maybeClusterList.isPresent()) {
 194             // Create a new CLUSTER_LIST builder
 195             final ListNodeBuilder<Object, LeafSetEntryNode<Object>> clusterBuilder = Builders.orderedLeafSetBuilder();
 196             clusterBuilder.withNodeIdentifier(this.clusterListLeaf);
 197             AttributeOperations.addOtherClusterEntries(maybeClusterList, clusterBuilder);
 198             // Now wrap it in a container and add it to attributes
 199             final DataContainerNodeAttrBuilder<NodeIdentifier, ContainerNode> clusterListCont= Builders.containerBuilder();
 200             clusterListCont.withNodeIdentifier(this.clusterListContainer);
 201             clusterListCont.withChild(clusterBuilder.build());
 202             attributesContainer.withChild(clusterListCont.build());
 203         }
 204
 205         return attributesContainer.build();
 206     }
 207
 208     // Attributes when reflecting a route
 209     ContainerNode reflectedAttributes(final ContainerNode attributes, final Ipv4Address originatorId, final ClusterIdentifier clusterId) {
 210         final DataContainerNodeAttrBuilder<NodeIdentifier, ContainerNode> attributesContainer = Builders.containerBuilder(attributes);
 211
 212         // Create a new CLUSTER_LIST builder
 213         final ListNodeBuilder<Object, LeafSetEntryNode<Object>> clusterBuilder = Builders.orderedLeafSetBuilder();
 214         clusterBuilder.withNodeIdentifier(this.clusterListLeaf);
 215
 216         // prepend local CLUSTER_ID
 217         clusterBuilder.withChild(Builders.leafSetEntryBuilder().withNodeIdentifier(new NodeWithValue(this.clusterQname, clusterId.getValue())).
 218             withValue(clusterId.getValue()).build());
 219
 220         // if there was a CLUSTER_LIST attribute, add all other entries
 221         final Optional<NormalizedNode<?, ?>> maybeClusterList = NormalizedNodes.findNode(attributes, this.clusterListPath);
 222         if (maybeClusterList.isPresent()) {
 223             AttributeOperations.addOtherClusterEntries(maybeClusterList, clusterBuilder);
 224         } else {
 225             LOG.debug("Creating fresh CLUSTER_LIST attribute");
 226         }
 227
 228         // Now wrap it in a container and add it to attributes
 229         final DataContainerNodeAttrBuilder<NodeIdentifier, ContainerNode> clusterListCont = Builders.containerBuilder();
 230         clusterListCont.withNodeIdentifier(this.clusterListContainer);
 231         clusterListCont.withChild(clusterBuilder.build());
 232         attributesContainer.withChild(clusterListCont.build());
 233
 234         // add ORIGINATOR_ID if not present
 235         final Optional<NormalizedNode<?, ?>> maybeOriginatorId = NormalizedNodes.findNode(attributes, this.originatorIdPath);
 236         if (!maybeOriginatorId.isPresent()) {
 237             final DataContainerNodeAttrBuilder<NodeIdentifier, ContainerNode> originatorIDBuilder = Builders.containerBuilder();
 238             originatorIDBuilder.withNodeIdentifier(this.originatorIdContainer);
 239             originatorIDBuilder.withChild(ImmutableNodes.leafNode(this.originatorIdLeaf, originatorId.getValue()));
 240             attributesContainer.withChild(originatorIDBuilder.build());
 241         }
 242
 243         return attributesContainer.build();
 244     }
 245
 246     private static void addOtherClusterEntries(final Optional<NormalizedNode<?, ?>> maybeClusterList, final ListNodeBuilder<Object,
 247         LeafSetEntryNode<Object>> clb) {
 248         final NormalizedNode<?, ?> clusterList = maybeClusterList.get();
 249         if (clusterList instanceof LeafSetNode) {
 250             for (final LeafSetEntryNode<?> n : ((LeafSetNode<?>) clusterList).getValue()) {
 251                 // There's no way we can safely avoid this cast
 252                 @SuppressWarnings("unchecked")
 253                 final LeafSetEntryNode<Object> child = (LeafSetEntryNode<Object>) n;
 254                 clb.addChild(child);
 255             }
 256         } else {
 257             LOG.warn("Ignoring malformed CLUSTER_LIST {}", clusterList);
 258         }
 259     }
 260
 261     private boolean isTransitiveAttribute(final DataContainerChild<? extends PathArgument, ?> child) {
 262         if (child.getIdentifier() instanceof AugmentationIdentifier) {
 263             final AugmentationIdentifier ai = (AugmentationIdentifier) child.getIdentifier();
 264             for (final QName name : ai.getPossibleChildNames()) {
 265                 LOG.trace("Augmented QNAME {}", name);
 266                 if (this.transitiveCollection.contains(name)) {
 267                     return true;
 268                 }
 269             }
 270             return false;
 271         }
 272         if (this.transitiveCollection.contains(child.getNodeType())) {
 273             return true;
 274         }
 275         if (UnrecognizedAttributes.QNAME.equals(child.getNodeType())) {
 276             final Optional<NormalizedNode<?, ?>> maybeTransitive = NormalizedNodes.findNode(child, this.transitiveLeaf);
 277             if (maybeTransitive.isPresent()) {
 278                 return (Boolean) maybeTransitive.get().getValue();
 279             }
 280         }
 281         return false;
 282     }
 283
 284     private boolean spliceTransitives(final DataContainerNodeAttrBuilder<NodeIdentifier, ContainerNode> target, final ContainerNode attributes) {
 285         // We want to reuse attributes as much as possible, so the result of the loop
 286         // indicates whether we performed a modification. If we have not modified the
 287         // attributes, we can reuse them.
 288         boolean ret = false;
 289         for (final DataContainerChild<? extends PathArgument, ?> child : attributes.getValue()) {
 290             if (isTransitiveAttribute(child)) {
 291                 target.withChild(child);
 292             } else {
 293                 ret = true;
 294             }
 295         }
 296
 297         return ret;
 298     }
 299
 300     /**
 301      * Filter out all non-transitive attributes.
 302      *
 303      * @param attributes Input attributes
 304      * @return Output attributes, transitive only.
 305      */
 306     ContainerNode transitiveAttributes(final ContainerNode attributes) {
 307         final DataContainerNodeAttrBuilder<NodeIdentifier, ContainerNode> b = Builders.containerBuilder();
 308         b.withNodeIdentifier(attributes.getIdentifier());
 309
 310         final boolean modified = spliceTransitives(b, attributes);
 311         return modified ? b.build() : attributes;
 312     }
 313
 314     LeafSetNode<?> getClusterList(final ContainerNode attributes) {
 315         final Optional<NormalizedNode<?, ?>> maybeClusterList = NormalizedNodes.findNode(attributes, this.clusterListPath);
 316         if (maybeClusterList.isPresent()) {
 317             final NormalizedNode<?, ?> clusterList = maybeClusterList.get();
 318             if (clusterList instanceof LeafSetNode) {
 319                 return (LeafSetNode<?>) clusterList;
 320             }
 321
 322             LOG.warn("Unexpected CLUSTER_LIST node {}, ignoring it", clusterList);
 323         }
 324
 325         return null;
 326     }
 327
 328     Object getOriginatorId(final ContainerNode attributes) {
 329         final Optional<NormalizedNode<?, ?>> maybeOriginatorId = NormalizedNodes.findNode(attributes, this.originatorIdPath);
 330         if (!maybeOriginatorId.isPresent()) {
 331             LOG.debug("No ORIGINATOR_ID present");
 332             return null;
 333         }
 334
 335         final NormalizedNode<?, ?> originatorId = maybeOriginatorId.get();
 336         if (originatorId instanceof LeafNode) {
 337             return ((LeafNode<?>) originatorId).getValue();
 338         }
 339
 340         LOG.warn("Unexpected ORIGINATOR_ID node {}, ignoring it", originatorId);
 341         return null;
 342     }
 343 }