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

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