1 /* -*- Mode: C; indent-tabs-mode:t ; c-basic-offset:8 -*- */
3 * I/O functions for libusb
4 * Copyright © 2007-2009 Daniel Drake <dsd@gentoo.org>
5 * Copyright © 2001 Johannes Erdfelt <johannes@erdfelt.com>
6 * Copyright © 2019 Nathan Hjelm <hjelmn@cs.umm.edu>
7 * Copyright © 2019 Google LLC. All rights reserved.
9 * This library is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU Lesser General Public
11 * License as published by the Free Software Foundation; either
12 * version 2.1 of the License, or (at your option) any later version.
14 * This library is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * Lesser General Public License for more details.
19 * You should have received a copy of the GNU Lesser General Public
20 * License along with this library; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
30 * \page libusb_io Synchronous and asynchronous device I/O
32 * \section io_intro Introduction
34 * If you're using libusb in your application, you're probably wanting to
35 * perform I/O with devices - you want to perform USB data transfers.
37 * libusb offers two separate interfaces for device I/O. This page aims to
38 * introduce the two in order to help you decide which one is more suitable
39 * for your application. You can also choose to use both interfaces in your
40 * application by considering each transfer on a case-by-case basis.
42 * Once you have read through the following discussion, you should consult the
43 * detailed API documentation pages for the details:
44 * - \ref libusb_syncio
45 * - \ref libusb_asyncio
47 * \section theory Transfers at a logical level
49 * At a logical level, USB transfers typically happen in two parts. For
50 * example, when reading data from a endpoint:
51 * -# A request for data is sent to the device
52 * -# Some time later, the incoming data is received by the host
54 * or when writing data to an endpoint:
56 * -# The data is sent to the device
57 * -# Some time later, the host receives acknowledgement from the device that
58 * the data has been transferred.
60 * There may be an indefinite delay between the two steps. Consider a
61 * fictional USB input device with a button that the user can press. In order
62 * to determine when the button is pressed, you would likely submit a request
63 * to read data on a bulk or interrupt endpoint and wait for data to arrive.
64 * Data will arrive when the button is pressed by the user, which is
65 * potentially hours later.
67 * libusb offers both a synchronous and an asynchronous interface to performing
68 * USB transfers. The main difference is that the synchronous interface
69 * combines both steps indicated above into a single function call, whereas
70 * the asynchronous interface separates them.
72 * \section sync The synchronous interface
74 * The synchronous I/O interface allows you to perform a USB transfer with
75 * a single function call. When the function call returns, the transfer has
76 * completed and you can parse the results.
78 * If you have used the libusb-0.1 before, this I/O style will seem familar to
79 * you. libusb-0.1 only offered a synchronous interface.
81 * In our input device example, to read button presses you might write code
82 * in the following style:
84 unsigned char data[4];
86 int r = libusb_bulk_transfer(dev_handle, LIBUSB_ENDPOINT_IN, data, sizeof(data), &actual_length, 0);
87 if (r == 0 && actual_length == sizeof(data)) {
88 // results of the transaction can now be found in the data buffer
89 // parse them here and report button press
95 * The main advantage of this model is simplicity: you did everything with
96 * a single simple function call.
98 * However, this interface has its limitations. Your application will sleep
99 * inside libusb_bulk_transfer() until the transaction has completed. If it
100 * takes the user 3 hours to press the button, your application will be
101 * sleeping for that long. Execution will be tied up inside the library -
102 * the entire thread will be useless for that duration.
104 * Another issue is that by tieing up the thread with that single transaction
105 * there is no possibility of performing I/O with multiple endpoints and/or
106 * multiple devices simultaneously, unless you resort to creating one thread
109 * Additionally, there is no opportunity to cancel the transfer after the
110 * request has been submitted.
112 * For details on how to use the synchronous API, see the
113 * \ref libusb_syncio "synchronous I/O API documentation" pages.
115 * \section async The asynchronous interface
117 * Asynchronous I/O is the most significant new feature in libusb-1.0.
118 * Although it is a more complex interface, it solves all the issues detailed
121 * Instead of providing which functions that block until the I/O has complete,
122 * libusb's asynchronous interface presents non-blocking functions which
123 * begin a transfer and then return immediately. Your application passes a
124 * callback function pointer to this non-blocking function, which libusb will
125 * call with the results of the transaction when it has completed.
127 * Transfers which have been submitted through the non-blocking functions
128 * can be cancelled with a separate function call.
130 * The non-blocking nature of this interface allows you to be simultaneously
131 * performing I/O to multiple endpoints on multiple devices, without having
134 * This added flexibility does come with some complications though:
135 * - In the interest of being a lightweight library, libusb does not create
136 * threads and can only operate when your application is calling into it. Your
137 * application must call into libusb from it's main loop when events are ready
138 * to be handled, or you must use some other scheme to allow libusb to
139 * undertake whatever work needs to be done.
140 * - libusb also needs to be called into at certain fixed points in time in
141 * order to accurately handle transfer timeouts.
142 * - Memory handling becomes more complex. You cannot use stack memory unless
143 * the function with that stack is guaranteed not to return until the transfer
144 * callback has finished executing.
145 * - You generally lose some linearity from your code flow because submitting
146 * the transfer request is done in a separate function from where the transfer
147 * results are handled. This becomes particularly obvious when you want to
148 * submit a second transfer based on the results of an earlier transfer.
150 * Internally, libusb's synchronous interface is expressed in terms of function
151 * calls to the asynchronous interface.
153 * For details on how to use the asynchronous API, see the
154 * \ref libusb_asyncio "asynchronous I/O API" documentation pages.
159 * \page libusb_packetoverflow Packets and overflows
161 * \section packets Packet abstraction
163 * The USB specifications describe how data is transmitted in packets, with
164 * constraints on packet size defined by endpoint descriptors. The host must
165 * not send data payloads larger than the endpoint's maximum packet size.
167 * libusb and the underlying OS abstract out the packet concept, allowing you
168 * to request transfers of any size. Internally, the request will be divided
169 * up into correctly-sized packets. You do not have to be concerned with
170 * packet sizes, but there is one exception when considering overflows.
172 * \section overflow Bulk/interrupt transfer overflows
174 * When requesting data on a bulk endpoint, libusb requires you to supply a
175 * buffer and the maximum number of bytes of data that libusb can put in that
176 * buffer. However, the size of the buffer is not communicated to the device -
177 * the device is just asked to send any amount of data.
179 * There is no problem if the device sends an amount of data that is less than
180 * or equal to the buffer size. libusb reports this condition to you through
181 * the \ref libusb_transfer::actual_length "libusb_transfer.actual_length"
184 * Problems may occur if the device attempts to send more data than can fit in
185 * the buffer. libusb reports LIBUSB_TRANSFER_OVERFLOW for this condition but
186 * other behaviour is largely undefined: actual_length may or may not be
187 * accurate, the chunk of data that can fit in the buffer (before overflow)
188 * may or may not have been transferred.
190 * Overflows are nasty, but can be avoided. Even though you were told to
191 * ignore packets above, think about the lower level details: each transfer is
192 * split into packets (typically small, with a maximum size of 512 bytes).
193 * Overflows can only happen if the final packet in an incoming data transfer
194 * is smaller than the actual packet that the device wants to transfer.
195 * Therefore, you will never see an overflow if your transfer buffer size is a
196 * multiple of the endpoint's packet size: the final packet will either
197 * fill up completely or will be only partially filled.
201 * @defgroup libusb_asyncio Asynchronous device I/O
203 * This page details libusb's asynchronous (non-blocking) API for USB device
204 * I/O. This interface is very powerful but is also quite complex - you will
205 * need to read this page carefully to understand the necessary considerations
206 * and issues surrounding use of this interface. Simplistic applications
207 * may wish to consider the \ref libusb_syncio "synchronous I/O API" instead.
209 * The asynchronous interface is built around the idea of separating transfer
210 * submission and handling of transfer completion (the synchronous model
211 * combines both of these into one). There may be a long delay between
212 * submission and completion, however the asynchronous submission function
213 * is non-blocking so will return control to your application during that
214 * potentially long delay.
216 * \section asyncabstraction Transfer abstraction
218 * For the asynchronous I/O, libusb implements the concept of a generic
219 * transfer entity for all types of I/O (control, bulk, interrupt,
220 * isochronous). The generic transfer object must be treated slightly
221 * differently depending on which type of I/O you are performing with it.
223 * This is represented by the public libusb_transfer structure type.
225 * \section asynctrf Asynchronous transfers
227 * We can view asynchronous I/O as a 5 step process:
228 * -# <b>Allocation</b>: allocate a libusb_transfer
229 * -# <b>Filling</b>: populate the libusb_transfer instance with information
230 * about the transfer you wish to perform
231 * -# <b>Submission</b>: ask libusb to submit the transfer
232 * -# <b>Completion handling</b>: examine transfer results in the
233 * libusb_transfer structure
234 * -# <b>Deallocation</b>: clean up resources
237 * \subsection asyncalloc Allocation
239 * This step involves allocating memory for a USB transfer. This is the
240 * generic transfer object mentioned above. At this stage, the transfer
241 * is "blank" with no details about what type of I/O it will be used for.
243 * Allocation is done with the libusb_alloc_transfer() function. You must use
244 * this function rather than allocating your own transfers.
246 * \subsection asyncfill Filling
248 * This step is where you take a previously allocated transfer and fill it
249 * with information to determine the message type and direction, data buffer,
250 * callback function, etc.
252 * You can either fill the required fields yourself or you can use the
253 * helper functions: libusb_fill_control_transfer(), libusb_fill_bulk_transfer()
254 * and libusb_fill_interrupt_transfer().
256 * \subsection asyncsubmit Submission
258 * When you have allocated a transfer and filled it, you can submit it using
259 * libusb_submit_transfer(). This function returns immediately but can be
260 * regarded as firing off the I/O request in the background.
262 * \subsection asynccomplete Completion handling
264 * After a transfer has been submitted, one of four things can happen to it:
266 * - The transfer completes (i.e. some data was transferred)
267 * - The transfer has a timeout and the timeout expires before all data is
269 * - The transfer fails due to an error
270 * - The transfer is cancelled
272 * Each of these will cause the user-specified transfer callback function to
273 * be invoked. It is up to the callback function to determine which of the
274 * above actually happened and to act accordingly.
276 * The user-specified callback is passed a pointer to the libusb_transfer
277 * structure which was used to setup and submit the transfer. At completion
278 * time, libusb has populated this structure with results of the transfer:
279 * success or failure reason, number of bytes of data transferred, etc. See
280 * the libusb_transfer structure documentation for more information.
282 * <b>Important Note</b>: The user-specified callback is called from an event
283 * handling context. It is therefore important that no calls are made into
284 * libusb that will attempt to perform any event handling. Examples of such
285 * functions are any listed in the \ref libusb_syncio "synchronous API" and any of
286 * the blocking functions that retrieve \ref libusb_desc "USB descriptors".
288 * \subsection Deallocation
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().
294 * It is undefined behaviour to free a transfer which has not completed.
296 * \section asyncresubmit Resubmission
298 * You may be wondering why allocation, filling, and submission are all
299 * separated above where they could reasonably be combined into a single
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.
308 * \section asynccancel Cancellation
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.
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.
319 * Freeing the transfer after it has been cancelled but before cancellation
320 * has completed will result in undefined behaviour.
323 * When a transfer is cancelled, some of the data may have been transferred.
324 * libusb will communicate this to you in the transfer callback.
325 * <b>Do not assume that no data was transferred.</b>
327 * \section asyncpartial Partial data transfer resulting from cancellation
329 * As noted above, some of the data may have been transferred at the time a
330 * transfer is cancelled. It is helpful to see how this is possible if you
331 * consider a bulk transfer to an endpoint with a packet size of 64 bytes.
332 * Supposing you submit a 512-byte transfer to this endpoint, the operating
333 * system will divide this transfer up into 8 separate 64-byte frames that the
334 * host controller will schedule for the device to transfer data. If this
335 * transfer is cancelled while the device is transferring data, a subset of
336 * these frames may be descheduled from the host controller before the device
337 * has the opportunity to finish transferring data to the host.
339 * What your application should do with a partial data transfer is a policy
340 * decision; there is no single answer that satisfies the needs of every
341 * application. The data that was successfully transferred should be
342 * considered entirely valid, but your application must decide what to do with
343 * the remaining data that was not transferred. Some possible actions to take
345 * - Resubmit another transfer for the remaining data, possibly with a shorter
347 * - Discard the partially transferred data and report an error
349 * \section asynctimeout Timeouts
351 * When a transfer times out, libusb internally notes this and attempts to
352 * cancel the transfer. As noted in \ref asyncpartial "above", it is possible
353 * that some of the data may actually have been transferred. Your application
354 * should <b>always</b> check how much data was actually transferred once the
355 * transfer completes and act accordingly.
357 * \section bulk_overflows Overflows on device-to-host bulk/interrupt endpoints
359 * If your device does not have predictable transfer sizes (or it misbehaves),
360 * your application may submit a request for data on an IN endpoint which is
361 * smaller than the data that the device wishes to send. In some circumstances
362 * this will cause an overflow, which is a nasty condition to deal with. See
363 * the \ref libusb_packetoverflow page for discussion.
365 * \section asyncctrl Considerations for control transfers
367 * The <tt>libusb_transfer</tt> structure is generic and hence does not
368 * include specific fields for the control-specific setup packet structure.
370 * In order to perform a control transfer, you must place the 8-byte setup
371 * packet at the start of the data buffer. To simplify this, you could
372 * cast the buffer pointer to type struct libusb_control_setup, or you can
373 * use the helper function libusb_fill_control_setup().
375 * The wLength field placed in the setup packet must be the length you would
376 * expect to be sent in the setup packet: the length of the payload that
377 * follows (or the expected maximum number of bytes to receive). However,
378 * the length field of the libusb_transfer object must be the length of
379 * the data buffer - i.e. it should be wLength <em>plus</em> the size of
380 * the setup packet (LIBUSB_CONTROL_SETUP_SIZE).
382 * If you use the helper functions, this is simplified for you:
383 * -# Allocate a buffer of size LIBUSB_CONTROL_SETUP_SIZE plus the size of the
384 * data you are sending/requesting.
385 * -# Call libusb_fill_control_setup() on the data buffer, using the transfer
386 * request size as the wLength value (i.e. do not include the extra space you
387 * allocated for the control setup).
388 * -# If this is a host-to-device transfer, place the data to be transferred
389 * in the data buffer, starting at offset LIBUSB_CONTROL_SETUP_SIZE.
390 * -# Call libusb_fill_control_transfer() to associate the data buffer with
391 * the transfer (and to set the remaining details such as callback and timeout).
392 * - Note that there is no parameter to set the length field of the transfer.
393 * The length is automatically inferred from the wLength field of the setup
395 * -# Submit the transfer.
397 * The multi-byte control setup fields (wValue, wIndex and wLength) must
398 * be given in little-endian byte order (the endianness of the USB bus).
399 * Endianness conversion is transparently handled by
400 * libusb_fill_control_setup() which is documented to accept host-endian
403 * Further considerations are needed when handling transfer completion in
404 * your callback function:
405 * - As you might expect, the setup packet will still be sitting at the start
406 * of the data buffer.
407 * - If this was a device-to-host transfer, the received data will be sitting
408 * at offset LIBUSB_CONTROL_SETUP_SIZE into the buffer.
409 * - The actual_length field of the transfer structure is relative to the
410 * wLength of the setup packet, rather than the size of the data buffer. So,
411 * if your wLength was 4, your transfer's <tt>length</tt> was 12, then you
412 * should expect an <tt>actual_length</tt> of 4 to indicate that the data was
413 * transferred in entirity.
415 * To simplify parsing of setup packets and obtaining the data from the
416 * correct offset, you may wish to use the libusb_control_transfer_get_data()
417 * and libusb_control_transfer_get_setup() functions within your transfer
420 * Even though control endpoints do not halt, a completed control transfer
421 * may have a LIBUSB_TRANSFER_STALL status code. This indicates the control
422 * request was not supported.
424 * \section asyncintr Considerations for interrupt transfers
426 * All interrupt transfers are performed using the polling interval presented
427 * by the bInterval value of the endpoint descriptor.
429 * \section asynciso Considerations for isochronous transfers
431 * Isochronous transfers are more complicated than transfers to
432 * non-isochronous endpoints.
434 * To perform I/O to an isochronous endpoint, allocate the transfer by calling
435 * libusb_alloc_transfer() with an appropriate number of isochronous packets.
437 * During filling, set \ref libusb_transfer::type "type" to
438 * \ref libusb_transfer_type::LIBUSB_TRANSFER_TYPE_ISOCHRONOUS
439 * "LIBUSB_TRANSFER_TYPE_ISOCHRONOUS", and set
440 * \ref libusb_transfer::num_iso_packets "num_iso_packets" to a value less than
441 * or equal to the number of packets you requested during allocation.
442 * libusb_alloc_transfer() does not set either of these fields for you, given
443 * that you might not even use the transfer on an isochronous endpoint.
445 * Next, populate the length field for the first num_iso_packets entries in
446 * the \ref libusb_transfer::iso_packet_desc "iso_packet_desc" array. Section
447 * 5.6.3 of the USB2 specifications describe how the maximum isochronous
448 * packet length is determined by the wMaxPacketSize field in the endpoint
450 * Two functions can help you here:
452 * - libusb_get_max_iso_packet_size() is an easy way to determine the max
453 * packet size for an isochronous endpoint. Note that the maximum packet
454 * size is actually the maximum number of bytes that can be transmitted in
455 * a single microframe, therefore this function multiplies the maximum number
456 * of bytes per transaction by the number of transaction opportunities per
458 * - libusb_set_iso_packet_lengths() assigns the same length to all packets
459 * within a transfer, which is usually what you want.
461 * For outgoing transfers, you'll obviously fill the buffer and populate the
462 * packet descriptors in hope that all the data gets transferred. For incoming
463 * transfers, you must ensure the buffer has sufficient capacity for
464 * the situation where all packets transfer the full amount of requested data.
466 * Completion handling requires some extra consideration. The
467 * \ref libusb_transfer::actual_length "actual_length" field of the transfer
468 * is meaningless and should not be examined; instead you must refer to the
469 * \ref libusb_iso_packet_descriptor::actual_length "actual_length" field of
470 * each individual packet.
472 * The \ref libusb_transfer::status "status" field of the transfer is also a
474 * - If the packets were submitted and the isochronous data microframes
475 * completed normally, status will have value
476 * \ref libusb_transfer_status::LIBUSB_TRANSFER_COMPLETED
477 * "LIBUSB_TRANSFER_COMPLETED". Note that bus errors and software-incurred
478 * delays are not counted as transfer errors; the transfer.status field may
479 * indicate COMPLETED even if some or all of the packets failed. Refer to
480 * the \ref libusb_iso_packet_descriptor::status "status" field of each
481 * individual packet to determine packet failures.
482 * - The status field will have value
483 * \ref libusb_transfer_status::LIBUSB_TRANSFER_ERROR
484 * "LIBUSB_TRANSFER_ERROR" only when serious errors were encountered.
485 * - Other transfer status codes occur with normal behaviour.
487 * The data for each packet will be found at an offset into the buffer that
488 * can be calculated as if each prior packet completed in full. The
489 * libusb_get_iso_packet_buffer() and libusb_get_iso_packet_buffer_simple()
490 * functions may help you here.
492 * \section asynclimits Transfer length limitations
494 * Some operating systems may impose limits on the length of the transfer data
495 * buffer or, in the case of isochronous transfers, the length of individual
496 * isochronous packets. Such limits can be difficult for libusb to detect, so
497 * in most cases the library will simply try and submit the transfer as set up
498 * by you. If the transfer fails to submit because it is too large,
499 * libusb_submit_transfer() will return
500 * \ref libusb_error::LIBUSB_ERROR_INVALID_PARAM "LIBUSB_ERROR_INVALID_PARAM".
502 * The following are known limits for control transfer lengths. Note that this
503 * length includes the 8-byte setup packet.
504 * - Linux (4,096 bytes)
505 * - Windows (4,096 bytes)
507 * \section asyncmem Memory caveats
509 * In most circumstances, it is not safe to use stack memory for transfer
510 * buffers. This is because the function that fired off the asynchronous
511 * transfer may return before libusb has finished using the buffer, and when
512 * the function returns it's stack gets destroyed. This is true for both
513 * host-to-device and device-to-host transfers.
515 * The only case in which it is safe to use stack memory is where you can
516 * guarantee that the function owning the stack space for the buffer does not
517 * return until after the transfer's callback function has completed. In every
518 * other case, you need to use heap memory instead.
520 * \section asyncflags Fine control
522 * Through using this asynchronous interface, you may find yourself repeating
523 * a few simple operations many times. You can apply a bitwise OR of certain
524 * flags to a transfer to simplify certain things:
525 * - \ref libusb_transfer_flags::LIBUSB_TRANSFER_SHORT_NOT_OK
526 * "LIBUSB_TRANSFER_SHORT_NOT_OK" results in transfers which transferred
527 * less than the requested amount of data being marked with status
528 * \ref libusb_transfer_status::LIBUSB_TRANSFER_ERROR "LIBUSB_TRANSFER_ERROR"
529 * (they would normally be regarded as COMPLETED)
530 * - \ref libusb_transfer_flags::LIBUSB_TRANSFER_FREE_BUFFER
531 * "LIBUSB_TRANSFER_FREE_BUFFER" allows you to ask libusb to free the transfer
532 * buffer when freeing the transfer.
533 * - \ref libusb_transfer_flags::LIBUSB_TRANSFER_FREE_TRANSFER
534 * "LIBUSB_TRANSFER_FREE_TRANSFER" causes libusb to automatically free the
535 * transfer after the transfer callback returns.
537 * \section asyncevent Event handling
539 * An asynchronous model requires that libusb perform work at various
540 * points in time - namely processing the results of previously-submitted
541 * transfers and invoking the user-supplied callback function.
543 * This gives rise to the libusb_handle_events() function which your
544 * application must call into when libusb has work do to. This gives libusb
545 * the opportunity to reap pending transfers, invoke callbacks, etc.
548 * All event handling is performed by whichever thread calls the
549 * libusb_handle_events() function. libusb does not invoke any callbacks
550 * outside of this context. Consequently, any callbacks will be run on the
551 * thread that calls the libusb_handle_events() function.
553 * When to call the libusb_handle_events() function depends on which model
554 * your application decides to use. The 2 different approaches:
556 * -# Repeatedly call libusb_handle_events() in blocking mode from a dedicated
558 * -# Integrate libusb with your application's main event loop. libusb
559 * exposes a set of file descriptors which allow you to do this.
561 * The first approach has the big advantage that it will also work on Windows
562 * were libusb' poll API for select / poll integration is not available. So
563 * if you want to support Windows and use the async API, you must use this
564 * approach, see the \ref eventthread "Using an event handling thread" section
567 * If you prefer a single threaded approach with a single central event loop,
568 * see the \ref libusb_poll "polling and timing" section for how to integrate libusb
569 * into your application's main event loop.
571 * \section eventthread Using an event handling thread
573 * Lets begin with stating the obvious: If you're going to use a separate
574 * thread for libusb event handling, your callback functions MUST be
577 * Other then that doing event handling from a separate thread, is mostly
578 * simple. You can use an event thread function as follows:
580 void *event_thread_func(void *ctx)
582 while (event_thread_run)
583 libusb_handle_events(ctx);
589 * There is one caveat though, stopping this thread requires setting the
590 * event_thread_run variable to 0, and after that libusb_handle_events() needs
591 * to return control to event_thread_func. But unless some event happens,
592 * libusb_handle_events() will not return.
594 * There are 2 different ways of dealing with this, depending on if your
595 * application uses libusb' \ref libusb_hotplug "hotplug" support or not.
597 * Applications which do not use hotplug support, should not start the event
598 * thread until after their first call to libusb_open(), and should stop the
599 * thread when closing the last open device as follows:
601 void my_close_handle(libusb_device_handle *dev_handle)
604 event_thread_run = 0;
606 libusb_close(dev_handle); // This wakes up libusb_handle_events()
609 pthread_join(event_thread);
615 * Applications using hotplug support should start the thread at program init,
616 * after having successfully called libusb_hotplug_register_callback(), and
617 * should stop the thread at program exit as follows:
619 void my_libusb_exit(void)
621 event_thread_run = 0;
622 libusb_hotplug_deregister_callback(ctx, hotplug_cb_handle); // This wakes up libusb_handle_events()
623 pthread_join(event_thread);
630 * @defgroup libusb_poll Polling and timing
632 * This page documents libusb's functions for polling events and timing.
633 * These functions are only necessary for users of the
634 * \ref libusb_asyncio "asynchronous API". If you are only using the simpler
635 * \ref libusb_syncio "synchronous API" then you do not need to ever call these
638 * The justification for the functionality described here has already been
639 * discussed in the \ref asyncevent "event handling" section of the
640 * asynchronous API documentation. In summary, libusb does not create internal
641 * threads for event processing and hence relies on your application calling
642 * into libusb at certain points in time so that pending events can be handled.
644 * Your main loop is probably already calling poll() or select() or a
645 * variant on a set of file descriptors for other event sources (e.g. keyboard
646 * button presses, mouse movements, network sockets, etc). You then add
647 * libusb's file descriptors to your poll()/select() calls, and when activity
648 * is detected on such descriptors you know it is time to call
649 * libusb_handle_events().
651 * There is one final event handling complication. libusb supports
652 * asynchronous transfers which time out after a specified time period.
654 * On some platforms a timerfd is used, so the timeout handling is just another
655 * fd, on other platforms this requires that libusb is called into at or after
656 * the timeout to handle it. So, in addition to considering libusb's file
657 * descriptors in your main event loop, you must also consider that libusb
658 * sometimes needs to be called into at fixed points in time even when there
659 * is no file descriptor activity, see \ref polltime details.
661 * In order to know precisely when libusb needs to be called into, libusb
662 * offers you a set of pollable file descriptors and information about when
663 * the next timeout expires.
665 * If you are using the asynchronous I/O API, you must take one of the two
666 * following options, otherwise your I/O will not complete.
668 * \section pollsimple The simple option
670 * If your application revolves solely around libusb and does not need to
671 * handle other event sources, you can have a program structure as follows:
674 // find and open device
675 // maybe fire off some initial async I/O
677 while (user_has_not_requested_exit)
678 libusb_handle_events(ctx);
683 * With such a simple main loop, you do not have to worry about managing
684 * sets of file descriptors or handling timeouts. libusb_handle_events() will
685 * handle those details internally.
687 * \section libusb_pollmain The more advanced option
689 * \note This functionality is currently only available on Unix-like platforms.
690 * On Windows, libusb_get_pollfds() simply returns NULL. Applications which
691 * want to support Windows are advised to use an \ref eventthread
692 * "event handling thread" instead.
694 * In more advanced applications, you will already have a main loop which
695 * is monitoring other event sources: network sockets, X11 events, mouse
696 * movements, etc. Through exposing a set of file descriptors, libusb is
697 * designed to cleanly integrate into such main loops.
699 * In addition to polling file descriptors for the other event sources, you
700 * take a set of file descriptors from libusb and monitor those too. When you
701 * detect activity on libusb's file descriptors, you call
702 * libusb_handle_events_timeout() in non-blocking mode.
704 * What's more, libusb may also need to handle events at specific moments in
705 * time. No file descriptor activity is generated at these times, so your
706 * own application needs to be continually aware of when the next one of these
707 * moments occurs (through calling libusb_get_next_timeout()), and then it
708 * needs to call libusb_handle_events_timeout() in non-blocking mode when
709 * these moments occur. This means that you need to adjust your
710 * poll()/select() timeout accordingly.
712 * libusb provides you with a set of file descriptors to poll and expects you
713 * to poll all of them, treating them as a single entity. The meaning of each
714 * file descriptor in the set is an internal implementation detail,
715 * platform-dependent and may vary from release to release. Don't try and
716 * interpret the meaning of the file descriptors, just do as libusb indicates,
717 * polling all of them at once.
719 * In pseudo-code, you want something that looks like:
723 libusb_get_pollfds(ctx)
724 while (user has not requested application exit) {
725 libusb_get_next_timeout(ctx);
726 poll(on libusb file descriptors plus any other event sources of interest,
727 using a timeout no larger than the value libusb just suggested)
728 if (poll() indicated activity on libusb file descriptors)
729 libusb_handle_events_timeout(ctx, &zero_tv);
730 if (time has elapsed to or beyond the libusb timeout)
731 libusb_handle_events_timeout(ctx, &zero_tv);
732 // handle events from other sources here
738 * \subsection polltime Notes on time-based events
740 * The above complication with having to track time and call into libusb at
741 * specific moments is a bit of a headache. For maximum compatibility, you do
742 * need to write your main loop as above, but you may decide that you can
743 * restrict the supported platforms of your application and get away with
744 * a more simplistic scheme.
746 * These time-based event complications are \b not required on the following
749 * - Linux, provided that the following version requirements are satisfied:
750 * - Linux v2.6.27 or newer, compiled with timerfd support
751 * - glibc v2.9 or newer
752 * - libusb v1.0.5 or newer
754 * Under these configurations, libusb_get_next_timeout() will \em always return
755 * 0, so your main loop can be simplified to:
759 libusb_get_pollfds(ctx)
760 while (user has not requested application exit) {
761 poll(on libusb file descriptors plus any other event sources of interest,
762 using any timeout that you like)
763 if (poll() indicated activity on libusb file descriptors)
764 libusb_handle_events_timeout(ctx, &zero_tv);
765 // handle events from other sources here
771 * Do remember that if you simplify your main loop to the above, you will
772 * lose compatibility with some platforms (including legacy Linux platforms,
773 * and <em>any future platforms supported by libusb which may have time-based
774 * event requirements</em>). The resultant problems will likely appear as
775 * strange bugs in your application.
777 * You can use the libusb_pollfds_handle_timeouts() function to do a runtime
778 * check to see if it is safe to ignore the time-based event complications.
779 * If your application has taken the shortcut of ignoring libusb's next timeout
780 * in your main loop, then you are advised to check the return value of
781 * libusb_pollfds_handle_timeouts() during application startup, and to abort
782 * if the platform does suffer from these timing complications.
784 * \subsection fdsetchange Changes in the file descriptor set
786 * The set of file descriptors that libusb uses as event sources may change
787 * during the life of your application. Rather than having to repeatedly
788 * call libusb_get_pollfds(), you can set up notification functions for when
789 * the file descriptor set changes using libusb_set_pollfd_notifiers().
791 * \subsection mtissues Multi-threaded considerations
793 * Unfortunately, the situation is complicated further when multiple threads
794 * come into play. If two threads are monitoring the same file descriptors,
795 * the fact that only one thread will be woken up when an event occurs causes
798 * The events lock, event waiters lock, and libusb_handle_events_locked()
799 * entities are added to solve these problems. You do not need to be concerned
800 * with these entities otherwise.
802 * See the extra documentation: \ref libusb_mtasync
805 /** \page libusb_mtasync Multi-threaded applications and asynchronous I/O
807 * libusb is a thread-safe library, but extra considerations must be applied
808 * to applications which interact with libusb from multiple threads.
810 * The underlying issue that must be addressed is that all libusb I/O
811 * revolves around monitoring file descriptors through the poll()/select()
812 * system calls. This is directly exposed at the
813 * \ref libusb_asyncio "asynchronous interface" but it is important to note that the
814 * \ref libusb_syncio "synchronous interface" is implemented on top of the
815 * asynchonrous interface, therefore the same considerations apply.
817 * The issue is that if two or more threads are concurrently calling poll()
818 * or select() on libusb's file descriptors then only one of those threads
819 * will be woken up when an event arrives. The others will be completely
820 * oblivious that anything has happened.
822 * Consider the following pseudo-code, which submits an asynchronous transfer
823 * then waits for its completion. This style is one way you could implement a
824 * synchronous interface on top of the asynchronous interface (and libusb
825 * does something similar, albeit more advanced due to the complications
826 * explained on this page).
829 void cb(struct libusb_transfer *transfer)
831 int *completed = transfer->user_data;
836 struct libusb_transfer *transfer;
837 unsigned char buffer[LIBUSB_CONTROL_SETUP_SIZE] __attribute__ ((aligned (2)));
840 transfer = libusb_alloc_transfer(0);
841 libusb_fill_control_setup(buffer,
842 LIBUSB_REQUEST_TYPE_VENDOR | LIBUSB_ENDPOINT_OUT, 0x04, 0x01, 0, 0);
843 libusb_fill_control_transfer(transfer, dev, buffer, cb, &completed, 1000);
844 libusb_submit_transfer(transfer);
847 poll(libusb file descriptors, 120*1000);
848 if (poll indicates activity)
849 libusb_handle_events_timeout(ctx, &zero_tv);
851 printf("completed!");
856 * Here we are <em>serializing</em> completion of an asynchronous event
857 * against a condition - the condition being completion of a specific transfer.
858 * The poll() loop has a long timeout to minimize CPU usage during situations
859 * when nothing is happening (it could reasonably be unlimited).
861 * If this is the only thread that is polling libusb's file descriptors, there
862 * is no problem: there is no danger that another thread will swallow up the
863 * event that we are interested in. On the other hand, if there is another
864 * thread polling the same descriptors, there is a chance that it will receive
865 * the event that we were interested in. In this situation, <tt>myfunc()</tt>
866 * will only realise that the transfer has completed on the next iteration of
867 * the loop, <em>up to 120 seconds later.</em> Clearly a two-minute delay is
868 * undesirable, and don't even think about using short timeouts to circumvent
871 * The solution here is to ensure that no two threads are ever polling the
872 * file descriptors at the same time. A naive implementation of this would
873 * impact the capabilities of the library, so libusb offers the scheme
874 * documented below to ensure no loss of functionality.
876 * Before we go any further, it is worth mentioning that all libusb-wrapped
877 * event handling procedures fully adhere to the scheme documented below.
878 * This includes libusb_handle_events() and its variants, and all the
879 * synchronous I/O functions - libusb hides this headache from you.
881 * \section Using libusb_handle_events() from multiple threads
883 * Even when only using libusb_handle_events() and synchronous I/O functions,
884 * you can still have a race condition. You might be tempted to solve the
885 * above with libusb_handle_events() like so:
888 libusb_submit_transfer(transfer);
891 libusb_handle_events(ctx);
893 printf("completed!");
896 * This however has a race between the checking of completed and
897 * libusb_handle_events() acquiring the events lock, so another thread
898 * could have completed the transfer, resulting in this thread hanging
899 * until either a timeout or another event occurs. See also commit
900 * 6696512aade99bb15d6792af90ae329af270eba6 which fixes this in the
901 * synchronous API implementation of libusb.
903 * Fixing this race requires checking the variable completed only after
904 * taking the event lock, which defeats the concept of just calling
905 * libusb_handle_events() without worrying about locking. This is why
906 * libusb-1.0.9 introduces the new libusb_handle_events_timeout_completed()
907 * and libusb_handle_events_completed() functions, which handles doing the
908 * completion check for you after they have acquired the lock:
911 libusb_submit_transfer(transfer);
914 libusb_handle_events_completed(ctx, &completed);
916 printf("completed!");
919 * This nicely fixes the race in our example. Note that if all you want to
920 * do is submit a single transfer and wait for its completion, then using
921 * one of the synchronous I/O functions is much easier.
923 * \section eventlock The events lock
925 * The problem is when we consider the fact that libusb exposes file
926 * descriptors to allow for you to integrate asynchronous USB I/O into
927 * existing main loops, effectively allowing you to do some work behind
928 * libusb's back. If you do take libusb's file descriptors and pass them to
929 * poll()/select() yourself, you need to be aware of the associated issues.
931 * The first concept to be introduced is the events lock. The events lock
932 * is used to serialize threads that want to handle events, such that only
933 * one thread is handling events at any one time.
935 * You must take the events lock before polling libusb file descriptors,
936 * using libusb_lock_events(). You must release the lock as soon as you have
937 * aborted your poll()/select() loop, using libusb_unlock_events().
939 * \section threadwait Letting other threads do the work for you
941 * Although the events lock is a critical part of the solution, it is not
942 * enough on it's own. You might wonder if the following is sufficient...
944 libusb_lock_events(ctx);
946 poll(libusb file descriptors, 120*1000);
947 if (poll indicates activity)
948 libusb_handle_events_timeout(ctx, &zero_tv);
950 libusb_unlock_events(ctx);
952 * ...and the answer is that it is not. This is because the transfer in the
953 * code shown above may take a long time (say 30 seconds) to complete, and
954 * the lock is not released until the transfer is completed.
956 * Another thread with similar code that wants to do event handling may be
957 * working with a transfer that completes after a few milliseconds. Despite
958 * having such a quick completion time, the other thread cannot check that
959 * status of its transfer until the code above has finished (30 seconds later)
960 * due to contention on the lock.
962 * To solve this, libusb offers you a mechanism to determine when another
963 * thread is handling events. It also offers a mechanism to block your thread
964 * until the event handling thread has completed an event (and this mechanism
965 * does not involve polling of file descriptors).
967 * After determining that another thread is currently handling events, you
968 * obtain the <em>event waiters</em> lock using libusb_lock_event_waiters().
969 * You then re-check that some other thread is still handling events, and if
970 * so, you call libusb_wait_for_event().
972 * libusb_wait_for_event() puts your application to sleep until an event
973 * occurs, or until a thread releases the events lock. When either of these
974 * things happen, your thread is woken up, and should re-check the condition
975 * it was waiting on. It should also re-check that another thread is handling
976 * events, and if not, it should start handling events itself.
978 * This looks like the following, as pseudo-code:
981 if (libusb_try_lock_events(ctx) == 0) {
982 // we obtained the event lock: do our own event handling
984 if (!libusb_event_handling_ok(ctx)) {
985 libusb_unlock_events(ctx);
988 poll(libusb file descriptors, 120*1000);
989 if (poll indicates activity)
990 libusb_handle_events_locked(ctx, 0);
992 libusb_unlock_events(ctx);
994 // another thread is doing event handling. wait for it to signal us that
995 // an event has completed
996 libusb_lock_event_waiters(ctx);
999 // now that we have the event waiters lock, double check that another
1000 // thread is still handling events for us. (it may have ceased handling
1001 // events in the time it took us to reach this point)
1002 if (!libusb_event_handler_active(ctx)) {
1003 // whoever was handling events is no longer doing so, try again
1004 libusb_unlock_event_waiters(ctx);
1008 libusb_wait_for_event(ctx, NULL);
1010 libusb_unlock_event_waiters(ctx);
1012 printf("completed!\n");
1015 * A naive look at the above code may suggest that this can only support
1016 * one event waiter (hence a total of 2 competing threads, the other doing
1017 * event handling), because the event waiter seems to have taken the event
1018 * waiters lock while waiting for an event. However, the system does support
1019 * multiple event waiters, because libusb_wait_for_event() actually drops
1020 * the lock while waiting, and reaquires it before continuing.
1022 * We have now implemented code which can dynamically handle situations where
1023 * nobody is handling events (so we should do it ourselves), and it can also
1024 * handle situations where another thread is doing event handling (so we can
1025 * piggyback onto them). It is also equipped to handle a combination of
1026 * the two, for example, another thread is doing event handling, but for
1027 * whatever reason it stops doing so before our condition is met, so we take
1028 * over the event handling.
1030 * Four functions were introduced in the above pseudo-code. Their importance
1031 * should be apparent from the code shown above.
1032 * -# libusb_try_lock_events() is a non-blocking function which attempts
1033 * to acquire the events lock but returns a failure code if it is contended.
1034 * -# libusb_event_handling_ok() checks that libusb is still happy for your
1035 * thread to be performing event handling. Sometimes, libusb needs to
1036 * interrupt the event handler, and this is how you can check if you have
1037 * been interrupted. If this function returns 0, the correct behaviour is
1038 * for you to give up the event handling lock, and then to repeat the cycle.
1039 * The following libusb_try_lock_events() will fail, so you will become an
1040 * events waiter. For more information on this, read \ref fullstory below.
1041 * -# libusb_handle_events_locked() is a variant of
1042 * libusb_handle_events_timeout() that you can call while holding the
1043 * events lock. libusb_handle_events_timeout() itself implements similar
1044 * logic to the above, so be sure not to call it when you are
1045 * "working behind libusb's back", as is the case here.
1046 * -# libusb_event_handler_active() determines if someone is currently
1047 * holding the events lock
1049 * You might be wondering why there is no function to wake up all threads
1050 * blocked on libusb_wait_for_event(). This is because libusb can do this
1051 * internally: it will wake up all such threads when someone calls
1052 * libusb_unlock_events() or when a transfer completes (at the point after its
1053 * callback has returned).
1055 * \subsection fullstory The full story
1057 * The above explanation should be enough to get you going, but if you're
1058 * really thinking through the issues then you may be left with some more
1059 * questions regarding libusb's internals. If you're curious, read on, and if
1060 * not, skip to the next section to avoid confusing yourself!
1062 * The immediate question that may spring to mind is: what if one thread
1063 * modifies the set of file descriptors that need to be polled while another
1064 * thread is doing event handling?
1066 * There are 2 situations in which this may happen.
1067 * -# libusb_open() will add another file descriptor to the poll set,
1068 * therefore it is desirable to interrupt the event handler so that it
1069 * restarts, picking up the new descriptor.
1070 * -# libusb_close() will remove a file descriptor from the poll set. There
1071 * are all kinds of race conditions that could arise here, so it is
1072 * important that nobody is doing event handling at this time.
1074 * libusb handles these issues internally, so application developers do not
1075 * have to stop their event handlers while opening/closing devices. Here's how
1076 * it works, focusing on the libusb_close() situation first:
1078 * -# During initialization, libusb opens an internal pipe, and it adds the read
1079 * end of this pipe to the set of file descriptors to be polled.
1080 * -# During libusb_close(), libusb writes some dummy data on this event pipe.
1081 * This immediately interrupts the event handler. libusb also records
1082 * internally that it is trying to interrupt event handlers for this
1083 * high-priority event.
1084 * -# At this point, some of the functions described above start behaving
1086 * - libusb_event_handling_ok() starts returning 1, indicating that it is NOT
1087 * OK for event handling to continue.
1088 * - libusb_try_lock_events() starts returning 1, indicating that another
1089 * thread holds the event handling lock, even if the lock is uncontended.
1090 * - libusb_event_handler_active() starts returning 1, indicating that
1091 * another thread is doing event handling, even if that is not true.
1092 * -# The above changes in behaviour result in the event handler stopping and
1093 * giving up the events lock very quickly, giving the high-priority
1094 * libusb_close() operation a "free ride" to acquire the events lock. All
1095 * threads that are competing to do event handling become event waiters.
1096 * -# With the events lock held inside libusb_close(), libusb can safely remove
1097 * a file descriptor from the poll set, in the safety of knowledge that
1098 * nobody is polling those descriptors or trying to access the poll set.
1099 * -# After obtaining the events lock, the close operation completes very
1100 * quickly (usually a matter of milliseconds) and then immediately releases
1102 * -# At the same time, the behaviour of libusb_event_handling_ok() and friends
1103 * reverts to the original, documented behaviour.
1104 * -# The release of the events lock causes the threads that are waiting for
1105 * events to be woken up and to start competing to become event handlers
1106 * again. One of them will succeed; it will then re-obtain the list of poll
1107 * descriptors, and USB I/O will then continue as normal.
1109 * libusb_open() is similar, and is actually a more simplistic case. Upon a
1110 * call to libusb_open():
1112 * -# The device is opened and a file descriptor is added to the poll set.
1113 * -# libusb sends some dummy data on the event pipe, and records that it
1114 * is trying to modify the poll descriptor set.
1115 * -# The event handler is interrupted, and the same behaviour change as for
1116 * libusb_close() takes effect, causing all event handling threads to become
1118 * -# The libusb_open() implementation takes its free ride to the events lock.
1119 * -# Happy that it has successfully paused the events handler, libusb_open()
1120 * releases the events lock.
1121 * -# The event waiter threads are all woken up and compete to become event
1122 * handlers again. The one that succeeds will obtain the list of poll
1123 * descriptors again, which will include the addition of the new device.
1125 * \subsection concl Closing remarks
1127 * The above may seem a little complicated, but hopefully I have made it clear
1128 * why such complications are necessary. Also, do not forget that this only
1129 * applies to applications that take libusb's file descriptors and integrate
1130 * them into their own polling loops.
1132 * You may decide that it is OK for your multi-threaded application to ignore
1133 * some of the rules and locks detailed above, because you don't think that
1134 * two threads can ever be polling the descriptors at the same time. If that
1135 * is the case, then that's good news for you because you don't have to worry.
1136 * But be careful here; remember that the synchronous I/O functions do event
1137 * handling internally. If you have one thread doing event handling in a loop
1138 * (without implementing the rules and locking semantics documented above)
1139 * and another trying to send a synchronous USB transfer, you will end up with
1140 * two threads monitoring the same descriptors, and the above-described
1141 * undesirable behaviour occurring. The solution is for your polling thread to
1142 * play by the rules; the synchronous I/O functions do so, and this will result
1143 * in them getting along in perfect harmony.
1145 * If you do have a dedicated thread doing event handling, it is perfectly
1146 * legal for it to take the event handling lock for long periods of time. Any
1147 * synchronous I/O functions you call from other threads will transparently
1148 * fall back to the "event waiters" mechanism detailed above. The only
1149 * consideration that your event handling thread must apply is the one related
1150 * to libusb_event_handling_ok(): you must call this before every poll(), and
1151 * give up the events lock if instructed.
1154 int usbi_io_init(struct libusb_context *ctx)
1158 usbi_mutex_init(&ctx->flying_transfers_lock);
1159 usbi_mutex_init(&ctx->events_lock);
1160 usbi_mutex_init(&ctx->event_waiters_lock);
1161 usbi_cond_init(&ctx->event_waiters_cond);
1162 usbi_mutex_init(&ctx->event_data_lock);
1163 usbi_tls_key_create(&ctx->event_handling_key);
1164 list_init(&ctx->flying_transfers);
1165 list_init(&ctx->event_sources);
1166 list_init(&ctx->removed_event_sources);
1167 list_init(&ctx->hotplug_msgs);
1168 list_init(&ctx->completed_transfers);
1170 r = usbi_create_event(&ctx->event);
1174 r = usbi_add_event_source(ctx, USBI_EVENT_OS_HANDLE(&ctx->event), USBI_EVENT_POLL_EVENTS);
1176 goto err_destroy_event;
1178 #ifdef HAVE_OS_TIMER
1179 r = usbi_create_timer(&ctx->timer);
1181 usbi_dbg("using timer for timeouts");
1182 r = usbi_add_event_source(ctx, USBI_TIMER_OS_HANDLE(&ctx->timer), USBI_TIMER_POLL_EVENTS);
1184 goto err_destroy_timer;
1186 usbi_dbg("timer not available for timeouts");
1192 #ifdef HAVE_OS_TIMER
1194 usbi_destroy_timer(&ctx->timer);
1195 usbi_remove_event_source(ctx, USBI_EVENT_OS_HANDLE(&ctx->event));
1198 usbi_destroy_event(&ctx->event);
1200 usbi_mutex_destroy(&ctx->flying_transfers_lock);
1201 usbi_mutex_destroy(&ctx->events_lock);
1202 usbi_mutex_destroy(&ctx->event_waiters_lock);
1203 usbi_cond_destroy(&ctx->event_waiters_cond);
1204 usbi_mutex_destroy(&ctx->event_data_lock);
1205 usbi_tls_key_delete(ctx->event_handling_key);
1209 static void cleanup_removed_event_sources(struct libusb_context *ctx)
1211 struct usbi_event_source *ievent_source, *tmp;
1213 for_each_removed_event_source_safe(ctx, ievent_source, tmp) {
1214 list_del(&ievent_source->list);
1215 free(ievent_source);
1219 void usbi_io_exit(struct libusb_context *ctx)
1221 #ifdef HAVE_OS_TIMER
1222 if (usbi_using_timer(ctx)) {
1223 usbi_remove_event_source(ctx, USBI_TIMER_OS_HANDLE(&ctx->timer));
1224 usbi_destroy_timer(&ctx->timer);
1227 usbi_remove_event_source(ctx, USBI_EVENT_OS_HANDLE(&ctx->event));
1228 usbi_destroy_event(&ctx->event);
1229 usbi_mutex_destroy(&ctx->flying_transfers_lock);
1230 usbi_mutex_destroy(&ctx->events_lock);
1231 usbi_mutex_destroy(&ctx->event_waiters_lock);
1232 usbi_cond_destroy(&ctx->event_waiters_cond);
1233 usbi_mutex_destroy(&ctx->event_data_lock);
1234 usbi_tls_key_delete(ctx->event_handling_key);
1235 cleanup_removed_event_sources(ctx);
1236 free(ctx->event_data);
1239 static int calculate_timeout(struct usbi_transfer *itransfer)
1242 unsigned int timeout =
1243 USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer)->timeout;
1246 TIMESPEC_CLEAR(&itransfer->timeout);
1250 r = usbi_clock_gettime(USBI_CLOCK_MONOTONIC, &itransfer->timeout);
1252 usbi_err(ITRANSFER_CTX(itransfer),
1253 "failed to read monotonic clock, errno=%d", errno);
1254 return LIBUSB_ERROR_OTHER;
1257 itransfer->timeout.tv_sec += timeout / 1000U;
1258 itransfer->timeout.tv_nsec += (timeout % 1000U) * 1000000L;
1259 if (itransfer->timeout.tv_nsec >= 1000000000L) {
1260 ++itransfer->timeout.tv_sec;
1261 itransfer->timeout.tv_nsec -= 1000000000L;
1267 /** \ingroup libusb_asyncio
1268 * Allocate a libusb transfer with a specified number of isochronous packet
1269 * descriptors. The returned transfer is pre-initialized for you. When the new
1270 * transfer is no longer needed, it should be freed with
1271 * libusb_free_transfer().
1273 * Transfers intended for non-isochronous endpoints (e.g. control, bulk,
1274 * interrupt) should specify an iso_packets count of zero.
1276 * For transfers intended for isochronous endpoints, specify an appropriate
1277 * number of packet descriptors to be allocated as part of the transfer.
1278 * The returned transfer is not specially initialized for isochronous I/O;
1279 * you are still required to set the
1280 * \ref libusb_transfer::num_iso_packets "num_iso_packets" and
1281 * \ref libusb_transfer::type "type" fields accordingly.
1283 * It is safe to allocate a transfer with some isochronous packets and then
1284 * use it on a non-isochronous endpoint. If you do this, ensure that at time
1285 * of submission, num_iso_packets is 0 and that type is set appropriately.
1287 * \param iso_packets number of isochronous packet descriptors to allocate. Must be non-negative.
1288 * \returns a newly allocated transfer, or NULL on error
1291 struct libusb_transfer * LIBUSB_CALL libusb_alloc_transfer(
1297 struct usbi_transfer *itransfer;
1298 struct libusb_transfer *transfer;
1300 assert(iso_packets >= 0);
1301 if (iso_packets < 0)
1304 priv_size = PTR_ALIGN(usbi_backend.transfer_priv_size);
1305 alloc_size = priv_size
1306 + sizeof(struct usbi_transfer)
1307 + sizeof(struct libusb_transfer)
1308 + (sizeof(struct libusb_iso_packet_descriptor) * (size_t)iso_packets);
1309 ptr = calloc(1, alloc_size);
1313 itransfer = (struct usbi_transfer *)(ptr + priv_size);
1314 itransfer->num_iso_packets = iso_packets;
1315 itransfer->priv = ptr;
1316 usbi_mutex_init(&itransfer->lock);
1317 transfer = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
1318 usbi_dbg("transfer %p", transfer);
1322 /** \ingroup libusb_asyncio
1323 * Free a transfer structure. This should be called for all transfers
1324 * allocated with libusb_alloc_transfer().
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()).
1331 * It is legal to call this function with a NULL transfer. In this case,
1332 * the function will simply return safely.
1334 * It is not legal to free an active transfer (one which has been submitted
1335 * and has not yet completed).
1337 * \param transfer the transfer to free
1339 void API_EXPORTED libusb_free_transfer(struct libusb_transfer *transfer)
1341 struct usbi_transfer *itransfer;
1348 usbi_dbg("transfer %p", transfer);
1349 if (transfer->flags & LIBUSB_TRANSFER_FREE_BUFFER)
1350 free(transfer->buffer);
1352 itransfer = LIBUSB_TRANSFER_TO_USBI_TRANSFER(transfer);
1353 usbi_mutex_destroy(&itransfer->lock);
1355 priv_size = PTR_ALIGN(usbi_backend.transfer_priv_size);
1356 ptr = (unsigned char *)itransfer - priv_size;
1357 assert(ptr == itransfer->priv);
1361 /* iterates through the flying transfers, and rearms the timer based on the
1362 * next upcoming timeout.
1363 * must be called with flying_list locked.
1364 * returns 0 on success or a LIBUSB_ERROR code on failure.
1366 #ifdef HAVE_OS_TIMER
1367 static int arm_timer_for_next_timeout(struct libusb_context *ctx)
1369 struct usbi_transfer *itransfer;
1371 if (!usbi_using_timer(ctx))
1374 for_each_transfer(ctx, itransfer) {
1375 struct timespec *cur_ts = &itransfer->timeout;
1377 /* if we've reached transfers of infinite timeout, then we have no
1379 if (!TIMESPEC_IS_SET(cur_ts))
1382 /* act on first transfer that has not already been handled */
1383 if (!(itransfer->timeout_flags & (USBI_TRANSFER_TIMEOUT_HANDLED | USBI_TRANSFER_OS_HANDLES_TIMEOUT))) {
1384 usbi_dbg("next timeout originally %ums", USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer)->timeout);
1385 return usbi_arm_timer(&ctx->timer, cur_ts);
1389 usbi_dbg("no timeouts, disarming timer");
1390 return usbi_disarm_timer(&ctx->timer);
1393 static inline int arm_timer_for_next_timeout(struct libusb_context *ctx)
1400 /* add a transfer to the (timeout-sorted) active transfers list.
1401 * This function will return non 0 if fails to update the timer,
1402 * in which case the transfer is *not* on the flying_transfers list. */
1403 static int add_to_flying_list(struct usbi_transfer *itransfer)
1405 struct usbi_transfer *cur;
1406 struct timespec *timeout = &itransfer->timeout;
1407 struct libusb_context *ctx = ITRANSFER_CTX(itransfer);
1411 r = calculate_timeout(itransfer);
1415 /* if we have no other flying transfers, start the list with this one */
1416 if (list_empty(&ctx->flying_transfers)) {
1417 list_add(&itransfer->list, &ctx->flying_transfers);
1421 /* if we have infinite timeout, append to end of list */
1422 if (!TIMESPEC_IS_SET(timeout)) {
1423 list_add_tail(&itransfer->list, &ctx->flying_transfers);
1424 /* first is irrelevant in this case */
1428 /* otherwise, find appropriate place in list */
1429 for_each_transfer(ctx, cur) {
1430 /* find first timeout that occurs after the transfer in question */
1431 struct timespec *cur_ts = &cur->timeout;
1433 if (!TIMESPEC_IS_SET(cur_ts) || TIMESPEC_CMP(cur_ts, timeout, >)) {
1434 list_add_tail(&itransfer->list, &cur->list);
1439 /* first is 0 at this stage (list not empty) */
1441 /* otherwise we need to be inserted at the end */
1442 list_add_tail(&itransfer->list, &ctx->flying_transfers);
1444 #ifdef HAVE_OS_TIMER
1445 if (first && usbi_using_timer(ctx) && TIMESPEC_IS_SET(timeout)) {
1446 /* if this transfer has the lowest timeout of all active transfers,
1447 * rearm the timer with this transfer's timeout */
1448 usbi_dbg("arm timer for timeout in %ums (first in line)",
1449 USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer)->timeout);
1450 r = usbi_arm_timer(&ctx->timer, timeout);
1457 list_del(&itransfer->list);
1462 /* remove a transfer from the active transfers list.
1463 * This function will *always* remove the transfer from the
1464 * flying_transfers list. It will return a LIBUSB_ERROR code
1465 * if it fails to update the timer for the next timeout. */
1466 static int remove_from_flying_list(struct usbi_transfer *itransfer)
1468 struct libusb_context *ctx = ITRANSFER_CTX(itransfer);
1472 usbi_mutex_lock(&ctx->flying_transfers_lock);
1473 rearm_timer = (TIMESPEC_IS_SET(&itransfer->timeout) &&
1474 list_first_entry(&ctx->flying_transfers, struct usbi_transfer, list) == itransfer);
1475 list_del(&itransfer->list);
1477 r = arm_timer_for_next_timeout(ctx);
1478 usbi_mutex_unlock(&ctx->flying_transfers_lock);
1483 /** \ingroup libusb_asyncio
1484 * Submit a transfer. This function will fire off the USB transfer and then
1485 * return immediately.
1487 * \param transfer the transfer to submit
1488 * \returns 0 on success
1489 * \returns LIBUSB_ERROR_NO_DEVICE if the device has been disconnected
1490 * \returns LIBUSB_ERROR_BUSY if the transfer has already been submitted.
1491 * \returns LIBUSB_ERROR_NOT_SUPPORTED if the transfer flags are not supported
1492 * by the operating system.
1493 * \returns LIBUSB_ERROR_INVALID_PARAM if the transfer size is larger than
1494 * the operating system and/or hardware can support (see \ref asynclimits)
1495 * \returns another LIBUSB_ERROR code on other failure
1497 int API_EXPORTED libusb_submit_transfer(struct libusb_transfer *transfer)
1499 struct usbi_transfer *itransfer =
1500 LIBUSB_TRANSFER_TO_USBI_TRANSFER(transfer);
1501 struct libusb_context *ctx = TRANSFER_CTX(transfer);
1504 usbi_dbg("transfer %p", transfer);
1507 * Important note on locking, this function takes / releases locks
1508 * in the following order:
1509 * take flying_transfers_lock
1510 * take itransfer->lock
1512 * add to flying_transfers list
1513 * release flying_transfers_lock
1515 * release itransfer->lock
1517 * take flying_transfers_lock
1518 * remove from flying_transfers list
1519 * release flying_transfers_lock
1521 * Note that it takes locks in the order a-b and then releases them
1522 * in the same order a-b. This is somewhat unusual but not wrong,
1523 * release order is not important as long as *all* locks are released
1524 * before re-acquiring any locks.
1526 * This means that the ordering of first releasing itransfer->lock
1527 * and then re-acquiring the flying_transfers_list on error is
1528 * important and must not be changed!
1530 * This is done this way because when we take both locks we must always
1531 * take flying_transfers_lock first to avoid ab-ba style deadlocks with
1532 * the timeout handling and usbi_handle_disconnect paths.
1534 * And we cannot release itransfer->lock before the submission is
1535 * complete otherwise timeout handling for transfers with short
1536 * timeouts may run before submission.
1538 usbi_mutex_lock(&ctx->flying_transfers_lock);
1539 usbi_mutex_lock(&itransfer->lock);
1540 if (itransfer->state_flags & USBI_TRANSFER_IN_FLIGHT) {
1541 usbi_mutex_unlock(&ctx->flying_transfers_lock);
1542 usbi_mutex_unlock(&itransfer->lock);
1543 return LIBUSB_ERROR_BUSY;
1545 itransfer->transferred = 0;
1546 itransfer->state_flags = 0;
1547 itransfer->timeout_flags = 0;
1548 r = add_to_flying_list(itransfer);
1550 usbi_mutex_unlock(&ctx->flying_transfers_lock);
1551 usbi_mutex_unlock(&itransfer->lock);
1555 * We must release the flying transfers lock here, because with
1556 * some backends the submit_transfer method is synchroneous.
1558 usbi_mutex_unlock(&ctx->flying_transfers_lock);
1560 r = usbi_backend.submit_transfer(itransfer);
1561 if (r == LIBUSB_SUCCESS) {
1562 itransfer->state_flags |= USBI_TRANSFER_IN_FLIGHT;
1563 /* keep a reference to this device */
1564 libusb_ref_device(transfer->dev_handle->dev);
1566 usbi_mutex_unlock(&itransfer->lock);
1568 if (r != LIBUSB_SUCCESS)
1569 remove_from_flying_list(itransfer);
1574 /** \ingroup libusb_asyncio
1575 * Asynchronously cancel a previously submitted transfer.
1576 * This function returns immediately, but this does not indicate cancellation
1577 * is complete. Your callback function will be invoked at some later time
1578 * with a transfer status of
1579 * \ref libusb_transfer_status::LIBUSB_TRANSFER_CANCELLED
1580 * "LIBUSB_TRANSFER_CANCELLED."
1582 * \param transfer the transfer to cancel
1583 * \returns 0 on success
1584 * \returns LIBUSB_ERROR_NOT_FOUND if the transfer is not in progress,
1585 * already complete, or already cancelled.
1586 * \returns a LIBUSB_ERROR code on failure
1588 int API_EXPORTED libusb_cancel_transfer(struct libusb_transfer *transfer)
1590 struct usbi_transfer *itransfer =
1591 LIBUSB_TRANSFER_TO_USBI_TRANSFER(transfer);
1594 usbi_dbg("transfer %p", transfer );
1595 usbi_mutex_lock(&itransfer->lock);
1596 if (!(itransfer->state_flags & USBI_TRANSFER_IN_FLIGHT)
1597 || (itransfer->state_flags & USBI_TRANSFER_CANCELLING)) {
1598 r = LIBUSB_ERROR_NOT_FOUND;
1601 r = usbi_backend.cancel_transfer(itransfer);
1603 if (r != LIBUSB_ERROR_NOT_FOUND &&
1604 r != LIBUSB_ERROR_NO_DEVICE)
1605 usbi_err(TRANSFER_CTX(transfer),
1606 "cancel transfer failed error %d", r);
1608 usbi_dbg("cancel transfer failed error %d", r);
1610 if (r == LIBUSB_ERROR_NO_DEVICE)
1611 itransfer->state_flags |= USBI_TRANSFER_DEVICE_DISAPPEARED;
1614 itransfer->state_flags |= USBI_TRANSFER_CANCELLING;
1617 usbi_mutex_unlock(&itransfer->lock);
1621 /** \ingroup libusb_asyncio
1622 * Set a transfers bulk stream id. Note users are advised to use
1623 * libusb_fill_bulk_stream_transfer() instead of calling this function
1626 * Since version 1.0.19, \ref LIBUSB_API_VERSION >= 0x01000103
1628 * \param transfer the transfer to set the stream id for
1629 * \param stream_id the stream id to set
1630 * \see libusb_alloc_streams()
1632 void API_EXPORTED libusb_transfer_set_stream_id(
1633 struct libusb_transfer *transfer, uint32_t stream_id)
1635 struct usbi_transfer *itransfer =
1636 LIBUSB_TRANSFER_TO_USBI_TRANSFER(transfer);
1638 itransfer->stream_id = stream_id;
1641 /** \ingroup libusb_asyncio
1642 * Get a transfers bulk stream id.
1644 * Since version 1.0.19, \ref LIBUSB_API_VERSION >= 0x01000103
1646 * \param transfer the transfer to get the stream id for
1647 * \returns the stream id for the transfer
1649 uint32_t API_EXPORTED libusb_transfer_get_stream_id(
1650 struct libusb_transfer *transfer)
1652 struct usbi_transfer *itransfer =
1653 LIBUSB_TRANSFER_TO_USBI_TRANSFER(transfer);
1655 return itransfer->stream_id;
1658 /* Handle completion of a transfer (completion might be an error condition).
1659 * This will invoke the user-supplied callback function, which may end up
1660 * freeing the transfer. Therefore you cannot use the transfer structure
1661 * after calling this function, and you should free all backend-specific
1662 * data before calling it.
1663 * Do not call this function with the usbi_transfer lock held. User-specified
1664 * callback functions may attempt to directly resubmit the transfer, which
1665 * will attempt to take the lock. */
1666 int usbi_handle_transfer_completion(struct usbi_transfer *itransfer,
1667 enum libusb_transfer_status status)
1669 struct libusb_transfer *transfer =
1670 USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
1671 struct libusb_device_handle *dev_handle = transfer->dev_handle;
1675 r = remove_from_flying_list(itransfer);
1677 usbi_err(ITRANSFER_CTX(itransfer), "failed to set timer for next timeout");
1679 usbi_mutex_lock(&itransfer->lock);
1680 itransfer->state_flags &= ~USBI_TRANSFER_IN_FLIGHT;
1681 usbi_mutex_unlock(&itransfer->lock);
1683 if (status == LIBUSB_TRANSFER_COMPLETED
1684 && transfer->flags & LIBUSB_TRANSFER_SHORT_NOT_OK) {
1685 int rqlen = transfer->length;
1686 if (transfer->type == LIBUSB_TRANSFER_TYPE_CONTROL)
1687 rqlen -= LIBUSB_CONTROL_SETUP_SIZE;
1688 if (rqlen != itransfer->transferred) {
1689 usbi_dbg("interpreting short transfer as error");
1690 status = LIBUSB_TRANSFER_ERROR;
1694 flags = transfer->flags;
1695 transfer->status = status;
1696 transfer->actual_length = itransfer->transferred;
1697 usbi_dbg("transfer %p has callback %p", transfer, transfer->callback);
1698 if (transfer->callback)
1699 transfer->callback(transfer);
1700 /* transfer might have been freed by the above call, do not use from
1702 if (flags & LIBUSB_TRANSFER_FREE_TRANSFER)
1703 libusb_free_transfer(transfer);
1704 libusb_unref_device(dev_handle->dev);
1708 /* Similar to usbi_handle_transfer_completion() but exclusively for transfers
1709 * that were asynchronously cancelled. The same concerns w.r.t. freeing of
1710 * transfers exist here.
1711 * Do not call this function with the usbi_transfer lock held. User-specified
1712 * callback functions may attempt to directly resubmit the transfer, which
1713 * will attempt to take the lock. */
1714 int usbi_handle_transfer_cancellation(struct usbi_transfer *itransfer)
1716 struct libusb_context *ctx = ITRANSFER_CTX(itransfer);
1719 usbi_mutex_lock(&ctx->flying_transfers_lock);
1720 timed_out = itransfer->timeout_flags & USBI_TRANSFER_TIMED_OUT;
1721 usbi_mutex_unlock(&ctx->flying_transfers_lock);
1723 /* if the URB was cancelled due to timeout, report timeout to the user */
1725 usbi_dbg("detected timeout cancellation");
1726 return usbi_handle_transfer_completion(itransfer, LIBUSB_TRANSFER_TIMED_OUT);
1729 /* otherwise its a normal async cancel */
1730 return usbi_handle_transfer_completion(itransfer, LIBUSB_TRANSFER_CANCELLED);
1733 /* Add a completed transfer to the completed_transfers list of the
1734 * context and signal the event. The backend's handle_transfer_completion()
1735 * function will be called the next time an event handler runs. */
1736 void usbi_signal_transfer_completion(struct usbi_transfer *itransfer)
1738 libusb_device_handle *dev_handle = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer)->dev_handle;
1741 struct libusb_context *ctx = HANDLE_CTX(dev_handle);
1742 unsigned int event_flags;
1744 usbi_mutex_lock(&ctx->event_data_lock);
1745 event_flags = ctx->event_flags;
1746 ctx->event_flags |= USBI_EVENT_TRANSFER_COMPLETED;
1747 list_add_tail(&itransfer->completed_list, &ctx->completed_transfers);
1749 usbi_signal_event(&ctx->event);
1750 usbi_mutex_unlock(&ctx->event_data_lock);
1754 /** \ingroup libusb_poll
1755 * Attempt to acquire the event handling lock. This lock is used to ensure that
1756 * only one thread is monitoring libusb event sources at any one time.
1758 * You only need to use this lock if you are developing an application
1759 * which calls poll() or select() on libusb's file descriptors directly.
1760 * If you stick to libusb's event handling loop functions (e.g.
1761 * libusb_handle_events()) then you do not need to be concerned with this
1764 * While holding this lock, you are trusted to actually be handling events.
1765 * If you are no longer handling events, you must call libusb_unlock_events()
1766 * as soon as possible.
1768 * \param ctx the context to operate on, or NULL for the default context
1769 * \returns 0 if the lock was obtained successfully
1770 * \returns 1 if the lock was not obtained (i.e. another thread holds the lock)
1771 * \ref libusb_mtasync
1773 int API_EXPORTED libusb_try_lock_events(libusb_context *ctx)
1778 ctx = usbi_get_context(ctx);
1780 /* is someone else waiting to close a device? if so, don't let this thread
1781 * start event handling */
1782 usbi_mutex_lock(&ctx->event_data_lock);
1783 ru = ctx->device_close;
1784 usbi_mutex_unlock(&ctx->event_data_lock);
1786 usbi_dbg("someone else is closing a device");
1790 r = usbi_mutex_trylock(&ctx->events_lock);
1794 ctx->event_handler_active = 1;
1798 /** \ingroup libusb_poll
1799 * Acquire the event handling lock, blocking until successful acquisition if
1800 * it is contended. This lock is used to ensure that only one thread is
1801 * monitoring libusb event sources at any one time.
1803 * You only need to use this lock if you are developing an application
1804 * which calls poll() or select() on libusb's file descriptors directly.
1805 * If you stick to libusb's event handling loop functions (e.g.
1806 * libusb_handle_events()) then you do not need to be concerned with this
1809 * While holding this lock, you are trusted to actually be handling events.
1810 * If you are no longer handling events, you must call libusb_unlock_events()
1811 * as soon as possible.
1813 * \param ctx the context to operate on, or NULL for the default context
1814 * \ref libusb_mtasync
1816 void API_EXPORTED libusb_lock_events(libusb_context *ctx)
1818 ctx = usbi_get_context(ctx);
1819 usbi_mutex_lock(&ctx->events_lock);
1820 ctx->event_handler_active = 1;
1823 /** \ingroup libusb_poll
1824 * Release the lock previously acquired with libusb_try_lock_events() or
1825 * libusb_lock_events(). Releasing this lock will wake up any threads blocked
1826 * on libusb_wait_for_event().
1828 * \param ctx the context to operate on, or NULL for the default context
1829 * \ref libusb_mtasync
1831 void API_EXPORTED libusb_unlock_events(libusb_context *ctx)
1833 ctx = usbi_get_context(ctx);
1834 ctx->event_handler_active = 0;
1835 usbi_mutex_unlock(&ctx->events_lock);
1837 /* FIXME: perhaps we should be a bit more efficient by not broadcasting
1838 * the availability of the events lock when we are modifying pollfds
1839 * (check ctx->device_close)? */
1840 usbi_mutex_lock(&ctx->event_waiters_lock);
1841 usbi_cond_broadcast(&ctx->event_waiters_cond);
1842 usbi_mutex_unlock(&ctx->event_waiters_lock);
1845 /** \ingroup libusb_poll
1846 * Determine if it is still OK for this thread to be doing event handling.
1848 * Sometimes, libusb needs to temporarily pause all event handlers, and this
1849 * is the function you should use before polling file descriptors to see if
1852 * If this function instructs your thread to give up the events lock, you
1853 * should just continue the usual logic that is documented in \ref libusb_mtasync.
1854 * On the next iteration, your thread will fail to obtain the events lock,
1855 * and will hence become an event waiter.
1857 * This function should be called while the events lock is held: you don't
1858 * need to worry about the results of this function if your thread is not
1859 * the current event handler.
1861 * \param ctx the context to operate on, or NULL for the default context
1862 * \returns 1 if event handling can start or continue
1863 * \returns 0 if this thread must give up the events lock
1864 * \ref fullstory "Multi-threaded I/O: the full story"
1866 int API_EXPORTED libusb_event_handling_ok(libusb_context *ctx)
1870 ctx = usbi_get_context(ctx);
1872 /* is someone else waiting to close a device? if so, don't let this thread
1873 * continue event handling */
1874 usbi_mutex_lock(&ctx->event_data_lock);
1875 r = ctx->device_close;
1876 usbi_mutex_unlock(&ctx->event_data_lock);
1878 usbi_dbg("someone else is closing a device");
1886 /** \ingroup libusb_poll
1887 * Determine if an active thread is handling events (i.e. if anyone is holding
1888 * the event handling lock).
1890 * \param ctx the context to operate on, or NULL for the default context
1891 * \returns 1 if a thread is handling events
1892 * \returns 0 if there are no threads currently handling events
1893 * \ref libusb_mtasync
1895 int API_EXPORTED libusb_event_handler_active(libusb_context *ctx)
1899 ctx = usbi_get_context(ctx);
1901 /* is someone else waiting to close a device? if so, don't let this thread
1902 * start event handling -- indicate that event handling is happening */
1903 usbi_mutex_lock(&ctx->event_data_lock);
1904 r = ctx->device_close;
1905 usbi_mutex_unlock(&ctx->event_data_lock);
1907 usbi_dbg("someone else is closing a device");
1911 return ctx->event_handler_active;
1914 /** \ingroup libusb_poll
1915 * Interrupt any active thread that is handling events. This is mainly useful
1916 * for interrupting a dedicated event handling thread when an application
1917 * wishes to call libusb_exit().
1919 * Since version 1.0.21, \ref LIBUSB_API_VERSION >= 0x01000105
1921 * \param ctx the context to operate on, or NULL for the default context
1922 * \ref libusb_mtasync
1924 void API_EXPORTED libusb_interrupt_event_handler(libusb_context *ctx)
1926 unsigned int event_flags;
1930 ctx = usbi_get_context(ctx);
1931 usbi_mutex_lock(&ctx->event_data_lock);
1933 event_flags = ctx->event_flags;
1934 ctx->event_flags |= USBI_EVENT_USER_INTERRUPT;
1936 usbi_signal_event(&ctx->event);
1938 usbi_mutex_unlock(&ctx->event_data_lock);
1941 /** \ingroup libusb_poll
1942 * Acquire the event waiters lock. This lock is designed to be obtained under
1943 * the situation where you want to be aware when events are completed, but
1944 * some other thread is event handling so calling libusb_handle_events() is not
1947 * You then obtain this lock, re-check that another thread is still handling
1948 * events, then call libusb_wait_for_event().
1950 * You only need to use this lock if you are developing an application
1951 * which calls poll() or select() on libusb's file descriptors directly,
1952 * <b>and</b> may potentially be handling events from 2 threads simultaenously.
1953 * If you stick to libusb's event handling loop functions (e.g.
1954 * libusb_handle_events()) then you do not need to be concerned with this
1957 * \param ctx the context to operate on, or NULL for the default context
1958 * \ref libusb_mtasync
1960 void API_EXPORTED libusb_lock_event_waiters(libusb_context *ctx)
1962 ctx = usbi_get_context(ctx);
1963 usbi_mutex_lock(&ctx->event_waiters_lock);
1966 /** \ingroup libusb_poll
1967 * Release the event waiters lock.
1968 * \param ctx the context to operate on, or NULL for the default context
1969 * \ref libusb_mtasync
1971 void API_EXPORTED libusb_unlock_event_waiters(libusb_context *ctx)
1973 ctx = usbi_get_context(ctx);
1974 usbi_mutex_unlock(&ctx->event_waiters_lock);
1977 /** \ingroup libusb_poll
1978 * Wait for another thread to signal completion of an event. Must be called
1979 * with the event waiters lock held, see libusb_lock_event_waiters().
1981 * This function will block until any of the following conditions are met:
1982 * -# The timeout expires
1983 * -# A transfer completes
1984 * -# A thread releases the event handling lock through libusb_unlock_events()
1986 * Condition 1 is obvious. Condition 2 unblocks your thread <em>after</em>
1987 * the callback for the transfer has completed. Condition 3 is important
1988 * because it means that the thread that was previously handling events is no
1989 * longer doing so, so if any events are to complete, another thread needs to
1990 * step up and start event handling.
1992 * This function releases the event waiters lock before putting your thread
1993 * to sleep, and reacquires the lock as it is being woken up.
1995 * \param ctx the context to operate on, or NULL for the default context
1996 * \param tv maximum timeout for this blocking function. A NULL value
1997 * indicates unlimited timeout.
1998 * \returns 0 after a transfer completes or another thread stops event handling
1999 * \returns 1 if the timeout expired
2000 * \ref libusb_mtasync
2002 int API_EXPORTED libusb_wait_for_event(libusb_context *ctx, struct timeval *tv)
2006 ctx = usbi_get_context(ctx);
2008 usbi_cond_wait(&ctx->event_waiters_cond, &ctx->event_waiters_lock);
2012 r = usbi_cond_timedwait(&ctx->event_waiters_cond,
2013 &ctx->event_waiters_lock, tv);
2018 return (r == ETIMEDOUT);
2021 static void handle_timeout(struct usbi_transfer *itransfer)
2023 struct libusb_transfer *transfer =
2024 USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
2027 itransfer->timeout_flags |= USBI_TRANSFER_TIMEOUT_HANDLED;
2028 r = libusb_cancel_transfer(transfer);
2029 if (r == LIBUSB_SUCCESS)
2030 itransfer->timeout_flags |= USBI_TRANSFER_TIMED_OUT;
2032 usbi_warn(TRANSFER_CTX(transfer),
2033 "async cancel failed %d errno=%d", r, errno);
2036 static int handle_timeouts_locked(struct libusb_context *ctx)
2039 struct timespec systime;
2040 struct usbi_transfer *itransfer;
2042 if (list_empty(&ctx->flying_transfers))
2045 /* get current time */
2046 r = usbi_clock_gettime(USBI_CLOCK_MONOTONIC, &systime);
2048 usbi_err(ctx, "failed to read monotonic clock, errno=%d", errno);
2049 return LIBUSB_ERROR_OTHER;
2052 /* iterate through flying transfers list, finding all transfers that
2053 * have expired timeouts */
2054 for_each_transfer(ctx, itransfer) {
2055 struct timespec *cur_ts = &itransfer->timeout;
2057 /* if we've reached transfers of infinite timeout, we're all done */
2058 if (!TIMESPEC_IS_SET(cur_ts))
2061 /* ignore timeouts we've already handled */
2062 if (itransfer->timeout_flags & (USBI_TRANSFER_TIMEOUT_HANDLED | USBI_TRANSFER_OS_HANDLES_TIMEOUT))
2065 /* if transfer has non-expired timeout, nothing more to do */
2066 if (TIMESPEC_CMP(cur_ts, &systime, >))
2069 /* otherwise, we've got an expired timeout to handle */
2070 handle_timeout(itransfer);
2075 static int handle_timeouts(struct libusb_context *ctx)
2079 ctx = usbi_get_context(ctx);
2080 usbi_mutex_lock(&ctx->flying_transfers_lock);
2081 r = handle_timeouts_locked(ctx);
2082 usbi_mutex_unlock(&ctx->flying_transfers_lock);
2086 static int handle_event_trigger(struct libusb_context *ctx)
2088 struct list_head hotplug_msgs;
2091 usbi_dbg("event triggered");
2093 list_init(&hotplug_msgs);
2095 /* take the the event data lock while processing events */
2096 usbi_mutex_lock(&ctx->event_data_lock);
2098 /* check if someone modified the event sources */
2099 if (ctx->event_flags & USBI_EVENT_EVENT_SOURCES_MODIFIED)
2100 usbi_dbg("someone updated the event sources");
2102 if (ctx->event_flags & USBI_EVENT_USER_INTERRUPT) {
2103 usbi_dbg("someone purposefully interrupted");
2104 ctx->event_flags &= ~USBI_EVENT_USER_INTERRUPT;
2107 /* check if someone is closing a device */
2108 if (ctx->event_flags & USBI_EVENT_DEVICE_CLOSE)
2109 usbi_dbg("someone is closing a device");
2111 /* check for any pending hotplug messages */
2112 if (ctx->event_flags & USBI_EVENT_HOTPLUG_MSG_PENDING) {
2113 usbi_dbg("hotplug message received");
2114 ctx->event_flags &= ~USBI_EVENT_HOTPLUG_MSG_PENDING;
2115 assert(!list_empty(&ctx->hotplug_msgs));
2116 list_cut(&hotplug_msgs, &ctx->hotplug_msgs);
2119 /* complete any pending transfers */
2120 if (ctx->event_flags & USBI_EVENT_TRANSFER_COMPLETED) {
2121 assert(!list_empty(&ctx->completed_transfers));
2122 while (r == 0 && !list_empty(&ctx->completed_transfers)) {
2123 struct usbi_transfer *itransfer =
2124 list_first_entry(&ctx->completed_transfers, struct usbi_transfer, completed_list);
2126 list_del(&itransfer->completed_list);
2127 usbi_mutex_unlock(&ctx->event_data_lock);
2128 r = usbi_backend.handle_transfer_completion(itransfer);
2130 usbi_err(ctx, "backend handle_transfer_completion failed with error %d", r);
2131 usbi_mutex_lock(&ctx->event_data_lock);
2134 if (list_empty(&ctx->completed_transfers))
2135 ctx->event_flags &= ~USBI_EVENT_TRANSFER_COMPLETED;
2138 /* if no further pending events, clear the event */
2139 if (!ctx->event_flags)
2140 usbi_clear_event(&ctx->event);
2142 usbi_mutex_unlock(&ctx->event_data_lock);
2144 /* process the hotplug messages, if any */
2145 while (!list_empty(&hotplug_msgs)) {
2146 struct libusb_hotplug_message *message =
2147 list_first_entry(&hotplug_msgs, struct libusb_hotplug_message, list);
2149 usbi_hotplug_match(ctx, message->device, message->event);
2151 /* the device left, dereference the device */
2152 if (message->event == LIBUSB_HOTPLUG_EVENT_DEVICE_LEFT)
2153 libusb_unref_device(message->device);
2155 list_del(&message->list);
2162 #ifdef HAVE_OS_TIMER
2163 static int handle_timer_trigger(struct libusb_context *ctx)
2167 usbi_mutex_lock(&ctx->flying_transfers_lock);
2169 /* process the timeout that just happened */
2170 r = handle_timeouts_locked(ctx);
2174 /* arm for next timeout */
2175 r = arm_timer_for_next_timeout(ctx);
2178 usbi_mutex_unlock(&ctx->flying_transfers_lock);
2183 /* do the actual event handling. assumes that no other thread is concurrently
2184 * doing the same thing. */
2185 static int handle_events(struct libusb_context *ctx, struct timeval *tv)
2187 struct usbi_reported_events reported_events;
2190 /* prevent attempts to recursively handle events (e.g. calling into
2191 * libusb_handle_events() from within a hotplug or transfer callback) */
2192 if (usbi_handling_events(ctx))
2193 return LIBUSB_ERROR_BUSY;
2195 /* only reallocate the event source data when the list of event sources has
2196 * been modified since the last handle_events(), otherwise reuse them to
2197 * save the additional overhead */
2198 usbi_mutex_lock(&ctx->event_data_lock);
2199 if (ctx->event_flags & USBI_EVENT_EVENT_SOURCES_MODIFIED) {
2200 usbi_dbg("event sources modified, reallocating event data");
2202 /* free anything removed since we last ran */
2203 cleanup_removed_event_sources(ctx);
2205 r = usbi_alloc_event_data(ctx);
2207 usbi_mutex_unlock(&ctx->event_data_lock);
2211 /* reset the flag now that we have the updated list */
2212 ctx->event_flags &= ~USBI_EVENT_EVENT_SOURCES_MODIFIED;
2214 /* if no further pending events, clear the event so that we do
2215 * not immediately return from the wait function */
2216 if (!ctx->event_flags)
2217 usbi_clear_event(&ctx->event);
2219 usbi_mutex_unlock(&ctx->event_data_lock);
2221 timeout_ms = (int)(tv->tv_sec * 1000) + (tv->tv_usec / 1000);
2223 /* round up to next millisecond */
2224 if (tv->tv_usec % 1000)
2227 usbi_start_event_handling(ctx);
2229 r = usbi_wait_for_events(ctx, &reported_events, timeout_ms);
2230 if (r != LIBUSB_SUCCESS) {
2231 if (r == LIBUSB_ERROR_TIMEOUT)
2232 r = handle_timeouts(ctx);
2236 if (reported_events.event_triggered) {
2237 r = handle_event_trigger(ctx);
2239 /* return error code */
2244 #ifdef HAVE_OS_TIMER
2245 if (reported_events.timer_triggered) {
2246 r = handle_timer_trigger(ctx);
2248 /* return error code */
2254 if (!reported_events.num_ready)
2257 r = usbi_backend.handle_events(ctx, reported_events.event_data,
2258 reported_events.event_data_count, reported_events.num_ready);
2260 usbi_err(ctx, "backend handle_events failed with error %d", r);
2263 usbi_end_event_handling(ctx);
2267 /* returns the smallest of:
2268 * 1. timeout of next URB
2269 * 2. user-supplied timeout
2270 * returns 1 if there is an already-expired timeout, otherwise returns 0
2273 static int get_next_timeout(libusb_context *ctx, struct timeval *tv,
2274 struct timeval *out)
2276 struct timeval timeout;
2277 int r = libusb_get_next_timeout(ctx, &timeout);
2279 /* timeout already expired? */
2280 if (!timerisset(&timeout))
2283 /* choose the smallest of next URB timeout or user specified timeout */
2284 if (timercmp(&timeout, tv, <))
2294 /** \ingroup libusb_poll
2295 * Handle any pending events.
2297 * libusb determines "pending events" by checking if any timeouts have expired
2298 * and by checking the set of file descriptors for activity.
2300 * If a zero timeval is passed, this function will handle any already-pending
2301 * events and then immediately return in non-blocking style.
2303 * If a non-zero timeval is passed and no events are currently pending, this
2304 * function will block waiting for events to handle up until the specified
2305 * timeout. If an event arrives or a signal is raised, this function will
2308 * If the parameter completed is not NULL then <em>after obtaining the event
2309 * handling lock</em> this function will return immediately if the integer
2310 * pointed to is not 0. This allows for race free waiting for the completion
2311 * of a specific transfer.
2313 * \param ctx the context to operate on, or NULL for the default context
2314 * \param tv the maximum time to block waiting for events, or an all zero
2315 * timeval struct for non-blocking mode
2316 * \param completed pointer to completion integer to check, or NULL
2317 * \returns 0 on success, or a LIBUSB_ERROR code on failure
2318 * \ref libusb_mtasync
2320 int API_EXPORTED libusb_handle_events_timeout_completed(libusb_context *ctx,
2321 struct timeval *tv, int *completed)
2324 struct timeval poll_timeout;
2326 ctx = usbi_get_context(ctx);
2327 r = get_next_timeout(ctx, tv, &poll_timeout);
2329 /* timeout already expired */
2330 return handle_timeouts(ctx);
2334 if (libusb_try_lock_events(ctx) == 0) {
2335 if (completed == NULL || !*completed) {
2336 /* we obtained the event lock: do our own event handling */
2337 usbi_dbg("doing our own event handling");
2338 r = handle_events(ctx, &poll_timeout);
2340 libusb_unlock_events(ctx);
2344 /* another thread is doing event handling. wait for thread events that
2345 * notify event completion. */
2346 libusb_lock_event_waiters(ctx);
2348 if (completed && *completed)
2351 if (!libusb_event_handler_active(ctx)) {
2352 /* we hit a race: whoever was event handling earlier finished in the
2353 * time it took us to reach this point. try the cycle again. */
2354 libusb_unlock_event_waiters(ctx);
2355 usbi_dbg("event handler was active but went away, retrying");
2359 usbi_dbg("another thread is doing event handling");
2360 r = libusb_wait_for_event(ctx, &poll_timeout);
2363 libusb_unlock_event_waiters(ctx);
2368 return handle_timeouts(ctx);
2373 /** \ingroup libusb_poll
2374 * Handle any pending events
2376 * Like libusb_handle_events_timeout_completed(), but without the completed
2377 * parameter, calling this function is equivalent to calling
2378 * libusb_handle_events_timeout_completed() with a NULL completed parameter.
2380 * This function is kept primarily for backwards compatibility.
2381 * All new code should call libusb_handle_events_completed() or
2382 * libusb_handle_events_timeout_completed() to avoid race conditions.
2384 * \param ctx the context to operate on, or NULL for the default context
2385 * \param tv the maximum time to block waiting for events, or an all zero
2386 * timeval struct for non-blocking mode
2387 * \returns 0 on success, or a LIBUSB_ERROR code on failure
2389 int API_EXPORTED libusb_handle_events_timeout(libusb_context *ctx,
2392 return libusb_handle_events_timeout_completed(ctx, tv, NULL);
2395 /** \ingroup libusb_poll
2396 * Handle any pending events in blocking mode. There is currently a timeout
2397 * hardcoded at 60 seconds but we plan to make it unlimited in future. For
2398 * finer control over whether this function is blocking or non-blocking, or
2399 * for control over the timeout, use libusb_handle_events_timeout_completed()
2402 * This function is kept primarily for backwards compatibility.
2403 * All new code should call libusb_handle_events_completed() or
2404 * libusb_handle_events_timeout_completed() to avoid race conditions.
2406 * \param ctx the context to operate on, or NULL for the default context
2407 * \returns 0 on success, or a LIBUSB_ERROR code on failure
2409 int API_EXPORTED libusb_handle_events(libusb_context *ctx)
2414 return libusb_handle_events_timeout_completed(ctx, &tv, NULL);
2417 /** \ingroup libusb_poll
2418 * Handle any pending events in blocking mode.
2420 * Like libusb_handle_events(), with the addition of a completed parameter
2421 * to allow for race free waiting for the completion of a specific transfer.
2423 * See libusb_handle_events_timeout_completed() for details on the completed
2426 * \param ctx the context to operate on, or NULL for the default context
2427 * \param completed pointer to completion integer to check, or NULL
2428 * \returns 0 on success, or a LIBUSB_ERROR code on failure
2429 * \ref libusb_mtasync
2431 int API_EXPORTED libusb_handle_events_completed(libusb_context *ctx,
2437 return libusb_handle_events_timeout_completed(ctx, &tv, completed);
2440 /** \ingroup libusb_poll
2441 * Handle any pending events by polling file descriptors, without checking if
2442 * any other threads are already doing so. Must be called with the event lock
2443 * held, see libusb_lock_events().
2445 * This function is designed to be called under the situation where you have
2446 * taken the event lock and are calling poll()/select() directly on libusb's
2447 * file descriptors (as opposed to using libusb_handle_events() or similar).
2448 * You detect events on libusb's descriptors, so you then call this function
2449 * with a zero timeout value (while still holding the event lock).
2451 * \param ctx the context to operate on, or NULL for the default context
2452 * \param tv the maximum time to block waiting for events, or zero for
2454 * \returns 0 on success, or a LIBUSB_ERROR code on failure
2455 * \ref libusb_mtasync
2457 int API_EXPORTED libusb_handle_events_locked(libusb_context *ctx,
2461 struct timeval poll_timeout;
2463 ctx = usbi_get_context(ctx);
2464 r = get_next_timeout(ctx, tv, &poll_timeout);
2466 /* timeout already expired */
2467 return handle_timeouts(ctx);
2470 return handle_events(ctx, &poll_timeout);
2473 /** \ingroup libusb_poll
2474 * Determines whether your application must apply special timing considerations
2475 * when monitoring libusb's file descriptors.
2477 * This function is only useful for applications which retrieve and poll
2478 * libusb's file descriptors in their own main loop (\ref libusb_pollmain).
2480 * Ordinarily, libusb's event handler needs to be called into at specific
2481 * moments in time (in addition to times when there is activity on the file
2482 * descriptor set). The usual approach is to use libusb_get_next_timeout()
2483 * to learn about when the next timeout occurs, and to adjust your
2484 * poll()/select() timeout accordingly so that you can make a call into the
2485 * library at that time.
2487 * Some platforms supported by libusb do not come with this baggage - any
2488 * events relevant to timing will be represented by activity on the file
2489 * descriptor set, and libusb_get_next_timeout() will always return 0.
2490 * This function allows you to detect whether you are running on such a
2495 * \param ctx the context to operate on, or NULL for the default context
2496 * \returns 0 if you must call into libusb at times determined by
2497 * libusb_get_next_timeout(), or 1 if all timeout events are handled internally
2498 * or through regular activity on the file descriptors.
2499 * \ref libusb_pollmain "Polling libusb file descriptors for event handling"
2501 int API_EXPORTED libusb_pollfds_handle_timeouts(libusb_context *ctx)
2503 ctx = usbi_get_context(ctx);
2504 return usbi_using_timer(ctx);
2507 /** \ingroup libusb_poll
2508 * Determine the next internal timeout that libusb needs to handle. You only
2509 * need to use this function if you are calling poll() or select() or similar
2510 * on libusb's file descriptors yourself - you do not need to use it if you
2511 * are calling libusb_handle_events() or a variant directly.
2513 * You should call this function in your main loop in order to determine how
2514 * long to wait for select() or poll() to return results. libusb needs to be
2515 * called into at this timeout, so you should use it as an upper bound on
2516 * your select() or poll() call.
2518 * When the timeout has expired, call into libusb_handle_events_timeout()
2519 * (perhaps in non-blocking mode) so that libusb can handle the timeout.
2521 * This function may return 1 (success) and an all-zero timeval. If this is
2522 * the case, it indicates that libusb has a timeout that has already expired
2523 * so you should call libusb_handle_events_timeout() or similar immediately.
2524 * A return code of 0 indicates that there are no pending timeouts.
2526 * On some platforms, this function will always returns 0 (no pending
2527 * timeouts). See \ref polltime.
2529 * \param ctx the context to operate on, or NULL for the default context
2530 * \param tv output location for a relative time against the current
2531 * clock in which libusb must be called into in order to process timeout events
2532 * \returns 0 if there are no pending timeouts, 1 if a timeout was returned,
2533 * or LIBUSB_ERROR_OTHER on failure
2535 int API_EXPORTED libusb_get_next_timeout(libusb_context *ctx,
2538 struct usbi_transfer *itransfer;
2539 struct timespec systime;
2540 struct timespec next_timeout = { 0, 0 };
2543 ctx = usbi_get_context(ctx);
2544 if (usbi_using_timer(ctx))
2547 usbi_mutex_lock(&ctx->flying_transfers_lock);
2548 if (list_empty(&ctx->flying_transfers)) {
2549 usbi_mutex_unlock(&ctx->flying_transfers_lock);
2550 usbi_dbg("no URBs, no timeout!");
2554 /* find next transfer which hasn't already been processed as timed out */
2555 for_each_transfer(ctx, itransfer) {
2556 if (itransfer->timeout_flags & (USBI_TRANSFER_TIMEOUT_HANDLED | USBI_TRANSFER_OS_HANDLES_TIMEOUT))
2559 /* if we've reached transfers of infinte timeout, we're done looking */
2560 if (!TIMESPEC_IS_SET(&itransfer->timeout))
2563 next_timeout = itransfer->timeout;
2566 usbi_mutex_unlock(&ctx->flying_transfers_lock);
2568 if (!TIMESPEC_IS_SET(&next_timeout)) {
2569 usbi_dbg("no URB with timeout or all handled by OS; no timeout!");
2573 r = usbi_clock_gettime(USBI_CLOCK_MONOTONIC, &systime);
2575 usbi_err(ctx, "failed to read monotonic clock, errno=%d", errno);
2579 if (!TIMESPEC_CMP(&systime, &next_timeout, <)) {
2580 usbi_dbg("first timeout already expired");
2583 TIMESPEC_SUB(&next_timeout, &systime, &next_timeout);
2584 TIMESPEC_TO_TIMEVAL(tv, &next_timeout);
2585 usbi_dbg("next timeout in %ld.%06lds", (long)tv->tv_sec, (long)tv->tv_usec);
2591 /** \ingroup libusb_poll
2592 * Register notification functions for file descriptor additions/removals.
2593 * These functions will be invoked for every new or removed file descriptor
2594 * that libusb uses as an event source.
2596 * To remove notifiers, pass NULL values for the function pointers.
2598 * Note that file descriptors may have been added even before you register
2599 * these notifiers (e.g. at libusb_init() time).
2601 * Additionally, note that the removal notifier may be called during
2602 * libusb_exit() (e.g. when it is closing file descriptors that were opened
2603 * and added to the poll set at libusb_init() time). If you don't want this,
2604 * remove the notifiers immediately before calling libusb_exit().
2606 * \param ctx the context to operate on, or NULL for the default context
2607 * \param added_cb pointer to function for addition notifications
2608 * \param removed_cb pointer to function for removal notifications
2609 * \param user_data User data to be passed back to callbacks (useful for
2610 * passing context information)
2612 void API_EXPORTED libusb_set_pollfd_notifiers(libusb_context *ctx,
2613 libusb_pollfd_added_cb added_cb, libusb_pollfd_removed_cb removed_cb,
2616 #if !defined(_WIN32) && !defined(__CYGWIN__)
2617 ctx = usbi_get_context(ctx);
2618 ctx->fd_added_cb = added_cb;
2619 ctx->fd_removed_cb = removed_cb;
2620 ctx->fd_cb_user_data = user_data;
2622 usbi_err(ctx, "external polling of libusb's internal event sources " \
2623 "is not yet supported on Windows");
2631 * Interrupt the iteration of the event handling thread, so that it picks
2632 * up the event source change. Callers of this function must hold the event_data_lock.
2634 static void usbi_event_source_notification(struct libusb_context *ctx)
2636 unsigned int event_flags;
2638 /* Record that there is a new poll fd.
2639 * Only signal an event if there are no prior pending events. */
2640 event_flags = ctx->event_flags;
2641 ctx->event_flags |= USBI_EVENT_EVENT_SOURCES_MODIFIED;
2643 usbi_signal_event(&ctx->event);
2646 /* Add an event source to the list of event sources to be monitored.
2647 * poll_events should be specified as a bitmask of events passed to poll(), e.g.
2648 * POLLIN and/or POLLOUT. */
2649 int usbi_add_event_source(struct libusb_context *ctx, usbi_os_handle_t os_handle, short poll_events)
2651 struct usbi_event_source *ievent_source = malloc(sizeof(*ievent_source));
2654 return LIBUSB_ERROR_NO_MEM;
2656 usbi_dbg("add " USBI_OS_HANDLE_FORMAT_STRING " events %d", os_handle, poll_events);
2657 ievent_source->data.os_handle = os_handle;
2658 ievent_source->data.poll_events = poll_events;
2659 usbi_mutex_lock(&ctx->event_data_lock);
2660 list_add_tail(&ievent_source->list, &ctx->event_sources);
2661 usbi_event_source_notification(ctx);
2662 usbi_mutex_unlock(&ctx->event_data_lock);
2664 #if !defined(_WIN32) && !defined(__CYGWIN__)
2665 if (ctx->fd_added_cb)
2666 ctx->fd_added_cb(os_handle, poll_events, ctx->fd_cb_user_data);
2672 /* Remove an event source from the list of event sources to be monitored. */
2673 void usbi_remove_event_source(struct libusb_context *ctx, usbi_os_handle_t os_handle)
2675 struct usbi_event_source *ievent_source;
2678 usbi_dbg("remove " USBI_OS_HANDLE_FORMAT_STRING, os_handle);
2679 usbi_mutex_lock(&ctx->event_data_lock);
2680 for_each_event_source(ctx, ievent_source) {
2681 if (ievent_source->data.os_handle == os_handle) {
2688 usbi_dbg("couldn't find " USBI_OS_HANDLE_FORMAT_STRING " to remove", os_handle);
2689 usbi_mutex_unlock(&ctx->event_data_lock);
2693 list_del(&ievent_source->list);
2694 list_add_tail(&ievent_source->list, &ctx->removed_event_sources);
2695 usbi_event_source_notification(ctx);
2696 usbi_mutex_unlock(&ctx->event_data_lock);
2698 #if !defined(_WIN32) && !defined(__CYGWIN__)
2699 if (ctx->fd_removed_cb)
2700 ctx->fd_removed_cb(os_handle, ctx->fd_cb_user_data);
2704 /** \ingroup libusb_poll
2705 * Retrieve a list of file descriptors that should be polled by your main loop
2706 * as libusb event sources.
2708 * The returned list is NULL-terminated and should be freed with libusb_free_pollfds()
2709 * when done. The actual list contents must not be touched.
2711 * As file descriptors are a Unix-specific concept, this function is not
2712 * available on Windows and will always return NULL.
2714 * \param ctx the context to operate on, or NULL for the default context
2715 * \returns a NULL-terminated list of libusb_pollfd structures
2716 * \returns NULL on error
2717 * \returns NULL on platforms where the functionality is not available
2720 const struct libusb_pollfd ** LIBUSB_CALL libusb_get_pollfds(
2721 libusb_context *ctx)
2723 #if !defined(_WIN32) && !defined(__CYGWIN__)
2724 struct libusb_pollfd **ret = NULL;
2725 struct usbi_event_source *ievent_source;
2728 static_assert(sizeof(struct usbi_event_source_data) == sizeof(struct libusb_pollfd),
2729 "mismatch between usbi_event_source_data and libusb_pollfd sizes");
2731 ctx = usbi_get_context(ctx);
2733 usbi_mutex_lock(&ctx->event_data_lock);
2736 for_each_event_source(ctx, ievent_source)
2739 ret = calloc(i + 1, sizeof(struct libusb_pollfd *));
2744 for_each_event_source(ctx, ievent_source)
2745 ret[i++] = (struct libusb_pollfd *)ievent_source;
2748 usbi_mutex_unlock(&ctx->event_data_lock);
2749 return (const struct libusb_pollfd **)ret;
2751 usbi_err(ctx, "external polling of libusb's internal event sources " \
2752 "is not yet supported on Windows");
2757 /** \ingroup libusb_poll
2758 * Free a list of libusb_pollfd structures. This should be called for all
2759 * pollfd lists allocated with libusb_get_pollfds().
2761 * Since version 1.0.20, \ref LIBUSB_API_VERSION >= 0x01000104
2763 * It is legal to call this function with a NULL pollfd list. In this case,
2764 * the function will simply do nothing.
2766 * \param pollfds the list of libusb_pollfd structures to free
2768 void API_EXPORTED libusb_free_pollfds(const struct libusb_pollfd **pollfds)
2770 #if !defined(_WIN32) && !defined(__CYGWIN__)
2771 free((void *)pollfds);
2777 /* Backends may call this from handle_events to report disconnection of a
2778 * device. This function ensures transfers get cancelled appropriately.
2779 * Callers of this function must hold the events_lock.
2781 void usbi_handle_disconnect(struct libusb_device_handle *dev_handle)
2783 struct libusb_context *ctx = HANDLE_CTX(dev_handle);
2784 struct usbi_transfer *cur;
2785 struct usbi_transfer *to_cancel;
2787 usbi_dbg("device %d.%d",
2788 dev_handle->dev->bus_number, dev_handle->dev->device_address);
2790 /* terminate all pending transfers with the LIBUSB_TRANSFER_NO_DEVICE
2793 * when we find a transfer for this device on the list, there are two
2794 * possible scenarios:
2795 * 1. the transfer is currently in-flight, in which case we terminate the
2797 * 2. the transfer has been added to the flying transfer list by
2798 * libusb_submit_transfer, has failed to submit and
2799 * libusb_submit_transfer is waiting for us to release the
2800 * flying_transfers_lock to remove it, so we ignore it
2805 usbi_mutex_lock(&ctx->flying_transfers_lock);
2806 for_each_transfer(ctx, cur) {
2807 if (USBI_TRANSFER_TO_LIBUSB_TRANSFER(cur)->dev_handle == dev_handle) {
2808 usbi_mutex_lock(&cur->lock);
2809 if (cur->state_flags & USBI_TRANSFER_IN_FLIGHT)
2811 usbi_mutex_unlock(&cur->lock);
2817 usbi_mutex_unlock(&ctx->flying_transfers_lock);
2822 usbi_dbg("cancelling transfer %p from disconnect",
2823 USBI_TRANSFER_TO_LIBUSB_TRANSFER(to_cancel));
2825 usbi_mutex_lock(&to_cancel->lock);
2826 usbi_backend.clear_transfer_priv(to_cancel);
2827 usbi_mutex_unlock(&to_cancel->lock);
2828 usbi_handle_transfer_completion(to_cancel, LIBUSB_TRANSFER_NO_DEVICE);