2 * Copyright (c) 2014, 2017 Cisco Systems, Inc. and others. All rights reserved.
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
9 package org.opendaylight.openflowplugin.applications.frm.impl;
11 import com.google.common.base.Optional;
12 import com.google.common.base.Preconditions;
13 import com.google.common.collect.Lists;
14 import com.google.common.util.concurrent.FutureCallback;
15 import com.google.common.util.concurrent.Futures;
16 import com.google.common.util.concurrent.JdkFutureAdapters;
17 import com.google.common.util.concurrent.ListenableFuture;
18 import com.google.common.util.concurrent.MoreExecutors;
19 import java.math.BigInteger;
20 import java.util.ArrayList;
21 import java.util.Collection;
22 import java.util.Collections;
23 import java.util.HashMap;
24 import java.util.List;
25 import java.util.ListIterator;
27 import java.util.concurrent.Callable;
28 import java.util.concurrent.ExecutionException;
29 import java.util.concurrent.ExecutorService;
30 import java.util.concurrent.Executors;
31 import java.util.concurrent.TimeUnit;
32 import java.util.concurrent.TimeoutException;
33 import java.util.concurrent.atomic.AtomicLong;
34 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
35 import org.opendaylight.controller.md.sal.binding.api.ReadOnlyTransaction;
36 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
37 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
38 import org.opendaylight.openflowplugin.api.OFConstants;
39 import org.opendaylight.openflowplugin.api.openflow.device.DeviceInfo;
40 import org.opendaylight.openflowplugin.applications.frm.FlowNodeReconciliation;
41 import org.opendaylight.openflowplugin.applications.frm.ForwardingRulesManager;
42 import org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.action.GroupActionCase;
43 import org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.action.OutputActionCase;
44 import org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.list.Action;
45 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNode;
46 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowId;
47 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.meters.Meter;
48 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.meters.MeterBuilder;
49 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.meters.MeterKey;
50 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.meters.StaleMeter;
51 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.meters.StaleMeterKey;
52 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.Table;
53 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.TableKey;
54 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.Flow;
55 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.FlowBuilder;
56 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.FlowKey;
57 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.StaleFlow;
58 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.StaleFlowKey;
59 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.GroupId;
60 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.GroupTypes;
61 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.group.Buckets;
62 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.group.buckets.Bucket;
63 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.groups.Group;
64 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.groups.GroupBuilder;
65 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.groups.GroupKey;
66 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.groups.StaleGroup;
67 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.groups.StaleGroupKey;
68 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId;
69 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef;
70 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
71 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.MeterId;
72 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.bundle.service.rev170124.AddBundleMessagesInput;
73 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.bundle.service.rev170124.AddBundleMessagesInputBuilder;
74 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.bundle.service.rev170124.AddBundleMessagesOutput;
75 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.bundle.service.rev170124.ControlBundleInput;
76 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.bundle.service.rev170124.ControlBundleInputBuilder;
77 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.bundle.service.rev170124.ControlBundleOutput;
78 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.bundle.service.rev170124.SalBundleService;
79 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.bundle.service.rev170124.add.bundle.messages.input.Messages;
80 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.bundle.service.rev170124.add.bundle.messages.input.MessagesBuilder;
81 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.bundle.service.rev170124.add.bundle.messages.input.messages.Message;
82 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.bundle.service.rev170124.add.bundle.messages.input.messages.MessageBuilder;
83 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.bundle.service.rev170124.bundle.inner.message.grouping.bundle.inner.message.BundleAddFlowCaseBuilder;
84 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.bundle.service.rev170124.bundle.inner.message.grouping.bundle.inner.message.BundleAddGroupCaseBuilder;
85 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.bundle.service.rev170124.bundle.inner.message.grouping.bundle.inner.message.BundleRemoveFlowCaseBuilder;
86 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.bundle.service.rev170124.bundle.inner.message.grouping.bundle.inner.message.BundleRemoveGroupCaseBuilder;
87 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;
88 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;
89 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.bundle.service.rev170124.bundle.inner.message.grouping.bundle.inner.message.bundle.remove.flow._case.RemoveFlowCaseDataBuilder;
90 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.bundle.service.rev170124.bundle.inner.message.grouping.bundle.inner.message.bundle.remove.group._case.RemoveGroupCaseDataBuilder;
91 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.rev170124.BundleControlType;
92 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.rev170124.BundleFlags;
93 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.rev170124.BundleId;
94 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.rf.state.rev170713.ResultState;
95 import org.opendaylight.yang.gen.v1.urn.opendaylight.table.types.rev131026.table.features.TableFeatures;
96 import org.opendaylight.yang.gen.v1.urn.opendaylight.table.types.rev131026.table.features.TableFeaturesKey;
97 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
98 import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
99 import org.opendaylight.yangtools.yang.common.RpcResult;
100 import org.slf4j.Logger;
101 import org.slf4j.LoggerFactory;
104 * Default implementation of {@link ForwardingRulesManager}.
106 * @author <a href="mailto:vdemcak@cisco.com">Vaclav Demcak</a>
108 public class FlowNodeReconciliationImpl implements FlowNodeReconciliation {
110 private static final Logger LOG = LoggerFactory.getLogger(FlowNodeReconciliationImpl.class);
112 // The number of nanoseconds to wait for a single group to be added.
113 private static final long ADD_GROUP_TIMEOUT = TimeUnit.SECONDS.toNanos(3);
115 // The maximum number of nanoseconds to wait for completion of add-group RPCs.
116 private static final long MAX_ADD_GROUP_TIMEOUT = TimeUnit.SECONDS.toNanos(20);
117 private static final String SEPARATOR = ":";
118 private static final int THREAD_POOL_SIZE = 4;
120 private final DataBroker dataBroker;
121 private final ForwardingRulesManager provider;
122 private final String serviceName;
123 private final int priority;
124 private final ResultState resultState;
125 private final Map<DeviceInfo, ListenableFuture<Boolean>> futureMap = new HashMap<>();
127 private final ExecutorService executor = Executors.newFixedThreadPool(THREAD_POOL_SIZE);
129 private final SalBundleService salBundleService;
131 private static final AtomicLong BUNDLE_ID = new AtomicLong();
132 private static final BundleFlags BUNDLE_FLAGS = new BundleFlags(true, true);
134 public FlowNodeReconciliationImpl(final ForwardingRulesManager manager, final DataBroker db,
135 final String serviceName, final int priority, final ResultState resultState) {
136 this.provider = Preconditions.checkNotNull(manager, "ForwardingRulesManager can not be null!");
137 dataBroker = Preconditions.checkNotNull(db, "DataBroker can not be null!");
138 this.serviceName = serviceName;
139 this.priority = priority;
140 this.resultState = resultState;
141 salBundleService = Preconditions.checkNotNull(manager.getSalBundleService(),
142 "salBundleService can not be null!");
146 public void close() {
147 if (executor != null) {
148 executor.shutdownNow();
153 public ListenableFuture<Boolean> reconcileConfiguration(InstanceIdentifier<FlowCapableNode> connectedNode) {
154 LOG.info("Triggering reconciliation for device {}", connectedNode.firstKeyOf(Node.class));
155 if (provider.isStaleMarkingEnabled()) {
156 LOG.info("Stale-Marking is ENABLED and proceeding with deletion of " + "stale-marked entities on switch {}",
157 connectedNode.toString());
158 reconciliationPreProcess(connectedNode);
160 if (provider.isBundleBasedReconciliationEnabled()) {
161 BundleBasedReconciliationTask bundleBasedReconTask = new BundleBasedReconciliationTask(connectedNode);
162 return JdkFutureAdapters.listenInPoolThread(executor.submit(bundleBasedReconTask));
164 ReconciliationTask reconciliationTask = new ReconciliationTask(connectedNode);
165 return JdkFutureAdapters.listenInPoolThread(executor.submit(reconciliationTask));
169 private class BundleBasedReconciliationTask implements Callable<Boolean> {
170 final InstanceIdentifier<FlowCapableNode> nodeIdentity;
172 BundleBasedReconciliationTask(final InstanceIdentifier<FlowCapableNode> nodeIdent) {
173 nodeIdentity = nodeIdent;
177 public Boolean call() {
178 String node = nodeIdentity.firstKeyOf(Node.class).getId().getValue();
179 Optional<FlowCapableNode> flowNode = Optional.absent();
180 BundleId bundleIdValue = new BundleId(BUNDLE_ID.getAndIncrement());
181 BigInteger dpnId = getDpnIdFromNodeName(node);
182 LOG.info("Triggering bundle based reconciliation for device : {}", dpnId);
183 ReadOnlyTransaction trans = provider.getReadTranaction();
185 flowNode = trans.read(LogicalDatastoreType.CONFIGURATION, nodeIdentity).get();
186 } catch (ExecutionException | InterruptedException e) {
187 LOG.error("Error occurred while reading the configuration data store for node {}", nodeIdentity, e);
190 if (flowNode.isPresent()) {
191 LOG.debug("FlowNode present for Datapath ID {}", dpnId);
192 final NodeRef nodeRef = new NodeRef(nodeIdentity.firstIdentifierOf(Node.class));
194 final ControlBundleInput closeBundleInput = new ControlBundleInputBuilder().setNode(nodeRef)
195 .setBundleId(bundleIdValue).setFlags(BUNDLE_FLAGS)
196 .setType(BundleControlType.ONFBCTCLOSEREQUEST).build();
198 final ControlBundleInput openBundleInput = new ControlBundleInputBuilder().setNode(nodeRef)
199 .setBundleId(bundleIdValue).setFlags(BUNDLE_FLAGS).setType(BundleControlType.ONFBCTOPENREQUEST)
202 final ControlBundleInput commitBundleInput = new ControlBundleInputBuilder().setNode(nodeRef)
203 .setBundleId(bundleIdValue).setFlags(BUNDLE_FLAGS)
204 .setType(BundleControlType.ONFBCTCOMMITREQUEST).build();
206 final AddBundleMessagesInput addBundleMessagesInput = new AddBundleMessagesInputBuilder()
207 .setNode(nodeRef).setBundleId(bundleIdValue).setFlags(BUNDLE_FLAGS)
208 .setMessages(createMessages(nodeRef, flowNode)).build();
210 /* Close previously opened bundle on the openflow switch if any */
211 ListenableFuture<RpcResult<ControlBundleOutput>> closeBundle
212 = salBundleService.controlBundle(closeBundleInput);
214 /* Open a new bundle on the switch */
215 ListenableFuture<RpcResult<ControlBundleOutput>> openBundle =
216 Futures.transformAsync(closeBundle,
217 rpcResult -> salBundleService.controlBundle(openBundleInput),
218 MoreExecutors.directExecutor());
220 /* Push groups and flows via bundle add messages */
221 ListenableFuture<RpcResult<AddBundleMessagesOutput>> addBundleMessagesFuture
222 = Futures.transformAsync(openBundle, rpcResult -> {
223 if (rpcResult.isSuccessful()) {
224 return salBundleService.addBundleMessages(addBundleMessagesInput);
226 return Futures.immediateFuture(null);
227 }, MoreExecutors.directExecutor());
229 /* Commit the bundle on the openflow switch */
230 ListenableFuture<RpcResult<ControlBundleOutput>> commitBundleFuture
231 = Futures.transformAsync(addBundleMessagesFuture, rpcResult -> {
232 if (rpcResult.isSuccessful()) {
233 return salBundleService.controlBundle(commitBundleInput);
235 return Futures.immediateFuture(null);
236 }, MoreExecutors.directExecutor());
238 /* Bundles not supported for meters */
239 List<Meter> meters = flowNode.get().getMeter() != null ? flowNode.get().getMeter()
240 : Collections.emptyList();
241 Futures.transformAsync(commitBundleFuture,
243 if (rpcResult.isSuccessful()) {
244 for (Meter meter : meters) {
245 final KeyedInstanceIdentifier<Meter, MeterKey> meterIdent = nodeIdentity
246 .child(Meter.class, meter.key());
247 provider.getMeterCommiter().add(meterIdent, meter, nodeIdentity);
250 return Futures.immediateFuture(null);
251 }, MoreExecutors.directExecutor());
255 if (commitBundleFuture.get().isSuccessful()) {
256 LOG.debug("Completing bundle based reconciliation for device ID:{}", dpnId);
261 } catch (InterruptedException | ExecutionException e) {
262 LOG.error("Error while doing bundle based reconciliation for device ID:{}", nodeIdentity);
266 LOG.error("FlowNode not present for Datapath ID {}", dpnId);
272 public ListenableFuture<Boolean> startReconciliation(DeviceInfo node) {
273 InstanceIdentifier<FlowCapableNode> connectedNode = node.getNodeInstanceIdentifier()
274 .augmentation(FlowCapableNode.class);
275 // Clearing the group registry cache for the connected node if exists
276 provider.getDevicesGroupRegistry().clearNodeGroups(node.getNodeId());
277 return futureMap.computeIfAbsent(node, future -> reconcileConfiguration(connectedNode));
281 public ListenableFuture<Boolean> endReconciliation(DeviceInfo node) {
282 futureMap.computeIfPresent(node, (key, future) -> future).cancel(true);
283 futureMap.remove(node);
284 return Futures.immediateFuture(true);
288 public int getPriority() {
293 public String getName() {
298 public ResultState getResultState() {
302 private class ReconciliationTask implements Callable<Boolean> {
304 InstanceIdentifier<FlowCapableNode> nodeIdentity;
306 ReconciliationTask(final InstanceIdentifier<FlowCapableNode> nodeIdent) {
307 nodeIdentity = nodeIdent;
311 public Boolean call() {
312 String node = nodeIdentity.firstKeyOf(Node.class).getId().getValue();
313 BigInteger dpnId = getDpnIdFromNodeName(node);
315 ReadOnlyTransaction trans = provider.getReadTranaction();
316 Optional<FlowCapableNode> flowNode;
317 // initialize the counter
320 flowNode = trans.read(LogicalDatastoreType.CONFIGURATION, nodeIdentity).get();
321 } catch (ExecutionException | InterruptedException e) {
322 LOG.warn("Fail with read Config/DS for Node {} !", nodeIdentity, e);
326 if (flowNode.isPresent()) {
327 /* Tables - have to be pushed before groups */
328 // CHECK if while pushing the update, updateTableInput can be null to emulate a
330 List<TableFeatures> tableList = flowNode.get().getTableFeatures() != null
331 ? flowNode.get().getTableFeatures()
332 : Collections.<TableFeatures>emptyList();
333 for (TableFeatures tableFeaturesItem : tableList) {
334 TableFeaturesKey tableKey = tableFeaturesItem.key();
335 KeyedInstanceIdentifier<TableFeatures, TableFeaturesKey> tableFeaturesII = nodeIdentity
336 .child(TableFeatures.class, new TableFeaturesKey(tableKey.getTableId()));
337 provider.getTableFeaturesCommiter().update(tableFeaturesII, tableFeaturesItem, null, nodeIdentity);
340 /* Groups - have to be first */
341 List<Group> groups = flowNode.get().getGroup() != null ? flowNode.get().getGroup()
342 : Collections.<Group>emptyList();
343 List<Group> toBeInstalledGroups = new ArrayList<>();
344 toBeInstalledGroups.addAll(groups);
345 // new list for suspected groups pointing to ports .. when the ports come up
347 List<Group> suspectedGroups = new ArrayList<>();
348 Map<Long, ListenableFuture<?>> groupFutures = new HashMap<>();
350 while ((!toBeInstalledGroups.isEmpty() || !suspectedGroups.isEmpty())
351 && counter <= provider.getReconciliationRetryCount()) { // also check if the counter has not
352 // crossed the threshold
354 if (toBeInstalledGroups.isEmpty() && !suspectedGroups.isEmpty()) {
355 LOG.debug("These Groups are pointing to node-connectors that are not up yet {}",
356 suspectedGroups.toString());
357 toBeInstalledGroups.addAll(suspectedGroups);
361 ListIterator<Group> iterator = toBeInstalledGroups.listIterator();
362 while (iterator.hasNext()) {
363 Group group = iterator.next();
364 boolean okToInstall = true;
365 Buckets buckets = group.getBuckets();
366 List<Bucket> bucketList = buckets == null ? null : buckets.getBucket();
367 if (bucketList == null) {
368 bucketList = Collections.<Bucket>emptyList();
370 for (Bucket bucket : bucketList) {
371 List<Action> actions = bucket.getAction();
372 if (actions == null) {
373 actions = Collections.<Action>emptyList();
375 for (Action action : actions) {
377 if (action.getAction().getImplementedInterface().getName()
378 .equals("org.opendaylight.yang.gen.v1.urn.opendaylight"
379 + ".action.types.rev131112.action.action.OutputActionCase")) {
380 String nodeConnectorUri = ((OutputActionCase) action.getAction()).getOutputAction()
381 .getOutputNodeConnector().getValue();
383 LOG.debug("Installing the group for node connector {}", nodeConnectorUri);
385 // check if the nodeconnector is there in the multimap
386 boolean isPresent = provider.getFlowNodeConnectorInventoryTranslatorImpl()
387 .isNodeConnectorUpdated(dpnId, nodeConnectorUri);
388 // if yes set okToInstall = true
393 // else put it in a different list and still set okToInstall = true
394 suspectedGroups.add(group);
396 "Not yet received the node-connector updated for {} "
397 + "for the group with id {}",
398 nodeConnectorUri, group.getGroupId().toString());
401 } else if (action.getAction().getImplementedInterface().getName()
402 .equals("org.opendaylight.yang.gen.v1.urn.opendaylight"
403 + ".action.types.rev131112.action.action.GroupActionCase")) {
405 Long groupId = ((GroupActionCase) action.getAction()).getGroupAction().getGroupId();
406 ListenableFuture<?> future = groupFutures.get(groupId);
407 if (future == null) {
411 // Need to ensure that the group specified
412 // by group-action is already installed.
413 awaitGroup(node, future);
417 // increment retry counter value
423 addGroup(groupFutures, group);
425 // resetting the counter to zero
431 /* installation of suspected groups */
432 if (!toBeInstalledGroups.isEmpty()) {
433 for (Group group : toBeInstalledGroups) {
435 "Installing the group {} finally although "
436 + "the port is not up after checking for {} times ",
437 group.getGroupId().toString(), provider.getReconciliationRetryCount());
438 addGroup(groupFutures, group);
442 List<Meter> meters = flowNode.get().getMeter() != null ? flowNode.get().getMeter()
443 : Collections.<Meter>emptyList();
444 for (Meter meter : meters) {
445 final KeyedInstanceIdentifier<Meter, MeterKey> meterIdent = nodeIdentity.child(Meter.class,
447 provider.getMeterCommiter().add(meterIdent, meter, nodeIdentity);
450 // Need to wait for all groups to be installed before adding
452 awaitGroups(node, groupFutures.values());
455 List<Table> tables = flowNode.get().getTable() != null ? flowNode.get().getTable()
456 : Collections.<Table>emptyList();
457 for (Table table : tables) {
458 final KeyedInstanceIdentifier<Table, TableKey> tableIdent = nodeIdentity.child(Table.class,
460 List<Flow> flows = table.getFlow() != null ? table.getFlow() : Collections.<Flow>emptyList();
461 for (Flow flow : flows) {
462 final KeyedInstanceIdentifier<Flow, FlowKey> flowIdent = tableIdent.child(Flow.class,
464 provider.getFlowCommiter().add(flowIdent, flow, nodeIdentity);
468 /* clean transaction */
474 * Invoke add-group RPC, and put listenable future associated with the RPC into
478 * The map to store listenable futures associated with add-group RPC.
482 private void addGroup(Map<Long, ListenableFuture<?>> map, Group group) {
483 KeyedInstanceIdentifier<Group, GroupKey> groupIdent = nodeIdentity.child(Group.class, group.key());
484 final Long groupId = group.getGroupId().getValue();
485 ListenableFuture<?> future = JdkFutureAdapters
486 .listenInPoolThread(provider.getGroupCommiter().add(groupIdent, group, nodeIdentity));
488 Futures.addCallback(future, new FutureCallback<Object>() {
490 public void onSuccess(Object result) {
491 if (LOG.isTraceEnabled()) {
492 LOG.trace("add-group RPC completed: node={}, id={}",
493 nodeIdentity.firstKeyOf(Node.class).getId().getValue(), groupId);
498 public void onFailure(Throwable cause) {
499 String msg = "add-group RPC failed: node=" + nodeIdentity.firstKeyOf(Node.class).getId().getValue()
501 LOG.debug(msg, cause);
503 }, MoreExecutors.directExecutor());
505 map.put(groupId, future);
509 * Wait for completion of add-group RPC.
512 * The identifier for the target node.
514 * Future associated with add-group RPC that installs the target
517 private void awaitGroup(String nodeId, ListenableFuture<?> future) {
518 awaitGroups(nodeId, Collections.singleton(future));
522 * Wait for completion of add-group RPCs.
525 * The identifier for the target node.
527 * A collection of futures associated with add-group RPCs.
529 private void awaitGroups(String nodeId, Collection<ListenableFuture<?>> futures) {
530 if (!futures.isEmpty()) {
531 long timeout = Math.min(ADD_GROUP_TIMEOUT * futures.size(), MAX_ADD_GROUP_TIMEOUT);
533 Futures.successfulAsList(futures).get(timeout, TimeUnit.NANOSECONDS);
534 LOG.trace("awaitGroups() completed: node={}", nodeId);
535 } catch (TimeoutException | InterruptedException | ExecutionException e) {
536 LOG.debug("add-group RPCs did not complete: node={}", nodeId);
542 private BigInteger getDpnIdFromNodeName(String nodeName) {
544 String dpId = nodeName.substring(nodeName.lastIndexOf(SEPARATOR) + 1);
545 return new BigInteger(dpId);
548 private void reconciliationPreProcess(final InstanceIdentifier<FlowCapableNode> nodeIdent) {
549 List<InstanceIdentifier<StaleFlow>> staleFlowsToBeBulkDeleted = Lists.newArrayList();
550 List<InstanceIdentifier<StaleGroup>> staleGroupsToBeBulkDeleted = Lists.newArrayList();
551 List<InstanceIdentifier<StaleMeter>> staleMetersToBeBulkDeleted = Lists.newArrayList();
553 ReadOnlyTransaction trans = provider.getReadTranaction();
554 Optional<FlowCapableNode> flowNode = Optional.absent();
557 flowNode = trans.read(LogicalDatastoreType.CONFIGURATION, nodeIdent).get();
558 } catch (ExecutionException | InterruptedException e) {
559 LOG.warn("Reconciliation Pre-Processing Fail with read Config/DS for Node {} !", nodeIdent, e);
562 if (flowNode.isPresent()) {
564 LOG.debug("Proceeding with deletion of stale-marked Flows on switch {} using Openflow interface",
565 nodeIdent.toString());
566 /* Stale-Flows - Stale-marked Flows have to be removed first for safety */
567 List<Table> tables = flowNode.get().getTable() != null ? flowNode.get().getTable()
568 : Collections.<Table>emptyList();
569 for (Table table : tables) {
570 final KeyedInstanceIdentifier<Table, TableKey> tableIdent = nodeIdent.child(Table.class,
572 List<StaleFlow> staleFlows = table.getStaleFlow() != null ? table.getStaleFlow()
573 : Collections.<StaleFlow>emptyList();
574 for (StaleFlow staleFlow : staleFlows) {
576 FlowBuilder flowBuilder = new FlowBuilder(staleFlow);
577 Flow toBeDeletedFlow = flowBuilder.setId(staleFlow.getId()).build();
579 final KeyedInstanceIdentifier<Flow, FlowKey> flowIdent = tableIdent.child(Flow.class,
580 toBeDeletedFlow.key());
582 this.provider.getFlowCommiter().remove(flowIdent, toBeDeletedFlow, nodeIdent);
584 staleFlowsToBeBulkDeleted.add(getStaleFlowInstanceIdentifier(staleFlow, nodeIdent));
588 LOG.debug("Proceeding with deletion of stale-marked Groups for switch {} using Openflow interface",
589 nodeIdent.toString());
591 // TODO: Should we collate the futures of RPC-calls to be sure that groups are
592 // Flows are fully deleted
593 // before attempting to delete groups - just in case there are references
595 /* Stale-marked Groups - Can be deleted after flows */
596 List<StaleGroup> staleGroups = flowNode.get().getStaleGroup() != null ? flowNode.get().getStaleGroup()
597 : Collections.<StaleGroup>emptyList();
598 for (StaleGroup staleGroup : staleGroups) {
600 GroupBuilder groupBuilder = new GroupBuilder(staleGroup);
601 Group toBeDeletedGroup = groupBuilder.setGroupId(staleGroup.getGroupId()).build();
603 final KeyedInstanceIdentifier<Group, GroupKey> groupIdent = nodeIdent.child(Group.class,
604 toBeDeletedGroup.key());
606 this.provider.getGroupCommiter().remove(groupIdent, toBeDeletedGroup, nodeIdent);
608 staleGroupsToBeBulkDeleted.add(getStaleGroupInstanceIdentifier(staleGroup, nodeIdent));
611 LOG.debug("Proceeding with deletion of stale-marked Meters for switch {} using Openflow interface",
612 nodeIdent.toString());
613 /* Stale-marked Meters - can be deleted anytime - so least priority */
614 List<StaleMeter> staleMeters = flowNode.get().getStaleMeter() != null ? flowNode.get().getStaleMeter()
615 : Collections.<StaleMeter>emptyList();
617 for (StaleMeter staleMeter : staleMeters) {
619 MeterBuilder meterBuilder = new MeterBuilder(staleMeter);
620 Meter toBeDeletedMeter = meterBuilder.setMeterId(staleMeter.getMeterId()).build();
622 final KeyedInstanceIdentifier<Meter, MeterKey> meterIdent = nodeIdent.child(Meter.class,
623 toBeDeletedMeter.key());
625 this.provider.getMeterCommiter().remove(meterIdent, toBeDeletedMeter, nodeIdent);
627 staleMetersToBeBulkDeleted.add(getStaleMeterInstanceIdentifier(staleMeter, nodeIdent));
631 /* clean transaction */
634 LOG.debug("Deleting all stale-marked flows/groups/meters of for switch {} in Configuration DS",
635 nodeIdent.toString());
636 // Now, do the bulk deletions
637 deleteDSStaleFlows(staleFlowsToBeBulkDeleted);
638 deleteDSStaleGroups(staleGroupsToBeBulkDeleted);
639 deleteDSStaleMeters(staleMetersToBeBulkDeleted);
642 private void deleteDSStaleFlows(List<InstanceIdentifier<StaleFlow>> flowsForBulkDelete) {
643 WriteTransaction writeTransaction = dataBroker.newWriteOnlyTransaction();
645 for (InstanceIdentifier<StaleFlow> staleFlowIId : flowsForBulkDelete) {
646 writeTransaction.delete(LogicalDatastoreType.CONFIGURATION, staleFlowIId);
649 ListenableFuture<Void> submitFuture = writeTransaction.submit();
650 handleStaleEntityDeletionResultFuture(submitFuture);
653 private void deleteDSStaleGroups(List<InstanceIdentifier<StaleGroup>> groupsForBulkDelete) {
654 WriteTransaction writeTransaction = dataBroker.newWriteOnlyTransaction();
656 for (InstanceIdentifier<StaleGroup> staleGroupIId : groupsForBulkDelete) {
657 writeTransaction.delete(LogicalDatastoreType.CONFIGURATION, staleGroupIId);
660 ListenableFuture<Void> submitFuture = writeTransaction.submit();
661 handleStaleEntityDeletionResultFuture(submitFuture);
664 private void deleteDSStaleMeters(List<InstanceIdentifier<StaleMeter>> metersForBulkDelete) {
665 WriteTransaction writeTransaction = dataBroker.newWriteOnlyTransaction();
667 for (InstanceIdentifier<StaleMeter> staleMeterIId : metersForBulkDelete) {
668 writeTransaction.delete(LogicalDatastoreType.CONFIGURATION, staleMeterIId);
671 ListenableFuture<Void> submitFuture = writeTransaction.submit();
672 handleStaleEntityDeletionResultFuture(submitFuture);
675 private InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight
676 .flow.inventory.rev130819.tables.table.StaleFlow> getStaleFlowInstanceIdentifier(
677 StaleFlow staleFlow, InstanceIdentifier<FlowCapableNode> nodeIdent) {
678 return nodeIdent.child(Table.class, new TableKey(staleFlow.getTableId())).child(
679 org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.StaleFlow.class,
680 new StaleFlowKey(new FlowId(staleFlow.getId())));
683 private InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight
684 .group.types.rev131018.groups.StaleGroup> getStaleGroupInstanceIdentifier(
685 StaleGroup staleGroup, InstanceIdentifier<FlowCapableNode> nodeIdent) {
686 return nodeIdent.child(StaleGroup.class, new StaleGroupKey(new GroupId(staleGroup.getGroupId())));
689 private InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight
690 .flow.inventory.rev130819.meters.StaleMeter> getStaleMeterInstanceIdentifier(
691 StaleMeter staleMeter, InstanceIdentifier<FlowCapableNode> nodeIdent) {
692 return nodeIdent.child(StaleMeter.class, new StaleMeterKey(new MeterId(staleMeter.getMeterId())));
695 private void handleStaleEntityDeletionResultFuture(ListenableFuture<Void> submitFuture) {
696 Futures.addCallback(submitFuture, new FutureCallback<Void>() {
698 public void onSuccess(Void result) {
699 LOG.debug("Stale entity removal success");
703 public void onFailure(Throwable throwable) {
704 LOG.debug("Stale entity removal failed {}", throwable);
706 }, MoreExecutors.directExecutor());
709 private Flow getDeleteAllFlow() {
710 final FlowBuilder flowBuilder = new FlowBuilder();
711 flowBuilder.setTableId(OFConstants.OFPTT_ALL);
712 return flowBuilder.build();
715 private Group getDeleteAllGroup() {
716 final GroupBuilder groupBuilder = new GroupBuilder();
717 groupBuilder.setGroupType(GroupTypes.GroupAll);
718 groupBuilder.setGroupId(new GroupId(OFConstants.OFPG_ALL));
719 return groupBuilder.build();
722 private Messages createMessages(final NodeRef nodeRef, final Optional<FlowCapableNode> flowNode) {
723 final List<Message> messages = new ArrayList<>();
724 messages.add(new MessageBuilder().setNode(nodeRef)
725 .setBundleInnerMessage(new BundleRemoveFlowCaseBuilder()
726 .setRemoveFlowCaseData(new RemoveFlowCaseDataBuilder(getDeleteAllFlow()).build()).build())
729 messages.add(new MessageBuilder().setNode(nodeRef)
730 .setBundleInnerMessage(new BundleRemoveGroupCaseBuilder()
731 .setRemoveGroupCaseData(new RemoveGroupCaseDataBuilder(getDeleteAllGroup()).build()).build())
734 if (flowNode.get().getGroup() != null) {
735 for (Group gr : flowNode.get().getGroup()) {
736 NodeId nodeId = nodeRef.getValue().firstKeyOf(Node.class).getId();
737 provider.getDevicesGroupRegistry().storeGroup(nodeId,gr.getGroupId().getValue());
738 messages.add(new MessageBuilder().setNode(nodeRef).setBundleInnerMessage(new BundleAddGroupCaseBuilder()
739 .setAddGroupCaseData(new AddGroupCaseDataBuilder(gr).build()).build()).build());
743 if (flowNode.get().getTable() != null) {
744 for (Table table : flowNode.get().getTable()) {
745 for (Flow flow : table.getFlow()) {
747 new MessageBuilder().setNode(nodeRef)
748 .setBundleInnerMessage(new BundleAddFlowCaseBuilder()
749 .setAddFlowCaseData(new AddFlowCaseDataBuilder(flow).build()).build())
755 LOG.debug("The size of the flows and group messages created in createMessage() {}", messages.size());
756 return new MessagesBuilder().setMessage(messages).build();