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.common.api.data.AsyncDataChangeEvent}.
  53  *
  54  */
  55 public class GroupForwarder extends AbstractListeningCommiter<Group> {
  56
  57     private static final Logger LOG = LoggerFactory.getLogger(GroupForwarder.class);
  58
  59     private final DataBroker dataBroker;
  60
  61     private ListenerRegistration<GroupForwarder> listenerRegistration;
  62
  63     public GroupForwarder (final ForwardingRulesManager manager, final DataBroker db) {
  64         super(manager, Group.class);
  65         dataBroker = Preconditions.checkNotNull(db, "DataBroker can not be null!");
  66         final DataTreeIdentifier<Group> treeId = new DataTreeIdentifier<>(LogicalDatastoreType.CONFIGURATION, getWildCardPath());
  67
  68         try {
  69             SimpleTaskRetryLooper looper = new SimpleTaskRetryLooper(ForwardingRulesManagerImpl.STARTUP_LOOP_TICK,
  70                     ForwardingRulesManagerImpl.STARTUP_LOOP_MAX_RETRIES);
  71             listenerRegistration = looper.loopUntilNoException(new Callable<ListenerRegistration<GroupForwarder>>() {
  72                 @Override
  73                 public ListenerRegistration<GroupForwarder> call() throws Exception {
  74                     return db.registerDataTreeChangeListener(treeId, GroupForwarder.this);
  75                 }
  76             });
  77         } catch (final Exception e) {
  78             LOG.warn("FRM Group DataTreeChange listener registration fail!");
  79             LOG.debug("FRM Group DataTreeChange listener registration fail ..", e);
  80             throw new IllegalStateException("GroupForwarder startup fail! System needs restart.", e);
  81         }
  82     }
  83
  84     @Override
  85     public void close() {
  86         if (listenerRegistration != null) {
  87             try {
  88                 listenerRegistration.close();
  89             } catch (Exception e) {
  90                 LOG.warn("Error by stop FRM GroupChangeListener: {}", e.getMessage());
  91                 LOG.debug("Error by stop FRM GroupChangeListener..", e);
  92             }
  93             listenerRegistration = null;
  94         }
  95     }
  96
  97     @Override
  98     protected InstanceIdentifier<Group> getWildCardPath() {
  99         return InstanceIdentifier.create(Nodes.class).child(Node.class)
 100                 .augmentation(FlowCapableNode.class).child(Group.class);
 101     }
 102
 103     @Override
 104     public void remove(final InstanceIdentifier<Group> identifier, final Group removeDataObj,
 105                        final InstanceIdentifier<FlowCapableNode> nodeIdent) {
 106
 107         final Group group = (removeDataObj);
 108         final RemoveGroupInputBuilder builder = new RemoveGroupInputBuilder(group);
 109
 110         builder.setNode(new NodeRef(nodeIdent.firstIdentifierOf(Node.class)));
 111         builder.setGroupRef(new GroupRef(identifier));
 112         builder.setTransactionUri(new Uri(provider.getNewTransactionId()));
 113         this.provider.getSalGroupService().removeGroup(builder.build());
 114     }
 115
 116     //TODO: Pull this into ForwardingRulesCommiter and override it here
 117     @Override
 118     public Future<RpcResult<RemoveGroupOutput>> removeWithResult(final InstanceIdentifier<Group> identifier, final Group removeDataObj,
 119                        final InstanceIdentifier<FlowCapableNode> nodeIdent) {
 120
 121         final Group group = (removeDataObj);
 122         final RemoveGroupInputBuilder builder = new RemoveGroupInputBuilder(group);
 123
 124         builder.setNode(new NodeRef(nodeIdent.firstIdentifierOf(Node.class)));
 125         builder.setGroupRef(new GroupRef(identifier));
 126         builder.setTransactionUri(new Uri(provider.getNewTransactionId()));
 127         return this.provider.getSalGroupService().removeGroup(builder.build());
 128     }
 129
 130     @Override
 131     public void update(final InstanceIdentifier<Group> identifier,
 132                        final Group original, final Group update,
 133                        final InstanceIdentifier<FlowCapableNode> nodeIdent) {
 134
 135         final Group originalGroup = (original);
 136         final Group updatedGroup = (update);
 137         final UpdateGroupInputBuilder builder = new UpdateGroupInputBuilder();
 138
 139         builder.setNode(new NodeRef(nodeIdent.firstIdentifierOf(Node.class)));
 140         builder.setGroupRef(new GroupRef(identifier));
 141         builder.setTransactionUri(new Uri(provider.getNewTransactionId()));
 142         builder.setUpdatedGroup((new UpdatedGroupBuilder(updatedGroup)).build());
 143         builder.setOriginalGroup((new OriginalGroupBuilder(originalGroup)).build());
 144
 145         this.provider.getSalGroupService().updateGroup(builder.build());
 146     }
 147
 148     @Override
 149     public Future<RpcResult<AddGroupOutput>> add(
 150         final InstanceIdentifier<Group> identifier, final Group addDataObj,
 151         final InstanceIdentifier<FlowCapableNode> nodeIdent) {
 152
 153         final Group group = (addDataObj);
 154         final AddGroupInputBuilder builder = new AddGroupInputBuilder(group);
 155
 156         builder.setNode(new NodeRef(nodeIdent.firstIdentifierOf(Node.class)));
 157         builder.setGroupRef(new GroupRef(identifier));
 158         builder.setTransactionUri(new Uri(provider.getNewTransactionId()));
 159         return this.provider.getSalGroupService().addGroup(builder.build());
 160     }
 161
 162     @Override
 163     public void createStaleMarkEntity(InstanceIdentifier<Group> identifier, Group del, InstanceIdentifier<FlowCapableNode> nodeIdent) {
 164         LOG.debug("Creating Stale-Mark entry for the switch {} for Group {} ", nodeIdent.toString(), del.toString());
 165         StaleGroup staleGroup = makeStaleGroup(identifier, del, nodeIdent);
 166         persistStaleGroup(staleGroup, nodeIdent);
 167
 168     }
 169
 170
 171     private StaleGroup makeStaleGroup(InstanceIdentifier<Group> identifier, Group del, InstanceIdentifier<FlowCapableNode> nodeIdent){
 172         StaleGroupBuilder staleGroupBuilder = new StaleGroupBuilder(del);
 173         return staleGroupBuilder.setGroupId(del.getGroupId()).build();
 174     }
 175
 176     private void persistStaleGroup(StaleGroup staleGroup, InstanceIdentifier<FlowCapableNode> nodeIdent){
 177         WriteTransaction writeTransaction = dataBroker.newWriteOnlyTransaction();
 178         writeTransaction.put(LogicalDatastoreType.CONFIGURATION, getStaleGroupInstanceIdentifier(staleGroup, nodeIdent), staleGroup, false);
 179
 180         CheckedFuture<Void, TransactionCommitFailedException> submitFuture = writeTransaction.submit();
 181         handleStaleGroupResultFuture(submitFuture);
 182     }
 183
 184     private void handleStaleGroupResultFuture(CheckedFuture<Void, TransactionCommitFailedException> submitFuture) {
 185         Futures.addCallback(submitFuture, new FutureCallback<Void>() {
 186             @Override
 187             public void onSuccess(Void result) {
 188                 LOG.debug("Stale Group creation success");
 189             }
 190
 191             @Override
 192             public void onFailure(Throwable t) {
 193                 LOG.error("Stale Group creation failed {}", t);
 194             }
 195         });
 196
 197     }
 198
 199     private InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.groups.StaleGroup> getStaleGroupInstanceIdentifier(StaleGroup staleGroup, InstanceIdentifier<FlowCapableNode> nodeIdent) {
 200             return nodeIdent
 201                 .child(StaleGroup.class, new StaleGroupKey(new GroupId(staleGroup.getGroupId())));
 202     }
 203
 204 }
 205