2 * Copyright (c) 2016 Cisco Systems, Inc. and others. 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 java.util.Objects.requireNonNull;
12 import com.google.common.base.Preconditions;
13 import com.google.common.collect.Iterables;
14 import com.google.common.util.concurrent.FluentFuture;
15 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
16 import io.netty.util.concurrent.Future;
17 import java.net.InetSocketAddress;
18 import java.util.ArrayList;
19 import java.util.Collections;
20 import java.util.List;
22 import java.util.Objects;
23 import java.util.Optional;
25 import java.util.stream.Collectors;
26 import org.apache.commons.lang3.StringUtils;
27 import org.checkerframework.checker.lock.qual.GuardedBy;
28 import org.opendaylight.mdsal.binding.api.RpcProviderService;
29 import org.opendaylight.mdsal.common.api.CommitInfo;
30 import org.opendaylight.protocol.bgp.openconfig.spi.BGPTableTypeRegistryConsumer;
31 import org.opendaylight.protocol.bgp.parser.BgpExtendedMessageUtil;
32 import org.opendaylight.protocol.bgp.parser.spi.MultiprotocolCapabilitiesUtil;
33 import org.opendaylight.protocol.bgp.parser.spi.RevisedErrorHandlingSupport;
34 import org.opendaylight.protocol.bgp.rib.impl.BGPPeer;
35 import org.opendaylight.protocol.bgp.rib.impl.BgpPeerUtil;
36 import org.opendaylight.protocol.bgp.rib.impl.spi.BGPDispatcher;
37 import org.opendaylight.protocol.bgp.rib.impl.spi.BGPPeerRegistry;
38 import org.opendaylight.protocol.bgp.rib.impl.spi.BGPSessionPreferences;
39 import org.opendaylight.protocol.bgp.rib.impl.spi.RIB;
40 import org.opendaylight.protocol.bgp.rib.spi.state.BGPPeerState;
41 import org.opendaylight.protocol.bgp.rib.spi.state.BGPPeerStateConsumer;
42 import org.opendaylight.protocol.concepts.KeyMapping;
43 import org.opendaylight.protocol.util.Ipv4Util;
44 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.multiprotocol.rev151009.bgp.common.afi.safi.list.AfiSafi;
45 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.neighbor.group.AfiSafis;
46 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.neighbor.group.Config;
47 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.neighbors.Neighbor;
48 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.peer.group.PeerGroup;
49 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.top.Bgp;
50 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber;
51 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
52 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber;
53 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.open.message.BgpParameters;
54 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.open.message.bgp.parameters.OptionalCapabilities;
55 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.open.message.bgp.parameters.OptionalCapabilitiesBuilder;
56 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.open.message.bgp.parameters.optional.capabilities.CParametersBuilder;
57 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.open.message.bgp.parameters.optional.capabilities.c.parameters.As4BytesCapabilityBuilder;
58 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.BgpTableType;
59 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.CParameters1;
60 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.CParameters1Builder;
61 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.mp.capabilities.AddPathCapabilityBuilder;
62 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.mp.capabilities.MultiprotocolCapabilityBuilder;
63 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.mp.capabilities.add.path.capability.AddressFamilies;
64 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.openconfig.extensions.rev180329.NeighborPeerGroupConfig;
65 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.PeerRole;
66 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.rib.TablesKey;
67 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev180329.ClusterIdentifier;
68 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
69 import org.osgi.framework.ServiceRegistration;
70 import org.slf4j.Logger;
71 import org.slf4j.LoggerFactory;
73 public class BgpPeer implements PeerBean, BGPPeerStateConsumer {
75 private static final Logger LOG = LoggerFactory.getLogger(BgpPeer.class);
77 private final RpcProviderService rpcRegistry;
79 private ServiceRegistration<?> serviceRegistration;
81 private Neighbor currentConfiguration;
83 private BgpPeerSingletonService bgpPeerSingletonService;
85 public BgpPeer(final RpcProviderService rpcRegistry) {
86 this.rpcRegistry = rpcRegistry;
89 @SuppressFBWarnings(value = "UPM_UNCALLED_PRIVATE_METHOD",
90 justification = "https://github.com/spotbugs/spotbugs/issues/811")
91 private static List<OptionalCapabilities> getBgpCapabilities(final AfiSafis afiSafis, final RIB rib,
92 final BGPTableTypeRegistryConsumer tableTypeRegistry) {
93 final List<OptionalCapabilities> caps = new ArrayList<>();
94 caps.add(new OptionalCapabilitiesBuilder().setCParameters(new CParametersBuilder().setAs4BytesCapability(
95 new As4BytesCapabilityBuilder().setAsNumber(rib.getLocalAs()).build()).build()).build());
97 caps.add(new OptionalCapabilitiesBuilder()
98 .setCParameters(BgpExtendedMessageUtil.EXTENDED_MESSAGE_CAPABILITY).build());
99 caps.add(new OptionalCapabilitiesBuilder()
100 .setCParameters(MultiprotocolCapabilitiesUtil.RR_CAPABILITY).build());
102 final List<AfiSafi> afiSafi = OpenConfigMappingUtil.getAfiSafiWithDefault(afiSafis, false);
103 final List<AddressFamilies> addPathCapability = OpenConfigMappingUtil
104 .toAddPathCapability(afiSafi, tableTypeRegistry);
105 if (!addPathCapability.isEmpty()) {
106 caps.add(new OptionalCapabilitiesBuilder()
107 .setCParameters(new CParametersBuilder().addAugmentation(CParameters1.class,
108 new CParameters1Builder().setAddPathCapability(
109 new AddPathCapabilityBuilder()
110 .setAddressFamilies(addPathCapability).build()).build()).build()).build());
113 final List<BgpTableType> tableTypes = OpenConfigMappingUtil.toTableTypes(afiSafi, tableTypeRegistry);
114 for (final BgpTableType tableType : tableTypes) {
115 if (!rib.getLocalTables().contains(tableType)) {
116 LOG.info("RIB instance does not list {} in its local tables. Incoming data will be dropped.",
120 caps.add(new OptionalCapabilitiesBuilder().setCParameters(
121 new CParametersBuilder().addAugmentation(CParameters1.class,
122 new CParameters1Builder().setMultiprotocolCapability(
123 new MultiprotocolCapabilityBuilder(tableType).build()).build()).build()).build());
128 @SuppressFBWarnings(value = "UPM_UNCALLED_PRIVATE_METHOD",
129 justification = "https://github.com/spotbugs/spotbugs/issues/811")
130 private static Optional<byte[]> getPassword(final KeyMapping key) {
132 return Optional.of(Iterables.getOnlyElement(key.values()));
134 return Optional.empty();
138 public synchronized void start(final RIB rib, final Neighbor neighbor, final InstanceIdentifier<Bgp> bgpIid,
139 final PeerGroupConfigLoader peerGroupLoader, final BGPTableTypeRegistryConsumer tableTypeRegistry) {
140 Preconditions.checkState(this.bgpPeerSingletonService == null,
141 "Previous peer instance was not closed.");
143 this.bgpPeerSingletonService = new BgpPeerSingletonService(rib, neighbor, bgpIid, peerGroupLoader,
145 this.currentConfiguration = neighbor;
149 public synchronized void restart(final RIB rib, final InstanceIdentifier<Bgp> bgpIid,
150 final PeerGroupConfigLoader peerGroupLoader, final BGPTableTypeRegistryConsumer tableTypeRegistry) {
151 Preconditions.checkState(this.currentConfiguration != null);
152 start(rib, this.currentConfiguration, bgpIid, peerGroupLoader, tableTypeRegistry);
156 public void close() {
157 if (this.serviceRegistration != null) {
158 this.serviceRegistration.unregister();
159 this.serviceRegistration = null;
164 public synchronized void instantiateServiceInstance() {
165 if (this.bgpPeerSingletonService != null) {
166 this.bgpPeerSingletonService.instantiateServiceInstance();
171 public synchronized FluentFuture<? extends CommitInfo> closeServiceInstance() {
172 if (this.bgpPeerSingletonService != null) {
173 final FluentFuture<? extends CommitInfo> fut = this.bgpPeerSingletonService.closeServiceInstance();
174 this.bgpPeerSingletonService = null;
177 return CommitInfo.emptyFluentFuture();
181 public synchronized Boolean containsEqualConfiguration(final Neighbor neighbor) {
182 if (this.currentConfiguration == null) {
185 final AfiSafis actAfiSafi = this.currentConfiguration.getAfiSafis();
186 final AfiSafis extAfiSafi = neighbor.getAfiSafis();
187 final List<AfiSafi> actualSafi = actAfiSafi != null ? actAfiSafi.getAfiSafi() : Collections.emptyList();
188 final List<AfiSafi> extSafi = extAfiSafi != null ? extAfiSafi.getAfiSafi() : Collections.emptyList();
189 return actualSafi.containsAll(extSafi) && extSafi.containsAll(actualSafi)
190 && Objects.equals(this.currentConfiguration.getConfig(), neighbor.getConfig())
191 && Objects.equals(this.currentConfiguration.getNeighborAddress(), neighbor.getNeighborAddress())
192 && Objects.equals(this.currentConfiguration.getAddPaths(), neighbor.getAddPaths())
193 && Objects.equals(this.currentConfiguration.getApplyPolicy(), neighbor.getApplyPolicy())
194 && Objects.equals(this.currentConfiguration.getAsPathOptions(), neighbor.getAsPathOptions())
195 && Objects.equals(this.currentConfiguration.getEbgpMultihop(), neighbor.getEbgpMultihop())
196 && Objects.equals(this.currentConfiguration.getGracefulRestart(), neighbor.getGracefulRestart())
197 && Objects.equals(this.currentConfiguration.getErrorHandling(), neighbor.getErrorHandling())
198 && Objects.equals(this.currentConfiguration.getLoggingOptions(), neighbor.getLoggingOptions())
199 && Objects.equals(this.currentConfiguration.getRouteReflector(), neighbor.getRouteReflector())
200 && Objects.equals(this.currentConfiguration.getState(), neighbor.getState())
201 && Objects.equals(this.currentConfiguration.getTimers(), neighbor.getTimers())
202 && Objects.equals(this.currentConfiguration.getTransport(), neighbor.getTransport());
206 public synchronized BGPPeerState getPeerState() {
207 if (this.bgpPeerSingletonService == null) {
210 return this.bgpPeerSingletonService.getPeerState();
213 synchronized void setServiceRegistration(final ServiceRegistration<?> serviceRegistration) {
214 this.serviceRegistration = serviceRegistration;
217 synchronized void removePeer(final BGPPeerRegistry bgpPeerRegistry) {
218 if (BgpPeer.this.currentConfiguration != null) {
219 bgpPeerRegistry.removePeer(BgpPeer.this.currentConfiguration.getNeighborAddress());
223 private final class BgpPeerSingletonService implements BGPPeerStateConsumer {
224 private final boolean activeConnection;
225 private final BGPDispatcher dispatcher;
226 private final InetSocketAddress inetAddress;
227 private final int retryTimer;
228 private final KeyMapping keys;
229 private final InetSocketAddress localAddress;
230 private final BGPPeer bgpPeer;
231 private final IpAddress neighborAddress;
232 private final BGPSessionPreferences prefs;
233 private Future<Void> connection;
234 private boolean isServiceInstantiated;
235 private final List<OptionalCapabilities> finalCapabilities;
236 private final int gracefulRestartTimer;
237 private final RevisedErrorHandlingSupport errorHandling;
240 private BgpPeerSingletonService(final RIB rib, final Neighbor neighbor, final InstanceIdentifier<Bgp> bgpIid,
241 final PeerGroupConfigLoader peerGroupLoader, final BGPTableTypeRegistryConsumer tableTypeRegistry) {
242 this.neighborAddress = neighbor.getNeighborAddress();
244 PeerGroup peerGroup = null;
245 String peerGroupName = null;
246 final Config neighborConfig = neighbor.getConfig();
247 if (neighborConfig != null) {
248 final NeighborPeerGroupConfig pgConfig = neighborConfig.augmentation(NeighborPeerGroupConfig.class);
249 if (pgConfig != null) {
250 peerGroupName = StringUtils.substringBetween(pgConfig.getPeerGroup(), "=\"", "\"");
251 peerGroup = peerGroupLoader.getPeerGroup(bgpIid, peerGroupName);
254 final AfiSafis afisSafis;
255 if (peerGroup != null && peerGroup.getAfiSafis() != null) {
256 afisSafis = peerGroup.getAfiSafis();
258 afisSafis = requireNonNull(neighbor.getAfiSafis(), "Missing mandatory AFIs/SAFIs");
261 final Set<TablesKey> afiSafisAdvertized = OpenConfigMappingUtil
262 .toTableKey(afisSafis.getAfiSafi(), tableTypeRegistry);
263 final PeerRole role = OpenConfigMappingUtil.toPeerRole(neighbor, peerGroup);
265 final ClusterIdentifier clusterId = OpenConfigMappingUtil
266 .getNeighborClusterIdentifier(neighbor.getRouteReflector(), peerGroup);
267 final int hold = OpenConfigMappingUtil.getHoldTimer(neighbor, peerGroup);
268 this.gracefulRestartTimer = OpenConfigMappingUtil.getGracefulRestartTimer(neighbor,
270 final Set<TablesKey> gracefulTables = GracefulRestartUtil.getGracefulTables(afisSafis.getAfiSafi(),
272 final Map<TablesKey, Integer> llGracefulTimers = GracefulRestartUtil
273 .getLlGracefulTimers(afisSafis.getAfiSafi(), tableTypeRegistry);
274 this.finalCapabilities = getBgpCapabilities(afisSafis, rib, tableTypeRegistry);
275 final List<BgpParameters> bgpParameters = getInitialBgpParameters(gracefulTables, llGracefulTimers);
276 final KeyMapping keyMapping = OpenConfigMappingUtil.getNeighborKey(neighbor);
277 final IpAddress neighborLocalAddress = OpenConfigMappingUtil.getLocalAddress(neighbor.getTransport());
278 final AsNumber globalAs = rib.getLocalAs();
279 final AsNumber neighborRemoteAs = OpenConfigMappingUtil
280 .getRemotePeerAs(neighbor.getConfig(), peerGroup, globalAs);
281 final AsNumber neighborLocalAs;
282 if (role == PeerRole.Ebgp) {
283 neighborLocalAs = OpenConfigMappingUtil.getLocalPeerAs(neighbor.getConfig(), globalAs);
285 neighborLocalAs = globalAs;
288 this.errorHandling = OpenConfigMappingUtil.getRevisedErrorHandling(role, peerGroup, neighbor);
289 this.bgpPeer = new BGPPeer(tableTypeRegistry, this.neighborAddress, peerGroupName, rib, role, clusterId,
290 neighborLocalAs, BgpPeer.this.rpcRegistry, afiSafisAdvertized, gracefulTables, llGracefulTimers,
292 this.prefs = new BGPSessionPreferences(neighborLocalAs, hold, rib.getBgpIdentifier(),
293 neighborRemoteAs, bgpParameters, getPassword(keyMapping));
294 this.activeConnection = OpenConfigMappingUtil.isActive(neighbor, peerGroup);
295 this.retryTimer = OpenConfigMappingUtil.getRetryTimer(neighbor, peerGroup);
296 this.dispatcher = rib.getDispatcher();
298 final PortNumber port = OpenConfigMappingUtil.getPort(neighbor, peerGroup);
299 this.inetAddress = Ipv4Util.toInetSocketAddress(this.neighborAddress, port);
300 if (neighborLocalAddress != null) {
301 this.localAddress = Ipv4Util.toInetSocketAddress(neighborLocalAddress, port);
303 this.localAddress = null;
305 this.keys = keyMapping;
308 private List<BgpParameters> getInitialBgpParameters(final Set<TablesKey> gracefulTables,
309 final Map<TablesKey, Integer> llGracefulTimers) {
310 final Set<BgpPeerUtil.LlGracefulRestartDTO> llGracefulRestarts = llGracefulTimers.entrySet().stream()
311 .map(entry -> new BgpPeerUtil.LlGracefulRestartDTO(entry.getKey(), entry.getValue(), false))
312 .collect(Collectors.toSet());
313 return Collections.singletonList(
314 GracefulRestartUtil.getGracefulBgpParameters(this.finalCapabilities, gracefulTables,
315 Collections.emptySet(), gracefulRestartTimer, false, llGracefulRestarts));
318 synchronized void instantiateServiceInstance() {
319 this.isServiceInstantiated = true;
320 LOG.info("Peer instantiated {}", this.neighborAddress);
321 this.bgpPeer.instantiateServiceInstance();
322 this.dispatcher.getBGPPeerRegistry().addPeer(this.neighborAddress, this.bgpPeer, this.prefs);
323 if (this.activeConnection) {
324 this.connection = this.dispatcher.createReconnectingClient(this.inetAddress, this.localAddress,
325 this.retryTimer, this.keys);
329 synchronized FluentFuture<? extends CommitInfo> closeServiceInstance() {
330 if (!this.isServiceInstantiated) {
331 LOG.info("Peer {} already closed", this.neighborAddress);
332 return CommitInfo.emptyFluentFuture();
334 LOG.info("Close Peer {}", this.neighborAddress);
335 this.isServiceInstantiated = false;
336 if (this.connection != null) {
337 this.connection.cancel(true);
338 this.connection = null;
340 final FluentFuture<? extends CommitInfo> future = this.bgpPeer.close();
341 removePeer(this.dispatcher.getBGPPeerRegistry());
346 public BGPPeerState getPeerState() {
347 return this.bgpPeer.getPeerState();
351 public synchronized List<OptionalCapabilities> getBgpFixedCapabilities() {
352 return this.bgpPeerSingletonService.finalCapabilities;
355 public synchronized int getGracefulRestartTimer() {
356 return this.bgpPeerSingletonService.gracefulRestartTimer;
359 public synchronized Optional<RevisedErrorHandlingSupport> getErrorHandling() {
360 return Optional.ofNullable(this.bgpPeerSingletonService.errorHandling);