openstack/sfc-translator/impl/src/main/java/org/opendaylight/netvirt/openstack/sfc/translator/portchain/PortPairGroupTranslator.java

   1 /*
   2  * Copyright (c) 2016 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.netvirt.openstack.sfc.translator.portchain;
   9
  10 import com.google.common.base.Preconditions;
  11 import org.opendaylight.netvirt.openstack.sfc.translator.OvsdbMdsalHelper;
  12 import org.opendaylight.netvirt.openstack.sfc.translator.OvsdbPortMetadata;
  13 import org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.sfc.common.rev151017.SffDataPlaneLocatorName;
  14 import org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.sfc.common.rev151017.SffName;
  15 import org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.sfc.common.rev151017.SnName;
  16 import org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.sfc.sf.rev140701.service.functions.ServiceFunction;
  17 import org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.sfc.sff.ovs.rev140701.SffOvsBridgeAugmentation;
  18 import org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.sfc.sff.ovs.rev140701.SffOvsBridgeAugmentationBuilder;
  19 import org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.sfc.sff.ovs.rev140701.SffOvsLocatorOptionsAugmentation;
  20 import org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.sfc.sff.ovs.rev140701.SffOvsLocatorOptionsAugmentationBuilder;
  21 import org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.sfc.sff.ovs.rev140701.SffOvsNodeAugmentation;
  22 import org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.sfc.sff.ovs.rev140701.SffOvsNodeAugmentationBuilder;
  23 import org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.sfc.sff.ovs.rev140701.bridge.OvsBridgeBuilder;
  24 import org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.sfc.sff.ovs.rev140701.node.OvsNodeBuilder;
  25 import org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.sfc.sff.ovs.rev140701.options.OvsOptionsBuilder;
  26 import org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.sfc.sff.rev140701.Open;
  27 import org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.sfc.sff.rev140701.service.function.forwarder.base.SffDataPlaneLocator;
  28 import org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.sfc.sff.rev140701.service.function.forwarder.base.SffDataPlaneLocatorBuilder;
  29 import org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.sfc.sff.rev140701.service.function.forwarder.base.SffDataPlaneLocatorKey;
  30 import org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.sfc.sff.rev140701.service.function.forwarder.base.sff.data.plane.locator.DataPlaneLocatorBuilder;
  31 import org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.sfc.sff.rev140701.service.function.forwarders.ServiceFunctionForwarderBuilder;
  32 import org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.sfc.sff.rev140701.service.function.forwarders.ServiceFunctionForwarderKey;
  33 import org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.sfc.sff.rev140701.service.function.forwarders.service.function.forwarder.ServiceFunctionDictionary;
  34 import org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.sfc.sff.rev140701.service.function.forwarders.service.function.forwarder.ServiceFunctionDictionaryBuilder;
  35 import org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.sfc.sff.rev140701.service.function.forwarders.service.function.forwarder.ServiceFunctionDictionaryKey;
  36 import org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.sfc.sff.rev140701.service.function.forwarders.service.function.forwarder.service.function.dictionary.SffSfDataPlaneLocatorBuilder;
  37 import org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.sfc.sl.rev140701.VxlanGpe;
  38 import org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.sfc.sl.rev140701.data.plane.locator.locator.type.IpBuilder;
  39 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.sfc.rev160511.sfc.attributes.port.pair.groups.PortPairGroup;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.sfc.rev160511.sfc.attributes.port.pairs.PortPair;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbBridgeAugmentation;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbNodeAugmentation;
  44 import org.slf4j.Logger;
  45 import org.slf4j.LoggerFactory;
  46
  47 import java.util.ArrayList;
  48 import java.util.Iterator;
  49 import java.util.List;
  50 import java.util.Map;
  51 import java.util.concurrent.atomic.AtomicInteger;
  52
  53 /**
  54  * Class will convert OpenStack Port Pair API yang models present in
  55  * neutron northbound project to OpenDaylight SFC yang models.
  56  */
  57 public class PortPairGroupTranslator {
  58     private static final Logger LOG = LoggerFactory.getLogger(PortPairGroupTranslator.class);
  59     private static final String OPT_FLOW_STR = "flow";
  60     private static final String OPT_GPE_STR = "gpe";
  61     private static final String OPT_DST_PORT = "6633";
  62
  63     private static final AtomicInteger counter = new AtomicInteger(0);
  64     private static final String SFF_DEFAULT_NAME = "sff";
  65     private static final String SFF_DPL_SUFFIX = "-dpl";
  66     private static final String SFF_DPL_FIX_NAME = "vxgpe";
  67
  68     public static ServiceFunctionForwarderBuilder buildServiceFunctionForwarder(
  69             PortPairGroup portPairGroup,
  70             List<PortPair> portPairs,
  71             Map<Uuid, OvsdbPortMetadata> ovsdbPortsMetadata) {
  72         Preconditions.checkNotNull(portPairGroup, "Port pair group must not be null");
  73
  74         ServiceFunctionForwarderBuilder sffBuilder = new ServiceFunctionForwarderBuilder();
  75         SffOvsBridgeAugmentationBuilder sffOvsBridgeAugBuilder = new SffOvsBridgeAugmentationBuilder();
  76         SffOvsNodeAugmentationBuilder sffOvsNodeAugBuilder = new SffOvsNodeAugmentationBuilder();
  77
  78         List<SffDataPlaneLocator> sffDataPlaneLocator = new ArrayList<>();
  79         SffDataPlaneLocatorBuilder sffDplBuilder = new SffDataPlaneLocatorBuilder();
  80         DataPlaneLocatorBuilder dplBuilder = new DataPlaneLocatorBuilder();
  81
  82         IpBuilder sffLocator = new IpBuilder();
  83
  84         //Currently we only support one SF per type. Mean, one port-pair per port-pair-group.
  85         //Get port pair from neutron data store.
  86         PortPair portPair = portPairs.get(0);
  87         if (portPair == null) {
  88            LOG.error("Port pair {} does not exist in the neutron data store. Port Pair Group {} request can't be " +
  89                    "processed.", portPairGroup.getPortPairs().get(0), portPairGroup);
  90             return null;
  91         }
  92         //Get metadata of neutron port related to port pair ingress port from ovsdb data store.
  93         OvsdbPortMetadata ovsdbPortMetadata = ovsdbPortsMetadata.get(portPair.getIngress());
  94
  95         //Convert the port pair to service function
  96
  97         //Set SFF DPL transport type
  98         dplBuilder.setTransport(VxlanGpe.class);
  99
 100         //Set SFF Locator Type
 101         OvsdbNodeAugmentation ovsdbNodeAug = ovsdbPortMetadata.getOvsdbNode();
 102         if (ovsdbNodeAug != null ) {
 103             sffLocator.setIp(ovsdbNodeAug.getConnectionInfo().getRemoteIp());
 104             sffLocator.setPort(ovsdbNodeAug.getConnectionInfo().getRemotePort());
 105         }
 106         dplBuilder.setLocatorType(sffLocator.build());
 107         //set data-path-locator for sff-data-path-locator
 108         sffDplBuilder.setDataPlaneLocator(dplBuilder.build());
 109
 110         //Set location options for sff-dp-locator
 111         sffDplBuilder.addAugmentation(SffOvsLocatorOptionsAugmentation.class, buildOvsOptions().build());
 112
 113         //Set ovsdb bridge name for sff
 114         OvsBridgeBuilder ovsBridgeBuilder = new OvsBridgeBuilder();
 115         OvsdbBridgeAugmentation ovsdbBridgeAugmentation = ovsdbPortMetadata.getOvsdbBridgeNode();
 116         if (ovsdbBridgeAugmentation != null) {
 117             ovsBridgeBuilder.setBridgeName(ovsdbBridgeAugmentation.getBridgeName().getValue());
 118
 119             //Set SFF name
 120             String serviceNode = OvsdbMdsalHelper.getNodeKey(ovsdbBridgeAugmentation.getManagedBy().getValue());
 121             if(serviceNode.isEmpty()) {
 122                 serviceNode += SFF_DEFAULT_NAME + counter.incrementAndGet();
 123                 sffBuilder.setName(new SffName(serviceNode));
 124                 sffBuilder.setServiceNode(new SnName(serviceNode));
 125             } else {
 126                 //Set service node to ovsdbNode
 127                 sffBuilder.setServiceNode(new SnName(serviceNode));
 128
 129                 //Set SFF name to ovsdbBridgeNode
 130                 serviceNode += "/" + ovsdbBridgeAugmentation.getBridgeName().getValue();
 131                 sffBuilder.setName(new SffName(serviceNode));
 132             }
 133
 134             //Set ovsdb-node iid reference for SFF
 135             OvsNodeBuilder ovsNodeBuilder = new OvsNodeBuilder();
 136             ovsNodeBuilder.setNodeId(ovsdbBridgeAugmentation.getManagedBy());
 137             sffOvsNodeAugBuilder.setOvsNode(ovsNodeBuilder.build());
 138             sffBuilder.addAugmentation(SffOvsNodeAugmentation.class, sffOvsNodeAugBuilder.build());
 139         }
 140         sffOvsBridgeAugBuilder.setOvsBridge(ovsBridgeBuilder.build());
 141         sffBuilder.addAugmentation(SffOvsBridgeAugmentation.class, sffOvsBridgeAugBuilder.build());
 142
 143         //Set management ip, same to the ovsdb  node ip
 144         sffBuilder.setIpMgmtAddress(sffLocator.getIp());
 145
 146         //TODO: DPL name should not be hardcoded. Require net-virt classifier to remove dependency on it.
 147         sffDplBuilder.setName(new SffDataPlaneLocatorName(SFF_DPL_FIX_NAME));
 148         sffDplBuilder.setKey(new SffDataPlaneLocatorKey(sffDplBuilder.getName()));
 149         sffDataPlaneLocator.add(sffDplBuilder.build());
 150         //set SFF key
 151         sffBuilder.setKey(new ServiceFunctionForwarderKey(sffBuilder.getName()));
 152         sffBuilder.setSffDataPlaneLocator(sffDataPlaneLocator);
 153
 154         return sffBuilder;
 155     }
 156
 157     public static void buildServiceFunctionDictonary(ServiceFunctionForwarderBuilder sffBuilder,
 158                                                                            ServiceFunction sf) {
 159         List<ServiceFunctionDictionary> sfdList = new ArrayList<>();
 160         ServiceFunctionDictionaryBuilder sfdBuilder = new ServiceFunctionDictionaryBuilder();
 161
 162         //Build Sff-sf-data-plane-locator
 163         SffSfDataPlaneLocatorBuilder sffSfDplBuilder = new SffSfDataPlaneLocatorBuilder();
 164         sffSfDplBuilder.setSfDplName(sf.getSfDataPlaneLocator().get(0).getName());
 165         sffSfDplBuilder.setSffDplName(sffBuilder.getSffDataPlaneLocator().get(0).getName());
 166         sfdBuilder.setSffSfDataPlaneLocator(sffSfDplBuilder.build());
 167
 168         sfdBuilder.setName(sf.getName());
 169         sfdBuilder.setKey(new ServiceFunctionDictionaryKey(sfdBuilder.getName()));
 170
 171         //NOTE: fail mode is set to Open by default
 172         sfdBuilder.setFailmode(Open.class);
 173         sfdList.add(sfdBuilder.build());
 174
 175         //TODO: set interface name list
 176
 177         if (sffBuilder.getServiceFunctionDictionary() != null) {
 178             for (Iterator<ServiceFunctionDictionary> sfdItr = sffBuilder.getServiceFunctionDictionary().iterator();sfdItr
 179                     .hasNext();) {
 180                 ServiceFunctionDictionary sfd = sfdItr.next();
 181                 if (sfd.getName().equals(sfdBuilder.getName())) {
 182                     LOG.info("Existing SF dictionary {} found in SFF {}, removing the SF dictionary", sfd.getName(),
 183                             sffBuilder.getName());
 184                     sfdItr.remove();
 185                     break;
 186                 }
 187             }
 188             sffBuilder.getServiceFunctionDictionary().addAll(sfdList);
 189         } else {
 190             sffBuilder.setServiceFunctionDictionary(sfdList);
 191         }
 192         LOG.info("Final Service Function Dictionary {}", sffBuilder.getServiceFunctionDictionary());
 193     }
 194
 195     private static SffOvsLocatorOptionsAugmentationBuilder buildOvsOptions() {
 196         SffOvsLocatorOptionsAugmentationBuilder ovsOptions = new SffOvsLocatorOptionsAugmentationBuilder();
 197         OvsOptionsBuilder ovsOptionsBuilder = new OvsOptionsBuilder();
 198         ovsOptionsBuilder.setRemoteIp(OPT_FLOW_STR);
 199         ovsOptionsBuilder.setDstPort(OPT_DST_PORT);
 200         ovsOptionsBuilder.setKey(OPT_FLOW_STR);
 201         ovsOptionsBuilder.setExts(OPT_GPE_STR);
 202         ovsOptions.setOvsOptions(ovsOptionsBuilder.build());
 203         return ovsOptions;
 204     }
 205 }