mirrors/pipewire
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/pipewire/pipewire.git synced 2026-04-29 06:46:38 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

spa: varlink: Set a default read timeout for sync calls

Browse source 
Makes sure we don't end up blocking forever, and timeouts are treated as
errors.
This commit is contained in:
Arun Raghavan 2026-04-24 11:54:48 -07:00
parent 7fb515d3ee
commit 4f798754e5
4 changed files with 17 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

8
spa/include/spa/support/varlink.h
View file

@ -79,10 +79,12 @@ struct spa_varlink_client {
* object). * object).
* \param reply The reply string. The caller is responsible for freeing * \param reply The reply string. The caller is responsible for freeing
* this data with `free()` * this data with `free()`
* \param timeout If non-negative, specifies how long (in milliseconds)
* to wait for a reply
* \return 0 on success, or a negative error code on failure. * \return 0 on success, or a negative error code on failure.
*/ */
int (*call_sync) (void *object, const char *method, const char *params, int (*call_sync) (void *object, const char *method, const char *params,
char **reply); char **reply, int timeout);
/** Destroy a varlink client. /** Destroy a varlink client.
* *
@ -117,10 +119,10 @@ spa_varlink_client_call(struct spa_varlink_client *client, const char *method,
* \sa spa_varlink_client_methods.call_sync */ * \sa spa_varlink_client_methods.call_sync */
SPA_API_VARLINK int SPA_API_VARLINK int
spa_varlink_client_call_sync(struct spa_varlink_client *client, const char *method, spa_varlink_client_call_sync(struct spa_varlink_client *client, const char *method,
const char *params, char **reply) const char *params, char **reply, int timeout)
{ {
return spa_api_func_r(int, -EINVAL, client, call_sync, 0, method, return spa_api_func_r(int, -EINVAL, client, call_sync, 0, method,
params, reply); params, reply, timeout);
} }
/** \copydoc spa_varlink_client_methods.destroy /** \copydoc spa_varlink_client_methods.destroy

9
spa/plugins/alsa/acp/ext-volume.c
View file

@ -22,6 +22,8 @@
#define METHOD_WRITE_MUTE_VALUE VOLUME_CONTROL_BASE "WriteMuteValue" #define METHOD_WRITE_MUTE_VALUE VOLUME_CONTROL_BASE "WriteMuteValue"
#define METHOD_WRITE_MUTE_TOGGLE VOLUME_CONTROL_BASE "WriteMuteToggle" #define METHOD_WRITE_MUTE_TOGGLE VOLUME_CONTROL_BASE "WriteMuteToggle"
#define DEFAULT_TIMEOUT_MSEC 500
static void client_disconnect(void *userdata) static void client_disconnect(void *userdata)
{ {
/* TODO: reconnect? bail? */ /* TODO: reconnect? bail? */
@ -78,7 +80,8 @@ spa_acp_ext_volume_init(struct spa_acp_ext_volume *ext_volume, struct spa_varlin
spa_json_builder_close(&params_json); spa_json_builder_close(&params_json);
res = spa_varlink_client_call_sync(ext_volume->client, METHOD_GET_CAPABILITIES, params, &reply); /* Initial probe for capabilities might take a bit longer than the default timeout */
res = spa_varlink_client_call_sync(ext_volume->client, METHOD_GET_CAPABILITIES, params, &reply, 2000);
if (res < 0) { if (res < 0) {
pa_log_error("Failed to query volume control capabilities: %s", spa_strerror(res)); pa_log_error("Failed to query volume control capabilities: %s", spa_strerror(res));
@ -164,7 +167,7 @@ spa_acp_ext_volume_read_volume(struct spa_acp_ext_volume *ext_volume,
spa_json_builder_close(&params_json); spa_json_builder_close(&params_json);
res = spa_varlink_client_call_sync(ext_volume->client, METHOD_READ_VOLUME, params, &reply); res = spa_varlink_client_call_sync(ext_volume->client, METHOD_READ_VOLUME, params, &reply, DEFAULT_TIMEOUT_MSEC);
if (res < 0) { if (res < 0) {
pa_log_error("Failed to query volume : %s", spa_strerror(res)); pa_log_error("Failed to query volume : %s", spa_strerror(res));
@ -311,7 +314,7 @@ spa_acp_ext_volume_read_mute(struct spa_acp_ext_volume *ext_volume,
spa_json_builder_close(&params_json); spa_json_builder_close(&params_json);
res = spa_varlink_client_call_sync(ext_volume->client, METHOD_READ_MUTE, params, &reply); res = spa_varlink_client_call_sync(ext_volume->client, METHOD_READ_MUTE, params, &reply, DEFAULT_TIMEOUT_MSEC);
if (res < 0) { if (res < 0) {
pa_log_error("Failed to query mute state: %s", spa_strerror(res)); pa_log_error("Failed to query mute state: %s", spa_strerror(res));

9
spa/plugins/support/varlink.c
View file

@ -153,7 +153,7 @@ done:
static int static int
client_call_sync(void *object, const char *method, const char *params, client_call_sync(void *object, const char *method, const char *params,
char **reply) char **reply, int timeout)
{ {
struct client *this = SPA_CONTAINER_OF(object, struct client, client); struct client *this = SPA_CONTAINER_OF(object, struct client, client);
struct impl *impl = this->impl; struct impl *impl = this->impl;
@ -174,6 +174,10 @@ client_call_sync(void *object, const char *method, const char *params,
this->source->mask & ~SPA_IO_IN); this->source->mask & ~SPA_IO_IN);
fcntl(this->fd, F_SETFL, fcntl(this->fd, F_GETFL) & ~O_NONBLOCK); fcntl(this->fd, F_SETFL, fcntl(this->fd, F_GETFL) & ~O_NONBLOCK);
if (timeout >= 0) {
struct timeval tv = { .tv_sec = 0, .tv_usec = timeout * 1000 };
setsockopt(this->fd, SOL_SOCKET, SO_RCVTIMEO, &tv, sizeof(tv));
}
buf = build_call(method, params, false, false, &len); buf = build_call(method, params, false, false, &len);
@ -201,9 +205,6 @@ client_call_sync(void *object, const char *method, const char *params,
if (res == -EINTR) if (res == -EINTR)
continue; continue;
if (res == -EAGAIN || res == -EWOULDBLOCK)
continue;
spa_log_error(impl->log, "Error reading from socket: %s", spa_log_error(impl->log, "Error reading from socket: %s",
spa_strerror(res)); spa_strerror(res));

2
spa/tests/varlink-call.c
View file

@ -236,7 +236,7 @@ int main(int argc, char *argv[])
if (sync) { if (sync) {
char *reply; char *reply;
res = spa_varlink_client_call_sync(data.client, argv[2], argv[3], &reply); res = spa_varlink_client_call_sync(data.client, argv[2], argv[3], &reply, 1000);
if (res < 0) { if (res < 0) {
printf("Call failed: %s\n", spa_strerror(res)); printf("Call failed: %s\n", spa_strerror(res));
return -1; return -1;