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