X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=bgp%2Frib-impl%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fprotocol%2Fbgp%2Frib%2Fimpl%2FEffectiveRibInWriter.java;h=993b34f6938e3bbabb38eb5893491d7e3bd3dbf8;hb=0fdeddbe3d072a88428599421191f0f60b2864e4;hp=47fe64c2b11440d01fc3fb43698a3885390ae28a;hpb=0db61ee18b5c1ed3dc86c0f93121aba860932bbb;p=bgpcep.git diff --git a/bgp/rib-impl/src/main/java/org/opendaylight/protocol/bgp/rib/impl/EffectiveRibInWriter.java b/bgp/rib-impl/src/main/java/org/opendaylight/protocol/bgp/rib/impl/EffectiveRibInWriter.java index 47fe64c2b1..993b34f693 100644 --- a/bgp/rib-impl/src/main/java/org/opendaylight/protocol/bgp/rib/impl/EffectiveRibInWriter.java +++ b/bgp/rib-impl/src/main/java/org/opendaylight/protocol/bgp/rib/impl/EffectiveRibInWriter.java @@ -7,258 +7,627 @@ */ package org.opendaylight.protocol.bgp.rib.impl; -import com.google.common.base.Preconditions; -import com.google.common.base.Verify; +import static com.google.common.base.Verify.verify; +import static java.util.Objects.requireNonNull; +import static org.opendaylight.protocol.bgp.rib.spi.RIBNodeIdentifiers.ADJRIBIN_ATTRIBUTES_AID; +import static org.opendaylight.protocol.bgp.rib.spi.RIBNodeIdentifiers.ADJRIBIN_NID; +import static org.opendaylight.protocol.bgp.rib.spi.RIBNodeIdentifiers.ATTRIBUTES_NID; +import static org.opendaylight.protocol.bgp.rib.spi.RIBNodeIdentifiers.EFFRIBIN_NID; +import static org.opendaylight.protocol.bgp.rib.spi.RIBNodeIdentifiers.LLGR_STALE_NID; +import static org.opendaylight.protocol.bgp.rib.spi.RIBNodeIdentifiers.ROUTES_NID; +import static org.opendaylight.protocol.bgp.rib.spi.RIBNodeIdentifiers.TABLES_NID; +import static org.opendaylight.protocol.bgp.rib.spi.RIBNodeIdentifiers.UPTODATE_NID; + +import com.google.common.collect.ImmutableList; +import com.google.common.collect.ImmutableMap; +import com.google.common.collect.ImmutableSet; +import com.google.common.util.concurrent.FluentFuture; +import com.google.common.util.concurrent.FutureCallback; +import com.google.common.util.concurrent.MoreExecutors; +import edu.umd.cs.findbugs.annotations.SuppressFBWarnings; import java.util.Collection; -import javax.annotation.Nonnull; -import javax.annotation.concurrent.NotThreadSafe; -import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType; -import org.opendaylight.controller.md.sal.dom.api.DOMDataTreeChangeListener; -import org.opendaylight.controller.md.sal.dom.api.DOMDataTreeChangeService; -import org.opendaylight.controller.md.sal.dom.api.DOMDataTreeIdentifier; -import org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction; -import org.opendaylight.controller.md.sal.dom.api.DOMTransactionChain; +import java.util.List; +import java.util.Map; +import java.util.Optional; +import java.util.Set; +import java.util.concurrent.ExecutionException; +import java.util.concurrent.atomic.LongAdder; +import org.checkerframework.checker.lock.qual.GuardedBy; +import org.checkerframework.checker.lock.qual.Holding; +import org.opendaylight.mdsal.common.api.CommitInfo; +import org.opendaylight.mdsal.common.api.LogicalDatastoreType; +import org.opendaylight.mdsal.dom.api.ClusteredDOMDataTreeChangeListener; +import org.opendaylight.mdsal.dom.api.DOMDataTreeChangeService; +import org.opendaylight.mdsal.dom.api.DOMDataTreeIdentifier; +import org.opendaylight.mdsal.dom.api.DOMDataTreeWriteTransaction; +import org.opendaylight.mdsal.dom.api.DOMTransactionChain; +import org.opendaylight.protocol.bgp.openconfig.spi.BGPTableTypeRegistryConsumer; +import org.opendaylight.protocol.bgp.parser.impl.message.update.CommunityUtil; +import org.opendaylight.protocol.bgp.rib.impl.spi.RIB; import org.opendaylight.protocol.bgp.rib.impl.spi.RIBSupportContext; import org.opendaylight.protocol.bgp.rib.impl.spi.RIBSupportContextRegistry; +import org.opendaylight.protocol.bgp.rib.impl.spi.RibOutRefresh; +import org.opendaylight.protocol.bgp.rib.impl.state.peer.PrefixesInstalledCounters; +import org.opendaylight.protocol.bgp.rib.impl.state.peer.PrefixesReceivedCounters; +import org.opendaylight.protocol.bgp.rib.spi.RIBNormalizedNodes; import org.opendaylight.protocol.bgp.rib.spi.RIBSupport; -import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.open.bgp.parameters.optional.capabilities.c.parameters.graceful.restart._case.graceful.restart.capability.Tables; -import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.bgp.rib.rib.Peer; -import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.bgp.rib.rib.peer.AdjRibIn; -import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.bgp.rib.rib.peer.EffectiveRibIn; -import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.rib.tables.Routes; +import org.opendaylight.protocol.bgp.rib.spi.policy.BGPRibRoutingPolicy; +import org.opendaylight.protocol.bgp.rib.spi.policy.BGPRouteEntryImportParameters; +import org.opendaylight.protocol.bgp.route.targetcontrain.spi.ClientRouteTargetContrainCache; +import org.opendaylight.protocol.bgp.route.targetcontrain.spi.RouteTargetMembeshipUtil; +import org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.types.rev151009.AfiSafiType; +import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.path.attributes.Attributes; +import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.path.attributes.attributes.Communities; +import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.PeerRole; +import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.rib.TablesKey; +import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.route.target.constrain.rev180618.RouteTargetConstrainSubsequentAddressFamily; +import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.route.target.constrain.rev180618.route.target.constrain.routes.route.target.constrain.routes.RouteTargetConstrainRoute; +import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev200120.Ipv4AddressFamily; +import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev200120.Ipv6AddressFamily; +import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev200120.MplsLabeledVpnSubsequentAddressFamily; +import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev200120.RouteTarget; import org.opendaylight.yangtools.concepts.ListenerRegistration; import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier; -import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier; import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates; import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument; +import org.opendaylight.yangtools.yang.data.api.schema.ChoiceNode; import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode; +import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild; +import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode; +import org.opendaylight.yangtools.yang.data.api.schema.MapNode; +import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode; import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNodes; import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidate; import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidateNode; +import org.opendaylight.yangtools.yang.data.api.schema.tree.ModificationType; +import org.opendaylight.yangtools.yang.data.impl.schema.Builders; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** - * Implementation of the BGP import policy. Listens on all Adj-RIB-In, inspects all inbound + * Implementation of the BGP import policy. Listens on peer's Adj-RIB-In, inspects all inbound * routes in the context of the advertising peer's role and applies the inbound policy. * + *

* Inbound policy is applied as follows: * + *

* 1) if the peer is an eBGP peer, perform attribute replacement and filtering * 2) check if a route is admissible based on attributes attached to it, as well as the - * advertising peer's role + * advertising peer's role * 3) output admitting routes with edited attributes into /bgp-rib/rib/peer/effective-rib-in/tables/routes * - * Note that we maintain the peer roles using a DCL, even if we could look up our internal - * structures. This is done so we maintain causality and loose coupling. + *

+ * This class is NOT thread-safe. */ -@NotThreadSafe -final class EffectiveRibInWriter implements AutoCloseable { +final class EffectiveRibInWriter implements PrefixesReceivedCounters, PrefixesInstalledCounters, + AutoCloseable, ClusteredDOMDataTreeChangeListener { + private static final Logger LOG = LoggerFactory.getLogger(EffectiveRibInWriter.class); - private static final NodeIdentifier TABLE_ROUTES = new NodeIdentifier(Routes.QNAME); - - /** - * Maintains {@link TableRouteListener} instances. - */ - private final class AdjInTracker implements AutoCloseable, DOMDataTreeChangeListener { - private final RIBSupportContextRegistry registry; - private final YangInstanceIdentifier ribId; - private final ListenerRegistration reg; - private final DOMTransactionChain chain; - - AdjInTracker(final DOMDataTreeChangeService service, final RIBSupportContextRegistry registry, final DOMTransactionChain chain, final YangInstanceIdentifier ribId) { - this.registry = Preconditions.checkNotNull(registry); - this.chain = Preconditions.checkNotNull(chain); - this.ribId = Preconditions.checkNotNull(ribId); - - final YangInstanceIdentifier tableId = ribId.node(Peer.QNAME).node(AdjRibIn.QNAME).node(Tables.QNAME); - final DOMDataTreeIdentifier treeId = new DOMDataTreeIdentifier(LogicalDatastoreType.OPERATIONAL, tableId); - this.reg = service.registerDataTreeChangeListener(treeId, this); + private static final TablesKey IVP4_VPN_TABLE_KEY = new TablesKey(Ipv4AddressFamily.class, + MplsLabeledVpnSubsequentAddressFamily.class); + private static final TablesKey IVP6_VPN_TABLE_KEY = new TablesKey(Ipv6AddressFamily.class, + MplsLabeledVpnSubsequentAddressFamily.class); + private static final ImmutableList STALE_LLGR_COMMUNUTIES = ImmutableList.of( + StaleCommunities.STALE_LLGR); + private static final Attributes STALE_LLGR_ATTRIBUTES = new org.opendaylight.yang.gen.v1.urn.opendaylight.params + .xml.ns.yang.bgp.message.rev200120.path.attributes.AttributesBuilder() + .setCommunities(STALE_LLGR_COMMUNUTIES) + .build(); + private static final ChoiceNode EMPTY_ROUTES = Builders.choiceBuilder().withNodeIdentifier(ROUTES_NID).build(); + + private final RIBSupportContextRegistry registry; + private final YangInstanceIdentifier peerIId; + private final YangInstanceIdentifier effRibTables; + private final DOMDataTreeChangeService service; + private final List rtMemberships; + private final RibOutRefresh vpnTableRefresher; + private final ClientRouteTargetContrainCache rtCache; + private ListenerRegistration reg; + private DOMTransactionChain chain; + private final Map prefixesReceived; + private final Map prefixesInstalled; + private final BGPRibRoutingPolicy ribPolicies; + private final BGPRouteEntryImportParameters peerImportParameters; + private final BGPTableTypeRegistryConsumer tableTypeRegistry; + @GuardedBy("this") + private FluentFuture submitted; + private boolean rtMembershipsUpdated; + + EffectiveRibInWriter( + final BGPRouteEntryImportParameters peer, + final RIB rib, + final DOMTransactionChain chain, + final YangInstanceIdentifier peerIId, + final Set tables, + final BGPTableTypeRegistryConsumer tableTypeRegistry, + final List rtMemberships, + final ClientRouteTargetContrainCache rtCache) { + this.registry = requireNonNull(rib.getRibSupportContext()); + this.chain = requireNonNull(chain); + this.peerIId = requireNonNull(peerIId); + this.effRibTables = this.peerIId.node(EFFRIBIN_NID); + this.prefixesInstalled = buildPrefixesTables(tables); + this.prefixesReceived = buildPrefixesTables(tables); + this.ribPolicies = requireNonNull(rib.getRibPolicies()); + this.service = requireNonNull(rib.getService()); + this.tableTypeRegistry = requireNonNull(tableTypeRegistry); + this.peerImportParameters = peer; + this.rtMemberships = rtMemberships; + this.rtCache = rtCache; + this.vpnTableRefresher = rib; + } + + public void init() { + final DOMDataTreeIdentifier treeId = new DOMDataTreeIdentifier(LogicalDatastoreType.OPERATIONAL, + this.peerIId.node(ADJRIBIN_NID).node(TABLES_NID)); + LOG.debug("Registered Effective RIB on {}", this.peerIId); + this.reg = requireNonNull(this.service).registerDataTreeChangeListener(treeId, this); + } + + private static Map buildPrefixesTables(final Set tables) { + final ImmutableMap.Builder b = ImmutableMap.builder(); + tables.forEach(table -> b.put(table, new LongAdder())); + return b.build(); + } + + @Override + public synchronized void onDataTreeChanged(final Collection changes) { + if (this.chain == null) { + LOG.trace("Chain closed. Ignoring Changes : {}", changes); + return; } - private void processRoute(final DOMDataWriteTransaction tx, final RIBSupport ribSupport, final AbstractImportPolicy policy, final YangInstanceIdentifier routesPath, final DataTreeCandidateNode route) { - LOG.debug("Process route {}", route); - switch (route.getModificationType()) { - case DELETE: - // Delete has already been affected by the store in caller, so this is a no-op. - break; - case MERGE: - LOG.info("Merge on {} reported, this should never have happened, ignoring", route); - break; - case UNMODIFIED: - // No-op - break; - case SUBTREE_MODIFIED: - case WRITE: - // Lookup per-table attributes from RIBSupport - final ContainerNode adverisedAttrs = (ContainerNode) NormalizedNodes.findNode(route.getDataAfter(), ribSupport.routeAttributesIdentifier()).orNull(); - final ContainerNode effectiveAttrs; - - if (adverisedAttrs != null) { - effectiveAttrs = policy.effectiveAttributes(adverisedAttrs); - - /* - * Speed hack: if we determine that the policy has passed the attributes - * back unmodified, the corresponding change has already been written in - * our caller. There is no need to perform any further processing. - * - * We also use direct object comparison to make the check very fast, as - * it may not be that common, in which case it does not make sense to pay - * the full equals price. - */ - if (effectiveAttrs == adverisedAttrs) { - return; - } - } else { - effectiveAttrs = null; + LOG.trace("Data changed called to effective RIB. Change : {}", changes); + DOMDataTreeWriteTransaction tx = null; + for (final DataTreeCandidate tc : changes) { + final YangInstanceIdentifier rootPath = tc.getRootPath(); + final DataTreeCandidateNode root = tc.getRootNode(); + for (final DataTreeCandidateNode table : root.getChildNodes()) { + if (tx == null) { + tx = this.chain.newWriteOnlyTransaction(); } + changeDataTree(tx, rootPath, root, table); + } + } - final YangInstanceIdentifier routeId = ribSupport.routePath(routesPath, route.getIdentifier()); - LOG.debug("Route {} effective attributes {} towards {}", route.getIdentifier(), effectiveAttrs, routeId); + if (tx != null) { + final FluentFuture future = tx.commit(); + this.submitted = future; + future.addCallback(new FutureCallback() { + @Override + public void onSuccess(final CommitInfo result) { + LOG.trace("Successful commit"); + } - if (effectiveAttrs != null) { - tx.put(LogicalDatastoreType.OPERATIONAL, routeId.node(ribSupport.routeAttributesIdentifier()), effectiveAttrs); - } else { - LOG.warn("Route {} advertised empty attributes", route.getDataAfter()); - tx.delete(LogicalDatastoreType.OPERATIONAL, routeId); + @Override + public void onFailure(final Throwable trw) { + LOG.error("Failed commit", trw); } + }, MoreExecutors.directExecutor()); + } + + //Refresh VPN Table if RT Memberships were updated + if (this.rtMembershipsUpdated) { + this.vpnTableRefresher.refreshTable(IVP4_VPN_TABLE_KEY, this.peerImportParameters.getFromPeerId()); + this.vpnTableRefresher.refreshTable(IVP6_VPN_TABLE_KEY, this.peerImportParameters.getFromPeerId()); + this.rtMembershipsUpdated = false; + } + } + + @Override + public synchronized void close() { + if (this.reg != null) { + this.reg.close(); + this.reg = null; + } + if (this.submitted != null) { + try { + this.submitted.get(); + } catch (final InterruptedException | ExecutionException throwable) { + LOG.error("Write routes failed", throwable); + } + } + if (this.chain != null) { + this.chain.close(); + this.chain = null; + } + this.prefixesReceived.values().forEach(LongAdder::reset); + this.prefixesInstalled.values().forEach(LongAdder::reset); + } + + @Override + public long getPrefixedReceivedCount(final TablesKey tablesKey) { + final LongAdder counter = this.prefixesReceived.get(tablesKey); + if (counter == null) { + return 0; + } + return counter.longValue(); + } + + @Override + public Set getTableKeys() { + return ImmutableSet.copyOf(this.prefixesReceived.keySet()); + } + + @Override + public boolean isSupported(final TablesKey tablesKey) { + return this.prefixesReceived.containsKey(tablesKey); + } + + @Override + public long getPrefixedInstalledCount(final TablesKey tablesKey) { + final LongAdder counter = this.prefixesInstalled.get(tablesKey); + if (counter == null) { + return 0; + } + return counter.longValue(); + } + + @Override + public long getTotalPrefixesInstalled() { + return this.prefixesInstalled.values().stream().mapToLong(LongAdder::longValue).sum(); + } + + @Holding("this") + private void changeDataTree(final DOMDataTreeWriteTransaction tx, final YangInstanceIdentifier rootPath, + final DataTreeCandidateNode root, final DataTreeCandidateNode table) { + final PathArgument lastArg = table.getIdentifier(); + verify(lastArg instanceof NodeIdentifierWithPredicates, "Unexpected type %s in path %s", lastArg.getClass(), + rootPath); + final NodeIdentifierWithPredicates tableKey = (NodeIdentifierWithPredicates) lastArg; + final RIBSupportContext ribContext = this.registry.getRIBSupportContext(tableKey); + if (ribContext == null) { + LOG.warn("Table {} is not supported, ignoring event", tableKey); + return; + } + + final YangInstanceIdentifier effectiveTablePath = effectiveTablePath(tableKey); + final ModificationType modificationType = root.getModificationType(); + LOG.debug("Effective table {} modification type {}", effectiveTablePath, modificationType); + switch (modificationType) { + case DISAPPEARED: + case DELETE: + deleteTable(tx, ribContext, effectiveTablePath, table); + break; + case APPEARED: + case WRITE: + writeTable(tx, ribContext, effectiveTablePath, table); + break; + case SUBTREE_MODIFIED: + modifyTable(tx, ribContext, effectiveTablePath, table); + break; + case UNMODIFIED: + LOG.info("Ignoring spurious notification on {} data {}", rootPath, table); break; default: - LOG.warn("Ignoring unhandled route {}", route); + LOG.warn("Ignoring unhandled root {}", table); break; - } } + } - private void processTableChildren(final DOMDataWriteTransaction tx, final RIBSupport ribSupport, final NodeIdentifierWithPredicates peerKey, final YangInstanceIdentifier tablePath, final Collection children) { - final AbstractImportPolicy policy = EffectiveRibInWriter.this.peerPolicyTracker.policyFor(IdentifierUtils.peerId(peerKey)); + private void deleteTable(final DOMDataTreeWriteTransaction tx, final RIBSupportContext ribContext, + final YangInstanceIdentifier effectiveTablePath, final DataTreeCandidateNode table) { + LOG.debug("Delete Effective Table {}", effectiveTablePath); + onDeleteTable(ribContext.getRibSupport(), effectiveTablePath, table.getDataBefore()); + tx.delete(LogicalDatastoreType.OPERATIONAL, effectiveTablePath); + } - for (final DataTreeCandidateNode child : children) { - switch (child.getModificationType()) { - case DELETE: - tx.delete(LogicalDatastoreType.OPERATIONAL, tablePath.node(child.getIdentifier())); - break; - case MERGE: - LOG.info("Merge on {} reported, this should never have happened, ignoring", child); + private void modifyTable(final DOMDataTreeWriteTransaction tx, final RIBSupportContext ribContext, + final YangInstanceIdentifier effectiveTablePath, final DataTreeCandidateNode table) { + LOG.debug("Modify Effective Table {}", effectiveTablePath); + + final boolean wasLongLivedStale = isLongLivedStaleTable(table.getDataBefore()); + final boolean longLivedStale = isLongLivedStaleTable(table.getDataAfter()); + if (wasLongLivedStale != longLivedStale) { + LOG.debug("LLGR_STALE flag flipped {}, overwriting table {}", longLivedStale ? "ON" : "OFF", + effectiveTablePath); + writeTable(tx, ribContext, effectiveTablePath, table); + return; + } + + table.getModifiedChild(ATTRIBUTES_NID).ifPresent(modifiedAttrs -> { + final YangInstanceIdentifier effAttrsPath = effectiveTablePath.node(ATTRIBUTES_NID); + final Optional> optAttrsAfter = modifiedAttrs.getDataAfter(); + if (optAttrsAfter.isPresent()) { + tx.put(LogicalDatastoreType.OPERATIONAL, effAttrsPath, effectiveAttributes( + NormalizedNodes.findNode(optAttrsAfter.get(), UPTODATE_NID))); + } else { + tx.delete(LogicalDatastoreType.OPERATIONAL, effAttrsPath); + } + }); + + table.getModifiedChild(ROUTES_NID).ifPresent(modifiedRoutes -> { + final RIBSupport ribSupport = ribContext.getRibSupport(); + switch (modifiedRoutes.getModificationType()) { + case APPEARED: + case WRITE: + deleteRoutesBefore(tx, ribSupport, effectiveTablePath, modifiedRoutes); + // XXX: YANG Tools seems to have an issue stacking DELETE with child WRITE + tx.put(LogicalDatastoreType.OPERATIONAL, effectiveTablePath.node(ROUTES_NID), EMPTY_ROUTES); + writeRoutesAfter(tx, ribSupport, effectiveTablePath, modifiedRoutes.getDataAfter(), longLivedStale); break; - case UNMODIFIED: - // No-op + case DELETE: + case DISAPPEARED: + deleteRoutesBefore(tx, ribSupport, effectiveTablePath, modifiedRoutes); + tx.delete(LogicalDatastoreType.OPERATIONAL, effectiveTablePath.node(ROUTES_NID)); break; case SUBTREE_MODIFIED: - case WRITE: - tx.put(LogicalDatastoreType.OPERATIONAL, tablePath.node(child.getIdentifier()), child.getDataAfter().get()); - - // Routes are special, as they may end up being filtered. The previous put conveniently - // ensured that we have them in at target, so a subsequent delete will not fail :) - if (TABLE_ROUTES.equals(child.getIdentifier())) { - final YangInstanceIdentifier routesPath = tablePath.node(Routes.QNAME); - for (final DataTreeCandidateNode route : ribSupport.changedRoutes(child)) { - processRoute(tx, ribSupport, policy, routesPath, route); - } + for (DataTreeCandidateNode modifiedRoute : ribSupport.changedRoutes(modifiedRoutes)) { + processRoute(tx, ribSupport, effectiveTablePath, modifiedRoute, longLivedStale); } break; + case UNMODIFIED: + // No-op + return; default: - LOG.warn("Ignoring unhandled child {}", child); + LOG.warn("Ignoring modified routes {}", modifiedRoutes); break; - } } - } + }); + } + + private void writeTable(final DOMDataTreeWriteTransaction tx, final RIBSupportContext ribContext, + final YangInstanceIdentifier effectiveTablePath, final DataTreeCandidateNode table) { + LOG.debug("Write Effective Table {}", effectiveTablePath); + onDeleteTable(ribContext.getRibSupport(), effectiveTablePath, table.getDataBefore()); + + final Optional> maybeTableAfter = table.getDataAfter(); + if (maybeTableAfter.isPresent()) { + final MapEntryNode tableAfter = extractMapEntry(maybeTableAfter); + ribContext.createEmptyTableStructure(tx, effectiveTablePath); + + final Optional> maybeAttrsAfter = tableAfter.getChild(ATTRIBUTES_NID); + final boolean longLivedStale; + if (maybeAttrsAfter.isPresent()) { + final ContainerNode attrsAfter = extractContainer(maybeAttrsAfter); + longLivedStale = isLongLivedStale(attrsAfter); + tx.put(LogicalDatastoreType.OPERATIONAL, effectiveTablePath.node(ATTRIBUTES_NID), + effectiveAttributes(attrsAfter.getChild(UPTODATE_NID))); + } else { + longLivedStale = false; + } - private RIBSupportContext getRibSupport(final NodeIdentifierWithPredicates tableKey) { - return this.registry.getRIBSupportContext(tableKey); + writeRoutesAfter(tx, ribContext.getRibSupport(), effectiveTablePath, + NormalizedNodes.findNode(tableAfter, ROUTES_NID), longLivedStale); } + } - private YangInstanceIdentifier effectiveTablePath(final NodeIdentifierWithPredicates peerKey, final NodeIdentifierWithPredicates tableKey) { - return this.ribId.node(Peer.QNAME).node(peerKey).node(EffectiveRibIn.QNAME).node(tableKey); + // Performs house-keeping when the contents of a table is deleted + private void onDeleteTable(final RIBSupport ribSupport, final YangInstanceIdentifier effectiveTablePath, + final Optional> tableBefore) { + // Routes are special in that we need to process the to keep our counters accurate + final Optional> maybeRoutesBefore = findRoutesMap(ribSupport, + NormalizedNodes.findNode(tableBefore, ROUTES_NID)); + if (maybeRoutesBefore.isPresent()) { + onRoutesDeleted(ribSupport, effectiveTablePath, extractMap(maybeRoutesBefore).getValue()); } + } - private void modifyTable(final DOMDataWriteTransaction tx, final NodeIdentifierWithPredicates peerKey, final NodeIdentifierWithPredicates tableKey, final DataTreeCandidateNode table) { - final RIBSupportContext ribSupport = getRibSupport(tableKey); - final YangInstanceIdentifier tablePath = effectiveTablePath(peerKey, tableKey); + private void deleteRoutesBefore(final DOMDataTreeWriteTransaction tx, final RIBSupport ribSupport, + final YangInstanceIdentifier effectiveTablePath, final DataTreeCandidateNode modifiedRoutes) { + final Optional> maybeRoutesBefore = NormalizedNodes.findNode( + modifiedRoutes.getDataBefore(), ribSupport.relativeRoutesPath()); + if (maybeRoutesBefore.isPresent()) { + onRoutesDeleted(ribSupport, effectiveTablePath, extractMap(maybeRoutesBefore).getValue()); + } + } - processTableChildren(tx, ribSupport.getRibSupport(), peerKey, tablePath, table.getChildNodes()); + private void writeRoutesAfter(final DOMDataTreeWriteTransaction tx, final RIBSupport ribSupport, + final YangInstanceIdentifier effectiveTablePath, final Optional> routesAfter, + final boolean longLivedStale) { + final Optional> maybeRoutesAfter = NormalizedNodes.findNode(routesAfter, + ribSupport.relativeRoutesPath()); + if (maybeRoutesAfter.isPresent()) { + final YangInstanceIdentifier routesPath = routeMapPath(ribSupport, effectiveTablePath); + for (MapEntryNode routeAfter : extractMap(maybeRoutesAfter).getValue()) { + writeRoute(tx, ribSupport, routesPath.node(routeAfter.getIdentifier()), Optional.empty(), routeAfter, + longLivedStale); + } } + } - private void writeTable(final DOMDataWriteTransaction tx, final NodeIdentifierWithPredicates peerKey, final NodeIdentifierWithPredicates tableKey, final DataTreeCandidateNode table) { - final RIBSupportContext ribSupport = getRibSupport(tableKey); - final YangInstanceIdentifier tablePath = effectiveTablePath(peerKey, tableKey); + private void onRoutesDeleted(final RIBSupport ribSupport, + final YangInstanceIdentifier effectiveTablePath, final Collection deletedRoutes) { + if (ribSupport.getSafi() == RouteTargetConstrainSubsequentAddressFamily.class) { + final YangInstanceIdentifier routesPath = routeMapPath(ribSupport, effectiveTablePath); + for (final MapEntryNode routeBefore : deletedRoutes) { + deleteRouteTarget(ribSupport, routesPath.node(routeBefore.getIdentifier()), routeBefore); + } + this.rtMembershipsUpdated = true; + } - // Create an empty table - ribSupport.clearTable(tx,tablePath); + final TablesKey tablesKey = ribSupport.getTablesKey(); + CountersUtil.add(prefixesInstalled.get(tablesKey), tablesKey, -deletedRoutes.size()); + } - processTableChildren(tx, ribSupport.getRibSupport(), peerKey, tablePath, table.getChildNodes()); + private void processRoute(final DOMDataTreeWriteTransaction tx, final RIBSupport ribSupport, + final YangInstanceIdentifier routesPath, final DataTreeCandidateNode route, final boolean longLivedStale) { + LOG.debug("Process route {}", route.getIdentifier()); + final YangInstanceIdentifier routePath = ribSupport.routePath(routesPath, route.getIdentifier()); + switch (route.getModificationType()) { + case DELETE: + case DISAPPEARED: + deleteRoute(tx, ribSupport, routePath, route.getDataBefore().orElse(null)); + break; + case UNMODIFIED: + // No-op + break; + case APPEARED: + case SUBTREE_MODIFIED: + case WRITE: + writeRoute(tx, ribSupport, routePath, route.getDataBefore(), route.getDataAfter().get(), + longLivedStale); + break; + default: + LOG.warn("Ignoring unhandled route {}", route); + break; } + } - @Override - public void onDataTreeChanged(final Collection changes) { - LOG.trace("Data changed called to effective RIB. Change : {}", changes); - final DOMDataWriteTransaction tx = this.chain.newWriteOnlyTransaction(); + private void deleteRoute(final DOMDataTreeWriteTransaction tx, final RIBSupport ribSupport, + final YangInstanceIdentifier routeIdPath, final NormalizedNode route) { + handleRouteTarget(ModificationType.DELETE, ribSupport, routeIdPath, route); + tx.delete(LogicalDatastoreType.OPERATIONAL, routeIdPath); + LOG.debug("Route deleted. routeId={}", routeIdPath); + final TablesKey tablesKey = ribSupport.getTablesKey(); + CountersUtil.decrement(this.prefixesInstalled.get(tablesKey), tablesKey); + } + + private void writeRoute(final DOMDataTreeWriteTransaction tx, final RIBSupport ribSupport, + final YangInstanceIdentifier routePath, final Optional> routeBefore, + final NormalizedNode routeAfter, final boolean longLivedStale) { + final TablesKey tablesKey = ribSupport.getTablesKey(); + CountersUtil.increment(this.prefixesReceived.get(tablesKey), tablesKey); + // Lookup per-table attributes from RIBSupport + final ContainerNode advertisedAttrs = (ContainerNode) NormalizedNodes.findNode(routeAfter, + ribSupport.routeAttributesIdentifier()).orElse(null); + final Attributes routeAttrs = ribSupport.attributeFromContainerNode(advertisedAttrs); + final Optional optEffAtt; + // In case we want to add LLGR_STALE we do not process route through policies since it may be + // considered as received with LLGR_STALE from peer which is not true. + if (longLivedStale) { + // LLGR procedures are in effect. If the route is tagged with NO_LLGR, it needs to be removed. + final List effCommunities = routeAttrs.getCommunities(); + if (effCommunities != null && effCommunities.contains(CommunityUtil.NO_LLGR)) { + deleteRoute(tx, ribSupport, routePath, routeBefore.orElse(null)); + return; + } + optEffAtt = Optional.of(wrapLongLivedStale(routeAttrs)); + } else { + final Class afiSafiType + = tableTypeRegistry.getAfiSafiType(ribSupport.getTablesKey()).get(); + optEffAtt = this.ribPolicies + .applyImportPolicies(this.peerImportParameters, routeAttrs, afiSafiType); + } + if (!optEffAtt.isPresent()) { + deleteRoute(tx, ribSupport, routePath, routeBefore.orElse(null)); + return; + } + handleRouteTarget(ModificationType.WRITE, ribSupport, routePath, routeAfter); + tx.put(LogicalDatastoreType.OPERATIONAL, routePath, routeAfter); + CountersUtil.increment(this.prefixesInstalled.get(tablesKey), tablesKey); + + final YangInstanceIdentifier attPath = routePath.node(ribSupport.routeAttributesIdentifier()); + final Attributes attToStore = optEffAtt.get(); + if (!attToStore.equals(routeAttrs)) { + final ContainerNode finalAttribute = ribSupport.attributeToContainerNode(attPath, attToStore); + tx.put(LogicalDatastoreType.OPERATIONAL, attPath, finalAttribute); + } + } - for (final DataTreeCandidate tc : changes) { - final YangInstanceIdentifier rootPath = tc.getRootPath(); + private void addRouteTarget(final RouteTargetConstrainRoute rtc) { + final RouteTarget rtMembership = RouteTargetMembeshipUtil.getRT(rtc); + if (PeerRole.Ebgp != this.peerImportParameters.getFromPeerRole()) { + this.rtCache.cacheRoute(rtc); + } + this.rtMemberships.add(rtMembership); + } - // Obtain the peer's key - final NodeIdentifierWithPredicates peerKey = IdentifierUtils.peerKey(rootPath); + private void deleteRouteTarget(final RIBSupport ribSupport, final YangInstanceIdentifier routeIdPath, + final NormalizedNode route) { + deleteRouteTarget((RouteTargetConstrainRoute) ribSupport.fromNormalizedNode(routeIdPath, route)); + } - // Extract the table key, this should be safe based on the path where we subscribed, - // but let's verify explicitly. - final PathArgument lastArg = rootPath.getLastPathArgument(); - Verify.verify(lastArg instanceof NodeIdentifierWithPredicates, "Unexpected type %s in path %s", lastArg.getClass(), rootPath); - final NodeIdentifierWithPredicates tableKey = (NodeIdentifierWithPredicates) lastArg; + private void deleteRouteTarget(final RouteTargetConstrainRoute rtc) { + final RouteTarget rtMembership = RouteTargetMembeshipUtil.getRT(rtc); + if (PeerRole.Ebgp != this.peerImportParameters.getFromPeerRole()) { + this.rtCache.uncacheRoute(rtc); + } + this.rtMemberships.remove(rtMembership); + } - final DataTreeCandidateNode root = tc.getRootNode(); - switch (root.getModificationType()) { - case DELETE: - // delete the corresponding effective table - tx.delete(LogicalDatastoreType.OPERATIONAL, effectiveTablePath(peerKey, tableKey)); - break; - case MERGE: - // TODO: upstream API should never give us this, as it leaks how the delta was created. - LOG.info("Merge on {} reported, this should never have happened, but attempting to cope", rootPath); - modifyTable(tx, peerKey, tableKey, root); - break; - case SUBTREE_MODIFIED: - modifyTable(tx, peerKey, tableKey, root); - break; - case UNMODIFIED: - LOG.info("Ignoring spurious notification on {} data {}", rootPath, root); - break; - case WRITE: - writeTable(tx, peerKey, tableKey, root); - break; - default: - LOG.warn("Ignoring unhandled root {}", root); - break; - } + private void handleRouteTarget(final ModificationType modificationType, final RIBSupport ribSupport, + final YangInstanceIdentifier routeIdPath, final NormalizedNode route) { + if (ribSupport.getSafi() == RouteTargetConstrainSubsequentAddressFamily.class) { + final RouteTargetConstrainRoute rtc = + (RouteTargetConstrainRoute) ribSupport.fromNormalizedNode(routeIdPath, route); + if (ModificationType.DELETE == modificationType) { + deleteRouteTarget(rtc); + } else { + addRouteTarget(rtc); } + this.rtMembershipsUpdated = true; + } + } - tx.submit(); + @SuppressFBWarnings("UPM_UNCALLED_PRIVATE_METHOD") + private static Attributes wrapLongLivedStale(final Attributes attrs) { + if (attrs == null) { + return STALE_LLGR_ATTRIBUTES; } - @Override - public void close() { - // FIXME: wipe all effective routes? - this.reg.close(); + final List oldCommunities = attrs.getCommunities(); + final List newCommunities; + if (oldCommunities != null) { + if (oldCommunities.contains(StaleCommunities.STALE_LLGR)) { + return attrs; + } + newCommunities = StaleCommunities.create(oldCommunities); + } else { + newCommunities = STALE_LLGR_COMMUNUTIES; } + + return new org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120 + .path.attributes.AttributesBuilder(attrs).setCommunities(newCommunities).build(); } - private final ImportPolicyPeerTracker peerPolicyTracker; - private final AdjInTracker adjInTracker; + // XXX: this should be moved to YangInstanceIdentifier at some point + private static YangInstanceIdentifier concat(final YangInstanceIdentifier parent, final List args) { + YangInstanceIdentifier ret = parent; + for (PathArgument arg : args) { + ret = ret.node(arg); + } + return ret; + } - static EffectiveRibInWriter create(@Nonnull final DOMDataTreeChangeService service, @Nonnull final DOMTransactionChain chain, - @Nonnull final YangInstanceIdentifier ribId, @Nonnull final PolicyDatabase pd, @Nonnull final RIBSupportContextRegistry registry) { - return new EffectiveRibInWriter(service, chain, ribId, pd, registry); + private YangInstanceIdentifier effectiveTablePath(final NodeIdentifierWithPredicates tableKey) { + return this.effRibTables.node(TABLES_NID).node(tableKey); } - private EffectiveRibInWriter(final DOMDataTreeChangeService service, final DOMTransactionChain chain, final YangInstanceIdentifier ribId, - final PolicyDatabase pd, final RIBSupportContextRegistry registry) { + private static YangInstanceIdentifier routeMapPath(final RIBSupport ribSupport, + final YangInstanceIdentifier tablePath) { + return concat(tablePath.node(ROUTES_NID), ribSupport.relativeRoutesPath()); + } - this.peerPolicyTracker = new ImportPolicyPeerTracker(service, ribId, pd); - this.adjInTracker = new AdjInTracker(service, registry, chain, ribId); + private static Optional> findRoutesMap(final RIBSupport ribSupport, + final Optional> optRoutes) { + return NormalizedNodes.findNode(optRoutes, ribSupport.relativeRoutesPath()); } - @Override - public void close() { - this.adjInTracker.close(); - this.peerPolicyTracker.close(); + private static ContainerNode extractContainer(final Optional> optNode) { + final NormalizedNode node = optNode.get(); + verify(node instanceof ContainerNode, "Expected ContainerNode, got %s", node); + return (ContainerNode) node; + } + + private static MapNode extractMap(final Optional> optNode) { + final NormalizedNode node = optNode.get(); + verify(node instanceof MapNode, "Expected MapNode, got %s", node); + return (MapNode) node; + } + + private static MapEntryNode extractMapEntry(final Optional> optNode) { + final NormalizedNode node = optNode.get(); + verify(node instanceof MapEntryNode, "Expected MapEntryNode, got %s", node); + return (MapEntryNode) node; + } + + private static boolean isLongLivedStale(final ContainerNode attributes) { + return NormalizedNodes.findNode(attributes, ADJRIBIN_ATTRIBUTES_AID, LLGR_STALE_NID).isPresent(); + } + + private static boolean isLongLivedStaleTable(final Optional> optTable) { + final Optional> optAttributes = NormalizedNodes.findNode(optTable, ATTRIBUTES_NID); + return optAttributes.isPresent() ? isLongLivedStale(extractContainer(optAttributes)) : false; + } + + private static ContainerNode effectiveAttributes(final Optional> optUptodate) { + return optUptodate.map(leaf -> { + final Object value = leaf.getValue(); + verify(value instanceof Boolean, "Expected boolean uptodate, got %s", value); + return ((Boolean) value).booleanValue() ? RIBNormalizedNodes.UPTODATE_ATTRIBUTES + : RIBNormalizedNodes.NOT_UPTODATE_ATTRIBUTES; + }).orElse(RIBNormalizedNodes.NOT_UPTODATE_ATTRIBUTES); } }