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.benchmark.app;
11 import static java.util.Objects.requireNonNull;
13 import com.google.common.annotations.VisibleForTesting;
14 import com.google.common.base.Stopwatch;
15 import com.google.common.net.InetAddresses;
16 import com.google.common.util.concurrent.FutureCallback;
17 import com.google.common.util.concurrent.Futures;
18 import com.google.common.util.concurrent.MoreExecutors;
19 import java.util.Collections;
20 import java.util.List;
21 import java.util.concurrent.Future;
22 import java.util.concurrent.TimeUnit;
23 import org.opendaylight.controller.md.sal.binding.api.BindingTransactionChain;
24 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
25 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
26 import org.opendaylight.controller.md.sal.common.api.data.AsyncTransaction;
27 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
28 import org.opendaylight.controller.md.sal.common.api.data.TransactionChain;
29 import org.opendaylight.controller.md.sal.common.api.data.TransactionChainListener;
30 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
31 import org.opendaylight.controller.sal.binding.api.BindingAwareBroker.RpcRegistration;
32 import org.opendaylight.controller.sal.binding.api.RpcProviderRegistry;
33 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address;
34 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Prefix;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev150305.application.rib.tables.routes.Ipv4RoutesCaseBuilder;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev150305.ipv4.routes.Ipv4Routes;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev150305.ipv4.routes.Ipv4RoutesBuilder;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev150305.ipv4.routes.ipv4.routes.Ipv4Route;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev150305.ipv4.routes.ipv4.routes.Ipv4RouteBuilder;
40 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev150305.ipv4.routes.ipv4.routes.Ipv4RouteKey;
41 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.PathId;
42 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.path.attributes.Attributes;
43 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.path.attributes.AttributesBuilder;
44 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.path.attributes.attributes.AsPath;
45 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.path.attributes.attributes.AsPathBuilder;
46 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.path.attributes.attributes.LocalPref;
47 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.path.attributes.attributes.LocalPrefBuilder;
48 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.path.attributes.attributes.MultiExitDisc;
49 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.path.attributes.attributes.MultiExitDiscBuilder;
50 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.path.attributes.attributes.Origin;
51 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.path.attributes.attributes.OriginBuilder;
52 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.ApplicationRib;
53 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.ApplicationRibBuilder;
54 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.ApplicationRibId;
55 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.ApplicationRibKey;
56 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.rib.Tables;
57 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.rib.TablesBuilder;
58 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.rib.TablesKey;
59 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.BgpOrigin;
60 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.Ipv4AddressFamily;
61 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.UnicastSubsequentAddressFamily;
62 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.next.hop.c.next.hop.Ipv4NextHopCaseBuilder;
63 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.next.hop.c.next.hop.ipv4.next.hop._case.Ipv4NextHopBuilder;
64 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.odl.bgp.app.peer.benchmark.rev160309.AddPrefixInput;
65 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.odl.bgp.app.peer.benchmark.rev160309.AddPrefixOutput;
66 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.odl.bgp.app.peer.benchmark.rev160309.AddPrefixOutputBuilder;
67 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.odl.bgp.app.peer.benchmark.rev160309.DeletePrefixInput;
68 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.odl.bgp.app.peer.benchmark.rev160309.DeletePrefixOutput;
69 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.odl.bgp.app.peer.benchmark.rev160309.DeletePrefixOutputBuilder;
70 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.odl.bgp.app.peer.benchmark.rev160309.OdlBgpAppPeerBenchmarkService;
71 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.odl.bgp.app.peer.benchmark.rev160309.output.Result;
72 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.odl.bgp.app.peer.benchmark.rev160309.output.ResultBuilder;
73 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
74 import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
75 import org.opendaylight.yangtools.yang.common.RpcResult;
76 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
77 import org.slf4j.Logger;
78 import org.slf4j.LoggerFactory;
80 public class AppPeerBenchmark implements OdlBgpAppPeerBenchmarkService, TransactionChainListener, AutoCloseable {
82 private static final Logger LOG = LoggerFactory.getLogger(AppPeerBenchmark.class);
84 private static final AsPath AS_PATH = new AsPathBuilder().build();
85 private static final Origin ORIGIN = new OriginBuilder().setValue(BgpOrigin.Igp).build();
86 private static final MultiExitDisc MED = new MultiExitDiscBuilder().setMed(0L).build();
87 private static final LocalPref LOC_PREF = new LocalPrefBuilder().setPref(100L).build();
88 private static final List<Tables> EMPTY_TABLES = Collections.singletonList(new TablesBuilder()
89 .setAfi(Ipv4AddressFamily.class).setSafi(UnicastSubsequentAddressFamily.class).setRoutes(
90 new Ipv4RoutesCaseBuilder().setIpv4Routes(new Ipv4RoutesBuilder().setIpv4Route(Collections.emptyList())
91 .build()).build()).build());
93 private static final String SLASH = "/";
94 private static final String PREFIX = SLASH + "32";
96 private static final PathId PATH_ID = new PathId(0L);
98 private final BindingTransactionChain txChain;
99 private final RpcRegistration<OdlBgpAppPeerBenchmarkService> rpcRegistration;
100 private final InstanceIdentifier<ApplicationRib> appIID;
101 private final InstanceIdentifier<Ipv4Routes> routesIId;
102 private final String appRibId;
104 public AppPeerBenchmark(final DataBroker bindingDataBroker, final RpcProviderRegistry rpcProviderRegistry,
105 final String appRibId) {
106 this.appRibId = requireNonNull(appRibId);
107 this.txChain = bindingDataBroker.createTransactionChain(this);
109 this.appIID = InstanceIdentifier.builder(ApplicationRib.class,
110 new ApplicationRibKey(new ApplicationRibId(appRibId))).build();
111 final InstanceIdentifier tablesIId = this.appIID
112 .child(Tables.class, new TablesKey(Ipv4AddressFamily.class, UnicastSubsequentAddressFamily.class));
113 this.routesIId = tablesIId.child(Ipv4Routes.class);
114 this.rpcRegistration = rpcProviderRegistry.addRpcImplementation(OdlBgpAppPeerBenchmarkService.class, this);
115 LOG.info("BGP Application Peer Benchmark Application started.");
118 public void start() {
119 LOG.debug("Instantiating App Peer Benchmark : {}", this.appRibId);
120 final ApplicationRib appRib = new ApplicationRibBuilder().setId(new ApplicationRibId(
121 new ApplicationRibId(this.appRibId))).setTables(EMPTY_TABLES).build();
123 final WriteTransaction wTx = this.txChain.newWriteOnlyTransaction();
124 wTx.put(LogicalDatastoreType.CONFIGURATION, this.appIID, appRib);
125 Futures.addCallback(wTx.submit(), new FutureCallback<Void>() {
127 public void onSuccess(final Void result) {
128 LOG.info("Empty Structure created for Application Peer Benchmark {}", AppPeerBenchmark.this.appRibId);
132 public void onFailure(final Throwable throwable) {
133 LOG.error("Failed to create Empty Structure for Application Peer Benchmark {}",
134 AppPeerBenchmark.this.appRibId, throwable);
136 }, MoreExecutors.directExecutor());
140 public void onTransactionChainFailed(final TransactionChain<?, ?> chain, final AsyncTransaction<?, ?> transaction,
141 final Throwable cause) {
142 LOG.error("Broken chain {} in DatastoreBaAbstractWrite, transaction {}, cause {}", chain,
143 transaction.getIdentifier(), cause);
148 public void onTransactionChainSuccessful(final TransactionChain<?, ?> chain) {
149 LOG.debug("DatastoreBaAbstractWrite closed successfully, chain {}", chain);
153 public Future<RpcResult<AddPrefixOutput>> addPrefix(final AddPrefixInput input) {
154 final long duration = addRoute(input.getPrefix(), input.getNexthop(), input.getCount(), input.getBatchsize());
155 final long rate = countRate(duration, input.getCount());
157 final AddPrefixOutputBuilder outputbuilder = new AddPrefixOutputBuilder();
158 outputbuilder.setResult(createResult(input.getCount(), duration, rate));
159 final AddPrefixOutput output = outputbuilder.build();
160 return RpcResultBuilder.success(output).buildFuture();
164 public Future<RpcResult<DeletePrefixOutput>> deletePrefix(final DeletePrefixInput input) {
165 final long duration = deleteRoute(input.getPrefix(), input.getCount(), input.getBatchsize());
166 final long rate = countRate(duration, input.getCount());
168 final DeletePrefixOutputBuilder outputbuilder = new DeletePrefixOutputBuilder();
169 outputbuilder.setResult(createResult(input.getCount(), duration, rate));
170 final DeletePrefixOutput output = outputbuilder.build();
171 return RpcResultBuilder.success(output).buildFuture();
175 public void close() {
176 this.rpcRegistration.close();
177 final WriteTransaction dTx = this.txChain.newWriteOnlyTransaction();
178 dTx.delete(LogicalDatastoreType.CONFIGURATION, this.appIID);
180 dTx.submit().checkedGet();
181 } catch (final TransactionCommitFailedException e) {
182 LOG.warn("Failed to clean-up BGP Application RIB.", e);
184 this.txChain.close();
185 LOG.info("BGP Application Peer Benchmark Application closed.");
189 InstanceIdentifier<Ipv4Routes> getIpv4RoutesIID() {
190 return this.routesIId;
193 private long addRoute(final Ipv4Prefix ipv4Prefix, final Ipv4Address nextHop, final long count, final long batch) {
194 final AttributesBuilder attributesBuilder = new AttributesBuilder();
195 attributesBuilder.setCNextHop(new Ipv4NextHopCaseBuilder().setIpv4NextHop(
196 new Ipv4NextHopBuilder().setGlobal(new Ipv4Address(nextHop)).build()).build());
197 attributesBuilder.setMultiExitDisc(MED);
198 attributesBuilder.setLocalPref(LOC_PREF);
199 attributesBuilder.setOrigin(ORIGIN);
200 attributesBuilder.setAsPath(AS_PATH);
201 final Attributes attributes = attributesBuilder.build();
202 return processRoutes(ipv4Prefix, count, batch, attributes);
205 private long deleteRoute(final Ipv4Prefix ipv4Prefix, final long count, final long batch) {
206 return processRoutes(ipv4Prefix, count, batch, null);
209 private long processRoutes(final Ipv4Prefix ipv4Prefix, final long count, final long batch,
210 final Attributes attributes) {
211 WriteTransaction wTx = this.txChain.newWriteOnlyTransaction();
212 String address = getAdddressFromPrefix(ipv4Prefix);
213 final Stopwatch stopwatch = Stopwatch.createStarted();
214 for (int i = 1; i <= count; i++) {
215 final Ipv4RouteKey routeKey = new Ipv4RouteKey(PATH_ID, createPrefix(address));
216 final KeyedInstanceIdentifier<Ipv4Route, Ipv4RouteKey> routeIId =
217 this.routesIId.child(Ipv4Route.class, routeKey);
218 if (attributes != null) {
219 final Ipv4RouteBuilder ipv4RouteBuilder = new Ipv4RouteBuilder();
220 ipv4RouteBuilder.setPrefix(routeKey.getPrefix());
221 ipv4RouteBuilder.setKey(routeKey);
222 ipv4RouteBuilder.setAttributes(attributes);
223 final Ipv4Route ipv4Route = ipv4RouteBuilder.build();
224 wTx.put(LogicalDatastoreType.CONFIGURATION, routeIId,
227 wTx.delete(LogicalDatastoreType.CONFIGURATION, routeIId);
229 if (i % batch == 0) {
231 wTx = this.txChain.newWriteOnlyTransaction();
233 address = increasePrefix(address);
236 return stopwatch.stop().elapsed(TimeUnit.MILLISECONDS);
239 private static long countRate(final long durationMillis, final long count) {
240 final long durationSec = TimeUnit.MILLISECONDS.toSeconds(durationMillis);
241 if (durationSec != 0) {
242 return count / durationSec;
247 private static String increasePrefix(final String prefix) {
248 return InetAddresses.increment(InetAddresses.forString(prefix)).getHostAddress();
251 private static Result createResult(final long count, final long duration, final long rate) {
252 return new ResultBuilder().setCount(count).setDuration(duration).setRate(rate).build();
255 private static String getAdddressFromPrefix(final Ipv4Prefix prefix) {
256 return prefix.getValue().split(SLASH)[0];
259 private static Ipv4Prefix createPrefix(final String address) {
260 return new Ipv4Prefix(address + PREFIX);