southbound/southbound-impl/src/main/java/org/opendaylight/ovsdb/southbound/ovsdb/transact/TerminationPointUpdateCommand.java

   1 /*
   2  * Copyright (c) 2015, 2016 Brocade Communications Systems, Inc. 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.southbound.ovsdb.transact;
   9
  10 import static org.opendaylight.ovsdb.lib.operations.Operations.op;
  11 import static org.opendaylight.ovsdb.southbound.SouthboundUtil.schemaMismatchLog;
  12
  13 import java.util.Collection;
  14 import java.util.HashMap;
  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.Set;
  20 import java.util.concurrent.ExecutionException;
  21
  22 import org.opendaylight.controller.md.sal.binding.api.DataTreeModification;
  23 import org.opendaylight.controller.md.sal.binding.api.ReadOnlyTransaction;
  24 import org.opendaylight.controller.md.sal.common.api.data.AsyncDataChangeEvent;
  25 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  26 import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
  27 import org.opendaylight.ovsdb.lib.error.SchemaVersionMismatchException;
  28 import org.opendaylight.ovsdb.lib.notation.UUID;
  29 import org.opendaylight.ovsdb.lib.operations.TransactionBuilder;
  30 import org.opendaylight.ovsdb.lib.schema.typed.TyperUtils;
  31 import org.opendaylight.ovsdb.schema.openvswitch.Interface;
  32 import org.opendaylight.ovsdb.schema.openvswitch.Port;
  33 import org.opendaylight.ovsdb.southbound.OvsdbConnectionInstance;
  34 import org.opendaylight.ovsdb.southbound.SouthboundConstants;
  35 import org.opendaylight.ovsdb.southbound.SouthboundProvider;
  36 import org.opendaylight.ovsdb.utils.yang.YangUtils;
  37 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.Uri;
  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.params.xml.ns.yang.ovsdb.rev150105.OvsdbPortInterfaceAttributes.VlanMode;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbBridgeAugmentation;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbNodeAugmentation;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbQosRef;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbTerminationPointAugmentation;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.node.attributes.QosEntries;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.node.attributes.Queues;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes.InterfaceBfd;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes.InterfaceExternalIds;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes.InterfaceLldp;
  49 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes.InterfaceOtherConfigs;
  50 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes.Options;
  51 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes.PortExternalIds;
  52 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes.PortOtherConfigs;
  53 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes.Trunks;
  54 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
  55 import org.opendaylight.yangtools.yang.binding.DataObject;
  56 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  57 import org.slf4j.Logger;
  58 import org.slf4j.LoggerFactory;
  59
  60 import com.google.common.base.Optional;
  61 import com.google.common.collect.Sets;
  62 import com.google.common.util.concurrent.CheckedFuture;
  63
  64 public class TerminationPointUpdateCommand implements TransactCommand {
  65
  66     private static final Logger LOG = LoggerFactory.getLogger(TerminationPointUpdateCommand.class);
  67
  68     @Override
  69     public void execute(TransactionBuilder transaction, BridgeOperationalState state,
  70                         AsyncDataChangeEvent<InstanceIdentifier<?>, DataObject> events) {
  71         execute(transaction, state, TransactUtils.extractCreatedOrUpdated(events, OvsdbTerminationPointAugmentation.class));
  72     }
  73
  74     @Override
  75     public void execute(TransactionBuilder transaction, BridgeOperationalState state,
  76                         Collection<DataTreeModification<Node>> modifications) {
  77         execute(transaction, state,
  78                 TransactUtils.extractCreatedOrUpdated(modifications, OvsdbTerminationPointAugmentation.class));
  79     }
  80
  81     private void execute(TransactionBuilder transaction, BridgeOperationalState state,
  82                          Map<InstanceIdentifier<OvsdbTerminationPointAugmentation>,
  83                                  OvsdbTerminationPointAugmentation> createdOrUpdated) {
  84         LOG.trace("TerminationPointUpdateCommand called");
  85         for (Entry<InstanceIdentifier<OvsdbTerminationPointAugmentation>,
  86                 OvsdbTerminationPointAugmentation> terminationPointEntry : createdOrUpdated.entrySet()) {
  87             updateTerminationPoint(transaction, state, terminationPointEntry.getKey(), terminationPointEntry.getValue());
  88         }
  89     }
  90
  91     public void updateTerminationPoint(TransactionBuilder transaction, BridgeOperationalState state,
  92                                        InstanceIdentifier<OvsdbTerminationPointAugmentation> iid,
  93                                        OvsdbTerminationPointAugmentation terminationPoint) {
  94         if (terminationPoint != null) {
  95             LOG.debug("Received request to update termination point {}",
  96                     terminationPoint.getName());
  97
  98             // Update interface
  99             Interface ovsInterface =
 100                     TyperUtils.getTypedRowWrapper(transaction.getDatabaseSchema(), Interface.class);
 101             updateInterface(terminationPoint, ovsInterface);
 102             Interface extraInterface = TyperUtils.getTypedRowWrapper(
 103                     transaction.getDatabaseSchema(), Interface.class);
 104             extraInterface.setName("");
 105             transaction.add(op.update(ovsInterface)
 106                     .where(extraInterface.getNameColumn().getSchema().opEqual(terminationPoint.getName()))
 107                     .build());
 108
 109             TerminationPointCreateCommand.stampInstanceIdentifier(transaction,
 110                     iid.firstIdentifierOf(OvsdbTerminationPointAugmentation.class), terminationPoint.getName());
 111
 112             // Update port
 113             OvsdbBridgeAugmentation operBridge = state.getBridgeNode(iid).get().getAugmentation(OvsdbBridgeAugmentation.class);
 114             Port port = TyperUtils.getTypedRowWrapper(
 115                     transaction.getDatabaseSchema(), Port.class);
 116             updatePort(terminationPoint, port, operBridge);
 117             Port extraPort = TyperUtils.getTypedRowWrapper(
 118                     transaction.getDatabaseSchema(), Port.class);
 119             extraPort.setName("");
 120             transaction.add(op.update(port)
 121                     .where(extraPort.getNameColumn().getSchema().opEqual(terminationPoint.getName()))
 122                     .build());
 123         }
 124     }
 125
 126     private void updateInterface(
 127             final OvsdbTerminationPointAugmentation terminationPoint,
 128             final Interface ovsInterface) {
 129         updateOfPort(terminationPoint, ovsInterface);
 130         updateOfPortRequest(terminationPoint, ovsInterface);
 131         updateInterfaceOptions(terminationPoint, ovsInterface);
 132         updateInterfaceOtherConfig(terminationPoint, ovsInterface);
 133         updateInterfaceExternalIds(terminationPoint, ovsInterface);
 134         updateInterfaceLldp(terminationPoint, ovsInterface);
 135         updateInterfaceBfd(terminationPoint, ovsInterface);
 136         updateInterfacePolicing(terminationPoint, ovsInterface);
 137     }
 138
 139     private void updatePort(
 140             final OvsdbTerminationPointAugmentation terminationPoint,
 141             final Port port,
 142             final OvsdbBridgeAugmentation operBridge) {
 143
 144         updatePortOtherConfig(terminationPoint, port);
 145         updatePortVlanTag(terminationPoint, port);
 146         updatePortVlanTrunk(terminationPoint, port);
 147         updatePortVlanMode(terminationPoint, port);
 148         updatePortExternalIds(terminationPoint, port);
 149         updatePortQos(terminationPoint, port, operBridge);
 150     }
 151
 152     private void updatePortQos(
 153             final OvsdbTerminationPointAugmentation terminationPoint,
 154             final Port port,
 155             final OvsdbBridgeAugmentation operBridge) {
 156
 157         Set<UUID> uuidSet = Sets.newHashSet();
 158
 159         // First check if QosEntry is present and use that
 160         if (terminationPoint.getQosEntry() != null && !terminationPoint.getQosEntry().isEmpty()) {
 161             OvsdbQosRef qosRef = terminationPoint.getQosEntry().iterator().next().getQosRef();
 162             Uri qosId = qosRef.getValue().firstKeyOf(QosEntries.class).getQosId();
 163             OvsdbNodeAugmentation operNode = getOperNode(operBridge);
 164             if (operNode != null && operNode.getQosEntries() != null &&
 165                     !operNode.getQosEntries().isEmpty()) {
 166                 for (QosEntries qosEntry : operNode.getQosEntries()) {
 167                     if (qosEntry.getQosId().equals(qosId)) {
 168                         uuidSet.add(new UUID(qosEntry.getQosUuid().getValue()));
 169                     }
 170                 }
 171             }
 172             if (uuidSet.size() == 0) {
 173                 uuidSet.add(new UUID(SouthboundConstants.QOS_NAMED_UUID_PREFIX +
 174                             TransactUtils.bytesToHexString(qosId.getValue().getBytes())));
 175             }
 176         } else {
 177             // Second check if Qos is present and use that (deprecated)
 178             // Do not bother to check if QosEntry and Qos are consistent if both are present
 179             Uuid qosUuid = terminationPoint.getQos();
 180             if (qosUuid != null) {
 181                 uuidSet.add(new UUID(qosUuid.getValue()));
 182             }
 183         }
 184         port.setQos(uuidSet);
 185     }
 186
 187     private OvsdbNodeAugmentation getOperNode(final OvsdbBridgeAugmentation operBridge) {
 188         @SuppressWarnings("unchecked")
 189         InstanceIdentifier<Node> iidNode = (InstanceIdentifier<Node>)operBridge.getManagedBy().getValue();
 190         OvsdbNodeAugmentation operNode = null;
 191         ReadOnlyTransaction transaction = SouthboundProvider.getDb().newReadOnlyTransaction();
 192         CheckedFuture<Optional<Node>, ReadFailedException> future =
 193                 transaction.read(LogicalDatastoreType.OPERATIONAL, iidNode);
 194         try {
 195             Optional<Node> nodeOptional = future.get();
 196             if (nodeOptional.isPresent()) {
 197                 operNode = nodeOptional.get().getAugmentation(OvsdbNodeAugmentation.class);
 198             }
 199         } catch (InterruptedException | ExecutionException e) {
 200             LOG.warn("Error reading from datastore", e);
 201         }
 202         return operNode;
 203     }
 204
 205     private void updateOfPort(
 206             final OvsdbTerminationPointAugmentation terminationPoint,
 207             final Interface ovsInterface) {
 208
 209         Long ofPort = terminationPoint.getOfport();
 210         if (ofPort != null) {
 211             ovsInterface.setOpenFlowPort(Sets.newHashSet(ofPort));
 212         }
 213     }
 214
 215     private void updateOfPortRequest(
 216             final OvsdbTerminationPointAugmentation terminationPoint,
 217             final Interface ovsInterface) {
 218
 219         Integer ofPortRequest = terminationPoint.getOfportRequest();
 220         if (ofPortRequest != null) {
 221             ovsInterface.setOpenFlowPortRequest(Sets.newHashSet(ofPortRequest.longValue()));
 222         }
 223     }
 224
 225     private void updateInterfaceOptions(
 226             final OvsdbTerminationPointAugmentation terminationPoint,
 227             final Interface ovsInterface) {
 228
 229         //Configure optional input
 230         if (terminationPoint.getOptions() != null) {
 231             try {
 232                 ovsInterface.setOptions(YangUtils.convertYangKeyValueListToMap(terminationPoint.getOptions(),
 233                         Options::getOption, Options::getValue));
 234             } catch (NullPointerException e) {
 235                 LOG.warn("Incomplete OVSDB interface options", e);
 236             }
 237         }
 238     }
 239
 240     private void updateInterfaceExternalIds(
 241             final OvsdbTerminationPointAugmentation terminationPoint,
 242             final Interface ovsInterface) {
 243
 244         List<InterfaceExternalIds> interfaceExternalIds =
 245                 terminationPoint.getInterfaceExternalIds();
 246         if (interfaceExternalIds != null && !interfaceExternalIds.isEmpty()) {
 247             try {
 248                 ovsInterface.setExternalIds(YangUtils.convertYangKeyValueListToMap(interfaceExternalIds,
 249                         InterfaceExternalIds::getExternalIdKey, InterfaceExternalIds::getExternalIdValue));
 250             } catch (NullPointerException e) {
 251                 LOG.warn("Incomplete OVSDB interface external_ids", e);
 252             }
 253         }
 254     }
 255
 256     private void updateInterfaceLldp(
 257             final OvsdbTerminationPointAugmentation terminationPoint,
 258             final Interface ovsInterface) {
 259
 260         try {
 261             List<InterfaceLldp> interfaceLldpList =
 262                     terminationPoint.getInterfaceLldp();
 263             if (interfaceLldpList != null && !interfaceLldpList.isEmpty()) {
 264                 try {
 265                     ovsInterface.setLldp(YangUtils.convertYangKeyValueListToMap(interfaceLldpList,
 266                             InterfaceLldp::getLldpKey, InterfaceLldp::getLldpValue));
 267                 } catch (NullPointerException e) {
 268                     LOG.warn("Incomplete OVSDB interface lldp", e);
 269                 }
 270             }
 271         } catch (SchemaVersionMismatchException e) {
 272             schemaMismatchLog("lldp", "Interface", e);
 273         }
 274     }
 275
 276     private void updateInterfaceOtherConfig(
 277             final OvsdbTerminationPointAugmentation terminationPoint,
 278             final Interface ovsInterface) {
 279
 280         List<InterfaceOtherConfigs> interfaceOtherConfigs =
 281                 terminationPoint.getInterfaceOtherConfigs();
 282         if (interfaceOtherConfigs != null && !interfaceOtherConfigs.isEmpty()) {
 283             Map<String, String> otherConfigsMap = new HashMap<>();
 284             for (InterfaceOtherConfigs interfaceOtherConfig : interfaceOtherConfigs) {
 285                 otherConfigsMap.put(interfaceOtherConfig.getOtherConfigKey(),
 286                         interfaceOtherConfig.getOtherConfigValue());
 287             }
 288             try {
 289                 ovsInterface.setOtherConfig(otherConfigsMap);
 290             } catch (NullPointerException e) {
 291                 LOG.warn("Incomplete OVSDB interface other_config", e);
 292             }
 293         }
 294     }
 295
 296     private void updateInterfaceBfd(
 297             final OvsdbTerminationPointAugmentation terminationPoint,
 298             final Interface ovsInterface) {
 299
 300         try {
 301             List<InterfaceBfd> interfaceBfdList =
 302                     terminationPoint.getInterfaceBfd();
 303             if (interfaceBfdList != null && !interfaceBfdList.isEmpty()) {
 304                 try {
 305                     ovsInterface.setBfd(YangUtils.convertYangKeyValueListToMap(interfaceBfdList,
 306                             InterfaceBfd::getBfdKey, InterfaceBfd::getBfdValue));
 307                 } catch (NullPointerException e) {
 308                     LOG.warn("Incomplete OVSDB interface bfd", e);
 309                 }
 310             }
 311         } catch (SchemaVersionMismatchException e) {
 312             schemaMismatchLog("bfd", "Interface", e);
 313         }
 314     }
 315
 316     private void updateInterfacePolicing(
 317             final OvsdbTerminationPointAugmentation terminationPoint,
 318             final Interface ovsInterface) {
 319
 320         Long ingressPolicingRate = terminationPoint.getIngressPolicingRate();
 321         if (ingressPolicingRate != null) {
 322             ovsInterface.setIngressPolicingRate(ingressPolicingRate);
 323         }
 324         Long ingressPolicingBurst = terminationPoint.getIngressPolicingBurst();
 325         if (ingressPolicingBurst != null) {
 326             ovsInterface.setIngressPolicingBurst(ingressPolicingBurst);
 327         }
 328     }
 329
 330     private void updatePortExternalIds(
 331             final OvsdbTerminationPointAugmentation terminationPoint,
 332             final Port port) {
 333
 334         List<PortExternalIds> portExternalIds = terminationPoint.getPortExternalIds();
 335         if (portExternalIds != null && !portExternalIds.isEmpty()) {
 336             try {
 337                 port.setExternalIds(YangUtils.convertYangKeyValueListToMap(portExternalIds,
 338                         PortExternalIds::getExternalIdKey, PortExternalIds::getExternalIdValue));
 339             } catch (NullPointerException e) {
 340                 LOG.warn("Incomplete OVSDB port external_ids", e);
 341             }
 342         }
 343     }
 344
 345     private void updatePortVlanTag(
 346             final OvsdbTerminationPointAugmentation terminationPoint,
 347             final Port port) {
 348
 349         if (terminationPoint.getVlanTag() != null) {
 350             Set<Long> vlanTag = new HashSet<>();
 351             vlanTag.add(terminationPoint.getVlanTag().getValue().longValue());
 352             port.setTag(vlanTag);
 353         }
 354     }
 355
 356     private void updatePortVlanTrunk(
 357             final OvsdbTerminationPointAugmentation terminationPoint,
 358             final Port port) {
 359
 360         if (terminationPoint.getTrunks() != null && terminationPoint.getTrunks().size() > 0) {
 361             Set<Long> portTrunks = new HashSet<>();
 362             List<Trunks> modelTrunks = terminationPoint.getTrunks();
 363             for (Trunks trunk : modelTrunks) {
 364                 if (trunk.getTrunk() != null) {
 365                     portTrunks.add(trunk.getTrunk().getValue().longValue());
 366                 }
 367             }
 368             port.setTrunks(portTrunks);
 369         }
 370     }
 371
 372     private void updatePortVlanMode(
 373             final OvsdbTerminationPointAugmentation terminationPoint,
 374             final Port port) {
 375         if (terminationPoint.getVlanMode() != null) {
 376             Set<String> portVlanMode = new HashSet<>();
 377             VlanMode modelVlanMode = terminationPoint.getVlanMode();
 378             portVlanMode.add(SouthboundConstants.VLANMODES.values()[modelVlanMode.getIntValue() - 1].getMode());
 379             port.setVlanMode(portVlanMode);
 380         }
 381     }
 382
 383     private void updatePortOtherConfig(
 384             final OvsdbTerminationPointAugmentation terminationPoint,
 385             final Port ovsPort) {
 386         List<PortOtherConfigs> portOtherConfigs =
 387                 terminationPoint.getPortOtherConfigs();
 388         if (portOtherConfigs != null && !portOtherConfigs.isEmpty()) {
 389             try {
 390                 ovsPort.setOtherConfig(YangUtils.convertYangKeyValueListToMap(portOtherConfigs,
 391                         PortOtherConfigs::getOtherConfigKey, PortOtherConfigs::getOtherConfigValue));
 392             } catch (NullPointerException e) {
 393                 LOG.warn("Incomplete OVSDB port other_config", e);
 394             }
 395         }
 396     }
 397
 398 }