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 java.util.Collections;
  11 import java.util.List;
  12 import java.util.concurrent.ExecutionException;
  13
  14 import javax.annotation.concurrent.ThreadSafe;
  15
  16 import org.opendaylight.controller.md.sal.common.api.TransactionStatus;
  17 import org.opendaylight.controller.sal.binding.api.data.DataModificationTransaction;
  18 import org.opendaylight.controller.sal.binding.api.data.DataProviderService;
  19 import org.opendaylight.protocol.bgp.rib.DefaultRibReference;
  20 import org.opendaylight.protocol.bgp.rib.impl.spi.BGPDispatcher;
  21 import org.opendaylight.protocol.bgp.rib.impl.spi.RIB;
  22 import org.opendaylight.protocol.bgp.rib.spi.AdjRIBsIn;
  23 import org.opendaylight.protocol.bgp.rib.spi.Peer;
  24 import org.opendaylight.protocol.bgp.rib.spi.RIBExtensionConsumerContext;
  25 import org.opendaylight.protocol.framework.ReconnectStrategyFactory;
  26 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.AsNumber;
  27 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.Ipv4Address;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.Update;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.UpdateBuilder;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.update.Nlri;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.update.PathAttributes;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev130919.update.WithdrawnRoutes;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.BgpTableType;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.PathAttributes1;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.PathAttributes2;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.destination.destination.type.DestinationIpv4CaseBuilder;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.destination.destination.type.destination.ipv4._case.DestinationIpv4Builder;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.update.path.attributes.MpReachNlri;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.update.path.attributes.MpReachNlriBuilder;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.update.path.attributes.MpUnreachNlri;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.update.path.attributes.MpUnreachNlriBuilder;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.update.path.attributes.mp.reach.nlri.AdvertizedRoutesBuilder;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.update.path.attributes.mp.unreach.nlri.WithdrawnRoutesBuilder;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.BgpRib;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.RibId;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.bgp.rib.Rib;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.bgp.rib.RibBuilder;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.bgp.rib.RibKey;
  49 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.bgp.rib.rib.LocRibBuilder;
  50 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.rib.Tables;
  51 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.rib.TablesKey;
  52 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.Ipv4AddressFamily;
  53 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.UnicastSubsequentAddressFamily;
  54 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  55 import org.opendaylight.yangtools.yang.common.RpcResult;
  56 import org.slf4j.Logger;
  57 import org.slf4j.LoggerFactory;
  58
  59 import com.google.common.base.Objects;
  60 import com.google.common.base.Objects.ToStringHelper;
  61 import com.google.common.base.Preconditions;
  62 import com.google.common.collect.ImmutableList;
  63 import com.google.common.util.concurrent.FutureCallback;
  64 import com.google.common.util.concurrent.Futures;
  65 import com.google.common.util.concurrent.JdkFutureAdapters;
  66
  67 @ThreadSafe
  68 public final class RIBImpl extends DefaultRibReference implements AutoCloseable, RIB {
  69         private static final Logger LOG = LoggerFactory.getLogger(RIBImpl.class);
  70         private static final Update EOR = new UpdateBuilder().build();
  71         private static final TablesKey IPV4_UNICAST_TABLE = new TablesKey(Ipv4AddressFamily.class, UnicastSubsequentAddressFamily.class);
  72         private final ReconnectStrategyFactory tcpStrategyFactory;
  73         private final ReconnectStrategyFactory sessionStrategyFactory;
  74         private final BGPDispatcher dispatcher;
  75         private final DataProviderService dps;
  76         private final AsNumber localAs;
  77         private final Ipv4Address bgpIdentifier;
  78         private final List<BgpTableType> localTables;
  79         private final RIBTables tables;
  80
  81         public RIBImpl(final RibId ribId, final AsNumber localAs, final Ipv4Address localBgpId, final RIBExtensionConsumerContext extensions,
  82                         final BGPDispatcher dispatcher, final ReconnectStrategyFactory tcpStrategyFactory, final ReconnectStrategyFactory sessionStrategyFactory,
  83                         final DataProviderService dps, final List<BgpTableType> localTables) {
  84                 super(InstanceIdentifier.builder(BgpRib.class).child(Rib.class, new RibKey(Preconditions.checkNotNull(ribId))).toInstance());
  85                 this.dps = Preconditions.checkNotNull(dps);
  86                 this.localAs = Preconditions.checkNotNull(localAs);
  87                 this.bgpIdentifier = Preconditions.checkNotNull(localBgpId);
  88                 this.dispatcher = Preconditions.checkNotNull(dispatcher);
  89                 this.sessionStrategyFactory = Preconditions.checkNotNull(sessionStrategyFactory);
  90                 this.tcpStrategyFactory = Preconditions.checkNotNull(tcpStrategyFactory);
  91                 this.localTables = ImmutableList.copyOf(localTables);
  92                 this.tables = new RIBTables(extensions);
  93
  94                 LOG.debug("Instantiating RIB table {} at {}", ribId, getInstanceIdentifier());
  95
  96                 final DataModificationTransaction trans = dps.beginTransaction();
  97                 final Object o = trans.readOperationalData(getInstanceIdentifier());
  98                 Preconditions.checkState(o == null, "Data provider conflict detected on object {}", getInstanceIdentifier());
  99
 100                 trans.putOperationalData(
 101                                 getInstanceIdentifier(),
 102                                 new RibBuilder().setKey(new RibKey(ribId)).setId(ribId).setLocRib(
 103                                                 new LocRibBuilder().setTables(Collections.<Tables> emptyList()).build()).build());
 104
 105                 for (BgpTableType t : localTables) {
 106                         final TablesKey key = new TablesKey(t.getAfi(), t.getSafi());
 107                         if (this.tables.create(trans, this, key) == null) {
 108                                 LOG.debug("Did not create local table for unhandled table type {}", t);
 109                         }
 110                 }
 111
 112                 Futures.addCallback(JdkFutureAdapters.listenInPoolThread(trans.commit()), new FutureCallback<RpcResult<TransactionStatus>>() {
 113                         @Override
 114                         public void onSuccess(final RpcResult<TransactionStatus> result) {
 115                                 LOG.trace("Change committed successfully");
 116                         }
 117
 118                         @Override
 119                         public void onFailure(final Throwable t) {
 120                                 LOG.error("Failed to initiate RIB {}", getInstanceIdentifier());
 121                         }
 122                 });
 123         }
 124
 125         synchronized void initTables(final byte[] remoteBgpId) {
 126         }
 127
 128         @Override
 129         public synchronized void updateTables(final Peer peer, final Update message) {
 130                 final DataModificationTransaction trans = this.dps.beginTransaction();
 131
 132                 if (!EOR.equals(message)) {
 133                         final WithdrawnRoutes wr = message.getWithdrawnRoutes();
 134                         if (wr != null) {
 135                                 final AdjRIBsIn ari = this.tables.get(IPV4_UNICAST_TABLE);
 136                                 if (ari != null) {
 137                                         ari.removeRoutes(
 138                                                         trans,
 139                                                         peer,
 140                                                         new MpUnreachNlriBuilder().setAfi(Ipv4AddressFamily.class).setSafi(UnicastSubsequentAddressFamily.class).setWithdrawnRoutes(
 141                                                                         new WithdrawnRoutesBuilder().setDestinationType(
 142                                                                                         new DestinationIpv4CaseBuilder().setDestinationIpv4(
 143                                                                                                         new DestinationIpv4Builder().setIpv4Prefixes(wr.getWithdrawnRoutes()).build()).build()).build()).build());
 144                                 } else {
 145                                         LOG.debug("Not removing objects from unhandled IPv4 Unicast");
 146                                 }
 147                         }
 148
 149                         final PathAttributes attrs = message.getPathAttributes();
 150                         if (attrs != null) {
 151                                 final PathAttributes2 mpu = attrs.getAugmentation(PathAttributes2.class);
 152                                 if (mpu != null) {
 153                                         final MpUnreachNlri nlri = mpu.getMpUnreachNlri();
 154
 155                                         final AdjRIBsIn ari = this.tables.get(new TablesKey(nlri.getAfi(), nlri.getSafi()));
 156                                         if (ari != null) {
 157                                                 ari.removeRoutes(trans, peer, nlri);
 158                                         } else {
 159                                                 LOG.debug("Not removing objects from unhandled NLRI {}", nlri);
 160                                         }
 161                                 }
 162                         }
 163
 164                         final Nlri ar = message.getNlri();
 165                         if (ar != null) {
 166                                 final AdjRIBsIn ari = this.tables.get(IPV4_UNICAST_TABLE);
 167                                 if (ari != null) {
 168                                         final MpReachNlriBuilder b = new MpReachNlriBuilder().setAfi(Ipv4AddressFamily.class).setSafi(UnicastSubsequentAddressFamily.class).setAdvertizedRoutes(
 169                                                         new AdvertizedRoutesBuilder().setDestinationType(
 170                                                                         new DestinationIpv4CaseBuilder().setDestinationIpv4(
 171                                                                                         new DestinationIpv4Builder().setIpv4Prefixes(ar.getNlri()).build()).build()).build());
 172                                         if (attrs != null) {
 173                                                 b.setCNextHop(attrs.getCNextHop());
 174                                         }
 175
 176                                         ari.addRoutes(trans, peer, b.build(), attrs);
 177                                 } else {
 178                                         LOG.debug("Not adding objects from unhandled IPv4 Unicast");
 179                                 }
 180                         }
 181
 182                         if (attrs != null) {
 183                                 final PathAttributes1 mpr = attrs.getAugmentation(PathAttributes1.class);
 184                                 if (mpr != null) {
 185                                         final MpReachNlri nlri = mpr.getMpReachNlri();
 186
 187                                         final AdjRIBsIn ari = this.tables.get(new TablesKey(nlri.getAfi(), nlri.getSafi()));
 188                                         if (ari != null) {
 189                                                 if (message.equals(ari.endOfRib())) {
 190                                                         ari.markUptodate(trans, peer);
 191                                                 } else {
 192                                                         ari.addRoutes(trans, peer, nlri, attrs);
 193                                                 }
 194                                         } else {
 195                                                 LOG.debug("Not adding objects from unhandled NLRI {}", nlri);
 196                                         }
 197                                 }
 198                         }
 199                 } else {
 200                         final AdjRIBsIn ari = this.tables.get(IPV4_UNICAST_TABLE);
 201                         if (ari != null) {
 202                                 ari.markUptodate(trans, peer);
 203                         } else {
 204                                 LOG.debug("End-of-RIB for IPv4 Unicast ignored");
 205                         }
 206                 }
 207
 208                 Futures.addCallback(JdkFutureAdapters.listenInPoolThread(trans.commit()), new FutureCallback<RpcResult<TransactionStatus>>() {
 209                         @Override
 210                         public void onSuccess(final RpcResult<TransactionStatus> result) {
 211                                 LOG.debug("RIB modification successfully committed.");
 212                         }
 213
 214                         @Override
 215                         public void onFailure(final Throwable t) {
 216                                 LOG.error("Failed to commit RIB modification", t);
 217                         }
 218                 });
 219         }
 220
 221         @Override
 222         public synchronized void clearTable(final Peer peer, final TablesKey key) {
 223                 final AdjRIBsIn ari = this.tables.get(key);
 224                 if (ari != null) {
 225                         final DataModificationTransaction trans = this.dps.beginTransaction();
 226                         ari.clear(trans, peer);
 227
 228                         Futures.addCallback(JdkFutureAdapters.listenInPoolThread(trans.commit()), new FutureCallback<RpcResult<TransactionStatus>>() {
 229                                 @Override
 230                                 public void onSuccess(final RpcResult<TransactionStatus> result) {
 231                                         // Nothing to do
 232                                 }
 233
 234                                 @Override
 235                                 public void onFailure(final Throwable t) {
 236                                         LOG.error("Failed to commit RIB modification", t);
 237                                 }
 238                         });
 239                 }
 240         }
 241
 242         @Override
 243         public final String toString() {
 244                 return addToStringAttributes(Objects.toStringHelper(this)).toString();
 245         }
 246
 247         protected ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) {
 248                 return toStringHelper;
 249         }
 250
 251         @Override
 252         public void close() throws InterruptedException, ExecutionException {
 253                 final DataModificationTransaction t = this.dps.beginTransaction();
 254                 t.removeOperationalData(getInstanceIdentifier());
 255                 t.commit().get();
 256         }
 257
 258         @Override
 259         public AsNumber getLocalAs() {
 260                 return this.localAs;
 261         }
 262
 263         @Override
 264         public Ipv4Address getBgpIdentifier() {
 265                 return this.bgpIdentifier;
 266         }
 267
 268         @Override
 269         public List<? extends BgpTableType> getLocalTables() {
 270                 return this.localTables;
 271         }
 272
 273         @Override
 274         public ReconnectStrategyFactory getTcpStrategyFactory() {
 275                 return this.tcpStrategyFactory;
 276         }
 277
 278         @Override
 279         public ReconnectStrategyFactory getSessionStrategyFactory() {
 280                 return this.sessionStrategyFactory;
 281         }
 282
 283         @Override
 284         public BGPDispatcher getDispatcher() {
 285                 return this.dispatcher;
 286         }
 287
 288         @Override
 289         public void initTable(final Peer bgpPeer, final TablesKey key) {
 290                 // FIXME: BUG-196: support graceful restart
 291         }
 292 }