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.state;
11 import com.google.common.primitives.UnsignedInteger;
12 import com.google.common.primitives.UnsignedLong;
13 import java.math.BigDecimal;
14 import java.math.BigInteger;
15 import java.util.ArrayList;
16 import java.util.HashSet;
17 import java.util.List;
18 import java.util.Objects;
19 import java.util.Optional;
21 import java.util.stream.Collectors;
22 import org.eclipse.jdt.annotation.NonNull;
23 import org.eclipse.jdt.annotation.Nullable;
24 import org.opendaylight.protocol.bgp.openconfig.spi.BGPTableTypeRegistryConsumer;
25 import org.opendaylight.protocol.bgp.rib.spi.state.BGPAfiSafiState;
26 import org.opendaylight.protocol.bgp.rib.spi.state.BGPErrorHandlingState;
27 import org.opendaylight.protocol.bgp.rib.spi.state.BGPGracelfulRestartState;
28 import org.opendaylight.protocol.bgp.rib.spi.state.BGPLlGracelfulRestartState;
29 import org.opendaylight.protocol.bgp.rib.spi.state.BGPPeerMessagesState;
30 import org.opendaylight.protocol.bgp.rib.spi.state.BGPPeerState;
31 import org.opendaylight.protocol.bgp.rib.spi.state.BGPSessionState;
32 import org.opendaylight.protocol.bgp.rib.spi.state.BGPTimersState;
33 import org.opendaylight.protocol.bgp.rib.spi.state.BGPTransportState;
34 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.multiprotocol.rev151009.bgp.common.afi.safi.list.AfiSafi;
35 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.multiprotocol.rev151009.bgp.common.afi.safi.list.AfiSafiBuilder;
36 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.operational.rev151009.BgpNeighborState.SessionState;
37 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.operational.rev151009.bgp.neighbor.prefix.counters_state.PrefixesBuilder;
38 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.graceful.restart.GracefulRestart;
39 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.graceful.restart.GracefulRestartBuilder;
40 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.neighbor.group.AfiSafis;
41 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.neighbor.group.AfiSafisBuilder;
42 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.neighbor.group.ErrorHandling;
43 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.neighbor.group.ErrorHandlingBuilder;
44 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.neighbor.group.State;
45 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.neighbor.group.StateBuilder;
46 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.neighbor.group.Timers;
47 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.neighbor.group.TimersBuilder;
48 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.neighbor.group.Transport;
49 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.neighbor.group.TransportBuilder;
50 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.neighbors.Neighbor;
51 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.neighbors.NeighborBuilder;
52 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.top.bgp.Neighbors;
53 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.top.bgp.NeighborsBuilder;
54 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.types.rev151009.ADDPATHS;
55 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.types.rev151009.ASN32;
56 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.types.rev151009.AfiSafiType;
57 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.types.rev151009.BgpCapability;
58 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.types.rev151009.GRACEFULRESTART;
59 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.types.rev151009.MPBGP;
60 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.types.rev151009.ROUTEREFRESH;
61 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Timeticks;
62 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.openconfig.extensions.rev180329.BgpNeighborStateAugmentation;
63 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.openconfig.extensions.rev180329.BgpNeighborStateAugmentationBuilder;
64 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.openconfig.extensions.rev180329.NeighborAfiSafiGracefulRestartStateAugmentation;
65 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.openconfig.extensions.rev180329.NeighborAfiSafiGracefulRestartStateAugmentationBuilder;
66 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.openconfig.extensions.rev180329.NeighborAfiSafiStateAugmentation;
67 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.openconfig.extensions.rev180329.NeighborAfiSafiStateAugmentationBuilder;
68 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.openconfig.extensions.rev180329.NeighborErrorHandlingStateAugmentation;
69 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.openconfig.extensions.rev180329.NeighborErrorHandlingStateAugmentationBuilder;
70 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.openconfig.extensions.rev180329.NeighborGracefulRestartStateAugmentation;
71 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.openconfig.extensions.rev180329.NeighborGracefulRestartStateAugmentationBuilder;
72 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.openconfig.extensions.rev180329.NeighborStateAugmentation;
73 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.openconfig.extensions.rev180329.NeighborStateAugmentationBuilder;
74 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.openconfig.extensions.rev180329.NeighborTimersStateAugmentation;
75 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.openconfig.extensions.rev180329.NeighborTimersStateAugmentationBuilder;
76 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.openconfig.extensions.rev180329.NeighborTransportStateAugmentation;
77 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.openconfig.extensions.rev180329.NeighborTransportStateAugmentationBuilder;
78 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.openconfig.extensions.rev180329.network.instances.network.instance.protocols.protocol.bgp.neighbors.neighbor.state.MessagesBuilder;
79 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.openconfig.extensions.rev180329.network.instances.network.instance.protocols.protocol.bgp.neighbors.neighbor.state.messages.Received;
80 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.openconfig.extensions.rev180329.network.instances.network.instance.protocols.protocol.bgp.neighbors.neighbor.state.messages.ReceivedBuilder;
81 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.openconfig.extensions.rev180329.network.instances.network.instance.protocols.protocol.bgp.neighbors.neighbor.state.messages.Sent;
82 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.openconfig.extensions.rev180329.network.instances.network.instance.protocols.protocol.bgp.neighbors.neighbor.state.messages.SentBuilder;
83 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.rib.TablesKey;
84 import org.opendaylight.yangtools.yang.common.Uint32;
87 * Util for create OpenConfig Neighbor with corresponding openConfig state.
89 public final class NeighborUtil {
90 private static final long TIMETICK_ROLLOVER_VALUE = UnsignedInteger.MAX_VALUE.longValue() + 1;
92 private NeighborUtil() {
97 * Build a Openconfig Neighbors container with all Neighbors Stats from a list of
100 * @param peerStats List of BGPPeerState containing Neighbor state counters
101 * @param bgpTableTypeRegistry BGP TableType Registry
102 * @return Openconfig Neighbors Stats
104 public static @Nullable Neighbors buildNeighbors(final @NonNull List<BGPPeerState> peerStats,
105 final @NonNull BGPTableTypeRegistryConsumer bgpTableTypeRegistry) {
106 if (peerStats.isEmpty()) {
109 return new NeighborsBuilder().setNeighbor(peerStats.stream()
110 .filter(Objects::nonNull)
111 .map(neighbor -> buildNeighbor(neighbor, bgpTableTypeRegistry))
112 .collect(Collectors.toList())).build();
116 * Build a list of neighbors containing Operational State from a list of BGPPeerState.
118 * @param neighbor containing Neighbor state counters
119 * @return neighbor containing Neighbor State
121 public static @NonNull Neighbor buildNeighbor(final @NonNull BGPPeerState neighbor,
122 final @NonNull BGPTableTypeRegistryConsumer bgpTableTypeRegistry) {
123 return new NeighborBuilder()
124 .setNeighborAddress(neighbor.getNeighborAddress())
125 .setState(buildNeighborState(neighbor.getBGPSessionState(), neighbor.getBGPPeerMessagesState()))
126 .setTimers(buildTimer(neighbor.getBGPTimersState()))
127 .setTransport(buildTransport(neighbor.getBGPTransportState()))
128 .setErrorHandling(buildErrorHandling(neighbor.getBGPErrorHandlingState()))
129 .setGracefulRestart(buildGracefulRestart(neighbor.getBGPGracelfulRestart()))
130 .setAfiSafis(buildAfisSafis(neighbor, bgpTableTypeRegistry))
135 * Builds Neighbor State from BGPPeerState counters.
137 * @param sessionState BGPPeerState containing Operational state counters
138 * @param bgpPeerMessagesState message state
139 * @return Neighbor State
141 public static @Nullable State buildNeighborState(final @Nullable BGPSessionState sessionState,
142 final BGPPeerMessagesState bgpPeerMessagesState) {
143 if (sessionState == null && bgpPeerMessagesState == null) {
146 final StateBuilder builder = new StateBuilder();
147 if (sessionState != null) {
148 builder.addAugmentation(NeighborStateAugmentation.class, buildCapabilityState(sessionState));
150 if (bgpPeerMessagesState != null) {
151 builder.addAugmentation(BgpNeighborStateAugmentation.class, buildMessageState(bgpPeerMessagesState));
153 return builder.build();
157 * Builds Neighbor State from BGPPeerState counters.
159 * @param neighbor BGPPeerState containing Operational state counters
160 * @return Timer State
162 public static @Nullable Timers buildTimer(final @Nullable BGPTimersState neighbor) {
163 if (neighbor == null) {
166 // convert neighbor uptime which is in milliseconds to time-ticks which is
167 // hundredth of a second, and handle roll-over scenario
168 final long uptimeTicks = neighbor.getUpTime() / 10 % TIMETICK_ROLLOVER_VALUE;
169 final NeighborTimersStateAugmentation timerState = new NeighborTimersStateAugmentationBuilder()
170 .setNegotiatedHoldTime(BigDecimal.valueOf(neighbor.getNegotiatedHoldTime()))
171 .setUptime(new Timeticks(Uint32.valueOf(uptimeTicks))).build();
173 return new TimersBuilder().setState(new org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp
174 .neighbor.group.timers.StateBuilder()
175 .addAugmentation(NeighborTimersStateAugmentation.class, timerState).build()).build();
179 * Builds Transport State from BGPTransportState counters.
181 * @param neighbor BGPPeerState containing Operational state counters
182 * @return Transport State
184 public static @Nullable Transport buildTransport(final @Nullable BGPTransportState neighbor) {
185 if (neighbor == null) {
188 final NeighborTransportStateAugmentation transportState = new NeighborTransportStateAugmentationBuilder()
189 .setLocalPort(neighbor.getLocalPort()).setRemoteAddress(neighbor.getRemoteAddress())
190 .setRemotePort(neighbor.getRemotePort()).build();
192 return new TransportBuilder().setState(new org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009
193 .bgp.neighbor.group.transport.StateBuilder()
194 .addAugmentation(NeighborTransportStateAugmentation.class, transportState).build()).build();
198 * Builds Error Handling State from BGPPeerState counters.
200 * @param errorHandlingState BGPErrorHandlingState containing ErrorHandlingState Operational state counters
201 * @return Error Handling State
203 public static ErrorHandling buildErrorHandling(final @Nullable BGPErrorHandlingState errorHandlingState) {
204 if (errorHandlingState == null) {
207 return new ErrorHandlingBuilder().setState(new org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp
208 .rev151009.bgp.neighbor.group.error.handling.StateBuilder()
209 .addAugmentation(NeighborErrorHandlingStateAugmentation.class,
210 buildErrorHandlingState(errorHandlingState.getErroneousUpdateReceivedCount())).build()).build();
214 * Builds Graceful Restart containing Graceful Restart State from BGPGracelfulRestartState counters.
216 * @param neighbor BGPPeerState containing Operational state counters
217 * @return Graceful Restart
219 public static @NonNull GracefulRestart buildGracefulRestart(final @NonNull BGPGracelfulRestartState neighbor) {
220 final NeighborGracefulRestartStateAugmentation gracefulRestartState =
221 new NeighborGracefulRestartStateAugmentationBuilder()
222 .setLocalRestarting(neighbor.isLocalRestarting())
223 .setPeerRestartTime(neighbor.getPeerRestartTime())
224 .setMode(neighbor.getMode())
225 .setPeerRestarting(neighbor.isPeerRestarting()).build();
227 return new GracefulRestartBuilder().setState(new org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp
228 .rev151009.bgp.graceful.restart.graceful.restart.StateBuilder()
229 .addAugmentation(NeighborGracefulRestartStateAugmentation.class, gracefulRestartState).build()).build();
233 * Builds Neighbor Afi Safi containing AfiSafi State.
235 * @param neighbor BGPPeerState containing Operational state counters
238 public static AfiSafis buildAfisSafis(final @NonNull BGPPeerState neighbor,
239 final @NonNull BGPTableTypeRegistryConsumer bgpTableTypeRegistry) {
240 return new AfiSafisBuilder().setAfiSafi(buildAfisSafisState(neighbor.getBGPAfiSafiState(),
241 bgpTableTypeRegistry)).build();
245 * Builds Neighbor State containing Capabilities State, session State.
247 * @return Neighbor State
249 public static NeighborStateAugmentation buildCapabilityState(final @NonNull BGPSessionState neighbor) {
251 final List<Class<? extends BgpCapability>> supportedCapabilities = buildSupportedCapabilities(neighbor);
252 SessionState sessionState = null;
253 switch (neighbor.getSessionState()) {
255 sessionState = SessionState.IDLE;
258 sessionState = SessionState.ESTABLISHED;
261 sessionState = SessionState.OPENCONFIRM;
265 return new NeighborStateAugmentationBuilder().setSupportedCapabilities(supportedCapabilities)
266 .setSessionState(sessionState).build();
270 * Builds Bgp Neighbor State containing Message State.
272 * @return BgpNeighborState containing Message State
274 public static @NonNull BgpNeighborStateAugmentation buildMessageState(
275 final @NonNull BGPPeerMessagesState neighbor) {
276 return new BgpNeighborStateAugmentationBuilder()
277 .setMessages(new MessagesBuilder()
278 .setReceived(buildMessagesReceived(neighbor))
279 .setSent(buildMessagesSent(neighbor)).build()).build();
282 private static Received buildMessagesReceived(final @NonNull BGPPeerMessagesState neighbor) {
283 return new ReceivedBuilder()
284 .setUPDATE(toBigInteger(neighbor.getUpdateMessagesReceivedCount()))
285 .setNOTIFICATION(toBigInteger(neighbor.getNotificationMessagesReceivedCount()))
289 public static BigInteger toBigInteger(final long updateReceivedCounter) {
290 return UnsignedLong.valueOf(updateReceivedCounter).bigIntegerValue();
293 private static Sent buildMessagesSent(final @NonNull BGPPeerMessagesState neighbor) {
294 return new SentBuilder()
295 .setUPDATE(toBigInteger(neighbor.getUpdateMessagesSentCount()))
296 .setNOTIFICATION(toBigInteger(neighbor.getNotificationMessagesSentCount()))
301 * Builds Neighbor Error Handling State.
303 * @param erroneousUpdateCount erroneous Update Count
304 * @return Error Handling State
306 public static @NonNull NeighborErrorHandlingStateAugmentation buildErrorHandlingState(
307 final long erroneousUpdateCount) {
308 return new NeighborErrorHandlingStateAugmentationBuilder()
309 .setErroneousUpdateMessages(erroneousUpdateCount).build();
313 * Build List of afi safi containing State per Afi Safi.
315 * @return AfiSafi List
317 public static @NonNull List<AfiSafi> buildAfisSafisState(final @NonNull BGPAfiSafiState neighbor,
318 final @NonNull BGPTableTypeRegistryConsumer bgpTableTypeRegistry) {
319 final Set<TablesKey> afiSafiJoin = new HashSet<>(neighbor.getAfiSafisAdvertized());
320 afiSafiJoin.addAll(neighbor.getAfiSafisReceived());
321 return afiSafiJoin.stream().map(tableKey -> buildAfiSafi(neighbor, tableKey, bgpTableTypeRegistry))
322 .filter(Objects::nonNull)
323 .collect(Collectors.toList());
326 private static AfiSafi buildAfiSafi(final @NonNull BGPAfiSafiState neighbor,
327 final @NonNull TablesKey tablesKey, final @NonNull BGPTableTypeRegistryConsumer bgpTableTypeRegistry) {
328 final Optional<Class<? extends AfiSafiType>> afiSafi = bgpTableTypeRegistry.getAfiSafiType(tablesKey);
329 return afiSafi.map(aClass -> new AfiSafiBuilder().setAfiSafiName(aClass)
330 .setState(buildAfiSafiState(neighbor, tablesKey, neighbor.isAfiSafiSupported(tablesKey)))
331 .setGracefulRestart(buildAfiSafiGracefulRestartState(neighbor, tablesKey)).build()).orElse(null);
335 private static org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.multiprotocol.rev151009.bgp.common.afi
336 .safi.list.afi.safi.State buildAfiSafiState(final @NonNull BGPAfiSafiState neighbor,
337 final @NonNull TablesKey tablesKey, final boolean afiSafiSupported) {
338 final NeighborAfiSafiStateAugmentationBuilder builder = new NeighborAfiSafiStateAugmentationBuilder();
339 builder.setActive(afiSafiSupported);
340 if (afiSafiSupported) {
341 builder.setPrefixes(new PrefixesBuilder()
342 .setInstalled(neighbor.getPrefixesInstalledCount(tablesKey))
343 .setReceived(neighbor.getPrefixesReceivedCount(tablesKey))
344 .setSent(neighbor.getPrefixesSentCount(tablesKey)).build());
346 return new org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.multiprotocol.rev151009.bgp.common.afi
347 .safi.list.afi.safi.StateBuilder().addAugmentation(NeighborAfiSafiStateAugmentation.class,
348 builder.build()).build();
351 private static org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.multiprotocol.rev151009.bgp.common.afi
352 .safi.list.afi.safi.GracefulRestart buildAfiSafiGracefulRestartState(
353 final @NonNull BGPLlGracelfulRestartState neighbor, final @NonNull TablesKey tablesKey) {
354 final NeighborAfiSafiGracefulRestartStateAugmentation builder =
355 new NeighborAfiSafiGracefulRestartStateAugmentationBuilder()
356 .setAdvertised(neighbor.isGracefulRestartAdvertized(tablesKey))
357 .setReceived(neighbor.isGracefulRestartReceived(tablesKey))
358 .setLlAdvertised(neighbor.isLlGracefulRestartAdvertised(tablesKey))
359 .setLlReceived(neighbor.isLlGracefulRestartReceived(tablesKey))
360 .setLlStaleTimer(Uint32.valueOf(neighbor.getLlGracefulRestartTimer(tablesKey))).build();
361 return new org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.multiprotocol.rev151009.bgp.common.afi
362 .safi.list.afi.safi.GracefulRestartBuilder().setState(new org.opendaylight.yang.gen.v1.http.openconfig
363 .net.yang.bgp.multiprotocol.rev151009.bgp.common.afi.safi.list.afi.safi.graceful.restart.StateBuilder()
364 .addAugmentation(NeighborAfiSafiGracefulRestartStateAugmentation.class, builder).build()).build();
368 * Builds List of BgpCapability supported capabilities.
370 * @return List containing supported capabilities
372 public static @NonNull List<Class<? extends BgpCapability>> buildSupportedCapabilities(
373 final @NonNull BGPSessionState neighbor) {
374 final List<Class<? extends BgpCapability>> supportedCapabilities = new ArrayList<>();
375 if (neighbor.isAddPathCapabilitySupported()) {
376 supportedCapabilities.add(ADDPATHS.class);
378 if (neighbor.isAsn32CapabilitySupported()) {
379 supportedCapabilities.add(ASN32.class);
381 if (neighbor.isGracefulRestartCapabilitySupported()) {
382 supportedCapabilities.add(GRACEFULRESTART.class);
384 if (neighbor.isMultiProtocolCapabilitySupported()) {
385 supportedCapabilities.add(MPBGP.class);
387 if (neighbor.isRouterRefreshCapabilitySupported()) {
388 supportedCapabilities.add(ROUTEREFRESH.class);
390 return supportedCapabilities;