bgp/rib-impl/src/main/java/org/opendaylight/protocol/bgp/rib/impl/config/GracefulRestartUtil.java

   1 /*
   2  * Copyright (c) 2018 AT&T Intellectual Property. 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.rib.impl.config;
   9
  10 import static org.opendaylight.protocol.bgp.parser.GracefulRestartUtil.gracefulRestartCapability;
  11 import static org.opendaylight.protocol.bgp.parser.GracefulRestartUtil.gracefulRestartTable;
  12
  13 import com.google.common.collect.Maps;
  14 import java.util.ArrayList;
  15 import java.util.Collection;
  16 import java.util.HashMap;
  17 import java.util.HashSet;
  18 import java.util.List;
  19 import java.util.Map;
  20 import java.util.Set;
  21 import org.opendaylight.protocol.bgp.openconfig.spi.BGPTableTypeRegistryConsumer;
  22 import org.opendaylight.protocol.bgp.rib.impl.BgpPeerUtil;
  23 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.multiprotocol.rev151009.bgp.common.afi.safi.list.AfiSafi;
  24 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.multiprotocol.rev151009.bgp.common.afi.safi.list.afi.safi.GracefulRestart;
  25 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.multiprotocol.rev151009.bgp.common.afi.safi.list.afi.safi.graceful.restart.Config;
  26 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.types.rev151009.AfiSafiType;
  27 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.routing.types.rev171204.Uint24;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.ll.graceful.restart.rev181112.Config1;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.ll.graceful.restart.rev181112.Config2;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.ll.graceful.restart.rev181112.afi.safi.ll.graceful.restart.LlGracefulRestart;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.open.message.BgpParameters;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.open.message.BgpParametersBuilder;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.open.message.bgp.parameters.OptionalCapabilities;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.open.message.bgp.parameters.OptionalCapabilitiesBuilder;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.open.message.bgp.parameters.optional.capabilities.CParameters;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.open.message.bgp.parameters.optional.capabilities.CParametersBuilder;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.CParameters1Builder;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.mp.capabilities.LlGracefulRestartCapabilityBuilder;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.mp.capabilities.ll.graceful.restart.capability.Tables.AfiFlags;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.mp.capabilities.ll.graceful.restart.capability.TablesBuilder;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.rib.TablesKey;
  42 import org.opendaylight.yangtools.yang.binding.util.BindingMap;
  43 import org.opendaylight.yangtools.yang.common.Uint32;
  44 import org.slf4j.Logger;
  45 import org.slf4j.LoggerFactory;
  46
  47 /**
  48  * Helpers for dealing with Graceful Restart capabilities.
  49  *
  50  * @deprecated This class is competing with bgp-parser-api's view of GR and will be renamed and/or eliminated.
  51  */
  52 // FIXME: This functionality should live in bgp-parser-api, except the use of RIB version of TablesKey prevents that.
  53 //        We should be able to refactor this class by providing TablesKey translation somewhere.
  54 @Deprecated
  55 public final class GracefulRestartUtil {
  56     private static final Logger LOG = LoggerFactory.getLogger(GracefulRestartUtil.class);
  57
  58     private GracefulRestartUtil() {
  59         // Hidden on purpose
  60     }
  61
  62     public static CParameters getGracefulCapability(final Map<TablesKey, Boolean> tables,
  63                                                     final int restartTime,
  64                                                     final boolean localRestarting) {
  65         return gracefulRestartCapability(tables.entrySet().stream()
  66             .map(entry -> {
  67                 final TablesKey key = entry.getKey();
  68                 return gracefulRestartTable(key.getAfi(), key.getSafi(), entry.getValue());
  69             })
  70             .collect(BindingMap.toMap()), restartTime, localRestarting);
  71     }
  72
  73     public static CParameters getLlGracefulCapability(final Set<BgpPeerUtil.LlGracefulRestartDTO> llGracefulRestarts) {
  74         return new CParametersBuilder()
  75                 .addAugmentation(new CParameters1Builder()
  76                     .setLlGracefulRestartCapability(new LlGracefulRestartCapabilityBuilder()
  77                         .setTables(llGracefulRestarts.stream()
  78                             .map(dto -> new TablesBuilder()
  79                                 .setAfi(dto.getTableKey().getAfi())
  80                                 .setSafi(dto.getTableKey().getSafi())
  81                                 .setAfiFlags(new AfiFlags(dto.isForwarding()))
  82                                 .setLongLivedStaleTime(new Uint24(Uint32.valueOf(dto.getStaleTime())))
  83                                 .build())
  84                             .collect(BindingMap.toMap()))
  85                         .build())
  86                     .build())
  87                 .build();
  88     }
  89
  90     static Set<TablesKey> getGracefulTables(final Collection<? extends AfiSafi> afiSafis,
  91                                             final BGPTableTypeRegistryConsumer tableTypeRegistry) {
  92         Set<TablesKey> gracefulTables = new HashSet<>();
  93         for (final AfiSafi afiSafi : afiSafis) {
  94             final GracefulRestart gr = afiSafi.getGracefulRestart();
  95             if (gr != null) {
  96                 final Config config = gr.getConfig();
  97                 if (config != null && Boolean.TRUE.equals(config.getEnabled())) {
  98                     final AfiSafiType afiSafiName = afiSafi.getAfiSafiName();
  99                     if (afiSafiName != null) {
 100                         final TablesKey tablesKey = tableTypeRegistry.getTableKey(afiSafiName);
 101                         if (tablesKey != null) {
 102                             gracefulTables.add(tablesKey);
 103                         }
 104                     }
 105                 }
 106             }
 107         }
 108         return gracefulTables;
 109     }
 110
 111     static Map<TablesKey, Integer> getLlGracefulTimers(final Collection<? extends AfiSafi> afiSafis,
 112                                                        final BGPTableTypeRegistryConsumer tableTypeRegistry) {
 113         final Map<TablesKey, Integer> timers = new HashMap<>();
 114         afiSafis.forEach(afiSafi -> {
 115             final GracefulRestart gracefulRestart = afiSafi.getGracefulRestart();
 116             if (gracefulRestart != null) {
 117                 final Config gracefulRestartConfig = gracefulRestart.getConfig();
 118                 if (gracefulRestartConfig != null) {
 119                     final LlGracefulRestart llGracefulRestart;
 120                     final Config1 peerAug = gracefulRestartConfig.augmentation(Config1.class);
 121                     if (peerAug != null) {
 122                         llGracefulRestart = peerAug.getLlGracefulRestart();
 123                     } else {
 124                         final Config2 neighborAug = gracefulRestartConfig.augmentation(Config2.class);
 125                         if (neighborAug != null) {
 126                             llGracefulRestart = neighborAug.getLlGracefulRestart();
 127                         } else {
 128                             return;
 129                         }
 130                     }
 131                     if (llGracefulRestart != null) {
 132                         final org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.ll.graceful.restart
 133                                 .rev181112.afi.safi.ll.graceful.restart.ll.graceful.restart.Config config =
 134                                 llGracefulRestart.getConfig();
 135                         if (config != null) {
 136                             final Uint24 staleTime = config.getLongLivedStaleTime();
 137                             if (staleTime != null && staleTime.getValue().toJava() > 0) {
 138                                 final TablesKey key = tableTypeRegistry.getTableKey(afiSafi.getAfiSafiName());
 139                                 if (key != null) {
 140                                     timers.put(key, staleTime.getValue().intValue());
 141                                 } else {
 142                                     LOG.debug("Skipping unsupported afi-safi {}", afiSafi.getAfiSafiName());
 143                                 }
 144                             }
 145                         }
 146                     }
 147                 }
 148             }
 149         });
 150         return timers;
 151     }
 152
 153     public static BgpParameters getGracefulBgpParameters(final List<OptionalCapabilities> fixedCapabilities,
 154                                                          final Set<TablesKey> gracefulTables,
 155                                                          final Set<TablesKey> preservedTables,
 156                                                          final int gracefulRestartTimer,
 157                                                          final boolean localRestarting,
 158                                                          final Set<BgpPeerUtil.LlGracefulRestartDTO> llGracefulDTOs) {
 159         final List<OptionalCapabilities> capabilities = new ArrayList<>(fixedCapabilities);
 160         capabilities.add(new OptionalCapabilitiesBuilder()
 161             .setCParameters(getGracefulCapability(Maps.asMap(gracefulTables, preservedTables::contains),
 162                 gracefulRestartTimer, localRestarting))
 163             .build());
 164         capabilities.add(new OptionalCapabilitiesBuilder()
 165             .setCParameters(getLlGracefulCapability(llGracefulDTOs))
 166             .build());
 167
 168         return new BgpParametersBuilder().setOptionalCapabilities(capabilities).build();
 169     }
 170 }