bgp/extensions/linkstate/src/main/java/org/opendaylight/protocol/bgp/linkstate/impl/LinkstateRIBSupport.java

   1 /*
   2  * Copyright (c) 2016 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.linkstate.impl;
   9
  10 import static com.google.common.base.Verify.verify;
  11
  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.linkstate.impl.nlri.LinkstateNlriParser;
  23 import org.opendaylight.protocol.bgp.linkstate.spi.pojo.SimpleNlriTypeRegistry;
  24 import org.opendaylight.protocol.bgp.parser.spi.PathIdUtil;
  25 import org.opendaylight.protocol.bgp.rib.spi.AbstractRIBSupport;
  26 import org.opendaylight.protocol.util.ByteArray;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev200120.LinkstateAddressFamily;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev200120.LinkstateSubsequentAddressFamily;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev200120.bgp.rib.rib.loc.rib.tables.routes.LinkstateRoutesCase;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev200120.linkstate.destination.CLinkstateDestination;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev200120.linkstate.routes.LinkstateRoutes;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev200120.linkstate.routes.LinkstateRoutesBuilder;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev200120.linkstate.routes.linkstate.routes.LinkstateRoute;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev200120.linkstate.routes.linkstate.routes.LinkstateRouteBuilder;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev200120.linkstate.routes.linkstate.routes.LinkstateRouteKey;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev200120.update.attributes.mp.reach.nlri.advertized.routes.destination.type.DestinationLinkstateCaseBuilder;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev200120.update.attributes.mp.reach.nlri.advertized.routes.destination.type.destination.linkstate._case.DestinationLinkstate;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev200120.update.attributes.mp.reach.nlri.advertized.routes.destination.type.destination.linkstate._case.DestinationLinkstateBuilder;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.PathId;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.path.attributes.Attributes;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.destination.DestinationType;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.rib.tables.Routes;
  43 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  44 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
  45 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  46 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  47 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
  48 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
  49 import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListEntryNode;
  50 import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListNode;
  51 import org.slf4j.Logger;
  52 import org.slf4j.LoggerFactory;
  53
  54 public final class LinkstateRIBSupport
  55         extends AbstractRIBSupport<LinkstateRoutesCase, LinkstateRoutes, LinkstateRoute, LinkstateRouteKey> {
  56     private static final Logger LOG = LoggerFactory.getLogger(LinkstateRIBSupport.class);
  57
  58     private static final LinkstateRoutes EMPTY_CONTAINER
  59             = new LinkstateRoutesBuilder().setLinkstateRoute(Collections.emptyList()).build();
  60     private static LinkstateRIBSupport SINGLETON;
  61     private final YangInstanceIdentifier.NodeIdentifier nlriRoutesList
  62             = new YangInstanceIdentifier.NodeIdentifier(CLinkstateDestination.QNAME);
  63
  64     private LinkstateRIBSupport(final BindingNormalizedNodeSerializer mappingService) {
  65         super(
  66                 mappingService,
  67                 LinkstateRoutesCase.class,
  68                 LinkstateRoutes.class,
  69                 LinkstateRoute.class,
  70                 LinkstateAddressFamily.class,
  71                 LinkstateSubsequentAddressFamily.class,
  72                 DestinationLinkstate.QNAME);
  73     }
  74
  75     public static synchronized LinkstateRIBSupport getInstance(final BindingNormalizedNodeSerializer mappingService) {
  76         if (SINGLETON == null) {
  77             SINGLETON = new LinkstateRIBSupport(mappingService);
  78         }
  79         return SINGLETON;
  80     }
  81
  82     private NodeIdentifierWithPredicates createRouteKey(final UnkeyedListEntryNode linkstate) {
  83         final ByteBuf buffer = Unpooled.buffer();
  84         final CLinkstateDestination cLinkstateDestination = LinkstateNlriParser.extractLinkstateDestination(linkstate);
  85         SimpleNlriTypeRegistry.getInstance().serializeNlriType(cLinkstateDestination, buffer);
  86         final Optional<DataContainerChild<? extends PathArgument, ?>> maybePathIdLeaf =
  87                 linkstate.getChild(routePathIdNid());
  88         return PathIdUtil.createNidKey(routeQName(), routeKeyTemplate(),
  89                 ByteArray.encodeBase64(buffer), maybePathIdLeaf);
  90     }
  91
  92     private static List<CLinkstateDestination> extractRoutes(final Collection<MapEntryNode> routes) {
  93         return routes.stream().map(LinkstateNlriParser::extractLinkstateDestination).collect(Collectors.toList());
  94     }
  95
  96     @Override
  97     protected Collection<NodeIdentifierWithPredicates> processDestination(final DOMDataTreeWriteTransaction tx,
  98                                                                           final YangInstanceIdentifier routesPath,
  99                                                                           final ContainerNode destination,
 100                                                                           final ContainerNode attributes,
 101                                                                           final ApplyRoute function) {
 102         if (destination != null) {
 103             final Optional<DataContainerChild<? extends PathArgument, ?>> maybeRoutes
 104                     = destination.getChild(this.nlriRoutesList);
 105             return processRoute(maybeRoutes, routesPath, attributes, function, tx);
 106         }
 107         return Collections.emptyList();
 108     }
 109
 110     private List<NodeIdentifierWithPredicates> processRoute(
 111             final Optional<DataContainerChild<? extends PathArgument, ?>> maybeRoutes,
 112             final YangInstanceIdentifier routesPath,
 113             final ContainerNode attributes, final ApplyRoute function, final DOMDataTreeWriteTransaction tx) {
 114         if (maybeRoutes.isPresent()) {
 115             final DataContainerChild<? extends PathArgument, ?> routes = maybeRoutes.get();
 116             if (routes instanceof UnkeyedListNode) {
 117                 final YangInstanceIdentifier base = routesYangInstanceIdentifier(routesPath);
 118                 final Collection<UnkeyedListEntryNode> routesList = ((UnkeyedListNode) routes).getValue();
 119                 final List<NodeIdentifierWithPredicates> keys = new ArrayList<>(routesList.size());
 120                 for (final UnkeyedListEntryNode linkstateDest : routesList) {
 121                     final NodeIdentifierWithPredicates routeKey = createRouteKey(linkstateDest);
 122                     function.apply(tx, base, routeKey, linkstateDest, attributes);
 123                     keys.add(routeKey);
 124                 }
 125                 return keys;
 126             }
 127             LOG.warn("Routes {} are not a map", routes);
 128         }
 129         return Collections.emptyList();
 130     }
 131
 132     @Override
 133     protected DestinationType buildDestination(final Collection<MapEntryNode> routes) {
 134         return new DestinationLinkstateCaseBuilder().setDestinationLinkstate(
 135                 new DestinationLinkstateBuilder().setCLinkstateDestination(extractRoutes(routes)).build()).build();
 136     }
 137
 138     @Override
 139     protected DestinationType buildWithdrawnDestination(final Collection<MapEntryNode> routes) {
 140         return new org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev200120.update
 141                 .attributes.mp.unreach.nlri.withdrawn.routes.destination.type.DestinationLinkstateCaseBuilder()
 142                 .setDestinationLinkstate(
 143                     new org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev200120
 144                         .update.attributes.mp.unreach.nlri.withdrawn.routes.destination.type
 145                         .destination.linkstate._case.DestinationLinkstateBuilder()
 146                         .setCLinkstateDestination(extractRoutes(routes)).build())
 147                 .build();
 148     }
 149
 150     @Override
 151     public LinkstateRoute createRoute(final LinkstateRoute route, final LinkstateRouteKey key,
 152             final Attributes attributes) {
 153         final LinkstateRouteBuilder builder;
 154         if (route != null) {
 155             builder = new LinkstateRouteBuilder(route);
 156         } else {
 157             builder = new LinkstateRouteBuilder();
 158         }
 159         return builder.withKey(key).setAttributes(attributes).build();
 160     }
 161
 162     @Override
 163     public LinkstateRoutes emptyRoutesContainer() {
 164         return EMPTY_CONTAINER;
 165     }
 166
 167     @Override
 168     public LinkstateRouteKey createRouteListKey(final PathId pathId, final String routeKey) {
 169         return new LinkstateRouteKey(pathId, routeKey);
 170     }
 171
 172     @Override
 173     public PathId extractPathId(final LinkstateRouteKey routeListKey) {
 174         return routeListKey.getPathId();
 175     }
 176
 177     @Override
 178     public String extractRouteKey(final LinkstateRouteKey routeListKey) {
 179         return routeListKey.getRouteKey();
 180     }
 181
 182     @Override
 183     public List<LinkstateRoute> extractAdjRibInRoutes(final Routes routes) {
 184         verify(
 185             routes instanceof org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev200120
 186                 .bgp.rib.rib.peer.adj.rib.in.tables.routes.LinkstateRoutesCase, "Unrecognized routes %s", routes);
 187         return ((org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev200120
 188                 .bgp.rib.rib.peer.adj.rib.in.tables.routes.LinkstateRoutesCase) routes).getLinkstateRoutes()
 189                 .nonnullLinkstateRoute();
 190     }
 191 }