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