bgp/extensions/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 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.mdsal.binding.dom.codec.api.BindingNormalizedNodeSerializer;
  21 import org.opendaylight.mdsal.dom.api.DOMDataTreeWriteTransaction;
  22 import org.opendaylight.protocol.bgp.evpn.impl.nlri.EvpnNlriParser;
  23 import org.opendaylight.protocol.bgp.parser.spi.PathIdUtil;
  24 import org.opendaylight.protocol.bgp.rib.spi.AbstractRIBSupport;
  25 import org.opendaylight.protocol.util.ByteArray;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.evpn.rev180329.EvpnSubsequentAddressFamily;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.evpn.rev180329.L2vpnAddressFamily;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.evpn.rev180329.bgp.rib.rib.loc.rib.tables.routes.EvpnRoutesCase;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.evpn.rev180329.bgp.rib.rib.loc.rib.tables.routes.EvpnRoutesCaseBuilder;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.evpn.rev180329.evpn.destination.EvpnDestination;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.evpn.rev180329.evpn.routes.EvpnRoutes;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.evpn.rev180329.evpn.routes.EvpnRoutesBuilder;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.evpn.rev180329.evpn.routes.evpn.routes.EvpnRoute;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.evpn.rev180329.evpn.routes.evpn.routes.EvpnRouteBuilder;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.evpn.rev180329.evpn.routes.evpn.routes.EvpnRouteKey;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.evpn.rev180329.update.attributes.mp.reach.nlri.advertized.routes.destination.type.destination.evpn._case.DestinationEvpn;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.evpn.rev180329.update.attributes.mp.unreach.nlri.withdrawn.routes.destination.type.DestinationEvpnCaseBuilder;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.evpn.rev180329.update.attributes.mp.unreach.nlri.withdrawn.routes.destination.type.destination.evpn._case.DestinationEvpnBuilder;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.PathId;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.path.attributes.Attributes;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.destination.DestinationType;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.rib.tables.Routes;
  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.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 final class EvpnRibSupport extends AbstractRIBSupport<EvpnRoutesCase, EvpnRoutes, EvpnRoute, EvpnRouteKey> {
  56     private static final Logger LOG = LoggerFactory.getLogger(EvpnRibSupport.class);
  57
  58     private static final NodeIdentifier NLRI_ROUTES_LIST = NodeIdentifier.create(EvpnDestination.QNAME);
  59     private static final EvpnRoutes EMPTY_CONTAINER
  60             =  new EvpnRoutesBuilder().setEvpnRoute(Collections.emptyList()).build();
  61     @Deprecated
  62     private static final EvpnRoutesCase EMPTY_CASE =
  63             new EvpnRoutesCaseBuilder().setEvpnRoutes(EMPTY_CONTAINER).build();
  64     private static EvpnRibSupport SINGLETON;
  65
  66     private EvpnRibSupport(final BindingNormalizedNodeSerializer mappingService) {
  67         super(mappingService,
  68                 EvpnRoutesCase.class,
  69                 EvpnRoutes.class,
  70                 EvpnRoute.class,
  71                 L2vpnAddressFamily.class,
  72                 EvpnSubsequentAddressFamily.class,
  73                 DestinationEvpn.QNAME);
  74     }
  75
  76     static synchronized EvpnRibSupport getInstance(final BindingNormalizedNodeSerializer mappingService) {
  77         if (SINGLETON == null) {
  78             SINGLETON = new EvpnRibSupport(mappingService);
  79         }
  80         return SINGLETON;
  81     }
  82
  83     @Override
  84     protected DestinationType buildDestination(final Collection<MapEntryNode> routes) {
  85         return new org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.evpn.rev180329.update
  86                 .attributes.mp.reach.nlri.advertized.routes.destination.type.DestinationEvpnCaseBuilder()
  87                 .setDestinationEvpn(new org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.evpn
  88                         .rev180329.update.attributes.mp.reach.nlri.advertized.routes.destination.type.destination
  89                         .evpn._case.DestinationEvpnBuilder().setEvpnDestination(extractRoutes(routes)).build()).build();
  90     }
  91
  92     @Override
  93     protected DestinationType buildWithdrawnDestination(final Collection<MapEntryNode> routes) {
  94         return new DestinationEvpnCaseBuilder().setDestinationEvpn(new DestinationEvpnBuilder()
  95                 .setEvpnDestination(extractRoutes(routes)).build()).build();
  96     }
  97
  98     private static List<EvpnDestination> extractRoutes(final Collection<MapEntryNode> routes) {
  99         return routes.stream().map(EvpnNlriParser::extractEvpnDestination).collect(Collectors.toList());
 100     }
 101
 102     @Override
 103     protected Collection<NodeIdentifierWithPredicates> processDestination(final DOMDataTreeWriteTransaction tx,
 104                                                                           final YangInstanceIdentifier routesPath,
 105                                                                           final ContainerNode destination,
 106                                                                           final ContainerNode attributes,
 107                                                                           final ApplyRoute function) {
 108         if (destination != null) {
 109             final Optional<DataContainerChild<? extends PathArgument, ?>> maybeRoutes = destination
 110                     .getChild(NLRI_ROUTES_LIST);
 111             if (maybeRoutes.isPresent()) {
 112                 final DataContainerChild<? extends PathArgument, ?> routes = maybeRoutes.get();
 113                 if (routes instanceof UnkeyedListNode) {
 114                     final YangInstanceIdentifier base = routesYangInstanceIdentifier(routesPath);
 115                     final Collection<UnkeyedListEntryNode> routesList = ((UnkeyedListNode) routes).getValue();
 116                     final List<NodeIdentifierWithPredicates> keys = new ArrayList<>(routesList.size());
 117                     for (final UnkeyedListEntryNode evpnDest : routesList) {
 118                         final NodeIdentifierWithPredicates routeKey = createRouteKey(evpnDest);
 119                         function.apply(tx, base, routeKey, evpnDest, attributes);
 120                         keys.add(routeKey);
 121                     }
 122                     return keys;
 123                 } else {
 124                     LOG.warn("Routes {} are not a map", routes);
 125                 }
 126             }
 127         }
 128         return Collections.emptyList();
 129     }
 130
 131     private NodeIdentifierWithPredicates createRouteKey(final UnkeyedListEntryNode evpn) {
 132         final ByteBuf buffer = Unpooled.buffer();
 133         final EvpnDestination dest = EvpnNlriParser.extractRouteKeyDestination(evpn);
 134         EvpnNlriParser.serializeNlri(Collections.singletonList(dest), buffer);
 135         final Optional<DataContainerChild<? extends PathArgument, ?>> maybePathIdLeaf =
 136                 evpn.getChild(routePathIdNid());
 137         return PathIdUtil.createNidKey(routeQName(), routeKeyQName(),
 138                 pathIdQName(), ByteArray.encodeBase64(buffer), maybePathIdLeaf);
 139     }
 140
 141     @Override
 142     public EvpnRoute createRoute(final EvpnRoute route, final EvpnRouteKey key, final Attributes attributes) {
 143         final EvpnRouteBuilder builder;
 144         if (route != null) {
 145             builder = new EvpnRouteBuilder(route);
 146         } else {
 147             builder = new EvpnRouteBuilder();
 148         }
 149         return builder.withKey(key).setAttributes(attributes).build();
 150     }
 151
 152     @Override
 153     @Deprecated
 154     public EvpnRoutesCase emptyRoutesCase() {
 155         return EMPTY_CASE;
 156     }
 157
 158     @Override
 159     public EvpnRoutes emptyRoutesContainer() {
 160         return EMPTY_CONTAINER;
 161     }
 162
 163     @Override
 164     public EvpnRouteKey createRouteListKey(final PathId pathId, final String routeKey) {
 165         return new EvpnRouteKey(pathId, routeKey);
 166     }
 167
 168     @Override
 169     public PathId extractPathId(final EvpnRouteKey routeListKey) {
 170         return routeListKey.getPathId();
 171     }
 172
 173     @Override
 174     public String extractRouteKey(final EvpnRouteKey routeListKey) {
 175         return routeListKey.getRouteKey();
 176     }
 177
 178     @Override
 179     public List<EvpnRoute> extractAdjRibInRoutes(Routes routes) {
 180         verify(routes instanceof org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.evpn.rev180329
 181             .bgp.rib.rib.peer.adj.rib.in.tables.routes.EvpnRoutesCase, "Unrecognized routes %s", routes);
 182         return ((org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.evpn.rev180329
 183                 .bgp.rib.rib.peer.adj.rib.in.tables.routes.EvpnRoutesCase) routes).getEvpnRoutes().nonnullEvpnRoute();
 184     }
 185 }