*/
package org.opendaylight.protocol.bgp.rib.impl;
+import static com.google.common.base.Verify.verifyNotNull;
import static java.util.Objects.requireNonNull;
+import static org.opendaylight.protocol.bgp.rib.spi.RIBNodeIdentifiers.BGPRIB_NID;
+import static org.opendaylight.protocol.bgp.rib.spi.RIBNodeIdentifiers.LOCRIB_NID;
+import static org.opendaylight.protocol.bgp.rib.spi.RIBNodeIdentifiers.PEER_NID;
+import static org.opendaylight.protocol.bgp.rib.spi.RIBNodeIdentifiers.RIB_NID;
+import static org.opendaylight.protocol.bgp.rib.spi.RIBNodeIdentifiers.TABLES_NID;
import com.google.common.base.MoreObjects;
import com.google.common.collect.ImmutableSet;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.ExecutionException;
-import javax.annotation.Nonnull;
-import javax.annotation.concurrent.GuardedBy;
-import javax.annotation.concurrent.ThreadSafe;
-import org.opendaylight.controller.md.sal.binding.api.BindingTransactionChain;
-import org.opendaylight.controller.md.sal.binding.api.DataBroker;
-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.DOMDataBroker;
-import org.opendaylight.controller.md.sal.dom.api.DOMDataBrokerExtension;
-import org.opendaylight.controller.md.sal.dom.api.DOMDataTreeChangeService;
-import org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction;
-import org.opendaylight.controller.md.sal.dom.api.DOMTransactionChain;
+import java.util.stream.Collectors;
+import org.checkerframework.checker.lock.qual.GuardedBy;
import org.opendaylight.mdsal.common.api.CommitInfo;
-import org.opendaylight.mdsal.singleton.common.api.ClusterSingletonServiceRegistration;
+import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
+import org.opendaylight.mdsal.dom.api.DOMDataBroker;
+import org.opendaylight.mdsal.dom.api.DOMDataBrokerExtension;
+import org.opendaylight.mdsal.dom.api.DOMDataTreeChangeService;
+import org.opendaylight.mdsal.dom.api.DOMDataTreeTransaction;
+import org.opendaylight.mdsal.dom.api.DOMDataTreeWriteTransaction;
+import org.opendaylight.mdsal.dom.api.DOMTransactionChain;
+import org.opendaylight.mdsal.dom.api.DOMTransactionChainListener;
import org.opendaylight.protocol.bgp.mode.api.PathSelectionMode;
import org.opendaylight.protocol.bgp.mode.impl.base.BasePathSelectionModeFactory;
import org.opendaylight.protocol.bgp.openconfig.spi.BGPTableTypeRegistryConsumer;
import org.opendaylight.protocol.bgp.rib.impl.spi.RIB;
import org.opendaylight.protocol.bgp.rib.impl.spi.RIBSupportContextRegistry;
import org.opendaylight.protocol.bgp.rib.impl.spi.RibOutRefresh;
-import org.opendaylight.protocol.bgp.rib.impl.state.BGPRIBStateImpl;
+import org.opendaylight.protocol.bgp.rib.impl.state.BGPRibStateImpl;
import org.opendaylight.protocol.bgp.rib.spi.BGPPeerTracker;
import org.opendaylight.protocol.bgp.rib.spi.RIBExtensionConsumerContext;
import org.opendaylight.protocol.bgp.rib.spi.RIBSupport;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.RibId;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.bgp.rib.Rib;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.bgp.rib.RibKey;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.bgp.rib.rib.LocRib;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.bgp.rib.rib.Peer;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.rib.Tables;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.rib.TablesKey;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.rib.tables.Routes;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev180329.BgpId;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev200120.BgpId;
+import org.opendaylight.yangtools.yang.binding.ChildOf;
+import org.opendaylight.yangtools.yang.binding.ChoiceIn;
+import org.opendaylight.yangtools.yang.binding.DataObject;
import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
import org.opendaylight.yangtools.yang.common.QName;
import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.InstanceIdentifierBuilder;
-import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
-import org.opendaylight.yangtools.yang.model.api.SchemaContext;
-import org.opendaylight.yangtools.yang.model.api.SchemaContextListener;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
-@ThreadSafe
-public final class RIBImpl extends BGPRIBStateImpl implements RIB, TransactionChainListener,
- SchemaContextListener, AutoCloseable {
+// This class is thread-safe
+public final class RIBImpl extends BGPRibStateImpl implements RIB, DOMTransactionChainListener {
private static final Logger LOG = LoggerFactory.getLogger(RIBImpl.class);
private static final QName RIB_ID_QNAME = QName.create(Rib.QNAME, "id").intern();
private final Set<BgpTableType> localTables;
private final Set<TablesKey> localTablesKeys;
private final DOMDataBroker domDataBroker;
- private final DataBroker dataBroker;
private final RIBExtensionConsumerContext extensions;
private final YangInstanceIdentifier yangRibId;
private final RIBSupportContextRegistryImpl ribContextRegistry;
- private final CodecsRegistryImpl codecsRegistry;
+ private final CodecsRegistry codecsRegistry;
private final BGPTableTypeRegistryConsumer tableTypeRegistry;
private final DOMDataBrokerExtension domService;
- private final Map<TransactionChain<?, ?>, LocRibWriter> txChainToLocRibWriter = new HashMap<>();
+ private final Map<DOMTransactionChain, LocRibWriter<?, ?>> txChainToLocRibWriter = new HashMap<>();
+ private final Map<TablesKey, RibOutRefresh> vpnTableRefresher = new HashMap<>();
private final Map<TablesKey, PathSelectionMode> bestPathSelectionStrategies;
private final RibId ribId;
private final BGPPeerTracker peerTracker = new BGPPeerTrackerImpl();
private final BGPRibRoutingPolicy ribPolicies;
@GuardedBy("this")
- private ClusterSingletonServiceRegistration registration;
- @GuardedBy("this")
private DOMTransactionChain domChain;
@GuardedBy("this")
private boolean isServiceInstantiated;
- private final Map<TablesKey, RibOutRefresh> vpnTableRefresher = new HashMap<>();
public RIBImpl(
final BGPTableTypeRegistryConsumer tableTypeRegistry,
final BgpId localBgpId,
final RIBExtensionConsumerContext extensions,
final BGPDispatcher dispatcher,
- final CodecsRegistryImpl codecsRegistry,
+ final CodecsRegistry codecsRegistry,
final DOMDataBroker domDataBroker,
- final DataBroker dataBroker,
final BGPRibRoutingPolicy ribPolicies,
final List<BgpTableType> localTables,
final Map<TablesKey, PathSelectionMode> bestPathSelectionStrategies
localBgpId, localAs);
this.tableTypeRegistry = requireNonNull(tableTypeRegistry);
this.localAs = requireNonNull(localAs);
- this.bgpIdentifier = requireNonNull(localBgpId);
+ bgpIdentifier = requireNonNull(localBgpId);
this.dispatcher = requireNonNull(dispatcher);
+
this.localTables = ImmutableSet.copyOf(localTables);
- this.localTablesKeys = new HashSet<>();
+ // FIXME: can this be immutable?
+ localTablesKeys = localTables.stream()
+ .map(t -> new TablesKey(t.getAfi(), t.getSafi()))
+ .collect(Collectors.toCollection(HashSet::new));
+
this.domDataBroker = requireNonNull(domDataBroker);
- this.dataBroker = requireNonNull(dataBroker);
- this.domService = this.domDataBroker.getSupportedExtensions().get(DOMDataTreeChangeService.class);
+ domService = domDataBroker.getExtensions().get(DOMDataTreeChangeService.class);
this.extensions = requireNonNull(extensions);
this.ribPolicies = requireNonNull(ribPolicies);
this.codecsRegistry = codecsRegistry;
- this.ribContextRegistry = RIBSupportContextRegistryImpl.create(extensions, this.codecsRegistry);
- final InstanceIdentifierBuilder yangRibIdBuilder = YangInstanceIdentifier.builder().node(BgpRib.QNAME).node(Rib.QNAME);
- this.yangRibId = yangRibIdBuilder.nodeWithKey(Rib.QNAME, RIB_ID_QNAME, ribId.getValue()).build();
+ ribContextRegistry = RIBSupportContextRegistryImpl.create(extensions, codecsRegistry);
+ yangRibId = YangInstanceIdentifier.builder().node(BGPRIB_NID).node(RIB_NID)
+ .nodeWithKey(Rib.QNAME, RIB_ID_QNAME, ribId.getValue()).build();
this.bestPathSelectionStrategies = requireNonNull(bestPathSelectionStrategies);
this.ribId = ribId;
-
- for (final BgpTableType t : this.localTables) {
- final TablesKey key = new TablesKey(t.getAfi(), t.getSafi());
- this.localTablesKeys.add(key);
- }
}
+ // FIXME: make this asynchronous?
private synchronized void startLocRib(final TablesKey key) {
LOG.debug("Creating LocRib table for {}", key);
// create locRibWriter for each table
- final DOMDataWriteTransaction tx = this.domChain.newWriteOnlyTransaction();
+ final DOMDataTreeWriteTransaction tx = domChain.newWriteOnlyTransaction();
- final RIBSupport<? extends Routes, ?, ?, ?> ribSupport = this.ribContextRegistry.getRIBSupport(key);
+ final RIBSupport<? extends Routes, ?> ribSupport = ribContextRegistry.getRIBSupport(key);
if (ribSupport != null) {
final MapEntryNode emptyTable = ribSupport.emptyTable();
final InstanceIdentifierBuilder tableId = YangInstanceIdentifier
- .builder(this.yangRibId.node(LocRib.QNAME).node(Tables.QNAME)).node(emptyTable.getIdentifier());
+ .builder(yangRibId.node(LOCRIB_NID).node(TABLES_NID)).node(emptyTable.name());
tx.put(LogicalDatastoreType.OPERATIONAL, tableId.build(), emptyTable);
try {
tx.commit().get();
- } catch (final InterruptedException | ExecutionException e1) {
- LOG.error("Failed to initiate LocRIB for key {}", key, e1);
+ } catch (final InterruptedException | ExecutionException e) {
+ LOG.error("Failed to initiate LocRIB for key {}", key, e);
}
} else {
LOG.warn("There's no registered RIB Context for {}", key.getAfi());
}
}
- private synchronized void createLocRibWriter(final TablesKey key) {
- final RIBSupport<?, ?, ?, ?> ribSupport = this.ribContextRegistry.getRIBSupport(key);
+ private synchronized <C extends Routes & DataObject & ChoiceIn<Tables>, S extends ChildOf<? super C>>
+ void createLocRibWriter(final TablesKey key) {
+ final RIBSupport<C, S> ribSupport = ribContextRegistry.getRIBSupport(key);
if (ribSupport == null) {
return;
}
LOG.debug("Creating LocRIB writer for key {}", key);
- final BindingTransactionChain txChain = createPeerChain(this);
- PathSelectionMode pathSelectionStrategy = this.bestPathSelectionStrategies.get(key);
+ final DOMTransactionChain txChain = createPeerDOMChain(this);
+ PathSelectionMode pathSelectionStrategy = bestPathSelectionStrategies.get(key);
if (pathSelectionStrategy == null) {
pathSelectionStrategy = BasePathSelectionModeFactory.createBestPathSelectionStrategy();
}
- final LocRibWriter locRibWriter = LocRibWriter.create(
+ final LocRibWriter<C, S> locRibWriter = LocRibWriter.create(
ribSupport,
- key,
- this.tableTypeRegistry.getAfiSafiType(key).get(),
+ verifyNotNull(tableTypeRegistry.getAfiSafiType(key)),
txChain,
- getInstanceIdentifier(),
- this.localAs,
- getDataBroker(),
- this.ribPolicies,
- this.peerTracker,
+ yangRibId,
+ localAs,
+ getService(),
+ ribPolicies,
+ peerTracker,
pathSelectionStrategy);
- this.vpnTableRefresher.put(key, locRibWriter);
+ vpnTableRefresher.put(key, locRibWriter);
registerTotalPathCounter(key, locRibWriter);
registerTotalPrefixesCounter(key, locRibWriter);
- this.txChainToLocRibWriter.put(txChain, locRibWriter);
+ txChainToLocRibWriter.put(txChain, locRibWriter);
}
@Override
return MoreObjects.toStringHelper(this).add("bgpId", bgpIdentifier).add("localTables", localTables).toString();
}
- @Override
- public synchronized void close() throws Exception {
- if (this.registration != null) {
- this.registration.close();
- this.registration = null;
- }
- }
-
@Override
public AsNumber getLocalAs() {
- return this.localAs;
+ return localAs;
}
@Override
public BgpId getBgpIdentifier() {
- return this.bgpIdentifier;
+ return bgpIdentifier;
}
- @Nonnull
@Override
public Set<? extends BgpTableType> getLocalTables() {
- return this.localTables;
+ return localTables;
}
@Override
public BGPDispatcher getDispatcher() {
- return this.dispatcher;
+ return dispatcher;
}
@Override
- public synchronized void onTransactionChainFailed(final TransactionChain<?, ?> chain,
- final AsyncTransaction<?, ?> transaction, final Throwable cause) {
+ public synchronized void onTransactionChainFailed(final DOMTransactionChain chain,
+ final DOMDataTreeTransaction transaction, final Throwable cause) {
LOG.error("Broken chain in RIB {} transaction {}",
- getInstanceIdentifier(), transaction != null ? transaction.getIdentifier() : null, cause);
- if (this.txChainToLocRibWriter.containsKey(chain)) {
- final LocRibWriter locRibWriter = this.txChainToLocRibWriter.remove(chain);
- final BindingTransactionChain newChain = createPeerChain(this);
+ getInstanceIdentifier(), transaction != null ? transaction.getIdentifier() : null, cause);
+ final LocRibWriter<?, ?> locRibWriter = txChainToLocRibWriter.remove(chain);
+ if (locRibWriter != null) {
+ final DOMTransactionChain newChain = createPeerDOMChain(this);
startLocRib(locRibWriter.getTableKey());
locRibWriter.restart(newChain);
- this.txChainToLocRibWriter.put(newChain, locRibWriter);
+ txChainToLocRibWriter.put(newChain, locRibWriter);
}
}
@Override
- public void onTransactionChainSuccessful(final TransactionChain<?, ?> chain) {
+ public void onTransactionChainSuccessful(final DOMTransactionChain chain) {
LOG.info("RIB {} closed successfully", getInstanceIdentifier());
}
@Override
public Set<TablesKey> getLocalTablesKeys() {
- return this.localTablesKeys;
+ return localTablesKeys;
}
@Override
public boolean supportsTable(final TablesKey tableKey) {
- return this.localTablesKeys.contains(tableKey);
+ return localTablesKeys.contains(tableKey);
}
@Override
public BGPRibRoutingPolicy getRibPolicies() {
- return this.ribPolicies;
+ return ribPolicies;
}
@Override
public BGPPeerTracker getPeerTracker() {
- return this.peerTracker;
+ return peerTracker;
}
@Override
public void refreshTable(final TablesKey tk, final PeerId peerId) {
- final RibOutRefresh table = this.vpnTableRefresher.get(tk);
+ final RibOutRefresh table = vpnTableRefresher.get(tk);
if (table != null) {
table.refreshTable(tk, peerId);
}
@Override
public DOMDataTreeChangeService getService() {
- return (DOMDataTreeChangeService) this.domService;
- }
-
- @Override
- public DataBroker getDataBroker() {
- return this.dataBroker;
+ return (DOMDataTreeChangeService) domService;
}
@Override
public YangInstanceIdentifier getYangRibId() {
- return this.yangRibId;
- }
-
- @Override
- public BindingTransactionChain createPeerChain(final TransactionChainListener listener) {
- return this.dataBroker.createTransactionChain(listener);
+ return yangRibId;
}
@Override
- public DOMTransactionChain createPeerDOMChain(final TransactionChainListener listener) {
- return this.domDataBroker.createTransactionChain(listener);
+ public DOMTransactionChain createPeerDOMChain(final DOMTransactionChainListener listener) {
+ return domDataBroker.createMergingTransactionChain(listener);
}
@Override
public RIBExtensionConsumerContext getRibExtensions() {
- return this.extensions;
+ return extensions;
}
@Override
public RIBSupportContextRegistry getRibSupportContext() {
- return this.ribContextRegistry;
- }
-
- @Override
- public void onGlobalContextUpdated(final SchemaContext context) {
- this.codecsRegistry.onSchemaContextUpdated(context);
+ return ribContextRegistry;
}
@Override
public CodecsRegistry getCodecsRegistry() {
- return this.codecsRegistry;
+ return codecsRegistry;
}
public synchronized void instantiateServiceInstance() {
- this.isServiceInstantiated = true;
+ isServiceInstantiated = true;
setActive(true);
- this.domChain = this.domDataBroker.createTransactionChain(this);
- LOG.debug("Instantiating RIB table {} at {}", this.ribId, this.yangRibId);
+ domChain = domDataBroker.createMergingTransactionChain(this);
+ LOG.debug("Instantiating RIB table {} at {}", ribId, yangRibId);
- final ContainerNode bgpRib = Builders.containerBuilder().withNodeIdentifier(new NodeIdentifier(BgpRib.QNAME))
- .addChild(ImmutableNodes.mapNodeBuilder(Rib.QNAME).build()).build();
+ final ContainerNode bgpRib = Builders.containerBuilder().withNodeIdentifier(BGPRIB_NID)
+ .addChild(ImmutableNodes.mapNodeBuilder(RIB_NID).build()).build();
final MapEntryNode ribInstance = Builders.mapEntryBuilder().withNodeIdentifier(
- new NodeIdentifierWithPredicates(Rib.QNAME, RIB_ID_QNAME, this.ribId.getValue()))
- .addChild(ImmutableNodes.leafNode(RIB_ID_QNAME, this.ribId.getValue()))
- .addChild(ImmutableNodes.mapNodeBuilder(Peer.QNAME).build())
- .addChild(Builders.containerBuilder().withNodeIdentifier(new NodeIdentifier(LocRib.QNAME))
- .addChild(ImmutableNodes.mapNodeBuilder(Tables.QNAME).build())
+ NodeIdentifierWithPredicates.of(Rib.QNAME, RIB_ID_QNAME, ribId.getValue()))
+ .addChild(ImmutableNodes.leafNode(RIB_ID_QNAME, ribId.getValue()))
+ .addChild(ImmutableNodes.mapNodeBuilder(PEER_NID).build())
+ .addChild(Builders.containerBuilder().withNodeIdentifier(LOCRIB_NID)
+ .addChild(ImmutableNodes.mapNodeBuilder(TABLES_NID).build())
.build()).build();
-
- final DOMDataWriteTransaction trans = this.domChain.newWriteOnlyTransaction();
+ final DOMDataTreeWriteTransaction trans = domChain.newWriteOnlyTransaction();
// merge empty BgpRib + Rib, to make sure the top-level parent structure is present
- trans.merge(LogicalDatastoreType.OPERATIONAL, YangInstanceIdentifier.builder().node(BgpRib.QNAME).build(), bgpRib);
- trans.put(LogicalDatastoreType.OPERATIONAL, this.yangRibId, ribInstance);
+ trans.merge(LogicalDatastoreType.OPERATIONAL, YangInstanceIdentifier.create(BGPRIB_NID), bgpRib);
+ trans.put(LogicalDatastoreType.OPERATIONAL, yangRibId, ribInstance);
try {
trans.commit().get();
} catch (final InterruptedException | ExecutionException e) {
- LOG.error("Failed to initiate RIB {}", this.yangRibId, e);
+ LOG.error("Failed to initiate RIB {}", yangRibId, e);
}
LOG.debug("Effective RIB created.");
- this.localTablesKeys.forEach(this::startLocRib);
- this.localTablesKeys.forEach(this::createLocRibWriter);
+ localTablesKeys.forEach(this::startLocRib);
+ localTablesKeys.forEach(this::createLocRibWriter);
}
public synchronized FluentFuture<? extends CommitInfo> closeServiceInstance() {
- if (!this.isServiceInstantiated) {
- LOG.trace("RIB {} already closed", this.ribId.getValue());
+ if (!isServiceInstantiated) {
+ LOG.trace("RIB {} already closed", ribId.getValue());
return CommitInfo.emptyFluentFuture();
}
- LOG.info("Close RIB {}", this.ribId.getValue());
- this.isServiceInstantiated = false;
+ LOG.info("Close RIB {}", ribId.getValue());
+ isServiceInstantiated = false;
setActive(false);
- this.txChainToLocRibWriter.values().forEach(LocRibWriter::close);
- this.txChainToLocRibWriter.clear();
+ txChainToLocRibWriter.values().forEach(LocRibWriter::close);
+ txChainToLocRibWriter.clear();
- final DOMDataWriteTransaction t = this.domChain.newWriteOnlyTransaction();
+ final DOMDataTreeWriteTransaction t = domChain.newWriteOnlyTransaction();
t.delete(LogicalDatastoreType.OPERATIONAL, getYangRibId());
final FluentFuture<? extends CommitInfo> cleanFuture = t.commit();
cleanFuture.addCallback(new FutureCallback<CommitInfo>() {
@Override
public void onSuccess(final CommitInfo result) {
- LOG.info("RIB cleaned {}", RIBImpl.this.ribId.getValue());
+ LOG.info("RIB cleaned {}", ribId.getValue());
}
@Override
public void onFailure(final Throwable throwable) {
LOG.error("Failed to clean RIB {}",
- RIBImpl.this.ribId.getValue(), throwable);
+ ribId.getValue(), throwable);
}
}, MoreExecutors.directExecutor());
- this.domChain.close();
+ domChain.close();
return cleanFuture;
}
}
Code Review / bgpcep.git / blobdiff