wayland_server.cpp 15.7 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
/********************************************************************
 KWin - the KDE window manager
 This file is part of the KDE project.

Copyright (C) 2015 Martin Gräßlin <mgraesslin@kde.org>

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.
*********************************************************************/
#include "wayland_server.h"
21
#include "client.h"
22
#include "abstract_backend.h"
23
#include "composite.h"
24
#include "screens.h"
25
#include "shell_client.h"
26
#include "workspace.h"
27

28 29
// Client
#include <KWayland/Client/connection_thread.h>
30
#include <KWayland/Client/event_queue.h>
31
#include <KWayland/Client/registry.h>
32
#include <KWayland/Client/shm_pool.h>
33
#include <KWayland/Client/surface.h>
34
// Server
35
#include <KWayland/Server/compositor_interface.h>
36
#include <KWayland/Server/datadevicemanager_interface.h>
37
#include <KWayland/Server/display.h>
38
#include <KWayland/Server/dpms_interface.h>
39
#include <KWayland/Server/idle_interface.h>
40
#include <KWayland/Server/output_interface.h>
41
#include <KWayland/Server/plasmashell_interface.h>
42
#include <KWayland/Server/plasmawindowmanagement_interface.h>
43
#include <KWayland/Server/qtsurfaceextension_interface.h>
44
#include <KWayland/Server/seat_interface.h>
45
#include <KWayland/Server/shadow_interface.h>
46
#include <KWayland/Server/blur_interface.h>
47 48
#include <KWayland/Server/shell_interface.h>

49
// Qt
50
#include <QThread>
51 52
#include <QWindow>

53 54 55 56
// system
#include <sys/types.h>
#include <sys/socket.h>

57 58 59
//screenlocker
#include <KScreenLocker/KsldApp>

60 61 62 63 64 65 66 67 68 69
using namespace KWayland::Server;

namespace KWin
{

KWIN_SINGLETON_FACTORY(WaylandServer)

WaylandServer::WaylandServer(QObject *parent)
    : QObject(parent)
{
70
    qRegisterMetaType<KWayland::Server::SurfaceInterface *>("KWayland::Server::SurfaceInterface *");
71
    qRegisterMetaType<KWayland::Server::OutputInterface::DpmsMode>();
72 73
}

74 75 76 77
WaylandServer::~WaylandServer()
{
    destroyInputMethodConnection();
}
78 79

void WaylandServer::destroyInternalConnection()
80 81
{
    if (m_internalConnection.client) {
82 83
        delete m_internalConnection.registry;
        delete m_internalConnection.shm;
84
        dispatch();
85 86 87
        m_internalConnection.client->deleteLater();
        m_internalConnection.clientThread->quit();
        m_internalConnection.clientThread->wait();
88
        delete m_internalConnection.clientThread;
89
        m_internalConnection.client = nullptr;
90
        m_internalConnection.server->destroy();
91 92
    }
}
93

94 95 96 97 98 99 100 101 102 103
void WaylandServer::terminateClientConnections()
{
    destroyInternalConnection();
    destroyInputMethodConnection();
    const auto connections = m_display->connections();
    for (auto it = connections.begin(); it != connections.end(); ++it) {
        (*it)->destroy();
    }
}

104
void WaylandServer::init(const QByteArray &socketName, InitalizationFlags flags)
105
{
106
    m_initFlags = flags;
107 108 109 110 111 112 113
    m_display = new KWayland::Server::Display(this);
    if (!socketName.isNull() && !socketName.isEmpty()) {
        m_display->setSocketName(QString::fromUtf8(socketName));
    }
    m_display->start();
    m_compositor = m_display->createCompositor(m_display);
    m_compositor->create();
114 115 116 117 118 119 120 121
    connect(m_compositor, &CompositorInterface::surfaceCreated, this,
        [this] (SurfaceInterface *surface) {
            // check whether we have a Toplevel with the Surface's id
            Workspace *ws = Workspace::self();
            if (!ws) {
                // it's possible that a Surface gets created before Workspace is created
                return;
            }
122 123 124 125
            if (surface->client() != xWaylandConnection()) {
                // setting surface is only relevat for Xwayland clients
                return;
            }
126 127 128 129 130 131 132 133
            auto check = [surface] (const Toplevel *t) {
                return t->surfaceId() == surface->id();
            };
            if (Toplevel *t = ws->findToplevel(check)) {
                t->setSurface(surface);
            }
        }
    );
134 135
    m_shell = m_display->createShell(m_display);
    m_shell->create();
136 137
    connect(m_shell, &ShellInterface::surfaceCreated, this,
        [this] (ShellSurfaceInterface *surface) {
138 139 140 141
            if (!Workspace::self()) {
                // it's possible that a Surface gets created before Workspace is created
                return;
            }
142
            if (surface->client() == m_xwayland.client) {
143 144 145
                // skip Xwayland clients, those are created using standard X11 way
                return;
            }
146 147 148
            if (surface->client() == m_screenLockerClientConnection && !isScreenLocked()) {
                ScreenLocker::KSldApp::self()->lockScreenShown();
            }
149 150 151 152
            auto client = new ShellClient(surface);
            if (auto c = Compositor::self()) {
                connect(client, &Toplevel::needsRepaint, c, &Compositor::scheduleRepaint);
            }
153 154 155 156 157
            if (client->isInternal()) {
                m_internalClients << client;
            } else {
                m_clients << client;
            }
158 159 160 161 162 163
            if (client->readyForPainting()) {
                emit shellClientAdded(client);
            } else {
                connect(client, &ShellClient::windowShown, this,
                    [this, client] {
                        emit shellClientAdded(client);
164
                    }
165 166
                );
            }
167 168
        }
    );
169
    m_display->createShm();
170 171
    m_seat = m_display->createSeat(m_display);
    m_seat->create();
172
    m_display->createDataDeviceManager(m_display)->create();
173
    m_display->createIdle(m_display)->create();
174 175 176 177 178 179 180 181 182
    m_plasmaShell = m_display->createPlasmaShell(m_display);
    m_plasmaShell->create();
    connect(m_plasmaShell, &PlasmaShellInterface::surfaceCreated,
        [this] (PlasmaShellSurfaceInterface *surface) {
            if (ShellClient *client = findClient(surface->surface())) {
                client->installPlasmaShellSurface(surface);
            }
        }
    );
183 184 185 186 187 188 189 190 191
    m_qtExtendedSurface = m_display->createQtSurfaceExtension(m_display);
    m_qtExtendedSurface->create();
    connect(m_qtExtendedSurface, &QtSurfaceExtensionInterface::surfaceCreated,
        [this] (QtExtendedSurfaceInterface *surface) {
            if (ShellClient *client = findClient(surface->surface())) {
                client->installQtExtendedSurface(surface);
            }
        }
    );
192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217
    m_windowManagement = m_display->createPlasmaWindowManagement(m_display);
    m_windowManagement->create();
    m_windowManagement->setShowingDesktopState(PlasmaWindowManagementInterface::ShowingDesktopState::Disabled);
    connect(m_windowManagement, &PlasmaWindowManagementInterface::requestChangeShowingDesktop, this,
        [] (PlasmaWindowManagementInterface::ShowingDesktopState state) {
            if (!workspace()) {
                return;
            }
            bool set = false;
            switch (state) {
            case PlasmaWindowManagementInterface::ShowingDesktopState::Disabled:
                set = false;
                break;
            case PlasmaWindowManagementInterface::ShowingDesktopState::Enabled:
                set = true;
                break;
            default:
                Q_UNREACHABLE();
                break;
            }
            if (set == workspace()->showingDesktop()) {
                return;
            }
            workspace()->setShowingDesktop(set);
        }
    );
218 219
    auto shadowManager = m_display->createShadowManager(m_display);
    shadowManager->create();
220 221

    m_display->createDpmsManager(m_display)->create();
222 223 224 225 226 227 228 229 230 231 232 233 234 235 236
}

void WaylandServer::initWorkspace()
{
    if (m_windowManagement) {
        connect(workspace(), &Workspace::showingDesktopChanged, this,
            [this] (bool set) {
                using namespace KWayland::Server;
                m_windowManagement->setShowingDesktopState(set ?
                    PlasmaWindowManagementInterface::ShowingDesktopState::Enabled :
                    PlasmaWindowManagementInterface::ShowingDesktopState::Disabled
                );
            }
        );
    }
237

238
    ScreenLocker::KSldApp::self();
239
    ScreenLocker::KSldApp::self()->setWaylandDisplay(m_display);
240
    ScreenLocker::KSldApp::self()->setGreeterEnvironment(kwinApp()->processStartupEnvironment());
241
    ScreenLocker::KSldApp::self()->initialize();
242

243
    connect(ScreenLocker::KSldApp::self(), &ScreenLocker::KSldApp::greeterClientConnectionChanged, this,
244 245 246 247 248 249 250 251 252 253 254
        [this] () {
            m_screenLockerClientConnection = ScreenLocker::KSldApp::self()->greeterClientConnection();
        }
    );

    connect(ScreenLocker::KSldApp::self(), &ScreenLocker::KSldApp::unlocked, this,
        [this] () {
            m_screenLockerClientConnection = nullptr;
        }
    );

255 256 257
    if (m_initFlags.testFlag(InitalizationFlag::LockScreen)) {
        ScreenLocker::KSldApp::self()->lock(ScreenLocker::EstablishLock::Immediate);
    }
258
}
259

260 261
void WaylandServer::initOutputs()
{
262 263 264
    if (m_backend && m_backend->handlesOutputs()) {
        return;
    }
265 266 267 268
    Screens *s = screens();
    Q_ASSERT(s);
    for (int i = 0; i < s->count(); ++i) {
        OutputInterface *output = m_display->createOutput(m_display);
269 270 271 272
        const QRect &geo = s->geometry(i);
        output->setGlobalPosition(geo.topLeft());
        output->setPhysicalSize(geo.size() / 3.8);
        output->addMode(geo.size());
273 274
        output->create();
    }
275 276
}

277 278 279 280 281 282 283
int WaylandServer::createXWaylandConnection()
{
    int sx[2];
    if (socketpair(AF_UNIX, SOCK_STREAM | SOCK_CLOEXEC, 0, sx) < 0) {
        qCWarning(KWIN_CORE) << "Could not create socket";
        return -1;
    }
284 285
    m_xwayland.client = m_display->createClient(sx[0]);
    m_xwayland.destroyConnection = connect(m_xwayland.client, &KWayland::Server::ClientConnection::disconnected, this,
286 287 288 289
        [] {
            qFatal("Xwayland Connection died");
        }
    );
290 291 292
    return sx[1];
}

293 294 295 296 297 298 299 300 301 302
void WaylandServer::destroyXWaylandConnection()
{
    if (!m_xwayland.client) {
        return;
    }
    disconnect(m_xwayland.destroyConnection);
    m_xwayland.client->destroy();
    m_xwayland.client = nullptr;
}

303 304 305 306 307 308 309 310 311 312 313
int WaylandServer::createInputMethodConnection()
{
    int sx[2];
    if (socketpair(AF_UNIX, SOCK_STREAM | SOCK_CLOEXEC, 0, sx) < 0) {
        qCWarning(KWIN_CORE) << "Could not create socket";
        return -1;
    }
    m_inputMethodServerConnection = m_display->createClient(sx[0]);
    return sx[1];
}

314 315 316 317 318 319 320 321 322
void WaylandServer::destroyInputMethodConnection()
{
    if (!m_inputMethodServerConnection) {
        return;
    }
    m_inputMethodServerConnection->destroy();
    m_inputMethodServerConnection = nullptr;
}

323 324 325 326 327 328 329 330 331
void WaylandServer::createInternalConnection()
{
    int sx[2];
    if (socketpair(AF_UNIX, SOCK_STREAM | SOCK_CLOEXEC, 0, sx) < 0) {
        qCWarning(KWIN_CORE) << "Could not create socket";
        return;
    }
    m_internalConnection.server = m_display->createClient(sx[0]);
    using namespace KWayland::Client;
332
    m_internalConnection.client = new ConnectionThread();
333
    m_internalConnection.client->setSocketFd(sx[1]);
334 335 336 337
    m_internalConnection.clientThread = new QThread;
    m_internalConnection.client->moveToThread(m_internalConnection.clientThread);
    m_internalConnection.clientThread->start();

338 339
    connect(m_internalConnection.client, &ConnectionThread::connected, this,
        [this] {
340 341 342 343
            Registry *registry = new Registry(this);
            EventQueue *eventQueue = new EventQueue(this);
            eventQueue->setup(m_internalConnection.client);
            registry->setEventQueue(eventQueue);
344
            registry->create(m_internalConnection.client);
345
            m_internalConnection.registry = registry;
346
            connect(registry, &Registry::shmAnnounced, this,
347
                [this] (quint32 name, quint32 version) {
348
                    m_internalConnection.shm = m_internalConnection.registry->createShmPool(name, version, this);
349 350 351 352 353 354 355 356
                }
            );
            registry->setup();
        }
    );
    m_internalConnection.client->initConnection();
}

357 358 359 360 361 362 363 364 365 366 367 368
void WaylandServer::installBackend(AbstractBackend *backend)
{
    Q_ASSERT(!m_backend);
    m_backend = backend;
}

void WaylandServer::uninstallBackend(AbstractBackend *backend)
{
    Q_ASSERT(m_backend == backend);
    m_backend = nullptr;
}

369 370 371
void WaylandServer::removeClient(ShellClient *c)
{
    m_clients.removeAll(c);
372
    m_internalClients.removeAll(c);
373 374 375
    emit shellClientRemoved(c);
}

376 377 378 379 380
void WaylandServer::dispatch()
{
    if (!m_display) {
        return;
    }
381 382
    if (m_internalConnection.server) {
        m_internalConnection.server->flush();
383 384 385 386
    }
    m_display->dispatchEvents(0);
}

387
static ShellClient *findClientInList(const QList<ShellClient*> &clients, quint32 id)
388
{
389
    auto it = std::find_if(clients.begin(), clients.end(),
390 391 392 393
        [id] (ShellClient *c) {
            return c->windowId() == id;
        }
    );
394
    if (it == clients.end()) {
395 396 397 398 399
        return nullptr;
    }
    return *it;
}

400 401 402 403 404 405 406 407 408 409 410 411 412
static ShellClient *findClientInList(const QList<ShellClient*> &clients, KWayland::Server::SurfaceInterface *surface)
{
    auto it = std::find_if(clients.begin(), clients.end(),
        [surface] (ShellClient *c) {
            return c->surface() == surface;
        }
    );
    if (it == clients.end()) {
        return nullptr;
    }
    return *it;
}

413 414 415 416 417 418 419 420 421 422 423 424 425 426
ShellClient *WaylandServer::findClient(quint32 id) const
{
    if (id == 0) {
        return nullptr;
    }
    if (ShellClient *c = findClientInList(m_clients, id)) {
        return c;
    }
    if (ShellClient *c = findClientInList(m_internalClients, id)) {
        return c;
    }
    return nullptr;
}

427 428 429 430 431 432 433 434 435 436 437 438 439 440
ShellClient *WaylandServer::findClient(SurfaceInterface *surface) const
{
    if (!surface) {
        return nullptr;
    }
    if (ShellClient *c = findClientInList(m_clients, surface)) {
        return c;
    }
    if (ShellClient *c = findClientInList(m_internalClients, surface)) {
        return c;
    }
    return nullptr;
}

441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456
ShellClient *WaylandServer::findClient(QWindow *w) const
{
    if (!w) {
        return nullptr;
    }
    auto it = std::find_if(m_internalClients.constBegin(), m_internalClients.constEnd(),
        [w] (const ShellClient *c) {
            return c->internalWindow() == w;
        }
    );
    if (it != m_internalClients.constEnd()) {
        return *it;
    }
    return nullptr;
}

457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498
quint32 WaylandServer::createWindowId(SurfaceInterface *surface)
{
    auto it = m_clientIds.constFind(surface->client());
    quint16 clientId = 0;
    if (it != m_clientIds.constEnd()) {
        clientId = it.value();
    } else {
        clientId = createClientId(surface->client());
    }
    Q_ASSERT(clientId != 0);
    quint32 id = clientId;
    // TODO: this does not prevent that two surfaces of same client get same id
    id = (id << 16) | (surface->id() & 0xFFFF);
    if (findClient(id)) {
        qCWarning(KWIN_CORE) << "Invalid client windowId generated:" << id;
        return 0;
    }
    return id;
}

quint16 WaylandServer::createClientId(ClientConnection *c)
{
    auto ids = m_clientIds.values().toSet();
    quint16 id = 1;
    if (!ids.isEmpty()) {
        for (quint16 i = ids.count() + 1; i >= 1 ; i--) {
            if (!ids.contains(i)) {
                id = i;
                break;
            }
        }
    }
    Q_ASSERT(!ids.contains(id));
    m_clientIds.insert(c, id);
    connect(c, &ClientConnection::disconnected, this,
        [this] (ClientConnection *c) {
            m_clientIds.remove(c);
        }
    );
    return id;
}

499 500 501 502 503
bool WaylandServer::isScreenLocked() const
{
    return ScreenLocker::KSldApp::self()->lockState() == ScreenLocker::KSldApp::Locked;
}

504
}