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