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