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 io.netty.buffer.ByteBuf;
  11 import io.netty.buffer.Unpooled;
  12 import java.util.ArrayList;
  13 import java.util.Collection;
  14 import java.util.Collections;
  15 import java.util.List;
  16 import java.util.Optional;
  17 import java.util.stream.Collectors;
  18 import org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction;
  19 import org.opendaylight.mdsal.binding.dom.codec.api.BindingNormalizedNodeSerializer;
  20 import org.opendaylight.protocol.bgp.linkstate.impl.nlri.LinkstateNlriParser;
  21 import org.opendaylight.protocol.bgp.linkstate.spi.pojo.SimpleNlriTypeRegistry;
  22 import org.opendaylight.protocol.bgp.parser.spi.PathIdUtil;
  23 import org.opendaylight.protocol.bgp.rib.spi.AbstractRIBSupport;
  24 import org.opendaylight.protocol.util.ByteArray;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev180329.LinkstateAddressFamily;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev180329.LinkstateSubsequentAddressFamily;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev180329.bgp.rib.rib.loc.rib.tables.routes.LinkstateRoutesCase;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev180329.bgp.rib.rib.loc.rib.tables.routes.LinkstateRoutesCaseBuilder;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev180329.linkstate.destination.CLinkstateDestination;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev180329.linkstate.routes.LinkstateRoutes;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev180329.linkstate.routes.LinkstateRoutesBuilder;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev180329.linkstate.routes.linkstate.routes.LinkstateRoute;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev180329.linkstate.routes.linkstate.routes.LinkstateRouteBuilder;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev180329.linkstate.routes.linkstate.routes.LinkstateRouteKey;
  35 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;
  36 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;
  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.destination.linkstate._case.DestinationLinkstateBuilder;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.PathId;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.path.attributes.Attributes;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.destination.DestinationType;
  41 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  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.MapEntryNode;
  47 import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListEntryNode;
  48 import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListNode;
  49 import org.slf4j.Logger;
  50 import org.slf4j.LoggerFactory;
  51
  52 public final class LinkstateRIBSupport
  53         extends AbstractRIBSupport<LinkstateRoutesCase, LinkstateRoutes, LinkstateRoute, LinkstateRouteKey> {
  54     private static final Logger LOG = LoggerFactory.getLogger(LinkstateRIBSupport.class);
  55
  56     private static final LinkstateRoutes EMPTY_CONTAINER
  57             = new LinkstateRoutesBuilder().setLinkstateRoute(Collections.emptyList()).build();
  58     private static final LinkstateRoutesCase EMPTY_CASE
  59             = new LinkstateRoutesCaseBuilder().setLinkstateRoutes(EMPTY_CONTAINER).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 synchronized static 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(), routeKeyQName(),
  89                 pathIdQName(), 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 DOMDataWriteTransaction 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 DOMDataWriteTransaction 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             } else {
 127                 LOG.warn("Routes {} are not a map", routes);
 128             }
 129         }
 130         return Collections.emptyList();
 131     }
 132
 133     @Override
 134     protected DestinationType buildDestination(final Collection<MapEntryNode> routes) {
 135         return new DestinationLinkstateCaseBuilder().setDestinationLinkstate(
 136                 new DestinationLinkstateBuilder().setCLinkstateDestination(extractRoutes(routes)).build()).build();
 137     }
 138
 139     @Override
 140     protected DestinationType buildWithdrawnDestination(final Collection<MapEntryNode> routes) {
 141         return new org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev180329.update
 142                 .attributes.mp.unreach.nlri.withdrawn.routes.destination.type.DestinationLinkstateCaseBuilder()
 143                 .setDestinationLinkstate(new org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp
 144                         .linkstate.rev180329.update.attributes.mp.unreach.nlri.withdrawn.routes.destination.type
 145                         .destination.linkstate._case.DestinationLinkstateBuilder()
 146                         .setCLinkstateDestination(extractRoutes(routes)).build()).build();
 147     }
 148
 149     @Override
 150     public LinkstateRoute createRoute(final LinkstateRoute route, final LinkstateRouteKey key,
 151             final Attributes attributes) {
 152         final LinkstateRouteBuilder builder;
 153         if (route != null) {
 154             builder = new LinkstateRouteBuilder(route);
 155         } else {
 156             builder = new LinkstateRouteBuilder();
 157         }
 158         return builder.withKey(key).setAttributes(attributes).build();
 159     }
 160
 161     @Override
 162     public LinkstateRoutesCase emptyRoutesCase() {
 163         return EMPTY_CASE;
 164     }
 165
 166     @Override
 167     public LinkstateRoutes emptyRoutesContainer() {
 168         return EMPTY_CONTAINER;
 169     }
 170
 171     @Override
 172     public LinkstateRouteKey createRouteListKey(final PathId pathId, final String routeKey) {
 173         return new LinkstateRouteKey(pathId, routeKey);
 174     }
 175
 176     @Override
 177     public List<LinkstateRoute> routesFromContainer(final LinkstateRoutes container) {
 178         return container.getLinkstateRoute();
 179     }
 180
 181     @Override
 182     public PathId extractPathId(final LinkstateRouteKey routeListKey) {
 183         return routeListKey.getPathId();
 184     }
 185
 186     @Override
 187     public String extractRouteKey(final LinkstateRouteKey routeListKey) {
 188         return routeListKey.getRouteKey();
 189     }
 190 }