bgp/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 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.Arrays;
  15 import java.util.Collection;
  16 import java.util.List;
  17 import java.util.Optional;
  18 import java.util.stream.Collectors;
  19 import org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction;
  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.peer.effective.rib.in.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.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.rib.tables.Routes;
  42 import org.opendaylight.yangtools.yang.binding.DataObject;
  43 import org.opendaylight.yangtools.yang.common.QName;
  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.MapEntryNode;
  51 import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListEntryNode;
  52 import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListNode;
  53 import org.slf4j.Logger;
  54 import org.slf4j.LoggerFactory;
  55
  56 public final class LinkstateRIBSupport extends AbstractRIBSupport<LinkstateRoute, LinkstateRouteKey> {
  57     private static final Logger LOG = LoggerFactory.getLogger(LinkstateRIBSupport.class);
  58     private static final QName ROUTE_KEY_QNAME = QName.create(LinkstateRoute.QNAME, ROUTE_KEY).intern();
  59     private static final LinkstateRIBSupport SINGLETON = new LinkstateRIBSupport();
  60     private final NodeIdentifier route = new NodeIdentifier(LinkstateRoute.QNAME);
  61     private final NodeIdentifier nlriRoutesList = new NodeIdentifier(CLinkstateDestination.QNAME);
  62
  63     private LinkstateRIBSupport() {
  64         super(LinkstateRoutesCase.class, LinkstateRoutes.class, LinkstateRoute.class, LinkstateAddressFamily.class,
  65                 LinkstateSubsequentAddressFamily.class, DestinationLinkstate.QNAME);
  66     }
  67
  68     public static LinkstateRIBSupport getInstance() {
  69         return SINGLETON;
  70     }
  71
  72     private NodeIdentifierWithPredicates createRouteKey(final UnkeyedListEntryNode linkstate) {
  73         final ByteBuf buffer = Unpooled.buffer();
  74         final CLinkstateDestination cLinkstateDestination = LinkstateNlriParser.extractLinkstateDestination(linkstate);
  75         SimpleNlriTypeRegistry.getInstance().serializeNlriType(cLinkstateDestination, buffer);
  76         final Optional<DataContainerChild<? extends PathArgument, ?>> maybePathIdLeaf =
  77                 linkstate.getChild(routePathIdNid());
  78         return PathIdUtil.createNidKey(LinkstateRoute.QNAME, ROUTE_KEY_QNAME,
  79                 pathIdQName(), Arrays.toString(ByteArray.readAllBytes(buffer)), maybePathIdLeaf);
  80     }
  81
  82     private static List<CLinkstateDestination> extractRoutes(final Collection<MapEntryNode> routes) {
  83         return routes.stream().map(LinkstateNlriParser::extractLinkstateDestination).collect(Collectors.toList());
  84     }
  85
  86     @Override
  87     public ImmutableCollection<Class<? extends DataObject>> cacheableAttributeObjects() {
  88         return ImmutableSet.of();
  89     }
  90
  91     @Override
  92     public ImmutableCollection<Class<? extends DataObject>> cacheableNlriObjects() {
  93         return ImmutableSet.of();
  94     }
  95
  96     @Override
  97     public boolean isComplexRoute() {
  98         return true;
  99     }
 100
 101     @Override
 102     protected void processDestination(final DOMDataWriteTransaction tx, final YangInstanceIdentifier routesPath,
 103             final ContainerNode destination, final ContainerNode attributes, final ApplyRoute function) {
 104         if (destination != null) {
 105             final Optional<DataContainerChild<? extends PathArgument, ?>> maybeRoutes
 106                     = destination.getChild(this.nlriRoutesList);
 107             processRoute(maybeRoutes, routesPath, attributes, function, tx);
 108         }
 109     }
 110
 111     private void processRoute(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 = routesPath.node(routesContainerIdentifier()).node(this.route);
 118                 for (final UnkeyedListEntryNode e : ((UnkeyedListNode) routes).getValue()) {
 119                     final NodeIdentifierWithPredicates routeKey = createRouteKey(e);
 120                     function.apply(tx, base, routeKey, e, attributes);
 121                 }
 122             } else {
 123                 LOG.warn("Routes {} are not a map", routes);
 124             }
 125         }
 126     }
 127
 128     @Override
 129     protected DestinationType buildDestination(final Collection<MapEntryNode> routes) {
 130         return new DestinationLinkstateCaseBuilder().setDestinationLinkstate(
 131                 new DestinationLinkstateBuilder().setCLinkstateDestination(extractRoutes(routes)).build()).build();
 132     }
 133
 134     @Override
 135     protected DestinationType buildWithdrawnDestination(final Collection<MapEntryNode> routes) {
 136         return new org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev180329.update
 137                 .attributes.mp.unreach.nlri.withdrawn.routes.destination.type.DestinationLinkstateCaseBuilder()
 138                 .setDestinationLinkstate(new org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp
 139                         .linkstate.rev180329.update.attributes.mp.unreach.nlri.withdrawn.routes.destination.type
 140                         .destination.linkstate._case.DestinationLinkstateBuilder()
 141                         .setCLinkstateDestination(extractRoutes(routes)).build()).build();
 142     }
 143
 144     @Override
 145     public LinkstateRoute createRoute(final LinkstateRoute route, final String routeKey,
 146             final long pathId, final Attributes attributes) {
 147         final LinkstateRouteBuilder builder;
 148         if (route != null) {
 149             builder = new LinkstateRouteBuilder(route);
 150         } else {
 151             builder = new LinkstateRouteBuilder();
 152         }
 153         return builder.setKey(new LinkstateRouteKey(new PathId(pathId), routeKey)).setAttributes(attributes).build();
 154     }
 155
 156     @Override
 157     public Routes emptyRoutesContainer() {
 158         return new LinkstateRoutesCaseBuilder().setLinkstateRoutes(new LinkstateRoutesBuilder().build()).build();
 159     }
 160
 161     @Override
 162     public LinkstateRouteKey createRouteListKey(final long pathId, final String routeKey) {
 163         return new LinkstateRouteKey(new PathId(pathId), routeKey);
 164     }
 165 }