applications/forwardingrules-manager/src/main/java/org/opendaylight/openflowplugin/applications/frm/impl/MeterForwarder.java

   1 /**
   2  * Copyright (c) 2014, 2017 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.openflowplugin.applications.frm.impl;
   9
  10 import com.google.common.base.Preconditions;
  11 import com.google.common.util.concurrent.FutureCallback;
  12 import com.google.common.util.concurrent.Futures;
  13 import com.google.common.util.concurrent.ListenableFuture;
  14 import com.google.common.util.concurrent.MoreExecutors;
  15 import java.util.concurrent.Future;
  16 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  17 import org.opendaylight.controller.md.sal.binding.api.DataTreeIdentifier;
  18 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
  19 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  20 import org.opendaylight.infrautils.utils.concurrent.JdkFutures;
  21 import org.opendaylight.openflowplugin.applications.frm.ForwardingRulesManager;
  22 import org.opendaylight.openflowplugin.common.wait.SimpleTaskRetryLooper;
  23 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNode;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.meters.Meter;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.meters.StaleMeter;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.meters.StaleMeterBuilder;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.meters.StaleMeterKey;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.Nodes;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.service.rev130918.AddMeterInputBuilder;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.service.rev130918.AddMeterOutput;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.service.rev130918.RemoveMeterInputBuilder;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.service.rev130918.RemoveMeterOutput;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.service.rev130918.UpdateMeterInputBuilder;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.service.rev130918.UpdateMeterOutput;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.service.rev130918.meter.update.OriginalMeterBuilder;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.service.rev130918.meter.update.UpdatedMeterBuilder;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.MeterId;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.MeterRef;
  42 import org.opendaylight.yangtools.concepts.ListenerRegistration;
  43 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  44 import org.opendaylight.yangtools.yang.common.RpcResult;
  45 import org.slf4j.Logger;
  46 import org.slf4j.LoggerFactory;
  47
  48 /**
  49  * MeterForwarder It implements
  50  * {@link org.opendaylight.controller.md.sal.binding.api.DataTreeChangeListener}
  51  * for WildCardedPath to {@link Meter} and ForwardingRulesCommiter interface for
  52  * methods: add, update and remove {@link Meter} processing for
  53  * {@link org.opendaylight.controller.md.sal.binding.api.DataTreeModification}.
  54  *
  55  */
  56 public class MeterForwarder extends AbstractListeningCommiter<Meter> {
  57
  58     private static final Logger LOG = LoggerFactory.getLogger(MeterForwarder.class);
  59     private final DataBroker dataBroker;
  60     private ListenerRegistration<MeterForwarder> listenerRegistration;
  61
  62     @SuppressWarnings("IllegalCatch")
  63     public MeterForwarder(final ForwardingRulesManager manager, final DataBroker db) {
  64         super(manager);
  65         dataBroker = Preconditions.checkNotNull(db, "DataBroker can not be null!");
  66         final DataTreeIdentifier<Meter> treeId = new DataTreeIdentifier<>(LogicalDatastoreType.CONFIGURATION,
  67                 getWildCardPath());
  68
  69         try {
  70             SimpleTaskRetryLooper looper = new SimpleTaskRetryLooper(ForwardingRulesManagerImpl.STARTUP_LOOP_TICK,
  71                     ForwardingRulesManagerImpl.STARTUP_LOOP_MAX_RETRIES);
  72             listenerRegistration = looper
  73                     .loopUntilNoException(() -> db.registerDataTreeChangeListener(treeId, MeterForwarder.this));
  74         } catch (final Exception e) {
  75             LOG.warn("FRM Meter DataTreeChange listener registration fail!");
  76             LOG.debug("FRM Meter DataTreeChange listener registration fail ..", e);
  77             throw new IllegalStateException("MeterForwarder startup fail! System needs restart.", e);
  78         }
  79     }
  80
  81     @Override
  82     public void close() {
  83         if (listenerRegistration != null) {
  84             listenerRegistration.close();
  85             listenerRegistration = null;
  86         }
  87     }
  88
  89     @Override
  90     protected InstanceIdentifier<Meter> getWildCardPath() {
  91         return InstanceIdentifier.create(Nodes.class).child(Node.class).augmentation(FlowCapableNode.class)
  92                 .child(Meter.class);
  93     }
  94
  95     @Override
  96     public void remove(final InstanceIdentifier<Meter> identifier, final Meter removeDataObj,
  97             final InstanceIdentifier<FlowCapableNode> nodeIdent) {
  98
  99         final RemoveMeterInputBuilder builder = new RemoveMeterInputBuilder(removeDataObj);
 100
 101         builder.setNode(new NodeRef(nodeIdent.firstIdentifierOf(Node.class)));
 102         builder.setMeterRef(new MeterRef(identifier));
 103         builder.setTransactionUri(new Uri(provider.getNewTransactionId()));
 104
 105         final Future<RpcResult<RemoveMeterOutput>> resultFuture =
 106                 this.provider.getSalMeterService().removeMeter(builder.build());
 107         JdkFutures.addErrorLogging(resultFuture, LOG, "removeMeter");
 108     }
 109
 110     @Override
 111     public Future<RpcResult<RemoveMeterOutput>> removeWithResult(final InstanceIdentifier<Meter> identifier,
 112             final Meter removeDataObj, final InstanceIdentifier<FlowCapableNode> nodeIdent) {
 113
 114         final RemoveMeterInputBuilder builder = new RemoveMeterInputBuilder(removeDataObj);
 115
 116         builder.setNode(new NodeRef(nodeIdent.firstIdentifierOf(Node.class)));
 117         builder.setMeterRef(new MeterRef(identifier));
 118         builder.setTransactionUri(new Uri(provider.getNewTransactionId()));
 119         return this.provider.getSalMeterService().removeMeter(builder.build());
 120     }
 121
 122     @Override
 123     public void update(final InstanceIdentifier<Meter> identifier, final Meter original, final Meter update,
 124             final InstanceIdentifier<FlowCapableNode> nodeIdent) {
 125
 126         final UpdateMeterInputBuilder builder = new UpdateMeterInputBuilder();
 127
 128         builder.setNode(new NodeRef(nodeIdent.firstIdentifierOf(Node.class)));
 129         builder.setMeterRef(new MeterRef(identifier));
 130         builder.setTransactionUri(new Uri(provider.getNewTransactionId()));
 131         builder.setUpdatedMeter(new UpdatedMeterBuilder(update).build());
 132         builder.setOriginalMeter(new OriginalMeterBuilder(original).build());
 133
 134         final Future<RpcResult<UpdateMeterOutput>> resultFuture =
 135                 this.provider.getSalMeterService().updateMeter(builder.build());
 136         JdkFutures.addErrorLogging(resultFuture, LOG, "updateMeter");
 137     }
 138
 139     @Override
 140     public Future<RpcResult<AddMeterOutput>> add(final InstanceIdentifier<Meter> identifier, final Meter addDataObj,
 141             final InstanceIdentifier<FlowCapableNode> nodeIdent) {
 142
 143         final AddMeterInputBuilder builder = new AddMeterInputBuilder(addDataObj);
 144
 145         builder.setNode(new NodeRef(nodeIdent.firstIdentifierOf(Node.class)));
 146         builder.setMeterRef(new MeterRef(identifier));
 147         builder.setTransactionUri(new Uri(provider.getNewTransactionId()));
 148         return this.provider.getSalMeterService().addMeter(builder.build());
 149     }
 150
 151     @Override
 152     public void createStaleMarkEntity(InstanceIdentifier<Meter> identifier, Meter del,
 153             InstanceIdentifier<FlowCapableNode> nodeIdent) {
 154         LOG.debug("Creating Stale-Mark entry for the switch {} for meter {} ", nodeIdent.toString(), del.toString());
 155         StaleMeter staleMeter = makeStaleMeter(del);
 156         persistStaleMeter(staleMeter, nodeIdent);
 157     }
 158
 159     private StaleMeter makeStaleMeter(Meter del) {
 160         StaleMeterBuilder staleMeterBuilder = new StaleMeterBuilder(del);
 161         return staleMeterBuilder.setMeterId(del.getMeterId()).build();
 162     }
 163
 164     private void persistStaleMeter(StaleMeter staleMeter, InstanceIdentifier<FlowCapableNode> nodeIdent) {
 165         WriteTransaction writeTransaction = dataBroker.newWriteOnlyTransaction();
 166         writeTransaction.put(LogicalDatastoreType.CONFIGURATION, getStaleMeterInstanceIdentifier(staleMeter, nodeIdent),
 167                 staleMeter, false);
 168
 169         ListenableFuture<Void> submitFuture = writeTransaction.submit();
 170         handleStaleMeterResultFuture(submitFuture);
 171     }
 172
 173     private void handleStaleMeterResultFuture(ListenableFuture<Void> submitFuture) {
 174         Futures.addCallback(submitFuture, new FutureCallback<Void>() {
 175             @Override
 176             public void onSuccess(Void result) {
 177                 LOG.debug("Stale Meter creation success");
 178             }
 179
 180             @Override
 181             public void onFailure(Throwable throwable) {
 182                 LOG.error("Stale Meter creation failed {}", throwable);
 183             }
 184         }, MoreExecutors.directExecutor());
 185     }
 186
 187     private InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819
 188         .meters.StaleMeter> getStaleMeterInstanceIdentifier(
 189             StaleMeter staleMeter, InstanceIdentifier<FlowCapableNode> nodeIdent) {
 190         return nodeIdent.child(StaleMeter.class, new StaleMeterKey(new MeterId(staleMeter.getMeterId())));
 191     }
 192 }