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