#define _POSIX_C_SOURCE 200809L #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include "backend/x11.h" #include "render/drm_format_set.h" #include "util/signal.h" // See dri2_format_for_depth in mesa const struct wlr_x11_format formats[] = { { .drm = DRM_FORMAT_XRGB8888, .depth = 24, .bpp = 32 }, { .drm = DRM_FORMAT_ARGB8888, .depth = 32, .bpp = 32 }, }; static const struct wlr_x11_format *x11_format_from_depth(uint8_t depth) { for (size_t i = 0; i < sizeof(formats) / sizeof(formats[0]); i++) { if (formats[i].depth == depth) { return &formats[i]; } } return NULL; } struct wlr_x11_output *get_x11_output_from_window_id( struct wlr_x11_backend *x11, xcb_window_t window) { struct wlr_x11_output *output; wl_list_for_each(output, &x11->outputs, link) { if (output->win == window) { return output; } } return NULL; } static void handle_x11_error(struct wlr_x11_backend *x11, xcb_value_error_t *ev); static void handle_x11_unknown_event(struct wlr_x11_backend *x11, xcb_generic_event_t *ev); static void handle_x11_event(struct wlr_x11_backend *x11, xcb_generic_event_t *event) { switch (event->response_type & XCB_EVENT_RESPONSE_TYPE_MASK) { case XCB_EXPOSE: { xcb_expose_event_t *ev = (xcb_expose_event_t *)event; struct wlr_x11_output *output = get_x11_output_from_window_id(x11, ev->window); if (output != NULL) { pixman_region32_union_rect( &output->exposed, &output->exposed, ev->x, ev->y, ev->width, ev->height); wlr_output_update_needs_frame(&output->wlr_output); } break; } case XCB_CONFIGURE_NOTIFY: { xcb_configure_notify_event_t *ev = (xcb_configure_notify_event_t *)event; struct wlr_x11_output *output = get_x11_output_from_window_id(x11, ev->window); if (output != NULL) { handle_x11_configure_notify(output, ev); } break; } case XCB_CLIENT_MESSAGE: { xcb_client_message_event_t *ev = (xcb_client_message_event_t *)event; if (ev->data.data32[0] == x11->atoms.wm_delete_window) { struct wlr_x11_output *output = get_x11_output_from_window_id(x11, ev->window); if (output != NULL) { wlr_output_destroy(&output->wlr_output); } } else { wlr_log(WLR_DEBUG, "Unhandled client message %"PRIu32, ev->data.data32[0]); } break; } case XCB_GE_GENERIC: { xcb_ge_generic_event_t *ev = (xcb_ge_generic_event_t *)event; if (ev->extension == x11->xinput_opcode) { handle_x11_xinput_event(x11, ev); } else if (ev->extension == x11->present_opcode) { handle_x11_present_event(x11, ev); } else { handle_x11_unknown_event(x11, event); } break; } case 0: { xcb_value_error_t *ev = (xcb_value_error_t *)event; handle_x11_error(x11, ev); break; } case XCB_UNMAP_NOTIFY: case XCB_MAP_NOTIFY: break; default: handle_x11_unknown_event(x11, event); break; } } static int x11_event(int fd, uint32_t mask, void *data) { struct wlr_x11_backend *x11 = data; if ((mask & WL_EVENT_HANGUP) || (mask & WL_EVENT_ERROR)) { if (mask & WL_EVENT_ERROR) { wlr_log(WLR_ERROR, "Failed to read from X11 server"); } wl_display_terminate(x11->wl_display); return 0; } xcb_generic_event_t *e; while ((e = xcb_poll_for_event(x11->xcb))) { handle_x11_event(x11, e); free(e); } int ret = xcb_connection_has_error(x11->xcb); if (ret != 0) { wlr_log(WLR_ERROR, "X11 connection error (%d)", ret); wl_display_terminate(x11->wl_display); } return 0; } struct wlr_x11_backend *get_x11_backend_from_backend( struct wlr_backend *wlr_backend) { assert(wlr_backend_is_x11(wlr_backend)); return (struct wlr_x11_backend *)wlr_backend; } static bool backend_start(struct wlr_backend *backend) { struct wlr_x11_backend *x11 = get_x11_backend_from_backend(backend); x11->started = true; wlr_log(WLR_INFO, "Starting X11 backend"); wlr_signal_emit_safe(&x11->backend.events.new_input, &x11->keyboard_dev); for (size_t i = 0; i < x11->requested_outputs; ++i) { wlr_x11_output_create(&x11->backend); } return true; } static void backend_destroy(struct wlr_backend *backend) { if (!backend) { return; } struct wlr_x11_backend *x11 = get_x11_backend_from_backend(backend); struct wlr_x11_output *output, *tmp; wl_list_for_each_safe(output, tmp, &x11->outputs, link) { wlr_output_destroy(&output->wlr_output); } wlr_input_device_destroy(&x11->keyboard_dev); wlr_backend_finish(backend); if (x11->event_source) { wl_event_source_remove(x11->event_source); } wl_list_remove(&x11->display_destroy.link); wlr_drm_format_set_finish(&x11->primary_dri3_formats); wlr_drm_format_set_finish(&x11->primary_shm_formats); wlr_drm_format_set_finish(&x11->dri3_formats); wlr_drm_format_set_finish(&x11->shm_formats); #if HAS_XCB_ERRORS xcb_errors_context_free(x11->errors_context); #endif close(x11->drm_fd); xcb_disconnect(x11->xcb); free(x11); } static int backend_get_drm_fd(struct wlr_backend *backend) { struct wlr_x11_backend *x11 = get_x11_backend_from_backend(backend); return x11->drm_fd; } static uint32_t get_buffer_caps(struct wlr_backend *backend) { struct wlr_x11_backend *x11 = get_x11_backend_from_backend(backend); return (x11->have_dri3 ? WLR_BUFFER_CAP_DMABUF : 0) | (x11->have_shm ? WLR_BUFFER_CAP_SHM : 0); } static const struct wlr_backend_impl backend_impl = { .start = backend_start, .destroy = backend_destroy, .get_drm_fd = backend_get_drm_fd, .get_buffer_caps = get_buffer_caps, }; bool wlr_backend_is_x11(struct wlr_backend *backend) { return backend->impl == &backend_impl; } static void handle_display_destroy(struct wl_listener *listener, void *data) { struct wlr_x11_backend *x11 = wl_container_of(listener, x11, display_destroy); backend_destroy(&x11->backend); } static xcb_depth_t *get_depth(xcb_screen_t *screen, uint8_t depth) { xcb_depth_iterator_t iter = xcb_screen_allowed_depths_iterator(screen); while (iter.rem > 0) { if (iter.data->depth == depth) { return iter.data; } xcb_depth_next(&iter); } return NULL; } static xcb_visualid_t pick_visualid(xcb_depth_t *depth) { xcb_visualtype_t *visuals = xcb_depth_visuals(depth); for (int i = 0; i < xcb_depth_visuals_length(depth); i++) { if (visuals[i]._class == XCB_VISUAL_CLASS_TRUE_COLOR) { return visuals[i].visual_id; } } return 0; } static int query_dri3_drm_fd(struct wlr_x11_backend *x11) { xcb_dri3_open_cookie_t open_cookie = xcb_dri3_open(x11->xcb, x11->screen->root, 0); xcb_dri3_open_reply_t *open_reply = xcb_dri3_open_reply(x11->xcb, open_cookie, NULL); if (open_reply == NULL) { return -1; } int *open_fds = xcb_dri3_open_reply_fds(x11->xcb, open_reply); if (open_fds == NULL) { free(open_reply); return -1; } assert(open_reply->nfd == 1); int drm_fd = open_fds[0]; free(open_reply); int flags = fcntl(drm_fd, F_GETFD); if (flags < 0) { close(drm_fd); return -1; } if (fcntl(drm_fd, F_SETFD, flags | FD_CLOEXEC) < 0) { close(drm_fd); return -1; } if (drmGetNodeTypeFromFd(drm_fd) != DRM_NODE_RENDER) { char *render_name = drmGetRenderDeviceNameFromFd(drm_fd); if (render_name == NULL) { close(drm_fd); return -1; } close(drm_fd); drm_fd = open(render_name, O_RDWR | O_CLOEXEC); if (drm_fd < 0) { free(render_name); return -1; } free(render_name); } return drm_fd; } static bool query_dri3_modifiers(struct wlr_x11_backend *x11, const struct wlr_x11_format *format) { if (x11->dri3_major_version == 1 && x11->dri3_minor_version < 2) { return true; // GetSupportedModifiers requires DRI3 1.2 } // Query the root window's supported modifiers, because we only care about // screen_modifiers for now xcb_dri3_get_supported_modifiers_cookie_t modifiers_cookie = xcb_dri3_get_supported_modifiers(x11->xcb, x11->screen->root, format->depth, format->bpp); xcb_dri3_get_supported_modifiers_reply_t *modifiers_reply = xcb_dri3_get_supported_modifiers_reply(x11->xcb, modifiers_cookie, NULL); if (!modifiers_reply) { wlr_log(WLR_ERROR, "Failed to get DMA-BUF modifiers supported by " "the X11 server for the format 0x%"PRIX32, format->drm); return false; } // If modifiers aren't supported, DRI3 will return an empty list const uint64_t *modifiers = xcb_dri3_get_supported_modifiers_screen_modifiers(modifiers_reply); int modifiers_len = xcb_dri3_get_supported_modifiers_screen_modifiers_length(modifiers_reply); for (int i = 0; i < modifiers_len; i++) { wlr_drm_format_set_add(&x11->dri3_formats, format->drm, modifiers[i]); } free(modifiers_reply); return true; } static bool query_formats(struct wlr_x11_backend *x11) { xcb_depth_iterator_t iter = xcb_screen_allowed_depths_iterator(x11->screen); while (iter.rem > 0) { uint8_t depth = iter.data->depth; const struct wlr_x11_format *format = x11_format_from_depth(depth); if (format != NULL) { if (x11->have_shm) { wlr_drm_format_set_add(&x11->shm_formats, format->drm, DRM_FORMAT_MOD_INVALID); } if (x11->have_dri3) { // X11 always supports implicit modifiers wlr_drm_format_set_add(&x11->dri3_formats, format->drm, DRM_FORMAT_MOD_INVALID); if (!query_dri3_modifiers(x11, format)) { return false; } } } xcb_depth_next(&iter); } return true; } static void x11_get_argb32(struct wlr_x11_backend *x11) { xcb_render_query_pict_formats_cookie_t cookie = xcb_render_query_pict_formats(x11->xcb); xcb_render_query_pict_formats_reply_t *reply = xcb_render_query_pict_formats_reply(x11->xcb, cookie, NULL); if (!reply) { wlr_log(WLR_ERROR, "Did not get any reply from xcb_render_query_pict_formats"); return; } xcb_render_pictforminfo_t *format = xcb_render_util_find_standard_format(reply, XCB_PICT_STANDARD_ARGB_32); if (format == NULL) { wlr_log(WLR_DEBUG, "No ARGB_32 render format"); free(reply); return; } x11->argb32 = format->id; free(reply); } struct wlr_backend *wlr_x11_backend_create(struct wl_display *display, const char *x11_display) { wlr_log(WLR_INFO, "Creating X11 backend"); struct wlr_x11_backend *x11 = calloc(1, sizeof(*x11)); if (!x11) { return NULL; } wlr_backend_init(&x11->backend, &backend_impl); x11->wl_display = display; wl_list_init(&x11->outputs); x11->xcb = xcb_connect(x11_display, NULL); if (!x11->xcb || xcb_connection_has_error(x11->xcb)) { wlr_log(WLR_ERROR, "Failed to open xcb connection"); goto error_x11; } struct { const char *name; xcb_intern_atom_cookie_t cookie; xcb_atom_t *atom; } atom[] = { { .name = "WM_PROTOCOLS", .atom = &x11->atoms.wm_protocols }, { .name = "WM_DELETE_WINDOW", .atom = &x11->atoms.wm_delete_window }, { .name = "_NET_WM_NAME", .atom = &x11->atoms.net_wm_name }, { .name = "UTF8_STRING", .atom = &x11->atoms.utf8_string }, { .name = "_VARIABLE_REFRESH", .atom = &x11->atoms.variable_refresh }, }; for (size_t i = 0; i < sizeof(atom) / sizeof(atom[0]); ++i) { atom[i].cookie = xcb_intern_atom(x11->xcb, true, strlen(atom[i].name), atom[i].name); } for (size_t i = 0; i < sizeof(atom) / sizeof(atom[0]); ++i) { xcb_intern_atom_reply_t *reply = xcb_intern_atom_reply( x11->xcb, atom[i].cookie, NULL); if (reply) { *atom[i].atom = reply->atom; free(reply); } else { *atom[i].atom = XCB_ATOM_NONE; } } const xcb_query_extension_reply_t *ext; // DRI3 extension ext = xcb_get_extension_data(x11->xcb, &xcb_dri3_id); if (ext && ext->present) { xcb_dri3_query_version_cookie_t dri3_cookie = xcb_dri3_query_version(x11->xcb, 1, 2); xcb_dri3_query_version_reply_t *dri3_reply = xcb_dri3_query_version_reply(x11->xcb, dri3_cookie, NULL); if (dri3_reply && dri3_reply->major_version >= 1) { x11->have_dri3 = true; x11->dri3_major_version = dri3_reply->major_version; x11->dri3_minor_version = dri3_reply->minor_version; } else { wlr_log(WLR_INFO, "X11 does not support required DRI3 version " "(has %"PRIu32".%"PRIu32", want 1.0)", dri3_reply->major_version, dri3_reply->minor_version); } free(dri3_reply); } else { wlr_log(WLR_INFO, "X11 does not support DRI3 extension"); } // SHM extension ext = xcb_get_extension_data(x11->xcb, &xcb_shm_id); if (ext && ext->present) { xcb_shm_query_version_cookie_t shm_cookie = xcb_shm_query_version(x11->xcb); xcb_shm_query_version_reply_t *shm_reply = xcb_shm_query_version_reply(x11->xcb, shm_cookie, NULL); if (shm_reply) { if (shm_reply->major_version >= 1 || shm_reply->minor_version >= 2) { if (shm_reply->shared_pixmaps) { x11->have_shm = true; } else { wlr_log(WLR_INFO, "X11 does not support shared pixmaps"); } } else { wlr_log(WLR_INFO, "X11 does not support required SHM version " "(has %"PRIu32".%"PRIu32", want 1.2)", shm_reply->major_version, shm_reply->minor_version); } } else { wlr_log(WLR_INFO, "X11 does not support required SHM version"); } free(shm_reply); } else { wlr_log(WLR_INFO, "X11 does not support SHM extension"); } // Present extension ext = xcb_get_extension_data(x11->xcb, &xcb_present_id); if (!ext || !ext->present) { wlr_log(WLR_ERROR, "X11 does not support Present extension"); goto error_display; } x11->present_opcode = ext->major_opcode; xcb_present_query_version_cookie_t present_cookie = xcb_present_query_version(x11->xcb, 1, 2); xcb_present_query_version_reply_t *present_reply = xcb_present_query_version_reply(x11->xcb, present_cookie, NULL); if (!present_reply || present_reply->major_version < 1) { wlr_log(WLR_ERROR, "X11 does not support required Present version " "(has %"PRIu32".%"PRIu32", want 1.0)", present_reply->major_version, present_reply->minor_version); free(present_reply); goto error_display; } free(present_reply); // Xfixes extension ext = xcb_get_extension_data(x11->xcb, &xcb_xfixes_id); if (!ext || !ext->present) { wlr_log(WLR_ERROR, "X11 does not support Xfixes extension"); goto error_display; } xcb_xfixes_query_version_cookie_t fixes_cookie = xcb_xfixes_query_version(x11->xcb, 4, 0); xcb_xfixes_query_version_reply_t *fixes_reply = xcb_xfixes_query_version_reply(x11->xcb, fixes_cookie, NULL); if (!fixes_reply || fixes_reply->major_version < 4) { wlr_log(WLR_ERROR, "X11 does not support required Xfixes version " "(has %"PRIu32".%"PRIu32", want 4.0)", fixes_reply->major_version, fixes_reply->minor_version); free(fixes_reply); goto error_display; } free(fixes_reply); // Xinput extension ext = xcb_get_extension_data(x11->xcb, &xcb_input_id); if (!ext || !ext->present) { wlr_log(WLR_ERROR, "X11 does not support Xinput extension"); goto error_display; } x11->xinput_opcode = ext->major_opcode; xcb_input_xi_query_version_cookie_t xi_cookie = xcb_input_xi_query_version(x11->xcb, 2, 0); xcb_input_xi_query_version_reply_t *xi_reply = xcb_input_xi_query_version_reply(x11->xcb, xi_cookie, NULL); if (!xi_reply || xi_reply->major_version < 2) { wlr_log(WLR_ERROR, "X11 does not support required Xinput version " "(has %"PRIu32".%"PRIu32", want 2.0)", xi_reply->major_version, xi_reply->minor_version); free(xi_reply); goto error_display; } free(xi_reply); int fd = xcb_get_file_descriptor(x11->xcb); struct wl_event_loop *ev = wl_display_get_event_loop(display); uint32_t events = WL_EVENT_READABLE | WL_EVENT_ERROR | WL_EVENT_HANGUP; x11->event_source = wl_event_loop_add_fd(ev, fd, events, x11_event, x11); if (!x11->event_source) { wlr_log(WLR_ERROR, "Could not create event source"); goto error_display; } wl_event_source_check(x11->event_source); x11->screen = xcb_setup_roots_iterator(xcb_get_setup(x11->xcb)).data; if (!x11->screen) { wlr_log(WLR_ERROR, "Failed to get X11 screen"); goto error_event; } x11->depth = get_depth(x11->screen, 24); if (!x11->depth) { wlr_log(WLR_ERROR, "Failed to get 24-bit depth for X11 screen"); goto error_event; } x11->visualid = pick_visualid(x11->depth); if (!x11->visualid) { wlr_log(WLR_ERROR, "Failed to pick X11 visual"); goto error_event; } x11->x11_format = x11_format_from_depth(x11->depth->depth); if (!x11->x11_format) { wlr_log(WLR_ERROR, "Unsupported depth %"PRIu8, x11->depth->depth); goto error_event; } x11->colormap = xcb_generate_id(x11->xcb); xcb_create_colormap(x11->xcb, XCB_COLORMAP_ALLOC_NONE, x11->colormap, x11->screen->root, x11->visualid); if (!query_formats(x11)) { wlr_log(WLR_ERROR, "Failed to query supported DRM formats"); return false; } x11->drm_fd = -1; if (x11->have_dri3) { // DRI3 may return a render node (Xwayland) or an authenticated primary // node (plain Glamor). x11->drm_fd = query_dri3_drm_fd(x11); if (x11->drm_fd < 0) { wlr_log(WLR_ERROR, "Failed to query DRI3 DRM FD"); goto error_event; } } // Windows can only display buffers with the depth they were created with // TODO: look into changing the window's depth at runtime const struct wlr_drm_format *dri3_format = wlr_drm_format_set_get(&x11->dri3_formats, x11->x11_format->drm); if (x11->have_dri3 && dri3_format != NULL) { wlr_drm_format_set_add(&x11->primary_dri3_formats, dri3_format->format, DRM_FORMAT_MOD_INVALID); for (size_t i = 0; i < dri3_format->len; i++) { wlr_drm_format_set_add(&x11->primary_dri3_formats, dri3_format->format, dri3_format->modifiers[i]); } } const struct wlr_drm_format *shm_format = wlr_drm_format_set_get(&x11->shm_formats, x11->x11_format->drm); if (x11->have_shm && shm_format != NULL) { wlr_drm_format_set_add(&x11->primary_shm_formats, shm_format->format, DRM_FORMAT_MOD_INVALID); } #if HAS_XCB_ERRORS if (xcb_errors_context_new(x11->xcb, &x11->errors_context) != 0) { wlr_log(WLR_ERROR, "Failed to create error context"); return false; } #endif wlr_input_device_init(&x11->keyboard_dev, WLR_INPUT_DEVICE_KEYBOARD, &input_device_impl, "X11 keyboard"); wlr_keyboard_init(&x11->keyboard, &keyboard_impl); x11->keyboard_dev.keyboard = &x11->keyboard; x11->display_destroy.notify = handle_display_destroy; wl_display_add_destroy_listener(display, &x11->display_destroy); // Create an empty pixmap to be used as the cursor. The // default GC foreground is 0, and that is what it will be // filled with. xcb_pixmap_t blank = xcb_generate_id(x11->xcb); xcb_create_pixmap(x11->xcb, 1, blank, x11->screen->root, 1, 1); xcb_gcontext_t gc = xcb_generate_id(x11->xcb); xcb_create_gc(x11->xcb, gc, blank, 0, NULL); xcb_rectangle_t rect = { .x = 0, .y = 0, .width = 1, .height = 1 }; xcb_poly_fill_rectangle(x11->xcb, blank, gc, 1, &rect); x11->transparent_cursor = xcb_generate_id(x11->xcb); xcb_create_cursor(x11->xcb, x11->transparent_cursor, blank, blank, 0, 0, 0, 0, 0, 0, 0, 0); xcb_free_gc(x11->xcb, gc); xcb_free_pixmap(x11->xcb, blank); x11_get_argb32(x11); return &x11->backend; error_event: wl_event_source_remove(x11->event_source); error_display: xcb_disconnect(x11->xcb); error_x11: free(x11); return NULL; } static void handle_x11_error(struct wlr_x11_backend *x11, xcb_value_error_t *ev) { #if HAS_XCB_ERRORS const char *major_name = xcb_errors_get_name_for_major_code( x11->errors_context, ev->major_opcode); if (!major_name) { wlr_log(WLR_DEBUG, "X11 error happened, but could not get major name"); goto log_raw; } const char *minor_name = xcb_errors_get_name_for_minor_code( x11->errors_context, ev->major_opcode, ev->minor_opcode); const char *extension; const char *error_name = xcb_errors_get_name_for_error(x11->errors_context, ev->error_code, &extension); if (!error_name) { wlr_log(WLR_DEBUG, "X11 error happened, but could not get error name"); goto log_raw; } wlr_log(WLR_ERROR, "X11 error: op %s (%s), code %s (%s), " "sequence %"PRIu16", value %"PRIu32, major_name, minor_name ? minor_name : "no minor", error_name, extension ? extension : "no extension", ev->sequence, ev->bad_value); return; log_raw: #endif wlr_log(WLR_ERROR, "X11 error: op %"PRIu8":%"PRIu16", code %"PRIu8", " "sequence %"PRIu16", value %"PRIu32, ev->major_opcode, ev->minor_opcode, ev->error_code, ev->sequence, ev->bad_value); } static void handle_x11_unknown_event(struct wlr_x11_backend *x11, xcb_generic_event_t *ev) { #if HAS_XCB_ERRORS const char *extension; const char *event_name = xcb_errors_get_name_for_xcb_event( x11->errors_context, ev, &extension); if (!event_name) { wlr_log(WLR_DEBUG, "No name for unhandled event: %u", ev->response_type); return; } wlr_log(WLR_DEBUG, "Unhandled X11 event: %s (%u)", event_name, ev->response_type); #else wlr_log(WLR_DEBUG, "Unhandled X11 event: %u", ev->response_type); #endif }