2 * Copyright (c) 2015, 2017 Ericsson India Global Services Pvt Ltd. and others. All rights reserved.
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
8 package org.opendaylight.ovsdb.hwvtepsouthbound.transactions.md;
10 import com.google.common.base.Preconditions;
11 import com.google.common.collect.Lists;
12 import java.util.ArrayList;
13 import java.util.Collections;
14 import java.util.HashSet;
15 import java.util.List;
17 import java.util.Map.Entry;
18 import java.util.Optional;
20 import org.opendaylight.mdsal.binding.api.ReadWriteTransaction;
21 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
22 import org.opendaylight.ovsdb.hwvtepsouthbound.HwvtepConnectionInstance;
23 import org.opendaylight.ovsdb.hwvtepsouthbound.HwvtepDeviceInfo;
24 import org.opendaylight.ovsdb.hwvtepsouthbound.HwvtepSouthboundMapper;
25 import org.opendaylight.ovsdb.hwvtepsouthbound.HwvtepSouthboundUtil;
26 import org.opendaylight.ovsdb.hwvtepsouthbound.events.PortEvent;
27 import org.opendaylight.ovsdb.hwvtepsouthbound.events.ReconcilePortEvent;
28 import org.opendaylight.ovsdb.hwvtepsouthbound.transact.HwvtepOperationalState;
29 import org.opendaylight.ovsdb.hwvtepsouthbound.transact.PhysicalPortUpdateCommand;
30 import org.opendaylight.ovsdb.lib.message.TableUpdates;
31 import org.opendaylight.ovsdb.lib.notation.UUID;
32 import org.opendaylight.ovsdb.lib.schema.DatabaseSchema;
33 import org.opendaylight.ovsdb.lib.schema.typed.TyperUtils;
34 import org.opendaylight.ovsdb.schema.hardwarevtep.LogicalSwitch;
35 import org.opendaylight.ovsdb.schema.hardwarevtep.PhysicalPort;
36 import org.opendaylight.ovsdb.schema.hardwarevtep.PhysicalSwitch;
37 import org.opendaylight.ovsdb.utils.mdsal.utils.ControllerMdsalUtils;
38 import org.opendaylight.ovsdb.utils.mdsal.utils.TransactionType;
39 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid;
40 import org.opendaylight.yang.gen.v1.urn.opendaylight.l2.types.rev130827.VlanId;
41 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.HwvtepGlobalAugmentation;
42 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.HwvtepLogicalSwitchRef;
43 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.HwvtepNodeName;
44 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.HwvtepPhysicalPortAugmentation;
45 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.HwvtepPhysicalPortAugmentationBuilder;
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.global.attributes.SwitchesKey;
49 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.hwvtep.physical.port.attributes.PortFaultStatus;
50 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.hwvtep.physical.port.attributes.PortFaultStatusBuilder;
51 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.hwvtep.physical.port.attributes.PortFaultStatusKey;
52 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.hwvtep.physical.port.attributes.VlanBindings;
53 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.hwvtep.physical.port.attributes.VlanBindingsBuilder;
54 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.hwvtep.physical.port.attributes.VlanBindingsKey;
55 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
56 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.TpId;
57 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
58 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.node.TerminationPoint;
59 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.node.TerminationPointBuilder;
60 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.node.TerminationPointKey;
61 import org.opendaylight.yangtools.yang.binding.DataObject;
62 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
63 import org.slf4j.Logger;
64 import org.slf4j.LoggerFactory;
66 public class HwvtepPhysicalPortUpdateCommand extends AbstractTransactionCommand {
68 private static final Logger LOG = LoggerFactory.getLogger(HwvtepPhysicalPortUpdateCommand.class);
69 private final Map<UUID, PhysicalPort> updatedPPRows;
70 private final Map<UUID, PhysicalPort> oldPPRows;
71 private final Map<UUID, PhysicalSwitch> switchUpdatedRows;
72 private final Set<UUID> skipReconciliationPorts;
73 private final ControllerMdsalUtils mdsalUtils;
75 public HwvtepPhysicalPortUpdateCommand(final HwvtepConnectionInstance key, final TableUpdates updates,
76 final DatabaseSchema dbSchema) {
77 super(key, updates, dbSchema);
78 updatedPPRows = TyperUtils.extractRowsUpdated(PhysicalPort.class, getUpdates(), getDbSchema());
79 oldPPRows = TyperUtils.extractRowsOld(PhysicalPort.class, getUpdates(), getDbSchema());
80 switchUpdatedRows = TyperUtils.extractRowsUpdated(PhysicalSwitch.class, getUpdates(), getDbSchema());
81 skipReconciliationPorts = new HashSet<>();
82 mdsalUtils = new ControllerMdsalUtils(key.getDataBroker());
83 for (Entry<UUID, PhysicalPort> portUpdateEntry : updatedPPRows.entrySet()) {
84 Optional<InstanceIdentifier<Node>> switchIid = getTerminationPointSwitch(portUpdateEntry.getKey());
85 if (switchIid.isPresent()) {
86 if (getDeviceInfo().getDeviceOperData(Node.class, switchIid.get()) == null) {
87 //This is the first update from switch do not have to do reconciliation of this port
88 //it is taken care by switch reconciliation
89 skipReconciliationPorts.add(portUpdateEntry.getKey());
97 public void execute(final ReadWriteTransaction transaction) {
98 final InstanceIdentifier<Node> connectionIId = getOvsdbConnectionInstance().getInstanceIdentifier();
99 if (updatedPPRows.isEmpty()) {
102 LOG.trace("PhysicalPortTable updated: {}", updatedPPRows);
103 Optional<Node> node = HwvtepSouthboundUtil.readNode(transaction, connectionIId);
104 if (node.isPresent()) {
105 updateTerminationPoints(transaction, node.get());
106 // TODO: Handle Deletion of VLAN Bindings
110 private void updateTerminationPoints(final ReadWriteTransaction transaction, final Node node) {
111 for (Entry<UUID, PhysicalPort> portUpdateEntry : updatedPPRows.entrySet()) {
112 PhysicalPort portUpdate = portUpdateEntry.getValue();
113 String portName = portUpdate.getNameColumn().getData();
114 Optional<InstanceIdentifier<Node>> switchIid = getTerminationPointSwitch(portUpdateEntry.getKey());
115 if (!switchIid.isPresent()) {
116 switchIid = getFromDeviceOperCache(portUpdate.getUuid());
117 if (!switchIid.isPresent()) {
118 LOG.debug("Failed to find node from the DeviceOperCache for port {}. Get it from the DS.",
120 switchIid = getTerminationPointSwitch(transaction, node, portName);
123 if (switchIid.isPresent()) {
124 TerminationPointKey tpKey = new TerminationPointKey(new TpId(portName));
125 TerminationPointBuilder tpBuilder = new TerminationPointBuilder();
126 tpBuilder.withKey(tpKey);
127 tpBuilder.setTpId(tpKey.getTpId());
128 InstanceIdentifier<TerminationPoint> tpPath = getInstanceIdentifier(switchIid.get(), portUpdate);
129 HwvtepPhysicalPortAugmentationBuilder tpAugmentationBuilder =
130 new HwvtepPhysicalPortAugmentationBuilder();
131 buildTerminationPoint(tpAugmentationBuilder, portUpdate);
132 setPortFaultStatus(tpAugmentationBuilder, portUpdate);
133 tpBuilder.addAugmentation(HwvtepPhysicalPortAugmentation.class, tpAugmentationBuilder.build());
134 if (oldPPRows.containsKey(portUpdateEntry.getKey())) {
135 transaction.merge(LogicalDatastoreType.OPERATIONAL, tpPath, tpBuilder.build());
137 transaction.put(LogicalDatastoreType.OPERATIONAL, tpPath, tpBuilder.build());
139 NodeId psNodeId = tpPath.firstKeyOf(Node.class).getNodeId();
140 if (getDeviceInfo().getDeviceOperData(TerminationPoint.class, tpPath) == null) {
141 addToDeviceUpdate(TransactionType.ADD, new PortEvent(portUpdate, psNodeId));
143 addToDeviceUpdate(TransactionType.UPDATE, new PortEvent(portUpdate, psNodeId));
145 reconcileToPort(portUpdate, tpPath);
146 addToUpdateTx(VlanBindings.class, tpPath, portUpdate.getUuid(), portUpdate);
147 // Update with Deleted VlanBindings
148 if (oldPPRows.get(portUpdateEntry.getKey()) != null
149 && oldPPRows.get(portUpdateEntry.getKey()).getVlanBindingsColumn() != null) {
150 List<InstanceIdentifier<VlanBindings>> vlanBindingsList = new ArrayList<>();
151 Map<Long, UUID> oldVb = oldPPRows.get(portUpdateEntry.getKey()).getVlanBindingsColumn().getData();
152 Map<Long, UUID> updatedVb = portUpdateEntry.getValue().getVlanBindingsColumn().getData();
153 for (Map.Entry<Long, UUID> oldVbEntry : oldVb.entrySet()) {
154 Long key = oldVbEntry.getKey();
155 if (!updatedVb.containsKey(key)) {
156 VlanBindings vlanBindings = createVlanBinding(key, oldVbEntry.getValue());
157 InstanceIdentifier<VlanBindings> vbIid = getInstanceIdentifier(tpPath, vlanBindings);
158 vlanBindingsList.add(vbIid);
160 deleteEntries(transaction, vlanBindingsList);
163 // Update with Deleted portfaultstatus
164 deleteEntries(transaction,getPortFaultStatusToRemove(tpPath, portUpdate));
166 LOG.warn("switchIid was not found for port {}", portUpdate);
171 private void reconcileToPort(final PhysicalPort portUpdate,
172 final InstanceIdentifier<TerminationPoint> tpPath) {
173 if (skipReconciliationPorts.contains(portUpdate.getUuid())) {
174 //case of port added along with switch add
175 //switch reconciliation will take care of this port along with other ports
178 if (getDeviceInfo().getDeviceOperData(VlanBindings.class, tpPath) != null) {
179 //case of port update not new port add
183 //case of individual port add , reconcile to this port
184 addToUpdateTx(VlanBindings.class, tpPath, portUpdate.getUuid(), portUpdate);
185 HwvtepDeviceInfo.DeviceData data = getDeviceInfo().getConfigData(VlanBindings.class, tpPath);
186 if (data == null || data.getData() == null) {
187 LOG.error("No config data present ");
189 addToDeviceUpdate(TransactionType.ADD,
190 new ReconcilePortEvent(portUpdate, tpPath.firstKeyOf(Node.class).getNodeId()));
191 LOG.info("addToDeviceUpdate {}", portUpdate);
192 getDeviceInfo().updateDeviceOperData(VlanBindings.class, tpPath,
193 portUpdate.getUuid(), portUpdate);
194 getDeviceInfo().scheduleTransaction((transactionBuilder) -> {
195 InstanceIdentifier psIid = tpPath.firstIdentifierOf(Node.class);
196 HwvtepOperationalState operState = new HwvtepOperationalState(getOvsdbConnectionInstance());
197 PhysicalPortUpdateCommand portUpdateCommand = new PhysicalPortUpdateCommand(
198 operState, Collections.EMPTY_LIST);
199 TerminationPoint cfgPoint = (TerminationPoint) data.getData();
200 portUpdateCommand.updatePhysicalPort(transactionBuilder, psIid,
201 Lists.newArrayList(cfgPoint));
207 private static <T extends DataObject> void deleteEntries(final ReadWriteTransaction transaction,
208 final List<InstanceIdentifier<T>> entryIids) {
209 for (InstanceIdentifier<T> entryIid : entryIids) {
210 transaction.delete(LogicalDatastoreType.OPERATIONAL, entryIid);
214 private InstanceIdentifier<VlanBindings> getInstanceIdentifier(final InstanceIdentifier<TerminationPoint> tpPath,
215 final VlanBindings vlanBindings) {
216 return HwvtepSouthboundMapper.createInstanceIdentifier(getOvsdbConnectionInstance(), tpPath, vlanBindings);
219 private static InstanceIdentifier<TerminationPoint> getInstanceIdentifier(final InstanceIdentifier<Node> switchIid,
220 final PhysicalPort port) {
221 return switchIid.child(TerminationPoint.class, new TerminationPointKey(new TpId(port.getName())));
224 private void buildTerminationPoint(final HwvtepPhysicalPortAugmentationBuilder tpAugmentationBuilder,
225 final PhysicalPort portUpdate) {
226 updatePhysicalPortId(portUpdate, tpAugmentationBuilder);
227 updatePort(portUpdate, tpAugmentationBuilder);
230 private void updatePort(final PhysicalPort portUpdate,
231 final HwvtepPhysicalPortAugmentationBuilder tpAugmentationBuilder) {
232 updateVlanBindings(portUpdate, tpAugmentationBuilder);
233 tpAugmentationBuilder.setPhysicalPortUuid(new Uuid(portUpdate.getUuid().toString()));
236 private static void updatePhysicalPortId(final PhysicalPort portUpdate,
237 final HwvtepPhysicalPortAugmentationBuilder tpAugmentationBuilder) {
238 tpAugmentationBuilder.setHwvtepNodeName(new HwvtepNodeName(portUpdate.getName()));
239 if (portUpdate.getDescription() != null) {
240 tpAugmentationBuilder.setHwvtepNodeDescription(portUpdate.getDescription());
244 private void updateVlanBindings(final PhysicalPort portUpdate,
245 final HwvtepPhysicalPortAugmentationBuilder tpAugmentationBuilder) {
246 Map<Long, UUID> vlanBindings = portUpdate.getVlanBindingsColumn().getData();
247 if (vlanBindings != null && !vlanBindings.isEmpty()) {
248 List<VlanBindings> vlanBindingsList = new ArrayList<>();
249 for (Map.Entry<Long, UUID> vlanBindingEntry : vlanBindings.entrySet()) {
250 Long vlanBindingKey = vlanBindingEntry.getKey();
251 UUID vlanBindingValue = vlanBindingEntry.getValue();
252 if (vlanBindingValue != null && vlanBindingKey != null) {
253 vlanBindingsList.add(createVlanBinding(vlanBindingKey, vlanBindingValue));
256 tpAugmentationBuilder.setVlanBindings(vlanBindingsList);
260 private VlanBindings createVlanBinding(final Long key, final UUID value) {
261 VlanBindingsBuilder vbBuilder = new VlanBindingsBuilder();
262 VlanBindingsKey vbKey = new VlanBindingsKey(new VlanId(key.intValue()));
263 vbBuilder.withKey(vbKey);
264 vbBuilder.setVlanIdKey(vbKey.getVlanIdKey());
265 HwvtepLogicalSwitchRef switchRef = this.getLogicalSwitchRef(value);
266 vbBuilder.setLogicalSwitchRef(switchRef);
267 return vbBuilder.build();
270 private HwvtepLogicalSwitchRef getLogicalSwitchRef(final UUID switchUUID) {
271 LogicalSwitch logicalSwitch = getOvsdbConnectionInstance().getDeviceInfo().getLogicalSwitch(switchUUID);
272 if (logicalSwitch != null) {
273 InstanceIdentifier<LogicalSwitches> switchIid =
274 HwvtepSouthboundMapper.createInstanceIdentifier(getOvsdbConnectionInstance(), logicalSwitch);
275 return new HwvtepLogicalSwitchRef(switchIid);
277 LOG.debug("Failed to get LogicalSwitch {}", switchUUID);
278 LOG.trace("Available LogicalSwitches: {}",
279 getOvsdbConnectionInstance().getDeviceInfo().getLogicalSwitches().values());
283 private Optional<InstanceIdentifier<Node>> getTerminationPointSwitch(final UUID portUUID) {
284 for (PhysicalSwitch updatedPhysicalSwitch : switchUpdatedRows.values()) {
285 if (updatedPhysicalSwitch.getPortsColumn().getData().contains(portUUID)) {
286 return Optional.of(HwvtepSouthboundMapper.createInstanceIdentifier(getOvsdbConnectionInstance(),
287 updatedPhysicalSwitch));
290 return Optional.empty();
293 private static Optional<InstanceIdentifier<Node>> getTerminationPointSwitch(final ReadWriteTransaction transaction,
294 final Node node, final String tpName) {
295 HwvtepGlobalAugmentation hwvtepNode = node.augmentation(HwvtepGlobalAugmentation.class);
296 Map<SwitchesKey, Switches> switchNodes = hwvtepNode.getSwitches();
297 if (switchNodes != null && !switchNodes.isEmpty()) {
298 for (Switches managedNodeEntry : switchNodes.values()) {
299 @SuppressWarnings("unchecked")
300 Node switchNode = HwvtepSouthboundUtil.readNode(transaction,
301 (InstanceIdentifier<Node>) managedNodeEntry.getSwitchRef().getValue()).get();
302 TerminationPointKey tpKey = new TerminationPointKey(new TpId(tpName));
303 TerminationPoint terminationPoint = switchNode.nonnullTerminationPoint().get(tpKey);
304 if (terminationPoint != null) {
305 return Optional.of((InstanceIdentifier<Node>) managedNodeEntry.getSwitchRef().getValue());
309 LOG.trace("PhyscialSwitch not present for the Port {}", tpName);
311 return Optional.empty();
314 private static void setPortFaultStatus(final HwvtepPhysicalPortAugmentationBuilder tpAugmentationBuilder,
315 final PhysicalPort portUpdate) {
316 if (portUpdate.getPortFaultStatusColumn() != null && portUpdate.getPortFaultStatusColumn().getData() != null
317 && !portUpdate.getPortFaultStatusColumn().getData().isEmpty()) {
318 List<PortFaultStatus> portFaultStatusLst = new ArrayList<>();
319 for (String portFaultStatus : portUpdate.getPortFaultStatusColumn().getData()) {
320 portFaultStatusLst.add(new PortFaultStatusBuilder().withKey(new PortFaultStatusKey(portFaultStatus))
321 .setPortFaultStatusKey(portFaultStatus).build());
323 tpAugmentationBuilder.setPortFaultStatus(portFaultStatusLst);
327 private List<InstanceIdentifier<PortFaultStatus>> getPortFaultStatusToRemove(
328 final InstanceIdentifier<TerminationPoint> tpPath, final PhysicalPort port) {
329 Preconditions.checkNotNull(tpPath);
330 Preconditions.checkNotNull(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));
346 private Optional<InstanceIdentifier<Node>> getFromDeviceOperCache(final UUID uuid) {
348 InstanceIdentifier<TerminationPoint> terminationPointIid =
349 getOvsdbConnectionInstance()
350 .getDeviceInfo().getDeviceOperKey(TerminationPoint.class, uuid);
351 if (terminationPointIid != null) {
352 return Optional.of(terminationPointIid.firstIdentifierOf(Node.class));
354 return Optional.empty();