mainnika/weston
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

compositor: Implement JSON-timeline logging

Browse Source 
Logging is activated and deactivated with the debug key binding 't'.
When activated, it creates a new log file, where it records the events.
The log file contains events and detailed object information entries in
JSON format, and is meant to be parsed in sequence from beginning to the
end.

The emitted events are mostly related to the output repaint cycle, like
when repaint begins, is submitted to GPU, and when it completes on a
vblank. This is recorded per-output. Also some per-surface events are
recorded, including when surface damage is flushed.

To reduce the log size, events refer to objects like outputs and
surfaces by id numbers. Detailed object information is emitted only as
needed: on the first object occurrence, and afterwards only if
weston_timeline_object::force_refresh asks for it.

The detailed information for surfaces includes the string returned by
weston_surface::get_label. Therefore it is important to set
weston_timeline_object::force_refresh = 1 whenever the string would
change, so that the new details get recorded.

A rudimentary parser and SVG generator can be found at:
https://github.com/ppaalanen/wesgr

The timeline logs can answer questions including:
- How does the compositor repaint cycle work timing-wise?
- When was the vblank deadline missed?
- What is the latency from surface commit to showing the new content on
  screen?
- How long does it take to process the scenegraph?

v2: weston_surface::get_description renamed to get_label.
v3: reafctor a bit into fprint_quoted_string().

Signed-off-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk>
This commit is contained in:
Pekka Paalanen
2014-11-12 15:09:24 +02:00
parent 8274d901f1
commit b502654b9f
7 changed files with 476 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files
desktop-shell/shell.c
+19 -9
View File
@@ -2244,6 +2244,14 @@ set_title(struct shell_surface *shsurf, const char *title)
{
free(shsurf->title);
shsurf->title = strdup(title);
shsurf->surface->timeline.force_refresh = 1;
}
static void
set_type(struct shell_surface *shsurf, enum shell_surface_type t)
{
shsurf->type = t;
shsurf->surface->timeline.force_refresh = 1;
}
static void
@@ -2274,6 +2282,7 @@ shell_surface_set_class(struct wl_client *client,
free(shsurf->class);
shsurf->class = strdup(class);
shsurf->surface->timeline.force_refresh = 1;
}
static void
@@ -2440,7 +2449,7 @@ set_toplevel(struct shell_surface *shsurf)
{
shell_surface_set_parent(shsurf, NULL);
surface_clear_next_states(shsurf);
shsurf->type = SHELL_SURFACE_TOPLEVEL;
set_type(shsurf, SHELL_SURFACE_TOPLEVEL);
/* The layer_link is updated in set_surface_type(),
* called from configure. */
@@ -2471,7 +2480,7 @@ set_transient(struct shell_surface *shsurf,
shsurf->next_state.relative = true;
shsurf->state_changed = true;
shsurf->type = SHELL_SURFACE_TOPLEVEL;
set_type(shsurf, SHELL_SURFACE_TOPLEVEL);
/* The layer_link is updated in set_surface_type(),
* called from configure. */
@@ -2497,7 +2506,7 @@ set_fullscreen(struct shell_surface *shsurf,
struct weston_output *output)
{
shell_surface_set_output(shsurf, output);
shsurf->type = SHELL_SURFACE_TOPLEVEL;
set_type(shsurf, SHELL_SURFACE_TOPLEVEL);
shsurf->fullscreen_output = shsurf->output;
shsurf->fullscreen.type = method;
@@ -2582,7 +2591,7 @@ set_popup(struct shell_surface *shsurf,
shsurf->popup.x = x;
shsurf->popup.y = y;
shsurf->type = SHELL_SURFACE_POPUP;
set_type(shsurf, SHELL_SURFACE_POPUP);
}
static void
@@ -2686,7 +2695,7 @@ shell_surface_set_maximized(struct wl_client *client,
shsurf->next_state.maximized = true;
shsurf->state_changed = true;
shsurf->type = SHELL_SURFACE_TOPLEVEL;
set_type(shsurf, SHELL_SURFACE_TOPLEVEL);
shell_surface_set_parent(shsurf, NULL);
if (output_resource)
@@ -2974,7 +2983,7 @@ set_xwayland(struct shell_surface *shsurf, int x, int y, uint32_t flags)
shell_surface_set_parent(shsurf, NULL);
shsurf->type = SHELL_SURFACE_XWAYLAND;
set_type(shsurf, SHELL_SURFACE_XWAYLAND);
shsurf->state_changed = true;
}
@@ -3576,7 +3585,7 @@ create_common_surface(struct shell_client *owner, void *shell,
wl_list_init(&shsurf->children_list);
shsurf->parent = NULL;
shsurf->type = SHELL_SURFACE_NONE;
set_type(shsurf, SHELL_SURFACE_NONE);
shsurf->client = client;
@@ -3703,6 +3712,7 @@ xdg_surface_set_app_id(struct wl_client *client,
free(shsurf->class);
shsurf->class = strdup(app_id);
shsurf->surface->timeline.force_refresh = 1;
}
static void
@@ -3932,7 +3942,7 @@ create_xdg_surface(struct shell_client *owner, void *shell,
if (!shsurf)
return NULL;
shsurf->type = SHELL_SURFACE_TOPLEVEL;
set_type(shsurf, SHELL_SURFACE_TOPLEVEL);
return shsurf;
}
@@ -4014,7 +4024,7 @@ create_xdg_popup(struct shell_client *owner, void *shell,
if (!shsurf)
return NULL;
shsurf->type = SHELL_SURFACE_POPUP;
set_type(shsurf, SHELL_SURFACE_POPUP);
shsurf->popup.shseat = seat;
shsurf->popup.serial = serial;
shsurf->popup.x = x;