core: Make event_data_lock non-recursive
[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  * \section asyncmem Memory caveats
470  *
471  * In most circumstances, it is not safe to use stack memory for transfer
472  * buffers. This is because the function that fired off the asynchronous
473  * transfer may return before libusb has finished using the buffer, and when
474  * the function returns it's stack gets destroyed. This is true for both
475  * host-to-device and device-to-host transfers.
476  *
477  * The only case in which it is safe to use stack memory is where you can
478  * guarantee that the function owning the stack space for the buffer does not
479  * return until after the transfer's callback function has completed. In every
480  * other case, you need to use heap memory instead.
481  *
482  * \section asyncflags Fine control
483  *
484  * Through using this asynchronous interface, you may find yourself repeating
485  * a few simple operations many times. You can apply a bitwise OR of certain
486  * flags to a transfer to simplify certain things:
487  * - \ref libusb_transfer_flags::LIBUSB_TRANSFER_SHORT_NOT_OK
488  *   "LIBUSB_TRANSFER_SHORT_NOT_OK" results in transfers which transferred
489  *   less than the requested amount of data being marked with status
490  *   \ref libusb_transfer_status::LIBUSB_TRANSFER_ERROR "LIBUSB_TRANSFER_ERROR"
491  *   (they would normally be regarded as COMPLETED)
492  * - \ref libusb_transfer_flags::LIBUSB_TRANSFER_FREE_BUFFER
493  *   "LIBUSB_TRANSFER_FREE_BUFFER" allows you to ask libusb to free the transfer
494  *   buffer when freeing the transfer.
495  * - \ref libusb_transfer_flags::LIBUSB_TRANSFER_FREE_TRANSFER
496  *   "LIBUSB_TRANSFER_FREE_TRANSFER" causes libusb to automatically free the
497  *   transfer after the transfer callback returns.
498  *
499  * \section asyncevent Event handling
500  *
501  * An asynchronous model requires that libusb perform work at various
502  * points in time - namely processing the results of previously-submitted
503  * transfers and invoking the user-supplied callback function.
504  *
505  * This gives rise to the libusb_handle_events() function which your
506  * application must call into when libusb has work do to. This gives libusb
507  * the opportunity to reap pending transfers, invoke callbacks, etc.
508  *
509  * There are 2 different approaches to dealing with libusb_handle_events:
510  *
511  * -# Repeatedly call libusb_handle_events() in blocking mode from a dedicated
512  *    thread.
513  * -# Integrate libusb with your application's main event loop. libusb
514  *    exposes a set of file descriptors which allow you to do this.
515  *
516  * The first approach has the big advantage that it will also work on Windows
517  * were libusb' poll API for select / poll integration is not available. So
518  * if you want to support Windows and use the async API, you must use this
519  * approach, see the \ref eventthread "Using an event handling thread" section
520  * below for details.
521  *
522  * If you prefer a single threaded approach with a single central event loop,
523  * see the \ref poll "polling and timing" section for how to integrate libusb
524  * into your application's main event loop.
525  *
526  * \section eventthread Using an event handling thread
527  *
528  * Lets begin with stating the obvious: If you're going to use a separate
529  * thread for libusb event handling, your callback functions MUST be
530  * threadsafe.
531  *
532  * Other then that doing event handling from a separate thread, is mostly
533  * simple. You can use an event thread function as follows:
534 \code
535 void *event_thread_func(void *ctx)
536 {
537     while (event_thread_run)
538         libusb_handle_events(ctx);
539
540     return NULL;
541 }
542 \endcode
543  *
544  * There is one caveat though, stopping this thread requires setting the
545  * event_thread_run variable to 0, and after that libusb_handle_events() needs
546  * to return control to event_thread_func. But unless some event happens,
547  * libusb_handle_events() will not return.
548  *
549  * There are 2 different ways of dealing with this, depending on if your
550  * application uses libusb' \ref hotplug "hotplug" support or not.
551  *
552  * Applications which do not use hotplug support, should not start the event
553  * thread until after their first call to libusb_open(), and should stop the
554  * thread when closing the last open device as follows:
555 \code
556 void my_close_handle(libusb_device_handle *handle)
557 {
558     if (open_devs == 1)
559         event_thread_run = 0;
560
561     libusb_close(handle); // This wakes up libusb_handle_events()
562
563     if (open_devs == 1)
564         pthread_join(event_thread);
565
566     open_devs--;
567 }
568 \endcode
569  *
570  * Applications using hotplug support should start the thread at program init,
571  * after having successfully called libusb_hotplug_register_callback(), and
572  * should stop the thread at program exit as follows:
573 \code
574 void my_libusb_exit(void)
575
576     event_thread_run = 0;
577     libusb_hotplug_deregister_callback(ctx, hotplug_cb_handle); // This wakes up libusb_handle_events()
578     pthread_join(event_thread);
579     libusb_exit(ctx);
580 }
581 \endcode
582  */
583
584 /**
585  * @defgroup poll Polling and timing
586  *
587  * This page documents libusb's functions for polling events and timing.
588  * These functions are only necessary for users of the
589  * \ref asyncio "asynchronous API". If you are only using the simpler
590  * \ref syncio "synchronous API" then you do not need to ever call these
591  * functions.
592  *
593  * The justification for the functionality described here has already been
594  * discussed in the \ref asyncevent "event handling" section of the
595  * asynchronous API documentation. In summary, libusb does not create internal
596  * threads for event processing and hence relies on your application calling
597  * into libusb at certain points in time so that pending events can be handled.
598  *
599  * Your main loop is probably already calling poll() or select() or a
600  * variant on a set of file descriptors for other event sources (e.g. keyboard
601  * button presses, mouse movements, network sockets, etc). You then add
602  * libusb's file descriptors to your poll()/select() calls, and when activity
603  * is detected on such descriptors you know it is time to call
604  * libusb_handle_events().
605  *
606  * There is one final event handling complication. libusb supports
607  * asynchronous transfers which time out after a specified time period.
608  *
609  * On some platforms a timerfd is used, so the timeout handling is just another
610  * fd, on other platforms this requires that libusb is called into at or after
611  * the timeout to handle it. So, in addition to considering libusb's file
612  * descriptors in your main event loop, you must also consider that libusb
613  * sometimes needs to be called into at fixed points in time even when there
614  * is no file descriptor activity, see \ref polltime details.
615  * 
616  * In order to know precisely when libusb needs to be called into, libusb
617  * offers you a set of pollable file descriptors and information about when
618  * the next timeout expires.
619  *
620  * If you are using the asynchronous I/O API, you must take one of the two
621  * following options, otherwise your I/O will not complete.
622  *
623  * \section pollsimple The simple option
624  *
625  * If your application revolves solely around libusb and does not need to
626  * handle other event sources, you can have a program structure as follows:
627 \code
628 // initialize libusb
629 // find and open device
630 // maybe fire off some initial async I/O
631
632 while (user_has_not_requested_exit)
633         libusb_handle_events(ctx);
634
635 // clean up and exit
636 \endcode
637  *
638  * With such a simple main loop, you do not have to worry about managing
639  * sets of file descriptors or handling timeouts. libusb_handle_events() will
640  * handle those details internally.
641  *
642  * \section pollmain The more advanced option
643  *
644  * \note This functionality is currently only available on Unix-like platforms.
645  * On Windows, libusb_get_pollfds() simply returns NULL. Applications which
646  * want to support Windows are advised to use an \ref eventthread
647  * "event handling thread" instead.
648  *
649  * In more advanced applications, you will already have a main loop which
650  * is monitoring other event sources: network sockets, X11 events, mouse
651  * movements, etc. Through exposing a set of file descriptors, libusb is
652  * designed to cleanly integrate into such main loops.
653  *
654  * In addition to polling file descriptors for the other event sources, you
655  * take a set of file descriptors from libusb and monitor those too. When you
656  * detect activity on libusb's file descriptors, you call
657  * libusb_handle_events_timeout() in non-blocking mode.
658  *
659  * What's more, libusb may also need to handle events at specific moments in
660  * time. No file descriptor activity is generated at these times, so your
661  * own application needs to be continually aware of when the next one of these
662  * moments occurs (through calling libusb_get_next_timeout()), and then it
663  * needs to call libusb_handle_events_timeout() in non-blocking mode when
664  * these moments occur. This means that you need to adjust your
665  * poll()/select() timeout accordingly.
666  *
667  * libusb provides you with a set of file descriptors to poll and expects you
668  * to poll all of them, treating them as a single entity. The meaning of each
669  * file descriptor in the set is an internal implementation detail,
670  * platform-dependent and may vary from release to release. Don't try and
671  * interpret the meaning of the file descriptors, just do as libusb indicates,
672  * polling all of them at once.
673  *
674  * In pseudo-code, you want something that looks like:
675 \code
676 // initialise libusb
677
678 libusb_get_pollfds(ctx)
679 while (user has not requested application exit) {
680         libusb_get_next_timeout(ctx);
681         poll(on libusb file descriptors plus any other event sources of interest,
682                 using a timeout no larger than the value libusb just suggested)
683         if (poll() indicated activity on libusb file descriptors)
684                 libusb_handle_events_timeout(ctx, &zero_tv);
685         if (time has elapsed to or beyond the libusb timeout)
686                 libusb_handle_events_timeout(ctx, &zero_tv);
687         // handle events from other sources here
688 }
689
690 // clean up and exit
691 \endcode
692  *
693  * \subsection polltime Notes on time-based events
694  *
695  * The above complication with having to track time and call into libusb at
696  * specific moments is a bit of a headache. For maximum compatibility, you do
697  * need to write your main loop as above, but you may decide that you can
698  * restrict the supported platforms of your application and get away with
699  * a more simplistic scheme.
700  *
701  * These time-based event complications are \b not required on the following
702  * platforms:
703  *  - Darwin
704  *  - Linux, provided that the following version requirements are satisfied:
705  *   - Linux v2.6.27 or newer, compiled with timerfd support
706  *   - glibc v2.9 or newer
707  *   - libusb v1.0.5 or newer
708  *
709  * Under these configurations, libusb_get_next_timeout() will \em always return
710  * 0, so your main loop can be simplified to:
711 \code
712 // initialise libusb
713
714 libusb_get_pollfds(ctx)
715 while (user has not requested application exit) {
716         poll(on libusb file descriptors plus any other event sources of interest,
717                 using any timeout that you like)
718         if (poll() indicated activity on libusb file descriptors)
719                 libusb_handle_events_timeout(ctx, &zero_tv);
720         // handle events from other sources here
721 }
722
723 // clean up and exit
724 \endcode
725  *
726  * Do remember that if you simplify your main loop to the above, you will
727  * lose compatibility with some platforms (including legacy Linux platforms,
728  * and <em>any future platforms supported by libusb which may have time-based
729  * event requirements</em>). The resultant problems will likely appear as
730  * strange bugs in your application.
731  *
732  * You can use the libusb_pollfds_handle_timeouts() function to do a runtime
733  * check to see if it is safe to ignore the time-based event complications.
734  * If your application has taken the shortcut of ignoring libusb's next timeout
735  * in your main loop, then you are advised to check the return value of
736  * libusb_pollfds_handle_timeouts() during application startup, and to abort
737  * if the platform does suffer from these timing complications.
738  *
739  * \subsection fdsetchange Changes in the file descriptor set
740  *
741  * The set of file descriptors that libusb uses as event sources may change
742  * during the life of your application. Rather than having to repeatedly
743  * call libusb_get_pollfds(), you can set up notification functions for when
744  * the file descriptor set changes using libusb_set_pollfd_notifiers().
745  *
746  * \subsection mtissues Multi-threaded considerations
747  *
748  * Unfortunately, the situation is complicated further when multiple threads
749  * come into play. If two threads are monitoring the same file descriptors,
750  * the fact that only one thread will be woken up when an event occurs causes
751  * some headaches.
752  *
753  * The events lock, event waiters lock, and libusb_handle_events_locked()
754  * entities are added to solve these problems. You do not need to be concerned
755  * with these entities otherwise.
756  *
757  * See the extra documentation: \ref mtasync
758  */
759
760 /** \page mtasync Multi-threaded applications and asynchronous I/O
761  *
762  * libusb is a thread-safe library, but extra considerations must be applied
763  * to applications which interact with libusb from multiple threads.
764  *
765  * The underlying issue that must be addressed is that all libusb I/O
766  * revolves around monitoring file descriptors through the poll()/select()
767  * system calls. This is directly exposed at the
768  * \ref asyncio "asynchronous interface" but it is important to note that the
769  * \ref syncio "synchronous interface" is implemented on top of the
770  * asynchonrous interface, therefore the same considerations apply.
771  *
772  * The issue is that if two or more threads are concurrently calling poll()
773  * or select() on libusb's file descriptors then only one of those threads
774  * will be woken up when an event arrives. The others will be completely
775  * oblivious that anything has happened.
776  *
777  * Consider the following pseudo-code, which submits an asynchronous transfer
778  * then waits for its completion. This style is one way you could implement a
779  * synchronous interface on top of the asynchronous interface (and libusb
780  * does something similar, albeit more advanced due to the complications
781  * explained on this page).
782  *
783 \code
784 void cb(struct libusb_transfer *transfer)
785 {
786         int *completed = transfer->user_data;
787         *completed = 1;
788 }
789
790 void myfunc() {
791         struct libusb_transfer *transfer;
792         unsigned char buffer[LIBUSB_CONTROL_SETUP_SIZE] __attribute__ ((aligned (2)));
793         int completed = 0;
794
795         transfer = libusb_alloc_transfer(0);
796         libusb_fill_control_setup(buffer,
797                 LIBUSB_REQUEST_TYPE_VENDOR | LIBUSB_ENDPOINT_OUT, 0x04, 0x01, 0, 0);
798         libusb_fill_control_transfer(transfer, dev, buffer, cb, &completed, 1000);
799         libusb_submit_transfer(transfer);
800
801         while (!completed) {
802                 poll(libusb file descriptors, 120*1000);
803                 if (poll indicates activity)
804                         libusb_handle_events_timeout(ctx, &zero_tv);
805         }
806         printf("completed!");
807         // other code here
808 }
809 \endcode
810  *
811  * Here we are <em>serializing</em> completion of an asynchronous event
812  * against a condition - the condition being completion of a specific transfer.
813  * The poll() loop has a long timeout to minimize CPU usage during situations
814  * when nothing is happening (it could reasonably be unlimited).
815  *
816  * If this is the only thread that is polling libusb's file descriptors, there
817  * is no problem: there is no danger that another thread will swallow up the
818  * event that we are interested in. On the other hand, if there is another
819  * thread polling the same descriptors, there is a chance that it will receive
820  * the event that we were interested in. In this situation, <tt>myfunc()</tt>
821  * will only realise that the transfer has completed on the next iteration of
822  * the loop, <em>up to 120 seconds later.</em> Clearly a two-minute delay is
823  * undesirable, and don't even think about using short timeouts to circumvent
824  * this issue!
825  *
826  * The solution here is to ensure that no two threads are ever polling the
827  * file descriptors at the same time. A naive implementation of this would
828  * impact the capabilities of the library, so libusb offers the scheme
829  * documented below to ensure no loss of functionality.
830  *
831  * Before we go any further, it is worth mentioning that all libusb-wrapped
832  * event handling procedures fully adhere to the scheme documented below.
833  * This includes libusb_handle_events() and its variants, and all the
834  * synchronous I/O functions - libusb hides this headache from you.
835  *
836  * \section Using libusb_handle_events() from multiple threads
837  *
838  * Even when only using libusb_handle_events() and synchronous I/O functions,
839  * you can still have a race condition. You might be tempted to solve the
840  * above with libusb_handle_events() like so:
841  *
842 \code
843         libusb_submit_transfer(transfer);
844
845         while (!completed) {
846                 libusb_handle_events(ctx);
847         }
848         printf("completed!");
849 \endcode
850  *
851  * This however has a race between the checking of completed and
852  * libusb_handle_events() acquiring the events lock, so another thread
853  * could have completed the transfer, resulting in this thread hanging
854  * until either a timeout or another event occurs. See also commit
855  * 6696512aade99bb15d6792af90ae329af270eba6 which fixes this in the
856  * synchronous API implementation of libusb.
857  *
858  * Fixing this race requires checking the variable completed only after
859  * taking the event lock, which defeats the concept of just calling
860  * libusb_handle_events() without worrying about locking. This is why
861  * libusb-1.0.9 introduces the new libusb_handle_events_timeout_completed()
862  * and libusb_handle_events_completed() functions, which handles doing the
863  * completion check for you after they have acquired the lock:
864  *
865 \code
866         libusb_submit_transfer(transfer);
867
868         while (!completed) {
869                 libusb_handle_events_completed(ctx, &completed);
870         }
871         printf("completed!");
872 \endcode
873  *
874  * This nicely fixes the race in our example. Note that if all you want to
875  * do is submit a single transfer and wait for its completion, then using
876  * one of the synchronous I/O functions is much easier.
877  *
878  * \section eventlock The events lock
879  *
880  * The problem is when we consider the fact that libusb exposes file
881  * descriptors to allow for you to integrate asynchronous USB I/O into
882  * existing main loops, effectively allowing you to do some work behind
883  * libusb's back. If you do take libusb's file descriptors and pass them to
884  * poll()/select() yourself, you need to be aware of the associated issues.
885  *
886  * The first concept to be introduced is the events lock. The events lock
887  * is used to serialize threads that want to handle events, such that only
888  * one thread is handling events at any one time.
889  *
890  * You must take the events lock before polling libusb file descriptors,
891  * using libusb_lock_events(). You must release the lock as soon as you have
892  * aborted your poll()/select() loop, using libusb_unlock_events().
893  *
894  * \section threadwait Letting other threads do the work for you
895  *
896  * Although the events lock is a critical part of the solution, it is not
897  * enough on it's own. You might wonder if the following is sufficient...
898 \code
899         libusb_lock_events(ctx);
900         while (!completed) {
901                 poll(libusb file descriptors, 120*1000);
902                 if (poll indicates activity)
903                         libusb_handle_events_timeout(ctx, &zero_tv);
904         }
905         libusb_unlock_events(ctx);
906 \endcode
907  * ...and the answer is that it is not. This is because the transfer in the
908  * code shown above may take a long time (say 30 seconds) to complete, and
909  * the lock is not released until the transfer is completed.
910  *
911  * Another thread with similar code that wants to do event handling may be
912  * working with a transfer that completes after a few milliseconds. Despite
913  * having such a quick completion time, the other thread cannot check that
914  * status of its transfer until the code above has finished (30 seconds later)
915  * due to contention on the lock.
916  *
917  * To solve this, libusb offers you a mechanism to determine when another
918  * thread is handling events. It also offers a mechanism to block your thread
919  * until the event handling thread has completed an event (and this mechanism
920  * does not involve polling of file descriptors).
921  *
922  * After determining that another thread is currently handling events, you
923  * obtain the <em>event waiters</em> lock using libusb_lock_event_waiters().
924  * You then re-check that some other thread is still handling events, and if
925  * so, you call libusb_wait_for_event().
926  *
927  * libusb_wait_for_event() puts your application to sleep until an event
928  * occurs, or until a thread releases the events lock. When either of these
929  * things happen, your thread is woken up, and should re-check the condition
930  * it was waiting on. It should also re-check that another thread is handling
931  * events, and if not, it should start handling events itself.
932  *
933  * This looks like the following, as pseudo-code:
934 \code
935 retry:
936 if (libusb_try_lock_events(ctx) == 0) {
937         // we obtained the event lock: do our own event handling
938         while (!completed) {
939                 if (!libusb_event_handling_ok(ctx)) {
940                         libusb_unlock_events(ctx);
941                         goto retry;
942                 }
943                 poll(libusb file descriptors, 120*1000);
944                 if (poll indicates activity)
945                         libusb_handle_events_locked(ctx, 0);
946         }
947         libusb_unlock_events(ctx);
948 } else {
949         // another thread is doing event handling. wait for it to signal us that
950         // an event has completed
951         libusb_lock_event_waiters(ctx);
952
953         while (!completed) {
954                 // now that we have the event waiters lock, double check that another
955                 // thread is still handling events for us. (it may have ceased handling
956                 // events in the time it took us to reach this point)
957                 if (!libusb_event_handler_active(ctx)) {
958                         // whoever was handling events is no longer doing so, try again
959                         libusb_unlock_event_waiters(ctx);
960                         goto retry;
961                 }
962
963                 libusb_wait_for_event(ctx, NULL);
964         }
965         libusb_unlock_event_waiters(ctx);
966 }
967 printf("completed!\n");
968 \endcode
969  *
970  * A naive look at the above code may suggest that this can only support
971  * one event waiter (hence a total of 2 competing threads, the other doing
972  * event handling), because the event waiter seems to have taken the event
973  * waiters lock while waiting for an event. However, the system does support
974  * multiple event waiters, because libusb_wait_for_event() actually drops
975  * the lock while waiting, and reaquires it before continuing.
976  *
977  * We have now implemented code which can dynamically handle situations where
978  * nobody is handling events (so we should do it ourselves), and it can also
979  * handle situations where another thread is doing event handling (so we can
980  * piggyback onto them). It is also equipped to handle a combination of
981  * the two, for example, another thread is doing event handling, but for
982  * whatever reason it stops doing so before our condition is met, so we take
983  * over the event handling.
984  *
985  * Four functions were introduced in the above pseudo-code. Their importance
986  * should be apparent from the code shown above.
987  * -# libusb_try_lock_events() is a non-blocking function which attempts
988  *    to acquire the events lock but returns a failure code if it is contended.
989  * -# libusb_event_handling_ok() checks that libusb is still happy for your
990  *    thread to be performing event handling. Sometimes, libusb needs to
991  *    interrupt the event handler, and this is how you can check if you have
992  *    been interrupted. If this function returns 0, the correct behaviour is
993  *    for you to give up the event handling lock, and then to repeat the cycle.
994  *    The following libusb_try_lock_events() will fail, so you will become an
995  *    events waiter. For more information on this, read \ref fullstory below.
996  * -# libusb_handle_events_locked() is a variant of
997  *    libusb_handle_events_timeout() that you can call while holding the
998  *    events lock. libusb_handle_events_timeout() itself implements similar
999  *    logic to the above, so be sure not to call it when you are
1000  *    "working behind libusb's back", as is the case here.
1001  * -# libusb_event_handler_active() determines if someone is currently
1002  *    holding the events lock
1003  *
1004  * You might be wondering why there is no function to wake up all threads
1005  * blocked on libusb_wait_for_event(). This is because libusb can do this
1006  * internally: it will wake up all such threads when someone calls
1007  * libusb_unlock_events() or when a transfer completes (at the point after its
1008  * callback has returned).
1009  *
1010  * \subsection fullstory The full story
1011  *
1012  * The above explanation should be enough to get you going, but if you're
1013  * really thinking through the issues then you may be left with some more
1014  * questions regarding libusb's internals. If you're curious, read on, and if
1015  * not, skip to the next section to avoid confusing yourself!
1016  *
1017  * The immediate question that may spring to mind is: what if one thread
1018  * modifies the set of file descriptors that need to be polled while another
1019  * thread is doing event handling?
1020  *
1021  * There are 2 situations in which this may happen.
1022  * -# libusb_open() will add another file descriptor to the poll set,
1023  *    therefore it is desirable to interrupt the event handler so that it
1024  *    restarts, picking up the new descriptor.
1025  * -# libusb_close() will remove a file descriptor from the poll set. There
1026  *    are all kinds of race conditions that could arise here, so it is
1027  *    important that nobody is doing event handling at this time.
1028  *
1029  * libusb handles these issues internally, so application developers do not
1030  * have to stop their event handlers while opening/closing devices. Here's how
1031  * it works, focusing on the libusb_close() situation first:
1032  *
1033  * -# During initialization, libusb opens an internal pipe, and it adds the read
1034  *    end of this pipe to the set of file descriptors to be polled.
1035  * -# During libusb_close(), libusb writes some dummy data on this event pipe.
1036  *    This immediately interrupts the event handler. libusb also records
1037  *    internally that it is trying to interrupt event handlers for this
1038  *    high-priority event.
1039  * -# At this point, some of the functions described above start behaving
1040  *    differently:
1041  *   - libusb_event_handling_ok() starts returning 1, indicating that it is NOT
1042  *     OK for event handling to continue.
1043  *   - libusb_try_lock_events() starts returning 1, indicating that another
1044  *     thread holds the event handling lock, even if the lock is uncontended.
1045  *   - libusb_event_handler_active() starts returning 1, indicating that
1046  *     another thread is doing event handling, even if that is not true.
1047  * -# The above changes in behaviour result in the event handler stopping and
1048  *    giving up the events lock very quickly, giving the high-priority
1049  *    libusb_close() operation a "free ride" to acquire the events lock. All
1050  *    threads that are competing to do event handling become event waiters.
1051  * -# With the events lock held inside libusb_close(), libusb can safely remove
1052  *    a file descriptor from the poll set, in the safety of knowledge that
1053  *    nobody is polling those descriptors or trying to access the poll set.
1054  * -# After obtaining the events lock, the close operation completes very
1055  *    quickly (usually a matter of milliseconds) and then immediately releases
1056  *    the events lock.
1057  * -# At the same time, the behaviour of libusb_event_handling_ok() and friends
1058  *    reverts to the original, documented behaviour.
1059  * -# The release of the events lock causes the threads that are waiting for
1060  *    events to be woken up and to start competing to become event handlers
1061  *    again. One of them will succeed; it will then re-obtain the list of poll
1062  *    descriptors, and USB I/O will then continue as normal.
1063  *
1064  * libusb_open() is similar, and is actually a more simplistic case. Upon a
1065  * call to libusb_open():
1066  *
1067  * -# The device is opened and a file descriptor is added to the poll set.
1068  * -# libusb sends some dummy data on the event pipe, and records that it
1069  *    is trying to modify the poll descriptor set.
1070  * -# The event handler is interrupted, and the same behaviour change as for
1071  *    libusb_close() takes effect, causing all event handling threads to become
1072  *    event waiters.
1073  * -# The libusb_open() implementation takes its free ride to the events lock.
1074  * -# Happy that it has successfully paused the events handler, libusb_open()
1075  *    releases the events lock.
1076  * -# The event waiter threads are all woken up and compete to become event
1077  *    handlers again. The one that succeeds will obtain the list of poll
1078  *    descriptors again, which will include the addition of the new device.
1079  *
1080  * \subsection concl Closing remarks
1081  *
1082  * The above may seem a little complicated, but hopefully I have made it clear
1083  * why such complications are necessary. Also, do not forget that this only
1084  * applies to applications that take libusb's file descriptors and integrate
1085  * them into their own polling loops.
1086  *
1087  * You may decide that it is OK for your multi-threaded application to ignore
1088  * some of the rules and locks detailed above, because you don't think that
1089  * two threads can ever be polling the descriptors at the same time. If that
1090  * is the case, then that's good news for you because you don't have to worry.
1091  * But be careful here; remember that the synchronous I/O functions do event
1092  * handling internally. If you have one thread doing event handling in a loop
1093  * (without implementing the rules and locking semantics documented above)
1094  * and another trying to send a synchronous USB transfer, you will end up with
1095  * two threads monitoring the same descriptors, and the above-described
1096  * undesirable behaviour occuring. The solution is for your polling thread to
1097  * play by the rules; the synchronous I/O functions do so, and this will result
1098  * in them getting along in perfect harmony.
1099  *
1100  * If you do have a dedicated thread doing event handling, it is perfectly
1101  * legal for it to take the event handling lock for long periods of time. Any
1102  * synchronous I/O functions you call from other threads will transparently
1103  * fall back to the "event waiters" mechanism detailed above. The only
1104  * consideration that your event handling thread must apply is the one related
1105  * to libusb_event_handling_ok(): you must call this before every poll(), and
1106  * give up the events lock if instructed.
1107  */
1108
1109 int usbi_io_init(struct libusb_context *ctx)
1110 {
1111         int r;
1112
1113         usbi_mutex_init(&ctx->flying_transfers_lock, NULL);
1114         usbi_mutex_init_recursive(&ctx->events_lock, NULL);
1115         usbi_mutex_init(&ctx->event_waiters_lock, NULL);
1116         usbi_cond_init(&ctx->event_waiters_cond, NULL);
1117         usbi_mutex_init(&ctx->event_data_lock, NULL);
1118         list_init(&ctx->flying_transfers);
1119         list_init(&ctx->ipollfds);
1120         list_init(&ctx->hotplug_msgs);
1121
1122         /* FIXME should use an eventfd on kernels that support it */
1123         r = usbi_pipe(ctx->event_pipe);
1124         if (r < 0) {
1125                 r = LIBUSB_ERROR_OTHER;
1126                 goto err;
1127         }
1128
1129         r = usbi_add_pollfd(ctx, ctx->event_pipe[0], POLLIN);
1130         if (r < 0)
1131                 goto err_close_pipe;
1132
1133 #ifdef USBI_TIMERFD_AVAILABLE
1134         ctx->timerfd = timerfd_create(usbi_backend->get_timerfd_clockid(),
1135                 TFD_NONBLOCK);
1136         if (ctx->timerfd >= 0) {
1137                 usbi_dbg("using timerfd for timeouts");
1138                 r = usbi_add_pollfd(ctx, ctx->timerfd, POLLIN);
1139                 if (r < 0)
1140                         goto err_close_timerfd;
1141         } else {
1142                 usbi_dbg("timerfd not available (code %d error %d)", ctx->timerfd, errno);
1143                 ctx->timerfd = -1;
1144         }
1145 #endif
1146
1147         return 0;
1148
1149 #ifdef USBI_TIMERFD_AVAILABLE
1150 err_close_timerfd:
1151         close(ctx->timerfd);
1152         usbi_remove_pollfd(ctx, ctx->event_pipe[0]);
1153 #endif
1154 err_close_pipe:
1155         usbi_close(ctx->event_pipe[0]);
1156         usbi_close(ctx->event_pipe[1]);
1157 err:
1158         usbi_mutex_destroy(&ctx->flying_transfers_lock);
1159         usbi_mutex_destroy(&ctx->events_lock);
1160         usbi_mutex_destroy(&ctx->event_waiters_lock);
1161         usbi_cond_destroy(&ctx->event_waiters_cond);
1162         usbi_mutex_destroy(&ctx->event_data_lock);
1163         return r;
1164 }
1165
1166 void usbi_io_exit(struct libusb_context *ctx)
1167 {
1168         usbi_remove_pollfd(ctx, ctx->event_pipe[0]);
1169         usbi_close(ctx->event_pipe[0]);
1170         usbi_close(ctx->event_pipe[1]);
1171 #ifdef USBI_TIMERFD_AVAILABLE
1172         if (usbi_using_timerfd(ctx)) {
1173                 usbi_remove_pollfd(ctx, ctx->timerfd);
1174                 close(ctx->timerfd);
1175         }
1176 #endif
1177         usbi_mutex_destroy(&ctx->flying_transfers_lock);
1178         usbi_mutex_destroy(&ctx->events_lock);
1179         usbi_mutex_destroy(&ctx->event_waiters_lock);
1180         usbi_cond_destroy(&ctx->event_waiters_cond);
1181         usbi_mutex_destroy(&ctx->event_data_lock);
1182         if (ctx->pollfds)
1183                 free(ctx->pollfds);
1184 }
1185
1186 static int calculate_timeout(struct usbi_transfer *transfer)
1187 {
1188         int r;
1189         struct timespec current_time;
1190         unsigned int timeout =
1191                 USBI_TRANSFER_TO_LIBUSB_TRANSFER(transfer)->timeout;
1192
1193         if (!timeout)
1194                 return 0;
1195
1196         r = usbi_backend->clock_gettime(USBI_CLOCK_MONOTONIC, &current_time);
1197         if (r < 0) {
1198                 usbi_err(ITRANSFER_CTX(transfer),
1199                         "failed to read monotonic clock, errno=%d", errno);
1200                 return r;
1201         }
1202
1203         current_time.tv_sec += timeout / 1000;
1204         current_time.tv_nsec += (timeout % 1000) * 1000000;
1205
1206         while (current_time.tv_nsec >= 1000000000) {
1207                 current_time.tv_nsec -= 1000000000;
1208                 current_time.tv_sec++;
1209         }
1210
1211         TIMESPEC_TO_TIMEVAL(&transfer->timeout, &current_time);
1212         return 0;
1213 }
1214
1215 /* add a transfer to the (timeout-sorted) active transfers list.
1216  * Callers of this function must hold the flying_transfers_lock.
1217  * This function *always* adds the transfer to the flying_transfers list,
1218  * it will return non 0 if it fails to update the timer, but even then the
1219  * transfer is added to the flying_transfers list. */
1220 static int add_to_flying_list(struct usbi_transfer *transfer)
1221 {
1222         struct usbi_transfer *cur;
1223         struct timeval *timeout = &transfer->timeout;
1224         struct libusb_context *ctx = ITRANSFER_CTX(transfer);
1225         int r = 0;
1226         int first = 1;
1227
1228         /* if we have no other flying transfers, start the list with this one */
1229         if (list_empty(&ctx->flying_transfers)) {
1230                 list_add(&transfer->list, &ctx->flying_transfers);
1231                 goto out;
1232         }
1233
1234         /* if we have infinite timeout, append to end of list */
1235         if (!timerisset(timeout)) {
1236                 list_add_tail(&transfer->list, &ctx->flying_transfers);
1237                 /* first is irrelevant in this case */
1238                 goto out;
1239         }
1240
1241         /* otherwise, find appropriate place in list */
1242         list_for_each_entry(cur, &ctx->flying_transfers, list, struct usbi_transfer) {
1243                 /* find first timeout that occurs after the transfer in question */
1244                 struct timeval *cur_tv = &cur->timeout;
1245
1246                 if (!timerisset(cur_tv) || (cur_tv->tv_sec > timeout->tv_sec) ||
1247                                 (cur_tv->tv_sec == timeout->tv_sec &&
1248                                         cur_tv->tv_usec > timeout->tv_usec)) {
1249                         list_add_tail(&transfer->list, &cur->list);
1250                         goto out;
1251                 }
1252                 first = 0;
1253         }
1254         /* first is 0 at this stage (list not empty) */
1255
1256         /* otherwise we need to be inserted at the end */
1257         list_add_tail(&transfer->list, &ctx->flying_transfers);
1258 out:
1259 #ifdef USBI_TIMERFD_AVAILABLE
1260         if (first && usbi_using_timerfd(ctx) && timerisset(timeout)) {
1261                 /* if this transfer has the lowest timeout of all active transfers,
1262                  * rearm the timerfd with this transfer's timeout */
1263                 const struct itimerspec it = { {0, 0},
1264                         { timeout->tv_sec, timeout->tv_usec * 1000 } };
1265                 usbi_dbg("arm timerfd for timeout in %dms (first in line)",
1266                         USBI_TRANSFER_TO_LIBUSB_TRANSFER(transfer)->timeout);
1267                 r = timerfd_settime(ctx->timerfd, TFD_TIMER_ABSTIME, &it, NULL);
1268                 if (r < 0) {
1269                         usbi_warn(ctx, "failed to arm first timerfd (errno %d)", errno);
1270                         r = LIBUSB_ERROR_OTHER;
1271                 }
1272         }
1273 #else
1274         UNUSED(first);
1275 #endif
1276
1277         return r;
1278 }
1279
1280 /** \ingroup asyncio
1281  * Allocate a libusb transfer with a specified number of isochronous packet
1282  * descriptors. The returned transfer is pre-initialized for you. When the new
1283  * transfer is no longer needed, it should be freed with
1284  * libusb_free_transfer().
1285  *
1286  * Transfers intended for non-isochronous endpoints (e.g. control, bulk,
1287  * interrupt) should specify an iso_packets count of zero.
1288  *
1289  * For transfers intended for isochronous endpoints, specify an appropriate
1290  * number of packet descriptors to be allocated as part of the transfer.
1291  * The returned transfer is not specially initialized for isochronous I/O;
1292  * you are still required to set the
1293  * \ref libusb_transfer::num_iso_packets "num_iso_packets" and
1294  * \ref libusb_transfer::type "type" fields accordingly.
1295  *
1296  * It is safe to allocate a transfer with some isochronous packets and then
1297  * use it on a non-isochronous endpoint. If you do this, ensure that at time
1298  * of submission, num_iso_packets is 0 and that type is set appropriately.
1299  *
1300  * \param iso_packets number of isochronous packet descriptors to allocate
1301  * \returns a newly allocated transfer, or NULL on error
1302  */
1303 DEFAULT_VISIBILITY
1304 struct libusb_transfer * LIBUSB_CALL libusb_alloc_transfer(
1305         int iso_packets)
1306 {
1307         size_t os_alloc_size = usbi_backend->transfer_priv_size
1308                 + (usbi_backend->add_iso_packet_size * iso_packets);
1309         size_t alloc_size = sizeof(struct usbi_transfer)
1310                 + sizeof(struct libusb_transfer)
1311                 + (sizeof(struct libusb_iso_packet_descriptor) * iso_packets)
1312                 + os_alloc_size;
1313         struct usbi_transfer *itransfer = calloc(1, alloc_size);
1314         if (!itransfer)
1315                 return NULL;
1316
1317         itransfer->num_iso_packets = iso_packets;
1318         usbi_mutex_init(&itransfer->lock, NULL);
1319         return USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
1320 }
1321
1322 /** \ingroup asyncio
1323  * Free a transfer structure. This should be called for all transfers
1324  * allocated with libusb_alloc_transfer().
1325  *
1326  * If the \ref libusb_transfer_flags::LIBUSB_TRANSFER_FREE_BUFFER
1327  * "LIBUSB_TRANSFER_FREE_BUFFER" flag is set and the transfer buffer is
1328  * non-NULL, this function will also free the transfer buffer using the
1329  * standard system memory allocator (e.g. free()).
1330  *
1331  * It is legal to call this function with a NULL transfer. In this case,
1332  * the function will simply return safely.
1333  *
1334  * It is not legal to free an active transfer (one which has been submitted
1335  * and has not yet completed).
1336  *
1337  * \param transfer the transfer to free
1338  */
1339 void API_EXPORTED libusb_free_transfer(struct libusb_transfer *transfer)
1340 {
1341         struct usbi_transfer *itransfer;
1342         if (!transfer)
1343                 return;
1344
1345         if (transfer->flags & LIBUSB_TRANSFER_FREE_BUFFER && transfer->buffer)
1346                 free(transfer->buffer);
1347
1348         itransfer = LIBUSB_TRANSFER_TO_USBI_TRANSFER(transfer);
1349         usbi_mutex_destroy(&itransfer->lock);
1350         free(itransfer);
1351 }
1352
1353 #ifdef USBI_TIMERFD_AVAILABLE
1354 static int disarm_timerfd(struct libusb_context *ctx)
1355 {
1356         const struct itimerspec disarm_timer = { { 0, 0 }, { 0, 0 } };
1357         int r;
1358
1359         usbi_dbg("");
1360         r = timerfd_settime(ctx->timerfd, 0, &disarm_timer, NULL);
1361         if (r < 0)
1362                 return LIBUSB_ERROR_OTHER;
1363         else
1364                 return 0;
1365 }
1366
1367 /* iterates through the flying transfers, and rearms the timerfd based on the
1368  * next upcoming timeout.
1369  * must be called with flying_list locked.
1370  * returns 0 if there was no timeout to arm, 1 if the next timeout was armed,
1371  * or a LIBUSB_ERROR code on failure.
1372  */
1373 static int arm_timerfd_for_next_timeout(struct libusb_context *ctx)
1374 {
1375         struct usbi_transfer *transfer;
1376
1377         list_for_each_entry(transfer, &ctx->flying_transfers, list, struct usbi_transfer) {
1378                 struct timeval *cur_tv = &transfer->timeout;
1379
1380                 /* if we've reached transfers of infinite timeout, then we have no
1381                  * arming to do */
1382                 if (!timerisset(cur_tv))
1383                         goto disarm;
1384
1385                 /* act on first transfer that is not already cancelled */
1386                 if (!(transfer->flags & USBI_TRANSFER_TIMED_OUT)) {
1387                         int r;
1388                         const struct itimerspec it = { {0, 0},
1389                                 { cur_tv->tv_sec, cur_tv->tv_usec * 1000 } };
1390                         usbi_dbg("next timeout originally %dms", USBI_TRANSFER_TO_LIBUSB_TRANSFER(transfer)->timeout);
1391                         r = timerfd_settime(ctx->timerfd, TFD_TIMER_ABSTIME, &it, NULL);
1392                         if (r < 0)
1393                                 return LIBUSB_ERROR_OTHER;
1394                         return 1;
1395                 }
1396         }
1397
1398 disarm:
1399         return disarm_timerfd(ctx);
1400 }
1401 #else
1402 static int arm_timerfd_for_next_timeout(struct libusb_context *ctx)
1403 {
1404         (void)ctx;
1405         return 0;
1406 }
1407 #endif
1408
1409 /** \ingroup asyncio
1410  * Submit a transfer. This function will fire off the USB transfer and then
1411  * return immediately.
1412  *
1413  * \param transfer the transfer to submit
1414  * \returns 0 on success
1415  * \returns LIBUSB_ERROR_NO_DEVICE if the device has been disconnected
1416  * \returns LIBUSB_ERROR_BUSY if the transfer has already been submitted.
1417  * \returns LIBUSB_ERROR_NOT_SUPPORTED if the transfer flags are not supported
1418  * by the operating system.
1419  * \returns another LIBUSB_ERROR code on other failure
1420  */
1421 int API_EXPORTED libusb_submit_transfer(struct libusb_transfer *transfer)
1422 {
1423         struct libusb_context *ctx = TRANSFER_CTX(transfer);
1424         struct usbi_transfer *itransfer =
1425                 LIBUSB_TRANSFER_TO_USBI_TRANSFER(transfer);
1426         int r;
1427
1428         usbi_mutex_lock(&ctx->flying_transfers_lock);
1429         usbi_mutex_lock(&itransfer->lock);
1430         itransfer->transferred = 0;
1431         itransfer->flags = 0;
1432         r = calculate_timeout(itransfer);
1433         if (r < 0) {
1434                 r = LIBUSB_ERROR_OTHER;
1435                 goto out;
1436         }
1437
1438         r = add_to_flying_list(itransfer);
1439         if (r == LIBUSB_SUCCESS) {
1440                 r = usbi_backend->submit_transfer(itransfer);
1441         }
1442         if (r != LIBUSB_SUCCESS) {
1443                 list_del(&itransfer->list);
1444                 arm_timerfd_for_next_timeout(ctx);
1445         } else {
1446                 /* keep a reference to this device */
1447                 libusb_ref_device(transfer->dev_handle->dev);
1448         }
1449 out:
1450         usbi_mutex_unlock(&itransfer->lock);
1451         usbi_mutex_unlock(&ctx->flying_transfers_lock);
1452         return r;
1453 }
1454
1455 /** \ingroup asyncio
1456  * Asynchronously cancel a previously submitted transfer.
1457  * This function returns immediately, but this does not indicate cancellation
1458  * is complete. Your callback function will be invoked at some later time
1459  * with a transfer status of
1460  * \ref libusb_transfer_status::LIBUSB_TRANSFER_CANCELLED
1461  * "LIBUSB_TRANSFER_CANCELLED."
1462  *
1463  * \param transfer the transfer to cancel
1464  * \returns 0 on success
1465  * \returns LIBUSB_ERROR_NOT_FOUND if the transfer is already complete or
1466  * cancelled.
1467  * \returns a LIBUSB_ERROR code on failure
1468  */
1469 int API_EXPORTED libusb_cancel_transfer(struct libusb_transfer *transfer)
1470 {
1471         struct usbi_transfer *itransfer =
1472                 LIBUSB_TRANSFER_TO_USBI_TRANSFER(transfer);
1473         int r;
1474
1475         usbi_dbg("");
1476         usbi_mutex_lock(&itransfer->lock);
1477         r = usbi_backend->cancel_transfer(itransfer);
1478         if (r < 0) {
1479                 if (r != LIBUSB_ERROR_NOT_FOUND &&
1480                     r != LIBUSB_ERROR_NO_DEVICE)
1481                         usbi_err(TRANSFER_CTX(transfer),
1482                                 "cancel transfer failed error %d", r);
1483                 else
1484                         usbi_dbg("cancel transfer failed error %d", r);
1485
1486                 if (r == LIBUSB_ERROR_NO_DEVICE)
1487                         itransfer->flags |= USBI_TRANSFER_DEVICE_DISAPPEARED;
1488         }
1489
1490         itransfer->flags |= USBI_TRANSFER_CANCELLING;
1491
1492         usbi_mutex_unlock(&itransfer->lock);
1493         return r;
1494 }
1495
1496 /** \ingroup asyncio
1497  * Set a transfers bulk stream id. Note users are advised to use
1498  * libusb_fill_bulk_stream_transfer() instead of calling this function
1499  * directly.
1500  *
1501  * Since version 1.0.19, \ref LIBUSB_API_VERSION >= 0x01000103
1502  *
1503  * \param transfer the transfer to set the stream id for
1504  * \param stream_id the stream id to set
1505  * \see libusb_alloc_streams()
1506  */
1507 void API_EXPORTED libusb_transfer_set_stream_id(
1508         struct libusb_transfer *transfer, uint32_t stream_id)
1509 {
1510         struct usbi_transfer *itransfer =
1511                 LIBUSB_TRANSFER_TO_USBI_TRANSFER(transfer);
1512
1513         itransfer->stream_id = stream_id;
1514 }
1515
1516 /** \ingroup asyncio
1517  * Get a transfers bulk stream id.
1518  *
1519  * Since version 1.0.19, \ref LIBUSB_API_VERSION >= 0x01000103
1520  *
1521  * \param transfer the transfer to get the stream id for
1522  * \returns the stream id for the transfer
1523  */
1524 uint32_t API_EXPORTED libusb_transfer_get_stream_id(
1525         struct libusb_transfer *transfer)
1526 {
1527         struct usbi_transfer *itransfer =
1528                 LIBUSB_TRANSFER_TO_USBI_TRANSFER(transfer);
1529
1530         return itransfer->stream_id;
1531 }
1532
1533 /* Handle completion of a transfer (completion might be an error condition).
1534  * This will invoke the user-supplied callback function, which may end up
1535  * freeing the transfer. Therefore you cannot use the transfer structure
1536  * after calling this function, and you should free all backend-specific
1537  * data before calling it.
1538  * Do not call this function with the usbi_transfer lock held. User-specified
1539  * callback functions may attempt to directly resubmit the transfer, which
1540  * will attempt to take the lock. */
1541 int usbi_handle_transfer_completion(struct usbi_transfer *itransfer,
1542         enum libusb_transfer_status status)
1543 {
1544         struct libusb_transfer *transfer =
1545                 USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
1546         struct libusb_context *ctx = TRANSFER_CTX(transfer);
1547         struct libusb_device_handle *handle = transfer->dev_handle;
1548         uint8_t flags;
1549         int r = 0;
1550
1551         /* FIXME: could be more intelligent with the timerfd here. we don't need
1552          * to disarm the timerfd if there was no timer running, and we only need
1553          * to rearm the timerfd if the transfer that expired was the one with
1554          * the shortest timeout. */
1555
1556         usbi_mutex_lock(&ctx->flying_transfers_lock);
1557         list_del(&itransfer->list);
1558         if (usbi_using_timerfd(ctx))
1559                 r = arm_timerfd_for_next_timeout(ctx);
1560         usbi_mutex_unlock(&ctx->flying_transfers_lock);
1561         if (usbi_using_timerfd(ctx) && (r < 0))
1562                 return r;
1563
1564         if (status == LIBUSB_TRANSFER_COMPLETED
1565                         && transfer->flags & LIBUSB_TRANSFER_SHORT_NOT_OK) {
1566                 int rqlen = transfer->length;
1567                 if (transfer->type == LIBUSB_TRANSFER_TYPE_CONTROL)
1568                         rqlen -= LIBUSB_CONTROL_SETUP_SIZE;
1569                 if (rqlen != itransfer->transferred) {
1570                         usbi_dbg("interpreting short transfer as error");
1571                         status = LIBUSB_TRANSFER_ERROR;
1572                 }
1573         }
1574
1575         flags = transfer->flags;
1576         transfer->status = status;
1577         transfer->actual_length = itransfer->transferred;
1578         usbi_dbg("transfer %p has callback %p", transfer, transfer->callback);
1579         if (transfer->callback)
1580                 transfer->callback(transfer);
1581         /* transfer might have been freed by the above call, do not use from
1582          * this point. */
1583         if (flags & LIBUSB_TRANSFER_FREE_TRANSFER)
1584                 libusb_free_transfer(transfer);
1585         libusb_unref_device(handle->dev);
1586         return 0;
1587 }
1588
1589 /* Similar to usbi_handle_transfer_completion() but exclusively for transfers
1590  * that were asynchronously cancelled. The same concerns w.r.t. freeing of
1591  * transfers exist here.
1592  * Do not call this function with the usbi_transfer lock held. User-specified
1593  * callback functions may attempt to directly resubmit the transfer, which
1594  * will attempt to take the lock. */
1595 int usbi_handle_transfer_cancellation(struct usbi_transfer *transfer)
1596 {
1597         /* if the URB was cancelled due to timeout, report timeout to the user */
1598         if (transfer->flags & USBI_TRANSFER_TIMED_OUT) {
1599                 usbi_dbg("detected timeout cancellation");
1600                 return usbi_handle_transfer_completion(transfer, LIBUSB_TRANSFER_TIMED_OUT);
1601         }
1602
1603         /* otherwise its a normal async cancel */
1604         return usbi_handle_transfer_completion(transfer, LIBUSB_TRANSFER_CANCELLED);
1605 }
1606
1607 /** \ingroup poll
1608  * Attempt to acquire the event handling lock. This lock is used to ensure that
1609  * only one thread is monitoring libusb event sources at any one time.
1610  *
1611  * You only need to use this lock if you are developing an application
1612  * which calls poll() or select() on libusb's file descriptors directly.
1613  * If you stick to libusb's event handling loop functions (e.g.
1614  * libusb_handle_events()) then you do not need to be concerned with this
1615  * locking.
1616  *
1617  * While holding this lock, you are trusted to actually be handling events.
1618  * If you are no longer handling events, you must call libusb_unlock_events()
1619  * as soon as possible.
1620  *
1621  * \param ctx the context to operate on, or NULL for the default context
1622  * \returns 0 if the lock was obtained successfully
1623  * \returns 1 if the lock was not obtained (i.e. another thread holds the lock)
1624  * \ref mtasync
1625  */
1626 int API_EXPORTED libusb_try_lock_events(libusb_context *ctx)
1627 {
1628         int r;
1629         unsigned int ru;
1630         USBI_GET_CONTEXT(ctx);
1631
1632         /* is someone else waiting to close a device? if so, don't let this thread
1633          * start event handling */
1634         usbi_mutex_lock(&ctx->event_data_lock);
1635         ru = ctx->device_close;
1636         usbi_mutex_unlock(&ctx->event_data_lock);
1637         if (ru) {
1638                 usbi_dbg("someone else is closing a device");
1639                 return 1;
1640         }
1641
1642         r = usbi_mutex_trylock(&ctx->events_lock);
1643         if (r)
1644                 return 1;
1645
1646         ctx->event_handler_active = 1;
1647         return 0;
1648 }
1649
1650 /** \ingroup poll
1651  * Acquire the event handling lock, blocking until successful acquisition if
1652  * it is contended. This lock is used to ensure that only one thread is
1653  * monitoring libusb event sources at any one time.
1654  *
1655  * You only need to use this lock if you are developing an application
1656  * which calls poll() or select() on libusb's file descriptors directly.
1657  * If you stick to libusb's event handling loop functions (e.g.
1658  * libusb_handle_events()) then you do not need to be concerned with this
1659  * locking.
1660  *
1661  * While holding this lock, you are trusted to actually be handling events.
1662  * If you are no longer handling events, you must call libusb_unlock_events()
1663  * as soon as possible.
1664  *
1665  * \param ctx the context to operate on, or NULL for the default context
1666  * \ref mtasync
1667  */
1668 void API_EXPORTED libusb_lock_events(libusb_context *ctx)
1669 {
1670         USBI_GET_CONTEXT(ctx);
1671         usbi_mutex_lock(&ctx->events_lock);
1672         ctx->event_handler_active = 1;
1673 }
1674
1675 /** \ingroup poll
1676  * Release the lock previously acquired with libusb_try_lock_events() or
1677  * libusb_lock_events(). Releasing this lock will wake up any threads blocked
1678  * on libusb_wait_for_event().
1679  *
1680  * \param ctx the context to operate on, or NULL for the default context
1681  * \ref mtasync
1682  */
1683 void API_EXPORTED libusb_unlock_events(libusb_context *ctx)
1684 {
1685         USBI_GET_CONTEXT(ctx);
1686         ctx->event_handler_active = 0;
1687         usbi_mutex_unlock(&ctx->events_lock);
1688
1689         /* FIXME: perhaps we should be a bit more efficient by not broadcasting
1690          * the availability of the events lock when we are modifying pollfds
1691          * (check ctx->device_close)? */
1692         usbi_mutex_lock(&ctx->event_waiters_lock);
1693         usbi_cond_broadcast(&ctx->event_waiters_cond);
1694         usbi_mutex_unlock(&ctx->event_waiters_lock);
1695 }
1696
1697 /** \ingroup poll
1698  * Determine if it is still OK for this thread to be doing event handling.
1699  *
1700  * Sometimes, libusb needs to temporarily pause all event handlers, and this
1701  * is the function you should use before polling file descriptors to see if
1702  * this is the case.
1703  *
1704  * If this function instructs your thread to give up the events lock, you
1705  * should just continue the usual logic that is documented in \ref mtasync.
1706  * On the next iteration, your thread will fail to obtain the events lock,
1707  * and will hence become an event waiter.
1708  *
1709  * This function should be called while the events lock is held: you don't
1710  * need to worry about the results of this function if your thread is not
1711  * the current event handler.
1712  *
1713  * \param ctx the context to operate on, or NULL for the default context
1714  * \returns 1 if event handling can start or continue
1715  * \returns 0 if this thread must give up the events lock
1716  * \ref fullstory "Multi-threaded I/O: the full story"
1717  */
1718 int API_EXPORTED libusb_event_handling_ok(libusb_context *ctx)
1719 {
1720         unsigned int r;
1721         USBI_GET_CONTEXT(ctx);
1722
1723         /* is someone else waiting to close a device? if so, don't let this thread
1724          * continue event handling */
1725         usbi_mutex_lock(&ctx->event_data_lock);
1726         r = ctx->device_close;
1727         usbi_mutex_unlock(&ctx->event_data_lock);
1728         if (r) {
1729                 usbi_dbg("someone else is closing a device");
1730                 return 0;
1731         }
1732
1733         return 1;
1734 }
1735
1736
1737 /** \ingroup poll
1738  * Determine if an active thread is handling events (i.e. if anyone is holding
1739  * the event handling lock).
1740  *
1741  * \param ctx the context to operate on, or NULL for the default context
1742  * \returns 1 if a thread is handling events
1743  * \returns 0 if there are no threads currently handling events
1744  * \ref mtasync
1745  */
1746 int API_EXPORTED libusb_event_handler_active(libusb_context *ctx)
1747 {
1748         unsigned int r;
1749         USBI_GET_CONTEXT(ctx);
1750
1751         /* is someone else waiting to close a device? if so, don't let this thread
1752          * start event handling -- indicate that event handling is happening */
1753         usbi_mutex_lock(&ctx->event_data_lock);
1754         r = ctx->device_close;
1755         usbi_mutex_unlock(&ctx->event_data_lock);
1756         if (r) {
1757                 usbi_dbg("someone else is closing a device");
1758                 return 1;
1759         }
1760
1761         return ctx->event_handler_active;
1762 }
1763
1764 /** \ingroup poll
1765  * Acquire the event waiters lock. This lock is designed to be obtained under
1766  * the situation where you want to be aware when events are completed, but
1767  * some other thread is event handling so calling libusb_handle_events() is not
1768  * allowed.
1769  *
1770  * You then obtain this lock, re-check that another thread is still handling
1771  * events, then call libusb_wait_for_event().
1772  *
1773  * You only need to use this lock if you are developing an application
1774  * which calls poll() or select() on libusb's file descriptors directly,
1775  * <b>and</b> may potentially be handling events from 2 threads simultaenously.
1776  * If you stick to libusb's event handling loop functions (e.g.
1777  * libusb_handle_events()) then you do not need to be concerned with this
1778  * locking.
1779  *
1780  * \param ctx the context to operate on, or NULL for the default context
1781  * \ref mtasync
1782  */
1783 void API_EXPORTED libusb_lock_event_waiters(libusb_context *ctx)
1784 {
1785         USBI_GET_CONTEXT(ctx);
1786         usbi_mutex_lock(&ctx->event_waiters_lock);
1787 }
1788
1789 /** \ingroup poll
1790  * Release the event waiters lock.
1791  * \param ctx the context to operate on, or NULL for the default context
1792  * \ref mtasync
1793  */
1794 void API_EXPORTED libusb_unlock_event_waiters(libusb_context *ctx)
1795 {
1796         USBI_GET_CONTEXT(ctx);
1797         usbi_mutex_unlock(&ctx->event_waiters_lock);
1798 }
1799
1800 /** \ingroup poll
1801  * Wait for another thread to signal completion of an event. Must be called
1802  * with the event waiters lock held, see libusb_lock_event_waiters().
1803  *
1804  * This function will block until any of the following conditions are met:
1805  * -# The timeout expires
1806  * -# A transfer completes
1807  * -# A thread releases the event handling lock through libusb_unlock_events()
1808  *
1809  * Condition 1 is obvious. Condition 2 unblocks your thread <em>after</em>
1810  * the callback for the transfer has completed. Condition 3 is important
1811  * because it means that the thread that was previously handling events is no
1812  * longer doing so, so if any events are to complete, another thread needs to
1813  * step up and start event handling.
1814  *
1815  * This function releases the event waiters lock before putting your thread
1816  * to sleep, and reacquires the lock as it is being woken up.
1817  *
1818  * \param ctx the context to operate on, or NULL for the default context
1819  * \param tv maximum timeout for this blocking function. A NULL value
1820  * indicates unlimited timeout.
1821  * \returns 0 after a transfer completes or another thread stops event handling
1822  * \returns 1 if the timeout expired
1823  * \ref mtasync
1824  */
1825 int API_EXPORTED libusb_wait_for_event(libusb_context *ctx, struct timeval *tv)
1826 {
1827         struct timespec timeout;
1828         int r;
1829
1830         USBI_GET_CONTEXT(ctx);
1831         if (tv == NULL) {
1832                 usbi_cond_wait(&ctx->event_waiters_cond, &ctx->event_waiters_lock);
1833                 return 0;
1834         }
1835
1836         r = usbi_backend->clock_gettime(USBI_CLOCK_REALTIME, &timeout);
1837         if (r < 0) {
1838                 usbi_err(ctx, "failed to read realtime clock, error %d", errno);
1839                 return LIBUSB_ERROR_OTHER;
1840         }
1841
1842         timeout.tv_sec += tv->tv_sec;
1843         timeout.tv_nsec += tv->tv_usec * 1000;
1844         while (timeout.tv_nsec >= 1000000000) {
1845                 timeout.tv_nsec -= 1000000000;
1846                 timeout.tv_sec++;
1847         }
1848
1849         r = usbi_cond_timedwait(&ctx->event_waiters_cond,
1850                 &ctx->event_waiters_lock, &timeout);
1851         return (r == ETIMEDOUT);
1852 }
1853
1854 static void handle_timeout(struct usbi_transfer *itransfer)
1855 {
1856         struct libusb_transfer *transfer =
1857                 USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
1858         int r;
1859
1860         itransfer->flags |= USBI_TRANSFER_TIMED_OUT;
1861         r = libusb_cancel_transfer(transfer);
1862         if (r < 0)
1863                 usbi_warn(TRANSFER_CTX(transfer),
1864                         "async cancel failed %d errno=%d", r, errno);
1865 }
1866
1867 static int handle_timeouts_locked(struct libusb_context *ctx)
1868 {
1869         int r;
1870         struct timespec systime_ts;
1871         struct timeval systime;
1872         struct usbi_transfer *transfer;
1873
1874         if (list_empty(&ctx->flying_transfers))
1875                 return 0;
1876
1877         /* get current time */
1878         r = usbi_backend->clock_gettime(USBI_CLOCK_MONOTONIC, &systime_ts);
1879         if (r < 0)
1880                 return r;
1881
1882         TIMESPEC_TO_TIMEVAL(&systime, &systime_ts);
1883
1884         /* iterate through flying transfers list, finding all transfers that
1885          * have expired timeouts */
1886         list_for_each_entry(transfer, &ctx->flying_transfers, list, struct usbi_transfer) {
1887                 struct timeval *cur_tv = &transfer->timeout;
1888
1889                 /* if we've reached transfers of infinite timeout, we're all done */
1890                 if (!timerisset(cur_tv))
1891                         return 0;
1892
1893                 /* ignore timeouts we've already handled */
1894                 if (transfer->flags & (USBI_TRANSFER_TIMED_OUT | USBI_TRANSFER_OS_HANDLES_TIMEOUT))
1895                         continue;
1896
1897                 /* if transfer has non-expired timeout, nothing more to do */
1898                 if ((cur_tv->tv_sec > systime.tv_sec) ||
1899                                 (cur_tv->tv_sec == systime.tv_sec &&
1900                                         cur_tv->tv_usec > systime.tv_usec))
1901                         return 0;
1902
1903                 /* otherwise, we've got an expired timeout to handle */
1904                 handle_timeout(transfer);
1905         }
1906         return 0;
1907 }
1908
1909 static int handle_timeouts(struct libusb_context *ctx)
1910 {
1911         int r;
1912         USBI_GET_CONTEXT(ctx);
1913         usbi_mutex_lock(&ctx->flying_transfers_lock);
1914         r = handle_timeouts_locked(ctx);
1915         usbi_mutex_unlock(&ctx->flying_transfers_lock);
1916         return r;
1917 }
1918
1919 #ifdef USBI_TIMERFD_AVAILABLE
1920 static int handle_timerfd_trigger(struct libusb_context *ctx)
1921 {
1922         int r;
1923
1924         usbi_mutex_lock(&ctx->flying_transfers_lock);
1925
1926         /* process the timeout that just happened */
1927         r = handle_timeouts_locked(ctx);
1928         if (r < 0)
1929                 goto out;
1930
1931         /* arm for next timeout*/
1932         r = arm_timerfd_for_next_timeout(ctx);
1933
1934 out:
1935         usbi_mutex_unlock(&ctx->flying_transfers_lock);
1936         return r;
1937 }
1938 #endif
1939
1940 /* do the actual event handling. assumes that no other thread is concurrently
1941  * doing the same thing. */
1942 static int handle_events(struct libusb_context *ctx, struct timeval *tv)
1943 {
1944         int r;
1945         struct usbi_pollfd *ipollfd;
1946         POLL_NFDS_TYPE nfds = 0;
1947         POLL_NFDS_TYPE internal_nfds;
1948         struct pollfd *fds = NULL;
1949         int i = -1;
1950         int timeout_ms;
1951         int special_event;
1952
1953         /* there are certain fds that libusb uses internally, currently:
1954          *
1955          *   1) event pipe
1956          *   2) timerfd
1957          *
1958          * the backend will never need to attempt to handle events on these fds, so
1959          * we determine how many fds are in use internally for this context and when
1960          * handle_events() is called in the backend, the pollfd list and count will
1961          * be adjusted to skip over these internal fds */
1962         if (usbi_using_timerfd(ctx))
1963                 internal_nfds = 2;
1964         else
1965                 internal_nfds = 1;
1966
1967         /* only reallocate the poll fds when the list of poll fds has been modified
1968          * since the last poll, otherwise reuse them to save the additional overhead */
1969         usbi_mutex_lock(&ctx->event_data_lock);
1970         if (ctx->pollfds_modified) {
1971                 usbi_dbg("poll fds modified, reallocating");
1972
1973                 if (ctx->pollfds) {
1974                         free(ctx->pollfds);
1975                         ctx->pollfds = NULL;
1976                 }
1977
1978                 /* sanity check - it is invalid for a context to have fewer than the
1979                  * required internal fds (memory corruption?) */
1980                 assert(ctx->pollfds_cnt >= internal_nfds);
1981
1982                 ctx->pollfds = calloc(ctx->pollfds_cnt, sizeof(*ctx->pollfds));
1983                 if (!ctx->pollfds) {
1984                         usbi_mutex_unlock(&ctx->event_data_lock);
1985                         return LIBUSB_ERROR_NO_MEM;
1986                 }
1987
1988                 list_for_each_entry(ipollfd, &ctx->ipollfds, list, struct usbi_pollfd) {
1989                         struct libusb_pollfd *pollfd = &ipollfd->pollfd;
1990                         i++;
1991                         ctx->pollfds[i].fd = pollfd->fd;
1992                         ctx->pollfds[i].events = pollfd->events;
1993                 }
1994
1995                 /* reset the flag now that we have the updated list */
1996                 ctx->pollfds_modified = 0;
1997
1998                 /* if no further pending events, clear the event pipe so that we do
1999                  * not immediately return from poll */
2000                 if (!usbi_pending_events(ctx))
2001                         usbi_clear_event(ctx);
2002         }
2003         fds = ctx->pollfds;
2004         nfds = ctx->pollfds_cnt;
2005         usbi_mutex_unlock(&ctx->event_data_lock);
2006
2007         timeout_ms = (int)(tv->tv_sec * 1000) + (tv->tv_usec / 1000);
2008
2009         /* round up to next millisecond */
2010         if (tv->tv_usec % 1000)
2011                 timeout_ms++;
2012
2013 redo_poll:
2014         usbi_dbg("poll() %d fds with timeout in %dms", nfds, timeout_ms);
2015         r = usbi_poll(fds, nfds, timeout_ms);
2016         usbi_dbg("poll() returned %d", r);
2017         if (r == 0)
2018                 return handle_timeouts(ctx);
2019         else if (r == -1 && errno == EINTR)
2020                 return LIBUSB_ERROR_INTERRUPTED;
2021         else if (r < 0) {
2022                 usbi_err(ctx, "poll failed %d err=%d\n", r, errno);
2023                 return LIBUSB_ERROR_IO;
2024         }
2025
2026         special_event = 0;
2027
2028         /* fds[0] is always the event pipe */
2029         if (fds[0].revents) {
2030                 libusb_hotplug_message *message = NULL;
2031
2032                 usbi_dbg("caught a fish on the event pipe");
2033
2034                 /* take the the event data lock while processing events */
2035                 usbi_mutex_lock(&ctx->event_data_lock);
2036
2037                 /* check if someone added a new poll fd */
2038                 if (ctx->pollfds_modified)
2039                         usbi_dbg("someone updated the poll fds");
2040
2041                 /* check if someone is closing a device */
2042                 if (ctx->device_close)
2043                         usbi_dbg("someone is closing a device");
2044
2045                 /* check for any pending hotplug messages */
2046                 if (!list_empty(&ctx->hotplug_msgs)) {
2047                         usbi_dbg("hotplug message received");
2048                         special_event = 1;
2049                         message = list_first_entry(&ctx->hotplug_msgs, libusb_hotplug_message, list);
2050                         list_del(&message->list);
2051                 }
2052
2053                 /* if no further pending events, clear the event pipe */
2054                 if (!usbi_pending_events(ctx))
2055                         usbi_clear_event(ctx);
2056
2057                 usbi_mutex_unlock(&ctx->event_data_lock);
2058
2059                 /* process the hotplug message, if any */
2060                 if (message) {
2061                         usbi_hotplug_match(ctx, message->device, message->event);
2062
2063                         /* the device left, dereference the device */
2064                         if (LIBUSB_HOTPLUG_EVENT_DEVICE_LEFT == message->event)
2065                                 libusb_unref_device(message->device);
2066
2067                         free(message);
2068                 }
2069
2070                 if (0 == --r)
2071                         goto handled;
2072         }
2073
2074 #ifdef USBI_TIMERFD_AVAILABLE
2075         /* on timerfd configurations, fds[1] is the timerfd */
2076         if (usbi_using_timerfd(ctx) && fds[1].revents) {
2077                 /* timerfd indicates that a timeout has expired */
2078                 int ret;
2079                 usbi_dbg("timerfd triggered");
2080                 special_event = 1;
2081
2082                 ret = handle_timerfd_trigger(ctx);
2083                 if (ret < 0) {
2084                         /* return error code */
2085                         r = ret;
2086                         goto handled;
2087                 }
2088
2089                 if (0 == --r)
2090                         goto handled;
2091         }
2092 #endif
2093
2094         r = usbi_backend->handle_events(ctx, fds + internal_nfds, nfds - internal_nfds, r);
2095         if (r)
2096                 usbi_err(ctx, "backend handle_events failed with error %d", r);
2097
2098 handled:
2099         if (r == 0 && special_event) {
2100                 timeout_ms = 0;
2101                 goto redo_poll;
2102         }
2103
2104         return r;
2105 }
2106
2107 /* returns the smallest of:
2108  *  1. timeout of next URB
2109  *  2. user-supplied timeout
2110  * returns 1 if there is an already-expired timeout, otherwise returns 0
2111  * and populates out
2112  */
2113 static int get_next_timeout(libusb_context *ctx, struct timeval *tv,
2114         struct timeval *out)
2115 {
2116         struct timeval timeout;
2117         int r = libusb_get_next_timeout(ctx, &timeout);
2118         if (r) {
2119                 /* timeout already expired? */
2120                 if (!timerisset(&timeout))
2121                         return 1;
2122
2123                 /* choose the smallest of next URB timeout or user specified timeout */
2124                 if (timercmp(&timeout, tv, <))
2125                         *out = timeout;
2126                 else
2127                         *out = *tv;
2128         } else {
2129                 *out = *tv;
2130         }
2131         return 0;
2132 }
2133
2134 /** \ingroup poll
2135  * Handle any pending events.
2136  *
2137  * libusb determines "pending events" by checking if any timeouts have expired
2138  * and by checking the set of file descriptors for activity.
2139  *
2140  * If a zero timeval is passed, this function will handle any already-pending
2141  * events and then immediately return in non-blocking style.
2142  *
2143  * If a non-zero timeval is passed and no events are currently pending, this
2144  * function will block waiting for events to handle up until the specified
2145  * timeout. If an event arrives or a signal is raised, this function will
2146  * return early.
2147  *
2148  * If the parameter completed is not NULL then <em>after obtaining the event
2149  * handling lock</em> this function will return immediately if the integer
2150  * pointed to is not 0. This allows for race free waiting for the completion
2151  * of a specific transfer.
2152  *
2153  * \param ctx the context to operate on, or NULL for the default context
2154  * \param tv the maximum time to block waiting for events, or an all zero
2155  * timeval struct for non-blocking mode
2156  * \param completed pointer to completion integer to check, or NULL
2157  * \returns 0 on success, or a LIBUSB_ERROR code on failure
2158  * \ref mtasync
2159  */
2160 int API_EXPORTED libusb_handle_events_timeout_completed(libusb_context *ctx,
2161         struct timeval *tv, int *completed)
2162 {
2163         int r;
2164         struct timeval poll_timeout;
2165
2166         USBI_GET_CONTEXT(ctx);
2167         r = get_next_timeout(ctx, tv, &poll_timeout);
2168         if (r) {
2169                 /* timeout already expired */
2170                 return handle_timeouts(ctx);
2171         }
2172
2173 retry:
2174         if (libusb_try_lock_events(ctx) == 0) {
2175                 if (completed == NULL || !*completed) {
2176                         /* we obtained the event lock: do our own event handling */
2177                         usbi_dbg("doing our own event handling");
2178                         r = handle_events(ctx, &poll_timeout);
2179                 }
2180                 libusb_unlock_events(ctx);
2181                 return r;
2182         }
2183
2184         /* another thread is doing event handling. wait for thread events that
2185          * notify event completion. */
2186         libusb_lock_event_waiters(ctx);
2187
2188         if (completed && *completed)
2189                 goto already_done;
2190
2191         if (!libusb_event_handler_active(ctx)) {
2192                 /* we hit a race: whoever was event handling earlier finished in the
2193                  * time it took us to reach this point. try the cycle again. */
2194                 libusb_unlock_event_waiters(ctx);
2195                 usbi_dbg("event handler was active but went away, retrying");
2196                 goto retry;
2197         }
2198
2199         usbi_dbg("another thread is doing event handling");
2200         r = libusb_wait_for_event(ctx, &poll_timeout);
2201
2202 already_done:
2203         libusb_unlock_event_waiters(ctx);
2204
2205         if (r < 0)
2206                 return r;
2207         else if (r == 1)
2208                 return handle_timeouts(ctx);
2209         else
2210                 return 0;
2211 }
2212
2213 /** \ingroup poll
2214  * Handle any pending events
2215  *
2216  * Like libusb_handle_events_timeout_completed(), but without the completed
2217  * parameter, calling this function is equivalent to calling
2218  * libusb_handle_events_timeout_completed() with a NULL completed parameter.
2219  *
2220  * This function is kept primarily for backwards compatibility.
2221  * All new code should call libusb_handle_events_completed() or
2222  * libusb_handle_events_timeout_completed() to avoid race conditions.
2223  *
2224  * \param ctx the context to operate on, or NULL for the default context
2225  * \param tv the maximum time to block waiting for events, or an all zero
2226  * timeval struct for non-blocking mode
2227  * \returns 0 on success, or a LIBUSB_ERROR code on failure
2228  */
2229 int API_EXPORTED libusb_handle_events_timeout(libusb_context *ctx,
2230         struct timeval *tv)
2231 {
2232         return libusb_handle_events_timeout_completed(ctx, tv, NULL);
2233 }
2234
2235 /** \ingroup poll
2236  * Handle any pending events in blocking mode. There is currently a timeout
2237  * hardcoded at 60 seconds but we plan to make it unlimited in future. For
2238  * finer control over whether this function is blocking or non-blocking, or
2239  * for control over the timeout, use libusb_handle_events_timeout_completed()
2240  * instead.
2241  *
2242  * This function is kept primarily for backwards compatibility.
2243  * All new code should call libusb_handle_events_completed() or
2244  * libusb_handle_events_timeout_completed() to avoid race conditions.
2245  *
2246  * \param ctx the context to operate on, or NULL for the default context
2247  * \returns 0 on success, or a LIBUSB_ERROR code on failure
2248  */
2249 int API_EXPORTED libusb_handle_events(libusb_context *ctx)
2250 {
2251         struct timeval tv;
2252         tv.tv_sec = 60;
2253         tv.tv_usec = 0;
2254         return libusb_handle_events_timeout_completed(ctx, &tv, NULL);
2255 }
2256
2257 /** \ingroup poll
2258  * Handle any pending events in blocking mode.
2259  *
2260  * Like libusb_handle_events(), with the addition of a completed parameter
2261  * to allow for race free waiting for the completion of a specific transfer.
2262  *
2263  * See libusb_handle_events_timeout_completed() for details on the completed
2264  * parameter.
2265  *
2266  * \param ctx the context to operate on, or NULL for the default context
2267  * \param completed pointer to completion integer to check, or NULL
2268  * \returns 0 on success, or a LIBUSB_ERROR code on failure
2269  * \ref mtasync
2270  */
2271 int API_EXPORTED libusb_handle_events_completed(libusb_context *ctx,
2272         int *completed)
2273 {
2274         struct timeval tv;
2275         tv.tv_sec = 60;
2276         tv.tv_usec = 0;
2277         return libusb_handle_events_timeout_completed(ctx, &tv, completed);
2278 }
2279
2280 /** \ingroup poll
2281  * Handle any pending events by polling file descriptors, without checking if
2282  * any other threads are already doing so. Must be called with the event lock
2283  * held, see libusb_lock_events().
2284  *
2285  * This function is designed to be called under the situation where you have
2286  * taken the event lock and are calling poll()/select() directly on libusb's
2287  * file descriptors (as opposed to using libusb_handle_events() or similar).
2288  * You detect events on libusb's descriptors, so you then call this function
2289  * with a zero timeout value (while still holding the event lock).
2290  *
2291  * \param ctx the context to operate on, or NULL for the default context
2292  * \param tv the maximum time to block waiting for events, or zero for
2293  * non-blocking mode
2294  * \returns 0 on success, or a LIBUSB_ERROR code on failure
2295  * \ref mtasync
2296  */
2297 int API_EXPORTED libusb_handle_events_locked(libusb_context *ctx,
2298         struct timeval *tv)
2299 {
2300         int r;
2301         struct timeval poll_timeout;
2302
2303         USBI_GET_CONTEXT(ctx);
2304         r = get_next_timeout(ctx, tv, &poll_timeout);
2305         if (r) {
2306                 /* timeout already expired */
2307                 return handle_timeouts(ctx);
2308         }
2309
2310         return handle_events(ctx, &poll_timeout);
2311 }
2312
2313 /** \ingroup poll
2314  * Determines whether your application must apply special timing considerations
2315  * when monitoring libusb's file descriptors.
2316  *
2317  * This function is only useful for applications which retrieve and poll
2318  * libusb's file descriptors in their own main loop (\ref pollmain).
2319  *
2320  * Ordinarily, libusb's event handler needs to be called into at specific
2321  * moments in time (in addition to times when there is activity on the file
2322  * descriptor set). The usual approach is to use libusb_get_next_timeout()
2323  * to learn about when the next timeout occurs, and to adjust your
2324  * poll()/select() timeout accordingly so that you can make a call into the
2325  * library at that time.
2326  *
2327  * Some platforms supported by libusb do not come with this baggage - any
2328  * events relevant to timing will be represented by activity on the file
2329  * descriptor set, and libusb_get_next_timeout() will always return 0.
2330  * This function allows you to detect whether you are running on such a
2331  * platform.
2332  *
2333  * Since v1.0.5.
2334  *
2335  * \param ctx the context to operate on, or NULL for the default context
2336  * \returns 0 if you must call into libusb at times determined by
2337  * libusb_get_next_timeout(), or 1 if all timeout events are handled internally
2338  * or through regular activity on the file descriptors.
2339  * \ref pollmain "Polling libusb file descriptors for event handling"
2340  */
2341 int API_EXPORTED libusb_pollfds_handle_timeouts(libusb_context *ctx)
2342 {
2343 #if defined(USBI_TIMERFD_AVAILABLE)
2344         USBI_GET_CONTEXT(ctx);
2345         return usbi_using_timerfd(ctx);
2346 #else
2347         (void)ctx;
2348         return 0;
2349 #endif
2350 }
2351
2352 /** \ingroup poll
2353  * Determine the next internal timeout that libusb needs to handle. You only
2354  * need to use this function if you are calling poll() or select() or similar
2355  * on libusb's file descriptors yourself - you do not need to use it if you
2356  * are calling libusb_handle_events() or a variant directly.
2357  *
2358  * You should call this function in your main loop in order to determine how
2359  * long to wait for select() or poll() to return results. libusb needs to be
2360  * called into at this timeout, so you should use it as an upper bound on
2361  * your select() or poll() call.
2362  *
2363  * When the timeout has expired, call into libusb_handle_events_timeout()
2364  * (perhaps in non-blocking mode) so that libusb can handle the timeout.
2365  *
2366  * This function may return 1 (success) and an all-zero timeval. If this is
2367  * the case, it indicates that libusb has a timeout that has already expired
2368  * so you should call libusb_handle_events_timeout() or similar immediately.
2369  * A return code of 0 indicates that there are no pending timeouts.
2370  *
2371  * On some platforms, this function will always returns 0 (no pending
2372  * timeouts). See \ref polltime.
2373  *
2374  * \param ctx the context to operate on, or NULL for the default context
2375  * \param tv output location for a relative time against the current
2376  * clock in which libusb must be called into in order to process timeout events
2377  * \returns 0 if there are no pending timeouts, 1 if a timeout was returned,
2378  * or LIBUSB_ERROR_OTHER on failure
2379  */
2380 int API_EXPORTED libusb_get_next_timeout(libusb_context *ctx,
2381         struct timeval *tv)
2382 {
2383         struct usbi_transfer *transfer;
2384         struct timespec cur_ts;
2385         struct timeval cur_tv;
2386         struct timeval *next_timeout;
2387         int r;
2388         int found = 0;
2389
2390         USBI_GET_CONTEXT(ctx);
2391         if (usbi_using_timerfd(ctx))
2392                 return 0;
2393
2394         usbi_mutex_lock(&ctx->flying_transfers_lock);
2395         if (list_empty(&ctx->flying_transfers)) {
2396                 usbi_mutex_unlock(&ctx->flying_transfers_lock);
2397                 usbi_dbg("no URBs, no timeout!");
2398                 return 0;
2399         }
2400
2401         /* find next transfer which hasn't already been processed as timed out */
2402         list_for_each_entry(transfer, &ctx->flying_transfers, list, struct usbi_transfer) {
2403                 if (transfer->flags & (USBI_TRANSFER_TIMED_OUT | USBI_TRANSFER_OS_HANDLES_TIMEOUT))
2404                         continue;
2405
2406                 /* no timeout for this transfer? */
2407                 if (!timerisset(&transfer->timeout))
2408                         continue;
2409
2410                 found = 1;
2411                 break;
2412         }
2413         usbi_mutex_unlock(&ctx->flying_transfers_lock);
2414
2415         if (!found) {
2416                 usbi_dbg("no URB with timeout or all handled by OS; no timeout!");
2417                 return 0;
2418         }
2419
2420         next_timeout = &transfer->timeout;
2421
2422         r = usbi_backend->clock_gettime(USBI_CLOCK_MONOTONIC, &cur_ts);
2423         if (r < 0) {
2424                 usbi_err(ctx, "failed to read monotonic clock, errno=%d", errno);
2425                 return 0;
2426         }
2427         TIMESPEC_TO_TIMEVAL(&cur_tv, &cur_ts);
2428
2429         if (!timercmp(&cur_tv, next_timeout, <)) {
2430                 usbi_dbg("first timeout already expired");
2431                 timerclear(tv);
2432         } else {
2433                 timersub(next_timeout, &cur_tv, tv);
2434                 usbi_dbg("next timeout in %d.%06ds", tv->tv_sec, tv->tv_usec);
2435         }
2436
2437         return 1;
2438 }
2439
2440 /** \ingroup poll
2441  * Register notification functions for file descriptor additions/removals.
2442  * These functions will be invoked for every new or removed file descriptor
2443  * that libusb uses as an event source.
2444  *
2445  * To remove notifiers, pass NULL values for the function pointers.
2446  *
2447  * Note that file descriptors may have been added even before you register
2448  * these notifiers (e.g. at libusb_init() time).
2449  *
2450  * Additionally, note that the removal notifier may be called during
2451  * libusb_exit() (e.g. when it is closing file descriptors that were opened
2452  * and added to the poll set at libusb_init() time). If you don't want this,
2453  * remove the notifiers immediately before calling libusb_exit().
2454  *
2455  * \param ctx the context to operate on, or NULL for the default context
2456  * \param added_cb pointer to function for addition notifications
2457  * \param removed_cb pointer to function for removal notifications
2458  * \param user_data User data to be passed back to callbacks (useful for
2459  * passing context information)
2460  */
2461 void API_EXPORTED libusb_set_pollfd_notifiers(libusb_context *ctx,
2462         libusb_pollfd_added_cb added_cb, libusb_pollfd_removed_cb removed_cb,
2463         void *user_data)
2464 {
2465         USBI_GET_CONTEXT(ctx);
2466         ctx->fd_added_cb = added_cb;
2467         ctx->fd_removed_cb = removed_cb;
2468         ctx->fd_cb_user_data = user_data;
2469 }
2470
2471 /*
2472  * Interrupt the iteration of the event handling thread, so that it picks
2473  * up the fd change. Callers of this function must hold the event_data_lock.
2474  */
2475 static void usbi_fd_notification(struct libusb_context *ctx)
2476 {
2477         int pending_events;
2478
2479         /* Record that there is a new poll fd.
2480          * Only signal an event if there are no prior pending events. */
2481         pending_events = usbi_pending_events(ctx);
2482         ctx->pollfds_modified = 1;
2483         if (!pending_events)
2484                 usbi_signal_event(ctx);
2485 }
2486
2487 /* Add a file descriptor to the list of file descriptors to be monitored.
2488  * events should be specified as a bitmask of events passed to poll(), e.g.
2489  * POLLIN and/or POLLOUT. */
2490 int usbi_add_pollfd(struct libusb_context *ctx, int fd, short events)
2491 {
2492         struct usbi_pollfd *ipollfd = malloc(sizeof(*ipollfd));
2493         if (!ipollfd)
2494                 return LIBUSB_ERROR_NO_MEM;
2495
2496         usbi_dbg("add fd %d events %d", fd, events);
2497         ipollfd->pollfd.fd = fd;
2498         ipollfd->pollfd.events = events;
2499         usbi_mutex_lock(&ctx->event_data_lock);
2500         list_add_tail(&ipollfd->list, &ctx->ipollfds);
2501         ctx->pollfds_cnt++;
2502         usbi_fd_notification(ctx);
2503         usbi_mutex_unlock(&ctx->event_data_lock);
2504
2505         if (ctx->fd_added_cb)
2506                 ctx->fd_added_cb(fd, events, ctx->fd_cb_user_data);
2507         return 0;
2508 }
2509
2510 /* Remove a file descriptor from the list of file descriptors to be polled. */
2511 void usbi_remove_pollfd(struct libusb_context *ctx, int fd)
2512 {
2513         struct usbi_pollfd *ipollfd;
2514         int found = 0;
2515
2516         usbi_dbg("remove fd %d", fd);
2517         usbi_mutex_lock(&ctx->event_data_lock);
2518         list_for_each_entry(ipollfd, &ctx->ipollfds, list, struct usbi_pollfd)
2519                 if (ipollfd->pollfd.fd == fd) {
2520                         found = 1;
2521                         break;
2522                 }
2523
2524         if (!found) {
2525                 usbi_dbg("couldn't find fd %d to remove", fd);
2526                 usbi_mutex_unlock(&ctx->event_data_lock);
2527                 return;
2528         }
2529
2530         list_del(&ipollfd->list);
2531         ctx->pollfds_cnt--;
2532         usbi_fd_notification(ctx);
2533         usbi_mutex_unlock(&ctx->event_data_lock);
2534         free(ipollfd);
2535         if (ctx->fd_removed_cb)
2536                 ctx->fd_removed_cb(fd, ctx->fd_cb_user_data);
2537 }
2538
2539 /** \ingroup poll
2540  * Retrieve a list of file descriptors that should be polled by your main loop
2541  * as libusb event sources.
2542  *
2543  * The returned list is NULL-terminated and should be freed with free() when
2544  * done. The actual list contents must not be touched.
2545  *
2546  * As file descriptors are a Unix-specific concept, this function is not
2547  * available on Windows and will always return NULL.
2548  *
2549  * \param ctx the context to operate on, or NULL for the default context
2550  * \returns a NULL-terminated list of libusb_pollfd structures
2551  * \returns NULL on error
2552  * \returns NULL on platforms where the functionality is not available
2553  */
2554 DEFAULT_VISIBILITY
2555 const struct libusb_pollfd ** LIBUSB_CALL libusb_get_pollfds(
2556         libusb_context *ctx)
2557 {
2558 #ifndef OS_WINDOWS
2559         struct libusb_pollfd **ret = NULL;
2560         struct usbi_pollfd *ipollfd;
2561         size_t i = 0;
2562         USBI_GET_CONTEXT(ctx);
2563
2564         usbi_mutex_lock(&ctx->event_data_lock);
2565
2566         ret = calloc(ctx->pollfds_cnt + 1, sizeof(struct libusb_pollfd *));
2567         if (!ret)
2568                 goto out;
2569
2570         list_for_each_entry(ipollfd, &ctx->ipollfds, list, struct usbi_pollfd)
2571                 ret[i++] = (struct libusb_pollfd *) ipollfd;
2572         ret[ctx->pollfds_cnt] = NULL;
2573
2574 out:
2575         usbi_mutex_unlock(&ctx->event_data_lock);
2576         return (const struct libusb_pollfd **) ret;
2577 #else
2578         usbi_err(ctx, "external polling of libusb's internal descriptors "\
2579                 "is not yet supported on Windows platforms");
2580         return NULL;
2581 #endif
2582 }
2583
2584 /* Backends may call this from handle_events to report disconnection of a
2585  * device. This function ensures transfers get cancelled appropriately.
2586  * Callers of this function must hold the events_lock.
2587  */
2588 void usbi_handle_disconnect(struct libusb_device_handle *handle)
2589 {
2590         struct usbi_transfer *cur;
2591         struct usbi_transfer *to_cancel;
2592
2593         usbi_dbg("device %d.%d",
2594                 handle->dev->bus_number, handle->dev->device_address);
2595
2596         /* terminate all pending transfers with the LIBUSB_TRANSFER_NO_DEVICE
2597          * status code.
2598          *
2599          * this is a bit tricky because:
2600          * 1. we can't do transfer completion while holding flying_transfers_lock
2601          *    because the completion handler may try to re-submit the transfer
2602          * 2. the transfers list can change underneath us - if we were to build a
2603          *    list of transfers to complete (while holding lock), the situation
2604          *    might be different by the time we come to free them
2605          *
2606          * so we resort to a loop-based approach as below
2607          *
2608          * This is safe because transfers are only removed from the
2609          * flying_transfer list by usbi_handle_transfer_completion and
2610          * libusb_close, both of which hold the events_lock while doing so,
2611          * so usbi_handle_disconnect cannot be running at the same time.
2612          *
2613          * Note that libusb_submit_transfer also removes the transfer from
2614          * the flying_transfer list on submission failure, but it keeps the
2615          * flying_transfer list locked between addition and removal, so
2616          * usbi_handle_disconnect never sees such transfers.
2617          */
2618
2619         while (1) {
2620                 usbi_mutex_lock(&HANDLE_CTX(handle)->flying_transfers_lock);
2621                 to_cancel = NULL;
2622                 list_for_each_entry(cur, &HANDLE_CTX(handle)->flying_transfers, list, struct usbi_transfer)
2623                         if (USBI_TRANSFER_TO_LIBUSB_TRANSFER(cur)->dev_handle == handle) {
2624                                 to_cancel = cur;
2625                                 break;
2626                         }
2627                 usbi_mutex_unlock(&HANDLE_CTX(handle)->flying_transfers_lock);
2628
2629                 if (!to_cancel)
2630                         break;
2631
2632                 usbi_dbg("cancelling transfer %p from disconnect",
2633                          USBI_TRANSFER_TO_LIBUSB_TRANSFER(to_cancel));
2634
2635                 usbi_backend->clear_transfer_priv(to_cancel);
2636                 usbi_handle_transfer_completion(to_cancel, LIBUSB_TRANSFER_NO_DEVICE);
2637         }
2638
2639 }