applications/forwardingrules-manager/src/main/java/org/opendaylight/openflowplugin/applications/frm/impl/GroupForwarder.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.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 com.google.common.util.concurrent.MoreExecutors;
  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.infrautils.utils.concurrent.JdkFutures;
  22 import org.opendaylight.openflowplugin.applications.frm.ForwardingRulesManager;
  23 import org.opendaylight.openflowplugin.common.wait.SimpleTaskRetryLooper;
  24 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNode;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.service.rev130918.AddGroupInputBuilder;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.service.rev130918.AddGroupOutput;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.service.rev130918.RemoveGroupInputBuilder;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.service.rev130918.RemoveGroupOutput;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.service.rev130918.UpdateGroupInputBuilder;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.service.rev130918.UpdateGroupOutput;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.service.rev130918.group.update.OriginalGroupBuilder;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.service.rev130918.group.update.UpdatedGroupBuilder;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.GroupId;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.GroupRef;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.groups.Group;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.groups.StaleGroup;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.groups.StaleGroupBuilder;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.groups.StaleGroupKey;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.Nodes;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
  43 import org.opendaylight.yangtools.concepts.ListenerRegistration;
  44 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  45 import org.opendaylight.yangtools.yang.common.RpcResult;
  46 import org.slf4j.Logger;
  47 import org.slf4j.LoggerFactory;
  48
  49 /**
  50  * GroupForwarder It implements
  51  * {@link org.opendaylight.controller.md.sal.binding.api.DataTreeChangeListener}
  52  * for WildCardedPath to {@link Group} and ForwardingRulesCommiter interface for
  53  * methods: add, update and remove {@link Group} processing for
  54  * {@link org.opendaylight.controller.md.sal.binding.api.DataTreeModification}.
  55  */
  56 public class GroupForwarder extends AbstractListeningCommiter<Group> {
  57
  58     private static final Logger LOG = LoggerFactory.getLogger(GroupForwarder.class);
  59     private final DataBroker dataBroker;
  60     private ListenerRegistration<GroupForwarder> listenerRegistration;
  61
  62     @SuppressWarnings("IllegalCatch")
  63     public GroupForwarder(final ForwardingRulesManager manager, final DataBroker db) {
  64         super(manager);
  65         dataBroker = Preconditions.checkNotNull(db, "DataBroker can not be null!");
  66         final DataTreeIdentifier<Group> treeId = new DataTreeIdentifier<>(LogicalDatastoreType.CONFIGURATION,
  67                 getWildCardPath());
  68
  69         try {
  70             SimpleTaskRetryLooper looper = new SimpleTaskRetryLooper(ForwardingRulesManagerImpl.STARTUP_LOOP_TICK,
  71                     ForwardingRulesManagerImpl.STARTUP_LOOP_MAX_RETRIES);
  72             listenerRegistration = looper
  73                     .loopUntilNoException(() -> db.registerDataTreeChangeListener(treeId, GroupForwarder.this));
  74         } catch (final Exception e) {
  75             LOG.warn("FRM Group DataTreeChange listener registration fail!");
  76             LOG.debug("FRM Group DataTreeChange listener registration fail ..", e);
  77             throw new IllegalStateException("GroupForwarder startup fail! System needs restart.", e);
  78         }
  79     }
  80
  81     @Override
  82     public void close() {
  83         if (listenerRegistration != null) {
  84             listenerRegistration.close();
  85             listenerRegistration = null;
  86         }
  87     }
  88
  89     @Override
  90     protected InstanceIdentifier<Group> getWildCardPath() {
  91         return InstanceIdentifier.create(Nodes.class).child(Node.class).augmentation(FlowCapableNode.class)
  92                 .child(Group.class);
  93     }
  94
  95     @Override
  96     public void remove(final InstanceIdentifier<Group> identifier, final Group removeDataObj,
  97             final InstanceIdentifier<FlowCapableNode> nodeIdent) {
  98
  99         final Group group = removeDataObj;
 100         final RemoveGroupInputBuilder builder = new RemoveGroupInputBuilder(group);
 101
 102         builder.setNode(new NodeRef(nodeIdent.firstIdentifierOf(Node.class)));
 103         builder.setGroupRef(new GroupRef(identifier));
 104         builder.setTransactionUri(new Uri(provider.getNewTransactionId()));
 105
 106         final Future<RpcResult<RemoveGroupOutput>> resultFuture =
 107                 this.provider.getSalGroupService().removeGroup(builder.build());
 108         JdkFutures.addErrorLogging(resultFuture, LOG, "removeGroup");
 109     }
 110
 111     // TODO: Pull this into ForwardingRulesCommiter and override it here
 112     @Override
 113     public Future<RpcResult<RemoveGroupOutput>> removeWithResult(final InstanceIdentifier<Group> identifier,
 114             final Group removeDataObj, final InstanceIdentifier<FlowCapableNode> nodeIdent) {
 115
 116         final Group group = removeDataObj;
 117         final RemoveGroupInputBuilder builder = new RemoveGroupInputBuilder(group);
 118
 119         builder.setNode(new NodeRef(nodeIdent.firstIdentifierOf(Node.class)));
 120         builder.setGroupRef(new GroupRef(identifier));
 121         builder.setTransactionUri(new Uri(provider.getNewTransactionId()));
 122         return this.provider.getSalGroupService().removeGroup(builder.build());
 123     }
 124
 125     @Override
 126     public void update(final InstanceIdentifier<Group> identifier, final Group original, final Group update,
 127             final InstanceIdentifier<FlowCapableNode> nodeIdent) {
 128
 129         final Group originalGroup = original;
 130         final Group updatedGroup = update;
 131         final UpdateGroupInputBuilder builder = new UpdateGroupInputBuilder();
 132
 133         builder.setNode(new NodeRef(nodeIdent.firstIdentifierOf(Node.class)));
 134         builder.setGroupRef(new GroupRef(identifier));
 135         builder.setTransactionUri(new Uri(provider.getNewTransactionId()));
 136         builder.setUpdatedGroup(new UpdatedGroupBuilder(updatedGroup).build());
 137         builder.setOriginalGroup(new OriginalGroupBuilder(originalGroup).build());
 138
 139         final Future<RpcResult<UpdateGroupOutput>> resultFuture =
 140                 this.provider.getSalGroupService().updateGroup(builder.build());
 141         JdkFutures.addErrorLogging(resultFuture, LOG, "updateGroup");
 142     }
 143
 144     @Override
 145     public Future<RpcResult<AddGroupOutput>> add(final InstanceIdentifier<Group> identifier, final Group addDataObj,
 146             final InstanceIdentifier<FlowCapableNode> nodeIdent) {
 147
 148         final Group group = addDataObj;
 149         final AddGroupInputBuilder builder = new AddGroupInputBuilder(group);
 150
 151         builder.setNode(new NodeRef(nodeIdent.firstIdentifierOf(Node.class)));
 152         builder.setGroupRef(new GroupRef(identifier));
 153         builder.setTransactionUri(new Uri(provider.getNewTransactionId()));
 154         return this.provider.getSalGroupService().addGroup(builder.build());
 155     }
 156
 157     @Override
 158     public void createStaleMarkEntity(InstanceIdentifier<Group> identifier, Group del,
 159             InstanceIdentifier<FlowCapableNode> nodeIdent) {
 160         LOG.debug("Creating Stale-Mark entry for the switch {} for Group {} ", nodeIdent.toString(), del.toString());
 161         StaleGroup staleGroup = makeStaleGroup(identifier, del, nodeIdent);
 162         persistStaleGroup(staleGroup, nodeIdent);
 163
 164     }
 165
 166     private StaleGroup makeStaleGroup(InstanceIdentifier<Group> identifier, Group del,
 167             InstanceIdentifier<FlowCapableNode> nodeIdent) {
 168         StaleGroupBuilder staleGroupBuilder = new StaleGroupBuilder(del);
 169         return staleGroupBuilder.setGroupId(del.getGroupId()).build();
 170     }
 171
 172     private void persistStaleGroup(StaleGroup staleGroup, InstanceIdentifier<FlowCapableNode> nodeIdent) {
 173         WriteTransaction writeTransaction = dataBroker.newWriteOnlyTransaction();
 174         writeTransaction.put(LogicalDatastoreType.CONFIGURATION, getStaleGroupInstanceIdentifier(staleGroup, nodeIdent),
 175                 staleGroup, false);
 176
 177         CheckedFuture<Void, TransactionCommitFailedException> submitFuture = writeTransaction.submit();
 178         handleStaleGroupResultFuture(submitFuture);
 179     }
 180
 181     private void handleStaleGroupResultFuture(CheckedFuture<Void, TransactionCommitFailedException> submitFuture) {
 182         Futures.addCallback(submitFuture, new FutureCallback<Void>() {
 183             @Override
 184             public void onSuccess(Void result) {
 185                 LOG.debug("Stale Group creation success");
 186             }
 187
 188             @Override
 189             public void onFailure(Throwable throwable) {
 190                 LOG.error("Stale Group creation failed {}", throwable);
 191             }
 192         }, MoreExecutors.directExecutor());
 193
 194     }
 195
 196     private InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.group
 197         .types.rev131018.groups.StaleGroup> getStaleGroupInstanceIdentifier(
 198             StaleGroup staleGroup, InstanceIdentifier<FlowCapableNode> nodeIdent) {
 199         return nodeIdent.child(StaleGroup.class, new StaleGroupKey(new GroupId(staleGroup.getGroupId())));
 200     }
 201
 202 }