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