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.inventory.rev130819.nodes.NodeKey;
72 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.MeterId;
73 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.bundle.service.rev170124.AddBundleMessagesInput;
74 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.bundle.service.rev170124.AddBundleMessagesInputBuilder;
75 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.bundle.service.rev170124.AddBundleMessagesOutput;
76 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.bundle.service.rev170124.ControlBundleInput;
77 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.bundle.service.rev170124.ControlBundleInputBuilder;
78 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.bundle.service.rev170124.ControlBundleOutput;
79 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.bundle.service.rev170124.SalBundleService;
80 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.bundle.service.rev170124.add.bundle.messages.input.Messages;
81 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.bundle.service.rev170124.add.bundle.messages.input.MessagesBuilder;
82 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.bundle.service.rev170124.add.bundle.messages.input.messages.Message;
83 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.bundle.service.rev170124.add.bundle.messages.input.messages.MessageBuilder;
84 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.bundle.service.rev170124.bundle.inner.message.grouping.bundle.inner.message.BundleAddFlowCaseBuilder;
85 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.bundle.service.rev170124.bundle.inner.message.grouping.bundle.inner.message.BundleAddGroupCaseBuilder;
86 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.bundle.service.rev170124.bundle.inner.message.grouping.bundle.inner.message.BundleRemoveFlowCaseBuilder;
87 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.bundle.service.rev170124.bundle.inner.message.grouping.bundle.inner.message.BundleRemoveGroupCaseBuilder;
88 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;
89 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;
90 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;
91 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;
92 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.rev170124.BundleControlType;
93 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.rev170124.BundleFlags;
94 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.rev170124.BundleId;
95 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.rf.state.rev170713.ResultState;
96 import org.opendaylight.yang.gen.v1.urn.opendaylight.table.types.rev131026.table.features.TableFeatures;
97 import org.opendaylight.yang.gen.v1.urn.opendaylight.table.types.rev131026.table.features.TableFeaturesKey;
98 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
99 import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
100 import org.opendaylight.yangtools.yang.common.RpcResult;
101 import org.slf4j.Logger;
102 import org.slf4j.LoggerFactory;
105 * Default implementation of {@link ForwardingRulesManager}.
107 * @author <a href="mailto:vdemcak@cisco.com">Vaclav Demcak</a>
109 public class FlowNodeReconciliationImpl implements FlowNodeReconciliation {
111 private static final Logger LOG = LoggerFactory.getLogger(FlowNodeReconciliationImpl.class);
113 // The number of nanoseconds to wait for a single group to be added.
114 private static final long ADD_GROUP_TIMEOUT = TimeUnit.SECONDS.toNanos(3);
116 // The maximum number of nanoseconds to wait for completion of add-group RPCs.
117 private static final long MAX_ADD_GROUP_TIMEOUT = TimeUnit.SECONDS.toNanos(20);
118 private static final String SEPARATOR = ":";
119 private static final int THREAD_POOL_SIZE = 4;
121 private final DataBroker dataBroker;
122 private final ForwardingRulesManager provider;
123 private final String serviceName;
124 private final int priority;
125 private final ResultState resultState;
126 private final Map<DeviceInfo, ListenableFuture<Boolean>> futureMap = new HashMap<>();
128 private final ExecutorService executor = Executors.newFixedThreadPool(THREAD_POOL_SIZE);
130 private final SalBundleService salBundleService;
132 private static final AtomicLong BUNDLE_ID = new AtomicLong();
133 private static final BundleFlags BUNDLE_FLAGS = new BundleFlags(true, true);
135 public FlowNodeReconciliationImpl(final ForwardingRulesManager manager, final DataBroker db,
136 final String serviceName, final int priority, final ResultState resultState) {
137 this.provider = Preconditions.checkNotNull(manager, "ForwardingRulesManager can not be null!");
138 dataBroker = Preconditions.checkNotNull(db, "DataBroker can not be null!");
139 this.serviceName = serviceName;
140 this.priority = priority;
141 this.resultState = resultState;
142 salBundleService = Preconditions.checkNotNull(manager.getSalBundleService(),
143 "salBundleService can not be null!");
147 public void close() {
148 if (executor != null) {
149 executor.shutdownNow();
154 public ListenableFuture<Boolean> reconcileConfiguration(InstanceIdentifier<FlowCapableNode> connectedNode) {
155 LOG.info("Triggering reconciliation for device {}", connectedNode.firstKeyOf(Node.class));
156 if (provider.isStaleMarkingEnabled()) {
157 LOG.info("Stale-Marking is ENABLED and proceeding with deletion of " + "stale-marked entities on switch {}",
158 connectedNode.toString());
159 reconciliationPreProcess(connectedNode);
161 if (provider.isBundleBasedReconciliationEnabled()) {
162 BundleBasedReconciliationTask bundleBasedReconTask = new BundleBasedReconciliationTask(connectedNode);
163 return JdkFutureAdapters.listenInPoolThread(executor.submit(bundleBasedReconTask));
165 ReconciliationTask reconciliationTask = new ReconciliationTask(connectedNode);
166 return JdkFutureAdapters.listenInPoolThread(executor.submit(reconciliationTask));
170 private class BundleBasedReconciliationTask implements Callable<Boolean> {
171 final InstanceIdentifier<FlowCapableNode> nodeIdentity;
173 BundleBasedReconciliationTask(final InstanceIdentifier<FlowCapableNode> nodeIdent) {
174 nodeIdentity = nodeIdent;
178 public Boolean call() {
179 String node = nodeIdentity.firstKeyOf(Node.class, NodeKey.class).getId().getValue();
180 Optional<FlowCapableNode> flowNode = Optional.absent();
181 BundleId bundleIdValue = new BundleId(BUNDLE_ID.getAndIncrement());
182 BigInteger dpnId = getDpnIdFromNodeName(node);
183 LOG.info("Triggering bundle based reconciliation for device : {}", dpnId);
184 ReadOnlyTransaction trans = provider.getReadTranaction();
186 flowNode = trans.read(LogicalDatastoreType.CONFIGURATION, nodeIdentity).get();
187 } catch (ExecutionException | InterruptedException e) {
188 LOG.error("Error occurred while reading the configuration data store for node {}", nodeIdentity, e);
191 if (flowNode.isPresent()) {
192 LOG.debug("FlowNode present for Datapath ID {}", dpnId);
193 final NodeRef nodeRef = new NodeRef(nodeIdentity.firstIdentifierOf(Node.class));
195 final ControlBundleInput closeBundleInput = new ControlBundleInputBuilder().setNode(nodeRef)
196 .setBundleId(bundleIdValue).setFlags(BUNDLE_FLAGS)
197 .setType(BundleControlType.ONFBCTCLOSEREQUEST).build();
199 final ControlBundleInput openBundleInput = new ControlBundleInputBuilder().setNode(nodeRef)
200 .setBundleId(bundleIdValue).setFlags(BUNDLE_FLAGS).setType(BundleControlType.ONFBCTOPENREQUEST)
203 final ControlBundleInput commitBundleInput = new ControlBundleInputBuilder().setNode(nodeRef)
204 .setBundleId(bundleIdValue).setFlags(BUNDLE_FLAGS)
205 .setType(BundleControlType.ONFBCTCOMMITREQUEST).build();
207 final AddBundleMessagesInput addBundleMessagesInput = new AddBundleMessagesInputBuilder()
208 .setNode(nodeRef).setBundleId(bundleIdValue).setFlags(BUNDLE_FLAGS)
209 .setMessages(createMessages(nodeRef, flowNode)).build();
211 /* Close previously opened bundle on the openflow switch if any */
212 ListenableFuture<RpcResult<ControlBundleOutput>> closeBundle
213 = salBundleService.controlBundle(closeBundleInput);
215 /* Open a new bundle on the switch */
216 ListenableFuture<RpcResult<ControlBundleOutput>> openBundle =
217 Futures.transformAsync(closeBundle,
218 rpcResult -> salBundleService.controlBundle(openBundleInput),
219 MoreExecutors.directExecutor());
221 /* Push groups and flows via bundle add messages */
222 ListenableFuture<RpcResult<AddBundleMessagesOutput>> addBundleMessagesFuture
223 = Futures.transformAsync(openBundle, rpcResult -> {
224 if (rpcResult.isSuccessful()) {
225 return salBundleService.addBundleMessages(addBundleMessagesInput);
227 return Futures.immediateFuture(null);
228 }, MoreExecutors.directExecutor());
230 /* Commit the bundle on the openflow switch */
231 ListenableFuture<RpcResult<ControlBundleOutput>> commitBundleFuture
232 = Futures.transformAsync(addBundleMessagesFuture, rpcResult -> {
233 if (rpcResult.isSuccessful()) {
234 return salBundleService.controlBundle(commitBundleInput);
236 return Futures.immediateFuture(null);
237 }, MoreExecutors.directExecutor());
239 /* Bundles not supported for meters */
240 List<Meter> meters = flowNode.get().getMeter() != null ? flowNode.get().getMeter()
241 : Collections.emptyList();
242 Futures.transformAsync(commitBundleFuture,
244 if (rpcResult.isSuccessful()) {
245 for (Meter meter : meters) {
246 final KeyedInstanceIdentifier<Meter, MeterKey> meterIdent = nodeIdentity
247 .child(Meter.class, meter.key());
248 provider.getMeterCommiter().add(meterIdent, meter, nodeIdentity);
251 return Futures.immediateFuture(null);
252 }, MoreExecutors.directExecutor());
256 if (commitBundleFuture.get().isSuccessful()) {
257 LOG.debug("Completing bundle based reconciliation for device ID:{}", dpnId);
262 } catch (InterruptedException | ExecutionException e) {
263 LOG.error("Error while doing bundle based reconciliation for device ID:{}", nodeIdentity);
267 LOG.error("FlowNode not present for Datapath ID {}", dpnId);
273 public ListenableFuture<Boolean> startReconciliation(DeviceInfo node) {
274 InstanceIdentifier<FlowCapableNode> connectedNode = node.getNodeInstanceIdentifier()
275 .augmentation(FlowCapableNode.class);
276 // Clearing the group registry cache for the connected node if exists
277 provider.getDevicesGroupRegistry().clearNodeGroups(node.getNodeId());
278 return futureMap.computeIfAbsent(node, future -> reconcileConfiguration(connectedNode));
282 public ListenableFuture<Boolean> endReconciliation(DeviceInfo node) {
283 futureMap.computeIfPresent(node, (key, future) -> future).cancel(true);
284 futureMap.remove(node);
285 return Futures.immediateFuture(true);
289 public int getPriority() {
294 public String getName() {
299 public ResultState getResultState() {
303 private class ReconciliationTask implements Callable<Boolean> {
305 InstanceIdentifier<FlowCapableNode> nodeIdentity;
307 ReconciliationTask(final InstanceIdentifier<FlowCapableNode> nodeIdent) {
308 nodeIdentity = nodeIdent;
312 public Boolean call() {
313 String node = nodeIdentity.firstKeyOf(Node.class, NodeKey.class).getId().getValue();
314 BigInteger dpnId = getDpnIdFromNodeName(node);
316 ReadOnlyTransaction trans = provider.getReadTranaction();
317 Optional<FlowCapableNode> flowNode;
318 // initialize the counter
321 flowNode = trans.read(LogicalDatastoreType.CONFIGURATION, nodeIdentity).get();
322 } catch (ExecutionException | InterruptedException e) {
323 LOG.warn("Fail with read Config/DS for Node {} !", nodeIdentity, e);
327 if (flowNode.isPresent()) {
328 /* Tables - have to be pushed before groups */
329 // CHECK if while pushing the update, updateTableInput can be null to emulate a
331 List<TableFeatures> tableList = flowNode.get().getTableFeatures() != null
332 ? flowNode.get().getTableFeatures()
333 : Collections.<TableFeatures>emptyList();
334 for (TableFeatures tableFeaturesItem : tableList) {
335 TableFeaturesKey tableKey = tableFeaturesItem.key();
336 KeyedInstanceIdentifier<TableFeatures, TableFeaturesKey> tableFeaturesII = nodeIdentity
337 .child(TableFeatures.class, new TableFeaturesKey(tableKey.getTableId()));
338 provider.getTableFeaturesCommiter().update(tableFeaturesII, tableFeaturesItem, null, nodeIdentity);
341 /* Groups - have to be first */
342 List<Group> groups = flowNode.get().getGroup() != null ? flowNode.get().getGroup()
343 : Collections.<Group>emptyList();
344 List<Group> toBeInstalledGroups = new ArrayList<>();
345 toBeInstalledGroups.addAll(groups);
346 // new list for suspected groups pointing to ports .. when the ports come up
348 List<Group> suspectedGroups = new ArrayList<>();
349 Map<Long, ListenableFuture<?>> groupFutures = new HashMap<>();
351 while ((!toBeInstalledGroups.isEmpty() || !suspectedGroups.isEmpty())
352 && counter <= provider.getReconciliationRetryCount()) { // also check if the counter has not
353 // crossed the threshold
355 if (toBeInstalledGroups.isEmpty() && !suspectedGroups.isEmpty()) {
356 LOG.debug("These Groups are pointing to node-connectors that are not up yet {}",
357 suspectedGroups.toString());
358 toBeInstalledGroups.addAll(suspectedGroups);
362 ListIterator<Group> iterator = toBeInstalledGroups.listIterator();
363 while (iterator.hasNext()) {
364 Group group = iterator.next();
365 boolean okToInstall = true;
366 Buckets buckets = group.getBuckets();
367 List<Bucket> bucketList = buckets == null ? null : buckets.getBucket();
368 if (bucketList == null) {
369 bucketList = Collections.<Bucket>emptyList();
371 for (Bucket bucket : bucketList) {
372 List<Action> actions = bucket.getAction();
373 if (actions == null) {
374 actions = Collections.<Action>emptyList();
376 for (Action action : actions) {
378 if (action.getAction().getImplementedInterface().getName()
379 .equals("org.opendaylight.yang.gen.v1.urn.opendaylight"
380 + ".action.types.rev131112.action.action.OutputActionCase")) {
381 String nodeConnectorUri = ((OutputActionCase) action.getAction()).getOutputAction()
382 .getOutputNodeConnector().getValue();
384 LOG.debug("Installing the group for node connector {}", nodeConnectorUri);
386 // check if the nodeconnector is there in the multimap
387 boolean isPresent = provider.getFlowNodeConnectorInventoryTranslatorImpl()
388 .isNodeConnectorUpdated(dpnId, nodeConnectorUri);
389 // if yes set okToInstall = true
394 // else put it in a different list and still set okToInstall = true
395 suspectedGroups.add(group);
397 "Not yet received the node-connector updated for {} "
398 + "for the group with id {}",
399 nodeConnectorUri, group.getGroupId().toString());
402 } else if (action.getAction().getImplementedInterface().getName()
403 .equals("org.opendaylight.yang.gen.v1.urn.opendaylight"
404 + ".action.types.rev131112.action.action.GroupActionCase")) {
406 Long groupId = ((GroupActionCase) action.getAction()).getGroupAction().getGroupId();
407 ListenableFuture<?> future = groupFutures.get(groupId);
408 if (future == null) {
412 // Need to ensure that the group specified
413 // by group-action is already installed.
414 awaitGroup(node, future);
418 // increment retry counter value
424 addGroup(groupFutures, group);
426 // resetting the counter to zero
432 /* installation of suspected groups */
433 if (!toBeInstalledGroups.isEmpty()) {
434 for (Group group : toBeInstalledGroups) {
436 "Installing the group {} finally although "
437 + "the port is not up after checking for {} times ",
438 group.getGroupId().toString(), provider.getReconciliationRetryCount());
439 addGroup(groupFutures, group);
443 List<Meter> meters = flowNode.get().getMeter() != null ? flowNode.get().getMeter()
444 : Collections.<Meter>emptyList();
445 for (Meter meter : meters) {
446 final KeyedInstanceIdentifier<Meter, MeterKey> meterIdent = nodeIdentity.child(Meter.class,
448 provider.getMeterCommiter().add(meterIdent, meter, nodeIdentity);
451 // Need to wait for all groups to be installed before adding
453 awaitGroups(node, groupFutures.values());
456 List<Table> tables = flowNode.get().getTable() != null ? flowNode.get().getTable()
457 : Collections.<Table>emptyList();
458 for (Table table : tables) {
459 final KeyedInstanceIdentifier<Table, TableKey> tableIdent = nodeIdentity.child(Table.class,
461 List<Flow> flows = table.getFlow() != null ? table.getFlow() : Collections.<Flow>emptyList();
462 for (Flow flow : flows) {
463 final KeyedInstanceIdentifier<Flow, FlowKey> flowIdent = tableIdent.child(Flow.class,
465 provider.getFlowCommiter().add(flowIdent, flow, nodeIdentity);
469 /* clean transaction */
475 * Invoke add-group RPC, and put listenable future associated with the RPC into
479 * The map to store listenable futures associated with add-group RPC.
483 private void addGroup(Map<Long, ListenableFuture<?>> map, Group group) {
484 KeyedInstanceIdentifier<Group, GroupKey> groupIdent = nodeIdentity.child(Group.class, group.key());
485 final Long groupId = group.getGroupId().getValue();
486 ListenableFuture<?> future = JdkFutureAdapters
487 .listenInPoolThread(provider.getGroupCommiter().add(groupIdent, group, nodeIdentity));
489 Futures.addCallback(future, new FutureCallback<Object>() {
491 public void onSuccess(Object result) {
492 if (LOG.isTraceEnabled()) {
493 LOG.trace("add-group RPC completed: node={}, id={}",
494 nodeIdentity.firstKeyOf(Node.class).getId().getValue(), groupId);
499 public void onFailure(Throwable cause) {
500 String msg = "add-group RPC failed: node=" + nodeIdentity.firstKeyOf(Node.class).getId().getValue()
502 LOG.debug(msg, cause);
504 }, MoreExecutors.directExecutor());
506 map.put(groupId, future);
510 * Wait for completion of add-group RPC.
513 * The identifier for the target node.
515 * Future associated with add-group RPC that installs the target
518 private void awaitGroup(String nodeId, ListenableFuture<?> future) {
519 awaitGroups(nodeId, Collections.singleton(future));
523 * Wait for completion of add-group RPCs.
526 * The identifier for the target node.
528 * A collection of futures associated with add-group RPCs.
530 private void awaitGroups(String nodeId, Collection<ListenableFuture<?>> futures) {
531 if (!futures.isEmpty()) {
532 long timeout = Math.min(ADD_GROUP_TIMEOUT * futures.size(), MAX_ADD_GROUP_TIMEOUT);
534 Futures.successfulAsList(futures).get(timeout, TimeUnit.NANOSECONDS);
535 LOG.trace("awaitGroups() completed: node={}", nodeId);
536 } catch (TimeoutException | InterruptedException | ExecutionException e) {
537 LOG.debug("add-group RPCs did not complete: node={}", nodeId);
543 private BigInteger getDpnIdFromNodeName(String nodeName) {
545 String dpId = nodeName.substring(nodeName.lastIndexOf(SEPARATOR) + 1);
546 return new BigInteger(dpId);
549 private void reconciliationPreProcess(final InstanceIdentifier<FlowCapableNode> nodeIdent) {
550 List<InstanceIdentifier<StaleFlow>> staleFlowsToBeBulkDeleted = Lists.newArrayList();
551 List<InstanceIdentifier<StaleGroup>> staleGroupsToBeBulkDeleted = Lists.newArrayList();
552 List<InstanceIdentifier<StaleMeter>> staleMetersToBeBulkDeleted = Lists.newArrayList();
554 ReadOnlyTransaction trans = provider.getReadTranaction();
555 Optional<FlowCapableNode> flowNode = Optional.absent();
558 flowNode = trans.read(LogicalDatastoreType.CONFIGURATION, nodeIdent).get();
559 } catch (ExecutionException | InterruptedException e) {
560 LOG.warn("Reconciliation Pre-Processing Fail with read Config/DS for Node {} !", nodeIdent, e);
563 if (flowNode.isPresent()) {
565 LOG.debug("Proceeding with deletion of stale-marked Flows on switch {} using Openflow interface",
566 nodeIdent.toString());
567 /* Stale-Flows - Stale-marked Flows have to be removed first for safety */
568 List<Table> tables = flowNode.get().getTable() != null ? flowNode.get().getTable()
569 : Collections.<Table>emptyList();
570 for (Table table : tables) {
571 final KeyedInstanceIdentifier<Table, TableKey> tableIdent = nodeIdent.child(Table.class,
573 List<StaleFlow> staleFlows = table.getStaleFlow() != null ? table.getStaleFlow()
574 : Collections.<StaleFlow>emptyList();
575 for (StaleFlow staleFlow : staleFlows) {
577 FlowBuilder flowBuilder = new FlowBuilder(staleFlow);
578 Flow toBeDeletedFlow = flowBuilder.setId(staleFlow.getId()).build();
580 final KeyedInstanceIdentifier<Flow, FlowKey> flowIdent = tableIdent.child(Flow.class,
581 toBeDeletedFlow.key());
583 this.provider.getFlowCommiter().remove(flowIdent, toBeDeletedFlow, nodeIdent);
585 staleFlowsToBeBulkDeleted.add(getStaleFlowInstanceIdentifier(staleFlow, nodeIdent));
589 LOG.debug("Proceeding with deletion of stale-marked Groups for switch {} using Openflow interface",
590 nodeIdent.toString());
592 // TODO: Should we collate the futures of RPC-calls to be sure that groups are
593 // Flows are fully deleted
594 // before attempting to delete groups - just in case there are references
596 /* Stale-marked Groups - Can be deleted after flows */
597 List<StaleGroup> staleGroups = flowNode.get().getStaleGroup() != null ? flowNode.get().getStaleGroup()
598 : Collections.<StaleGroup>emptyList();
599 for (StaleGroup staleGroup : staleGroups) {
601 GroupBuilder groupBuilder = new GroupBuilder(staleGroup);
602 Group toBeDeletedGroup = groupBuilder.setGroupId(staleGroup.getGroupId()).build();
604 final KeyedInstanceIdentifier<Group, GroupKey> groupIdent = nodeIdent.child(Group.class,
605 toBeDeletedGroup.key());
607 this.provider.getGroupCommiter().remove(groupIdent, toBeDeletedGroup, nodeIdent);
609 staleGroupsToBeBulkDeleted.add(getStaleGroupInstanceIdentifier(staleGroup, nodeIdent));
612 LOG.debug("Proceeding with deletion of stale-marked Meters for switch {} using Openflow interface",
613 nodeIdent.toString());
614 /* Stale-marked Meters - can be deleted anytime - so least priority */
615 List<StaleMeter> staleMeters = flowNode.get().getStaleMeter() != null ? flowNode.get().getStaleMeter()
616 : Collections.<StaleMeter>emptyList();
618 for (StaleMeter staleMeter : staleMeters) {
620 MeterBuilder meterBuilder = new MeterBuilder(staleMeter);
621 Meter toBeDeletedMeter = meterBuilder.setMeterId(staleMeter.getMeterId()).build();
623 final KeyedInstanceIdentifier<Meter, MeterKey> meterIdent = nodeIdent.child(Meter.class,
624 toBeDeletedMeter.key());
626 this.provider.getMeterCommiter().remove(meterIdent, toBeDeletedMeter, nodeIdent);
628 staleMetersToBeBulkDeleted.add(getStaleMeterInstanceIdentifier(staleMeter, nodeIdent));
632 /* clean transaction */
635 LOG.debug("Deleting all stale-marked flows/groups/meters of for switch {} in Configuration DS",
636 nodeIdent.toString());
637 // Now, do the bulk deletions
638 deleteDSStaleFlows(staleFlowsToBeBulkDeleted);
639 deleteDSStaleGroups(staleGroupsToBeBulkDeleted);
640 deleteDSStaleMeters(staleMetersToBeBulkDeleted);
643 private void deleteDSStaleFlows(List<InstanceIdentifier<StaleFlow>> flowsForBulkDelete) {
644 WriteTransaction writeTransaction = dataBroker.newWriteOnlyTransaction();
646 for (InstanceIdentifier<StaleFlow> staleFlowIId : flowsForBulkDelete) {
647 writeTransaction.delete(LogicalDatastoreType.CONFIGURATION, staleFlowIId);
650 ListenableFuture<Void> submitFuture = writeTransaction.submit();
651 handleStaleEntityDeletionResultFuture(submitFuture);
654 private void deleteDSStaleGroups(List<InstanceIdentifier<StaleGroup>> groupsForBulkDelete) {
655 WriteTransaction writeTransaction = dataBroker.newWriteOnlyTransaction();
657 for (InstanceIdentifier<StaleGroup> staleGroupIId : groupsForBulkDelete) {
658 writeTransaction.delete(LogicalDatastoreType.CONFIGURATION, staleGroupIId);
661 ListenableFuture<Void> submitFuture = writeTransaction.submit();
662 handleStaleEntityDeletionResultFuture(submitFuture);
665 private void deleteDSStaleMeters(List<InstanceIdentifier<StaleMeter>> metersForBulkDelete) {
666 WriteTransaction writeTransaction = dataBroker.newWriteOnlyTransaction();
668 for (InstanceIdentifier<StaleMeter> staleMeterIId : metersForBulkDelete) {
669 writeTransaction.delete(LogicalDatastoreType.CONFIGURATION, staleMeterIId);
672 ListenableFuture<Void> submitFuture = writeTransaction.submit();
673 handleStaleEntityDeletionResultFuture(submitFuture);
676 private InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight
677 .flow.inventory.rev130819.tables.table.StaleFlow> getStaleFlowInstanceIdentifier(
678 StaleFlow staleFlow, InstanceIdentifier<FlowCapableNode> nodeIdent) {
679 return nodeIdent.child(Table.class, new TableKey(staleFlow.getTableId())).child(
680 org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.StaleFlow.class,
681 new StaleFlowKey(new FlowId(staleFlow.getId())));
684 private InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight
685 .group.types.rev131018.groups.StaleGroup> getStaleGroupInstanceIdentifier(
686 StaleGroup staleGroup, InstanceIdentifier<FlowCapableNode> nodeIdent) {
687 return nodeIdent.child(StaleGroup.class, new StaleGroupKey(new GroupId(staleGroup.getGroupId())));
690 private InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight
691 .flow.inventory.rev130819.meters.StaleMeter> getStaleMeterInstanceIdentifier(
692 StaleMeter staleMeter, InstanceIdentifier<FlowCapableNode> nodeIdent) {
693 return nodeIdent.child(StaleMeter.class, new StaleMeterKey(new MeterId(staleMeter.getMeterId())));
696 private void handleStaleEntityDeletionResultFuture(ListenableFuture<Void> submitFuture) {
697 Futures.addCallback(submitFuture, new FutureCallback<Void>() {
699 public void onSuccess(Void result) {
700 LOG.debug("Stale entity removal success");
704 public void onFailure(Throwable throwable) {
705 LOG.debug("Stale entity removal failed {}", throwable);
707 }, MoreExecutors.directExecutor());
710 private Flow getDeleteAllFlow() {
711 final FlowBuilder flowBuilder = new FlowBuilder();
712 flowBuilder.setTableId(OFConstants.OFPTT_ALL);
713 return flowBuilder.build();
716 private Group getDeleteAllGroup() {
717 final GroupBuilder groupBuilder = new GroupBuilder();
718 groupBuilder.setGroupType(GroupTypes.GroupAll);
719 groupBuilder.setGroupId(new GroupId(OFConstants.OFPG_ALL));
720 return groupBuilder.build();
723 private Messages createMessages(final NodeRef nodeRef, final Optional<FlowCapableNode> flowNode) {
724 final List<Message> messages = new ArrayList<>();
725 messages.add(new MessageBuilder().setNode(nodeRef)
726 .setBundleInnerMessage(new BundleRemoveFlowCaseBuilder()
727 .setRemoveFlowCaseData(new RemoveFlowCaseDataBuilder(getDeleteAllFlow()).build()).build())
730 messages.add(new MessageBuilder().setNode(nodeRef)
731 .setBundleInnerMessage(new BundleRemoveGroupCaseBuilder()
732 .setRemoveGroupCaseData(new RemoveGroupCaseDataBuilder(getDeleteAllGroup()).build()).build())
735 if (flowNode.get().getGroup() != null) {
736 for (Group gr : flowNode.get().getGroup()) {
737 NodeId nodeId = nodeRef.getValue().firstKeyOf(Node.class, NodeKey.class).getId();
738 provider.getDevicesGroupRegistry().storeGroup(nodeId,gr.getGroupId().getValue());
739 messages.add(new MessageBuilder().setNode(nodeRef).setBundleInnerMessage(new BundleAddGroupCaseBuilder()
740 .setAddGroupCaseData(new AddGroupCaseDataBuilder(gr).build()).build()).build());
744 if (flowNode.get().getTable() != null) {
745 for (Table table : flowNode.get().getTable()) {
746 for (Flow flow : table.getFlow()) {
748 new MessageBuilder().setNode(nodeRef)
749 .setBundleInnerMessage(new BundleAddFlowCaseBuilder()
750 .setAddFlowCaseData(new AddFlowCaseDataBuilder(flow).build()).build())
756 LOG.debug("The size of the flows and group messages created in createMessage() {}", messages.size());
757 return new MessagesBuilder().setMessage(messages).build();