| 1 | /* $Id: req.h 39510 2011-12-02 10:58:29Z vboxsync $ */
|
|---|
| 2 | /** @file
|
|---|
| 3 | * IPRT - Internal RTReq header.
|
|---|
| 4 | */
|
|---|
| 5 |
|
|---|
| 6 | /*
|
|---|
| 7 | * Copyright (C) 2006-2011 Oracle Corporation
|
|---|
| 8 | *
|
|---|
| 9 | * This file is part of VirtualBox Open Source Edition (OSE), as
|
|---|
| 10 | * available from http://www.virtualbox.org. This file is free software;
|
|---|
| 11 | * you can redistribute it and/or modify it under the terms of the GNU
|
|---|
| 12 | * General Public License (GPL) as published by the Free Software
|
|---|
| 13 | * Foundation, in version 2 as it comes in the "COPYING" file of the
|
|---|
| 14 | * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
|
|---|
| 15 | * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
|
|---|
| 16 | *
|
|---|
| 17 | * The contents of this file may alternatively be used under the terms
|
|---|
| 18 | * of the Common Development and Distribution License Version 1.0
|
|---|
| 19 | * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
|
|---|
| 20 | * VirtualBox OSE distribution, in which case the provisions of the
|
|---|
| 21 | * CDDL are applicable instead of those of the GPL.
|
|---|
| 22 | *
|
|---|
| 23 | * You may elect to license modified versions of this file under the
|
|---|
| 24 | * terms and conditions of either the GPL or the CDDL or both.
|
|---|
| 25 | */
|
|---|
| 26 |
|
|---|
| 27 | #ifndef ___internal_req_h
|
|---|
| 28 | #define ___internal_req_h
|
|---|
| 29 |
|
|---|
| 30 | #include <iprt/types.h>
|
|---|
| 31 |
|
|---|
| 32 |
|
|---|
| 33 | RT_C_DECLS_BEGIN
|
|---|
| 34 |
|
|---|
| 35 | /**
|
|---|
| 36 | * Request state.
|
|---|
| 37 | */
|
|---|
| 38 | typedef enum RTREQSTATE
|
|---|
| 39 | {
|
|---|
| 40 | /** The state is invalid. */
|
|---|
| 41 | RTREQSTATE_INVALID = 0,
|
|---|
| 42 | /** The request have been allocated and is in the process of being filed. */
|
|---|
| 43 | RTREQSTATE_ALLOCATED,
|
|---|
| 44 | /** The request is queued by the requester. */
|
|---|
| 45 | RTREQSTATE_QUEUED,
|
|---|
| 46 | /** The request is begin processed. */
|
|---|
| 47 | RTREQSTATE_PROCESSING,
|
|---|
| 48 | /** The request is completed, the requester is begin notified. */
|
|---|
| 49 | RTREQSTATE_COMPLETED,
|
|---|
| 50 | /** The request packet is in the free chain. (The requester */
|
|---|
| 51 | RTREQSTATE_FREE
|
|---|
| 52 | } RTREQSTATE;
|
|---|
| 53 |
|
|---|
| 54 |
|
|---|
| 55 | /**
|
|---|
| 56 | * RT Request packet.
|
|---|
| 57 | *
|
|---|
| 58 | * This is used to request an action in the queue handler thread.
|
|---|
| 59 | */
|
|---|
| 60 | struct RTREQ
|
|---|
| 61 | {
|
|---|
| 62 | /** Magic number (RTREQ_MAGIC). */
|
|---|
| 63 | uint32_t u32Magic;
|
|---|
| 64 | /** Set if the event semaphore is clear. */
|
|---|
| 65 | volatile bool fEventSemClear;
|
|---|
| 66 | /** Set if pool, clear if queue. */
|
|---|
| 67 | volatile bool fPoolOrQueue;
|
|---|
| 68 | /** IPRT status code for the completed request. */
|
|---|
| 69 | volatile int32_t iStatusX;
|
|---|
| 70 | /** Request state. */
|
|---|
| 71 | volatile RTREQSTATE enmState;
|
|---|
| 72 |
|
|---|
| 73 | /** Pointer to the next request in the chain. */
|
|---|
| 74 | struct RTREQ * volatile pNext;
|
|---|
| 75 |
|
|---|
| 76 | union
|
|---|
| 77 | {
|
|---|
| 78 | /** Pointer to the pool this packet belongs to. */
|
|---|
| 79 | RTREQPOOL hPool;
|
|---|
| 80 | /** Pointer to the queue this packet belongs to. */
|
|---|
| 81 | RTREQQUEUE hQueue;
|
|---|
| 82 | } uOwner;
|
|---|
| 83 |
|
|---|
| 84 | /** Requester event sem.
|
|---|
| 85 | * The request can use this event semaphore to wait/poll for completion
|
|---|
| 86 | * of the request.
|
|---|
| 87 | */
|
|---|
| 88 | RTSEMEVENT EventSem;
|
|---|
| 89 | /** Flags, RTREQ_FLAGS_*. */
|
|---|
| 90 | uint32_t fFlags;
|
|---|
| 91 | /** Request type. */
|
|---|
| 92 | RTREQTYPE enmType;
|
|---|
| 93 | /** Request specific data. */
|
|---|
| 94 | union RTREQ_U
|
|---|
| 95 | {
|
|---|
| 96 | /** RTREQTYPE_INTERNAL. */
|
|---|
| 97 | struct
|
|---|
| 98 | {
|
|---|
| 99 | /** Pointer to the function to be called. */
|
|---|
| 100 | PFNRT pfn;
|
|---|
| 101 | /** Number of arguments. */
|
|---|
| 102 | uint32_t cArgs;
|
|---|
| 103 | /** Array of arguments. */
|
|---|
| 104 | uintptr_t aArgs[64];
|
|---|
| 105 | } Internal;
|
|---|
| 106 | } u;
|
|---|
| 107 | };
|
|---|
| 108 |
|
|---|
| 109 | /** Internal request representation. */
|
|---|
| 110 | typedef RTREQ RTREQINT;
|
|---|
| 111 | /** Pointer to an internal request representation. */
|
|---|
| 112 | typedef RTREQINT *PRTREQINT;
|
|---|
| 113 |
|
|---|
| 114 | /**
|
|---|
| 115 | * Internal queue instance.
|
|---|
| 116 | */
|
|---|
| 117 | typedef struct RTREQQUEUEINT
|
|---|
| 118 | {
|
|---|
| 119 | /** Magic value (RTREQQUEUE_MAGIC). */
|
|---|
| 120 | uint32_t u32Magic;
|
|---|
| 121 | /** Set if busy (pending or processing requests). */
|
|---|
| 122 | bool volatile fBusy;
|
|---|
| 123 | /** Head of the request queue. Atomic. */
|
|---|
| 124 | volatile PRTREQ pReqs;
|
|---|
| 125 | /** The last index used during alloc/free. */
|
|---|
| 126 | volatile uint32_t iReqFree;
|
|---|
| 127 | /** Number of free request packets. */
|
|---|
| 128 | volatile uint32_t cReqFree;
|
|---|
| 129 | /** Array of pointers to lists of free request packets. Atomic. */
|
|---|
| 130 | volatile PRTREQ apReqFree[9];
|
|---|
| 131 | /** Requester event sem.
|
|---|
| 132 | * The request can use this event semaphore to wait/poll for new requests.
|
|---|
| 133 | */
|
|---|
| 134 | RTSEMEVENT EventSem;
|
|---|
| 135 | } RTREQQUEUEINT;
|
|---|
| 136 |
|
|---|
| 137 | /** Pointer to an internal queue instance. */
|
|---|
| 138 | typedef RTREQQUEUEINT *PRTREQQUEUEINT;
|
|---|
| 139 |
|
|---|
| 140 |
|
|---|
| 141 |
|
|---|
| 142 | DECLHIDDEN(int) rtReqProcessOne(PRTREQ pReq);
|
|---|
| 143 |
|
|---|
| 144 | RT_C_DECLS_END
|
|---|
| 145 |
|
|---|
| 146 | #endif
|
|---|
| 147 |
|
|---|
