hwvtepsouthbound/hwvtepsouthbound-impl/src/main/java/org/opendaylight/ovsdb/hwvtepsouthbound/transactions/md/HwvtepPhysicalPortUpdateCommand.java

   1 /*
   2  * Copyright (c) 2015, 2017 Ericsson India Global Services Pvt Ltd. 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
   9 package org.opendaylight.ovsdb.hwvtepsouthbound.transactions.md;
  10
  11 import java.util.ArrayList;
  12 import java.util.Collections;
  13 import java.util.HashMap;
  14 import java.util.HashSet;
  15 import java.util.List;
  16 import java.util.Map;
  17 import java.util.Map.Entry;
  18 import java.util.Set;
  19
  20 import com.google.common.collect.Lists;
  21 import com.google.common.util.concurrent.FutureCallback;
  22 import com.google.common.util.concurrent.Futures;
  23 import org.opendaylight.controller.md.sal.binding.api.ReadOnlyTransaction;
  24 import org.opendaylight.controller.md.sal.binding.api.ReadWriteTransaction;
  25 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  26 import org.opendaylight.ovsdb.hwvtepsouthbound.HwvtepConnectionInstance;
  27 import org.opendaylight.ovsdb.hwvtepsouthbound.HwvtepSouthboundMapper;
  28 import org.opendaylight.ovsdb.hwvtepsouthbound.HwvtepSouthboundUtil;
  29 import org.opendaylight.ovsdb.hwvtepsouthbound.events.PortEvent;
  30 import org.opendaylight.ovsdb.hwvtepsouthbound.events.ReconcilePortEvent;
  31 import org.opendaylight.ovsdb.hwvtepsouthbound.transact.HwvtepOperationalState;
  32 import org.opendaylight.ovsdb.hwvtepsouthbound.transact.PhysicalPortUpdateCommand;
  33 import org.opendaylight.ovsdb.lib.message.TableUpdates;
  34 import org.opendaylight.ovsdb.lib.notation.UUID;
  35 import org.opendaylight.ovsdb.lib.schema.DatabaseSchema;
  36 import org.opendaylight.ovsdb.lib.schema.typed.TyperUtils;
  37 import org.opendaylight.ovsdb.schema.hardwarevtep.LogicalSwitch;
  38 import org.opendaylight.ovsdb.schema.hardwarevtep.PhysicalPort;
  39 import org.opendaylight.ovsdb.schema.hardwarevtep.PhysicalSwitch;
  40 import org.opendaylight.ovsdb.utils.mdsal.utils.TransactionType;
  41 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.l2.types.rev130827.VlanId;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.HwvtepGlobalAugmentation;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.HwvtepLogicalSwitchRef;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.HwvtepNodeName;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.HwvtepPhysicalPortAugmentation;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.HwvtepPhysicalPortAugmentationBuilder;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.PhysicalSwitchAugmentation;
  49 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.hwvtep.global.attributes.LogicalSwitches;
  50 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.hwvtep.global.attributes.Switches;
  51 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.hwvtep.physical.port.attributes.PortFaultStatus;
  52 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.hwvtep.physical.port.attributes.PortFaultStatusBuilder;
  53 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.hwvtep.physical.port.attributes.PortFaultStatusKey;
  54 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.hwvtep.physical.port.attributes.VlanBindings;
  55 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.hwvtep.physical.port.attributes.VlanBindingsBuilder;
  56 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.hwvtep.physical.port.attributes.VlanBindingsKey;
  57 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
  58 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.TpId;
  59 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
  60 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.node.TerminationPoint;
  61 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.node.TerminationPointBuilder;
  62 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.node.TerminationPointKey;
  63 import org.opendaylight.yangtools.yang.binding.DataObject;
  64 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  65 import org.slf4j.Logger;
  66 import org.slf4j.LoggerFactory;
  67
  68 import com.google.common.base.Optional;
  69 import com.google.common.base.Preconditions;
  70
  71 public class HwvtepPhysicalPortUpdateCommand extends AbstractTransactionCommand {
  72
  73     private static final Logger LOG = LoggerFactory.getLogger(HwvtepPhysicalPortUpdateCommand.class);
  74     private Map<UUID, PhysicalPort> updatedPPRows;
  75     private Map<UUID, PhysicalPort> oldPPRows;
  76     private Map<UUID, PhysicalSwitch> switchUpdatedRows;
  77     private Set<UUID> skipReconciliationPorts;
  78
  79     public HwvtepPhysicalPortUpdateCommand(HwvtepConnectionInstance key, TableUpdates updates, DatabaseSchema dbSchema) {
  80         super(key, updates, dbSchema);
  81         updatedPPRows = TyperUtils.extractRowsUpdated(PhysicalPort.class, getUpdates(), getDbSchema());
  82         oldPPRows = TyperUtils.extractRowsOld(PhysicalPort.class, getUpdates(), getDbSchema());
  83         switchUpdatedRows = TyperUtils.extractRowsUpdated(PhysicalSwitch.class, getUpdates(), getDbSchema());
  84         skipReconciliationPorts = new HashSet<>();
  85         for (Entry<UUID, PhysicalPort> pPortUpdateEntry : updatedPPRows.entrySet()) {
  86             Optional<InstanceIdentifier<Node>> switchIid = getTerminationPointSwitch(pPortUpdateEntry.getKey());
  87             if (switchIid.isPresent()) {
  88                 if (getDeviceInfo().getDeviceOperData(Node.class, switchIid.get()) == null) {
  89                     //This is the first update from switch do not have to do reconciliation of this port
  90                     //it is taken care by switch reconciliation
  91                     skipReconciliationPorts.add(pPortUpdateEntry.getKey());
  92                 }
  93             }
  94         }
  95
  96     }
  97
  98     @Override
  99     public void execute(ReadWriteTransaction transaction) {
 100         final InstanceIdentifier<Node> connectionIId = getOvsdbConnectionInstance().getInstanceIdentifier();
 101         if (updatedPPRows.isEmpty()) {
 102             return;
 103         }
 104         LOG.trace("PhysicalPortTable updated: {}", updatedPPRows);
 105         Optional<Node> node = HwvtepSouthboundUtil.readNode(transaction, connectionIId);
 106         if (node.isPresent()) {
 107             updateTerminationPoints(transaction, node.get());
 108             // TODO: Handle Deletion of VLAN Bindings
 109         }
 110     }
 111
 112     private void updateTerminationPoints(ReadWriteTransaction transaction, Node node) {
 113         for (Entry<UUID, PhysicalPort> pPortUpdateEntry : updatedPPRows.entrySet()) {
 114             PhysicalPort pPortUpdate = pPortUpdateEntry.getValue();
 115             String portName = pPortUpdate.getNameColumn().getData();
 116             Optional<InstanceIdentifier<Node>> switchIid = getTerminationPointSwitch(pPortUpdateEntry.getKey());
 117             if (!switchIid.isPresent()) {
 118                 switchIid = getTerminationPointSwitch(transaction, node, portName);
 119             }
 120             if (switchIid.isPresent()) {
 121                 TerminationPointKey tpKey = new TerminationPointKey(new TpId(portName));
 122                 TerminationPointBuilder tpBuilder = new TerminationPointBuilder();
 123                 tpBuilder.setKey(tpKey);
 124                 tpBuilder.setTpId(tpKey.getTpId());
 125                 InstanceIdentifier<TerminationPoint> tpPath = getInstanceIdentifier(switchIid.get(), pPortUpdate);
 126                 HwvtepPhysicalPortAugmentationBuilder tpAugmentationBuilder =
 127                         new HwvtepPhysicalPortAugmentationBuilder();
 128                 buildTerminationPoint(tpAugmentationBuilder, pPortUpdate);
 129                 setPortFaultStatus(tpAugmentationBuilder, pPortUpdate);
 130                 tpBuilder.addAugmentation(HwvtepPhysicalPortAugmentation.class, tpAugmentationBuilder.build());
 131                 if (oldPPRows.containsKey(pPortUpdateEntry.getKey())) {
 132                     transaction.merge(LogicalDatastoreType.OPERATIONAL, tpPath, tpBuilder.build());
 133                 } else {
 134                     transaction.put(LogicalDatastoreType.OPERATIONAL, tpPath, tpBuilder.build());
 135                 }
 136                 NodeId psNodeId = tpPath.firstKeyOf(Node.class).getNodeId();
 137                 if (getDeviceInfo().getDeviceOperData(TerminationPoint.class, tpPath) == null) {
 138                     addToDeviceUpdate(TransactionType.ADD, new PortEvent(pPortUpdate, psNodeId));
 139                 } else {
 140                     addToDeviceUpdate(TransactionType.UPDATE, new PortEvent(pPortUpdate, psNodeId));
 141                 }
 142                 reconcileToPort(transaction, pPortUpdate, tpPath);
 143                 getDeviceInfo().updateDeviceOperData(TerminationPoint.class, tpPath,
 144                         pPortUpdate.getUuid(), pPortUpdate);
 145                 // Update with Deleted VlanBindings
 146                 if (oldPPRows.get(pPortUpdateEntry.getKey()) != null
 147                         && oldPPRows.get(pPortUpdateEntry.getKey()).getVlanBindingsColumn() != null) {
 148                     List<InstanceIdentifier<VlanBindings>> vBIiList = new ArrayList<>();
 149                     Map<Long, UUID> oldVb = oldPPRows.get(pPortUpdateEntry.getKey()).getVlanBindingsColumn().getData();
 150                     Map<Long, UUID> updatedVb = pPortUpdateEntry.getValue().getVlanBindingsColumn().getData();
 151                     for (Map.Entry<Long, UUID> oldVbEntry : oldVb.entrySet()) {
 152                         Long key = oldVbEntry.getKey();
 153                         if (!updatedVb.containsKey(key)) {
 154                             VlanBindings vBindings = createVlanBinding(key, oldVbEntry.getValue());
 155                             InstanceIdentifier<VlanBindings> vBid = getInstanceIdentifier(tpPath, vBindings);
 156                             vBIiList.add(vBid);
 157                         }
 158                         deleteEntries(transaction, vBIiList);
 159                     }
 160                 }
 161                 // Update with Deleted portfaultstatus
 162                 deleteEntries(transaction,getPortFaultStatusToRemove( tpPath, pPortUpdate));
 163             }
 164         }
 165     }
 166
 167     private void reconcileToPort(final ReadWriteTransaction transaction,
 168                                  final PhysicalPort pPortUpdate,
 169                                  final InstanceIdentifier<TerminationPoint> tpPath) {
 170         if (skipReconciliationPorts.contains(pPortUpdate.getUuid())) {
 171             //case of port added along with switch add
 172             //switch reconciliation will take care of this port along with other ports
 173             return;
 174         }
 175         if (getDeviceInfo().getDeviceOperData(TerminationPoint.class, tpPath) != null) {
 176             //case of port update not new port add
 177             return;
 178         }
 179         //case of individual port add , reconcile to this port
 180         getDeviceInfo().updateDeviceOperData(TerminationPoint.class, tpPath, pPortUpdate.getUuid(), pPortUpdate);
 181         Futures.addCallback(transaction.read(LogicalDatastoreType.CONFIGURATION, tpPath),
 182                 new FutureCallback<Optional<TerminationPoint>>() {
 183                     @Override
 184                     public void onSuccess(Optional<TerminationPoint> optionalConfigTp) {
 185                         if (!optionalConfigTp.isPresent() || optionalConfigTp.get().getAugmentation(
 186                                 HwvtepPhysicalPortAugmentation.class) == null) {
 187                             //TODO port came with some vlan bindings clean them up use PortRemovedCommand
 188                             return;
 189                         }
 190                         addToDeviceUpdate(TransactionType.ADD,
 191                                 new ReconcilePortEvent(pPortUpdate, tpPath.firstKeyOf(Node.class).getNodeId()));
 192                         getDeviceInfo().updateDeviceOperData(TerminationPoint.class, tpPath,
 193                                 pPortUpdate.getUuid(), pPortUpdate);
 194                         TerminationPoint configTp = optionalConfigTp.get();
 195                         getDeviceInfo().scheduleTransaction((transactionBuilder) -> {
 196                             InstanceIdentifier psIid = tpPath.firstIdentifierOf(Node.class);
 197                             HwvtepOperationalState operState = new HwvtepOperationalState(getOvsdbConnectionInstance());
 198                             PhysicalPortUpdateCommand portUpdateCommand = new PhysicalPortUpdateCommand(
 199                                     operState, Collections.EMPTY_LIST);
 200                             portUpdateCommand.updatePhysicalPort(transactionBuilder, psIid,
 201                                     Lists.newArrayList(configTp.getAugmentation(HwvtepPhysicalPortAugmentation.class)));
 202                         });
 203                     }
 204
 205                     @Override
 206                     public void onFailure(Throwable throwable) {
 207                     }
 208                 });
 209     }
 210
 211     private <T extends DataObject> void deleteEntries(ReadWriteTransaction transaction,
 212             List<InstanceIdentifier<T>> entryIids) {
 213         for (InstanceIdentifier<T> entryIid : entryIids) {
 214             transaction.delete(LogicalDatastoreType.OPERATIONAL, entryIid);
 215         }
 216     }
 217
 218     private InstanceIdentifier<VlanBindings> getInstanceIdentifier(InstanceIdentifier<TerminationPoint> tpPath,
 219             VlanBindings vBindings) {
 220         return HwvtepSouthboundMapper.createInstanceIdentifier(getOvsdbConnectionInstance(), tpPath, vBindings);
 221     }
 222
 223     private void buildTerminationPoint(HwvtepPhysicalPortAugmentationBuilder tpAugmentationBuilder,
 224             PhysicalPort portUpdate) {
 225         updatePhysicalPortId(portUpdate, tpAugmentationBuilder);
 226         updatePort(portUpdate, tpAugmentationBuilder);
 227     }
 228
 229     private void updatePort(PhysicalPort portUpdate, HwvtepPhysicalPortAugmentationBuilder tpAugmentationBuilder) {
 230         updateVlanBindings(portUpdate, tpAugmentationBuilder);
 231         tpAugmentationBuilder.setPhysicalPortUuid(new Uuid(portUpdate.getUuid().toString()));
 232     }
 233
 234     private void updatePhysicalPortId(PhysicalPort portUpdate,
 235             HwvtepPhysicalPortAugmentationBuilder tpAugmentationBuilder) {
 236         tpAugmentationBuilder.setHwvtepNodeName(new HwvtepNodeName(portUpdate.getName()));
 237         if (portUpdate.getDescription() != null) {
 238             tpAugmentationBuilder.setHwvtepNodeDescription(portUpdate.getDescription());
 239         }
 240     }
 241
 242     private void updateVlanBindings(PhysicalPort portUpdate,
 243             HwvtepPhysicalPortAugmentationBuilder tpAugmentationBuilder) {
 244         Map<Long, UUID> vlanBindings = portUpdate.getVlanBindingsColumn().getData();
 245         if (vlanBindings != null && !vlanBindings.isEmpty()) {
 246             List<VlanBindings> vlanBindingsList = new ArrayList<>();
 247             for (Map.Entry<Long, UUID> vlanBindingEntry : vlanBindings.entrySet()) {
 248                 Long vlanBindingKey = vlanBindingEntry.getKey();
 249                 UUID vlanBindingValue = vlanBindingEntry.getValue();
 250                 if (vlanBindingValue != null && vlanBindingKey != null) {
 251                     vlanBindingsList.add(createVlanBinding(vlanBindingKey, vlanBindingValue));
 252                 }
 253             }
 254             tpAugmentationBuilder.setVlanBindings(vlanBindingsList);
 255         }
 256     }
 257
 258     private VlanBindings createVlanBinding(Long key, UUID value) {
 259         VlanBindingsBuilder vbBuilder = new VlanBindingsBuilder();
 260         VlanBindingsKey vbKey = new VlanBindingsKey(new VlanId(key.intValue()));
 261         vbBuilder.setKey(vbKey);
 262         vbBuilder.setVlanIdKey(vbKey.getVlanIdKey());
 263         HwvtepLogicalSwitchRef lSwitchRef = this.getLogicalSwitchRef(value);
 264         vbBuilder.setLogicalSwitchRef(lSwitchRef);
 265         return vbBuilder.build();
 266     }
 267
 268     private HwvtepLogicalSwitchRef getLogicalSwitchRef(UUID switchUUID) {
 269         LogicalSwitch logicalSwitch = getOvsdbConnectionInstance().getDeviceInfo().getLogicalSwitch(switchUUID);
 270         if (logicalSwitch != null) {
 271             InstanceIdentifier<LogicalSwitches> lSwitchIid =
 272                     HwvtepSouthboundMapper.createInstanceIdentifier(getOvsdbConnectionInstance(), logicalSwitch);
 273             return new HwvtepLogicalSwitchRef(lSwitchIid);
 274         }
 275         LOG.debug("Failed to get LogicalSwitch {}", switchUUID);
 276         LOG.trace("Available LogicalSwitches: {}",
 277                         getOvsdbConnectionInstance().getDeviceInfo().getLogicalSwitches().values());
 278         return null;
 279     }
 280
 281     private Optional<InstanceIdentifier<Node>> getTerminationPointSwitch(UUID portUUID) {
 282         for (PhysicalSwitch updatedPhysicalSwitch : switchUpdatedRows.values()) {
 283             if (updatedPhysicalSwitch.getPortsColumn().getData().contains(portUUID)) {
 284                 return Optional.of(HwvtepSouthboundMapper.createInstanceIdentifier(getOvsdbConnectionInstance(),
 285                         updatedPhysicalSwitch));
 286             }
 287         }
 288         return Optional.absent();
 289     }
 290
 291     private Optional<InstanceIdentifier<Node>> getTerminationPointSwitch(final ReadWriteTransaction transaction,
 292             Node node, String tpName) {
 293         HwvtepGlobalAugmentation hwvtepNode = node.getAugmentation(HwvtepGlobalAugmentation.class);
 294         List<Switches> switchNodes = hwvtepNode.getSwitches();
 295         for (Switches managedNodeEntry : switchNodes) {
 296             @SuppressWarnings("unchecked")
 297             Node switchNode = HwvtepSouthboundUtil
 298                     .readNode(transaction, (InstanceIdentifier<Node>) managedNodeEntry.getSwitchRef().getValue()).get();
 299             TerminationPointKey tpKey = new TerminationPointKey(new TpId(tpName));
 300             if (switchNode.getTerminationPoint() != null) {
 301                 for (TerminationPoint terminationPoint : switchNode.getTerminationPoint()) {
 302                     if (terminationPoint.getKey().equals(tpKey)) {
 303                         return Optional.of((InstanceIdentifier<Node>) managedNodeEntry.getSwitchRef().getValue());
 304                     }
 305                 }
 306             }
 307         }
 308         return Optional.absent();
 309     }
 310
 311     private InstanceIdentifier<TerminationPoint> getInstanceIdentifier(InstanceIdentifier<Node> switchIid,
 312             PhysicalPort pPort) {
 313         return switchIid.child(TerminationPoint.class, new TerminationPointKey(new TpId(pPort.getName())));
 314     }
 315
 316     private void setPortFaultStatus(HwvtepPhysicalPortAugmentationBuilder tpAugmentationBuilder,
 317             PhysicalPort portUpdate) {
 318         if (portUpdate.getPortFaultStatusColumn() != null && portUpdate.getPortFaultStatusColumn().getData() != null
 319                 && !portUpdate.getPortFaultStatusColumn().getData().isEmpty()) {
 320             List<PortFaultStatus> portFaultStatusLst = new ArrayList<>();
 321             for (String portFaultStatus : portUpdate.getPortFaultStatusColumn().getData()) {
 322                 portFaultStatusLst.add(new PortFaultStatusBuilder().setKey(new PortFaultStatusKey(portFaultStatus))
 323                         .setPortFaultStatusKey(portFaultStatus).build());
 324             }
 325             tpAugmentationBuilder.setPortFaultStatus(portFaultStatusLst);
 326         }
 327     }
 328
 329     private List<InstanceIdentifier<PortFaultStatus>> getPortFaultStatusToRemove(
 330             InstanceIdentifier<TerminationPoint> tpPath, PhysicalPort pPort) {
 331         Preconditions.checkNotNull(tpPath);
 332         Preconditions.checkNotNull(pPort);
 333         List<InstanceIdentifier<PortFaultStatus>> result = new ArrayList<>();
 334         PhysicalPort oldPort = oldPPRows.get(pPort.getUuid());
 335         if (oldPort != null && oldPort.getPortFaultStatusColumn() != null) {
 336             for (String portFltStat : oldPort.getPortFaultStatusColumn().getData()) {
 337                 if (pPort.getPortFaultStatusColumn() == null
 338                         || !pPort.getPortFaultStatusColumn().getData().contains(portFltStat)) {
 339                     InstanceIdentifier<PortFaultStatus> iid = tpPath.augmentation(HwvtepPhysicalPortAugmentation.class)
 340                             .child(PortFaultStatus.class, new PortFaultStatusKey(portFltStat));
 341                     result.add(iid);
 342                 }
 343             }
 344         }
 345         return result;
 346     }
 347
 348 }