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.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.group.service.rev130918.AddGroupInputBuilder;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.service.rev130918.AddGroupOutput;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.service.rev130918.RemoveGroupInputBuilder;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.service.rev130918.RemoveGroupOutput;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.service.rev130918.UpdateGroupInputBuilder;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.service.rev130918.group.update.OriginalGroupBuilder;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.service.rev130918.group.update.UpdatedGroupBuilder;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.GroupId;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.GroupRef;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.groups.Group;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.groups.StaleGroup;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.groups.StaleGroupBuilder;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.groups.StaleGroupKey;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.Nodes;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
  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  * GroupForwarder
  49  * It implements {@link org.opendaylight.controller.md.sal.binding.api.DataTreeChangeListener}
  50  * for WildCardedPath to {@link Group} and ForwardingRulesCommiter interface for methods:
  51  * add, update and remove {@link Group} processing for
  52  * {@link org.opendaylight.controller.md.sal.binding.api.DataTreeModification}.
  53  */
  54 public class GroupForwarder extends AbstractListeningCommiter<Group> {
  55
  56     private static final Logger LOG = LoggerFactory.getLogger(GroupForwarder.class);
  57     private final DataBroker dataBroker;
  58     private ListenerRegistration<GroupForwarder> listenerRegistration;
  59
  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, getWildCardPath());
  64
  65         try {
  66             SimpleTaskRetryLooper looper = new SimpleTaskRetryLooper(ForwardingRulesManagerImpl.STARTUP_LOOP_TICK,
  67                     ForwardingRulesManagerImpl.STARTUP_LOOP_MAX_RETRIES);
  68             listenerRegistration = looper.loopUntilNoException(new Callable<ListenerRegistration<GroupForwarder>>() {
  69                 @Override
  70                 public ListenerRegistration<GroupForwarder> call() throws Exception {
  71                     return db.registerDataTreeChangeListener(treeId, GroupForwarder.this);
  72                 }
  73             });
  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             try {
  85                 listenerRegistration.close();
  86             } catch (Exception e) {
  87                 LOG.warn("Error by stop FRM GroupChangeListener: {}", e.getMessage());
  88                 LOG.debug("Error by stop FRM GroupChangeListener..", e);
  89             }
  90             listenerRegistration = null;
  91         }
  92     }
  93
  94     @Override
  95     protected InstanceIdentifier<Group> getWildCardPath() {
  96         return InstanceIdentifier.create(Nodes.class).child(Node.class)
  97                 .augmentation(FlowCapableNode.class).child(Group.class);
  98     }
  99
 100     @Override
 101     public void remove(final InstanceIdentifier<Group> identifier, final Group removeDataObj,
 102                        final InstanceIdentifier<FlowCapableNode> nodeIdent) {
 103
 104         final Group group = (removeDataObj);
 105         final RemoveGroupInputBuilder builder = new RemoveGroupInputBuilder(group);
 106
 107         builder.setNode(new NodeRef(nodeIdent.firstIdentifierOf(Node.class)));
 108         builder.setGroupRef(new GroupRef(identifier));
 109         builder.setTransactionUri(new Uri(provider.getNewTransactionId()));
 110         this.provider.getSalGroupService().removeGroup(builder.build());
 111     }
 112
 113     //TODO: Pull this into ForwardingRulesCommiter and override it here
 114     @Override
 115     public Future<RpcResult<RemoveGroupOutput>> removeWithResult(final InstanceIdentifier<Group> identifier, final Group removeDataObj,
 116                        final InstanceIdentifier<FlowCapableNode> nodeIdent) {
 117
 118         final Group group = (removeDataObj);
 119         final RemoveGroupInputBuilder builder = new RemoveGroupInputBuilder(group);
 120
 121         builder.setNode(new NodeRef(nodeIdent.firstIdentifierOf(Node.class)));
 122         builder.setGroupRef(new GroupRef(identifier));
 123         builder.setTransactionUri(new Uri(provider.getNewTransactionId()));
 124         return this.provider.getSalGroupService().removeGroup(builder.build());
 125     }
 126
 127     @Override
 128     public void update(final InstanceIdentifier<Group> identifier,
 129                        final Group original, final Group update,
 130                        final InstanceIdentifier<FlowCapableNode> nodeIdent) {
 131
 132         final Group originalGroup = (original);
 133         final Group updatedGroup = (update);
 134         final UpdateGroupInputBuilder builder = new UpdateGroupInputBuilder();
 135
 136         builder.setNode(new NodeRef(nodeIdent.firstIdentifierOf(Node.class)));
 137         builder.setGroupRef(new GroupRef(identifier));
 138         builder.setTransactionUri(new Uri(provider.getNewTransactionId()));
 139         builder.setUpdatedGroup((new UpdatedGroupBuilder(updatedGroup)).build());
 140         builder.setOriginalGroup((new OriginalGroupBuilder(originalGroup)).build());
 141
 142         this.provider.getSalGroupService().updateGroup(builder.build());
 143     }
 144
 145     @Override
 146     public Future<RpcResult<AddGroupOutput>> add(
 147         final InstanceIdentifier<Group> identifier, final Group addDataObj,
 148         final InstanceIdentifier<FlowCapableNode> nodeIdent) {
 149
 150         final Group group = (addDataObj);
 151         final AddGroupInputBuilder builder = new AddGroupInputBuilder(group);
 152
 153         builder.setNode(new NodeRef(nodeIdent.firstIdentifierOf(Node.class)));
 154         builder.setGroupRef(new GroupRef(identifier));
 155         builder.setTransactionUri(new Uri(provider.getNewTransactionId()));
 156         return this.provider.getSalGroupService().addGroup(builder.build());
 157     }
 158
 159     @Override
 160     public void createStaleMarkEntity(InstanceIdentifier<Group> identifier, Group del, InstanceIdentifier<FlowCapableNode> nodeIdent) {
 161         LOG.debug("Creating Stale-Mark entry for the switch {} for Group {} ", nodeIdent.toString(), del.toString());
 162         StaleGroup staleGroup = makeStaleGroup(identifier, del, nodeIdent);
 163         persistStaleGroup(staleGroup, nodeIdent);
 164
 165     }
 166
 167
 168     private StaleGroup makeStaleGroup(InstanceIdentifier<Group> identifier, Group del, InstanceIdentifier<FlowCapableNode> nodeIdent){
 169         StaleGroupBuilder staleGroupBuilder = new StaleGroupBuilder(del);
 170         return staleGroupBuilder.setGroupId(del.getGroupId()).build();
 171     }
 172
 173     private void persistStaleGroup(StaleGroup staleGroup, InstanceIdentifier<FlowCapableNode> nodeIdent){
 174         WriteTransaction writeTransaction = dataBroker.newWriteOnlyTransaction();
 175         writeTransaction.put(LogicalDatastoreType.CONFIGURATION, getStaleGroupInstanceIdentifier(staleGroup, nodeIdent), 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 t) {
 190                 LOG.error("Stale Group creation failed {}", t);
 191             }
 192         });
 193
 194     }
 195
 196     private InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.groups.StaleGroup> getStaleGroupInstanceIdentifier(StaleGroup staleGroup, InstanceIdentifier<FlowCapableNode> nodeIdent) {
 197             return nodeIdent
 198                 .child(StaleGroup.class, new StaleGroupKey(new GroupId(staleGroup.getGroupId())));
 199     }
 200
 201 }
 202