d10ccc1eb1
Fixes #2364. Suppose a view is 600px wide, and we tell it to resize to 601px during a resize operation. We create a transaction, save the 600px buffer and send the configure. This buffer is saved into the associated instruction, and is rendered while we wait for the view to commit a 601px buffer. Before the view commits the 601px buffer, suppose we tell it to resize to 602px. The new transaction will also save the buffer, but it's still the 600px buffer because we haven't received a new one yet. Then suppose the view commits its original 601px buffer. This completes the first transaction, so we apply the 601px width to the container. There's still the second (now only) transaction remaining, so we render the saved buffer from that. But this is still the 600px buffer, and we believe it's 601px. Whoops. The problem here is we can't stack buffers like this. So this commit removes the saved buffer from the instructions, places it in the view instead, and re-saves the latest buffer every time the view completes a transaction and still has further pending transactions. As saved buffers are now specific to views rather than instructions, the functions for saving and removing the saved buffer have been moved to view.c. The calls to save and restore the buffer have been relocated to more appropriate functions too, favouring transaction_commit and transaction_apply rather than transaction_add_container and transaction_destroy.
401 lines
13 KiB
C
401 lines
13 KiB
C
#define _POSIX_C_SOURCE 200809L
|
|
#include <errno.h>
|
|
#include <stdbool.h>
|
|
#include <stdlib.h>
|
|
#include <string.h>
|
|
#include <time.h>
|
|
#include <wlr/types/wlr_buffer.h>
|
|
#include "sway/debug.h"
|
|
#include "sway/desktop/idle_inhibit_v1.h"
|
|
#include "sway/desktop/transaction.h"
|
|
#include "sway/output.h"
|
|
#include "sway/tree/container.h"
|
|
#include "sway/tree/view.h"
|
|
#include "sway/tree/workspace.h"
|
|
#include "list.h"
|
|
#include "log.h"
|
|
|
|
/**
|
|
* How long we should wait for views to respond to the configure before giving
|
|
* up and applying the transaction anyway.
|
|
*/
|
|
int txn_timeout_ms = 200;
|
|
|
|
/**
|
|
* If enabled, sway will always wait for the transaction timeout before
|
|
* applying it, rather than applying it when the views are ready. This allows us
|
|
* to observe the rendered state while a transaction is in progress.
|
|
*/
|
|
bool txn_debug = false;
|
|
|
|
struct sway_transaction {
|
|
struct wl_event_source *timer;
|
|
list_t *instructions; // struct sway_transaction_instruction *
|
|
size_t num_waiting;
|
|
size_t num_configures;
|
|
struct timespec create_time;
|
|
struct timespec commit_time;
|
|
};
|
|
|
|
struct sway_transaction_instruction {
|
|
struct sway_transaction *transaction;
|
|
struct sway_container *container;
|
|
struct sway_container_state state;
|
|
uint32_t serial;
|
|
bool ready;
|
|
};
|
|
|
|
static struct sway_transaction *transaction_create() {
|
|
struct sway_transaction *transaction =
|
|
calloc(1, sizeof(struct sway_transaction));
|
|
transaction->instructions = create_list();
|
|
if (server.debug_txn_timings) {
|
|
clock_gettime(CLOCK_MONOTONIC, &transaction->create_time);
|
|
}
|
|
return transaction;
|
|
}
|
|
|
|
static void transaction_destroy(struct sway_transaction *transaction) {
|
|
// Free instructions
|
|
for (int i = 0; i < transaction->instructions->length; ++i) {
|
|
struct sway_transaction_instruction *instruction =
|
|
transaction->instructions->items[i];
|
|
struct sway_container *con = instruction->container;
|
|
for (int j = 0; j < con->instructions->length; ++j) {
|
|
if (con->instructions->items[j] == instruction) {
|
|
list_del(con->instructions, j);
|
|
break;
|
|
}
|
|
}
|
|
if (con->destroying && !con->instructions->length) {
|
|
container_free(con);
|
|
}
|
|
free(instruction);
|
|
}
|
|
list_free(transaction->instructions);
|
|
|
|
if (transaction->timer) {
|
|
wl_event_source_remove(transaction->timer);
|
|
}
|
|
free(transaction);
|
|
}
|
|
|
|
static void copy_pending_state(struct sway_container *container,
|
|
struct sway_container_state *state) {
|
|
state->layout = container->layout;
|
|
state->swayc_x = container->x;
|
|
state->swayc_y = container->y;
|
|
state->swayc_width = container->width;
|
|
state->swayc_height = container->height;
|
|
state->is_fullscreen = container->is_fullscreen;
|
|
state->has_gaps = container->has_gaps;
|
|
state->current_gaps = container->current_gaps;
|
|
state->gaps_inner = container->gaps_inner;
|
|
state->gaps_outer = container->gaps_outer;
|
|
state->parent = container->parent;
|
|
|
|
if (container->type == C_VIEW) {
|
|
struct sway_view *view = container->sway_view;
|
|
state->view_x = view->x;
|
|
state->view_y = view->y;
|
|
state->view_width = view->width;
|
|
state->view_height = view->height;
|
|
state->border = view->border;
|
|
state->border_thickness = view->border_thickness;
|
|
state->border_top = view->border_top;
|
|
state->border_left = view->border_left;
|
|
state->border_right = view->border_right;
|
|
state->border_bottom = view->border_bottom;
|
|
} else if (container->type == C_WORKSPACE) {
|
|
state->ws_fullscreen = container->sway_workspace->fullscreen;
|
|
state->ws_floating = container->sway_workspace->floating;
|
|
state->children = create_list();
|
|
list_cat(state->children, container->children);
|
|
} else {
|
|
state->children = create_list();
|
|
list_cat(state->children, container->children);
|
|
}
|
|
|
|
struct sway_seat *seat = input_manager_current_seat(input_manager);
|
|
state->focused = seat_get_focus(seat) == container;
|
|
|
|
if (container->type != C_VIEW) {
|
|
state->focused_inactive_child =
|
|
seat_get_active_child(seat, container);
|
|
}
|
|
}
|
|
|
|
static void transaction_add_container(struct sway_transaction *transaction,
|
|
struct sway_container *container) {
|
|
struct sway_transaction_instruction *instruction =
|
|
calloc(1, sizeof(struct sway_transaction_instruction));
|
|
instruction->transaction = transaction;
|
|
instruction->container = container;
|
|
|
|
copy_pending_state(container, &instruction->state);
|
|
|
|
list_add(transaction->instructions, instruction);
|
|
}
|
|
|
|
/**
|
|
* Apply a transaction to the "current" state of the tree.
|
|
*/
|
|
static void transaction_apply(struct sway_transaction *transaction) {
|
|
wlr_log(WLR_DEBUG, "Applying transaction %p", transaction);
|
|
if (server.debug_txn_timings) {
|
|
struct timespec now;
|
|
clock_gettime(CLOCK_MONOTONIC, &now);
|
|
struct timespec *create = &transaction->create_time;
|
|
struct timespec *commit = &transaction->commit_time;
|
|
float ms_arranging = (commit->tv_sec - create->tv_sec) * 1000 +
|
|
(commit->tv_nsec - create->tv_nsec) / 1000000.0;
|
|
float ms_waiting = (now.tv_sec - commit->tv_sec) * 1000 +
|
|
(now.tv_nsec - commit->tv_nsec) / 1000000.0;
|
|
float ms_total = ms_arranging + ms_waiting;
|
|
wlr_log(WLR_DEBUG, "Transaction %p: %.1fms arranging, %.1fms waiting, "
|
|
"%.1fms total (%.1f frames if 60Hz)", transaction,
|
|
ms_arranging, ms_waiting, ms_total, ms_total / (1000.0f / 60));
|
|
}
|
|
|
|
// Apply the instruction state to the container's current state
|
|
for (int i = 0; i < transaction->instructions->length; ++i) {
|
|
struct sway_transaction_instruction *instruction =
|
|
transaction->instructions->items[i];
|
|
struct sway_container *container = instruction->container;
|
|
|
|
// Damage the old and new locations
|
|
struct wlr_box old_box = {
|
|
.x = container->current.swayc_x,
|
|
.y = container->current.swayc_y,
|
|
.width = container->current.swayc_width,
|
|
.height = container->current.swayc_height,
|
|
};
|
|
struct wlr_box new_box = {
|
|
.x = instruction->state.swayc_x,
|
|
.y = instruction->state.swayc_y,
|
|
.width = instruction->state.swayc_width,
|
|
.height = instruction->state.swayc_height,
|
|
};
|
|
for (int j = 0; j < root_container.current.children->length; ++j) {
|
|
struct sway_container *output = root_container.current.children->items[j];
|
|
if (output->sway_output) {
|
|
output_damage_box(output->sway_output, &old_box);
|
|
output_damage_box(output->sway_output, &new_box);
|
|
}
|
|
}
|
|
|
|
// There are separate children lists for each instruction state, the
|
|
// container's current state and the container's pending state
|
|
// (ie. con->children). The list itself needs to be freed here.
|
|
// Any child containers which are being deleted will be cleaned up in
|
|
// transaction_destroy().
|
|
list_free(container->current.children);
|
|
|
|
memcpy(&container->current, &instruction->state,
|
|
sizeof(struct sway_container_state));
|
|
|
|
if (container->type == C_VIEW) {
|
|
if (container->sway_view->saved_buffer) {
|
|
view_remove_saved_buffer(container->sway_view);
|
|
}
|
|
if (container->instructions->length > 1) {
|
|
view_save_buffer(container->sway_view);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
static void transaction_progress_queue() {
|
|
while (server.transactions->length) {
|
|
struct sway_transaction *transaction = server.transactions->items[0];
|
|
if (transaction->num_waiting) {
|
|
return;
|
|
}
|
|
transaction_apply(transaction);
|
|
transaction_destroy(transaction);
|
|
list_del(server.transactions, 0);
|
|
}
|
|
idle_inhibit_v1_check_active(server.idle_inhibit_manager_v1);
|
|
}
|
|
|
|
static int handle_timeout(void *data) {
|
|
struct sway_transaction *transaction = data;
|
|
wlr_log(WLR_DEBUG, "Transaction %p timed out (%li waiting)",
|
|
transaction, transaction->num_waiting);
|
|
transaction->num_waiting = 0;
|
|
transaction_progress_queue();
|
|
return 0;
|
|
}
|
|
|
|
static bool should_configure(struct sway_container *con,
|
|
struct sway_transaction_instruction *instruction) {
|
|
if (con->type != C_VIEW) {
|
|
return false;
|
|
}
|
|
if (con->destroying) {
|
|
return false;
|
|
}
|
|
// The settled dimensions are what size the view will be once any pending
|
|
// configures have applied (excluding the one we might be configuring now).
|
|
// If these match the dimensions that this transaction wants then we don't
|
|
// need to configure it.
|
|
int settled_width = con->current.view_width;
|
|
int settled_height = con->current.view_height;
|
|
if (con->instructions->length) {
|
|
struct sway_transaction_instruction *last_instruction =
|
|
con->instructions->items[con->instructions->length - 1];
|
|
settled_width = last_instruction->state.view_width;
|
|
settled_height = last_instruction->state.view_height;
|
|
}
|
|
if (settled_width == instruction->state.view_width &&
|
|
settled_height == instruction->state.view_height) {
|
|
return false;
|
|
}
|
|
return true;
|
|
}
|
|
|
|
static void transaction_commit(struct sway_transaction *transaction) {
|
|
wlr_log(WLR_DEBUG, "Transaction %p committing with %i instructions",
|
|
transaction, transaction->instructions->length);
|
|
transaction->num_waiting = 0;
|
|
for (int i = 0; i < transaction->instructions->length; ++i) {
|
|
struct sway_transaction_instruction *instruction =
|
|
transaction->instructions->items[i];
|
|
struct sway_container *con = instruction->container;
|
|
if (should_configure(con, instruction)) {
|
|
instruction->serial = view_configure(con->sway_view,
|
|
instruction->state.view_x,
|
|
instruction->state.view_y,
|
|
instruction->state.view_width,
|
|
instruction->state.view_height);
|
|
++transaction->num_waiting;
|
|
|
|
// From here on we are rendering a saved buffer of the view, which
|
|
// means we can send a frame done event to make the client redraw it
|
|
// as soon as possible. Additionally, this is required if a view is
|
|
// mapping and its default geometry doesn't intersect an output.
|
|
struct timespec when;
|
|
wlr_surface_send_frame_done(con->sway_view->surface, &when);
|
|
if (!con->sway_view->saved_buffer) {
|
|
view_save_buffer(con->sway_view);
|
|
}
|
|
}
|
|
list_add(con->instructions, instruction);
|
|
}
|
|
transaction->num_configures = transaction->num_waiting;
|
|
if (server.debug_txn_timings) {
|
|
clock_gettime(CLOCK_MONOTONIC, &transaction->commit_time);
|
|
}
|
|
if (server.transactions->length || transaction->num_waiting) {
|
|
list_add(server.transactions, transaction);
|
|
} else {
|
|
// There are no other transactions in progress, and this one has nothing
|
|
// to wait for, so we can skip the queue.
|
|
wlr_log(WLR_DEBUG, "Transaction %p has nothing to wait for", transaction);
|
|
transaction_apply(transaction);
|
|
transaction_destroy(transaction);
|
|
idle_inhibit_v1_check_active(server.idle_inhibit_manager_v1);
|
|
return;
|
|
}
|
|
|
|
if (transaction->num_waiting) {
|
|
// Set up a timer which the views must respond within
|
|
transaction->timer = wl_event_loop_add_timer(server.wl_event_loop,
|
|
handle_timeout, transaction);
|
|
if (transaction->timer) {
|
|
wl_event_source_timer_update(transaction->timer, txn_timeout_ms);
|
|
} else {
|
|
wlr_log(WLR_ERROR, "Unable to create transaction timer (%s). "
|
|
"Some imperfect frames might be rendered.",
|
|
strerror(errno));
|
|
handle_timeout(transaction);
|
|
}
|
|
}
|
|
|
|
// The debug tree shows the pending/live tree. Here is a good place to
|
|
// update it, because we make a transaction every time we change the pending
|
|
// tree.
|
|
update_debug_tree();
|
|
}
|
|
|
|
static void set_instruction_ready(
|
|
struct sway_transaction_instruction *instruction) {
|
|
instruction->ready = true;
|
|
struct sway_transaction *transaction = instruction->transaction;
|
|
|
|
if (server.debug_txn_timings) {
|
|
struct timespec now;
|
|
clock_gettime(CLOCK_MONOTONIC, &now);
|
|
struct timespec *start = &transaction->commit_time;
|
|
float ms = (now.tv_sec - start->tv_sec) * 1000 +
|
|
(now.tv_nsec - start->tv_nsec) / 1000000.0;
|
|
wlr_log(WLR_DEBUG, "Transaction %p: %li/%li ready in %.1fms (%s)",
|
|
transaction,
|
|
transaction->num_configures - transaction->num_waiting + 1,
|
|
transaction->num_configures, ms,
|
|
instruction->container->name);
|
|
|
|
}
|
|
|
|
// If the transaction has timed out then its num_waiting will be 0 already.
|
|
if (transaction->num_waiting > 0 && --transaction->num_waiting == 0) {
|
|
if (!txn_debug) {
|
|
wlr_log(WLR_DEBUG, "Transaction %p is ready", transaction);
|
|
wl_event_source_timer_update(transaction->timer, 0);
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Mark all of the view's instructions as ready up to and including the
|
|
* instruction at the given index. This allows the view to skip a configure.
|
|
*/
|
|
static void set_instructions_ready(struct sway_view *view, int index) {
|
|
for (int i = 0; i <= index; ++i) {
|
|
struct sway_transaction_instruction *instruction =
|
|
view->swayc->instructions->items[i];
|
|
if (!instruction->ready) {
|
|
set_instruction_ready(instruction);
|
|
}
|
|
}
|
|
transaction_progress_queue();
|
|
}
|
|
|
|
void transaction_notify_view_ready(struct sway_view *view, uint32_t serial) {
|
|
for (int i = 0; i < view->swayc->instructions->length; ++i) {
|
|
struct sway_transaction_instruction *instruction =
|
|
view->swayc->instructions->items[i];
|
|
if (instruction->serial == serial && !instruction->ready) {
|
|
set_instructions_ready(view, i);
|
|
return;
|
|
}
|
|
}
|
|
}
|
|
|
|
void transaction_notify_view_ready_by_size(struct sway_view *view,
|
|
int width, int height) {
|
|
for (int i = 0; i < view->swayc->instructions->length; ++i) {
|
|
struct sway_transaction_instruction *instruction =
|
|
view->swayc->instructions->items[i];
|
|
if (!instruction->ready && instruction->state.view_width == width &&
|
|
instruction->state.view_height == height) {
|
|
set_instructions_ready(view, i);
|
|
return;
|
|
}
|
|
}
|
|
}
|
|
|
|
void transaction_commit_dirty(void) {
|
|
if (!server.dirty_containers->length) {
|
|
return;
|
|
}
|
|
struct sway_transaction *transaction = transaction_create();
|
|
for (int i = 0; i < server.dirty_containers->length; ++i) {
|
|
struct sway_container *container = server.dirty_containers->items[i];
|
|
transaction_add_container(transaction, container);
|
|
container->dirty = false;
|
|
}
|
|
server.dirty_containers->length = 0;
|
|
transaction_commit(transaction);
|
|
}
|