X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=netconf%2Fsal-netconf-connector%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fnetconf%2Fsal%2Fconnect%2Fnetconf%2FNetconfDevice.java;h=f29bd2422b1f71c420c0c668aec316a5c2245a76;hb=451131b35737d7e449714309732b30cb91d3bc44;hp=b78011460e4e81f4544c79863184e7f7089ea429;hpb=21588aadb96699b6f4f87e2cbbbb08fe1e38ed78;p=netconf.git diff --git a/netconf/sal-netconf-connector/src/main/java/org/opendaylight/netconf/sal/connect/netconf/NetconfDevice.java b/netconf/sal-netconf-connector/src/main/java/org/opendaylight/netconf/sal/connect/netconf/NetconfDevice.java index b78011460e..f29bd2422b 100644 --- a/netconf/sal-netconf-connector/src/main/java/org/opendaylight/netconf/sal/connect/netconf/NetconfDevice.java +++ b/netconf/sal-netconf-connector/src/main/java/org/opendaylight/netconf/sal/connect/netconf/NetconfDevice.java @@ -7,123 +7,133 @@ */ package org.opendaylight.netconf.sal.connect.netconf; -import com.google.common.base.Optional; -import com.google.common.base.Preconditions; +import static com.google.common.base.Preconditions.checkState; +import static java.util.Objects.requireNonNull; +import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_GET_NODEID; + import com.google.common.base.Predicates; import com.google.common.collect.Collections2; -import com.google.common.collect.Lists; +import com.google.common.collect.ImmutableMap; +import com.google.common.collect.ImmutableSet; import com.google.common.collect.Sets; -import com.google.common.util.concurrent.CheckedFuture; import com.google.common.util.concurrent.FutureCallback; import com.google.common.util.concurrent.Futures; import com.google.common.util.concurrent.ListenableFuture; import com.google.common.util.concurrent.ListeningExecutorService; import com.google.common.util.concurrent.MoreExecutors; +import com.google.common.util.concurrent.SettableFuture; import java.util.ArrayList; +import java.util.Arrays; import java.util.Collection; -import java.util.Collections; -import java.util.LinkedList; +import java.util.HashMap; +import java.util.HashSet; import java.util.List; +import java.util.Map; +import java.util.Objects; import java.util.Set; -import java.util.concurrent.Callable; -import java.util.concurrent.ExecutorService; +import java.util.concurrent.ExecutionException; import java.util.stream.Collectors; -import javax.annotation.concurrent.GuardedBy; -import org.opendaylight.controller.md.sal.dom.api.DOMNotification; -import org.opendaylight.controller.md.sal.dom.api.DOMRpcException; -import org.opendaylight.controller.md.sal.dom.api.DOMRpcResult; -import org.opendaylight.controller.md.sal.dom.api.DOMRpcService; +import org.checkerframework.checker.lock.qual.GuardedBy; +import org.eclipse.jdt.annotation.NonNull; +import org.opendaylight.mdsal.dom.api.DOMRpcResult; import org.opendaylight.netconf.api.NetconfMessage; -import org.opendaylight.netconf.sal.connect.api.MessageTransformer; -import org.opendaylight.netconf.sal.connect.api.NetconfDeviceSchemas; +import org.opendaylight.netconf.api.xml.XmlNetconfConstants; +import org.opendaylight.netconf.sal.connect.api.DeviceActionFactory; import org.opendaylight.netconf.sal.connect.api.NetconfDeviceSchemasResolver; import org.opendaylight.netconf.sal.connect.api.RemoteDevice; import org.opendaylight.netconf.sal.connect.api.RemoteDeviceCommunicator; import org.opendaylight.netconf.sal.connect.api.RemoteDeviceHandler; +import org.opendaylight.netconf.sal.connect.api.RemoteDeviceServices; +import org.opendaylight.netconf.sal.connect.api.RemoteDeviceServices.Rpcs; import org.opendaylight.netconf.sal.connect.netconf.listener.NetconfDeviceCapabilities; import org.opendaylight.netconf.sal.connect.netconf.listener.NetconfDeviceCommunicator; import org.opendaylight.netconf.sal.connect.netconf.listener.NetconfSessionPreferences; import org.opendaylight.netconf.sal.connect.netconf.sal.NetconfDeviceRpc; -import org.opendaylight.netconf.sal.connect.netconf.schema.NetconfRemoteSchemaYangSourceProvider; -import org.opendaylight.netconf.sal.connect.netconf.schema.YangLibrarySchemaYangSourceProvider; +import org.opendaylight.netconf.sal.connect.netconf.schema.mapping.BaseNetconfSchemas; import org.opendaylight.netconf.sal.connect.netconf.schema.mapping.BaseSchema; import org.opendaylight.netconf.sal.connect.netconf.schema.mapping.NetconfMessageTransformer; import org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil; import org.opendaylight.netconf.sal.connect.util.RemoteDeviceId; import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.notifications.rev120206.NetconfCapabilityChange; +import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.connection.status.available.capabilities.AvailableCapability; import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.connection.status.available.capabilities.AvailableCapabilityBuilder; import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.connection.status.unavailable.capabilities.UnavailableCapability; +import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.connection.status.unavailable.capabilities.UnavailableCapability.FailureReason; +import org.opendaylight.yangtools.concepts.Registration; +import org.opendaylight.yangtools.rfc8528.data.api.MountPointContext; +import org.opendaylight.yangtools.rfc8528.data.util.EmptyMountPointContext; +import org.opendaylight.yangtools.rfc8528.model.api.SchemaMountConstants; import org.opendaylight.yangtools.yang.common.QName; -import org.opendaylight.yangtools.yang.model.api.SchemaContext; +import org.opendaylight.yangtools.yang.common.RpcError; +import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier; +import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier; +import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode; +import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode; +import org.opendaylight.yangtools.yang.data.impl.schema.Builders; +import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext; +import org.opendaylight.yangtools.yang.model.repo.api.EffectiveModelContextFactory; import org.opendaylight.yangtools.yang.model.repo.api.MissingSchemaSourceException; -import org.opendaylight.yangtools.yang.model.repo.api.RevisionSourceIdentifier; -import org.opendaylight.yangtools.yang.model.repo.api.SchemaContextFactory; import org.opendaylight.yangtools.yang.model.repo.api.SchemaRepository; import org.opendaylight.yangtools.yang.model.repo.api.SchemaResolutionException; -import org.opendaylight.yangtools.yang.model.repo.api.SchemaSourceException; -import org.opendaylight.yangtools.yang.model.repo.api.SchemaSourceRepresentation; import org.opendaylight.yangtools.yang.model.repo.api.SourceIdentifier; import org.opendaylight.yangtools.yang.model.repo.api.YangTextSchemaSource; -import org.opendaylight.yangtools.yang.model.repo.spi.PotentialSchemaSource; -import org.opendaylight.yangtools.yang.model.repo.spi.SchemaSourceProvider; -import org.opendaylight.yangtools.yang.model.repo.spi.SchemaSourceRegistration; import org.opendaylight.yangtools.yang.model.repo.spi.SchemaSourceRegistry; -import org.opendaylight.yangtools.yang.parser.util.ASTSchemaSource; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * This is a mediator between NetconfDeviceCommunicator and NetconfDeviceSalFacade. */ -public class NetconfDevice - implements RemoteDevice { - +public class NetconfDevice implements RemoteDevice { private static final Logger LOG = LoggerFactory.getLogger(NetconfDevice.class); - protected final RemoteDeviceId id; - private final boolean reconnectOnSchemasChange; + private static final QName RFC8528_SCHEMA_MOUNTS_QNAME = QName.create( + SchemaMountConstants.RFC8528_MODULE, "schema-mounts").intern(); + private static final YangInstanceIdentifier RFC8528_SCHEMA_MOUNTS = YangInstanceIdentifier.create( + NodeIdentifier.create(RFC8528_SCHEMA_MOUNTS_QNAME)); - protected final SchemaContextFactory schemaContextFactory; - private final RemoteDeviceHandler salFacade; - private final ListeningExecutorService processingExecutor; + protected final RemoteDeviceId id; + protected final EffectiveModelContextFactory schemaContextFactory; protected final SchemaSourceRegistry schemaRegistry; protected final SchemaRepository schemaRepository; + + protected final List sourceRegistrations = new ArrayList<>(); + + private final RemoteDeviceHandler salFacade; + private final ListeningExecutorService processingExecutor; + private final DeviceActionFactory deviceActionFactory; private final NetconfDeviceSchemasResolver stateSchemasResolver; private final NotificationHandler notificationHandler; - protected final List> sourceRegistrations = - new ArrayList<>(); + private final boolean reconnectOnSchemasChange; + private final BaseNetconfSchemas baseSchemas; + @GuardedBy("this") private boolean connected = false; // Message transformer is constructed once the schemas are available - private MessageTransformer messageTransformer; + private NetconfMessageTransformer messageTransformer; - /** - * Create rpc implementation capable of handling RPC for monitoring and notifications - * even before the schemas of remote device are downloaded. - */ - static NetconfDeviceRpc getRpcForInitialization(final NetconfDeviceCommunicator listener, - final boolean notificationSupport) { - final BaseSchema baseSchema = notificationSupport - ? BaseSchema.BASE_NETCONF_CTX_WITH_NOTIFICATIONS - : BaseSchema.BASE_NETCONF_CTX; - - return new NetconfDeviceRpc(baseSchema.getSchemaContext(), listener, - new NetconfMessageTransformer(baseSchema.getSchemaContext(), false, baseSchema)); + public NetconfDevice(final SchemaResourcesDTO schemaResourcesDTO, final BaseNetconfSchemas baseSchemas, + final RemoteDeviceId id, final RemoteDeviceHandler salFacade, + final ListeningExecutorService globalProcessingExecutor, final boolean reconnectOnSchemasChange) { + this(schemaResourcesDTO, baseSchemas, id, salFacade, globalProcessingExecutor, reconnectOnSchemasChange, null); } - public NetconfDevice(final SchemaResourcesDTO schemaResourcesDTO, final RemoteDeviceId id, - final RemoteDeviceHandler salFacade, - final ExecutorService globalProcessingExecutor, final boolean reconnectOnSchemasChange) { + public NetconfDevice(final SchemaResourcesDTO schemaResourcesDTO, final BaseNetconfSchemas baseSchemas, + final RemoteDeviceId id, final RemoteDeviceHandler salFacade, + final ListeningExecutorService globalProcessingExecutor, final boolean reconnectOnSchemasChange, + final DeviceActionFactory deviceActionFactory) { + this.baseSchemas = requireNonNull(baseSchemas); this.id = id; this.reconnectOnSchemasChange = reconnectOnSchemasChange; - this.schemaRegistry = schemaResourcesDTO.getSchemaRegistry(); - this.schemaRepository = schemaResourcesDTO.getSchemaRepository(); - this.schemaContextFactory = schemaResourcesDTO.getSchemaContextFactory(); + this.deviceActionFactory = deviceActionFactory; + schemaRegistry = schemaResourcesDTO.getSchemaRegistry(); + schemaRepository = schemaResourcesDTO.getSchemaRepository(); + schemaContextFactory = schemaResourcesDTO.getSchemaContextFactory(); this.salFacade = salFacade; - this.stateSchemasResolver = schemaResourcesDTO.getStateSchemasResolver(); - this.processingExecutor = MoreExecutors.listeningDecorator(globalProcessingExecutor); - this.notificationHandler = new NotificationHandler(salFacade, id); + stateSchemasResolver = schemaResourcesDTO.getStateSchemasResolver(); + processingExecutor = requireNonNull(globalProcessingExecutor); + notificationHandler = new NotificationHandler(salFacade, id); } @Override @@ -137,35 +147,42 @@ public class NetconfDevice setConnected(true); LOG.debug("{}: Session to remote device established with {}", id, remoteSessionCapabilities); - final NetconfDeviceRpc initRpc = - getRpcForInitialization(listener, remoteSessionCapabilities.isNotificationsSupported()); - final DeviceSourcesResolver task = - new DeviceSourcesResolver(remoteSessionCapabilities, id, stateSchemasResolver, initRpc); - final ListenableFuture sourceResolverFuture = processingExecutor.submit(task); + final BaseSchema baseSchema = resolveBaseSchema(remoteSessionCapabilities.isNotificationsSupported()); + final NetconfDeviceRpc initRpc = new NetconfDeviceRpc(baseSchema.getEffectiveModelContext(), listener, + new NetconfMessageTransformer(baseSchema.getMountPointContext(), false, baseSchema)); + final ListenableFuture sourceResolverFuture = processingExecutor.submit( + new DeviceSourcesResolver(id, baseSchema, initRpc, remoteSessionCapabilities, stateSchemasResolver)); if (shouldListenOnSchemaChange(remoteSessionCapabilities)) { registerToBaseNetconfStream(initRpc, listener); } - final FutureCallback resolvedSourceCallback = new FutureCallback() { - @Override - public void onSuccess(final DeviceSources result) { - addProvidedSourcesToSchemaRegistry(result); - setUpSchema(result); - } + // Set up the SchemaContext for the device + final ListenableFuture futureSchema = Futures.transformAsync(sourceResolverFuture, + deviceSources -> assembleSchemaContext(deviceSources, remoteSessionCapabilities), processingExecutor); - private void setUpSchema(final DeviceSources result) { - processingExecutor.submit(new SchemaSetup(result, remoteSessionCapabilities, listener)); - } + // Potentially acquire mount point list and interpret it + final ListenableFuture futureContext = Futures.transformAsync(futureSchema, + result -> Futures.transform(createMountPointContext(result.modelContext(), baseSchema, listener), + mount -> new NetconfDeviceSchema(result.capabilities(), mount), processingExecutor), + processingExecutor); + Futures.addCallback(futureContext, new FutureCallback<>() { @Override - public void onFailure(final Throwable throwable) { - LOG.warn("{}: Unexpected error resolving device sources: {}", id, throwable); - handleSalInitializationFailure(throwable, listener); + public void onSuccess(final NetconfDeviceSchema result) { + handleSalInitializationSuccess(result, remoteSessionCapabilities, + getDeviceSpecificRpc(result.mountContext(), listener, baseSchema), listener); } - }; - Futures.addCallback(sourceResolverFuture, resolvedSourceCallback); + @Override + public void onFailure(final Throwable cause) { + LOG.warn("{}: Unexpected error resolving device sources", id, cause); + // FIXME: this causes salFacade to see onDeviceDisconnected() and then onDeviceFailed(), which is quite + // weird + handleSalInitializationFailure(cause, listener); + salFacade.onDeviceFailed(cause); + } + }, MoreExecutors.directExecutor()); } private void registerToBaseNetconfStream(final NetconfDeviceRpc deviceRpc, @@ -173,32 +190,23 @@ public class NetconfDevice // TODO check whether the model describing create subscription is present in schema // Perhaps add a default schema context to support create-subscription if the model was not provided // (same as what we do for base netconf operations in transformer) - final CheckedFuture rpcResultListenableFuture = deviceRpc.invokeRpc( - NetconfMessageTransformUtil.toPath(NetconfMessageTransformUtil.CREATE_SUBSCRIPTION_RPC_QNAME), + final ListenableFuture rpcResultListenableFuture = deviceRpc.invokeRpc( + NetconfMessageTransformUtil.CREATE_SUBSCRIPTION_RPC_QNAME, NetconfMessageTransformUtil.CREATE_SUBSCRIPTION_RPC_CONTENT); - final NotificationHandler.NotificationFilter filter = new NotificationHandler.NotificationFilter() { - @Override - public Optional filterNotification(final DOMNotification notification) { - if (isCapabilityChanged(notification)) { - LOG.info("{}: Schemas change detected, reconnecting", id); - // Only disconnect is enough, - // the reconnecting nature of the connector will take care of reconnecting - listener.disconnect(); - return Optional.absent(); - } - return Optional.of(notification); - } - - private boolean isCapabilityChanged(final DOMNotification notification) { - return notification.getBody().getNodeType().equals(NetconfCapabilityChange.QNAME); - } - }; - Futures.addCallback(rpcResultListenableFuture, new FutureCallback() { @Override public void onSuccess(final DOMRpcResult domRpcResult) { - notificationHandler.addNotificationFilter(filter); + notificationHandler.addNotificationFilter(notification -> { + if (NetconfCapabilityChange.QNAME.equals(notification.getBody().getIdentifier().getNodeType())) { + LOG.info("{}: Schemas change detected, reconnecting", id); + // Only disconnect is enough, + // the reconnecting nature of the connector will take care of reconnecting + listener.disconnect(); + return false; + } + return true; + }); } @Override @@ -206,27 +214,27 @@ public class NetconfDevice LOG.warn("Unable to subscribe to base notification stream. Schemas will not be reloaded on the fly", throwable); } - }); + }, MoreExecutors.directExecutor()); } private boolean shouldListenOnSchemaChange(final NetconfSessionPreferences remoteSessionCapabilities) { return remoteSessionCapabilities.isNotificationsSupported() && reconnectOnSchemasChange; } - private synchronized void handleSalInitializationSuccess(final SchemaContext result, - final NetconfSessionPreferences remoteSessionCapabilities, - final DOMRpcService deviceRpc) { + private synchronized void handleSalInitializationSuccess(final NetconfDeviceSchema deviceSchema, + final NetconfSessionPreferences remoteSessionCapabilities, final Rpcs deviceRpc, + final RemoteDeviceCommunicator listener) { //NetconfDevice.SchemaSetup can complete after NetconfDeviceCommunicator was closed. In that case do nothing, //since salFacade.onDeviceDisconnected was already called. if (connected) { - final BaseSchema baseSchema = - remoteSessionCapabilities.isNotificationsSupported() - ? BaseSchema.BASE_NETCONF_CTX_WITH_NOTIFICATIONS : BaseSchema.BASE_NETCONF_CTX; - messageTransformer = new NetconfMessageTransformer(result, true, baseSchema); + final var mount = deviceSchema.mountContext(); + messageTransformer = new NetconfMessageTransformer(mount, true, + resolveBaseSchema(remoteSessionCapabilities.isNotificationsSupported())); - updateTransformer(messageTransformer); // salFacade.onDeviceConnected has to be called before the notification handler is initialized - salFacade.onDeviceConnected(result, remoteSessionCapabilities, deviceRpc); + salFacade.onDeviceConnected(deviceSchema, remoteSessionCapabilities, + new RemoteDeviceServices(deviceRpc, deviceActionFactory == null ? null + : deviceActionFactory.createDeviceAction(messageTransformer, listener))); notificationHandler.onRemoteSchemaUp(messageTransformer); LOG.info("{}: Netconf connector initialized successfully", id); @@ -235,8 +243,7 @@ public class NetconfDevice } } - private void handleSalInitializationFailure(final Throwable throwable, - final RemoteDeviceCommunicator listener) { + private void handleSalInitializationFailure(final Throwable throwable, final RemoteDeviceCommunicator listener) { LOG.error("{}: Initialization in sal failed, disconnecting from device", id, throwable); listener.close(); onRemoteSessionDown(); @@ -250,7 +257,7 @@ public class NetconfDevice updateTransformer(null); } - private void updateTransformer(final MessageTransformer transformer) { + private synchronized void updateTransformer(final NetconfMessageTransformer transformer) { messageTransformer = transformer; } @@ -258,13 +265,50 @@ public class NetconfDevice this.connected = connected; } - private void addProvidedSourcesToSchemaRegistry(final DeviceSources deviceSources) { - final SchemaSourceProvider yangProvider = deviceSources.getSourceProvider(); - for (final SourceIdentifier sourceId : deviceSources.getProvidedSources()) { - sourceRegistrations.add(schemaRegistry.registerSchemaSource(yangProvider, - PotentialSchemaSource.create( - sourceId, YangTextSchemaSource.class, PotentialSchemaSource.Costs.REMOTE_IO.getValue()))); + private ListenableFuture assembleSchemaContext(final DeviceSources deviceSources, + final NetconfSessionPreferences remoteSessionCapabilities) { + LOG.debug("{}: Resolved device sources to {}", id, deviceSources); + + sourceRegistrations.addAll(deviceSources.register(schemaRegistry)); + + return new SchemaSetup(deviceSources, remoteSessionCapabilities).startResolution(); + } + + private ListenableFuture<@NonNull MountPointContext> createMountPointContext( + final EffectiveModelContext schemaContext, final BaseSchema baseSchema, + final NetconfDeviceCommunicator listener) { + final MountPointContext emptyContext = new EmptyMountPointContext(schemaContext); + if (schemaContext.findModule(SchemaMountConstants.RFC8528_MODULE).isEmpty()) { + return Futures.immediateFuture(emptyContext); } + + // Create a temporary RPC invoker and acquire the mount point tree + LOG.debug("{}: Acquiring available mount points", id); + final NetconfDeviceRpc deviceRpc = new NetconfDeviceRpc(schemaContext, listener, + new NetconfMessageTransformer(emptyContext, false, baseSchema)); + + return Futures.transform(deviceRpc.invokeRpc(NetconfMessageTransformUtil.NETCONF_GET_QNAME, + Builders.containerBuilder().withNodeIdentifier(NETCONF_GET_NODEID) + .withChild(NetconfMessageTransformUtil.toFilterStructure(RFC8528_SCHEMA_MOUNTS, schemaContext)) + .build()), rpcResult -> processSchemaMounts(rpcResult, emptyContext), MoreExecutors.directExecutor()); + } + + private MountPointContext processSchemaMounts(final DOMRpcResult rpcResult, final MountPointContext emptyContext) { + final Collection errors = rpcResult.getErrors(); + if (!errors.isEmpty()) { + LOG.warn("{}: Schema-mounts acquisition resulted in errors {}", id, errors); + } + final NormalizedNode schemaMounts = rpcResult.getResult(); + if (schemaMounts == null) { + LOG.debug("{}: device does not define any schema mounts", id); + return emptyContext; + } + if (!(schemaMounts instanceof ContainerNode)) { + LOG.warn("{}: ignoring non-container schema mounts {}", id, schemaMounts); + return emptyContext; + } + + return DeviceMountPointContext.create(emptyContext, (ContainerNode) schemaMounts); } @Override @@ -273,10 +317,8 @@ public class NetconfDevice notificationHandler.onRemoteSchemaDown(); salFacade.onDeviceDisconnected(); - for (final SchemaSourceRegistration sourceRegistration - : sourceRegistrations) { - sourceRegistration.close(); - } + sourceRegistrations.forEach(Registration::close); + sourceRegistrations.clear(); resetMessageTransformer(); } @@ -291,23 +333,33 @@ public class NetconfDevice notificationHandler.handleNotification(notification); } + private BaseSchema resolveBaseSchema(final boolean notificationSupport) { + return notificationSupport ? baseSchemas.getBaseSchemaWithNotifications() : baseSchemas.getBaseSchema(); + } + + protected NetconfDeviceRpc getDeviceSpecificRpc(final MountPointContext result, + final RemoteDeviceCommunicator listener, final BaseSchema schema) { + return new NetconfDeviceRpc(result.getEffectiveModelContext(), listener, + new NetconfMessageTransformer(result, true, schema)); + } + /** * Just a transfer object containing schema related dependencies. Injected in constructor. */ public static class SchemaResourcesDTO { private final SchemaSourceRegistry schemaRegistry; private final SchemaRepository schemaRepository; - private final SchemaContextFactory schemaContextFactory; + private final EffectiveModelContextFactory schemaContextFactory; private final NetconfDeviceSchemasResolver stateSchemasResolver; public SchemaResourcesDTO(final SchemaSourceRegistry schemaRegistry, final SchemaRepository schemaRepository, - final SchemaContextFactory schemaContextFactory, + final EffectiveModelContextFactory schemaContextFactory, final NetconfDeviceSchemasResolver deviceSchemasResolver) { - this.schemaRegistry = Preconditions.checkNotNull(schemaRegistry); - this.schemaRepository = Preconditions.checkNotNull(schemaRepository); - this.schemaContextFactory = Preconditions.checkNotNull(schemaContextFactory); - this.stateSchemasResolver = Preconditions.checkNotNull(deviceSchemasResolver); + this.schemaRegistry = requireNonNull(schemaRegistry); + this.schemaRepository = requireNonNull(schemaRepository); + this.schemaContextFactory = requireNonNull(schemaContextFactory); + stateSchemasResolver = requireNonNull(deviceSchemasResolver); } public SchemaSourceRegistry getSchemaRegistry() { @@ -318,7 +370,7 @@ public class NetconfDevice return schemaRepository; } - public SchemaContextFactory getSchemaContextFactory() { + public EffectiveModelContextFactory getSchemaContextFactory() { return schemaContextFactory; } @@ -328,225 +380,164 @@ public class NetconfDevice } /** - * Schema building callable. + * A dedicated exception to indicate when we fail to setup an {@link EffectiveModelContext}. */ - private static class DeviceSourcesResolver implements Callable { - - private final NetconfDeviceRpc deviceRpc; - private final NetconfSessionPreferences remoteSessionCapabilities; - private final RemoteDeviceId id; - private final NetconfDeviceSchemasResolver stateSchemasResolver; - - DeviceSourcesResolver(final NetconfDeviceRpc deviceRpc, - final NetconfSessionPreferences remoteSessionCapabilities, - final RemoteDeviceId id, final NetconfDeviceSchemasResolver stateSchemasResolver) { - this.deviceRpc = deviceRpc; - this.remoteSessionCapabilities = remoteSessionCapabilities; - this.id = id; - this.stateSchemasResolver = stateSchemasResolver; - } + public static final class EmptySchemaContextException extends Exception { + private static final long serialVersionUID = 1L; - DeviceSourcesResolver(final NetconfSessionPreferences remoteSessionCapabilities, final RemoteDeviceId id, - final NetconfDeviceSchemasResolver stateSchemasResolver, - final NetconfDeviceRpc rpcForMonitoring) { - this(rpcForMonitoring, remoteSessionCapabilities, id, stateSchemasResolver); - } - - @Override - public DeviceSources call() throws Exception { - final NetconfDeviceSchemas availableSchemas = - stateSchemasResolver.resolve(deviceRpc, remoteSessionCapabilities, id); - LOG.debug("{}: Schemas exposed by ietf-netconf-monitoring: {}", id, - availableSchemas.getAvailableYangSchemasQNames()); - - final Set requiredSources = Sets.newHashSet(remoteSessionCapabilities.getModuleBasedCaps()); - final Set providedSources = availableSchemas.getAvailableYangSchemasQNames(); - - final Set requiredSourcesNotProvided = Sets.difference(requiredSources, providedSources); - if (!requiredSourcesNotProvided.isEmpty()) { - LOG.warn("{}: Netconf device does not provide all yang models reported in hello message capabilities," - + " required but not provided: {}", id, requiredSourcesNotProvided); - LOG.warn("{}: Attempting to build schema context from required sources", id); - } - - // Here all the sources reported in netconf monitoring are merged with those reported in hello. - // It is necessary to perform this since submodules are not mentioned in hello but still required. - // This clashes with the option of a user to specify supported yang models manually in configuration - // for netconf-connector and as a result one is not able to fully override yang models of a device. - // It is only possible to add additional models. - final Set providedSourcesNotRequired = Sets.difference(providedSources, requiredSources); - if (!providedSourcesNotRequired.isEmpty()) { - LOG.warn("{}: Netconf device provides additional yang models not reported in " - + "hello message capabilities: {}", id, providedSourcesNotRequired); - LOG.warn("{}: Adding provided but not required sources as required to prevent failures", id); - LOG.debug("{}: Netconf device reported in hello: {}", id, requiredSources); - requiredSources.addAll(providedSourcesNotRequired); - } - - final SchemaSourceProvider sourceProvider; - if (availableSchemas instanceof LibraryModulesSchemas) { - sourceProvider = new YangLibrarySchemaYangSourceProvider(id, - ((LibraryModulesSchemas) availableSchemas).getAvailableModels()); - } else { - sourceProvider = new NetconfRemoteSchemaYangSourceProvider(id, deviceRpc); - } - - return new DeviceSources(requiredSources, providedSources, sourceProvider); + public EmptySchemaContextException(final String message) { + super(message); } } /** - * Contains RequiredSources - sources from capabilities. + * {@link NetconfDeviceCapabilities} and {@link EffectiveModelContext}. */ - private static final class DeviceSources { - private final Set requiredSources; - private final Set providedSources; - private final SchemaSourceProvider sourceProvider; - - DeviceSources(final Set requiredSources, final Set providedSources, - final SchemaSourceProvider sourceProvider) { - this.requiredSources = requiredSources; - this.providedSources = providedSources; - this.sourceProvider = sourceProvider; - } - - public Set getRequiredSourcesQName() { - return requiredSources; - } - - public Set getProvidedSourcesQName() { - return providedSources; - } + private record SchemaResult( + @NonNull NetconfDeviceCapabilities capabilities, + @NonNull EffectiveModelContext modelContext) { - public Collection getRequiredSources() { - return Collections2.transform(requiredSources, DeviceSources::toSourceId); - } - - public Collection getProvidedSources() { - return Collections2.transform(providedSources, DeviceSources::toSourceId); - } - - public SchemaSourceProvider getSourceProvider() { - return sourceProvider; - } - - private static SourceIdentifier toSourceId(final QName input) { - return RevisionSourceIdentifier.create(input.getLocalName(), - Optional.fromNullable(input.getFormattedRevision())); + SchemaResult { + requireNonNull(capabilities); + requireNonNull(modelContext); } } /** * Schema builder that tries to build schema context from provided sources or biggest subset of it. */ - private final class SchemaSetup implements Runnable { + private final class SchemaSetup implements FutureCallback { + private final SettableFuture resultFuture = SettableFuture.create(); + + private final Set nonModuleBasedCapabilities = new HashSet<>(); + private final Map unresolvedCapabilites = new HashMap<>(); + private final Set resolvedCapabilities = new HashSet<>(); + private final DeviceSources deviceSources; private final NetconfSessionPreferences remoteSessionCapabilities; - private final RemoteDeviceCommunicator listener; - private final NetconfDeviceCapabilities capabilities; - SchemaSetup(final DeviceSources deviceSources, final NetconfSessionPreferences remoteSessionCapabilities, - final RemoteDeviceCommunicator listener) { + private Collection requiredSources; + + SchemaSetup(final DeviceSources deviceSources, final NetconfSessionPreferences remoteSessionCapabilities) { this.deviceSources = deviceSources; this.remoteSessionCapabilities = remoteSessionCapabilities; - this.listener = listener; - this.capabilities = remoteSessionCapabilities.getNetconfDeviceCapabilities(); - } - @Override - public void run() { + // If device supports notifications and does not contain necessary modules, add them automatically + if (remoteSessionCapabilities.containsNonModuleCapability( + XmlNetconfConstants.URN_IETF_PARAMS_NETCONF_CAPABILITY_NOTIFICATION_1_0)) { + deviceSources.getRequiredSourcesQName().addAll( + Arrays.asList( + org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.notification._1._0.rev080714 + .$YangModuleInfoImpl.getInstance().getName(), + org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715 + .$YangModuleInfoImpl.getInstance().getName() + ) + ); + } - final Collection requiredSources = deviceSources.getRequiredSources(); + requiredSources = deviceSources.getRequiredSources(); final Collection missingSources = filterMissingSources(requiredSources); - capabilities.addUnresolvedCapabilities(getQNameFromSourceIdentifiers(missingSources), - UnavailableCapability.FailureReason.MissingSource); - + addUnresolvedCapabilities(getQNameFromSourceIdentifiers(missingSources), + UnavailableCapability.FailureReason.MissingSource); requiredSources.removeAll(missingSources); - setUpSchema(requiredSources); } - private Collection filterMissingSources(final Collection requiredSources) { + ListenableFuture startResolution() { + trySetupSchema(); + return resultFuture; + } - return requiredSources.parallelStream().filter(sourceIdentifier -> { - boolean remove = false; - try { - schemaRepository.getSchemaSource(sourceIdentifier, ASTSchemaSource.class).checkedGet(); - } catch (SchemaSourceException e) { - remove = true; - } - return remove; - }).collect(Collectors.toList()); + @Override + public void onSuccess(final EffectiveModelContext result) { + LOG.debug("{}: Schema context built successfully from {}", id, requiredSources); + + final Collection filteredQNames = Sets.difference(deviceSources.getRequiredSourcesQName(), + unresolvedCapabilites.keySet()); + resolvedCapabilities.addAll(filteredQNames.stream() + .map(capability -> new AvailableCapabilityBuilder() + .setCapability(capability.toString()) + .setCapabilityOrigin(remoteSessionCapabilities.capabilityOrigin(capability)) + .build()) + .collect(Collectors.toList())); + + nonModuleBasedCapabilities.addAll(remoteSessionCapabilities.nonModuleCaps().keySet().stream() + .map(capability -> new AvailableCapabilityBuilder() + .setCapability(capability) + .setCapabilityOrigin(remoteSessionCapabilities.capabilityOrigin(capability)) + .build()) + .collect(Collectors.toList())); + + + resultFuture.set(new SchemaResult(new NetconfDeviceCapabilities(ImmutableMap.copyOf(unresolvedCapabilites), + ImmutableSet.copyOf(resolvedCapabilities), ImmutableSet.copyOf(nonModuleBasedCapabilities)), result)); } - /** - * Build schema context, in case of success or final failure notify device. - */ - @SuppressWarnings("checkstyle:IllegalCatch") - private void setUpSchema(Collection requiredSources) { - while (!requiredSources.isEmpty()) { + @Override + public void onFailure(final Throwable cause) { + // schemaBuilderFuture.checkedGet() throws only SchemaResolutionException + // that might be wrapping a MissingSchemaSourceException so we need to look + // at the cause of the exception to make sure we don't misinterpret it. + if (cause instanceof MissingSchemaSourceException) { + requiredSources = handleMissingSchemaSourceException((MissingSchemaSourceException) cause); + } else if (cause instanceof SchemaResolutionException) { + requiredSources = handleSchemaResolutionException((SchemaResolutionException) cause); + } else { + LOG.debug("Unhandled failure", cause); + resultFuture.setException(cause); + // No more trying... + return; + } + + trySetupSchema(); + } + + private void trySetupSchema() { + if (!requiredSources.isEmpty()) { + // Initiate async resolution, drive it back based on the result LOG.trace("{}: Trying to build schema context from {}", id, requiredSources); + Futures.addCallback(schemaContextFactory.createEffectiveModelContext(requiredSources), this, + MoreExecutors.directExecutor()); + } else { + LOG.debug("{}: no more sources for schema context", id); + resultFuture.setException(new EmptySchemaContextException(id + ": No more sources for schema context")); + } + } + + private List filterMissingSources(final Collection origSources) { + return origSources.parallelStream().filter(sourceIdentifier -> { try { - final CheckedFuture schemaBuilderFuture = - schemaContextFactory.createSchemaContext(requiredSources); - final SchemaContext result = schemaBuilderFuture.checkedGet(); - LOG.debug("{}: Schema context built successfully from {}", id, requiredSources); - final Collection filteredQNames = Sets.difference(deviceSources.getRequiredSourcesQName(), - capabilities.getUnresolvedCapabilites().keySet()); - capabilities.addCapabilities(filteredQNames.stream().map(entry -> new AvailableCapabilityBuilder() - .setCapability(entry.toString()).setCapabilityOrigin( - remoteSessionCapabilities.getModuleBasedCapsOrigin().get(entry)).build()) - .collect(Collectors.toList())); - - capabilities.addNonModuleBasedCapabilities(remoteSessionCapabilities - .getNonModuleCaps().stream().map(entry -> new AvailableCapabilityBuilder() - .setCapability(entry).setCapabilityOrigin( - remoteSessionCapabilities.getNonModuleBasedCapsOrigin().get(entry)).build()) - .collect(Collectors.toList())); - - handleSalInitializationSuccess(result, remoteSessionCapabilities, getDeviceSpecificRpc(result)); - return; - } catch (final SchemaResolutionException e) { - // schemaBuilderFuture.checkedGet() throws only SchemaResolutionException - // that might be wrapping a MissingSchemaSourceException so we need to look - // at the cause of the exception to make sure we don't misinterpret it. - if (e.getCause() instanceof MissingSchemaSourceException) { - requiredSources = handleMissingSchemaSourceException( - requiredSources, (MissingSchemaSourceException) e.getCause()); - continue; - } - requiredSources = handleSchemaResolutionException(requiredSources, e); - } catch (final Exception e) { - // unknown error, fail - handleSalInitializationFailure(e, listener); - return; + schemaRepository.getSchemaSource(sourceIdentifier, YangTextSchemaSource.class).get(); + return false; + } catch (InterruptedException | ExecutionException e) { + return true; } + }).collect(Collectors.toList()); + } + + private void addUnresolvedCapabilities(final Collection capabilities, final FailureReason reason) { + for (QName s : capabilities) { + unresolvedCapabilites.put(s, reason); } - // No more sources, fail - final IllegalStateException cause = new IllegalStateException(id + ": No more sources for schema context"); - handleSalInitializationFailure(cause, listener); - salFacade.onDeviceFailed(cause); } - private Collection handleMissingSchemaSourceException( - final Collection requiredSources, final MissingSchemaSourceException exception) { + private List handleMissingSchemaSourceException( + final MissingSchemaSourceException exception) { // In case source missing, try without it final SourceIdentifier missingSource = exception.getSourceId(); - LOG.warn("{}: Unable to build schema context, missing source {}, will reattempt without it", id, - missingSource); + LOG.warn("{}: Unable to build schema context, missing source {}, will reattempt without it", + id, missingSource); LOG.debug("{}: Unable to build schema context, missing source {}, will reattempt without it", - exception); - final Collection qNameOfMissingSource = - getQNameFromSourceIdentifiers(Sets.newHashSet(missingSource)); + id, missingSource, exception); + final var qNameOfMissingSource = getQNameFromSourceIdentifiers(Sets.newHashSet(missingSource)); if (!qNameOfMissingSource.isEmpty()) { - capabilities.addUnresolvedCapabilities( - qNameOfMissingSource, UnavailableCapability.FailureReason.MissingSource); + addUnresolvedCapabilities(qNameOfMissingSource, UnavailableCapability.FailureReason.MissingSource); } - return stripUnavailableSource(requiredSources, missingSource); + return stripUnavailableSource(missingSource); } private Collection handleSchemaResolutionException( - final Collection requiredSources, final SchemaResolutionException resolutionException) { + final SchemaResolutionException resolutionException) { // In case resolution error, try only with resolved sources // There are two options why schema resolution exception occurred : unsatisfied imports or flawed model // FIXME Do we really have assurance that these two cases cannot happen at once? @@ -554,35 +545,29 @@ public class NetconfDevice // flawed model - exclude it final SourceIdentifier failedSourceId = resolutionException.getFailedSource(); LOG.warn("{}: Unable to build schema context, failed to resolve source {}, will reattempt without it", - id, failedSourceId); + id, failedSourceId); LOG.warn("{}: Unable to build schema context, failed to resolve source {}, will reattempt without it", - id, resolutionException); - capabilities.addUnresolvedCapabilities(getQNameFromSourceIdentifiers( - Collections.singleton(failedSourceId)), UnavailableCapability.FailureReason.UnableToResolve); - return stripUnavailableSource(requiredSources, resolutionException.getFailedSource()); + id, failedSourceId, resolutionException); + addUnresolvedCapabilities(getQNameFromSourceIdentifiers(List.of(failedSourceId)), + UnavailableCapability.FailureReason.UnableToResolve); + return stripUnavailableSource(resolutionException.getFailedSource()); } // unsatisfied imports - final Set unresolvedSources = resolutionException.getUnsatisfiedImports().keySet(); - capabilities.addUnresolvedCapabilities( - getQNameFromSourceIdentifiers(unresolvedSources), UnavailableCapability.FailureReason.UnableToResolve); + addUnresolvedCapabilities( + getQNameFromSourceIdentifiers(resolutionException.getUnsatisfiedImports().keySet()), + UnavailableCapability.FailureReason.UnableToResolve); LOG.warn("{}: Unable to build schema context, unsatisfied imports {}, will reattempt with resolved only", - id, resolutionException.getUnsatisfiedImports()); + id, resolutionException.getUnsatisfiedImports()); LOG.debug("{}: Unable to build schema context, unsatisfied imports {}, will reattempt with resolved only", - resolutionException); + id, resolutionException.getUnsatisfiedImports(), resolutionException); return resolutionException.getResolvedSources(); } - protected NetconfDeviceRpc getDeviceSpecificRpc(final SchemaContext result) { - return new NetconfDeviceRpc(result, listener, new NetconfMessageTransformer(result, true)); - } - - private Collection stripUnavailableSource(final Collection requiredSources, - final SourceIdentifier sourceIdToRemove) { - final LinkedList sourceIdentifiers = Lists.newLinkedList(requiredSources); - final boolean removed = sourceIdentifiers.remove(sourceIdToRemove); - Preconditions.checkState( - removed, "{}: Trying to remove {} from {} failed", id, sourceIdToRemove, requiredSources); - return sourceIdentifiers; + private List stripUnavailableSource(final SourceIdentifier sourceIdToRemove) { + final var tmp = new ArrayList<>(requiredSources); + checkState(tmp.remove(sourceIdToRemove), "%s: Trying to remove %s from %s failed", id, sourceIdToRemove, + requiredSources); + return tmp; } private Collection getQNameFromSourceIdentifiers(final Collection identifiers) { @@ -598,16 +583,11 @@ public class NetconfDevice private QName getQNameFromSourceIdentifier(final SourceIdentifier identifier) { // Required sources are all required and provided merged in DeviceSourcesResolver for (final QName qname : deviceSources.getRequiredSourcesQName()) { - if (!qname.getLocalName().equals(identifier.getName())) { + if (!qname.getLocalName().equals(identifier.name().getLocalName())) { continue; } - final String rev = getNullableRev(identifier); - if (rev == null) { - if (qname.getRevision() == null) { - return qname; - } - } else if (qname.getFormattedRevision().equals(rev)) { + if (Objects.equals(identifier.revision(), qname.getRevision().orElse(null))) { return qname; } } @@ -617,10 +597,5 @@ public class NetconfDevice // this capability will be removed from required sources and not reported as unresolved-capability return null; } - - private String getNullableRev(final SourceIdentifier identifier) { - final String rev = identifier.getRevision(); - return rev == null || SourceIdentifier.NOT_PRESENT_FORMATTED_REVISION.equals(rev) ? null : rev; - } } }