bgp/openconfig-rp-impl/src/main/java/org/opendaylight/protocol/bgp/openconfig/routing/policy/impl/BGPRibPolicyImpl.java

   1 /*
   2  * Copyright (c) 2018 AT&T Intellectual Property. 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.protocol.bgp.openconfig.routing.policy.impl;
  10
  11 import static java.util.Objects.requireNonNull;
  12 import static org.opendaylight.protocol.bgp.openconfig.routing.policy.spi.registry.RouteAttributeContainer.routeAttributeContainerFalse;
  13
  14 import com.google.common.cache.CacheBuilder;
  15 import com.google.common.cache.CacheLoader;
  16 import com.google.common.cache.LoadingCache;
  17 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
  18 import java.util.Collections;
  19 import java.util.List;
  20 import java.util.Optional;
  21 import java.util.concurrent.ExecutionException;
  22 import org.opendaylight.mdsal.binding.api.DataBroker;
  23 import org.opendaylight.mdsal.binding.api.ReadTransaction;
  24 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  25 import org.opendaylight.protocol.bgp.openconfig.routing.policy.spi.RouteEntryBaseAttributes;
  26 import org.opendaylight.protocol.bgp.openconfig.routing.policy.spi.registry.RouteAttributeContainer;
  27 import org.opendaylight.protocol.bgp.openconfig.routing.policy.spi.registry.StatementRegistryConsumer;
  28 import org.opendaylight.protocol.bgp.rib.spi.policy.BGPRibRoutingPolicy;
  29 import org.opendaylight.protocol.bgp.rib.spi.policy.BGPRouteEntryExportParameters;
  30 import org.opendaylight.protocol.bgp.rib.spi.policy.BGPRouteEntryImportParameters;
  31 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.types.rev151009.AfiSafiType;
  32 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.routing.policy.rev151009.DefaultPolicyType;
  33 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.routing.policy.rev151009.apply.policy.group.apply.policy.Config;
  34 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.routing.policy.rev151009.routing.policy.top.RoutingPolicy;
  35 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.routing.policy.rev151009.routing.policy.top.routing.policy.PolicyDefinitions;
  36 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.routing.policy.rev151009.routing.policy.top.routing.policy.policy.definitions.PolicyDefinition;
  37 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.routing.policy.rev151009.routing.policy.top.routing.policy.policy.definitions.PolicyDefinitionKey;
  38 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.routing.policy.rev151009.routing.policy.top.routing.policy.policy.definitions.policy.definition.Statements;
  39 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.routing.policy.rev151009.routing.policy.top.routing.policy.policy.definitions.policy.definition.statements.Statement;
  40 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.path.attributes.Attributes;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev180329.ClusterIdentifier;
  43 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  44
  45 final class BGPRibPolicyImpl implements BGPRibRoutingPolicy {
  46     private static final InstanceIdentifier<RoutingPolicy> ROUTING_POLICY_IID
  47             = InstanceIdentifier.create(RoutingPolicy.class);
  48     private static final List<String> DEFAULT_IMPORT_POLICY = Collections.singletonList("default-odl-import-policy");
  49     private static final List<String> DEFAULT_EXPORT_POLICY = Collections.singletonList("default-odl-export-policy");
  50     private final DefaultPolicyType defaultExportPolicy;
  51     private final DefaultPolicyType defaultImportPolicy;
  52     private final List<String> exportPolicy;
  53     private final List<String> importPolicy;
  54     private final StatementRegistryConsumer policyRegistry;
  55     private final RouteEntryBaseAttributes ribBaseParameters;
  56     private final DataBroker databroker;
  57     private final LoadingCache<String, List<Statement>> statements = CacheBuilder.newBuilder()
  58             .build(new CacheLoader<String, List<Statement>>() {
  59                 @Override
  60                 public List<Statement> load(final String key) throws ExecutionException, InterruptedException {
  61                     return loadStatements(key);
  62                 }
  63             });
  64
  65     BGPRibPolicyImpl(final DataBroker databroker, final StatementRegistryConsumer policyRegistry,
  66             final long localAs, final Ipv4Address originatorId, final ClusterIdentifier clusterId,
  67             final Config policyConfig) {
  68         this.policyRegistry = requireNonNull(policyRegistry);
  69         this.databroker = requireNonNull(databroker);
  70         requireNonNull(policyConfig);
  71
  72
  73         List<String> epolicy = policyConfig.getExportPolicy();
  74         if (epolicy == null) {
  75             epolicy = DEFAULT_EXPORT_POLICY;
  76         }
  77         List<String> ipolicy = policyConfig.getImportPolicy();
  78         if (ipolicy == null) {
  79             ipolicy = DEFAULT_IMPORT_POLICY;
  80         }
  81
  82         this.defaultExportPolicy = requireNonNull(policyConfig.getDefaultExportPolicy());
  83         this.defaultImportPolicy = requireNonNull(policyConfig.getDefaultImportPolicy());
  84         this.exportPolicy = requireNonNull(epolicy);
  85         this.importPolicy = requireNonNull(ipolicy);
  86         this.ribBaseParameters = new PolicyRIBBaseParametersImpl(localAs, originatorId, clusterId);
  87     }
  88
  89     @SuppressFBWarnings(value = "UPM_UNCALLED_PRIVATE_METHOD",
  90             justification = "https://github.com/spotbugs/spotbugs/issues/811")
  91     private List<Statement> loadStatements(final String key) throws ExecutionException, InterruptedException {
  92         final ReadTransaction tr = this.databroker.newReadOnlyTransaction();
  93         final Optional<Statements> result =
  94                 tr.read(LogicalDatastoreType.CONFIGURATION, ROUTING_POLICY_IID.child(PolicyDefinitions.class)
  95                         .child(PolicyDefinition.class, new PolicyDefinitionKey(key)).child(Statements.class)).get();
  96         if (!result.isPresent()) {
  97             return Collections.emptyList();
  98         }
  99         return result.get().getStatement();
 100     }
 101
 102     @Override
 103     public Optional<Attributes> applyImportPolicies(final BGPRouteEntryImportParameters policyParameters,
 104             final Attributes attributes, final Class<? extends AfiSafiType> afiSafiType) {
 105         RouteAttributeContainer currentAttributes = routeAttributeContainerFalse(attributes);
 106         for (final String policyName : this.importPolicy) {
 107             for (final Statement statement : this.statements.getUnchecked(policyName)) {
 108                 currentAttributes = this.policyRegistry
 109                         .applyImportStatement(this.ribBaseParameters, afiSafiType, policyParameters, currentAttributes,
 110                                 statement);
 111             }
 112         }
 113         if (!currentAttributes.anyConditionSatisfied()) {
 114             if (DefaultPolicyType.REJECTROUTE.equals(this.defaultImportPolicy)) {
 115                 return Optional.empty();
 116             }
 117         }
 118         return Optional.ofNullable(currentAttributes.getAttributes());
 119     }
 120
 121     @Override
 122     public Optional<Attributes> applyExportPolicies(final BGPRouteEntryExportParameters policyParameters,
 123             final Attributes attributes, final Class<? extends AfiSafiType> afiSafi) {
 124         RouteAttributeContainer currentAttributes = routeAttributeContainerFalse(attributes);
 125         for (final String policyName : this.exportPolicy) {
 126             for (final Statement statement : this.statements.getUnchecked(policyName)) {
 127                 currentAttributes = this.policyRegistry.applyExportStatement(
 128                         this.ribBaseParameters, afiSafi, policyParameters, currentAttributes, statement);
 129             }
 130         }
 131         if (!currentAttributes.anyConditionSatisfied()) {
 132             if (DefaultPolicyType.REJECTROUTE.equals(this.defaultExportPolicy)) {
 133                 return Optional.empty();
 134             }
 135         }
 136
 137         return Optional.ofNullable(currentAttributes.getAttributes());
 138     }
 139 }