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.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.NodeId;
55 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.TpId;
56 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
57 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.node.TerminationPoint;
58 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.node.TerminationPointBuilder;
59 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.node.TerminationPointKey;
60 import org.opendaylight.yangtools.yang.binding.DataObject;
61 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
62 import org.slf4j.Logger;
63 import org.slf4j.LoggerFactory;
65 public class HwvtepPhysicalPortUpdateCommand extends AbstractTransactionCommand {
67 private static final Logger LOG = LoggerFactory.getLogger(HwvtepPhysicalPortUpdateCommand.class);
68 private final Map<UUID, PhysicalPort> updatedPPRows;
69 private final Map<UUID, PhysicalPort> oldPPRows;
70 private final Map<UUID, PhysicalSwitch> switchUpdatedRows;
71 private final Set<UUID> skipReconciliationPorts;
72 private final ControllerMdsalUtils mdsalUtils;
74 public HwvtepPhysicalPortUpdateCommand(final HwvtepConnectionInstance key, final TableUpdates updates,
75 final 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 mdsalUtils = new ControllerMdsalUtils(key.getDataBroker());
82 for (Entry<UUID, PhysicalPort> portUpdateEntry : updatedPPRows.entrySet()) {
83 Optional<InstanceIdentifier<Node>> switchIid = getTerminationPointSwitch(portUpdateEntry.getKey());
84 if (switchIid.isPresent()) {
85 if (getDeviceInfo().getDeviceOperData(Node.class, switchIid.get()) == null) {
86 //This is the first update from switch do not have to do reconciliation of this port
87 //it is taken care by switch reconciliation
88 skipReconciliationPorts.add(portUpdateEntry.getKey());
96 public void execute(final ReadWriteTransaction transaction) {
97 final InstanceIdentifier<Node> connectionIId = getOvsdbConnectionInstance().getInstanceIdentifier();
98 if (updatedPPRows.isEmpty()) {
101 LOG.trace("PhysicalPortTable updated: {}", updatedPPRows);
102 Optional<Node> node = HwvtepSouthboundUtil.readNode(transaction, connectionIId);
103 if (node.isPresent()) {
104 updateTerminationPoints(transaction, node.get());
105 // TODO: Handle Deletion of VLAN Bindings
109 private void updateTerminationPoints(final ReadWriteTransaction transaction, final Node node) {
110 for (Entry<UUID, PhysicalPort> portUpdateEntry : updatedPPRows.entrySet()) {
111 PhysicalPort portUpdate = portUpdateEntry.getValue();
112 String portName = portUpdate.getNameColumn().getData();
113 Optional<InstanceIdentifier<Node>> switchIid = getTerminationPointSwitch(portUpdateEntry.getKey());
114 if (!switchIid.isPresent()) {
115 switchIid = getFromDeviceOperCache(portUpdate.getUuid());
116 if (!switchIid.isPresent()) {
117 LOG.debug("Failed to find node from the DeviceOperCache for port {}. Get it from the DS.",
119 switchIid = getTerminationPointSwitch(transaction, node, portName);
122 if (switchIid.isPresent()) {
123 TerminationPointKey tpKey = new TerminationPointKey(new TpId(portName));
124 TerminationPointBuilder tpBuilder = new TerminationPointBuilder();
125 tpBuilder.withKey(tpKey);
126 tpBuilder.setTpId(tpKey.getTpId());
127 InstanceIdentifier<TerminationPoint> tpPath = getInstanceIdentifier(switchIid.get(), portUpdate);
128 HwvtepPhysicalPortAugmentationBuilder tpAugmentationBuilder =
129 new HwvtepPhysicalPortAugmentationBuilder();
130 buildTerminationPoint(tpAugmentationBuilder, portUpdate);
131 setPortFaultStatus(tpAugmentationBuilder, portUpdate);
132 tpBuilder.addAugmentation(HwvtepPhysicalPortAugmentation.class, tpAugmentationBuilder.build());
133 if (oldPPRows.containsKey(portUpdateEntry.getKey())) {
134 transaction.merge(LogicalDatastoreType.OPERATIONAL, tpPath, tpBuilder.build());
136 transaction.put(LogicalDatastoreType.OPERATIONAL, tpPath, tpBuilder.build());
138 NodeId psNodeId = tpPath.firstKeyOf(Node.class).getNodeId();
139 if (getDeviceInfo().getDeviceOperData(TerminationPoint.class, tpPath) == null) {
140 addToDeviceUpdate(TransactionType.ADD, new PortEvent(portUpdate, psNodeId));
142 addToDeviceUpdate(TransactionType.UPDATE, new PortEvent(portUpdate, psNodeId));
144 reconcileToPort(portUpdate, tpPath);
145 addToUpdateTx(VlanBindings.class, tpPath, portUpdate.getUuid(), portUpdate);
146 // Update with Deleted VlanBindings
147 if (oldPPRows.get(portUpdateEntry.getKey()) != null
148 && oldPPRows.get(portUpdateEntry.getKey()).getVlanBindingsColumn() != null) {
149 List<InstanceIdentifier<VlanBindings>> vlanBindingsList = new ArrayList<>();
150 Map<Long, UUID> oldVb = oldPPRows.get(portUpdateEntry.getKey()).getVlanBindingsColumn().getData();
151 Map<Long, UUID> updatedVb = portUpdateEntry.getValue().getVlanBindingsColumn().getData();
152 for (Map.Entry<Long, UUID> oldVbEntry : oldVb.entrySet()) {
153 Long key = oldVbEntry.getKey();
154 if (!updatedVb.containsKey(key)) {
155 VlanBindings vlanBindings = createVlanBinding(key, oldVbEntry.getValue());
156 InstanceIdentifier<VlanBindings> vbIid = getInstanceIdentifier(tpPath, vlanBindings);
157 vlanBindingsList.add(vbIid);
159 deleteEntries(transaction, vlanBindingsList);
162 // Update with Deleted portfaultstatus
163 deleteEntries(transaction,getPortFaultStatusToRemove(tpPath, portUpdate));
165 LOG.warn("switchIid was not found for port {}", portUpdate);
170 private void reconcileToPort(final PhysicalPort portUpdate,
171 final InstanceIdentifier<TerminationPoint> tpPath) {
172 if (skipReconciliationPorts.contains(portUpdate.getUuid())) {
173 //case of port added along with switch add
174 //switch reconciliation will take care of this port along with other ports
177 if (getDeviceInfo().getDeviceOperData(VlanBindings.class, tpPath) != null) {
178 //case of port update not new port add
182 //case of individual port add , reconcile to this port
183 addToUpdateTx(VlanBindings.class, tpPath, portUpdate.getUuid(), portUpdate);
184 HwvtepDeviceInfo.DeviceData data = getDeviceInfo().getConfigData(VlanBindings.class, tpPath);
185 if (data == null || data.getData() == null) {
186 LOG.error("No config data present ");
188 addToDeviceUpdate(TransactionType.ADD,
189 new ReconcilePortEvent(portUpdate, tpPath.firstKeyOf(Node.class).getNodeId()));
190 LOG.info("addToDeviceUpdate {}", portUpdate);
191 getDeviceInfo().updateDeviceOperData(VlanBindings.class, tpPath,
192 portUpdate.getUuid(), portUpdate);
193 getDeviceInfo().scheduleTransaction((transactionBuilder) -> {
194 InstanceIdentifier psIid = tpPath.firstIdentifierOf(Node.class);
195 HwvtepOperationalState operState = new HwvtepOperationalState(getOvsdbConnectionInstance());
196 PhysicalPortUpdateCommand portUpdateCommand = new PhysicalPortUpdateCommand(
197 operState, Collections.EMPTY_LIST);
198 TerminationPoint cfgPoint = (TerminationPoint) data.getData();
199 portUpdateCommand.updatePhysicalPort(transactionBuilder, psIid,
200 Lists.newArrayList(cfgPoint));
206 private static <T extends DataObject> void deleteEntries(final ReadWriteTransaction transaction,
207 final List<InstanceIdentifier<T>> entryIids) {
208 for (InstanceIdentifier<T> entryIid : entryIids) {
209 transaction.delete(LogicalDatastoreType.OPERATIONAL, entryIid);
213 private InstanceIdentifier<VlanBindings> getInstanceIdentifier(final InstanceIdentifier<TerminationPoint> tpPath,
214 final VlanBindings vlanBindings) {
215 return HwvtepSouthboundMapper.createInstanceIdentifier(getOvsdbConnectionInstance(), tpPath, vlanBindings);
218 private static InstanceIdentifier<TerminationPoint> getInstanceIdentifier(final InstanceIdentifier<Node> switchIid,
219 final PhysicalPort port) {
220 return switchIid.child(TerminationPoint.class, new TerminationPointKey(new TpId(port.getName())));
223 private void buildTerminationPoint(final HwvtepPhysicalPortAugmentationBuilder tpAugmentationBuilder,
224 final PhysicalPort portUpdate) {
225 updatePhysicalPortId(portUpdate, tpAugmentationBuilder);
226 updatePort(portUpdate, tpAugmentationBuilder);
229 private void updatePort(final PhysicalPort portUpdate,
230 final HwvtepPhysicalPortAugmentationBuilder tpAugmentationBuilder) {
231 updateVlanBindings(portUpdate, tpAugmentationBuilder);
232 tpAugmentationBuilder.setPhysicalPortUuid(new Uuid(portUpdate.getUuid().toString()));
235 private static void updatePhysicalPortId(final PhysicalPort portUpdate,
236 final HwvtepPhysicalPortAugmentationBuilder tpAugmentationBuilder) {
237 tpAugmentationBuilder.setHwvtepNodeName(new HwvtepNodeName(portUpdate.getName()));
238 if (portUpdate.getDescription() != null) {
239 tpAugmentationBuilder.setHwvtepNodeDescription(portUpdate.getDescription());
243 private void updateVlanBindings(final PhysicalPort portUpdate,
244 final HwvtepPhysicalPortAugmentationBuilder tpAugmentationBuilder) {
245 Map<Long, UUID> vlanBindings = portUpdate.getVlanBindingsColumn().getData();
246 if (vlanBindings != null && !vlanBindings.isEmpty()) {
247 List<VlanBindings> vlanBindingsList = new ArrayList<>();
248 for (Map.Entry<Long, UUID> vlanBindingEntry : vlanBindings.entrySet()) {
249 Long vlanBindingKey = vlanBindingEntry.getKey();
250 UUID vlanBindingValue = vlanBindingEntry.getValue();
251 if (vlanBindingValue != null && vlanBindingKey != null) {
252 vlanBindingsList.add(createVlanBinding(vlanBindingKey, vlanBindingValue));
255 tpAugmentationBuilder.setVlanBindings(vlanBindingsList);
259 private VlanBindings createVlanBinding(final Long key, final UUID value) {
260 VlanBindingsBuilder vbBuilder = new VlanBindingsBuilder();
261 VlanBindingsKey vbKey = new VlanBindingsKey(new VlanId(key.intValue()));
262 vbBuilder.withKey(vbKey);
263 vbBuilder.setVlanIdKey(vbKey.getVlanIdKey());
264 HwvtepLogicalSwitchRef switchRef = this.getLogicalSwitchRef(value);
265 vbBuilder.setLogicalSwitchRef(switchRef);
266 return vbBuilder.build();
269 private HwvtepLogicalSwitchRef getLogicalSwitchRef(final UUID switchUUID) {
270 LogicalSwitch logicalSwitch = getOvsdbConnectionInstance().getDeviceInfo().getLogicalSwitch(switchUUID);
271 if (logicalSwitch != null) {
272 InstanceIdentifier<LogicalSwitches> switchIid =
273 HwvtepSouthboundMapper.createInstanceIdentifier(getOvsdbConnectionInstance(), logicalSwitch);
274 return new HwvtepLogicalSwitchRef(switchIid);
276 LOG.debug("Failed to get LogicalSwitch {}", switchUUID);
277 LOG.trace("Available LogicalSwitches: {}",
278 getOvsdbConnectionInstance().getDeviceInfo().getLogicalSwitches().values());
282 private Optional<InstanceIdentifier<Node>> getTerminationPointSwitch(final UUID portUUID) {
283 for (PhysicalSwitch updatedPhysicalSwitch : switchUpdatedRows.values()) {
284 if (updatedPhysicalSwitch.getPortsColumn().getData().contains(portUUID)) {
285 return Optional.of(HwvtepSouthboundMapper.createInstanceIdentifier(getOvsdbConnectionInstance(),
286 updatedPhysicalSwitch));
289 return Optional.empty();
292 private static Optional<InstanceIdentifier<Node>> getTerminationPointSwitch(final ReadWriteTransaction transaction,
293 final Node node, final String tpName) {
294 HwvtepGlobalAugmentation hwvtepNode = node.augmentation(HwvtepGlobalAugmentation.class);
295 List<Switches> switchNodes = hwvtepNode.getSwitches();
296 if (switchNodes != null && !switchNodes.isEmpty()) {
297 for (Switches managedNodeEntry : switchNodes) {
298 @SuppressWarnings("unchecked")
299 Node switchNode = HwvtepSouthboundUtil
300 .readNode(transaction,
301 (InstanceIdentifier<Node>) managedNodeEntry.getSwitchRef().getValue()).get();
302 TerminationPointKey tpKey = new TerminationPointKey(new TpId(tpName));
303 if (switchNode.getTerminationPoint() != null) {
304 for (TerminationPoint terminationPoint : switchNode.getTerminationPoint()) {
305 if (terminationPoint.key().equals(tpKey)) {
306 return Optional.of((InstanceIdentifier<Node>) managedNodeEntry.getSwitchRef().getValue());
312 LOG.trace("PhyscialSwitch not present for the Port {}", tpName);
314 return Optional.empty();
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 List<PortFaultStatus> portFaultStatusLst = new ArrayList<>();
322 for (String portFaultStatus : portUpdate.getPortFaultStatusColumn().getData()) {
323 portFaultStatusLst.add(new PortFaultStatusBuilder().withKey(new PortFaultStatusKey(portFaultStatus))
324 .setPortFaultStatusKey(portFaultStatus).build());
326 tpAugmentationBuilder.setPortFaultStatus(portFaultStatusLst);
330 private List<InstanceIdentifier<PortFaultStatus>> getPortFaultStatusToRemove(
331 final InstanceIdentifier<TerminationPoint> tpPath, final PhysicalPort port) {
332 Preconditions.checkNotNull(tpPath);
333 Preconditions.checkNotNull(port);
334 List<InstanceIdentifier<PortFaultStatus>> result = new ArrayList<>();
335 PhysicalPort oldPort = oldPPRows.get(port.getUuid());
336 if (oldPort != null && oldPort.getPortFaultStatusColumn() != null) {
337 for (String portFltStat : oldPort.getPortFaultStatusColumn().getData()) {
338 if (port.getPortFaultStatusColumn() == null
339 || !port.getPortFaultStatusColumn().getData().contains(portFltStat)) {
340 InstanceIdentifier<PortFaultStatus> iid = tpPath.augmentation(HwvtepPhysicalPortAugmentation.class)
341 .child(PortFaultStatus.class, new PortFaultStatusKey(portFltStat));
349 private Optional<InstanceIdentifier<Node>> getFromDeviceOperCache(final UUID uuid) {
351 InstanceIdentifier<TerminationPoint> terminationPointIid =
352 getOvsdbConnectionInstance()
353 .getDeviceInfo().getDeviceOperKey(TerminationPoint.class, uuid);
354 if (terminationPointIid != null) {
355 return Optional.of(terminationPointIid.firstIdentifierOf(Node.class));
357 return Optional.empty();