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