/* * Copyright (c) 2014 Cisco Systems, Inc. and others. All rights reserved. * * This program and the accompanying materials are made available under the * terms of the Eclipse Public License v1.0 which accompanies this distribution, * and is available at http://www.eclipse.org/legal/epl-v10.html */ package org.opendaylight.protocol.bgp.rib.impl; import com.google.common.base.Preconditions; import com.google.common.base.Verify; import com.google.common.net.InetAddresses; import java.util.Arrays; import java.util.Collection; import java.util.Collections; import java.util.Optional; 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.DOMDataWriteTransaction; import org.opendaylight.controller.md.sal.dom.api.DOMTransactionChain; import org.opendaylight.protocol.bgp.openconfig.spi.BGPConfigModuleTracker; import org.opendaylight.protocol.bgp.rib.spi.IdentifierUtils; 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.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.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; /** * 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 AutoCloseable, org.opendaylight.protocol.bgp.rib.spi.Peer, DOMDataTreeChangeListener, TransactionChainListener { private static final Logger LOG = LoggerFactory.getLogger(ApplicationPeer.class); private final byte[] rawIdentifier; private final String name; private final YangInstanceIdentifier adjRibsInId; private final DOMTransactionChain chain; private final BGPConfigModuleTracker moduleTracker; private final EffectiveRibInWriter effectiveRibInWriter; private AdjRibInWriter writer; public ApplicationPeer(final ApplicationRibId applicationRibId, final Ipv4Address ipAddress, final RIBImpl rib, final BGPConfigModuleTracker moduleTracker) { this.name = applicationRibId.getValue().toString(); final RIBImpl targetRib = Preconditions.checkNotNull(rib); this.rawIdentifier = InetAddresses.forString(ipAddress.getValue()).getAddress(); final NodeIdentifierWithPredicates peerId = IdentifierUtils.domPeerId(RouterIds.createPeerId(ipAddress)); final YangInstanceIdentifier peerIId = targetRib.getYangRibId().node(Peer.QNAME).node(peerId); this.adjRibsInId = peerIId.node(AdjRibIn.QNAME).node(Tables.QNAME); this.chain = targetRib.createPeerChain(this); this.writer = AdjRibInWriter.create(targetRib.getYangRibId(), PeerRole.Internal, Optional.of(SimpleRoutingPolicy.AnnounceNone), this.chain); this.writer = this.writer.transform(RouterIds.createPeerId(ipAddress), targetRib.getRibSupportContext(), targetRib.getLocalTablesKeys(), Collections.emptyList()); //TODO need to create effective rib in writer with route counter here this.effectiveRibInWriter = EffectiveRibInWriter.create(targetRib.getService(), this.chain, peerIId, targetRib.getImportPolicyPeerTracker(), targetRib.getRibSupportContext(), PeerRole.Internal); this.moduleTracker = moduleTracker; if (moduleTracker != null) { moduleTracker.onInstanceCreate(); } } public ApplicationPeer(final ApplicationRibId applicationRibId, final Ipv4Address bgpPeerId, final RIBImpl targetRibDependency) { this(applicationRibId, bgpPeerId, targetRibDependency, null); } /** * 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 changes) { 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; for (final DataTreeCandidateNode child : tc.getRootNode().getChildNodes()) { 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 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; } @Override public void close() { this.effectiveRibInWriter.close(); this.writer.removePeer(); this.chain.close(); if (this.moduleTracker != null) { this.moduleTracker.onInstanceClose(); } } @Override public byte[] getRawIdentifier() { return Arrays.copyOf(this.rawIdentifier, this.rawIdentifier.length); } @Override public void onTransactionChainFailed(final TransactionChain chain, final AsyncTransaction transaction, final Throwable cause) { LOG.error("Transaction chain failed.", cause); } @Override public void onTransactionChainSuccessful(final TransactionChain chain) { LOG.debug("Transaction chain {} successfull.", chain); } }