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 org.opendaylight.protocol.bgp.rib.impl.config.OpenConfigMappingUtil.getHoldTimer;
12 import static org.opendaylight.protocol.bgp.rib.impl.config.OpenConfigMappingUtil.getPeerAs;
14 import com.google.common.base.Optional;
15 import com.google.common.base.Preconditions;
16 import com.google.common.collect.Iterables;
17 import com.google.common.util.concurrent.Futures;
18 import com.google.common.util.concurrent.ListenableFuture;
19 import io.netty.util.concurrent.Future;
20 import java.net.InetSocketAddress;
21 import java.util.ArrayList;
22 import java.util.List;
23 import java.util.Objects;
24 import org.opendaylight.controller.config.yang.bgp.rib.impl.BGPPeerRuntimeMXBean;
25 import org.opendaylight.controller.config.yang.bgp.rib.impl.BgpPeerState;
26 import org.opendaylight.controller.config.yang.bgp.rib.impl.BgpSessionState;
27 import org.opendaylight.controller.sal.binding.api.RpcProviderRegistry;
28 import org.opendaylight.mdsal.singleton.common.api.ClusterSingletonService;
29 import org.opendaylight.mdsal.singleton.common.api.ClusterSingletonServiceRegistration;
30 import org.opendaylight.mdsal.singleton.common.api.ServiceGroupIdentifier;
31 import org.opendaylight.protocol.bgp.openconfig.spi.BGPOpenConfigMappingService;
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.BGPPeerRegistry;
37 import org.opendaylight.protocol.bgp.rib.impl.spi.BGPSessionPreferences;
38 import org.opendaylight.protocol.bgp.rib.impl.spi.BgpDeployer.WriteConfiguration;
39 import org.opendaylight.protocol.bgp.rib.impl.spi.RIB;
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.neighbor.group.Config;
45 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.neighbors.Neighbor;
46 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
47 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.open.message.BgpParameters;
48 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.open.message.BgpParametersBuilder;
49 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.open.message.bgp.parameters.OptionalCapabilities;
50 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.open.message.bgp.parameters.OptionalCapabilitiesBuilder;
51 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.open.message.bgp.parameters.optional.capabilities.CParametersBuilder;
52 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.open.message.bgp.parameters.optional.capabilities.c.parameters.As4BytesCapabilityBuilder;
53 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.BgpTableType;
54 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.CParameters1;
55 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.CParameters1Builder;
56 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.mp.capabilities.AddPathCapabilityBuilder;
57 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.mp.capabilities.MultiprotocolCapabilityBuilder;
58 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.mp.capabilities.add.path.capability.AddressFamilies;
59 import org.osgi.framework.ServiceRegistration;
60 import org.slf4j.Logger;
61 import org.slf4j.LoggerFactory;
64 public class BgpPeer implements PeerBean, BGPPeerRuntimeMXBean {
66 private static final Logger LOG = LoggerFactory.getLogger(BgpPeer.class);
68 private final RpcProviderRegistry rpcRegistry;
69 private final BGPPeerRegistry peerRegistry;
70 private ServiceRegistration<?> serviceRegistration;
71 private Neighbor currentConfiguration;
72 private BgpPeerSingletonService bgpPeerSingletonService;
74 public BgpPeer(final RpcProviderRegistry rpcRegistry, final BGPPeerRegistry peerRegistry) {
75 this.rpcRegistry = rpcRegistry;
76 this.peerRegistry = peerRegistry;
80 public void start(final RIB rib, final Neighbor neighbor, final BGPOpenConfigMappingService mappingService,
81 final WriteConfiguration configurationWriter) {
82 Preconditions.checkState(this.bgpPeerSingletonService == null, "Previous peer instance {} was not closed.");
83 this.bgpPeerSingletonService = new BgpPeerSingletonService(rib, neighbor, mappingService, configurationWriter);
84 this.currentConfiguration = neighbor;
88 public void restart(final RIB rib, final BGPOpenConfigMappingService mappingService) {
89 Preconditions.checkState(this.currentConfiguration != null);
90 start(rib, this.currentConfiguration, mappingService, null);
96 this.bgpPeerSingletonService.close();
97 this.bgpPeerSingletonService = null;
98 } catch (final Exception e) {
99 LOG.warn("Failed to close peer instance", e);
101 this.currentConfiguration = null;
102 if (this.serviceRegistration != null) {
103 this.serviceRegistration.unregister();
104 this.serviceRegistration = null;
109 public Boolean containsEqualConfiguration(final Neighbor neighbor) {
110 final AfiSafis actAfiSafi = this.currentConfiguration.getAfiSafis();
111 final AfiSafis extAfiSafi = neighbor.getAfiSafis();
112 final List<AfiSafi> actualSafi = actAfiSafi.getAfiSafi();
113 final List<AfiSafi> extSafi = extAfiSafi.getAfiSafi();
114 return actualSafi.containsAll(extSafi) && extSafi.containsAll(actualSafi)
115 && Objects.equals(this.currentConfiguration.getConfig(), neighbor.getConfig())
116 && Objects.equals(this.currentConfiguration.getNeighborAddress(), neighbor.getNeighborAddress())
117 && Objects.equals(this.currentConfiguration.getAddPaths(),neighbor.getAddPaths())
118 && Objects.equals(this.currentConfiguration.getApplyPolicy(), neighbor.getApplyPolicy())
119 && Objects.equals(this.currentConfiguration.getAsPathOptions(), neighbor.getAsPathOptions())
120 && Objects.equals(this.currentConfiguration.getEbgpMultihop(), neighbor.getEbgpMultihop())
121 && Objects.equals(this.currentConfiguration.getGracefulRestart(), neighbor.getGracefulRestart())
122 && Objects.equals(this.currentConfiguration.getErrorHandling(), neighbor.getErrorHandling())
123 && Objects.equals(this.currentConfiguration.getLoggingOptions(), neighbor.getLoggingOptions())
124 && Objects.equals(this.currentConfiguration.getRouteReflector(), neighbor.getRouteReflector())
125 && Objects.equals(this.currentConfiguration.getState(), neighbor.getState())
126 && Objects.equals(this.currentConfiguration.getTimers(), neighbor.getTimers())
127 && Objects.equals(this.currentConfiguration.getTransport(), neighbor.getTransport());
130 private static List<BgpParameters> getBgpParameters(final Neighbor neighbor, final RIB rib,
131 final BGPOpenConfigMappingService mappingService) {
132 final List<BgpParameters> tlvs = new ArrayList<>();
133 final List<OptionalCapabilities> caps = new ArrayList<>();
134 caps.add(new OptionalCapabilitiesBuilder().setCParameters(new CParametersBuilder().setAs4BytesCapability(
135 new As4BytesCapabilityBuilder().setAsNumber(rib.getLocalAs()).build()).build()).build());
137 caps.add(new OptionalCapabilitiesBuilder().setCParameters(BgpExtendedMessageUtil.EXTENDED_MESSAGE_CAPABILITY).build());
138 caps.add(new OptionalCapabilitiesBuilder().setCParameters(MultiprotocolCapabilitiesUtil.RR_CAPABILITY).build());
140 final List<AfiSafi> afiSafi = OpenConfigMappingUtil.getAfiSafiWithDefault(neighbor.getAfiSafis(), false);
141 final List<AddressFamilies> addPathCapability = mappingService.toAddPathCapability(afiSafi);
142 if (!addPathCapability.isEmpty()) {
143 caps.add(new OptionalCapabilitiesBuilder().setCParameters(new CParametersBuilder().addAugmentation(CParameters1.class,
144 new CParameters1Builder().setAddPathCapability(
145 new AddPathCapabilityBuilder().setAddressFamilies(addPathCapability).build()).build()).build()).build());
148 final List<BgpTableType> tableTypes = mappingService.toTableTypes(afiSafi);
149 for (final BgpTableType tableType : tableTypes) {
150 if (!rib.getLocalTables().contains(tableType)) {
151 LOG.info("RIB instance does not list {} in its local tables. Incoming data will be dropped.", tableType);
154 caps.add(new OptionalCapabilitiesBuilder().setCParameters(
155 new CParametersBuilder().addAugmentation(CParameters1.class,
156 new CParameters1Builder().setMultiprotocolCapability(
157 new MultiprotocolCapabilityBuilder(tableType).build()).build()).build()).build());
159 tlvs.add(new BgpParametersBuilder().setOptionalCapabilities(caps).build());
163 private static Optional<byte[]> getPassword(final KeyMapping key) {
165 return Optional.of(Iterables.getOnlyElement(key.values()));
167 return Optional.absent();
171 public BgpPeerState getBgpPeerState() {
172 return this.bgpPeerSingletonService.getPeer().getBgpPeerState();
176 public BgpSessionState getBgpSessionState() {
177 return this.bgpPeerSingletonService.getPeer().getBgpSessionState();
181 public void resetSession() {
182 this.bgpPeerSingletonService.getPeer().resetSession();
186 public void resetStats() {
187 this.bgpPeerSingletonService.getPeer().resetStats();
190 void setServiceRegistration(final ServiceRegistration<?> serviceRegistration) {
191 this.serviceRegistration = serviceRegistration;
194 private final class BgpPeerSingletonService implements ClusterSingletonService, AutoCloseable {
195 private final ServiceGroupIdentifier serviceGroupIdentifier;
196 private final boolean activeConnection;
197 private final BGPDispatcher dispatcher;
198 private final InetSocketAddress inetAddress;
199 private final int retryTimer;
200 private final Optional<KeyMapping> key;
201 private final WriteConfiguration configurationWriter;
202 private ClusterSingletonServiceRegistration registration;
203 private final BGPPeer bgpPeer;
204 private final IpAddress neighborAddress;
205 private final BGPSessionPreferences prefs;
206 private Future<Void> connection;
208 private BgpPeerSingletonService(final RIB rib, final Neighbor neighbor, final BGPOpenConfigMappingService mappingService,
209 final WriteConfiguration configurationWriter) {
210 this.neighborAddress = neighbor.getNeighborAddress();
211 this.bgpPeer = new BGPPeer(Ipv4Util.toStringIP(this.neighborAddress), rib, mappingService.toPeerRole(neighbor), BgpPeer.this.rpcRegistry);
212 final List<BgpParameters> bgpParameters = getBgpParameters(neighbor, rib, mappingService);
213 final KeyMapping key = OpenConfigMappingUtil.getNeighborKey(neighbor);
214 this.prefs = new BGPSessionPreferences(rib.getLocalAs(), getHoldTimer(neighbor), rib.getBgpIdentifier(), getPeerAs(neighbor, rib),
215 bgpParameters, getPassword(key));
216 this.activeConnection = OpenConfigMappingUtil.isActive(neighbor);
217 this.dispatcher = rib.getDispatcher();
218 this.inetAddress = Ipv4Util.toInetSocketAddress(this.neighborAddress, OpenConfigMappingUtil.getPort(neighbor));
219 this.retryTimer = OpenConfigMappingUtil.getRetryTimer(neighbor);
220 this.key = Optional.fromNullable(key);
221 this.configurationWriter = configurationWriter;
222 this.serviceGroupIdentifier = rib.getRibIServiceGroupIdentifier();
223 LOG.info("Peer Singleton Service {} registered", this.serviceGroupIdentifier);
224 //this need to be always the last step
225 this.registration = rib.registerClusterSingletonService(this);
229 public void close() throws Exception {
230 if (this.registration != null) {
231 this.registration.close();
232 this.registration = null;
237 public void instantiateServiceInstance() {
238 if(this.configurationWriter != null) {
239 this.configurationWriter.apply();
241 LOG.info("Peer Singleton Service {} instantiated", getIdentifier());
242 this.bgpPeer.instantiateServiceInstance();
243 BgpPeer.this.peerRegistry.addPeer(this.neighborAddress, this.bgpPeer, this.prefs);
244 if (this.activeConnection) {
245 this.connection = this.dispatcher.createReconnectingClient(this.inetAddress, BgpPeer.this.peerRegistry, this.retryTimer, this.key);
250 public ListenableFuture<Void> closeServiceInstance() {
251 LOG.info("Close Peer Singleton Service {}", getIdentifier());
252 if (this.connection != null) {
253 this.connection.cancel(true);
254 this.connection = null;
256 this.bgpPeer.close();
257 if(BgpPeer.this.currentConfiguration != null) {
258 BgpPeer.this.peerRegistry.removePeer(BgpPeer.this.currentConfiguration.getNeighborAddress());
260 return Futures.immediateFuture(null);
264 public ServiceGroupIdentifier getIdentifier() {
265 return this.serviceGroupIdentifier;
268 BGPPeerRuntimeMXBean getPeer() {