File indexing completed on 2024-06-09 05:25:27

 /*
     SPDX-FileCopyrightText: 2022 Vlad Zahorodnii <vlad.zahorodnii@kde.org>
 
     SPDX-License-Identifier: GPL-2.0-or-later
 */
 
 #include "wayland_display.h"
 #include "utils/memorymap.h"
 #include "wayland_logging.h"
 
 #include <KWayland/Client/compositor.h>
 #include <KWayland/Client/pointerconstraints.h>
 #include <KWayland/Client/pointergestures.h>
 #include <KWayland/Client/registry.h>
 #include <KWayland/Client/relativepointer.h>
 #include <KWayland/Client/seat.h>
 #include <KWayland/Client/subcompositor.h>
 #include <KWayland/Client/xdgdecoration.h>
 #include <KWayland/Client/xdgshell.h>
 
 #include <QMutex>
 #include <QThread>
 #include <QWaitCondition>
 
 #include <drm_fourcc.h>
 #include <fcntl.h>
 #include <poll.h>
 #include <span>
 #include <unistd.h>
 #include <wayland-client.h>
 #include <xf86drm.h>
 
 // Generated in src/wayland.
 #include "wayland-linux-dmabuf-unstable-v1-client-protocol.h"
 #include "wayland-pointer-constraints-unstable-v1-client-protocol.h"
 #include "wayland-pointer-gestures-unstable-v1-server-protocol.h"
 #include "wayland-relative-pointer-unstable-v1-client-protocol.h"
 #include "wayland-xdg-decoration-unstable-v1-client-protocol.h"
 #include "wayland-xdg-shell-client-protocol.h"
 
 namespace KWin
 {
 namespace Wayland
 {
 
 class WaylandEventThread : public QThread
 {
     Q_OBJECT
 
 public:
     WaylandEventThread(wl_display *display)
         : m_display(display)
         , m_fd(wl_display_get_fd(display))
         , m_quitPipe{-1, -1}
         , m_reading(true)
         , m_quitting(false)
     {
         if (pipe2(m_quitPipe, O_CLOEXEC) == -1) {
             qCWarning(KWIN_WAYLAND_BACKEND) << "Failed to create quite pipe in WaylandEventThread";
         }
     }
 
     ~WaylandEventThread() override
     {
         if (m_quitPipe[0] != -1) {
             close(m_quitPipe[0]);
             close(m_quitPipe[1]);
         }
     }
 
     void dispatch()
     {
         while (true) {
             if (wl_display_dispatch_pending(m_display) < 0) {
                 qFatal("Wayland connection broke");
             }
 
             wl_display_flush(m_display);
 
             if (m_reading.loadAcquire()) {
                 break;
             }
 
             if (wl_display_prepare_read(m_display) == 0) {
                 QMutexLocker lock(&m_mutex);
                 m_reading.storeRelease(true);
                 m_cond.wakeOne();
                 break;
             }
         }
     }
 
     void stop()
     {
         if (m_quitPipe[1] != -1) {
             write(m_quitPipe[1], "\0", 1);
         }
 
         m_mutex.lock();
         m_quitting = true;
         m_cond.wakeOne();
         m_mutex.unlock();
 
         wait();
     }
 
 Q_SIGNALS:
     void available();
 
 protected:
     void run() override
     {
         while (true) {
             m_reading.storeRelease(false);
 
             Q_EMIT available();
 
             m_mutex.lock();
             while (!m_reading.loadRelaxed() && !m_quitting) {
                 m_cond.wait(&m_mutex);
             }
             m_mutex.unlock();
 
             if (m_quitting) {
                 break;
             }
 
             pollfd fds[2] = { { m_fd, POLLIN, 0 }, { m_quitPipe[0], POLLIN, 0 } };
             poll(fds, 2, -1);
 
             if (fds[1].revents & POLLIN) {
                 wl_display_cancel_read(m_display);
                 break;
             }
 
             if (fds[0].revents & POLLIN) {
                 wl_display_read_events(m_display);
             } else {
                 wl_display_cancel_read(m_display);
             }
         }
     }
 
 private:
     wl_display *const m_display;
     int m_fd;
     int m_quitPipe[2];
     QAtomicInteger<bool> m_reading;
     QMutex m_mutex;
     QWaitCondition m_cond;
     bool m_quitting;
 };
 
 static dev_t deserializeDeviceId(wl_array *data)
 {
     Q_ASSERT(sizeof(dev_t) == data->size);
     dev_t ret;
     std::memcpy(&ret, data->data, data->size);
     return ret;
 }
 
 class WaylandLinuxDmabufFeedbackV1
 {
 public:
     WaylandLinuxDmabufFeedbackV1(zwp_linux_dmabuf_feedback_v1 *feedback)
         : feedback(feedback)
     {
         static const struct zwp_linux_dmabuf_feedback_v1_listener feedbackListener = {
             .done = done,
             .format_table = format_table,
             .main_device = main_device,
             .tranche_done = tranche_done,
             .tranche_target_device = tranche_target_device,
             .tranche_formats = tranche_formats,
             .tranche_flags = tranche_flags,
         };
         zwp_linux_dmabuf_feedback_v1_add_listener(feedback, &feedbackListener, this);
     }
 
     ~WaylandLinuxDmabufFeedbackV1()
     {
         zwp_linux_dmabuf_feedback_v1_destroy(feedback);
     }
 
     zwp_linux_dmabuf_feedback_v1 *feedback;
     QByteArray mainDevice;
     dev_t mainDeviceId = 0;
     dev_t trancheDeviceId = 0;
     MemoryMap formatTable;
     QHash<uint32_t, QList<uint64_t>> formats;
 
 private:
     static void done(void *data, zwp_linux_dmabuf_feedback_v1 *zwp_linux_dmabuf_feedback_v1)
     {
         // Nothing to do
     }
 
     static void format_table(void *data, zwp_linux_dmabuf_feedback_v1 *zwp_linux_dmabuf_feedback_v1, int32_t fd, uint32_t size)
     {
         WaylandLinuxDmabufFeedbackV1 *feedback = static_cast<WaylandLinuxDmabufFeedbackV1 *>(data);
 
         feedback->formatTable = MemoryMap(size, PROT_READ, MAP_PRIVATE, fd, 0);
         close(fd);
     }
 
     static void main_device(void *data, zwp_linux_dmabuf_feedback_v1 *zwp_linux_dmabuf_feedback_v1, wl_array *deviceId)
     {
         WaylandLinuxDmabufFeedbackV1 *feedback = static_cast<WaylandLinuxDmabufFeedbackV1 *>(data);
 
         feedback->mainDeviceId = deserializeDeviceId(deviceId);
 
         drmDevice *device = nullptr;
         if (drmGetDeviceFromDevId(feedback->mainDeviceId, 0, &device) != 0) {
             qCWarning(KWIN_WAYLAND_BACKEND) << "drmGetDeviceFromDevId() failed";
             return;
         }
 
         if (device->available_nodes & (1 << DRM_NODE_RENDER)) {
             feedback->mainDevice = QByteArray(device->nodes[DRM_NODE_RENDER]);
         } else if (device->available_nodes & (1 << DRM_NODE_PRIMARY)) {
             // We can't reliably find the render node from the primary node if the display and
             // render devices are split, so just fallback to the primary node.
             feedback->mainDevice = QByteArray(device->nodes[DRM_NODE_PRIMARY]);
         }
 
         drmFreeDevice(&device);
     }
 
     static void tranche_done(void *data, zwp_linux_dmabuf_feedback_v1 *zwp_linux_dmabuf_feedback_v1)
     {
         WaylandLinuxDmabufFeedbackV1 *feedback = static_cast<WaylandLinuxDmabufFeedbackV1 *>(data);
 
         feedback->trancheDeviceId = 0;
         feedback->formatTable = MemoryMap{};
     }
 
     static void tranche_target_device(void *data, zwp_linux_dmabuf_feedback_v1 *zwp_linux_dmabuf_feedback_v1, wl_array *deviceId)
     {
         WaylandLinuxDmabufFeedbackV1 *feedback = static_cast<WaylandLinuxDmabufFeedbackV1 *>(data);
 
         feedback->trancheDeviceId = deserializeDeviceId(deviceId);
     }
 
     static void tranche_formats(void *data, zwp_linux_dmabuf_feedback_v1 *zwp_linux_dmabuf_feedback_v1, wl_array *indices)
     {
         WaylandLinuxDmabufFeedbackV1 *feedback = static_cast<WaylandLinuxDmabufFeedbackV1 *>(data);
         if (!feedback->formatTable.isValid()) {
             return;
         }
         if (feedback->mainDeviceId != feedback->trancheDeviceId) {
             return;
         }
 
         struct linux_dmabuf_feedback_v1_table_entry
         {
             uint32_t format;
             uint32_t pad; // unused
             uint64_t modifier;
         };
 
         const auto entries = static_cast<linux_dmabuf_feedback_v1_table_entry *>(feedback->formatTable.data());
         for (const uint16_t &index : std::span(static_cast<uint16_t *>(indices->data), indices->size / sizeof(uint16_t))) {
             const linux_dmabuf_feedback_v1_table_entry &entry = entries[index];
             feedback->formats[entry.format].append(entry.modifier);
         }
     }
 
     static void tranche_flags(void *data, zwp_linux_dmabuf_feedback_v1 *zwp_linux_dmabuf_feedback_v1, uint32_t flags)
     {
         // Nothing to do
     }
 };
 
 WaylandLinuxDmabufV1::WaylandLinuxDmabufV1(wl_registry *registry, uint32_t name, uint32_t version)
 {
     m_dmabuf = static_cast<zwp_linux_dmabuf_v1 *>(wl_registry_bind(registry, name, &zwp_linux_dmabuf_v1_interface, version));
 
     static const struct zwp_linux_dmabuf_v1_listener dmabufListener = {
         .format = format,
         .modifier = modifier,
     };
     zwp_linux_dmabuf_v1_add_listener(m_dmabuf, &dmabufListener, this);
 
     m_defaultFeedback = std::make_unique<WaylandLinuxDmabufFeedbackV1>(zwp_linux_dmabuf_v1_get_default_feedback(m_dmabuf));
 }
 
 WaylandLinuxDmabufV1::~WaylandLinuxDmabufV1()
 {
     zwp_linux_dmabuf_v1_destroy(m_dmabuf);
 }
 
 zwp_linux_dmabuf_v1 *WaylandLinuxDmabufV1::handle() const
 {
     return m_dmabuf;
 }
 
 QByteArray WaylandLinuxDmabufV1::mainDevice() const
 {
     return m_defaultFeedback->mainDevice;
 }
 
 QHash<uint32_t, QList<uint64_t>> WaylandLinuxDmabufV1::formats() const
 {
     return m_defaultFeedback->formats;
 }
 
 void WaylandLinuxDmabufV1::format(void *data, struct zwp_linux_dmabuf_v1 *zwp_linux_dmabuf_v1, uint32_t format)
 {
     // Not sent in v4 and onward.
 }
 
 void WaylandLinuxDmabufV1::modifier(void *data, struct zwp_linux_dmabuf_v1 *zwp_linux_dmabuf_v1, uint32_t format, uint32_t modifier_hi, uint32_t modifier_lo)
 {
     // Not sent in v4 and onward.
 }
 
 WaylandDisplay::WaylandDisplay()
 {
 }
 
 WaylandDisplay::~WaylandDisplay()
 {
     m_eventThread->stop();
     m_eventThread.reset();
 
     m_compositor.reset();
     m_pointerConstraints.reset();
     m_pointerGestures.reset();
     m_relativePointerManager.reset();
     m_seat.reset();
     m_xdgDecorationManager.reset();
     m_xdgShell.reset();
     m_linuxDmabuf.reset();
 
     if (m_shm) {
         wl_shm_destroy(m_shm);
     }
     if (m_registry) {
         wl_registry_destroy(m_registry);
     }
     if (m_display) {
         wl_display_disconnect(m_display);
     }
 }
 
 void WaylandDisplay::flush()
 {
     m_eventThread->dispatch();
 }
 
 bool WaylandDisplay::initialize(const QString &socketName)
 {
     m_display = wl_display_connect(socketName.toUtf8());
     if (!m_display) {
         return false;
     }
 
     m_eventThread = std::make_unique<WaylandEventThread>(m_display);
     connect(m_eventThread.get(), &WaylandEventThread::available, this, &WaylandDisplay::flush, Qt::QueuedConnection);
     m_eventThread->start();
 
     static wl_registry_listener registryListener {
         .global = registry_global,
         .global_remove = registry_global_remove,
     };
     m_registry = wl_display_get_registry(m_display);
     wl_registry_add_listener(m_registry, &registryListener, this);
     wl_display_roundtrip(m_display);
     wl_display_roundtrip(m_display); // get dmabuf formats
 
     return true;
 }
 
 wl_display *WaylandDisplay::nativeDisplay() const
 {
     return m_display;
 }
 
 KWayland::Client::Compositor *WaylandDisplay::compositor() const
 {
     return m_compositor.get();
 }
 
 KWayland::Client::PointerConstraints *WaylandDisplay::pointerConstraints() const
 {
     return m_pointerConstraints.get();
 }
 
 KWayland::Client::PointerGestures *WaylandDisplay::pointerGestures() const
 {
     return m_pointerGestures.get();
 }
 
 KWayland::Client::RelativePointerManager *WaylandDisplay::relativePointerManager() const
 {
     return m_relativePointerManager.get();
 }
 
 wl_shm *WaylandDisplay::shm() const
 {
     return m_shm;
 }
 
 KWayland::Client::Seat *WaylandDisplay::seat() const
 {
     return m_seat.get();
 }
 
 KWayland::Client::XdgShell *WaylandDisplay::xdgShell() const
 {
     return m_xdgShell.get();
 }
 
 KWayland::Client::XdgDecorationManager *WaylandDisplay::xdgDecorationManager() const
 {
     return m_xdgDecorationManager.get();
 }
 
 WaylandLinuxDmabufV1 *WaylandDisplay::linuxDmabuf() const
 {
     return m_linuxDmabuf.get();
 }
 
 void WaylandDisplay::registry_global(void *data, wl_registry *registry, uint32_t name, const char *interface, uint32_t version)
 {
     WaylandDisplay *display = static_cast<WaylandDisplay *>(data);
 
     if (strcmp(interface, wl_compositor_interface.name) == 0) {
         if (version < 4) {
             qFatal("wl_compositor version 4 or later is required");
         }
         display->m_compositor = std::make_unique<KWayland::Client::Compositor>();
         display->m_compositor->setup(static_cast<wl_compositor *>(wl_registry_bind(registry, name, &wl_compositor_interface, std::min(version, 4u))));
     } else if (strcmp(interface, wl_shm_interface.name) == 0) {
         display->m_shm = static_cast<wl_shm *>(wl_registry_bind(registry, name, &wl_shm_interface, std::min(version, 1u)));
     } else if (strcmp(interface, wl_seat_interface.name) == 0) {
         display->m_seat = std::make_unique<KWayland::Client::Seat>();
         display->m_seat->setup(static_cast<wl_seat *>(wl_registry_bind(registry, name, &wl_seat_interface, std::min(version, 5u))));
     } else if (strcmp(interface, xdg_wm_base_interface.name) == 0) {
         display->m_xdgShell = std::make_unique<KWayland::Client::XdgShellStable>();
         display->m_xdgShell->setup(static_cast<xdg_wm_base *>(wl_registry_bind(registry, name, &xdg_wm_base_interface, std::min(version, 1u))));
     } else if (strcmp(interface, zwp_pointer_constraints_v1_interface.name) == 0) {
         display->m_pointerConstraints = std::make_unique<KWayland::Client::PointerConstraints>();
         display->m_pointerConstraints->setup(static_cast<zwp_pointer_constraints_v1 *>(wl_registry_bind(registry, name, &zwp_pointer_constraints_v1_interface, std::min(version, 1u))));
     } else if (strcmp(interface, zwp_pointer_gestures_v1_interface.name) == 0) {
         display->m_pointerGestures = std::make_unique<KWayland::Client::PointerGestures>();
         display->m_pointerGestures->setup(static_cast<zwp_pointer_gestures_v1 *>(wl_registry_bind(registry, name, &zwp_pointer_gestures_v1_interface, std::min(version, 1u))));
     } else if (strcmp(interface, zwp_relative_pointer_manager_v1_interface.name) == 0) {
         display->m_relativePointerManager = std::make_unique<KWayland::Client::RelativePointerManager>();
         display->m_relativePointerManager->setup(static_cast<zwp_relative_pointer_manager_v1 *>(wl_registry_bind(registry, name, &zwp_relative_pointer_manager_v1_interface, std::min(version, 1u))));
     } else if (strcmp(interface, zxdg_decoration_manager_v1_interface.name) == 0) {
         display->m_xdgDecorationManager = std::make_unique<KWayland::Client::XdgDecorationManager>();
         display->m_xdgDecorationManager->setup(static_cast<zxdg_decoration_manager_v1 *>(wl_registry_bind(registry, name, &zxdg_decoration_manager_v1_interface, std::min(version, 1u))));
     } else if (strcmp(interface, zwp_linux_dmabuf_v1_interface.name) == 0) {
         if (version < 4) {
             qWarning("zwp_linux_dmabuf_v1 v4 or newer is needed");
             return;
         }
         display->m_linuxDmabuf = std::make_unique<WaylandLinuxDmabufV1>(registry, name, std::min(version, 4u));
     }
 }
 
 void WaylandDisplay::registry_global_remove(void *data, wl_registry *registry, uint32_t name)
 {
 }
 
 }
 }
 
 #include "wayland_display.moc"
 
 #include "moc_wayland_display.cpp"