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