bgp/evpn/src/main/java/org/opendaylight/protocol/bgp/evpn/impl/EvpnRibSupport.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.evpn.impl;
   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.Collections;
  18 import java.util.List;
  19 import java.util.stream.Collectors;
  20 import javax.annotation.Nonnull;
  21 import org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction;
  22 import org.opendaylight.protocol.bgp.evpn.impl.nlri.EvpnNlriParser;
  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.evpn.rev160321.EvpnSubsequentAddressFamily;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.evpn.rev160321.L2vpnAddressFamily;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.evpn.rev160321.application.rib.tables.routes.EvpnRoutesCase;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.evpn.rev160321.evpn.destination.EvpnDestination;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.evpn.rev160321.evpn.routes.EvpnRoutes;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.evpn.rev160321.evpn.routes.evpn.routes.EvpnRoute;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.evpn.rev160321.update.attributes.mp.reach.nlri.advertized.routes.destination.type.destination.evpn._case.DestinationEvpn;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.evpn.rev160321.update.attributes.mp.unreach.nlri.withdrawn.routes.destination.type.DestinationEvpnCaseBuilder;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.evpn.rev160321.update.attributes.mp.unreach.nlri.withdrawn.routes.destination.type.destination.evpn._case.DestinationEvpnBuilder;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.update.attributes.MpReachNlri;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.update.attributes.MpReachNlriBuilder;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.update.attributes.MpUnreachNlri;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.update.attributes.MpUnreachNlriBuilder;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.update.attributes.mp.reach.nlri.AdvertizedRoutesBuilder;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.rib.tables.Routes;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.next.hop.CNextHop;
  41 import org.opendaylight.yangtools.yang.binding.DataObject;
  42 import org.opendaylight.yangtools.yang.common.QName;
  43 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  44 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  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.ChoiceNode;
  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.opendaylight.yangtools.yang.data.impl.schema.Builders;
  54 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
  55 import org.slf4j.Logger;
  56 import org.slf4j.LoggerFactory;
  57
  58 final class EvpnRibSupport extends AbstractRIBSupport {
  59     private static final EvpnRibSupport SINGLETON = new EvpnRibSupport();
  60     private static final Logger LOG = LoggerFactory.getLogger(EvpnRibSupport.class);
  61     private static final QName ROUTE_KEY = QName.create(EvpnRoute.QNAME, "route-key").intern();
  62     private static final NodeIdentifier DESTINATION = NodeIdentifier.create(DestinationEvpn.QNAME);
  63     private static final NodeIdentifier NLRI_ROUTES_LIST = NodeIdentifier.create(EvpnDestination.QNAME);
  64     private static final NodeIdentifier ROUTE = NodeIdentifier.create(EvpnRoute.QNAME);
  65
  66     private static final ChoiceNode EMPTY_ROUTES = Builders.choiceBuilder().withNodeIdentifier(NodeIdentifier.create(Routes.QNAME))
  67         .addChild(Builders.containerBuilder().withNodeIdentifier(NodeIdentifier.create(EvpnRoutes.QNAME))
  68             .addChild(ImmutableNodes.mapNodeBuilder(EvpnRoute.QNAME).build()).build()).build();
  69
  70     private EvpnRibSupport() {
  71         super(EvpnRoutesCase.class, EvpnRoutes.class, EvpnRoute.class);
  72     }
  73
  74     static EvpnRibSupport getInstance() {
  75         return SINGLETON;
  76     }
  77
  78     @Nonnull
  79     @Override
  80     public ChoiceNode emptyRoutes() {
  81         return EMPTY_ROUTES;
  82     }
  83
  84     @Nonnull
  85     @Override
  86     public ImmutableCollection<Class<? extends DataObject>> cacheableAttributeObjects() {
  87         return ImmutableSet.of();
  88     }
  89
  90     @Nonnull
  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     @Nonnull
 102     @Override
 103     protected NodeIdentifier destinationContainerIdentifier() {
 104         return DESTINATION;
 105     }
 106
 107     @Override
 108     protected void deleteDestinationRoutes(final DOMDataWriteTransaction tx, final YangInstanceIdentifier tablePath, final ContainerNode destination,
 109         final NodeIdentifier routesNodeId) {
 110         processDestination(tx, tablePath.node(routesNodeId), destination, null, DELETE_ROUTE);
 111     }
 112
 113     @Override
 114     protected void putDestinationRoutes(final DOMDataWriteTransaction tx, final YangInstanceIdentifier tablePath, final ContainerNode destination,
 115         final ContainerNode attributes, final NodeIdentifier routesNodeId) {
 116         processDestination(tx, tablePath.node(routesNodeId), destination, attributes, putRoute);
 117     }
 118
 119     @Nonnull
 120     @Override
 121     protected MpReachNlri buildReach(final Collection<MapEntryNode> routes, final CNextHop hop) {
 122         final MpReachNlriBuilder mb = new MpReachNlriBuilder();
 123         mb.setAfi(L2vpnAddressFamily.class);
 124         mb.setSafi(EvpnSubsequentAddressFamily.class);
 125         mb.setCNextHop(hop);
 126
 127         final List<EvpnDestination> dests = new ArrayList<>(routes.size());
 128         dests.addAll(routes.stream().map(EvpnNlriParser::extractEvpnDestination).collect(Collectors.toList()));
 129         mb.setAdvertizedRoutes(new AdvertizedRoutesBuilder().setDestinationType(new org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.evpn.rev160321.update.attributes.mp.reach.nlri.advertized.routes.destination.type.DestinationEvpnCaseBuilder()
 130             .setDestinationEvpn(new org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.evpn.rev160321.update
 131                 .attributes.mp.reach.nlri.advertized.routes.destination.type.destination.evpn._case.DestinationEvpnBuilder().setEvpnDestination(dests).build()).build()).build());
 132         return mb.build();
 133     }
 134
 135     @Nonnull
 136     @Override
 137     protected MpUnreachNlri buildUnreach(final Collection<MapEntryNode> routes) {
 138         final MpUnreachNlriBuilder mb = new MpUnreachNlriBuilder();
 139         mb.setAfi(L2vpnAddressFamily.class);
 140         mb.setSafi(EvpnSubsequentAddressFamily.class);
 141
 142         final List<EvpnDestination> dests = new ArrayList<>(routes.size());
 143         dests.addAll(routes.stream().map(EvpnNlriParser::extractEvpnDestination).collect(Collectors.toList()));
 144         mb.setWithdrawnRoutes(new org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.update.attributes.mp
 145             .unreach.nlri.WithdrawnRoutesBuilder().setDestinationType(new DestinationEvpnCaseBuilder().setDestinationEvpn(
 146             new DestinationEvpnBuilder().setEvpnDestination(dests).build()).build()).build()).build();
 147         return mb.build();
 148     }
 149
 150     private void processDestination(final DOMDataWriteTransaction tx, final YangInstanceIdentifier routesPath,
 151         final ContainerNode destination, final ContainerNode attributes, final ApplyRoute function) {
 152         if (destination != null) {
 153             final Optional<DataContainerChild<? extends PathArgument, ?>> maybeRoutes = destination.getChild(NLRI_ROUTES_LIST);
 154             if (maybeRoutes.isPresent()) {
 155                 final DataContainerChild<? extends PathArgument, ?> routes = maybeRoutes.get();
 156                 if (routes instanceof UnkeyedListNode) {
 157                     final YangInstanceIdentifier base = routesPath.node(routesContainerIdentifier()).node(ROUTE);
 158                     for (final UnkeyedListEntryNode e : ((UnkeyedListNode) routes).getValue()) {
 159                         final NodeIdentifierWithPredicates routeKey = createRouteKey(e);
 160                         function.apply(tx, base, routeKey, e, attributes);
 161                     }
 162                 } else {
 163                     LOG.warn("Routes {} are not a map", routes);
 164                 }
 165             }
 166         }
 167     }
 168
 169     private NodeIdentifierWithPredicates createRouteKey(final UnkeyedListEntryNode evpn) {
 170         final ByteBuf buffer = Unpooled.buffer();
 171         final EvpnDestination dest = EvpnNlriParser.extractRouteKeyDestination(evpn);
 172         EvpnNlriParser.serializeNlri(Collections.singletonList(dest), buffer);
 173         return new NodeIdentifierWithPredicates(EvpnRoute.QNAME, ROUTE_KEY, ByteArray.readAllBytes(buffer));
 174     }
 175
 176 }