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