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