A modular Wayland compositor library
Go to file
Dominique Martinet ffd37b664f xdg_shell: destroy children popups with parent surface
popups have a link in parent's surface->popups list and needs
to be freed before:

==6902==ERROR: AddressSanitizer: heap-use-after-free on address 0x6120001a0300 at pc 0x7fc1447acb50 bp 0x7fffd396e680 sp 0x7fffd396e670
WRITE of size 8 at 0x6120001a0300 thread T0
    #0 0x7fc1447acb4f in wl_list_remove ../util/signal.c:55
    #1 0x7fc14477d206 in destroy_xdg_popup_v6 ../types/xdg_shell_v6/wlr_xdg_popup_v6.c:162
    #2 0x7fc1447816e0 in destroy_xdg_surface_v6 ../types/xdg_shell_v6/wlr_xdg_surface_v6.c:108
    #3 0x7fc144a1c025 in destroy_resource src/wayland-server.c:688
    #4 0x7fc144a1c091 in wl_resource_destroy src/wayland-server.c:705
    #5 0x7fc14477fd6f in xdg_client_v6_handle_resource_destroy ../types/xdg_shell_v6/wlr_xdg_shell_v6.c:72
    #6 0x7fc144a1c025 in destroy_resource src/wayland-server.c:688
    #7 0x7fc144a20851  (/lib64/libwayland-server.so.0+0xc851)
    #8 0x7fc144a20d92  (/lib64/libwayland-server.so.0+0xcd92)
    #9 0x7fc144a1c140 in wl_client_destroy src/wayland-server.c:847
    #10 0x7fc144a1c21c in destroy_client_with_error src/wayland-server.c:307
    #11 0x7fc144a1c21c in wl_client_connection_data src/wayland-server.c:330
    #12 0x7fc144a1df01 in wl_event_loop_dispatch src/event-loop.c:641
    #13 0x7fc144a1c601 in wl_display_run src/wayland-server.c:1260
    #14 0x40a2f4 in main ../sway/main.c:433
    #15 0x7fc143ef718a in __libc_start_main ../csu/libc-start.c:308
    #16 0x40b749 in _start (/opt/wayland/bin/sway+0x40b749)

0x6120001a0300 is located 64 bytes inside of 264-byte region [0x6120001a02c0,0x6120001a03c8)
freed by thread T0 here:
    #0 0x7fc14690d880 in __interceptor_free (/lib64/libasan.so.5+0xee880)
    #1 0x7fc1447acce8 in wlr_signal_emit_safe ../util/signal.c:29
    #2 0x7fc1447a3cac in surface_handle_resource_destroy ../types/wlr_surface.c:576
    #3 0x7fc144a1c025 in destroy_resource src/wayland-server.c:688

previously allocated by thread T0 here:
    #0 0x7fc14690de50 in calloc (/lib64/libasan.so.5+0xeee50)
    #1 0x7fc144781d38 in create_xdg_surface_v6 ../types/xdg_shell_v6/wlr_xdg_surface_v6.c:415
    #2 0x7fc14147503d in ffi_call_unix64 (/lib64/libffi.so.6+0x603d)

Alternative would be to have popups listen to the parent's surface
destroy event and remove themselves from the list at this point OR on
their own destroy, whichever happens first, but that seems more
complicated for little benefit.
2018-06-25 17:54:25 +09:00
backend Merge pull request #992 from emersion/screencontent 2018-06-22 05:37:07 -07:00
docs backend: allow multiple backends in WLR_BACKENDS 2018-05-19 09:09:03 +01:00
examples Fix example 2018-06-17 15:19:17 +01:00
include Merge pull request #992 from emersion/screencontent 2018-06-22 05:37:07 -07:00
protocol Update example and protocol 2018-06-17 14:06:52 +01:00
render Merge branch 'master' into screencontent 2018-06-17 14:49:18 +01:00
rootston use seat function to end grab 2018-06-24 18:18:30 -04:00
types xdg_shell: destroy children popups with parent surface 2018-06-25 17:54:25 +09:00
util Remove wlr_ prefix from local symbols 2018-04-25 23:00:46 +01:00
xcursor Don't use the wlr_ prefix for static functions 2018-04-25 23:51:00 +01:00
xwayland xwm: fix use-after-free involving parents/children 2018-06-25 17:28:44 +09:00
.build.yml build: add dependencies for examples/dmabuf-capture 2018-05-29 18:47:20 +01:00
.editorconfig Add wlr_primary_selection_device_manager and wlr_primary_selection_source 2017-12-22 19:20:12 +01:00
.gitignore update .gitignore 2018-03-03 15:23:26 +01:00
CONTRIBUTING.md cleanup: Use void for zero-parameter functions 2018-05-30 20:19:16 -04:00
glgen.sh Change glapi.sh to generate both files 2017-11-22 14:04:29 +13:00
LICENSE Update LICENSE year (MIT license) 2018-04-12 21:29:59 -04:00
meson_options.txt Add option to disable examples build 2018-05-05 09:50:10 +02:00
meson.build rootston: use wl_display_destroy_clients 2018-05-29 22:50:26 +01:00
README.md Fix xcb/xkb swap in README 2018-05-05 00:25:11 -05:00
wlroots.syms Remove wlr_ prefix from local symbols 2018-04-25 23:00:46 +01:00

wlroots

Pluggable, composable, unopinionated modules for building a Wayland compositor; or about 40,000 lines of code you were going to write anyway.

  • wlroots provides backends that abstract the underlying display and input hardware, including KMS/DRM, libinput, Wayland, X11, and headless backends, plus any custom backends you choose to write, which can all be created or destroyed at runtime and used in concert with each other.
  • wlroots provides unopinionated, mostly standalone implementations of many Wayland interfaces, both from wayland.xml and various protocol extensions. We also promote the standardization of portable extensions across many compositors.
  • wlroots provides several powerful, standalone, and optional tools that implement components common to many compositors, such as the arrangement of outputs in physical space.
  • wlroots provides an Xwayland abstraction that allows you to have excellent Xwayland support without worrying about writing your own X11 window manager on top of writing your compositor.
  • wlroots provides a renderer abstraction that simple compositors can use to avoid writing GL code directly, but which steps out of the way when your needs demand custom rendering code.

wlroots implements a huge variety of Wayland compositor features and implements them right, so you can focus on the features that make your compositor unique. By using wlroots, you get high performance, excellent hardware compatibility, broad support for many wayland interfaces, and comfortable development tools - or any subset of these features you like, because all of them work independently of one another and freely compose with anything you want to implement yourself.

Status: prior to 1.0 the API is not stable, but we've done most of the work and various projects are using wlroots to build Wayland compositors with.

wlroots is developed under the direction of the sway project. A variety of wrapper libraries are available for using it with your favorite programming language.

Building

Install dependencies:

  • meson
  • wayland
  • wayland-protocols
  • EGL
  • GLESv2
  • libdrm
  • GBM
  • libinput
  • xkbcommon
  • udev
  • pixman
  • systemd (optional, for logind support)
  • elogind (optional, for logind support on systems without systemd)
  • libcap (optional, for capability support)

If you choose to enable X11 support:

  • xcb
  • xcb-composite
  • xcb-xfixes
  • xcb-image
  • xcb-render
  • x11-xcb
  • xcb-errors (optional, for improved error reporting)
  • x11-icccm (optional, for improved Xwayland introspection)
  • xcb-xkb (optional, for improved keyboard handling on the X11 backend)

Run these commands:

meson build
ninja -C build

On FreeBSD, you need to pass an extra flag to prevent a linking error: meson build -D b_lundef=false.

Install like so:

sudo ninja -C build install

Running the test compositor

wlroots comes with a test compositor called rootston, which demonstrates the features of the library and is used as a testbed for the development of the library. It may also be useful as a reference for understanding how to use various wlroots features.

If you followed the build instructions above the rootston executable can be found at ./build/rootston/rootston. To use it, refer to the example config at ./rootston/rootston.ini.example and place a config file of your own at rootston.ini in the working directory (or in an arbitrary location via rootston -C). Other options are available, refer to rootston -h.

Contributing

See CONTRIBUTING.md.