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 package org.opendaylight.ovsdb.hwvtepsouthbound.transactions.md;
   9
  10 import static java.util.Objects.requireNonNull;
  11
  12 import com.google.common.collect.Lists;
  13 import java.util.ArrayList;
  14 import java.util.Collections;
  15 import java.util.HashSet;
  16 import java.util.List;
  17 import java.util.Map;
  18 import java.util.Map.Entry;
  19 import java.util.Optional;
  20 import java.util.Set;
  21 import org.opendaylight.mdsal.binding.api.ReadWriteTransaction;
  22 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  23 import org.opendaylight.ovsdb.hwvtepsouthbound.HwvtepConnectionInstance;
  24 import org.opendaylight.ovsdb.hwvtepsouthbound.HwvtepDeviceInfo;
  25 import org.opendaylight.ovsdb.hwvtepsouthbound.HwvtepSouthboundMapper;
  26 import org.opendaylight.ovsdb.hwvtepsouthbound.HwvtepSouthboundUtil;
  27 import org.opendaylight.ovsdb.hwvtepsouthbound.events.PortEvent;
  28 import org.opendaylight.ovsdb.hwvtepsouthbound.events.ReconcilePortEvent;
  29 import org.opendaylight.ovsdb.hwvtepsouthbound.transact.HwvtepOperationalState;
  30 import org.opendaylight.ovsdb.hwvtepsouthbound.transact.PhysicalPortUpdateCommand;
  31 import org.opendaylight.ovsdb.lib.message.TableUpdates;
  32 import org.opendaylight.ovsdb.lib.notation.UUID;
  33 import org.opendaylight.ovsdb.lib.schema.DatabaseSchema;
  34 import org.opendaylight.ovsdb.lib.schema.typed.TyperUtils;
  35 import org.opendaylight.ovsdb.schema.hardwarevtep.LogicalSwitch;
  36 import org.opendaylight.ovsdb.schema.hardwarevtep.PhysicalPort;
  37 import org.opendaylight.ovsdb.schema.hardwarevtep.PhysicalSwitch;
  38 import org.opendaylight.ovsdb.utils.mdsal.utils.MdsalUtils;
  39 import org.opendaylight.ovsdb.utils.mdsal.utils.TransactionType;
  40 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.l2.types.rev130827.VlanId;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.HwvtepGlobalAugmentation;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.HwvtepLogicalSwitchRef;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.HwvtepNodeName;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.HwvtepPhysicalPortAugmentation;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.HwvtepPhysicalPortAugmentationBuilder;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.hwvtep.global.attributes.LogicalSwitches;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.hwvtep.global.attributes.Switches;
  49 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.hwvtep.global.attributes.SwitchesKey;
  50 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.hwvtep.physical.port.attributes.PortFaultStatus;
  51 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.hwvtep.physical.port.attributes.PortFaultStatusBuilder;
  52 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.hwvtep.physical.port.attributes.PortFaultStatusKey;
  53 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.hwvtep.physical.port.attributes.VlanBindings;
  54 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.hwvtep.physical.port.attributes.VlanBindingsBuilder;
  55 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.hwvtep.physical.port.attributes.VlanBindingsKey;
  56 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
  57 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.TpId;
  58 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
  59 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.node.TerminationPoint;
  60 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.node.TerminationPointBuilder;
  61 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.node.TerminationPointKey;
  62 import org.opendaylight.yangtools.yang.binding.DataObject;
  63 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  64 import org.slf4j.Logger;
  65 import org.slf4j.LoggerFactory;
  66
  67 public class HwvtepPhysicalPortUpdateCommand extends AbstractTransactionCommand {
  68
  69     private static final Logger LOG = LoggerFactory.getLogger(HwvtepPhysicalPortUpdateCommand.class);
  70     private final Map<UUID, PhysicalPort> updatedPPRows;
  71     private final Map<UUID, PhysicalPort> oldPPRows;
  72     private final Map<UUID, PhysicalSwitch> switchUpdatedRows;
  73     private final Set<UUID> skipReconciliationPorts;
  74     private final MdsalUtils mdsalUtils;
  75
  76     public HwvtepPhysicalPortUpdateCommand(final HwvtepConnectionInstance key, final TableUpdates updates,
  77             final 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         mdsalUtils = new MdsalUtils(key.getDataBroker());
  84         for (Entry<UUID, PhysicalPort> portUpdateEntry : updatedPPRows.entrySet()) {
  85             Optional<InstanceIdentifier<Node>> switchIid = getTerminationPointSwitch(portUpdateEntry.getKey());
  86             if (switchIid.isPresent()) {
  87                 if (getDeviceInfo().getDeviceOperData(Node.class, switchIid.get()) == null) {
  88                     //This is the first update from switch do not have to do reconciliation of this port
  89                     //it is taken care by switch reconciliation
  90                     skipReconciliationPorts.add(portUpdateEntry.getKey());
  91                 }
  92             }
  93         }
  94
  95     }
  96
  97     @Override
  98     public void execute(final ReadWriteTransaction transaction) {
  99         final InstanceIdentifier<Node> connectionIId = getOvsdbConnectionInstance().getInstanceIdentifier();
 100         if (updatedPPRows.isEmpty()) {
 101             return;
 102         }
 103         LOG.trace("PhysicalPortTable updated: {}", updatedPPRows);
 104         Optional<Node> node = HwvtepSouthboundUtil.readNode(transaction, connectionIId);
 105         if (node.isPresent()) {
 106             updateTerminationPoints(transaction, node.get());
 107             // TODO: Handle Deletion of VLAN Bindings
 108         }
 109     }
 110
 111     private void updateTerminationPoints(final ReadWriteTransaction transaction, final Node node) {
 112         for (Entry<UUID, PhysicalPort> portUpdateEntry : updatedPPRows.entrySet()) {
 113             PhysicalPort portUpdate = portUpdateEntry.getValue();
 114             String portName = portUpdate.getNameColumn().getData();
 115             Optional<InstanceIdentifier<Node>> switchIid = getTerminationPointSwitch(portUpdateEntry.getKey());
 116             if (!switchIid.isPresent()) {
 117                 switchIid = getFromDeviceOperCache(portUpdate.getUuid());
 118                 if (!switchIid.isPresent()) {
 119                     LOG.debug("Failed to find node from the DeviceOperCache for port {}. Get it from the DS.",
 120                             portUpdate);
 121                     switchIid = getTerminationPointSwitch(transaction, node, portName);
 122                 }
 123             }
 124             if (switchIid.isPresent()) {
 125                 TerminationPointKey tpKey = new TerminationPointKey(new TpId(portName));
 126                 TerminationPointBuilder tpBuilder = new TerminationPointBuilder();
 127                 tpBuilder.withKey(tpKey);
 128                 tpBuilder.setTpId(tpKey.getTpId());
 129                 InstanceIdentifier<TerminationPoint> tpPath = getInstanceIdentifier(switchIid.get(), portUpdate);
 130                 HwvtepPhysicalPortAugmentationBuilder tpAugmentationBuilder =
 131                         new HwvtepPhysicalPortAugmentationBuilder();
 132                 buildTerminationPoint(tpAugmentationBuilder, portUpdate);
 133                 setPortFaultStatus(tpAugmentationBuilder, portUpdate);
 134                 tpBuilder.addAugmentation(tpAugmentationBuilder.build());
 135                 if (oldPPRows.containsKey(portUpdateEntry.getKey())) {
 136                     transaction.merge(LogicalDatastoreType.OPERATIONAL, tpPath, tpBuilder.build());
 137                 } else {
 138                     transaction.put(LogicalDatastoreType.OPERATIONAL, tpPath, tpBuilder.build());
 139                 }
 140                 NodeId psNodeId = tpPath.firstKeyOf(Node.class).getNodeId();
 141                 if (getDeviceInfo().getDeviceOperData(TerminationPoint.class, tpPath) == null) {
 142                     addToDeviceUpdate(TransactionType.ADD, new PortEvent(portUpdate, psNodeId));
 143                 } else {
 144                     addToDeviceUpdate(TransactionType.UPDATE, new PortEvent(portUpdate, psNodeId));
 145                 }
 146                 reconcileToPort(portUpdate, tpPath);
 147                 addToUpdateTx(VlanBindings.class, tpPath, portUpdate.getUuid(), portUpdate);
 148                 // Update with Deleted VlanBindings
 149                 if (oldPPRows.get(portUpdateEntry.getKey()) != null
 150                         && oldPPRows.get(portUpdateEntry.getKey()).getVlanBindingsColumn() != null) {
 151                     List<InstanceIdentifier<VlanBindings>> vlanBindingsList = new ArrayList<>();
 152                     Map<Long, UUID> oldVb = oldPPRows.get(portUpdateEntry.getKey()).getVlanBindingsColumn().getData();
 153                     Map<Long, UUID> updatedVb = portUpdateEntry.getValue().getVlanBindingsColumn().getData();
 154                     for (Map.Entry<Long, UUID> oldVbEntry : oldVb.entrySet()) {
 155                         Long key = oldVbEntry.getKey();
 156                         if (!updatedVb.containsKey(key)) {
 157                             VlanBindings vlanBindings = createVlanBinding(key, oldVbEntry.getValue());
 158                             InstanceIdentifier<VlanBindings> vbIid = getInstanceIdentifier(tpPath, vlanBindings);
 159                             vlanBindingsList.add(vbIid);
 160                         }
 161                         deleteEntries(transaction, vlanBindingsList);
 162                     }
 163                 }
 164                 // Update with Deleted portfaultstatus
 165                 deleteEntries(transaction,getPortFaultStatusToRemove(tpPath, portUpdate));
 166             } else {
 167                 LOG.warn("switchIid was not found for port {}", portUpdate);
 168             }
 169         }
 170     }
 171
 172     private void reconcileToPort(final PhysicalPort portUpdate,
 173                                  final InstanceIdentifier<TerminationPoint> tpPath) {
 174         if (skipReconciliationPorts.contains(portUpdate.getUuid())) {
 175             //case of port added along with switch add
 176             //switch reconciliation will take care of this port along with other ports
 177             return;
 178         }
 179         if (getDeviceInfo().getDeviceOperData(VlanBindings.class, tpPath) != null) {
 180             //case of port update not new port add
 181             return;
 182
 183         }
 184         //case of individual port add , reconcile to this port
 185         addToUpdateTx(VlanBindings.class, tpPath, portUpdate.getUuid(), portUpdate);
 186         HwvtepDeviceInfo.DeviceData data = getDeviceInfo().getConfigData(VlanBindings.class, tpPath);
 187         if (data == null || data.getData() == null) {
 188             LOG.error("No config data present ");
 189         } else {
 190             addToDeviceUpdate(TransactionType.ADD,
 191                     new ReconcilePortEvent(portUpdate, tpPath.firstKeyOf(Node.class).getNodeId()));
 192             LOG.info("addToDeviceUpdate {}", portUpdate);
 193             getDeviceInfo().updateDeviceOperData(VlanBindings.class, tpPath,
 194                     portUpdate.getUuid(), portUpdate);
 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.emptyList());
 200                 TerminationPoint cfgPoint = (TerminationPoint) data.getData();
 201                 portUpdateCommand.updatePhysicalPort(transactionBuilder, psIid,
 202                             Lists.newArrayList(cfgPoint));
 203
 204             });
 205         }
 206     }
 207
 208     private static <T extends DataObject> void deleteEntries(final ReadWriteTransaction transaction,
 209             final List<InstanceIdentifier<T>> entryIids) {
 210         for (InstanceIdentifier<T> entryIid : entryIids) {
 211             transaction.delete(LogicalDatastoreType.OPERATIONAL, entryIid);
 212         }
 213     }
 214
 215     private InstanceIdentifier<VlanBindings> getInstanceIdentifier(final InstanceIdentifier<TerminationPoint> tpPath,
 216             final VlanBindings vlanBindings) {
 217         return HwvtepSouthboundMapper.createInstanceIdentifier(getOvsdbConnectionInstance(), tpPath, vlanBindings);
 218     }
 219
 220     private static InstanceIdentifier<TerminationPoint> getInstanceIdentifier(final InstanceIdentifier<Node> switchIid,
 221             final PhysicalPort port) {
 222         return switchIid.child(TerminationPoint.class, new TerminationPointKey(new TpId(port.getName())));
 223     }
 224
 225     private void buildTerminationPoint(final HwvtepPhysicalPortAugmentationBuilder tpAugmentationBuilder,
 226             final PhysicalPort portUpdate) {
 227         updatePhysicalPortId(portUpdate, tpAugmentationBuilder);
 228         updatePort(portUpdate, tpAugmentationBuilder);
 229     }
 230
 231     private void updatePort(final PhysicalPort portUpdate,
 232             final HwvtepPhysicalPortAugmentationBuilder tpAugmentationBuilder) {
 233         updateVlanBindings(portUpdate, tpAugmentationBuilder);
 234         tpAugmentationBuilder.setPhysicalPortUuid(new Uuid(portUpdate.getUuid().toString()));
 235     }
 236
 237     private static void updatePhysicalPortId(final PhysicalPort portUpdate,
 238             final 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(final PhysicalPort portUpdate,
 246             final 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(final Long key, final UUID value) {
 262         VlanBindingsBuilder vbBuilder = new VlanBindingsBuilder();
 263         VlanBindingsKey vbKey = new VlanBindingsKey(new VlanId(key.intValue()));
 264         vbBuilder.withKey(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(final 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(final 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.empty();
 292     }
 293
 294     private static Optional<InstanceIdentifier<Node>> getTerminationPointSwitch(final ReadWriteTransaction transaction,
 295             final Node node, final String tpName) {
 296         HwvtepGlobalAugmentation hwvtepNode = node.augmentation(HwvtepGlobalAugmentation.class);
 297         Map<SwitchesKey, Switches> switchNodes = hwvtepNode.getSwitches();
 298         if (switchNodes != null && !switchNodes.isEmpty()) {
 299             for (Switches managedNodeEntry : switchNodes.values()) {
 300                 @SuppressWarnings("unchecked")
 301                 Node switchNode = HwvtepSouthboundUtil.readNode(transaction,
 302                                 (InstanceIdentifier<Node>) managedNodeEntry.getSwitchRef().getValue()).get();
 303                 TerminationPointKey tpKey = new TerminationPointKey(new TpId(tpName));
 304                 TerminationPoint terminationPoint = switchNode.nonnullTerminationPoint().get(tpKey);
 305                 if (terminationPoint != null) {
 306                     return Optional.of((InstanceIdentifier<Node>) managedNodeEntry.getSwitchRef().getValue());
 307                 }
 308             }
 309         } else {
 310             LOG.trace("PhyscialSwitch not present for the Port {}", tpName);
 311         }
 312         return Optional.empty();
 313     }
 314
 315     private static void setPortFaultStatus(final HwvtepPhysicalPortAugmentationBuilder tpAugmentationBuilder,
 316             final PhysicalPort portUpdate) {
 317         if (portUpdate.getPortFaultStatusColumn() != null && portUpdate.getPortFaultStatusColumn().getData() != null
 318                 && !portUpdate.getPortFaultStatusColumn().getData().isEmpty()) {
 319             List<PortFaultStatus> portFaultStatusLst = new ArrayList<>();
 320             for (String portFaultStatus : portUpdate.getPortFaultStatusColumn().getData()) {
 321                 portFaultStatusLst.add(new PortFaultStatusBuilder().withKey(new PortFaultStatusKey(portFaultStatus))
 322                         .setPortFaultStatusKey(portFaultStatus).build());
 323             }
 324             tpAugmentationBuilder.setPortFaultStatus(portFaultStatusLst);
 325         }
 326     }
 327
 328     private List<InstanceIdentifier<PortFaultStatus>> getPortFaultStatusToRemove(
 329             final InstanceIdentifier<TerminationPoint> tpPath, final PhysicalPort port) {
 330         requireNonNull(tpPath);
 331         requireNonNull(port);
 332         List<InstanceIdentifier<PortFaultStatus>> result = new ArrayList<>();
 333         PhysicalPort oldPort = oldPPRows.get(port.getUuid());
 334         if (oldPort != null && oldPort.getPortFaultStatusColumn() != null) {
 335             for (String portFltStat : oldPort.getPortFaultStatusColumn().getData()) {
 336                 if (port.getPortFaultStatusColumn() == null
 337                         || !port.getPortFaultStatusColumn().getData().contains(portFltStat)) {
 338                     InstanceIdentifier<PortFaultStatus> iid = tpPath.augmentation(HwvtepPhysicalPortAugmentation.class)
 339                             .child(PortFaultStatus.class, new PortFaultStatusKey(portFltStat));
 340                     result.add(iid);
 341                 }
 342             }
 343         }
 344         return result;
 345     }
 346
 347     private  Optional<InstanceIdentifier<Node>> getFromDeviceOperCache(final UUID uuid) {
 348
 349         InstanceIdentifier<TerminationPoint> terminationPointIid =
 350                 getOvsdbConnectionInstance()
 351                 .getDeviceInfo().getDeviceOperKey(TerminationPoint.class, uuid);
 352         if (terminationPointIid != null) {
 353             return Optional.of(terminationPointIid.firstIdentifierOf(Node.class));
 354         }
 355         return Optional.empty();
 356     }
 357 }