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.annotations.VisibleForTesting;
13 import com.google.common.base.Optional;
14 import com.google.common.base.Preconditions;
15 import com.google.common.net.InetAddresses;
16 import java.net.InetAddress;
17 import java.net.NetworkInterface;
18 import java.net.SocketException;
19 import java.util.ArrayList;
20 import java.util.Enumeration;
21 import java.util.List;
23 import java.util.Map.Entry;
25 import org.apache.commons.lang3.math.NumberUtils;
26 import org.opendaylight.controller.md.sal.binding.api.ReadWriteTransaction;
27 import org.opendaylight.controller.md.sal.common.api.data.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.OvsdbNodeAugmentation;
50 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbNodeAugmentationBuilder;
51 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbNodeRef;
52 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.bridge.attributes.BridgeExternalIds;
53 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.bridge.attributes.BridgeExternalIdsBuilder;
54 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.bridge.attributes.BridgeExternalIdsKey;
55 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.bridge.attributes.BridgeOtherConfigs;
56 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.bridge.attributes.BridgeOtherConfigsBuilder;
57 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.bridge.attributes.BridgeOtherConfigsKey;
58 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.bridge.attributes.ControllerEntry;
59 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.bridge.attributes.ProtocolEntry;
60 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.bridge.attributes.ProtocolEntryKey;
61 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.node.attributes.ManagedNodeEntry;
62 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.node.attributes.ManagedNodeEntryBuilder;
63 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
64 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
65 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeBuilder;
66 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeKey;
67 import org.opendaylight.yangtools.yang.binding.DataObject;
68 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
69 import org.slf4j.Logger;
70 import org.slf4j.LoggerFactory;
72 public class OvsdbBridgeUpdateCommand extends AbstractTransactionCommand {
73 private static final Logger LOG = LoggerFactory.getLogger(OvsdbBridgeUpdateCommand.class);
74 private final InstanceIdentifierCodec instanceIdentifierCodec;
75 private final Map<UUID,Bridge> updatedBridgeRows;
76 private final Map<UUID, Bridge> oldBridgeRows;
77 private final List<InstanceIdentifier<Node>> updatedBridges = new ArrayList<>();
79 public OvsdbBridgeUpdateCommand(InstanceIdentifierCodec instanceIdentifierCodec, OvsdbConnectionInstance key,
80 TableUpdates updates, DatabaseSchema dbSchema) {
81 super(key,updates,dbSchema);
82 this.instanceIdentifierCodec = instanceIdentifierCodec;
83 updatedBridgeRows = TyperUtils.extractRowsUpdated(Bridge.class, getUpdates(), getDbSchema());
84 oldBridgeRows = TyperUtils.extractRowsOld(Bridge.class, getUpdates(), getDbSchema());
88 public void execute(ReadWriteTransaction transaction) {
89 if (updatedBridgeRows == null || updatedBridgeRows.isEmpty()) {
93 final InstanceIdentifier<Node> connectionIId = getOvsdbConnectionInstance().getInstanceIdentifier();
94 Optional<Node> connection = SouthboundUtil.readNode(transaction, connectionIId);
95 if (!connection.isPresent()) {
99 for (Entry<UUID, Bridge> entry : updatedBridgeRows.entrySet()) {
100 updateBridge(transaction, entry.getValue(), connectionIId);
105 void updateBridge(ReadWriteTransaction transaction,
106 Bridge bridge, InstanceIdentifier<Node> connectionIId) {
107 // Update the connection node to let it know it manages this bridge
108 Node connectionNode = buildConnectionNode(bridge);
109 transaction.merge(LogicalDatastoreType.OPERATIONAL, connectionIId, connectionNode);
111 // Update the bridge node with whatever data we are getting
112 InstanceIdentifier<Node> bridgeIid = getInstanceIdentifier(bridge);
113 Node bridgeNode = buildBridgeNode(bridge);
114 transaction.merge(LogicalDatastoreType.OPERATIONAL, bridgeIid, bridgeNode);
115 updatedBridges.add(bridgeIid);
116 deleteEntries(transaction, protocolEntriesToRemove(bridgeIid, bridge));
117 deleteEntries(transaction, externalIdsToRemove(bridgeIid,bridge));
118 deleteEntries(transaction, bridgeOtherConfigsToRemove(bridgeIid,bridge));
122 <T extends DataObject> void deleteEntries(ReadWriteTransaction transaction,
123 List<InstanceIdentifier<T>> entryIids) {
124 for (InstanceIdentifier<T> entryIid : entryIids) {
125 transaction.delete(LogicalDatastoreType.OPERATIONAL, entryIid);
129 private List<InstanceIdentifier<BridgeOtherConfigs>> bridgeOtherConfigsToRemove(
130 InstanceIdentifier<Node> bridgeIid, Bridge bridge) {
131 Preconditions.checkNotNull(bridgeIid);
132 Preconditions.checkNotNull(bridge);
133 List<InstanceIdentifier<BridgeOtherConfigs>> result = new ArrayList<>();
135 Bridge oldBridge = oldBridgeRows.get(bridge.getUuid());
137 if (oldBridge != null && oldBridge.getOtherConfigColumn() != null) {
138 for (Entry<String, String> otherConfig:
139 oldBridge.getOtherConfigColumn().getData().entrySet()) {
140 if (bridge.getOtherConfigColumn() == null
141 || !bridge.getOtherConfigColumn().getData().containsKey(otherConfig.getKey())) {
142 InstanceIdentifier<BridgeOtherConfigs> iid = bridgeIid
143 .augmentation(OvsdbBridgeAugmentation.class)
144 .child(BridgeOtherConfigs.class,
145 new BridgeOtherConfigsKey(otherConfig.getKey()));
153 private List<InstanceIdentifier<BridgeExternalIds>> externalIdsToRemove(
154 InstanceIdentifier<Node> bridgeIid, Bridge bridge) {
155 Preconditions.checkNotNull(bridgeIid);
156 Preconditions.checkNotNull(bridge);
157 List<InstanceIdentifier<BridgeExternalIds>> result = new ArrayList<>();
159 Bridge oldBridge = oldBridgeRows.get(bridge.getUuid());
161 if (oldBridge != null && oldBridge.getExternalIdsColumn() != null) {
162 for (Entry<String, String> externalId:
163 oldBridge.getExternalIdsColumn().getData().entrySet()) {
164 if (bridge.getExternalIdsColumn() == null
165 || !bridge.getExternalIdsColumn().getData().containsKey(externalId.getKey())) {
166 InstanceIdentifier<BridgeExternalIds> iid = bridgeIid
167 .augmentation(OvsdbBridgeAugmentation.class)
168 .child(BridgeExternalIds.class,
169 new BridgeExternalIdsKey(externalId.getKey()));
177 private List<InstanceIdentifier<ProtocolEntry>> protocolEntriesToRemove(
178 InstanceIdentifier<Node> bridgeIid, Bridge bridge) {
179 Preconditions.checkNotNull(bridgeIid);
180 Preconditions.checkNotNull(bridge);
181 List<InstanceIdentifier<ProtocolEntry>> result = new ArrayList<>();
182 Bridge oldBridge = oldBridgeRows.get(bridge.getUuid());
185 if (oldBridge != null && oldBridge.getProtocolsColumn() != null) {
186 for (String protocol : oldBridge.getProtocolsColumn().getData()) {
187 if (bridge.getProtocolsColumn() == null || !bridge.getProtocolsColumn().getData()
188 .contains(protocol)) {
189 Class<? extends OvsdbBridgeProtocolBase> proto = SouthboundConstants.OVSDB_PROTOCOL_MAP
190 .inverse().get(protocol);
191 InstanceIdentifier<ProtocolEntry> iid = bridgeIid
192 .augmentation(OvsdbBridgeAugmentation.class)
193 .child(ProtocolEntry.class,
194 new ProtocolEntryKey(proto));
199 } catch (SchemaVersionMismatchException e) {
200 schemaMismatchLog("protocols", "Bridge", e);
205 private Node buildConnectionNode(
207 //Update node with managed node reference
208 NodeBuilder connectionNode = new NodeBuilder();
209 connectionNode.setNodeId(getOvsdbConnectionInstance().getNodeId());
211 OvsdbNodeAugmentationBuilder ovsdbConnectionAugmentationBuilder = new OvsdbNodeAugmentationBuilder();
212 List<ManagedNodeEntry> managedBridges = new ArrayList<>();
213 InstanceIdentifier<Node> bridgeIid =
214 SouthboundMapper.createInstanceIdentifier(instanceIdentifierCodec, getOvsdbConnectionInstance(),
216 ManagedNodeEntry managedBridge = new ManagedNodeEntryBuilder().setBridgeRef(
217 new OvsdbBridgeRef(bridgeIid)).build();
218 managedBridges.add(managedBridge);
219 ovsdbConnectionAugmentationBuilder.setManagedNodeEntry(managedBridges);
221 connectionNode.addAugmentation(OvsdbNodeAugmentation.class, ovsdbConnectionAugmentationBuilder.build());
223 LOG.debug("Update node with bridge node ref {}",
224 ovsdbConnectionAugmentationBuilder.getManagedNodeEntry().iterator().next());
225 return connectionNode.build();
228 private Node buildBridgeNode(Bridge bridge) {
229 NodeBuilder bridgeNodeBuilder = new NodeBuilder();
230 NodeId bridgeNodeId = getNodeId(bridge);
231 bridgeNodeBuilder.setNodeId(bridgeNodeId);
232 OvsdbBridgeAugmentationBuilder ovsdbBridgeAugmentationBuilder = new OvsdbBridgeAugmentationBuilder();
233 ovsdbBridgeAugmentationBuilder.setBridgeName(new OvsdbBridgeName(bridge.getName()));
234 ovsdbBridgeAugmentationBuilder.setBridgeUuid(new Uuid(bridge.getUuid().toString()));
235 setDataPath(ovsdbBridgeAugmentationBuilder, bridge);
236 setDataPathType(ovsdbBridgeAugmentationBuilder, bridge);
237 setProtocol(ovsdbBridgeAugmentationBuilder, bridge);
238 setExternalIds(ovsdbBridgeAugmentationBuilder, bridge);
239 setOtherConfig(ovsdbBridgeAugmentationBuilder, bridge);
240 setFailMode(ovsdbBridgeAugmentationBuilder, bridge);
241 setOpenFlowNodeRef(ovsdbBridgeAugmentationBuilder, bridge);
242 setManagedBy(ovsdbBridgeAugmentationBuilder);
243 setAutoAttach(ovsdbBridgeAugmentationBuilder, bridge);
244 setStpEnalbe(ovsdbBridgeAugmentationBuilder,bridge);
245 bridgeNodeBuilder.addAugmentation(OvsdbBridgeAugmentation.class, ovsdbBridgeAugmentationBuilder.build());
247 LOG.debug("Built with the intent to store bridge data {}",
248 ovsdbBridgeAugmentationBuilder.build());
249 return bridgeNodeBuilder.build();
252 private static void setAutoAttach(OvsdbBridgeAugmentationBuilder ovsdbBridgeAugmentationBuilder, Bridge bridge) {
254 if (bridge.getAutoAttachColumn() != null
255 && bridge.getAutoAttachColumn().getData() != null
256 && !bridge.getAutoAttachColumn().getData().isEmpty()) {
257 Set<UUID> uuids = bridge.getAutoAttachColumn().getData();
258 for (UUID uuid : uuids) {
259 ovsdbBridgeAugmentationBuilder.setAutoAttach(new Uuid(uuid.toString()));
262 } catch (SchemaVersionMismatchException e) {
263 schemaMismatchLog("auto_attach", "Bridge", e);
267 private void setManagedBy(OvsdbBridgeAugmentationBuilder ovsdbBridgeAugmentationBuilder) {
268 InstanceIdentifier<Node> connectionNodePath = getOvsdbConnectionInstance().getInstanceIdentifier();
269 ovsdbBridgeAugmentationBuilder.setManagedBy(new OvsdbNodeRef(connectionNodePath));
272 private static void setDataPathType(OvsdbBridgeAugmentationBuilder ovsdbBridgeAugmentationBuilder, Bridge bridge) {
273 ovsdbBridgeAugmentationBuilder.setDatapathType(
274 SouthboundMapper.createDatapathType(bridge.getDatapathTypeColumn().getData()));
277 private static void setFailMode(OvsdbBridgeAugmentationBuilder ovsdbBridgeAugmentationBuilder, Bridge bridge) {
278 if (bridge.getFailModeColumn() != null
279 && bridge.getFailModeColumn().getData() != null
280 && !bridge.getFailModeColumn().getData().isEmpty()) {
281 String[] failmodeArray = new String[bridge.getFailModeColumn().getData().size()];
282 bridge.getFailModeColumn().getData().toArray(failmodeArray);
283 ovsdbBridgeAugmentationBuilder.setFailMode(
284 SouthboundConstants.OVSDB_FAIL_MODE_MAP.inverse().get(failmodeArray[0]));
288 private static void setOtherConfig(OvsdbBridgeAugmentationBuilder ovsdbBridgeAugmentationBuilder, Bridge bridge) {
289 Map<String, String> otherConfigs = bridge
290 .getOtherConfigColumn().getData();
291 if (otherConfigs != null && !otherConfigs.isEmpty()) {
292 List<BridgeOtherConfigs> otherConfigList = new ArrayList<>();
293 for (Entry<String, String> entry : otherConfigs.entrySet()) {
294 String otherConfigKey = entry.getKey();
295 String otherConfigValue = entry.getValue();
296 if (otherConfigKey != null && otherConfigValue != null) {
297 otherConfigList.add(new BridgeOtherConfigsBuilder()
298 .setBridgeOtherConfigKey(otherConfigKey)
299 .setBridgeOtherConfigValue(otherConfigValue)
303 ovsdbBridgeAugmentationBuilder.setBridgeOtherConfigs(otherConfigList);
307 private static void setExternalIds(OvsdbBridgeAugmentationBuilder ovsdbBridgeAugmentationBuilder, Bridge bridge) {
308 Map<String, String> externalIds = bridge.getExternalIdsColumn()
310 if (externalIds != null && !externalIds.isEmpty()) {
311 List<BridgeExternalIds> externalIdsList = new ArrayList<>();
312 for (Entry<String, String> entry : externalIds.entrySet()) {
313 String externalIdKey = entry.getKey();
314 String externalIdValue = entry.getValue();
315 if (externalIdKey != null && externalIdValue != null) {
316 externalIdsList.add(new BridgeExternalIdsBuilder()
317 .setBridgeExternalIdKey(externalIdKey)
318 .setBridgeExternalIdValue(externalIdValue)
322 ovsdbBridgeAugmentationBuilder.setBridgeExternalIds(externalIdsList);
326 private static void setProtocol(OvsdbBridgeAugmentationBuilder ovsdbBridgeAugmentationBuilder, Bridge bridge) {
327 final List<ProtocolEntry> protocols = SouthboundMapper.createMdsalProtocols(bridge);
328 if (!protocols.isEmpty()) {
329 ovsdbBridgeAugmentationBuilder.setProtocolEntry(protocols);
333 private static void setDataPath(OvsdbBridgeAugmentationBuilder ovsdbBridgeAugmentationBuilder, Bridge bridge) {
334 DatapathId dpid = SouthboundMapper.createDatapathId(bridge);
336 ovsdbBridgeAugmentationBuilder.setDatapathId(dpid);
340 private static void setStpEnalbe(OvsdbBridgeAugmentationBuilder ovsdbBridgeAugmentationBuilder,
342 if (bridge.getStpEnableColumn() != null) {
343 Boolean stpEnable = bridge.getStpEnableColumn().getData();
344 if (stpEnable != null) {
345 ovsdbBridgeAugmentationBuilder.setStpEnable(stpEnable);
350 private void setOpenFlowNodeRef(OvsdbBridgeAugmentationBuilder ovsdbBridgeAugmentationBuilder, Bridge bridge) {
351 Map<UUID, Controller> updatedControllerRows =
352 TyperUtils.extractRowsUpdated(Controller.class, getUpdates(), getDbSchema());
353 LOG.debug("setOpenFlowNodeRef: updatedControllerRows: {}", updatedControllerRows);
354 for (ControllerEntry controllerEntry: SouthboundMapper.createControllerEntries(bridge, updatedControllerRows)) {
355 if (controllerEntry != null
356 && controllerEntry.isIsConnected() != null && controllerEntry.isIsConnected()) {
357 String [] controllerTarget = controllerEntry.getTarget().getValue().split(":");
358 IpAddress bridgeControllerIpAddress = null;
359 for (String targetElement : controllerTarget) {
360 if (InetAddresses.isInetAddress(targetElement)) {
361 bridgeControllerIpAddress = IpAddressBuilder.getDefaultInstance(targetElement);
364 if (NumberUtils.isCreatable(targetElement)) {
369 Enumeration<NetworkInterface> networkInterfaces = NetworkInterface.getNetworkInterfaces();
370 networkInterfacesLoop:
371 while (networkInterfaces.hasMoreElements()) {
372 NetworkInterface networkInterface = networkInterfaces.nextElement();
373 Enumeration<InetAddress> networkInterfaceAddresses = networkInterface.getInetAddresses();
374 while (networkInterfaceAddresses.hasMoreElements()) {
375 InetAddress networkInterfaceAddress = networkInterfaceAddresses.nextElement();
376 if (bridgeControllerIpAddress.getIpv4Address().getValue()
377 .equals(networkInterfaceAddress.getHostAddress())) {
378 ovsdbBridgeAugmentationBuilder.setBridgeOpenflowNodeRef(
379 getOvsdbConnectionInstance().getInstanceIdentifier());
380 break networkInterfacesLoop;
384 } catch (SocketException e) {
385 LOG.warn("Error getting local ip address", e);
391 private InstanceIdentifier<Node> getInstanceIdentifier(Bridge bridge) {
392 return SouthboundMapper.createInstanceIdentifier(instanceIdentifierCodec, getOvsdbConnectionInstance(),
396 private NodeId getNodeId(Bridge bridge) {
397 NodeKey nodeKey = getInstanceIdentifier(bridge).firstKeyOf(Node.class);
398 return nodeKey.getNodeId();
402 public void onSuccess() {
403 for (InstanceIdentifier<Node> updatedBridge : updatedBridges) {
404 LOG.debug("Updated bridge {} in operational datastore", updatedBridge);
409 public void onFailure(Throwable throwable) {
410 for (InstanceIdentifier<Node> updatedBridge : updatedBridges) {
411 LOG.error("Failed to update bridge {} in operational datastore", updatedBridge);