/**
* Copyright (c) 2014, 2017 Cisco Systems, Inc. and others. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v1.0 which accompanies this distribution,
* and is available at http://www.eclipse.org/legal/epl-v10.html
*/
package org.opendaylight.openflowplugin.applications.frm.impl;
import com.google.common.base.Optional;
import com.google.common.base.Preconditions;
import com.google.common.collect.Lists;
import com.google.common.util.concurrent.FutureCallback;
import com.google.common.util.concurrent.Futures;
import com.google.common.util.concurrent.JdkFutureAdapters;
import com.google.common.util.concurrent.ListenableFuture;
import com.google.common.util.concurrent.MoreExecutors;
import java.math.BigInteger;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.ListIterator;
import java.util.Map;
import java.util.concurrent.Callable;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.TimeoutException;
import java.util.concurrent.atomic.AtomicLong;
import org.opendaylight.controller.md.sal.binding.api.DataBroker;
import org.opendaylight.controller.md.sal.binding.api.ReadOnlyTransaction;
import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
import org.opendaylight.openflowplugin.api.OFConstants;
import org.opendaylight.openflowplugin.api.openflow.device.DeviceInfo;
import org.opendaylight.openflowplugin.applications.frm.FlowNodeReconciliation;
import org.opendaylight.openflowplugin.applications.frm.ForwardingRulesManager;
import org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.action.GroupActionCase;
import org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.action.OutputActionCase;
import org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.list.Action;
import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNode;
import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowId;
import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.meters.Meter;
import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.meters.MeterBuilder;
import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.meters.MeterKey;
import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.meters.StaleMeter;
import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.meters.StaleMeterKey;
import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.Table;
import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.TableKey;
import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.Flow;
import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.FlowBuilder;
import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.FlowKey;
import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.StaleFlow;
import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.StaleFlowKey;
import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.GroupId;
import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.GroupTypes;
import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.group.Buckets;
import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.group.buckets.Bucket;
import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.groups.Group;
import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.groups.GroupBuilder;
import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.groups.GroupKey;
import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.groups.StaleGroup;
import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.groups.StaleGroupKey;
import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef;
import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeKey;
import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.MeterId;
import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.bundle.service.rev170124.AddBundleMessagesInput;
import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.bundle.service.rev170124.AddBundleMessagesInputBuilder;
import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.bundle.service.rev170124.AddBundleMessagesOutput;
import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.bundle.service.rev170124.ControlBundleInput;
import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.bundle.service.rev170124.ControlBundleInputBuilder;
import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.bundle.service.rev170124.ControlBundleOutput;
import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.bundle.service.rev170124.SalBundleService;
import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.bundle.service.rev170124.add.bundle.messages.input.Messages;
import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.bundle.service.rev170124.add.bundle.messages.input.MessagesBuilder;
import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.bundle.service.rev170124.add.bundle.messages.input.messages.Message;
import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.bundle.service.rev170124.add.bundle.messages.input.messages.MessageBuilder;
import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.bundle.service.rev170124.bundle.inner.message.grouping.bundle.inner.message.BundleAddFlowCaseBuilder;
import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.bundle.service.rev170124.bundle.inner.message.grouping.bundle.inner.message.BundleAddGroupCaseBuilder;
import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.bundle.service.rev170124.bundle.inner.message.grouping.bundle.inner.message.BundleRemoveFlowCaseBuilder;
import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.bundle.service.rev170124.bundle.inner.message.grouping.bundle.inner.message.BundleRemoveGroupCaseBuilder;
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;
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;
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;
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;
import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.rev170124.BundleControlType;
import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.rev170124.BundleFlags;
import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.rev170124.BundleId;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.rf.state.rev170713.ResultState;
import org.opendaylight.yang.gen.v1.urn.opendaylight.table.types.rev131026.table.features.TableFeatures;
import org.opendaylight.yang.gen.v1.urn.opendaylight.table.types.rev131026.table.features.TableFeaturesKey;
import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
import org.opendaylight.yangtools.yang.common.RpcResult;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* Default implementation of {@link ForwardingRulesManager}.
*
* @author Vaclav Demcak
*/
public class FlowNodeReconciliationImpl implements FlowNodeReconciliation {
private static final Logger LOG = LoggerFactory.getLogger(FlowNodeReconciliationImpl.class);
// The number of nanoseconds to wait for a single group to be added.
private static final long ADD_GROUP_TIMEOUT = TimeUnit.SECONDS.toNanos(3);
// The maximum number of nanoseconds to wait for completion of add-group RPCs.
private static final long MAX_ADD_GROUP_TIMEOUT = TimeUnit.SECONDS.toNanos(20);
private static final String SEPARATOR = ":";
private static final int THREAD_POOL_SIZE = 4;
private final DataBroker dataBroker;
private final ForwardingRulesManager provider;
private final String serviceName;
private final int priority;
private final ResultState resultState;
private final Map> futureMap = new HashMap<>();
private final ExecutorService executor = Executors.newFixedThreadPool(THREAD_POOL_SIZE);
private final SalBundleService salBundleService;
private static final AtomicLong BUNDLE_ID = new AtomicLong();
private static final BundleFlags BUNDLE_FLAGS = new BundleFlags(true, true);
public FlowNodeReconciliationImpl(final ForwardingRulesManager manager, final DataBroker db,
final String serviceName, final int priority, final ResultState resultState) {
this.provider = Preconditions.checkNotNull(manager, "ForwardingRulesManager can not be null!");
dataBroker = Preconditions.checkNotNull(db, "DataBroker can not be null!");
this.serviceName = serviceName;
this.priority = priority;
this.resultState = resultState;
salBundleService = Preconditions.checkNotNull(manager.getSalBundleService(),
"salBundleService can not be null!");
}
@Override
public void close() {
if (executor != null) {
executor.shutdownNow();
}
}
@Override
public ListenableFuture reconcileConfiguration(InstanceIdentifier connectedNode) {
LOG.info("Triggering reconciliation for device {}", connectedNode.firstKeyOf(Node.class));
if (provider.isStaleMarkingEnabled()) {
LOG.info("Stale-Marking is ENABLED and proceeding with deletion of " + "stale-marked entities on switch {}",
connectedNode.toString());
reconciliationPreProcess(connectedNode);
}
if (provider.isBundleBasedReconciliationEnabled()) {
BundleBasedReconciliationTask bundleBasedReconTask = new BundleBasedReconciliationTask(connectedNode);
return JdkFutureAdapters.listenInPoolThread(executor.submit(bundleBasedReconTask));
} else {
ReconciliationTask reconciliationTask = new ReconciliationTask(connectedNode);
return JdkFutureAdapters.listenInPoolThread(executor.submit(reconciliationTask));
}
}
private class BundleBasedReconciliationTask implements Callable {
final InstanceIdentifier nodeIdentity;
BundleBasedReconciliationTask(final InstanceIdentifier nodeIdent) {
nodeIdentity = nodeIdent;
}
@Override
public Boolean call() {
String node = nodeIdentity.firstKeyOf(Node.class, NodeKey.class).getId().getValue();
Optional flowNode = Optional.absent();
BundleId bundleIdValue = new BundleId(BUNDLE_ID.getAndIncrement());
BigInteger dpnId = getDpnIdFromNodeName(node);
LOG.info("Triggering bundle based reconciliation for device : {}", dpnId);
ReadOnlyTransaction trans = provider.getReadTranaction();
try {
flowNode = trans.read(LogicalDatastoreType.CONFIGURATION, nodeIdentity).get();
} catch (ExecutionException | InterruptedException e) {
LOG.error("Error occurred while reading the configuration data store for node {}", nodeIdentity, e);
}
if (flowNode.isPresent()) {
LOG.debug("FlowNode present for Datapath ID {}", dpnId);
final NodeRef nodeRef = new NodeRef(nodeIdentity.firstIdentifierOf(Node.class));
final ControlBundleInput closeBundleInput = new ControlBundleInputBuilder().setNode(nodeRef)
.setBundleId(bundleIdValue).setFlags(BUNDLE_FLAGS)
.setType(BundleControlType.ONFBCTCLOSEREQUEST).build();
final ControlBundleInput openBundleInput = new ControlBundleInputBuilder().setNode(nodeRef)
.setBundleId(bundleIdValue).setFlags(BUNDLE_FLAGS).setType(BundleControlType.ONFBCTOPENREQUEST)
.build();
final ControlBundleInput commitBundleInput = new ControlBundleInputBuilder().setNode(nodeRef)
.setBundleId(bundleIdValue).setFlags(BUNDLE_FLAGS)
.setType(BundleControlType.ONFBCTCOMMITREQUEST).build();
final AddBundleMessagesInput addBundleMessagesInput = new AddBundleMessagesInputBuilder()
.setNode(nodeRef).setBundleId(bundleIdValue).setFlags(BUNDLE_FLAGS)
.setMessages(createMessages(nodeRef, flowNode)).build();
/* Close previously opened bundle on the openflow switch if any */
ListenableFuture> closeBundle
= salBundleService.controlBundle(closeBundleInput);
/* Open a new bundle on the switch */
ListenableFuture> openBundle =
Futures.transformAsync(closeBundle,
rpcResult -> salBundleService.controlBundle(openBundleInput),
MoreExecutors.directExecutor());
/* Push groups and flows via bundle add messages */
ListenableFuture> addBundleMessagesFuture
= Futures.transformAsync(openBundle, rpcResult -> {
if (rpcResult.isSuccessful()) {
return salBundleService.addBundleMessages(addBundleMessagesInput);
}
return Futures.immediateFuture(null);
}, MoreExecutors.directExecutor());
/* Commit the bundle on the openflow switch */
ListenableFuture> commitBundleFuture
= Futures.transformAsync(addBundleMessagesFuture, rpcResult -> {
if (rpcResult.isSuccessful()) {
return salBundleService.controlBundle(commitBundleInput);
}
return Futures.immediateFuture(null);
}, MoreExecutors.directExecutor());
/* Bundles not supported for meters */
List meters = flowNode.get().getMeter() != null ? flowNode.get().getMeter()
: Collections.emptyList();
Futures.transformAsync(commitBundleFuture,
rpcResult -> {
if (rpcResult.isSuccessful()) {
for (Meter meter : meters) {
final KeyedInstanceIdentifier meterIdent = nodeIdentity
.child(Meter.class, meter.key());
provider.getMeterCommiter().add(meterIdent, meter, nodeIdentity);
}
}
return Futures.immediateFuture(null);
}, MoreExecutors.directExecutor());
trans.close();
try {
if (commitBundleFuture.get().isSuccessful()) {
LOG.debug("Completing bundle based reconciliation for device ID:{}", dpnId);
return true;
} else {
return false;
}
} catch (InterruptedException | ExecutionException e) {
LOG.error("Error while doing bundle based reconciliation for device ID:{}", nodeIdentity);
return false;
}
}
LOG.error("FlowNode not present for Datapath ID {}", dpnId);
return false;
}
}
@Override
public ListenableFuture startReconciliation(DeviceInfo node) {
InstanceIdentifier connectedNode = node.getNodeInstanceIdentifier()
.augmentation(FlowCapableNode.class);
return futureMap.computeIfAbsent(node, future -> reconcileConfiguration(connectedNode));
}
@Override
public ListenableFuture endReconciliation(DeviceInfo node) {
futureMap.computeIfPresent(node, (key, future) -> future).cancel(true);
futureMap.remove(node);
return Futures.immediateFuture(true);
}
@Override
public int getPriority() {
return priority;
}
@Override
public String getName() {
return serviceName;
}
@Override
public ResultState getResultState() {
return resultState;
}
private class ReconciliationTask implements Callable {
InstanceIdentifier nodeIdentity;
ReconciliationTask(final InstanceIdentifier nodeIdent) {
nodeIdentity = nodeIdent;
}
@Override
public Boolean call() {
String node = nodeIdentity.firstKeyOf(Node.class, NodeKey.class).getId().getValue();
BigInteger dpnId = getDpnIdFromNodeName(node);
ReadOnlyTransaction trans = provider.getReadTranaction();
Optional flowNode;
// initialize the counter
int counter = 0;
try {
flowNode = trans.read(LogicalDatastoreType.CONFIGURATION, nodeIdentity).get();
} catch (ExecutionException | InterruptedException e) {
LOG.warn("Fail with read Config/DS for Node {} !", nodeIdentity, e);
return false;
}
if (flowNode.isPresent()) {
/* Tables - have to be pushed before groups */
// CHECK if while pushing the update, updateTableInput can be null to emulate a
// table add
List tableList = flowNode.get().getTableFeatures() != null
? flowNode.get().getTableFeatures()
: Collections.emptyList();
for (TableFeatures tableFeaturesItem : tableList) {
TableFeaturesKey tableKey = tableFeaturesItem.key();
KeyedInstanceIdentifier tableFeaturesII = nodeIdentity
.child(TableFeatures.class, new TableFeaturesKey(tableKey.getTableId()));
provider.getTableFeaturesCommiter().update(tableFeaturesII, tableFeaturesItem, null, nodeIdentity);
}
/* Groups - have to be first */
List groups = flowNode.get().getGroup() != null ? flowNode.get().getGroup()
: Collections.emptyList();
List toBeInstalledGroups = new ArrayList<>();
toBeInstalledGroups.addAll(groups);
// new list for suspected groups pointing to ports .. when the ports come up
// late
List suspectedGroups = new ArrayList<>();
Map> groupFutures = new HashMap<>();
while ((!toBeInstalledGroups.isEmpty() || !suspectedGroups.isEmpty())
&& counter <= provider.getReconciliationRetryCount()) { // also check if the counter has not
// crossed the threshold
if (toBeInstalledGroups.isEmpty() && !suspectedGroups.isEmpty()) {
LOG.debug("These Groups are pointing to node-connectors that are not up yet {}",
suspectedGroups.toString());
toBeInstalledGroups.addAll(suspectedGroups);
break;
}
ListIterator iterator = toBeInstalledGroups.listIterator();
while (iterator.hasNext()) {
Group group = iterator.next();
boolean okToInstall = true;
Buckets buckets = group.getBuckets();
List bucketList = buckets == null ? null : buckets.getBucket();
if (bucketList == null) {
bucketList = Collections.emptyList();
}
for (Bucket bucket : bucketList) {
List actions = bucket.getAction();
if (actions == null) {
actions = Collections.emptyList();
}
for (Action action : actions) {
// chained-port
if (action.getAction().getImplementedInterface().getName()
.equals("org.opendaylight.yang.gen.v1.urn.opendaylight"
+ ".action.types.rev131112.action.action.OutputActionCase")) {
String nodeConnectorUri = ((OutputActionCase) action.getAction()).getOutputAction()
.getOutputNodeConnector().getValue();
LOG.debug("Installing the group for node connector {}", nodeConnectorUri);
// check if the nodeconnector is there in the multimap
boolean isPresent = provider.getFlowNodeConnectorInventoryTranslatorImpl()
.isNodeConnectorUpdated(dpnId, nodeConnectorUri);
// if yes set okToInstall = true
if (isPresent) {
break;
} else {
// else put it in a different list and still set okToInstall = true
suspectedGroups.add(group);
LOG.debug(
"Not yet received the node-connector updated for {} "
+ "for the group with id {}",
nodeConnectorUri, group.getGroupId().toString());
break;
}
} else if (action.getAction().getImplementedInterface().getName()
.equals("org.opendaylight.yang.gen.v1.urn.opendaylight"
+ ".action.types.rev131112.action.action.GroupActionCase")) {
// chained groups
Long groupId = ((GroupActionCase) action.getAction()).getGroupAction().getGroupId();
ListenableFuture> future = groupFutures.get(groupId);
if (future == null) {
okToInstall = false;
break;
}
// Need to ensure that the group specified
// by group-action is already installed.
awaitGroup(node, future);
}
}
if (!okToInstall) {
// increment retry counter value
counter++;
break;
}
}
if (okToInstall) {
addGroup(groupFutures, group);
iterator.remove();
// resetting the counter to zero
counter = 0;
}
}
}
/* installation of suspected groups */
if (!toBeInstalledGroups.isEmpty()) {
for (Group group : toBeInstalledGroups) {
LOG.debug(
"Installing the group {} finally although "
+ "the port is not up after checking for {} times ",
group.getGroupId().toString(), provider.getReconciliationRetryCount());
addGroup(groupFutures, group);
}
}
/* Meters */
List meters = flowNode.get().getMeter() != null ? flowNode.get().getMeter()
: Collections.emptyList();
for (Meter meter : meters) {
final KeyedInstanceIdentifier meterIdent = nodeIdentity.child(Meter.class,
meter.key());
provider.getMeterCommiter().add(meterIdent, meter, nodeIdentity);
}
// Need to wait for all groups to be installed before adding
// flows.
awaitGroups(node, groupFutures.values());
/* Flows */
List
emptyList();
for (Table table : tables) {
final KeyedInstanceIdentifier
tableIdent = nodeIdentity.child(Table.class,
table.key());
List flows = table.getFlow() != null ? table.getFlow() : Collections.emptyList();
for (Flow flow : flows) {
final KeyedInstanceIdentifier flowIdent = tableIdent.child(Flow.class,
flow.key());
provider.getFlowCommiter().add(flowIdent, flow, nodeIdentity);
}
}
}
/* clean transaction */
trans.close();
return true;
}
/**
* Invoke add-group RPC, and put listenable future associated with the RPC into
* the given map.
*
* @param map
* The map to store listenable futures associated with add-group RPC.
* @param group
* The group to add.
*/
private void addGroup(Map> map, Group group) {
KeyedInstanceIdentifier groupIdent = nodeIdentity.child(Group.class, group.key());
final Long groupId = group.getGroupId().getValue();
ListenableFuture> future = JdkFutureAdapters
.listenInPoolThread(provider.getGroupCommiter().add(groupIdent, group, nodeIdentity));
Futures.addCallback(future, new FutureCallback