fpi-poll.c 13.5 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
/*
 * Polling/timing management
 * Copyright (C) 2008 Daniel Drake <dsd@gentoo.org>
 *
 * This library 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.1 of the License, or (at your option) any later version.
 *
 * This library 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 */

#define FP_COMPONENT "poll"

22
#include "fp_internal.h"
23
#include "fpi-poll.h"
24

25 26 27 28 29 30 31 32 33
#include <config.h>
#include <errno.h>
#include <time.h>
#include <sys/time.h>

#include <glib.h>
#include <libusb.h>

/**
34 35
 * SECTION:events
 * @title: Initialisation and events handling
36
 * @short_description: Initialisation and events handling functions
37
 *
38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56
 * These functions are only applicable to users of libfprint's asynchronous
 * API.
 *
 * libfprint does not create internal library threads and hence can only
 * execute when your application is calling a libfprint function. However,
 * libfprint often has work to be do, such as handling of completed USB
 * transfers, and processing of timeouts required in order for the library
 * to function. Therefore it is essential that your own application must
 * regularly "phone into" libfprint so that libfprint can handle any pending
 * events.
 *
 * The function you must call is fp_handle_events() or a variant of it. This
 * function will handle any pending events, and it is from this context that
 * all asynchronous event callbacks from the library will occur. You can view
 * this function as a kind of iteration function.
 *
 * If there are no events pending, fp_handle_events() will block for a few
 * seconds (and will handle any new events should anything occur in that time).
 * If you wish to customise this timeout, you can use
57
 * fp_handle_events_timeout() instead. If you wish to do a non-blocking
58 59
 * iteration, call fp_handle_events_timeout() with a zero timeout.
 *
60 61 62 63 64 65
 * How to integrate events handling depends on your main loop implementation.
 * The sister fprintd project includes an implementation of main loop handling
 * that integrates into GLib's main loop. The
 * [libusb documentation](http://libusb.sourceforge.net/api-1.0/group__poll.html#details)
 * also includes more details about how to integrate libfprint events into
 * your main loop.
66 67
 */

68 69 70
/**
 * SECTION:fpi-poll
 * @title: Timeouts
71
 * @short_description: Timeout handling helpers
72 73 74 75 76 77
 *
 * Helper functions to schedule a function call to be made after a timeout. This
 * is useful to avoid making blocking calls while waiting for hardware to answer
 * for example.
 */

78 79 80 81
/* this is a singly-linked list of pending timers, sorted with the timer that
 * is expiring soonest at the head. */
static GSList *active_timers = NULL;

Daniel Drake's avatar
Daniel Drake committed
82 83 84 85
/* notifiers for added or removed poll fds */
static fp_pollfd_added_cb fd_added_cb = NULL;
static fp_pollfd_removed_cb fd_removed_cb = NULL;

86 87 88
struct fpi_timeout {
	struct timeval expiry;
	fpi_timeout_fn callback;
89
	struct fp_dev *dev;
90
	void *data;
91
	char *name;
92 93
};

94 95
static gboolean fpi_poll_is_setup(void);

96 97
static int timeout_sort_fn(gconstpointer _a, gconstpointer _b)
{
98 99
	fpi_timeout *a = (fpi_timeout *) _a;
	fpi_timeout *b = (fpi_timeout *) _b;
100 101 102 103 104 105 106 107 108 109 110
	struct timeval *tv_a = &a->expiry;
	struct timeval *tv_b = &b->expiry;

	if (timercmp(tv_a, tv_b, <))
		return -1;
	else if (timercmp(tv_a, tv_b, >))
		return 1;
	else
		return 0;
}

111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139
static void
fpi_timeout_free(fpi_timeout *timeout)
{
	if (timeout == NULL)
		return;

	g_free(timeout->name);
	g_free(timeout);
}

/**
 * fpi_timeout_set_name:
 * @timeout: a #fpi_timeout
 * @name: the name to give the timeout
 *
 * Sets a name for a timeout, allowing that name to be printed
 * along with any timeout related debug.
 */
void
fpi_timeout_set_name(fpi_timeout *timeout,
		     const char  *name)
{
	g_return_if_fail (timeout != NULL);
	g_return_if_fail (name != NULL);
	g_return_if_fail (timeout->name == NULL);

	timeout->name = g_strdup(name);
}

140 141 142 143
/**
 * fpi_timeout_add:
 * @msec: the time before calling the function, in milliseconds (1/1000ths of a second)
 * @callback: function to callback
144 145
 * @dev: a struct #fp_dev
 * @data: data to pass to @callback, or %NULL
146 147
 *
 * A timeout is the asynchronous equivalent of sleeping. You create a timeout
148
 * saying that you'd like to have a function invoked at a certain time in
149 150 151 152
 * the future.
 *
 * Note that you should hold onto the return value of this function to cancel it
 * use fpi_timeout_cancel(), otherwise the callback could be called while the driver
153 154 155
 * is being torn down.
 *
 * This function can be considered to never fail.
156 157 158
 *
 * Returns: an #fpi_timeout structure
 */
159 160 161 162
fpi_timeout *fpi_timeout_add(unsigned int    msec,
			     fpi_timeout_fn  callback,
			     struct fp_dev  *dev,
			     void           *data)
163 164 165
{
	struct timespec ts;
	struct timeval add_msec;
166
	fpi_timeout *timeout;
167 168
	int r;

169
	g_return_val_if_fail (dev != NULL, NULL);
170
	g_return_val_if_fail (fpi_poll_is_setup(), NULL);
171

172 173 174 175 176
	fp_dbg("in %dms", msec);

	r = clock_gettime(CLOCK_MONOTONIC, &ts);
	if (r < 0) {
		fp_err("failed to read monotonic clock, errno=%d", errno);
177
		BUG();
178
		return NULL;
179 180
	}

181
	timeout = g_new0(fpi_timeout, 1);
182
	timeout->callback = callback;
183
	timeout->dev = dev;
184 185 186 187 188 189 190 191 192 193 194 195
	timeout->data = data;
	TIMESPEC_TO_TIMEVAL(&timeout->expiry, &ts);

	/* calculate timeout expiry by adding delay to current monotonic clock */
	timerclear(&add_msec);
	add_msec.tv_sec = msec / 1000;
	add_msec.tv_usec = (msec % 1000) * 1000;
	timeradd(&timeout->expiry, &add_msec, &timeout->expiry);

	active_timers = g_slist_insert_sorted(active_timers, timeout,
		timeout_sort_fn);

196 197 198
	return timeout;
}

199 200 201 202 203 204 205
/**
 * fpi_timeout_cancel:
 * @timeout: an #fpi_timeout structure
 *
 * Cancels a timeout scheduled with fpi_timeout_add(), and frees the
 * @timeout structure.
 */
206
void fpi_timeout_cancel(fpi_timeout *timeout)
207
{
208
	G_DEBUG_HERE();
209
	active_timers = g_slist_remove(active_timers, timeout);
210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230
	fpi_timeout_free(timeout);
}

void
fpi_timeout_cancel_for_dev(struct fp_dev *dev)
{
	GSList *l;

	g_return_if_fail (dev != NULL);

	l = active_timers;
	while (l) {
		struct fpi_timeout *timeout = l->data;
		GSList *current = l;

		l = l->next;
		if (timeout->dev == dev) {
			fpi_timeout_free (timeout);
			active_timers = g_slist_delete_link (active_timers, current);
		}
	}
231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260
}

/* get the expiry time and optionally the timeout structure for the next
 * timeout. returns 0 if there are no expired timers, or 1 if the
 * timeval/timeout output parameters were populated. if the returned timeval
 * is zero then it means the timeout has already expired and should be handled
 * ASAP. */
static int get_next_timeout_expiry(struct timeval *out,
	struct fpi_timeout **out_timeout)
{
	struct timespec ts;
	struct timeval tv;
	struct fpi_timeout *next_timeout;
	int r;

	if (active_timers == NULL)
		return 0;

	r = clock_gettime(CLOCK_MONOTONIC, &ts);
	if (r < 0) {
		fp_err("failed to read monotonic clock, errno=%d", errno);
		return r;
	}
	TIMESPEC_TO_TIMEVAL(&tv, &ts);

	next_timeout = active_timers->data;
	if (out_timeout)
		*out_timeout = next_timeout;

	if (timercmp(&tv, &next_timeout->expiry, >=)) {
261 262 263 264
		if (next_timeout->name)
			fp_dbg("first timeout '%s' already expired", next_timeout->name);
		else
			fp_dbg("first timeout already expired");
265 266 267
		timerclear(out);
	} else {
		timersub(&next_timeout->expiry, &tv, out);
268 269 270 271 272
		if (next_timeout->name)
			fp_dbg("next timeout '%s' in %ld.%06lds", next_timeout->name,
			       out->tv_sec, out->tv_usec);
		else
			fp_dbg("next timeout in %ld.%06lds", out->tv_sec, out->tv_usec);
273 274 275 276 277 278 279 280
	}

	return 1;
}

/* handle a timeout that has expired */
static void handle_timeout(struct fpi_timeout *timeout)
{
281
	G_DEBUG_HERE();
282
	timeout->callback(timeout->dev, timeout->data);
283
	active_timers = g_slist_remove(active_timers, timeout);
284
	fpi_timeout_free(timeout);
285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302
}

static int handle_timeouts(void)
{
	struct timeval next_timeout_expiry;
	struct fpi_timeout *next_timeout;
	int r;

	r = get_next_timeout_expiry(&next_timeout_expiry, &next_timeout);
	if (r <= 0)
		return r;

	if (!timerisset(&next_timeout_expiry))
		handle_timeout(next_timeout);

	return 0;
}

303 304 305 306
/**
 * fp_handle_events_timeout:
 * @timeout: Maximum timeout for this blocking function
 *
307 308 309 310 311
 * Handle any pending events. If a non-zero timeout is specified, the function
 * will potentially block for the specified amount of time, although it may
 * return sooner if events have been handled. The function acts as non-blocking
 * for a zero timeout.
 *
312
 * Returns: 0 on success, non-zero on error.
313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340
 */
API_EXPORTED int fp_handle_events_timeout(struct timeval *timeout)
{
	struct timeval next_timeout_expiry;
	struct timeval select_timeout;
	struct fpi_timeout *next_timeout;
	int r;

	r = get_next_timeout_expiry(&next_timeout_expiry, &next_timeout);
	if (r < 0)
		return r;

	if (r) {
		/* timer already expired? */
		if (!timerisset(&next_timeout_expiry)) {
			handle_timeout(next_timeout);
			return 0;
		}

		/* choose the smallest of next URB timeout or user specified timeout */
		if (timercmp(&next_timeout_expiry, timeout, <))
			select_timeout = next_timeout_expiry;
		else
			select_timeout = *timeout;
	} else {
		select_timeout = *timeout;
	}

Daniel Drake's avatar
Daniel Drake committed
341
	r = libusb_handle_events_timeout(fpi_usb_ctx, &select_timeout);
342 343 344 345 346 347 348
	*timeout = select_timeout;
	if (r < 0)
		return r;

	return handle_timeouts();
}

349 350 351
/**
 * fp_handle_events:
 *
352 353 354 355
 * Convenience function for calling fp_handle_events_timeout() with a sensible
 * default timeout value of two seconds (subject to change if we decide another
 * value is more sensible).
 *
356
 * Returns: 0 on success, non-zero on error.
357 358 359 360 361 362 363 364 365
 */
API_EXPORTED int fp_handle_events(void)
{
	struct timeval tv;
	tv.tv_sec = 2;
	tv.tv_usec = 0;
	return fp_handle_events_timeout(&tv);
}

366 367
/**
 * fp_get_next_timeout:
368
 * @tv: a #timeval structure containing the duration to the next timeout.
369 370 371 372 373
 *
 * A zero filled @tv timeout means events are to be handled immediately
 *
 * Returns: returns 0 if no timeouts active, or 1 if timeout returned.
 */
374 375
API_EXPORTED int fp_get_next_timeout(struct timeval *tv)
{
376 377
	struct timeval fprint_timeout = { 0, 0 };
	struct timeval libusb_timeout = { 0, 0 };
378 379 380 381
	int r_fprint;
	int r_libusb;

	r_fprint = get_next_timeout_expiry(&fprint_timeout, NULL);
Daniel Drake's avatar
Daniel Drake committed
382
	r_libusb = libusb_get_next_timeout(fpi_usb_ctx, &libusb_timeout);
383 384 385

	/* if we have no pending timeouts and the same is true for libusb,
	 * indicate that we have no pending timouts */
386
	if (r_fprint <= 0 && r_libusb <= 0)
387 388
		return 0;

389 390 391 392 393 394 395 396
	/* if fprint have no pending timeouts return libusb timeout */
	else if (r_fprint == 0)
		*tv = libusb_timeout;

	/* if libusb have no pending timeouts return fprint timeout */
	else if (r_libusb == 0)
		*tv = fprint_timeout;

397 398 399 400 401 402 403 404
	/* otherwise return the smaller of the 2 timeouts */
	else if (timercmp(&fprint_timeout, &libusb_timeout, <))
		*tv = fprint_timeout;
	else
		*tv = libusb_timeout;
	return 1;
}

405 406 407 408 409
/**
 * fp_get_pollfds:
 * @pollfds: output location for a list of pollfds. If non-%NULL, must be
 * released with free() when done.
 *
Daniel Drake's avatar
Daniel Drake committed
410 411
 * Retrieve a list of file descriptors that should be polled for events
 * interesting to libfprint. This function is only for users who wish to
412
 * combine libfprint's file descriptor set with other event sources – more
Daniel Drake's avatar
Daniel Drake committed
413 414 415
 * simplistic users will be able to call fp_handle_events() or a variant
 * directly.
 *
416
 * Returns: the number of pollfds in the resultant list, or negative on error.
Daniel Drake's avatar
Daniel Drake committed
417
 */
418
API_EXPORTED ssize_t fp_get_pollfds(struct fp_pollfd **pollfds)
Daniel Drake's avatar
Daniel Drake committed
419
{
420 421
	const struct libusb_pollfd **usbfds;
	const struct libusb_pollfd *usbfd;
Daniel Drake's avatar
Daniel Drake committed
422
	struct fp_pollfd *ret;
423
	ssize_t cnt = 0;
424
	size_t i = 0;
Daniel Drake's avatar
Daniel Drake committed
425

426 427
	g_return_val_if_fail (fpi_usb_ctx != NULL, -EIO);

Daniel Drake's avatar
Daniel Drake committed
428
	usbfds = libusb_get_pollfds(fpi_usb_ctx);
429
	if (!usbfds) {
Daniel Drake's avatar
Daniel Drake committed
430
		*pollfds = NULL;
431
		return -EIO;
Daniel Drake's avatar
Daniel Drake committed
432 433
	}

434 435 436 437 438
	while ((usbfd = usbfds[i++]) != NULL)
		cnt++;

	ret = g_malloc(sizeof(struct fp_pollfd) * cnt);
	i = 0;
Bastien Nocera's avatar
Bastien Nocera committed
439
	while ((usbfd = usbfds[i]) != NULL) {
440 441
		ret[i].fd = usbfd->fd;
		ret[i].events = usbfd->events;
Bastien Nocera's avatar
Bastien Nocera committed
442
		i++;
Daniel Drake's avatar
Daniel Drake committed
443 444 445 446 447 448
	}

	*pollfds = ret;
	return cnt;
}

449 450
/**
 * fp_set_pollfd_notifiers:
451 452
 * @added_cb: a #fp_pollfd_added_cb callback or %NULL
 * @removed_cb: a #fp_pollfd_removed_cb callback or %NULL
453
 *
454 455
 * This sets the callback functions to call for every new or removed
 * file descriptor used as an event source.
456
 */
Daniel Drake's avatar
Daniel Drake committed
457 458 459 460 461 462 463
API_EXPORTED void fp_set_pollfd_notifiers(fp_pollfd_added_cb added_cb,
	fp_pollfd_removed_cb removed_cb)
{
	fd_added_cb = added_cb;
	fd_removed_cb = removed_cb;
}

Daniel Drake's avatar
Daniel Drake committed
464
static void add_pollfd(int fd, short events, void *user_data)
Daniel Drake's avatar
Daniel Drake committed
465 466 467 468 469
{
	if (fd_added_cb)
		fd_added_cb(fd, events);
}

Daniel Drake's avatar
Daniel Drake committed
470
static void remove_pollfd(int fd, void *user_data)
Daniel Drake's avatar
Daniel Drake committed
471 472 473 474 475 476 477
{
	if (fd_removed_cb)
		fd_removed_cb(fd);
}

void fpi_poll_init(void)
{
Daniel Drake's avatar
Daniel Drake committed
478
	libusb_set_pollfd_notifiers(fpi_usb_ctx, add_pollfd, remove_pollfd, NULL);
Daniel Drake's avatar
Daniel Drake committed
479 480 481 482
}

void fpi_poll_exit(void)
{
483
	g_slist_free_full(active_timers, (GDestroyNotify) fpi_timeout_free);
Daniel Drake's avatar
Daniel Drake committed
484 485 486
	active_timers = NULL;
	fd_added_cb = NULL;
	fd_removed_cb = NULL;
Daniel Drake's avatar
Daniel Drake committed
487
	libusb_set_pollfd_notifiers(fpi_usb_ctx, NULL, NULL, NULL);
Daniel Drake's avatar
Daniel Drake committed
488 489
}

490
static gboolean
491 492 493 494 495
fpi_poll_is_setup(void)
{
	return (fd_added_cb != NULL && fd_removed_cb != NULL);
}

496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514
void
fpi_timeout_cancel_all_for_dev(struct fp_dev *dev)
{
	GSList *l;

	g_return_if_fail (dev != NULL);

	l = active_timers;
	while (l) {
		struct fpi_timeout *timeout = l->data;
		GSList *current = l;

		l = l->next;
		if (timeout->dev == dev) {
			g_free (timeout);
			active_timers = g_slist_delete_link (active_timers, current);
		}
	}
}