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.getGlobalClusterIdentifier;
14 import com.google.common.base.Preconditions;
15 import com.google.common.collect.Iterables;
16 import com.google.common.util.concurrent.Futures;
17 import com.google.common.util.concurrent.ListenableFuture;
18 import io.netty.util.concurrent.Future;
19 import java.net.InetSocketAddress;
20 import java.util.ArrayList;
21 import java.util.Collections;
22 import java.util.List;
23 import java.util.Objects;
24 import java.util.Optional;
26 import javax.annotation.concurrent.GuardedBy;
27 import org.apache.commons.lang3.StringUtils;
28 import org.opendaylight.controller.sal.binding.api.RpcProviderRegistry;
29 import org.opendaylight.protocol.bgp.openconfig.spi.BGPTableTypeRegistryConsumer;
30 import org.opendaylight.protocol.bgp.parser.BgpExtendedMessageUtil;
31 import org.opendaylight.protocol.bgp.parser.spi.MultiprotocolCapabilitiesUtil;
32 import org.opendaylight.protocol.bgp.rib.impl.BGPPeer;
33 import org.opendaylight.protocol.bgp.rib.impl.spi.BGPDispatcher;
34 import org.opendaylight.protocol.bgp.rib.impl.spi.BGPPeerRegistry;
35 import org.opendaylight.protocol.bgp.rib.impl.spi.BGPSessionPreferences;
36 import org.opendaylight.protocol.bgp.rib.impl.spi.RIB;
37 import org.opendaylight.protocol.bgp.rib.spi.state.BGPPeerState;
38 import org.opendaylight.protocol.bgp.rib.spi.state.BGPPeerStateConsumer;
39 import org.opendaylight.protocol.concepts.KeyMapping;
40 import org.opendaylight.protocol.util.Ipv4Util;
41 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.multiprotocol.rev151009.bgp.common.afi.safi.list.AfiSafi;
42 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.neighbor.group.AfiSafis;
43 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.neighbor.group.Config;
44 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.neighbors.Neighbor;
45 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.peer.group.PeerGroup;
46 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.top.Bgp;
47 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber;
48 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
49 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev171207.open.message.BgpParameters;
50 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev171207.open.message.BgpParametersBuilder;
51 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev171207.open.message.bgp.parameters.OptionalCapabilities;
52 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev171207.open.message.bgp.parameters.OptionalCapabilitiesBuilder;
53 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev171207.open.message.bgp.parameters.optional.capabilities.CParametersBuilder;
54 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev171207.open.message.bgp.parameters.optional.capabilities.c.parameters.As4BytesCapabilityBuilder;
55 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev171207.BgpTableType;
56 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev171207.CParameters1;
57 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev171207.CParameters1Builder;
58 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev171207.mp.capabilities.AddPathCapabilityBuilder;
59 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev171207.mp.capabilities.MultiprotocolCapabilityBuilder;
60 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev171207.mp.capabilities.add.path.capability.AddressFamilies;
61 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.openconfig.extensions.rev180321.NeighborPeerGroupConfig;
62 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev171207.PeerRole;
63 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev171207.rib.TablesKey;
64 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.ClusterIdentifier;
65 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
66 import org.osgi.framework.ServiceRegistration;
67 import org.slf4j.Logger;
68 import org.slf4j.LoggerFactory;
70 public final class BgpPeer implements PeerBean, BGPPeerStateConsumer {
72 private static final Logger LOG = LoggerFactory.getLogger(BgpPeer.class);
74 private final RpcProviderRegistry rpcRegistry;
76 private ServiceRegistration<?> serviceRegistration;
78 private Neighbor currentConfiguration;
80 private BgpPeerSingletonService bgpPeerSingletonService;
82 public BgpPeer(final RpcProviderRegistry rpcRegistry) {
83 this.rpcRegistry = rpcRegistry;
86 private static List<BgpParameters> getBgpParameters(final AfiSafis afiSafis, final RIB rib,
87 final BGPTableTypeRegistryConsumer tableTypeRegistry) {
88 final List<BgpParameters> tlvs = new ArrayList<>();
89 final List<OptionalCapabilities> caps = new ArrayList<>();
90 caps.add(new OptionalCapabilitiesBuilder().setCParameters(new CParametersBuilder().setAs4BytesCapability(
91 new As4BytesCapabilityBuilder().setAsNumber(rib.getLocalAs()).build()).build()).build());
93 caps.add(new OptionalCapabilitiesBuilder()
94 .setCParameters(BgpExtendedMessageUtil.EXTENDED_MESSAGE_CAPABILITY).build());
95 caps.add(new OptionalCapabilitiesBuilder()
96 .setCParameters(MultiprotocolCapabilitiesUtil.RR_CAPABILITY).build());
98 final List<AfiSafi> afiSafi = OpenConfigMappingUtil.getAfiSafiWithDefault(afiSafis, false);
99 final List<AddressFamilies> addPathCapability = OpenConfigMappingUtil
100 .toAddPathCapability(afiSafi, tableTypeRegistry);
101 if (!addPathCapability.isEmpty()) {
102 caps.add(new OptionalCapabilitiesBuilder()
103 .setCParameters(new CParametersBuilder().addAugmentation(CParameters1.class,
104 new CParameters1Builder().setAddPathCapability(
105 new AddPathCapabilityBuilder()
106 .setAddressFamilies(addPathCapability).build()).build()).build()).build());
109 final List<BgpTableType> tableTypes = OpenConfigMappingUtil.toTableTypes(afiSafi, tableTypeRegistry);
110 for (final BgpTableType tableType : tableTypes) {
111 if (!rib.getLocalTables().contains(tableType)) {
112 LOG.info("RIB instance does not list {} " +
113 "in its local tables. Incoming data will be dropped.", tableType);
116 caps.add(new OptionalCapabilitiesBuilder().setCParameters(
117 new CParametersBuilder().addAugmentation(CParameters1.class,
118 new CParameters1Builder().setMultiprotocolCapability(
119 new MultiprotocolCapabilityBuilder(tableType).build()).build()).build()).build());
121 tlvs.add(new BgpParametersBuilder().setOptionalCapabilities(caps).build());
125 private static Optional<byte[]> getPassword(final KeyMapping key) {
127 return Optional.of(Iterables.getOnlyElement(key.values()));
129 return Optional.empty();
133 public synchronized void start(final RIB rib, final Neighbor neighbor, final InstanceIdentifier<Bgp> bgpIid,
134 final PeerGroupConfigLoader peerGroupLoader, final BGPTableTypeRegistryConsumer tableTypeRegistry) {
135 Preconditions.checkState(this.bgpPeerSingletonService == null,
136 "Previous peer instance was not closed.");
138 this.bgpPeerSingletonService = new BgpPeerSingletonService(rib, neighbor, bgpIid, peerGroupLoader,
140 this.currentConfiguration = neighbor;
144 public synchronized void restart(final RIB rib, final InstanceIdentifier<Bgp> bgpIid,
145 final PeerGroupConfigLoader peerGroupLoader, final BGPTableTypeRegistryConsumer tableTypeRegistry) {
146 Preconditions.checkState(this.currentConfiguration != null);
147 start(rib, this.currentConfiguration, bgpIid, peerGroupLoader, tableTypeRegistry);
151 public synchronized void close() {
152 if (this.serviceRegistration != null) {
153 this.serviceRegistration.unregister();
154 this.serviceRegistration = null;
159 public synchronized void instantiateServiceInstance() {
160 if (this.bgpPeerSingletonService != null) {
161 this.bgpPeerSingletonService.instantiateServiceInstance();
166 public synchronized ListenableFuture<Void> closeServiceInstance() {
167 if (this.bgpPeerSingletonService != null) {
168 final ListenableFuture<Void> fut = this.bgpPeerSingletonService.closeServiceInstance();
169 this.bgpPeerSingletonService = null;
172 return Futures.immediateFuture(null);
176 public synchronized Boolean containsEqualConfiguration(final Neighbor neighbor) {
177 if (this.currentConfiguration == null) {
180 final AfiSafis actAfiSafi = this.currentConfiguration.getAfiSafis();
181 final AfiSafis extAfiSafi = neighbor.getAfiSafis();
182 final List<AfiSafi> actualSafi = actAfiSafi != null ? actAfiSafi.getAfiSafi() : Collections.emptyList();
183 final List<AfiSafi> extSafi = extAfiSafi != null ? extAfiSafi.getAfiSafi() : Collections.emptyList();
184 return actualSafi.containsAll(extSafi) && extSafi.containsAll(actualSafi)
185 && Objects.equals(this.currentConfiguration.getConfig(), neighbor.getConfig())
186 && Objects.equals(this.currentConfiguration.getNeighborAddress(), neighbor.getNeighborAddress())
187 && Objects.equals(this.currentConfiguration.getAddPaths(), neighbor.getAddPaths())
188 && Objects.equals(this.currentConfiguration.getApplyPolicy(), neighbor.getApplyPolicy())
189 && Objects.equals(this.currentConfiguration.getAsPathOptions(), neighbor.getAsPathOptions())
190 && Objects.equals(this.currentConfiguration.getEbgpMultihop(), neighbor.getEbgpMultihop())
191 && Objects.equals(this.currentConfiguration.getGracefulRestart(), neighbor.getGracefulRestart())
192 && Objects.equals(this.currentConfiguration.getErrorHandling(), neighbor.getErrorHandling())
193 && Objects.equals(this.currentConfiguration.getLoggingOptions(), neighbor.getLoggingOptions())
194 && Objects.equals(this.currentConfiguration.getRouteReflector(), neighbor.getRouteReflector())
195 && Objects.equals(this.currentConfiguration.getState(), neighbor.getState())
196 && Objects.equals(this.currentConfiguration.getTimers(), neighbor.getTimers())
197 && Objects.equals(this.currentConfiguration.getTransport(), neighbor.getTransport());
201 public synchronized BGPPeerState getPeerState() {
202 if (this.bgpPeerSingletonService == null) {
205 return this.bgpPeerSingletonService.getPeerState();
208 synchronized void setServiceRegistration(final ServiceRegistration<?> serviceRegistration) {
209 this.serviceRegistration = serviceRegistration;
212 synchronized void removePeer(final BGPPeerRegistry bgpPeerRegistry) {
213 if (BgpPeer.this.currentConfiguration != null) {
214 bgpPeerRegistry.removePeer(BgpPeer.this.currentConfiguration.getNeighborAddress());
218 private final class BgpPeerSingletonService implements BGPPeerStateConsumer {
219 private boolean activeConnection;
220 private final BGPDispatcher dispatcher;
221 private final InetSocketAddress inetAddress;
222 private final int retryTimer;
223 private final KeyMapping keys;
224 private final BGPPeer bgpPeer;
225 private final IpAddress neighborAddress;
226 private final BGPSessionPreferences prefs;
227 private Future<Void> connection;
228 private boolean isServiceInstantiated;
230 private BgpPeerSingletonService(final RIB rib, final Neighbor neighbor, final InstanceIdentifier<Bgp> bgpIid,
231 final PeerGroupConfigLoader peerGroupLoader, final BGPTableTypeRegistryConsumer tableTypeRegistry) {
232 this.neighborAddress = neighbor.getNeighborAddress();
234 PeerGroup peerGroup = null;
235 String peerGroupName = null;
236 final Config neighborConfig = neighbor.getConfig();
237 if (neighborConfig != null) {
238 final NeighborPeerGroupConfig pgConfig = neighborConfig.getAugmentation(NeighborPeerGroupConfig.class);
239 if (pgConfig != null) {
240 peerGroupName = StringUtils.substringBetween(pgConfig.getPeerGroup(), "=\"", "\"");
241 peerGroup = peerGroupLoader.getPeerGroup(bgpIid, peerGroupName);
244 final AfiSafis afisSAfis;
245 if (peerGroup != null && peerGroup.getAfiSafis() != null) {
246 afisSAfis = peerGroup.getAfiSafis();
248 afisSAfis = requireNonNull(neighbor.getAfiSafis(), "Missing mandatory AFIs/SAFIs");
251 final Set<TablesKey> afiSafisAdvertized = OpenConfigMappingUtil
252 .toTableKey(afisSAfis.getAfiSafi(), tableTypeRegistry);
254 final PeerRole role = OpenConfigMappingUtil.toPeerRole(neighbor, peerGroup);
255 final ClusterIdentifier clusterId = OpenConfigMappingUtil
256 .getNeighborClusterIdentifier(neighbor.getConfig());
258 this.bgpPeer = new BGPPeer(this.neighborAddress, peerGroupName, rib, role, clusterId,
259 BgpPeer.this.rpcRegistry, afiSafisAdvertized, Collections.emptySet());
261 final List<BgpParameters> bgpParameters = getBgpParameters(afisSAfis, rib, tableTypeRegistry);
262 final KeyMapping keyMapping = OpenConfigMappingUtil.getNeighborKey(neighbor);
264 int hold = OpenConfigMappingUtil.getHoldTimer(neighbor, peerGroup);
265 final AsNumber ribAs = rib.getLocalAs();
266 final AsNumber neighborAs = OpenConfigMappingUtil.getPeerAs(neighbor, peerGroup, ribAs);
268 this.prefs = new BGPSessionPreferences(ribAs, hold, rib.getBgpIdentifier(),
269 neighborAs, bgpParameters, getPassword(keyMapping));
270 this.activeConnection = OpenConfigMappingUtil.isActive(neighbor, peerGroup);
271 this.retryTimer = OpenConfigMappingUtil.getRetryTimer(neighbor, peerGroup);
272 this.dispatcher = rib.getDispatcher();
274 this.inetAddress = Ipv4Util.toInetSocketAddress(this.neighborAddress,
275 OpenConfigMappingUtil.getPort(neighbor, peerGroup));
276 this.keys = keyMapping;
279 private synchronized void instantiateServiceInstance() {
280 this.isServiceInstantiated = true;
281 LOG.info("Peer instantiated {}", this.neighborAddress);
282 this.bgpPeer.instantiateServiceInstance();
283 this.dispatcher.getBGPPeerRegistry().addPeer(this.neighborAddress, this.bgpPeer, this.prefs);
284 if (this.activeConnection) {
285 this.connection = this.dispatcher.createReconnectingClient(this.inetAddress, this.retryTimer,
290 private synchronized ListenableFuture<Void> closeServiceInstance() {
291 if (!this.isServiceInstantiated) {
292 LOG.info("Peer {} already closed", this.neighborAddress);
293 return Futures.immediateFuture(null);
295 LOG.info("Close Peer {}", this.neighborAddress);
296 this.isServiceInstantiated = false;
297 if (this.connection != null) {
298 this.connection.cancel(true);
299 this.connection = null;
301 final ListenableFuture<Void> future = this.bgpPeer.close();
302 removePeer(this.dispatcher.getBGPPeerRegistry());
307 public BGPPeerState getPeerState() {
308 return this.bgpPeer.getPeerState();