API: Add libusb_free_pollfds() function
[platform/upstream/libusb.git] / libusb / io.c
1 /* -*- Mode: C; indent-tabs-mode:t ; c-basic-offset:8 -*- */
2 /*
3  * I/O functions for libusb
4  * Copyright © 2007-2009 Daniel Drake <dsd@gentoo.org>
5  * Copyright © 2001 Johannes Erdfelt <johannes@erdfelt.com>
6  *
7  * This library is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2.1 of the License, or (at your option) any later version.
11  *
12  * This library is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with this library; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20  */
21
22 #include <config.h>
23
24 #include <assert.h>
25 #include <errno.h>
26 #include <stdint.h>
27 #include <stdlib.h>
28 #include <string.h>
29 #include <time.h>
30 #ifdef HAVE_SIGNAL_H
31 #include <signal.h>
32 #endif
33 #ifdef HAVE_SYS_TIME_H
34 #include <sys/time.h>
35 #endif
36 #ifdef USBI_TIMERFD_AVAILABLE
37 #include <sys/timerfd.h>
38 #endif
39
40 #include "libusbi.h"
41 #include "hotplug.h"
42
43 /**
44  * \page io Synchronous and asynchronous device I/O
45  *
46  * \section io_intro Introduction
47  *
48  * If you're using libusb in your application, you're probably wanting to
49  * perform I/O with devices - you want to perform USB data transfers.
50  *
51  * libusb offers two separate interfaces for device I/O. This page aims to
52  * introduce the two in order to help you decide which one is more suitable
53  * for your application. You can also choose to use both interfaces in your
54  * application by considering each transfer on a case-by-case basis.
55  *
56  * Once you have read through the following discussion, you should consult the
57  * detailed API documentation pages for the details:
58  * - \ref syncio
59  * - \ref asyncio
60  *
61  * \section theory Transfers at a logical level
62  *
63  * At a logical level, USB transfers typically happen in two parts. For
64  * example, when reading data from a endpoint:
65  * -# A request for data is sent to the device
66  * -# Some time later, the incoming data is received by the host
67  *
68  * or when writing data to an endpoint:
69  *
70  * -# The data is sent to the device
71  * -# Some time later, the host receives acknowledgement from the device that
72  *    the data has been transferred.
73  *
74  * There may be an indefinite delay between the two steps. Consider a
75  * fictional USB input device with a button that the user can press. In order
76  * to determine when the button is pressed, you would likely submit a request
77  * to read data on a bulk or interrupt endpoint and wait for data to arrive.
78  * Data will arrive when the button is pressed by the user, which is
79  * potentially hours later.
80  *
81  * libusb offers both a synchronous and an asynchronous interface to performing
82  * USB transfers. The main difference is that the synchronous interface
83  * combines both steps indicated above into a single function call, whereas
84  * the asynchronous interface separates them.
85  *
86  * \section sync The synchronous interface
87  *
88  * The synchronous I/O interface allows you to perform a USB transfer with
89  * a single function call. When the function call returns, the transfer has
90  * completed and you can parse the results.
91  *
92  * If you have used the libusb-0.1 before, this I/O style will seem familar to
93  * you. libusb-0.1 only offered a synchronous interface.
94  *
95  * In our input device example, to read button presses you might write code
96  * in the following style:
97 \code
98 unsigned char data[4];
99 int actual_length;
100 int r = libusb_bulk_transfer(handle, LIBUSB_ENDPOINT_IN, data, sizeof(data), &actual_length, 0);
101 if (r == 0 && actual_length == sizeof(data)) {
102         // results of the transaction can now be found in the data buffer
103         // parse them here and report button press
104 } else {
105         error();
106 }
107 \endcode
108  *
109  * The main advantage of this model is simplicity: you did everything with
110  * a single simple function call.
111  *
112  * However, this interface has its limitations. Your application will sleep
113  * inside libusb_bulk_transfer() until the transaction has completed. If it
114  * takes the user 3 hours to press the button, your application will be
115  * sleeping for that long. Execution will be tied up inside the library -
116  * the entire thread will be useless for that duration.
117  *
118  * Another issue is that by tieing up the thread with that single transaction
119  * there is no possibility of performing I/O with multiple endpoints and/or
120  * multiple devices simultaneously, unless you resort to creating one thread
121  * per transaction.
122  *
123  * Additionally, there is no opportunity to cancel the transfer after the
124  * request has been submitted.
125  *
126  * For details on how to use the synchronous API, see the
127  * \ref syncio "synchronous I/O API documentation" pages.
128  *
129  * \section async The asynchronous interface
130  *
131  * Asynchronous I/O is the most significant new feature in libusb-1.0.
132  * Although it is a more complex interface, it solves all the issues detailed
133  * above.
134  *
135  * Instead of providing which functions that block until the I/O has complete,
136  * libusb's asynchronous interface presents non-blocking functions which
137  * begin a transfer and then return immediately. Your application passes a
138  * callback function pointer to this non-blocking function, which libusb will
139  * call with the results of the transaction when it has completed.
140  *
141  * Transfers which have been submitted through the non-blocking functions
142  * can be cancelled with a separate function call.
143  *
144  * The non-blocking nature of this interface allows you to be simultaneously
145  * performing I/O to multiple endpoints on multiple devices, without having
146  * to use threads.
147  *
148  * This added flexibility does come with some complications though:
149  * - In the interest of being a lightweight library, libusb does not create
150  * threads and can only operate when your application is calling into it. Your
151  * application must call into libusb from it's main loop when events are ready
152  * to be handled, or you must use some other scheme to allow libusb to
153  * undertake whatever work needs to be done.
154  * - libusb also needs to be called into at certain fixed points in time in
155  * order to accurately handle transfer timeouts.
156  * - Memory handling becomes more complex. You cannot use stack memory unless
157  * the function with that stack is guaranteed not to return until the transfer
158  * callback has finished executing.
159  * - You generally lose some linearity from your code flow because submitting
160  * the transfer request is done in a separate function from where the transfer
161  * results are handled. This becomes particularly obvious when you want to
162  * submit a second transfer based on the results of an earlier transfer.
163  *
164  * Internally, libusb's synchronous interface is expressed in terms of function
165  * calls to the asynchronous interface.
166  *
167  * For details on how to use the asynchronous API, see the
168  * \ref asyncio "asynchronous I/O API" documentation pages.
169  */
170
171
172 /**
173  * \page packetoverflow Packets and overflows
174  *
175  * \section packets Packet abstraction
176  *
177  * The USB specifications describe how data is transmitted in packets, with
178  * constraints on packet size defined by endpoint descriptors. The host must
179  * not send data payloads larger than the endpoint's maximum packet size.
180  *
181  * libusb and the underlying OS abstract out the packet concept, allowing you
182  * to request transfers of any size. Internally, the request will be divided
183  * up into correctly-sized packets. You do not have to be concerned with
184  * packet sizes, but there is one exception when considering overflows.
185  *
186  * \section overflow Bulk/interrupt transfer overflows
187  *
188  * When requesting data on a bulk endpoint, libusb requires you to supply a
189  * buffer and the maximum number of bytes of data that libusb can put in that
190  * buffer. However, the size of the buffer is not communicated to the device -
191  * the device is just asked to send any amount of data.
192  *
193  * There is no problem if the device sends an amount of data that is less than
194  * or equal to the buffer size. libusb reports this condition to you through
195  * the \ref libusb_transfer::actual_length "libusb_transfer.actual_length"
196  * field.
197  *
198  * Problems may occur if the device attempts to send more data than can fit in
199  * the buffer. libusb reports LIBUSB_TRANSFER_OVERFLOW for this condition but
200  * other behaviour is largely undefined: actual_length may or may not be
201  * accurate, the chunk of data that can fit in the buffer (before overflow)
202  * may or may not have been transferred.
203  *
204  * Overflows are nasty, but can be avoided. Even though you were told to
205  * ignore packets above, think about the lower level details: each transfer is
206  * split into packets (typically small, with a maximum size of 512 bytes).
207  * Overflows can only happen if the final packet in an incoming data transfer
208  * is smaller than the actual packet that the device wants to transfer.
209  * Therefore, you will never see an overflow if your transfer buffer size is a
210  * multiple of the endpoint's packet size: the final packet will either
211  * fill up completely or will be only partially filled.
212  */
213
214 /**
215  * @defgroup asyncio Asynchronous device I/O
216  *
217  * This page details libusb's asynchronous (non-blocking) API for USB device
218  * I/O. This interface is very powerful but is also quite complex - you will
219  * need to read this page carefully to understand the necessary considerations
220  * and issues surrounding use of this interface. Simplistic applications
221  * may wish to consider the \ref syncio "synchronous I/O API" instead.
222  *
223  * The asynchronous interface is built around the idea of separating transfer
224  * submission and handling of transfer completion (the synchronous model
225  * combines both of these into one). There may be a long delay between
226  * submission and completion, however the asynchronous submission function
227  * is non-blocking so will return control to your application during that
228  * potentially long delay.
229  *
230  * \section asyncabstraction Transfer abstraction
231  *
232  * For the asynchronous I/O, libusb implements the concept of a generic
233  * transfer entity for all types of I/O (control, bulk, interrupt,
234  * isochronous). The generic transfer object must be treated slightly
235  * differently depending on which type of I/O you are performing with it.
236  *
237  * This is represented by the public libusb_transfer structure type.
238  *
239  * \section asynctrf Asynchronous transfers
240  *
241  * We can view asynchronous I/O as a 5 step process:
242  * -# <b>Allocation</b>: allocate a libusb_transfer
243  * -# <b>Filling</b>: populate the libusb_transfer instance with information
244  *    about the transfer you wish to perform
245  * -# <b>Submission</b>: ask libusb to submit the transfer
246  * -# <b>Completion handling</b>: examine transfer results in the
247  *    libusb_transfer structure
248  * -# <b>Deallocation</b>: clean up resources
249  *
250  *
251  * \subsection asyncalloc Allocation
252  *
253  * This step involves allocating memory for a USB transfer. This is the
254  * generic transfer object mentioned above. At this stage, the transfer
255  * is "blank" with no details about what type of I/O it will be used for.
256  *
257  * Allocation is done with the libusb_alloc_transfer() function. You must use
258  * this function rather than allocating your own transfers.
259  *
260  * \subsection asyncfill Filling
261  *
262  * This step is where you take a previously allocated transfer and fill it
263  * with information to determine the message type and direction, data buffer,
264  * callback function, etc.
265  *
266  * You can either fill the required fields yourself or you can use the
267  * helper functions: libusb_fill_control_transfer(), libusb_fill_bulk_transfer()
268  * and libusb_fill_interrupt_transfer().
269  *
270  * \subsection asyncsubmit Submission
271  *
272  * When you have allocated a transfer and filled it, you can submit it using
273  * libusb_submit_transfer(). This function returns immediately but can be
274  * regarded as firing off the I/O request in the background.
275  *
276  * \subsection asynccomplete Completion handling
277  *
278  * After a transfer has been submitted, one of four things can happen to it:
279  *
280  * - The transfer completes (i.e. some data was transferred)
281  * - The transfer has a timeout and the timeout expires before all data is
282  * transferred
283  * - The transfer fails due to an error
284  * - The transfer is cancelled
285  *
286  * Each of these will cause the user-specified transfer callback function to
287  * be invoked. It is up to the callback function to determine which of the
288  * above actually happened and to act accordingly.
289  *
290  * The user-specified callback is passed a pointer to the libusb_transfer
291  * structure which was used to setup and submit the transfer. At completion
292  * time, libusb has populated this structure with results of the transfer:
293  * success or failure reason, number of bytes of data transferred, etc. See
294  * the libusb_transfer structure documentation for more information.
295  *
296  * \subsection Deallocation
297  *
298  * When a transfer has completed (i.e. the callback function has been invoked),
299  * you are advised to free the transfer (unless you wish to resubmit it, see
300  * below). Transfers are deallocated with libusb_free_transfer().
301  *
302  * It is undefined behaviour to free a transfer which has not completed.
303  *
304  * \section asyncresubmit Resubmission
305  *
306  * You may be wondering why allocation, filling, and submission are all
307  * separated above where they could reasonably be combined into a single
308  * operation.
309  *
310  * The reason for separation is to allow you to resubmit transfers without
311  * having to allocate new ones every time. This is especially useful for
312  * common situations dealing with interrupt endpoints - you allocate one
313  * transfer, fill and submit it, and when it returns with results you just
314  * resubmit it for the next interrupt.
315  *
316  * \section asynccancel Cancellation
317  *
318  * Another advantage of using the asynchronous interface is that you have
319  * the ability to cancel transfers which have not yet completed. This is
320  * done by calling the libusb_cancel_transfer() function.
321  *
322  * libusb_cancel_transfer() is asynchronous/non-blocking in itself. When the
323  * cancellation actually completes, the transfer's callback function will
324  * be invoked, and the callback function should check the transfer status to
325  * determine that it was cancelled.
326  *
327  * Freeing the transfer after it has been cancelled but before cancellation
328  * has completed will result in undefined behaviour.
329  *
330  * When a transfer is cancelled, some of the data may have been transferred.
331  * libusb will communicate this to you in the transfer callback. Do not assume
332  * that no data was transferred.
333  *
334  * \section bulk_overflows Overflows on device-to-host bulk/interrupt endpoints
335  *
336  * If your device does not have predictable transfer sizes (or it misbehaves),
337  * your application may submit a request for data on an IN endpoint which is
338  * smaller than the data that the device wishes to send. In some circumstances
339  * this will cause an overflow, which is a nasty condition to deal with. See
340  * the \ref packetoverflow page for discussion.
341  *
342  * \section asyncctrl Considerations for control transfers
343  *
344  * The <tt>libusb_transfer</tt> structure is generic and hence does not
345  * include specific fields for the control-specific setup packet structure.
346  *
347  * In order to perform a control transfer, you must place the 8-byte setup
348  * packet at the start of the data buffer. To simplify this, you could
349  * cast the buffer pointer to type struct libusb_control_setup, or you can
350  * use the helper function libusb_fill_control_setup().
351  *
352  * The wLength field placed in the setup packet must be the length you would
353  * expect to be sent in the setup packet: the length of the payload that
354  * follows (or the expected maximum number of bytes to receive). However,
355  * the length field of the libusb_transfer object must be the length of
356  * the data buffer - i.e. it should be wLength <em>plus</em> the size of
357  * the setup packet (LIBUSB_CONTROL_SETUP_SIZE).
358  *
359  * If you use the helper functions, this is simplified for you:
360  * -# Allocate a buffer of size LIBUSB_CONTROL_SETUP_SIZE plus the size of the
361  * data you are sending/requesting.
362  * -# Call libusb_fill_control_setup() on the data buffer, using the transfer
363  * request size as the wLength value (i.e. do not include the extra space you
364  * allocated for the control setup).
365  * -# If this is a host-to-device transfer, place the data to be transferred
366  * in the data buffer, starting at offset LIBUSB_CONTROL_SETUP_SIZE.
367  * -# Call libusb_fill_control_transfer() to associate the data buffer with
368  * the transfer (and to set the remaining details such as callback and timeout).
369  *   - Note that there is no parameter to set the length field of the transfer.
370  *     The length is automatically inferred from the wLength field of the setup
371  *     packet.
372  * -# Submit the transfer.
373  *
374  * The multi-byte control setup fields (wValue, wIndex and wLength) must
375  * be given in little-endian byte order (the endianness of the USB bus).
376  * Endianness conversion is transparently handled by
377  * libusb_fill_control_setup() which is documented to accept host-endian
378  * values.
379  *
380  * Further considerations are needed when handling transfer completion in
381  * your callback function:
382  * - As you might expect, the setup packet will still be sitting at the start
383  * of the data buffer.
384  * - If this was a device-to-host transfer, the received data will be sitting
385  * at offset LIBUSB_CONTROL_SETUP_SIZE into the buffer.
386  * - The actual_length field of the transfer structure is relative to the
387  * wLength of the setup packet, rather than the size of the data buffer. So,
388  * if your wLength was 4, your transfer's <tt>length</tt> was 12, then you
389  * should expect an <tt>actual_length</tt> of 4 to indicate that the data was
390  * transferred in entirity.
391  *
392  * To simplify parsing of setup packets and obtaining the data from the
393  * correct offset, you may wish to use the libusb_control_transfer_get_data()
394  * and libusb_control_transfer_get_setup() functions within your transfer
395  * callback.
396  *
397  * Even though control endpoints do not halt, a completed control transfer
398  * may have a LIBUSB_TRANSFER_STALL status code. This indicates the control
399  * request was not supported.
400  *
401  * \section asyncintr Considerations for interrupt transfers
402  *
403  * All interrupt transfers are performed using the polling interval presented
404  * by the bInterval value of the endpoint descriptor.
405  *
406  * \section asynciso Considerations for isochronous transfers
407  *
408  * Isochronous transfers are more complicated than transfers to
409  * non-isochronous endpoints.
410  *
411  * To perform I/O to an isochronous endpoint, allocate the transfer by calling
412  * libusb_alloc_transfer() with an appropriate number of isochronous packets.
413  *
414  * During filling, set \ref libusb_transfer::type "type" to
415  * \ref libusb_transfer_type::LIBUSB_TRANSFER_TYPE_ISOCHRONOUS
416  * "LIBUSB_TRANSFER_TYPE_ISOCHRONOUS", and set
417  * \ref libusb_transfer::num_iso_packets "num_iso_packets" to a value less than
418  * or equal to the number of packets you requested during allocation.
419  * libusb_alloc_transfer() does not set either of these fields for you, given
420  * that you might not even use the transfer on an isochronous endpoint.
421  *
422  * Next, populate the length field for the first num_iso_packets entries in
423  * the \ref libusb_transfer::iso_packet_desc "iso_packet_desc" array. Section
424  * 5.6.3 of the USB2 specifications describe how the maximum isochronous
425  * packet length is determined by the wMaxPacketSize field in the endpoint
426  * descriptor.
427  * Two functions can help you here:
428  *
429  * - libusb_get_max_iso_packet_size() is an easy way to determine the max
430  *   packet size for an isochronous endpoint. Note that the maximum packet
431  *   size is actually the maximum number of bytes that can be transmitted in
432  *   a single microframe, therefore this function multiplies the maximum number
433  *   of bytes per transaction by the number of transaction opportunities per
434  *   microframe.
435  * - libusb_set_iso_packet_lengths() assigns the same length to all packets
436  *   within a transfer, which is usually what you want.
437  *
438  * For outgoing transfers, you'll obviously fill the buffer and populate the
439  * packet descriptors in hope that all the data gets transferred. For incoming
440  * transfers, you must ensure the buffer has sufficient capacity for
441  * the situation where all packets transfer the full amount of requested data.
442  *
443  * Completion handling requires some extra consideration. The
444  * \ref libusb_transfer::actual_length "actual_length" field of the transfer
445  * is meaningless and should not be examined; instead you must refer to the
446  * \ref libusb_iso_packet_descriptor::actual_length "actual_length" field of
447  * each individual packet.
448  *
449  * The \ref libusb_transfer::status "status" field of the transfer is also a
450  * little misleading:
451  *  - If the packets were submitted and the isochronous data microframes
452  *    completed normally, status will have value
453  *    \ref libusb_transfer_status::LIBUSB_TRANSFER_COMPLETED
454  *    "LIBUSB_TRANSFER_COMPLETED". Note that bus errors and software-incurred
455  *    delays are not counted as transfer errors; the transfer.status field may
456  *    indicate COMPLETED even if some or all of the packets failed. Refer to
457  *    the \ref libusb_iso_packet_descriptor::status "status" field of each
458  *    individual packet to determine packet failures.
459  *  - The status field will have value
460  *    \ref libusb_transfer_status::LIBUSB_TRANSFER_ERROR
461  *    "LIBUSB_TRANSFER_ERROR" only when serious errors were encountered.
462  *  - Other transfer status codes occur with normal behaviour.
463  *
464  * The data for each packet will be found at an offset into the buffer that
465  * can be calculated as if each prior packet completed in full. The
466  * libusb_get_iso_packet_buffer() and libusb_get_iso_packet_buffer_simple()
467  * functions may help you here.
468  *
469  * <b>Note</b>: Some operating systems (e.g. Linux) may impose limits on the
470  * length of individual isochronous packets and/or the total length of the
471  * isochronous transfer. Such limits can be difficult for libusb to detect,
472  * so the library will simply try and submit the transfer as set up by you.
473  * If the transfer fails to submit because it is too large,
474  * libusb_submit_transfer() will return
475  * \ref libusb_error::LIBUSB_ERROR_INVALID_PARAM "LIBUSB_ERROR_INVALID_PARAM".
476  *
477  * \section asyncmem Memory caveats
478  *
479  * In most circumstances, it is not safe to use stack memory for transfer
480  * buffers. This is because the function that fired off the asynchronous
481  * transfer may return before libusb has finished using the buffer, and when
482  * the function returns it's stack gets destroyed. This is true for both
483  * host-to-device and device-to-host transfers.
484  *
485  * The only case in which it is safe to use stack memory is where you can
486  * guarantee that the function owning the stack space for the buffer does not
487  * return until after the transfer's callback function has completed. In every
488  * other case, you need to use heap memory instead.
489  *
490  * \section asyncflags Fine control
491  *
492  * Through using this asynchronous interface, you may find yourself repeating
493  * a few simple operations many times. You can apply a bitwise OR of certain
494  * flags to a transfer to simplify certain things:
495  * - \ref libusb_transfer_flags::LIBUSB_TRANSFER_SHORT_NOT_OK
496  *   "LIBUSB_TRANSFER_SHORT_NOT_OK" results in transfers which transferred
497  *   less than the requested amount of data being marked with status
498  *   \ref libusb_transfer_status::LIBUSB_TRANSFER_ERROR "LIBUSB_TRANSFER_ERROR"
499  *   (they would normally be regarded as COMPLETED)
500  * - \ref libusb_transfer_flags::LIBUSB_TRANSFER_FREE_BUFFER
501  *   "LIBUSB_TRANSFER_FREE_BUFFER" allows you to ask libusb to free the transfer
502  *   buffer when freeing the transfer.
503  * - \ref libusb_transfer_flags::LIBUSB_TRANSFER_FREE_TRANSFER
504  *   "LIBUSB_TRANSFER_FREE_TRANSFER" causes libusb to automatically free the
505  *   transfer after the transfer callback returns.
506  *
507  * \section asyncevent Event handling
508  *
509  * An asynchronous model requires that libusb perform work at various
510  * points in time - namely processing the results of previously-submitted
511  * transfers and invoking the user-supplied callback function.
512  *
513  * This gives rise to the libusb_handle_events() function which your
514  * application must call into when libusb has work do to. This gives libusb
515  * the opportunity to reap pending transfers, invoke callbacks, etc.
516  *
517  * There are 2 different approaches to dealing with libusb_handle_events:
518  *
519  * -# Repeatedly call libusb_handle_events() in blocking mode from a dedicated
520  *    thread.
521  * -# Integrate libusb with your application's main event loop. libusb
522  *    exposes a set of file descriptors which allow you to do this.
523  *
524  * The first approach has the big advantage that it will also work on Windows
525  * were libusb' poll API for select / poll integration is not available. So
526  * if you want to support Windows and use the async API, you must use this
527  * approach, see the \ref eventthread "Using an event handling thread" section
528  * below for details.
529  *
530  * If you prefer a single threaded approach with a single central event loop,
531  * see the \ref poll "polling and timing" section for how to integrate libusb
532  * into your application's main event loop.
533  *
534  * \section eventthread Using an event handling thread
535  *
536  * Lets begin with stating the obvious: If you're going to use a separate
537  * thread for libusb event handling, your callback functions MUST be
538  * threadsafe.
539  *
540  * Other then that doing event handling from a separate thread, is mostly
541  * simple. You can use an event thread function as follows:
542 \code
543 void *event_thread_func(void *ctx)
544 {
545     while (event_thread_run)
546         libusb_handle_events(ctx);
547
548     return NULL;
549 }
550 \endcode
551  *
552  * There is one caveat though, stopping this thread requires setting the
553  * event_thread_run variable to 0, and after that libusb_handle_events() needs
554  * to return control to event_thread_func. But unless some event happens,
555  * libusb_handle_events() will not return.
556  *
557  * There are 2 different ways of dealing with this, depending on if your
558  * application uses libusb' \ref hotplug "hotplug" support or not.
559  *
560  * Applications which do not use hotplug support, should not start the event
561  * thread until after their first call to libusb_open(), and should stop the
562  * thread when closing the last open device as follows:
563 \code
564 void my_close_handle(libusb_device_handle *handle)
565 {
566     if (open_devs == 1)
567         event_thread_run = 0;
568
569     libusb_close(handle); // This wakes up libusb_handle_events()
570
571     if (open_devs == 1)
572         pthread_join(event_thread);
573
574     open_devs--;
575 }
576 \endcode
577  *
578  * Applications using hotplug support should start the thread at program init,
579  * after having successfully called libusb_hotplug_register_callback(), and
580  * should stop the thread at program exit as follows:
581 \code
582 void my_libusb_exit(void)
583
584     event_thread_run = 0;
585     libusb_hotplug_deregister_callback(ctx, hotplug_cb_handle); // This wakes up libusb_handle_events()
586     pthread_join(event_thread);
587     libusb_exit(ctx);
588 }
589 \endcode
590  */
591
592 /**
593  * @defgroup poll Polling and timing
594  *
595  * This page documents libusb's functions for polling events and timing.
596  * These functions are only necessary for users of the
597  * \ref asyncio "asynchronous API". If you are only using the simpler
598  * \ref syncio "synchronous API" then you do not need to ever call these
599  * functions.
600  *
601  * The justification for the functionality described here has already been
602  * discussed in the \ref asyncevent "event handling" section of the
603  * asynchronous API documentation. In summary, libusb does not create internal
604  * threads for event processing and hence relies on your application calling
605  * into libusb at certain points in time so that pending events can be handled.
606  *
607  * Your main loop is probably already calling poll() or select() or a
608  * variant on a set of file descriptors for other event sources (e.g. keyboard
609  * button presses, mouse movements, network sockets, etc). You then add
610  * libusb's file descriptors to your poll()/select() calls, and when activity
611  * is detected on such descriptors you know it is time to call
612  * libusb_handle_events().
613  *
614  * There is one final event handling complication. libusb supports
615  * asynchronous transfers which time out after a specified time period.
616  *
617  * On some platforms a timerfd is used, so the timeout handling is just another
618  * fd, on other platforms this requires that libusb is called into at or after
619  * the timeout to handle it. So, in addition to considering libusb's file
620  * descriptors in your main event loop, you must also consider that libusb
621  * sometimes needs to be called into at fixed points in time even when there
622  * is no file descriptor activity, see \ref polltime details.
623  * 
624  * In order to know precisely when libusb needs to be called into, libusb
625  * offers you a set of pollable file descriptors and information about when
626  * the next timeout expires.
627  *
628  * If you are using the asynchronous I/O API, you must take one of the two
629  * following options, otherwise your I/O will not complete.
630  *
631  * \section pollsimple The simple option
632  *
633  * If your application revolves solely around libusb and does not need to
634  * handle other event sources, you can have a program structure as follows:
635 \code
636 // initialize libusb
637 // find and open device
638 // maybe fire off some initial async I/O
639
640 while (user_has_not_requested_exit)
641         libusb_handle_events(ctx);
642
643 // clean up and exit
644 \endcode
645  *
646  * With such a simple main loop, you do not have to worry about managing
647  * sets of file descriptors or handling timeouts. libusb_handle_events() will
648  * handle those details internally.
649  *
650  * \section pollmain The more advanced option
651  *
652  * \note This functionality is currently only available on Unix-like platforms.
653  * On Windows, libusb_get_pollfds() simply returns NULL. Applications which
654  * want to support Windows are advised to use an \ref eventthread
655  * "event handling thread" instead.
656  *
657  * In more advanced applications, you will already have a main loop which
658  * is monitoring other event sources: network sockets, X11 events, mouse
659  * movements, etc. Through exposing a set of file descriptors, libusb is
660  * designed to cleanly integrate into such main loops.
661  *
662  * In addition to polling file descriptors for the other event sources, you
663  * take a set of file descriptors from libusb and monitor those too. When you
664  * detect activity on libusb's file descriptors, you call
665  * libusb_handle_events_timeout() in non-blocking mode.
666  *
667  * What's more, libusb may also need to handle events at specific moments in
668  * time. No file descriptor activity is generated at these times, so your
669  * own application needs to be continually aware of when the next one of these
670  * moments occurs (through calling libusb_get_next_timeout()), and then it
671  * needs to call libusb_handle_events_timeout() in non-blocking mode when
672  * these moments occur. This means that you need to adjust your
673  * poll()/select() timeout accordingly.
674  *
675  * libusb provides you with a set of file descriptors to poll and expects you
676  * to poll all of them, treating them as a single entity. The meaning of each
677  * file descriptor in the set is an internal implementation detail,
678  * platform-dependent and may vary from release to release. Don't try and
679  * interpret the meaning of the file descriptors, just do as libusb indicates,
680  * polling all of them at once.
681  *
682  * In pseudo-code, you want something that looks like:
683 \code
684 // initialise libusb
685
686 libusb_get_pollfds(ctx)
687 while (user has not requested application exit) {
688         libusb_get_next_timeout(ctx);
689         poll(on libusb file descriptors plus any other event sources of interest,
690                 using a timeout no larger than the value libusb just suggested)
691         if (poll() indicated activity on libusb file descriptors)
692                 libusb_handle_events_timeout(ctx, &zero_tv);
693         if (time has elapsed to or beyond the libusb timeout)
694                 libusb_handle_events_timeout(ctx, &zero_tv);
695         // handle events from other sources here
696 }
697
698 // clean up and exit
699 \endcode
700  *
701  * \subsection polltime Notes on time-based events
702  *
703  * The above complication with having to track time and call into libusb at
704  * specific moments is a bit of a headache. For maximum compatibility, you do
705  * need to write your main loop as above, but you may decide that you can
706  * restrict the supported platforms of your application and get away with
707  * a more simplistic scheme.
708  *
709  * These time-based event complications are \b not required on the following
710  * platforms:
711  *  - Darwin
712  *  - Linux, provided that the following version requirements are satisfied:
713  *   - Linux v2.6.27 or newer, compiled with timerfd support
714  *   - glibc v2.9 or newer
715  *   - libusb v1.0.5 or newer
716  *
717  * Under these configurations, libusb_get_next_timeout() will \em always return
718  * 0, so your main loop can be simplified to:
719 \code
720 // initialise libusb
721
722 libusb_get_pollfds(ctx)
723 while (user has not requested application exit) {
724         poll(on libusb file descriptors plus any other event sources of interest,
725                 using any timeout that you like)
726         if (poll() indicated activity on libusb file descriptors)
727                 libusb_handle_events_timeout(ctx, &zero_tv);
728         // handle events from other sources here
729 }
730
731 // clean up and exit
732 \endcode
733  *
734  * Do remember that if you simplify your main loop to the above, you will
735  * lose compatibility with some platforms (including legacy Linux platforms,
736  * and <em>any future platforms supported by libusb which may have time-based
737  * event requirements</em>). The resultant problems will likely appear as
738  * strange bugs in your application.
739  *
740  * You can use the libusb_pollfds_handle_timeouts() function to do a runtime
741  * check to see if it is safe to ignore the time-based event complications.
742  * If your application has taken the shortcut of ignoring libusb's next timeout
743  * in your main loop, then you are advised to check the return value of
744  * libusb_pollfds_handle_timeouts() during application startup, and to abort
745  * if the platform does suffer from these timing complications.
746  *
747  * \subsection fdsetchange Changes in the file descriptor set
748  *
749  * The set of file descriptors that libusb uses as event sources may change
750  * during the life of your application. Rather than having to repeatedly
751  * call libusb_get_pollfds(), you can set up notification functions for when
752  * the file descriptor set changes using libusb_set_pollfd_notifiers().
753  *
754  * \subsection mtissues Multi-threaded considerations
755  *
756  * Unfortunately, the situation is complicated further when multiple threads
757  * come into play. If two threads are monitoring the same file descriptors,
758  * the fact that only one thread will be woken up when an event occurs causes
759  * some headaches.
760  *
761  * The events lock, event waiters lock, and libusb_handle_events_locked()
762  * entities are added to solve these problems. You do not need to be concerned
763  * with these entities otherwise.
764  *
765  * See the extra documentation: \ref mtasync
766  */
767
768 /** \page mtasync Multi-threaded applications and asynchronous I/O
769  *
770  * libusb is a thread-safe library, but extra considerations must be applied
771  * to applications which interact with libusb from multiple threads.
772  *
773  * The underlying issue that must be addressed is that all libusb I/O
774  * revolves around monitoring file descriptors through the poll()/select()
775  * system calls. This is directly exposed at the
776  * \ref asyncio "asynchronous interface" but it is important to note that the
777  * \ref syncio "synchronous interface" is implemented on top of the
778  * asynchonrous interface, therefore the same considerations apply.
779  *
780  * The issue is that if two or more threads are concurrently calling poll()
781  * or select() on libusb's file descriptors then only one of those threads
782  * will be woken up when an event arrives. The others will be completely
783  * oblivious that anything has happened.
784  *
785  * Consider the following pseudo-code, which submits an asynchronous transfer
786  * then waits for its completion. This style is one way you could implement a
787  * synchronous interface on top of the asynchronous interface (and libusb
788  * does something similar, albeit more advanced due to the complications
789  * explained on this page).
790  *
791 \code
792 void cb(struct libusb_transfer *transfer)
793 {
794         int *completed = transfer->user_data;
795         *completed = 1;
796 }
797
798 void myfunc() {
799         struct libusb_transfer *transfer;
800         unsigned char buffer[LIBUSB_CONTROL_SETUP_SIZE] __attribute__ ((aligned (2)));
801         int completed = 0;
802
803         transfer = libusb_alloc_transfer(0);
804         libusb_fill_control_setup(buffer,
805                 LIBUSB_REQUEST_TYPE_VENDOR | LIBUSB_ENDPOINT_OUT, 0x04, 0x01, 0, 0);
806         libusb_fill_control_transfer(transfer, dev, buffer, cb, &completed, 1000);
807         libusb_submit_transfer(transfer);
808
809         while (!completed) {
810                 poll(libusb file descriptors, 120*1000);
811                 if (poll indicates activity)
812                         libusb_handle_events_timeout(ctx, &zero_tv);
813         }
814         printf("completed!");
815         // other code here
816 }
817 \endcode
818  *
819  * Here we are <em>serializing</em> completion of an asynchronous event
820  * against a condition - the condition being completion of a specific transfer.
821  * The poll() loop has a long timeout to minimize CPU usage during situations
822  * when nothing is happening (it could reasonably be unlimited).
823  *
824  * If this is the only thread that is polling libusb's file descriptors, there
825  * is no problem: there is no danger that another thread will swallow up the
826  * event that we are interested in. On the other hand, if there is another
827  * thread polling the same descriptors, there is a chance that it will receive
828  * the event that we were interested in. In this situation, <tt>myfunc()</tt>
829  * will only realise that the transfer has completed on the next iteration of
830  * the loop, <em>up to 120 seconds later.</em> Clearly a two-minute delay is
831  * undesirable, and don't even think about using short timeouts to circumvent
832  * this issue!
833  *
834  * The solution here is to ensure that no two threads are ever polling the
835  * file descriptors at the same time. A naive implementation of this would
836  * impact the capabilities of the library, so libusb offers the scheme
837  * documented below to ensure no loss of functionality.
838  *
839  * Before we go any further, it is worth mentioning that all libusb-wrapped
840  * event handling procedures fully adhere to the scheme documented below.
841  * This includes libusb_handle_events() and its variants, and all the
842  * synchronous I/O functions - libusb hides this headache from you.
843  *
844  * \section Using libusb_handle_events() from multiple threads
845  *
846  * Even when only using libusb_handle_events() and synchronous I/O functions,
847  * you can still have a race condition. You might be tempted to solve the
848  * above with libusb_handle_events() like so:
849  *
850 \code
851         libusb_submit_transfer(transfer);
852
853         while (!completed) {
854                 libusb_handle_events(ctx);
855         }
856         printf("completed!");
857 \endcode
858  *
859  * This however has a race between the checking of completed and
860  * libusb_handle_events() acquiring the events lock, so another thread
861  * could have completed the transfer, resulting in this thread hanging
862  * until either a timeout or another event occurs. See also commit
863  * 6696512aade99bb15d6792af90ae329af270eba6 which fixes this in the
864  * synchronous API implementation of libusb.
865  *
866  * Fixing this race requires checking the variable completed only after
867  * taking the event lock, which defeats the concept of just calling
868  * libusb_handle_events() without worrying about locking. This is why
869  * libusb-1.0.9 introduces the new libusb_handle_events_timeout_completed()
870  * and libusb_handle_events_completed() functions, which handles doing the
871  * completion check for you after they have acquired the lock:
872  *
873 \code
874         libusb_submit_transfer(transfer);
875
876         while (!completed) {
877                 libusb_handle_events_completed(ctx, &completed);
878         }
879         printf("completed!");
880 \endcode
881  *
882  * This nicely fixes the race in our example. Note that if all you want to
883  * do is submit a single transfer and wait for its completion, then using
884  * one of the synchronous I/O functions is much easier.
885  *
886  * \section eventlock The events lock
887  *
888  * The problem is when we consider the fact that libusb exposes file
889  * descriptors to allow for you to integrate asynchronous USB I/O into
890  * existing main loops, effectively allowing you to do some work behind
891  * libusb's back. If you do take libusb's file descriptors and pass them to
892  * poll()/select() yourself, you need to be aware of the associated issues.
893  *
894  * The first concept to be introduced is the events lock. The events lock
895  * is used to serialize threads that want to handle events, such that only
896  * one thread is handling events at any one time.
897  *
898  * You must take the events lock before polling libusb file descriptors,
899  * using libusb_lock_events(). You must release the lock as soon as you have
900  * aborted your poll()/select() loop, using libusb_unlock_events().
901  *
902  * \section threadwait Letting other threads do the work for you
903  *
904  * Although the events lock is a critical part of the solution, it is not
905  * enough on it's own. You might wonder if the following is sufficient...
906 \code
907         libusb_lock_events(ctx);
908         while (!completed) {
909                 poll(libusb file descriptors, 120*1000);
910                 if (poll indicates activity)
911                         libusb_handle_events_timeout(ctx, &zero_tv);
912         }
913         libusb_unlock_events(ctx);
914 \endcode
915  * ...and the answer is that it is not. This is because the transfer in the
916  * code shown above may take a long time (say 30 seconds) to complete, and
917  * the lock is not released until the transfer is completed.
918  *
919  * Another thread with similar code that wants to do event handling may be
920  * working with a transfer that completes after a few milliseconds. Despite
921  * having such a quick completion time, the other thread cannot check that
922  * status of its transfer until the code above has finished (30 seconds later)
923  * due to contention on the lock.
924  *
925  * To solve this, libusb offers you a mechanism to determine when another
926  * thread is handling events. It also offers a mechanism to block your thread
927  * until the event handling thread has completed an event (and this mechanism
928  * does not involve polling of file descriptors).
929  *
930  * After determining that another thread is currently handling events, you
931  * obtain the <em>event waiters</em> lock using libusb_lock_event_waiters().
932  * You then re-check that some other thread is still handling events, and if
933  * so, you call libusb_wait_for_event().
934  *
935  * libusb_wait_for_event() puts your application to sleep until an event
936  * occurs, or until a thread releases the events lock. When either of these
937  * things happen, your thread is woken up, and should re-check the condition
938  * it was waiting on. It should also re-check that another thread is handling
939  * events, and if not, it should start handling events itself.
940  *
941  * This looks like the following, as pseudo-code:
942 \code
943 retry:
944 if (libusb_try_lock_events(ctx) == 0) {
945         // we obtained the event lock: do our own event handling
946         while (!completed) {
947                 if (!libusb_event_handling_ok(ctx)) {
948                         libusb_unlock_events(ctx);
949                         goto retry;
950                 }
951                 poll(libusb file descriptors, 120*1000);
952                 if (poll indicates activity)
953                         libusb_handle_events_locked(ctx, 0);
954         }
955         libusb_unlock_events(ctx);
956 } else {
957         // another thread is doing event handling. wait for it to signal us that
958         // an event has completed
959         libusb_lock_event_waiters(ctx);
960
961         while (!completed) {
962                 // now that we have the event waiters lock, double check that another
963                 // thread is still handling events for us. (it may have ceased handling
964                 // events in the time it took us to reach this point)
965                 if (!libusb_event_handler_active(ctx)) {
966                         // whoever was handling events is no longer doing so, try again
967                         libusb_unlock_event_waiters(ctx);
968                         goto retry;
969                 }
970
971                 libusb_wait_for_event(ctx, NULL);
972         }
973         libusb_unlock_event_waiters(ctx);
974 }
975 printf("completed!\n");
976 \endcode
977  *
978  * A naive look at the above code may suggest that this can only support
979  * one event waiter (hence a total of 2 competing threads, the other doing
980  * event handling), because the event waiter seems to have taken the event
981  * waiters lock while waiting for an event. However, the system does support
982  * multiple event waiters, because libusb_wait_for_event() actually drops
983  * the lock while waiting, and reaquires it before continuing.
984  *
985  * We have now implemented code which can dynamically handle situations where
986  * nobody is handling events (so we should do it ourselves), and it can also
987  * handle situations where another thread is doing event handling (so we can
988  * piggyback onto them). It is also equipped to handle a combination of
989  * the two, for example, another thread is doing event handling, but for
990  * whatever reason it stops doing so before our condition is met, so we take
991  * over the event handling.
992  *
993  * Four functions were introduced in the above pseudo-code. Their importance
994  * should be apparent from the code shown above.
995  * -# libusb_try_lock_events() is a non-blocking function which attempts
996  *    to acquire the events lock but returns a failure code if it is contended.
997  * -# libusb_event_handling_ok() checks that libusb is still happy for your
998  *    thread to be performing event handling. Sometimes, libusb needs to
999  *    interrupt the event handler, and this is how you can check if you have
1000  *    been interrupted. If this function returns 0, the correct behaviour is
1001  *    for you to give up the event handling lock, and then to repeat the cycle.
1002  *    The following libusb_try_lock_events() will fail, so you will become an
1003  *    events waiter. For more information on this, read \ref fullstory below.
1004  * -# libusb_handle_events_locked() is a variant of
1005  *    libusb_handle_events_timeout() that you can call while holding the
1006  *    events lock. libusb_handle_events_timeout() itself implements similar
1007  *    logic to the above, so be sure not to call it when you are
1008  *    "working behind libusb's back", as is the case here.
1009  * -# libusb_event_handler_active() determines if someone is currently
1010  *    holding the events lock
1011  *
1012  * You might be wondering why there is no function to wake up all threads
1013  * blocked on libusb_wait_for_event(). This is because libusb can do this
1014  * internally: it will wake up all such threads when someone calls
1015  * libusb_unlock_events() or when a transfer completes (at the point after its
1016  * callback has returned).
1017  *
1018  * \subsection fullstory The full story
1019  *
1020  * The above explanation should be enough to get you going, but if you're
1021  * really thinking through the issues then you may be left with some more
1022  * questions regarding libusb's internals. If you're curious, read on, and if
1023  * not, skip to the next section to avoid confusing yourself!
1024  *
1025  * The immediate question that may spring to mind is: what if one thread
1026  * modifies the set of file descriptors that need to be polled while another
1027  * thread is doing event handling?
1028  *
1029  * There are 2 situations in which this may happen.
1030  * -# libusb_open() will add another file descriptor to the poll set,
1031  *    therefore it is desirable to interrupt the event handler so that it
1032  *    restarts, picking up the new descriptor.
1033  * -# libusb_close() will remove a file descriptor from the poll set. There
1034  *    are all kinds of race conditions that could arise here, so it is
1035  *    important that nobody is doing event handling at this time.
1036  *
1037  * libusb handles these issues internally, so application developers do not
1038  * have to stop their event handlers while opening/closing devices. Here's how
1039  * it works, focusing on the libusb_close() situation first:
1040  *
1041  * -# During initialization, libusb opens an internal pipe, and it adds the read
1042  *    end of this pipe to the set of file descriptors to be polled.
1043  * -# During libusb_close(), libusb writes some dummy data on this event pipe.
1044  *    This immediately interrupts the event handler. libusb also records
1045  *    internally that it is trying to interrupt event handlers for this
1046  *    high-priority event.
1047  * -# At this point, some of the functions described above start behaving
1048  *    differently:
1049  *   - libusb_event_handling_ok() starts returning 1, indicating that it is NOT
1050  *     OK for event handling to continue.
1051  *   - libusb_try_lock_events() starts returning 1, indicating that another
1052  *     thread holds the event handling lock, even if the lock is uncontended.
1053  *   - libusb_event_handler_active() starts returning 1, indicating that
1054  *     another thread is doing event handling, even if that is not true.
1055  * -# The above changes in behaviour result in the event handler stopping and
1056  *    giving up the events lock very quickly, giving the high-priority
1057  *    libusb_close() operation a "free ride" to acquire the events lock. All
1058  *    threads that are competing to do event handling become event waiters.
1059  * -# With the events lock held inside libusb_close(), libusb can safely remove
1060  *    a file descriptor from the poll set, in the safety of knowledge that
1061  *    nobody is polling those descriptors or trying to access the poll set.
1062  * -# After obtaining the events lock, the close operation completes very
1063  *    quickly (usually a matter of milliseconds) and then immediately releases
1064  *    the events lock.
1065  * -# At the same time, the behaviour of libusb_event_handling_ok() and friends
1066  *    reverts to the original, documented behaviour.
1067  * -# The release of the events lock causes the threads that are waiting for
1068  *    events to be woken up and to start competing to become event handlers
1069  *    again. One of them will succeed; it will then re-obtain the list of poll
1070  *    descriptors, and USB I/O will then continue as normal.
1071  *
1072  * libusb_open() is similar, and is actually a more simplistic case. Upon a
1073  * call to libusb_open():
1074  *
1075  * -# The device is opened and a file descriptor is added to the poll set.
1076  * -# libusb sends some dummy data on the event pipe, and records that it
1077  *    is trying to modify the poll descriptor set.
1078  * -# The event handler is interrupted, and the same behaviour change as for
1079  *    libusb_close() takes effect, causing all event handling threads to become
1080  *    event waiters.
1081  * -# The libusb_open() implementation takes its free ride to the events lock.
1082  * -# Happy that it has successfully paused the events handler, libusb_open()
1083  *    releases the events lock.
1084  * -# The event waiter threads are all woken up and compete to become event
1085  *    handlers again. The one that succeeds will obtain the list of poll
1086  *    descriptors again, which will include the addition of the new device.
1087  *
1088  * \subsection concl Closing remarks
1089  *
1090  * The above may seem a little complicated, but hopefully I have made it clear
1091  * why such complications are necessary. Also, do not forget that this only
1092  * applies to applications that take libusb's file descriptors and integrate
1093  * them into their own polling loops.
1094  *
1095  * You may decide that it is OK for your multi-threaded application to ignore
1096  * some of the rules and locks detailed above, because you don't think that
1097  * two threads can ever be polling the descriptors at the same time. If that
1098  * is the case, then that's good news for you because you don't have to worry.
1099  * But be careful here; remember that the synchronous I/O functions do event
1100  * handling internally. If you have one thread doing event handling in a loop
1101  * (without implementing the rules and locking semantics documented above)
1102  * and another trying to send a synchronous USB transfer, you will end up with
1103  * two threads monitoring the same descriptors, and the above-described
1104  * undesirable behaviour occuring. The solution is for your polling thread to
1105  * play by the rules; the synchronous I/O functions do so, and this will result
1106  * in them getting along in perfect harmony.
1107  *
1108  * If you do have a dedicated thread doing event handling, it is perfectly
1109  * legal for it to take the event handling lock for long periods of time. Any
1110  * synchronous I/O functions you call from other threads will transparently
1111  * fall back to the "event waiters" mechanism detailed above. The only
1112  * consideration that your event handling thread must apply is the one related
1113  * to libusb_event_handling_ok(): you must call this before every poll(), and
1114  * give up the events lock if instructed.
1115  */
1116
1117 int usbi_io_init(struct libusb_context *ctx)
1118 {
1119         int r;
1120
1121         usbi_mutex_init(&ctx->flying_transfers_lock, NULL);
1122         usbi_mutex_init_recursive(&ctx->events_lock, NULL);
1123         usbi_mutex_init(&ctx->event_waiters_lock, NULL);
1124         usbi_cond_init(&ctx->event_waiters_cond, NULL);
1125         usbi_mutex_init(&ctx->event_data_lock, NULL);
1126         list_init(&ctx->flying_transfers);
1127         list_init(&ctx->ipollfds);
1128         list_init(&ctx->hotplug_msgs);
1129         list_init(&ctx->completed_transfers);
1130
1131         /* FIXME should use an eventfd on kernels that support it */
1132         r = usbi_pipe(ctx->event_pipe);
1133         if (r < 0) {
1134                 r = LIBUSB_ERROR_OTHER;
1135                 goto err;
1136         }
1137
1138         r = usbi_add_pollfd(ctx, ctx->event_pipe[0], POLLIN);
1139         if (r < 0)
1140                 goto err_close_pipe;
1141
1142 #ifdef USBI_TIMERFD_AVAILABLE
1143         ctx->timerfd = timerfd_create(usbi_backend->get_timerfd_clockid(),
1144                 TFD_NONBLOCK);
1145         if (ctx->timerfd >= 0) {
1146                 usbi_dbg("using timerfd for timeouts");
1147                 r = usbi_add_pollfd(ctx, ctx->timerfd, POLLIN);
1148                 if (r < 0)
1149                         goto err_close_timerfd;
1150         } else {
1151                 usbi_dbg("timerfd not available (code %d error %d)", ctx->timerfd, errno);
1152                 ctx->timerfd = -1;
1153         }
1154 #endif
1155
1156         return 0;
1157
1158 #ifdef USBI_TIMERFD_AVAILABLE
1159 err_close_timerfd:
1160         close(ctx->timerfd);
1161         usbi_remove_pollfd(ctx, ctx->event_pipe[0]);
1162 #endif
1163 err_close_pipe:
1164         usbi_close(ctx->event_pipe[0]);
1165         usbi_close(ctx->event_pipe[1]);
1166 err:
1167         usbi_mutex_destroy(&ctx->flying_transfers_lock);
1168         usbi_mutex_destroy(&ctx->events_lock);
1169         usbi_mutex_destroy(&ctx->event_waiters_lock);
1170         usbi_cond_destroy(&ctx->event_waiters_cond);
1171         usbi_mutex_destroy(&ctx->event_data_lock);
1172         return r;
1173 }
1174
1175 void usbi_io_exit(struct libusb_context *ctx)
1176 {
1177         usbi_remove_pollfd(ctx, ctx->event_pipe[0]);
1178         usbi_close(ctx->event_pipe[0]);
1179         usbi_close(ctx->event_pipe[1]);
1180 #ifdef USBI_TIMERFD_AVAILABLE
1181         if (usbi_using_timerfd(ctx)) {
1182                 usbi_remove_pollfd(ctx, ctx->timerfd);
1183                 close(ctx->timerfd);
1184         }
1185 #endif
1186         usbi_mutex_destroy(&ctx->flying_transfers_lock);
1187         usbi_mutex_destroy(&ctx->events_lock);
1188         usbi_mutex_destroy(&ctx->event_waiters_lock);
1189         usbi_cond_destroy(&ctx->event_waiters_cond);
1190         usbi_mutex_destroy(&ctx->event_data_lock);
1191         if (ctx->pollfds)
1192                 free(ctx->pollfds);
1193 }
1194
1195 static int calculate_timeout(struct usbi_transfer *transfer)
1196 {
1197         int r;
1198         struct timespec current_time;
1199         unsigned int timeout =
1200                 USBI_TRANSFER_TO_LIBUSB_TRANSFER(transfer)->timeout;
1201
1202         if (!timeout)
1203                 return 0;
1204
1205         r = usbi_backend->clock_gettime(USBI_CLOCK_MONOTONIC, &current_time);
1206         if (r < 0) {
1207                 usbi_err(ITRANSFER_CTX(transfer),
1208                         "failed to read monotonic clock, errno=%d", errno);
1209                 return r;
1210         }
1211
1212         current_time.tv_sec += timeout / 1000;
1213         current_time.tv_nsec += (timeout % 1000) * 1000000;
1214
1215         while (current_time.tv_nsec >= 1000000000) {
1216                 current_time.tv_nsec -= 1000000000;
1217                 current_time.tv_sec++;
1218         }
1219
1220         TIMESPEC_TO_TIMEVAL(&transfer->timeout, &current_time);
1221         return 0;
1222 }
1223
1224 /** \ingroup asyncio
1225  * Allocate a libusb transfer with a specified number of isochronous packet
1226  * descriptors. The returned transfer is pre-initialized for you. When the new
1227  * transfer is no longer needed, it should be freed with
1228  * libusb_free_transfer().
1229  *
1230  * Transfers intended for non-isochronous endpoints (e.g. control, bulk,
1231  * interrupt) should specify an iso_packets count of zero.
1232  *
1233  * For transfers intended for isochronous endpoints, specify an appropriate
1234  * number of packet descriptors to be allocated as part of the transfer.
1235  * The returned transfer is not specially initialized for isochronous I/O;
1236  * you are still required to set the
1237  * \ref libusb_transfer::num_iso_packets "num_iso_packets" and
1238  * \ref libusb_transfer::type "type" fields accordingly.
1239  *
1240  * It is safe to allocate a transfer with some isochronous packets and then
1241  * use it on a non-isochronous endpoint. If you do this, ensure that at time
1242  * of submission, num_iso_packets is 0 and that type is set appropriately.
1243  *
1244  * \param iso_packets number of isochronous packet descriptors to allocate
1245  * \returns a newly allocated transfer, or NULL on error
1246  */
1247 DEFAULT_VISIBILITY
1248 struct libusb_transfer * LIBUSB_CALL libusb_alloc_transfer(
1249         int iso_packets)
1250 {
1251         struct libusb_transfer *transfer;
1252         size_t os_alloc_size = usbi_backend->transfer_priv_size;
1253         size_t alloc_size = sizeof(struct usbi_transfer)
1254                 + sizeof(struct libusb_transfer)
1255                 + (sizeof(struct libusb_iso_packet_descriptor) * iso_packets)
1256                 + os_alloc_size;
1257         struct usbi_transfer *itransfer = calloc(1, alloc_size);
1258         if (!itransfer)
1259                 return NULL;
1260
1261         itransfer->num_iso_packets = iso_packets;
1262         usbi_mutex_init(&itransfer->lock, NULL);
1263         usbi_mutex_init(&itransfer->flags_lock, NULL);
1264         transfer = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
1265         usbi_dbg("transfer %p", transfer);
1266         return transfer;
1267 }
1268
1269 /** \ingroup asyncio
1270  * Free a transfer structure. This should be called for all transfers
1271  * allocated with libusb_alloc_transfer().
1272  *
1273  * If the \ref libusb_transfer_flags::LIBUSB_TRANSFER_FREE_BUFFER
1274  * "LIBUSB_TRANSFER_FREE_BUFFER" flag is set and the transfer buffer is
1275  * non-NULL, this function will also free the transfer buffer using the
1276  * standard system memory allocator (e.g. free()).
1277  *
1278  * It is legal to call this function with a NULL transfer. In this case,
1279  * the function will simply return safely.
1280  *
1281  * It is not legal to free an active transfer (one which has been submitted
1282  * and has not yet completed).
1283  *
1284  * \param transfer the transfer to free
1285  */
1286 void API_EXPORTED libusb_free_transfer(struct libusb_transfer *transfer)
1287 {
1288         struct usbi_transfer *itransfer;
1289         if (!transfer)
1290                 return;
1291
1292         usbi_dbg("transfer %p", transfer);
1293         if (transfer->flags & LIBUSB_TRANSFER_FREE_BUFFER && transfer->buffer)
1294                 free(transfer->buffer);
1295
1296         itransfer = LIBUSB_TRANSFER_TO_USBI_TRANSFER(transfer);
1297         usbi_mutex_destroy(&itransfer->lock);
1298         usbi_mutex_destroy(&itransfer->flags_lock);
1299         free(itransfer);
1300 }
1301
1302 #ifdef USBI_TIMERFD_AVAILABLE
1303 static int disarm_timerfd(struct libusb_context *ctx)
1304 {
1305         const struct itimerspec disarm_timer = { { 0, 0 }, { 0, 0 } };
1306         int r;
1307
1308         usbi_dbg("");
1309         r = timerfd_settime(ctx->timerfd, 0, &disarm_timer, NULL);
1310         if (r < 0)
1311                 return LIBUSB_ERROR_OTHER;
1312         else
1313                 return 0;
1314 }
1315
1316 /* iterates through the flying transfers, and rearms the timerfd based on the
1317  * next upcoming timeout.
1318  * must be called with flying_list locked.
1319  * returns 0 if there was no timeout to arm, 1 if the next timeout was armed,
1320  * or a LIBUSB_ERROR code on failure.
1321  */
1322 static int arm_timerfd_for_next_timeout(struct libusb_context *ctx)
1323 {
1324         struct usbi_transfer *transfer;
1325
1326         list_for_each_entry(transfer, &ctx->flying_transfers, list, struct usbi_transfer) {
1327                 struct timeval *cur_tv = &transfer->timeout;
1328
1329                 /* if we've reached transfers of infinite timeout, then we have no
1330                  * arming to do */
1331                 if (!timerisset(cur_tv))
1332                         goto disarm;
1333
1334                 /* act on first transfer that is not already cancelled */
1335                 if (!(transfer->flags & USBI_TRANSFER_TIMED_OUT)) {
1336                         int r;
1337                         const struct itimerspec it = { {0, 0},
1338                                 { cur_tv->tv_sec, cur_tv->tv_usec * 1000 } };
1339                         usbi_dbg("next timeout originally %dms", USBI_TRANSFER_TO_LIBUSB_TRANSFER(transfer)->timeout);
1340                         r = timerfd_settime(ctx->timerfd, TFD_TIMER_ABSTIME, &it, NULL);
1341                         if (r < 0)
1342                                 return LIBUSB_ERROR_OTHER;
1343                         return 1;
1344                 }
1345         }
1346
1347 disarm:
1348         return disarm_timerfd(ctx);
1349 }
1350 #else
1351 static int arm_timerfd_for_next_timeout(struct libusb_context *ctx)
1352 {
1353         (void)ctx;
1354         return 0;
1355 }
1356 #endif
1357
1358 /* add a transfer to the (timeout-sorted) active transfers list.
1359  * This function will return non 0 if fails to update the timer,
1360  * in which case the transfer is *not* on the flying_transfers list. */
1361 static int add_to_flying_list(struct usbi_transfer *transfer)
1362 {
1363         struct usbi_transfer *cur;
1364         struct timeval *timeout = &transfer->timeout;
1365         struct libusb_context *ctx = ITRANSFER_CTX(transfer);
1366         int r = 0;
1367         int first = 1;
1368
1369         usbi_mutex_lock(&ctx->flying_transfers_lock);
1370
1371         /* if we have no other flying transfers, start the list with this one */
1372         if (list_empty(&ctx->flying_transfers)) {
1373                 list_add(&transfer->list, &ctx->flying_transfers);
1374                 goto out;
1375         }
1376
1377         /* if we have infinite timeout, append to end of list */
1378         if (!timerisset(timeout)) {
1379                 list_add_tail(&transfer->list, &ctx->flying_transfers);
1380                 /* first is irrelevant in this case */
1381                 goto out;
1382         }
1383
1384         /* otherwise, find appropriate place in list */
1385         list_for_each_entry(cur, &ctx->flying_transfers, list, struct usbi_transfer) {
1386                 /* find first timeout that occurs after the transfer in question */
1387                 struct timeval *cur_tv = &cur->timeout;
1388
1389                 if (!timerisset(cur_tv) || (cur_tv->tv_sec > timeout->tv_sec) ||
1390                                 (cur_tv->tv_sec == timeout->tv_sec &&
1391                                         cur_tv->tv_usec > timeout->tv_usec)) {
1392                         list_add_tail(&transfer->list, &cur->list);
1393                         goto out;
1394                 }
1395                 first = 0;
1396         }
1397         /* first is 0 at this stage (list not empty) */
1398
1399         /* otherwise we need to be inserted at the end */
1400         list_add_tail(&transfer->list, &ctx->flying_transfers);
1401 out:
1402 #ifdef USBI_TIMERFD_AVAILABLE
1403         if (first && usbi_using_timerfd(ctx) && timerisset(timeout)) {
1404                 /* if this transfer has the lowest timeout of all active transfers,
1405                  * rearm the timerfd with this transfer's timeout */
1406                 const struct itimerspec it = { {0, 0},
1407                         { timeout->tv_sec, timeout->tv_usec * 1000 } };
1408                 usbi_dbg("arm timerfd for timeout in %dms (first in line)",
1409                         USBI_TRANSFER_TO_LIBUSB_TRANSFER(transfer)->timeout);
1410                 r = timerfd_settime(ctx->timerfd, TFD_TIMER_ABSTIME, &it, NULL);
1411                 if (r < 0) {
1412                         usbi_warn(ctx, "failed to arm first timerfd (errno %d)", errno);
1413                         r = LIBUSB_ERROR_OTHER;
1414                 }
1415         }
1416 #else
1417         UNUSED(first);
1418 #endif
1419
1420         if (r)
1421                 list_del(&transfer->list);
1422
1423         usbi_mutex_unlock(&ctx->flying_transfers_lock);
1424         return r;
1425 }
1426
1427 /* remove a transfer from the active transfers list.
1428  * This function will *always* remove the transfer from the
1429  * flying_transfers list. It will return non 0 if it fails to
1430  * update the timer for the next timeout. */
1431 static int remove_from_flying_list(struct usbi_transfer *transfer)
1432 {
1433         struct libusb_context *ctx = ITRANSFER_CTX(transfer);
1434         int rearm_timerfd;
1435         int r = 0;
1436
1437         usbi_mutex_lock(&ctx->flying_transfers_lock);
1438         rearm_timerfd = (timerisset(&transfer->timeout) &&
1439                 list_first_entry(&ctx->flying_transfers, struct usbi_transfer, list) == transfer);
1440         list_del(&transfer->list);
1441         if (usbi_using_timerfd(ctx) && rearm_timerfd)
1442                 r = arm_timerfd_for_next_timeout(ctx);
1443         usbi_mutex_unlock(&ctx->flying_transfers_lock);
1444
1445         return r;
1446 }
1447
1448 /** \ingroup asyncio
1449  * Submit a transfer. This function will fire off the USB transfer and then
1450  * return immediately.
1451  *
1452  * \param transfer the transfer to submit
1453  * \returns 0 on success
1454  * \returns LIBUSB_ERROR_NO_DEVICE if the device has been disconnected
1455  * \returns LIBUSB_ERROR_BUSY if the transfer has already been submitted.
1456  * \returns LIBUSB_ERROR_NOT_SUPPORTED if the transfer flags are not supported
1457  * by the operating system.
1458  * \returns another LIBUSB_ERROR code on other failure
1459  */
1460 int API_EXPORTED libusb_submit_transfer(struct libusb_transfer *transfer)
1461 {
1462         struct usbi_transfer *itransfer =
1463                 LIBUSB_TRANSFER_TO_USBI_TRANSFER(transfer);
1464         int remove = 0;
1465         int r;
1466
1467         usbi_dbg("transfer %p", transfer);
1468         usbi_mutex_lock(&itransfer->lock);
1469         usbi_mutex_lock(&itransfer->flags_lock);
1470         if (itransfer->flags & USBI_TRANSFER_IN_FLIGHT) {
1471                 r = LIBUSB_ERROR_BUSY;
1472                 goto out;
1473         }
1474         itransfer->transferred = 0;
1475         itransfer->flags = 0;
1476         r = calculate_timeout(itransfer);
1477         if (r < 0) {
1478                 r = LIBUSB_ERROR_OTHER;
1479                 goto out;
1480         }
1481         itransfer->flags |= USBI_TRANSFER_SUBMITTING;
1482         usbi_mutex_unlock(&itransfer->flags_lock);
1483
1484         r = add_to_flying_list(itransfer);
1485         if (r) {
1486                 usbi_mutex_lock(&itransfer->flags_lock);
1487                 itransfer->flags = 0;
1488                 goto out;
1489         }
1490
1491         /* keep a reference to this device */
1492         libusb_ref_device(transfer->dev_handle->dev);
1493         r = usbi_backend->submit_transfer(itransfer);
1494
1495         usbi_mutex_lock(&itransfer->flags_lock);
1496         itransfer->flags &= ~USBI_TRANSFER_SUBMITTING;
1497         if (r == LIBUSB_SUCCESS) {
1498                 /* check for two possible special conditions:
1499                  *   1) device disconnect occurred immediately after submission
1500                  *   2) transfer completed before we got here to update the flags
1501                  */
1502                 if (itransfer->flags & USBI_TRANSFER_DEVICE_DISAPPEARED) {
1503                         usbi_backend->clear_transfer_priv(itransfer);
1504                         remove = 1;
1505                         r = LIBUSB_ERROR_NO_DEVICE;
1506                 }
1507                 else if (!(itransfer->flags & USBI_TRANSFER_COMPLETED)) {
1508                         itransfer->flags |= USBI_TRANSFER_IN_FLIGHT;
1509                 }
1510         } else {
1511                 remove = 1;
1512         }
1513 out:
1514         usbi_mutex_unlock(&itransfer->flags_lock);
1515         if (remove) {
1516                 libusb_unref_device(transfer->dev_handle->dev);
1517                 remove_from_flying_list(itransfer);
1518         }
1519         usbi_mutex_unlock(&itransfer->lock);
1520         return r;
1521 }
1522
1523 /** \ingroup asyncio
1524  * Asynchronously cancel a previously submitted transfer.
1525  * This function returns immediately, but this does not indicate cancellation
1526  * is complete. Your callback function will be invoked at some later time
1527  * with a transfer status of
1528  * \ref libusb_transfer_status::LIBUSB_TRANSFER_CANCELLED
1529  * "LIBUSB_TRANSFER_CANCELLED."
1530  *
1531  * \param transfer the transfer to cancel
1532  * \returns 0 on success
1533  * \returns LIBUSB_ERROR_NOT_FOUND if the transfer is not in progress,
1534  * already complete, or already cancelled.
1535  * \returns a LIBUSB_ERROR code on failure
1536  */
1537 int API_EXPORTED libusb_cancel_transfer(struct libusb_transfer *transfer)
1538 {
1539         struct usbi_transfer *itransfer =
1540                 LIBUSB_TRANSFER_TO_USBI_TRANSFER(transfer);
1541         int r;
1542
1543         usbi_dbg("transfer %p", transfer );
1544         usbi_mutex_lock(&itransfer->lock);
1545         usbi_mutex_lock(&itransfer->flags_lock);
1546         if (!(itransfer->flags & USBI_TRANSFER_IN_FLIGHT)
1547                         || (itransfer->flags & USBI_TRANSFER_CANCELLING)) {
1548                 r = LIBUSB_ERROR_NOT_FOUND;
1549                 goto out;
1550         }
1551         r = usbi_backend->cancel_transfer(itransfer);
1552         if (r < 0) {
1553                 if (r != LIBUSB_ERROR_NOT_FOUND &&
1554                     r != LIBUSB_ERROR_NO_DEVICE)
1555                         usbi_err(TRANSFER_CTX(transfer),
1556                                 "cancel transfer failed error %d", r);
1557                 else
1558                         usbi_dbg("cancel transfer failed error %d", r);
1559
1560                 if (r == LIBUSB_ERROR_NO_DEVICE)
1561                         itransfer->flags |= USBI_TRANSFER_DEVICE_DISAPPEARED;
1562         }
1563
1564         itransfer->flags |= USBI_TRANSFER_CANCELLING;
1565
1566 out:
1567         usbi_mutex_unlock(&itransfer->flags_lock);
1568         usbi_mutex_unlock(&itransfer->lock);
1569         return r;
1570 }
1571
1572 /** \ingroup asyncio
1573  * Set a transfers bulk stream id. Note users are advised to use
1574  * libusb_fill_bulk_stream_transfer() instead of calling this function
1575  * directly.
1576  *
1577  * Since version 1.0.19, \ref LIBUSB_API_VERSION >= 0x01000103
1578  *
1579  * \param transfer the transfer to set the stream id for
1580  * \param stream_id the stream id to set
1581  * \see libusb_alloc_streams()
1582  */
1583 void API_EXPORTED libusb_transfer_set_stream_id(
1584         struct libusb_transfer *transfer, uint32_t stream_id)
1585 {
1586         struct usbi_transfer *itransfer =
1587                 LIBUSB_TRANSFER_TO_USBI_TRANSFER(transfer);
1588
1589         itransfer->stream_id = stream_id;
1590 }
1591
1592 /** \ingroup asyncio
1593  * Get a transfers bulk stream id.
1594  *
1595  * Since version 1.0.19, \ref LIBUSB_API_VERSION >= 0x01000103
1596  *
1597  * \param transfer the transfer to get the stream id for
1598  * \returns the stream id for the transfer
1599  */
1600 uint32_t API_EXPORTED libusb_transfer_get_stream_id(
1601         struct libusb_transfer *transfer)
1602 {
1603         struct usbi_transfer *itransfer =
1604                 LIBUSB_TRANSFER_TO_USBI_TRANSFER(transfer);
1605
1606         return itransfer->stream_id;
1607 }
1608
1609 /* Handle completion of a transfer (completion might be an error condition).
1610  * This will invoke the user-supplied callback function, which may end up
1611  * freeing the transfer. Therefore you cannot use the transfer structure
1612  * after calling this function, and you should free all backend-specific
1613  * data before calling it.
1614  * Do not call this function with the usbi_transfer lock held. User-specified
1615  * callback functions may attempt to directly resubmit the transfer, which
1616  * will attempt to take the lock. */
1617 int usbi_handle_transfer_completion(struct usbi_transfer *itransfer,
1618         enum libusb_transfer_status status)
1619 {
1620         struct libusb_transfer *transfer =
1621                 USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
1622         struct libusb_device_handle *handle = transfer->dev_handle;
1623         uint8_t flags;
1624         int r;
1625
1626         r = remove_from_flying_list(itransfer);
1627         if (r)
1628                 return r;
1629
1630         usbi_mutex_lock(&itransfer->flags_lock);
1631         itransfer->flags &= ~USBI_TRANSFER_IN_FLIGHT;
1632         itransfer->flags |= USBI_TRANSFER_COMPLETED;
1633         usbi_mutex_unlock(&itransfer->flags_lock);
1634
1635         if (status == LIBUSB_TRANSFER_COMPLETED
1636                         && transfer->flags & LIBUSB_TRANSFER_SHORT_NOT_OK) {
1637                 int rqlen = transfer->length;
1638                 if (transfer->type == LIBUSB_TRANSFER_TYPE_CONTROL)
1639                         rqlen -= LIBUSB_CONTROL_SETUP_SIZE;
1640                 if (rqlen != itransfer->transferred) {
1641                         usbi_dbg("interpreting short transfer as error");
1642                         status = LIBUSB_TRANSFER_ERROR;
1643                 }
1644         }
1645
1646         flags = transfer->flags;
1647         transfer->status = status;
1648         transfer->actual_length = itransfer->transferred;
1649         usbi_dbg("transfer %p has callback %p", transfer, transfer->callback);
1650         if (transfer->callback)
1651                 transfer->callback(transfer);
1652         /* transfer might have been freed by the above call, do not use from
1653          * this point. */
1654         if (flags & LIBUSB_TRANSFER_FREE_TRANSFER)
1655                 libusb_free_transfer(transfer);
1656         libusb_unref_device(handle->dev);
1657         return 0;
1658 }
1659
1660 /* Similar to usbi_handle_transfer_completion() but exclusively for transfers
1661  * that were asynchronously cancelled. The same concerns w.r.t. freeing of
1662  * transfers exist here.
1663  * Do not call this function with the usbi_transfer lock held. User-specified
1664  * callback functions may attempt to directly resubmit the transfer, which
1665  * will attempt to take the lock. */
1666 int usbi_handle_transfer_cancellation(struct usbi_transfer *transfer)
1667 {
1668         /* if the URB was cancelled due to timeout, report timeout to the user */
1669         if (transfer->flags & USBI_TRANSFER_TIMED_OUT) {
1670                 usbi_dbg("detected timeout cancellation");
1671                 return usbi_handle_transfer_completion(transfer, LIBUSB_TRANSFER_TIMED_OUT);
1672         }
1673
1674         /* otherwise its a normal async cancel */
1675         return usbi_handle_transfer_completion(transfer, LIBUSB_TRANSFER_CANCELLED);
1676 }
1677
1678 /* Add a completed transfer to the completed_transfers list of the
1679  * context and signal the event. The backend's handle_transfer_completion()
1680  * function will be called the next time an event handler runs. */
1681 void usbi_signal_transfer_completion(struct usbi_transfer *transfer)
1682 {
1683         struct libusb_context *ctx = ITRANSFER_CTX(transfer);
1684         int pending_events;
1685
1686         usbi_mutex_lock(&ctx->event_data_lock);
1687         pending_events = usbi_pending_events(ctx);
1688         list_add_tail(&transfer->completed_list, &ctx->completed_transfers);
1689         if (!pending_events)
1690                 usbi_signal_event(ctx);
1691         usbi_mutex_unlock(&ctx->event_data_lock);
1692 }
1693
1694 /** \ingroup poll
1695  * Attempt to acquire the event handling lock. This lock is used to ensure that
1696  * only one thread is monitoring libusb event sources at any one time.
1697  *
1698  * You only need to use this lock if you are developing an application
1699  * which calls poll() or select() on libusb's file descriptors directly.
1700  * If you stick to libusb's event handling loop functions (e.g.
1701  * libusb_handle_events()) then you do not need to be concerned with this
1702  * locking.
1703  *
1704  * While holding this lock, you are trusted to actually be handling events.
1705  * If you are no longer handling events, you must call libusb_unlock_events()
1706  * as soon as possible.
1707  *
1708  * \param ctx the context to operate on, or NULL for the default context
1709  * \returns 0 if the lock was obtained successfully
1710  * \returns 1 if the lock was not obtained (i.e. another thread holds the lock)
1711  * \ref mtasync
1712  */
1713 int API_EXPORTED libusb_try_lock_events(libusb_context *ctx)
1714 {
1715         int r;
1716         unsigned int ru;
1717         USBI_GET_CONTEXT(ctx);
1718
1719         /* is someone else waiting to close a device? if so, don't let this thread
1720          * start event handling */
1721         usbi_mutex_lock(&ctx->event_data_lock);
1722         ru = ctx->device_close;
1723         usbi_mutex_unlock(&ctx->event_data_lock);
1724         if (ru) {
1725                 usbi_dbg("someone else is closing a device");
1726                 return 1;
1727         }
1728
1729         r = usbi_mutex_trylock(&ctx->events_lock);
1730         if (r)
1731                 return 1;
1732
1733         ctx->event_handler_active = 1;
1734         return 0;
1735 }
1736
1737 /** \ingroup poll
1738  * Acquire the event handling lock, blocking until successful acquisition if
1739  * it is contended. This lock is used to ensure that only one thread is
1740  * monitoring libusb event sources at any one time.
1741  *
1742  * You only need to use this lock if you are developing an application
1743  * which calls poll() or select() on libusb's file descriptors directly.
1744  * If you stick to libusb's event handling loop functions (e.g.
1745  * libusb_handle_events()) then you do not need to be concerned with this
1746  * locking.
1747  *
1748  * While holding this lock, you are trusted to actually be handling events.
1749  * If you are no longer handling events, you must call libusb_unlock_events()
1750  * as soon as possible.
1751  *
1752  * \param ctx the context to operate on, or NULL for the default context
1753  * \ref mtasync
1754  */
1755 void API_EXPORTED libusb_lock_events(libusb_context *ctx)
1756 {
1757         USBI_GET_CONTEXT(ctx);
1758         usbi_mutex_lock(&ctx->events_lock);
1759         ctx->event_handler_active = 1;
1760 }
1761
1762 /** \ingroup poll
1763  * Release the lock previously acquired with libusb_try_lock_events() or
1764  * libusb_lock_events(). Releasing this lock will wake up any threads blocked
1765  * on libusb_wait_for_event().
1766  *
1767  * \param ctx the context to operate on, or NULL for the default context
1768  * \ref mtasync
1769  */
1770 void API_EXPORTED libusb_unlock_events(libusb_context *ctx)
1771 {
1772         USBI_GET_CONTEXT(ctx);
1773         ctx->event_handler_active = 0;
1774         usbi_mutex_unlock(&ctx->events_lock);
1775
1776         /* FIXME: perhaps we should be a bit more efficient by not broadcasting
1777          * the availability of the events lock when we are modifying pollfds
1778          * (check ctx->device_close)? */
1779         usbi_mutex_lock(&ctx->event_waiters_lock);
1780         usbi_cond_broadcast(&ctx->event_waiters_cond);
1781         usbi_mutex_unlock(&ctx->event_waiters_lock);
1782 }
1783
1784 /** \ingroup poll
1785  * Determine if it is still OK for this thread to be doing event handling.
1786  *
1787  * Sometimes, libusb needs to temporarily pause all event handlers, and this
1788  * is the function you should use before polling file descriptors to see if
1789  * this is the case.
1790  *
1791  * If this function instructs your thread to give up the events lock, you
1792  * should just continue the usual logic that is documented in \ref mtasync.
1793  * On the next iteration, your thread will fail to obtain the events lock,
1794  * and will hence become an event waiter.
1795  *
1796  * This function should be called while the events lock is held: you don't
1797  * need to worry about the results of this function if your thread is not
1798  * the current event handler.
1799  *
1800  * \param ctx the context to operate on, or NULL for the default context
1801  * \returns 1 if event handling can start or continue
1802  * \returns 0 if this thread must give up the events lock
1803  * \ref fullstory "Multi-threaded I/O: the full story"
1804  */
1805 int API_EXPORTED libusb_event_handling_ok(libusb_context *ctx)
1806 {
1807         unsigned int r;
1808         USBI_GET_CONTEXT(ctx);
1809
1810         /* is someone else waiting to close a device? if so, don't let this thread
1811          * continue event handling */
1812         usbi_mutex_lock(&ctx->event_data_lock);
1813         r = ctx->device_close;
1814         usbi_mutex_unlock(&ctx->event_data_lock);
1815         if (r) {
1816                 usbi_dbg("someone else is closing a device");
1817                 return 0;
1818         }
1819
1820         return 1;
1821 }
1822
1823
1824 /** \ingroup poll
1825  * Determine if an active thread is handling events (i.e. if anyone is holding
1826  * the event handling lock).
1827  *
1828  * \param ctx the context to operate on, or NULL for the default context
1829  * \returns 1 if a thread is handling events
1830  * \returns 0 if there are no threads currently handling events
1831  * \ref mtasync
1832  */
1833 int API_EXPORTED libusb_event_handler_active(libusb_context *ctx)
1834 {
1835         unsigned int r;
1836         USBI_GET_CONTEXT(ctx);
1837
1838         /* is someone else waiting to close a device? if so, don't let this thread
1839          * start event handling -- indicate that event handling is happening */
1840         usbi_mutex_lock(&ctx->event_data_lock);
1841         r = ctx->device_close;
1842         usbi_mutex_unlock(&ctx->event_data_lock);
1843         if (r) {
1844                 usbi_dbg("someone else is closing a device");
1845                 return 1;
1846         }
1847
1848         return ctx->event_handler_active;
1849 }
1850
1851 /** \ingroup poll
1852  * Acquire the event waiters lock. This lock is designed to be obtained under
1853  * the situation where you want to be aware when events are completed, but
1854  * some other thread is event handling so calling libusb_handle_events() is not
1855  * allowed.
1856  *
1857  * You then obtain this lock, re-check that another thread is still handling
1858  * events, then call libusb_wait_for_event().
1859  *
1860  * You only need to use this lock if you are developing an application
1861  * which calls poll() or select() on libusb's file descriptors directly,
1862  * <b>and</b> may potentially be handling events from 2 threads simultaenously.
1863  * If you stick to libusb's event handling loop functions (e.g.
1864  * libusb_handle_events()) then you do not need to be concerned with this
1865  * locking.
1866  *
1867  * \param ctx the context to operate on, or NULL for the default context
1868  * \ref mtasync
1869  */
1870 void API_EXPORTED libusb_lock_event_waiters(libusb_context *ctx)
1871 {
1872         USBI_GET_CONTEXT(ctx);
1873         usbi_mutex_lock(&ctx->event_waiters_lock);
1874 }
1875
1876 /** \ingroup poll
1877  * Release the event waiters lock.
1878  * \param ctx the context to operate on, or NULL for the default context
1879  * \ref mtasync
1880  */
1881 void API_EXPORTED libusb_unlock_event_waiters(libusb_context *ctx)
1882 {
1883         USBI_GET_CONTEXT(ctx);
1884         usbi_mutex_unlock(&ctx->event_waiters_lock);
1885 }
1886
1887 /** \ingroup poll
1888  * Wait for another thread to signal completion of an event. Must be called
1889  * with the event waiters lock held, see libusb_lock_event_waiters().
1890  *
1891  * This function will block until any of the following conditions are met:
1892  * -# The timeout expires
1893  * -# A transfer completes
1894  * -# A thread releases the event handling lock through libusb_unlock_events()
1895  *
1896  * Condition 1 is obvious. Condition 2 unblocks your thread <em>after</em>
1897  * the callback for the transfer has completed. Condition 3 is important
1898  * because it means that the thread that was previously handling events is no
1899  * longer doing so, so if any events are to complete, another thread needs to
1900  * step up and start event handling.
1901  *
1902  * This function releases the event waiters lock before putting your thread
1903  * to sleep, and reacquires the lock as it is being woken up.
1904  *
1905  * \param ctx the context to operate on, or NULL for the default context
1906  * \param tv maximum timeout for this blocking function. A NULL value
1907  * indicates unlimited timeout.
1908  * \returns 0 after a transfer completes or another thread stops event handling
1909  * \returns 1 if the timeout expired
1910  * \ref mtasync
1911  */
1912 int API_EXPORTED libusb_wait_for_event(libusb_context *ctx, struct timeval *tv)
1913 {
1914         struct timespec timeout;
1915         int r;
1916
1917         USBI_GET_CONTEXT(ctx);
1918         if (tv == NULL) {
1919                 usbi_cond_wait(&ctx->event_waiters_cond, &ctx->event_waiters_lock);
1920                 return 0;
1921         }
1922
1923         r = usbi_backend->clock_gettime(USBI_CLOCK_REALTIME, &timeout);
1924         if (r < 0) {
1925                 usbi_err(ctx, "failed to read realtime clock, error %d", errno);
1926                 return LIBUSB_ERROR_OTHER;
1927         }
1928
1929         timeout.tv_sec += tv->tv_sec;
1930         timeout.tv_nsec += tv->tv_usec * 1000;
1931         while (timeout.tv_nsec >= 1000000000) {
1932                 timeout.tv_nsec -= 1000000000;
1933                 timeout.tv_sec++;
1934         }
1935
1936         r = usbi_cond_timedwait(&ctx->event_waiters_cond,
1937                 &ctx->event_waiters_lock, &timeout);
1938         return (r == ETIMEDOUT);
1939 }
1940
1941 static void handle_timeout(struct usbi_transfer *itransfer)
1942 {
1943         struct libusb_transfer *transfer =
1944                 USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
1945         int r;
1946
1947         itransfer->flags |= USBI_TRANSFER_TIMED_OUT;
1948         r = libusb_cancel_transfer(transfer);
1949         if (r < 0)
1950                 usbi_warn(TRANSFER_CTX(transfer),
1951                         "async cancel failed %d errno=%d", r, errno);
1952 }
1953
1954 static int handle_timeouts_locked(struct libusb_context *ctx)
1955 {
1956         int r;
1957         struct timespec systime_ts;
1958         struct timeval systime;
1959         struct usbi_transfer *transfer;
1960
1961         if (list_empty(&ctx->flying_transfers))
1962                 return 0;
1963
1964         /* get current time */
1965         r = usbi_backend->clock_gettime(USBI_CLOCK_MONOTONIC, &systime_ts);
1966         if (r < 0)
1967                 return r;
1968
1969         TIMESPEC_TO_TIMEVAL(&systime, &systime_ts);
1970
1971         /* iterate through flying transfers list, finding all transfers that
1972          * have expired timeouts */
1973         list_for_each_entry(transfer, &ctx->flying_transfers, list, struct usbi_transfer) {
1974                 struct timeval *cur_tv = &transfer->timeout;
1975
1976                 /* if we've reached transfers of infinite timeout, we're all done */
1977                 if (!timerisset(cur_tv))
1978                         return 0;
1979
1980                 /* ignore timeouts we've already handled */
1981                 if (transfer->flags & (USBI_TRANSFER_TIMED_OUT | USBI_TRANSFER_OS_HANDLES_TIMEOUT))
1982                         continue;
1983
1984                 /* if transfer has non-expired timeout, nothing more to do */
1985                 if ((cur_tv->tv_sec > systime.tv_sec) ||
1986                                 (cur_tv->tv_sec == systime.tv_sec &&
1987                                         cur_tv->tv_usec > systime.tv_usec))
1988                         return 0;
1989
1990                 /* otherwise, we've got an expired timeout to handle */
1991                 handle_timeout(transfer);
1992         }
1993         return 0;
1994 }
1995
1996 static int handle_timeouts(struct libusb_context *ctx)
1997 {
1998         int r;
1999         USBI_GET_CONTEXT(ctx);
2000         usbi_mutex_lock(&ctx->flying_transfers_lock);
2001         r = handle_timeouts_locked(ctx);
2002         usbi_mutex_unlock(&ctx->flying_transfers_lock);
2003         return r;
2004 }
2005
2006 #ifdef USBI_TIMERFD_AVAILABLE
2007 static int handle_timerfd_trigger(struct libusb_context *ctx)
2008 {
2009         int r;
2010
2011         usbi_mutex_lock(&ctx->flying_transfers_lock);
2012
2013         /* process the timeout that just happened */
2014         r = handle_timeouts_locked(ctx);
2015         if (r < 0)
2016                 goto out;
2017
2018         /* arm for next timeout*/
2019         r = arm_timerfd_for_next_timeout(ctx);
2020
2021 out:
2022         usbi_mutex_unlock(&ctx->flying_transfers_lock);
2023         return r;
2024 }
2025 #endif
2026
2027 /* do the actual event handling. assumes that no other thread is concurrently
2028  * doing the same thing. */
2029 static int handle_events(struct libusb_context *ctx, struct timeval *tv)
2030 {
2031         int r;
2032         struct usbi_pollfd *ipollfd;
2033         POLL_NFDS_TYPE nfds = 0;
2034         POLL_NFDS_TYPE internal_nfds;
2035         struct pollfd *fds = NULL;
2036         int i = -1;
2037         int timeout_ms;
2038         int special_event;
2039
2040         /* there are certain fds that libusb uses internally, currently:
2041          *
2042          *   1) event pipe
2043          *   2) timerfd
2044          *
2045          * the backend will never need to attempt to handle events on these fds, so
2046          * we determine how many fds are in use internally for this context and when
2047          * handle_events() is called in the backend, the pollfd list and count will
2048          * be adjusted to skip over these internal fds */
2049         if (usbi_using_timerfd(ctx))
2050                 internal_nfds = 2;
2051         else
2052                 internal_nfds = 1;
2053
2054         /* only reallocate the poll fds when the list of poll fds has been modified
2055          * since the last poll, otherwise reuse them to save the additional overhead */
2056         usbi_mutex_lock(&ctx->event_data_lock);
2057         if (ctx->pollfds_modified) {
2058                 usbi_dbg("poll fds modified, reallocating");
2059
2060                 if (ctx->pollfds) {
2061                         free(ctx->pollfds);
2062                         ctx->pollfds = NULL;
2063                 }
2064
2065                 /* sanity check - it is invalid for a context to have fewer than the
2066                  * required internal fds (memory corruption?) */
2067                 assert(ctx->pollfds_cnt >= internal_nfds);
2068
2069                 ctx->pollfds = calloc(ctx->pollfds_cnt, sizeof(*ctx->pollfds));
2070                 if (!ctx->pollfds) {
2071                         usbi_mutex_unlock(&ctx->event_data_lock);
2072                         return LIBUSB_ERROR_NO_MEM;
2073                 }
2074
2075                 list_for_each_entry(ipollfd, &ctx->ipollfds, list, struct usbi_pollfd) {
2076                         struct libusb_pollfd *pollfd = &ipollfd->pollfd;
2077                         i++;
2078                         ctx->pollfds[i].fd = pollfd->fd;
2079                         ctx->pollfds[i].events = pollfd->events;
2080                 }
2081
2082                 /* reset the flag now that we have the updated list */
2083                 ctx->pollfds_modified = 0;
2084
2085                 /* if no further pending events, clear the event pipe so that we do
2086                  * not immediately return from poll */
2087                 if (!usbi_pending_events(ctx))
2088                         usbi_clear_event(ctx);
2089         }
2090         fds = ctx->pollfds;
2091         nfds = ctx->pollfds_cnt;
2092         usbi_mutex_unlock(&ctx->event_data_lock);
2093
2094         timeout_ms = (int)(tv->tv_sec * 1000) + (tv->tv_usec / 1000);
2095
2096         /* round up to next millisecond */
2097         if (tv->tv_usec % 1000)
2098                 timeout_ms++;
2099
2100 redo_poll:
2101         usbi_dbg("poll() %d fds with timeout in %dms", nfds, timeout_ms);
2102         r = usbi_poll(fds, nfds, timeout_ms);
2103         usbi_dbg("poll() returned %d", r);
2104         if (r == 0)
2105                 return handle_timeouts(ctx);
2106         else if (r == -1 && errno == EINTR)
2107                 return LIBUSB_ERROR_INTERRUPTED;
2108         else if (r < 0) {
2109                 usbi_err(ctx, "poll failed %d err=%d", r, errno);
2110                 return LIBUSB_ERROR_IO;
2111         }
2112
2113         special_event = 0;
2114
2115         /* fds[0] is always the event pipe */
2116         if (fds[0].revents) {
2117                 libusb_hotplug_message *message = NULL;
2118                 struct usbi_transfer *itransfer;
2119                 int ret = 0;
2120
2121                 usbi_dbg("caught a fish on the event pipe");
2122
2123                 /* take the the event data lock while processing events */
2124                 usbi_mutex_lock(&ctx->event_data_lock);
2125
2126                 /* check if someone added a new poll fd */
2127                 if (ctx->pollfds_modified)
2128                         usbi_dbg("someone updated the poll fds");
2129
2130                 /* check if someone is closing a device */
2131                 if (ctx->device_close)
2132                         usbi_dbg("someone is closing a device");
2133
2134                 /* check for any pending hotplug messages */
2135                 if (!list_empty(&ctx->hotplug_msgs)) {
2136                         usbi_dbg("hotplug message received");
2137                         special_event = 1;
2138                         message = list_first_entry(&ctx->hotplug_msgs, libusb_hotplug_message, list);
2139                         list_del(&message->list);
2140                 }
2141
2142                 /* complete any pending transfers */
2143                 while (ret == 0 && !list_empty(&ctx->completed_transfers)) {
2144                         itransfer = list_first_entry(&ctx->completed_transfers, struct usbi_transfer, completed_list);
2145                         list_del(&itransfer->completed_list);
2146                         usbi_mutex_unlock(&ctx->event_data_lock);
2147                         ret = usbi_backend->handle_transfer_completion(itransfer);
2148                         if (ret)
2149                                 usbi_err(ctx, "backend handle_transfer_completion failed with error %d", ret);
2150                         usbi_mutex_lock(&ctx->event_data_lock);
2151                 }
2152
2153                 /* if no further pending events, clear the event pipe */
2154                 if (!usbi_pending_events(ctx))
2155                         usbi_clear_event(ctx);
2156
2157                 usbi_mutex_unlock(&ctx->event_data_lock);
2158
2159                 /* process the hotplug message, if any */
2160                 if (message) {
2161                         usbi_hotplug_match(ctx, message->device, message->event);
2162
2163                         /* the device left, dereference the device */
2164                         if (LIBUSB_HOTPLUG_EVENT_DEVICE_LEFT == message->event)
2165                                 libusb_unref_device(message->device);
2166
2167                         free(message);
2168                 }
2169
2170                 if (ret) {
2171                         /* return error code */
2172                         r = ret;
2173                         goto handled;
2174                 }
2175
2176                 if (0 == --r)
2177                         goto handled;
2178         }
2179
2180 #ifdef USBI_TIMERFD_AVAILABLE
2181         /* on timerfd configurations, fds[1] is the timerfd */
2182         if (usbi_using_timerfd(ctx) && fds[1].revents) {
2183                 /* timerfd indicates that a timeout has expired */
2184                 int ret;
2185                 usbi_dbg("timerfd triggered");
2186                 special_event = 1;
2187
2188                 ret = handle_timerfd_trigger(ctx);
2189                 if (ret < 0) {
2190                         /* return error code */
2191                         r = ret;
2192                         goto handled;
2193                 }
2194
2195                 if (0 == --r)
2196                         goto handled;
2197         }
2198 #endif
2199
2200         r = usbi_backend->handle_events(ctx, fds + internal_nfds, nfds - internal_nfds, r);
2201         if (r)
2202                 usbi_err(ctx, "backend handle_events failed with error %d", r);
2203
2204 handled:
2205         if (r == 0 && special_event) {
2206                 timeout_ms = 0;
2207                 goto redo_poll;
2208         }
2209
2210         return r;
2211 }
2212
2213 /* returns the smallest of:
2214  *  1. timeout of next URB
2215  *  2. user-supplied timeout
2216  * returns 1 if there is an already-expired timeout, otherwise returns 0
2217  * and populates out
2218  */
2219 static int get_next_timeout(libusb_context *ctx, struct timeval *tv,
2220         struct timeval *out)
2221 {
2222         struct timeval timeout;
2223         int r = libusb_get_next_timeout(ctx, &timeout);
2224         if (r) {
2225                 /* timeout already expired? */
2226                 if (!timerisset(&timeout))
2227                         return 1;
2228
2229                 /* choose the smallest of next URB timeout or user specified timeout */
2230                 if (timercmp(&timeout, tv, <))
2231                         *out = timeout;
2232                 else
2233                         *out = *tv;
2234         } else {
2235                 *out = *tv;
2236         }
2237         return 0;
2238 }
2239
2240 /** \ingroup poll
2241  * Handle any pending events.
2242  *
2243  * libusb determines "pending events" by checking if any timeouts have expired
2244  * and by checking the set of file descriptors for activity.
2245  *
2246  * If a zero timeval is passed, this function will handle any already-pending
2247  * events and then immediately return in non-blocking style.
2248  *
2249  * If a non-zero timeval is passed and no events are currently pending, this
2250  * function will block waiting for events to handle up until the specified
2251  * timeout. If an event arrives or a signal is raised, this function will
2252  * return early.
2253  *
2254  * If the parameter completed is not NULL then <em>after obtaining the event
2255  * handling lock</em> this function will return immediately if the integer
2256  * pointed to is not 0. This allows for race free waiting for the completion
2257  * of a specific transfer.
2258  *
2259  * \param ctx the context to operate on, or NULL for the default context
2260  * \param tv the maximum time to block waiting for events, or an all zero
2261  * timeval struct for non-blocking mode
2262  * \param completed pointer to completion integer to check, or NULL
2263  * \returns 0 on success, or a LIBUSB_ERROR code on failure
2264  * \ref mtasync
2265  */
2266 int API_EXPORTED libusb_handle_events_timeout_completed(libusb_context *ctx,
2267         struct timeval *tv, int *completed)
2268 {
2269         int r;
2270         struct timeval poll_timeout;
2271
2272         USBI_GET_CONTEXT(ctx);
2273         r = get_next_timeout(ctx, tv, &poll_timeout);
2274         if (r) {
2275                 /* timeout already expired */
2276                 return handle_timeouts(ctx);
2277         }
2278
2279 retry:
2280         if (libusb_try_lock_events(ctx) == 0) {
2281                 if (completed == NULL || !*completed) {
2282                         /* we obtained the event lock: do our own event handling */
2283                         usbi_dbg("doing our own event handling");
2284                         r = handle_events(ctx, &poll_timeout);
2285                 }
2286                 libusb_unlock_events(ctx);
2287                 return r;
2288         }
2289
2290         /* another thread is doing event handling. wait for thread events that
2291          * notify event completion. */
2292         libusb_lock_event_waiters(ctx);
2293
2294         if (completed && *completed)
2295                 goto already_done;
2296
2297         if (!libusb_event_handler_active(ctx)) {
2298                 /* we hit a race: whoever was event handling earlier finished in the
2299                  * time it took us to reach this point. try the cycle again. */
2300                 libusb_unlock_event_waiters(ctx);
2301                 usbi_dbg("event handler was active but went away, retrying");
2302                 goto retry;
2303         }
2304
2305         usbi_dbg("another thread is doing event handling");
2306         r = libusb_wait_for_event(ctx, &poll_timeout);
2307
2308 already_done:
2309         libusb_unlock_event_waiters(ctx);
2310
2311         if (r < 0)
2312                 return r;
2313         else if (r == 1)
2314                 return handle_timeouts(ctx);
2315         else
2316                 return 0;
2317 }
2318
2319 /** \ingroup poll
2320  * Handle any pending events
2321  *
2322  * Like libusb_handle_events_timeout_completed(), but without the completed
2323  * parameter, calling this function is equivalent to calling
2324  * libusb_handle_events_timeout_completed() with a NULL completed parameter.
2325  *
2326  * This function is kept primarily for backwards compatibility.
2327  * All new code should call libusb_handle_events_completed() or
2328  * libusb_handle_events_timeout_completed() to avoid race conditions.
2329  *
2330  * \param ctx the context to operate on, or NULL for the default context
2331  * \param tv the maximum time to block waiting for events, or an all zero
2332  * timeval struct for non-blocking mode
2333  * \returns 0 on success, or a LIBUSB_ERROR code on failure
2334  */
2335 int API_EXPORTED libusb_handle_events_timeout(libusb_context *ctx,
2336         struct timeval *tv)
2337 {
2338         return libusb_handle_events_timeout_completed(ctx, tv, NULL);
2339 }
2340
2341 /** \ingroup poll
2342  * Handle any pending events in blocking mode. There is currently a timeout
2343  * hardcoded at 60 seconds but we plan to make it unlimited in future. For
2344  * finer control over whether this function is blocking or non-blocking, or
2345  * for control over the timeout, use libusb_handle_events_timeout_completed()
2346  * instead.
2347  *
2348  * This function is kept primarily for backwards compatibility.
2349  * All new code should call libusb_handle_events_completed() or
2350  * libusb_handle_events_timeout_completed() to avoid race conditions.
2351  *
2352  * \param ctx the context to operate on, or NULL for the default context
2353  * \returns 0 on success, or a LIBUSB_ERROR code on failure
2354  */
2355 int API_EXPORTED libusb_handle_events(libusb_context *ctx)
2356 {
2357         struct timeval tv;
2358         tv.tv_sec = 60;
2359         tv.tv_usec = 0;
2360         return libusb_handle_events_timeout_completed(ctx, &tv, NULL);
2361 }
2362
2363 /** \ingroup poll
2364  * Handle any pending events in blocking mode.
2365  *
2366  * Like libusb_handle_events(), with the addition of a completed parameter
2367  * to allow for race free waiting for the completion of a specific transfer.
2368  *
2369  * See libusb_handle_events_timeout_completed() for details on the completed
2370  * parameter.
2371  *
2372  * \param ctx the context to operate on, or NULL for the default context
2373  * \param completed pointer to completion integer to check, or NULL
2374  * \returns 0 on success, or a LIBUSB_ERROR code on failure
2375  * \ref mtasync
2376  */
2377 int API_EXPORTED libusb_handle_events_completed(libusb_context *ctx,
2378         int *completed)
2379 {
2380         struct timeval tv;
2381         tv.tv_sec = 60;
2382         tv.tv_usec = 0;
2383         return libusb_handle_events_timeout_completed(ctx, &tv, completed);
2384 }
2385
2386 /** \ingroup poll
2387  * Handle any pending events by polling file descriptors, without checking if
2388  * any other threads are already doing so. Must be called with the event lock
2389  * held, see libusb_lock_events().
2390  *
2391  * This function is designed to be called under the situation where you have
2392  * taken the event lock and are calling poll()/select() directly on libusb's
2393  * file descriptors (as opposed to using libusb_handle_events() or similar).
2394  * You detect events on libusb's descriptors, so you then call this function
2395  * with a zero timeout value (while still holding the event lock).
2396  *
2397  * \param ctx the context to operate on, or NULL for the default context
2398  * \param tv the maximum time to block waiting for events, or zero for
2399  * non-blocking mode
2400  * \returns 0 on success, or a LIBUSB_ERROR code on failure
2401  * \ref mtasync
2402  */
2403 int API_EXPORTED libusb_handle_events_locked(libusb_context *ctx,
2404         struct timeval *tv)
2405 {
2406         int r;
2407         struct timeval poll_timeout;
2408
2409         USBI_GET_CONTEXT(ctx);
2410         r = get_next_timeout(ctx, tv, &poll_timeout);
2411         if (r) {
2412                 /* timeout already expired */
2413                 return handle_timeouts(ctx);
2414         }
2415
2416         return handle_events(ctx, &poll_timeout);
2417 }
2418
2419 /** \ingroup poll
2420  * Determines whether your application must apply special timing considerations
2421  * when monitoring libusb's file descriptors.
2422  *
2423  * This function is only useful for applications which retrieve and poll
2424  * libusb's file descriptors in their own main loop (\ref pollmain).
2425  *
2426  * Ordinarily, libusb's event handler needs to be called into at specific
2427  * moments in time (in addition to times when there is activity on the file
2428  * descriptor set). The usual approach is to use libusb_get_next_timeout()
2429  * to learn about when the next timeout occurs, and to adjust your
2430  * poll()/select() timeout accordingly so that you can make a call into the
2431  * library at that time.
2432  *
2433  * Some platforms supported by libusb do not come with this baggage - any
2434  * events relevant to timing will be represented by activity on the file
2435  * descriptor set, and libusb_get_next_timeout() will always return 0.
2436  * This function allows you to detect whether you are running on such a
2437  * platform.
2438  *
2439  * Since v1.0.5.
2440  *
2441  * \param ctx the context to operate on, or NULL for the default context
2442  * \returns 0 if you must call into libusb at times determined by
2443  * libusb_get_next_timeout(), or 1 if all timeout events are handled internally
2444  * or through regular activity on the file descriptors.
2445  * \ref pollmain "Polling libusb file descriptors for event handling"
2446  */
2447 int API_EXPORTED libusb_pollfds_handle_timeouts(libusb_context *ctx)
2448 {
2449 #if defined(USBI_TIMERFD_AVAILABLE)
2450         USBI_GET_CONTEXT(ctx);
2451         return usbi_using_timerfd(ctx);
2452 #else
2453         (void)ctx;
2454         return 0;
2455 #endif
2456 }
2457
2458 /** \ingroup poll
2459  * Determine the next internal timeout that libusb needs to handle. You only
2460  * need to use this function if you are calling poll() or select() or similar
2461  * on libusb's file descriptors yourself - you do not need to use it if you
2462  * are calling libusb_handle_events() or a variant directly.
2463  *
2464  * You should call this function in your main loop in order to determine how
2465  * long to wait for select() or poll() to return results. libusb needs to be
2466  * called into at this timeout, so you should use it as an upper bound on
2467  * your select() or poll() call.
2468  *
2469  * When the timeout has expired, call into libusb_handle_events_timeout()
2470  * (perhaps in non-blocking mode) so that libusb can handle the timeout.
2471  *
2472  * This function may return 1 (success) and an all-zero timeval. If this is
2473  * the case, it indicates that libusb has a timeout that has already expired
2474  * so you should call libusb_handle_events_timeout() or similar immediately.
2475  * A return code of 0 indicates that there are no pending timeouts.
2476  *
2477  * On some platforms, this function will always returns 0 (no pending
2478  * timeouts). See \ref polltime.
2479  *
2480  * \param ctx the context to operate on, or NULL for the default context
2481  * \param tv output location for a relative time against the current
2482  * clock in which libusb must be called into in order to process timeout events
2483  * \returns 0 if there are no pending timeouts, 1 if a timeout was returned,
2484  * or LIBUSB_ERROR_OTHER on failure
2485  */
2486 int API_EXPORTED libusb_get_next_timeout(libusb_context *ctx,
2487         struct timeval *tv)
2488 {
2489         struct usbi_transfer *transfer;
2490         struct timespec cur_ts;
2491         struct timeval cur_tv;
2492         struct timeval next_timeout = { 0, 0 };
2493         int r;
2494
2495         USBI_GET_CONTEXT(ctx);
2496         if (usbi_using_timerfd(ctx))
2497                 return 0;
2498
2499         usbi_mutex_lock(&ctx->flying_transfers_lock);
2500         if (list_empty(&ctx->flying_transfers)) {
2501                 usbi_mutex_unlock(&ctx->flying_transfers_lock);
2502                 usbi_dbg("no URBs, no timeout!");
2503                 return 0;
2504         }
2505
2506         /* find next transfer which hasn't already been processed as timed out */
2507         list_for_each_entry(transfer, &ctx->flying_transfers, list, struct usbi_transfer) {
2508                 if (transfer->flags & (USBI_TRANSFER_TIMED_OUT | USBI_TRANSFER_OS_HANDLES_TIMEOUT))
2509                         continue;
2510
2511                 /* if we've reached transfers of infinte timeout, we're done looking */
2512                 if (!timerisset(&transfer->timeout))
2513                         break;
2514
2515                 next_timeout = transfer->timeout;
2516                 break;
2517         }
2518         usbi_mutex_unlock(&ctx->flying_transfers_lock);
2519
2520         if (!timerisset(&next_timeout)) {
2521                 usbi_dbg("no URB with timeout or all handled by OS; no timeout!");
2522                 return 0;
2523         }
2524
2525         r = usbi_backend->clock_gettime(USBI_CLOCK_MONOTONIC, &cur_ts);
2526         if (r < 0) {
2527                 usbi_err(ctx, "failed to read monotonic clock, errno=%d", errno);
2528                 return 0;
2529         }
2530         TIMESPEC_TO_TIMEVAL(&cur_tv, &cur_ts);
2531
2532         if (!timercmp(&cur_tv, &next_timeout, <)) {
2533                 usbi_dbg("first timeout already expired");
2534                 timerclear(tv);
2535         } else {
2536                 timersub(&next_timeout, &cur_tv, tv);
2537                 usbi_dbg("next timeout in %d.%06ds", tv->tv_sec, tv->tv_usec);
2538         }
2539
2540         return 1;
2541 }
2542
2543 /** \ingroup poll
2544  * Register notification functions for file descriptor additions/removals.
2545  * These functions will be invoked for every new or removed file descriptor
2546  * that libusb uses as an event source.
2547  *
2548  * To remove notifiers, pass NULL values for the function pointers.
2549  *
2550  * Note that file descriptors may have been added even before you register
2551  * these notifiers (e.g. at libusb_init() time).
2552  *
2553  * Additionally, note that the removal notifier may be called during
2554  * libusb_exit() (e.g. when it is closing file descriptors that were opened
2555  * and added to the poll set at libusb_init() time). If you don't want this,
2556  * remove the notifiers immediately before calling libusb_exit().
2557  *
2558  * \param ctx the context to operate on, or NULL for the default context
2559  * \param added_cb pointer to function for addition notifications
2560  * \param removed_cb pointer to function for removal notifications
2561  * \param user_data User data to be passed back to callbacks (useful for
2562  * passing context information)
2563  */
2564 void API_EXPORTED libusb_set_pollfd_notifiers(libusb_context *ctx,
2565         libusb_pollfd_added_cb added_cb, libusb_pollfd_removed_cb removed_cb,
2566         void *user_data)
2567 {
2568         USBI_GET_CONTEXT(ctx);
2569         ctx->fd_added_cb = added_cb;
2570         ctx->fd_removed_cb = removed_cb;
2571         ctx->fd_cb_user_data = user_data;
2572 }
2573
2574 /*
2575  * Interrupt the iteration of the event handling thread, so that it picks
2576  * up the fd change. Callers of this function must hold the event_data_lock.
2577  */
2578 static void usbi_fd_notification(struct libusb_context *ctx)
2579 {
2580         int pending_events;
2581
2582         /* Record that there is a new poll fd.
2583          * Only signal an event if there are no prior pending events. */
2584         pending_events = usbi_pending_events(ctx);
2585         ctx->pollfds_modified = 1;
2586         if (!pending_events)
2587                 usbi_signal_event(ctx);
2588 }
2589
2590 /* Add a file descriptor to the list of file descriptors to be monitored.
2591  * events should be specified as a bitmask of events passed to poll(), e.g.
2592  * POLLIN and/or POLLOUT. */
2593 int usbi_add_pollfd(struct libusb_context *ctx, int fd, short events)
2594 {
2595         struct usbi_pollfd *ipollfd = malloc(sizeof(*ipollfd));
2596         if (!ipollfd)
2597                 return LIBUSB_ERROR_NO_MEM;
2598
2599         usbi_dbg("add fd %d events %d", fd, events);
2600         ipollfd->pollfd.fd = fd;
2601         ipollfd->pollfd.events = events;
2602         usbi_mutex_lock(&ctx->event_data_lock);
2603         list_add_tail(&ipollfd->list, &ctx->ipollfds);
2604         ctx->pollfds_cnt++;
2605         usbi_fd_notification(ctx);
2606         usbi_mutex_unlock(&ctx->event_data_lock);
2607
2608         if (ctx->fd_added_cb)
2609                 ctx->fd_added_cb(fd, events, ctx->fd_cb_user_data);
2610         return 0;
2611 }
2612
2613 /* Remove a file descriptor from the list of file descriptors to be polled. */
2614 void usbi_remove_pollfd(struct libusb_context *ctx, int fd)
2615 {
2616         struct usbi_pollfd *ipollfd;
2617         int found = 0;
2618
2619         usbi_dbg("remove fd %d", fd);
2620         usbi_mutex_lock(&ctx->event_data_lock);
2621         list_for_each_entry(ipollfd, &ctx->ipollfds, list, struct usbi_pollfd)
2622                 if (ipollfd->pollfd.fd == fd) {
2623                         found = 1;
2624                         break;
2625                 }
2626
2627         if (!found) {
2628                 usbi_dbg("couldn't find fd %d to remove", fd);
2629                 usbi_mutex_unlock(&ctx->event_data_lock);
2630                 return;
2631         }
2632
2633         list_del(&ipollfd->list);
2634         ctx->pollfds_cnt--;
2635         usbi_fd_notification(ctx);
2636         usbi_mutex_unlock(&ctx->event_data_lock);
2637         free(ipollfd);
2638         if (ctx->fd_removed_cb)
2639                 ctx->fd_removed_cb(fd, ctx->fd_cb_user_data);
2640 }
2641
2642 /** \ingroup poll
2643  * Retrieve a list of file descriptors that should be polled by your main loop
2644  * as libusb event sources.
2645  *
2646  * The returned list is NULL-terminated and should be freed with libusb_free_pollfds()
2647  * when done. The actual list contents must not be touched.
2648  *
2649  * As file descriptors are a Unix-specific concept, this function is not
2650  * available on Windows and will always return NULL.
2651  *
2652  * \param ctx the context to operate on, or NULL for the default context
2653  * \returns a NULL-terminated list of libusb_pollfd structures
2654  * \returns NULL on error
2655  * \returns NULL on platforms where the functionality is not available
2656  */
2657 DEFAULT_VISIBILITY
2658 const struct libusb_pollfd ** LIBUSB_CALL libusb_get_pollfds(
2659         libusb_context *ctx)
2660 {
2661 #ifndef OS_WINDOWS
2662         struct libusb_pollfd **ret = NULL;
2663         struct usbi_pollfd *ipollfd;
2664         size_t i = 0;
2665         USBI_GET_CONTEXT(ctx);
2666
2667         usbi_mutex_lock(&ctx->event_data_lock);
2668
2669         ret = calloc(ctx->pollfds_cnt + 1, sizeof(struct libusb_pollfd *));
2670         if (!ret)
2671                 goto out;
2672
2673         list_for_each_entry(ipollfd, &ctx->ipollfds, list, struct usbi_pollfd)
2674                 ret[i++] = (struct libusb_pollfd *) ipollfd;
2675         ret[ctx->pollfds_cnt] = NULL;
2676
2677 out:
2678         usbi_mutex_unlock(&ctx->event_data_lock);
2679         return (const struct libusb_pollfd **) ret;
2680 #else
2681         usbi_err(ctx, "external polling of libusb's internal descriptors "\
2682                 "is not yet supported on Windows platforms");
2683         return NULL;
2684 #endif
2685 }
2686
2687 /** \ingroup poll
2688  * Free a list of libusb_pollfd structures. This should be called for all
2689  * pollfd lists allocated with libusb_get_pollfds().
2690  *
2691  * Since version 1.0.20, \ref LIBUSB_API_VERSION >= 0x01000104
2692  *
2693  * It is legal to call this function with a NULL pollfd list. In this case,
2694  * the function will simply return safely.
2695  *
2696  * \param pollfds the list of libusb_pollfd structures to free
2697  */
2698 void API_EXPORTED libusb_free_pollfds(const struct libusb_pollfd **pollfds)
2699 {
2700         if (!pollfds)
2701                 return;
2702
2703         free((void *)pollfds);
2704 }
2705
2706 /* Backends may call this from handle_events to report disconnection of a
2707  * device. This function ensures transfers get cancelled appropriately.
2708  * Callers of this function must hold the events_lock.
2709  */
2710 void usbi_handle_disconnect(struct libusb_device_handle *handle)
2711 {
2712         struct usbi_transfer *cur;
2713         struct usbi_transfer *to_cancel;
2714
2715         usbi_dbg("device %d.%d",
2716                 handle->dev->bus_number, handle->dev->device_address);
2717
2718         /* terminate all pending transfers with the LIBUSB_TRANSFER_NO_DEVICE
2719          * status code.
2720          *
2721          * when we find a transfer for this device on the list, there are two
2722          * possible scenarios:
2723          * 1. the transfer is currently in-flight, in which case we terminate the
2724          *    transfer here
2725          * 2. the transfer is not in-flight (or is but hasn't been marked as such),
2726          *    in which case we record that the device disappeared and this will be
2727          *    handled by libusb_submit_transfer()
2728          */
2729
2730         while (1) {
2731                 to_cancel = NULL;
2732                 usbi_mutex_lock(&HANDLE_CTX(handle)->flying_transfers_lock);
2733                 list_for_each_entry(cur, &HANDLE_CTX(handle)->flying_transfers, list, struct usbi_transfer)
2734                         if (USBI_TRANSFER_TO_LIBUSB_TRANSFER(cur)->dev_handle == handle) {
2735                                 usbi_mutex_lock(&cur->flags_lock);
2736                                 if (cur->flags & USBI_TRANSFER_IN_FLIGHT)
2737                                         to_cancel = cur;
2738                                 else
2739                                         cur->flags |= USBI_TRANSFER_DEVICE_DISAPPEARED;
2740                                 usbi_mutex_unlock(&cur->flags_lock);
2741
2742                                 if (to_cancel)
2743                                         break;
2744                         }
2745                 usbi_mutex_unlock(&HANDLE_CTX(handle)->flying_transfers_lock);
2746
2747                 if (!to_cancel)
2748                         break;
2749
2750                 usbi_dbg("cancelling transfer %p from disconnect",
2751                          USBI_TRANSFER_TO_LIBUSB_TRANSFER(to_cancel));
2752
2753                 usbi_mutex_lock(&to_cancel->lock);
2754                 usbi_backend->clear_transfer_priv(to_cancel);
2755                 usbi_mutex_unlock(&to_cancel->lock);
2756                 usbi_handle_transfer_completion(to_cancel, LIBUSB_TRANSFER_NO_DEVICE);
2757         }
2758
2759 }