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