bgp/extensions/l3vpn/src/main/java/org/opendaylight/protocol/bgp/l3vpn/mcast/AbstractL3vpnMcastIpRIBSupport.java

   1 /*
   2  * Copyright (c) 2018 AT&T Intellectual Property. 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.l3vpn.mcast;
   9
  10 import com.google.common.collect.ImmutableCollection;
  11 import com.google.common.collect.ImmutableSet;
  12 import java.util.Collection;
  13 import java.util.List;
  14 import java.util.Optional;
  15 import java.util.stream.Collectors;
  16 import org.opendaylight.bgp.concepts.RouteDistinguisherUtil;
  17 import org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction;
  18 import org.opendaylight.mdsal.binding.dom.codec.api.BindingNormalizedNodeSerializer;
  19 import org.opendaylight.mdsal.binding.spec.reflect.BindingReflections;
  20 import org.opendaylight.protocol.bgp.parser.spi.PathIdUtil;
  21 import org.opendaylight.protocol.bgp.rib.spi.AbstractRIBSupport;
  22 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix;
  23 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.l3vpn.mcast.rev180417.L3vpnMcastRoutes;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.l3vpn.mcast.rev180417.McastMplsLabeledVpnSubsequentAddressFamily;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.l3vpn.mcast.rev180417.l3vpn.mcast.destination.L3vpnMcastDestination;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.l3vpn.mcast.rev180417.l3vpn.mcast.destination.L3vpnMcastDestinationBuilder;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.l3vpn.mcast.rev180417.l3vpn.mcast.routes.L3vpnMcastRoute;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.l3vpn.mcast.rev180417.l3vpn.mcast.routes.L3vpnMcastRouteBuilder;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.l3vpn.mcast.rev180417.l3vpn.mcast.routes.L3vpnMcastRouteKey;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.PathId;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.path.attributes.Attributes;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.rib.Tables;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.rib.tables.Routes;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev180329.AddressFamily;
  35 import org.opendaylight.yangtools.yang.binding.ChildOf;
  36 import org.opendaylight.yangtools.yang.binding.ChoiceIn;
  37 import org.opendaylight.yangtools.yang.binding.DataObject;
  38 import org.opendaylight.yangtools.yang.common.QName;
  39 import org.opendaylight.yangtools.yang.common.QNameModule;
  40 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  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.ContainerNode;
  45 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
  46 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerNode;
  47 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
  48 import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListEntryNode;
  49 import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListNode;
  50 import org.slf4j.Logger;
  51 import org.slf4j.LoggerFactory;
  52
  53 /**
  54  * Abstract L3VPN Multicast RIBSupport.
  55  *
  56  * @author Claudio D. Gasparini
  57  */
  58 abstract class AbstractL3vpnMcastIpRIBSupport<
  59         C extends Routes & DataObject & ChoiceIn<Tables>,
  60         S extends ChildOf<? super C> & L3vpnMcastRoutes>
  61         extends AbstractRIBSupport<C, S, L3vpnMcastRoute, L3vpnMcastRouteKey> {
  62     private static final Logger LOG = LoggerFactory.getLogger(AbstractL3vpnMcastIpRIBSupport.class);
  63     private final NodeIdentifier nlriRoutesList;
  64     private final NodeIdentifier rdNid;
  65     private final ImmutableCollection<Class<? extends DataObject>> cacheableNlriObjects;
  66
  67     /**
  68      * Default constructor. Requires the QName of the container augmented under the routes choice
  69      * node in instantiations of the rib grouping. It is assumed that this container is defined by
  70      * the same model which populates it with route grouping instantiation, and by extension with
  71      * the route attributes container.
  72      *
  73      * @param mappingService     Serialization service
  74      * @param cazeClass          Binding class of the AFI/SAFI-specific case statement, must not be null
  75      * @param afiClass           address Family Class
  76      * @param destContainerQname destination container Qname
  77      * @param destListQname      destinations list Qname
  78      */
  79     AbstractL3vpnMcastIpRIBSupport(
  80             final BindingNormalizedNodeSerializer mappingService,
  81             final Class<C> cazeClass,
  82             final Class<S> containerClass,
  83             final Class<? extends AddressFamily> afiClass,
  84             final QName destContainerQname,
  85             final QName destListQname) {
  86         super(mappingService, cazeClass, containerClass, L3vpnMcastRoute.class, afiClass,
  87                 McastMplsLabeledVpnSubsequentAddressFamily.class, destContainerQname);
  88         final QNameModule module = BindingReflections.getQNameModule(cazeClass);
  89         this.nlriRoutesList = NodeIdentifier.create(destListQname);
  90         this.rdNid = new NodeIdentifier(QName.create(module, "route-distinguisher"));
  91         this.cacheableNlriObjects = ImmutableSet.of(cazeClass);
  92
  93     }
  94
  95     @Override
  96     public final ImmutableCollection<Class<? extends DataObject>> cacheableNlriObjects() {
  97         return this.cacheableNlriObjects;
  98     }
  99
 100     protected abstract IpPrefix createPrefix(String prefix);
 101
 102     @Override
 103     public final L3vpnMcastRoute createRoute(final L3vpnMcastRoute route, final String routeKey, final long pathId,
 104             final Attributes attributes) {
 105         final L3vpnMcastRouteBuilder builder;
 106         if (route != null) {
 107             builder = new L3vpnMcastRouteBuilder(route);
 108         } else {
 109             builder = new L3vpnMcastRouteBuilder();
 110         }
 111         return builder.withKey(createRouteListKey(pathId, routeKey)).setAttributes(attributes).build();
 112     }
 113
 114     @Override
 115     public final L3vpnMcastRouteKey createRouteListKey(final long pathId, final String routeKey) {
 116         return new L3vpnMcastRouteKey(new PathId(pathId), routeKey);
 117     }
 118
 119     @Override
 120     protected final void processDestination(
 121             final DOMDataWriteTransaction tx,
 122             final YangInstanceIdentifier routesPath,
 123             final ContainerNode destination,
 124             final ContainerNode attributes,
 125             final ApplyRoute function) {
 126         if (destination != null) {
 127             final Optional<DataContainerChild<? extends PathArgument, ?>> maybeRoutes = destination
 128                     .getChild(nlriRoutesList);
 129             if (maybeRoutes.isPresent()) {
 130                 final DataContainerChild<? extends PathArgument, ?> routes = maybeRoutes.get();
 131                 if (routes instanceof UnkeyedListNode) {
 132                     final YangInstanceIdentifier base = routesYangInstanceIdentifier(routesPath);
 133                     for (final UnkeyedListEntryNode l3vpnDest : ((UnkeyedListNode) routes).getValue()) {
 134                         final YangInstanceIdentifier.NodeIdentifierWithPredicates routeKey = createRouteKey(l3vpnDest);
 135                         function.apply(tx, base, routeKey, l3vpnDest, attributes);
 136                     }
 137                 } else {
 138                     LOG.warn("Routes {} are not a map", routes);
 139                 }
 140             }
 141         }
 142     }
 143
 144
 145     final List<L3vpnMcastDestination> extractRoutes(final Collection<MapEntryNode> routes) {
 146         return routes.stream().map(this::extractDestinations).collect(Collectors.toList());
 147     }
 148
 149     final L3vpnMcastDestination extractDestinations(
 150             final DataContainerNode<? extends PathArgument> destination) {
 151         return new L3vpnMcastDestinationBuilder()
 152                 .setRouteDistinguisher(RouteDistinguisherUtil.extractRouteDistinguisher(destination, rdNid))
 153                 .setPrefix(createPrefix(extractPrefix(destination)))
 154                 .setPathId(PathIdUtil.buildPathId(destination, routePathIdNid()))
 155                 .build();
 156     }
 157
 158     abstract NodeIdentifierWithPredicates createRouteKey(UnkeyedListEntryNode l3vpn);
 159 }