bgp/rib-impl/src/main/java/org/opendaylight/protocol/bgp/rib/impl/ApplicationPeer.java

   1 /*
   2  * Copyright (c) 2014 Cisco Systems, Inc. and others.  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.rib.impl;
   9
  10 import static java.util.Objects.requireNonNull;
  11
  12 import com.google.common.base.Verify;
  13 import com.google.common.net.InetAddresses;
  14 import com.google.common.util.concurrent.Futures;
  15 import com.google.common.util.concurrent.ListenableFuture;
  16 import java.util.Arrays;
  17 import java.util.Collection;
  18 import java.util.Collections;
  19 import java.util.HashSet;
  20 import java.util.Optional;
  21 import java.util.Set;
  22 import org.opendaylight.controller.md.sal.common.api.data.AsyncTransaction;
  23 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  24 import org.opendaylight.controller.md.sal.common.api.data.TransactionChain;
  25 import org.opendaylight.controller.md.sal.common.api.data.TransactionChainListener;
  26 import org.opendaylight.controller.md.sal.dom.api.ClusteredDOMDataTreeChangeListener;
  27 import org.opendaylight.controller.md.sal.dom.api.DOMDataTreeChangeService;
  28 import org.opendaylight.controller.md.sal.dom.api.DOMDataTreeIdentifier;
  29 import org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction;
  30 import org.opendaylight.controller.md.sal.dom.api.DOMTransactionChain;
  31 import org.opendaylight.protocol.bgp.rib.impl.spi.RIB;
  32 import org.opendaylight.protocol.bgp.rib.impl.spi.RIBSupportContextRegistry;
  33 import org.opendaylight.protocol.bgp.rib.impl.state.BGPPeerStateImpl;
  34 import org.opendaylight.protocol.bgp.rib.impl.state.BGPSessionStateImpl;
  35 import org.opendaylight.protocol.bgp.rib.spi.ExportPolicyPeerTracker;
  36 import org.opendaylight.protocol.bgp.rib.spi.IdentifierUtils;
  37 import org.opendaylight.protocol.bgp.rib.spi.RibSupportUtils;
  38 import org.opendaylight.protocol.bgp.rib.spi.RouterIds;
  39 import org.opendaylight.protocol.bgp.rib.spi.state.BGPAfiSafiState;
  40 import org.opendaylight.protocol.bgp.rib.spi.state.BGPErrorHandlingState;
  41 import org.opendaylight.protocol.bgp.rib.spi.state.BGPSessionState;
  42 import org.opendaylight.protocol.bgp.rib.spi.state.BGPTimersState;
  43 import org.opendaylight.protocol.bgp.rib.spi.state.BGPTransportState;
  44 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
  45 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.ApplicationRibId;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.PeerId;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.PeerRole;
  49 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.SimpleRoutingPolicy;
  50 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.bgp.rib.rib.Peer;
  51 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.bgp.rib.rib.peer.AdjRibIn;
  52 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.rib.Tables;
  53 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.rib.TablesKey;
  54 import org.opendaylight.yangtools.concepts.ListenerRegistration;
  55 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  56 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
  57 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  58 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  59 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidate;
  60 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidateNode;
  61 import org.slf4j.Logger;
  62 import org.slf4j.LoggerFactory;
  63
  64 /**
  65  * Application Peer is a special case of BGP peer. It serves as an interface
  66  * for user to advertise user routes to ODL and through ODL to other BGP peers.
  67  *
  68  * This peer has it's own RIB, where it stores all user routes. This RIB is
  69  * located in configurational datastore. Routes are added through RESTCONF.
  70  *
  71  * They are then processed as routes from any other peer, through AdjRib,
  72  * EffectiveRib,LocRib and if they are advertised further, through AdjRibOut.
  73  *
  74  * For purposed of import policies such as Best Path Selection, application
  75  * peer needs to have a BGP-ID that is configurable.
  76  */
  77 public class ApplicationPeer extends BGPPeerStateImpl implements org.opendaylight.protocol.bgp.rib.spi.Peer,
  78         ClusteredDOMDataTreeChangeListener, TransactionChainListener {
  79
  80     private static final Logger LOG = LoggerFactory.getLogger(ApplicationPeer.class);
  81
  82     private final byte[] rawIdentifier;
  83     private final String name;
  84     private final YangInstanceIdentifier adjRibsInId;
  85     private final Ipv4Address ipAddress;
  86     private final RIB rib;
  87     private final YangInstanceIdentifier peerIId;
  88     private DOMTransactionChain chain;
  89     private DOMTransactionChain writerChain;
  90     private EffectiveRibInWriter effectiveRibInWriter;
  91     private AdjRibInWriter adjRibInWriter;
  92     private ListenerRegistration<ApplicationPeer> registration;
  93     private final Set<NodeIdentifierWithPredicates> supportedTables = new HashSet<>();
  94     private final BGPSessionStateImpl bgpSessionState = new BGPSessionStateImpl();
  95
  96     @FunctionalInterface
  97     interface RegisterAppPeerListener {
  98         /**
  99          * Register Application Peer Change Listener once AdjRibIn has been successfully initialized.
 100          */
 101         void register();
 102     }
 103
 104     public ApplicationPeer(final ApplicationRibId applicationRibId, final Ipv4Address ipAddress, final RIB rib) {
 105         super(rib.getInstanceIdentifier(), "application-peers", new IpAddress(ipAddress),
 106                 rib.getLocalTablesKeys(), Collections.emptySet());
 107         this.name = applicationRibId.getValue();
 108         final RIB targetRib = requireNonNull(rib);
 109         this.rawIdentifier = InetAddresses.forString(ipAddress.getValue()).getAddress();
 110         final NodeIdentifierWithPredicates peerId = IdentifierUtils.domPeerId(RouterIds.createPeerId(ipAddress));
 111         this.peerIId = targetRib.getYangRibId().node(Peer.QNAME).node(peerId);
 112         this.adjRibsInId = this.peerIId.node(AdjRibIn.QNAME).node(Tables.QNAME);
 113         this.rib = targetRib;
 114         this.ipAddress = ipAddress;
 115     }
 116
 117     public synchronized void instantiateServiceInstance(final DOMDataTreeChangeService dataTreeChangeService,
 118             final DOMDataTreeIdentifier appPeerDOMId) {
 119         this.chain = this.rib.createPeerChain(this);
 120         this.writerChain = this.rib.createPeerChain(this);
 121
 122         final Optional<SimpleRoutingPolicy> simpleRoutingPolicy = Optional.of(SimpleRoutingPolicy.AnnounceNone);
 123         final PeerId peerId = RouterIds.createPeerId(this.ipAddress);
 124         final Set<TablesKey> localTables = this.rib.getLocalTablesKeys();
 125         localTables.forEach(tablesKey -> {
 126             final ExportPolicyPeerTracker exportTracker = this.rib.getExportPolicyPeerTracker(tablesKey);
 127             if (exportTracker != null) {
 128                 exportTracker.registerPeer(peerId, null, this.peerIId, PeerRole.Internal, simpleRoutingPolicy);
 129             }
 130             this.supportedTables.add(RibSupportUtils.toYangTablesKey(tablesKey));
 131         });
 132         setAdvertizedGracefulRestartTableTypes(Collections.emptyList());
 133
 134         this.adjRibInWriter = AdjRibInWriter.create(this.rib.getYangRibId(), PeerRole.Internal, simpleRoutingPolicy,
 135                 this.writerChain);
 136         final RIBSupportContextRegistry context = this.rib.getRibSupportContext();
 137         final RegisterAppPeerListener registerAppPeerListener = () -> {
 138             synchronized (this) {
 139                 if (this.chain != null) {
 140                     this.registration = dataTreeChangeService.registerDataTreeChangeListener(appPeerDOMId, this);
 141                 }
 142             }
 143         };
 144         this.adjRibInWriter = this.adjRibInWriter.transform(peerId, context, localTables, Collections.emptyMap(),
 145                 registerAppPeerListener);
 146         this.effectiveRibInWriter = EffectiveRibInWriter
 147                 .create(this.rib.getService(), this.rib.createPeerChain(this), this.peerIId,
 148                 this.rib.getImportPolicyPeerTracker(), context, PeerRole.Internal,
 149                 localTables);
 150         this.bgpSessionState.registerMessagesCounter(this);
 151     }
 152
 153     /**
 154      * Routes come from application RIB that is identified by (configurable) name.
 155      * Each route is pushed into AdjRibsInWriter with it's whole context. In this
 156      * method, it doesn't matter if the routes are removed or added, this will
 157      * be determined in LocRib.
 158      */
 159     @Override
 160     public synchronized void onDataTreeChanged(final Collection<DataTreeCandidate> changes) {
 161         if (this.chain == null) {
 162             LOG.trace("Skipping data changed called to Application Peer. Change : {}", changes);
 163             return;
 164         }
 165         final DOMDataWriteTransaction tx = this.chain.newWriteOnlyTransaction();
 166         LOG.debug("Received data change to ApplicationRib {}", changes);
 167         for (final DataTreeCandidate tc : changes) {
 168             LOG.debug("Modification Type {}", tc.getRootNode().getModificationType());
 169             final YangInstanceIdentifier path = tc.getRootPath();
 170             final PathArgument lastArg = path.getLastPathArgument();
 171             Verify.verify(lastArg instanceof NodeIdentifierWithPredicates,
 172                     "Unexpected type %s in path %s", lastArg.getClass(), path);
 173             final NodeIdentifierWithPredicates tableKey = (NodeIdentifierWithPredicates) lastArg;
 174             if (!this.supportedTables.contains(tableKey)) {
 175                 LOG.trace("Skipping received data change for non supported family {}.", tableKey);
 176                 continue;
 177             }
 178             for (final DataTreeCandidateNode child : tc.getRootNode().getChildNodes()) {
 179                 final PathArgument childIdentifier = child.getIdentifier();
 180                 final YangInstanceIdentifier tableId = this.adjRibsInId.node(tableKey).node(childIdentifier);
 181                 switch (child.getModificationType()) {
 182                     case DELETE:
 183                         LOG.trace("App peer -> AdjRibsIn path delete: {}", childIdentifier);
 184                         tx.delete(LogicalDatastoreType.OPERATIONAL, tableId);
 185                         break;
 186                     case UNMODIFIED:
 187                         // No-op
 188                         break;
 189                     case SUBTREE_MODIFIED:
 190                         if (EffectiveRibInWriter.TABLE_ROUTES.equals(childIdentifier)) {
 191                             processRoutesTable(child, tableId, tx, tableId);
 192                             break;
 193                         }
 194                     case WRITE:
 195                         if (child.getDataAfter().isPresent()) {
 196                             final NormalizedNode<?, ?> dataAfter = child.getDataAfter().get();
 197                             LOG.trace("App peer -> AdjRibsIn path : {}", tableId);
 198                             LOG.trace("App peer -> AdjRibsIn data : {}", dataAfter);
 199                             tx.put(LogicalDatastoreType.OPERATIONAL, tableId, dataAfter);
 200                         }
 201                         break;
 202                     default:
 203                         break;
 204                 }
 205             }
 206         }
 207         tx.submit();
 208     }
 209
 210     /**
 211      * Applies modification under table routes based on modification type instead of only put. BUG 4438
 212      *
 213      * @param node
 214      * @param identifier
 215      * @param tx
 216      * @param routeTableIdentifier
 217      */
 218     private synchronized void processRoutesTable(final DataTreeCandidateNode node,
 219             final YangInstanceIdentifier identifier, final DOMDataWriteTransaction tx,
 220             final YangInstanceIdentifier routeTableIdentifier) {
 221         for (final DataTreeCandidateNode child : node.getChildNodes()) {
 222             final YangInstanceIdentifier childIdentifier = identifier.node(child.getIdentifier());
 223             switch (child.getModificationType()) {
 224                 case DELETE:
 225                     LOG.trace("App peer -> AdjRibsIn path delete: {}", childIdentifier);
 226                     tx.delete(LogicalDatastoreType.OPERATIONAL, childIdentifier);
 227                     break;
 228                 case UNMODIFIED:
 229                     // No-op
 230                     break;
 231                 case SUBTREE_MODIFIED:
 232                     //For be ables to use DELETE when we remove specific routes as we do when we remove the whole routes,
 233                     // we need to go deeper three levels
 234                     if (!routeTableIdentifier.equals(childIdentifier.getParent().getParent().getParent())) {
 235                         processRoutesTable(child, childIdentifier, tx, routeTableIdentifier);
 236                         break;
 237                     }
 238                 case WRITE:
 239                     if (child.getDataAfter().isPresent()) {
 240                         final NormalizedNode<?, ?> dataAfter = child.getDataAfter().get();
 241                         LOG.trace("App peer -> AdjRibsIn path : {}", childIdentifier);
 242                         LOG.trace("App peer -> AdjRibsIn data : {}", dataAfter);
 243                         tx.put(LogicalDatastoreType.OPERATIONAL, childIdentifier, dataAfter);
 244                     }
 245                     break;
 246                 default:
 247                     break;
 248             }
 249         }
 250     }
 251
 252     @Override
 253     public String getName() {
 254         return this.name;
 255     }
 256
 257     // FIXME ListenableFuture<?> should be used once closeServiceInstance uses wildcard too
 258     @Override
 259     public synchronized ListenableFuture<Void> close() {
 260         if (this.registration != null) {
 261             this.registration.close();
 262             this.registration = null;
 263         }
 264         if (this.effectiveRibInWriter != null) {
 265             this.effectiveRibInWriter.close();
 266         }
 267         final ListenableFuture<Void> future;
 268         if (this.adjRibInWriter != null) {
 269             future = this.adjRibInWriter.removePeer();
 270         } else {
 271             future = Futures.immediateFuture(null);
 272         }
 273         if (this.chain != null) {
 274             this.chain.close();
 275             this.chain = null;
 276         }
 277         if (this.writerChain != null) {
 278             this.writerChain.close();
 279             this.writerChain = null;
 280         }
 281         return future;
 282     }
 283
 284     @Override
 285     public byte[] getRawIdentifier() {
 286         return Arrays.copyOf(this.rawIdentifier, this.rawIdentifier.length);
 287     }
 288
 289     @Override
 290     public void onTransactionChainFailed(final TransactionChain<?, ?> chain,
 291             final AsyncTransaction<?, ?> transaction, final Throwable cause) {
 292         LOG.error("Transaction chain {} failed.", transaction != null ? transaction.getIdentifier() : null, cause);
 293     }
 294
 295     @Override
 296     public void onTransactionChainSuccessful(final TransactionChain<?, ?> chain) {
 297         LOG.debug("Transaction chain {} successful.", chain);
 298     }
 299
 300     @Override
 301     public BGPErrorHandlingState getBGPErrorHandlingState() {
 302         return this;
 303     }
 304
 305     @Override
 306     public BGPAfiSafiState getBGPAfiSafiState() {
 307         return this;
 308     }
 309
 310     @Override
 311     public BGPSessionState getBGPSessionState() {
 312         return this.bgpSessionState;
 313     }
 314
 315     @Override
 316     public BGPTimersState getBGPTimersState() {
 317         return this.bgpSessionState;
 318     }
 319
 320     @Override
 321     public BGPTransportState getBGPTransportState() {
 322         return this.bgpSessionState;
 323     }
 324 }