2 * Copyright (c) 2015 Cisco Systems, Inc. and others. All rights reserved.
4 * This program and the accompanying materials are made available under the
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
8 package org.opendaylight.ovsdb.southbound.transactions.md;
10 import static java.util.Objects.requireNonNull;
11 import static org.opendaylight.ovsdb.southbound.SouthboundUtil.schemaMismatchLog;
13 import com.google.common.annotations.VisibleForTesting;
14 import com.google.common.net.InetAddresses;
15 import java.net.InetAddress;
16 import java.net.NetworkInterface;
17 import java.net.SocketException;
18 import java.util.ArrayList;
19 import java.util.Enumeration;
20 import java.util.List;
22 import java.util.Map.Entry;
23 import java.util.Optional;
25 import org.apache.commons.lang3.math.NumberUtils;
26 import org.opendaylight.mdsal.binding.api.ReadWriteTransaction;
27 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
28 import org.opendaylight.ovsdb.lib.error.SchemaVersionMismatchException;
29 import org.opendaylight.ovsdb.lib.message.TableUpdates;
30 import org.opendaylight.ovsdb.lib.notation.UUID;
31 import org.opendaylight.ovsdb.lib.schema.DatabaseSchema;
32 import org.opendaylight.ovsdb.lib.schema.typed.TyperUtils;
33 import org.opendaylight.ovsdb.schema.openvswitch.Bridge;
34 import org.opendaylight.ovsdb.schema.openvswitch.Controller;
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.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
41 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressBuilder;
42 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid;
43 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.DatapathId;
44 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbBridgeAugmentation;
45 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbBridgeAugmentationBuilder;
46 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbBridgeName;
47 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbBridgeProtocolBase;
48 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbBridgeRef;
49 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbNodeAugmentationBuilder;
50 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbNodeRef;
51 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.bridge.attributes.BridgeExternalIds;
52 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.bridge.attributes.BridgeExternalIdsBuilder;
53 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.bridge.attributes.BridgeExternalIdsKey;
54 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.bridge.attributes.BridgeOtherConfigs;
55 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.bridge.attributes.BridgeOtherConfigsBuilder;
56 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.bridge.attributes.BridgeOtherConfigsKey;
57 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.bridge.attributes.ControllerEntry;
58 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.bridge.attributes.ProtocolEntry;
59 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.bridge.attributes.ProtocolEntryKey;
60 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.node.attributes.ManagedNodeEntry;
61 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.node.attributes.ManagedNodeEntryBuilder;
62 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
63 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
64 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeBuilder;
65 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeKey;
66 import org.opendaylight.yangtools.yang.binding.DataObject;
67 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
68 import org.slf4j.Logger;
69 import org.slf4j.LoggerFactory;
71 public class OvsdbBridgeUpdateCommand extends AbstractTransactionCommand {
72 private static final Logger LOG = LoggerFactory.getLogger(OvsdbBridgeUpdateCommand.class);
73 private final InstanceIdentifierCodec instanceIdentifierCodec;
74 private final Map<UUID,Bridge> updatedBridgeRows;
75 private final Map<UUID, Bridge> oldBridgeRows;
76 private final List<InstanceIdentifier<Node>> updatedBridges = new ArrayList<>();
77 private final Map<NodeId, Node> updatedBridgeNodes;
79 public OvsdbBridgeUpdateCommand(InstanceIdentifierCodec instanceIdentifierCodec, OvsdbConnectionInstance key,
80 TableUpdates updates, DatabaseSchema dbSchema,
81 Map<NodeId, Node> updatedBridgeNodes) {
82 super(key,updates,dbSchema);
83 this.instanceIdentifierCodec = instanceIdentifierCodec;
84 updatedBridgeRows = TyperUtils.extractRowsUpdated(Bridge.class, getUpdates(), getDbSchema());
85 oldBridgeRows = TyperUtils.extractRowsOld(Bridge.class, getUpdates(), getDbSchema());
86 this.updatedBridgeNodes = updatedBridgeNodes;
90 public void execute(ReadWriteTransaction transaction) {
91 if (updatedBridgeRows == null || updatedBridgeRows.isEmpty()) {
95 final InstanceIdentifier<Node> connectionIId = getOvsdbConnectionInstance().getInstanceIdentifier();
96 Optional<Node> connection = SouthboundUtil.readNode(transaction, connectionIId);
97 if (!connection.isPresent()) {
101 for (Entry<UUID, Bridge> entry : updatedBridgeRows.entrySet()) {
102 updateBridge(transaction, entry.getValue(), connectionIId);
107 void updateBridge(ReadWriteTransaction transaction,
108 Bridge bridge, InstanceIdentifier<Node> connectionIId) {
109 // Update the connection node to let it know it manages this bridge
110 Node connectionNode = buildConnectionNode(bridge);
111 transaction.merge(LogicalDatastoreType.OPERATIONAL, connectionIId, connectionNode);
113 // Update the bridge node with whatever data we are getting
114 InstanceIdentifier<Node> bridgeIid = getInstanceIdentifier(bridge);
115 Node bridgeNode = buildBridgeNode(bridge);
116 transaction.merge(LogicalDatastoreType.OPERATIONAL, bridgeIid, bridgeNode);
117 updatedBridges.add(bridgeIid);
118 updatedBridgeNodes.put(getNodeId(bridge), bridgeNode);
119 deleteEntries(transaction, protocolEntriesToRemove(bridgeIid, bridge));
120 deleteEntries(transaction, externalIdsToRemove(bridgeIid,bridge));
121 deleteEntries(transaction, bridgeOtherConfigsToRemove(bridgeIid,bridge));
125 <T extends DataObject> void deleteEntries(ReadWriteTransaction transaction,
126 List<InstanceIdentifier<T>> entryIids) {
127 for (InstanceIdentifier<T> entryIid : entryIids) {
128 transaction.delete(LogicalDatastoreType.OPERATIONAL, entryIid);
132 private List<InstanceIdentifier<BridgeOtherConfigs>> bridgeOtherConfigsToRemove(
133 InstanceIdentifier<Node> bridgeIid, Bridge bridge) {
134 requireNonNull(bridgeIid);
135 requireNonNull(bridge);
136 List<InstanceIdentifier<BridgeOtherConfigs>> result = new ArrayList<>();
138 Bridge oldBridge = oldBridgeRows.get(bridge.getUuid());
140 if (oldBridge != null && oldBridge.getOtherConfigColumn() != null) {
141 for (Entry<String, String> otherConfig:
142 oldBridge.getOtherConfigColumn().getData().entrySet()) {
143 if (bridge.getOtherConfigColumn() == null
144 || !bridge.getOtherConfigColumn().getData().containsKey(otherConfig.getKey())) {
145 InstanceIdentifier<BridgeOtherConfigs> iid = bridgeIid
146 .augmentation(OvsdbBridgeAugmentation.class)
147 .child(BridgeOtherConfigs.class,
148 new BridgeOtherConfigsKey(otherConfig.getKey()));
156 private List<InstanceIdentifier<BridgeExternalIds>> externalIdsToRemove(
157 InstanceIdentifier<Node> bridgeIid, Bridge bridge) {
158 requireNonNull(bridgeIid);
159 requireNonNull(bridge);
160 List<InstanceIdentifier<BridgeExternalIds>> result = new ArrayList<>();
162 Bridge oldBridge = oldBridgeRows.get(bridge.getUuid());
164 if (oldBridge != null && oldBridge.getExternalIdsColumn() != null) {
165 for (Entry<String, String> externalId:
166 oldBridge.getExternalIdsColumn().getData().entrySet()) {
167 if (bridge.getExternalIdsColumn() == null
168 || !bridge.getExternalIdsColumn().getData().containsKey(externalId.getKey())) {
169 InstanceIdentifier<BridgeExternalIds> iid = bridgeIid
170 .augmentation(OvsdbBridgeAugmentation.class)
171 .child(BridgeExternalIds.class,
172 new BridgeExternalIdsKey(externalId.getKey()));
180 private List<InstanceIdentifier<ProtocolEntry>> protocolEntriesToRemove(
181 InstanceIdentifier<Node> bridgeIid, Bridge bridge) {
182 requireNonNull(bridgeIid);
183 requireNonNull(bridge);
184 List<InstanceIdentifier<ProtocolEntry>> result = new ArrayList<>();
185 Bridge oldBridge = oldBridgeRows.get(bridge.getUuid());
188 if (oldBridge != null && oldBridge.getProtocolsColumn() != null) {
189 for (String protocol : oldBridge.getProtocolsColumn().getData()) {
190 if (bridge.getProtocolsColumn() == null || !bridge.getProtocolsColumn().getData()
191 .contains(protocol)) {
192 Class<? extends OvsdbBridgeProtocolBase> proto = SouthboundConstants.OVSDB_PROTOCOL_MAP
193 .inverse().get(protocol);
194 InstanceIdentifier<ProtocolEntry> iid = bridgeIid
195 .augmentation(OvsdbBridgeAugmentation.class)
196 .child(ProtocolEntry.class,
197 new ProtocolEntryKey(proto));
202 } catch (SchemaVersionMismatchException e) {
203 schemaMismatchLog("protocols", "Bridge", e);
208 private Node buildConnectionNode(
210 //Update node with managed node reference
211 NodeBuilder connectionNode = new NodeBuilder();
212 connectionNode.setNodeId(getOvsdbConnectionInstance().getNodeId());
214 OvsdbNodeAugmentationBuilder ovsdbConnectionAugmentationBuilder = new OvsdbNodeAugmentationBuilder();
215 List<ManagedNodeEntry> managedBridges = new ArrayList<>();
216 InstanceIdentifier<Node> bridgeIid =
217 SouthboundMapper.createInstanceIdentifier(instanceIdentifierCodec, getOvsdbConnectionInstance(),
219 ManagedNodeEntry managedBridge = new ManagedNodeEntryBuilder().setBridgeRef(
220 new OvsdbBridgeRef(bridgeIid)).build();
221 managedBridges.add(managedBridge);
222 ovsdbConnectionAugmentationBuilder.setManagedNodeEntry(managedBridges);
224 connectionNode.addAugmentation(ovsdbConnectionAugmentationBuilder.build());
226 LOG.debug("Update node with bridge node ref {}",
227 ovsdbConnectionAugmentationBuilder.getManagedNodeEntry().values().iterator().next());
228 return connectionNode.build();
231 private Node buildBridgeNode(Bridge bridge) {
232 NodeBuilder bridgeNodeBuilder = new NodeBuilder();
233 NodeId bridgeNodeId = getNodeId(bridge);
234 bridgeNodeBuilder.setNodeId(bridgeNodeId);
235 OvsdbBridgeAugmentationBuilder ovsdbBridgeAugmentationBuilder = new OvsdbBridgeAugmentationBuilder();
236 ovsdbBridgeAugmentationBuilder.setBridgeName(new OvsdbBridgeName(bridge.getName()));
237 ovsdbBridgeAugmentationBuilder.setBridgeUuid(new Uuid(bridge.getUuid().toString()));
238 setDataPath(ovsdbBridgeAugmentationBuilder, bridge);
239 setDataPathType(ovsdbBridgeAugmentationBuilder, bridge);
240 setProtocol(ovsdbBridgeAugmentationBuilder, bridge);
241 setExternalIds(ovsdbBridgeAugmentationBuilder, bridge);
242 setOtherConfig(ovsdbBridgeAugmentationBuilder, bridge);
243 setFailMode(ovsdbBridgeAugmentationBuilder, bridge);
244 setOpenFlowNodeRef(ovsdbBridgeAugmentationBuilder, bridge);
245 setManagedBy(ovsdbBridgeAugmentationBuilder);
246 setAutoAttach(ovsdbBridgeAugmentationBuilder, bridge);
247 setStpEnalbe(ovsdbBridgeAugmentationBuilder,bridge);
248 bridgeNodeBuilder.addAugmentation(ovsdbBridgeAugmentationBuilder.build());
250 LOG.debug("Built with the intent to store bridge data {}",
251 ovsdbBridgeAugmentationBuilder.build());
252 return bridgeNodeBuilder.build();
255 private static void setAutoAttach(OvsdbBridgeAugmentationBuilder ovsdbBridgeAugmentationBuilder, Bridge bridge) {
257 if (bridge.getAutoAttachColumn() != null
258 && bridge.getAutoAttachColumn().getData() != null
259 && !bridge.getAutoAttachColumn().getData().isEmpty()) {
260 Set<UUID> uuids = bridge.getAutoAttachColumn().getData();
261 for (UUID uuid : uuids) {
262 ovsdbBridgeAugmentationBuilder.setAutoAttach(new Uuid(uuid.toString()));
265 } catch (SchemaVersionMismatchException e) {
266 schemaMismatchLog("auto_attach", "Bridge", e);
270 private void setManagedBy(OvsdbBridgeAugmentationBuilder ovsdbBridgeAugmentationBuilder) {
271 InstanceIdentifier<Node> connectionNodePath = getOvsdbConnectionInstance().getInstanceIdentifier();
272 ovsdbBridgeAugmentationBuilder.setManagedBy(new OvsdbNodeRef(connectionNodePath));
275 private static void setDataPathType(OvsdbBridgeAugmentationBuilder ovsdbBridgeAugmentationBuilder, Bridge bridge) {
276 ovsdbBridgeAugmentationBuilder.setDatapathType(
277 SouthboundMapper.createDatapathType(bridge.getDatapathTypeColumn().getData()));
280 private static void setFailMode(OvsdbBridgeAugmentationBuilder ovsdbBridgeAugmentationBuilder, Bridge bridge) {
281 if (bridge.getFailModeColumn() != null
282 && bridge.getFailModeColumn().getData() != null
283 && !bridge.getFailModeColumn().getData().isEmpty()) {
284 String[] failmodeArray = new String[bridge.getFailModeColumn().getData().size()];
285 bridge.getFailModeColumn().getData().toArray(failmodeArray);
286 ovsdbBridgeAugmentationBuilder.setFailMode(
287 SouthboundConstants.OVSDB_FAIL_MODE_MAP.inverse().get(failmodeArray[0]));
291 private static void setOtherConfig(OvsdbBridgeAugmentationBuilder ovsdbBridgeAugmentationBuilder, Bridge bridge) {
292 Map<String, String> otherConfigs = bridge
293 .getOtherConfigColumn().getData();
294 if (otherConfigs != null && !otherConfigs.isEmpty()) {
295 List<BridgeOtherConfigs> otherConfigList = new ArrayList<>();
296 for (Entry<String, String> entry : otherConfigs.entrySet()) {
297 String otherConfigKey = entry.getKey();
298 String otherConfigValue = entry.getValue();
299 if (otherConfigKey != null && otherConfigValue != null) {
300 otherConfigList.add(new BridgeOtherConfigsBuilder()
301 .setBridgeOtherConfigKey(otherConfigKey)
302 .setBridgeOtherConfigValue(otherConfigValue)
306 ovsdbBridgeAugmentationBuilder.setBridgeOtherConfigs(otherConfigList);
310 private static void setExternalIds(OvsdbBridgeAugmentationBuilder ovsdbBridgeAugmentationBuilder, Bridge bridge) {
311 Map<String, String> externalIds = bridge.getExternalIdsColumn()
313 if (externalIds != null && !externalIds.isEmpty()) {
314 List<BridgeExternalIds> externalIdsList = new ArrayList<>();
315 for (Entry<String, String> entry : externalIds.entrySet()) {
316 String externalIdKey = entry.getKey();
317 String externalIdValue = entry.getValue();
318 if (externalIdKey != null && externalIdValue != null) {
319 externalIdsList.add(new BridgeExternalIdsBuilder()
320 .setBridgeExternalIdKey(externalIdKey)
321 .setBridgeExternalIdValue(externalIdValue)
325 ovsdbBridgeAugmentationBuilder.setBridgeExternalIds(externalIdsList);
329 private static void setProtocol(OvsdbBridgeAugmentationBuilder ovsdbBridgeAugmentationBuilder, Bridge bridge) {
330 final List<ProtocolEntry> protocols = SouthboundMapper.createMdsalProtocols(bridge);
331 if (!protocols.isEmpty()) {
332 ovsdbBridgeAugmentationBuilder.setProtocolEntry(protocols);
336 private static void setDataPath(OvsdbBridgeAugmentationBuilder ovsdbBridgeAugmentationBuilder, Bridge bridge) {
337 DatapathId dpid = SouthboundMapper.createDatapathId(bridge);
339 ovsdbBridgeAugmentationBuilder.setDatapathId(dpid);
343 private static void setStpEnalbe(OvsdbBridgeAugmentationBuilder ovsdbBridgeAugmentationBuilder,
345 if (bridge.getStpEnableColumn() != null) {
346 Boolean stpEnable = bridge.getStpEnableColumn().getData();
347 if (stpEnable != null) {
348 ovsdbBridgeAugmentationBuilder.setStpEnable(stpEnable);
353 private void setOpenFlowNodeRef(OvsdbBridgeAugmentationBuilder ovsdbBridgeAugmentationBuilder, Bridge bridge) {
354 Map<UUID, Controller> updatedControllerRows =
355 TyperUtils.extractRowsUpdated(Controller.class, getUpdates(), getDbSchema());
356 LOG.debug("setOpenFlowNodeRef: updatedControllerRows: {}", updatedControllerRows);
357 for (ControllerEntry controllerEntry: SouthboundMapper.createControllerEntries(bridge, updatedControllerRows)) {
358 if (controllerEntry != null
359 && controllerEntry.isIsConnected() != null && controllerEntry.isIsConnected()) {
360 String [] controllerTarget = controllerEntry.getTarget().getValue().split(":");
361 IpAddress bridgeControllerIpAddress = null;
362 for (String targetElement : controllerTarget) {
363 if (InetAddresses.isInetAddress(targetElement)) {
364 bridgeControllerIpAddress = IpAddressBuilder.getDefaultInstance(targetElement);
367 if (NumberUtils.isCreatable(targetElement)) {
372 Enumeration<NetworkInterface> networkInterfaces = NetworkInterface.getNetworkInterfaces();
373 networkInterfacesLoop:
374 while (networkInterfaces.hasMoreElements()) {
375 NetworkInterface networkInterface = networkInterfaces.nextElement();
376 Enumeration<InetAddress> networkInterfaceAddresses = networkInterface.getInetAddresses();
377 while (networkInterfaceAddresses.hasMoreElements()) {
378 InetAddress networkInterfaceAddress = networkInterfaceAddresses.nextElement();
379 if (bridgeControllerIpAddress.getIpv4Address().getValue()
380 .equals(networkInterfaceAddress.getHostAddress())) {
381 ovsdbBridgeAugmentationBuilder.setBridgeOpenflowNodeRef(
382 getOvsdbConnectionInstance().getInstanceIdentifier());
383 break networkInterfacesLoop;
387 } catch (SocketException e) {
388 LOG.warn("Error getting local ip address", e);
394 private InstanceIdentifier<Node> getInstanceIdentifier(Bridge bridge) {
395 return SouthboundMapper.createInstanceIdentifier(instanceIdentifierCodec, getOvsdbConnectionInstance(),
399 private NodeId getNodeId(Bridge bridge) {
400 NodeKey nodeKey = getInstanceIdentifier(bridge).firstKeyOf(Node.class);
401 return nodeKey.getNodeId();
405 public void onSuccess() {
406 for (InstanceIdentifier<Node> updatedBridge : updatedBridges) {
407 LOG.debug("Updated bridge {} in operational datastore", updatedBridge);
412 public void onFailure(Throwable throwable) {
413 for (InstanceIdentifier<Node> updatedBridge : updatedBridges) {
414 LOG.error("Failed to update bridge {} in operational datastore", updatedBridge);