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
9 package org.opendaylight.protocol.bgp.rib.impl.config;
11 import static java.util.Objects.requireNonNull;
12 import static org.opendaylight.protocol.bgp.rib.impl.config.OpenConfigMappingUtil.getHoldTimer;
13 import static org.opendaylight.protocol.bgp.rib.impl.config.OpenConfigMappingUtil.getPeerAs;
14 import static org.opendaylight.protocol.bgp.rib.impl.config.OpenConfigMappingUtil.getSimpleRoutingPolicy;
16 import com.google.common.base.Optional;
17 import com.google.common.base.Preconditions;
18 import com.google.common.collect.Iterables;
19 import com.google.common.util.concurrent.Futures;
20 import com.google.common.util.concurrent.ListenableFuture;
21 import io.netty.util.concurrent.Future;
22 import java.net.InetSocketAddress;
23 import java.util.ArrayList;
24 import java.util.Collections;
25 import java.util.List;
26 import java.util.Objects;
28 import javax.annotation.concurrent.GuardedBy;
29 import org.opendaylight.controller.sal.binding.api.RpcProviderRegistry;
30 import org.opendaylight.mdsal.singleton.common.api.ClusterSingletonServiceRegistration;
31 import org.opendaylight.protocol.bgp.openconfig.spi.BGPTableTypeRegistryConsumer;
32 import org.opendaylight.protocol.bgp.parser.BgpExtendedMessageUtil;
33 import org.opendaylight.protocol.bgp.parser.spi.MultiprotocolCapabilitiesUtil;
34 import org.opendaylight.protocol.bgp.rib.impl.BGPPeer;
35 import org.opendaylight.protocol.bgp.rib.impl.spi.BGPDispatcher;
36 import org.opendaylight.protocol.bgp.rib.impl.spi.BGPSessionPreferences;
37 import org.opendaylight.protocol.bgp.rib.impl.spi.RIB;
38 import org.opendaylight.protocol.bgp.rib.spi.state.BGPPeerState;
39 import org.opendaylight.protocol.bgp.rib.spi.state.BGPPeerStateConsumer;
40 import org.opendaylight.protocol.concepts.KeyMapping;
41 import org.opendaylight.protocol.util.Ipv4Util;
42 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.multiprotocol.rev151009.bgp.common.afi.safi.list.AfiSafi;
43 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.neighbor.group.AfiSafis;
44 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.neighbors.Neighbor;
45 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
46 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev171207.open.message.BgpParameters;
47 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev171207.open.message.BgpParametersBuilder;
48 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev171207.open.message.bgp.parameters.OptionalCapabilities;
49 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev171207.open.message.bgp.parameters.OptionalCapabilitiesBuilder;
50 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev171207.open.message.bgp.parameters.optional.capabilities.CParametersBuilder;
51 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev171207.open.message.bgp.parameters.optional.capabilities.c.parameters.As4BytesCapabilityBuilder;
52 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev171207.BgpTableType;
53 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev171207.CParameters1;
54 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev171207.CParameters1Builder;
55 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev171207.mp.capabilities.AddPathCapabilityBuilder;
56 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev171207.mp.capabilities.MultiprotocolCapabilityBuilder;
57 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev171207.mp.capabilities.add.path.capability.AddressFamilies;
58 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev171207.rib.TablesKey;
59 import org.osgi.framework.ServiceRegistration;
60 import org.slf4j.Logger;
61 import org.slf4j.LoggerFactory;
64 public final class BgpPeer implements PeerBean, BGPPeerStateConsumer {
66 private static final Logger LOG = LoggerFactory.getLogger(BgpPeer.class);
68 private final RpcProviderRegistry rpcRegistry;
70 private ServiceRegistration<?> serviceRegistration;
72 private Neighbor currentConfiguration;
74 private BgpPeerSingletonService bgpPeerSingletonService;
76 public BgpPeer(final RpcProviderRegistry rpcRegistry) {
77 this.rpcRegistry = rpcRegistry;
80 private static List<BgpParameters> getBgpParameters(final Neighbor neighbor, final RIB rib,
81 final BGPTableTypeRegistryConsumer tableTypeRegistry) {
82 final List<BgpParameters> tlvs = new ArrayList<>();
83 final List<OptionalCapabilities> caps = new ArrayList<>();
84 caps.add(new OptionalCapabilitiesBuilder().setCParameters(new CParametersBuilder().setAs4BytesCapability(
85 new As4BytesCapabilityBuilder().setAsNumber(rib.getLocalAs()).build()).build()).build());
87 caps.add(new OptionalCapabilitiesBuilder()
88 .setCParameters(BgpExtendedMessageUtil.EXTENDED_MESSAGE_CAPABILITY).build());
89 caps.add(new OptionalCapabilitiesBuilder()
90 .setCParameters(MultiprotocolCapabilitiesUtil.RR_CAPABILITY).build());
92 final List<AfiSafi> afiSafi = OpenConfigMappingUtil
93 .getAfiSafiWithDefault(neighbor.getAfiSafis(), false);
94 final List<AddressFamilies> addPathCapability = OpenConfigMappingUtil
95 .toAddPathCapability(afiSafi, tableTypeRegistry);
96 if (!addPathCapability.isEmpty()) {
97 caps.add(new OptionalCapabilitiesBuilder()
98 .setCParameters(new CParametersBuilder().addAugmentation(CParameters1.class,
99 new CParameters1Builder().setAddPathCapability(
100 new AddPathCapabilityBuilder()
101 .setAddressFamilies(addPathCapability).build()).build()).build()).build());
104 final List<BgpTableType> tableTypes = OpenConfigMappingUtil.toTableTypes(afiSafi, tableTypeRegistry);
105 for (final BgpTableType tableType : tableTypes) {
106 if (!rib.getLocalTables().contains(tableType)) {
107 LOG.info("RIB instance does not list {} " +
108 "in its local tables. Incoming data will be dropped.", tableType);
111 caps.add(new OptionalCapabilitiesBuilder().setCParameters(
112 new CParametersBuilder().addAugmentation(CParameters1.class,
113 new CParameters1Builder().setMultiprotocolCapability(
114 new MultiprotocolCapabilityBuilder(tableType).build()).build()).build()).build());
116 tlvs.add(new BgpParametersBuilder().setOptionalCapabilities(caps).build());
120 private static Optional<byte[]> getPassword(final KeyMapping key) {
122 return Optional.of(Iterables.getOnlyElement(key.values()));
124 return Optional.absent();
128 public synchronized void start(final RIB rib, final Neighbor neighbor,
129 final BGPTableTypeRegistryConsumer tableTypeRegistry) {
130 Preconditions.checkState(this.bgpPeerSingletonService == null,
131 "Previous peer instance was not closed.");
132 this.bgpPeerSingletonService = new BgpPeerSingletonService(rib, neighbor, tableTypeRegistry);
133 this.currentConfiguration = neighbor;
137 public synchronized void restart(final RIB rib, final BGPTableTypeRegistryConsumer tableTypeRegistry) {
138 Preconditions.checkState(this.currentConfiguration != null);
139 start(rib, this.currentConfiguration, tableTypeRegistry);
143 public synchronized void close() {
144 closeSingletonService();
145 if (this.serviceRegistration != null) {
146 this.serviceRegistration.unregister();
147 this.serviceRegistration = null;
152 public synchronized void instantiateServiceInstance() {
153 if (this.bgpPeerSingletonService != null) {
154 this.bgpPeerSingletonService.instantiateServiceInstance();
159 public synchronized ListenableFuture<Void> closeServiceInstance() {
160 if (this.bgpPeerSingletonService != null) {
161 return this.bgpPeerSingletonService.closeServiceInstance();
163 return Futures.immediateFuture(null);
166 private void closeSingletonService() {
167 if (this.bgpPeerSingletonService != null) {
169 this.bgpPeerSingletonService.close();
170 this.bgpPeerSingletonService = null;
171 } catch (final Exception e) {
172 LOG.warn("Failed to close peer instance", e);
178 public Boolean containsEqualConfiguration(final Neighbor neighbor) {
179 final AfiSafis actAfiSafi = this.currentConfiguration.getAfiSafis();
180 final AfiSafis extAfiSafi = neighbor.getAfiSafis();
181 final List<AfiSafi> actualSafi = actAfiSafi != null ? actAfiSafi.getAfiSafi() : Collections.emptyList();
182 final List<AfiSafi> extSafi = extAfiSafi != null ? extAfiSafi.getAfiSafi() : Collections.emptyList();
183 return actualSafi.containsAll(extSafi) && extSafi.containsAll(actualSafi)
184 && Objects.equals(this.currentConfiguration.getConfig(), neighbor.getConfig())
185 && Objects.equals(this.currentConfiguration.getNeighborAddress(), neighbor.getNeighborAddress())
186 && Objects.equals(this.currentConfiguration.getAddPaths(), neighbor.getAddPaths())
187 && Objects.equals(this.currentConfiguration.getApplyPolicy(), neighbor.getApplyPolicy())
188 && Objects.equals(this.currentConfiguration.getAsPathOptions(), neighbor.getAsPathOptions())
189 && Objects.equals(this.currentConfiguration.getEbgpMultihop(), neighbor.getEbgpMultihop())
190 && Objects.equals(this.currentConfiguration.getGracefulRestart(), neighbor.getGracefulRestart())
191 && Objects.equals(this.currentConfiguration.getErrorHandling(), neighbor.getErrorHandling())
192 && Objects.equals(this.currentConfiguration.getLoggingOptions(), neighbor.getLoggingOptions())
193 && Objects.equals(this.currentConfiguration.getRouteReflector(), neighbor.getRouteReflector())
194 && Objects.equals(this.currentConfiguration.getState(), neighbor.getState())
195 && Objects.equals(this.currentConfiguration.getTimers(), neighbor.getTimers())
196 && Objects.equals(this.currentConfiguration.getTransport(), neighbor.getTransport());
200 public BGPPeerState getPeerState() {
201 if (this.bgpPeerSingletonService == null) {
204 return this.bgpPeerSingletonService.getPeerState();
207 synchronized void setServiceRegistration(final ServiceRegistration<?> serviceRegistration) {
208 this.serviceRegistration = serviceRegistration;
211 private final class BgpPeerSingletonService implements BGPPeerStateConsumer, AutoCloseable {
212 private final boolean activeConnection;
213 private final BGPDispatcher dispatcher;
214 private final InetSocketAddress inetAddress;
215 private final int retryTimer;
216 private final KeyMapping keys;
217 private ClusterSingletonServiceRegistration registration;
218 private final BGPPeer bgpPeer;
219 private final IpAddress neighborAddress;
220 private final BGPSessionPreferences prefs;
221 private Future<Void> connection;
223 private boolean isServiceInstantiated;
225 private BgpPeerSingletonService(final RIB rib, final Neighbor neighbor,
226 final BGPTableTypeRegistryConsumer tableTypeRegistry) {
227 this.neighborAddress = neighbor.getNeighborAddress();
228 final AfiSafis afisSAfis = requireNonNull(neighbor.getAfiSafis());
229 final Set<TablesKey> afiSafisAdvertized = OpenConfigMappingUtil
230 .toTableKey(afisSAfis.getAfiSafi(), tableTypeRegistry);
231 this.bgpPeer = new BGPPeer(this.neighborAddress, rib,
232 OpenConfigMappingUtil.toPeerRole(neighbor),
233 getSimpleRoutingPolicy(neighbor), BgpPeer.this.rpcRegistry,
234 afiSafisAdvertized, Collections.emptySet());
235 final List<BgpParameters> bgpParameters = getBgpParameters(neighbor, rib, tableTypeRegistry);
236 final KeyMapping keyMapping = OpenConfigMappingUtil.getNeighborKey(neighbor);
237 this.prefs = new BGPSessionPreferences(rib.getLocalAs(), getHoldTimer(neighbor), rib.getBgpIdentifier(),
238 getPeerAs(neighbor, rib), bgpParameters, getPassword(keyMapping));
239 this.activeConnection = OpenConfigMappingUtil.isActive(neighbor);
240 this.dispatcher = rib.getDispatcher();
241 this.inetAddress = Ipv4Util.toInetSocketAddress(this.neighborAddress,
242 OpenConfigMappingUtil.getPort(neighbor));
243 this.retryTimer = OpenConfigMappingUtil.getRetryTimer(neighbor);
244 this.keys = keyMapping;
248 public void close() throws Exception {
249 if (this.registration != null) {
250 this.registration.close();
251 this.registration = null;
255 private synchronized void instantiateServiceInstance() {
256 this.isServiceInstantiated = true;
257 LOG.info("Peer instantiated {}", this.neighborAddress);
258 this.bgpPeer.instantiateServiceInstance();
259 this.dispatcher.getBGPPeerRegistry().addPeer(this.neighborAddress, this.bgpPeer, this.prefs);
260 if (this.activeConnection) {
261 this.connection = this.dispatcher.createReconnectingClient(this.inetAddress, this.retryTimer,
266 private synchronized ListenableFuture<Void> closeServiceInstance() {
267 if (!this.isServiceInstantiated) {
268 LOG.info("Peer {} already closed", this.neighborAddress);
269 return Futures.immediateFuture(null);
271 LOG.info("Close Peer {}", this.neighborAddress);
272 this.isServiceInstantiated = false;
273 if (this.connection != null) {
274 this.connection.cancel(true);
275 this.connection = null;
277 final ListenableFuture<Void> future = this.bgpPeer.close();
278 if (BgpPeer.this.currentConfiguration != null) {
279 this.dispatcher.getBGPPeerRegistry().removePeer(BgpPeer.this.currentConfiguration.getNeighborAddress());
285 public BGPPeerState getPeerState() {
286 return this.bgpPeer.getPeerState();