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

   1 /*
   2  * Copyright (c) 2013 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 javax.annotation.concurrent.ThreadSafe;
  11
  12 import org.opendaylight.controller.md.sal.common.api.TransactionStatus;
  13 import org.opendaylight.controller.sal.binding.api.data.DataModificationTransaction;
  14 import org.opendaylight.controller.sal.binding.api.data.DataProviderService;
  15 import org.opendaylight.protocol.bgp.rib.DefaultRibReference;
  16 import org.opendaylight.protocol.bgp.rib.spi.AdjRIBsIn;
  17 import org.opendaylight.protocol.bgp.rib.spi.RIBExtensionConsumerContext;
  18 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.Update;
  19 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.UpdateBuilder;
  20 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.update.Nlri;
  21 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.update.PathAttributes;
  22 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.update.WithdrawnRoutes;
  23 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.PathAttributes1;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.PathAttributes2;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.destination.destination.type.DestinationIpv4CaseBuilder;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.destination.destination.type.destination.ipv4._case.DestinationIpv4Builder;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.update.path.attributes.MpReachNlri;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.update.path.attributes.MpReachNlriBuilder;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.update.path.attributes.MpUnreachNlri;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.update.path.attributes.MpUnreachNlriBuilder;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.update.path.attributes.mp.reach.nlri.AdvertizedRoutesBuilder;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.update.path.attributes.mp.unreach.nlri.WithdrawnRoutesBuilder;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.BgpRib;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.RibId;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.bgp.rib.Rib;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.bgp.rib.RibKey;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.rib.TablesKey;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.Ipv4AddressFamily;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.UnicastSubsequentAddressFamily;
  40 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  41 import org.opendaylight.yangtools.yang.common.RpcResult;
  42 import org.slf4j.Logger;
  43 import org.slf4j.LoggerFactory;
  44
  45 import com.google.common.base.Objects;
  46 import com.google.common.base.Objects.ToStringHelper;
  47 import com.google.common.base.Preconditions;
  48 import com.google.common.util.concurrent.FutureCallback;
  49 import com.google.common.util.concurrent.Futures;
  50 import com.google.common.util.concurrent.JdkFutureAdapters;
  51
  52 @ThreadSafe
  53 public class RIBImpl extends DefaultRibReference {
  54         private static final Logger LOG = LoggerFactory.getLogger(RIBImpl.class);
  55         private static final Update EOR = new UpdateBuilder().build();
  56         private final DataProviderService dps;
  57         private final RIBTables tables;
  58
  59         public RIBImpl(final RibId ribId, final RIBExtensionConsumerContext extensions, final DataProviderService dps) {
  60                 super(InstanceIdentifier.builder(BgpRib.class).child(Rib.class, new RibKey(ribId)).toInstance());
  61                 this.dps = Preconditions.checkNotNull(dps);
  62                 this.tables = new RIBTables(BGPObjectComparator.INSTANCE, extensions);
  63         }
  64
  65         synchronized void updateTables(final BGPPeer peer, final Update message) {
  66                 final DataModificationTransaction trans = this.dps.beginTransaction();
  67
  68                 if (EOR.equals(message)) {
  69                         final AdjRIBsIn ari = this.tables.getOrCreate(trans, this,
  70                                         new TablesKey(Ipv4AddressFamily.class, UnicastSubsequentAddressFamily.class));
  71                         if (ari != null) {
  72                                 ari.markUptodate(trans, peer);
  73                         } else {
  74                                 LOG.debug("End-of-RIB for IPv4 Unicast ignored");
  75                         }
  76                         return;
  77                 }
  78
  79                 final WithdrawnRoutes wr = message.getWithdrawnRoutes();
  80                 if (wr != null) {
  81                         final AdjRIBsIn ari = this.tables.getOrCreate(trans, this,
  82                                         new TablesKey(Ipv4AddressFamily.class, UnicastSubsequentAddressFamily.class));
  83                         if (ari != null) {
  84                                 ari.removeRoutes(
  85                                                 trans,
  86                                                 peer,
  87                                                 new MpUnreachNlriBuilder().setAfi(Ipv4AddressFamily.class).setSafi(UnicastSubsequentAddressFamily.class).setWithdrawnRoutes(
  88                                                                 new WithdrawnRoutesBuilder().setDestinationType(
  89                                                                                 new DestinationIpv4CaseBuilder().setDestinationIpv4(
  90                                                                                                 new DestinationIpv4Builder().setIpv4Prefixes(wr.getWithdrawnRoutes()).build()).build()).build()).build());
  91                         } else {
  92                                 LOG.debug("Not removing objects from unhandled IPv4 Unicast");
  93                         }
  94                 }
  95
  96                 final PathAttributes attrs = message.getPathAttributes();
  97                 final PathAttributes2 mpu = attrs.getAugmentation(PathAttributes2.class);
  98                 if (mpu != null) {
  99                         final MpUnreachNlri nlri = mpu.getMpUnreachNlri();
 100
 101                         final AdjRIBsIn ari = this.tables.getOrCreate(trans, this, new TablesKey(nlri.getAfi(), nlri.getSafi()));
 102                         if (ari != null) {
 103                                 ari.removeRoutes(trans, peer, nlri);
 104                         } else {
 105                                 LOG.debug("Not removing objects from unhandled NLRI {}", nlri);
 106                         }
 107                 }
 108
 109                 final Nlri ar = message.getNlri();
 110                 if (ar != null) {
 111                         final AdjRIBsIn ari = this.tables.getOrCreate(trans, this,
 112                                         new TablesKey(Ipv4AddressFamily.class, UnicastSubsequentAddressFamily.class));
 113                         if (ari != null) {
 114                                 ari.addRoutes(
 115                                                 trans,
 116                                                 peer,
 117                                                 new MpReachNlriBuilder().setAfi(Ipv4AddressFamily.class).setSafi(UnicastSubsequentAddressFamily.class).setCNextHop(
 118                                                                 attrs.getCNextHop()).setAdvertizedRoutes(
 119                                                                                 new AdvertizedRoutesBuilder().setDestinationType(
 120                                                                                                 new DestinationIpv4CaseBuilder().setDestinationIpv4(
 121                                                                                                                 new DestinationIpv4Builder().setIpv4Prefixes(ar.getNlri()).build()).build()).build()).build(),
 122                                                                                                                 attrs);
 123                         } else {
 124                                 LOG.debug("Not adding objects from unhandled IPv4 Unicast");
 125                         }
 126                 }
 127
 128                 final PathAttributes1 mpr = message.getPathAttributes().getAugmentation(PathAttributes1.class);
 129                 if (mpr != null) {
 130                         final MpReachNlri nlri = mpr.getMpReachNlri();
 131
 132                         final AdjRIBsIn ari = this.tables.getOrCreate(trans, this, new TablesKey(nlri.getAfi(), nlri.getSafi()));
 133                         if (ari != null) {
 134                                 ari.addRoutes(trans, peer, nlri, attrs);
 135                                 if (message.equals(ari.endOfRib())) {
 136                                         ari.markUptodate(trans, peer);
 137                                 }
 138                         } else {
 139                                 LOG.debug("Not adding objects from unhandled NLRI {}", nlri);
 140                         }
 141                 }
 142
 143                 Futures.addCallback(JdkFutureAdapters.listenInPoolThread(trans.commit()), new FutureCallback<RpcResult<TransactionStatus>>() {
 144                         @Override
 145                         public void onSuccess(final RpcResult<TransactionStatus> result) {
 146                                 LOG.debug("RIB modification successfully committed.");
 147                         }
 148
 149                         @Override
 150                         public void onFailure(final Throwable t) {
 151                                 LOG.error("Failed to commit RIB modification", t);
 152                         }
 153                 });
 154         }
 155
 156         synchronized void clearTable(final BGPPeer peer, final TablesKey key) {
 157                 final AdjRIBsIn ari = this.tables.get(key);
 158                 if (ari != null) {
 159                         final DataModificationTransaction trans = this.dps.beginTransaction();
 160                         ari.clear(trans, peer);
 161
 162                         Futures.addCallback(JdkFutureAdapters.listenInPoolThread(trans.commit()), new FutureCallback<RpcResult<TransactionStatus>>() {
 163                                 @Override
 164                                 public void onSuccess(final RpcResult<TransactionStatus> result) {
 165                                         // Nothing to do
 166                                 }
 167
 168                                 @Override
 169                                 public void onFailure(final Throwable t) {
 170                                         LOG.error("Failed to commit RIB modification", t);
 171                                 }
 172                         });
 173                 }
 174         }
 175
 176         @Override
 177         public final String toString() {
 178                 return addToStringAttributes(Objects.toStringHelper(this)).toString();
 179         }
 180
 181         protected ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) {
 182                 return toStringHelper;
 183         }
 184 }