2 * Copyright (c) 2014 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.netconf.sal.connect.netconf.listener;
10 import com.google.common.base.Strings;
11 import com.google.common.util.concurrent.ListenableFuture;
12 import com.google.common.util.concurrent.SettableFuture;
13 import io.netty.util.concurrent.Future;
14 import java.io.EOFException;
15 import java.util.ArrayDeque;
16 import java.util.ArrayList;
17 import java.util.Iterator;
18 import java.util.List;
19 import java.util.Optional;
20 import java.util.Queue;
21 import java.util.concurrent.Semaphore;
22 import java.util.concurrent.atomic.AtomicIntegerFieldUpdater;
23 import java.util.concurrent.locks.Lock;
24 import java.util.concurrent.locks.ReentrantLock;
25 import org.opendaylight.netconf.api.FailedNetconfMessage;
26 import org.opendaylight.netconf.api.NetconfDocumentedException;
27 import org.opendaylight.netconf.api.NetconfMessage;
28 import org.opendaylight.netconf.api.NetconfTerminationReason;
29 import org.opendaylight.netconf.api.xml.XmlElement;
30 import org.opendaylight.netconf.api.xml.XmlNetconfConstants;
31 import org.opendaylight.netconf.api.xml.XmlUtil;
32 import org.opendaylight.netconf.client.NetconfClientDispatcher;
33 import org.opendaylight.netconf.client.NetconfClientSession;
34 import org.opendaylight.netconf.client.NetconfClientSessionListener;
35 import org.opendaylight.netconf.client.conf.NetconfClientConfiguration;
36 import org.opendaylight.netconf.client.conf.NetconfReconnectingClientConfiguration;
37 import org.opendaylight.netconf.sal.connect.api.RemoteDevice;
38 import org.opendaylight.netconf.sal.connect.api.RemoteDeviceCommunicator;
39 import org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil;
40 import org.opendaylight.netconf.sal.connect.util.RemoteDeviceId;
41 import org.opendaylight.yangtools.util.concurrent.FluentFutures;
42 import org.opendaylight.yangtools.yang.common.ErrorTag;
43 import org.opendaylight.yangtools.yang.common.ErrorType;
44 import org.opendaylight.yangtools.yang.common.QName;
45 import org.opendaylight.yangtools.yang.common.RpcResult;
46 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
47 import org.slf4j.Logger;
48 import org.slf4j.LoggerFactory;
50 public class NetconfDeviceCommunicator
51 implements NetconfClientSessionListener, RemoteDeviceCommunicator<NetconfMessage> {
53 private static final Logger LOG = LoggerFactory.getLogger(NetconfDeviceCommunicator.class);
55 protected final RemoteDevice<NetconfSessionPreferences, NetconfMessage, NetconfDeviceCommunicator> remoteDevice;
56 private final Optional<UserPreferences> overrideNetconfCapabilities;
57 protected final RemoteDeviceId id;
58 private final Lock sessionLock = new ReentrantLock();
60 private final Semaphore semaphore;
61 private final int concurentRpcMsgs;
63 private final Queue<Request> requests = new ArrayDeque<>();
64 private NetconfClientSession currentSession;
66 private final SettableFuture<NetconfDeviceCapabilities> firstConnectionFuture;
67 private Future<?> taskFuture;
69 // isSessionClosing indicates a close operation on the session is issued and
70 // tearDown will surely be called later to finish the close.
71 // Used to allow only one thread to enter tearDown and other threads should
72 // NOT enter it simultaneously and should end its close operation without
73 // calling tearDown to release the locks they hold to avoid deadlock.
74 private static final AtomicIntegerFieldUpdater<NetconfDeviceCommunicator> CLOSING_UPDATER =
75 AtomicIntegerFieldUpdater.newUpdater(NetconfDeviceCommunicator.class, "closing");
76 private volatile int closing;
78 public boolean isSessionClosing() {
82 public NetconfDeviceCommunicator(
83 final RemoteDeviceId id,
84 final RemoteDevice<NetconfSessionPreferences, NetconfMessage, NetconfDeviceCommunicator> remoteDevice,
85 final UserPreferences netconfSessionPreferences, final int rpcMessageLimit) {
86 this(id, remoteDevice, Optional.of(netconfSessionPreferences), rpcMessageLimit);
89 public NetconfDeviceCommunicator(
90 final RemoteDeviceId id,
91 final RemoteDevice<NetconfSessionPreferences, NetconfMessage, NetconfDeviceCommunicator> remoteDevice,
92 final int rpcMessageLimit) {
93 this(id, remoteDevice, Optional.empty(), rpcMessageLimit);
96 private NetconfDeviceCommunicator(
97 final RemoteDeviceId id,
98 final RemoteDevice<NetconfSessionPreferences, NetconfMessage, NetconfDeviceCommunicator> remoteDevice,
99 final Optional<UserPreferences> overrideNetconfCapabilities, final int rpcMessageLimit) {
100 concurentRpcMsgs = rpcMessageLimit;
102 this.remoteDevice = remoteDevice;
103 this.overrideNetconfCapabilities = overrideNetconfCapabilities;
104 firstConnectionFuture = SettableFuture.create();
105 semaphore = rpcMessageLimit > 0 ? new Semaphore(rpcMessageLimit) : null;
109 public void onSessionUp(final NetconfClientSession session) {
112 LOG.debug("{}: Session established", id);
113 currentSession = session;
115 NetconfSessionPreferences netconfSessionPreferences =
116 NetconfSessionPreferences.fromNetconfSession(session);
117 LOG.trace("{}: Session advertised capabilities: {}", id,
118 netconfSessionPreferences);
120 if (overrideNetconfCapabilities.isPresent()) {
121 final NetconfSessionPreferences sessionPreferences = overrideNetconfCapabilities
122 .get().getSessionPreferences();
123 netconfSessionPreferences = overrideNetconfCapabilities.get().moduleBasedCapsOverrided()
124 ? netconfSessionPreferences.replaceModuleCaps(sessionPreferences)
125 : netconfSessionPreferences.addModuleCaps(sessionPreferences);
127 netconfSessionPreferences = overrideNetconfCapabilities.get().nonModuleBasedCapsOverrided()
128 ? netconfSessionPreferences.replaceNonModuleCaps(sessionPreferences)
129 : netconfSessionPreferences.addNonModuleCaps(sessionPreferences);
130 LOG.debug("{}: Session capabilities overridden, capabilities that will be used: {}", id,
131 netconfSessionPreferences);
134 remoteDevice.onRemoteSessionUp(netconfSessionPreferences, this);
135 if (!firstConnectionFuture.isDone()) {
136 firstConnectionFuture.set(netconfSessionPreferences.getNetconfDeviceCapabilities());
139 sessionLock.unlock();
144 * Initialize remote connection.
146 * @param dispatcher {@code NetconfCLientDispatcher}
147 * @param config {@code NetconfClientConfiguration}
148 * @return a ListenableFuture that returns success on first successful connection and failure when the underlying
149 * reconnecting strategy runs out of reconnection attempts
151 public ListenableFuture<NetconfDeviceCapabilities> initializeRemoteConnection(
152 final NetconfClientDispatcher dispatcher, final NetconfClientConfiguration config) {
154 final Future<?> connectFuture;
155 if (config instanceof NetconfReconnectingClientConfiguration) {
156 // FIXME: This is weird. If I understand it correctly we want to know about the first connection so as to
157 // forward error state. Analyze the call graph to understand what is going on here. We really want
158 // to move reconnection away from the socket layer, so that it can properly interface with sessions
159 // and generally has some event-driven state (as all good network glue does). There is a second story
160 // which is we want to avoid duplicate code, so it depends on other users as well.
161 final var future = dispatcher.createReconnectingClient((NetconfReconnectingClientConfiguration) config);
163 connectFuture = future.firstSessionFuture();
165 taskFuture = connectFuture = dispatcher.createClient(config);
168 connectFuture.addListener(future -> {
169 if (!future.isSuccess() && !future.isCancelled()) {
170 LOG.debug("{}: Connection failed", id, future.cause());
171 remoteDevice.onRemoteSessionFailed(future.cause());
172 if (!firstConnectionFuture.isDone()) {
173 firstConnectionFuture.setException(future.cause());
177 return firstConnectionFuture;
180 public void disconnect() {
181 // If session is already in closing, no need to close it again
182 if (currentSession != null && startClosing() && currentSession.isUp()) {
183 currentSession.close();
187 private void tearDown(final String reason) {
188 if (!isSessionClosing()) {
189 LOG.warn("It's curious that no one to close the session but tearDown is called!");
191 LOG.debug("Tearing down {}", reason);
192 final List<UncancellableFuture<RpcResult<NetconfMessage>>> futuresToCancel = new ArrayList<>();
195 if (currentSession != null) {
196 currentSession = null;
198 * Walk all requests, check if they have been executing
199 * or cancelled and remove them from the queue.
201 final Iterator<Request> it = requests.iterator();
202 while (it.hasNext()) {
203 final Request r = it.next();
204 if (r.future.isUncancellable()) {
205 futuresToCancel.add(r.future);
207 } else if (r.future.isCancelled()) {
208 // This just does some house-cleaning
213 remoteDevice.onRemoteSessionDown();
216 sessionLock.unlock();
219 // Notify pending request futures outside of the sessionLock to avoid unnecessarily
220 // blocking the caller.
221 for (final UncancellableFuture<RpcResult<NetconfMessage>> future : futuresToCancel) {
222 if (Strings.isNullOrEmpty(reason)) {
223 future.set(createSessionDownRpcResult());
225 future.set(createErrorRpcResult(ErrorType.TRANSPORT, reason));
232 private RpcResult<NetconfMessage> createSessionDownRpcResult() {
233 return createErrorRpcResult(ErrorType.TRANSPORT,
234 String.format("The netconf session to %1$s is disconnected", id.getName()));
237 private static RpcResult<NetconfMessage> createErrorRpcResult(final ErrorType errorType, final String message) {
238 return RpcResultBuilder.<NetconfMessage>failed()
239 .withError(errorType, ErrorTag.OPERATION_FAILED, message).build();
243 public void onSessionDown(final NetconfClientSession session, final Exception exception) {
244 // If session is already in closing, no need to call tearDown again.
245 if (startClosing()) {
246 if (exception instanceof EOFException) {
247 LOG.info("{}: Session went down: {}", id, exception.getMessage());
249 LOG.warn("{}: Session went down", id, exception);
256 public void onSessionTerminated(final NetconfClientSession session, final NetconfTerminationReason reason) {
257 // onSessionTerminated is called directly by disconnect, no need to compare and set isSessionClosing.
258 LOG.warn("{}: Session terminated {}", id, reason);
259 tearDown(reason.getErrorMessage());
263 public void close() {
264 // Cancel reconnect if in progress
265 if (taskFuture != null) {
266 taskFuture.cancel(false);
268 // Disconnect from device
269 // tear down not necessary, called indirectly by the close in disconnect()
274 public void onMessage(final NetconfClientSession session, final NetconfMessage message) {
276 * Dispatch between notifications and messages. Messages need to be processed
277 * with lock held, notifications do not.
279 if (isNotification(message)) {
280 processNotification(message);
282 processMessage(message);
286 private void processMessage(final NetconfMessage message) {
287 Request request = null;
291 request = requests.peek();
292 if (request != null && request.future.isUncancellable()) {
293 request = requests.poll();
294 // we have just removed one request from the queue
295 // we can also release one permit
296 if (semaphore != null) {
301 LOG.warn("{}: Ignoring unsolicited message {}", id,
305 sessionLock.unlock();
308 if (request == null) {
309 // No matching request, bail out
314 if (message instanceof FailedNetconfMessage) {
315 request.future.set(NetconfMessageTransformUtil.toRpcResult((FailedNetconfMessage) message));
319 LOG.debug("{}: Message received {}", id, message);
321 if (LOG.isTraceEnabled()) {
322 LOG.trace("{}: Matched request: {} to response: {}", id, msgToS(request.request), msgToS(message));
326 NetconfMessageTransformUtil.checkValidReply(request.request, message);
327 } catch (final NetconfDocumentedException e) {
328 LOG.warn("{}: Invalid request-reply match, reply message contains different message-id, "
329 + "request: {}, response: {}", id, msgToS(request.request), msgToS(message), e);
331 request.future.set(RpcResultBuilder.<NetconfMessage>failed()
332 .withRpcError(NetconfMessageTransformUtil.toRpcError(e))
335 //recursively processing message to eventually find matching request
336 processMessage(message);
341 NetconfMessageTransformUtil.checkSuccessReply(message);
342 } catch (final NetconfDocumentedException e) {
343 LOG.warn("{}: Error reply from remote device, request: {}, response: {}",
344 id, msgToS(request.request), msgToS(message), e);
346 request.future.set(RpcResultBuilder.<NetconfMessage>failed()
347 .withRpcError(NetconfMessageTransformUtil.toRpcError(e))
352 request.future.set(RpcResultBuilder.success(message).build());
355 private static String msgToS(final NetconfMessage msg) {
356 return XmlUtil.toString(msg.getDocument());
360 public ListenableFuture<RpcResult<NetconfMessage>> sendRequest(final NetconfMessage message, final QName rpc) {
363 if (semaphore != null && !semaphore.tryAcquire()) {
364 LOG.warn("Limit of concurrent rpc messages was reached (limit: {}). Rpc reply message is needed. "
365 + "Discarding request of Netconf device with id: {}", concurentRpcMsgs, id.getName());
366 return FluentFutures.immediateFailedFluentFuture(new NetconfDocumentedException(
367 "Limit of rpc messages was reached (Limit :" + concurentRpcMsgs
368 + ") waiting for emptying the queue of Netconf device with id: " + id.getName()));
371 return sendRequestWithLock(message, rpc);
373 sessionLock.unlock();
377 private ListenableFuture<RpcResult<NetconfMessage>> sendRequestWithLock(final NetconfMessage message,
379 if (LOG.isTraceEnabled()) {
380 LOG.trace("{}: Sending message {}", id, msgToS(message));
383 if (currentSession == null) {
384 LOG.warn("{}: Session is disconnected, failing RPC request {}",
386 return FluentFutures.immediateFluentFuture(createSessionDownRpcResult());
389 final Request req = new Request(new UncancellableFuture<>(true), message);
392 currentSession.sendMessage(req.request).addListener(future -> {
393 if (!future.isSuccess()) {
394 // We expect that a session down will occur at this point
395 LOG.debug("{}: Failed to send request {}", id,
396 XmlUtil.toString(req.request.getDocument()),
399 if (future.cause() != null) {
400 req.future.set(createErrorRpcResult(ErrorType.TRANSPORT, future.cause().getLocalizedMessage()));
402 req.future.set(createSessionDownRpcResult()); // assume session is down
404 req.future.setException(future.cause());
406 LOG.trace("Finished sending request {}", req.request);
413 private void processNotification(final NetconfMessage notification) {
414 if (LOG.isTraceEnabled()) {
415 LOG.trace("{}: Notification received: {}", id, notification);
418 remoteDevice.onNotification(notification);
421 private static boolean isNotification(final NetconfMessage message) {
422 if (message.getDocument() == null) {
423 // We have no message, which mean we have a FailedNetconfMessage
426 final XmlElement xmle = XmlElement.fromDomDocument(message.getDocument());
427 return XmlNetconfConstants.NOTIFICATION_ELEMENT_NAME.equals(xmle.getName()) ;
430 private static final class Request {
431 final UncancellableFuture<RpcResult<NetconfMessage>> future;
432 final NetconfMessage request;
434 private Request(final UncancellableFuture<RpcResult<NetconfMessage>> future,
435 final NetconfMessage request) {
436 this.future = future;
437 this.request = request;
441 private boolean startClosing() {
442 return CLOSING_UPDATER.compareAndSet(this, 0, 1);