dns_sd_avahi.c

// SPDX-License-Identifier: LGPL-2.1-or-later
/*
 * libiio - Library for interfacing industrial I/O (IIO) devices
 *
 * Copyright (C) 2014-2020 Analog Devices, Inc.
 * Author: Paul Cercueil <paul.cercueil@analog.com>
 *         Robin Getz <robin.getz@analog.com>
 *
 * Some of this is insipred from libavahi's example:
 * https://avahi.org/doxygen/html/client-browse-services_8c-example.html
 * which is also LGPL 2.1 or later.
 */

#include "dns_sd.h"

#include <errno.h>
#include <string.h>
#include <time.h>
#include <unistd.h>

#include <avahi-common/address.h>
#include <avahi-common/error.h>
#include <avahi-common/simple-watch.h>
#include <avahi-common/malloc.h>
#include <avahi-client/client.h>
#include <avahi-client/lookup.h>

#include <iio/iio-backend.h>
#include <iio/iio-debug.h>
#include <iio/iio-lock.h>

/*
 * Fundamentally, this builds up a linked list to manage
 * potential clients on the network
 */

static struct dns_sd_discovery_data *new_discovery_data(void)
{
	struct dns_sd_discovery_data *d;

	d = zalloc(sizeof(*d));
	if (!d)
		return NULL;

	d->address = zalloc(sizeof(*d->address));
	if (!d->address) {
		free(d);
		return NULL;
	}

	return d;
}

static void avahi_process_resolved(struct dns_sd_cb_data *adata,
				   AvahiIfIndex iface,
				   const AvahiAddress *addr,
				   const char *host_name,
				   const uint16_t port)
{
	struct dns_sd_discovery_data *ddata = adata->d;
	const struct iio_context_params *params = adata->params;
	char *ptr;

	/* Avahi is multi-threaded, so lock the list */
	iio_mutex_lock(ddata->lock);
	ddata->resolved++;

	/* Find empty data to store things*/
	while (ddata->next)
		ddata = ddata->next;

	/* link a new placeholder to the list */
	avahi_address_snprint(ddata->addr_str,
			      sizeof(ddata->addr_str), addr);
	memcpy(ddata->address, addr, sizeof(*ddata->address)); /* Flawfinder: ignore */
	ddata->port = port;
	ddata->hostname = strdup(host_name);
	ddata->resolved = true;

	/* link a new, empty placeholder to the list */
	ddata->next = new_discovery_data();
	if (ddata->next) {
		/* duplicate poll & lock info,
		 * since we don't know which might be discarded */
		ddata->next->poll = ddata->poll;
		ddata->next->lock = ddata->lock;
	} else {
		prm_err(params, "Avahi Resolver : memory failure\n");
	}
	iio_mutex_unlock(ddata->lock);

	ptr = ddata->addr_str + strnlen(ddata->addr_str, DNS_SD_ADDRESS_STR_MAX);

	if (addr->proto == AVAHI_PROTO_INET6
	    && addr->data.ipv6.address[0] == 0xfe
	    && addr->data.ipv6.address[1] == 0x80
	    && iface != AVAHI_IF_UNSPEC
	    && if_indextoname((unsigned int)iface, ptr + 1)) {
		*ptr = '%';
	}

	prm_dbg(params, "\t\t%s:%u (%s)\n", host_name, port, ddata->addr_str);
}

/*
 * libavahi callbacks for browser and resolver
 * for more info, check out libavahi docs at:
 * https://avahi.org/doxygen/html/index.html
 */

static void __avahi_resolver_cb(AvahiServiceResolver *resolver,
				AvahiIfIndex iface,
				AvahiProtocol proto,
				AvahiResolverEvent event,
				const char *name,
				const char *type,
				const char *domain,
				const char *host_name,
				const AvahiAddress *address,
				uint16_t port,
				AvahiStringList *txt,
				AvahiLookupResultFlags flags,
				void *d)
{
	struct dns_sd_cb_data *adata = d;
	const struct iio_context_params *params = adata->params;
	AvahiClient *client;
	int err;

	if (!resolver) {
		prm_err(params, "Fatal Error in Avahi Resolver\n");
		return;
	}

	switch(event) {
	case AVAHI_RESOLVER_FAILURE:
		client = avahi_service_resolver_get_client(resolver);
		err = avahi_client_errno(client);

		prm_err(params, "Avahi Resolver: Failed resolve service '%s' "
			"of type '%s' in domain '%s': %s\n",
			name, type, domain,
			avahi_strerror(err));
		break;
	case AVAHI_RESOLVER_FOUND: {
		avahi_process_resolved(adata, iface, address, host_name, port);
		prm_dbg(params, "Avahi Resolver : service '%s' of type '%s' in domain '%s':\n",
				name, type, domain);
		break;
	}
	}
	avahi_service_resolver_free(resolver);
}

static void avahi_host_resolver(AvahiHostNameResolver *resolver,
				AvahiIfIndex iface,
				AvahiProtocol proto,
				AvahiResolverEvent event,
				const char *host_name,
				const AvahiAddress *address,
				AvahiLookupResultFlags flags,
				void *d)
{
	struct dns_sd_cb_data *adata = d;
	const struct iio_context_params *params = adata->params;
	struct dns_sd_discovery_data *ddata = adata->d;
	AvahiClient *client;
	int err;

	switch(event) {
	case AVAHI_RESOLVER_FAILURE:
		client = avahi_host_name_resolver_get_client(resolver);
		err = avahi_client_errno(client);

		prm_err(params, "Avahi Resolver: Failed to resolve host '%s' : %s\n",
			host_name, avahi_strerror(err));
		break;
	case AVAHI_RESOLVER_FOUND:
		avahi_process_resolved(adata, iface, address, host_name, IIOD_PORT);
		break;
	}

	avahi_host_name_resolver_free(resolver);
	avahi_simple_poll_quit(ddata->poll);
}

static void __avahi_browser_cb(AvahiServiceBrowser *browser,
			       AvahiIfIndex iface,
			       AvahiProtocol proto,
			       AvahiBrowserEvent event,
			       const char *name,
			       const char *type,
			       const char *domain,
			       AvahiLookupResultFlags flags,
			       void *d)
{
	struct dns_sd_cb_data *adata = d;
	struct dns_sd_discovery_data *ddata = adata->d;
	const struct iio_context_params *params = adata->params;
	struct AvahiClient *client = avahi_service_browser_get_client(browser);
	unsigned int i;
	struct timespec ts;

	ts.tv_sec = 0;
	ts.tv_nsec = 5e6; /* 5ms in ns */

	if (!browser) {
		prm_err(params, "Fatal Error in Avahi Browser\n");
		return;
	}

	switch (event) {
	case AVAHI_BROWSER_REMOVE:
		prm_dbg(params, "Avahi Browser : REMOVE : service '%s' of "
			"type '%s' in domain '%s'\n", name, type, domain);
		break;
	case AVAHI_BROWSER_NEW:
		prm_dbg(params, "Avahi Browser : NEW: service '%s' of type "
			"'%s' in domain '%s'\n", name, type, domain);
		if(!avahi_service_resolver_new(client, iface,
					       proto, name, type, domain,
					       AVAHI_PROTO_UNSPEC, 0,
					       __avahi_resolver_cb, adata)) {
			prm_err(params, "Failed to resolve service '%s\n", name);
		} else {
			iio_mutex_lock(ddata->lock);
			ddata->found++;
			iio_mutex_unlock(ddata->lock);
		}
		break;
	case AVAHI_BROWSER_ALL_FOR_NOW:
		prm_dbg(params, "Avahi Browser : ALL_FOR_NOW Browser : %d, "
			"Resolved : %d\n", ddata->found, ddata->resolved);

		/* 200 * 5ms = wait 1 second */
		for (i = 0; ddata->found != ddata->resolved && i <= 200; i++)
			nanosleep(&ts, NULL);

		avahi_simple_poll_quit(ddata->poll);
		break;
	case AVAHI_BROWSER_FAILURE:
		prm_dbg(params, "Avahi Browser : FAILURE\n");
		avahi_simple_poll_quit(ddata->poll);
		break;
	case AVAHI_BROWSER_CACHE_EXHAUSTED:
		prm_dbg(params, "Avahi Browser : CACHE_EXHAUSTED\n");
		break;
	}
}

/*
 * This creates the linked lists, tests it (make sure a context is there)
 * and returns. The structure must be freed with free_all_discovery_data();
 * The returned value is zero on success, negative error code on failure.
 */

int dnssd_find_hosts(const struct iio_context_params *params,
		     struct dns_sd_discovery_data **ddata)
{
	struct dns_sd_discovery_data *d;
	struct dns_sd_cb_data adata;
	AvahiClient *client;
	AvahiServiceBrowser *browser;
	int ret;

	d = new_discovery_data();
	if (!d)
		return -ENOMEM;

	adata.params = params;
	adata.d = d;

	d->lock = iio_mutex_create();
	ret = iio_err(d->lock);
	if (ret) {
		dnssd_free_all_discovery_data(params, d);
		return ret;
	}

	d->poll = avahi_simple_poll_new();
	if (!d->poll) {
		iio_mutex_destroy(d->lock);
		dnssd_free_all_discovery_data(params, d);
		return -ENOMEM;
	}

	client = avahi_client_new(avahi_simple_poll_get(d->poll),
				  0, NULL, NULL, &ret);
	if (!client) {
		prm_err(params, "Unable to create Avahi DNS-SD client :%s\n",
			avahi_strerror(ret));
		goto err_free_poll;
	}

	browser = avahi_service_browser_new(client,
					    AVAHI_IF_UNSPEC, AVAHI_PROTO_UNSPEC,
					    "_iio._tcp", NULL, 0,
					    __avahi_browser_cb, &adata);
	if (!browser) {
		ret = avahi_client_errno(client);
		prm_err(params, "Unable to create Avahi DNS-SD browser: %s\n",
			avahi_strerror(ret));
		goto err_free_client;
	}

	prm_dbg(params, "Trying to discover host\n");
	avahi_simple_poll_loop(d->poll);

	if (d->resolved) {
		remove_dup_discovery_data(params, &d);
		port_knock_discovery_data(params, &d);
	} else
		ret = -ENXIO;

	avahi_service_browser_free(browser);
err_free_client:
	avahi_client_free(client);
err_free_poll:
	avahi_simple_poll_free(d->poll);
	iio_mutex_destroy(d->lock);
	*ddata = d;

	return ret;
}

static void avahi_resolve_host(struct dns_sd_cb_data *adata,
			       const char *hostname,
			       const AvahiProtocol proto)
{
	struct dns_sd_discovery_data *d = adata->d;
	const struct iio_context_params *params = adata->params;
	AvahiClient *client;
	AvahiHostNameResolver *resolver;
	int ret;

	d->poll = avahi_simple_poll_new();
	if (!d->poll)
		return;

	client = avahi_client_new(avahi_simple_poll_get(d->poll), 0, NULL, NULL, &ret);
	if (!client) {
		prm_err(params, "Unable to create Avahi DNS-SD client :%s\n",
			avahi_strerror(ret));
		goto err_free_poll;
	}

	resolver = avahi_host_name_resolver_new(client, AVAHI_IF_UNSPEC, proto,
						hostname, proto, 0,
						avahi_host_resolver, adata);
	if (!resolver) {
		ret = avahi_client_errno(client);
		prm_err(params, "Unable to create Avahi DNS-SD browser: %s\n",
			avahi_strerror(ret));
		goto err_free_client;
	}

	prm_dbg(params, "Trying to resolve host: %s, proto: %d\n",
		hostname, proto);
	avahi_simple_poll_loop(d->poll);

err_free_client:
	avahi_client_free(client);
err_free_poll:
	avahi_simple_poll_free(d->poll);
}

int dnssd_resolve_host(const struct iio_context_params *params,
		       const char *hostname,
		       char *ip_addr,
		       const int addr_len)
{
	struct dns_sd_discovery_data *d;
	struct dns_sd_cb_data adata;
	int ret;

	if (!hostname || hostname[0] == '\0')
		return -EINVAL;

	d = new_discovery_data();
	if (!d)
		return -ENOMEM;

	d->lock = iio_mutex_create();
	ret = iio_err(d->lock);
	if (ret)
		goto err_free_data;

	adata.params = params;
	adata.d = d;

	/*
	 * The reason not to use AVAHI_PROTO_UNSPEC is that avahi sometimes resolves the host
	 * to an ipv6 link local address which is not suitable to be used by connect. In fact,
	 * `port_knock_discovery_data()` would discard this entry. On the other hand, some users
	 * might really want to use ipv6 and have their environment correctly configured. Hence,
	 * we try to resolve both in ipv4 and ipv6...
	 */
	avahi_resolve_host(&adata, hostname, AVAHI_PROTO_INET);
#ifdef HAVE_IPV6
	avahi_resolve_host(&adata, hostname, AVAHI_PROTO_INET6);
#endif

	if (d->resolved) {
		remove_dup_discovery_data(params, &d);
		port_knock_discovery_data(params, &d);
	} else {
		ret = -ENXIO;
		goto err_mutex_destroy;
	}

	/* If next is null it means that d is empty */
	if (!d->next) {
		ret = -ENXIO;
		goto err_mutex_destroy;
	}

	iio_strlcpy(ip_addr, d->addr_str, addr_len);

err_mutex_destroy:
	iio_mutex_destroy(d->lock);
err_free_data:
	dnssd_free_all_discovery_data(params, d);
	return ret;
}