wayland_server.cpp 17.1 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 "platform.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/server_decoration_interface.h>
46
#include <KWayland/Server/shadow_interface.h>
47
#include <KWayland/Server/subcompositor_interface.h>
48
#include <KWayland/Server/blur_interface.h>
49
#include <KWayland/Server/shell_interface.h>
50 51
#include <KWayland/Server/outputmanagement_interface.h>
#include <KWayland/Server/outputconfiguration_interface.h>
52

53
// Qt
54
#include <QThread>
55 56
#include <QWindow>

57 58 59 60
// system
#include <sys/types.h>
#include <sys/socket.h>

61 62 63
//screenlocker
#include <KScreenLocker/KsldApp>

64 65 66 67 68 69 70 71 72 73
using namespace KWayland::Server;

namespace KWin
{

KWIN_SINGLETON_FACTORY(WaylandServer)

WaylandServer::WaylandServer(QObject *parent)
    : QObject(parent)
{
74
    qRegisterMetaType<KWayland::Server::SurfaceInterface *>("KWayland::Server::SurfaceInterface *");
75
    qRegisterMetaType<KWayland::Server::OutputInterface::DpmsMode>();
76 77

    connect(kwinApp(), &Application::screensCreated, this, &WaylandServer::initOutputs);
78 79
}

80 81 82 83
WaylandServer::~WaylandServer()
{
    destroyInputMethodConnection();
}
84 85

void WaylandServer::destroyInternalConnection()
86
{
87
    emit terminatingInternalClientConnection();
88
    if (m_internalConnection.client) {
89 90
        delete m_internalConnection.registry;
        delete m_internalConnection.shm;
91
        dispatch();
92 93 94
        m_internalConnection.client->deleteLater();
        m_internalConnection.clientThread->quit();
        m_internalConnection.clientThread->wait();
95
        delete m_internalConnection.clientThread;
96
        m_internalConnection.client = nullptr;
97
        m_internalConnection.server->destroy();
98 99
    }
}
100

101 102 103 104
void WaylandServer::terminateClientConnections()
{
    destroyInternalConnection();
    destroyInputMethodConnection();
105 106 107 108 109
    if (m_display) {
        const auto connections = m_display->connections();
        for (auto it = connections.begin(); it != connections.end(); ++it) {
            (*it)->destroy();
        }
110 111 112
    }
}

113
void WaylandServer::init(const QByteArray &socketName, InitalizationFlags flags)
114
{
115
    m_initFlags = flags;
116 117 118 119 120 121 122
    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();
123 124 125 126 127 128 129 130
    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;
            }
131 132 133 134
            if (surface->client() != xWaylandConnection()) {
                // setting surface is only relevat for Xwayland clients
                return;
            }
135 136 137 138 139 140 141 142
            auto check = [surface] (const Toplevel *t) {
                return t->surfaceId() == surface->id();
            };
            if (Toplevel *t = ws->findToplevel(check)) {
                t->setSurface(surface);
            }
        }
    );
143 144
    m_shell = m_display->createShell(m_display);
    m_shell->create();
145 146
    connect(m_shell, &ShellInterface::surfaceCreated, this,
        [this] (ShellSurfaceInterface *surface) {
147 148 149 150
            if (!Workspace::self()) {
                // it's possible that a Surface gets created before Workspace is created
                return;
            }
151
            if (surface->client() == m_xwayland.client) {
152 153 154
                // skip Xwayland clients, those are created using standard X11 way
                return;
            }
155
            if (surface->client() == m_screenLockerClientConnection) {
156 157
                ScreenLocker::KSldApp::self()->lockScreenShown();
            }
158 159 160 161
            auto client = new ShellClient(surface);
            if (auto c = Compositor::self()) {
                connect(client, &Toplevel::needsRepaint, c, &Compositor::scheduleRepaint);
            }
162 163 164 165 166
            if (client->isInternal()) {
                m_internalClients << client;
            } else {
                m_clients << client;
            }
167 168 169 170 171 172
            if (client->readyForPainting()) {
                emit shellClientAdded(client);
            } else {
                connect(client, &ShellClient::windowShown, this,
                    [this, client] {
                        emit shellClientAdded(client);
173
                    }
174 175
                );
            }
176 177
        }
    );
178
    m_display->createShm();
179 180
    m_seat = m_display->createSeat(m_display);
    m_seat->create();
181
    m_display->createDataDeviceManager(m_display)->create();
182
    m_display->createIdle(m_display)->create();
183 184 185 186 187 188 189 190 191
    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);
            }
        }
    );
192 193 194 195 196 197 198 199 200
    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);
            }
        }
    );
201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226
    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);
        }
    );
227 228
    auto shadowManager = m_display->createShadowManager(m_display);
    shadowManager->create();
229 230

    m_display->createDpmsManager(m_display)->create();
231 232 233 234 235 236 237 238 239 240

    m_decorationManager = m_display->createServerSideDecorationManager(m_display);
    connect(m_decorationManager, &ServerSideDecorationManagerInterface::decorationCreated, this,
        [this] (ServerSideDecorationInterface *deco) {
            if (ShellClient *c = findClient(deco->surface())) {
                c->installServerSideDecoration(deco);
            }
        }
    );
    m_decorationManager->create();
241 242 243 244

    m_outputManagement = m_display->createOutputManagement(m_display);
    connect(m_outputManagement, &OutputManagementInterface::configurationChangeRequested,
            this, [this](KWayland::Server::OutputConfigurationInterface *config) {
245
                kwinApp()->platform()->configurationChangeRequested(config);
246
    });
247
    m_outputManagement->create();
248 249

    m_display->createSubCompositor(m_display)->create();
250 251 252 253 254 255 256 257 258 259 260 261 262 263 264
}

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
                );
            }
        );
    }
265

266 267 268 269 270 271 272 273 274 275 276
    if (hasScreenLockerIntegration()) {
        ScreenLocker::KSldApp::self();
        ScreenLocker::KSldApp::self()->setWaylandDisplay(m_display);
        ScreenLocker::KSldApp::self()->setGreeterEnvironment(kwinApp()->processStartupEnvironment());
        ScreenLocker::KSldApp::self()->initialize();

        connect(ScreenLocker::KSldApp::self(), &ScreenLocker::KSldApp::greeterClientConnectionChanged, this,
            [this] () {
                m_screenLockerClientConnection = ScreenLocker::KSldApp::self()->greeterClientConnection();
            }
        );
277

278 279 280 281 282
        connect(ScreenLocker::KSldApp::self(), &ScreenLocker::KSldApp::unlocked, this,
            [this] () {
                m_screenLockerClientConnection = nullptr;
            }
        );
283

284 285 286
        if (m_initFlags.testFlag(InitalizationFlag::LockScreen)) {
            ScreenLocker::KSldApp::self()->lock(ScreenLocker::EstablishLock::Immediate);
        }
287
    }
288
}
289

290 291
void WaylandServer::initOutputs()
{
292
    if (kwinApp()->platform()->handlesOutputs()) {
293 294
        return;
    }
295 296 297 298
    Screens *s = screens();
    Q_ASSERT(s);
    for (int i = 0; i < s->count(); ++i) {
        OutputInterface *output = m_display->createOutput(m_display);
299 300 301 302
        const QRect &geo = s->geometry(i);
        output->setGlobalPosition(geo.topLeft());
        output->setPhysicalSize(geo.size() / 3.8);
        output->addMode(geo.size());
303 304
        output->create();
    }
305 306
}

307 308 309 310 311 312 313
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;
    }
314 315
    m_xwayland.client = m_display->createClient(sx[0]);
    m_xwayland.destroyConnection = connect(m_xwayland.client, &KWayland::Server::ClientConnection::disconnected, this,
316 317 318 319
        [] {
            qFatal("Xwayland Connection died");
        }
    );
320 321 322
    return sx[1];
}

323 324 325 326 327 328 329 330 331 332
void WaylandServer::destroyXWaylandConnection()
{
    if (!m_xwayland.client) {
        return;
    }
    disconnect(m_xwayland.destroyConnection);
    m_xwayland.client->destroy();
    m_xwayland.client = nullptr;
}

333 334 335 336 337 338 339 340 341 342 343
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];
}

344 345 346 347 348 349 350 351 352
void WaylandServer::destroyInputMethodConnection()
{
    if (!m_inputMethodServerConnection) {
        return;
    }
    m_inputMethodServerConnection->destroy();
    m_inputMethodServerConnection = nullptr;
}

353 354 355 356 357 358 359 360 361
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;
362
    m_internalConnection.client = new ConnectionThread();
363
    m_internalConnection.client->setSocketFd(sx[1]);
364 365 366 367
    m_internalConnection.clientThread = new QThread;
    m_internalConnection.client->moveToThread(m_internalConnection.clientThread);
    m_internalConnection.clientThread->start();

368 369
    connect(m_internalConnection.client, &ConnectionThread::connected, this,
        [this] {
370 371 372 373
            Registry *registry = new Registry(this);
            EventQueue *eventQueue = new EventQueue(this);
            eventQueue->setup(m_internalConnection.client);
            registry->setEventQueue(eventQueue);
374
            registry->create(m_internalConnection.client);
375
            m_internalConnection.registry = registry;
376
            connect(registry, &Registry::shmAnnounced, this,
377
                [this] (quint32 name, quint32 version) {
378
                    m_internalConnection.shm = m_internalConnection.registry->createShmPool(name, version, this);
379 380 381 382 383 384 385 386
                }
            );
            registry->setup();
        }
    );
    m_internalConnection.client->initConnection();
}

387 388 389
void WaylandServer::removeClient(ShellClient *c)
{
    m_clients.removeAll(c);
390
    m_internalClients.removeAll(c);
391 392 393
    emit shellClientRemoved(c);
}

394 395 396 397 398
void WaylandServer::dispatch()
{
    if (!m_display) {
        return;
    }
399 400
    if (m_internalConnection.server) {
        m_internalConnection.server->flush();
401 402 403 404
    }
    m_display->dispatchEvents(0);
}

405
static ShellClient *findClientInList(const QList<ShellClient*> &clients, quint32 id)
406
{
407
    auto it = std::find_if(clients.begin(), clients.end(),
408 409 410 411
        [id] (ShellClient *c) {
            return c->windowId() == id;
        }
    );
412
    if (it == clients.end()) {
413 414 415 416 417
        return nullptr;
    }
    return *it;
}

418 419 420 421 422 423 424 425 426 427 428 429 430
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;
}

431 432 433 434 435 436 437 438 439 440 441 442 443 444
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;
}

445 446 447 448 449 450 451 452 453 454 455 456 457 458
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;
}

459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474
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;
}

475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516
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;
}

517 518
bool WaylandServer::isScreenLocked() const
{
519 520 521
    if (!hasScreenLockerIntegration()) {
        return false;
    }
522 523
    return ScreenLocker::KSldApp::self()->lockState() == ScreenLocker::KSldApp::Locked ||
           ScreenLocker::KSldApp::self()->lockState() == ScreenLocker::KSldApp::AcquiringLock;
524 525
}

526 527 528 529 530
bool WaylandServer::hasScreenLockerIntegration() const
{
    return !m_initFlags.testFlag(InitalizationFlag::NoLockScreenIntegration);
}

531
}