renderers/ios-xe/src/main/java/org/opendaylight/groupbasedpolicy/renderer/ios_xe_provider/impl/manager/PolicyManagerImpl.java

   1 /*
   2  * Copyright (c) 2016 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.ios_xe_provider.impl.manager;
  10
  11 import static org.opendaylight.groupbasedpolicy.renderer.ios_xe_provider.impl.manager.PolicyManagerImpl.DsAction.Create;
  12 import static org.opendaylight.groupbasedpolicy.renderer.ios_xe_provider.impl.manager.PolicyManagerImpl.DsAction.Delete;
  13
  14 import java.util.concurrent.TimeUnit;
  15 import javax.annotation.Nonnull;
  16 import javax.annotation.Nullable;
  17 import java.util.List;
  18 import java.util.Optional;
  19 import com.google.common.base.Function;
  20 import com.google.common.base.Preconditions;
  21 import com.google.common.util.concurrent.AsyncFunction;
  22 import com.google.common.util.concurrent.CheckedFuture;
  23 import com.google.common.util.concurrent.Futures;
  24 import com.google.common.util.concurrent.ListenableFuture;
  25 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  26 import org.opendaylight.controller.md.sal.binding.api.ReadWriteTransaction;
  27 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  28 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
  29 import org.opendaylight.groupbasedpolicy.renderer.ios_xe_provider.api.manager.PolicyManager;
  30 import org.opendaylight.groupbasedpolicy.renderer.ios_xe_provider.impl.util.PolicyManagerUtil;
  31 import org.opendaylight.groupbasedpolicy.renderer.ios_xe_provider.impl.util.StatusUtil;
  32 import org.opendaylight.groupbasedpolicy.sxp.ep.provider.api.EPToSgtMapper;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.renderer.rev151103.RendererName;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.renderer.rev151103.Renderers;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.renderer.rev151103.renderers.Renderer;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.renderer.rev151103.renderers.RendererKey;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.renderer.rev151103.renderers.renderer.RendererPolicy;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.renderer.rev151103.renderers.renderer.RendererPolicyBuilder;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.renderer.rev151103.renderers.renderer.renderer.policy.Configuration;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.renderer.rev151103.renderers.renderer.renderer.policy.Status;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.renderer.rev151103.renderers.renderer.renderer.policy.StatusBuilder;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.renderer.rev151103.renderers.renderer.renderer.policy.configuration.endpoints.AddressEndpointWithLocation;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.renderer.rev151103.renderers.renderer.renderer.policy.configuration.renderer.endpoints.RendererEndpoint;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.renderer.rev151103.renderers.renderer.renderer.policy.configuration.renderer.endpoints.renderer.endpoint.PeerEndpoint;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.renderer.rev151103.renderers.renderer.renderer.policy.status.UnconfiguredEndpointsBuilder;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.sxp.database.rev160308.Sgt;
  47 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
  48 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  49 import org.slf4j.Logger;
  50 import org.slf4j.LoggerFactory;
  51
  52 public class PolicyManagerImpl implements PolicyManager {
  53
  54     private static final Logger LOG = LoggerFactory.getLogger(PolicyManagerImpl.class);
  55     public static final RendererName IOS_XE_RENDERER = new RendererName("ios-xe-renderer");
  56     private static final String BASE_POLICY_MAP_NAME = "service-chains-";
  57     private final DataBroker dataBroker;
  58     private final NodeManager nodeManager;
  59     private final EPToSgtMapper epToSgtMapper;
  60
  61     public PolicyManagerImpl(final DataBroker dataBroker,
  62                              final NodeManager nodeManager, final EPToSgtMapper epToSgtMapper) {
  63         this.dataBroker = Preconditions.checkNotNull(dataBroker);
  64         this.nodeManager = Preconditions.checkNotNull(nodeManager);
  65         this.epToSgtMapper = Preconditions.checkNotNull(epToSgtMapper);
  66     }
  67
  68     @Override
  69     @Nonnull
  70     public ListenableFuture<Boolean> syncPolicy(@Nullable final Configuration dataAfter, @Nullable final Configuration dataBefore,
  71                                                 final long version) {
  72         ListenableFuture<Optional<Status>> creationResult;
  73         if (dataBefore == null && dataAfter != null) {
  74             creationResult = syncEndpoints(dataAfter, Create);
  75         } else if (dataBefore != null && dataAfter == null) {
  76             creationResult = syncEndpoints(dataBefore, Delete);
  77         } else {
  78             final ListenableFuture<Optional<Status>> deletionResult = syncEndpoints(dataBefore, Delete);
  79             creationResult = Futures.transform(deletionResult, new AsyncFunction<Optional<Status>, Optional<Status>>() {
  80                 @Nonnull
  81                 @Override
  82                 public ListenableFuture<Optional<Status>> apply(@Nonnull Optional<Status> deletionResult) throws Exception {
  83                     if (deletionResult.isPresent()) {
  84                         // Wait till task is done. Result is not used, delete case has no status
  85                         deletionResult.get();
  86                     }
  87                     return syncEndpoints(dataAfter, Create);
  88                 }
  89             });
  90         }
  91         return Futures.transform(creationResult, new AsyncFunction<Optional<Status>, Boolean>() {
  92             @Override
  93             public ListenableFuture<Boolean> apply(@Nullable final Optional<Status> statusValue) throws Exception {
  94                 Preconditions.checkArgument(statusValue != null, "provided status must not be null");
  95                 return Futures.transform(reportPolicy(version, statusValue), new Function<Void, Boolean>() {
  96                     @Override
  97                     public Boolean apply(@Nullable final Void input) {
  98                         return Boolean.TRUE;
  99                     }
 100                 });
 101             }
 102         });
 103     }
 104
 105     /**
 106      * Resolve policy for all endpoint pairs
 107      *
 108      * @param dataAfter - data used while processing
 109      * @param action    - specifies whether data are intended for creating or removing of configuration
 110      * @return status of policy resolution
 111      */
 112     @Nonnull
 113     private ListenableFuture<Optional<Status>> syncEndpoints(final Configuration dataAfter, final DsAction action) {
 114         if (dataAfter.getRendererEndpoints() == null
 115                 || dataAfter.getRendererEndpoints().getRendererEndpoint() == null) {
 116             LOG.debug("No configuration obtained - skipping");
 117             return Futures.immediateFuture(Optional.empty());
 118         }
 119         final PolicyConfigurationContext context = new PolicyConfigurationContext();
 120         // Renderer endpoint
 121         for (RendererEndpoint rendererEndpoint : dataAfter.getRendererEndpoints().getRendererEndpoint()) {
 122             context.setCurrentRendererEP(rendererEndpoint);
 123
 124             if (dataAfter.getEndpoints() == null || dataAfter.getEndpoints().getAddressEndpointWithLocation() == null) {
 125                 final String info = "Renderer-endpoint: missing address-endpoint-with-location";
 126                 context.appendUnconfiguredRendererEP(StatusUtil.assembleFullyNotConfigurableRendererEP(context, info));
 127                 continue;
 128             }
 129             final List<AddressEndpointWithLocation> endpointsWithLocation = dataAfter.getEndpoints()
 130                     .getAddressEndpointWithLocation();
 131             final InstanceIdentifier mountpointIid = PolicyManagerUtil.getMountpointIidFromAbsoluteLocation(rendererEndpoint, endpointsWithLocation);
 132             final DataBroker mountpoint = nodeManager.getNodeMountPoint(mountpointIid);
 133             if (mountpoint == null) {
 134                 final String info = String.format("No data-broker for mount-point [%s] available", mountpointIid);
 135                 context.appendUnconfiguredRendererEP(StatusUtil.assembleFullyNotConfigurableRendererEP(context, info));
 136                 continue;
 137             }
 138             final Optional<String> optionalManagementIpAddress = nodeManager.getNodeManagementIpByMountPointIid(mountpointIid);
 139             if (!optionalManagementIpAddress.isPresent()) {
 140                 final String info = String.format("Can not create policyWriter, managementIpAddress for mountpoint %s is null",
 141                         mountpointIid);
 142                 context.appendUnconfiguredRendererEP(StatusUtil.assembleFullyNotConfigurableRendererEP(context, info));
 143                 continue;
 144             }
 145             final String managementIpAddress = optionalManagementIpAddress.get();
 146             final String interfaceName = PolicyManagerUtil.getInterfaceNameFromAbsoluteLocation(rendererEndpoint, endpointsWithLocation);
 147             final NodeId nodeId = nodeManager.getNodeIdByMountpointIid(mountpointIid);
 148             if (interfaceName == null || nodeId == null) {
 149                 final String info = String.format("Cannot compose policy-map, missing value. Interface: %s, NodeId: %s", interfaceName, nodeId);
 150                 context.appendUnconfiguredRendererEP(StatusUtil.assembleFullyNotConfigurableRendererEP(context, info));
 151                 LOG.warn(info);
 152                 continue;
 153             }
 154             final String policyMapName = BASE_POLICY_MAP_NAME.concat(interfaceName);
 155             final PolicyMapLocation policyMapLocation = new PolicyMapLocation(policyMapName, interfaceName, nodeId,
 156                     managementIpAddress, mountpoint);
 157             context.setPolicyMapLocation(policyMapLocation);
 158
 159             // TODO: pull timeout for async ops from config
 160             final long TIMEOUT = 10;
 161             final TimeUnit UNIT = TimeUnit.SECONDS;
 162
 163             final Sgt sourceSgt = PolicyManagerUtil.findSgtTag(epToSgtMapper, rendererEndpoint, dataAfter.getEndpoints()
 164                     .getAddressEndpointWithLocation(), TIMEOUT, UNIT);
 165             // Peer Endpoint
 166             for (PeerEndpoint peerEndpoint : rendererEndpoint.getPeerEndpoint()) {
 167                 final Sgt destinationSgt = PolicyManagerUtil.findSgtTag(epToSgtMapper, peerEndpoint, dataAfter.getEndpoints()
 168                         .getAddressEndpointWithLocation(), TIMEOUT, UNIT);
 169                 if (sourceSgt == null || destinationSgt == null) {
 170                     final String info = String.format("Endpoint-policy: missing sgt value(sourceSgt=%s, destinationSgt=%s)",
 171                             sourceSgt, destinationSgt);
 172                     context.appendUnconfiguredRendererEP(
 173                             StatusUtil.assembleNotConfigurableRendererEPForPeer(context, peerEndpoint, info));
 174                     continue;
 175                 }
 176                 // Resolve policy between endpoints
 177                 if (action.equals(Create)) {
 178                     LOG.debug("Setting up policy between endpoint {}, sgt: {} and peer {}, sgt: {}", rendererEndpoint,
 179                             sourceSgt, peerEndpoint, destinationSgt);
 180                     PolicyManagerUtil.syncEndpointPairCreatePolicy(sourceSgt, destinationSgt, context, dataAfter,
 181                             peerEndpoint, dataBroker);
 182                 } else {
 183                     LOG.debug("Removing policy between endpoint {}, sgt: {} and peer {}, sgt: {}", rendererEndpoint,
 184                             sourceSgt, peerEndpoint, destinationSgt);
 185                     PolicyManagerUtil.syncEndpointPairRemovePolicy(sourceSgt, destinationSgt, context, dataAfter,
 186                             peerEndpoint);
 187                 }
 188             }
 189         }
 190         final ListenableFuture<List<Boolean>> cumulativeResult = context.getCumulativeResult();
 191         return Futures.transform(cumulativeResult, new Function<List<Boolean>, Optional<Status>>() {
 192             @Nullable
 193             @Override
 194             public Optional<Status> apply(@Nullable final List<Boolean> input) {
 195                 //TODO: inspect if all booleans are true
 196
 197                 LOG.trace("considering all submits as successful - otherwise there will be exception");
 198                 final Status status = new StatusBuilder()
 199                         .setUnconfiguredEndpoints(new UnconfiguredEndpointsBuilder()
 200                                 .setUnconfiguredRendererEndpoint(context.getUnconfiguredRendererEPBag())
 201                                 .build())
 202                         .build();
 203
 204                 return Optional.of(status);
 205             }
 206         });
 207     }
 208
 209     private CheckedFuture<Void, TransactionCommitFailedException> reportPolicy(final long version,
 210                                                                                @Nonnull final Optional<Status> statusValue) {
 211         if (statusValue.isPresent()) {
 212             LOG.warn("IOS-XE renderer: operation not successfully completed, check unconfigured policy in operational/renderer:renderers");
 213         }
 214         final ReadWriteTransaction readWriteTransaction = dataBroker.newReadWriteTransaction();
 215         final InstanceIdentifier<RendererPolicy> iid = InstanceIdentifier.create(Renderers.class)
 216                 .child(Renderer.class, new RendererKey(IOS_XE_RENDERER))
 217                 .child(RendererPolicy.class);
 218         final RendererPolicy rendererPolicy = new RendererPolicyBuilder()
 219                 .setVersion(version)
 220                 .setStatus(statusValue.orElse(null))
 221                 .build();
 222         readWriteTransaction.merge(LogicalDatastoreType.OPERATIONAL, iid, rendererPolicy);
 223         return readWriteTransaction.submit();
 224     }
 225
 226     @Override
 227     public void close() {
 228         //NOOP
 229     }
 230
 231     enum DsAction {Create, Delete}
 232
 233     public enum ActionCase {ALLOW, CHAIN}
 234
 235     /**
 236      * Wrapper class - contains all necessary information to clearly localize policy-map/interface/node in network
 237      */
 238     public static class PolicyMapLocation {
 239
 240         private final String policyMapName;
 241         private final String interfaceName;
 242         private final NodeId nodeId;
 243         private final String managementIpAddress;
 244         private final DataBroker mountpoint;
 245
 246         public PolicyMapLocation(final String policyMapName, final String interfaceName, final NodeId nodeId,
 247                                  final String managementIpAddress, final DataBroker mountpoint) {
 248             this.policyMapName = Preconditions.checkNotNull(policyMapName);
 249             this.interfaceName = Preconditions.checkNotNull(interfaceName);
 250             this.nodeId = Preconditions.checkNotNull(nodeId);
 251             this.managementIpAddress = Preconditions.checkNotNull(managementIpAddress);
 252             this.mountpoint = Preconditions.checkNotNull(mountpoint);
 253         }
 254
 255         public String getPolicyMapName() {
 256             return policyMapName;
 257         }
 258
 259         public String getInterfaceName() {
 260             return interfaceName;
 261         }
 262
 263         public NodeId getNodeId() {
 264             return nodeId;
 265         }
 266
 267         public String getManagementIpAddress() {
 268             return managementIpAddress;
 269         }
 270
 271         public DataBroker getMountpoint() {
 272             return mountpoint;
 273         }
 274     }
 275 }