import com.google.common.base.Preconditions;
import com.google.common.base.Verify;
import com.google.common.net.InetAddresses;
+import com.google.common.util.concurrent.Futures;
+import com.google.common.util.concurrent.ListenableFuture;
import java.util.Arrays;
import java.util.Collection;
+import java.util.Collections;
+import java.util.HashSet;
+import java.util.Optional;
+import java.util.Set;
import org.opendaylight.controller.md.sal.common.api.data.AsyncTransaction;
import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
import org.opendaylight.controller.md.sal.common.api.data.TransactionChain;
import org.opendaylight.controller.md.sal.common.api.data.TransactionChainListener;
-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.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.Ipv4Address;
+import org.opendaylight.protocol.bgp.openconfig.spi.BGPConfigModuleTracker;
+import org.opendaylight.protocol.bgp.rib.impl.spi.RIB;
+import org.opendaylight.protocol.bgp.rib.impl.spi.RIBSupportContextRegistry;
+import org.opendaylight.protocol.bgp.rib.impl.stats.peer.BGPPeerStats;
+import org.opendaylight.protocol.bgp.rib.impl.stats.peer.BGPPeerStatsImpl;
+import org.opendaylight.protocol.bgp.rib.spi.ExportPolicyPeerTracker;
+import org.opendaylight.protocol.bgp.rib.spi.IdentifierUtils;
+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.Ipv4Address;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.ApplicationRibId;
+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.SimpleRoutingPolicy;
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.rib.Tables;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.rib.TablesKey;
+import org.opendaylight.yangtools.concepts.ListenerRegistration;
import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
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.NormalizedNode;
import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidate;
import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidateNode;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
-public class ApplicationPeer implements AutoCloseable, org.opendaylight.protocol.bgp.rib.spi.Peer, DOMDataTreeChangeListener, TransactionChainListener {
+/**
+ * Application Peer is a special case of BGP peer. It serves as an interface
+ * for user to advertise user routes to ODL and through ODL to other BGP peers.
+ *
+ * This peer has it's own RIB, where it stores all user routes. This RIB is
+ * located in configurational datastore. Routes are added through RESTCONF.
+ *
+ * They are then processed as routes from any other peer, through AdjRib,
+ * EffectiveRib,LocRib and if they are advertised further, through AdjRibOut.
+ *
+ * For purposed of import policies such as Best Path Selection, application
+ * peer needs to have a BGP-ID that is configurable.
+ */
+public class ApplicationPeer implements org.opendaylight.protocol.bgp.rib.spi.Peer, ClusteredDOMDataTreeChangeListener, TransactionChainListener {
private static final Logger LOG = LoggerFactory.getLogger(ApplicationPeer.class);
private final byte[] rawIdentifier;
- private final RIBImpl targetRib;
private final String name;
private final YangInstanceIdentifier adjRibsInId;
- private final DOMTransactionChain chain;
+ private final Ipv4Address ipAddress;
+ private final BGPConfigModuleTracker moduleTracker;
+ private final RIB rib;
+ private final YangInstanceIdentifier peerIId;
+ private DOMTransactionChain chain;
+ private DOMTransactionChain writerChain;
+ private EffectiveRibInWriter effectiveRibInWriter;
+ private AdjRibInWriter adjRibInWriter;
+ private BGPPeerStats peerStats;
+ private ListenerRegistration<ApplicationPeer> registration;
+ private final Set<NodeIdentifierWithPredicates> supportedTables = new HashSet<>();
- private AdjRibInWriter writer;
- public ApplicationPeer(final ApplicationRibId applicationRibId, final Ipv4Address ipAddress, final RIBImpl targetRib) {
- this.name = applicationRibId.getValue().toString();
- this.targetRib = Preconditions.checkNotNull(targetRib);
+ @FunctionalInterface
+ interface RegisterAppPeerListener {
+ /**
+ * Register Application Peer Change Listener once AdjRibIn has been successfully initialized.
+ */
+ void register();
+ }
+
+ public ApplicationPeer(final ApplicationRibId applicationRibId, final Ipv4Address ipAddress, final RIB rib,
+ final BGPConfigModuleTracker moduleTracker) {
+ this.name = applicationRibId.getValue();
+ final RIB targetRib = Preconditions.checkNotNull(rib);
this.rawIdentifier = InetAddresses.forString(ipAddress.getValue()).getAddress();
final NodeIdentifierWithPredicates peerId = IdentifierUtils.domPeerId(RouterIds.createPeerId(ipAddress));
- this.adjRibsInId = this.targetRib.getYangRibId().node(Peer.QNAME).node(peerId).node(AdjRibIn.QNAME).node(Tables.QNAME);
- this.chain = this.targetRib.createPeerChain(this);
- this.writer = AdjRibInWriter.create(this.targetRib.getYangRibId(), PeerRole.Ibgp, this.targetRib.createPeerChain(this));
- this.writer = this.writer.transform(RouterIds.createPeerId(ipAddress), this.targetRib.getRibSupportContext(), this.targetRib.getLocalTablesKeys(), true);
+ this.peerIId = targetRib.getYangRibId().node(Peer.QNAME).node(peerId);
+ this.adjRibsInId = this.peerIId.node(AdjRibIn.QNAME).node(Tables.QNAME);
+ this.rib = targetRib;
+ this.ipAddress = ipAddress;
+ this.moduleTracker = moduleTracker;
+ }
+
+ public ApplicationPeer(final ApplicationRibId applicationRibId, final Ipv4Address bgpPeerId, final RIB targetRibDependency) {
+ this(applicationRibId, bgpPeerId, targetRibDependency, null);
+ }
+
+ public synchronized void instantiateServiceInstance(final DOMDataTreeChangeService dataTreeChangeService,
+ final DOMDataTreeIdentifier appPeerDOMId) {
+ this.chain = this.rib.createPeerChain(this);
+ this.writerChain = this.rib.createPeerChain(this);
+
+ final Optional<SimpleRoutingPolicy> simpleRoutingPolicy = Optional.of(SimpleRoutingPolicy.AnnounceNone);
+ final PeerId peerId = RouterIds.createPeerId(this.ipAddress);
+ final Set<TablesKey> localTables = this.rib.getLocalTablesKeys();
+ localTables.forEach(tablesKey -> {
+ final ExportPolicyPeerTracker exportTracker = this.rib.getExportPolicyPeerTracker(tablesKey);
+ if (exportTracker != null) {
+ exportTracker.registerPeer(peerId, null, this.peerIId, PeerRole.Internal, simpleRoutingPolicy);
+ }
+ this.supportedTables.add(RibSupportUtils.toYangTablesKey(tablesKey));
+ });
+
+ this.adjRibInWriter = AdjRibInWriter.create(this.rib.getYangRibId(), PeerRole.Internal, simpleRoutingPolicy, this.writerChain);
+ final RIBSupportContextRegistry context = this.rib.getRibSupportContext();
+ final RegisterAppPeerListener registerAppPeerListener = () -> {
+ synchronized (this) {
+ if(this.chain != null) {
+ this.registration = dataTreeChangeService.registerDataTreeChangeListener(appPeerDOMId, this);
+ }
+ }
+ };
+ this.adjRibInWriter = this.adjRibInWriter.transform(peerId, context, localTables, Collections.emptyMap(),
+ registerAppPeerListener);
+ this.peerStats = new BGPPeerStatsImpl(this.name, localTables);
+ this.effectiveRibInWriter = EffectiveRibInWriter.create(this.rib.getService(), this.rib.createPeerChain(this), this.peerIId,
+ this.rib.getImportPolicyPeerTracker(), context, PeerRole.Internal, this.peerStats.getEffectiveRibInRouteCounters(),
+ this.peerStats.getAdjRibInRouteCounters());
+ if (moduleTracker != null) {
+ moduleTracker.onInstanceCreate();
+ }
}
+ /**
+ * Routes come from application RIB that is identified by (configurable) name.
+ * Each route is pushed into AdjRibsInWriter with it's whole context. In this
+ * method, it doesn't matter if the routes are removed or added, this will
+ * be determined in LocRib.
+ */
@Override
- public void onDataTreeChanged(final Collection<DataTreeCandidate> changes) {
+ public synchronized void onDataTreeChanged(final Collection<DataTreeCandidate> changes) {
+ if(this.chain == null) {
+ LOG.trace("Skipping data changed called to Application Peer. Change : {}", changes);
+ return;
+ }
final DOMDataWriteTransaction tx = this.chain.newWriteOnlyTransaction();
LOG.debug("Received data change to ApplicationRib {}", changes);
for (final DataTreeCandidate tc : changes) {
+ LOG.debug("Modification Type {}", tc.getRootNode().getModificationType());
final YangInstanceIdentifier path = tc.getRootPath();
final PathArgument lastArg = path.getLastPathArgument();
Verify.verify(lastArg instanceof NodeIdentifierWithPredicates, "Unexpected type %s in path %s", lastArg.getClass(), path);
final NodeIdentifierWithPredicates tableKey = (NodeIdentifierWithPredicates) lastArg;
+ if (!this.supportedTables.contains(tableKey)) {
+ LOG.trace("Skipping received data change for non supported family {}.", tableKey);
+ continue;
+ }
for (final DataTreeCandidateNode child : tc.getRootNode().getChildNodes()) {
- final YangInstanceIdentifier tableId = this.adjRibsInId.node(tableKey).node(child.getIdentifier());
- if (child.getDataAfter().isPresent()) {
- LOG.trace("App peer -> AdjRibsIn path : {}", tableId);
- LOG.trace("App peer -> AdjRibsIn data : {}", child.getDataAfter().get());
- tx.put(LogicalDatastoreType.OPERATIONAL, tableId, child.getDataAfter().get());
+ final PathArgument childIdentifier = child.getIdentifier();
+ final YangInstanceIdentifier tableId = this.adjRibsInId.node(tableKey).node(childIdentifier);
+ switch (child.getModificationType()) {
+ case DELETE:
+ LOG.trace("App peer -> AdjRibsIn path delete: {}", childIdentifier);
+ tx.delete(LogicalDatastoreType.OPERATIONAL, tableId);
+ break;
+ case UNMODIFIED:
+ // No-op
+ break;
+ case SUBTREE_MODIFIED:
+ if (EffectiveRibInWriter.TABLE_ROUTES.equals(childIdentifier)) {
+ processRoutesTable(child, tableId, tx, tableId);
+ break;
+ }
+ case WRITE:
+ if (child.getDataAfter().isPresent()) {
+ final NormalizedNode<?,?> dataAfter = child.getDataAfter().get();
+ LOG.trace("App peer -> AdjRibsIn path : {}", tableId);
+ LOG.trace("App peer -> AdjRibsIn data : {}", dataAfter);
+ tx.put(LogicalDatastoreType.OPERATIONAL, tableId, dataAfter);
+ }
+ break;
+ default:
+ break;
}
}
}
tx.submit();
}
+ /**
+ * Applies modification under table routes based on modification type instead of only put. BUG 4438
+ * @param node
+ * @param identifier
+ * @param tx
+ * @param routeTableIdentifier
+ */
+ private synchronized void processRoutesTable(final DataTreeCandidateNode node, final YangInstanceIdentifier identifier,
+ final DOMDataWriteTransaction tx, final YangInstanceIdentifier routeTableIdentifier) {
+ for (final DataTreeCandidateNode child : node.getChildNodes()) {
+ final YangInstanceIdentifier childIdentifier = identifier.node(child.getIdentifier());
+ switch (child.getModificationType()) {
+ case DELETE:
+ LOG.trace("App peer -> AdjRibsIn path delete: {}", childIdentifier);
+ tx.delete(LogicalDatastoreType.OPERATIONAL, childIdentifier);
+ break;
+ case UNMODIFIED:
+ // No-op
+ break;
+ case SUBTREE_MODIFIED:
+ //For be ables to use DELETE when we remove specific routes as we do when we remove the whole routes,
+ // we need to go deeper three levels
+ if (!routeTableIdentifier.equals(childIdentifier.getParent().getParent().getParent())) {
+ processRoutesTable(child, childIdentifier, tx, routeTableIdentifier);
+ break;
+ }
+ case WRITE:
+ if (child.getDataAfter().isPresent()) {
+ final NormalizedNode<?,?> dataAfter = child.getDataAfter().get();
+ LOG.trace("App peer -> AdjRibsIn path : {}", childIdentifier);
+ LOG.trace("App peer -> AdjRibsIn data : {}", dataAfter);
+ tx.put(LogicalDatastoreType.OPERATIONAL, childIdentifier, dataAfter);
+ }
+ break;
+ default:
+ break;
+ }
+ }
+ }
+
@Override
public String getName() {
return this.name;
}
+ // FIXME ListenableFuture<?> should be used once closeServiceInstance uses wildcard too
@Override
- public void close() {
- this.writer.cleanTables(this.targetRib.getLocalTablesKeys());
- this.chain.close();
+ public synchronized ListenableFuture<Void> close() {
+ if (this.registration != null) {
+ this.registration.close();
+ this.registration = null;
+ }
+ if (this.effectiveRibInWriter != null) {
+ this.effectiveRibInWriter.close();
+ }
+ final ListenableFuture<Void> future;
+ if (this.adjRibInWriter != null) {
+ future = this.adjRibInWriter.removePeer();
+ }else {
+ future = Futures.immediateFuture(null);
+ }
+ if (this.chain != null) {
+ this.chain.close();
+ this.chain = null;
+ }
+ if (this.writerChain != null) {
+ this.writerChain.close();
+ this.writerChain = null;
+ }
+ if (this.moduleTracker != null) {
+ this.moduleTracker.onInstanceClose();
+ }
+ return future;
}
@Override
}
@Override
- public void onTransactionChainFailed(final TransactionChain<?, ?> chain, final AsyncTransaction<?, ?> transaction,
- final Throwable cause) {
- LOG.error("Transaction chain failed.", cause);
+ public void onTransactionChainFailed(final TransactionChain<?, ?> chain,
+ final AsyncTransaction<?, ?> transaction, final Throwable cause) {
+ LOG.error("Transaction chain {} failed.", transaction != null ? transaction.getIdentifier() : null, cause);
}
@Override
public void onTransactionChainSuccessful(final TransactionChain<?, ?> chain) {
- LOG.debug("Transaction chain {} successfull.", chain);
+ LOG.debug("Transaction chain {} successful.", chain);
}
}
Code Review / bgpcep.git / blobdiff