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.util.concurrent.FutureCallback;
  11 import com.google.common.util.concurrent.Futures;
  12 import com.google.common.util.concurrent.ListenableFuture;
  13 import com.google.common.util.concurrent.MoreExecutors;
  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.infrautils.utils.concurrent.JdkFutures;
  20 import org.opendaylight.openflowplugin.applications.frm.ForwardingRulesManager;
  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.AddMeterOutput;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.service.rev130918.RemoveMeterInputBuilder;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.service.rev130918.RemoveMeterOutput;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.service.rev130918.UpdateMeterInputBuilder;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.service.rev130918.UpdateMeterOutput;
  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 ListenerRegistration<MeterForwarder> listenerRegistration;
  58
  59     public MeterForwarder(final ForwardingRulesManager manager, final DataBroker db) {
  60         super(manager, db);
  61     }
  62
  63     @SuppressWarnings("IllegalCatch")
  64     @Override
  65     public void registerListener() {
  66         final DataTreeIdentifier<Meter> treeId = new DataTreeIdentifier<>(LogicalDatastoreType.CONFIGURATION,
  67                 getWildCardPath());
  68
  69         try {
  70             listenerRegistration = dataBroker.registerDataTreeChangeListener(treeId, MeterForwarder.this);
  71         } catch (final Exception e) {
  72             LOG.warn("FRM Meter DataTreeChange listener registration fail!");
  73             LOG.debug("FRM Meter DataTreeChange listener registration fail ..", e);
  74             throw new IllegalStateException("MeterForwarder startup fail! System needs restart.", e);
  75         }
  76     }
  77
  78     @Override
  79     public  void deregisterListener() {
  80         close();
  81     }
  82
  83     @Override
  84     public void close() {
  85         if (listenerRegistration != null) {
  86             listenerRegistration.close();
  87             listenerRegistration = null;
  88         }
  89     }
  90
  91     @Override
  92     protected InstanceIdentifier<Meter> getWildCardPath() {
  93         return InstanceIdentifier.create(Nodes.class).child(Node.class).augmentation(FlowCapableNode.class)
  94                 .child(Meter.class);
  95     }
  96
  97     @Override
  98     public void remove(final InstanceIdentifier<Meter> identifier, final Meter removeDataObj,
  99             final InstanceIdentifier<FlowCapableNode> nodeIdent) {
 100
 101         final RemoveMeterInputBuilder builder = new RemoveMeterInputBuilder(removeDataObj);
 102
 103         builder.setNode(new NodeRef(nodeIdent.firstIdentifierOf(Node.class)));
 104         builder.setMeterRef(new MeterRef(identifier));
 105         builder.setTransactionUri(new Uri(provider.getNewTransactionId()));
 106
 107         final Future<RpcResult<RemoveMeterOutput>> resultFuture =
 108                 this.provider.getSalMeterService().removeMeter(builder.build());
 109         JdkFutures.addErrorLogging(resultFuture, LOG, "removeMeter");
 110     }
 111
 112     @Override
 113     public Future<RpcResult<RemoveMeterOutput>> removeWithResult(final InstanceIdentifier<Meter> identifier,
 114             final Meter removeDataObj, final InstanceIdentifier<FlowCapableNode> nodeIdent) {
 115
 116         final RemoveMeterInputBuilder builder = new RemoveMeterInputBuilder(removeDataObj);
 117
 118         builder.setNode(new NodeRef(nodeIdent.firstIdentifierOf(Node.class)));
 119         builder.setMeterRef(new MeterRef(identifier));
 120         builder.setTransactionUri(new Uri(provider.getNewTransactionId()));
 121         return this.provider.getSalMeterService().removeMeter(builder.build());
 122     }
 123
 124     @Override
 125     public void update(final InstanceIdentifier<Meter> identifier, final Meter original, final Meter update,
 126             final InstanceIdentifier<FlowCapableNode> nodeIdent) {
 127
 128         final UpdateMeterInputBuilder builder = new UpdateMeterInputBuilder();
 129
 130         builder.setNode(new NodeRef(nodeIdent.firstIdentifierOf(Node.class)));
 131         builder.setMeterRef(new MeterRef(identifier));
 132         builder.setTransactionUri(new Uri(provider.getNewTransactionId()));
 133         builder.setUpdatedMeter(new UpdatedMeterBuilder(update).build());
 134         builder.setOriginalMeter(new OriginalMeterBuilder(original).build());
 135
 136         final Future<RpcResult<UpdateMeterOutput>> resultFuture =
 137                 this.provider.getSalMeterService().updateMeter(builder.build());
 138         JdkFutures.addErrorLogging(resultFuture, LOG, "updateMeter");
 139     }
 140
 141     @Override
 142     public Future<RpcResult<AddMeterOutput>> add(final InstanceIdentifier<Meter> identifier, final Meter addDataObj,
 143             final InstanceIdentifier<FlowCapableNode> nodeIdent) {
 144
 145         final AddMeterInputBuilder builder = new AddMeterInputBuilder(addDataObj);
 146
 147         builder.setNode(new NodeRef(nodeIdent.firstIdentifierOf(Node.class)));
 148         builder.setMeterRef(new MeterRef(identifier));
 149         builder.setTransactionUri(new Uri(provider.getNewTransactionId()));
 150         return this.provider.getSalMeterService().addMeter(builder.build());
 151     }
 152
 153     @Override
 154     public void createStaleMarkEntity(InstanceIdentifier<Meter> identifier, Meter del,
 155             InstanceIdentifier<FlowCapableNode> nodeIdent) {
 156         LOG.debug("Creating Stale-Mark entry for the switch {} for meter {} ", nodeIdent.toString(), del.toString());
 157         StaleMeter staleMeter = makeStaleMeter(del);
 158         persistStaleMeter(staleMeter, nodeIdent);
 159     }
 160
 161     private StaleMeter makeStaleMeter(Meter del) {
 162         StaleMeterBuilder staleMeterBuilder = new StaleMeterBuilder(del);
 163         return staleMeterBuilder.setMeterId(del.getMeterId()).build();
 164     }
 165
 166     private void persistStaleMeter(StaleMeter staleMeter, InstanceIdentifier<FlowCapableNode> nodeIdent) {
 167         WriteTransaction writeTransaction = dataBroker.newWriteOnlyTransaction();
 168         writeTransaction.put(LogicalDatastoreType.CONFIGURATION, getStaleMeterInstanceIdentifier(staleMeter, nodeIdent),
 169                 staleMeter, false);
 170
 171         ListenableFuture<Void> submitFuture = writeTransaction.submit();
 172         handleStaleMeterResultFuture(submitFuture);
 173     }
 174
 175     private void handleStaleMeterResultFuture(ListenableFuture<Void> submitFuture) {
 176         Futures.addCallback(submitFuture, new FutureCallback<Void>() {
 177             @Override
 178             public void onSuccess(Void result) {
 179                 LOG.debug("Stale Meter creation success");
 180             }
 181
 182             @Override
 183             public void onFailure(Throwable throwable) {
 184                 LOG.error("Stale Meter creation failed {}", throwable);
 185             }
 186         }, MoreExecutors.directExecutor());
 187     }
 188
 189     private InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819
 190         .meters.StaleMeter> getStaleMeterInstanceIdentifier(
 191             StaleMeter staleMeter, InstanceIdentifier<FlowCapableNode> nodeIdent) {
 192         return nodeIdent.child(StaleMeter.class, new StaleMeterKey(new MeterId(staleMeter.getMeterId())));
 193     }
 194 }