git.opendaylight Code Review - netvirt.git/blob

   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_DST_PORT = "6633";
  61
  62     private static final AtomicInteger counter = new AtomicInteger(0);
  63     private static final String SFF_DEFAULT_NAME = "sff";
  64     private static final String SFF_DPL_SUFFIX = "-dpl";
  65
  66     public static ServiceFunctionForwarderBuilder buildServiceFunctionForwarder(
  67             PortPairGroup portPairGroup,
  68             List<PortPair> portPairs,
  69             Map<Uuid, OvsdbPortMetadata> ovsdbPortsMetadata) {
  70         Preconditions.checkNotNull(portPairGroup, "Port pair group must not be null");
  71
  72         ServiceFunctionForwarderBuilder sffBuilder = new ServiceFunctionForwarderBuilder();
  73         SffOvsBridgeAugmentationBuilder sffOvsBridgeAugBuilder = new SffOvsBridgeAugmentationBuilder();
  74         SffOvsNodeAugmentationBuilder sffOvsNodeAugBuilder = new SffOvsNodeAugmentationBuilder();
  75
  76         List<SffDataPlaneLocator> sffDataPlaneLocator = new ArrayList<>();
  77         SffDataPlaneLocatorBuilder sffDplBuilder = new SffDataPlaneLocatorBuilder();
  78         DataPlaneLocatorBuilder dplBuilder = new DataPlaneLocatorBuilder();
  79
  80         IpBuilder sffLocator = new IpBuilder();
  81
  82         //Currently we only support one SF per type. Mean, one port-pair per port-pair-group.
  83         //Get port pair from neutron data store.
  84         PortPair portPair = portPairs.get(0);
  85         if (portPair == null) {
  86            LOG.error("Port pair {} does not exist in the neutron data store. Port Pair Group {} request can't be " +
  87                    "processed.", portPairGroup.getPortPairs().get(0), portPairGroup);
  88             return null;
  89         }
  90         //Get metadata of neutron port related to port pair ingress port from ovsdb data store.
  91         OvsdbPortMetadata ovsdbPortMetadata = ovsdbPortsMetadata.get(portPair.getIngress());
  92
  93         //Convert the port pair to service function
  94
  95         //Set SFF DPL transport type
  96         dplBuilder.setTransport(VxlanGpe.class);
  97
  98         //Set SFF Locator Type
  99         OvsdbNodeAugmentation ovsdbNodeAug = ovsdbPortMetadata.getOvsdbNode();
 100         if (ovsdbNodeAug != null ) {
 101             sffLocator.setIp(ovsdbNodeAug.getConnectionInfo().getRemoteIp());
 102             sffLocator.setPort(ovsdbNodeAug.getConnectionInfo().getRemotePort());
 103         }
 104         dplBuilder.setLocatorType(sffLocator.build());
 105         //set data-path-locator for sff-data-path-locator
 106         sffDplBuilder.setDataPlaneLocator(dplBuilder.build());
 107
 108         //Set location options for sff-dp-locator
 109         sffDplBuilder.addAugmentation(SffOvsLocatorOptionsAugmentation.class, buildOvsOptions().build());
 110
 111         //Set ovsdb bridge name for sff
 112         OvsBridgeBuilder ovsBridgeBuilder = new OvsBridgeBuilder();
 113         OvsdbBridgeAugmentation ovsdbBridgeAugmentation = ovsdbPortMetadata.getOvsdbBridgeNode();
 114         if (ovsdbBridgeAugmentation != null) {
 115             ovsBridgeBuilder.setBridgeName(ovsdbBridgeAugmentation.getBridgeName().getValue());
 116
 117             //Set SFF name
 118             String serviceNode = OvsdbMdsalHelper.getNodeKey(ovsdbBridgeAugmentation.getManagedBy().getValue());
 119             if(serviceNode.isEmpty()) {
 120                 serviceNode += SFF_DEFAULT_NAME + counter.incrementAndGet();
 121                 sffBuilder.setName(new SffName(serviceNode));
 122                 sffBuilder.setServiceNode(new SnName(serviceNode));
 123             } else {
 124                 //Set service node to ovsdbNode
 125                 sffBuilder.setServiceNode(new SnName(serviceNode));
 126
 127                 //Set SFF name to ovsdbBridgeNode
 128                 serviceNode += "/" + ovsdbBridgeAugmentation.getBridgeName().getValue();
 129                 sffBuilder.setName(new SffName(serviceNode));
 130             }
 131
 132             //Set ovsdb-node iid reference for SFF
 133             OvsNodeBuilder ovsNodeBuilder = new OvsNodeBuilder();
 134             ovsNodeBuilder.setNodeId(ovsdbBridgeAugmentation.getManagedBy());
 135             sffOvsNodeAugBuilder.setOvsNode(ovsNodeBuilder.build());
 136             sffBuilder.addAugmentation(SffOvsNodeAugmentation.class, sffOvsNodeAugBuilder.build());
 137         }
 138         sffOvsBridgeAugBuilder.setOvsBridge(ovsBridgeBuilder.build());
 139         sffBuilder.addAugmentation(SffOvsBridgeAugmentation.class, sffOvsBridgeAugBuilder.build());
 140
 141         //Set management ip, same to the ovsdb  node ip
 142         sffBuilder.setIpMgmtAddress(sffLocator.getIp());
 143         sffDplBuilder.setName(new SffDataPlaneLocatorName(sffBuilder.getName().getValue() + SFF_DPL_SUFFIX));
 144         sffDplBuilder.setKey(new SffDataPlaneLocatorKey(sffDplBuilder.getName()));
 145         sffDataPlaneLocator.add(sffDplBuilder.build());
 146         //set SFF key
 147         sffBuilder.setKey(new ServiceFunctionForwarderKey(sffBuilder.getName()));
 148         sffBuilder.setSffDataPlaneLocator(sffDataPlaneLocator);
 149
 150         return sffBuilder;
 151     }
 152
 153     public static void buildServiceFunctionDictonary(ServiceFunctionForwarderBuilder sffBuilder,
 154                                                                            ServiceFunction sf) {
 155         List<ServiceFunctionDictionary> sfdList = new ArrayList<>();
 156         ServiceFunctionDictionaryBuilder sfdBuilder = new ServiceFunctionDictionaryBuilder();
 157
 158         //Build Sff-sf-data-plane-locator
 159         SffSfDataPlaneLocatorBuilder sffSfDplBuilder = new SffSfDataPlaneLocatorBuilder();
 160         sffSfDplBuilder.setSfDplName(sf.getSfDataPlaneLocator().get(0).getName());
 161         sffSfDplBuilder.setSffDplName(sffBuilder.getSffDataPlaneLocator().get(0).getName());
 162         sfdBuilder.setSffSfDataPlaneLocator(sffSfDplBuilder.build());
 163
 164         sfdBuilder.setName(sf.getName());
 165         sfdBuilder.setKey(new ServiceFunctionDictionaryKey(sfdBuilder.getName()));
 166
 167         //NOTE: fail mode is set to Open by default
 168         sfdBuilder.setFailmode(Open.class);
 169         sfdList.add(sfdBuilder.build());
 170
 171         //TODO: set interface name list
 172
 173         if (sffBuilder.getServiceFunctionDictionary() != null) {
 174             for (Iterator<ServiceFunctionDictionary> sfdItr = sffBuilder.getServiceFunctionDictionary().iterator();sfdItr
 175                     .hasNext();) {
 176                 ServiceFunctionDictionary sfd = sfdItr.next();
 177                 if (sfd.getName().equals(sfdBuilder.getName())) {
 178                     LOG.info("Existing SF dictionary {} found in SFF {}, removing the SF dictionary", sfd.getName(),
 179                             sffBuilder.getName());
 180                     sfdItr.remove();
 181                     break;
 182                 }
 183             }
 184             sffBuilder.getServiceFunctionDictionary().addAll(sfdList);
 185         } else {
 186             sffBuilder.setServiceFunctionDictionary(sfdList);
 187         }
 188         LOG.info("Final Service Function Dictionary {}", sffBuilder.getServiceFunctionDictionary());
 189     }
 190
 191     private static SffOvsLocatorOptionsAugmentationBuilder buildOvsOptions() {
 192         SffOvsLocatorOptionsAugmentationBuilder ovsOptions = new SffOvsLocatorOptionsAugmentationBuilder();
 193         OvsOptionsBuilder ovsOptionsBuilder = new OvsOptionsBuilder();
 194         ovsOptionsBuilder.setRemoteIp(OPT_FLOW_STR);
 195         ovsOptionsBuilder.setDstPort(OPT_DST_PORT);
 196         ovsOptionsBuilder.setKey(OPT_FLOW_STR);
 197         ovsOptionsBuilder.setNsp(OPT_FLOW_STR);
 198         ovsOptionsBuilder.setNsi(OPT_FLOW_STR);
 199         ovsOptionsBuilder.setNshc1(OPT_FLOW_STR);
 200         ovsOptionsBuilder.setNshc2(OPT_FLOW_STR);
 201         ovsOptionsBuilder.setNshc3(OPT_FLOW_STR);
 202         ovsOptionsBuilder.setNshc4(OPT_FLOW_STR);
 203         ovsOptions.setOvsOptions(ovsOptionsBuilder.build());
 204         return ovsOptions;
 205     }
 206 }