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;
13 import static org.opendaylight.protocol.bgp.rib.impl.config.OpenConfigMappingUtil.getSimpleRoutingPolicy;
15 import com.google.common.base.Optional;
16 import com.google.common.base.Preconditions;
17 import com.google.common.collect.Iterables;
18 import com.google.common.util.concurrent.Futures;
19 import com.google.common.util.concurrent.ListenableFuture;
20 import io.netty.util.concurrent.Future;
21 import java.net.InetSocketAddress;
22 import java.util.ArrayList;
23 import java.util.Collections;
24 import java.util.List;
25 import java.util.Objects;
26 import org.opendaylight.controller.config.yang.bgp.rib.impl.BGPPeerRuntimeMXBean;
27 import org.opendaylight.controller.config.yang.bgp.rib.impl.BgpPeerState;
28 import org.opendaylight.controller.config.yang.bgp.rib.impl.BgpSessionState;
29 import org.opendaylight.controller.sal.binding.api.RpcProviderRegistry;
30 import org.opendaylight.mdsal.singleton.common.api.ClusterSingletonService;
31 import org.opendaylight.mdsal.singleton.common.api.ClusterSingletonServiceRegistration;
32 import org.opendaylight.mdsal.singleton.common.api.ServiceGroupIdentifier;
33 import org.opendaylight.protocol.bgp.openconfig.spi.BGPOpenConfigMappingService;
34 import org.opendaylight.protocol.bgp.parser.BgpExtendedMessageUtil;
35 import org.opendaylight.protocol.bgp.parser.spi.MultiprotocolCapabilitiesUtil;
36 import org.opendaylight.protocol.bgp.rib.impl.BGPPeer;
37 import org.opendaylight.protocol.bgp.rib.impl.spi.BGPDispatcher;
38 import org.opendaylight.protocol.bgp.rib.impl.spi.BGPPeerRegistry;
39 import org.opendaylight.protocol.bgp.rib.impl.spi.BGPSessionPreferences;
40 import org.opendaylight.protocol.bgp.rib.impl.spi.BgpDeployer.WriteConfiguration;
41 import org.opendaylight.protocol.bgp.rib.impl.spi.RIB;
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.neighbors.Neighbor;
47 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
48 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.open.message.BgpParameters;
49 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.open.message.BgpParametersBuilder;
50 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.open.message.bgp.parameters.OptionalCapabilities;
51 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.open.message.bgp.parameters.OptionalCapabilitiesBuilder;
52 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.open.message.bgp.parameters.optional.capabilities.CParametersBuilder;
53 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.open.message.bgp.parameters.optional.capabilities.c.parameters.As4BytesCapabilityBuilder;
54 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.BgpTableType;
55 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.CParameters1;
56 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.CParameters1Builder;
57 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.mp.capabilities.AddPathCapabilityBuilder;
58 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.mp.capabilities.MultiprotocolCapabilityBuilder;
59 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.mp.capabilities.add.path.capability.AddressFamilies;
60 import org.osgi.framework.ServiceRegistration;
61 import org.slf4j.Logger;
62 import org.slf4j.LoggerFactory;
65 public final class BgpPeer implements PeerBean, BGPPeerRuntimeMXBean {
67 private static final Logger LOG = LoggerFactory.getLogger(BgpPeer.class);
69 private final RpcProviderRegistry rpcRegistry;
70 private final BGPPeerRegistry peerRegistry;
71 private ServiceRegistration<?> serviceRegistration;
72 private Neighbor currentConfiguration;
73 private BgpPeerSingletonService bgpPeerSingletonService;
75 public BgpPeer(final RpcProviderRegistry rpcRegistry, final BGPPeerRegistry peerRegistry) {
76 this.rpcRegistry = rpcRegistry;
77 this.peerRegistry = peerRegistry;
81 public void start(final RIB rib, final Neighbor neighbor, final BGPOpenConfigMappingService mappingService,
82 final WriteConfiguration configurationWriter) {
83 Preconditions.checkState(this.bgpPeerSingletonService == null, "Previous peer instance {} was not closed.");
84 this.bgpPeerSingletonService = new BgpPeerSingletonService(rib, neighbor, mappingService, configurationWriter);
85 this.currentConfiguration = neighbor;
89 public void restart(final RIB rib, final BGPOpenConfigMappingService mappingService) {
90 Preconditions.checkState(this.currentConfiguration != null);
91 start(rib, this.currentConfiguration, mappingService, null);
96 closeSingletonService();
97 if (this.serviceRegistration != null) {
98 this.serviceRegistration.unregister();
99 this.serviceRegistration = null;
103 private void closeSingletonService() {
105 this.bgpPeerSingletonService.close();
106 this.bgpPeerSingletonService = null;
107 } catch (final Exception e) {
108 LOG.warn("Failed to close peer instance", e);
113 public Boolean containsEqualConfiguration(final Neighbor neighbor) {
114 final AfiSafis actAfiSafi = this.currentConfiguration.getAfiSafis();
115 final AfiSafis extAfiSafi = neighbor.getAfiSafis();
116 final List<AfiSafi> actualSafi = actAfiSafi != null ? actAfiSafi.getAfiSafi() : Collections.emptyList();
117 final List<AfiSafi> extSafi = extAfiSafi != null ? extAfiSafi.getAfiSafi() : Collections.emptyList();
118 return actualSafi.containsAll(extSafi) && extSafi.containsAll(actualSafi)
119 && Objects.equals(this.currentConfiguration.getConfig(), neighbor.getConfig())
120 && Objects.equals(this.currentConfiguration.getNeighborAddress(), neighbor.getNeighborAddress())
121 && Objects.equals(this.currentConfiguration.getAddPaths(),neighbor.getAddPaths())
122 && Objects.equals(this.currentConfiguration.getApplyPolicy(), neighbor.getApplyPolicy())
123 && Objects.equals(this.currentConfiguration.getAsPathOptions(), neighbor.getAsPathOptions())
124 && Objects.equals(this.currentConfiguration.getEbgpMultihop(), neighbor.getEbgpMultihop())
125 && Objects.equals(this.currentConfiguration.getGracefulRestart(), neighbor.getGracefulRestart())
126 && Objects.equals(this.currentConfiguration.getErrorHandling(), neighbor.getErrorHandling())
127 && Objects.equals(this.currentConfiguration.getLoggingOptions(), neighbor.getLoggingOptions())
128 && Objects.equals(this.currentConfiguration.getRouteReflector(), neighbor.getRouteReflector())
129 && Objects.equals(this.currentConfiguration.getState(), neighbor.getState())
130 && Objects.equals(this.currentConfiguration.getTimers(), neighbor.getTimers())
131 && Objects.equals(this.currentConfiguration.getTransport(), neighbor.getTransport());
134 private static List<BgpParameters> getBgpParameters(final Neighbor neighbor, final RIB rib,
135 final BGPOpenConfigMappingService mappingService) {
136 final List<BgpParameters> tlvs = new ArrayList<>();
137 final List<OptionalCapabilities> caps = new ArrayList<>();
138 caps.add(new OptionalCapabilitiesBuilder().setCParameters(new CParametersBuilder().setAs4BytesCapability(
139 new As4BytesCapabilityBuilder().setAsNumber(rib.getLocalAs()).build()).build()).build());
141 caps.add(new OptionalCapabilitiesBuilder().setCParameters(BgpExtendedMessageUtil.EXTENDED_MESSAGE_CAPABILITY).build());
142 caps.add(new OptionalCapabilitiesBuilder().setCParameters(MultiprotocolCapabilitiesUtil.RR_CAPABILITY).build());
144 final List<AfiSafi> afiSafi = OpenConfigMappingUtil.getAfiSafiWithDefault(neighbor.getAfiSafis(), false);
145 final List<AddressFamilies> addPathCapability = OpenConfigMappingUtil.toAddPathCapability(afiSafi, mappingService);
146 if (!addPathCapability.isEmpty()) {
147 caps.add(new OptionalCapabilitiesBuilder().setCParameters(new CParametersBuilder().addAugmentation(CParameters1.class,
148 new CParameters1Builder().setAddPathCapability(
149 new AddPathCapabilityBuilder().setAddressFamilies(addPathCapability).build()).build()).build()).build());
152 final List<BgpTableType> tableTypes = mappingService.toTableTypes(afiSafi);
153 for (final BgpTableType tableType : tableTypes) {
154 if (!rib.getLocalTables().contains(tableType)) {
155 LOG.info("RIB instance does not list {} in its local tables. Incoming data will be dropped.", tableType);
158 caps.add(new OptionalCapabilitiesBuilder().setCParameters(
159 new CParametersBuilder().addAugmentation(CParameters1.class,
160 new CParameters1Builder().setMultiprotocolCapability(
161 new MultiprotocolCapabilityBuilder(tableType).build()).build()).build()).build());
163 tlvs.add(new BgpParametersBuilder().setOptionalCapabilities(caps).build());
167 private static Optional<byte[]> getPassword(final KeyMapping key) {
169 return Optional.of(Iterables.getOnlyElement(key.values()));
171 return Optional.absent();
175 public BgpPeerState getBgpPeerState() {
176 return this.bgpPeerSingletonService.getPeer().getBgpPeerState();
180 public BgpSessionState getBgpSessionState() {
181 return this.bgpPeerSingletonService.getPeer().getBgpSessionState();
185 public void resetSession() {
186 this.bgpPeerSingletonService.getPeer().resetSession();
190 public void resetStats() {
191 this.bgpPeerSingletonService.getPeer().resetStats();
194 void setServiceRegistration(final ServiceRegistration<?> serviceRegistration) {
195 this.serviceRegistration = serviceRegistration;
198 private final class BgpPeerSingletonService implements ClusterSingletonService, AutoCloseable {
199 private final ServiceGroupIdentifier serviceGroupIdentifier;
200 private final boolean activeConnection;
201 private final BGPDispatcher dispatcher;
202 private final InetSocketAddress inetAddress;
203 private final int retryTimer;
204 private final Optional<KeyMapping> key;
205 private final WriteConfiguration configurationWriter;
206 private ClusterSingletonServiceRegistration registration;
207 private final BGPPeer bgpPeer;
208 private final IpAddress neighborAddress;
209 private final BGPSessionPreferences prefs;
210 private Future<Void> connection;
212 private BgpPeerSingletonService(final RIB rib, final Neighbor neighbor, final BGPOpenConfigMappingService mappingService,
213 final WriteConfiguration configurationWriter) {
214 this.neighborAddress = neighbor.getNeighborAddress();
215 this.bgpPeer = new BGPPeer(Ipv4Util.toStringIP(this.neighborAddress), rib,
216 OpenConfigMappingUtil.toPeerRole(neighbor), getSimpleRoutingPolicy(neighbor), BgpPeer.this.rpcRegistry);
217 final List<BgpParameters> bgpParameters = getBgpParameters(neighbor, rib, mappingService);
218 final KeyMapping keyMapping = OpenConfigMappingUtil.getNeighborKey(neighbor);
219 this.prefs = new BGPSessionPreferences(rib.getLocalAs(), getHoldTimer(neighbor), rib.getBgpIdentifier(), getPeerAs(neighbor, rib),
220 bgpParameters, getPassword(keyMapping));
221 this.activeConnection = OpenConfigMappingUtil.isActive(neighbor);
222 this.dispatcher = rib.getDispatcher();
223 this.inetAddress = Ipv4Util.toInetSocketAddress(this.neighborAddress, OpenConfigMappingUtil.getPort(neighbor));
224 this.retryTimer = OpenConfigMappingUtil.getRetryTimer(neighbor);
225 this.key = Optional.fromNullable(keyMapping);
226 this.configurationWriter = configurationWriter;
227 this.serviceGroupIdentifier = rib.getRibIServiceGroupIdentifier();
228 LOG.info("Peer Singleton Service {} registered", this.serviceGroupIdentifier);
229 //this need to be always the last step
230 this.registration = rib.registerClusterSingletonService(this);
234 public void close() throws Exception {
235 if (this.registration != null) {
236 this.registration.close();
237 this.registration = null;
242 public void instantiateServiceInstance() {
243 if(this.configurationWriter != null) {
244 this.configurationWriter.apply();
246 LOG.info("Peer Singleton Service {} instantiated", getIdentifier());
247 this.bgpPeer.instantiateServiceInstance();
248 BgpPeer.this.peerRegistry.addPeer(this.neighborAddress, this.bgpPeer, this.prefs);
249 if (this.activeConnection) {
250 this.connection = this.dispatcher.createReconnectingClient(this.inetAddress, BgpPeer.this.peerRegistry, this.retryTimer, this.key);
255 public ListenableFuture<Void> closeServiceInstance() {
256 LOG.info("Close Peer Singleton Service {}", getIdentifier());
257 if (this.connection != null) {
258 this.connection.cancel(true);
259 this.connection = null;
261 this.bgpPeer.close();
262 if(BgpPeer.this.currentConfiguration != null) {
263 BgpPeer.this.peerRegistry.removePeer(BgpPeer.this.currentConfiguration.getNeighborAddress());
265 return Futures.immediateFuture(null);
269 public ServiceGroupIdentifier getIdentifier() {
270 return this.serviceGroupIdentifier;
273 BGPPeerRuntimeMXBean getPeer() {