+public final class RIBImpl extends DefaultRibReference implements ClusterSingletonService, AutoCloseable, RIB, TransactionChainListener, SchemaContextListener {
+ private static final Logger LOG = LoggerFactory.getLogger(RIBImpl.class);
+ private static final QName RIB_ID_QNAME = QName.create(Rib.QNAME, "id").intern();
+ private static final ContainerNode EMPTY_TABLE_ATTRIBUTES = ImmutableNodes.containerNode(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.rib.tables.Attributes.QNAME);
+ private static final int MAX_REGISTRATION_ATTEMPTS = 10;
+ private static final int SLEEP_TIME = MAX_REGISTRATION_ATTEMPTS;
+
+ private final BGPDispatcher dispatcher;
+ private final AsNumber localAs;
+ private final BgpId bgpIdentifier;
+ private final Set<BgpTableType> localTables;
+ private final Set<TablesKey> localTablesKeys;
+ private final DOMDataBroker domDataBroker;
+ private final RIBExtensionConsumerContext extensions;
+ private final YangInstanceIdentifier yangRibId;
+ private final RIBSupportContextRegistryImpl ribContextRegistry;
+ private final CodecsRegistryImpl codecsRegistry;
+ private final ServiceGroupIdentifier serviceGroupIdentifier;
+ private final ClusterSingletonServiceProvider provider;
+ private final BgpDeployer.WriteConfiguration configurationWriter;
+ private ClusterSingletonServiceRegistration registration;
+ private final DOMDataBrokerExtension service;
+ private final Map<TransactionChain, LocRibWriter> txChainToLocRibWriter = new HashMap<>();
+ private final BGPConfigModuleTracker configModuleTracker;
+ private final BGPOpenConfigProvider openConfigProvider;
+ private final Map<TablesKey, PathSelectionMode> bestPathSelectionStrategies;
+ private final ImportPolicyPeerTracker importPolicyPeerTracker;
+ private final RIBImplRuntimeMXBeanImpl renderStats;
+ private final RibId ribId;
+ private final Map<TablesKey, ExportPolicyPeerTracker> exportPolicyPeerTrackerMap;
+
+ private DOMTransactionChain domChain;
+ @GuardedBy("this")
+ private boolean isServiceInstantiated;
+
+ public RIBImpl(final ClusterSingletonServiceProvider provider, final RibId ribId, final AsNumber localAs, final BgpId localBgpId,
+ final ClusterIdentifier clusterId, final RIBExtensionConsumerContext extensions, final BGPDispatcher dispatcher,
+ final BindingCodecTreeFactory codecFactory, final DOMDataBroker domDataBroker, final List<BgpTableType> localTables,
+ @Nonnull final Map<TablesKey, PathSelectionMode> bestPathSelectionStrategies, final GeneratedClassLoadingStrategy classStrategy,
+ final BGPConfigModuleTracker moduleTracker, final BGPOpenConfigProvider openConfigProvider,
+ final BgpDeployer.WriteConfiguration configurationWriter) {
+
+ super(InstanceIdentifier.create(BgpRib.class).child(Rib.class, new RibKey(Preconditions.checkNotNull(ribId))));
+ this.localAs = Preconditions.checkNotNull(localAs);
+ this.bgpIdentifier = Preconditions.checkNotNull(localBgpId);
+ this.dispatcher = Preconditions.checkNotNull(dispatcher);
+ this.localTables = ImmutableSet.copyOf(localTables);
+ this.localTablesKeys = new HashSet<>();
+ this.domDataBroker = Preconditions.checkNotNull(domDataBroker);
+ this.service = this.domDataBroker.getSupportedExtensions().get(DOMDataTreeChangeService.class);
+ this.extensions = Preconditions.checkNotNull(extensions);
+ this.codecsRegistry = CodecsRegistryImpl.create(codecFactory, classStrategy);
+ 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();
+ this.configModuleTracker = moduleTracker;
+ this.openConfigProvider = openConfigProvider;
+ this.bestPathSelectionStrategies = Preconditions.checkNotNull(bestPathSelectionStrategies);
+ final ClusterIdentifier cId = (clusterId == null) ? new ClusterIdentifier(localBgpId) : clusterId;
+ this.renderStats = new RIBImplRuntimeMXBeanImpl(localBgpId, ribId, localAs, cId);
+ this.ribId = ribId;
+ final PolicyDatabase policyDatabase = new PolicyDatabase(this.localAs.getValue(), localBgpId, cId);
+ this.importPolicyPeerTracker = new ImportPolicyPeerTrackerImpl(policyDatabase);
+ this.serviceGroupIdentifier = ServiceGroupIdentifier.create(this.ribId.getValue() + "-service-group");
+ Preconditions.checkNotNull(provider, "ClusterSingletonServiceProvider is null");
+ this.provider = provider;
+ this.configurationWriter = configurationWriter;
+
+ final ImmutableMap.Builder<TablesKey, ExportPolicyPeerTracker> exportPolicies = new ImmutableMap.Builder<>();
+ for (final BgpTableType t : this.localTables) {
+ final TablesKey key = new TablesKey(t.getAfi(), t.getSafi());
+ this.localTablesKeys.add(key);
+ exportPolicies.put(key, new ExportPolicyPeerTrackerImpl(policyDatabase, key));
+ }
+ this.exportPolicyPeerTrackerMap = exportPolicies.build();
+
+ LOG.info("RIB Singleton Service {} registered, RIB {}", getIdentifier().getValue(), this.ribId.getValue());
+ //this need to be always the last step
+ this.registration = registerClusterSingletonService(this);
+ }
+
+ public RIBImpl(final ClusterSingletonServiceProvider provider, final RibId ribId, final AsNumber localAs, final BgpId localBgpId, @Nullable final ClusterIdentifier clusterId,
+ final RIBExtensionConsumerContext extensions, final BGPDispatcher dispatcher, final BindingCodecTreeFactory codecFactory,
+ final DOMDataBroker domDataBroker, final List<BgpTableType> localTables, final Map<TablesKey, PathSelectionMode> bestPathSelectionstrategies,
+ final GeneratedClassLoadingStrategy classStrategy, final BgpDeployer.WriteConfiguration configurationWriter) {
+ this(provider, ribId, localAs, localBgpId, clusterId, extensions, dispatcher, codecFactory,
+ domDataBroker, localTables, bestPathSelectionstrategies, classStrategy, null, null, configurationWriter);
+ }
+
+ private void startLocRib(final TablesKey key) {
+ LOG.debug("Creating LocRib table for {}", key);
+ // create locRibWriter for each table
+ final DOMDataWriteTransaction tx = this.domChain.newWriteOnlyTransaction();
+
+ final DataContainerNodeBuilder<NodeIdentifierWithPredicates, MapEntryNode> table = ImmutableNodes.mapEntryBuilder();
+ table.withNodeIdentifier(RibSupportUtils.toYangTablesKey(key));
+ table.withChild(EMPTY_TABLE_ATTRIBUTES);
+
+ final NodeIdentifierWithPredicates tableKey = RibSupportUtils.toYangTablesKey(key);
+ final InstanceIdentifierBuilder tableId = YangInstanceIdentifier.builder(this.yangRibId.node(LocRib.QNAME).node(Tables.QNAME));
+ tableId.nodeWithKey(tableKey.getNodeType(), tableKey.getKeyValues());
+ for (final Entry<QName, Object> e : tableKey.getKeyValues().entrySet()) {
+ table.withChild(ImmutableNodes.leafNode(e.getKey(), e.getValue()));
+ }
+
+ final ChoiceNode routes = this.ribContextRegistry.getRIBSupportContext(key).getRibSupport().emptyRoutes();
+ table.withChild(routes);
+
+ tx.put(LogicalDatastoreType.OPERATIONAL, tableId.build(), table.build());
+ try {
+ tx.submit().checkedGet();
+ } catch (final TransactionCommitFailedException e1) {
+ LOG.error("Failed to initiate LocRIB for key {}", key, e1);
+ }
+ createLocRibWriter(key);
+ }
+
+ private synchronized void createLocRibWriter(final TablesKey key) {
+ LOG.debug("Creating LocRIB writer for key {}", key);
+ final DOMTransactionChain txChain = createPeerChain(this);
+ PathSelectionMode pathSelectionStrategy = this.bestPathSelectionStrategies.get(key);
+ if (pathSelectionStrategy == null) {
+ pathSelectionStrategy = BasePathSelectionModeFactory.createBestPathSelectionStrategy();
+ }
+
+ final LocRibWriter locRibWriter = LocRibWriter.create(this.ribContextRegistry, key, txChain,
+ getYangRibId(), this.localAs, getService(), this.exportPolicyPeerTrackerMap.get(key),
+ pathSelectionStrategy, this.renderStats.getLocRibRouteCounter().init(key));
+ this.txChainToLocRibWriter.put(txChain, locRibWriter);
+ }
+
+ @Override
+ public String toString() {
+ return addToStringAttributes(MoreObjects.toStringHelper(this)).toString();
+ }
+
+ protected ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) {
+ return toStringHelper;
+ }
+
+ @Override
+ public synchronized void close() throws Exception {
+ if (this.registration != null) {
+ this.registration.close();
+ this.registration = null;
+ }
+ }
+
+ @Override
+ public AsNumber getLocalAs() {
+ return this.localAs;
+ }
+
+ @Override
+ public BgpId getBgpIdentifier() {
+ return this.bgpIdentifier;
+ }
+
+ @Nonnull
+ @Override
+ public Set<? extends BgpTableType> getLocalTables() {
+ return this.localTables;
+ }
+
+ @Override
+ public BGPDispatcher getDispatcher() {
+ return this.dispatcher;
+ }
+
+ @Override
+ public synchronized void onTransactionChainFailed(final TransactionChain<?, ?> chain, final AsyncTransaction<?, ?> 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 DOMTransactionChain newChain = createPeerChain(this);
+ locRibWriter.restart(newChain);
+ this.txChainToLocRibWriter.put(newChain, locRibWriter);
+ }
+ }
+
+ @Override
+ public void onTransactionChainSuccessful(final TransactionChain<?, ?> chain) {
+ LOG.info("RIB {} closed successfully", getInstanceIdentifier());
+ }
+
+ @Override
+ public Set<TablesKey> getLocalTablesKeys() {
+ return this.localTablesKeys;
+ }
+
+ @Override
+ public DOMDataTreeChangeService getService() {
+ return (DOMDataTreeChangeService) this.service;
+ }
+
+ @Override
+ public BGPRenderStats getRenderStats() {
+ return this.renderStats;
+ }
+
+ @Override
+ public YangInstanceIdentifier getYangRibId() {
+ return this.yangRibId;
+ }
+
+ @Override
+ public DOMTransactionChain createPeerChain(final TransactionChainListener listener) {
+ return this.domDataBroker.createTransactionChain(listener);
+ }
+
+ @Override
+ public RIBExtensionConsumerContext getRibExtensions() {
+ return this.extensions;
+ }
+
+ @Override
+ public RIBSupportContextRegistry getRibSupportContext() {
+ return this.ribContextRegistry;
+ }
+
+ @Override
+ public void onGlobalContextUpdated(final SchemaContext context) {
+ this.codecsRegistry.onSchemaContextUpdated(context);
+ }
+
+ @Override
+ public CodecsRegistry getCodecsRegistry() {
+ return this.codecsRegistry;
+ }
+
+ @Override
+ public Optional<BGPOpenConfigProvider> getOpenConfigProvider() {
+ return Optional.fromNullable(this.openConfigProvider);
+ }
+
+ @Override
+ public ImportPolicyPeerTracker getImportPolicyPeerTracker() {
+ return this.importPolicyPeerTracker;
+ }
+
+ @Override
+ public ExportPolicyPeerTracker getExportPolicyPeerTracker(final TablesKey tablesKey) {
+ return this.exportPolicyPeerTrackerMap.get(tablesKey);
+ }
+
+ @Override
+ public synchronized void instantiateServiceInstance() {
+ this.isServiceInstantiated = true;
+ this.domChain = this.domDataBroker.createTransactionChain(this);
+ if(this.configurationWriter != null) {
+ this.configurationWriter.apply();
+ }
+ LOG.info("RIB Singleton Service {} instantiated, RIB {}", getIdentifier().getValue(), this.ribId.getValue());
+ LOG.debug("Instantiating RIB table {} at {}", this.ribId , this.yangRibId);
+
+ final ContainerNode bgpRib = Builders.containerBuilder().withNodeIdentifier(new NodeIdentifier(BgpRib.QNAME))
+ .addChild(ImmutableNodes.mapNodeBuilder(Rib.QNAME).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())
+ .build()).build();
+
+
+ final DOMDataWriteTransaction trans = this.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);
+
+ try {
+ trans.submit().checkedGet();
+ } catch (final TransactionCommitFailedException e) {
+ LOG.error("Failed to initiate RIB {}", this.yangRibId, e);
+ }
+
+ LOG.debug("Effective RIB created.");
+
+ this.localTablesKeys.forEach(this::startLocRib);
+ if (this.configModuleTracker != null) {
+ this.configModuleTracker.onInstanceCreate();
+ }
+ }
+
+ @Override
+ public synchronized ListenableFuture<Void> closeServiceInstance() {
+ if(!this.isServiceInstantiated) {
+ LOG.trace("RIB Singleton Service {} already closed, RIB {}", getIdentifier().getValue(),
+ this.ribId.getValue());
+ return Futures.immediateFuture(null);
+ }
+ LOG.info("Close RIB Singleton Service {}, RIB {}", getIdentifier().getValue(), this.ribId.getValue());
+ this.isServiceInstantiated = false;
+
+ this.txChainToLocRibWriter.values().forEach(LocRibWriter::close);
+ this.txChainToLocRibWriter.clear();
+
+ this.renderStats.getLocRibRouteCounter().resetAll();
+
+ if (this.configModuleTracker != null) {
+ this.configModuleTracker.onInstanceClose();
+ }
+
+ final DOMDataWriteTransaction t = this.domChain.newWriteOnlyTransaction();
+ t.delete(LogicalDatastoreType.OPERATIONAL, getYangRibId());
+ final CheckedFuture<Void, TransactionCommitFailedException> cleanFuture = t.submit();
+
+ this.domChain.close();
+
+ return cleanFuture;
+ }
+
+ @Override
+ public ServiceGroupIdentifier getIdentifier() {
+ return this.serviceGroupIdentifier;
+ }
+
+ @Override
+ public ClusterSingletonServiceRegistration registerClusterSingletonService(final ClusterSingletonService clusterSingletonService) {
+ return ClusterSingletonServiceRegistrationHelper.registerSingletonService(this.provider, clusterSingletonService, MAX_REGISTRATION_ATTEMPTS,
+ SLEEP_TIME);
+ }
+
+ @Override
+ public ServiceGroupIdentifier getRibIServiceGroupIdentifier() {
+ return getIdentifier();
+ }