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