Pause event handling while opening and closing devices
[platform/upstream/libusb.git] / libusb / io.c
1 /*
2  * I/O functions for libusb
3  * Copyright (C) 2007-2008 Daniel Drake <dsd@gentoo.org>
4  * Copyright (c) 2001 Johannes Erdfelt <johannes@erdfelt.com>
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with this library; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19  */
20
21 #include <config.h>
22 #include <errno.h>
23 #include <poll.h>
24 #include <pthread.h>
25 #include <signal.h>
26 #include <stdint.h>
27 #include <stdlib.h>
28 #include <string.h>
29 #include <sys/time.h>
30 #include <time.h>
31 #include <unistd.h>
32
33 #include "libusbi.h"
34
35 /**
36  * \page io Synchronous and asynchronous device I/O
37  *
38  * \section intro Introduction
39  *
40  * If you're using libusb in your application, you're probably wanting to
41  * perform I/O with devices - you want to perform USB data transfers.
42  *
43  * libusb offers two separate interfaces for device I/O. This page aims to
44  * introduce the two in order to help you decide which one is more suitable
45  * for your application. You can also choose to use both interfaces in your
46  * application by considering each transfer on a case-by-case basis.
47  *
48  * Once you have read through the following discussion, you should consult the
49  * detailed API documentation pages for the details:
50  * - \ref syncio
51  * - \ref asyncio
52  *
53  * \section theory Transfers at a logical level
54  *
55  * At a logical level, USB transfers typically happen in two parts. For
56  * example, when reading data from a endpoint:
57  * -# A request for data is sent to the device
58  * -# Some time later, the incoming data is received by the host
59  *
60  * or when writing data to an endpoint:
61  *
62  * -# The data is sent to the device
63  * -# Some time later, the host receives acknowledgement from the device that
64  *    the data has been transferred.
65  *
66  * There may be an indefinite delay between the two steps. Consider a
67  * fictional USB input device with a button that the user can press. In order
68  * to determine when the button is pressed, you would likely submit a request
69  * to read data on a bulk or interrupt endpoint and wait for data to arrive.
70  * Data will arrive when the button is pressed by the user, which is
71  * potentially hours later.
72  *
73  * libusb offers both a synchronous and an asynchronous interface to performing
74  * USB transfers. The main difference is that the synchronous interface
75  * combines both steps indicated above into a single function call, whereas
76  * the asynchronous interface separates them.
77  *
78  * \section sync The synchronous interface
79  *
80  * The synchronous I/O interface allows you to perform a USB transfer with
81  * a single function call. When the function call returns, the transfer has
82  * completed and you can parse the results.
83  *
84  * If you have used the libusb-0.1 before, this I/O style will seem familar to
85  * you. libusb-0.1 only offered a synchronous interface.
86  *
87  * In our input device example, to read button presses you might write code
88  * in the following style:
89 \code
90 unsigned char data[4];
91 int actual_length,
92 int r = libusb_bulk_transfer(handle, EP_IN, data, sizeof(data), &actual_length, 0);
93 if (r == 0 && actual_length == sizeof(data)) {
94         // results of the transaction can now be found in the data buffer
95         // parse them here and report button press
96 } else {
97         error();
98 }
99 \endcode
100  *
101  * The main advantage of this model is simplicity: you did everything with
102  * a single simple function call.
103  *
104  * However, this interface has its limitations. Your application will sleep
105  * inside libusb_bulk_transfer() until the transaction has completed. If it
106  * takes the user 3 hours to press the button, your application will be
107  * sleeping for that long. Execution will be tied up inside the library -
108  * the entire thread will be useless for that duration.
109  *
110  * Another issue is that by tieing up the thread with that single transaction
111  * there is no possibility of performing I/O with multiple endpoints and/or
112  * multiple devices simultaneously, unless you resort to creating one thread
113  * per transaction.
114  *
115  * Additionally, there is no opportunity to cancel the transfer after the
116  * request has been submitted.
117  *
118  * For details on how to use the synchronous API, see the
119  * \ref syncio "synchronous I/O API documentation" pages.
120  * 
121  * \section async The asynchronous interface
122  *
123  * Asynchronous I/O is the most significant new feature in libusb-1.0.
124  * Although it is a more complex interface, it solves all the issues detailed
125  * above.
126  *
127  * Instead of providing which functions that block until the I/O has complete,
128  * libusb's asynchronous interface presents non-blocking functions which
129  * begin a transfer and then return immediately. Your application passes a
130  * callback function pointer to this non-blocking function, which libusb will
131  * call with the results of the transaction when it has completed.
132  *
133  * Transfers which have been submitted through the non-blocking functions
134  * can be cancelled with a separate function call.
135  *
136  * The non-blocking nature of this interface allows you to be simultaneously
137  * performing I/O to multiple endpoints on multiple devices, without having
138  * to use threads.
139  *
140  * This added flexibility does come with some complications though:
141  * - In the interest of being a lightweight library, libusb does not create
142  * threads and can only operate when your application is calling into it. Your
143  * application must call into libusb from it's main loop when events are ready
144  * to be handled, or you must use some other scheme to allow libusb to
145  * undertake whatever work needs to be done.
146  * - libusb also needs to be called into at certain fixed points in time in
147  * order to accurately handle transfer timeouts.
148  * - Memory handling becomes more complex. You cannot use stack memory unless
149  * the function with that stack is guaranteed not to return until the transfer
150  * callback has finished executing.
151  * - You generally lose some linearity from your code flow because submitting
152  * the transfer request is done in a separate function from where the transfer
153  * results are handled. This becomes particularly obvious when you want to
154  * submit a second transfer based on the results of an earlier transfer.
155  *
156  * Internally, libusb's synchronous interface is expressed in terms of function
157  * calls to the asynchronous interface.
158  *
159  * For details on how to use the asynchronous API, see the
160  * \ref asyncio "asynchronous I/O API" documentation pages.
161  */
162
163
164 /**
165  * \page packetoverflow Packets and overflows
166  *
167  * \section packets Packet abstraction
168  *
169  * The USB specifications describe how data is transmitted in packets, with
170  * constraints on packet size defined by endpoint descriptors. The host must
171  * not send data payloads larger than the endpoint's maximum packet size.
172  *
173  * libusb and the underlying OS abstract out the packet concept, allowing you
174  * to request transfers of any size. Internally, the request will be divided
175  * up into correctly-sized packets. You do not have to be concerned with
176  * packet sizes, but there is one exception when considering overflows.
177  *
178  * \section overflow Bulk/interrupt transfer overflows
179  *
180  * When requesting data on a bulk endpoint, libusb requires you to supply a
181  * buffer and the maximum number of bytes of data that libusb can put in that
182  * buffer. However, the size of the buffer is not communicated to the device -
183  * the device is just asked to send any amount of data.
184  *
185  * There is no problem if the device sends an amount of data that is less than
186  * or equal to the buffer size. libusb reports this condition to you through
187  * the \ref libusb_transfer::actual_length "libusb_transfer.actual_length"
188  * field.
189  *
190  * Problems may occur if the device attempts to send more data than can fit in
191  * the buffer. libusb reports LIBUSB_TRANSFER_OVERFLOW for this condition but
192  * other behaviour is largely undefined: actual_length may or may not be
193  * accurate, the chunk of data that can fit in the buffer (before overflow)
194  * may or may not have been transferred.
195  *
196  * Overflows are nasty, but can be avoided. Even though you were told to
197  * ignore packets above, think about the lower level details: each transfer is
198  * split into packets (typically small, with a maximum size of 512 bytes).
199  * Overflows can only happen if the final packet in an incoming data transfer
200  * is smaller than the actual packet that the device wants to transfer.
201  * Therefore, you will never see an overflow if your transfer buffer size is a
202  * multiple of the endpoint's packet size: the final packet will either
203  * fill up completely or will be only partially filled.
204  */
205
206 /**
207  * @defgroup asyncio Asynchronous device I/O
208  *
209  * This page details libusb's asynchronous (non-blocking) API for USB device
210  * I/O. This interface is very powerful but is also quite complex - you will
211  * need to read this page carefully to understand the necessary considerations
212  * and issues surrounding use of this interface. Simplistic applications
213  * may wish to consider the \ref syncio "synchronous I/O API" instead.
214  *
215  * The asynchronous interface is built around the idea of separating transfer
216  * submission and handling of transfer completion (the synchronous model
217  * combines both of these into one). There may be a long delay between
218  * submission and completion, however the asynchronous submission function
219  * is non-blocking so will return control to your application during that
220  * potentially long delay.
221  *
222  * \section asyncabstraction Transfer abstraction
223  *
224  * For the asynchronous I/O, libusb implements the concept of a generic
225  * transfer entity for all types of I/O (control, bulk, interrupt,
226  * isochronous). The generic transfer object must be treated slightly
227  * differently depending on which type of I/O you are performing with it.
228  *
229  * This is represented by the public libusb_transfer structure type.
230  *
231  * \section asynctrf Asynchronous transfers
232  *
233  * We can view asynchronous I/O as a 5 step process:
234  * -# <b>Allocation</b>: allocate a libusb_transfer
235  * -# <b>Filling</b>: populate the libusb_transfer instance with information
236  *    about the transfer you wish to perform
237  * -# <b>Submission</b>: ask libusb to submit the transfer
238  * -# <b>Completion handling</b>: examine transfer results in the
239  *    libusb_transfer structure
240  * -# <b>Deallocation</b>: clean up resources
241  * 
242  *
243  * \subsection asyncalloc Allocation
244  *
245  * This step involves allocating memory for a USB transfer. This is the
246  * generic transfer object mentioned above. At this stage, the transfer
247  * is "blank" with no details about what type of I/O it will be used for.
248  *
249  * Allocation is done with the libusb_alloc_transfer() function. You must use
250  * this function rather than allocating your own transfers.
251  *
252  * \subsection asyncfill Filling
253  *
254  * This step is where you take a previously allocated transfer and fill it
255  * with information to determine the message type and direction, data buffer,
256  * callback function, etc.
257  *
258  * You can either fill the required fields yourself or you can use the
259  * helper functions: libusb_fill_control_transfer(), libusb_fill_bulk_transfer()
260  * and libusb_fill_interrupt_transfer().
261  *
262  * \subsection asyncsubmit Submission
263  *
264  * When you have allocated a transfer and filled it, you can submit it using
265  * libusb_submit_transfer(). This function returns immediately but can be
266  * regarded as firing off the I/O request in the background.
267  *
268  * \subsection asynccomplete Completion handling
269  *
270  * After a transfer has been submitted, one of four things can happen to it:
271  *
272  * - The transfer completes (i.e. some data was transferred)
273  * - The transfer has a timeout and the timeout expires before all data is
274  * transferred
275  * - The transfer fails due to an error
276  * - The transfer is cancelled
277  *
278  * Each of these will cause the user-specified transfer callback function to
279  * be invoked. It is up to the callback function to determine which of the
280  * above actually happened and to act accordingly.
281  *
282  * The user-specified callback is passed a pointer to the libusb_transfer
283  * structure which was used to setup and submit the transfer. At completion
284  * time, libusb has populated this structure with results of the transfer:
285  * success or failure reason, number of bytes of data transferred, etc. See
286  * the libusb_transfer structure documentation for more information.
287  *
288  * \subsection Deallocation
289  *
290  * When a transfer has completed (i.e. the callback function has been invoked),
291  * you are advised to free the transfer (unless you wish to resubmit it, see
292  * below). Transfers are deallocated with libusb_free_transfer().
293  *
294  * It is undefined behaviour to free a transfer which has not completed.
295  *
296  * \section asyncresubmit Resubmission
297  *
298  * You may be wondering why allocation, filling, and submission are all
299  * separated above where they could reasonably be combined into a single
300  * operation.
301  *
302  * The reason for separation is to allow you to resubmit transfers without
303  * having to allocate new ones every time. This is especially useful for
304  * common situations dealing with interrupt endpoints - you allocate one
305  * transfer, fill and submit it, and when it returns with results you just
306  * resubmit it for the next interrupt.
307  *
308  * \section asynccancel Cancellation
309  *
310  * Another advantage of using the asynchronous interface is that you have
311  * the ability to cancel transfers which have not yet completed. This is
312  * done by calling the libusb_cancel_transfer() function.
313  *
314  * libusb_cancel_transfer() is asynchronous/non-blocking in itself. When the
315  * cancellation actually completes, the transfer's callback function will
316  * be invoked, and the callback function should check the transfer status to
317  * determine that it was cancelled.
318  *
319  * Freeing the transfer after it has been cancelled but before cancellation
320  * has completed will result in undefined behaviour.
321  *
322  * \section bulk_overflows Overflows on device-to-host bulk/interrupt endpoints
323  *
324  * If your device does not have predictable transfer sizes (or it misbehaves),
325  * your application may submit a request for data on an IN endpoint which is
326  * smaller than the data that the device wishes to send. In some circumstances
327  * this will cause an overflow, which is a nasty condition to deal with. See
328  * the \ref packetoverflow page for discussion.
329  *
330  * \section asyncctrl Considerations for control transfers
331  *
332  * The <tt>libusb_transfer</tt> structure is generic and hence does not
333  * include specific fields for the control-specific setup packet structure.
334  *
335  * In order to perform a control transfer, you must place the 8-byte setup
336  * packet at the start of the data buffer. To simplify this, you could
337  * cast the buffer pointer to type struct libusb_control_setup, or you can
338  * use the helper function libusb_fill_control_setup().
339  *
340  * The wLength field placed in the setup packet must be the length you would
341  * expect to be sent in the setup packet: the length of the payload that
342  * follows (or the expected maximum number of bytes to receive). However,
343  * the length field of the libusb_transfer object must be the length of
344  * the data buffer - i.e. it should be wLength <em>plus</em> the size of
345  * the setup packet (LIBUSB_CONTROL_SETUP_SIZE).
346  *
347  * If you use the helper functions, this is simplified for you:
348  * -# Allocate a buffer of size LIBUSB_CONTROL_SETUP_SIZE plus the size of the
349  * data you are sending/requesting.
350  * -# Call libusb_fill_control_setup() on the data buffer, using the transfer
351  * request size as the wLength value (i.e. do not include the extra space you
352  * allocated for the control setup).
353  * -# If this is a host-to-device transfer, place the data to be transferred
354  * in the data buffer, starting at offset LIBUSB_CONTROL_SETUP_SIZE.
355  * -# Call libusb_fill_control_transfer() to associate the data buffer with
356  * the transfer (and to set the remaining details such as callback and timeout).
357  *   - Note that there is no parameter to set the length field of the transfer.
358  *     The length is automatically inferred from the wLength field of the setup
359  *     packet.
360  * -# Submit the transfer.
361  *
362  * The multi-byte control setup fields (wValue, wIndex and wLength) must
363  * be given in little-endian byte order (the endianness of the USB bus).
364  * Endianness conversion is transparently handled by
365  * libusb_fill_control_setup() which is documented to accept host-endian
366  * values.
367  *
368  * Further considerations are needed when handling transfer completion in
369  * your callback function:
370  * - As you might expect, the setup packet will still be sitting at the start
371  * of the data buffer.
372  * - If this was a device-to-host transfer, the received data will be sitting
373  * at offset LIBUSB_CONTROL_SETUP_SIZE into the buffer.
374  * - The actual_length field of the transfer structure is relative to the
375  * wLength of the setup packet, rather than the size of the data buffer. So,
376  * if your wLength was 4, your transfer's <tt>length</tt> was 12, then you
377  * should expect an <tt>actual_length</tt> of 4 to indicate that the data was
378  * transferred in entirity.
379  *
380  * To simplify parsing of setup packets and obtaining the data from the
381  * correct offset, you may wish to use the libusb_control_transfer_get_data()
382  * and libusb_control_transfer_get_setup() functions within your transfer
383  * callback.
384  *
385  * Even though control endpoints do not halt, a completed control transfer
386  * may have a LIBUSB_TRANSFER_STALL status code. This indicates the control
387  * request was not supported.
388  *
389  * \section asyncintr Considerations for interrupt transfers
390  * 
391  * All interrupt transfers are performed using the polling interval presented
392  * by the bInterval value of the endpoint descriptor.
393  *
394  * \section asynciso Considerations for isochronous transfers
395  *
396  * Isochronous transfers are more complicated than transfers to
397  * non-isochronous endpoints.
398  *
399  * To perform I/O to an isochronous endpoint, allocate the transfer by calling
400  * libusb_alloc_transfer() with an appropriate number of isochronous packets.
401  *
402  * During filling, set \ref libusb_transfer::type "type" to
403  * \ref libusb_transfer_type::LIBUSB_TRANSFER_TYPE_ISOCHRONOUS
404  * "LIBUSB_TRANSFER_TYPE_ISOCHRONOUS", and set
405  * \ref libusb_transfer::num_iso_packets "num_iso_packets" to a value less than
406  * or equal to the number of packets you requested during allocation.
407  * libusb_alloc_transfer() does not set either of these fields for you, given
408  * that you might not even use the transfer on an isochronous endpoint.
409  *
410  * Next, populate the length field for the first num_iso_packets entries in
411  * the \ref libusb_transfer::iso_packet_desc "iso_packet_desc" array. Section
412  * 5.6.3 of the USB2 specifications describe how the maximum isochronous
413  * packet length is determined by wMaxPacketSize field in the endpoint
414  * descriptor. Two functions can help you here:
415  *
416  * - libusb_get_max_packet_size() is an easy way to determine the max
417  *   packet size for an endpoint.
418  * - libusb_set_iso_packet_lengths() assigns the same length to all packets
419  *   within a transfer, which is usually what you want.
420  *
421  * For outgoing transfers, you'll obviously fill the buffer and populate the
422  * packet descriptors in hope that all the data gets transferred. For incoming
423  * transfers, you must ensure the buffer has sufficient capacity for
424  * the situation where all packets transfer the full amount of requested data.
425  *
426  * Completion handling requires some extra consideration. The
427  * \ref libusb_transfer::actual_length "actual_length" field of the transfer
428  * is meaningless and should not be examined; instead you must refer to the
429  * \ref libusb_iso_packet_descriptor::actual_length "actual_length" field of
430  * each individual packet.
431  *
432  * The \ref libusb_transfer::status "status" field of the transfer is also a
433  * little misleading:
434  *  - If the packets were submitted and the isochronous data microframes
435  *    completed normally, status will have value
436  *    \ref libusb_transfer_status::LIBUSB_TRANSFER_COMPLETED
437  *    "LIBUSB_TRANSFER_COMPLETED". Note that bus errors and software-incurred
438  *    delays are not counted as transfer errors; the transfer.status field may
439  *    indicate COMPLETED even if some or all of the packets failed. Refer to
440  *    the \ref libusb_iso_packet_descriptor::status "status" field of each
441  *    individual packet to determine packet failures.
442  *  - The status field will have value
443  *    \ref libusb_transfer_status::LIBUSB_TRANSFER_ERROR
444  *    "LIBUSB_TRANSFER_ERROR" only when serious errors were encountered.
445  *  - Other transfer status codes occur with normal behaviour.
446  *
447  * The data for each packet will be found at an offset into the buffer that
448  * can be calculated as if each prior packet completed in full. The
449  * libusb_get_iso_packet_buffer() and libusb_get_iso_packet_buffer_simple()
450  * functions may help you here.
451  *
452  * \section asyncmem Memory caveats
453  *
454  * In most circumstances, it is not safe to use stack memory for transfer
455  * buffers. This is because the function that fired off the asynchronous
456  * transfer may return before libusb has finished using the buffer, and when
457  * the function returns it's stack gets destroyed. This is true for both
458  * host-to-device and device-to-host transfers.
459  *
460  * The only case in which it is safe to use stack memory is where you can
461  * guarantee that the function owning the stack space for the buffer does not
462  * return until after the transfer's callback function has completed. In every
463  * other case, you need to use heap memory instead.
464  *
465  * \section asyncflags Fine control
466  *
467  * Through using this asynchronous interface, you may find yourself repeating
468  * a few simple operations many times. You can apply a bitwise OR of certain
469  * flags to a transfer to simplify certain things:
470  * - \ref libusb_transfer_flags::LIBUSB_TRANSFER_SHORT_NOT_OK
471  *   "LIBUSB_TRANSFER_SHORT_NOT_OK" results in transfers which transferred
472  *   less than the requested amount of data being marked with status
473  *   \ref libusb_transfer_status::LIBUSB_TRANSFER_ERROR "LIBUSB_TRANSFER_ERROR"
474  *   (they would normally be regarded as COMPLETED)
475  * - \ref libusb_transfer_flags::LIBUSB_TRANSFER_FREE_BUFFER
476  *   "LIBUSB_TRANSFER_FREE_BUFFER" allows you to ask libusb to free the transfer
477  *   buffer when freeing the transfer.
478  * - \ref libusb_transfer_flags::LIBUSB_TRANSFER_FREE_TRANSFER
479  *   "LIBUSB_TRANSFER_FREE_TRANSFER" causes libusb to automatically free the
480  *   transfer after the transfer callback returns.
481  *
482  * \section asyncevent Event handling
483  *
484  * In accordance of the aim of being a lightweight library, libusb does not
485  * create threads internally. This means that libusb code does not execute
486  * at any time other than when your application is calling a libusb function.
487  * However, an asynchronous model requires that libusb perform work at various
488  * points in time - namely processing the results of previously-submitted
489  * transfers and invoking the user-supplied callback function.
490  *
491  * This gives rise to the libusb_handle_events() function which your
492  * application must call into when libusb has work do to. This gives libusb
493  * the opportunity to reap pending transfers, invoke callbacks, etc.
494  *
495  * The first issue to discuss here is how your application can figure out
496  * when libusb has work to do. In fact, there are two naive options which
497  * do not actually require your application to know this:
498  * -# Periodically call libusb_handle_events() in non-blocking mode at fixed
499  *    short intervals from your main loop
500  * -# Repeatedly call libusb_handle_events() in blocking mode from a dedicated
501  *    thread.
502  *
503  * The first option is plainly not very nice, and will cause unnecessary 
504  * CPU wakeups leading to increased power usage and decreased battery life.
505  * The second option is not very nice either, but may be the nicest option
506  * available to you if the "proper" approach can not be applied to your
507  * application (read on...).
508  * 
509  * The recommended option is to integrate libusb with your application main
510  * event loop. libusb exposes a set of file descriptors which allow you to do
511  * this. Your main loop is probably already calling poll() or select() or a
512  * variant on a set of file descriptors for other event sources (e.g. keyboard
513  * button presses, mouse movements, network sockets, etc). You then add
514  * libusb's file descriptors to your poll()/select() calls, and when activity
515  * is detected on such descriptors you know it is time to call
516  * libusb_handle_events().
517  *
518  * There is one final event handling complication. libusb supports
519  * asynchronous transfers which time out after a specified time period, and
520  * this requires that libusb is called into at or after the timeout so that
521  * the timeout can be handled. So, in addition to considering libusb's file
522  * descriptors in your main event loop, you must also consider that libusb
523  * sometimes needs to be called into at fixed points in time even when there
524  * is no file descriptor activity.
525  *
526  * For the details on retrieving the set of file descriptors and determining
527  * the next timeout, see the \ref poll "polling and timing" API documentation.
528  */
529
530 /**
531  * @defgroup poll Polling and timing
532  *
533  * This page documents libusb's functions for polling events and timing.
534  * These functions are only necessary for users of the
535  * \ref asyncio "asynchronous API". If you are only using the simpler
536  * \ref syncio "synchronous API" then you do not need to ever call these
537  * functions.
538  *
539  * The justification for the functionality described here has already been
540  * discussed in the \ref asyncevent "event handling" section of the
541  * asynchronous API documentation. In summary, libusb does not create internal
542  * threads for event processing and hence relies on your application calling
543  * into libusb at certain points in time so that pending events can be handled.
544  * In order to know precisely when libusb needs to be called into, libusb
545  * offers you a set of pollable file descriptors and information about when
546  * the next timeout expires.
547  *
548  * If you are using the asynchronous I/O API, you must take one of the two
549  * following options, otherwise your I/O will not complete.
550  *
551  * \section pollsimple The simple option
552  *
553  * If your application revolves solely around libusb and does not need to
554  * handle other event sources, you can have a program structure as follows:
555 \code
556 // initialize libusb
557 // find and open device
558 // maybe fire off some initial async I/O
559
560 while (user_has_not_requested_exit)
561         libusb_handle_events(ctx);
562
563 // clean up and exit
564 \endcode
565  *
566  * With such a simple main loop, you do not have to worry about managing
567  * sets of file descriptors or handling timeouts. libusb_handle_events() will
568  * handle those details internally.
569  *
570  * \section pollmain The more advanced option
571  *
572  * In more advanced applications, you will already have a main loop which
573  * is monitoring other event sources: network sockets, X11 events, mouse
574  * movements, etc. Through exposing a set of file descriptors, libusb is
575  * designed to cleanly integrate into such main loops.
576  *
577  * In addition to polling file descriptors for the other event sources, you
578  * take a set of file descriptors from libusb and monitor those too. When you
579  * detect activity on libusb's file descriptors, you call
580  * libusb_handle_events_timeout() in non-blocking mode.
581  *
582  * You must also consider the fact that libusb sometimes has to handle events
583  * at certain known times which do not generate activity on file descriptors.
584  * Your main loop must also consider these times, modify it's poll()/select()
585  * timeout accordingly, and track time so that libusb_handle_events_timeout()
586  * is called in non-blocking mode when timeouts expire.
587  *
588  * In pseudo-code, you want something that looks like:
589 \code
590 // initialise libusb
591
592 libusb_get_pollfds(ctx)
593 while (user has not requested application exit) {
594         libusb_get_next_timeout(ctx);
595         select(on libusb file descriptors plus any other event sources of interest,
596                 using a timeout no larger than the value libusb just suggested)
597         if (select() indicated activity on libusb file descriptors)
598                 libusb_handle_events_timeout(ctx, 0);
599         if (time has elapsed to or beyond the libusb timeout)
600                 libusb_handle_events_timeout(ctx, 0);
601 }
602
603 // clean up and exit
604 \endcode
605  *
606  * The set of file descriptors that libusb uses as event sources may change
607  * during the life of your application. Rather than having to repeatedly
608  * call libusb_get_pollfds(), you can set up notification functions for when
609  * the file descriptor set changes using libusb_set_pollfd_notifiers().
610  *
611  * \section mtissues Multi-threaded considerations
612  *
613  * Unfortunately, the situation is complicated further when multiple threads
614  * come into play. If two threads are monitoring the same file descriptors,
615  * the fact that only one thread will be woken up when an event occurs causes
616  * some headaches.
617  *
618  * The events lock, event waiters lock, and libusb_handle_events_locked()
619  * entities are added to solve these problems. You do not need to be concerned
620  * with these entities otherwise.
621  *
622  * See the extra documentation: \ref mtasync
623  */
624
625 /** \page mtasync Multi-threaded applications and asynchronous I/O
626  *
627  * libusb is a thread-safe library, but extra considerations must be applied
628  * to applications which interact with libusb from multiple threads.
629  *
630  * The underlying issue that must be addressed is that all libusb I/O
631  * revolves around monitoring file descriptors through the poll()/select()
632  * system calls. This is directly exposed at the
633  * \ref asyncio "asynchronous interface" but it is important to note that the
634  * \ref syncio "synchronous interface" is implemented on top of the
635  * asynchonrous interface, therefore the same considerations apply.
636  *
637  * The issue is that if two or more threads are concurrently calling poll()
638  * or select() on libusb's file descriptors then only one of those threads
639  * will be woken up when an event arrives. The others will be completely
640  * oblivious that anything has happened.
641  *
642  * Consider the following pseudo-code, which submits an asynchronous transfer
643  * then waits for its completion. This style is one way you could implement a
644  * synchronous interface on top of the asynchronous interface (and libusb
645  * does something similar, albeit more advanced due to the complications
646  * explained on this page).
647  *
648 \code
649 void cb(struct libusb_transfer *transfer)
650 {
651         int *completed = transfer->user_data;
652         *completed = 1;
653 }
654
655 void myfunc() {
656         const struct timeval timeout = { 120, 0 };
657         struct libusb_transfer *transfer;
658         unsigned char buffer[LIBUSB_CONTROL_SETUP_SIZE];
659         int completed = 0;
660
661         transfer = libusb_alloc_transfer(0);
662         libusb_fill_control_setup(buffer,
663                 LIBUSB_REQUEST_TYPE_VENDOR | LIBUSB_ENDPOINT_OUT, 0x04, 0x01, 0, 0);
664         libusb_fill_control_transfer(transfer, dev, buffer, cb, &completed, 1000);
665         libusb_submit_transfer(transfer);
666
667         while (!completed) {
668                 poll(libusb file descriptors, 120*1000);
669                 if (poll indicates activity)
670                         libusb_handle_events_timeout(ctx, 0);
671         }
672         printf("completed!");
673         // other code here
674 }
675 \endcode
676  *
677  * Here we are <em>serializing</em> completion of an asynchronous event
678  * against a condition - the condition being completion of a specific transfer.
679  * The poll() loop has a long timeout to minimize CPU usage during situations
680  * when nothing is happening (it could reasonably be unlimited).
681  *
682  * If this is the only thread that is polling libusb's file descriptors, there
683  * is no problem: there is no danger that another thread will swallow up the
684  * event that we are interested in. On the other hand, if there is another
685  * thread polling the same descriptors, there is a chance that it will receive
686  * the event that we were interested in. In this situation, <tt>myfunc()</tt>
687  * will only realise that the transfer has completed on the next iteration of
688  * the loop, <em>up to 120 seconds later.</em> Clearly a two-minute delay is
689  * undesirable, and don't even think about using short timeouts to circumvent
690  * this issue!
691  * 
692  * The solution here is to ensure that no two threads are ever polling the
693  * file descriptors at the same time. A naive implementation of this would
694  * impact the capabilities of the library, so libusb offers the scheme
695  * documented below to ensure no loss of functionality.
696  *
697  * Before we go any further, it is worth mentioning that all libusb-wrapped
698  * event handling procedures fully adhere to the scheme documented below.
699  * This includes libusb_handle_events() and all the synchronous I/O functions - 
700  * libusb hides this headache from you. You do not need to worry about any
701  * of these issues if you stick to that level.
702  *
703  * The problem is when we consider the fact that libusb exposes file
704  * descriptors to allow for you to integrate asynchronous USB I/O into
705  * existing main loops, effectively allowing you to do some work behind
706  * libusb's back. If you do take libusb's file descriptors and pass them to
707  * poll()/select() yourself, you need to be aware of the associated issues.
708  *
709  * \section eventlock The events lock
710  *
711  * The first concept to be introduced is the events lock. The events lock
712  * is used to serialize threads that want to handle events, such that only
713  * one thread is handling events at any one time.
714  *
715  * You must take the events lock before polling libusb file descriptors,
716  * using libusb_lock_events(). You must release the lock as soon as you have
717  * aborted your poll()/select() loop, using libusb_unlock_events().
718  *
719  * \section threadwait Letting other threads do the work for you
720  *
721  * Although the events lock is a critical part of the solution, it is not
722  * enough on it's own. You might wonder if the following is sufficient...
723 \code
724         libusb_lock_events(ctx);
725         while (!completed) {
726                 poll(libusb file descriptors, 120*1000);
727                 if (poll indicates activity)
728                         libusb_handle_events_timeout(ctx, 0);
729         }
730         libusb_unlock_events(ctx);
731 \endcode
732  * ...and the answer is that it is not. This is because the transfer in the
733  * code shown above may take a long time (say 30 seconds) to complete, and
734  * the lock is not released until the transfer is completed.
735  *
736  * Another thread with similar code that wants to do event handling may be
737  * working with a transfer that completes after a few milliseconds. Despite
738  * having such a quick completion time, the other thread cannot check that
739  * status of its transfer until the code above has finished (30 seconds later)
740  * due to contention on the lock.
741  *
742  * To solve this, libusb offers you a mechanism to determine when another
743  * thread is handling events. It also offers a mechanism to block your thread
744  * until the event handling thread has completed an event (and this mechanism
745  * does not involve polling of file descriptors).
746  *
747  * After determining that another thread is currently handling events, you
748  * obtain the <em>event waiters</em> lock using libusb_lock_event_waiters().
749  * You then re-check that some other thread is still handling events, and if
750  * so, you call libusb_wait_for_event().
751  *
752  * libusb_wait_for_event() puts your application to sleep until an event
753  * occurs, or until a thread releases the events lock. When either of these
754  * things happen, your thread is woken up, and should re-check the condition
755  * it was waiting on. It should also re-check that another thread is handling
756  * events, and if not, it should start handling events itself.
757  *
758  * This looks like the following, as pseudo-code:
759 \code
760 retry:
761 if (libusb_try_lock_events(ctx) == 0) {
762         // we obtained the event lock: do our own event handling
763         while (!completed) {
764                 poll(libusb file descriptors, 120*1000);
765                 if (poll indicates activity)
766                         libusb_handle_events_locked(ctx, 0);
767         }
768         libusb_unlock_events(ctx);
769 } else {
770         // another thread is doing event handling. wait for it to signal us that
771         // an event has completed
772         libusb_lock_event_waiters(ctx);
773
774         while (!completed) {
775                 // now that we have the event waiters lock, double check that another
776                 // thread is still handling events for us. (it may have ceased handling
777                 // events in the time it took us to reach this point)
778                 if (!libusb_event_handler_active(ctx)) {
779                         // whoever was handling events is no longer doing so, try again
780                         libusb_unlock_event_waiters(ctx);
781                         goto retry;
782                 }
783         
784                 libusb_wait_for_event(ctx);
785         }
786         libusb_unlock_event_waiters(ctx);
787 }
788 printf("completed!\n");
789 \endcode
790  *
791  * We have now implemented code which can dynamically handle situations where
792  * nobody is handling events (so we should do it ourselves), and it can also
793  * handle situations where another thread is doing event handling (so we can
794  * piggyback onto them). It is also equipped to handle a combination of
795  * the two, for example, another thread is doing event handling, but for
796  * whatever reason it stops doing so before our condition is met, so we take
797  * over the event handling.
798  *
799  * Three functions were introduced in the above pseudo-code. Their importance
800  * should be apparent from the code shown above.
801  * -# libusb_try_lock_events() is a non-blocking function which attempts
802  *    to acquire the events lock but returns a failure code if it is contended.
803  * -# libusb_handle_events_locked() is a variant of
804  *    libusb_handle_events_timeout() that you can call while holding the
805  *    events lock. libusb_handle_events_timeout() itself implements similar
806  *    logic to the above, so be sure not to call it when you are
807  *    "working behind libusb's back", as is the case here.
808  * -# libusb_event_handler_active() determines if someone is currently
809  *    holding the events lock
810  *
811  * You might be wondering why there is no function to wake up all threads
812  * blocked on libusb_wait_for_event(). This is because libusb can do this
813  * internally: it will wake up all such threads when someone calls
814  * libusb_unlock_events() or when a transfer completes (at the point after its
815  * callback has returned).
816  *
817  * \subsection concl Closing remarks
818  *
819  * The above may seem a little complicated, but hopefully I have made it clear
820  * why such complications are necessary. Also, do not forget that this only
821  * applies to applications that take libusb's file descriptors and integrate
822  * them into their own polling loops.
823  *
824  * You may decide that it is OK for your multi-threaded application to ignore
825  * some of the rules and locks detailed above, because you don't think that
826  * two threads can ever be polling the descriptors at the same time. If that
827  * is the case, then that's good news for you because you don't have to worry.
828  * But be careful here; remember that the synchronous I/O functions do event
829  * handling internally. If you have one thread doing event handling in a loop
830  * (without implementing the rules and locking semantics documented above)
831  * and another trying to send a synchronous USB transfer, you will end up with
832  * two threads monitoring the same descriptors, and the above-described
833  * undesirable behaviour occuring. The solution is for your polling thread to
834  * play by the rules; the synchronous I/O functions do so, and this will result
835  * in them getting along in perfect harmony.
836  *
837  * If you do have a dedicated thread doing event handling, it is perfectly
838  * legal for it to take the event handling lock and never release it. Any
839  * synchronous I/O functions you call from other threads will transparently
840  * fall back to the "event waiters" mechanism detailed above.
841  */
842
843 int usbi_io_init(struct libusb_context *ctx)
844 {
845         int r;
846
847         pthread_mutex_init(&ctx->flying_transfers_lock, NULL);
848         pthread_mutex_init(&ctx->pollfds_lock, NULL);
849         pthread_mutex_init(&ctx->pollfd_modify_lock, NULL);
850         pthread_mutex_init(&ctx->events_lock, NULL);
851         pthread_mutex_init(&ctx->event_waiters_lock, NULL);
852         pthread_cond_init(&ctx->event_waiters_cond, NULL);
853         list_init(&ctx->flying_transfers);
854         list_init(&ctx->pollfds);
855
856         /* FIXME should use an eventfd on kernels that support it */
857         r = pipe(ctx->ctrl_pipe);
858         if (r < 0)
859                 return LIBUSB_ERROR_OTHER;
860
861         r = usbi_add_pollfd(ctx, ctx->ctrl_pipe[0], POLLIN);
862         if (r < 0)
863                 return r;
864
865         return 0;
866 }
867
868 void usbi_io_exit(struct libusb_context *ctx)
869 {
870         usbi_remove_pollfd(ctx, ctx->ctrl_pipe[0]);
871         close(ctx->ctrl_pipe[0]);
872         close(ctx->ctrl_pipe[1]);
873 }
874
875 static int calculate_timeout(struct usbi_transfer *transfer)
876 {
877         int r;
878         struct timespec current_time;
879         unsigned int timeout =
880                 __USBI_TRANSFER_TO_LIBUSB_TRANSFER(transfer)->timeout;
881
882         if (!timeout)
883                 return 0;
884
885         r = clock_gettime(CLOCK_MONOTONIC, &current_time);
886         if (r < 0) {
887                 usbi_err(ITRANSFER_CTX(transfer),
888                         "failed to read monotonic clock, errno=%d", errno);
889                 return r;
890         }
891
892         current_time.tv_sec += timeout / 1000;
893         current_time.tv_nsec += (timeout % 1000) * 1000000;
894
895         if (current_time.tv_nsec > 1000000000) {
896                 current_time.tv_nsec -= 1000000000;
897                 current_time.tv_sec++;
898         }
899
900         TIMESPEC_TO_TIMEVAL(&transfer->timeout, &current_time);
901         return 0;
902 }
903
904 static void add_to_flying_list(struct usbi_transfer *transfer)
905 {
906         struct usbi_transfer *cur;
907         struct timeval *timeout = &transfer->timeout;
908         struct libusb_context *ctx = ITRANSFER_CTX(transfer);
909         
910         pthread_mutex_lock(&ctx->flying_transfers_lock);
911
912         /* if we have no other flying transfers, start the list with this one */
913         if (list_empty(&ctx->flying_transfers)) {
914                 list_add(&transfer->list, &ctx->flying_transfers);
915                 goto out;
916         }
917
918         /* if we have infinite timeout, append to end of list */
919         if (!timerisset(timeout)) {
920                 list_add_tail(&transfer->list, &ctx->flying_transfers);
921                 goto out;
922         }
923
924         /* otherwise, find appropriate place in list */
925         list_for_each_entry(cur, &ctx->flying_transfers, list) {
926                 /* find first timeout that occurs after the transfer in question */
927                 struct timeval *cur_tv = &cur->timeout;
928
929                 if (!timerisset(cur_tv) || (cur_tv->tv_sec > timeout->tv_sec) ||
930                                 (cur_tv->tv_sec == timeout->tv_sec &&
931                                         cur_tv->tv_usec > timeout->tv_usec)) {
932                         list_add_tail(&transfer->list, &cur->list);
933                         goto out;
934                 }
935         }
936
937         /* otherwise we need to be inserted at the end */
938         list_add_tail(&transfer->list, &ctx->flying_transfers);
939 out:
940         pthread_mutex_unlock(&ctx->flying_transfers_lock);
941 }
942
943 /** \ingroup asyncio
944  * Allocate a libusb transfer with a specified number of isochronous packet
945  * descriptors. The returned transfer is pre-initialized for you. When the new
946  * transfer is no longer needed, it should be freed with
947  * libusb_free_transfer().
948  *
949  * Transfers intended for non-isochronous endpoints (e.g. control, bulk,
950  * interrupt) should specify an iso_packets count of zero.
951  *
952  * For transfers intended for isochronous endpoints, specify an appropriate
953  * number of packet descriptors to be allocated as part of the transfer.
954  * The returned transfer is not specially initialized for isochronous I/O;
955  * you are still required to set the
956  * \ref libusb_transfer::num_iso_packets "num_iso_packets" and
957  * \ref libusb_transfer::type "type" fields accordingly.
958  *
959  * It is safe to allocate a transfer with some isochronous packets and then
960  * use it on a non-isochronous endpoint. If you do this, ensure that at time
961  * of submission, num_iso_packets is 0 and that type is set appropriately.
962  *
963  * \param iso_packets number of isochronous packet descriptors to allocate
964  * \returns a newly allocated transfer, or NULL on error
965  */
966 API_EXPORTED struct libusb_transfer *libusb_alloc_transfer(int iso_packets)
967 {
968         size_t os_alloc_size = usbi_backend->transfer_priv_size
969                 + (usbi_backend->add_iso_packet_size * iso_packets);
970         int alloc_size = sizeof(struct usbi_transfer)
971                 + sizeof(struct libusb_transfer)
972                 + (sizeof(struct libusb_iso_packet_descriptor) * iso_packets)
973                 + os_alloc_size;
974         struct usbi_transfer *itransfer = malloc(alloc_size);
975         if (!itransfer)
976                 return NULL;
977
978         memset(itransfer, 0, alloc_size);
979         itransfer->num_iso_packets = iso_packets;
980         return __USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
981 }
982
983 /** \ingroup asyncio
984  * Free a transfer structure. This should be called for all transfers
985  * allocated with libusb_alloc_transfer().
986  *
987  * If the \ref libusb_transfer_flags::LIBUSB_TRANSFER_FREE_BUFFER
988  * "LIBUSB_TRANSFER_FREE_BUFFER" flag is set and the transfer buffer is
989  * non-NULL, this function will also free the transfer buffer using the
990  * standard system memory allocator (e.g. free()).
991  *
992  * It is legal to call this function with a NULL transfer. In this case,
993  * the function will simply return safely.
994  *
995  * \param transfer the transfer to free
996  */
997 API_EXPORTED void libusb_free_transfer(struct libusb_transfer *transfer)
998 {
999         struct usbi_transfer *itransfer;
1000         if (!transfer)
1001                 return;
1002
1003         if (transfer->flags & LIBUSB_TRANSFER_FREE_BUFFER && transfer->buffer)
1004                 free(transfer->buffer);
1005
1006         itransfer = __LIBUSB_TRANSFER_TO_USBI_TRANSFER(transfer);
1007         free(itransfer);
1008 }
1009
1010 /** \ingroup asyncio
1011  * Submit a transfer. This function will fire off the USB transfer and then
1012  * return immediately.
1013  *
1014  * It is undefined behaviour to submit a transfer that has already been
1015  * submitted but has not yet completed.
1016  *
1017  * \param transfer the transfer to submit
1018  * \returns 0 on success
1019  * \returns LIBUSB_ERROR_NO_DEVICE if the device has been disconnected
1020  * \returns another LIBUSB_ERROR code on other failure
1021  */
1022 API_EXPORTED int libusb_submit_transfer(struct libusb_transfer *transfer)
1023 {
1024         struct usbi_transfer *itransfer =
1025                 __LIBUSB_TRANSFER_TO_USBI_TRANSFER(transfer);
1026         int r;
1027
1028         itransfer->transferred = 0;
1029         itransfer->flags = 0;
1030         r = calculate_timeout(itransfer);
1031         if (r < 0)
1032                 return LIBUSB_ERROR_OTHER;
1033
1034         add_to_flying_list(itransfer);
1035         r = usbi_backend->submit_transfer(itransfer);
1036         if (r) {
1037                 pthread_mutex_lock(&TRANSFER_CTX(transfer)->flying_transfers_lock);
1038                 list_del(&itransfer->list);
1039                 pthread_mutex_unlock(&TRANSFER_CTX(transfer)->flying_transfers_lock);
1040         }
1041
1042         return r;
1043 }
1044
1045 /** \ingroup asyncio
1046  * Asynchronously cancel a previously submitted transfer.
1047  * It is undefined behaviour to call this function on a transfer that is
1048  * already being cancelled or has already completed.
1049  * This function returns immediately, but this does not indicate cancellation
1050  * is complete. Your callback function will be invoked at some later time
1051  * with a transfer status of
1052  * \ref libusb_transfer_status::LIBUSB_TRANSFER_CANCELLED
1053  * "LIBUSB_TRANSFER_CANCELLED."
1054  *
1055  * \param transfer the transfer to cancel
1056  * \returns 0 on success
1057  * \returns a LIBUSB_ERROR code on failure
1058  */
1059 API_EXPORTED int libusb_cancel_transfer(struct libusb_transfer *transfer)
1060 {
1061         struct usbi_transfer *itransfer =
1062                 __LIBUSB_TRANSFER_TO_USBI_TRANSFER(transfer);
1063         int r;
1064
1065         usbi_dbg("");
1066         r = usbi_backend->cancel_transfer(itransfer);
1067         if (r < 0)
1068                 usbi_err(TRANSFER_CTX(transfer),
1069                         "cancel transfer failed error %d", r);
1070         return r;
1071 }
1072
1073 /* Handle completion of a transfer (completion might be an error condition).
1074  * This will invoke the user-supplied callback function, which may end up
1075  * freeing the transfer. Therefore you cannot use the transfer structure
1076  * after calling this function, and you should free all backend-specific
1077  * data before calling it. */
1078 void usbi_handle_transfer_completion(struct usbi_transfer *itransfer,
1079         enum libusb_transfer_status status)
1080 {
1081         struct libusb_transfer *transfer =
1082                 __USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
1083         struct libusb_context *ctx = TRANSFER_CTX(transfer);
1084         uint8_t flags;
1085
1086         pthread_mutex_lock(&ctx->flying_transfers_lock);
1087         list_del(&itransfer->list);
1088         pthread_mutex_unlock(&ctx->flying_transfers_lock);
1089
1090         if (status == LIBUSB_TRANSFER_COMPLETED
1091                         && transfer->flags & LIBUSB_TRANSFER_SHORT_NOT_OK) {
1092                 int rqlen = transfer->length;
1093                 if (transfer->type == LIBUSB_TRANSFER_TYPE_CONTROL)
1094                         rqlen -= LIBUSB_CONTROL_SETUP_SIZE;
1095                 if (rqlen != itransfer->transferred) {
1096                         usbi_dbg("interpreting short transfer as error");
1097                         status = LIBUSB_TRANSFER_ERROR;
1098                 }
1099         }
1100
1101         flags = transfer->flags;
1102         transfer->status = status;
1103         transfer->actual_length = itransfer->transferred;
1104         if (transfer->callback)
1105                 transfer->callback(transfer);
1106         /* transfer might have been freed by the above call, do not use from
1107          * this point. */
1108         if (flags & LIBUSB_TRANSFER_FREE_TRANSFER)
1109                 libusb_free_transfer(transfer);
1110         pthread_mutex_lock(&ctx->event_waiters_lock);
1111         pthread_cond_broadcast(&ctx->event_waiters_cond);
1112         pthread_mutex_unlock(&ctx->event_waiters_lock);
1113 }
1114
1115 /* Similar to usbi_handle_transfer_completion() but exclusively for transfers
1116  * that were asynchronously cancelled. The same concerns w.r.t. freeing of
1117  * transfers exist here.
1118  */
1119 void usbi_handle_transfer_cancellation(struct usbi_transfer *transfer)
1120 {
1121         /* if the URB was cancelled due to timeout, report timeout to the user */
1122         if (transfer->flags & USBI_TRANSFER_TIMED_OUT) {
1123                 usbi_dbg("detected timeout cancellation");
1124                 usbi_handle_transfer_completion(transfer, LIBUSB_TRANSFER_TIMED_OUT);
1125                 return;
1126         }
1127
1128         /* otherwise its a normal async cancel */
1129         usbi_handle_transfer_completion(transfer, LIBUSB_TRANSFER_CANCELLED);
1130 }
1131
1132 /** \ingroup poll
1133  * Attempt to acquire the event handling lock. This lock is used to ensure that
1134  * only one thread is monitoring libusb event sources at any one time.
1135  *
1136  * You only need to use this lock if you are developing an application
1137  * which calls poll() or select() on libusb's file descriptors directly.
1138  * If you stick to libusb's event handling loop functions (e.g.
1139  * libusb_handle_events()) then you do not need to be concerned with this
1140  * locking.
1141  *
1142  * While holding this lock, you are trusted to actually be handling events.
1143  * If you are no longer handling events, you must call libusb_unlock_events()
1144  * as soon as possible.
1145  *
1146  * \param ctx the context to operate on, or NULL for the default context
1147  * \returns 0 if the lock was obtained successfully
1148  * \returns 1 if the lock was not obtained (i.e. another thread holds the lock)
1149  * \see \ref mtasync
1150  */
1151 API_EXPORTED int libusb_try_lock_events(libusb_context *ctx)
1152 {
1153         int r;
1154         USBI_GET_CONTEXT(ctx);
1155
1156         /* is someone else waiting to modify poll fds? if so, don't let this thread
1157          * start event handling */
1158         pthread_mutex_lock(&ctx->pollfd_modify_lock);
1159         r = ctx->pollfd_modify;
1160         pthread_mutex_unlock(&ctx->pollfd_modify_lock);
1161         if (r) {
1162                 usbi_dbg("someone else is modifying poll fds");
1163                 return 1;
1164         }
1165
1166         r = pthread_mutex_trylock(&ctx->events_lock);
1167         if (r)
1168                 return 1;
1169
1170         ctx->event_handler_active = 1;  
1171         return 0;
1172 }
1173
1174 /** \ingroup poll
1175  * Acquire the event handling lock, blocking until successful acquisition if
1176  * it is contended. This lock is used to ensure that only one thread is
1177  * monitoring libusb event sources at any one time.
1178  *
1179  * You only need to use this lock if you are developing an application
1180  * which calls poll() or select() on libusb's file descriptors directly.
1181  * If you stick to libusb's event handling loop functions (e.g.
1182  * libusb_handle_events()) then you do not need to be concerned with this
1183  * locking.
1184  *
1185  * While holding this lock, you are trusted to actually be handling events.
1186  * If you are no longer handling events, you must call libusb_unlock_events()
1187  * as soon as possible.
1188  *
1189  * \param ctx the context to operate on, or NULL for the default context
1190  * \see \ref mtasync
1191  */
1192 API_EXPORTED void libusb_lock_events(libusb_context *ctx)
1193 {
1194         USBI_GET_CONTEXT(ctx);
1195         pthread_mutex_lock(&ctx->events_lock);
1196         ctx->event_handler_active = 1;
1197 }
1198
1199 /** \ingroup poll
1200  * Release the lock previously acquired with libusb_try_lock_events() or
1201  * libusb_lock_events(). Releasing this lock will wake up any threads blocked
1202  * on libusb_wait_for_event().
1203  *
1204  * \param ctx the context to operate on, or NULL for the default context
1205  * \see \ref mtasync
1206  */
1207 API_EXPORTED void libusb_unlock_events(libusb_context *ctx)
1208 {
1209         USBI_GET_CONTEXT(ctx);
1210         ctx->event_handler_active = 0;
1211         pthread_mutex_unlock(&ctx->events_lock);
1212
1213         pthread_mutex_lock(&ctx->event_waiters_lock);
1214         pthread_cond_broadcast(&ctx->event_waiters_cond);
1215         pthread_mutex_unlock(&ctx->event_waiters_lock);
1216 }
1217
1218 /** \ingroup poll
1219  * Determine if an active thread is handling events (i.e. if anyone is holding
1220  * the event handling lock).
1221  *
1222  * \param ctx the context to operate on, or NULL for the default context
1223  * \returns 1 if a thread is handling events
1224  * \returns 0 if there are no threads currently handling events
1225  * \see \ref mtasync
1226  */
1227 API_EXPORTED int libusb_event_handler_active(libusb_context *ctx)
1228 {
1229         int r;
1230         USBI_GET_CONTEXT(ctx);
1231
1232         /* is someone else waiting to modify poll fds? if so, don't let this thread
1233          * start event handling -- indicate that event handling is happening */
1234         pthread_mutex_lock(&ctx->pollfd_modify_lock);
1235         r = ctx->pollfd_modify;
1236         pthread_mutex_unlock(&ctx->pollfd_modify_lock);
1237         if (r) {
1238                 usbi_dbg("someone else is modifying poll fds");
1239                 return 1;
1240         }
1241
1242         return ctx->event_handler_active;
1243 }
1244
1245 /** \ingroup poll
1246  * Acquire the event waiters lock. This lock is designed to be obtained under
1247  * the situation where you want to be aware when events are completed, but
1248  * some other thread is event handling so calling libusb_handle_events() is not
1249  * allowed.
1250  *
1251  * You then obtain this lock, re-check that another thread is still handling
1252  * events, then call libusb_wait_for_event().
1253  *
1254  * You only need to use this lock if you are developing an application
1255  * which calls poll() or select() on libusb's file descriptors directly,
1256  * <b>and</b> may potentially be handling events from 2 threads simultaenously.
1257  * If you stick to libusb's event handling loop functions (e.g.
1258  * libusb_handle_events()) then you do not need to be concerned with this
1259  * locking.
1260  *
1261  * \param ctx the context to operate on, or NULL for the default context
1262  * \see \ref mtasync
1263  */
1264 API_EXPORTED void libusb_lock_event_waiters(libusb_context *ctx)
1265 {
1266         USBI_GET_CONTEXT(ctx);
1267         pthread_mutex_lock(&ctx->event_waiters_lock);
1268 }
1269
1270 /** \ingroup poll
1271  * Release the event waiters lock.
1272  * \param ctx the context to operate on, or NULL for the default context
1273  * \see \ref mtasync
1274  */
1275 API_EXPORTED void libusb_unlock_event_waiters(libusb_context *ctx)
1276 {
1277         USBI_GET_CONTEXT(ctx);
1278         pthread_mutex_unlock(&ctx->event_waiters_lock);
1279 }
1280
1281 /** \ingroup poll
1282  * Wait for another thread to signal completion of an event. Must be called
1283  * with the event waiters lock held, see libusb_lock_event_waiters().
1284  *
1285  * This function will block until any of the following conditions are met:
1286  * -# The timeout expires
1287  * -# A transfer completes
1288  * -# A thread releases the event handling lock through libusb_unlock_events()
1289  *
1290  * Condition 1 is obvious. Condition 2 unblocks your thread <em>after</em>
1291  * the callback for the transfer has completed. Condition 3 is important
1292  * because it means that the thread that was previously handling events is no
1293  * longer doing so, so if any events are to complete, another thread needs to
1294  * step up and start event handling.
1295  *
1296  * This function releases the event waiters lock before putting your thread
1297  * to sleep, and reacquires the lock as it is being woken up.
1298  *
1299  * \param ctx the context to operate on, or NULL for the default context
1300  * \param tv maximum timeout for this blocking function. A NULL value
1301  * indicates unlimited timeout.
1302  * \returns 0 after a transfer completes or another thread stops event handling
1303  * \returns 1 if the timeout expired
1304  * \see \ref mtasync
1305  */
1306 API_EXPORTED int libusb_wait_for_event(libusb_context *ctx, struct timeval *tv)
1307 {
1308         struct timespec timeout;
1309         int r;
1310
1311         USBI_GET_CONTEXT(ctx);
1312         if (tv == NULL) {
1313                 pthread_cond_wait(&ctx->event_waiters_cond, &ctx->event_waiters_lock);
1314                 return 0;
1315         }
1316
1317         r = clock_gettime(CLOCK_REALTIME, &timeout);
1318         if (r < 0) {
1319                 usbi_err(ctx, "failed to read realtime clock, error %d", errno);
1320                 return LIBUSB_ERROR_OTHER;
1321         }
1322
1323         timeout.tv_sec += tv->tv_sec;
1324         timeout.tv_nsec += tv->tv_usec * 1000;
1325         if (timeout.tv_nsec > 1000000000) {
1326                 timeout.tv_nsec -= 1000000000;
1327                 timeout.tv_sec++;
1328         }
1329
1330         r = pthread_cond_timedwait(&ctx->event_waiters_cond,
1331                 &ctx->event_waiters_lock, &timeout);
1332         return (r == ETIMEDOUT);
1333 }
1334
1335 static void handle_timeout(struct usbi_transfer *itransfer)
1336 {
1337         struct libusb_transfer *transfer =
1338                 __USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
1339         int r;
1340
1341         itransfer->flags |= USBI_TRANSFER_TIMED_OUT;
1342         r = libusb_cancel_transfer(transfer);
1343         if (r < 0)
1344                 usbi_warn(TRANSFER_CTX(transfer),
1345                         "async cancel failed %d errno=%d", r, errno);
1346 }
1347
1348 static int handle_timeouts(struct libusb_context *ctx)
1349 {
1350         struct timespec systime_ts;
1351         struct timeval systime;
1352         struct usbi_transfer *transfer;
1353         int r = 0;
1354
1355         USBI_GET_CONTEXT(ctx);
1356         pthread_mutex_lock(&ctx->flying_transfers_lock);
1357         if (list_empty(&ctx->flying_transfers))
1358                 goto out;
1359
1360         /* get current time */
1361         r = clock_gettime(CLOCK_MONOTONIC, &systime_ts);
1362         if (r < 0)
1363                 goto out;
1364
1365         TIMESPEC_TO_TIMEVAL(&systime, &systime_ts);
1366
1367         /* iterate through flying transfers list, finding all transfers that
1368          * have expired timeouts */
1369         list_for_each_entry(transfer, &ctx->flying_transfers, list) {
1370                 struct timeval *cur_tv = &transfer->timeout;
1371
1372                 /* if we've reached transfers of infinite timeout, we're all done */
1373                 if (!timerisset(cur_tv))
1374                         goto out;
1375
1376                 /* ignore timeouts we've already handled */
1377                 if (transfer->flags & USBI_TRANSFER_TIMED_OUT)
1378                         continue;
1379
1380                 /* if transfer has non-expired timeout, nothing more to do */
1381                 if ((cur_tv->tv_sec > systime.tv_sec) ||
1382                                 (cur_tv->tv_sec == systime.tv_sec &&
1383                                         cur_tv->tv_usec > systime.tv_usec))
1384                         goto out;
1385         
1386                 /* otherwise, we've got an expired timeout to handle */
1387                 handle_timeout(transfer);
1388         }
1389
1390 out:
1391         pthread_mutex_unlock(&ctx->flying_transfers_lock);
1392         return r;
1393 }
1394
1395 /* do the actual event handling. assumes that no other thread is concurrently
1396  * doing the same thing. */
1397 static int handle_events(struct libusb_context *ctx, struct timeval *tv)
1398 {
1399         int r;
1400         struct usbi_pollfd *ipollfd;
1401         nfds_t nfds = 0;
1402         struct pollfd *fds;
1403         int i = -1;
1404         int timeout_ms;
1405
1406         pthread_mutex_lock(&ctx->pollfds_lock);
1407         list_for_each_entry(ipollfd, &ctx->pollfds, list)
1408                 nfds++;
1409
1410         /* TODO: malloc when number of fd's changes, not on every poll */
1411         fds = malloc(sizeof(*fds) * nfds);
1412         if (!fds)
1413                 return LIBUSB_ERROR_NO_MEM;
1414
1415         list_for_each_entry(ipollfd, &ctx->pollfds, list) {
1416                 struct libusb_pollfd *pollfd = &ipollfd->pollfd;
1417                 int fd = pollfd->fd;
1418                 i++;
1419                 fds[i].fd = fd;
1420                 fds[i].events = pollfd->events;
1421                 fds[i].revents = 0;
1422         }
1423         pthread_mutex_unlock(&ctx->pollfds_lock);
1424
1425         timeout_ms = (tv->tv_sec * 1000) + (tv->tv_usec / 1000);
1426
1427         /* round up to next millisecond */
1428         if (tv->tv_usec % 1000)
1429                 timeout_ms++;
1430
1431         usbi_dbg("poll() %d fds with timeout in %dms", nfds, timeout_ms);
1432         r = poll(fds, nfds, timeout_ms);
1433         usbi_dbg("poll() returned %d", r);
1434         if (r == 0) {
1435                 free(fds);
1436                 return handle_timeouts(ctx);
1437         } else if (r == -1 && errno == EINTR) {
1438                 free(fds);
1439                 return LIBUSB_ERROR_INTERRUPTED;
1440         } else if (r < 0) {
1441                 free(fds);
1442                 usbi_err(ctx, "poll failed %d err=%d\n", r, errno);
1443                 return LIBUSB_ERROR_IO;
1444         }
1445
1446         /* fd[0] is always the ctrl pipe */
1447         if (fds[0].revents) {
1448                 /* another thread wanted to interrupt event handling, and it succeeded!
1449                  * handle any other events that cropped up at the same time, and
1450                  * simply return */
1451                 usbi_dbg("caught a fish on the control pipe");
1452
1453                 if (r == 1) {
1454                         r = 0;
1455                         goto handled;
1456                 } else {
1457                         /* prevent OS backend from trying to handle events on ctrl pipe */
1458                         fds[0].revents = 0;
1459                 }
1460         }
1461
1462         r = usbi_backend->handle_events(ctx, fds, nfds, r);
1463         if (r)
1464                 usbi_err(ctx, "backend handle_events failed with error %d", r);
1465
1466 handled:
1467         free(fds);
1468         return r;
1469 }
1470
1471 /* returns the smallest of:
1472  *  1. timeout of next URB
1473  *  2. user-supplied timeout
1474  * returns 1 if there is an already-expired timeout, otherwise returns 0
1475  * and populates out
1476  */
1477 static int get_next_timeout(libusb_context *ctx, struct timeval *tv,
1478         struct timeval *out)
1479 {
1480         struct timeval timeout;
1481         int r = libusb_get_next_timeout(ctx, &timeout);
1482         if (r) {
1483                 /* timeout already expired? */
1484                 if (!timerisset(&timeout))
1485                         return 1;
1486
1487                 /* choose the smallest of next URB timeout or user specified timeout */
1488                 if (timercmp(&timeout, tv, <))
1489                         *out = timeout;
1490                 else
1491                         *out = *tv;
1492         } else {
1493                 *out = *tv;
1494         }
1495         return 0;
1496 }
1497
1498 /** \ingroup poll
1499  * Handle any pending events.
1500  *
1501  * libusb determines "pending events" by checking if any timeouts have expired
1502  * and by checking the set of file descriptors for activity.
1503  *
1504  * If a zero timeval is passed, this function will handle any already-pending
1505  * events and then immediately return in non-blocking style.
1506  *
1507  * If a non-zero timeval is passed and no events are currently pending, this
1508  * function will block waiting for events to handle up until the specified
1509  * timeout. If an event arrives or a signal is raised, this function will
1510  * return early.
1511  *
1512  * \param ctx the context to operate on, or NULL for the default context
1513  * \param tv the maximum time to block waiting for events, or zero for
1514  * non-blocking mode
1515  * \returns 0 on success, or a LIBUSB_ERROR code on failure
1516  */
1517 API_EXPORTED int libusb_handle_events_timeout(libusb_context *ctx,
1518         struct timeval *tv)
1519 {
1520         int r;
1521         struct timeval poll_timeout;
1522
1523         USBI_GET_CONTEXT(ctx);
1524         r = get_next_timeout(ctx, tv, &poll_timeout);
1525         if (r) {
1526                 /* timeout already expired */
1527                 return handle_timeouts(ctx);
1528         }
1529
1530 retry:
1531         if (libusb_try_lock_events(ctx) == 0) {
1532                 /* we obtained the event lock: do our own event handling */
1533                 r = handle_events(ctx, &poll_timeout);
1534                 libusb_unlock_events(ctx);
1535                 return r;
1536         }
1537
1538         /* another thread is doing event handling. wait for pthread events that
1539          * notify event completion. */
1540         libusb_lock_event_waiters(ctx);
1541
1542         if (!libusb_event_handler_active(ctx)) {
1543                 /* we hit a race: whoever was event handling earlier finished in the
1544                  * time it took us to reach this point. try the cycle again. */
1545                 libusb_unlock_event_waiters(ctx);
1546                 usbi_dbg("event handler was active but went away, retrying");
1547                 goto retry;
1548         }
1549
1550         usbi_dbg("another thread is doing event handling");
1551         r = libusb_wait_for_event(ctx, &poll_timeout);
1552         libusb_unlock_event_waiters(ctx);
1553
1554         if (r < 0)
1555                 return r;
1556         else if (r == 1)
1557                 return handle_timeouts(ctx);
1558         else
1559                 return 0;
1560 }
1561
1562 /** \ingroup poll
1563  * Handle any pending events in blocking mode with a sensible timeout. This
1564  * timeout is currently hardcoded at 2 seconds but we may change this if we
1565  * decide other values are more sensible. For finer control over whether this
1566  * function is blocking or non-blocking, or the maximum timeout, use
1567  * libusb_handle_events_timeout() instead.
1568  *
1569  * \param ctx the context to operate on, or NULL for the default context
1570  * \returns 0 on success, or a LIBUSB_ERROR code on failure
1571  */
1572 API_EXPORTED int libusb_handle_events(libusb_context *ctx)
1573 {
1574         struct timeval tv;
1575         tv.tv_sec = 2;
1576         tv.tv_usec = 0;
1577         return libusb_handle_events_timeout(ctx, &tv);
1578 }
1579
1580 /** \ingroup poll
1581  * Handle any pending events by polling file descriptors, without checking if
1582  * any other threads are already doing so. Must be called with the event lock
1583  * held, see libusb_lock_events().
1584  *
1585  * This function is designed to be called under the situation where you have
1586  * taken the event lock and are calling poll()/select() directly on libusb's
1587  * file descriptors (as opposed to using libusb_handle_events() or similar).
1588  * You detect events on libusb's descriptors, so you then call this function
1589  * with a zero timeout value (while still holding the event lock).
1590  *
1591  * \param ctx the context to operate on, or NULL for the default context
1592  * \param tv the maximum time to block waiting for events, or zero for
1593  * non-blocking mode
1594  * \returns 0 on success, or a LIBUSB_ERROR code on failure
1595  * \see \ref mtasync
1596  */
1597 API_EXPORTED int libusb_handle_events_locked(libusb_context *ctx,
1598         struct timeval *tv)
1599 {
1600         int r;
1601         struct timeval poll_timeout;
1602
1603         USBI_GET_CONTEXT(ctx);
1604         r = get_next_timeout(ctx, tv, &poll_timeout);
1605         if (r) {
1606                 /* timeout already expired */
1607                 return handle_timeouts(ctx);
1608         }
1609
1610         return handle_events(ctx, &poll_timeout);
1611 }
1612
1613 /** \ingroup poll
1614  * Determine the next internal timeout that libusb needs to handle. You only
1615  * need to use this function if you are calling poll() or select() or similar
1616  * on libusb's file descriptors yourself - you do not need to use it if you
1617  * are calling libusb_handle_events() or a variant directly.
1618  * 
1619  * You should call this function in your main loop in order to determine how
1620  * long to wait for select() or poll() to return results. libusb needs to be
1621  * called into at this timeout, so you should use it as an upper bound on
1622  * your select() or poll() call.
1623  *
1624  * When the timeout has expired, call into libusb_handle_events_timeout()
1625  * (perhaps in non-blocking mode) so that libusb can handle the timeout.
1626  *
1627  * This function may return 1 (success) and an all-zero timeval. If this is
1628  * the case, it indicates that libusb has a timeout that has already expired
1629  * so you should call libusb_handle_events_timeout() or similar immediately.
1630  * A return code of 0 indicates that there are no pending timeouts.
1631  *
1632  * \param ctx the context to operate on, or NULL for the default context
1633  * \param tv output location for a relative time against the current
1634  * clock in which libusb must be called into in order to process timeout events
1635  * \returns 0 if there are no pending timeouts, 1 if a timeout was returned,
1636  * or LIBUSB_ERROR_OTHER on failure
1637  */
1638 API_EXPORTED int libusb_get_next_timeout(libusb_context *ctx,
1639         struct timeval *tv)
1640 {
1641         struct usbi_transfer *transfer;
1642         struct timespec cur_ts;
1643         struct timeval cur_tv;
1644         struct timeval *next_timeout;
1645         int r;
1646         int found = 0;
1647
1648         USBI_GET_CONTEXT(ctx);
1649         pthread_mutex_lock(&ctx->flying_transfers_lock);
1650         if (list_empty(&ctx->flying_transfers)) {
1651                 pthread_mutex_unlock(&ctx->flying_transfers_lock);
1652                 usbi_dbg("no URBs, no timeout!");
1653                 return 0;
1654         }
1655
1656         /* find next transfer which hasn't already been processed as timed out */
1657         list_for_each_entry(transfer, &ctx->flying_transfers, list) {
1658                 if (!(transfer->flags & USBI_TRANSFER_TIMED_OUT)) {
1659                         found = 1;
1660                         break;
1661                 }
1662         }
1663         pthread_mutex_unlock(&ctx->flying_transfers_lock);
1664
1665         if (!found) {
1666                 usbi_dbg("all URBs have already been processed for timeouts");
1667                 return 0;
1668         }
1669
1670         next_timeout = &transfer->timeout;
1671
1672         /* no timeout for next transfer */
1673         if (!timerisset(next_timeout)) {
1674                 usbi_dbg("no URBs with timeouts, no timeout!");
1675                 return 0;
1676         }
1677
1678         r = clock_gettime(CLOCK_MONOTONIC, &cur_ts);
1679         if (r < 0) {
1680                 usbi_err(ctx, "failed to read monotonic clock, errno=%d", errno);
1681                 return LIBUSB_ERROR_OTHER;
1682         }
1683         TIMESPEC_TO_TIMEVAL(&cur_tv, &cur_ts);
1684
1685         if (timercmp(&cur_tv, next_timeout, >=)) {
1686                 usbi_dbg("first timeout already expired");
1687                 timerclear(tv);
1688         } else {
1689                 timersub(next_timeout, &cur_tv, tv);
1690                 usbi_dbg("next timeout in %d.%06ds", tv->tv_sec, tv->tv_usec);
1691         }
1692
1693         return 1;
1694 }
1695
1696 /** \ingroup poll
1697  * Register notification functions for file descriptor additions/removals.
1698  * These functions will be invoked for every new or removed file descriptor
1699  * that libusb uses as an event source.
1700  *
1701  * To remove notifiers, pass NULL values for the function pointers.
1702  *
1703  * Note that file descriptors may have been added even before you register
1704  * these notifiers (e.g. at libusb_init() time).
1705  *
1706  * Additionally, note that the removal notifier may be called during
1707  * libusb_exit() (e.g. when it is closing file descriptors that were opened
1708  * and added to the poll set at libusb_init() time). If you don't want this,
1709  * remove the notifiers immediately before calling libusb_exit().
1710  *
1711  * \param ctx the context to operate on, or NULL for the default context
1712  * \param added_cb pointer to function for addition notifications
1713  * \param removed_cb pointer to function for removal notifications
1714  * \param user_data User data to be passed back to callbacks (useful for
1715  * passing context information)
1716  */
1717 API_EXPORTED void libusb_set_pollfd_notifiers(libusb_context *ctx,
1718         libusb_pollfd_added_cb added_cb, libusb_pollfd_removed_cb removed_cb,
1719         void *user_data)
1720 {
1721         USBI_GET_CONTEXT(ctx);
1722         ctx->fd_added_cb = added_cb;
1723         ctx->fd_removed_cb = removed_cb;
1724         ctx->fd_cb_user_data = user_data;
1725 }
1726
1727 /* Add a file descriptor to the list of file descriptors to be monitored.
1728  * events should be specified as a bitmask of events passed to poll(), e.g.
1729  * POLLIN and/or POLLOUT. */
1730 int usbi_add_pollfd(struct libusb_context *ctx, int fd, short events)
1731 {
1732         struct usbi_pollfd *ipollfd = malloc(sizeof(*ipollfd));
1733         if (!ipollfd)
1734                 return LIBUSB_ERROR_NO_MEM;
1735
1736         usbi_dbg("add fd %d events %d", fd, events);
1737         ipollfd->pollfd.fd = fd;
1738         ipollfd->pollfd.events = events;
1739         pthread_mutex_lock(&ctx->pollfds_lock);
1740         list_add_tail(&ipollfd->list, &ctx->pollfds);
1741         pthread_mutex_unlock(&ctx->pollfds_lock);
1742
1743         if (ctx->fd_added_cb)
1744                 ctx->fd_added_cb(fd, events, ctx->fd_cb_user_data);
1745         return 0;
1746 }
1747
1748 /* Remove a file descriptor from the list of file descriptors to be polled. */
1749 void usbi_remove_pollfd(struct libusb_context *ctx, int fd)
1750 {
1751         struct usbi_pollfd *ipollfd;
1752         int found = 0;
1753
1754         usbi_dbg("remove fd %d", fd);
1755         pthread_mutex_lock(&ctx->pollfds_lock);
1756         list_for_each_entry(ipollfd, &ctx->pollfds, list)
1757                 if (ipollfd->pollfd.fd == fd) {
1758                         found = 1;
1759                         break;
1760                 }
1761
1762         if (!found) {
1763                 usbi_dbg("couldn't find fd %d to remove", fd);
1764                 pthread_mutex_unlock(&ctx->pollfds_lock);
1765                 return;
1766         }
1767
1768         list_del(&ipollfd->list);
1769         pthread_mutex_unlock(&ctx->pollfds_lock);
1770         free(ipollfd);
1771         if (ctx->fd_removed_cb)
1772                 ctx->fd_removed_cb(fd, ctx->fd_cb_user_data);
1773 }
1774
1775 /** \ingroup poll
1776  * Retrieve a list of file descriptors that should be polled by your main loop
1777  * as libusb event sources.
1778  *
1779  * The returned list is NULL-terminated and should be freed with free() when
1780  * done. The actual list contents must not be touched.
1781  *
1782  * \param ctx the context to operate on, or NULL for the default context
1783  * \returns a NULL-terminated list of libusb_pollfd structures, or NULL on
1784  * error
1785  */
1786 API_EXPORTED const struct libusb_pollfd **libusb_get_pollfds(
1787         libusb_context *ctx)
1788 {
1789         struct libusb_pollfd **ret = NULL;
1790         struct usbi_pollfd *ipollfd;
1791         size_t i = 0;
1792         size_t cnt = 0;
1793         USBI_GET_CONTEXT(ctx);
1794
1795         pthread_mutex_lock(&ctx->pollfds_lock);
1796         list_for_each_entry(ipollfd, &ctx->pollfds, list)
1797                 cnt++;
1798
1799         ret = calloc(cnt + 1, sizeof(struct libusb_pollfd *));
1800         if (!ret)
1801                 goto out;
1802
1803         list_for_each_entry(ipollfd, &ctx->pollfds, list)
1804                 ret[i++] = (struct libusb_pollfd *) ipollfd;
1805         ret[cnt] = NULL;
1806
1807 out:
1808         pthread_mutex_unlock(&ctx->pollfds_lock);
1809         return (const struct libusb_pollfd **) ret;
1810 }
1811
1812 /* Backends call this from handle_events to report disconnection of a device.
1813  * The transfers get cancelled appropriately.
1814  */
1815 void usbi_handle_disconnect(struct libusb_device_handle *handle)
1816 {
1817         struct usbi_transfer *cur;
1818         struct usbi_transfer *to_cancel;
1819
1820         usbi_dbg("device %d.%d",
1821                 handle->dev->bus_number, handle->dev->device_address);
1822
1823         /* terminate all pending transfers with the LIBUSB_TRANSFER_NO_DEVICE
1824          * status code.
1825          * 
1826          * this is a bit tricky because:
1827          * 1. we can't do transfer completion while holding flying_transfers_lock
1828          * 2. the transfers list can change underneath us - if we were to build a
1829          *    list of transfers to complete (while holding look), the situation
1830          *    might be different by the time we come to free them
1831          *
1832          * so we resort to a loop-based approach as below
1833          * FIXME: is this still potentially racy?
1834          */
1835
1836         while (1) {
1837                 pthread_mutex_lock(&HANDLE_CTX(handle)->flying_transfers_lock);
1838                 to_cancel = NULL;
1839                 list_for_each_entry(cur, &HANDLE_CTX(handle)->flying_transfers, list)
1840                         if (__USBI_TRANSFER_TO_LIBUSB_TRANSFER(cur)->dev_handle == handle) {
1841                                 to_cancel = cur;
1842                                 break;
1843                         }
1844                 pthread_mutex_unlock(&HANDLE_CTX(handle)->flying_transfers_lock);
1845
1846                 if (!to_cancel)
1847                         break;
1848
1849                 usbi_backend->clear_transfer_priv(to_cancel);
1850                 usbi_handle_transfer_completion(to_cancel, LIBUSB_TRANSFER_NO_DEVICE);
1851         }
1852
1853 }
1854