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 io.netty.buffer.ByteBuf;
  11 import io.netty.buffer.Unpooled;
  12 import java.util.Collection;
  13 import java.util.Collections;
  14 import java.util.List;
  15 import java.util.Optional;
  16 import java.util.stream.Collectors;
  17 import org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction;
  18 import org.opendaylight.mdsal.binding.dom.codec.api.BindingNormalizedNodeSerializer;
  19 import org.opendaylight.protocol.bgp.evpn.impl.nlri.EvpnNlriParser;
  20 import org.opendaylight.protocol.bgp.parser.spi.PathIdUtil;
  21 import org.opendaylight.protocol.bgp.rib.spi.AbstractRIBSupport;
  22 import org.opendaylight.protocol.util.ByteArray;
  23 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.evpn.rev180329.EvpnSubsequentAddressFamily;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.evpn.rev180329.L2vpnAddressFamily;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.evpn.rev180329.bgp.rib.rib.loc.rib.tables.routes.EvpnRoutesCase;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.evpn.rev180329.bgp.rib.rib.loc.rib.tables.routes.EvpnRoutesCaseBuilder;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.evpn.rev180329.evpn.destination.EvpnDestination;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.evpn.rev180329.evpn.routes.EvpnRoutes;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.evpn.rev180329.evpn.routes.EvpnRoutesBuilder;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.evpn.rev180329.evpn.routes.evpn.routes.EvpnRoute;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.evpn.rev180329.evpn.routes.evpn.routes.EvpnRouteBuilder;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.evpn.rev180329.evpn.routes.evpn.routes.EvpnRouteKey;
  33 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;
  34 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;
  35 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;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.PathId;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.path.attributes.Attributes;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.destination.DestinationType;
  39 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  40 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  41 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
  42 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  43 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  44 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
  45 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
  46 import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListEntryNode;
  47 import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListNode;
  48 import org.slf4j.Logger;
  49 import org.slf4j.LoggerFactory;
  50
  51 final class EvpnRibSupport extends AbstractRIBSupport<EvpnRoutesCase, EvpnRoutes, EvpnRoute, EvpnRouteKey> {
  52     private static final Logger LOG = LoggerFactory.getLogger(EvpnRibSupport.class);
  53
  54     private static final NodeIdentifier NLRI_ROUTES_LIST = NodeIdentifier.create(EvpnDestination.QNAME);
  55     private static final EvpnRoutes EMPTY_CONTAINER
  56             =  new EvpnRoutesBuilder().setEvpnRoute(Collections.emptyList()).build();
  57     private static final EvpnRoutesCase EMPTY_CASE =
  58             new EvpnRoutesCaseBuilder().setEvpnRoutes(EMPTY_CONTAINER).build();
  59     private static EvpnRibSupport SINGLETON;
  60
  61     private EvpnRibSupport(final BindingNormalizedNodeSerializer mappingService) {
  62         super(mappingService,
  63                 EvpnRoutesCase.class,
  64                 EvpnRoutes.class,
  65                 EvpnRoute.class,
  66                 L2vpnAddressFamily.class,
  67                 EvpnSubsequentAddressFamily.class,
  68                 DestinationEvpn.QNAME);
  69     }
  70
  71     static synchronized EvpnRibSupport getInstance(final BindingNormalizedNodeSerializer mappingService) {
  72         if (SINGLETON == null) {
  73             SINGLETON = new EvpnRibSupport(mappingService);
  74         }
  75         return SINGLETON;
  76     }
  77
  78     @Override
  79     protected DestinationType buildDestination(final Collection<MapEntryNode> routes) {
  80         return new org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.evpn.rev180329.update
  81                 .attributes.mp.reach.nlri.advertized.routes.destination.type.DestinationEvpnCaseBuilder()
  82                 .setDestinationEvpn(new org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.evpn
  83                         .rev180329.update.attributes.mp.reach.nlri.advertized.routes.destination.type.destination
  84                         .evpn._case.DestinationEvpnBuilder().setEvpnDestination(extractRoutes(routes)).build()).build();
  85     }
  86
  87     @Override
  88     protected DestinationType buildWithdrawnDestination(final Collection<MapEntryNode> routes) {
  89         return new DestinationEvpnCaseBuilder().setDestinationEvpn(new DestinationEvpnBuilder()
  90                 .setEvpnDestination(extractRoutes(routes)).build()).build();
  91     }
  92
  93     private static List<EvpnDestination> extractRoutes(final Collection<MapEntryNode> routes) {
  94         return routes.stream().map(EvpnNlriParser::extractEvpnDestination).collect(Collectors.toList());
  95     }
  96
  97     @Override
  98     protected void processDestination(final DOMDataWriteTransaction tx, final YangInstanceIdentifier routesPath,
  99         final ContainerNode destination, final ContainerNode attributes, final ApplyRoute function) {
 100         if (destination != null) {
 101             final Optional<DataContainerChild<? extends PathArgument, ?>> maybeRoutes = destination
 102                     .getChild(NLRI_ROUTES_LIST);
 103             if (maybeRoutes.isPresent()) {
 104                 final DataContainerChild<? extends PathArgument, ?> routes = maybeRoutes.get();
 105                 if (routes instanceof UnkeyedListNode) {
 106                     final YangInstanceIdentifier base = routesYangInstanceIdentifier(routesPath);
 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     private NodeIdentifierWithPredicates createRouteKey(final UnkeyedListEntryNode evpn) {
 119         final ByteBuf buffer = Unpooled.buffer();
 120         final EvpnDestination dest = EvpnNlriParser.extractRouteKeyDestination(evpn);
 121         EvpnNlriParser.serializeNlri(Collections.singletonList(dest), buffer);
 122         final Optional<DataContainerChild<? extends PathArgument, ?>> maybePathIdLeaf =
 123                 evpn.getChild(routePathIdNid());
 124         return PathIdUtil.createNidKey(routeQName(), routeKeyQName(),
 125                 pathIdQName(), ByteArray.encodeBase64(buffer), maybePathIdLeaf);
 126     }
 127
 128     @Override
 129     public EvpnRoute createRoute(final EvpnRoute route, final String routeKey, final long pathId,
 130             final Attributes attributes) {
 131         final EvpnRouteBuilder builder;
 132         if (route != null) {
 133             builder = new EvpnRouteBuilder(route);
 134         } else {
 135             builder = new EvpnRouteBuilder();
 136         }
 137         return builder.withKey(createRouteListKey(pathId, routeKey)).setAttributes(attributes).build();
 138     }
 139
 140     @Override
 141     public EvpnRoutesCase emptyRoutesCase() {
 142         return EMPTY_CASE;
 143     }
 144
 145     @Override
 146     public EvpnRoutes emptyRoutesContainer() {
 147         return EMPTY_CONTAINER;
 148     }
 149
 150     @Override
 151     public EvpnRouteKey createRouteListKey(final long pathId, final String routeKey) {
 152         return new EvpnRouteKey(new PathId(pathId), routeKey);
 153     }
 154 }