bgp/openconfig-rp-statement/src/main/java/org/opendaylight/protocol/bgp/openconfig/routing/policy/statement/conditions/MatchBgpNeighborSetHandler.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.statement.conditions;
   9
  10 import static java.util.Objects.requireNonNull;
  11
  12 import com.google.common.cache.CacheBuilder;
  13 import com.google.common.cache.CacheLoader;
  14 import com.google.common.cache.LoadingCache;
  15 import com.google.common.util.concurrent.FluentFuture;
  16 import java.util.List;
  17 import java.util.Optional;
  18 import java.util.concurrent.ExecutionException;
  19 import java.util.stream.Collectors;
  20 import org.apache.commons.lang3.StringUtils;
  21 import org.opendaylight.mdsal.binding.api.DataBroker;
  22 import org.opendaylight.mdsal.binding.api.ReadTransaction;
  23 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  24 import org.opendaylight.protocol.bgp.openconfig.routing.policy.spi.RouteEntryBaseAttributes;
  25 import org.opendaylight.protocol.bgp.openconfig.routing.policy.spi.policy.condition.BgpConditionsAugmentationPolicy;
  26 import org.opendaylight.protocol.bgp.rib.spi.RouterIds;
  27 import org.opendaylight.protocol.bgp.rib.spi.policy.BGPRouteEntryExportParameters;
  28 import org.opendaylight.protocol.bgp.rib.spi.policy.BGPRouteEntryImportParameters;
  29 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.types.rev151009.AfiSafiType;
  30 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.policy.types.rev151009.MatchSetOptionsRestrictedType;
  31 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.routing.policy.rev151009.OpenconfigRoutingPolicyData;
  32 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.routing.policy.rev151009.generic.defined.sets.NeighborSets;
  33 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.routing.policy.rev151009.neighbor.set.NeighborSet;
  34 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.routing.policy.rev151009.neighbor.set.NeighborSetKey;
  35 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.routing.policy.rev151009.routing.policy.top.RoutingPolicy;
  36 import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.routing.policy.rev151009.routing.policy.top.routing.policy.DefinedSets;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.path.attributes.Attributes;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.PeerId;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.odl.bgp._default.policy.rev200120.BgpNeighbor;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.odl.bgp._default.policy.rev200120.MatchBgpNeighborCondition;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.odl.bgp._default.policy.rev200120.match.bgp.neighbor.grouping.MatchBgpNeighborSet;
  42 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  43
  44 /**
  45  * Match a set of Neighbors(ip address) (ANY, INVERT).
  46  */
  47 public final class MatchBgpNeighborSetHandler
  48         implements BgpConditionsAugmentationPolicy<MatchBgpNeighborCondition, Void> {
  49     private static final InstanceIdentifier<NeighborSets> NEIGHBOR_SET_IID =
  50         InstanceIdentifier.builderOfInherited(OpenconfigRoutingPolicyData.class, RoutingPolicy.class).build()
  51             .child(DefinedSets.class)
  52             .child(NeighborSets.class);
  53     private final DataBroker dataBroker;
  54     private final LoadingCache<String, List<PeerId>> peerSets = CacheBuilder.newBuilder()
  55             .build(new CacheLoader<>() {
  56                 @Override
  57                 public List<PeerId> load(final String key) throws ExecutionException, InterruptedException {
  58                     return loadRoleSets(key);
  59                 }
  60             });
  61
  62     public MatchBgpNeighborSetHandler(final DataBroker dataBroker) {
  63         this.dataBroker = requireNonNull(dataBroker);
  64     }
  65
  66     private List<PeerId> loadRoleSets(final String key) throws ExecutionException, InterruptedException {
  67         final FluentFuture<Optional<NeighborSet>> future;
  68         try (ReadTransaction tr = dataBroker.newReadOnlyTransaction()) {
  69             future = tr.read(LogicalDatastoreType.CONFIGURATION,
  70                     NEIGHBOR_SET_IID.child(NeighborSet.class, new NeighborSetKey(key)));
  71
  72         }
  73         return future.get().map(neighboursSet -> neighboursSet.getNeighbor().values().stream()
  74                                                          .map(nei -> RouterIds.createPeerId(nei.getAddress()))
  75                                                          .collect(Collectors.toUnmodifiableList())).orElse(List.of());
  76     }
  77
  78     @Override
  79     public boolean matchImportCondition(
  80             final AfiSafiType afiSafi,
  81             final RouteEntryBaseAttributes routeEntryInfo,
  82             final BGPRouteEntryImportParameters importParameters,
  83             final Void nonAttributres,
  84             final MatchBgpNeighborCondition conditions) {
  85         return matchBgpNeighborSetCondition(importParameters.getFromPeerId(), null,
  86                 conditions.getMatchBgpNeighborSet());
  87     }
  88
  89     @Override
  90     public boolean matchExportCondition(
  91             final AfiSafiType afiSafi,
  92             final RouteEntryBaseAttributes routeEntryInfo,
  93             final BGPRouteEntryExportParameters exportParameters,
  94             final Void nonAttributres,
  95             final MatchBgpNeighborCondition conditions) {
  96         return matchBgpNeighborSetCondition(exportParameters.getFromPeerId(), exportParameters.getToPeerId(),
  97                 conditions.getMatchBgpNeighborSet());
  98     }
  99
 100     private boolean matchBgpNeighborSetCondition(
 101             final PeerId fromPeerId,
 102             final PeerId toPeerId,
 103             final MatchBgpNeighborSet matchBgpNeighborSet) {
 104
 105         final BgpNeighbor from = matchBgpNeighborSet.getFromNeighbor();
 106         Boolean match = null;
 107         if (from != null) {
 108             match = checkMatch(from.getNeighborSet(), fromPeerId, from.getMatchSetOptions());
 109         }
 110
 111         if (match != null && !match) {
 112             return false;
 113         }
 114
 115         final BgpNeighbor to = matchBgpNeighborSet.getToNeighbor();
 116         if (to != null) {
 117             match = checkMatch(to.getNeighborSet(), toPeerId, to.getMatchSetOptions());
 118         }
 119
 120         return match;
 121     }
 122
 123     private boolean checkMatch(
 124             final String neighborSetName,
 125             final PeerId peerId,
 126             final MatchSetOptionsRestrictedType matchSetOptions) {
 127         final List<PeerId> roles = peerSets.getUnchecked(StringUtils
 128                 .substringBetween(neighborSetName, "=\"", "\""));
 129
 130         final boolean found = roles.contains(peerId);
 131         if (MatchSetOptionsRestrictedType.ANY.equals(matchSetOptions)) {
 132             return found;
 133         }
 134         //INVERT
 135         return !found;
 136     }
 137
 138     @Override
 139     public Void getConditionParameter(final Attributes attributes) {
 140         return null;
 141     }
 142 }