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