samples/sample-bundles/src/main/java/org/opendaylight/openflowplugin/samples/sample/bundles/SampleFlowCapableNodeListener.java

   1 /*
   2  * Copyright (c) 2017 Pantheon Technologies s.r.o. 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.samples.sample.bundles;
   9
  10 import java.math.BigInteger;
  11 import java.util.ArrayList;
  12 import java.util.Collection;
  13 import java.util.List;
  14 import java.util.concurrent.CompletableFuture;
  15 import java.util.concurrent.ExecutionException;
  16 import java.util.concurrent.ExecutorService;
  17 import java.util.concurrent.Executors;
  18 import java.util.concurrent.Future;
  19 import org.opendaylight.mdsal.binding.api.ClusteredDataTreeChangeListener;
  20 import org.opendaylight.mdsal.binding.api.DataBroker;
  21 import org.opendaylight.mdsal.binding.api.DataObjectModification.ModificationType;
  22 import org.opendaylight.mdsal.binding.api.DataTreeIdentifier;
  23 import org.opendaylight.mdsal.binding.api.DataTreeModification;
  24 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  25 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Prefix;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.action.GroupActionCaseBuilder;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.action.PopVlanActionCaseBuilder;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.action.SetFieldCaseBuilder;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.action.group.action._case.GroupActionBuilder;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.action.pop.vlan.action._case.PopVlanActionBuilder;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.action.set.field._case.SetFieldBuilder;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.list.Action;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.list.ActionBuilder;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.list.ActionKey;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNode;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowId;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.Flow;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.FlowBuilder;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.FlowKey;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.FlowCookie;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.flow.InstructionsBuilder;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.flow.MatchBuilder;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.instruction.ApplyActionsCaseBuilder;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.instruction.apply.actions._case.ApplyActionsBuilder;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.list.Instruction;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.list.InstructionBuilder;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.list.InstructionKey;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.BucketId;
  49 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.Group;
  50 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.GroupId;
  51 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.GroupTypes;
  52 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.group.BucketsBuilder;
  53 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.group.buckets.Bucket;
  54 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.group.buckets.BucketBuilder;
  55 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.groups.GroupBuilder;
  56 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.groups.GroupKey;
  57 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef;
  58 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.Nodes;
  59 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
  60 import org.opendaylight.yang.gen.v1.urn.opendaylight.l2.types.rev130827.EtherType;
  61 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.ethernet.match.fields.EthernetTypeBuilder;
  62 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.EthernetMatchBuilder;
  63 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.layer._3.match.Ipv4MatchBuilder;
  64 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.bundle.service.rev170124.AddBundleMessagesInput;
  65 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.bundle.service.rev170124.AddBundleMessagesInputBuilder;
  66 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.bundle.service.rev170124.AddBundleMessagesOutput;
  67 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.bundle.service.rev170124.ControlBundleInput;
  68 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.bundle.service.rev170124.ControlBundleInputBuilder;
  69 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.bundle.service.rev170124.ControlBundleOutput;
  70 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.bundle.service.rev170124.SalBundleService;
  71 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.bundle.service.rev170124.add.bundle.messages.input.Messages;
  72 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.bundle.service.rev170124.add.bundle.messages.input.MessagesBuilder;
  73 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.bundle.service.rev170124.add.bundle.messages.input.messages.Message;
  74 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.bundle.service.rev170124.add.bundle.messages.input.messages.MessageBuilder;
  75 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.bundle.service.rev170124.bundle.inner.message.grouping.bundle.inner.message.BundleAddFlowCaseBuilder;
  76 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.bundle.service.rev170124.bundle.inner.message.grouping.bundle.inner.message.BundleAddGroupCaseBuilder;
  77 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.bundle.service.rev170124.bundle.inner.message.grouping.bundle.inner.message.bundle.add.flow._case.AddFlowCaseDataBuilder;
  78 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.bundle.service.rev170124.bundle.inner.message.grouping.bundle.inner.message.bundle.add.group._case.AddGroupCaseDataBuilder;
  79 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.rev170124.BundleControlType;
  80 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.rev170124.BundleFlags;
  81 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.rev170124.BundleId;
  82 import org.opendaylight.yangtools.concepts.ListenerRegistration;
  83 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  84 import org.opendaylight.yangtools.yang.common.RpcResult;
  85 import org.slf4j.Logger;
  86 import org.slf4j.LoggerFactory;
  87
  88 /**
  89  * Sample DataTreeChangeListener.
  90  */
  91 public class SampleFlowCapableNodeListener implements ClusteredDataTreeChangeListener<FlowCapableNode>, AutoCloseable {
  92
  93     private static final Logger LOG = LoggerFactory.getLogger(SampleFlowCapableNodeListener.class);
  94
  95     private static final BundleId BUNDLE_ID = new BundleId(1L);
  96     private static final BundleFlags BUNDLE_FLAGS = new BundleFlags(true, true);
  97     private static final ExecutorService EXECUTOR = Executors.newSingleThreadExecutor();
  98
  99     private final DataBroker dataBroker;
 100     private final SalBundleService bundleService;
 101     private ListenerRegistration<?> listenerReg;
 102
 103     public SampleFlowCapableNodeListener(DataBroker dataBroker, SalBundleService bundleService) {
 104         this.dataBroker = dataBroker;
 105         this.bundleService = bundleService;
 106     }
 107
 108     @Override
 109     public void close() {
 110         LOG.debug("close() passing");
 111         if (listenerReg != null) {
 112             listenerReg.close();
 113         }
 114     }
 115
 116     public void init() {
 117         LOG.debug("inSessionInitialized() passing");
 118
 119         final InstanceIdentifier<FlowCapableNode> path = InstanceIdentifier.create(Nodes.class).child(Node.class)
 120                 .augmentation(FlowCapableNode.class);
 121         final DataTreeIdentifier<FlowCapableNode> identifier =
 122                 DataTreeIdentifier.create(LogicalDatastoreType.OPERATIONAL, path);
 123
 124         listenerReg = dataBroker.registerDataTreeChangeListener(identifier, SampleFlowCapableNodeListener.this);
 125     }
 126
 127     @Override
 128     public void onDataTreeChanged(Collection<DataTreeModification<FlowCapableNode>> modifications) {
 129         for (DataTreeModification<FlowCapableNode> modification : modifications) {
 130             if (modification.getRootNode().getModificationType() == ModificationType.WRITE) {
 131                 LOG.info("Node connected:  {}",
 132                         modification.getRootPath().getRootIdentifier().firstIdentifierOf(Node.class));
 133
 134                 final NodeRef nodeRef =
 135                         new NodeRef(modification.getRootPath().getRootIdentifier().firstIdentifierOf(Node.class));
 136
 137                 final ControlBundleInput openBundleInput = new ControlBundleInputBuilder()
 138                         .setNode(nodeRef)
 139                         .setBundleId(BUNDLE_ID)
 140                         .setFlags(BUNDLE_FLAGS)
 141                         .setType(BundleControlType.ONFBCTOPENREQUEST)
 142                         .build();
 143
 144                 final ControlBundleInput commitBundleInput = new ControlBundleInputBuilder()
 145                         .setNode(nodeRef)
 146                         .setBundleId(BUNDLE_ID)
 147                         .setFlags(BUNDLE_FLAGS)
 148                         .setType(BundleControlType.ONFBCTCOMMITREQUEST)
 149                         .build();
 150
 151                 final List<Message> innerMessages = createMessages(nodeRef);
 152                 final Messages messages = new MessagesBuilder().setMessage(innerMessages).build();
 153                 final AddBundleMessagesInput addBundleMessagesInput = new AddBundleMessagesInputBuilder()
 154                         .setNode(nodeRef)
 155                         .setBundleId(BUNDLE_ID)
 156                         .setFlags(BUNDLE_FLAGS)
 157                         .setMessages(messages)
 158                         .build();
 159
 160                 makeCompletableFuture(bundleService.controlBundle(openBundleInput))
 161                     .thenComposeAsync(voidRpcResult -> {
 162                         LOG.debug("Open successful: {}, msg: {}", voidRpcResult.isSuccessful(),
 163                                 voidRpcResult.getErrors());
 164
 165                         final CompletableFuture<RpcResult<AddBundleMessagesOutput>> addFuture =
 166                                 makeCompletableFuture(bundleService.addBundleMessages(addBundleMessagesInput));
 167
 168                         return addFuture;
 169                     }).thenComposeAsync(voidRpcResult -> {
 170                         LOG.debug("AddBundleMessages successful: {}, msg: {}", voidRpcResult.isSuccessful(),
 171                                 voidRpcResult.getErrors());
 172
 173                         final CompletableFuture<RpcResult<ControlBundleOutput>> controlCommitFuture =
 174                                 makeCompletableFuture(bundleService.controlBundle(commitBundleInput));
 175
 176                         return controlCommitFuture;
 177                     }).thenAccept(voidRpcResult -> LOG.debug("Commit successful: {}, msg: {}",
 178                         voidRpcResult.isSuccessful(), voidRpcResult.getErrors()));
 179             }
 180         }
 181     }
 182
 183     private static <T> CompletableFuture<T> makeCompletableFuture(Future<T> future) {
 184         return CompletableFuture.supplyAsync(() -> {
 185             try {
 186                 return future.get();
 187             } catch (InterruptedException | ExecutionException e) {
 188                 throw new RuntimeException(e);
 189             }
 190         }, EXECUTOR);
 191     }
 192
 193     private static List<Message> createMessages(NodeRef nodeRef) {
 194         List<Message> messages  = new ArrayList<>();
 195
 196
 197         messages.add(new MessageBuilder().setNode(nodeRef).setBundleInnerMessage(new BundleAddGroupCaseBuilder()
 198             .setAddGroupCaseData(new AddGroupCaseDataBuilder(createGroup(1L)).build()).build()).build());
 199
 200         messages.add(new MessageBuilder().setNode(nodeRef).setBundleInnerMessage(new BundleAddFlowCaseBuilder()
 201                 .setAddFlowCaseData(new AddFlowCaseDataBuilder(createFlow("42", 1L, 1, (short) 1)).build()).build())
 202                 .build());
 203
 204         messages.add(new MessageBuilder().setNode(nodeRef).setBundleInnerMessage(new BundleAddFlowCaseBuilder()
 205                 .setAddFlowCaseData(new AddFlowCaseDataBuilder(createFlow("43", 1L, 2, (short) 2)).build()).build())
 206                 .build());
 207
 208         LOG.debug("createMessages() passing {}", messages);
 209
 210         return messages;
 211     }
 212
 213     private static Flow createFlow(String flowId, long groupId, int priority, short tableId) {
 214         MatchBuilder matchBuilder = new MatchBuilder();
 215         matchBuilder.setEthernetMatch(new EthernetMatchBuilder()
 216                 .setEthernetType(new EthernetTypeBuilder()
 217                         .setType(new EtherType(2048L)).build()).build());
 218
 219         FlowBuilder flowBuilder = new FlowBuilder();
 220         flowBuilder.setMatch(matchBuilder.build());
 221         flowBuilder.setInstructions(createGroupInstructions(groupId).build());
 222         flowBuilder.setPriority(priority);
 223         flowBuilder.setCookie(new FlowCookie(new BigInteger(flowId + "" + priority)));
 224
 225         FlowKey key = new FlowKey(new FlowId(flowId));
 226         flowBuilder.setHardTimeout(0);
 227         flowBuilder.setIdleTimeout(0);
 228         flowBuilder.setStrict(false);
 229         flowBuilder.setContainerName(null);
 230         flowBuilder.setId(new FlowId(flowId));
 231         flowBuilder.setTableId(tableId);
 232         flowBuilder.withKey(key);
 233         flowBuilder.setFlowName("FlowWithGroupInstruction");
 234
 235         return flowBuilder.build();
 236     }
 237
 238     private static Group createGroup(long groupId) {
 239         GroupBuilder groupBuilder = new GroupBuilder();
 240         GroupKey groupKey = new GroupKey(new GroupId(groupId));
 241         groupBuilder.withKey(groupKey);
 242         groupBuilder.setGroupId(groupKey.getGroupId());
 243         groupBuilder.setBarrier(false);
 244         groupBuilder.setGroupName("Foo");
 245         groupBuilder.setContainerName(null);
 246         groupBuilder.setGroupType(GroupTypes.GroupAll);
 247         groupBuilder.setBuckets(createBuckets().build());
 248
 249         return groupBuilder.build();
 250     }
 251
 252     private static BucketsBuilder createBuckets() {
 253         List<Action> actionList = new ArrayList<>();
 254
 255         actionList.add(new ActionBuilder()
 256                 .setOrder(0)
 257                 .setAction(new PopVlanActionCaseBuilder()
 258                         .setPopVlanAction(new PopVlanActionBuilder().build())
 259                         .build()).build());
 260
 261         BucketBuilder bucketBuilder = new BucketBuilder();
 262         bucketBuilder.setBucketId(new BucketId(12L));
 263         bucketBuilder.setAction(actionList);
 264
 265         List<Bucket> bucketList = new ArrayList<>();
 266         bucketList.add(bucketBuilder.build());
 267
 268         actionList = new ArrayList<>();
 269         SetFieldCaseBuilder setFieldCaseBuilder = new SetFieldCaseBuilder();
 270         setFieldCaseBuilder.setSetField(new SetFieldBuilder()
 271                 .setLayer3Match(new Ipv4MatchBuilder()
 272                         .setIpv4Source(new Ipv4Prefix("10.0.1.0/32"))
 273                         .build())
 274                 .build());
 275
 276         actionList.add(new ActionBuilder()
 277                 .setAction(setFieldCaseBuilder.build())
 278                 .setOrder(0)
 279                 .build());
 280
 281         setFieldCaseBuilder = new SetFieldCaseBuilder();
 282         setFieldCaseBuilder.setSetField(new SetFieldBuilder()
 283                 .setLayer3Match(new Ipv4MatchBuilder()
 284                         .setIpv4Destination(new Ipv4Prefix("10.0.10.0/32"))
 285                         .build())
 286                 .build());
 287
 288         actionList.add(new ActionBuilder()
 289                 .setAction(setFieldCaseBuilder.build())
 290                 .setOrder(0)
 291                 .build());
 292
 293         bucketBuilder = new BucketBuilder();
 294         bucketBuilder.setBucketId(new BucketId(13L));
 295         bucketBuilder.setAction(actionList);
 296
 297         bucketList.add(bucketBuilder.build());
 298
 299         BucketsBuilder bucketsBuilder = new BucketsBuilder();
 300         bucketsBuilder.setBucket(bucketList);
 301
 302         return bucketsBuilder;
 303     }
 304
 305     private static InstructionsBuilder createGroupInstructions(long groupId) {
 306         ActionBuilder actionBuilder = new ActionBuilder();
 307
 308         GroupActionBuilder groupActionBuilder = new GroupActionBuilder();
 309         groupActionBuilder.setGroupId(groupId);
 310
 311         actionBuilder.setAction(new GroupActionCaseBuilder().setGroupAction(groupActionBuilder.build()).build());
 312         actionBuilder.setOrder(1);
 313         actionBuilder.withKey(new ActionKey(0));
 314         List<Action> actionList = new ArrayList<>();
 315         actionList.add(actionBuilder.build());
 316
 317         ApplyActionsBuilder applyActionsBuilder = new ApplyActionsBuilder();
 318         applyActionsBuilder.setAction(actionList);
 319
 320         InstructionBuilder instructionBuilder = new InstructionBuilder();
 321         instructionBuilder.setInstruction(new ApplyActionsCaseBuilder()
 322                 .setApplyActions(applyActionsBuilder.build()).build());
 323         instructionBuilder.setOrder(0);
 324         instructionBuilder.withKey(new InstructionKey(0));
 325
 326         InstructionsBuilder instructionsBuilder = new InstructionsBuilder();
 327         List<Instruction> instructions = new ArrayList<>();
 328         instructions.add(instructionBuilder.build());
 329         instructionsBuilder.setInstruction(instructions);
 330
 331         return instructionsBuilder;
 332     }
 333 }