southbound/southbound-impl/src/main/java/org/opendaylight/ovsdb/southbound/reconciliation/configuration/BridgeConfigReconciliationTask.java

   1 /*
   2  * Copyright (c) 2016 , NEC Corporation and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.ovsdb.southbound.reconciliation.configuration;
   9
  10
  11 import com.google.common.base.Optional;
  12 import com.google.common.util.concurrent.CheckedFuture;
  13 import com.google.common.util.concurrent.FutureCallback;
  14 import com.google.common.util.concurrent.Futures;
  15 import org.opendaylight.controller.md.sal.common.api.data.AsyncDataChangeEvent;
  16 import org.opendaylight.controller.md.sal.binding.api.ReadOnlyTransaction;
  17 import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
  18 import org.opendaylight.ovsdb.southbound.OvsdbConnectionInstance;
  19 import org.opendaylight.ovsdb.southbound.OvsdbConnectionManager;
  20 import org.opendaylight.ovsdb.southbound.SouthboundConstants;
  21 import org.opendaylight.ovsdb.southbound.SouthboundMapper;
  22 import org.opendaylight.ovsdb.southbound.ovsdb.transact.BridgeOperationalState;
  23 import org.opendaylight.ovsdb.southbound.ovsdb.transact.DataChangesManagedByOvsdbNodeEvent;
  24 import org.opendaylight.ovsdb.southbound.ovsdb.transact.TransactCommandAggregator;
  25 import org.opendaylight.ovsdb.southbound.reconciliation.ReconciliationManager;
  26 import org.opendaylight.ovsdb.southbound.reconciliation.ReconciliationTask;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbBridgeAugmentation;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.bridge.attributes.BridgeOtherConfigs;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.bridge.attributes.BridgeOtherConfigsKey;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.bridge.attributes.ControllerEntry;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.bridge.attributes.ControllerEntryKey;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.bridge.attributes.ProtocolEntry;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.bridge.attributes.ProtocolEntryKey;
  34 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.Topology;
  35 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
  36 import org.opendaylight.yangtools.yang.binding.DataObject;
  37 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  38 import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
  39 import org.slf4j.Logger;
  40 import org.slf4j.LoggerFactory;
  41
  42 import java.util.Collections;
  43 import java.util.HashMap;
  44 import java.util.Map;
  45 import java.util.Set;
  46
  47 import javax.annotation.Nullable;
  48
  49 import static org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType.CONFIGURATION;
  50
  51 /**
  52  * Configuration Reconciliation task to reconcile existing bridge configurations in the config datastore and the
  53  * switch when the latter is up and connected to the controller.
  54  * Created by Vinh Nguyen (vinh.nguyen@hcl.com) on 3/21/16.
  55  */
  56 public class BridgeConfigReconciliationTask extends ReconciliationTask{
  57
  58     private static final Logger LOG = LoggerFactory.getLogger(BridgeConfigReconciliationTask.class);
  59     private final OvsdbConnectionInstance connectionInstance;
  60
  61     public BridgeConfigReconciliationTask(ReconciliationManager reconciliationManager, OvsdbConnectionManager
  62             connectionManager, InstanceIdentifier<?> nodeIid, OvsdbConnectionInstance connectionInstance) {
  63         super(reconciliationManager, connectionManager, nodeIid, null);
  64         this.connectionInstance = connectionInstance;
  65
  66     }
  67
  68     @Override
  69     public boolean reconcileConfiguration(OvsdbConnectionManager connectionManager) {
  70         InstanceIdentifier<Topology> topologyInstanceIdentifier = SouthboundMapper.createTopologyInstanceIdentifier();
  71         ReadOnlyTransaction tx = reconciliationManager.getDb().newReadOnlyTransaction();
  72
  73         // find all bridges of the specific device in the config data store
  74         // TODO: this query is not efficient. It retrieves all the Nodes in the datastore, loop over them and look for
  75         // the bridges of specific device. It is mre efficient if MDSAL allows query nodes using wildcard on node id
  76         // (ie: ovsdb://uuid/<device uuid>/bridge/*) r attributes
  77         CheckedFuture<Optional<Topology>, ReadFailedException> readTopologyFuture =
  78                 tx.read(CONFIGURATION, topologyInstanceIdentifier);
  79         Futures.addCallback(readTopologyFuture, new FutureCallback<Optional<Topology>>() {
  80             @Override
  81             public void onSuccess(@Nullable Optional<Topology> optionalTopology) {
  82                 if (optionalTopology.isPresent()) {
  83                     InstanceIdentifier<Node> nIid = (InstanceIdentifier<Node>) nodeIid;
  84                     Topology topology = optionalTopology.get();
  85                     if (topology.getNode() != null) {
  86                         final Map<InstanceIdentifier<?>, DataObject> changes = new HashMap<>();
  87                         for (Node node : topology.getNode()) {
  88                             OvsdbBridgeAugmentation bridge = node.getAugmentation(OvsdbBridgeAugmentation.class);
  89                             if (bridge != null && bridge.getManagedBy() != null && bridge.getManagedBy().getValue().equals(nIid)) {
  90                                 changes.putAll(extractBridgeConfigurationChanges(node, bridge));
  91                             }
  92                         }
  93                         if (!changes.isEmpty()) {
  94                             reconcileBridgeConfigurations(changes);
  95                         }
  96                     }
  97                 }
  98             }
  99
 100             @Override
 101             public void onFailure(Throwable t) {
 102                 LOG.warn("Read Config/DS for Topology failed! {}", nodeIid, t);
 103             }
 104
 105         });
 106
 107         return true;
 108     }
 109
 110     private Map<InstanceIdentifier<?>, DataObject> extractBridgeConfigurationChanges(
 111             final Node bridgeNode, final OvsdbBridgeAugmentation ovsdbBridge) {
 112         Map<InstanceIdentifier<?>, DataObject> changes = new HashMap<>();
 113         final InstanceIdentifier<Node> bridgeNodeIid =
 114                 SouthboundMapper.createInstanceIdentifier(connectionInstance, ovsdbBridge.getBridgeName().getValue());
 115         final InstanceIdentifier<OvsdbBridgeAugmentation> ovsdbBridgeIid =
 116                 bridgeNodeIid.builder().augmentation(OvsdbBridgeAugmentation.class).build();
 117         changes.put(bridgeNodeIid, bridgeNode);
 118         changes.put(ovsdbBridgeIid, ovsdbBridge);
 119
 120         if (ovsdbBridge.getProtocolEntry() != null) {
 121             for (ProtocolEntry protocol : ovsdbBridge.getProtocolEntry()) {
 122                 if (SouthboundConstants.OVSDB_PROTOCOL_MAP.get(protocol.getProtocol()) != null) {
 123                     KeyedInstanceIdentifier<ProtocolEntry, ProtocolEntryKey> protocolIid =
 124                             ovsdbBridgeIid.child(ProtocolEntry.class, protocol.getKey());
 125                     changes.put(protocolIid, protocol);
 126                 } else {
 127                     throw new IllegalArgumentException("Unknown protocol " + protocol.getProtocol());
 128                 }
 129             }
 130         }
 131
 132         if (ovsdbBridge.getControllerEntry() != null) {
 133             for (ControllerEntry controller : ovsdbBridge.getControllerEntry()) {
 134                 KeyedInstanceIdentifier<ControllerEntry, ControllerEntryKey> controllerIid =
 135                         ovsdbBridgeIid.child(ControllerEntry.class, controller.getKey());
 136                 changes.put(controllerIid, controller);
 137             }
 138         }
 139
 140         return changes;
 141     }
 142
 143     private void reconcileBridgeConfigurations(final Map<InstanceIdentifier<?>, DataObject> changes) {
 144         AsyncDataChangeEvent<InstanceIdentifier<?>, DataObject> changeEvents = new AsyncDataChangeEvent() {
 145             @Override
 146             public Map<InstanceIdentifier<?>, DataObject> getCreatedData() {
 147                 return changes;
 148             }
 149
 150             @Override
 151             public Map<InstanceIdentifier<?>, DataObject> getUpdatedData() {
 152                 return Collections.emptyMap();
 153             }
 154
 155             @Override
 156             public Map<InstanceIdentifier<?>, DataObject> getOriginalData() {
 157                 return Collections.emptyMap();
 158             }
 159
 160             @Override
 161             public Set<InstanceIdentifier<?>> getRemovedPaths() {
 162                 return Collections.emptySet();
 163             }
 164
 165             @Override
 166             public DataObject getOriginalSubtree() {
 167                 return null;
 168             }
 169
 170             @Override
 171             public DataObject getUpdatedSubtree() {
 172                 return null;
 173             }
 174         };
 175
 176         connectionInstance.transact(new TransactCommandAggregator(),
 177                 new BridgeOperationalState(reconciliationManager.getDb(), changeEvents),
 178                 new DataChangesManagedByOvsdbNodeEvent(
 179                         reconciliationManager.getDb(),
 180                         connectionInstance.getInstanceIdentifier(),
 181                         changeEvents));
 182     }
 183
 184     @Override
 185     public void doRetry(boolean wasPreviousAttemptSuccessful) {
 186     }
 187
 188     @Override
 189     public void checkReadinessAndProcess() {
 190     }
 191
 192     @Override
 193     public long retryDelayInMills() {
 194         return 0;
 195     }
 196 }