bgp/path-selection-mode/src/main/java/org/opendaylight/protocol/bgp/mode/spi/AbstractRouteEntry.java

   1 /*
   2  * Copyright (c) 2016 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
   9 package org.opendaylight.protocol.bgp.mode.spi;
  10
  11 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  12 import org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction;
  13 import org.opendaylight.protocol.bgp.mode.api.RouteEntry;
  14 import org.opendaylight.protocol.bgp.rib.spi.ExportPolicyPeerTracker;
  15 import org.opendaylight.protocol.bgp.rib.spi.PeerExportGroup;
  16 import org.opendaylight.protocol.bgp.rib.spi.RIBSupport;
  17 import org.opendaylight.protocol.bgp.rib.spi.RibSupportUtils;
  18 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev171207.PeerId;
  19 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev171207.PeerRole;
  20 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev171207.bgp.rib.rib.peer.AdjRibOut;
  21 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev171207.rib.Tables;
  22 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev171207.rib.TablesKey;
  23 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev171207.rib.tables.Routes;
  24 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  25 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  26 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  27 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  28 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  29 import org.slf4j.Logger;
  30 import org.slf4j.LoggerFactory;
  31
  32 public abstract class AbstractRouteEntry implements RouteEntry {
  33     protected static final NodeIdentifier ROUTES_IDENTIFIER = new NodeIdentifier(Routes.QNAME);
  34     private static final Logger LOG = LoggerFactory.getLogger(AbstractRouteEntry.class);
  35
  36     protected static void fillLocRib(final YangInstanceIdentifier routeTarget, final NormalizedNode<?, ?> value,
  37             final DOMDataWriteTransaction tx) {
  38         if (value != null) {
  39             LOG.debug("Write route to LocRib {}", value);
  40             tx.put(LogicalDatastoreType.OPERATIONAL, routeTarget, value);
  41         } else {
  42             LOG.debug("Delete route from LocRib {}", routeTarget);
  43             tx.delete(LogicalDatastoreType.OPERATIONAL, routeTarget);
  44         }
  45     }
  46
  47     protected static void update(final PeerId destPeer, final YangInstanceIdentifier routeTarget,
  48             final ContainerNode effAttr, final NormalizedNode<?, ?> value, final RIBSupport ribSup,
  49             final DOMDataWriteTransaction tx) {
  50         if (!writeRoute(destPeer, routeTarget, effAttr, value, ribSup, tx)) {
  51             deleteRoute(destPeer, routeTarget, tx);
  52         }
  53     }
  54
  55     protected static boolean writeRoute(final PeerId destPeer, final YangInstanceIdentifier routeTarget,
  56             final ContainerNode effAttrib, final NormalizedNode<?, ?> value, final RIBSupport ribSup,
  57             final DOMDataWriteTransaction tx) {
  58         if (effAttrib != null && value != null) {
  59             LOG.debug("Write route {} to peer AdjRibsOut {}", value, destPeer);
  60             tx.put(LogicalDatastoreType.OPERATIONAL, routeTarget, value);
  61             tx.put(LogicalDatastoreType.OPERATIONAL, routeTarget.node(ribSup.routeAttributesIdentifier()), effAttrib);
  62             return true;
  63         }
  64         return false;
  65     }
  66
  67     private static void deleteRoute(final PeerId destPeer, final YangInstanceIdentifier routeTarget,
  68             final DOMDataWriteTransaction tx) {
  69         LOG.trace("Removing {} from transaction for peer {}", routeTarget, destPeer);
  70         tx.delete(LogicalDatastoreType.OPERATIONAL, routeTarget);
  71     }
  72
  73     protected static boolean filterRoutes(final PeerId rootPeer, final PeerId destPeer,
  74             final ExportPolicyPeerTracker peerPT, final TablesKey localTK, final PeerRole destPeerRole) {
  75         return !rootPeer.equals(destPeer) && isTableSupportedAndReady(destPeer, peerPT, localTK)
  76                 && !PeerRole.Internal.equals(destPeerRole);
  77     }
  78
  79     private static boolean isTableSupportedAndReady(final PeerId destPeer, final ExportPolicyPeerTracker peerPT,
  80             final TablesKey localTK) {
  81         if (!peerPT.isTableSupported(destPeer) || !peerPT.isTableStructureInitialized(destPeer)) {
  82             LOG.trace("Route rejected, peer {} does not support this table type {}", destPeer, localTK);
  83             return false;
  84         }
  85         return true;
  86     }
  87
  88     protected static YangInstanceIdentifier getAdjRibOutYII(final RIBSupport ribSup,
  89             final YangInstanceIdentifier rootPath, final PathArgument routeId, final TablesKey localTK) {
  90         return ribSup.routePath(rootPath.node(AdjRibOut.QNAME).node(Tables.QNAME)
  91                 .node(RibSupportUtils.toYangTablesKey(localTK)).node(ROUTES_IDENTIFIER), routeId);
  92     }
  93
  94     protected PeerRole getRoutePeerIdRole(final ExportPolicyPeerTracker peerPT, final PeerId routePeerId) {
  95         for (final PeerRole role : PeerRole.values()) {
  96             final PeerExportGroup peerGroup = peerPT.getPeerGroup(role);
  97             if (peerGroup != null && peerGroup.containsPeer(routePeerId)) {
  98                 return role;
  99             }
 100         }
 101         return null;
 102     }
 103 }