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 org.opendaylight.ovsdb.southbound.SouthboundUtil.schemaMismatchLog;
12 import com.google.common.base.Optional;
13 import com.google.common.base.Preconditions;
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;
24 import org.apache.commons.lang3.math.NumberUtils;
25 import org.opendaylight.controller.md.sal.binding.api.ReadWriteTransaction;
26 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
27 import org.opendaylight.ovsdb.lib.error.SchemaVersionMismatchException;
28 import org.opendaylight.ovsdb.lib.message.TableUpdates;
29 import org.opendaylight.ovsdb.lib.notation.UUID;
30 import org.opendaylight.ovsdb.lib.schema.DatabaseSchema;
31 import org.opendaylight.ovsdb.lib.schema.typed.TyperUtils;
32 import org.opendaylight.ovsdb.schema.openvswitch.Bridge;
33 import org.opendaylight.ovsdb.schema.openvswitch.Controller;
34 import org.opendaylight.ovsdb.southbound.InstanceIdentifierCodec;
35 import org.opendaylight.ovsdb.southbound.OvsdbConnectionInstance;
36 import org.opendaylight.ovsdb.southbound.SouthboundConstants;
37 import org.opendaylight.ovsdb.southbound.SouthboundMapper;
38 import org.opendaylight.ovsdb.southbound.SouthboundUtil;
39 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
40 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressBuilder;
41 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid;
42 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.DatapathId;
43 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbBridgeAugmentation;
44 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbBridgeAugmentationBuilder;
45 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbBridgeName;
46 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbBridgeProtocolBase;
47 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbBridgeRef;
48 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbNodeAugmentation;
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<>();
78 public OvsdbBridgeUpdateCommand(InstanceIdentifierCodec instanceIdentifierCodec, OvsdbConnectionInstance key,
79 TableUpdates updates, DatabaseSchema dbSchema) {
80 super(key,updates,dbSchema);
81 this.instanceIdentifierCodec = instanceIdentifierCodec;
82 updatedBridgeRows = TyperUtils.extractRowsUpdated(Bridge.class, getUpdates(), getDbSchema());
83 oldBridgeRows = TyperUtils.extractRowsOld(Bridge.class, getUpdates(), getDbSchema());
87 public void execute(ReadWriteTransaction transaction) {
88 if (updatedBridgeRows == null || updatedBridgeRows.isEmpty()) {
92 final InstanceIdentifier<Node> connectionIId = getOvsdbConnectionInstance().getInstanceIdentifier();
93 Optional<Node> connection = SouthboundUtil.readNode(transaction, connectionIId);
94 if (!connection.isPresent()) {
98 for (Entry<UUID, Bridge> entry : updatedBridgeRows.entrySet()) {
99 updateBridge(transaction, entry.getValue(), connectionIId);
103 private void updateBridge(ReadWriteTransaction transaction,
104 Bridge bridge, InstanceIdentifier<Node> connectionIId) {
105 // Update the connection node to let it know it manages this bridge
106 Node connectionNode = buildConnectionNode(bridge);
107 transaction.merge(LogicalDatastoreType.OPERATIONAL, connectionIId, connectionNode);
109 // Update the bridge node with whatever data we are getting
110 InstanceIdentifier<Node> bridgeIid = getInstanceIdentifier(bridge);
111 Node bridgeNode = buildBridgeNode(bridge);
112 transaction.merge(LogicalDatastoreType.OPERATIONAL, bridgeIid, bridgeNode);
113 updatedBridges.add(bridgeIid);
114 deleteEntries(transaction, protocolEntriesToRemove(bridgeIid, bridge));
115 deleteEntries(transaction, externalIdsToRemove(bridgeIid,bridge));
116 deleteEntries(transaction, bridgeOtherConfigsToRemove(bridgeIid,bridge));
119 private static <T extends DataObject> void deleteEntries(ReadWriteTransaction transaction,
120 List<InstanceIdentifier<T>> entryIids) {
121 for (InstanceIdentifier<T> entryIid: entryIids) {
122 transaction.delete(LogicalDatastoreType.OPERATIONAL, entryIid);
126 private List<InstanceIdentifier<BridgeOtherConfigs>> bridgeOtherConfigsToRemove(
127 InstanceIdentifier<Node> bridgeIid, Bridge bridge) {
128 Preconditions.checkNotNull(bridgeIid);
129 Preconditions.checkNotNull(bridge);
130 List<InstanceIdentifier<BridgeOtherConfigs>> result = new ArrayList<>();
132 Bridge oldBridge = oldBridgeRows.get(bridge.getUuid());
134 if (oldBridge != null && oldBridge.getOtherConfigColumn() != null) {
135 for (Entry<String, String> otherConfig:
136 oldBridge.getOtherConfigColumn().getData().entrySet()) {
137 if (bridge.getOtherConfigColumn() == null
138 || !bridge.getOtherConfigColumn().getData().containsKey(otherConfig.getKey())) {
139 InstanceIdentifier<BridgeOtherConfigs> iid = bridgeIid
140 .augmentation(OvsdbBridgeAugmentation.class)
141 .child(BridgeOtherConfigs.class,
142 new BridgeOtherConfigsKey(otherConfig.getKey()));
150 private List<InstanceIdentifier<BridgeExternalIds>> externalIdsToRemove(
151 InstanceIdentifier<Node> bridgeIid, Bridge bridge) {
152 Preconditions.checkNotNull(bridgeIid);
153 Preconditions.checkNotNull(bridge);
154 List<InstanceIdentifier<BridgeExternalIds>> result = new ArrayList<>();
156 Bridge oldBridge = oldBridgeRows.get(bridge.getUuid());
158 if (oldBridge != null && oldBridge.getExternalIdsColumn() != null) {
159 for (Entry<String, String> externalId:
160 oldBridge.getExternalIdsColumn().getData().entrySet()) {
161 if (bridge.getExternalIdsColumn() == null
162 || !bridge.getExternalIdsColumn().getData().containsKey(externalId.getKey())) {
163 InstanceIdentifier<BridgeExternalIds> iid = bridgeIid
164 .augmentation(OvsdbBridgeAugmentation.class)
165 .child(BridgeExternalIds.class,
166 new BridgeExternalIdsKey(externalId.getKey()));
174 private List<InstanceIdentifier<ProtocolEntry>> protocolEntriesToRemove(
175 InstanceIdentifier<Node> bridgeIid, Bridge bridge) {
176 Preconditions.checkNotNull(bridgeIid);
177 Preconditions.checkNotNull(bridge);
178 List<InstanceIdentifier<ProtocolEntry>> result = new ArrayList<>();
179 Bridge oldBridge = oldBridgeRows.get(bridge.getUuid());
182 if (oldBridge != null && oldBridge.getProtocolsColumn() != null) {
183 for (String protocol : oldBridge.getProtocolsColumn().getData()) {
184 if (bridge.getProtocolsColumn() == null || !bridge.getProtocolsColumn().getData()
185 .contains(protocol)) {
186 Class<? extends OvsdbBridgeProtocolBase> proto = SouthboundConstants.OVSDB_PROTOCOL_MAP
187 .inverse().get(protocol);
188 InstanceIdentifier<ProtocolEntry> iid = bridgeIid
189 .augmentation(OvsdbBridgeAugmentation.class)
190 .child(ProtocolEntry.class,
191 new ProtocolEntryKey(proto));
196 } catch (SchemaVersionMismatchException e) {
197 schemaMismatchLog("protocols", "Bridge", e);
202 private Node buildConnectionNode(
204 //Update node with managed node reference
205 NodeBuilder connectionNode = new NodeBuilder();
206 connectionNode.setNodeId(getOvsdbConnectionInstance().getNodeId());
208 OvsdbNodeAugmentationBuilder ovsdbConnectionAugmentationBuilder = new OvsdbNodeAugmentationBuilder();
209 List<ManagedNodeEntry> managedBridges = new ArrayList<>();
210 InstanceIdentifier<Node> bridgeIid =
211 SouthboundMapper.createInstanceIdentifier(instanceIdentifierCodec, getOvsdbConnectionInstance(),
213 ManagedNodeEntry managedBridge = new ManagedNodeEntryBuilder().setBridgeRef(
214 new OvsdbBridgeRef(bridgeIid)).build();
215 managedBridges.add(managedBridge);
216 ovsdbConnectionAugmentationBuilder.setManagedNodeEntry(managedBridges);
218 connectionNode.addAugmentation(OvsdbNodeAugmentation.class, ovsdbConnectionAugmentationBuilder.build());
220 LOG.debug("Update node with bridge node ref {}",
221 ovsdbConnectionAugmentationBuilder.getManagedNodeEntry().iterator().next());
222 return connectionNode.build();
225 private Node buildBridgeNode(Bridge bridge) {
226 NodeBuilder bridgeNodeBuilder = new NodeBuilder();
227 NodeId bridgeNodeId = getNodeId(bridge);
228 bridgeNodeBuilder.setNodeId(bridgeNodeId);
229 OvsdbBridgeAugmentationBuilder ovsdbBridgeAugmentationBuilder = new OvsdbBridgeAugmentationBuilder();
230 ovsdbBridgeAugmentationBuilder.setBridgeName(new OvsdbBridgeName(bridge.getName()));
231 ovsdbBridgeAugmentationBuilder.setBridgeUuid(new Uuid(bridge.getUuid().toString()));
232 setDataPath(ovsdbBridgeAugmentationBuilder, bridge);
233 setDataPathType(ovsdbBridgeAugmentationBuilder, bridge);
234 setProtocol(ovsdbBridgeAugmentationBuilder, bridge);
235 setExternalIds(ovsdbBridgeAugmentationBuilder, bridge);
236 setOtherConfig(ovsdbBridgeAugmentationBuilder, bridge);
237 setFailMode(ovsdbBridgeAugmentationBuilder, bridge);
238 setOpenFlowNodeRef(ovsdbBridgeAugmentationBuilder, bridge);
239 setManagedBy(ovsdbBridgeAugmentationBuilder);
240 setAutoAttach(ovsdbBridgeAugmentationBuilder, bridge);
241 setStpEnalbe(ovsdbBridgeAugmentationBuilder,bridge);
242 bridgeNodeBuilder.addAugmentation(OvsdbBridgeAugmentation.class, ovsdbBridgeAugmentationBuilder.build());
244 LOG.debug("Built with the intent to store bridge data {}",
245 ovsdbBridgeAugmentationBuilder.build());
246 return bridgeNodeBuilder.build();
249 private static void setAutoAttach(OvsdbBridgeAugmentationBuilder ovsdbBridgeAugmentationBuilder, Bridge bridge) {
251 if (bridge.getAutoAttachColumn() != null
252 && bridge.getAutoAttachColumn().getData() != null
253 && !bridge.getAutoAttachColumn().getData().isEmpty()) {
254 Set<UUID> uuids = bridge.getAutoAttachColumn().getData();
255 for (UUID uuid : uuids) {
256 ovsdbBridgeAugmentationBuilder.setAutoAttach(new Uuid(uuid.toString()));
259 } catch (SchemaVersionMismatchException e) {
260 schemaMismatchLog("auto_attach", "Bridge", e);
264 private void setManagedBy(OvsdbBridgeAugmentationBuilder ovsdbBridgeAugmentationBuilder) {
265 InstanceIdentifier<Node> connectionNodePath = getOvsdbConnectionInstance().getInstanceIdentifier();
266 ovsdbBridgeAugmentationBuilder.setManagedBy(new OvsdbNodeRef(connectionNodePath));
269 private static void setDataPathType(OvsdbBridgeAugmentationBuilder ovsdbBridgeAugmentationBuilder, Bridge bridge) {
270 ovsdbBridgeAugmentationBuilder.setDatapathType(
271 SouthboundMapper.createDatapathType(bridge.getDatapathTypeColumn().getData()));
274 private static void setFailMode(OvsdbBridgeAugmentationBuilder ovsdbBridgeAugmentationBuilder, Bridge bridge) {
275 if (bridge.getFailModeColumn() != null
276 && bridge.getFailModeColumn().getData() != null
277 && !bridge.getFailModeColumn().getData().isEmpty()) {
278 String[] failmodeArray = new String[bridge.getFailModeColumn().getData().size()];
279 bridge.getFailModeColumn().getData().toArray(failmodeArray);
280 ovsdbBridgeAugmentationBuilder.setFailMode(
281 SouthboundConstants.OVSDB_FAIL_MODE_MAP.inverse().get(failmodeArray[0]));
285 private static void setOtherConfig(OvsdbBridgeAugmentationBuilder ovsdbBridgeAugmentationBuilder, Bridge bridge) {
286 Map<String, String> otherConfigs = bridge
287 .getOtherConfigColumn().getData();
288 if (otherConfigs != null && !otherConfigs.isEmpty()) {
289 List<BridgeOtherConfigs> otherConfigList = new ArrayList<>();
290 for (Entry<String, String> entry : otherConfigs.entrySet()) {
291 String otherConfigKey = entry.getKey();
292 String otherConfigValue = entry.getValue();
293 if (otherConfigKey != null && otherConfigValue != null) {
294 otherConfigList.add(new BridgeOtherConfigsBuilder()
295 .setBridgeOtherConfigKey(otherConfigKey)
296 .setBridgeOtherConfigValue(otherConfigValue)
300 ovsdbBridgeAugmentationBuilder.setBridgeOtherConfigs(otherConfigList);
304 private static void setExternalIds(OvsdbBridgeAugmentationBuilder ovsdbBridgeAugmentationBuilder, Bridge bridge) {
305 Map<String, String> externalIds = bridge.getExternalIdsColumn()
307 if (externalIds != null && !externalIds.isEmpty()) {
308 List<BridgeExternalIds> externalIdsList = new ArrayList<>();
309 for (Entry<String, String> entry : externalIds.entrySet()) {
310 String externalIdKey = entry.getKey();
311 String externalIdValue = entry.getValue();
312 if (externalIdKey != null && externalIdValue != null) {
313 externalIdsList.add(new BridgeExternalIdsBuilder()
314 .setBridgeExternalIdKey(externalIdKey)
315 .setBridgeExternalIdValue(externalIdValue)
319 ovsdbBridgeAugmentationBuilder.setBridgeExternalIds(externalIdsList);
323 private static void setProtocol(OvsdbBridgeAugmentationBuilder ovsdbBridgeAugmentationBuilder, Bridge bridge) {
324 final List<ProtocolEntry> protocols = SouthboundMapper.createMdsalProtocols(bridge);
325 if (!protocols.isEmpty()) {
326 ovsdbBridgeAugmentationBuilder.setProtocolEntry(protocols);
330 private static void setDataPath(OvsdbBridgeAugmentationBuilder ovsdbBridgeAugmentationBuilder, Bridge bridge) {
331 DatapathId dpid = SouthboundMapper.createDatapathId(bridge);
333 ovsdbBridgeAugmentationBuilder.setDatapathId(dpid);
337 private static void setStpEnalbe(OvsdbBridgeAugmentationBuilder ovsdbBridgeAugmentationBuilder,
339 if (bridge.getStpEnableColumn() != null) {
340 Boolean stpEnable = bridge.getStpEnableColumn().getData();
341 if (stpEnable != null) {
342 ovsdbBridgeAugmentationBuilder.setStpEnable(stpEnable);
347 private void setOpenFlowNodeRef(OvsdbBridgeAugmentationBuilder ovsdbBridgeAugmentationBuilder, Bridge bridge) {
348 Map<UUID, Controller> updatedControllerRows =
349 TyperUtils.extractRowsUpdated(Controller.class, getUpdates(), getDbSchema());
350 LOG.debug("setOpenFlowNodeRef: updatedControllerRows: {}", updatedControllerRows);
351 for (ControllerEntry controllerEntry: SouthboundMapper.createControllerEntries(bridge, updatedControllerRows)) {
352 if (controllerEntry != null
353 && controllerEntry.isIsConnected() != null && controllerEntry.isIsConnected()) {
354 String [] controllerTarget = controllerEntry.getTarget().getValue().split(":");
355 IpAddress bridgeControllerIpAddress = null;
356 for (String targetElement : controllerTarget) {
357 if (InetAddresses.isInetAddress(targetElement)) {
358 bridgeControllerIpAddress = IpAddressBuilder.getDefaultInstance(targetElement);
361 if (NumberUtils.isCreatable(targetElement)) {
366 Enumeration<NetworkInterface> networkInterfaces = NetworkInterface.getNetworkInterfaces();
367 networkInterfacesLoop:
368 while (networkInterfaces.hasMoreElements()) {
369 NetworkInterface networkInterface = networkInterfaces.nextElement();
370 Enumeration<InetAddress> networkInterfaceAddresses = networkInterface.getInetAddresses();
371 while (networkInterfaceAddresses.hasMoreElements()) {
372 InetAddress networkInterfaceAddress = networkInterfaceAddresses.nextElement();
373 if (bridgeControllerIpAddress.getIpv4Address().getValue()
374 .equals(networkInterfaceAddress.getHostAddress())) {
375 ovsdbBridgeAugmentationBuilder.setBridgeOpenflowNodeRef(
376 getOvsdbConnectionInstance().getInstanceIdentifier());
377 break networkInterfacesLoop;
381 } catch (SocketException e) {
382 LOG.warn("Error getting local ip address", e);
388 private InstanceIdentifier<Node> getInstanceIdentifier(Bridge bridge) {
389 return SouthboundMapper.createInstanceIdentifier(instanceIdentifierCodec, getOvsdbConnectionInstance(),
393 private NodeId getNodeId(Bridge bridge) {
394 NodeKey nodeKey = getInstanceIdentifier(bridge).firstKeyOf(Node.class);
395 return nodeKey.getNodeId();
399 public void onSuccess() {
400 for (InstanceIdentifier<Node> updatedBridge : updatedBridges) {
401 LOG.debug("Updated bridge {} in operational datastore", updatedBridge);
406 public void onFailure(Throwable throwable) {
407 for (InstanceIdentifier<Node> updatedBridge : updatedBridges) {
408 LOG.error("Failed to update bridge {} in operational datastore", updatedBridge);