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