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;
12 import static org.opendaylight.protocol.bgp.parser.spi.PathIdUtil.NON_PATH_ID;
14 import com.google.common.annotations.VisibleForTesting;
15 import com.google.common.base.Stopwatch;
16 import com.google.common.net.InetAddresses;
17 import com.google.common.util.concurrent.FutureCallback;
18 import com.google.common.util.concurrent.Futures;
19 import com.google.common.util.concurrent.MoreExecutors;
20 import java.util.Collections;
21 import java.util.List;
22 import java.util.concurrent.Future;
23 import java.util.concurrent.TimeUnit;
24 import org.opendaylight.controller.md.sal.binding.api.BindingTransactionChain;
25 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
26 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
27 import org.opendaylight.controller.md.sal.common.api.data.AsyncTransaction;
28 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
29 import org.opendaylight.controller.md.sal.common.api.data.TransactionChain;
30 import org.opendaylight.controller.md.sal.common.api.data.TransactionChainListener;
31 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
32 import org.opendaylight.controller.sal.binding.api.BindingAwareBroker.RpcRegistration;
33 import org.opendaylight.controller.sal.binding.api.RpcProviderRegistry;
34 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address;
35 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Prefix;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev180329.application.rib.tables.routes.Ipv4RoutesCaseBuilder;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev180329.ipv4.routes.Ipv4Routes;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev180329.ipv4.routes.Ipv4RoutesBuilder;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev180329.ipv4.routes.ipv4.routes.Ipv4Route;
40 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev180329.ipv4.routes.ipv4.routes.Ipv4RouteBuilder;
41 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev180329.ipv4.routes.ipv4.routes.Ipv4RouteKey;
42 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.path.attributes.Attributes;
43 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.path.attributes.AttributesBuilder;
44 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.path.attributes.attributes.AsPath;
45 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.path.attributes.attributes.AsPathBuilder;
46 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.path.attributes.attributes.LocalPref;
47 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.path.attributes.attributes.LocalPrefBuilder;
48 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.path.attributes.attributes.MultiExitDisc;
49 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.path.attributes.attributes.MultiExitDiscBuilder;
50 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.path.attributes.attributes.Origin;
51 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.path.attributes.attributes.OriginBuilder;
52 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.ApplicationRib;
53 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.ApplicationRibBuilder;
54 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.ApplicationRibId;
55 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.ApplicationRibKey;
56 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.rib.Tables;
57 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.rib.TablesBuilder;
58 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.rib.TablesKey;
59 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev180329.BgpOrigin;
60 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev180329.Ipv4AddressFamily;
61 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev180329.UnicastSubsequentAddressFamily;
62 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev180329.next.hop.c.next.hop.Ipv4NextHopCaseBuilder;
63 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev180329.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 final BindingTransactionChain txChain;
97 private final RpcRegistration<OdlBgpAppPeerBenchmarkService> rpcRegistration;
98 private final InstanceIdentifier<ApplicationRib> appIID;
99 private final InstanceIdentifier<Ipv4Routes> routesIId;
100 private final String appRibId;
102 public AppPeerBenchmark(final DataBroker bindingDataBroker, final RpcProviderRegistry rpcProviderRegistry,
103 final String appRibId) {
104 this.appRibId = requireNonNull(appRibId);
105 this.txChain = bindingDataBroker.createTransactionChain(this);
107 this.appIID = InstanceIdentifier.builder(ApplicationRib.class,
108 new ApplicationRibKey(new ApplicationRibId(appRibId))).build();
109 final InstanceIdentifier tablesIId = this.appIID
110 .child(Tables.class, new TablesKey(Ipv4AddressFamily.class, UnicastSubsequentAddressFamily.class));
111 this.routesIId = tablesIId.child(Ipv4Routes.class);
112 this.rpcRegistration = rpcProviderRegistry.addRpcImplementation(OdlBgpAppPeerBenchmarkService.class, this);
113 LOG.info("BGP Application Peer Benchmark Application started.");
116 public void start() {
117 LOG.debug("Instantiating App Peer Benchmark : {}", this.appRibId);
118 final ApplicationRib appRib = new ApplicationRibBuilder().setId(new ApplicationRibId(
119 new ApplicationRibId(this.appRibId))).setTables(EMPTY_TABLES).build();
121 final WriteTransaction wTx = this.txChain.newWriteOnlyTransaction();
122 wTx.put(LogicalDatastoreType.CONFIGURATION, this.appIID, appRib);
123 Futures.addCallback(wTx.submit(), new FutureCallback<Void>() {
125 public void onSuccess(final Void result) {
126 LOG.info("Empty Structure created for Application Peer Benchmark {}", AppPeerBenchmark.this.appRibId);
130 public void onFailure(final Throwable throwable) {
131 LOG.error("Failed to create Empty Structure for Application Peer Benchmark {}",
132 AppPeerBenchmark.this.appRibId, throwable);
134 }, MoreExecutors.directExecutor());
138 public void onTransactionChainFailed(final TransactionChain<?, ?> chain, final AsyncTransaction<?, ?> transaction,
139 final Throwable cause) {
140 LOG.error("Broken chain {} in DatastoreBaAbstractWrite, transaction {}, cause {}", chain,
141 transaction.getIdentifier(), cause);
146 public void onTransactionChainSuccessful(final TransactionChain<?, ?> chain) {
147 LOG.debug("DatastoreBaAbstractWrite closed successfully, chain {}", chain);
151 public Future<RpcResult<AddPrefixOutput>> addPrefix(final AddPrefixInput input) {
152 final long duration = addRoute(input.getPrefix(), input.getNexthop(), input.getCount(), input.getBatchsize());
153 final long rate = countRate(duration, input.getCount());
155 final AddPrefixOutputBuilder outputbuilder = new AddPrefixOutputBuilder();
156 outputbuilder.setResult(createResult(input.getCount(), duration, rate));
157 final AddPrefixOutput output = outputbuilder.build();
158 return RpcResultBuilder.success(output).buildFuture();
162 public Future<RpcResult<DeletePrefixOutput>> deletePrefix(final DeletePrefixInput input) {
163 final long duration = deleteRoute(input.getPrefix(), input.getCount(), input.getBatchsize());
164 final long rate = countRate(duration, input.getCount());
166 final DeletePrefixOutputBuilder outputbuilder = new DeletePrefixOutputBuilder();
167 outputbuilder.setResult(createResult(input.getCount(), duration, rate));
168 final DeletePrefixOutput output = outputbuilder.build();
169 return RpcResultBuilder.success(output).buildFuture();
173 public void close() {
174 this.rpcRegistration.close();
175 final WriteTransaction dTx = this.txChain.newWriteOnlyTransaction();
176 dTx.delete(LogicalDatastoreType.CONFIGURATION, this.appIID);
178 dTx.submit().checkedGet();
179 } catch (final TransactionCommitFailedException e) {
180 LOG.warn("Failed to clean-up BGP Application RIB.", e);
182 this.txChain.close();
183 LOG.info("BGP Application Peer Benchmark Application closed.");
187 InstanceIdentifier<Ipv4Routes> getIpv4RoutesIID() {
188 return this.routesIId;
191 private long addRoute(final Ipv4Prefix ipv4Prefix, final Ipv4Address nextHop, final long count, final long batch) {
192 final AttributesBuilder attributesBuilder = new AttributesBuilder();
193 attributesBuilder.setCNextHop(new Ipv4NextHopCaseBuilder().setIpv4NextHop(
194 new Ipv4NextHopBuilder().setGlobal(new Ipv4Address(nextHop)).build()).build());
195 attributesBuilder.setMultiExitDisc(MED);
196 attributesBuilder.setLocalPref(LOC_PREF);
197 attributesBuilder.setOrigin(ORIGIN);
198 attributesBuilder.setAsPath(AS_PATH);
199 final Attributes attributes = attributesBuilder.build();
200 return processRoutes(ipv4Prefix, count, batch, attributes);
203 private long deleteRoute(final Ipv4Prefix ipv4Prefix, final long count, final long batch) {
204 return processRoutes(ipv4Prefix, count, batch, null);
207 private long processRoutes(final Ipv4Prefix ipv4Prefix, final long count, final long batch,
208 final Attributes attributes) {
209 WriteTransaction wt = this.txChain.newWriteOnlyTransaction();
210 String address = getAdddressFromPrefix(ipv4Prefix);
211 final Stopwatch stopwatch = Stopwatch.createStarted();
212 for (int i = 1; i <= count; i++) {
213 final Ipv4RouteKey routeKey = new Ipv4RouteKey(NON_PATH_ID, createKey(address));
214 final KeyedInstanceIdentifier<Ipv4Route, Ipv4RouteKey> routeIId =
215 this.routesIId.child(Ipv4Route.class, routeKey);
216 if (attributes != null) {
217 final Ipv4RouteBuilder ipv4RouteBuilder = new Ipv4RouteBuilder();
218 ipv4RouteBuilder.setRouteKey(routeKey.getRouteKey());
219 ipv4RouteBuilder.setPrefix(new Ipv4Prefix(routeKey.getRouteKey()));
220 ipv4RouteBuilder.setKey(routeKey);
221 ipv4RouteBuilder.setAttributes(attributes);
222 final Ipv4Route ipv4Route = ipv4RouteBuilder.build();
223 wt.put(LogicalDatastoreType.CONFIGURATION, routeIId,
226 wt.delete(LogicalDatastoreType.CONFIGURATION, routeIId);
228 if (i % batch == 0) {
230 wt = this.txChain.newWriteOnlyTransaction();
232 address = increasePrefix(address);
235 return stopwatch.stop().elapsed(TimeUnit.MILLISECONDS);
238 private static long countRate(final long durationMillis, final long count) {
239 final long durationSec = TimeUnit.MILLISECONDS.toSeconds(durationMillis);
240 if (durationSec != 0) {
241 return count / durationSec;
246 private static String increasePrefix(final String prefix) {
247 return InetAddresses.increment(InetAddresses.forString(prefix)).getHostAddress();
250 private static Result createResult(final long count, final long duration, final long rate) {
251 return new ResultBuilder().setCount(count).setDuration(duration).setRate(rate).build();
254 private static String getAdddressFromPrefix(final Ipv4Prefix prefix) {
255 return prefix.getValue().split(SLASH)[0];
258 private static String createKey(final String address) {
259 return address + PREFIX;