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

   1 /*
   2  * Copyright © 2015, 2017 Cisco Systems, Inc. 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 package org.opendaylight.ovsdb.southbound.ovsdb.transact;
   9
  10 import static org.opendaylight.ovsdb.lib.operations.Operations.op;
  11
  12 import com.google.common.base.Optional;
  13 import java.util.Collection;
  14 import java.util.Collections;
  15 import java.util.HashMap;
  16 import java.util.Map;
  17 import java.util.Map.Entry;
  18 import javax.annotation.Nonnull;
  19 import org.opendaylight.controller.md.sal.binding.api.DataTreeModification;
  20 import org.opendaylight.controller.md.sal.common.api.data.AsyncDataChangeEvent;
  21 import org.opendaylight.ovsdb.lib.notation.UUID;
  22 import org.opendaylight.ovsdb.lib.operations.Insert;
  23 import org.opendaylight.ovsdb.lib.operations.Mutate;
  24 import org.opendaylight.ovsdb.lib.operations.TransactionBuilder;
  25 import org.opendaylight.ovsdb.lib.schema.GenericTableSchema;
  26 import org.opendaylight.ovsdb.lib.schema.typed.TyperUtils;
  27 import org.opendaylight.ovsdb.schema.openvswitch.Bridge;
  28 import org.opendaylight.ovsdb.schema.openvswitch.Interface;
  29 import org.opendaylight.ovsdb.schema.openvswitch.Port;
  30 import org.opendaylight.ovsdb.southbound.InstanceIdentifierCodec;
  31 import org.opendaylight.ovsdb.southbound.SouthboundConstants;
  32 import org.opendaylight.ovsdb.southbound.SouthboundMapper;
  33 import org.opendaylight.ovsdb.utils.yang.YangUtils;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.InterfaceTypeInternal;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbBridgeAugmentation;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.bridge.attributes.BridgeExternalIds;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.bridge.attributes.BridgeOtherConfigs;
  38 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
  39 import org.opendaylight.yangtools.yang.binding.DataObject;
  40 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  41 import org.slf4j.Logger;
  42 import org.slf4j.LoggerFactory;
  43
  44 public class BridgeUpdateCommand implements TransactCommand {
  45
  46     private static final Logger LOG = LoggerFactory.getLogger(BridgeUpdateCommand.class);
  47
  48     @Override
  49     public void execute(TransactionBuilder transaction, BridgeOperationalState state,
  50             AsyncDataChangeEvent<InstanceIdentifier<?>, DataObject> events,
  51             InstanceIdentifierCodec instanceIdentifierCodec) {
  52         execute(transaction, state, TransactUtils.extractCreatedOrUpdated(events, OvsdbBridgeAugmentation.class),
  53                 instanceIdentifierCodec);
  54     }
  55
  56     @Override
  57     public void execute(TransactionBuilder transaction, BridgeOperationalState state,
  58             Collection<DataTreeModification<Node>> modifications, InstanceIdentifierCodec instanceIdentifierCodec) {
  59         execute(transaction, state,
  60                 TransactUtils.extractCreatedOrUpdated(modifications, OvsdbBridgeAugmentation.class),
  61                 instanceIdentifierCodec);
  62     }
  63
  64     private void execute(TransactionBuilder transaction, BridgeOperationalState state,
  65             Map<InstanceIdentifier<OvsdbBridgeAugmentation>, OvsdbBridgeAugmentation> createdOrUpdated,
  66             InstanceIdentifierCodec instanceIdentifierCodec) {
  67         for (Entry<InstanceIdentifier<OvsdbBridgeAugmentation>, OvsdbBridgeAugmentation> ovsdbManagedNodeEntry :
  68                 createdOrUpdated.entrySet()) {
  69             updateBridge(transaction, state, ovsdbManagedNodeEntry.getKey(), ovsdbManagedNodeEntry.getValue(),
  70                     instanceIdentifierCodec);
  71         }
  72     }
  73
  74     private void updateBridge(TransactionBuilder transaction, BridgeOperationalState state,
  75             InstanceIdentifier<OvsdbBridgeAugmentation> iid, OvsdbBridgeAugmentation ovsdbManagedNode,
  76             InstanceIdentifierCodec instanceIdentifierCodec) {
  77         LOG.debug("Received request to create ovsdb bridge name: {} uuid: {}",
  78                 ovsdbManagedNode.getBridgeName(),
  79                 ovsdbManagedNode.getBridgeUuid());
  80         Bridge bridge = TyperUtils.getTypedRowWrapper(transaction.getDatabaseSchema(), Bridge.class);
  81         setFailMode(bridge, ovsdbManagedNode);
  82         setDataPathType(bridge, ovsdbManagedNode);
  83         setStpEnalbe(bridge, ovsdbManagedNode);
  84         setOpenDaylightExternalIds(bridge, iid, ovsdbManagedNode, instanceIdentifierCodec);
  85         setOpenDaylightOtherConfig(bridge, ovsdbManagedNode);
  86         Optional<OvsdbBridgeAugmentation> operationalBridgeOptional =
  87                 state.getOvsdbBridgeAugmentation(iid);
  88         if (!operationalBridgeOptional.isPresent()) {
  89             setName(bridge, ovsdbManagedNode,operationalBridgeOptional);
  90             setPort(transaction, bridge, ovsdbManagedNode);
  91             transaction.add(op.insert(bridge));
  92             LOG.info("Added ovsdb Bridge name: {} uuid: {}",
  93                     ovsdbManagedNode.getBridgeName(),
  94                     ovsdbManagedNode.getBridgeUuid());
  95         } else {
  96             String existingBridgeName = operationalBridgeOptional.get().getBridgeName().getValue();
  97             // Name is immutable, and so we *can't* update it.  So we use extraBridge for the schema stuff
  98             Bridge extraBridge = TyperUtils.getTypedRowWrapper(transaction.getDatabaseSchema(), Bridge.class);
  99             extraBridge.setName("");
 100             transaction.add(op.update(bridge)
 101                     .where(extraBridge.getNameColumn().getSchema().opEqual(existingBridgeName))
 102                     .build());
 103             stampInstanceIdentifier(transaction, iid.firstIdentifierOf(Node.class), existingBridgeName,
 104                     instanceIdentifierCodec);
 105         }
 106     }
 107
 108     private void setDataPathType(Bridge bridge,OvsdbBridgeAugmentation ovsdbManagedNode) {
 109         if (ovsdbManagedNode.getDatapathType() != null) {
 110             bridge.setDatapathType(SouthboundMapper.createDatapathType(ovsdbManagedNode));
 111         }
 112     }
 113
 114     private void setStpEnalbe(Bridge bridge, OvsdbBridgeAugmentation ovsdbManageNode) {
 115         if (ovsdbManageNode.isStpEnable() != null) {
 116             bridge.setStpEnable(ovsdbManageNode.isStpEnable());
 117         }
 118     }
 119
 120     private void setName(Bridge bridge, OvsdbBridgeAugmentation ovsdbManagedNode,
 121             Optional<OvsdbBridgeAugmentation> operationalBridgeOptional) {
 122         if (ovsdbManagedNode.getBridgeName() != null) {
 123             bridge.setName(ovsdbManagedNode.getBridgeName().getValue());
 124         } else if (operationalBridgeOptional.isPresent() && operationalBridgeOptional.get().getBridgeName() != null) {
 125             bridge.setName(operationalBridgeOptional.get().getBridgeName().getValue());
 126         }
 127     }
 128
 129     private void setOpenDaylightExternalIds(Bridge bridge, InstanceIdentifier<OvsdbBridgeAugmentation> iid,
 130             OvsdbBridgeAugmentation ovsdbManagedNode, InstanceIdentifierCodec instanceIdentifierCodec) {
 131         // Set the iid external_id
 132         Map<String, String> externalIdMap = new HashMap<>();
 133         externalIdMap.put(SouthboundConstants.IID_EXTERNAL_ID_KEY, instanceIdentifierCodec.serialize(iid));
 134         // Set user provided external ids
 135         try {
 136             YangUtils.copyYangKeyValueListToMap(externalIdMap, ovsdbManagedNode.getBridgeExternalIds(),
 137                     BridgeExternalIds::getBridgeExternalIdKey, BridgeExternalIds::getBridgeExternalIdValue);
 138         } catch (NullPointerException e) {
 139             LOG.warn("Incomplete bridge external Id", e);
 140         }
 141         bridge.setExternalIds(externalIdMap);
 142     }
 143
 144     private void setOpenDaylightOtherConfig(@Nonnull Bridge bridge, @Nonnull OvsdbBridgeAugmentation ovsdbManagedNode) {
 145         try {
 146             bridge.setOtherConfig(YangUtils.convertYangKeyValueListToMap(ovsdbManagedNode.getBridgeOtherConfigs(),
 147                     BridgeOtherConfigs::getBridgeOtherConfigKey, BridgeOtherConfigs::getBridgeOtherConfigValue));
 148         } catch (NullPointerException e) {
 149             LOG.warn("Incomplete bridge other config", e);
 150         }
 151     }
 152
 153     private void setPort(TransactionBuilder transaction, Bridge bridge,
 154             OvsdbBridgeAugmentation ovsdbManagedNode) {
 155
 156         Insert<GenericTableSchema> interfaceInsert = setInterface(transaction,ovsdbManagedNode);
 157         // Port part
 158         String portNamedUuid = "Port_" + SouthboundMapper.getRandomUuid();
 159         Port port = TyperUtils.getTypedRowWrapper(transaction.getDatabaseSchema(), Port.class);
 160         port.setName(ovsdbManagedNode.getBridgeName().getValue());
 161         port.setInterfaces(Collections.singleton(TransactUtils.extractNamedUuid(interfaceInsert)));
 162         transaction.add(op.insert(port).withId(portNamedUuid));
 163         bridge.setPorts(Collections.singleton(new UUID(portNamedUuid)));
 164     }
 165
 166     private Insert<GenericTableSchema> setInterface(TransactionBuilder transaction,
 167             OvsdbBridgeAugmentation ovsdbManagedNode) {
 168         // Interface part
 169         String interfaceNamedUuid = "Interface_" + SouthboundMapper.getRandomUuid();
 170         Interface interfaceOvs = TyperUtils.getTypedRowWrapper(transaction.getDatabaseSchema(), Interface.class);
 171         interfaceOvs.setName(ovsdbManagedNode.getBridgeName().getValue());
 172         interfaceOvs.setType(SouthboundMapper.createOvsdbInterfaceType(InterfaceTypeInternal.class));
 173         Insert<GenericTableSchema> result = op.insert(interfaceOvs).withId(interfaceNamedUuid);
 174         transaction.add(result);
 175         return result;
 176     }
 177
 178     private void setFailMode(Bridge bridge,
 179             OvsdbBridgeAugmentation ovsdbManagedNode) {
 180         if (ovsdbManagedNode.getFailMode() != null
 181                 && SouthboundConstants.OVSDB_FAIL_MODE_MAP.get(ovsdbManagedNode.getFailMode()) != null) {
 182             bridge.setFailMode(Collections.singleton(
 183                     SouthboundConstants.OVSDB_FAIL_MODE_MAP.get(ovsdbManagedNode.getFailMode())));
 184         }
 185     }
 186
 187     private void stampInstanceIdentifier(TransactionBuilder transaction,InstanceIdentifier<Node> iid,
 188             String bridgeName, InstanceIdentifierCodec instanceIdentifierCodec) {
 189         Bridge bridge = TyperUtils.getTypedRowWrapper(transaction.getDatabaseSchema(), Bridge.class);
 190         bridge.setName(bridgeName);
 191         bridge.setExternalIds(Collections.emptyMap());
 192         Mutate mutate = TransactUtils.stampInstanceIdentifierMutation(transaction, iid, bridge.getSchema(),
 193                 bridge.getExternalIdsColumn().getSchema(), instanceIdentifierCodec);
 194         transaction.add(mutate
 195                 .where(bridge.getNameColumn().getSchema().opEqual(bridgeName))
 196                 .build());
 197     }
 198
 199 }