openflowplugin-impl/src/main/java/org/opendaylight/openflowplugin/impl/statistics/StatisticsGatheringUtils.java

   1 /*
   2  * Copyright (c) 2015 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
   9 package org.opendaylight.openflowplugin.impl.statistics;
  10
  11 import com.google.common.base.Function;
  12 import com.google.common.base.Optional;
  13 import com.google.common.util.concurrent.CheckedFuture;
  14 import com.google.common.util.concurrent.Futures;
  15 import com.google.common.util.concurrent.ListenableFuture;
  16 import com.google.common.util.concurrent.ListeningExecutorService;
  17 import com.google.common.util.concurrent.MoreExecutors;
  18 import java.text.SimpleDateFormat;
  19 import java.util.Collections;
  20 import java.util.Date;
  21 import java.util.List;
  22 import java.util.Objects;
  23 import java.util.concurrent.ExecutionException;
  24 import java.util.concurrent.atomic.AtomicBoolean;
  25 import java.util.stream.Collectors;
  26 import org.opendaylight.controller.md.sal.binding.api.ReadOnlyTransaction;
  27 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  28 import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
  29 import org.opendaylight.controller.md.sal.common.api.data.TransactionChainClosedException;
  30 import org.opendaylight.openflowplugin.api.openflow.device.DeviceInfo;
  31 import org.opendaylight.openflowplugin.api.openflow.device.DeviceRegistry;
  32 import org.opendaylight.openflowplugin.api.openflow.device.TxFacade;
  33 import org.opendaylight.openflowplugin.api.openflow.registry.flow.DeviceFlowRegistry;
  34 import org.opendaylight.openflowplugin.api.openflow.registry.group.DeviceGroupRegistry;
  35 import org.opendaylight.openflowplugin.api.openflow.registry.meter.DeviceMeterRegistry;
  36 import org.opendaylight.openflowplugin.api.openflow.statistics.ofpspecific.EventIdentifier;
  37 import org.opendaylight.openflowplugin.api.openflow.statistics.ofpspecific.StatisticsGatherer;
  38 import org.opendaylight.openflowplugin.impl.common.MultipartReplyTranslatorUtil;
  39 import org.opendaylight.openflowplugin.impl.datastore.MultipartWriterProvider;
  40 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.ConvertorExecutor;
  41 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.DateAndTime;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNode;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableStatisticsGatheringStatus;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableStatisticsGatheringStatusBuilder;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.meters.Meter;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.meters.MeterKey;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.snapshot.gathering.status.grouping.SnapshotGatheringStatusEnd;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.snapshot.gathering.status.grouping.SnapshotGatheringStatusEndBuilder;
  49 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.snapshot.gathering.status.grouping.SnapshotGatheringStatusStartBuilder;
  50 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.Table;
  51 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.TableBuilder;
  52 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.groups.Group;
  53 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.groups.GroupKey;
  54 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.MultipartType;
  55 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.OfHeader;
  56 import org.opendaylight.yangtools.yang.binding.DataContainer;
  57 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  58 import org.slf4j.Logger;
  59 import org.slf4j.LoggerFactory;
  60
  61 /**
  62  * Utils for gathering statistics.
  63  */
  64 public final class StatisticsGatheringUtils {
  65
  66     private static final String DATE_AND_TIME_FORMAT = "yyyy-MM-dd'T'HH:mm:ss.SSSXXX";
  67     private static final Logger LOG = LoggerFactory.getLogger(StatisticsGatheringUtils.class);
  68     private static final String QUEUE2_REQCTX = "QUEUE2REQCTX-";
  69
  70     private StatisticsGatheringUtils() {
  71         throw new IllegalStateException("This class should not be instantiated.");
  72     }
  73
  74     static <T extends OfHeader> ListenableFuture<Boolean> gatherStatistics(
  75             final StatisticsGatherer<T> statisticsGatheringService, final DeviceInfo deviceInfo,
  76             final MultipartType type, final TxFacade txFacade, final DeviceRegistry registry,
  77             final ConvertorExecutor convertorExecutor, final MultipartWriterProvider statisticsWriterProvider,
  78             final ListeningExecutorService executorService) {
  79         return Futures.transformAsync(statisticsGatheringService.getStatisticsOfType(
  80            new EventIdentifier(QUEUE2_REQCTX + type.toString(), deviceInfo.getNodeId().toString()), type),
  81             rpcResult -> executorService.submit(() -> {
  82                 final boolean rpcResultIsNull = rpcResult == null;
  83
  84                 if (!rpcResultIsNull && rpcResult.isSuccessful()) {
  85                     LOG.debug("Stats reply successfully received for node {} of type {}", deviceInfo.getNodeId(), type);
  86                         // TODO: in case the result value is null then multipart data probably got processed
  87                         // TODO: on the fly. This contract should by clearly stated and enforced.
  88                         // TODO: Now simple true value is returned
  89                     if (Objects.nonNull(rpcResult.getResult()) && !rpcResult.getResult().isEmpty()) {
  90                         final List<DataContainer> allMultipartData = rpcResult.getResult().stream()
  91                                 .map(reply -> MultipartReplyTranslatorUtil
  92                                                     .translate(reply, deviceInfo, convertorExecutor, null))
  93                                 .filter(java.util.Optional::isPresent).map(java.util.Optional::get)
  94                                             .collect(Collectors.toList());
  95
  96                         return processStatistics(type, allMultipartData, txFacade, registry, deviceInfo,
  97                                         statisticsWriterProvider);
  98                     } else {
  99                         LOG.debug("Stats reply was empty for node {} of type {}", deviceInfo.getNodeId(), type);
 100                     }
 101                 } else {
 102                     LOG.warn("Stats reply FAILED for node {} of type {}: {}", deviceInfo.getNodeId(), type,
 103                                 rpcResultIsNull ? "" : rpcResult.getErrors());
 104                 }
 105                 return false;
 106             }), MoreExecutors.directExecutor());
 107     }
 108
 109     private static boolean processStatistics(final MultipartType type, final List<? extends DataContainer> statistics,
 110                                              final TxFacade txFacade, final DeviceRegistry deviceRegistry,
 111                                              final DeviceInfo deviceInfo,
 112                                              final MultipartWriterProvider statisticsWriterProvider) {
 113         final InstanceIdentifier<FlowCapableNode> instanceIdentifier = deviceInfo.getNodeInstanceIdentifier()
 114                 .augmentation(FlowCapableNode.class);
 115
 116         switch (type) {
 117             case OFPMPFLOW:
 118                 deleteAllKnownFlows(txFacade, instanceIdentifier, deviceRegistry.getDeviceFlowRegistry());
 119                 deviceRegistry.getDeviceFlowRegistry().processMarks();
 120                 break;
 121             case OFPMPMETERCONFIG:
 122                 deleteAllKnownMeters(txFacade, instanceIdentifier, deviceRegistry.getDeviceMeterRegistry());
 123                 deviceRegistry.getDeviceMeterRegistry().processMarks();
 124                 break;
 125             case OFPMPGROUPDESC:
 126                 deleteAllKnownGroups(txFacade, instanceIdentifier, deviceRegistry.getDeviceGroupRegistry());
 127                 deviceRegistry.getDeviceGroupRegistry().processMarks();
 128                 break;
 129             default:
 130                 // no operation
 131         }
 132
 133         if (writeStatistics(type, statistics, deviceInfo, statisticsWriterProvider)) {
 134             txFacade.submitTransaction();
 135
 136             LOG.debug("Stats reply added to transaction for node {} of type {}", deviceInfo.getNodeId(), type);
 137             return true;
 138         }
 139
 140         LOG.warn("Stats processing of type {} for node {} " + "failed during write-to-tx step", type, deviceInfo);
 141         return false;
 142     }
 143
 144     @SuppressWarnings("checkstyle:IllegalCatch")
 145     private static boolean writeStatistics(final MultipartType type, final List<? extends DataContainer> statistics,
 146                                            final DeviceInfo deviceInfo,
 147                                            final MultipartWriterProvider statisticsWriterProvider) {
 148         final AtomicBoolean result = new AtomicBoolean(false);
 149
 150         try {
 151             statistics.forEach(stat -> statisticsWriterProvider.lookup(type).ifPresent(p -> {
 152                 final boolean write = p.write(stat, false);
 153
 154                 if (!result.get()) {
 155                     result.set(write);
 156                 }
 157             }));
 158         } catch (final Exception ex) {
 159             LOG.warn("Stats processing of type {} for node {} " + "failed during write-to-tx step", type, deviceInfo,
 160                      ex);
 161         }
 162
 163         return result.get();
 164     }
 165
 166     public static void deleteAllKnownFlows(final TxFacade txFacade,
 167                                            final InstanceIdentifier<FlowCapableNode> instanceIdentifier,
 168                                            final DeviceFlowRegistry deviceFlowRegistry) {
 169         if (!txFacade.isTransactionsEnabled()) {
 170             return;
 171         }
 172
 173         final CheckedFuture<Optional<FlowCapableNode>, ReadFailedException> future;
 174         try (ReadOnlyTransaction readTx = txFacade.getReadTransaction()) {
 175             future = readTx.read(LogicalDatastoreType.OPERATIONAL, instanceIdentifier);
 176         }
 177
 178         try {
 179             Futures.transform(Futures.catchingAsync(future, Throwable.class, throwable -> {
 180                 return Futures.immediateFailedFuture(throwable);
 181             }, MoreExecutors.directExecutor()), (Function<Optional<FlowCapableNode>, Void>) flowCapNodeOpt -> {
 182                     // we have to read actual tables with all information before we set empty Flow list,
 183                     // merge is expensive and not applicable for lists
 184                     if (flowCapNodeOpt != null && flowCapNodeOpt.isPresent()) {
 185                         for (final Table tableData : flowCapNodeOpt.get().getTable()) {
 186                             final Table table = new TableBuilder(tableData).setFlow(Collections.emptyList()).build();
 187                             final InstanceIdentifier<Table> iiToTable = instanceIdentifier
 188                                     .child(Table.class, tableData.getKey());
 189                             txFacade.writeToTransaction(LogicalDatastoreType.OPERATIONAL, iiToTable, table);
 190                         }
 191                     }
 192                     return null;
 193                 }, MoreExecutors.directExecutor()).get();
 194         } catch (InterruptedException | ExecutionException ex) {
 195             LOG.debug("Failed to delete {} flows, exception: {}", deviceFlowRegistry.size(), ex);
 196         }
 197     }
 198
 199     public static void deleteAllKnownMeters(final TxFacade txFacade,
 200                                             final InstanceIdentifier<FlowCapableNode> instanceIdentifier,
 201                                             final DeviceMeterRegistry meterRegistry) {
 202         meterRegistry.forEach(meterId -> {
 203             txFacade
 204                     .addDeleteToTxChain(
 205                             LogicalDatastoreType.OPERATIONAL,
 206                             instanceIdentifier.child(Meter.class, new MeterKey(meterId)));
 207             meterRegistry.addMark(meterId);
 208         });
 209     }
 210
 211     public static void deleteAllKnownGroups(final TxFacade txFacade,
 212                                             final InstanceIdentifier<FlowCapableNode> instanceIdentifier,
 213                                             final DeviceGroupRegistry groupRegistry) {
 214         LOG.debug("deleteAllKnownGroups on device targetType {}", instanceIdentifier.getTargetType());
 215         groupRegistry.forEach(groupId -> {
 216             txFacade
 217                     .addDeleteToTxChain(
 218                             LogicalDatastoreType.OPERATIONAL,
 219                             instanceIdentifier.child(Group.class, new GroupKey(groupId)));
 220             groupRegistry.addMark(groupId);
 221         });
 222     }
 223
 224     /**
 225      * Writes snapshot gathering start timestamp + cleans end mark.
 226      *
 227      * @param deviceInfo device info
 228      * @param txFacade tx manager
 229      */
 230     static void markDeviceStateSnapshotStart(final DeviceInfo deviceInfo, final TxFacade txFacade) {
 231         final InstanceIdentifier<FlowCapableStatisticsGatheringStatus> statusPath = deviceInfo
 232                 .getNodeInstanceIdentifier().augmentation(FlowCapableStatisticsGatheringStatus.class);
 233
 234         final SimpleDateFormat simpleDateFormat = new SimpleDateFormat(DATE_AND_TIME_FORMAT);
 235         final FlowCapableStatisticsGatheringStatus gatheringStatus = new FlowCapableStatisticsGatheringStatusBuilder()
 236                 .setSnapshotGatheringStatusStart(new SnapshotGatheringStatusStartBuilder()
 237                         .setBegin(new DateAndTime(simpleDateFormat.format(new Date())))
 238                         .build())
 239                 .setSnapshotGatheringStatusEnd(null) // TODO: reconsider if really need to clean end mark here
 240                 .build();
 241         try {
 242             txFacade.writeToTransaction(LogicalDatastoreType.OPERATIONAL, statusPath, gatheringStatus);
 243         } catch (final TransactionChainClosedException e) {
 244             LOG.warn("Can't write to transaction, transaction chain probably closed.");
 245             LOG.trace("Write to transaction exception: ", e);
 246         }
 247
 248         txFacade.submitTransaction();
 249     }
 250
 251     /**
 252      * Writes snapshot gathering end timestamp + outcome.
 253      *
 254      * @param deviceInfo device info
 255      * @param txFacade tx manager
 256      * @param succeeded     outcome of currently finished gathering
 257      */
 258     static void markDeviceStateSnapshotEnd(final DeviceInfo deviceInfo,
 259                                            final TxFacade txFacade, final boolean succeeded) {
 260         final InstanceIdentifier<SnapshotGatheringStatusEnd> statusEndPath = deviceInfo
 261                 .getNodeInstanceIdentifier().augmentation(FlowCapableStatisticsGatheringStatus.class)
 262                 .child(SnapshotGatheringStatusEnd.class);
 263
 264         final SimpleDateFormat simpleDateFormat = new SimpleDateFormat(DATE_AND_TIME_FORMAT);
 265         final SnapshotGatheringStatusEnd gatheringStatus = new SnapshotGatheringStatusEndBuilder()
 266                 .setEnd(new DateAndTime(simpleDateFormat.format(new Date())))
 267                 .setSucceeded(succeeded)
 268                 .build();
 269         try {
 270             txFacade.writeToTransaction(LogicalDatastoreType.OPERATIONAL, statusEndPath, gatheringStatus);
 271         } catch (TransactionChainClosedException e) {
 272             LOG.warn("Can't write to transaction, transaction chain probably closed.");
 273             LOG.trace("Write to transaction exception: ", e);
 274         }
 275
 276         txFacade.submitTransaction();
 277     }
 278 }