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