*/
package org.opendaylight.protocol.bgp.rib.impl;
+import com.google.common.base.Optional;
import com.google.common.base.Preconditions;
import com.google.common.primitives.UnsignedInteger;
import java.util.Collection;
import java.util.HashMap;
import java.util.Map;
-import java.util.Map.Entry;
+import java.util.Set;
+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.ClusteredDOMDataTreeChangeListener;
+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 org.opendaylight.protocol.bgp.mode.api.PathSelectionMode;
+import org.opendaylight.protocol.bgp.mode.api.RouteEntry;
+import org.opendaylight.protocol.bgp.rib.impl.spi.RIBSupportContextRegistry;
+import org.opendaylight.protocol.bgp.rib.impl.stats.UnsignedInt32Counter;
+import org.opendaylight.protocol.bgp.rib.spi.ExportPolicyPeerTracker;
+import org.opendaylight.protocol.bgp.rib.spi.IdentifierUtils;
+import org.opendaylight.protocol.bgp.rib.spi.PeerExportGroup;
import org.opendaylight.protocol.bgp.rib.spi.RIBSupport;
+import org.opendaylight.protocol.bgp.rib.spi.RibSupportUtils;
+import org.opendaylight.protocol.bgp.rib.spi.RouterIds;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.PeerId;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.PeerRole;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.bgp.rib.rib.LocRib;
+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.EffectiveRibIn;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.rib.Tables;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.rib.TablesKey;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.rib.tables.Attributes;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.rib.tables.Routes;
+import org.opendaylight.yangtools.concepts.ListenerRegistration;
+import org.opendaylight.yangtools.yang.common.QName;
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.ContainerNode;
+import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
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.impl.schema.ImmutableNodes;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
-// FIXME: instantiate for each table, listen on wildcard peer and routes
@NotThreadSafe
-final class LocRibWriter implements AutoCloseable, DOMDataTreeChangeListener {
+final class LocRibWriter implements AutoCloseable, ClusteredDOMDataTreeChangeListener {
+
+ private static final Logger LOG = LoggerFactory.getLogger(LocRibWriter.class);
+
+ private static final LeafNode<Boolean> ATTRIBUTES_UPTODATE_TRUE = ImmutableNodes.leafNode(QName.create(Attributes.QNAME, "uptodate"), Boolean.TRUE);
+
private final Map<PathArgument, RouteEntry> routeEntries = new HashMap<>();
- private final YangInstanceIdentifier target;
+ private final YangInstanceIdentifier locRibTarget;
private final DOMTransactionChain chain;
- private final ExportPolicyPeerTracker peerPolicyTracker;
+ private final ExportPolicyPeerTracker exportPolicyPeerTracker;
private final NodeIdentifier attributesIdentifier;
private final Long ourAs;
-
- LocRibWriter(final RIBSupport ribSupport, final DOMTransactionChain chain, final YangInstanceIdentifier target, final Long ourAs) {
+ private final RIBSupport ribSupport;
+ private final TablesKey localTablesKey;
+ private final ListenerRegistration<LocRibWriter> reg;
+ private final PathSelectionMode pathSelectionMode;
+ private final UnsignedInt32Counter routeCounter;
+
+ private LocRibWriter(final RIBSupportContextRegistry registry, final DOMTransactionChain chain, final YangInstanceIdentifier target,
+ final Long ourAs, final DOMDataTreeChangeService service, final ExportPolicyPeerTracker exportPolicyPeerTracker, final TablesKey tablesKey,
+ @Nonnull final PathSelectionMode pathSelectionMode, final UnsignedInt32Counter routeCounter) {
this.chain = Preconditions.checkNotNull(chain);
- this.target = Preconditions.checkNotNull(target);
+ final NodeIdentifierWithPredicates tableKey = RibSupportUtils.toYangTablesKey(tablesKey);
+ this.localTablesKey = tablesKey;
+ this.locRibTarget = YangInstanceIdentifier.create(target.node(LocRib.QNAME).node(Tables.QNAME).node(tableKey).getPathArguments());
this.ourAs = Preconditions.checkNotNull(ourAs);
- this.attributesIdentifier = ribSupport.routeAttributesIdentifier();
+ this.ribSupport = registry.getRIBSupportContext(tablesKey).getRibSupport();
+ this.attributesIdentifier = this.ribSupport.routeAttributesIdentifier();
+ this.exportPolicyPeerTracker = exportPolicyPeerTracker;
+ this.pathSelectionMode = pathSelectionMode;
+ this.routeCounter = routeCounter;
+
+ final DOMDataWriteTransaction tx = this.chain.newWriteOnlyTransaction();
+ tx.merge(LogicalDatastoreType.OPERATIONAL, this.locRibTarget.node(Routes.QNAME), this.ribSupport.emptyRoutes());
+ tx.merge(LogicalDatastoreType.OPERATIONAL, this.locRibTarget.node(Attributes.QNAME).node(ATTRIBUTES_UPTODATE_TRUE.getNodeType()), ATTRIBUTES_UPTODATE_TRUE);
+ tx.submit();
- // FIXME: proper values
- this.peerPolicyTracker = new ExportPolicyPeerTracker(null, null);
+ final YangInstanceIdentifier tableId = target.node(Peer.QNAME).node(Peer.QNAME).node(EffectiveRibIn.QNAME).node(Tables.QNAME).node(tableKey);
+ final DOMDataTreeIdentifier wildcard = new DOMDataTreeIdentifier(LogicalDatastoreType.OPERATIONAL, tableId);
+ this.reg = service.registerDataTreeChangeListener(wildcard, this);
+ }
+
+ public static LocRibWriter create(@Nonnull final RIBSupportContextRegistry registry, @Nonnull final TablesKey tablesKey, @Nonnull final DOMTransactionChain chain,
+ @Nonnull final YangInstanceIdentifier target, @Nonnull final AsNumber ourAs, @Nonnull final DOMDataTreeChangeService service, @Nonnull final ExportPolicyPeerTracker ep,
+ @Nonnull final PathSelectionMode pathSelectionStrategy, @Nonnull final UnsignedInt32Counter routeCounter) {
+ return new LocRibWriter(registry, chain, target, ourAs.getValue(), service, ep, tablesKey, pathSelectionStrategy, routeCounter);
}
@Override
public void close() {
- peerPolicyTracker.close();
+ this.reg.close();
+ // FIXME: wait for the chain to close? unfortunately RIBImpl is the listener, so that may require some work
+ this.chain.close();
+ }
+
+ @Nonnull
+ private RouteEntry createEntry(final PathArgument routeId) {
+ final RouteEntry ret = this.pathSelectionMode.createRouteEntry(ribSupport.isComplexRoute());
+ this.routeEntries.put(routeId, ret);
+ LOG.trace("Created new entry for {}", routeId);
+ return ret;
}
+ /**
+ * We use two-stage processing here in hopes that we avoid duplicate
+ * calculations when multiple peers have changed a particular entry.
+ *
+ * @param changes on supported table
+ */
@Override
public void onDataTreeChanged(final Collection<DataTreeCandidate> changes) {
- /*
- * We use two-stage processing here in hopes that we avoid duplicate
- * calculations when multiple peers have changed a particular entry.
- */
- final Map<RouteUpdateKey, RouteEntry> toUpdate = new HashMap<>();
- for (final DataTreeCandidate tc : changes) {
- final YangInstanceIdentifier path = tc.getRootPath();
- final PathArgument routeId = path.getLastPathArgument();
- final NodeIdentifierWithPredicates peerKey = IdentifierUtils.peerKey(path);
- final PeerId peerId = IdentifierUtils.peerId(peerKey);
- final UnsignedInteger routerId = RouterIds.routerIdForPeerId(peerId);
+ LOG.trace("Received data change {} to LocRib {}", changes, this);
- RouteEntry entry = this.routeEntries.get(routeId);
- if (tc.getRootNode().getDataAfter().isPresent()) {
- if (entry == null) {
- entry = new RouteEntry();
- this.routeEntries.put(routeId, entry);
- }
+ final DOMDataWriteTransaction tx = this.chain.newWriteOnlyTransaction();
+ try {
+ final Map<RouteUpdateKey, RouteEntry> toUpdate = update(tx, changes);
- entry.addRoute(routerId, (ContainerNode) tc.getRootNode().getDataAfter().get());
- } else if (entry != null && entry.removeRoute(routerId)) {
- this.routeEntries.remove(routeId);
- entry = null;
+ if (!toUpdate.isEmpty()) {
+ walkThrough(tx, toUpdate.entrySet());
}
-
- toUpdate.put(new RouteUpdateKey(peerId, routeId), entry);
+ } catch (final Exception e) {
+ LOG.error("Failed to completely propagate updates {}, state is undefined", changes, e);
+ } finally {
+ tx.submit();
}
+ }
- final DOMDataWriteTransaction tx = this.chain.newWriteOnlyTransaction();
+ private Map<RouteUpdateKey, RouteEntry> update(final DOMDataWriteTransaction tx, final Collection<DataTreeCandidate> changes) {
+ final Map<RouteUpdateKey, RouteEntry> ret = new HashMap<>();
+ changes.forEach(tc -> {
+ final DataTreeCandidateNode table = tc.getRootNode();
+ final YangInstanceIdentifier rootPath = tc.getRootPath();
+ final PeerId peerId = IdentifierUtils.peerKeyToPeerId(rootPath);
+ initializeTableWithExistentRoutes(table, peerId, rootPath, tx);
+ updateNodes(table, peerId, tx, ret);
+ });
+ return ret;
+ }
- // Now walk all updated entries
- for (final Entry<RouteUpdateKey, RouteEntry> e : toUpdate.entrySet()) {
- final RouteEntry entry = e.getValue();
- final NormalizedNode<?, ?> value;
+ private void initializeTableWithExistentRoutes(final DataTreeCandidateNode table, final PeerId peerIdOfNewPeer, final YangInstanceIdentifier rootPath,
+ final DOMDataWriteTransaction tx) {
+ if (!table.getDataBefore().isPresent() && this.exportPolicyPeerTracker.isTableSupported(peerIdOfNewPeer)) {
+ LOG.debug("Peer {} table has been created, inserting existent routes", peerIdOfNewPeer);
+ final PeerRole newPeerRole = this.exportPolicyPeerTracker.getRole(IdentifierUtils.peerPath(rootPath));
+ final PeerExportGroup peerGroup = this.exportPolicyPeerTracker.getPeerGroup(newPeerRole);
+ this.routeEntries.entrySet().forEach(entry -> entry.getValue().writeRoute(peerIdOfNewPeer, entry.getKey(),
+ rootPath.getParent().getParent().getParent(), peerGroup, this.localTablesKey, this.exportPolicyPeerTracker, this.ribSupport, tx));
+ }
+ }
- if (entry != null) {
- if (!entry.selectBest(this.ourAs)) {
- // Best path has not changed, no need to do anything else. Proceed to next route.
- continue;
+ private void updateNodes(final DataTreeCandidateNode table, final PeerId peerId, final DOMDataWriteTransaction tx,
+ final Map<RouteUpdateKey, RouteEntry> routes) {
+ for (final DataTreeCandidateNode child : table.getChildNodes()) {
+ LOG.debug("Modification type {}", child.getModificationType());
+ if ((Attributes.QNAME).equals(child.getIdentifier().getNodeType())) {
+ if (child.getDataAfter().isPresent()) {
+ // putting uptodate attribute in
+ LOG.trace("Uptodate found for {}", child.getDataAfter());
+ tx.put(LogicalDatastoreType.OPERATIONAL, this.locRibTarget.node(child.getIdentifier()), child.getDataAfter().get());
}
-
- value = entry.bestValue(e.getKey().getRouteId());
- } else {
- value = null;
- }
-
- if (value != null) {
- tx.put(LogicalDatastoreType.OPERATIONAL, this.target.node(e.getKey().getRouteId()), value);
- } else {
- tx.delete(LogicalDatastoreType.OPERATIONAL, this.target.node(e.getKey().getRouteId()));
+ continue;
}
+ updateRoutesEntries(child, peerId, routes);
+ }
+ }
- /*
- * We need to keep track of routers and populate adj-ribs-out, too. If we do not, we need to
- * expose from which client a particular route was learned from in the local RIB, and have
- * the listener perform filtering.
- *
- * We walk the policy set in order to minimize the amount of work we do for multiple peers:
- * if we have two eBGP peers, for example, there is no reason why we should perform the translation
- * multiple times.
- */
- for (PeerRole role : PeerRole.values()) {
- final PeerExportGroup peerGroup = peerPolicyTracker.getPeerGroup(role);
- if (peerGroup != null) {
- final ContainerNode attributes = null;
- final PeerId peerId = e.getKey().getPeerId();
- final ContainerNode effectiveAttributes = peerGroup.effectiveAttributes(peerId, attributes);
-
- for (final Entry<PeerId, YangInstanceIdentifier> pid : peerGroup.getPeers()) {
- // This points to adj-rib-out for a particular peer/table combination
- final YangInstanceIdentifier routeTarget = pid.getValue().node(e.getKey().getRouteId());
-
- if (effectiveAttributes != null && value != null && !peerId.equals(pid.getKey())) {
- tx.put(LogicalDatastoreType.OPERATIONAL, routeTarget, value);
- tx.put(LogicalDatastoreType.OPERATIONAL, routeTarget.node(attributesIdentifier), effectiveAttributes);
- } else {
- tx.delete(LogicalDatastoreType.OPERATIONAL, routeTarget);
- }
- }
+ private void updateRoutesEntries(final DataTreeCandidateNode child, final PeerId peerId, final Map<RouteUpdateKey, RouteEntry> routes) {
+ final UnsignedInteger routerId = RouterIds.routerIdForPeerId(peerId);
+ final Collection<DataTreeCandidateNode> modifiedRoutes = this.ribSupport.changedRoutes(child);
+ for (final DataTreeCandidateNode route : modifiedRoutes) {
+ final PathArgument routeId = this.ribSupport.createRouteKeyPathArgument(route.getIdentifier());
+ RouteEntry entry = this.routeEntries.get(routeId);
+ final Optional<NormalizedNode<?, ?>> maybeData = route.getDataAfter();
+ final Optional<NormalizedNode<?, ?>> maybeDataBefore = route.getDataBefore();
+ if (maybeData.isPresent()) {
+ if (entry == null) {
+ entry = createEntry(routeId);
}
+ entry.addRoute(routerId, this.ribSupport.extractPathId(maybeData.get()), this.attributesIdentifier, maybeData.get());
+ } else if (entry != null && entry.removeRoute(routerId, this.ribSupport.extractPathId(maybeDataBefore.get()))) {
+ this.routeEntries.remove(routeId);
+ LOG.trace("Removed route from {}", routerId);
}
+ final RouteUpdateKey routeUpdateKey = new RouteUpdateKey(peerId, routeId);
+ LOG.debug("Updated route {} entry {}", routeId, entry);
+ routes.put(routeUpdateKey, entry);
}
+ updateRouteCounter();
+ }
- tx.submit();
+ /**
+ * Update the statistic of loc-rib route
+ */
+ private void updateRouteCounter() {
+ routeCounter.setCount(this.routeEntries.size());
+ }
+
+ private void walkThrough(final DOMDataWriteTransaction tx, final Set<Map.Entry<RouteUpdateKey, RouteEntry>> toUpdate) {
+ for (final Map.Entry<RouteUpdateKey, RouteEntry> e : toUpdate) {
+ LOG.trace("Walking through {}", e);
+ final RouteEntry entry = e.getValue();
+
+ if (!entry.selectBest(this.ourAs)) {
+ LOG.trace("Best path has not changed, continuing");
+ continue;
+ }
+ entry.updateRoute(this.localTablesKey, this.exportPolicyPeerTracker, this.locRibTarget, this.ribSupport, tx, e.getKey().getRouteId());
+ }
}
}