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