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