bgp/benchmark-app/src/main/java/org/opendaylight/protocol/bgp/benchmark/app/AppPeerBenchmark.java

   1 /*
   2  * Copyright (c) 2016 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   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
   7  */
   8 package org.opendaylight.protocol.bgp.benchmark.app;
   9
  10 import static java.util.Objects.requireNonNull;
  11 import static org.opendaylight.protocol.bgp.parser.spi.PathIdUtil.NON_PATH_ID;
  12
  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.ListenableFuture;
  18 import com.google.common.util.concurrent.MoreExecutors;
  19 import java.util.Map;
  20 import java.util.concurrent.ExecutionException;
  21 import java.util.concurrent.TimeUnit;
  22 import org.opendaylight.mdsal.binding.api.DataBroker;
  23 import org.opendaylight.mdsal.binding.api.RpcProviderService;
  24 import org.opendaylight.mdsal.binding.api.TransactionChain;
  25 import org.opendaylight.mdsal.binding.api.WriteTransaction;
  26 import org.opendaylight.mdsal.common.api.CommitInfo;
  27 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  28 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone;
  29 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Prefix;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev180329.application.rib.tables.routes.Ipv4RoutesCaseBuilder;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev180329.bgp.rib.rib.loc.rib.tables.routes.Ipv4RoutesCase;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev180329.ipv4.routes.Ipv4Routes;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev180329.ipv4.routes.Ipv4RoutesBuilder;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev180329.ipv4.routes.ipv4.routes.Ipv4Route;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev180329.ipv4.routes.ipv4.routes.Ipv4RouteBuilder;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev180329.ipv4.routes.ipv4.routes.Ipv4RouteKey;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.path.attributes.Attributes;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.path.attributes.AttributesBuilder;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.path.attributes.attributes.AsPath;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.path.attributes.attributes.AsPathBuilder;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.path.attributes.attributes.LocalPref;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.path.attributes.attributes.LocalPrefBuilder;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.path.attributes.attributes.MultiExitDisc;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.path.attributes.attributes.MultiExitDiscBuilder;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.path.attributes.attributes.Origin;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.path.attributes.attributes.OriginBuilder;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.ApplicationRib;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.ApplicationRibBuilder;
  49 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.ApplicationRibId;
  50 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.ApplicationRibKey;
  51 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.rib.Tables;
  52 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.rib.TablesBuilder;
  53 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.rib.TablesKey;
  54 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev200120.BgpOrigin;
  55 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev200120.Ipv4AddressFamily;
  56 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev200120.UnicastSubsequentAddressFamily;
  57 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev200120.next.hop.c.next.hop.Ipv4NextHopCaseBuilder;
  58 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev200120.next.hop.c.next.hop.ipv4.next.hop._case.Ipv4NextHopBuilder;
  59 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.odl.bgp.app.peer.benchmark.rev200120.AddPrefix;
  60 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.odl.bgp.app.peer.benchmark.rev200120.AddPrefixInput;
  61 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.odl.bgp.app.peer.benchmark.rev200120.AddPrefixOutput;
  62 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.odl.bgp.app.peer.benchmark.rev200120.AddPrefixOutputBuilder;
  63 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.odl.bgp.app.peer.benchmark.rev200120.DeletePrefix;
  64 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.odl.bgp.app.peer.benchmark.rev200120.DeletePrefixInput;
  65 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.odl.bgp.app.peer.benchmark.rev200120.DeletePrefixOutput;
  66 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.odl.bgp.app.peer.benchmark.rev200120.DeletePrefixOutputBuilder;
  67 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.odl.bgp.app.peer.benchmark.rev200120.output.Result;
  68 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.odl.bgp.app.peer.benchmark.rev200120.output.ResultBuilder;
  69 import org.opendaylight.yangtools.concepts.Registration;
  70 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  71 import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
  72 import org.opendaylight.yangtools.yang.binding.util.BindingMap;
  73 import org.opendaylight.yangtools.yang.common.Empty;
  74 import org.opendaylight.yangtools.yang.common.RpcResult;
  75 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
  76 import org.opendaylight.yangtools.yang.common.Uint32;
  77 import org.slf4j.Logger;
  78 import org.slf4j.LoggerFactory;
  79
  80 public final class AppPeerBenchmark implements FutureCallback<Empty>, AutoCloseable {
  81
  82     private static final Logger LOG = LoggerFactory.getLogger(AppPeerBenchmark.class);
  83
  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(Uint32.ZERO).build();
  87     private static final LocalPref LOC_PREF = new LocalPrefBuilder().setPref(Uint32.valueOf(100)).build();
  88     private static final Map<TablesKey, Tables> EMPTY_TABLES = BindingMap.of(new TablesBuilder()
  89         .setAfi(Ipv4AddressFamily.VALUE).setSafi(UnicastSubsequentAddressFamily.VALUE).setRoutes(
  90             new Ipv4RoutesCaseBuilder().setIpv4Routes(new Ipv4RoutesBuilder().setIpv4Route(Map.of())
  91                 .build()).build()).build());
  92
  93     private static final String SLASH = "/";
  94     private static final String PREFIX = SLASH + "32";
  95
  96     private final TransactionChain txChain;
  97     private final Registration rpcRegistration;
  98     private final InstanceIdentifier<ApplicationRib> appIID;
  99     private final InstanceIdentifier<Ipv4Routes> routesIId;
 100     private final String appRibId;
 101
 102     public AppPeerBenchmark(final DataBroker bindingDataBroker, final RpcProviderService rpcProviderRegistry,
 103             final String appRibId) {
 104         this.appRibId = requireNonNull(appRibId);
 105         txChain = bindingDataBroker.createMergingTransactionChain();
 106         txChain.addCallback(this);
 107
 108         appIID = InstanceIdentifier.builder(ApplicationRib.class,
 109             new ApplicationRibKey(new ApplicationRibId(appRibId))).build();
 110         routesIId = appIID
 111             .child(Tables.class, new TablesKey(Ipv4AddressFamily.VALUE, UnicastSubsequentAddressFamily.VALUE))
 112             .child(Ipv4RoutesCase.class, Ipv4Routes.class);
 113         rpcRegistration = rpcProviderRegistry.registerRpcImplementations(
 114             (AddPrefix) this::addPrefix,
 115             (DeletePrefix) this::deletePrefix);
 116         LOG.info("BGP Application Peer Benchmark Application started.");
 117     }
 118
 119     public void start() {
 120         LOG.debug("Instantiating App Peer Benchmark : {}", appRibId);
 121         final ApplicationRib appRib = new ApplicationRibBuilder().setId(new ApplicationRibId(
 122             new ApplicationRibId(appRibId))).setTables(EMPTY_TABLES).build();
 123
 124         final WriteTransaction wTx = txChain.newWriteOnlyTransaction();
 125         wTx.put(LogicalDatastoreType.CONFIGURATION, appIID, appRib);
 126         wTx.commit().addCallback(new FutureCallback<CommitInfo>() {
 127             @Override
 128             public void onSuccess(final CommitInfo result) {
 129                 LOG.info("Empty Structure created for Application Peer Benchmark {}", appRibId);
 130             }
 131
 132             @Override
 133             public void onFailure(final Throwable throwable) {
 134                 LOG.error("Failed to create Empty Structure for Application Peer Benchmark {}", appRibId, throwable);
 135             }
 136         }, MoreExecutors.directExecutor());
 137     }
 138
 139     @Override
 140     public void onFailure(final Throwable cause) {
 141         LOG.error("Broken chain in DatastoreBaAbstractWrite", cause);
 142         close();
 143     }
 144
 145     @Override
 146     public void onSuccess(final Empty result) {
 147         LOG.debug("DatastoreBaAbstractWrite closed successfully");
 148     }
 149
 150     @VisibleForTesting
 151     ListenableFuture<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());
 154
 155         return RpcResultBuilder.success(
 156             new AddPrefixOutputBuilder().setResult(createResult(input.getCount(), duration, rate)).build())
 157             .buildFuture();
 158     }
 159
 160     @VisibleForTesting
 161     ListenableFuture<RpcResult<DeletePrefixOutput>> deletePrefix(final DeletePrefixInput input) {
 162         final long duration = deleteRoute(input.getPrefix(), input.getCount(), input.getBatchsize());
 163         final long rate = countRate(duration, input.getCount());
 164
 165         return RpcResultBuilder.success(
 166             new DeletePrefixOutputBuilder().setResult(createResult(input.getCount(), duration, rate)).build())
 167             .buildFuture();
 168     }
 169
 170     @Override
 171     public void close() {
 172         rpcRegistration.close();
 173         final WriteTransaction dTx = txChain.newWriteOnlyTransaction();
 174         dTx.delete(LogicalDatastoreType.CONFIGURATION, appIID);
 175         try {
 176             dTx.commit().get();
 177         } catch (final InterruptedException | ExecutionException e) {
 178             LOG.warn("Failed to clean-up BGP Application RIB.", e);
 179         }
 180         txChain.close();
 181         LOG.info("BGP Application Peer Benchmark Application closed.");
 182     }
 183
 184     @VisibleForTesting
 185     InstanceIdentifier<Ipv4Routes> getIpv4RoutesIID() {
 186         return routesIId;
 187     }
 188
 189     private long addRoute(final Ipv4Prefix ipv4Prefix, final Ipv4AddressNoZone nextHop, final Uint32 count,
 190             final Uint32 batch) {
 191         return processRoutes(ipv4Prefix, count, batch, new AttributesBuilder()
 192             .setCNextHop(new Ipv4NextHopCaseBuilder()
 193                 .setIpv4NextHop(new Ipv4NextHopBuilder().setGlobal(nextHop).build())
 194                 .build())
 195             .setMultiExitDisc(MED)
 196             .setLocalPref(LOC_PREF)
 197             .setOrigin(ORIGIN)
 198             .setAsPath(AS_PATH)
 199             .build());
 200     }
 201
 202     private long deleteRoute(final Ipv4Prefix ipv4Prefix, final Uint32 count, final Uint32 batch) {
 203         return processRoutes(ipv4Prefix, count, batch, null);
 204     }
 205
 206     private long processRoutes(final Ipv4Prefix ipv4Prefix, final Uint32 count, final Uint32 batch,
 207         final Attributes attributes) {
 208         WriteTransaction wt = txChain.newWriteOnlyTransaction();
 209         String address = getAdddressFromPrefix(ipv4Prefix);
 210         final long countLong = count.longValue();
 211         final long batchLong = batch.longValue();
 212         final Stopwatch stopwatch = Stopwatch.createStarted();
 213         for (int i = 1; i <= countLong; i++) {
 214             final Ipv4RouteKey routeKey = new Ipv4RouteKey(NON_PATH_ID, createKey(address));
 215             final KeyedInstanceIdentifier<Ipv4Route, Ipv4RouteKey> routeIId =
 216                 routesIId.child(Ipv4Route.class, routeKey);
 217             if (attributes != null) {
 218                 wt.put(LogicalDatastoreType.CONFIGURATION, routeIId, new Ipv4RouteBuilder()
 219                     .setRouteKey(routeKey.getRouteKey())
 220                     .setPrefix(new Ipv4Prefix(routeKey.getRouteKey()))
 221                     .withKey(routeKey)
 222                     .setAttributes(attributes)
 223                     .build());
 224             } else {
 225                 wt.delete(LogicalDatastoreType.CONFIGURATION, routeIId);
 226             }
 227             if (i % batchLong == 0) {
 228                 wt.commit().addCallback(new FutureCallback<CommitInfo>() {
 229                     @Override
 230                     public void onSuccess(final CommitInfo result) {
 231                         LOG.trace("Successful commit");
 232                     }
 233
 234                     @Override
 235                     public void onFailure(final Throwable trw) {
 236                         LOG.error("Failed commit", trw);
 237                     }
 238                 }, MoreExecutors.directExecutor());
 239                 wt = txChain.newWriteOnlyTransaction();
 240             }
 241             address = increasePrefix(address);
 242         }
 243         wt.commit().addCallback(new FutureCallback<CommitInfo>() {
 244             @Override
 245             public void onSuccess(final CommitInfo result) {
 246                 LOG.trace("Route batch stored.");
 247             }
 248
 249             @Override
 250             public void onFailure(final Throwable throwable) {
 251                 LOG.error("Failed to store route batch.", throwable);
 252             }
 253         }, MoreExecutors.directExecutor());
 254         return stopwatch.stop().elapsed(TimeUnit.MILLISECONDS);
 255     }
 256
 257     private static long countRate(final long durationMillis, final Uint32 count) {
 258         final long durationSec = TimeUnit.MILLISECONDS.toSeconds(durationMillis);
 259         if (durationSec != 0) {
 260             return count.toJava() / durationSec;
 261         }
 262         return count.toJava();
 263     }
 264
 265     private static String increasePrefix(final String prefix) {
 266         return InetAddresses.increment(InetAddresses.forString(prefix)).getHostAddress();
 267     }
 268
 269     private static Result createResult(final Uint32 count, final long duration, final long rate) {
 270         return new ResultBuilder().setCount(count).setDuration(Uint32.valueOf(duration)).setRate(Uint32.valueOf(rate))
 271                 .build();
 272     }
 273
 274     private static String getAdddressFromPrefix(final Ipv4Prefix prefix) {
 275         return prefix.getValue().split(SLASH)[0];
 276     }
 277
 278     private static String createKey(final String address) {
 279         return address + PREFIX;
 280     }
 281 }