-/* $Id$ */
-
/***
This file is part of PulseAudio.
-
+
+ Copyright 2004-2006 Lennart Poettering
+
PulseAudio is free software; you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as
- published by the Free Software Foundation; either version 2 of the
+ published by the Free Software Foundation; either version 2.1 of the
License, or (at your option) any later version.
-
+
PulseAudio is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
-
+
You should have received a copy of the GNU Lesser General Public
License along with PulseAudio; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
#endif
#include <stdio.h>
-#include <assert.h>
#include <stdlib.h>
-#include <string.h>
#include <unistd.h>
#include <avahi-client/client.h>
#include <avahi-client/publish.h>
#include <avahi-common/alternative.h>
#include <avahi-common/error.h>
+#include <avahi-common/domain.h>
#include <pulse/xmalloc.h>
#include <pulse/util.h>
+#include <pulse/thread-mainloop.h>
-#include <pulsecore/autoload.h>
+#include <pulsecore/parseaddr.h>
#include <pulsecore/sink.h>
#include <pulsecore/source.h>
#include <pulsecore/native-common.h>
#include <pulsecore/core-util.h>
#include <pulsecore/log.h>
-#include <pulsecore/core-subscribe.h>
#include <pulsecore/dynarray.h>
#include <pulsecore/modargs.h>
#include <pulsecore/avahi-wrap.h>
-#include <pulsecore/endianmacros.h>
+#include <pulsecore/protocol-native.h>
#include "module-zeroconf-publish-symdef.h"
-PA_MODULE_AUTHOR("Lennart Poettering")
-PA_MODULE_DESCRIPTION("mDNS/DNS-SD Service Publisher")
-PA_MODULE_VERSION(PACKAGE_VERSION)
-PA_MODULE_USAGE("port=<IP port number>")
+PA_MODULE_AUTHOR("Lennart Poettering");
+PA_MODULE_DESCRIPTION("mDNS/DNS-SD Service Publisher");
+PA_MODULE_VERSION(PACKAGE_VERSION);
+PA_MODULE_LOAD_ONCE(true);
#define SERVICE_TYPE_SINK "_pulse-sink._tcp"
#define SERVICE_TYPE_SOURCE "_pulse-source._tcp"
#define SERVICE_TYPE_SERVER "_pulse-server._tcp"
+#define SERVICE_SUBTYPE_SINK_HARDWARE "_hardware._sub."SERVICE_TYPE_SINK
+#define SERVICE_SUBTYPE_SINK_VIRTUAL "_virtual._sub."SERVICE_TYPE_SINK
+#define SERVICE_SUBTYPE_SOURCE_HARDWARE "_hardware._sub."SERVICE_TYPE_SOURCE
+#define SERVICE_SUBTYPE_SOURCE_VIRTUAL "_virtual._sub."SERVICE_TYPE_SOURCE
+#define SERVICE_SUBTYPE_SOURCE_MONITOR "_monitor._sub."SERVICE_TYPE_SOURCE
+#define SERVICE_SUBTYPE_SOURCE_NON_MONITOR "_non-monitor._sub."SERVICE_TYPE_SOURCE
+
+/*
+ * Note: Because the core avahi-client calls result in synchronous D-Bus
+ * communication, calling any of those functions in the PA mainloop context
+ * could lead to the mainloop being blocked for long periods.
+ *
+ * To avoid this, we create a threaded-mainloop for Avahi calls, and push all
+ * D-Bus communication into that thread. The thumb-rule for the split is:
+ *
+ * 1. If access to PA data structures is needed, use the PA mainloop context
+ *
+ * 2. If a (blocking) avahi-client call is needed, use the Avahi mainloop
+ *
+ * We do have message queue to pass messages from the Avahi mainloop to the PA
+ * mainloop.
+ */
static const char* const valid_modargs[] = {
- "port",
NULL
};
+struct avahi_msg {
+ pa_msgobject parent;
+};
+
+typedef struct avahi_msg avahi_msg;
+PA_DEFINE_PRIVATE_CLASS(avahi_msg, pa_msgobject);
+
+enum {
+ AVAHI_MESSAGE_PUBLISH_ALL,
+ AVAHI_MESSAGE_SHUTDOWN_START,
+ AVAHI_MESSAGE_SHUTDOWN_COMPLETE,
+};
+
+enum service_subtype {
+ SUBTYPE_HARDWARE,
+ SUBTYPE_VIRTUAL,
+ SUBTYPE_MONITOR
+};
+
struct service {
+ void *key;
+
struct userdata *userdata;
AvahiEntryGroup *entry_group;
char *service_name;
+ const char *service_type;
+ enum service_subtype subtype;
+
char *name;
- enum { UNPUBLISHED, PUBLISHED_REAL, PUBLISHED_AUTOLOAD } published ;
-
- struct {
- int valid;
- pa_namereg_type_t type;
- uint32_t index;
- } loaded;
-
- struct {
- int valid;
- pa_namereg_type_t type;
- uint32_t index;
- } autoload;
+ bool is_sink;
+ pa_sample_spec ss;
+ pa_channel_map cm;
+ pa_proplist *proplist;
};
struct userdata {
+ pa_thread_mq thread_mq;
+ pa_rtpoll *rtpoll;
+ avahi_msg *msg;
+
pa_core *core;
+ pa_module *module;
+ pa_mainloop_api *api;
+ pa_threaded_mainloop *mainloop;
+
AvahiPoll *avahi_poll;
AvahiClient *client;
- pa_hashmap *services;
- pa_dynarray *sink_dynarray, *source_dynarray, *autoload_dynarray;
- pa_subscription *subscription;
+
+ pa_hashmap *services; /* protect with mainloop lock */
char *service_name;
AvahiEntryGroup *main_entry_group;
- uint16_t port;
+ pa_hook_slot *sink_new_slot, *source_new_slot, *sink_unlink_slot, *source_unlink_slot, *sink_changed_slot, *source_changed_slot;
+
+ pa_native_protocol *native;
};
-static void get_service_data(struct userdata *u, struct service *s, pa_sample_spec *ret_ss, char **ret_description) {
- assert(u && s && s->loaded.valid && ret_ss && ret_description);
-
- if (s->loaded.type == PA_NAMEREG_SINK) {
- pa_sink *sink = pa_idxset_get_by_index(u->core->sinks, s->loaded.index);
- assert(sink);
- *ret_ss = sink->sample_spec;
- *ret_description = sink->description;
- } else if (s->loaded.type == PA_NAMEREG_SOURCE) {
- pa_source *source = pa_idxset_get_by_index(u->core->sources, s->loaded.index);
- assert(source);
- *ret_ss = source->sample_spec;
- *ret_description = source->description;
+/* Runs in PA mainloop context */
+static void get_service_data(struct service *s, pa_object *device) {
+ pa_assert(s);
+
+ if (pa_sink_isinstance(device)) {
+ pa_sink *sink = PA_SINK(device);
+
+ s->is_sink = true;
+ s->service_type = SERVICE_TYPE_SINK;
+ s->ss = sink->sample_spec;
+ s->cm = sink->channel_map;
+ s->name = pa_xstrdup(sink->name);
+ s->proplist = pa_proplist_copy(sink->proplist);
+ s->subtype = sink->flags & PA_SINK_HARDWARE ? SUBTYPE_HARDWARE : SUBTYPE_VIRTUAL;
+
+ } else if (pa_source_isinstance(device)) {
+ pa_source *source = PA_SOURCE(device);
+
+ s->is_sink = false;
+ s->service_type = SERVICE_TYPE_SOURCE;
+ s->ss = source->sample_spec;
+ s->cm = source->channel_map;
+ s->name = pa_xstrdup(source->name);
+ s->proplist = pa_proplist_copy(source->proplist);
+ s->subtype = source->monitor_of ? SUBTYPE_MONITOR : (source->flags & PA_SOURCE_HARDWARE ? SUBTYPE_HARDWARE : SUBTYPE_VIRTUAL);
+
} else
- assert(0);
+ pa_assert_not_reached();
}
+/* Can be used in either PA or Avahi mainloop context since the bits of u->core
+ * that we access don't change after startup. */
static AvahiStringList* txt_record_server_data(pa_core *c, AvahiStringList *l) {
char s[128];
- assert(c);
+ char *t;
+
+ pa_assert(c);
l = avahi_string_list_add_pair(l, "server-version", PACKAGE_NAME" "PACKAGE_VERSION);
- l = avahi_string_list_add_pair(l, "user-name", pa_get_user_name(s, sizeof(s)));
+
+ t = pa_get_user_name_malloc();
+ l = avahi_string_list_add_pair(l, "user-name", t);
+ pa_xfree(t);
+
+ t = pa_machine_id();
+ l = avahi_string_list_add_pair(l, "machine-id", t);
+ pa_xfree(t);
+
+ t = pa_uname_string();
+ l = avahi_string_list_add_pair(l, "uname", t);
+ pa_xfree(t);
+
l = avahi_string_list_add_pair(l, "fqdn", pa_get_fqdn(s, sizeof(s)));
l = avahi_string_list_add_printf(l, "cookie=0x%08x", c->cookie);
return l;
}
-static int publish_service(struct userdata *u, struct service *s);
+static void publish_service(pa_mainloop_api *api, void *service);
+/* Runs in Avahi mainloop context */
static void service_entry_group_callback(AvahiEntryGroup *g, AvahiEntryGroupState state, void *userdata) {
struct service *s = userdata;
- if (state == AVAHI_ENTRY_GROUP_COLLISION) {
- char *t;
+ pa_assert(s);
- t = avahi_alternative_service_name(s->service_name);
- pa_xfree(s->service_name);
- s->service_name = t;
+ switch (state) {
+
+ case AVAHI_ENTRY_GROUP_ESTABLISHED:
+ pa_log_info("Successfully established service %s.", s->service_name);
+ break;
+
+ case AVAHI_ENTRY_GROUP_COLLISION: {
+ char *t;
+
+ t = avahi_alternative_service_name(s->service_name);
+ pa_log_info("Name collision, renaming %s to %s.", s->service_name, t);
+ pa_xfree(s->service_name);
+ s->service_name = t;
+
+ publish_service(NULL, s);
+ break;
+ }
+
+ case AVAHI_ENTRY_GROUP_FAILURE: {
+ pa_log("Failed to register service: %s", avahi_strerror(avahi_client_errno(avahi_entry_group_get_client(g))));
+
+ avahi_entry_group_free(g);
+ s->entry_group = NULL;
+
+ break;
+ }
+
+ case AVAHI_ENTRY_GROUP_UNCOMMITED:
+ case AVAHI_ENTRY_GROUP_REGISTERING:
+ ;
+ }
+}
+
+static void service_free(struct service *s);
+
+/* Can run in either context */
+static uint16_t compute_port(struct userdata *u) {
+ pa_strlist *i;
+
+ pa_assert(u);
+
+ for (i = pa_native_protocol_servers(u->native); i; i = pa_strlist_next(i)) {
+ pa_parsed_address a;
+
+ if (pa_parse_address(pa_strlist_data(i), &a) >= 0 &&
+ (a.type == PA_PARSED_ADDRESS_TCP4 ||
+ a.type == PA_PARSED_ADDRESS_TCP6 ||
+ a.type == PA_PARSED_ADDRESS_TCP_AUTO) &&
+ a.port > 0) {
- publish_service(s->userdata, s);
+ pa_xfree(a.path_or_host);
+ return a.port;
+ }
+
+ pa_xfree(a.path_or_host);
}
+
+ return PA_NATIVE_DEFAULT_PORT;
}
-static int publish_service(struct userdata *u, struct service *s) {
+/* Runs in Avahi mainloop context */
+static void publish_service(pa_mainloop_api *api PA_GCC_UNUSED, void *service) {
+ struct service *s = (struct service *) service;
int r = -1;
AvahiStringList *txt = NULL;
+ char cm[PA_CHANNEL_MAP_SNPRINT_MAX];
+ const char *t;
- assert(u);
- assert(s);
+ const char * const subtype_text[] = {
+ [SUBTYPE_HARDWARE] = "hardware",
+ [SUBTYPE_VIRTUAL] = "virtual",
+ [SUBTYPE_MONITOR] = "monitor"
+ };
- if (!u->client || avahi_client_get_state(u->client) != AVAHI_CLIENT_S_RUNNING)
- return 0;
-
- if ((s->published == PUBLISHED_REAL && s->loaded.valid) ||
- (s->published == PUBLISHED_AUTOLOAD && s->autoload.valid && !s->loaded.valid))
- return 0;
+ pa_assert(s);
- if (s->published != UNPUBLISHED) {
- avahi_entry_group_reset(s->entry_group);
- s->published = UNPUBLISHED;
- }
-
- if (s->loaded.valid || s->autoload.valid) {
- pa_namereg_type_t type;
-
- if (!s->entry_group) {
- if (!(s->entry_group = avahi_entry_group_new(u->client, service_entry_group_callback, s))) {
- pa_log("avahi_entry_group_new(): %s", avahi_strerror(avahi_client_errno(u->client)));
- goto finish;
- }
+ if (!s->userdata->client || avahi_client_get_state(s->userdata->client) != AVAHI_CLIENT_S_RUNNING)
+ return;
+
+ if (!s->entry_group) {
+ if (!(s->entry_group = avahi_entry_group_new(s->userdata->client, service_entry_group_callback, s))) {
+ pa_log("avahi_entry_group_new(): %s", avahi_strerror(avahi_client_errno(s->userdata->client)));
+ goto finish;
}
-
- txt = avahi_string_list_add_pair(txt, "device", s->name);
- txt = txt_record_server_data(u->core, txt);
-
- if (s->loaded.valid) {
- char *description;
- pa_sample_spec ss;
-
- get_service_data(u, s, &ss, &description);
-
- txt = avahi_string_list_add_printf(txt, "rate=%u", ss.rate);
- txt = avahi_string_list_add_printf(txt, "channels=%u", ss.channels);
- txt = avahi_string_list_add_pair(txt, "format", pa_sample_format_to_string(ss.format));
- if (description)
- txt = avahi_string_list_add_pair(txt, "description", description);
-
- type = s->loaded.type;
- } else if (s->autoload.valid)
- type = s->autoload.type;
-
- if (avahi_entry_group_add_service_strlst(
+ } else
+ avahi_entry_group_reset(s->entry_group);
+
+ txt = txt_record_server_data(s->userdata->core, txt);
+
+ txt = avahi_string_list_add_pair(txt, "device", s->name);
+ txt = avahi_string_list_add_printf(txt, "rate=%u", s->ss.rate);
+ txt = avahi_string_list_add_printf(txt, "channels=%u", s->ss.channels);
+ txt = avahi_string_list_add_pair(txt, "format", pa_sample_format_to_string(s->ss.format));
+ txt = avahi_string_list_add_pair(txt, "channel_map", pa_channel_map_snprint(cm, sizeof(cm), &s->cm));
+ txt = avahi_string_list_add_pair(txt, "subtype", subtype_text[s->subtype]);
+
+ if ((t = pa_proplist_gets(s->proplist, PA_PROP_DEVICE_DESCRIPTION)))
+ txt = avahi_string_list_add_pair(txt, "description", t);
+ if ((t = pa_proplist_gets(s->proplist, PA_PROP_DEVICE_ICON_NAME)))
+ txt = avahi_string_list_add_pair(txt, "icon-name", t);
+ if ((t = pa_proplist_gets(s->proplist, PA_PROP_DEVICE_VENDOR_NAME)))
+ txt = avahi_string_list_add_pair(txt, "vendor-name", t);
+ if ((t = pa_proplist_gets(s->proplist, PA_PROP_DEVICE_PRODUCT_NAME)))
+ txt = avahi_string_list_add_pair(txt, "product-name", t);
+ if ((t = pa_proplist_gets(s->proplist, PA_PROP_DEVICE_CLASS)))
+ txt = avahi_string_list_add_pair(txt, "class", t);
+ if ((t = pa_proplist_gets(s->proplist, PA_PROP_DEVICE_FORM_FACTOR)))
+ txt = avahi_string_list_add_pair(txt, "form-factor", t);
+
+ if (avahi_entry_group_add_service_strlst(
+ s->entry_group,
+ AVAHI_IF_UNSPEC, AVAHI_PROTO_UNSPEC,
+ 0,
+ s->service_name,
+ s->service_type,
+ NULL,
+ NULL,
+ compute_port(s->userdata),
+ txt) < 0) {
+
+ pa_log("avahi_entry_group_add_service_strlst(): %s", avahi_strerror(avahi_client_errno(s->userdata->client)));
+ goto finish;
+ }
+
+ if (avahi_entry_group_add_service_subtype(
+ s->entry_group,
+ AVAHI_IF_UNSPEC, AVAHI_PROTO_UNSPEC,
+ 0,
+ s->service_name,
+ s->service_type,
+ NULL,
+ s->is_sink ? (s->subtype == SUBTYPE_HARDWARE ? SERVICE_SUBTYPE_SINK_HARDWARE : SERVICE_SUBTYPE_SINK_VIRTUAL) :
+ (s->subtype == SUBTYPE_HARDWARE ? SERVICE_SUBTYPE_SOURCE_HARDWARE : (s->subtype == SUBTYPE_VIRTUAL ? SERVICE_SUBTYPE_SOURCE_VIRTUAL : SERVICE_SUBTYPE_SOURCE_MONITOR))) < 0) {
+
+ pa_log("avahi_entry_group_add_service_subtype(): %s", avahi_strerror(avahi_client_errno(s->userdata->client)));
+ goto finish;
+ }
+
+ if (!s->is_sink && s->subtype != SUBTYPE_MONITOR) {
+ if (avahi_entry_group_add_service_subtype(
s->entry_group,
AVAHI_IF_UNSPEC, AVAHI_PROTO_UNSPEC,
0,
s->service_name,
- type == PA_NAMEREG_SINK ? SERVICE_TYPE_SINK : SERVICE_TYPE_SOURCE,
- NULL,
+ SERVICE_TYPE_SOURCE,
NULL,
- u->port,
- txt) < 0) {
-
- pa_log(__FILE__": avahi_entry_group_add_service_strlst(): %s", avahi_strerror(avahi_client_errno(u->client)));
- goto finish;
- }
-
- if (avahi_entry_group_commit(s->entry_group) < 0) {
- pa_log(__FILE__": avahi_entry_group_commit(): %s", avahi_strerror(avahi_client_errno(u->client)));
+ SERVICE_SUBTYPE_SOURCE_NON_MONITOR) < 0) {
+
+ pa_log("avahi_entry_group_add_service_subtype(): %s", avahi_strerror(avahi_client_errno(s->userdata->client)));
goto finish;
}
-
- if (s->loaded.valid)
- s->published = PUBLISHED_REAL;
- else if (s->autoload.valid)
- s->published = PUBLISHED_AUTOLOAD;
}
-
+
+ if (avahi_entry_group_commit(s->entry_group) < 0) {
+ pa_log("avahi_entry_group_commit(): %s", avahi_strerror(avahi_client_errno(s->userdata->client)));
+ goto finish;
+ }
+
r = 0;
-
-finish:
+ pa_log_debug("Successfully created entry group for %s.", s->service_name);
- if (s->published == UNPUBLISHED) {
- /* Remove this service */
+finish:
- if (s->entry_group) {
- avahi_entry_group_free(s->entry_group);
- }
-
- pa_hashmap_remove(u->services, s->name);
- pa_xfree(s->name);
- pa_xfree(s->service_name);
- pa_xfree(s);
+ /* Remove this service */
+ if (r < 0) {
+ pa_hashmap_remove(s->userdata->services, s->key);
+ service_free(s);
}
- if (txt)
- avahi_string_list_free(txt);
-
- return r;
+ avahi_string_list_free(txt);
}
-static struct service *get_service(struct userdata *u, const char *name) {
+/* Runs in PA mainloop context */
+static struct service *get_service(struct userdata *u, pa_object *device) {
struct service *s;
- char hn[64];
-
- if ((s = pa_hashmap_get(u->services, name)))
- return s;
-
+ char *hn, *un;
+ const char *n;
+
+ pa_assert(u);
+ pa_object_assert_ref(device);
+
+ pa_threaded_mainloop_lock(u->mainloop);
+
+ if ((s = pa_hashmap_get(u->services, device)))
+ goto out;
+
s = pa_xnew(struct service, 1);
+ s->key = device;
s->userdata = u;
s->entry_group = NULL;
- s->published = UNPUBLISHED;
- s->name = pa_xstrdup(name);
- s->loaded.valid = s->autoload.valid = 0;
- s->service_name = pa_sprintf_malloc("%s on %s", s->name, pa_get_host_name(hn, sizeof(hn)));
- pa_hashmap_put(u->services, s->name, s);
+ get_service_data(s, device);
- return s;
-}
+ if (!(n = pa_proplist_gets(s->proplist, PA_PROP_DEVICE_DESCRIPTION)))
+ n = s->name;
-static int publish_sink(struct userdata *u, pa_sink *s) {
- struct service *svc;
- assert(u && s);
+ hn = pa_get_host_name_malloc();
+ un = pa_get_user_name_malloc();
- svc = get_service(u, s->name);
- if (svc->loaded.valid)
- return publish_service(u, svc);
+ s->service_name = pa_truncate_utf8(pa_sprintf_malloc("%s@%s: %s", un, hn, n), AVAHI_LABEL_MAX-1);
- svc->loaded.valid = 1;
- svc->loaded.type = PA_NAMEREG_SINK;
- svc->loaded.index = s->index;
+ pa_xfree(un);
+ pa_xfree(hn);
- pa_dynarray_put(u->sink_dynarray, s->index, svc);
+ pa_hashmap_put(u->services, device, s);
- return publish_service(u, svc);
+out:
+ pa_threaded_mainloop_unlock(u->mainloop);
+
+ return s;
}
-static int publish_source(struct userdata *u, pa_source *s) {
- struct service *svc;
- assert(u && s);
+/* Run from Avahi mainloop context */
+static void service_free(struct service *s) {
+ pa_assert(s);
+
+ if (s->entry_group) {
+ pa_log_debug("Removing entry group for %s.", s->service_name);
+ avahi_entry_group_free(s->entry_group);
+ }
- svc = get_service(u, s->name);
- if (svc->loaded.valid)
- return publish_service(u, svc);
+ pa_xfree(s->service_name);
- svc->loaded.valid = 1;
- svc->loaded.type = PA_NAMEREG_SOURCE;
- svc->loaded.index = s->index;
+ pa_xfree(s->name);
+ pa_proplist_free(s->proplist);
- pa_dynarray_put(u->source_dynarray, s->index, svc);
-
- return publish_service(u, svc);
+ pa_xfree(s);
}
-static int publish_autoload(struct userdata *u, pa_autoload_entry *s) {
- struct service *svc;
- assert(u && s);
+/* Runs in PA mainloop context */
+static bool shall_ignore(pa_object *o) {
+ pa_object_assert_ref(o);
- svc = get_service(u, s->name);
- if (svc->autoload.valid)
- return publish_service(u, svc);
+ if (pa_sink_isinstance(o))
+ return !!(PA_SINK(o)->flags & PA_SINK_NETWORK);
- svc->autoload.valid = 1;
- svc->autoload.type = s->type;
- svc->autoload.index = s->index;
+ if (pa_source_isinstance(o))
+ return PA_SOURCE(o)->monitor_of || (PA_SOURCE(o)->flags & PA_SOURCE_NETWORK);
- pa_dynarray_put(u->autoload_dynarray, s->index, svc);
-
- return publish_service(u, svc);
+ pa_assert_not_reached();
}
-static int remove_sink(struct userdata *u, uint32_t idx) {
- struct service *svc;
- assert(u && idx != PA_INVALID_INDEX);
-
- if (!(svc = pa_dynarray_get(u->sink_dynarray, idx)))
- return 0;
+/* Runs in PA mainloop context */
+static pa_hook_result_t device_new_or_changed_cb(pa_core *c, pa_object *o, struct userdata *u) {
+ pa_assert(c);
+ pa_object_assert_ref(o);
- if (!svc->loaded.valid || svc->loaded.type != PA_NAMEREG_SINK)
- return 0;
+ if (!shall_ignore(o)) {
+ pa_threaded_mainloop_lock(u->mainloop);
+ pa_mainloop_api_once(u->api, publish_service, get_service(u, o));
+ pa_threaded_mainloop_unlock(u->mainloop);
+ }
- svc->loaded.valid = 0;
- pa_dynarray_put(u->sink_dynarray, idx, NULL);
-
- return publish_service(u, svc);
+ return PA_HOOK_OK;
}
-static int remove_source(struct userdata *u, uint32_t idx) {
- struct service *svc;
- assert(u && idx != PA_INVALID_INDEX);
-
- if (!(svc = pa_dynarray_get(u->source_dynarray, idx)))
- return 0;
-
- if (!svc->loaded.valid || svc->loaded.type != PA_NAMEREG_SOURCE)
- return 0;
-
- svc->loaded.valid = 0;
- pa_dynarray_put(u->source_dynarray, idx, NULL);
+/* Runs in PA mainloop context */
+static pa_hook_result_t device_unlink_cb(pa_core *c, pa_object *o, struct userdata *u) {
+ struct service *s;
- return publish_service(u, svc);
-}
+ pa_assert(c);
+ pa_object_assert_ref(o);
-static int remove_autoload(struct userdata *u, uint32_t idx) {
- struct service *svc;
- assert(u && idx != PA_INVALID_INDEX);
-
- if (!(svc = pa_dynarray_get(u->autoload_dynarray, idx)))
- return 0;
+ pa_threaded_mainloop_lock(u->mainloop);
- if (!svc->autoload.valid)
- return 0;
+ if ((s = pa_hashmap_remove(u->services, o)))
+ service_free(s);
- svc->autoload.valid = 0;
- pa_dynarray_put(u->autoload_dynarray, idx, NULL);
+ pa_threaded_mainloop_unlock(u->mainloop);
- return publish_service(u, svc);
+ return PA_HOOK_OK;
}
-static void subscribe_callback(pa_core *c, pa_subscription_event_type_t t, uint32_t idx, void *userdata) {
+static int publish_main_service(struct userdata *u);
+
+/* Runs in Avahi mainloop context */
+static void main_entry_group_callback(AvahiEntryGroup *g, AvahiEntryGroupState state, void *userdata) {
struct userdata *u = userdata;
- assert(u && c);
+ pa_assert(u);
- switch (t & PA_SUBSCRIPTION_EVENT_FACILITY_MASK)
- case PA_SUBSCRIPTION_EVENT_SINK: {
- if ((t & PA_SUBSCRIPTION_EVENT_TYPE_MASK) == PA_SUBSCRIPTION_EVENT_NEW) {
- pa_sink *sink;
+ switch (state) {
- if ((sink = pa_idxset_get_by_index(c->sinks, idx))) {
- if (publish_sink(u, sink) < 0)
- goto fail;
- }
- } else if ((t & PA_SUBSCRIPTION_EVENT_TYPE_MASK) == PA_SUBSCRIPTION_EVENT_REMOVE) {
- if (remove_sink(u, idx) < 0)
- goto fail;
- }
-
+ case AVAHI_ENTRY_GROUP_ESTABLISHED:
+ pa_log_info("Successfully established main service.");
break;
- case PA_SUBSCRIPTION_EVENT_SOURCE:
+ case AVAHI_ENTRY_GROUP_COLLISION: {
+ char *t;
- if ((t & PA_SUBSCRIPTION_EVENT_TYPE_MASK) == PA_SUBSCRIPTION_EVENT_NEW) {
- pa_source *source;
-
- if ((source = pa_idxset_get_by_index(c->sources, idx))) {
- if (publish_source(u, source) < 0)
- goto fail;
- }
- } else if ((t & PA_SUBSCRIPTION_EVENT_TYPE_MASK) == PA_SUBSCRIPTION_EVENT_REMOVE) {
- if (remove_source(u, idx) < 0)
- goto fail;
- }
-
- break;
+ t = avahi_alternative_service_name(u->service_name);
+ pa_log_info("Name collision: renaming main service %s to %s.", u->service_name, t);
+ pa_xfree(u->service_name);
+ u->service_name = t;
- case PA_SUBSCRIPTION_EVENT_AUTOLOAD:
- if ((t & PA_SUBSCRIPTION_EVENT_TYPE_MASK) == PA_SUBSCRIPTION_EVENT_NEW) {
- pa_autoload_entry *autoload;
-
- if ((autoload = pa_idxset_get_by_index(c->autoload_idxset, idx))) {
- if (publish_autoload(u, autoload) < 0)
- goto fail;
- }
- } else if ((t & PA_SUBSCRIPTION_EVENT_TYPE_MASK) == PA_SUBSCRIPTION_EVENT_REMOVE) {
- if (remove_autoload(u, idx) < 0)
- goto fail;
- }
-
+ publish_main_service(u);
break;
- }
-
- return;
-
-fail:
- if (u->subscription) {
- pa_subscription_free(u->subscription);
- u->subscription = NULL;
- }
-}
-
-static int publish_main_service(struct userdata *u);
-
-static void main_entry_group_callback(AvahiEntryGroup *g, AvahiEntryGroupState state, void *userdata) {
- struct userdata *u = userdata;
- assert(u);
+ }
- if (state == AVAHI_ENTRY_GROUP_COLLISION) {
- char *t;
+ case AVAHI_ENTRY_GROUP_FAILURE: {
+ pa_log("Failed to register main service: %s", avahi_strerror(avahi_client_errno(avahi_entry_group_get_client(g))));
- t = avahi_alternative_service_name(u->service_name);
- pa_xfree(u->service_name);
- u->service_name = t;
+ avahi_entry_group_free(g);
+ u->main_entry_group = NULL;
+ break;
+ }
- publish_main_service(u);
+ case AVAHI_ENTRY_GROUP_UNCOMMITED:
+ case AVAHI_ENTRY_GROUP_REGISTERING:
+ break;
}
}
+/* Runs in Avahi mainloop context */
static int publish_main_service(struct userdata *u) {
AvahiStringList *txt = NULL;
int r = -1;
-
+
+ pa_assert(u);
+
if (!u->main_entry_group) {
if (!(u->main_entry_group = avahi_entry_group_new(u->client, main_entry_group_callback, u))) {
- pa_log(__FILE__": avahi_entry_group_new() failed: %s", avahi_strerror(avahi_client_errno(u->client)));
+ pa_log("avahi_entry_group_new() failed: %s", avahi_strerror(avahi_client_errno(u->client)));
goto fail;
}
} else
avahi_entry_group_reset(u->main_entry_group);
-
- txt = txt_record_server_data(u->core, NULL);
+
+ txt = txt_record_server_data(u->core, txt);
if (avahi_entry_group_add_service_strlst(
u->main_entry_group,
SERVICE_TYPE_SERVER,
NULL,
NULL,
- u->port,
+ compute_port(u),
txt) < 0) {
-
- pa_log(__FILE__": avahi_entry_group_add_service_strlst() failed: %s", avahi_strerror(avahi_client_errno(u->client)));
+
+ pa_log("avahi_entry_group_add_service_strlst() failed: %s", avahi_strerror(avahi_client_errno(u->client)));
goto fail;
}
-
+
if (avahi_entry_group_commit(u->main_entry_group) < 0) {
- pa_log(__FILE__": avahi_entry_group_commit() failed: %s", avahi_strerror(avahi_client_errno(u->client)));
+ pa_log("avahi_entry_group_commit() failed: %s", avahi_strerror(avahi_client_errno(u->client)));
goto fail;
}
r = 0;
-
+
fail:
avahi_string_list_free(txt);
return r;
}
+/* Runs in PA mainloop context */
static int publish_all_services(struct userdata *u) {
pa_sink *sink;
pa_source *source;
- pa_autoload_entry *autoload;
int r = -1;
uint32_t idx;
-
- assert(u);
- pa_log_debug(__FILE__": Publishing services in Zeroconf");
+ pa_assert(u);
- for (sink = pa_idxset_first(u->core->sinks, &idx); sink; sink = pa_idxset_next(u->core->sinks, &idx))
- if (publish_sink(u, sink) < 0)
- goto fail;
+ pa_log_debug("Publishing services in Zeroconf");
- for (source = pa_idxset_first(u->core->sources, &idx); source; source = pa_idxset_next(u->core->sources, &idx))
- if (publish_source(u, source) < 0)
- goto fail;
+ for (sink = PA_SINK(pa_idxset_first(u->core->sinks, &idx)); sink; sink = PA_SINK(pa_idxset_next(u->core->sinks, &idx)))
+ if (!shall_ignore(PA_OBJECT(sink))) {
+ pa_threaded_mainloop_lock(u->mainloop);
+ pa_mainloop_api_once(u->api, publish_service, get_service(u, PA_OBJECT(sink)));
+ pa_threaded_mainloop_unlock(u->mainloop);
+ }
- if (u->core->autoload_idxset)
- for (autoload = pa_idxset_first(u->core->autoload_idxset, &idx); autoload; autoload = pa_idxset_next(u->core->autoload_idxset, &idx))
- if (publish_autoload(u, autoload) < 0)
- goto fail;
+ for (source = PA_SOURCE(pa_idxset_first(u->core->sources, &idx)); source; source = PA_SOURCE(pa_idxset_next(u->core->sources, &idx)))
+ if (!shall_ignore(PA_OBJECT(source))) {
+ pa_threaded_mainloop_lock(u->mainloop);
+ pa_mainloop_api_once(u->api, publish_service, get_service(u, PA_OBJECT(source)));
+ pa_threaded_mainloop_unlock(u->mainloop);
+ }
if (publish_main_service(u) < 0)
goto fail;
-
+
r = 0;
-
+
fail:
return r;
}
-static void unpublish_all_services(struct userdata *u, int rem) {
+/* Runs in Avahi mainloop context */
+static void unpublish_all_services(struct userdata *u, bool rem) {
void *state = NULL;
struct service *s;
-
- assert(u);
- pa_log_debug(__FILE__": Unpublishing services in Zeroconf");
+ pa_assert(u);
+
+ pa_log_debug("Unpublishing services in Zeroconf");
while ((s = pa_hashmap_iterate(u->services, &state, NULL))) {
if (s->entry_group) {
if (rem) {
+ pa_log_debug("Removing entry group for %s.", s->service_name);
avahi_entry_group_free(s->entry_group);
s->entry_group = NULL;
- } else
+ } else {
avahi_entry_group_reset(s->entry_group);
+ pa_log_debug("Resetting entry group for %s.", s->service_name);
+ }
}
-
- s->published = UNPUBLISHED;
}
if (u->main_entry_group) {
if (rem) {
+ pa_log_debug("Removing main entry group.");
avahi_entry_group_free(u->main_entry_group);
u->main_entry_group = NULL;
- } else
+ } else {
avahi_entry_group_reset(u->main_entry_group);
+ pa_log_debug("Resetting main entry group.");
+ }
+ }
+}
+
+/* Runs in PA mainloop context */
+static int avahi_process_msg(pa_msgobject *o, int code, void *data, int64_t offset, pa_memchunk *chunk) {
+ struct userdata *u = (struct userdata *) data;
+
+ switch (code) {
+ case AVAHI_MESSAGE_PUBLISH_ALL:
+ publish_all_services(u);
+ break;
+
+ case AVAHI_MESSAGE_SHUTDOWN_START:
+ pa_module_unload(u->core, u->module, true);
+ break;
+
+ case AVAHI_MESSAGE_SHUTDOWN_COMPLETE:
+ /* pa__done() is waiting for this */
+ break;
+
+ default:
+ pa_assert_not_reached();
}
+
+ return 0;
}
+/* Runs in Avahi mainloop context */
static void client_callback(AvahiClient *c, AvahiClientState state, void *userdata) {
struct userdata *u = userdata;
- assert(c);
+
+ pa_assert(c);
+ pa_assert(u);
u->client = c;
-
+
switch (state) {
case AVAHI_CLIENT_S_RUNNING:
- publish_all_services(u);
+ /* Collect all sinks/sources, and publish them */
+ pa_asyncmsgq_post(u->thread_mq.outq, PA_MSGOBJECT(u->msg), AVAHI_MESSAGE_PUBLISH_ALL, u, 0, NULL, NULL);
break;
-
+
case AVAHI_CLIENT_S_COLLISION:
- unpublish_all_services(u, 0);
+ pa_log_debug("Host name collision");
+ unpublish_all_services(u, false);
break;
case AVAHI_CLIENT_FAILURE:
if (avahi_client_errno(c) == AVAHI_ERR_DISCONNECTED) {
int error;
- unpublish_all_services(u, 1);
+
+ pa_log_debug("Avahi daemon disconnected.");
+
+ unpublish_all_services(u, true);
avahi_client_free(u->client);
- if (!(u->client = avahi_client_new(u->avahi_poll, AVAHI_CLIENT_NO_FAIL, client_callback, u, &error)))
- pa_log(__FILE__": pa_avahi_client_new() failed: %s", avahi_strerror(error));
+ if (!(u->client = avahi_client_new(u->avahi_poll, AVAHI_CLIENT_NO_FAIL, client_callback, u, &error))) {
+ pa_log("avahi_client_new() failed: %s", avahi_strerror(error));
+ pa_module_unload_request(u->module, true);
+ }
}
-
+
break;
default: ;
}
}
-int pa__init(pa_core *c, pa_module*m) {
- struct userdata *u;
- uint32_t port = PA_NATIVE_DEFAULT_PORT;
- pa_modargs *ma = NULL;
- char hn[256];
+/* Runs in Avahi mainloop context */
+static void create_client(pa_mainloop_api *api PA_GCC_UNUSED, void *userdata) {
+ struct userdata *u = (struct userdata *) userdata;
int error;
- if (!(ma = pa_modargs_new(m->argument, valid_modargs))) {
- pa_log(__FILE__": failed to parse module arguments.");
+ pa_thread_mq_install(&u->thread_mq);
+
+ if (!(u->client = avahi_client_new(u->avahi_poll, AVAHI_CLIENT_NO_FAIL, client_callback, u, &error))) {
+ pa_log("avahi_client_new() failed: %s", avahi_strerror(error));
goto fail;
}
- if (pa_modargs_get_value_u32(ma, "port", &port) < 0 || port == 0 || port >= 0xFFFF) {
- pa_log(__FILE__": invalid port specified.");
+ pa_log_debug("Started Avahi threaded mainloop");
+
+ return;
+
+fail:
+ pa_asyncmsgq_post(u->thread_mq.outq, PA_MSGOBJECT(u->msg), AVAHI_MESSAGE_SHUTDOWN_START, u, 0, NULL, NULL);
+}
+
+int pa__init(pa_module*m) {
+
+ struct userdata *u;
+ pa_modargs *ma = NULL;
+ char *hn, *un;
+
+ if (!(ma = pa_modargs_new(m->argument, valid_modargs))) {
+ pa_log("Failed to parse module arguments.");
goto fail;
}
m->userdata = u = pa_xnew(struct userdata, 1);
- u->core = c;
- u->port = (uint16_t) port;
+ u->core = m->core;
+ u->module = m;
+ u->native = pa_native_protocol_get(u->core);
+
+ u->rtpoll = pa_rtpoll_new();
+ u->mainloop = pa_threaded_mainloop_new();
+ u->api = pa_threaded_mainloop_get_api(u->mainloop);
+
+ pa_thread_mq_init(&u->thread_mq, u->core->mainloop, u->rtpoll);
+ u->msg = pa_msgobject_new(avahi_msg);
+ u->msg->parent.process_msg = avahi_process_msg;
+
+ u->avahi_poll = pa_avahi_poll_new(u->api);
- u->avahi_poll = pa_avahi_poll_new(c->mainloop);
-
- u->services = pa_hashmap_new(pa_idxset_string_hash_func, pa_idxset_string_compare_func);
- u->sink_dynarray = pa_dynarray_new();
- u->source_dynarray = pa_dynarray_new();
- u->autoload_dynarray = pa_dynarray_new();
+ u->services = pa_hashmap_new(pa_idxset_trivial_hash_func, pa_idxset_trivial_compare_func);
- u->subscription = pa_subscription_new(c,
- PA_SUBSCRIPTION_MASK_SINK|
- PA_SUBSCRIPTION_MASK_SOURCE|
- PA_SUBSCRIPTION_MASK_AUTOLOAD, subscribe_callback, u);
+ u->sink_new_slot = pa_hook_connect(&m->core->hooks[PA_CORE_HOOK_SINK_PUT], PA_HOOK_LATE, (pa_hook_cb_t) device_new_or_changed_cb, u);
+ u->sink_changed_slot = pa_hook_connect(&m->core->hooks[PA_CORE_HOOK_SINK_PROPLIST_CHANGED], PA_HOOK_LATE, (pa_hook_cb_t) device_new_or_changed_cb, u);
+ u->sink_unlink_slot = pa_hook_connect(&m->core->hooks[PA_CORE_HOOK_SINK_UNLINK], PA_HOOK_LATE, (pa_hook_cb_t) device_unlink_cb, u);
+ u->source_new_slot = pa_hook_connect(&m->core->hooks[PA_CORE_HOOK_SOURCE_PUT], PA_HOOK_LATE, (pa_hook_cb_t) device_new_or_changed_cb, u);
+ u->source_changed_slot = pa_hook_connect(&m->core->hooks[PA_CORE_HOOK_SOURCE_PROPLIST_CHANGED], PA_HOOK_LATE, (pa_hook_cb_t) device_new_or_changed_cb, u);
+ u->source_unlink_slot = pa_hook_connect(&m->core->hooks[PA_CORE_HOOK_SOURCE_UNLINK], PA_HOOK_LATE, (pa_hook_cb_t) device_unlink_cb, u);
u->main_entry_group = NULL;
- u->service_name = pa_xstrdup(pa_get_host_name(hn, sizeof(hn)));
+ un = pa_get_user_name_malloc();
+ hn = pa_get_host_name_malloc();
+ u->service_name = pa_truncate_utf8(pa_sprintf_malloc("%s@%s", un, hn), AVAHI_LABEL_MAX-1);
+ pa_xfree(un);
+ pa_xfree(hn);
- if (!(u->client = avahi_client_new(u->avahi_poll, AVAHI_CLIENT_NO_FAIL, client_callback, u, &error))) {
- pa_log(__FILE__": pa_avahi_client_new() failed: %s", avahi_strerror(error));
- goto fail;
- }
+ pa_threaded_mainloop_set_name(u->mainloop, "avahi-ml");
+ pa_threaded_mainloop_start(u->mainloop);
+
+ pa_threaded_mainloop_lock(u->mainloop);
+ pa_mainloop_api_once(u->api, create_client, u);
+ pa_threaded_mainloop_unlock(u->mainloop);
pa_modargs_free(ma);
-
+
return 0;
-
+
fail:
- pa__done(c, m);
+ pa__done(m);
if (ma)
pa_modargs_free(ma);
-
+
return -1;
}
-static void service_free(void *p, void *userdata) {
- struct service *s = p;
- struct userdata *u = userdata;
+/* Runs in Avahi mainloop context */
+static void client_free(pa_mainloop_api *api PA_GCC_UNUSED, void *userdata) {
+ struct userdata *u = (struct userdata *) userdata;
- assert(s);
- assert(u);
+ pa_hashmap_free(u->services, (pa_free_cb_t) service_free);
- if (s->entry_group)
- avahi_entry_group_free(s->entry_group);
-
- pa_xfree(s->service_name);
- pa_xfree(s->name);
- pa_xfree(s);
+ if (u->main_entry_group)
+ avahi_entry_group_free(u->main_entry_group);
+
+ if (u->client)
+ avahi_client_free(u->client);
+
+ if (u->avahi_poll)
+ pa_avahi_poll_free(u->avahi_poll);
+
+ pa_asyncmsgq_post(u->thread_mq.outq, PA_MSGOBJECT(u->msg), AVAHI_MESSAGE_SHUTDOWN_COMPLETE, NULL, 0, NULL, NULL);
}
-void pa__done(pa_core *c, pa_module*m) {
+void pa__done(pa_module*m) {
struct userdata*u;
- assert(c && m);
+ pa_assert(m);
if (!(u = m->userdata))
return;
- if (u->services)
- pa_hashmap_free(u->services, service_free, u);
+ pa_mainloop_api_once(u->api, client_free, u);
+ pa_asyncmsgq_wait_for(u->thread_mq.outq, AVAHI_MESSAGE_SHUTDOWN_COMPLETE);
- if (u->sink_dynarray)
- pa_dynarray_free(u->sink_dynarray, NULL, NULL);
- if (u->source_dynarray)
- pa_dynarray_free(u->source_dynarray, NULL, NULL);
- if (u->autoload_dynarray)
- pa_dynarray_free(u->autoload_dynarray, NULL, NULL);
-
- if (u->subscription)
- pa_subscription_free(u->subscription);
+ pa_threaded_mainloop_stop(u->mainloop);
+ pa_threaded_mainloop_free(u->mainloop);
- if (u->main_entry_group)
- avahi_entry_group_free(u->main_entry_group);
-
- if (u->client)
- avahi_client_free(u->client);
-
- if (u->avahi_poll)
- pa_avahi_poll_free(u->avahi_poll);
+ pa_thread_mq_done(&u->thread_mq);
+ pa_rtpoll_free(u->rtpoll);
+ if (u->sink_new_slot)
+ pa_hook_slot_free(u->sink_new_slot);
+ if (u->source_new_slot)
+ pa_hook_slot_free(u->source_new_slot);
+ if (u->sink_changed_slot)
+ pa_hook_slot_free(u->sink_changed_slot);
+ if (u->source_changed_slot)
+ pa_hook_slot_free(u->source_changed_slot);
+ if (u->sink_unlink_slot)
+ pa_hook_slot_free(u->sink_unlink_slot);
+ if (u->source_unlink_slot)
+ pa_hook_slot_free(u->source_unlink_slot);
+
+ if (u->native)
+ pa_native_protocol_unref(u->native);
+
+ pa_xfree(u->msg);
pa_xfree(u->service_name);
pa_xfree(u);
}
-