renderers/ofoverlay/src/main/java/org/opendaylight/groupbasedpolicy/renderer/ofoverlay/sf/ChainAction.java

   1 /*
   2  * Copyright (c) 2014 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
   9 package org.opendaylight.groupbasedpolicy.renderer.ofoverlay.sf;
  10
  11 /*
  12  * Copyright (c) 2014 Cisco Systems, Inc. and others. All rights reserved.
  13  *
  14  * This program and the accompanying materials are made available under the
  15  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
  16  * and is available at http://www.eclipse.org/legal/epl-v10.html
  17  */
  18
  19 import static org.opendaylight.groupbasedpolicy.renderer.ofoverlay.flow.ChainActionFlows.createChainTunnelFlows;
  20 import static org.opendaylight.groupbasedpolicy.renderer.ofoverlay.flow.FlowUtils.nxSetNsiAction;
  21 import static org.opendaylight.groupbasedpolicy.renderer.ofoverlay.flow.FlowUtils.nxSetNspAction;
  22
  23 import java.util.List;
  24 import java.util.Map;
  25
  26 import org.opendaylight.controller.md.sal.binding.api.ReadOnlyTransaction;
  27 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  28 import org.opendaylight.groupbasedpolicy.renderer.ofoverlay.OfContext;
  29 import org.opendaylight.groupbasedpolicy.renderer.ofoverlay.PolicyManager.FlowMap;
  30 import org.opendaylight.groupbasedpolicy.renderer.ofoverlay.flow.OrdinalFactory;
  31 import org.opendaylight.groupbasedpolicy.renderer.ofoverlay.flow.PolicyEnforcer.NetworkElements;
  32 import org.opendaylight.groupbasedpolicy.renderer.ofoverlay.flow.PolicyEnforcer.PolicyPair;
  33 import org.opendaylight.groupbasedpolicy.renderer.ofoverlay.sfcutils.SfcIidFactory;
  34 import org.opendaylight.groupbasedpolicy.renderer.ofoverlay.sfcutils.SfcNshHeader;
  35 import org.opendaylight.groupbasedpolicy.renderer.ofoverlay.sfcutils.SfcNshHeader.SfcNshHeaderBuilder;
  36 import org.opendaylight.groupbasedpolicy.resolver.EgKey;
  37 import org.opendaylight.groupbasedpolicy.util.DataStoreHelper;
  38 import org.opendaylight.sfc.provider.api.SfcProviderRenderedPathAPI;
  39 import org.opendaylight.sfc.provider.api.SfcProviderServiceChainAPI;
  40 import org.opendaylight.sfc.provider.api.SfcProviderServicePathAPI;
  41 import org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.sfc.rsp.rev140701.CreateRenderedPathInput;
  42 import org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.sfc.rsp.rev140701.CreateRenderedPathInputBuilder;
  43 import org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.sfc.rsp.rev140701.rendered.service.path.first.hop.info.RenderedServicePathFirstHop;
  44 import org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.sfc.rsp.rev140701.rendered.service.paths.RenderedServicePath;
  45 import org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.sfc.rsp.rev140701.rendered.service.paths.rendered.service.path.RenderedServicePathHop;
  46 import org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.sfc.sfc.rev140701.service.function.chain.grouping.ServiceFunctionChain;
  47 import org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.sfc.sfp.rev140701.ServiceFunctionPaths;
  48 import org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.sfc.sfp.rev140701.service.function.paths.ServiceFunctionPath;
  49 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.IpAddress;
  50 import org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.list.ActionBuilder;
  51 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.ActionDefinitionId;
  52 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.ActionName;
  53 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.Description;
  54 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.ParameterName;
  55 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.endpoint.rev140421.endpoints.Endpoint;
  56 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.HasDirection.Direction;
  57 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.subject.feature.definition.Parameter.IsRequired;
  58 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.subject.feature.definition.Parameter.Type;
  59 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.subject.feature.definition.ParameterBuilder;
  60 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.subject.feature.definitions.ActionDefinition;
  61 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.subject.feature.definitions.ActionDefinitionBuilder;
  62 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.subject.feature.instance.ParameterValue;
  63 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.policy.rev140421.tenants.tenant.subject.feature.instances.ActionInstance;
  64 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId;
  65 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.overlay.rev150105.TunnelTypeVxlanGpe;
  66 import org.slf4j.Logger;
  67 import org.slf4j.LoggerFactory;
  68
  69 import com.google.common.base.Optional;
  70 import com.google.common.collect.ImmutableList;
  71 import com.google.common.collect.Iterables;
  72
  73 /**
  74  * Chain action for the OpenFlow Overlay renderer
  75  * TODO: separate the generic definition from the concrete
  76  * implementation for the OpenFlow Overlay renderer
  77  */
  78 public class ChainAction extends Action {
  79
  80     private static final Logger LOG = LoggerFactory.getLogger(ChainAction.class);
  81
  82     public static final ActionDefinitionId ID = new ActionDefinitionId("3d886be7-059f-4c4f-bbef-0356bea40933");
  83
  84     public static final Integer CHAIN_CONDITION_GROUP = 0xfffffe;
  85
  86     protected static final String TYPE = "type";
  87
  88     // the chain action
  89     public static final String SFC_CHAIN_ACTION = "chain";
  90     // the parameter used for storing the chain name
  91     public static final String SFC_CHAIN_NAME = "sfc-chain-name";
  92
  93     protected static final ActionDefinition DEF = new ActionDefinitionBuilder().setId(ID)
  94         .setName(new ActionName(SFC_CHAIN_ACTION))
  95         .setDescription(new Description("Send the traffic through a Service Function Chain"))
  96         .setParameter(
  97                 (ImmutableList.of(new ParameterBuilder().setName(new ParameterName(SFC_CHAIN_NAME))
  98                     .setDescription(new Description("The named chain to match against"))
  99                     .setIsRequired(IsRequired.Required)
 100                     .setType(Type.String)
 101                     .build())))
 102         .build();
 103
 104     @Override
 105     public ActionDefinitionId getId() {
 106         return ID;
 107     }
 108
 109     @Override
 110     public ActionDefinition getActionDef() {
 111         return DEF;
 112     }
 113
 114     @Override
 115     public List<ActionBuilder> updateAction(List<ActionBuilder> actions, Map<String, Object> params, Integer order,
 116             NetworkElements netElements, PolicyPair policyPair, FlowMap flowMap, OfContext ctx, Direction direction) {
 117         /*
 118          * Get the named chain
 119          */
 120         String chainName = null;
 121         if (params != null) {
 122             LOG.debug("updateAction: Searching for named chain");
 123             for (String name : params.keySet()) {
 124                 if (name instanceof String) {
 125                     if (name.equals(SFC_CHAIN_NAME)) {
 126                         chainName = (String) params.get(name);
 127                         if (chainName == null) {
 128                             LOG.error("updateAction: Chain name was null");
 129                             return null;
 130                         }
 131                     }
 132                 }
 133             }
 134         } else {
 135             LOG.error("updateAction: Parameters null for chain action");
 136             return null;
 137         }
 138
 139         if (chainName == null) {
 140             LOG.error("updateAction: Chain name was null");
 141             return null;
 142         }
 143
 144         /*
 145          * If path is symmetrical then there are two RSPs.
 146          * if srcEp is in consumer EPG use "rspName"
 147          * else srcEp is in provider EPG, "rspName-Reverse".
 148          */
 149         ServiceFunctionPath sfcPath = getSfcPath(chainName);
 150         if (sfcPath == null || sfcPath.getName() == null) {
 151             LOG.error("updateAction: SFC Path was invalid. Either null or name was null.", sfcPath);
 152             return null;
 153         }
 154         // Find existing RSP based on following naming convention, else create it.
 155         String rspName = sfcPath.getName() + "-gbp-rsp";
 156         ReadOnlyTransaction rTx = ctx.getDataBroker().newReadOnlyTransaction();
 157         RenderedServicePath renderedServicePath;
 158         RenderedServicePath rsp = getRspByName(rspName, rTx);
 159         if (rsp == null) {
 160             renderedServicePath = createRsp(sfcPath, rspName);
 161             if (renderedServicePath != null) {
 162                 LOG.info("updateAction: Could not find RSP {} for Chain {}, created.", rspName, chainName);
 163             } else {
 164                 LOG.error("updateAction: Could not create RSP {} for Chain {}", rspName, chainName);
 165                 return null;
 166             }
 167         } else {
 168             renderedServicePath = rsp;
 169         }
 170
 171         try {
 172             if (sfcPath.isSymmetric() && direction.equals(Direction.Out)){
 173                 rspName = rspName + "-Reverse";
 174                 rsp = getRspByName(rspName, rTx);
 175                 if (rsp == null) {
 176                     LOG.info("updateAction: Could not find Reverse RSP {} for Chain {}", rspName, chainName);
 177                     renderedServicePath = createSymmetricRsp(renderedServicePath);
 178                     if (renderedServicePath == null) {
 179                         LOG.error("updateAction: Could not create RSP {} for Chain {}", rspName, chainName);
 180                         return null;
 181                     }
 182                 } else {
 183                     renderedServicePath = rsp;
 184                 }
 185             }
 186         } catch (Exception e) {
 187             LOG.error("updateAction: Attemping to determine if srcEp {} was consumer.", netElements.getSrcEp().getKey(), e);
 188             return null;
 189         }
 190
 191         RenderedServicePathFirstHop rspFirstHop = SfcProviderRenderedPathAPI.readRenderedServicePathFirstHop(rspName);
 192         if (!isValidRspFirstHop(rspFirstHop)) {
 193             // Errors logged in method.
 194             return null;
 195         }
 196
 197         NodeId tunnelDestNodeId=netElements.getDstNodeId();
 198
 199         Long returnVnid = (long) netElements.getSrcEpOrds().getTunnelId();
 200
 201         IpAddress tunnelDest = ctx.getSwitchManager().getTunnelIP(tunnelDestNodeId, TunnelTypeVxlanGpe.class);
 202         if (tunnelDest == null || tunnelDest.getIpv4Address() == null) {
 203             LOG.error("updateAction: Invalid tunnelDest for NodeId: {}", tunnelDestNodeId);
 204             return null;
 205         }
 206
 207         RenderedServicePathHop firstRspHop = renderedServicePath.getRenderedServicePathHop().get(0);
 208         RenderedServicePathHop lastRspHop = Iterables.getLast(renderedServicePath.getRenderedServicePathHop());
 209         SfcNshHeader sfcNshHeader = new SfcNshHeaderBuilder().setNshTunIpDst(rspFirstHop.getIp().getIpv4Address())
 210             .setNshTunUdpPort(rspFirstHop.getPort())
 211             .setNshNsiToChain(firstRspHop.getServiceIndex())
 212             .setNshNspToChain(renderedServicePath.getPathId())
 213             .setNshNsiFromChain((short) (lastRspHop.getServiceIndex().intValue() - 1))
 214             .setNshNspFromChain(renderedServicePath.getPathId())
 215             .setNshMetaC1(SfcNshHeader.convertIpAddressToLong(tunnelDest.getIpv4Address()))
 216             .setNshMetaC2(returnVnid)
 217             .build();
 218
 219         // Cannot set all actions here. Some actions are destination specific, and we don't know
 220         // a destination is to be
 221         // chained until we reach this point. Need to write match/action in External Table for
 222         // chained packets.
 223         actions = addActionBuilder(actions, nxSetNsiAction(sfcNshHeader.getNshNsiToChain()), order);
 224         actions = addActionBuilder(actions, nxSetNspAction(sfcNshHeader.getNshNspToChain()), order);
 225         createChainTunnelFlows(sfcNshHeader, netElements, flowMap, ctx);
 226         return actions;
 227     }
 228
 229     private RenderedServicePath createRsp(ServiceFunctionPath sfcPath, String rspName) {
 230         CreateRenderedPathInput rspInput = new CreateRenderedPathInputBuilder().setParentServiceFunctionPath(
 231                 sfcPath.getName())
 232             .setName(rspName)
 233             .setSymmetric(sfcPath.isSymmetric())
 234             .build();
 235          return SfcProviderRenderedPathAPI.createRenderedServicePathAndState(sfcPath, rspInput);
 236     }
 237
 238     private RenderedServicePath createSymmetricRsp(RenderedServicePath rsp) {
 239         if (rsp == null) {
 240             return null;
 241         }
 242         return SfcProviderRenderedPathAPI.createSymmetricRenderedServicePathAndState(rsp);
 243     }
 244
 245     private boolean isValidRspFirstHop(RenderedServicePathFirstHop rspFirstHop) {
 246         boolean valid = true;
 247         if (rspFirstHop == null) {
 248             LOG.error("isValidRspFirstHop: rspFirstHop is null.");
 249             return false;
 250         }
 251         if (rspFirstHop.getIp() == null || rspFirstHop.getIp().getIpv4Address() == null
 252                 || rspFirstHop.getIp().getIpv6Address() != null) {
 253             LOG.error("isValidRspFirstHop: rspFirstHop has invalid IP address.");
 254             valid = false;
 255         }
 256         if (rspFirstHop.getPort() == null) {
 257             LOG.error("isValidRspFirstHop: rspFirstHop has no IP port .");
 258             valid = false;
 259         }
 260         if (rspFirstHop.getPathId() == null) {
 261             LOG.error("isValidRspFirstHop: rspFirstHop has no Path Id (NSP).");
 262             valid = false;
 263         }
 264         if (rspFirstHop.getStartingIndex() == null) {
 265             LOG.error("isValidRspFirstHop: rspFirstHop has no Starting Index (NSI)");
 266             valid = false;
 267         }
 268         return valid;
 269     }
 270
 271     private RenderedServicePath getRspByName(String rspName, ReadOnlyTransaction rTx) {
 272         Optional<RenderedServicePath> optRsp = DataStoreHelper.readFromDs(LogicalDatastoreType.OPERATIONAL,
 273                 SfcIidFactory.rspIid(rspName), rTx);
 274         if (optRsp.isPresent()) {
 275             return optRsp.get();
 276         }
 277         return null;
 278     }
 279
 280     @Override
 281     public boolean isValid(ActionInstance actionInstance) {
 282         return isValidGbpChain(actionInstance.getParameterValue());
 283     }
 284
 285     private boolean isValidGbpChain(List<ParameterValue> paramValue) {
 286         ParameterValue pv = getChainNameParameter(paramValue);
 287         if (pv == null) {
 288             return false;
 289         }
 290         LOG.trace("isValidGbpChain: Invoking RPC for chain {}", pv.getStringValue());
 291         ServiceFunctionChain chain = SfcProviderServiceChainAPI.readServiceFunctionChain(pv.getStringValue());
 292         return (chain != null);
 293     }
 294
 295     public ServiceFunctionPath getSfcPath(String chainName) {
 296         ServiceFunctionPaths paths = SfcProviderServicePathAPI.readAllServiceFunctionPaths();
 297         for (ServiceFunctionPath path : paths.getServiceFunctionPath()) {
 298             if (path.getServiceChainName().equals(chainName)) {
 299                 return path;
 300             }
 301         }
 302         return null;
 303     }
 304
 305     private ParameterValue getChainNameParameter(List<ParameterValue> paramValueList) {
 306         if (paramValueList == null)
 307             return null;
 308         for (ParameterValue pv : paramValueList) {
 309             if (pv.getName().getValue().equals(SFC_CHAIN_NAME)) {
 310                 return pv;
 311             }
 312         }
 313         return null;
 314     }
 315
 316     private List<ActionBuilder> addActionBuilder(List<ActionBuilder> actions,
 317             org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.Action action, Integer order) {
 318         ActionBuilder ab = new ActionBuilder();
 319         ab.setAction(action);
 320         ab.setOrder(order);
 321         actions.add(ab);
 322         return actions;
 323     }
 324
 325 }