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

   1 /*
   2  * Copyright (c) 2015 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;
   9
  10 import com.google.common.base.Optional;
  11 import com.google.common.collect.ImmutableCollection;
  12 import com.google.common.collect.ImmutableSet;
  13 import io.netty.buffer.ByteBuf;
  14 import io.netty.buffer.Unpooled;
  15 import java.util.ArrayList;
  16 import java.util.Collection;
  17 import java.util.List;
  18 import org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction;
  19 import org.opendaylight.protocol.bgp.linkstate.nlri.LinkstateNlriParser;
  20 import org.opendaylight.protocol.bgp.rib.spi.AbstractRIBSupport;
  21 import org.opendaylight.protocol.util.ByteArray;
  22 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.LinkstateAddressFamily;
  23 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.LinkstateSubsequentAddressFamily;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.bgp.rib.rib.loc.rib.tables.routes.LinkstateRoutesCase;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.linkstate.destination.CLinkstateDestination;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.linkstate.routes.LinkstateRoutes;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.linkstate.routes.linkstate.routes.LinkstateRoute;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.update.attributes.mp.reach.nlri.advertized.routes.destination.type.DestinationLinkstateCaseBuilder;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.update.attributes.mp.reach.nlri.advertized.routes.destination.type.destination.linkstate._case.DestinationLinkstate;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.update.attributes.mp.reach.nlri.advertized.routes.destination.type.destination.linkstate._case.DestinationLinkstateBuilder;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.update.attributes.MpReachNlri;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.update.attributes.MpReachNlriBuilder;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.update.attributes.MpUnreachNlri;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.update.attributes.MpUnreachNlriBuilder;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.update.attributes.mp.reach.nlri.AdvertizedRoutesBuilder;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.update.attributes.mp.unreach.nlri.WithdrawnRoutesBuilder;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.rib.tables.Routes;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.next.hop.CNextHop;
  39 import org.opendaylight.yangtools.yang.binding.DataObject;
  40 import org.opendaylight.yangtools.yang.common.QName;
  41 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  42 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  43 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
  44 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  45 import org.opendaylight.yangtools.yang.data.api.schema.ChoiceNode;
  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.opendaylight.yangtools.yang.data.impl.schema.Builders;
  52 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
  53 import org.slf4j.Logger;
  54 import org.slf4j.LoggerFactory;
  55
  56 final class LinkstateRIBSupport extends AbstractRIBSupport {
  57     private static final Logger LOG = LoggerFactory.getLogger(LinkstateRIBSupport.class);
  58
  59     private static final QName ROUTE_KEY = QName.create(LinkstateRoute.QNAME, "route-key").intern();
  60     private static final LinkstateRIBSupport SINGLETON = new LinkstateRIBSupport();
  61     private final ChoiceNode emptyRoutes = Builders.choiceBuilder()
  62         .withNodeIdentifier(new NodeIdentifier(Routes.QNAME))
  63         .addChild(Builders.containerBuilder()
  64             .withNodeIdentifier(new NodeIdentifier(LinkstateRoutes.QNAME))
  65             .addChild(ImmutableNodes.mapNodeBuilder(LinkstateRoute.QNAME).build()).build()).build();
  66     private final NodeIdentifier destination = new NodeIdentifier(DestinationLinkstate.QNAME);
  67     private final NodeIdentifier route = new NodeIdentifier(LinkstateRoute.QNAME);
  68     private final NodeIdentifier nlriRoutesList = new NodeIdentifier(CLinkstateDestination.QNAME);
  69
  70     private LinkstateRIBSupport() {
  71        super(LinkstateRoutesCase.class, LinkstateRoutes.class, LinkstateRoute.class);
  72     }
  73
  74     static LinkstateRIBSupport getInstance() {
  75         return SINGLETON;
  76     }
  77
  78     @Override
  79     public ChoiceNode emptyRoutes() {
  80         return this.emptyRoutes;
  81     }
  82
  83     @Override
  84     public ImmutableCollection<Class<? extends DataObject>> cacheableAttributeObjects() {
  85         return ImmutableSet.of();
  86     }
  87
  88     @Override
  89     public ImmutableCollection<Class<? extends DataObject>> cacheableNlriObjects() {
  90         return ImmutableSet.of();
  91     }
  92
  93     @Override
  94     protected void deleteDestinationRoutes(final DOMDataWriteTransaction tx, final YangInstanceIdentifier tablePath,
  95         final ContainerNode destination, final NodeIdentifier routesNodeId) {
  96         processDestination(tx, tablePath.node(routesNodeId), destination, null, DELETE_ROUTE);
  97     }
  98
  99     private void processDestination(final DOMDataWriteTransaction tx, final YangInstanceIdentifier routesPath,
 100         final ContainerNode destination, final ContainerNode attributes, final ApplyRoute function) {
 101         if (destination != null) {
 102             final Optional<DataContainerChild<? extends PathArgument, ?>> maybeRoutes = destination.getChild(this.nlriRoutesList);
 103             if (maybeRoutes.isPresent()) {
 104                 final DataContainerChild<? extends PathArgument, ?> routes = maybeRoutes.get();
 105                 if (routes instanceof UnkeyedListNode) {
 106                     final YangInstanceIdentifier base = routesPath.node(routesContainerIdentifier()).node(this.route);
 107                     for (final UnkeyedListEntryNode e : ((UnkeyedListNode)routes).getValue()) {
 108                         final NodeIdentifierWithPredicates routeKey = createRouteKey(e);
 109                         function.apply(tx, base, routeKey,  e, attributes);
 110                     }
 111                 } else {
 112                     LOG.warn("Routes {} are not a map", routes);
 113                 }
 114             }
 115         }
 116     }
 117
 118     @Override
 119     protected void putDestinationRoutes(final DOMDataWriteTransaction tx, final YangInstanceIdentifier tablePath,
 120         final ContainerNode destination, final ContainerNode attributes, final NodeIdentifier routesNodeId) {
 121         processDestination(tx, tablePath.node(routesNodeId), destination, attributes, this.putRoute);
 122     }
 123
 124     private NodeIdentifierWithPredicates createRouteKey(final UnkeyedListEntryNode linkstate) {
 125         final ByteBuf buffer = Unpooled.buffer();
 126         final CLinkstateDestination cLinkstateDestination = LinkstateNlriParser.extractLinkstateDestination(linkstate);
 127         LinkstateNlriParser.serializeNlri(cLinkstateDestination, buffer);
 128
 129         return new NodeIdentifierWithPredicates(LinkstateRoute.QNAME, ROUTE_KEY, ByteArray.readAllBytes(buffer));
 130     }
 131
 132     @Override
 133     protected NodeIdentifier destinationContainerIdentifier() {
 134         return this.destination;
 135     }
 136
 137     @Override
 138     public boolean isComplexRoute() {
 139         return true;
 140     }
 141
 142     @Override
 143     protected MpReachNlri buildReach(final Collection<MapEntryNode> routes, final CNextHop hop) {
 144         final MpReachNlriBuilder mb = new MpReachNlriBuilder();
 145         mb.setAfi(LinkstateAddressFamily.class);
 146         mb.setSafi(LinkstateSubsequentAddressFamily.class);
 147         mb.setCNextHop(hop);
 148
 149         final List<CLinkstateDestination> dests = new ArrayList<>(routes.size());
 150         for (final MapEntryNode reachRoute : routes) {
 151             dests.add(LinkstateNlriParser.extractLinkstateDestination(reachRoute));
 152         }
 153         mb.setAdvertizedRoutes(new AdvertizedRoutesBuilder().setDestinationType(
 154             new DestinationLinkstateCaseBuilder().setDestinationLinkstate(
 155                 new DestinationLinkstateBuilder().setCLinkstateDestination(dests).build()).build()).build());
 156         return mb.build();
 157     }
 158
 159     @Override
 160     protected MpUnreachNlri buildUnreach(final Collection<MapEntryNode> routes) {
 161         final MpUnreachNlriBuilder mb = new MpUnreachNlriBuilder();
 162         mb.setAfi(LinkstateAddressFamily.class);
 163         mb.setSafi(LinkstateSubsequentAddressFamily.class);
 164
 165         final List<CLinkstateDestination> dests = new ArrayList<>(routes.size());
 166         for (final MapEntryNode unreachRoute : routes) {
 167             dests.add(LinkstateNlriParser.extractLinkstateDestination(unreachRoute));
 168         }
 169         mb.setWithdrawnRoutes(new WithdrawnRoutesBuilder().setDestinationType(
 170             new org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.update.attributes.mp.unreach.nlri.withdrawn.routes.destination.type.DestinationLinkstateCaseBuilder().setDestinationLinkstate(
 171                 new org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.update.attributes.mp.unreach.nlri.withdrawn.routes.destination.type.destination.linkstate._case.DestinationLinkstateBuilder().setCLinkstateDestination(dests).build()).build()).build());
 172         return mb.build();
 173     }
 174 }