17d5f2ceab9adb040c2d207019124e6ac47d92c6
[ovsdb.git] / southbound / southbound-impl / src / main / java / org / opendaylight / ovsdb / southbound / transactions / md / OvsdbPortUpdateCommand.java
1 /*
2  * Copyright (c) 2014, 2017 Intel Corp. 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.transactions.md;
9
10 import static org.opendaylight.ovsdb.southbound.SouthboundUtil.schemaMismatchLog;
11
12 import com.google.common.annotations.VisibleForTesting;
13 import java.util.ArrayList;
14 import java.util.Collection;
15 import java.util.Iterator;
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.lib.error.ColumnSchemaNotFoundException;
24 import org.opendaylight.ovsdb.lib.error.SchemaVersionMismatchException;
25 import org.opendaylight.ovsdb.lib.message.TableUpdates;
26 import org.opendaylight.ovsdb.lib.notation.Column;
27 import org.opendaylight.ovsdb.lib.notation.UUID;
28 import org.opendaylight.ovsdb.lib.schema.DatabaseSchema;
29 import org.opendaylight.ovsdb.lib.schema.GenericTableSchema;
30 import org.opendaylight.ovsdb.lib.schema.typed.TyperUtils;
31 import org.opendaylight.ovsdb.schema.openvswitch.Bridge;
32 import org.opendaylight.ovsdb.schema.openvswitch.Interface;
33 import org.opendaylight.ovsdb.schema.openvswitch.Port;
34 import org.opendaylight.ovsdb.schema.openvswitch.Qos;
35 import org.opendaylight.ovsdb.southbound.InstanceIdentifierCodec;
36 import org.opendaylight.ovsdb.southbound.OvsdbConnectionInstance;
37 import org.opendaylight.ovsdb.southbound.SouthboundConstants;
38 import org.opendaylight.ovsdb.southbound.SouthboundMapper;
39 import org.opendaylight.ovsdb.southbound.SouthboundUtil;
40 import org.opendaylight.ovsdb.utils.mdsal.utils.TransactionType;
41 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri;
42 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress;
43 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid;
44 import org.opendaylight.yang.gen.v1.urn.opendaylight.l2.types.rev130827.VlanId;
45 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbNodeAugmentation;
46 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbPortInterfaceAttributes;
47 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbQosRef;
48 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbTerminationPointAugmentation;
49 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbTerminationPointAugmentationBuilder;
50 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.node.attributes.ManagedNodeEntry;
51 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.node.attributes.ManagedNodeEntryKey;
52 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.node.attributes.QosEntries;
53 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.node.attributes.QosEntriesKey;
54 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes.InterfaceBfd;
55 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes.InterfaceBfdBuilder;
56 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes.InterfaceBfdKey;
57 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes.InterfaceBfdStatus;
58 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes.InterfaceBfdStatusBuilder;
59 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes.InterfaceBfdStatusKey;
60 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes.InterfaceExternalIds;
61 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes.InterfaceExternalIdsBuilder;
62 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes.InterfaceExternalIdsKey;
63 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes.InterfaceLldp;
64 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes.InterfaceLldpBuilder;
65 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes.InterfaceLldpKey;
66 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes.InterfaceOtherConfigs;
67 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes.InterfaceOtherConfigsBuilder;
68 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes.InterfaceOtherConfigsKey;
69 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes.Options;
70 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes.OptionsBuilder;
71 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes.OptionsKey;
72 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes.PortExternalIds;
73 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes.PortExternalIdsBuilder;
74 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes.PortExternalIdsKey;
75 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes.PortOtherConfigs;
76 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes.PortOtherConfigsBuilder;
77 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes.PortOtherConfigsKey;
78 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes.QosEntry;
79 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes.QosEntryBuilder;
80 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes.Trunks;
81 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes.TrunksBuilder;
82 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NetworkTopology;
83 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
84 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.TpId;
85 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.Topology;
86 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.TopologyKey;
87 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
88 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeKey;
89 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.node.TerminationPoint;
90 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.node.TerminationPointBuilder;
91 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.node.TerminationPointKey;
92 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
93 import org.opendaylight.yangtools.yang.binding.util.BindingMap;
94 import org.opendaylight.yangtools.yang.common.Uint16;
95 import org.opendaylight.yangtools.yang.common.Uint32;
96 import org.slf4j.Logger;
97 import org.slf4j.LoggerFactory;
98
99 public class OvsdbPortUpdateCommand extends AbstractTransactionCommand {
100     private static final Logger LOG = LoggerFactory.getLogger(OvsdbPortUpdateCommand.class);
101
102     private final InstanceIdentifierCodec instanceIdentifierCodec;
103     private final Map<UUID, Port> portUpdatedRows;
104     private final Map<UUID, Port> portOldRows;
105     private final Map<UUID, Interface> interfaceUpdatedRows;
106     private final Map<UUID, Interface> interfaceOldRows;
107     private final Map<UUID, Bridge> bridgeUpdatedRows;
108     private final Map<UUID, Qos> qosUpdatedRows;
109
110     public OvsdbPortUpdateCommand(InstanceIdentifierCodec instanceIdentifierCodec, OvsdbConnectionInstance key,
111             TableUpdates updates, DatabaseSchema dbSchema) {
112         super(key, updates, dbSchema);
113         this.instanceIdentifierCodec = instanceIdentifierCodec;
114         portUpdatedRows = TyperUtils.extractRowsUpdated(Port.class, updates, dbSchema);
115         portOldRows = TyperUtils.extractRowsOld(Port.class, updates, dbSchema);
116         interfaceUpdatedRows = TyperUtils.extractRowsUpdated(Interface.class, updates, dbSchema);
117         interfaceOldRows = TyperUtils.extractRowsOld(Interface.class, updates, dbSchema);
118         bridgeUpdatedRows = TyperUtils.extractRowsUpdated(Bridge.class, updates, dbSchema);
119         qosUpdatedRows = TyperUtils.extractRowsUpdated(Qos.class, updates, dbSchema);
120     }
121
122     @Override
123     public void execute(ReadWriteTransaction transaction) {
124         final InstanceIdentifier<Node> connectionIId = getOvsdbConnectionInstance().getInstanceIdentifier();
125         if (portUpdatedRows == null && interfaceOldRows == null
126                 || interfaceOldRows.isEmpty() && portUpdatedRows.isEmpty()) {
127             return;
128         }
129         Optional<Node> node = readNode(transaction, connectionIId);
130         if (node.isPresent()) {
131             updateTerminationPoints(transaction, node.get());
132         }
133     }
134
135     @VisibleForTesting
136     void updateTerminationPoints(ReadWriteTransaction transaction, Node node) {
137         for (Entry<UUID, Port> portUpdate : portUpdatedRows.entrySet()) {
138             String portName = null;
139             portName = portUpdate.getValue().getNameColumn().getData();
140             Optional<InstanceIdentifier<Node>> bridgeIid = getTerminationPointBridge(portUpdate.getKey());
141             if (!bridgeIid.isPresent()) {
142                 bridgeIid = getTerminationPointBridge(transaction, node, portName);
143             }
144             if (bridgeIid.isPresent()) {
145                 NodeId bridgeId = SouthboundMapper.createManagedNodeId(bridgeIid.get());
146                 TerminationPointKey tpKey = new TerminationPointKey(new TpId(portName));
147                 getOvsdbConnectionInstance().updatePortInterface(portName, bridgeIid.get());
148                 TerminationPointBuilder tpBuilder = new TerminationPointBuilder();
149                 tpBuilder.withKey(tpKey);
150                 tpBuilder.setTpId(tpKey.getTpId());
151                 InstanceIdentifier<TerminationPoint> tpPath =
152                         getInstanceIdentifier(bridgeIid.get(), portUpdate.getValue());
153                 OvsdbTerminationPointAugmentationBuilder tpAugmentationBuilder =
154                         new OvsdbTerminationPointAugmentationBuilder();
155                 buildTerminationPoint(transaction, tpPath, tpAugmentationBuilder, node, portUpdate);
156                 UUID interfaceUuid = (UUID)portUpdate.getValue().getInterfacesColumn().getData().toArray()[0];
157                 if (interfaceUpdatedRows.containsKey(interfaceUuid)) {
158                     buildTerminationPoint(tpAugmentationBuilder, interfaceUpdatedRows.get(interfaceUuid));
159                     interfaceUpdatedRows.remove(interfaceUuid);
160                     interfaceOldRows.remove(interfaceUuid);
161                 }
162                 tpBuilder.addAugmentation(tpAugmentationBuilder.build());
163                 if (portOldRows.containsKey(portUpdate.getKey()) && !portQosCleared(portUpdate)) {
164                     updateToDataStore(transaction, tpBuilder, tpPath, true);
165                     LOG.info("DEVICE - {} TerminationPoint : {} to Bridge : {}", TransactionType.ADD,
166                             tpKey.getTpId().getValue(), bridgeId.getValue());
167                 } else {
168                     updateToDataStore(transaction, tpBuilder, tpPath, false);
169                     LOG.debug("DEVICE - {} TerminationPoint : {} to Bridge : {}", TransactionType.UPDATE,
170                             tpKey.getTpId().getValue(), bridgeId.getValue());
171                 }
172             }
173         }
174         for (Entry<UUID, Interface> interfaceUpdate : interfaceUpdatedRows.entrySet()) {
175             String interfaceName = null;
176             Optional<InstanceIdentifier<Node>> bridgeIid = Optional.empty();
177             interfaceName = interfaceUpdatedRows.get(interfaceUpdate.getKey()).getNameColumn().getData();
178             if (getOvsdbConnectionInstance().getPortInterface(interfaceName) != null) {
179                 bridgeIid = Optional.of(getOvsdbConnectionInstance().getPortInterface(interfaceName));
180             }
181             if (!bridgeIid.isPresent()) {
182                 bridgeIid = getTerminationPointBridge(transaction, node, interfaceName);
183             }
184             if (bridgeIid.isPresent()) {
185                 TerminationPointKey tpKey = new TerminationPointKey(new TpId(interfaceName));
186                 TerminationPointBuilder tpBuilder = new TerminationPointBuilder();
187                 tpBuilder.withKey(tpKey);
188                 tpBuilder.setTpId(tpKey.getTpId());
189                 OvsdbTerminationPointAugmentationBuilder tpAugmentationBuilder =
190                         new OvsdbTerminationPointAugmentationBuilder();
191                 buildTerminationPoint(tpAugmentationBuilder, interfaceUpdate.getValue());
192                 tpBuilder.addAugmentation(tpAugmentationBuilder.build());
193                 NodeId bridgeId = SouthboundMapper.createManagedNodeId(bridgeIid.get());
194                 InstanceIdentifier<TerminationPoint> tpPath = InstanceIdentifier
195                         .create(NetworkTopology.class)
196                         .child(Topology.class, new TopologyKey(SouthboundConstants.OVSDB_TOPOLOGY_ID))
197                         .child(Node.class,new NodeKey(bridgeId))
198                         .child(TerminationPoint.class,tpKey);
199                 updateToDataStore(transaction, tpBuilder, tpPath, true);
200             }
201         }
202
203     }
204
205     protected void updateToDataStore(ReadWriteTransaction transaction, TerminationPointBuilder tpBuilder,
206                                      InstanceIdentifier<TerminationPoint> tpPath, boolean merge) {
207         if (merge) {
208             transaction.merge(LogicalDatastoreType.OPERATIONAL,
209                     tpPath, tpBuilder.build());
210         } else {
211             transaction.put(LogicalDatastoreType.OPERATIONAL,
212                     tpPath, tpBuilder.build());
213         }
214     }
215
216     @VisibleForTesting
217     void buildTerminationPoint(ReadWriteTransaction transaction,
218             InstanceIdentifier<TerminationPoint> tpPath,
219             OvsdbTerminationPointAugmentationBuilder tpAugmentationBuilder,
220             Node node, Entry<UUID, Port> portUpdate) {
221
222         tpAugmentationBuilder
223                 .setName(portUpdate.getValue().getName());
224         tpAugmentationBuilder.setPortUuid(new Uuid(
225                 portUpdate.getValue().getUuid().toString()));
226         updatePort(transaction, node, tpPath, portUpdate, tpAugmentationBuilder);
227     }
228
229     private void buildTerminationPoint(OvsdbTerminationPointAugmentationBuilder tpAugmentationBuilder,
230             Interface interfaceUpdate) {
231
232         tpAugmentationBuilder
233                 .setName(interfaceUpdate.getName());
234         tpAugmentationBuilder.setInterfaceUuid(new Uuid(
235                 interfaceUpdate.getUuid().toString()));
236         updateInterfaces(interfaceUpdate, tpAugmentationBuilder);
237     }
238
239     @SuppressWarnings("IllegalCatch")
240     private Optional<Node> readNode(final ReadWriteTransaction transaction, final InstanceIdentifier<Node> nodePath) {
241         Optional<Node> node = Optional.empty();
242         try {
243             node = SouthboundUtil.readNode(transaction, nodePath);
244         } catch (Exception exp) {
245             LOG.error("Error in getting the Node for {}", nodePath, exp);
246         }
247         return node;
248     }
249
250     private Optional<InstanceIdentifier<Node>> getTerminationPointBridge(UUID portUuid) {
251
252         if (bridgeUpdatedRows != null) {
253             for (Entry<UUID, Bridge> entry : this.bridgeUpdatedRows.entrySet()) {
254                 UUID bridgeUuid = entry.getKey();
255                 if (this.bridgeUpdatedRows.get(bridgeUuid).getPortsColumn().getData()
256                     .contains(portUuid)) {
257                     InstanceIdentifier<Node> iid = SouthboundMapper.createInstanceIdentifier(
258                         instanceIdentifierCodec, getOvsdbConnectionInstance(),
259                         this.bridgeUpdatedRows.get(bridgeUuid));
260                     getOvsdbConnectionInstance().updatePort(portUuid, iid);
261                     return Optional.of(iid);
262                 }
263             }
264         }
265         if (getOvsdbConnectionInstance().getPort(portUuid) != null) {
266             return Optional.of(getOvsdbConnectionInstance().getPort(portUuid));
267         }
268         return Optional.empty();
269     }
270
271     @SuppressWarnings("unchecked")
272     // FIXME: non-static for implementation internals mocking
273     private Optional<InstanceIdentifier<Node>> getTerminationPointBridge(
274             final ReadWriteTransaction transaction, Node node, String tpName) {
275         OvsdbNodeAugmentation ovsdbNode = node.augmentation(OvsdbNodeAugmentation.class);
276         Map<ManagedNodeEntryKey, ManagedNodeEntry> managedNodes = ovsdbNode.nonnullManagedNodeEntry();
277         TpId tpId = new TpId(tpName);
278
279         for (ManagedNodeEntry managedNodeEntry : managedNodes.values()) {
280             Optional<Node> optManagedNode = SouthboundUtil.readNode(transaction,
281                     (InstanceIdentifier<Node>)managedNodeEntry.getBridgeRef().getValue());
282             if (optManagedNode.isPresent()) {
283                 Node managedNode = optManagedNode.get();
284                 Map<TerminationPointKey, TerminationPoint> tpEntrys = managedNode.getTerminationPoint();
285                 if (tpEntrys != null) {
286                     TerminationPoint tpEntry = tpEntrys.get(new TerminationPointKey(tpId));
287                     if (tpEntry != null) {
288                         return Optional.of((InstanceIdentifier<Node>) managedNodeEntry.getBridgeRef().getValue());
289                     }
290                 }
291             }
292         }
293
294         return Optional.empty();
295     }
296
297     @VisibleForTesting
298     void updateInterfaces(Interface interfaceUpdate,
299             final OvsdbTerminationPointAugmentationBuilder ovsdbTerminationPointBuilder) {
300
301         Column<GenericTableSchema, String> typeColumn = interfaceUpdate.getTypeColumn();
302         String type = typeColumn.getData();
303         updateInterface(interfaceUpdate, type,ovsdbTerminationPointBuilder);
304     }
305
306     @VisibleForTesting
307     void updatePort(final ReadWriteTransaction transaction, final Node node,
308             final InstanceIdentifier<TerminationPoint> tpPath, final Entry<UUID, Port> port,
309             final OvsdbTerminationPointAugmentationBuilder ovsdbTerminationPointBuilder) {
310
311         updateVlan(port.getValue(), ovsdbTerminationPointBuilder);
312         updateVlanTrunks(port.getValue(), ovsdbTerminationPointBuilder);
313         updateVlanMode(port.getValue(), ovsdbTerminationPointBuilder);
314         updateQos(transaction, node, tpPath, port, ovsdbTerminationPointBuilder);
315         updatePortExternalIds(port.getValue(), ovsdbTerminationPointBuilder);
316         updatePortOtherConfig(port.getValue(), ovsdbTerminationPointBuilder);
317     }
318
319     @VisibleForTesting
320     void updateInterface(final Interface interf,
321             final String type,
322             final OvsdbTerminationPointAugmentationBuilder ovsdbTerminationPointBuilder) {
323
324         ovsdbTerminationPointBuilder.setInterfaceUuid(
325                 new Uuid(interf.getUuid().toString()));
326         ovsdbTerminationPointBuilder.setInterfaceType(
327                 SouthboundMapper.createInterfaceType(type));
328         updateIfIndex(interf, ovsdbTerminationPointBuilder);
329         updateMac(interf, ovsdbTerminationPointBuilder);
330         updateMacInUse(interf, ovsdbTerminationPointBuilder);
331         updateOfPort(interf, ovsdbTerminationPointBuilder);
332         updateOfPortRequest(interf, ovsdbTerminationPointBuilder);
333         updateInterfaceExternalIds(interf, ovsdbTerminationPointBuilder);
334         updateOptions(interf, ovsdbTerminationPointBuilder);
335         updateInterfaceOtherConfig(interf, ovsdbTerminationPointBuilder);
336         updateInterfaceLldp(interf, ovsdbTerminationPointBuilder);
337         updateInterfaceBfd(interf, ovsdbTerminationPointBuilder);
338         updateInterfaceBfdStatus(interf, ovsdbTerminationPointBuilder);
339         updateInterfacePolicing(interf, ovsdbTerminationPointBuilder);
340     }
341
342     @VisibleForTesting
343     void updateVlan(final Port port,
344             final OvsdbTerminationPointAugmentationBuilder ovsdbTerminationPointBuilder) {
345
346         Collection<Long> vlanId = port.getTagColumn().getData();
347         if (vlanId.size() > 0) {
348             Iterator<Long> itr = vlanId.iterator();
349             // There are no loops here, just get the first element.
350             int id = itr.next().intValue();
351             ovsdbTerminationPointBuilder.setVlanTag(new VlanId(Uint16.valueOf(id)));
352         }
353     }
354
355     @VisibleForTesting
356     void updateVlanTrunks(final Port port,
357             final OvsdbTerminationPointAugmentationBuilder ovsdbTerminationPointBuilder) {
358
359         Set<Long> portTrunks = port.getTrunksColumn().getData();
360         List<Trunks> modelTrunks = new ArrayList<>();
361         if (!portTrunks.isEmpty()) {
362             for (Long trunk: portTrunks) {
363                 if (trunk != null) {
364                     modelTrunks.add(new TrunksBuilder()
365                         .setTrunk(new VlanId(Uint16.valueOf(trunk.intValue()))).build());
366                 }
367             }
368         }
369         ovsdbTerminationPointBuilder.setTrunks(modelTrunks);
370     }
371
372     @VisibleForTesting
373     void updateVlanMode(final Port port,
374             final OvsdbTerminationPointAugmentationBuilder ovsdbTerminationPointBuilder) {
375
376         Collection<String> vlanMode = port.getVlanModeColumn().getData();
377         if (!vlanMode.isEmpty()) {
378             Iterator<String> itr = vlanMode.iterator();
379             String vlanType = itr.next();
380             if (vlanType.equals(SouthboundConstants.VlanModes.ACCESS.getMode())) {
381                 ovsdbTerminationPointBuilder
382                     .setVlanMode(OvsdbPortInterfaceAttributes.VlanMode.Access);
383             } else if (vlanType.equals(SouthboundConstants.VlanModes.NATIVE_TAGGED.getMode())) {
384                 ovsdbTerminationPointBuilder
385                     .setVlanMode(OvsdbPortInterfaceAttributes.VlanMode.NativeTagged);
386             } else if (vlanType.equals(SouthboundConstants.VlanModes.NATIVE_UNTAGGED.getMode())) {
387                 ovsdbTerminationPointBuilder
388                     .setVlanMode(OvsdbPortInterfaceAttributes.VlanMode.NativeUntagged);
389             } else if (vlanType.equals(SouthboundConstants.VlanModes.TRUNK.getMode())) {
390                 ovsdbTerminationPointBuilder
391                     .setVlanMode(OvsdbPortInterfaceAttributes.VlanMode.Trunk);
392             } else {
393                 LOG.debug("Invalid vlan mode {}.", vlanType);
394             }
395         }
396     }
397
398     private void updateQos(final ReadWriteTransaction transaction, final Node node,
399                            InstanceIdentifier<TerminationPoint> tpPath, final Entry<UUID, Port> port,
400                            final OvsdbTerminationPointAugmentationBuilder ovsdbTerminationPointBuilder) {
401         if (port.getValue() == null) {
402             return;
403         }
404         Collection<UUID> qosUuidCol = port.getValue().getQosColumn().getData();
405         if (!qosUuidCol.isEmpty()) {
406             UUID qosUuid = qosUuidCol.iterator().next();
407
408             NodeId nodeId = node.getNodeId();
409             OvsdbNodeAugmentation ovsdbNode = node.augmentation(OvsdbNodeAugmentation.class);
410
411             // Delete an older QoS entry
412             if (portOldRows.containsKey(port.getKey()) && portOldRows.get(port.getKey()).getQosColumn() != null) {
413                 Collection<UUID> oldQos = portOldRows.get(port.getKey()).getQosColumn().getData();
414                 if (!oldQos.isEmpty()) {
415                     UUID oldQosUuid = oldQos.iterator().next();
416                     if (!oldQosUuid.equals(qosUuid)) {
417                         InstanceIdentifier<QosEntries> oldQosIid = getQosIid(nodeId, ovsdbNode, oldQosUuid);
418                         if (oldQosIid != null) {
419                             InstanceIdentifier<QosEntry> oldPortQosIid = tpPath
420                                 .augmentation(OvsdbTerminationPointAugmentation.class)
421                                 .child(QosEntry.class, SouthboundConstants.PORT_QOS_LIST_KEY);
422                             transaction.delete(LogicalDatastoreType.OPERATIONAL, oldPortQosIid);
423                         }
424                     }
425                 }
426             }
427
428             InstanceIdentifier<QosEntries> qosIid = getQosIid(nodeId, ovsdbNode, qosUuid);
429             if (qosIid != null) {
430                 ovsdbTerminationPointBuilder.setQosEntry(
431                     Map.of(SouthboundConstants.PORT_QOS_LIST_KEY, new QosEntryBuilder()
432                         .withKey(SouthboundConstants.PORT_QOS_LIST_KEY)
433                         .setQosRef(new OvsdbQosRef(qosIid))
434                         .build()));
435             }
436         }
437     }
438
439     @SuppressWarnings("unchecked")
440     private InstanceIdentifier<QosEntries> getQosIid(NodeId nodeId, OvsdbNodeAugmentation ovsdbNode, UUID qosUuid) {
441         // Search for the QoS entry first in the operational datastore
442         final Uuid uuid = new Uuid(qosUuid.toString());
443         for (QosEntries qosEntry : ovsdbNode.nonnullQosEntries().values()) {
444             if (uuid.equals(qosEntry.getQosUuid())) {
445                 return SouthboundMapper.createInstanceIdentifier(nodeId)
446                         .augmentation(OvsdbNodeAugmentation.class)
447                         .child(QosEntries.class, qosEntry.key());
448             }
449         }
450
451         // Search for the QoS entry in the current OVS updates
452         for (Entry<UUID, Qos> qosUpdate : qosUpdatedRows.entrySet()) {
453             Qos qos = qosUpdate.getValue();
454             if (qos.getUuid().equals(qosUuid)) {
455                 if (qos.getExternalIdsColumn().getData().containsKey(SouthboundConstants.IID_EXTERNAL_ID_KEY)) {
456                     return (InstanceIdentifier<QosEntries>) instanceIdentifierCodec.bindingDeserializerOrNull(
457                             qos.getExternalIdsColumn().getData().get(SouthboundConstants.IID_EXTERNAL_ID_KEY));
458                 } else {
459                     return SouthboundMapper.createInstanceIdentifier(nodeId)
460                             .augmentation(OvsdbNodeAugmentation.class)
461                             .child(QosEntries.class, new QosEntriesKey(
462                                     new Uri(SouthboundConstants.QOS_URI_PREFIX + "://" + qosUuid.toString())));
463                 }
464             }
465         }
466         LOG.debug("QoS UUID {} assigned to port not found in operational node {} or QoS updates", qosUuid, ovsdbNode);
467         return SouthboundMapper.createInstanceIdentifier(nodeId)
468                 .augmentation(OvsdbNodeAugmentation.class)
469                 .child(QosEntries.class, new QosEntriesKey(
470                         new Uri(SouthboundConstants.QOS_URI_PREFIX + "://" + qosUuid.toString())));
471     }
472
473     private static void updateIfIndex(final Interface interf,
474             final OvsdbTerminationPointAugmentationBuilder ovsdbTerminationPointBuilder) {
475         Set<Long> ifIndexSet = null;
476         try {
477             if (interf.getIfIndexColumn() != null) {
478                 ifIndexSet = interf.getIfIndexColumn().getData();
479             }
480             if (ifIndexSet != null && !ifIndexSet.isEmpty()) {
481                 for (Long ifIndex : ifIndexSet) {
482                     ovsdbTerminationPointBuilder.setIfindex(Uint32.valueOf(ifIndex));
483                 }
484             }
485         } catch (SchemaVersionMismatchException e) {
486             schemaMismatchLog("ifindex", "Interface", e);
487         }
488     }
489
490     private static void updateMac(final Interface interf,
491                                   final OvsdbTerminationPointAugmentationBuilder ovsdbTerminationPointBuilder) {
492         Set<String> macSet = null;
493         try {
494             if (interf.getMacColumn() != null) {
495                 macSet = interf.getMacColumn().getData();
496             }
497             if (macSet != null && !macSet.isEmpty()) {
498                 /*
499                  * It is a set due to way JSON decoder converts [] objects. OVS
500                  * only supports ONE mac, so we're fine.
501                  */
502                 for (String mac: macSet) {
503                     ovsdbTerminationPointBuilder.setMac(new MacAddress(mac));
504                 }
505             }
506         } catch (SchemaVersionMismatchException e) {
507             schemaMismatchLog("mac", "Interface", e);
508         }
509     }
510
511     private static void updateMacInUse(final Interface interf,
512                                        final OvsdbTerminationPointAugmentationBuilder ovsdbTerminationPointBuilder) {
513         Set<String> macInUseSet = null;
514         try {
515             if (interf.getMacInUseColumn() != null) {
516                 macInUseSet = interf.getMacInUseColumn().getData();
517             }
518             if (macInUseSet != null && !macInUseSet.isEmpty()) {
519                 /*
520                  * It is a set due to way JSON decoder converts [] objects. OVS
521                  * only supports ONE mac, so we're fine.
522                  */
523                 for (String macInUse: macInUseSet) {
524                     ovsdbTerminationPointBuilder.setMacInUse(new MacAddress(macInUse));
525                 }
526             }
527         } catch (SchemaVersionMismatchException e) {
528             schemaMismatchLog("mac_in_use", "Interface", e);
529         }
530     }
531
532     @VisibleForTesting
533     void updateOfPort(final Interface interf,
534             final OvsdbTerminationPointAugmentationBuilder ovsdbTerminationPointBuilder) {
535
536         Set<Long> ofPorts = interf.getOpenFlowPortColumn().getData();
537         if (ofPorts != null && !ofPorts.isEmpty()) {
538             Iterator<Long> ofPortsIter = ofPorts.iterator();
539             long ofPort = ofPortsIter.next();
540             if (ofPort >= 0) {
541                 ovsdbTerminationPointBuilder.setOfport(Uint32.valueOf(ofPort));
542             } else {
543                 LOG.debug("Received negative value for ofPort from ovsdb for {} {}", interf.getName(),ofPort);
544             }
545         }
546     }
547
548     @VisibleForTesting
549     void updateOfPortRequest(final Interface interf,
550             final OvsdbTerminationPointAugmentationBuilder ovsdbTerminationPointBuilder) {
551
552         Set<Long> ofPortRequests = null;
553         try {
554             ofPortRequests = interf.getOpenFlowPortRequestColumn().getData();
555         } catch (ColumnSchemaNotFoundException e) {
556             LOG.warn("Cannot find openflow column", e);
557         }
558         if (ofPortRequests != null && !ofPortRequests.isEmpty()) {
559             Iterator<Long> ofPortRequestsIter = ofPortRequests.iterator();
560             int ofPort = ofPortRequestsIter.next().intValue();
561             if (ofPort >= 0) {
562                 ovsdbTerminationPointBuilder.setOfportRequest(Uint16.valueOf(ofPort));
563             } else {
564                 LOG.debug("Received negative value for ofPort from ovsdb for {} {}", interf.getName(),ofPort);
565             }
566         }
567     }
568
569     @VisibleForTesting
570     void updateInterfaceExternalIds(final Interface interf,
571             final OvsdbTerminationPointAugmentationBuilder ovsdbTerminationPointBuilder) {
572
573         Map<String, String> interfaceExternalIds =
574                 interf.getExternalIdsColumn().getData();
575         if (interfaceExternalIds != null && !interfaceExternalIds.isEmpty()) {
576             var externalIdsList = BindingMap.<InterfaceExternalIdsKey, InterfaceExternalIds>orderedBuilder();
577             for (Entry<String, String> entry : interfaceExternalIds.entrySet()) {
578                 String externalIdKey = entry.getKey();
579                 String externalIdValue = entry.getValue();
580                 if (externalIdKey != null && externalIdValue != null) {
581                     externalIdsList.add(new InterfaceExternalIdsBuilder()
582                             .setExternalIdKey(externalIdKey)
583                             .setExternalIdValue(externalIdValue)
584                             .build());
585                 }
586             }
587             ovsdbTerminationPointBuilder.setInterfaceExternalIds(externalIdsList.build());
588         }
589     }
590
591     @VisibleForTesting
592     void updatePortExternalIds(final Port port,
593             final OvsdbTerminationPointAugmentationBuilder ovsdbTerminationPointBuilder) {
594
595         Map<String, String> portExternalIds = port.getExternalIdsColumn().getData();
596         if (portExternalIds != null && !portExternalIds.isEmpty()) {
597             var externalIdsList = BindingMap.<PortExternalIdsKey, PortExternalIds>orderedBuilder();
598             for (Entry<String, String> entry : portExternalIds.entrySet()) {
599                 String externalIdKey = entry.getKey();
600                 String externalIdValue = entry.getValue();
601                 if (externalIdKey != null && externalIdValue != null) {
602                     externalIdsList.add(new PortExternalIdsBuilder()
603                             .setExternalIdKey(externalIdKey)
604                             .setExternalIdValue(externalIdValue).build());
605                 }
606             }
607             ovsdbTerminationPointBuilder.setPortExternalIds(externalIdsList.build());
608         }
609     }
610
611     @VisibleForTesting
612     void updateOptions(final Interface interf,
613             final OvsdbTerminationPointAugmentationBuilder ovsdbTerminationPointBuilder) {
614
615         Map<String, String> optionsMap = interf.getOptionsColumn().getData();
616         if (optionsMap != null && !optionsMap.isEmpty()) {
617             var options = BindingMap.<OptionsKey, Options>orderedBuilder();
618             for (Entry<String, String> entry : optionsMap.entrySet()) {
619                 String optionsKeyString = entry.getKey();
620                 String optionsValueString = entry.getValue();
621                 if (optionsKeyString != null && optionsValueString != null) {
622                     OptionsKey optionsKey = new OptionsKey(optionsKeyString);
623                     options.add(new OptionsBuilder()
624                         .withKey(optionsKey)
625                         .setValue(optionsValueString).build());
626                 }
627             }
628             ovsdbTerminationPointBuilder.setOptions(options.build());
629         }
630     }
631
632     @VisibleForTesting
633     void updatePortOtherConfig(final Port port,
634             final OvsdbTerminationPointAugmentationBuilder ovsdbTerminationPointBuilder) {
635
636         Map<String, String> portOtherConfigMap = port.getOtherConfigColumn().getData();
637         if (portOtherConfigMap != null && !portOtherConfigMap.isEmpty()) {
638             var portOtherConfigs = BindingMap.<PortOtherConfigsKey, PortOtherConfigs>orderedBuilder();
639             for (Entry<String, String> entry : portOtherConfigMap.entrySet()) {
640                 String portOtherConfigKeyString = entry.getKey();
641                 String portOtherConfigValueString = entry.getValue();
642                 if (portOtherConfigKeyString != null && portOtherConfigValueString != null) {
643                     portOtherConfigs.add(new PortOtherConfigsBuilder()
644                         .setOtherConfigKey(portOtherConfigKeyString)
645                         .setOtherConfigValue(portOtherConfigValueString).build());
646                 }
647             }
648             ovsdbTerminationPointBuilder.setPortOtherConfigs(portOtherConfigs.build());
649         }
650     }
651
652     private static void updateInterfaceLldp(final Interface interf,
653             final OvsdbTerminationPointAugmentationBuilder ovsdbTerminationPointBuilder) {
654
655         try {
656             Map<String, String> interfaceLldpMap = interf.getLldpColumn().getData();
657             if (interfaceLldpMap != null && !interfaceLldpMap.isEmpty()) {
658                 var interfaceLldpList = BindingMap.<InterfaceLldpKey, InterfaceLldp>orderedBuilder();
659                 for (Entry<String, String> entry : interfaceLldpMap.entrySet()) {
660                     String interfaceLldpKeyString = entry.getKey();
661                     String interfaceLldpValueString = entry.getValue();
662                     if (interfaceLldpKeyString != null && interfaceLldpValueString != null) {
663                         interfaceLldpList.add(new InterfaceLldpBuilder()
664                                 .withKey(new InterfaceLldpKey(interfaceLldpKeyString))
665                                 .setLldpKey(interfaceLldpKeyString)
666                                 .setLldpValue(interfaceLldpValueString)
667                                 .build());
668                     }
669                 }
670                 ovsdbTerminationPointBuilder.setInterfaceLldp(interfaceLldpList.build());
671             }
672         } catch (SchemaVersionMismatchException e) {
673             schemaMismatchLog("lldp", "Interface", e);
674         }
675     }
676
677     @VisibleForTesting
678     void updateInterfaceOtherConfig(final Interface interf,
679             final OvsdbTerminationPointAugmentationBuilder ovsdbTerminationPointBuilder) {
680
681         Map<String, String> interfaceOtherConfigMap = interf.getOtherConfigColumn().getData();
682         if (interfaceOtherConfigMap != null && !interfaceOtherConfigMap.isEmpty()) {
683             var interfaceOtherConfigs = BindingMap.<InterfaceOtherConfigsKey, InterfaceOtherConfigs>orderedBuilder();
684             for (Entry<String, String> entry : interfaceOtherConfigMap.entrySet()) {
685                 String interfaceOtherConfigKeyString = entry.getKey();
686                 String interfaceOtherConfigValueString = entry.getValue();
687                 if (interfaceOtherConfigKeyString != null && interfaceOtherConfigValueString != null) {
688                     interfaceOtherConfigs.add(new InterfaceOtherConfigsBuilder()
689                         .setOtherConfigKey(interfaceOtherConfigKeyString)
690                         .setOtherConfigValue(interfaceOtherConfigValueString).build());
691                 }
692             }
693             ovsdbTerminationPointBuilder.setInterfaceOtherConfigs(interfaceOtherConfigs.build());
694         }
695     }
696
697     private static void updateInterfaceBfdStatus(final Interface interf,
698             final OvsdbTerminationPointAugmentationBuilder ovsdbTerminationPointBuilder) {
699
700         try {
701             Map<String, String> interfaceBfdStatusMap = interf.getBfdStatusColumn().getData();
702             if (interfaceBfdStatusMap != null && !interfaceBfdStatusMap.isEmpty()) {
703                 var interfaceBfdStatusList = BindingMap.<InterfaceBfdStatusKey, InterfaceBfdStatus>orderedBuilder();
704                 for (Entry<String, String> entry : interfaceBfdStatusMap.entrySet()) {
705                     String interfaceBfdStatusKeyString = entry.getKey();
706                     String interfaceBfdStatusValueString = entry.getValue();
707                     if (interfaceBfdStatusKeyString != null && interfaceBfdStatusValueString != null) {
708                         interfaceBfdStatusList.add(new InterfaceBfdStatusBuilder()
709                                 .withKey(new InterfaceBfdStatusKey(interfaceBfdStatusKeyString))
710                                 .setBfdStatusKey(interfaceBfdStatusKeyString)
711                                 .setBfdStatusValue(interfaceBfdStatusValueString)
712                                 .build());
713                     }
714                 }
715                 ovsdbTerminationPointBuilder.setInterfaceBfdStatus(interfaceBfdStatusList.build());
716             }
717         } catch (SchemaVersionMismatchException e) {
718             schemaMismatchLog("bfd", "Interface", e);
719         }
720     }
721
722     private static void updateInterfaceBfd(final Interface interf,
723             final OvsdbTerminationPointAugmentationBuilder ovsdbTerminationPointBuilder) {
724
725         try {
726             Map<String, String> interfaceBfdMap = interf.getBfdColumn().getData();
727             if (interfaceBfdMap != null && !interfaceBfdMap.isEmpty()) {
728                 var interfaceBfdList = BindingMap.<InterfaceBfdKey, InterfaceBfd>orderedBuilder();
729                 for (Entry<String, String> entry : interfaceBfdMap.entrySet()) {
730                     String interfaceBfdKeyString = entry.getKey();
731                     String interfaceBfdValueString = entry.getValue();
732                     if (interfaceBfdKeyString != null && interfaceBfdValueString != null) {
733                         interfaceBfdList.add(new InterfaceBfdBuilder()
734                                 .withKey(new InterfaceBfdKey(interfaceBfdKeyString))
735                                 .setBfdKey(interfaceBfdKeyString)
736                                 .setBfdValue(interfaceBfdValueString)
737                                 .build());
738                     }
739                 }
740                 ovsdbTerminationPointBuilder.setInterfaceBfd(interfaceBfdList.build());
741             }
742         } catch (SchemaVersionMismatchException e) {
743             schemaMismatchLog("bfd", "Interface", e);
744
745         }
746     }
747
748     private static void updateInterfacePolicing(final Interface interf,
749             final OvsdbTerminationPointAugmentationBuilder ovsdbTerminationPointBuilder) {
750
751         Long ingressPolicingRate = null;
752         if (interf.getIngressPolicingRateColumn() != null) {
753             ingressPolicingRate = interf.getIngressPolicingRateColumn().getData();
754         }
755         if (ingressPolicingRate != null) {
756             if (ingressPolicingRate >= 0) {
757                 ovsdbTerminationPointBuilder
758                     .setIngressPolicingRate(Uint32.valueOf(ingressPolicingRate));
759             } else {
760                 LOG.debug("Received negative value for ingressPolicingRate from ovsdb for {} {}",
761                         interf.getName(),ingressPolicingRate);
762             }
763         }
764
765         Long ingressPolicingBurst = null;
766         if (interf.getIngressPolicingBurstColumn() != null) {
767             ingressPolicingBurst = interf.getIngressPolicingBurstColumn().getData();
768         }
769         if (ingressPolicingBurst != null) {
770             if (ingressPolicingBurst >= 0) {
771                 ovsdbTerminationPointBuilder
772                     .setIngressPolicingBurst(Uint32.valueOf(ingressPolicingBurst));
773             } else {
774                 LOG.debug("Received negative value for ingressPolicingBurst from ovsdb for {} {}",
775                         interf.getName(),ingressPolicingBurst);
776             }
777         }
778     }
779
780     private boolean portQosCleared(Entry<UUID, Port> portUpdate) {
781         if (portUpdate.getValue().getQosColumn() == null) {
782             return false;
783         }
784         Collection<UUID> newQos = portUpdate.getValue().getQosColumn().getData();
785         if (portOldRows.get(portUpdate.getKey()).getQosColumn() == null) {
786             return false;
787         }
788         Collection<UUID> oldQos = portOldRows.get(portUpdate.getKey()).getQosColumn().getData();
789
790         if (newQos.isEmpty() && !oldQos.isEmpty()) {
791             return true;
792         } else {
793             return false;
794         }
795     }
796
797     @SuppressWarnings("unchecked")
798     @VisibleForTesting
799     InstanceIdentifier<TerminationPoint> getInstanceIdentifier(InstanceIdentifier<Node> bridgeIid,Port port) {
800         if (port.getExternalIdsColumn() != null
801                 && port.getExternalIdsColumn().getData() != null
802                 && port.getExternalIdsColumn().getData().containsKey(SouthboundConstants.IID_EXTERNAL_ID_KEY)) {
803             String iidString = port.getExternalIdsColumn().getData().get(SouthboundConstants.IID_EXTERNAL_ID_KEY);
804             return (InstanceIdentifier<TerminationPoint>) instanceIdentifierCodec.bindingDeserializerOrNull(iidString);
805         } else {
806             return bridgeIid.child(TerminationPoint.class, new TerminationPointKey(new TpId(port.getName())));
807         }
808     }
809 }