From 1f6fa1f37a14742ddf53c753ce52d9dc048cd1dc Mon Sep 17 00:00:00 2001 From: Thiago Macieira Date: Sun, 27 Dec 2015 11:15:24 -0200 Subject: Suspend processing of some messages in the default busses by default To retain a bit compatibility with applications developed in the last 9 years that expect that QDBusConnections won't process their events until the event loop runs, we now suspend the handling of incoming messages in the two default buses (and only in them) and resume when the event loop starts. This is required because the new threaded QtDBus would otherwise process incoming messages that the application didn't expect it to. For example, if the application first acquires names on the bus and only after that registers objects with QtDBus, there's a small window in which the name is acquired and visible to other applications, but no objects are registered yet. Calls to those objects may be received, would then be processed in the QDBusConnectionManager thread and fail. The work around is to disable the actual handling of method calls and signals in QDBusConnectionPrivate::handleMessage. Instead, those messages are queued until later. Due to the way that libdbus-1 works, outgoing method calls that are waiting for replies are not affected, since their processing does not happen in handleMessage(). [ChangeLog][Important Behavior Changes] QtDBus now uses threads to implement processing of incoming and outgoing messages. This solves a number of thread safety issues and fixes an architectural problem that would cause all processing to stop if a particular thread (usually the main thread) were blocked in any operation. On the flip side, application developers need to know that modifications to a QDBusConnection may be visible immediately on the connection, so they should be done in an order that won't allow for incomplete states to be observed (for example, first register all objects, then acquire service names). Change-Id: I39cc61d0d59846ab8c23ffff1423c6d555f6ee0a Reviewed-by: David Faure --- tests/auto/dbus/dbus.pro | 5 + .../qdbusconnection_delayed.pro | 5 + .../tst_qdbusconnection_delayed.cpp | 111 +++++++++++++++++++++ 3 files changed, 121 insertions(+) create mode 100644 tests/auto/dbus/qdbusconnection_delayed/qdbusconnection_delayed.pro create mode 100644 tests/auto/dbus/qdbusconnection_delayed/tst_qdbusconnection_delayed.cpp (limited to 'tests/auto') diff --git a/tests/auto/dbus/dbus.pro b/tests/auto/dbus/dbus.pro index bd1fef5193..ea8939bb9d 100644 --- a/tests/auto/dbus/dbus.pro +++ b/tests/auto/dbus/dbus.pro @@ -1,5 +1,10 @@ TEMPLATE=subdirs + +# Run this test first SUBDIRS=\ + qdbusconnection_delayed + +SUBDIRS+=\ qdbusabstractadaptor \ qdbusabstractinterface \ qdbusconnection \ diff --git a/tests/auto/dbus/qdbusconnection_delayed/qdbusconnection_delayed.pro b/tests/auto/dbus/qdbusconnection_delayed/qdbusconnection_delayed.pro new file mode 100644 index 0000000000..71a75c644d --- /dev/null +++ b/tests/auto/dbus/qdbusconnection_delayed/qdbusconnection_delayed.pro @@ -0,0 +1,5 @@ +CONFIG += testcase parallel_test +TARGET = tst_qdbusconnection_delayed +QT = core dbus testlib +SOURCES += tst_qdbusconnection_delayed.cpp +DEFINES += SRCDIR=\\\"$$PWD/\\\" diff --git a/tests/auto/dbus/qdbusconnection_delayed/tst_qdbusconnection_delayed.cpp b/tests/auto/dbus/qdbusconnection_delayed/tst_qdbusconnection_delayed.cpp new file mode 100644 index 0000000000..a7492a4855 --- /dev/null +++ b/tests/auto/dbus/qdbusconnection_delayed/tst_qdbusconnection_delayed.cpp @@ -0,0 +1,111 @@ +/**************************************************************************** +** +** Copyright (C) 2015 Intel Corporation. +** Contact: http://www.qt.io/licensing/ +** +** This file is part of the test suite of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:LGPL21$ +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and The Qt Company. For licensing terms +** and conditions see http://www.qt.io/terms-conditions. For further +** information use the contact form at http://www.qt.io/contact-us. +** +** GNU Lesser General Public License Usage +** Alternatively, this file may be used under the terms of the GNU Lesser +** General Public License version 2.1 or version 3 as published by the Free +** Software Foundation and appearing in the file LICENSE.LGPLv21 and +** LICENSE.LGPLv3 included in the packaging of this file. Please review the +** following information to ensure the GNU Lesser General Public License +** requirements will be met: https://www.gnu.org/licenses/lgpl.html and +** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. +** +** As a special exception, The Qt Company gives you certain additional +** rights. These rights are described in The Qt Company LGPL Exception +** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +#include +#include + +#ifdef Q_OS_WIN +# include +# define getpid _getpid +#else +# include +# include +#endif + +class tst_QDBusConnection_Delayed : public QObject +{ + Q_OBJECT +private slots: + void delayedMessages(); +}; + +class Foo : public QObject +{ + Q_OBJECT + Q_CLASSINFO("D-Bus Interface", "org.qtproject.tst_qdbusconnection_delayed.Foo") +public slots: + int bar() { return 42; } +}; + +static bool executedOnce = false; + +void tst_QDBusConnection_Delayed::delayedMessages() +{ + if (executedOnce) + QSKIP("This test can only be executed once"); + executedOnce = true; + + int argc = 1; + char *argv[] = { const_cast("tst_qdbusconnection_delayed"), 0 }; + QCoreApplication app(argc, argv); + + QDBusConnection session = QDBusConnection::sessionBus(); + QVERIFY(session.isConnected()); + QVERIFY(!session.baseService().isEmpty()); + + QDBusConnection other = QDBusConnection::connectToBus(QDBusConnection::SessionBus, "other"); + QVERIFY(other.isConnected()); + QVERIFY(!other.baseService().isEmpty()); + + QString name = "org.qtproject.tst_qdbusconnection_delayed-" + + QString::number(getpid()); + + // acquire a name in the main session bus connection + QVERIFY(session.registerService(name)); + QVERIFY(other.interface()->isServiceRegistered(name)); + + // make an asynchronous call to a yet-unregistered object + QDBusPendingCallWatcher pending(other.asyncCall(QDBusMessage::createMethodCall(name, "/foo", QString(), "bar"))); + + // sleep the main thread without running the event loop; + // the call must not be delivered + QTest::qSleep(1000); + QVERIFY(!pending.isFinished()); + + // now register the object + Foo foo; + session.registerObject("/foo", &foo, QDBusConnection::ExportAllSlots); + + connect(&pending, &QDBusPendingCallWatcher::finished, + &QTestEventLoop::instance(), &QTestEventLoop::exitLoop); + QTestEventLoop::instance().enterLoop(2); + QVERIFY(!QTestEventLoop::instance().timeout()); + QVERIFY(pending.isFinished()); + QVERIFY2(!pending.isError(), pending.error().name().toLatin1()); + QVERIFY(!pending.reply().arguments().isEmpty()); + QCOMPARE(pending.reply().arguments().at(0), QVariant(42)); +} + +QTEST_APPLESS_MAIN(tst_QDBusConnection_Delayed) + +#include "tst_qdbusconnection_delayed.moc" -- cgit v1.2.3