req.h revision 36411046d85fccaa66061120a064225fd1b5ae01
36411046d85fccaa66061120a064225fd1b5ae01vboxsync * IPRT - Request Queue & Pool.
36411046d85fccaa66061120a064225fd1b5ae01vboxsync * Copyright (C) 2006-2011 Oracle Corporation
c98fb3e16fcd571a790eab772c0c66173d225205vboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
c98fb3e16fcd571a790eab772c0c66173d225205vboxsync * available from http://www.virtualbox.org. This file is free software;
c98fb3e16fcd571a790eab772c0c66173d225205vboxsync * you can redistribute it and/or modify it under the terms of the GNU
a16eb14ad7a4b5ef91ddc22d3e8e92d930f736fcvboxsync * General Public License (GPL) as published by the Free Software
a16eb14ad7a4b5ef91ddc22d3e8e92d930f736fcvboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
a16eb14ad7a4b5ef91ddc22d3e8e92d930f736fcvboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
a16eb14ad7a4b5ef91ddc22d3e8e92d930f736fcvboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
a16eb14ad7a4b5ef91ddc22d3e8e92d930f736fcvboxsync * The contents of this file may alternatively be used under the terms
a16eb14ad7a4b5ef91ddc22d3e8e92d930f736fcvboxsync * of the Common Development and Distribution License Version 1.0
a16eb14ad7a4b5ef91ddc22d3e8e92d930f736fcvboxsync * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
a16eb14ad7a4b5ef91ddc22d3e8e92d930f736fcvboxsync * VirtualBox OSE distribution, in which case the provisions of the
a16eb14ad7a4b5ef91ddc22d3e8e92d930f736fcvboxsync * CDDL are applicable instead of those of the GPL.
a16eb14ad7a4b5ef91ddc22d3e8e92d930f736fcvboxsync * You may elect to license modified versions of this file under the
a16eb14ad7a4b5ef91ddc22d3e8e92d930f736fcvboxsync * terms and conditions of either the GPL or the CDDL or both.
36411046d85fccaa66061120a064225fd1b5ae01vboxsync/** @defgroup grp_rt_req RTReq - Request Queue & Pool.
00314ca59bb0358d05053ee753174724d82adff4vboxsync * @ingroup grp_rt
36411046d85fccaa66061120a064225fd1b5ae01vboxsync/** Request queue handle. */
36411046d85fccaa66061120a064225fd1b5ae01vboxsync/** Pointer to a request queue handle. */
36411046d85fccaa66061120a064225fd1b5ae01vboxsync/** NIL request queue handle. */
36411046d85fccaa66061120a064225fd1b5ae01vboxsync/** Request thread pool handle. */
36411046d85fccaa66061120a064225fd1b5ae01vboxsync/** Poiner to a request thread pool handle. */
36411046d85fccaa66061120a064225fd1b5ae01vboxsync/** NIL request pool handle. */
00314ca59bb0358d05053ee753174724d82adff4vboxsync * Request type.
00314ca59bb0358d05053ee753174724d82adff4vboxsync /** Invalid request. */
00314ca59bb0358d05053ee753174724d82adff4vboxsync /** RT: Internal. */
00314ca59bb0358d05053ee753174724d82adff4vboxsync /** Maximum request type (exclusive). Used for validation. */
00314ca59bb0358d05053ee753174724d82adff4vboxsync * Request state.
00314ca59bb0358d05053ee753174724d82adff4vboxsync /** The state is invalid. */
00314ca59bb0358d05053ee753174724d82adff4vboxsync /** The request have been allocated and is in the process of being filed. */
00314ca59bb0358d05053ee753174724d82adff4vboxsync /** The request is queued by the requester. */
00314ca59bb0358d05053ee753174724d82adff4vboxsync /** The request is begin processed. */
00314ca59bb0358d05053ee753174724d82adff4vboxsync /** The request is completed, the requester is begin notified. */
00314ca59bb0358d05053ee753174724d82adff4vboxsync /** The request packet is in the free chain. (The requester */
00314ca59bb0358d05053ee753174724d82adff4vboxsync * Request flags.
00314ca59bb0358d05053ee753174724d82adff4vboxsync /** The request returns a iprt status code. */
00314ca59bb0358d05053ee753174724d82adff4vboxsync /** The request is a void request and have no status code. */
00314ca59bb0358d05053ee753174724d82adff4vboxsync /** Return type mask. */
00314ca59bb0358d05053ee753174724d82adff4vboxsync /** Caller does not wait on the packet, Queue process thread will free it. */
00314ca59bb0358d05053ee753174724d82adff4vboxsync * RT Request packet.
00314ca59bb0358d05053ee753174724d82adff4vboxsync * This is used to request an action in the queue handler thread.
00314ca59bb0358d05053ee753174724d82adff4vboxsynctypedef struct RTREQ
00314ca59bb0358d05053ee753174724d82adff4vboxsync /** Pointer to the next request in the chain. */
00314ca59bb0358d05053ee753174724d82adff4vboxsync /** Pointer to the queue this packet belongs to. */
00314ca59bb0358d05053ee753174724d82adff4vboxsync /** Request state. */
00314ca59bb0358d05053ee753174724d82adff4vboxsync /** iprt status code for the completed request. */
00314ca59bb0358d05053ee753174724d82adff4vboxsync volatile int iStatus;
00314ca59bb0358d05053ee753174724d82adff4vboxsync /** Requester event sem.
00314ca59bb0358d05053ee753174724d82adff4vboxsync * The request can use this event semaphore to wait/poll for completion
00314ca59bb0358d05053ee753174724d82adff4vboxsync * of the request.
00314ca59bb0358d05053ee753174724d82adff4vboxsync /** Set if the event semaphore is clear. */
00314ca59bb0358d05053ee753174724d82adff4vboxsync volatile bool fEventSemClear;
00314ca59bb0358d05053ee753174724d82adff4vboxsync /** Flags, RTREQ_FLAGS_*. */
00314ca59bb0358d05053ee753174724d82adff4vboxsync /** Request type. */
00314ca59bb0358d05053ee753174724d82adff4vboxsync /** Request specific data. */
00314ca59bb0358d05053ee753174724d82adff4vboxsync /** RTREQTYPE_INTERNAL. */
00314ca59bb0358d05053ee753174724d82adff4vboxsync /** Pointer to the function to be called. */
00314ca59bb0358d05053ee753174724d82adff4vboxsync /** Number of arguments. */
00314ca59bb0358d05053ee753174724d82adff4vboxsync /** Array of arguments. */
00314ca59bb0358d05053ee753174724d82adff4vboxsync/** Pointer to an RT request packet. */
ad27e1d5e48ca41245120c331cc88b50464813cevboxsync * Create a request packet queue
00314ca59bb0358d05053ee753174724d82adff4vboxsync * @returns iprt status code.
36411046d85fccaa66061120a064225fd1b5ae01vboxsync * @param phQueue Where to store the request queue handle.
ad27e1d5e48ca41245120c331cc88b50464813cevboxsync * Destroy a request packet queue
00314ca59bb0358d05053ee753174724d82adff4vboxsync * @returns iprt status code.
36411046d85fccaa66061120a064225fd1b5ae01vboxsync * @param hQueue The request queue.
00314ca59bb0358d05053ee753174724d82adff4vboxsync * Process one or more request packets
00314ca59bb0358d05053ee753174724d82adff4vboxsync * @returns iprt status code.
00314ca59bb0358d05053ee753174724d82adff4vboxsync * @returns VERR_TIMEOUT if cMillies was reached without the packet being added.
36411046d85fccaa66061120a064225fd1b5ae01vboxsync * @param hQueue The request queue.
00314ca59bb0358d05053ee753174724d82adff4vboxsync * @param cMillies Number of milliseconds to wait for a pending request.
00314ca59bb0358d05053ee753174724d82adff4vboxsync * Use RT_INDEFINITE_WAIT to only wait till one is added.
36411046d85fccaa66061120a064225fd1b5ae01vboxsyncRTDECL(int) RTReqQueueProcess(RTREQQUEUE hQueue, RTMSINTERVAL cMillies);
00314ca59bb0358d05053ee753174724d82adff4vboxsync * Allocate and queue a call request.
00314ca59bb0358d05053ee753174724d82adff4vboxsync * If it's desired to poll on the completion of the request set cMillies
ad27e1d5e48ca41245120c331cc88b50464813cevboxsync * to 0 and use RTReqWait() to check for completion. In the other case
00314ca59bb0358d05053ee753174724d82adff4vboxsync * use RT_INDEFINITE_WAIT.
00314ca59bb0358d05053ee753174724d82adff4vboxsync * The returned request packet must be freed using RTReqFree().
00314ca59bb0358d05053ee753174724d82adff4vboxsync * @returns iprt statuscode.
00314ca59bb0358d05053ee753174724d82adff4vboxsync * Will not return VERR_INTERRUPTED.
00314ca59bb0358d05053ee753174724d82adff4vboxsync * @returns VERR_TIMEOUT if cMillies was reached without the packet being completed.
36411046d85fccaa66061120a064225fd1b5ae01vboxsync * @param hQueue The request queue.
00314ca59bb0358d05053ee753174724d82adff4vboxsync * @param ppReq Where to store the pointer to the request.
ad27e1d5e48ca41245120c331cc88b50464813cevboxsync * This will be NULL or a valid request pointer not matter what happens.
00314ca59bb0358d05053ee753174724d82adff4vboxsync * @param cMillies Number of milliseconds to wait for the request to
00314ca59bb0358d05053ee753174724d82adff4vboxsync * be completed. Use RT_INDEFINITE_WAIT to only
00314ca59bb0358d05053ee753174724d82adff4vboxsync * wait till it's completed.
00314ca59bb0358d05053ee753174724d82adff4vboxsync * @param pfnFunction Pointer to the function to call.
00314ca59bb0358d05053ee753174724d82adff4vboxsync * @param cArgs Number of arguments following in the ellipsis.
00314ca59bb0358d05053ee753174724d82adff4vboxsync * @param ... Function arguments.
36411046d85fccaa66061120a064225fd1b5ae01vboxsync * @remarks See remarks on RTReqQueueCallV.
36411046d85fccaa66061120a064225fd1b5ae01vboxsyncRTDECL(int) RTReqQueueCall(RTREQQUEUE hQueue, PRTREQ *ppReq, RTMSINTERVAL cMillies, PFNRT pfnFunction, unsigned cArgs, ...);
00314ca59bb0358d05053ee753174724d82adff4vboxsync * Allocate and queue a call request to a void function.
00314ca59bb0358d05053ee753174724d82adff4vboxsync * If it's desired to poll on the completion of the request set cMillies
ad27e1d5e48ca41245120c331cc88b50464813cevboxsync * to 0 and use RTReqWait() to check for completion. In the other case
00314ca59bb0358d05053ee753174724d82adff4vboxsync * use RT_INDEFINITE_WAIT.
00314ca59bb0358d05053ee753174724d82adff4vboxsync * The returned request packet must be freed using RTReqFree().
00314ca59bb0358d05053ee753174724d82adff4vboxsync * @returns iprt status code.
00314ca59bb0358d05053ee753174724d82adff4vboxsync * Will not return VERR_INTERRUPTED.
00314ca59bb0358d05053ee753174724d82adff4vboxsync * @returns VERR_TIMEOUT if cMillies was reached without the packet being completed.
36411046d85fccaa66061120a064225fd1b5ae01vboxsync * @param hQueue The request queue.
00314ca59bb0358d05053ee753174724d82adff4vboxsync * @param ppReq Where to store the pointer to the request.
ad27e1d5e48ca41245120c331cc88b50464813cevboxsync * This will be NULL or a valid request pointer not matter what happens.
00314ca59bb0358d05053ee753174724d82adff4vboxsync * @param cMillies Number of milliseconds to wait for the request to
00314ca59bb0358d05053ee753174724d82adff4vboxsync * be completed. Use RT_INDEFINITE_WAIT to only
00314ca59bb0358d05053ee753174724d82adff4vboxsync * wait till it's completed.
00314ca59bb0358d05053ee753174724d82adff4vboxsync * @param pfnFunction Pointer to the function to call.
00314ca59bb0358d05053ee753174724d82adff4vboxsync * @param cArgs Number of arguments following in the ellipsis.
00314ca59bb0358d05053ee753174724d82adff4vboxsync * @param ... Function arguments.
36411046d85fccaa66061120a064225fd1b5ae01vboxsync * @remarks See remarks on RTReqQueueCallV.
36411046d85fccaa66061120a064225fd1b5ae01vboxsyncRTDECL(int) RTReqQueueCallVoid(RTREQQUEUE hQueue, PRTREQ *ppReq, RTMSINTERVAL cMillies, PFNRT pfnFunction, unsigned cArgs, ...);
00314ca59bb0358d05053ee753174724d82adff4vboxsync * Allocate and queue a call request to a void function.
00314ca59bb0358d05053ee753174724d82adff4vboxsync * If it's desired to poll on the completion of the request set cMillies
ad27e1d5e48ca41245120c331cc88b50464813cevboxsync * to 0 and use RTReqWait() to check for completion. In the other case
00314ca59bb0358d05053ee753174724d82adff4vboxsync * use RT_INDEFINITE_WAIT.
00314ca59bb0358d05053ee753174724d82adff4vboxsync * The returned request packet must be freed using RTReqFree().
00314ca59bb0358d05053ee753174724d82adff4vboxsync * @returns iprt status code.
00314ca59bb0358d05053ee753174724d82adff4vboxsync * Will not return VERR_INTERRUPTED.
00314ca59bb0358d05053ee753174724d82adff4vboxsync * @returns VERR_TIMEOUT if cMillies was reached without the packet being completed.
36411046d85fccaa66061120a064225fd1b5ae01vboxsync * @param hQueue The request queue.
00314ca59bb0358d05053ee753174724d82adff4vboxsync * @param ppReq Where to store the pointer to the request.
ad27e1d5e48ca41245120c331cc88b50464813cevboxsync * This will be NULL or a valid request pointer not matter what happens, unless fFlags
00314ca59bb0358d05053ee753174724d82adff4vboxsync * contains RTREQFLAGS_NO_WAIT when it will be optional and always NULL.
00314ca59bb0358d05053ee753174724d82adff4vboxsync * @param cMillies Number of milliseconds to wait for the request to
00314ca59bb0358d05053ee753174724d82adff4vboxsync * be completed. Use RT_INDEFINITE_WAIT to only
00314ca59bb0358d05053ee753174724d82adff4vboxsync * wait till it's completed.
00314ca59bb0358d05053ee753174724d82adff4vboxsync * @param fFlags A combination of the RTREQFLAGS values.
00314ca59bb0358d05053ee753174724d82adff4vboxsync * @param pfnFunction Pointer to the function to call.
00314ca59bb0358d05053ee753174724d82adff4vboxsync * @param cArgs Number of arguments following in the ellipsis.
00314ca59bb0358d05053ee753174724d82adff4vboxsync * @param ... Function arguments.
36411046d85fccaa66061120a064225fd1b5ae01vboxsync * @remarks See remarks on RTReqQueueCallV.
36411046d85fccaa66061120a064225fd1b5ae01vboxsyncRTDECL(int) RTReqQueueCallEx(RTREQQUEUE hQueue, PRTREQ *ppReq, RTMSINTERVAL cMillies, unsigned fFlags, PFNRT pfnFunction, unsigned cArgs, ...);
00314ca59bb0358d05053ee753174724d82adff4vboxsync * Allocate and queue a call request.
00314ca59bb0358d05053ee753174724d82adff4vboxsync * If it's desired to poll on the completion of the request set cMillies
ad27e1d5e48ca41245120c331cc88b50464813cevboxsync * to 0 and use RTReqWait() to check for completion. In the other case
00314ca59bb0358d05053ee753174724d82adff4vboxsync * use RT_INDEFINITE_WAIT.
00314ca59bb0358d05053ee753174724d82adff4vboxsync * The returned request packet must be freed using RTReqFree().
00314ca59bb0358d05053ee753174724d82adff4vboxsync * @returns iprt status code.
00314ca59bb0358d05053ee753174724d82adff4vboxsync * Will not return VERR_INTERRUPTED.
00314ca59bb0358d05053ee753174724d82adff4vboxsync * @returns VERR_TIMEOUT if cMillies was reached without the packet being completed.
36411046d85fccaa66061120a064225fd1b5ae01vboxsync * @param hQueue The request queue.
00314ca59bb0358d05053ee753174724d82adff4vboxsync * @param ppReq Where to store the pointer to the request.
ad27e1d5e48ca41245120c331cc88b50464813cevboxsync * This will be NULL or a valid request pointer not matter what happens, unless fFlags
00314ca59bb0358d05053ee753174724d82adff4vboxsync * contains RTREQFLAGS_NO_WAIT when it will be optional and always NULL.
00314ca59bb0358d05053ee753174724d82adff4vboxsync * @param cMillies Number of milliseconds to wait for the request to
00314ca59bb0358d05053ee753174724d82adff4vboxsync * be completed. Use RT_INDEFINITE_WAIT to only
00314ca59bb0358d05053ee753174724d82adff4vboxsync * wait till it's completed.
00314ca59bb0358d05053ee753174724d82adff4vboxsync * @param fFlags A combination of the RTREQFLAGS values.
00314ca59bb0358d05053ee753174724d82adff4vboxsync * @param pfnFunction Pointer to the function to call.
00314ca59bb0358d05053ee753174724d82adff4vboxsync * @param cArgs Number of arguments following in the ellipsis.
cb13ee8e628d04a773894bf4f9e8047d74f2ee21vboxsync * @param Args Variable argument vector.
89ed8fe4cc94bfa1639d2101d5e076f2cae971ddvboxsync * @remarks Caveats:
89ed8fe4cc94bfa1639d2101d5e076f2cae971ddvboxsync * - Do not pass anything which is larger than an uintptr_t.
89ed8fe4cc94bfa1639d2101d5e076f2cae971ddvboxsync * - 64-bit integers are larger than uintptr_t on 32-bit hosts.
89ed8fe4cc94bfa1639d2101d5e076f2cae971ddvboxsync * Pass integers > 32-bit by reference (pointers).
89ed8fe4cc94bfa1639d2101d5e076f2cae971ddvboxsync * - Don't use NULL since it should be the integer 0 in C++ and may
89ed8fe4cc94bfa1639d2101d5e076f2cae971ddvboxsync * therefore end up with garbage in the bits 63:32 on 64-bit
89ed8fe4cc94bfa1639d2101d5e076f2cae971ddvboxsync * hosts because 'int' is 32-bit.
89ed8fe4cc94bfa1639d2101d5e076f2cae971ddvboxsync * Use (void *)NULL or (uintptr_t)0 instead of NULL.
36411046d85fccaa66061120a064225fd1b5ae01vboxsyncRTDECL(int) RTReqQueueCallV(RTREQQUEUE hQueue, PRTREQ *ppReq, RTMSINTERVAL cMillies, unsigned fFlags, PFNRT pfnFunction, unsigned cArgs, va_list Args);
36411046d85fccaa66061120a064225fd1b5ae01vboxsync * Checks if the queue is busy or not.
36411046d85fccaa66061120a064225fd1b5ae01vboxsync * The caller is responsible for dealing with any concurrent submitts.
36411046d85fccaa66061120a064225fd1b5ae01vboxsync * @returns true if busy, false if idle.
36411046d85fccaa66061120a064225fd1b5ae01vboxsync * @param hQueue The queue.
00314ca59bb0358d05053ee753174724d82adff4vboxsync * Allocates a request packet.
00314ca59bb0358d05053ee753174724d82adff4vboxsync * The caller allocates a request packet, fills in the request data
00314ca59bb0358d05053ee753174724d82adff4vboxsync * union and queues the request.
00314ca59bb0358d05053ee753174724d82adff4vboxsync * @returns iprt status code.
36411046d85fccaa66061120a064225fd1b5ae01vboxsync * @param hQueue The request queue.
00314ca59bb0358d05053ee753174724d82adff4vboxsync * @param ppReq Where to store the pointer to the allocated packet.
00314ca59bb0358d05053ee753174724d82adff4vboxsync * @param enmType Package type.
36411046d85fccaa66061120a064225fd1b5ae01vboxsyncRTDECL(int) RTReqQueueAlloc(RTREQQUEUE hQueue, PRTREQ *ppReq, RTREQTYPE enmType);
00314ca59bb0358d05053ee753174724d82adff4vboxsync * Free a request packet.
00314ca59bb0358d05053ee753174724d82adff4vboxsync * @returns iprt status code.
00314ca59bb0358d05053ee753174724d82adff4vboxsync * @param pReq Package to free.
00314ca59bb0358d05053ee753174724d82adff4vboxsync * @remark The request packet must be in allocated or completed state!
00314ca59bb0358d05053ee753174724d82adff4vboxsync * Queue a request.
36411046d85fccaa66061120a064225fd1b5ae01vboxsync * The quest must be allocated using RTReqQueueAlloc() or RTReqPoolAlloc() and
36411046d85fccaa66061120a064225fd1b5ae01vboxsync * contain all the required data.
ad27e1d5e48ca41245120c331cc88b50464813cevboxsync * If it's desired to poll on the completion of the request set cMillies
ad27e1d5e48ca41245120c331cc88b50464813cevboxsync * to 0 and use RTReqWait() to check for completion. In the other case
00314ca59bb0358d05053ee753174724d82adff4vboxsync * use RT_INDEFINITE_WAIT.
00314ca59bb0358d05053ee753174724d82adff4vboxsync * @returns iprt status code.
00314ca59bb0358d05053ee753174724d82adff4vboxsync * Will not return VERR_INTERRUPTED.
00314ca59bb0358d05053ee753174724d82adff4vboxsync * @returns VERR_TIMEOUT if cMillies was reached without the packet being completed.
00314ca59bb0358d05053ee753174724d82adff4vboxsync * @param pReq The request to queue.
00314ca59bb0358d05053ee753174724d82adff4vboxsync * @param cMillies Number of milliseconds to wait for the request to
00314ca59bb0358d05053ee753174724d82adff4vboxsync * be completed. Use RT_INDEFINITE_WAIT to only
00314ca59bb0358d05053ee753174724d82adff4vboxsync * wait till it's completed.
36411046d85fccaa66061120a064225fd1b5ae01vboxsyncRTDECL(int) RTReqSubmit(PRTREQ pReq, RTMSINTERVAL cMillies);
00314ca59bb0358d05053ee753174724d82adff4vboxsync * Wait for a request to be completed.
00314ca59bb0358d05053ee753174724d82adff4vboxsync * @returns iprt status code.
00314ca59bb0358d05053ee753174724d82adff4vboxsync * Will not return VERR_INTERRUPTED.
00314ca59bb0358d05053ee753174724d82adff4vboxsync * @returns VERR_TIMEOUT if cMillies was reached without the packet being completed.
00314ca59bb0358d05053ee753174724d82adff4vboxsync * @param pReq The request to wait for.
00314ca59bb0358d05053ee753174724d82adff4vboxsync * @param cMillies Number of milliseconds to wait.
00314ca59bb0358d05053ee753174724d82adff4vboxsync * Use RT_INDEFINITE_WAIT to only wait till it's completed.
b79e4344bf4eb8033fd06d560cd864192728bd0bvboxsyncRTDECL(int) RTReqWait(PRTREQ pReq, RTMSINTERVAL cMillies);
00314ca59bb0358d05053ee753174724d82adff4vboxsync#endif /* IN_RING3 */