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