req.h revision 9de47c4ec7b0fc9a384e4b815153de399da7b8de
/* $Id$ */
/** @file
* IPRT - Internal RTReq header.
*/
/*
* Copyright (C) 2006-2011 Oracle Corporation
*
* This file is part of VirtualBox Open Source Edition (OSE), as
* available from http://www.virtualbox.org. This file is free software;
* General Public License (GPL) as published by the Free Software
* Foundation, in version 2 as it comes in the "COPYING" file of the
* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
*
* The contents of this file may alternatively be used under the terms
* of the Common Development and Distribution License Version 1.0
* (CDDL) only, as it comes in the "COPYING.CDDL" file of the
* VirtualBox OSE distribution, in which case the provisions of the
* CDDL are applicable instead of those of the GPL.
*
* You may elect to license modified versions of this file under the
* terms and conditions of either the GPL or the CDDL or both.
*/
#ifndef ___internal_req_h
#define ___internal_req_h
/**
* Request state.
*/
typedef enum RTREQSTATE
{
/** The state is invalid. */
RTREQSTATE_INVALID = 0,
/** The request have been allocated and is in the process of being filed. */
/** The request is queued by the requester. */
/** The request is begin processed. */
/** The request is completed, the requester is begin notified. */
/** The request packet is in the free chain. (The requester */
} RTREQSTATE;
/**
* RT Request packet.
*
* This is used to request an action in the queue handler thread.
*/
struct RTREQ
{
/** Magic number (RTREQ_MAGIC). */
/** Set if the event semaphore is clear. */
volatile bool fEventSemClear;
/** Set if the push back semaphore should be signaled when the request
* is picked up from the queue. */
volatile bool fSignalPushBack;
/** Set if pool, clear if queue. */
volatile bool fPoolOrQueue;
/** IPRT status code for the completed request. */
/** Request state. */
volatile RTREQSTATE enmState;
/** The reference count. */
/** Pointer to the next request in the chain. */
union
{
/** Pointer to the pool this packet belongs to. */
/** Pointer to the queue this packet belongs to. */
/** Opaque owner access. */
void *pv;
} uOwner;
/** Timestamp take when the request was submitted to a pool. Not used
* for queued request. */
/** Requester completion event sem. */
/** Request pushback event sem. Allocated lazily. */
/** Flags, RTREQ_FLAGS_*. */
/** Request type. */
/** Request specific data. */
union RTREQ_U
{
/** RTREQTYPE_INTERNAL. */
struct
{
/** Pointer to the function to be called. */
/** Number of arguments. */
/** Array of arguments. */
} Internal;
} u;
};
/** Internal request representation. */
/** Pointer to an internal request representation. */
/**
* Internal queue instance.
*/
typedef struct RTREQQUEUEINT
{
/** Magic value (RTREQQUEUE_MAGIC). */
/** Set if busy (pending or processing requests). */
bool volatile fBusy;
/** Head of the request queue. Atomic. */
/** Number of free request packets. */
/** Array of pointers to lists of free request packets. Atomic. */
/** Requester event sem.
*/
/** Pointer to an internal queue instance. */
typedef struct RTREQQUEUEINT *PRTREQQUEUEINT;
/** Pointer to a request thread pool instance. */
typedef struct RTREQPOOLINT *PRTREQPOOLINT;
/* req.cpp */
/* reqpool.cpp / reqqueue.cpp. */
#endif