Skip to content

Commit

Permalink
GUACAMOLE-377: Migrate from timer to thread for pending users.
Browse files Browse the repository at this point in the history
  • Loading branch information
@mike-jumper
mike-jumper committed Sep 1, 2024
1 parent c7b401a commit 6573243
Show file tree
Hide file tree
Showing 2 changed files with 51 additions and 131 deletions.
165 changes: 44 additions & 121 deletions src/libguac/client.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -48,10 +48,10 @@
#include <string.h>

/**
* The number of nanoseconds between times that the pending users list will be
* The number of milliseconds between times that the pending users list will be
* synchronized and emptied (250 milliseconds aka 1/4 second).
*/
#define GUAC_CLIENT_PENDING_USERS_REFRESH_INTERVAL 250000000
#define GUAC_CLIENT_PENDING_USERS_REFRESH_INTERVAL 250

/**
* A value that indicates that the pending users timer has yet to be
Expand Down Expand Up @@ -160,28 +160,10 @@ void guac_client_free_stream(guac_client* client, guac_stream* stream) {
* Promote all pending users to full users, calling the join pending handler
* before, if any.
*
* @param data
* @param client
* The client for which all pending users should be promoted.
*/
static void guac_client_promote_pending_users(union sigval data) {

guac_client* client = (guac_client*) data.sival_ptr;

pthread_mutex_lock(&(client->__pending_users_timer_mutex));

/* Check if the previous instance of this handler is still running */
int already_running = (
client->__pending_users_timer_state
== GUAC_CLIENT_PENDING_TIMER_TRIGGERED);

/* Mark the handler as running if it isn't already */
client->__pending_users_timer_state = GUAC_CLIENT_PENDING_TIMER_TRIGGERED;

pthread_mutex_unlock(&(client->__pending_users_timer_mutex));

/* Do not start the handler if the previous instance is still running */
if (already_running)
return;
static void guac_client_promote_pending_users(guac_client* client) {

/* Acquire the lock for reading and modifying the list of pending users */
guac_rwlock_acquire_write_lock(&(client->__pending_users_lock));
Expand Down Expand Up @@ -244,10 +226,29 @@ static void guac_client_promote_pending_users(union sigval data) {
* to ensure that all users are always on exactly one of these lists) */
guac_rwlock_release_lock(&(client->__pending_users_lock));

/* Mark the handler as complete so the next instance can run */
pthread_mutex_lock(&(client->__pending_users_timer_mutex));
client->__pending_users_timer_state = GUAC_CLIENT_PENDING_TIMER_REGISTERED;
pthread_mutex_unlock(&(client->__pending_users_timer_mutex));
}

/**
* Thread that periodically checks for users that have requested to join the
* current connection (pending users). The check is performed every
* GUAC_CLIENT_PENDING_USERS_REFRESH_INTERVAL milliseconds.
*
* @param data
* A pointer to the guac_client associated with the connection.
*
* @return
* Always NULL.
*/
static void* guac_client_pending_users_thread(void* data) {

guac_client* client = (guac_client*) data;

while (client->state == GUAC_CLIENT_RUNNING) {
guac_client_promote_pending_users(client);
guac_timestamp_msleep(GUAC_CLIENT_PENDING_USERS_REFRESH_INTERVAL);
}

return NULL;

}

Expand Down Expand Up @@ -295,12 +296,6 @@ guac_client* guac_client_alloc() {
guac_rwlock_init(&(client->__users_lock));
guac_rwlock_init(&(client->__pending_users_lock));

/* The timer will be lazily created in the child process */
client->__pending_users_timer_state = GUAC_CLIENT_PENDING_TIMER_UNREGISTERED;

/* Set up the pending user promotion mutex */
pthread_mutex_init(&(client->__pending_users_timer_mutex), NULL);

/* Set up broadcast sockets */
client->socket = guac_socket_broadcast(client);
client->pending_socket = guac_socket_broadcast_pending(client);
Expand All @@ -311,6 +306,9 @@ guac_client* guac_client_alloc() {

void guac_client_free(guac_client* client) {

/* Ensure that anything waiting for the client can begin shutting down */
guac_client_stop(client);

/* Acquire write locks before referencing user pointers */
guac_rwlock_acquire_write_lock(&(client->__pending_users_lock));
guac_rwlock_acquire_write_lock(&(client->__users_lock));
Expand All @@ -323,6 +321,11 @@ void guac_client_free(guac_client* client) {
while (client->__users != NULL)
guac_client_remove_user(client, client->__users);

/* Stop the thread monitoring for new pending users, if it's been started */
if (client->__pending_users_thread_started) {
pthread_join(&client->__pending_users_thread, NULL);
}

/* Release the locks */
guac_rwlock_release_lock(&(client->__users_lock));
guac_rwlock_release_lock(&(client->__pending_users_lock));
Expand Down Expand Up @@ -354,19 +357,6 @@ void guac_client_free(guac_client* client) {
guac_client_log(client, GUAC_LOG_ERROR, "Unable to close plugin: %s", dlerror());
}

/* Find out if the pending user promotion timer was ever started */
pthread_mutex_lock(&(client->__pending_users_timer_mutex));
int was_started = (
client->__pending_users_timer_state
!= GUAC_CLIENT_PENDING_TIMER_UNREGISTERED);
pthread_mutex_unlock(&(client->__pending_users_timer_mutex));

/* If the timer was registered, stop it before destroying the lock */
if (was_started)
timer_delete(client->__pending_users_timer);

pthread_mutex_destroy(&(client->__pending_users_timer_mutex));

/* Destroy the reentrant read-write locks */
guac_rwlock_destroy(&(client->__users_lock));
guac_rwlock_destroy(&(client->__pending_users_lock));
Expand Down Expand Up @@ -444,12 +434,19 @@ void guac_client_abort(guac_client* client, guac_protocol_status status,
* @param user
* The user to add to the pending list.
*/
static void guac_client_add_pending_user(
guac_client* client, guac_user* user) {
static void guac_client_add_pending_user(guac_client* client,
guac_user* user) {

/* Acquire the lock for modifying the list of pending users */
guac_rwlock_acquire_write_lock(&(client->__pending_users_lock));

/* Set up the pending user promotion mutex */
if (!client->__pending_users_thread_started) {
pthread_create(&client->__pending_users_thread, NULL,
guac_client_pending_users_thread, (void*) client);
client->__pending_users_thread_started = 1;
}

user->__prev = NULL;
user->__next = client->__pending_users;

Expand All @@ -466,82 +463,8 @@ static void guac_client_add_pending_user(

}

/**
* Periodically promote pending users to full users. Returns zero if the timer
* is already running, or successfully created, or a non-zero value if the
* timer could not be created and started.
*
* @param client
* The guac client for which the new timer should be started, if not
* already running.
*
* @return
* Zero if the timer was successfully created and started, or a negative
* value otherwise.
*/
static int guac_client_start_pending_users_timer(guac_client* client) {

pthread_mutex_lock(&(client->__pending_users_timer_mutex));

/* Return success if the timer is already created and running */
if (client->__pending_users_timer_state
!= GUAC_CLIENT_PENDING_TIMER_UNREGISTERED) {
pthread_mutex_unlock(&(client->__pending_users_timer_mutex));
return 0;
}

/* Configure the timer to synchronize and clear the pending users */
struct sigevent signal_config = {
.sigev_notify = SIGEV_THREAD,
.sigev_notify_function = guac_client_promote_pending_users,
.sigev_value = { .sival_ptr = client }};

/* Create a timer to synchronize any pending users periodically */
if (timer_create(
CLOCK_MONOTONIC,
&signal_config,
&(client->__pending_users_timer))) {
pthread_mutex_unlock(&(client->__pending_users_timer_mutex));
return 1;
}

/* Configure the pending users timer to run on the defined interval */
struct itimerspec time_config = {
.it_interval = { .tv_nsec = GUAC_CLIENT_PENDING_USERS_REFRESH_INTERVAL },
.it_value = { .tv_nsec = GUAC_CLIENT_PENDING_USERS_REFRESH_INTERVAL }
};

/* Start the timer */
if (timer_settime(
client->__pending_users_timer, 0, &time_config, NULL) < 0) {
timer_delete(client->__pending_users_timer);
pthread_mutex_unlock(&(client->__pending_users_timer_mutex));
return 1;
}

/* Mark the timer as registered but not yet running */
client->__pending_users_timer_state = GUAC_CLIENT_PENDING_TIMER_REGISTERED;

pthread_mutex_unlock(&(client->__pending_users_timer_mutex));
return 0;

}

int guac_client_add_user(guac_client* client, guac_user* user, int argc, char** argv) {

/* Create and start the timer if it hasn't already been initialized */
if (guac_client_start_pending_users_timer(client)) {

/**
*
* If the timer could not be created, do not add the user - they cannot
* be synchronized without the timer.
*/
guac_client_log(client, GUAC_LOG_ERROR,
"Could not start pending user timer: %s.", strerror(errno));
return 1;
}

int retval = 0;

/* Call handler, if defined */
Expand Down
17 changes: 7 additions & 10 deletions src/libguac/guacamole/client.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,8 @@ struct guac_client {

/**
* Lock which is acquired when the pending users list is being manipulated,
* or when the pending users list is being iterated.
* or iterated, or when checking/altering the
* __pending_users_thread_started flag.
*/
guac_rwlock __pending_users_lock;

Expand All @@ -192,18 +193,14 @@ struct guac_client {
* use within the client. This will be NULL until the first user joins
* the connection, as it is lazily instantiated at that time.
*/
timer_t __pending_users_timer;
pthread_t __pending_users_thread;

/**
* A flag storing the current state of the pending users timer.
* Whether the pending users thread has started for this guac_client. The
* __pending_users_lock must be acquired before checking or altering this
* value.
*/
int __pending_users_timer_state;

/**
* A mutex that must be acquired before modifying or checking the value of
* the timer state.
*/
pthread_mutex_t __pending_users_timer_mutex;
int __pending_users_thread_started;

/**
* The first user within the list of connected users who have not yet had
Expand Down

0 comments on commit 6573243

Please sign in to comment.