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.opendaylight.yangtools.yang.binding.util.BindingMap;
  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     private final MdsalUtils mdsalUtils;
  76
  77     public HwvtepPhysicalPortUpdateCommand(final HwvtepConnectionInstance key, final TableUpdates updates,
  78             final DatabaseSchema dbSchema) {
  79         super(key, updates, dbSchema);
  80         updatedPPRows = TyperUtils.extractRowsUpdated(PhysicalPort.class, getUpdates(), getDbSchema());
  81         oldPPRows = TyperUtils.extractRowsOld(PhysicalPort.class, getUpdates(), getDbSchema());
  82         switchUpdatedRows = TyperUtils.extractRowsUpdated(PhysicalSwitch.class, getUpdates(), getDbSchema());
  83         skipReconciliationPorts = new HashSet<>();
  84         mdsalUtils = new MdsalUtils(key.getDataBroker());
  85         for (Entry<UUID, PhysicalPort> portUpdateEntry : updatedPPRows.entrySet()) {
  86             Optional<InstanceIdentifier<Node>> switchIid = getTerminationPointSwitch(portUpdateEntry.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(portUpdateEntry.getKey());
  92                 }
  93             }
  94         }
  95
  96     }
  97
  98     @Override
  99     public void execute(final 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(final ReadWriteTransaction transaction, final Node node) {
 113         for (Entry<UUID, PhysicalPort> portUpdateEntry : updatedPPRows.entrySet()) {
 114             PhysicalPort portUpdate = portUpdateEntry.getValue();
 115             String portName = portUpdate.getNameColumn().getData();
 116             Optional<InstanceIdentifier<Node>> switchIid = getTerminationPointSwitch(portUpdateEntry.getKey());
 117             if (!switchIid.isPresent()) {
 118                 switchIid = getFromDeviceOperCache(portUpdate.getUuid());
 119                 if (!switchIid.isPresent()) {
 120                     LOG.debug("Failed to find node from the DeviceOperCache for port {}. Get it from the DS.",
 121                             portUpdate);
 122                     switchIid = getTerminationPointSwitch(transaction, node, portName);
 123                 }
 124             }
 125             if (switchIid.isPresent()) {
 126                 TerminationPointKey tpKey = new TerminationPointKey(new TpId(portName));
 127                 TerminationPointBuilder tpBuilder = new TerminationPointBuilder();
 128                 tpBuilder.withKey(tpKey);
 129                 tpBuilder.setTpId(tpKey.getTpId());
 130                 InstanceIdentifier<TerminationPoint> tpPath = getInstanceIdentifier(switchIid.get(), portUpdate);
 131                 HwvtepPhysicalPortAugmentationBuilder tpAugmentationBuilder =
 132                         new HwvtepPhysicalPortAugmentationBuilder();
 133                 buildTerminationPoint(tpAugmentationBuilder, portUpdate);
 134                 setPortFaultStatus(tpAugmentationBuilder, portUpdate);
 135                 tpBuilder.addAugmentation(tpAugmentationBuilder.build());
 136                 if (oldPPRows.containsKey(portUpdateEntry.getKey())) {
 137                     transaction.merge(LogicalDatastoreType.OPERATIONAL, tpPath, tpBuilder.build());
 138                 } else {
 139                     transaction.put(LogicalDatastoreType.OPERATIONAL, tpPath, tpBuilder.build());
 140                 }
 141                 NodeId psNodeId = tpPath.firstKeyOf(Node.class).getNodeId();
 142                 if (getDeviceInfo().getDeviceOperData(TerminationPoint.class, tpPath) == null) {
 143                     addToDeviceUpdate(TransactionType.ADD, new PortEvent(portUpdate, psNodeId));
 144                 } else {
 145                     addToDeviceUpdate(TransactionType.UPDATE, new PortEvent(portUpdate, psNodeId));
 146                 }
 147                 reconcileToPort(portUpdate, tpPath);
 148                 addToUpdateTx(VlanBindings.class, tpPath, portUpdate.getUuid(), portUpdate);
 149                 // Update with Deleted VlanBindings
 150                 if (oldPPRows.get(portUpdateEntry.getKey()) != null
 151                         && oldPPRows.get(portUpdateEntry.getKey()).getVlanBindingsColumn() != null) {
 152                     List<InstanceIdentifier<VlanBindings>> vlanBindingsList = new ArrayList<>();
 153                     Map<Long, UUID> oldVb = oldPPRows.get(portUpdateEntry.getKey()).getVlanBindingsColumn().getData();
 154                     Map<Long, UUID> updatedVb = portUpdateEntry.getValue().getVlanBindingsColumn().getData();
 155                     for (Map.Entry<Long, UUID> oldVbEntry : oldVb.entrySet()) {
 156                         Long key = oldVbEntry.getKey();
 157                         if (!updatedVb.containsKey(key)) {
 158                             VlanBindings vlanBindings = createVlanBinding(key, oldVbEntry.getValue());
 159                             InstanceIdentifier<VlanBindings> vbIid = getInstanceIdentifier(tpPath, vlanBindings);
 160                             vlanBindingsList.add(vbIid);
 161                         }
 162                         deleteEntries(transaction, vlanBindingsList);
 163                     }
 164                 }
 165                 // Update with Deleted portfaultstatus
 166                 deleteEntries(transaction,getPortFaultStatusToRemove(tpPath, portUpdate));
 167             } else {
 168                 LOG.warn("switchIid was not found for port {}", portUpdate);
 169             }
 170         }
 171     }
 172
 173     private void reconcileToPort(final PhysicalPort portUpdate,
 174                                  final InstanceIdentifier<TerminationPoint> tpPath) {
 175         if (skipReconciliationPorts.contains(portUpdate.getUuid())) {
 176             //case of port added along with switch add
 177             //switch reconciliation will take care of this port along with other ports
 178             return;
 179         }
 180         if (getDeviceInfo().getDeviceOperData(VlanBindings.class, tpPath) != null) {
 181             //case of port update not new port add
 182             return;
 183
 184         }
 185         //case of individual port add , reconcile to this port
 186         addToUpdateTx(VlanBindings.class, tpPath, portUpdate.getUuid(), portUpdate);
 187         HwvtepDeviceInfo.DeviceData data = getDeviceInfo().getConfigData(VlanBindings.class, tpPath);
 188         if (data == null || data.getData() == null) {
 189             LOG.error("No config data present ");
 190         } else {
 191             addToDeviceUpdate(TransactionType.ADD,
 192                     new ReconcilePortEvent(portUpdate, tpPath.firstKeyOf(Node.class).getNodeId()));
 193             LOG.info("addToDeviceUpdate {}", portUpdate);
 194             getDeviceInfo().updateDeviceOperData(VlanBindings.class, tpPath,
 195                     portUpdate.getUuid(), portUpdate);
 196             getDeviceInfo().scheduleTransaction(transactionBuilder -> {
 197                 InstanceIdentifier psIid = tpPath.firstIdentifierOf(Node.class);
 198                 HwvtepOperationalState operState = new HwvtepOperationalState(getOvsdbConnectionInstance());
 199                 PhysicalPortUpdateCommand portUpdateCommand = new PhysicalPortUpdateCommand(
 200                         operState, Collections.emptyList());
 201                 TerminationPoint cfgPoint = (TerminationPoint) data.getData();
 202                 portUpdateCommand.updatePhysicalPort(transactionBuilder, psIid,
 203                             Lists.newArrayList(cfgPoint));
 204
 205             });
 206         }
 207     }
 208
 209     private static <T extends DataObject> void deleteEntries(final ReadWriteTransaction transaction,
 210             final List<InstanceIdentifier<T>> entryIids) {
 211         for (InstanceIdentifier<T> entryIid : entryIids) {
 212             transaction.delete(LogicalDatastoreType.OPERATIONAL, entryIid);
 213         }
 214     }
 215
 216     private InstanceIdentifier<VlanBindings> getInstanceIdentifier(final InstanceIdentifier<TerminationPoint> tpPath,
 217             final VlanBindings vlanBindings) {
 218         return HwvtepSouthboundMapper.createInstanceIdentifier(getOvsdbConnectionInstance(), tpPath, vlanBindings);
 219     }
 220
 221     private static InstanceIdentifier<TerminationPoint> getInstanceIdentifier(final InstanceIdentifier<Node> switchIid,
 222             final PhysicalPort port) {
 223         return switchIid.child(TerminationPoint.class, new TerminationPointKey(new TpId(port.getName())));
 224     }
 225
 226     private void buildTerminationPoint(final HwvtepPhysicalPortAugmentationBuilder tpAugmentationBuilder,
 227             final PhysicalPort portUpdate) {
 228         updatePhysicalPortId(portUpdate, tpAugmentationBuilder);
 229         updatePort(portUpdate, tpAugmentationBuilder);
 230     }
 231
 232     private void updatePort(final PhysicalPort portUpdate,
 233             final HwvtepPhysicalPortAugmentationBuilder tpAugmentationBuilder) {
 234         updateVlanBindings(portUpdate, tpAugmentationBuilder);
 235         tpAugmentationBuilder.setPhysicalPortUuid(new Uuid(portUpdate.getUuid().toString()));
 236     }
 237
 238     private static void updatePhysicalPortId(final PhysicalPort portUpdate,
 239             final HwvtepPhysicalPortAugmentationBuilder tpAugmentationBuilder) {
 240         tpAugmentationBuilder.setHwvtepNodeName(new HwvtepNodeName(portUpdate.getName()));
 241         if (portUpdate.getDescription() != null) {
 242             tpAugmentationBuilder.setHwvtepNodeDescription(portUpdate.getDescription());
 243         }
 244     }
 245
 246     private void updateVlanBindings(final PhysicalPort portUpdate,
 247             final HwvtepPhysicalPortAugmentationBuilder tpAugmentationBuilder) {
 248         Map<Long, UUID> vlanBindings = portUpdate.getVlanBindingsColumn().getData();
 249         if (vlanBindings != null && !vlanBindings.isEmpty()) {
 250             var vlanBindingsList = BindingMap.<VlanBindingsKey, VlanBindings>orderedBuilder();
 251             for (Map.Entry<Long, UUID> vlanBindingEntry : vlanBindings.entrySet()) {
 252                 Long vlanBindingKey = vlanBindingEntry.getKey();
 253                 UUID vlanBindingValue = vlanBindingEntry.getValue();
 254                 if (vlanBindingValue != null && vlanBindingKey != null) {
 255                     vlanBindingsList.add(createVlanBinding(vlanBindingKey, vlanBindingValue));
 256                 }
 257             }
 258             tpAugmentationBuilder.setVlanBindings(vlanBindingsList.build());
 259         }
 260     }
 261
 262     private VlanBindings createVlanBinding(final Long key, final UUID value) {
 263         VlanBindingsBuilder vbBuilder = new VlanBindingsBuilder();
 264         VlanBindingsKey vbKey = new VlanBindingsKey(new VlanId(key.intValue()));
 265         vbBuilder.withKey(vbKey);
 266         vbBuilder.setVlanIdKey(vbKey.getVlanIdKey());
 267         HwvtepLogicalSwitchRef switchRef = this.getLogicalSwitchRef(value);
 268         vbBuilder.setLogicalSwitchRef(switchRef);
 269         return vbBuilder.build();
 270     }
 271
 272     private HwvtepLogicalSwitchRef getLogicalSwitchRef(final UUID switchUUID) {
 273         LogicalSwitch logicalSwitch = getOvsdbConnectionInstance().getDeviceInfo().getLogicalSwitch(switchUUID);
 274         if (logicalSwitch != null) {
 275             InstanceIdentifier<LogicalSwitches> switchIid =
 276                     HwvtepSouthboundMapper.createInstanceIdentifier(getOvsdbConnectionInstance(), logicalSwitch);
 277             return new HwvtepLogicalSwitchRef(switchIid);
 278         }
 279         LOG.debug("Failed to get LogicalSwitch {}", switchUUID);
 280         LOG.trace("Available LogicalSwitches: {}",
 281                         getOvsdbConnectionInstance().getDeviceInfo().getLogicalSwitches().values());
 282         return null;
 283     }
 284
 285     private Optional<InstanceIdentifier<Node>> getTerminationPointSwitch(final UUID portUUID) {
 286         for (PhysicalSwitch updatedPhysicalSwitch : switchUpdatedRows.values()) {
 287             if (updatedPhysicalSwitch.getPortsColumn().getData().contains(portUUID)) {
 288                 return Optional.of(HwvtepSouthboundMapper.createInstanceIdentifier(getOvsdbConnectionInstance(),
 289                         updatedPhysicalSwitch));
 290             }
 291         }
 292         return Optional.empty();
 293     }
 294
 295     private static Optional<InstanceIdentifier<Node>> getTerminationPointSwitch(final ReadWriteTransaction transaction,
 296             final Node node, final String tpName) {
 297         HwvtepGlobalAugmentation hwvtepNode = node.augmentation(HwvtepGlobalAugmentation.class);
 298         Map<SwitchesKey, Switches> switchNodes = hwvtepNode.getSwitches();
 299         if (switchNodes != null && !switchNodes.isEmpty()) {
 300             for (Switches managedNodeEntry : switchNodes.values()) {
 301                 @SuppressWarnings("unchecked")
 302                 Node switchNode = HwvtepSouthboundUtil.readNode(transaction,
 303                                 (InstanceIdentifier<Node>) managedNodeEntry.getSwitchRef().getValue()).get();
 304                 TerminationPointKey tpKey = new TerminationPointKey(new TpId(tpName));
 305                 TerminationPoint terminationPoint = switchNode.nonnullTerminationPoint().get(tpKey);
 306                 if (terminationPoint != null) {
 307                     return Optional.of((InstanceIdentifier<Node>) managedNodeEntry.getSwitchRef().getValue());
 308                 }
 309             }
 310         } else {
 311             LOG.trace("PhyscialSwitch not present for the Port {}", tpName);
 312         }
 313         return Optional.empty();
 314     }
 315
 316     private static void setPortFaultStatus(final HwvtepPhysicalPortAugmentationBuilder tpAugmentationBuilder,
 317             final PhysicalPort portUpdate) {
 318         if (portUpdate.getPortFaultStatusColumn() != null && portUpdate.getPortFaultStatusColumn().getData() != null
 319                 && !portUpdate.getPortFaultStatusColumn().getData().isEmpty()) {
 320             var portFaultStatusLst = portUpdate.getPortFaultStatusColumn().getData().stream()
 321                 .map(portFaultStatus -> new PortFaultStatusBuilder().setPortFaultStatusKey(portFaultStatus).build())
 322                 .collect(BindingMap.toOrderedMap());
 323             tpAugmentationBuilder.setPortFaultStatus(portFaultStatusLst);
 324         }
 325     }
 326
 327     private List<InstanceIdentifier<PortFaultStatus>> getPortFaultStatusToRemove(
 328             final InstanceIdentifier<TerminationPoint> tpPath, final PhysicalPort port) {
 329         requireNonNull(tpPath);
 330         requireNonNull(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
 346     private  Optional<InstanceIdentifier<Node>> getFromDeviceOperCache(final UUID uuid) {
 347
 348         InstanceIdentifier<TerminationPoint> terminationPointIid =
 349                 getOvsdbConnectionInstance()
 350                 .getDeviceInfo().getDeviceOperKey(TerminationPoint.class, uuid);
 351         if (terminationPointIid != null) {
 352             return Optional.of(terminationPointIid.firstIdentifierOf(Node.class));
 353         }
 354         return Optional.empty();
 355     }
 356 }