2 * Copyright © 2016, 2017 Inocybe Technologies 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.ovsdb.transact;
10 import static org.opendaylight.ovsdb.lib.operations.Operations.op;
12 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
13 import java.util.Collection;
14 import java.util.Collections;
15 import java.util.HashMap;
17 import java.util.Map.Entry;
18 import java.util.Optional;
19 import java.util.concurrent.ExecutionException;
20 import org.opendaylight.mdsal.binding.api.DataTreeModification;
21 import org.opendaylight.mdsal.binding.api.ReadTransaction;
22 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
23 import org.opendaylight.ovsdb.lib.notation.Mutator;
24 import org.opendaylight.ovsdb.lib.notation.UUID;
25 import org.opendaylight.ovsdb.lib.operations.TransactionBuilder;
26 import org.opendaylight.ovsdb.schema.openvswitch.AutoAttach;
27 import org.opendaylight.ovsdb.schema.openvswitch.Bridge;
28 import org.opendaylight.ovsdb.southbound.InstanceIdentifierCodec;
29 import org.opendaylight.ovsdb.southbound.SouthboundConstants;
30 import org.opendaylight.ovsdb.southbound.SouthboundMapper;
31 import org.opendaylight.ovsdb.southbound.SouthboundProvider;
32 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri;
33 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid;
34 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbBridgeAugmentation;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbNodeAugmentation;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.node.attributes.Autoattach;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.node.attributes.AutoattachKey;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.node.attributes.autoattach.AutoattachExternalIds;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.node.attributes.autoattach.AutoattachExternalIdsKey;
40 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.node.attributes.autoattach.Mappings;
41 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.node.attributes.autoattach.MappingsKey;
42 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NetworkTopology;
43 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
44 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.Topology;
45 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.TopologyKey;
46 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
47 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeKey;
48 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
49 import org.slf4j.Logger;
50 import org.slf4j.LoggerFactory;
52 @SuppressFBWarnings("UPM_UNCALLED_PRIVATE_METHOD")
53 public class AutoAttachUpdateCommand implements TransactCommand {
54 private static final Logger LOG = LoggerFactory.getLogger(AutoAttachUpdateCommand.class);
57 public void execute(final TransactionBuilder transaction, final BridgeOperationalState state,
58 final DataChangeEvent events, final InstanceIdentifierCodec instanceIdentifierCodec) {
59 execute(transaction, state, TransactUtils.extractCreatedOrUpdated(events, OvsdbNodeAugmentation.class));
63 public void execute(final TransactionBuilder transaction, final BridgeOperationalState state,
64 final Collection<DataTreeModification<Node>> modifications,
65 final InstanceIdentifierCodec instanceIdentifierCodec) {
66 execute(transaction, state, TransactUtils.extractCreatedOrUpdated(modifications, OvsdbNodeAugmentation.class));
69 private void execute(final TransactionBuilder transaction, final BridgeOperationalState state,
70 final Map<InstanceIdentifier<OvsdbNodeAugmentation>, OvsdbNodeAugmentation> createdOrUpdated) {
72 for (final Entry<InstanceIdentifier<OvsdbNodeAugmentation>, OvsdbNodeAugmentation> ovsdbNodeEntry
73 : createdOrUpdated.entrySet()) {
74 updateAutoAttach(transaction, state, ovsdbNodeEntry.getKey(), ovsdbNodeEntry.getValue());
78 private static void updateAutoAttach(final TransactionBuilder transaction, final BridgeOperationalState state,
79 final InstanceIdentifier<OvsdbNodeAugmentation> iid,
80 final OvsdbNodeAugmentation ovsdbNode) {
82 if (!state.getBridgeNode(iid).isPresent()) {
85 final Map<AutoattachKey, Autoattach> autoAttachList = ovsdbNode.getAutoattach();
86 if (autoAttachList != null) {
88 // FIXME: Remove if loop after ovs community supports external_ids column in AutoAttach Table
89 LOG.info("UNSUPPORTED FUNCTIONALITY: Auto Attach related CRUD operations are not supported for"
90 + " this version of OVSDB schema due to missing external_ids column.");
94 final OvsdbNodeAugmentation currentOvsdbNode =
95 state.getBridgeNode(iid).get().augmentation(OvsdbNodeAugmentation.class);
96 final Map<AutoattachKey, Autoattach> currentAutoAttach = currentOvsdbNode.getAutoattach();
97 for (final Autoattach autoAttach : autoAttachList.values()) {
98 final AutoAttach autoAttachWrapper = transaction.getTypedRowWrapper(AutoAttach.class);
99 if (autoAttach.getSystemName() != null) {
100 autoAttachWrapper.setSystemName(autoAttach.getSystemName());
102 if (autoAttach.getSystemDescription() != null) {
103 autoAttachWrapper.setSystemDescription(autoAttach.getSystemDescription());
106 final Map<MappingsKey, Mappings> mappingsList = autoAttach.getMappings();
107 if (mappingsList != null && !mappingsList.isEmpty()) {
108 final Map<Long, Long> newMappings = new HashMap<>();
109 for (final Mappings mappings : mappingsList.values()) {
110 newMappings.put(mappings.getMappingsKey().toJava(), mappings.getMappingsValue().longValue());
112 autoAttachWrapper.setMappings(newMappings);
115 final Map<AutoattachExternalIdsKey, AutoattachExternalIds> externalIds =
116 autoAttach.getAutoattachExternalIds();
117 final Map<String, String> externalIdsMap = new HashMap<>();
118 if (externalIds != null) {
119 for (final AutoattachExternalIds externalId : externalIds.values()) {
120 externalIdsMap.put(externalId.getAutoattachExternalIdKey(),
121 externalId.getAutoattachExternalIdValue());
124 externalIdsMap.put(SouthboundConstants.AUTOATTACH_ID_EXTERNAL_ID_KEY,
125 autoAttach.getAutoattachId().getValue());
126 // FIXME: To be uncommented when Open vSwitch supports external_ids column
128 // autoAttachWrapper.setExternalIds(ImmutableMap.copyOf(externalIdsMap));
129 // } catch (NullPointerException e) {
130 // LOG.warn("Incomplete AutoAttach external IDs");
133 final Uuid aaUuid = getAutoAttachUuid(currentAutoAttach, autoAttach.key());
134 if (aaUuid != null) {
135 final UUID uuid = new UUID(aaUuid.getValue());
136 final AutoAttach newAutoAttach = transaction.getTypedRowSchema(AutoAttach.class);
137 newAutoAttach.getUuidColumn().setData(uuid);
138 LOG.trace("Updating autoattach table entries {}", uuid);
139 transaction.add(op.update(autoAttachWrapper)
140 .where(newAutoAttach.getUuidColumn().getSchema().opEqual(uuid)).build());
141 transaction.add(op.comment("Updating AutoAttach table: " + uuid));
143 final Uri bridgeUri = autoAttach.getBridgeId();
144 final String namedUuid = SouthboundMapper.getRandomUuid();
145 final Bridge bridge = transaction.getTypedRowWrapper(Bridge.class);
146 transaction.add(op.insert(autoAttachWrapper).withId(namedUuid));
147 final OvsdbBridgeAugmentation ovsdbBridgeAugmentation = getBridge(iid, bridgeUri);
148 if (ovsdbBridgeAugmentation != null) {
149 bridge.setName(ovsdbBridgeAugmentation.getBridgeName().getValue());
150 bridge.setAutoAttach(Collections.singleton(new UUID(namedUuid)));
151 LOG.trace("Create Autoattach table {}, and mutate the bridge {}",
152 autoAttach.getAutoattachId(), getBridge(iid, bridgeUri).getBridgeName().getValue());
153 transaction.add(op.mutate(bridge)
154 .addMutation(bridge.getAutoAttachColumn().getSchema(),
155 Mutator.INSERT,bridge.getAutoAttachColumn().getData())
156 .where(bridge.getNameColumn().getSchema()
157 .opEqual(bridge.getNameColumn().getData())).build());
159 op.comment("Bridge: Mutating " + ovsdbBridgeAugmentation.getBridgeName().getValue()
160 + " to add autoattach column " + namedUuid));
167 private static OvsdbBridgeAugmentation getBridge(final InstanceIdentifier<OvsdbNodeAugmentation> key,
168 final Uri bridgeUri) {
169 final InstanceIdentifier<OvsdbBridgeAugmentation> bridgeIid = InstanceIdentifier
170 .create(NetworkTopology.class)
171 .child(Topology.class, new TopologyKey(SouthboundConstants.OVSDB_TOPOLOGY_ID))
172 .child(Node.class, new NodeKey(new NodeId(bridgeUri)))
173 .augmentation(OvsdbBridgeAugmentation.class);
175 OvsdbBridgeAugmentation bridge = null;
176 try (ReadTransaction transaction = SouthboundProvider.getDb().newReadOnlyTransaction()) {
177 final Optional<OvsdbBridgeAugmentation> bridgeOptional =
178 transaction.read(LogicalDatastoreType.OPERATIONAL, bridgeIid).get();
179 if (bridgeOptional.isPresent()) {
180 bridge = bridgeOptional.get();
182 } catch (InterruptedException | ExecutionException e) {
183 LOG.warn("Error reading from datastore", e);
188 private static Uuid getAutoAttachUuid(final Map<AutoattachKey, Autoattach> currentAutoAttach,
189 final AutoattachKey autoattachId) {
190 if (currentAutoAttach != null) {
191 final Autoattach found = currentAutoAttach.get(autoattachId);
193 return found.getAutoattachUuid();