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