bgp/extensions/route-target/src/main/java/org/opendaylight/protocol/bgp/route/targetcontrain/impl/RouteTargetConstrainRIBSupport.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.route.targetcontrain.impl;
   9
  10 import com.google.common.collect.ImmutableCollection;
  11 import com.google.common.collect.ImmutableSet;
  12 import io.netty.buffer.ByteBuf;
  13 import io.netty.buffer.Unpooled;
  14 import java.util.ArrayList;
  15 import java.util.Collection;
  16 import java.util.Collections;
  17 import java.util.List;
  18 import java.util.Optional;
  19 import java.util.stream.Collectors;
  20 import org.opendaylight.mdsal.binding.dom.codec.api.BindingNormalizedNodeSerializer;
  21 import org.opendaylight.mdsal.dom.api.DOMDataTreeWriteTransaction;
  22 import org.opendaylight.protocol.bgp.parser.spi.PathIdUtil;
  23 import org.opendaylight.protocol.bgp.rib.spi.AbstractRIBSupport;
  24 import org.opendaylight.protocol.bgp.route.targetcontrain.impl.nlri.ImmutableRouteTargetConstrainNlriRegistry;
  25 import org.opendaylight.protocol.util.ByteArray;
  26 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.destination.DestinationType;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.route.target.constrain.rev180618.RouteTargetConstrainSubsequentAddressFamily;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.route.target.constrain.rev180618.bgp.rib.rib.loc.rib.tables.routes.RouteTargetConstrainRoutesCase;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.route.target.constrain.rev180618.route.target.constrain.RouteTargetConstrainChoice;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.route.target.constrain.rev180618.route.target.constrain.destination.RouteTargetConstrainDestination;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.route.target.constrain.rev180618.route.target.constrain.destination.RouteTargetConstrainDestinationBuilder;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.route.target.constrain.rev180618.route.target.constrain.routes.RouteTargetConstrainRoutes;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.route.target.constrain.rev180618.route.target.constrain.routes.route.target.constrain.routes.RouteTargetConstrainRoute;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.route.target.constrain.rev180618.update.attributes.mp.reach.nlri.advertized.routes.destination.type.DestinationRouteTargetConstrainAdvertizedCaseBuilder;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.route.target.constrain.rev180618.update.attributes.mp.reach.nlri.advertized.routes.destination.type.destination.route.target.constrain.advertized._case.DestinationRouteTargetConstrain;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.route.target.constrain.rev180618.update.attributes.mp.reach.nlri.advertized.routes.destination.type.destination.route.target.constrain.advertized._case.DestinationRouteTargetConstrainBuilder;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.route.target.constrain.rev180618.update.attributes.mp.unreach.nlri.withdrawn.routes.destination.type.DestinationRouteTargetConstrainWithdrawnCaseBuilder;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev200120.Ipv4AddressFamily;
  40 import org.opendaylight.yangtools.yang.binding.BindingObject;
  41 import org.opendaylight.yangtools.yang.binding.DataObject;
  42 import org.opendaylight.yangtools.yang.common.QName;
  43 import org.opendaylight.yangtools.yang.common.Uint32;
  44 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  45 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  46 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
  47 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  48 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  49 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
  50 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerNode;
  51 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
  52 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  53 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNodes;
  54 import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListEntryNode;
  55 import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListNode;
  56 import org.slf4j.Logger;
  57 import org.slf4j.LoggerFactory;
  58
  59 /**
  60  * Route Target Constrains RIBSupport.
  61  *
  62  * @author Claudio D. Gasparini
  63  */
  64 public final class RouteTargetConstrainRIBSupport
  65         extends AbstractRIBSupport<RouteTargetConstrainRoutesCase, RouteTargetConstrainRoutes,
  66         RouteTargetConstrainRoute> {
  67     private static final Logger LOG = LoggerFactory.getLogger(RouteTargetConstrainRIBSupport.class);
  68
  69     private static final NodeIdentifier NLRI_ROUTES_LIST = NodeIdentifier.create(RouteTargetConstrainDestination.QNAME);
  70     private static final String ORIGIN_AS = "origin-as";
  71     private final ImmutableCollection<Class<? extends BindingObject>> cacheableNlriObjects
  72             = ImmutableSet.of(RouteTargetConstrainRoutesCase.class);
  73     private final NodeIdentifier originAsNid;
  74
  75     /**
  76      * Default constructor. Requires the QName of the container augmented under the routes choice
  77      * node in instantiations of the rib grouping. It is assumed that this container is defined by
  78      * the same model which populates it with route grouping instantiation, and by extension with
  79      * the route attributes container.
  80      *
  81      * @param mappingService Serialization service
  82      */
  83     public RouteTargetConstrainRIBSupport(final BindingNormalizedNodeSerializer mappingService) {
  84         super(mappingService,
  85                 RouteTargetConstrainRoutesCase.class,
  86                 RouteTargetConstrainRoutes.class,
  87                 RouteTargetConstrainRoute.class,
  88                 Ipv4AddressFamily.class,
  89                 RouteTargetConstrainSubsequentAddressFamily.class,
  90                 DestinationRouteTargetConstrain.QNAME);
  91         this.originAsNid = new NodeIdentifier(QName.create(routeQName(), ORIGIN_AS).intern());
  92     }
  93
  94     @Override
  95     public ImmutableCollection<Class<? extends BindingObject>> cacheableNlriObjects() {
  96         return this.cacheableNlriObjects;
  97     }
  98
  99     @Override
 100     protected DestinationType buildDestination(final Collection<MapEntryNode> routes) {
 101         return new DestinationRouteTargetConstrainAdvertizedCaseBuilder().setDestinationRouteTargetConstrain(
 102                 new DestinationRouteTargetConstrainBuilder()
 103                         .setRouteTargetConstrainDestination(extractRoutes(routes)).build()).build();
 104     }
 105
 106     @Override
 107     protected DestinationType buildWithdrawnDestination(final Collection<MapEntryNode> routes) {
 108         return new DestinationRouteTargetConstrainWithdrawnCaseBuilder()
 109                 .setDestinationRouteTargetConstrain(new org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns
 110                         .yang.bgp.route.target.constrain.rev180618.update.attributes.mp.unreach.nlri.withdrawn.routes
 111                         .destination.type.destination.route.target.constrain.withdrawn._case
 112                         .DestinationRouteTargetConstrainBuilder()
 113                         .setRouteTargetConstrainDestination(extractRoutes(routes)).build()).build();
 114     }
 115
 116     private List<RouteTargetConstrainDestination> extractRoutes(final Collection<MapEntryNode> routes) {
 117         return routes.stream().map(this::extractDestination).collect(Collectors.toList());
 118     }
 119
 120     private RouteTargetConstrainDestination extractDestination(final DataContainerNode<? extends PathArgument> rtDest) {
 121         final RouteTargetConstrainDestinationBuilder builder = new RouteTargetConstrainDestinationBuilder()
 122                 .setPathId(PathIdUtil.buildPathId(rtDest, routePathIdNid()))
 123                 .setRouteTargetConstrainChoice(extractRouteTargetChoice(rtDest));
 124         final Optional<Object> originAs = NormalizedNodes
 125                 .findNode(rtDest, this.originAsNid).map(NormalizedNode::getValue);
 126         originAs.ifPresent(o -> builder.setOriginAs(new AsNumber((Uint32) o)));
 127         return builder.build();
 128     }
 129
 130     private RouteTargetConstrainChoice extractRouteTargetChoice(final DataContainerNode<? extends PathArgument> route) {
 131         final DataObject nn = this.mappingService.fromNormalizedNode(this.routeDefaultYii, route).getValue();
 132         return ((RouteTargetConstrainRoute) nn).getRouteTargetConstrainChoice();
 133     }
 134
 135     @Override
 136     protected Collection<NodeIdentifierWithPredicates> processDestination(
 137             final DOMDataTreeWriteTransaction tx,
 138             final YangInstanceIdentifier routesPath,
 139             final ContainerNode destination,
 140             final ContainerNode attributes,
 141             final ApplyRoute function) {
 142         if (destination != null) {
 143             final Optional<DataContainerChild<? extends PathArgument, ?>> maybeRoutes = destination
 144                     .getChild(NLRI_ROUTES_LIST);
 145             if (maybeRoutes.isPresent()) {
 146                 final DataContainerChild<? extends PathArgument, ?> routes = maybeRoutes.get();
 147                 if (routes instanceof UnkeyedListNode) {
 148                     final YangInstanceIdentifier base = routesYangInstanceIdentifier(routesPath);
 149                     final Collection<UnkeyedListEntryNode> routesList = ((UnkeyedListNode) routes).getValue();
 150                     final List<NodeIdentifierWithPredicates> keys = new ArrayList<>(routesList.size());
 151                     for (final UnkeyedListEntryNode rtDest : routesList) {
 152                         final NodeIdentifierWithPredicates routeKey = createRouteKey(rtDest);
 153                         function.apply(tx, base, routeKey, rtDest, attributes);
 154                         keys.add(routeKey);
 155                     }
 156                     return keys;
 157                 }
 158                 LOG.warn("Routes {} are not a map", routes);
 159             }
 160         }
 161         return Collections.emptyList();
 162     }
 163
 164     private NodeIdentifierWithPredicates createRouteKey(final UnkeyedListEntryNode routeTarget) {
 165         final ByteBuf buffer = Unpooled.buffer();
 166         final RouteTargetConstrainDestination dest = extractDestination(routeTarget);
 167         buffer.writeBytes(ImmutableRouteTargetConstrainNlriRegistry.getInstance()
 168                 .serializeRouteTargetConstrain(dest.getRouteTargetConstrainChoice()));
 169         final Optional<DataContainerChild<? extends PathArgument, ?>> maybePathIdLeaf =
 170                 routeTarget.getChild(routePathIdNid());
 171         return PathIdUtil.createNidKey(routeQName(), routeKeyTemplate(),
 172                 ByteArray.encodeBase64(buffer), maybePathIdLeaf);
 173     }
 174 }