/**
- * Copyright (c) 2014, 2015 Cisco Systems, Inc. and others. All rights reserved.
+ * 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,
package org.opendaylight.openflowplugin.applications.frm.impl;
+import com.google.common.annotations.VisibleForTesting;
import com.google.common.base.Preconditions;
-import com.google.common.collect.Sets;
-import java.util.Collections;
-import java.util.Set;
+import com.google.common.util.concurrent.CheckedFuture;
+import java.util.Objects;
+import java.util.Optional;
import java.util.concurrent.atomic.AtomicLong;
+import javax.annotation.Nonnull;
import org.opendaylight.controller.md.sal.binding.api.DataBroker;
import org.opendaylight.controller.md.sal.binding.api.ReadOnlyTransaction;
+import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
+import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
+import org.opendaylight.controller.sal.binding.api.NotificationProviderService;
import org.opendaylight.controller.sal.binding.api.RpcConsumerRegistry;
+import org.opendaylight.mdsal.singleton.common.api.ClusterSingletonServiceProvider;
+import org.opendaylight.openflowplugin.api.openflow.configuration.ConfigurationService;
import org.opendaylight.openflowplugin.applications.frm.FlowNodeReconciliation;
import org.opendaylight.openflowplugin.applications.frm.ForwardingRulesCommiter;
import org.opendaylight.openflowplugin.applications.frm.ForwardingRulesManager;
+import org.opendaylight.openflowplugin.applications.frm.ForwardingRulesProperty;
+import org.opendaylight.openflowplugin.applications.reconciliation.NotificationRegistration;
+import org.opendaylight.openflowplugin.applications.reconciliation.ReconciliationManager;
import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNode;
import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.meters.Meter;
import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.Flow;
import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.SalFlowService;
import org.opendaylight.yang.gen.v1.urn.opendaylight.group.service.rev130918.SalGroupService;
import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.groups.Group;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.service.rev130918.SalMeterService;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.table.types.rev131026.table.features.TableFeatures;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.bundle.service.rev170124.SalBundleService;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.app.forwardingrules.manager.config.rev160511.ForwardingRulesManagerConfig;
+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.service.rev131026.SalTableService;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.table.types.rev131026.table.features.TableFeatures;
import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
- * forwardingrules-manager
- * org.opendaylight.openflowplugin.applications.frm.impl
- *
- * Manager and middle point for whole module.
- * It contains ActiveNodeHolder and provide all RPC services.
+ * forwardingrules-manager org.opendaylight.openflowplugin.applications.frm.impl
*
- * @author <a href="mailto:vdemcak@cisco.com">Vaclav Demcak</a>
+ * <p>
+ * Manager and middle point for whole module. It contains ActiveNodeHolder and
+ * provide all RPC services.
*
- * Created: Aug 25, 2014
*/
public class ForwardingRulesManagerImpl implements ForwardingRulesManager {
-
private static final Logger LOG = LoggerFactory.getLogger(ForwardingRulesManagerImpl.class);
- public static final int STARTUP_LOOP_TICK = 500;
- public static final int STARTUP_LOOP_MAX_RETRIES = 8;
- private final AtomicLong txNum = new AtomicLong();
- private final Object lockObj = new Object();
- private Set<InstanceIdentifier<FlowCapableNode>> activeNodes = Collections.emptySet();
+ static final int STARTUP_LOOP_TICK = 500;
+ static final int STARTUP_LOOP_MAX_RETRIES = 8;
+ private static final int FRM_RECONCILIATION_PRIORITY = Integer.getInteger("frm.reconciliation.priority", 0);
+ private static final String SERVICE_NAME = "FRM";
+ private final AtomicLong txNum = new AtomicLong();
private final DataBroker dataService;
private final SalFlowService salFlowService;
private final SalGroupService salGroupService;
private final SalMeterService salMeterService;
private final SalTableService salTableService;
-
+ private final ClusterSingletonServiceProvider clusterSingletonServiceProvider;
+ private final NotificationProviderService notificationService;
+ private final SalBundleService salBundleService;
+ private final AutoCloseable configurationServiceRegistration;
private ForwardingRulesCommiter<Flow> flowListener;
private ForwardingRulesCommiter<Group> groupListener;
private ForwardingRulesCommiter<Meter> meterListener;
private ForwardingRulesCommiter<TableFeatures> tableListener;
private FlowNodeReconciliation nodeListener;
+ private NotificationRegistration reconciliationNotificationRegistration;
+ private FlowNodeConnectorInventoryTranslatorImpl flowNodeConnectorInventoryTranslatorImpl;
+ private DeviceMastershipManager deviceMastershipManager;
+ private final ReconciliationManager reconciliationManager;
+
+ private boolean disableReconciliation;
+ private boolean staleMarkingEnabled;
+ private int reconciliationRetryCount;
+ private boolean isBundleBasedReconciliationEnabled;
- public ForwardingRulesManagerImpl(final DataBroker dataBroker,
- final RpcConsumerRegistry rpcRegistry) {
+ public ForwardingRulesManagerImpl(final DataBroker dataBroker, final RpcConsumerRegistry rpcRegistry,
+ final ForwardingRulesManagerConfig config, final ClusterSingletonServiceProvider clusterSingletonService,
+ final NotificationProviderService notificationService, final ConfigurationService configurationService,
+ final ReconciliationManager reconciliationManager) {
+ disableReconciliation = config.isDisableReconciliation();
+ staleMarkingEnabled = config.isStaleMarkingEnabled();
+ reconciliationRetryCount = config.getReconciliationRetryCount();
+ isBundleBasedReconciliationEnabled = config.isBundleBasedReconciliationEnabled();
+ this.configurationServiceRegistration = configurationService.registerListener(this);
this.dataService = Preconditions.checkNotNull(dataBroker, "DataBroker can not be null!");
+ this.clusterSingletonServiceProvider = Preconditions.checkNotNull(clusterSingletonService,
+ "ClusterSingletonService provider can not be null");
+ this.notificationService = Preconditions.checkNotNull(notificationService,
+ "Notification publisher configurationService is" + " not available");
+ this.reconciliationManager = reconciliationManager;
Preconditions.checkArgument(rpcRegistry != null, "RpcConsumerRegistry can not be null !");
"RPC SalMeterService not found.");
this.salTableService = Preconditions.checkNotNull(rpcRegistry.getRpcService(SalTableService.class),
"RPC SalTableService not found.");
+ this.salBundleService = Preconditions.checkNotNull(rpcRegistry.getRpcService(SalBundleService.class),
+ "RPC SalBundlService not found.");
}
@Override
public void start() {
+ this.nodeListener = new FlowNodeReconciliationImpl(this, dataService, SERVICE_NAME, FRM_RECONCILIATION_PRIORITY,
+ ResultState.DONOTHING);
+ if (this.isReconciliationDisabled()) {
+ LOG.debug("Reconciliation is disabled by user");
+ } else {
+ this.reconciliationNotificationRegistration = reconciliationManager.registerService(this.nodeListener);
+ LOG.debug("Reconciliation is enabled by user and successfully registered to the reconciliation framework");
+ }
+ this.deviceMastershipManager = new DeviceMastershipManager(clusterSingletonServiceProvider, notificationService,
+ this.nodeListener, dataService);
+ flowNodeConnectorInventoryTranslatorImpl = new FlowNodeConnectorInventoryTranslatorImpl(dataService);
this.flowListener = new FlowForwarder(this, dataService);
-
this.groupListener = new GroupForwarder(this, dataService);
this.meterListener = new MeterForwarder(this, dataService);
-
this.tableListener = new TableForwarder(this, dataService);
- this.nodeListener = new FlowNodeReconciliationImpl(this, dataService);
LOG.info("ForwardingRulesManager has started successfully.");
-
}
@Override
public void close() throws Exception {
+ configurationServiceRegistration.close();
+
if (this.flowListener != null) {
this.flowListener.close();
this.flowListener = null;
this.nodeListener.close();
this.nodeListener = null;
}
+ if (deviceMastershipManager != null) {
+ deviceMastershipManager.close();
+ }
+ if (this.reconciliationNotificationRegistration != null) {
+ this.reconciliationNotificationRegistration.close();
+ this.reconciliationNotificationRegistration = null;
+ }
}
@Override
@Override
public boolean isNodeActive(InstanceIdentifier<FlowCapableNode> ident) {
- return activeNodes.contains(ident);
+ return deviceMastershipManager.isNodeActive(ident.firstKeyOf(Node.class).getId());
}
@Override
- public void registrateNewNode(InstanceIdentifier<FlowCapableNode> ident) {
- if (!activeNodes.contains(ident)) {
- synchronized (lockObj) {
- if (!activeNodes.contains(ident)) {
- Set<InstanceIdentifier<FlowCapableNode>> set =
- Sets.newHashSet(activeNodes);
- set.add(ident);
- activeNodes = Collections.unmodifiableSet(set);
- }
+ public boolean checkNodeInOperationalDataStore(InstanceIdentifier<FlowCapableNode> ident) {
+ boolean result = false;
+ InstanceIdentifier<Node> nodeIid = ident.firstIdentifierOf(Node.class);
+ final ReadOnlyTransaction transaction = dataService.newReadOnlyTransaction();
+ CheckedFuture<com.google.common.base.Optional<Node>, ReadFailedException> future = transaction
+ .read(LogicalDatastoreType.OPERATIONAL, nodeIid);
+ try {
+ com.google.common.base.Optional<Node> optionalDataObject = future.checkedGet();
+ if (optionalDataObject.isPresent()) {
+ result = true;
+ } else {
+ LOG.debug("{}: Failed to read {}", Thread.currentThread().getStackTrace()[1], nodeIid);
}
+ } catch (ReadFailedException e) {
+ LOG.warn("Failed to read {} ", nodeIid, e);
}
- }
+ transaction.close();
- @Override
- public void unregistrateNode(InstanceIdentifier<FlowCapableNode> ident) {
- if (activeNodes.contains(ident)) {
- synchronized (lockObj) {
- if (activeNodes.contains(ident)) {
- Set<InstanceIdentifier<FlowCapableNode>> set =
- Sets.newHashSet(activeNodes);
- set.remove(ident);
- activeNodes = Collections.unmodifiableSet(set);
- }
- }
- }
+ return result;
}
@Override
return salTableService;
}
+ @Override
+ public SalBundleService getSalBundleService() {
+ return salBundleService;
+ }
+
@Override
public ForwardingRulesCommiter<Flow> getFlowCommiter() {
return flowListener;
}
@Override
- public FlowNodeReconciliation getFlowNodeReconciliation() {
- return nodeListener;
+ public boolean isReconciliationDisabled() {
+ return disableReconciliation;
+ }
+
+ @Override
+ public boolean isStaleMarkingEnabled() {
+ return staleMarkingEnabled;
+ }
+
+ @Override
+ public int getReconciliationRetryCount() {
+ return reconciliationRetryCount;
+ }
+
+ @Override
+ public FlowNodeConnectorInventoryTranslatorImpl getFlowNodeConnectorInventoryTranslatorImpl() {
+ return flowNodeConnectorInventoryTranslatorImpl;
+ }
+
+ @Override
+ public boolean isBundleBasedReconciliationEnabled() {
+ return isBundleBasedReconciliationEnabled;
+ }
+
+ @Override
+ public boolean isNodeOwner(InstanceIdentifier<FlowCapableNode> ident) {
+ return Objects.nonNull(ident) && deviceMastershipManager.isDeviceMastered(ident.firstKeyOf(Node.class).getId());
}
-}
+ @VisibleForTesting
+ public void setDeviceMastershipManager(final DeviceMastershipManager deviceMastershipManager) {
+ this.deviceMastershipManager = deviceMastershipManager;
+ }
+
+ @Override
+ public void onPropertyChanged(@Nonnull final String propertyName, @Nonnull final String propertyValue) {
+ Optional.ofNullable(ForwardingRulesProperty.forValue(propertyName)).ifPresent(forwardingRulesProperty -> {
+ switch (forwardingRulesProperty) {
+ case DISABLE_RECONCILIATION:
+ disableReconciliation = Boolean.valueOf(propertyValue);
+ break;
+ case STALE_MARKING_ENABLED:
+ staleMarkingEnabled = Boolean.valueOf(propertyValue);
+ break;
+ case RECONCILIATION_RETRY_COUNT:
+ reconciliationRetryCount = Integer.parseInt(propertyValue);
+ break;
+ case BUNDLE_BASED_RECONCILIATION_ENABLED:
+ isBundleBasedReconciliationEnabled = Boolean.valueOf(propertyValue);
+ break;
+ default:
+ LOG.warn("No forwarding rule property found.");
+ break;
+ }
+ });
+ }
+}