southbound/southbound-impl/src/main/java/org/opendaylight/ovsdb/southbound/ovsdb/transact/AutoAttachUpdateCommand.java

   1 /*
   2  * Copyright (c) 2016 Inocybe Technologies 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
   9 package org.opendaylight.ovsdb.southbound.ovsdb.transact;
  10
  11 import static org.opendaylight.ovsdb.lib.operations.Operations.op;
  12
  13 import com.google.common.base.Optional;
  14 import com.google.common.collect.Sets;
  15 import java.util.Collection;
  16 import java.util.HashMap;
  17 import java.util.List;
  18 import java.util.Map;
  19 import java.util.Map.Entry;
  20 import java.util.concurrent.ExecutionException;
  21 import org.opendaylight.controller.md.sal.binding.api.DataTreeModification;
  22 import org.opendaylight.controller.md.sal.binding.api.ReadOnlyTransaction;
  23 import org.opendaylight.controller.md.sal.common.api.data.AsyncDataChangeEvent;
  24 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  25 import org.opendaylight.ovsdb.lib.notation.Mutator;
  26 import org.opendaylight.ovsdb.lib.notation.UUID;
  27 import org.opendaylight.ovsdb.lib.operations.TransactionBuilder;
  28 import org.opendaylight.ovsdb.lib.schema.typed.TyperUtils;
  29 import org.opendaylight.ovsdb.schema.openvswitch.AutoAttach;
  30 import org.opendaylight.ovsdb.schema.openvswitch.Bridge;
  31 import org.opendaylight.ovsdb.southbound.InstanceIdentifierCodec;
  32 import org.opendaylight.ovsdb.southbound.SouthboundConstants;
  33 import org.opendaylight.ovsdb.southbound.SouthboundMapper;
  34 import org.opendaylight.ovsdb.southbound.SouthboundProvider;
  35 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri;
  36 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbBridgeAugmentation;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbNodeAugmentation;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.node.attributes.Autoattach;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.node.attributes.autoattach.AutoattachExternalIds;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.node.attributes.autoattach.Mappings;
  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.DataObject;
  49 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  50 import org.slf4j.Logger;
  51 import org.slf4j.LoggerFactory;
  52
  53 public class AutoAttachUpdateCommand implements TransactCommand {
  54     private static final Logger LOG = LoggerFactory.getLogger(AutoAttachUpdateCommand.class);
  55
  56     @Override
  57     public void execute(TransactionBuilder transaction, BridgeOperationalState state,
  58             AsyncDataChangeEvent<InstanceIdentifier<?>, DataObject> events,
  59             InstanceIdentifierCodec instanceIdentifierCodec) {
  60         execute(transaction, state, TransactUtils.extractCreatedOrUpdated(events, OvsdbNodeAugmentation.class));
  61     }
  62
  63     @Override
  64     public void execute(TransactionBuilder transaction, BridgeOperationalState state,
  65             Collection<DataTreeModification<Node>> modifications, InstanceIdentifierCodec instanceIdentifierCodec) {
  66         execute(transaction, state, TransactUtils.extractCreatedOrUpdated(modifications, OvsdbNodeAugmentation.class));
  67     }
  68
  69     private void execute(TransactionBuilder transaction, BridgeOperationalState state,
  70                          Map<InstanceIdentifier<OvsdbNodeAugmentation>, OvsdbNodeAugmentation> createdOrUpdated) {
  71
  72         for (final Entry<InstanceIdentifier<OvsdbNodeAugmentation>, OvsdbNodeAugmentation> ovsdbNodeEntry
  73                 : createdOrUpdated.entrySet()) {
  74             updateAutoAttach(transaction, state, ovsdbNodeEntry.getKey(), ovsdbNodeEntry.getValue());
  75         }
  76     }
  77
  78     private void updateAutoAttach(TransactionBuilder transaction, BridgeOperationalState state,
  79             InstanceIdentifier<OvsdbNodeAugmentation> iid,
  80             OvsdbNodeAugmentation ovsdbNode) {
  81
  82         if (!state.getBridgeNode(iid).isPresent()) {
  83             return;
  84         }
  85         final List<Autoattach> autoAttachList = ovsdbNode.getAutoattach();
  86         if (autoAttachList != null) {
  87             if (true) {
  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.");
  91                 return;
  92             }
  93
  94             final OvsdbNodeAugmentation currentOvsdbNode =
  95                     state.getBridgeNode(iid).get().getAugmentation(OvsdbNodeAugmentation.class);
  96             final List<Autoattach> currentAutoAttach = currentOvsdbNode.getAutoattach();
  97             for (final Autoattach autoAttach : autoAttachList) {
  98                 final AutoAttach autoAttachWrapper =
  99                         TyperUtils.getTypedRowWrapper(transaction.getDatabaseSchema(), AutoAttach.class);
 100                 if (autoAttach.getSystemName() != null) {
 101                     autoAttachWrapper.setSystemName(autoAttach.getSystemName());
 102                 }
 103                 if (autoAttach.getSystemDescription() != null) {
 104                     autoAttachWrapper.setSystemDescription(autoAttach.getSystemDescription());
 105                 }
 106
 107                 final List<Mappings> mappingsList = autoAttach.getMappings();
 108                 if (mappingsList != null && !mappingsList.isEmpty()) {
 109                     final Map<Long, Long> newMappings = new HashMap<>();
 110                     for (final Mappings mappings : mappingsList) {
 111                         final Long mappingsValue = new Long(mappings.getMappingsValue().toString());
 112                         newMappings.put(mappings.getMappingsKey(), mappingsValue);
 113                     }
 114                     autoAttachWrapper.setMappings(newMappings);
 115                 }
 116
 117                 final List<AutoattachExternalIds> externalIds = autoAttach.getAutoattachExternalIds();
 118                 final Map<String, String> externalIdsMap = new HashMap<>();
 119                 if (externalIds != null) {
 120                     for (final AutoattachExternalIds externalId : externalIds) {
 121                         externalIdsMap.put(externalId.getAutoattachExternalIdKey(),
 122                                 externalId.getAutoattachExternalIdValue());
 123                     }
 124                 }
 125                 externalIdsMap.put(SouthboundConstants.AUTOATTACH_ID_EXTERNAL_ID_KEY,
 126                         autoAttach.getAutoattachId().getValue());
 127                 // FIXME: To be uncommented when Open vSwitch supports external_ids column
 128 //                try {
 129 //                    autoAttachWrapper.setExternalIds(ImmutableMap.copyOf(externalIdsMap));
 130 //                } catch (NullPointerException e) {
 131 //                    LOG.warn("Incomplete AutoAttach external IDs");
 132 //                }
 133
 134                 final Uuid aaUuid = getAutoAttachUuid(currentAutoAttach, autoAttach.getAutoattachId());
 135                 if (aaUuid != null) {
 136                     final UUID uuid = new UUID(aaUuid.getValue());
 137                     final AutoAttach newAutoAttach = TyperUtils.getTypedRowWrapper(
 138                             transaction.getDatabaseSchema(), AutoAttach.class, null);
 139                     newAutoAttach.getUuidColumn().setData(uuid);
 140                     LOG.trace("Updating autoattach table entries {}", uuid);
 141                     transaction.add(op.update(autoAttachWrapper)
 142                             .where(newAutoAttach.getUuidColumn().getSchema().opEqual(uuid)).build());
 143                     transaction.add(op.comment("Updating AutoAttach table: " + uuid));
 144                 } else {
 145                     final Uri bridgeUri = autoAttach.getBridgeId();
 146                     final String namedUuid = SouthboundMapper.getRandomUuid();
 147                     final Bridge bridge = TyperUtils.getTypedRowWrapper(transaction.getDatabaseSchema(), Bridge.class);
 148                     transaction.add(op.insert(autoAttachWrapper).withId(namedUuid));
 149                     final OvsdbBridgeAugmentation ovsdbBridgeAugmentation = getBridge(iid, bridgeUri);
 150                     if (ovsdbBridgeAugmentation != null) {
 151                         bridge.setName(ovsdbBridgeAugmentation.getBridgeName().getValue());
 152                         bridge.setAutoAttach(Sets.newHashSet(new UUID(namedUuid)));
 153                         LOG.trace("Create Autoattach table {}, and mutate the bridge {}",
 154                                 autoAttach.getAutoattachId(), getBridge(iid, bridgeUri).getBridgeName().getValue());
 155                         transaction.add(op.mutate(bridge)
 156                                 .addMutation(bridge.getAutoAttachColumn().getSchema(),
 157                                         Mutator.INSERT,bridge.getAutoAttachColumn().getData())
 158                                 .where(bridge.getNameColumn().getSchema()
 159                                         .opEqual(bridge.getNameColumn().getData())).build());
 160                         transaction.add(
 161                                 op.comment("Bridge: Mutating " + ovsdbBridgeAugmentation.getBridgeName().getValue()
 162                                 + " to add autoattach column " + namedUuid));
 163                     }
 164                 }
 165             }
 166         }
 167     }
 168
 169     private OvsdbBridgeAugmentation getBridge(InstanceIdentifier<OvsdbNodeAugmentation> key,
 170             Uri bridgeUri) {
 171         final InstanceIdentifier<OvsdbBridgeAugmentation> bridgeIid = InstanceIdentifier
 172                 .create(NetworkTopology.class)
 173                 .child(Topology.class, new TopologyKey(SouthboundConstants.OVSDB_TOPOLOGY_ID))
 174                 .child(Node.class, new NodeKey(new NodeId(bridgeUri)))
 175                 .augmentation(OvsdbBridgeAugmentation.class);
 176
 177         OvsdbBridgeAugmentation bridge = null;
 178         try (ReadOnlyTransaction transaction = SouthboundProvider.getDb().newReadOnlyTransaction()) {
 179             final Optional<OvsdbBridgeAugmentation> bridgeOptional =
 180                     transaction.read(LogicalDatastoreType.OPERATIONAL, bridgeIid).get();
 181             if (bridgeOptional.isPresent()) {
 182                 bridge = bridgeOptional.get();
 183             }
 184         } catch (InterruptedException | ExecutionException e) {
 185             LOG.warn("Error reading from datastore", e);
 186         }
 187         return bridge;
 188     }
 189
 190     private Uuid getAutoAttachUuid(List<Autoattach> currentAutoAttach, Uri autoattachId) {
 191         if (currentAutoAttach != null && !currentAutoAttach.isEmpty()) {
 192             for (final Autoattach autoAttach : currentAutoAttach) {
 193                 if (autoAttach.getAutoattachId().equals(autoattachId)) {
 194                     return autoAttach.getAutoattachUuid();
 195                 }
 196             }
 197         }
 198         return null;
 199     }
 200 }