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

   1 /*
   2  * Copyright (c) 2015 Brocade Communications 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 java.util.Collections;
  13 import java.util.HashMap;
  14 import java.util.HashSet;
  15 import java.util.List;
  16 import java.util.Map;
  17 import java.util.Map.Entry;
  18 import java.util.concurrent.ExecutionException;
  19 import java.util.Set;
  20
  21 import org.opendaylight.controller.md.sal.binding.api.ReadOnlyTransaction;
  22 import org.opendaylight.controller.md.sal.common.api.data.AsyncDataChangeEvent;
  23 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  24 import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
  25 import org.opendaylight.ovsdb.lib.notation.Mutator;
  26 import org.opendaylight.ovsdb.lib.notation.UUID;
  27 import org.opendaylight.ovsdb.lib.operations.Mutate;
  28 import org.opendaylight.ovsdb.lib.operations.TransactionBuilder;
  29 import org.opendaylight.ovsdb.lib.schema.typed.TyperUtils;
  30 import org.opendaylight.ovsdb.schema.openvswitch.Bridge;
  31 import org.opendaylight.ovsdb.schema.openvswitch.Interface;
  32 import org.opendaylight.ovsdb.schema.openvswitch.Port;
  33 import org.opendaylight.ovsdb.southbound.SouthboundConstants;
  34 import org.opendaylight.ovsdb.southbound.SouthboundMapper;
  35 import org.opendaylight.ovsdb.southbound.SouthboundProvider;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.InterfaceTypeBase;
  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.OvsdbPortInterfaceAttributes.VlanMode;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbTerminationPointAugmentation;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes.InterfaceExternalIds;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes.InterfaceOtherConfigs;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes.Options;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes.PortExternalIds;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes.PortOtherConfigs;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes.Trunks;
  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.node.TerminationPoint;
  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 import com.google.common.base.Optional;
  54 import com.google.common.collect.ImmutableMap;
  55 import com.google.common.collect.Sets;
  56 import com.google.common.util.concurrent.CheckedFuture;
  57
  58 public class TerminationPointCreateCommand extends AbstractTransactCommand {
  59
  60     private static final Logger LOG = LoggerFactory.getLogger(TerminationPointCreateCommand.class);
  61
  62     public TerminationPointCreateCommand(BridgeOperationalState state,
  63             AsyncDataChangeEvent<InstanceIdentifier<?>, DataObject> changes) {
  64         super(state, changes);
  65     }
  66
  67     @Override
  68     public void execute(TransactionBuilder transaction) {
  69         for (Entry<InstanceIdentifier<?>, DataObject> entry: getChanges().getCreatedData().entrySet()) {
  70             DataObject dataObject = entry.getValue();
  71             if (dataObject instanceof OvsdbTerminationPointAugmentation) {
  72                 OvsdbTerminationPointAugmentation terminationPoint = (OvsdbTerminationPointAugmentation) dataObject;
  73                 LOG.debug("Received request to create termination point {}",
  74                         terminationPoint.getName());
  75                 InstanceIdentifier terminationPointIid = entry.getKey();
  76                 Optional<TerminationPoint> terminationPointOptional =
  77                         getOperationalState().getBridgeTerminationPoint(terminationPointIid);
  78                 if (!terminationPointOptional.isPresent()) {
  79                     // Configure interface
  80                     String interfaceUuid = "Interface_" + SouthboundMapper.getRandomUUID();
  81                     Interface ovsInterface =
  82                             TyperUtils.getTypedRowWrapper(transaction.getDatabaseSchema(), Interface.class);
  83                     createInterface(terminationPoint, ovsInterface);
  84                     transaction.add(op.insert(ovsInterface).withId(interfaceUuid));
  85
  86                     stampInstanceIdentifier(transaction, (InstanceIdentifier<TerminationPoint>) entry.getKey(),
  87                             ovsInterface.getName());
  88
  89                     // Configure port with the above interface details
  90                     String portUuid = "Port_" + SouthboundMapper.getRandomUUID();
  91                     Port port = TyperUtils.getTypedRowWrapper(transaction.getDatabaseSchema(), Port.class);
  92                     createPort(terminationPoint, port, interfaceUuid);
  93                     transaction.add(op.insert(port).withId(portUuid));
  94
  95                     //Configure bridge with the above port details
  96                     Bridge bridge = TyperUtils.getTypedRowWrapper(transaction.getDatabaseSchema(), Bridge.class);
  97                     if (getBridge(entry.getKey()) != null) {
  98                         bridge.setName(getBridge(entry.getKey()).getBridgeName().getValue());
  99                         bridge.setPorts(Sets.newHashSet(new UUID(portUuid)));
 100
 101                         transaction.add(op.mutate(bridge)
 102                                 .addMutation(bridge.getPortsColumn().getSchema(),
 103                                         Mutator.INSERT,bridge.getPortsColumn().getData())
 104                                 .where(bridge.getNameColumn().getSchema()
 105                                         .opEqual(bridge.getNameColumn().getData())).build());
 106                     }
 107                 }
 108             }
 109         }
 110
 111     }
 112
 113     private void createInterface(
 114             final OvsdbTerminationPointAugmentation terminationPoint,
 115             final Interface ovsInterface) {
 116         ovsInterface.setName(terminationPoint.getName());
 117
 118         createInterfaceType(terminationPoint, ovsInterface);
 119         createOfPort(terminationPoint, ovsInterface);
 120         createOfPortRequest(terminationPoint, ovsInterface);
 121         createInterfaceOptions(terminationPoint, ovsInterface);
 122         createInterfaceOtherConfig(terminationPoint, ovsInterface);
 123         createInterfaceExternalIds(terminationPoint, ovsInterface);
 124     }
 125
 126     private void createInterfaceType(final OvsdbTerminationPointAugmentation terminationPoint,
 127                                      final Interface ovsInterface) {
 128
 129         Class<? extends InterfaceTypeBase> mdsaltype = terminationPoint.getInterfaceType();
 130         if (mdsaltype != null) {
 131             ovsInterface.setType(SouthboundMapper.createOvsdbInterfaceType(mdsaltype));
 132         }
 133     }
 134
 135     private void createPort(
 136             final OvsdbTerminationPointAugmentation terminationPoint,
 137             final Port port, final String interfaceUuid) {
 138
 139         port.setName(terminationPoint.getName());
 140         port.setInterfaces(Sets.newHashSet(new UUID(interfaceUuid)));
 141         createPortOtherConfig(terminationPoint, port);
 142         createPortVlanTag(terminationPoint, port);
 143         createPortVlanTrunk(terminationPoint, port);
 144         createPortVlanMode(terminationPoint, port);
 145         createPortExternalIds(terminationPoint, port);
 146     }
 147
 148     private void createOfPort(
 149             final OvsdbTerminationPointAugmentation terminationPoint,
 150             final Interface ovsInterface) {
 151
 152         Long ofPort = terminationPoint.getOfport();
 153         if (ofPort != null) {
 154             ovsInterface.setOpenFlowPort(Sets.newHashSet(ofPort));
 155         }
 156     }
 157
 158     private void createOfPortRequest(
 159             final OvsdbTerminationPointAugmentation terminationPoint,
 160             final Interface ovsInterface) {
 161
 162         Integer ofPortRequest = terminationPoint.getOfportRequest();
 163         if (ofPortRequest != null) {
 164             ovsInterface.setOpenFlowPortRequest(Sets.newHashSet(ofPortRequest.longValue()));
 165         }
 166     }
 167
 168     private void createInterfaceOptions(
 169             final OvsdbTerminationPointAugmentation terminationPoint,
 170             final Interface ovsInterface) {
 171
 172         //Configure optional input
 173         if (terminationPoint.getOptions() != null) {
 174             Map<String, String> optionsMap = new HashMap<>();
 175             for (Options option : terminationPoint.getOptions()) {
 176                 optionsMap.put(option.getOption(), option.getValue());
 177             }
 178             try {
 179                 ovsInterface.setOptions(ImmutableMap.copyOf(optionsMap));
 180             } catch (NullPointerException e) {
 181                 LOG.warn("Incomplete OVSDB interface options");
 182             }
 183         }
 184     }
 185
 186     private void createInterfaceExternalIds(
 187             final OvsdbTerminationPointAugmentation terminationPoint,
 188             final Interface ovsInterface) {
 189
 190         List<InterfaceExternalIds> interfaceExternalIds =
 191                 terminationPoint.getInterfaceExternalIds();
 192         if (interfaceExternalIds != null && !interfaceExternalIds.isEmpty()) {
 193             Map<String, String> externalIdsMap = new HashMap<>();
 194             for (InterfaceExternalIds externalId: interfaceExternalIds) {
 195                 externalIdsMap.put(externalId.getExternalIdKey(), externalId.getExternalIdValue());
 196             }
 197             try {
 198                 ovsInterface.setExternalIds(ImmutableMap.copyOf(externalIdsMap));
 199             } catch (NullPointerException e) {
 200                 LOG.warn("Incomplete OVSDB interface external_ids");
 201             }
 202         }
 203     }
 204
 205     private void createInterfaceOtherConfig(
 206             final OvsdbTerminationPointAugmentation terminationPoint,
 207             final Interface ovsInterface) {
 208
 209         List<InterfaceOtherConfigs> interfaceOtherConfigs =
 210                 terminationPoint.getInterfaceOtherConfigs();
 211         if (interfaceOtherConfigs != null && !interfaceOtherConfigs.isEmpty()) {
 212             Map<String, String> otherConfigsMap = new HashMap<>();
 213             for (InterfaceOtherConfigs interfaceOtherConfig : interfaceOtherConfigs) {
 214                 otherConfigsMap.put(interfaceOtherConfig.getOtherConfigKey(),
 215                         interfaceOtherConfig.getOtherConfigValue());
 216             }
 217             try {
 218                 ovsInterface.setOtherConfig(otherConfigsMap);
 219             } catch (NullPointerException e) {
 220                 LOG.warn("Incomplete OVSDB interface other_config", e);
 221             }
 222         }
 223     }
 224
 225     private void createPortExternalIds(
 226             final OvsdbTerminationPointAugmentation terminationPoint,
 227             final Port port) {
 228
 229         List<PortExternalIds> portExternalIds = terminationPoint.getPortExternalIds();
 230         if (portExternalIds != null && !portExternalIds.isEmpty()) {
 231             Map<String, String> externalIdsMap = new HashMap<>();
 232             for (PortExternalIds externalId: portExternalIds) {
 233                 externalIdsMap.put(externalId.getExternalIdKey(), externalId.getExternalIdValue());
 234             }
 235             try {
 236                 port.setExternalIds(ImmutableMap.copyOf(externalIdsMap));
 237             } catch (NullPointerException e) {
 238                 LOG.warn("Incomplete OVSDB port external_ids");
 239             }
 240         }
 241     }
 242
 243     private void createPortVlanTag(
 244             final OvsdbTerminationPointAugmentation terminationPoint,
 245             final Port port) {
 246
 247         if (terminationPoint.getVlanTag() != null) {
 248             Set<Long> vlanTag = new HashSet<>();
 249             vlanTag.add(terminationPoint.getVlanTag().getValue().longValue());
 250             port.setTag(vlanTag);
 251         }
 252     }
 253
 254     private void createPortVlanTrunk(
 255             final OvsdbTerminationPointAugmentation terminationPoint,
 256             final Port port) {
 257
 258         if (terminationPoint.getTrunks() != null && terminationPoint.getTrunks().size() > 0) {
 259             Set<Long> portTrunks = new HashSet<>();
 260             List<Trunks> modelTrunks = terminationPoint.getTrunks();
 261             for (Trunks trunk: modelTrunks) {
 262                 if (trunk.getTrunk() != null) {
 263                     portTrunks.add(trunk.getTrunk().getValue().longValue());
 264                 }
 265             }
 266             port.setTrunks(portTrunks);
 267         }
 268     }
 269
 270     private void createPortVlanMode(
 271             final OvsdbTerminationPointAugmentation terminationPoint,
 272             final Port port) {
 273         if (terminationPoint.getVlanMode() != null) {
 274             Set<String> portVlanMode = new HashSet<>();
 275             VlanMode modelVlanMode = terminationPoint.getVlanMode();
 276             portVlanMode.add(SouthboundConstants.VLANMODES.values()[modelVlanMode.getIntValue() - 1].getMode());
 277             port.setVlanMode(portVlanMode);
 278         }
 279     }
 280
 281     private void createPortOtherConfig(
 282             final OvsdbTerminationPointAugmentation terminationPoint,
 283             final Port ovsPort) {
 284         List<PortOtherConfigs> portOtherConfigs =
 285                 terminationPoint.getPortOtherConfigs();
 286         if (portOtherConfigs != null && !portOtherConfigs.isEmpty()) {
 287             Map<String, String> otherConfigsMap = new HashMap<>();
 288             for (PortOtherConfigs portOtherConfig : portOtherConfigs) {
 289                 otherConfigsMap.put(portOtherConfig.getOtherConfigKey(),
 290                         portOtherConfig.getOtherConfigValue());
 291             }
 292             try {
 293                 ovsPort.setOtherConfig(ImmutableMap.copyOf(otherConfigsMap));
 294             } catch (NullPointerException e) {
 295                 LOG.warn("Incomplete OVSDB port other_config", e);
 296             }
 297         }
 298     }
 299
 300     private OvsdbBridgeAugmentation getBridge(InstanceIdentifier<?> key) {
 301         OvsdbBridgeAugmentation bridge = null;
 302         InstanceIdentifier<Node> nodeIid = key.firstIdentifierOf(Node.class);
 303         Map<InstanceIdentifier<Node>, Node> nodes =
 304                 TransactUtils.extractCreatedOrUpdated(getChanges(),Node.class);
 305         if (nodes != null && nodes.get(nodeIid) != null) {
 306             Node node = nodes.get(nodeIid);
 307             bridge = node.getAugmentation(OvsdbBridgeAugmentation.class);
 308             if (bridge == null) {
 309                 ReadOnlyTransaction transaction = SouthboundProvider.getDb().newReadOnlyTransaction();
 310                 CheckedFuture<Optional<Node>, ReadFailedException> future =
 311                         transaction.read(LogicalDatastoreType.OPERATIONAL, nodeIid);
 312                 try {
 313                     Optional<Node> nodeOptional = future.get();
 314                     if (nodeOptional.isPresent()) {
 315                         bridge = nodeOptional.get().getAugmentation(OvsdbBridgeAugmentation.class);
 316                     }
 317                 } catch (InterruptedException | ExecutionException e) {
 318                     LOG.warn("Error reading from datastore",e);
 319                 }
 320                 transaction.close();
 321             }
 322         }
 323         return bridge;
 324     }
 325
 326     public static void stampInstanceIdentifier(TransactionBuilder transaction,InstanceIdentifier<TerminationPoint> iid,
 327             String interfaceName) {
 328         Port port = TyperUtils.getTypedRowWrapper(transaction.getDatabaseSchema(), Port.class);
 329         port.setName(interfaceName);
 330         port.setExternalIds(Collections.<String,String>emptyMap());
 331         Mutate mutate = TransactUtils.stampInstanceIdentifierMutation(transaction,
 332                 iid,
 333                 port.getSchema(),
 334                 port.getExternalIdsColumn().getSchema());
 335         transaction.add(mutate
 336                 .where(port.getNameColumn().getSchema().opEqual(interfaceName))
 337                 .build());
 338     }
 339
 340 }