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