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