bgp/rib-impl/src/main/java/org/opendaylight/protocol/bgp/rib/impl/IPv4RIBSupport.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.annotations.VisibleForTesting;
  11 import com.google.common.base.Optional;
  12 import com.google.common.collect.ImmutableCollection;
  13 import com.google.common.collect.ImmutableMap;
  14 import com.google.common.collect.ImmutableSet;
  15 import java.util.ArrayList;
  16 import java.util.Collection;
  17 import java.util.List;
  18 import javax.annotation.Nonnull;
  19 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.Ipv4Prefix;
  20 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev150305.bgp.rib.rib.loc.rib.tables.routes.Ipv4RoutesCase;
  21 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev150305.ipv4.prefixes.DestinationIpv4;
  22 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev150305.ipv4.prefixes.DestinationIpv4Builder;
  23 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev150305.ipv4.prefixes.destination.ipv4.Ipv4Prefixes;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev150305.ipv4.prefixes.destination.ipv4.Ipv4PrefixesBuilder;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev150305.ipv4.routes.Ipv4Routes;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev150305.ipv4.routes.ipv4.routes.Ipv4Route;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev150305.update.attributes.mp.reach.nlri.advertized.routes.destination.type.DestinationIpv4CaseBuilder;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.PathId;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.update.attributes.MpReachNlri;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.update.attributes.MpReachNlriBuilder;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.update.attributes.MpUnreachNlri;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.update.attributes.MpUnreachNlriBuilder;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.update.attributes.mp.reach.nlri.AdvertizedRoutesBuilder;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.update.attributes.mp.unreach.nlri.WithdrawnRoutesBuilder;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.rib.tables.Routes;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.Ipv4AddressFamily;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.UnicastSubsequentAddressFamily;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.next.hop.CNextHop;
  39 import org.opendaylight.yangtools.yang.binding.DataObject;
  40 import org.opendaylight.yangtools.yang.common.QName;
  41 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  42 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
  43 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  44 import org.opendaylight.yangtools.yang.data.api.schema.ChoiceNode;
  45 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
  46 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
  47 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  48 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNodes;
  49 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
  50 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
  51
  52 /**
  53  * Class supporting IPv4 unicast RIBs.
  54  */
  55 final class IPv4RIBSupport extends AbstractIPRIBSupport {
  56     @VisibleForTesting
  57     static final QName PREFIX_QNAME = QName.create(Ipv4Route.QNAME, "prefix").intern();
  58     private static final QName PATHID_QNAME = QName.create(Ipv4Route.QNAME, "path-id").intern();
  59     private static final IPv4RIBSupport SINGLETON = new IPv4RIBSupport();
  60     private static final ImmutableCollection<Class<? extends DataObject>> CACHEABLE_NLRI_OBJECTS =
  61             ImmutableSet.<Class<? extends DataObject>>of(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev150305.Ipv4Prefix.class);
  62     private final ChoiceNode emptyRoutes = Builders.choiceBuilder()
  63             .withNodeIdentifier(new NodeIdentifier(Routes.QNAME))
  64             .addChild(Builders.containerBuilder()
  65                 .withNodeIdentifier(new NodeIdentifier(Ipv4Routes.QNAME))
  66                 .withChild(ImmutableNodes.mapNodeBuilder(Ipv4Route.QNAME).build()).build()).build();
  67     private final NodeIdentifier destination = new NodeIdentifier(DestinationIpv4.QNAME);
  68     private final NodeIdentifier ipv4Route = new NodeIdentifier(Ipv4Route.QNAME);
  69     private final NodeIdentifier nlriRoutesList = new NodeIdentifier(Ipv4Prefixes.QNAME);
  70     private final NodeIdentifier routeKeyLeaf = new NodeIdentifier(PREFIX_QNAME);
  71     private final NodeIdentifier pathIdLeaf = new NodeIdentifier(PATHID_QNAME);
  72
  73     private IPv4RIBSupport() {
  74         super(Ipv4RoutesCase.class, Ipv4Routes.class, Ipv4Route.class);
  75     }
  76
  77     static IPv4RIBSupport getInstance() {
  78         return SINGLETON;
  79     }
  80
  81     @Override
  82     public ChoiceNode emptyRoutes() {
  83         return this.emptyRoutes;
  84     }
  85
  86     @Override
  87     protected NodeIdentifier destinationContainerIdentifier() {
  88         return this.destination;
  89     }
  90
  91     @Override
  92     protected NodeIdentifier routeIdentifier() {
  93         return this.ipv4Route;
  94     }
  95
  96     @Override
  97     protected NodeIdentifier routeKeyLeafIdentifier() {
  98         return this.routeKeyLeaf;
  99     }
 100
 101     @Override
 102     protected NodeIdentifier nlriRoutesListIdentifier() {
 103         return this.nlriRoutesList;
 104     }
 105
 106     @Override
 107     protected QName keyLeafQName() {
 108         return PREFIX_QNAME;
 109     }
 110
 111     @Override
 112     protected QName routeQName() {
 113         return Ipv4Route.QNAME;
 114     }
 115
 116     @Override
 117     public ImmutableCollection<Class<? extends DataObject>> cacheableNlriObjects() {
 118         return CACHEABLE_NLRI_OBJECTS;
 119     }
 120
 121     @Nonnull
 122     @Override
 123     public PathArgument getRouteIdAddPath(final long pathId, final PathArgument routeId) {
 124         final String prefix = (String) (((NodeIdentifierWithPredicates) routeId).getKeyValues()).get(PREFIX_QNAME);
 125         final ImmutableMap<QName, Object> keyValues = ImmutableMap.of(PATHID_QNAME, pathId, PREFIX_QNAME, prefix);
 126
 127         return new NodeIdentifierWithPredicates(Ipv4Route.QNAME, keyValues);
 128     }
 129
 130     @Override
 131     public long extractPathId(final NormalizedNode<?, ?> data) {
 132         final NormalizedNode<?, ?> pathId = NormalizedNodes.findNode(data, pathIdLeaf).orNull();
 133         if (pathId == null) {
 134             return 0;
 135         }
 136         return (Long) pathId.getValue();
 137     }
 138
 139     private List<Ipv4Prefixes> extractPrefixes(final Collection<MapEntryNode> routes) {
 140         final List<Ipv4Prefixes> prefs = new ArrayList<>(routes.size());
 141         for (final MapEntryNode route : routes) {
 142             final String prefix = (String) route.getChild(this.routeKeyLeaf).get().getValue();
 143             final Ipv4PrefixesBuilder prefixBuilder = new Ipv4PrefixesBuilder().setPrefix(new Ipv4Prefix(prefix));
 144             final Optional<DataContainerChild<? extends PathArgument, ?>> pathIdChild = route.getChild(this.pathIdLeaf);
 145             if(pathIdChild.isPresent()) {
 146                 prefixBuilder.setPathId(new PathId((Long) pathIdChild.get().getValue()));
 147             }
 148             prefs.add(prefixBuilder.build());
 149         }
 150         return prefs;
 151     }
 152
 153     @Override
 154     protected MpReachNlri buildReach(final Collection<MapEntryNode> routes, final CNextHop hop) {
 155         final MpReachNlriBuilder mb = new MpReachNlriBuilder();
 156         mb.setAfi(Ipv4AddressFamily.class);
 157         mb.setSafi(UnicastSubsequentAddressFamily.class);
 158         mb.setCNextHop(hop);
 159         mb.setAdvertizedRoutes(new AdvertizedRoutesBuilder().setDestinationType(
 160             new DestinationIpv4CaseBuilder().setDestinationIpv4(
 161                 new DestinationIpv4Builder().setIpv4Prefixes(extractPrefixes(routes)).build()).build()).build());
 162         return mb.build();
 163     }
 164
 165     @Override
 166     protected MpUnreachNlri buildUnreach(final Collection<MapEntryNode> routes) {
 167         final MpUnreachNlriBuilder mb = new MpUnreachNlriBuilder();
 168         mb.setAfi(Ipv4AddressFamily.class);
 169         mb.setSafi(UnicastSubsequentAddressFamily.class);
 170         mb.setWithdrawnRoutes(new WithdrawnRoutesBuilder().setDestinationType(
 171             new org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev150305.update.attributes.mp.unreach.nlri.withdrawn.routes.destination.type.DestinationIpv4CaseBuilder().setDestinationIpv4(
 172                 new DestinationIpv4Builder().setIpv4Prefixes(extractPrefixes(routes)).build()).build()).build());
 173         return mb.build();
 174     }
 175 }