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