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