/usr/x86_64-w64-mingw32/include/ddk/csq.h is in mingw-w64-x86-64-dev 2.0.3-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 | /*
* Cancel-Safe Queue Library
* Created in 2004 by Vizzini (vizzini@plasmic.com)
*
* THIS SOFTWARE IS NOT COPYRIGHTED
*
* This source code is offered for use in the public domain. You may
* use, modify or distribute it freely.
*
* This code is distributed in the hope that it will be useful but
* WITHOUT ANY WARRANTY. ALL WARRANTIES, EXPRESS OR IMPLIED ARE HEREBY
* DISCLAIMED. This includes but is not limited to warranties of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
*
*
* This header defines the interface to the ReactOS Cancel-Safe Queue library.
* This interface is based on and is similar to the Microsoft Cancel-Safe
* Queue interface.
*
* BACKGROUND
*
* IRP queuing is a royal pain in the butt, due to the fact that there are
* tons of built-in race conditions. IRP handling is difficult in general,
* but the cancel logic has been particularly complicated due to some subtle
* races, coupled with the fact that the system interfaces have changed over
* time.
*
* Walter Oney (2nd. Ed. of Programming the Windows Driver Model) states a
* common opinion among driver developers when he says that it is foolish
* to try to roll your own cancel logic. There are only a very few people
* who have gotten it right in the past. He suggests, instead, that you
* either use his own well-tested code, or use the code in the Microsoft
* Cancel-Safe Queue Library.
*
* We cannot do either, of course, due to copyright issues. I have therefore
* created this clone of the Microsoft library in order to concentrate all
* of the IRP-queuing bugs in one place. I'm quite sure there are problems
* here, so if you are a driver writer, I'd be glad to hear your feedback.
*
* Apart from that, please try to use these routines, rather than building
* your own. If you think you have found a bug, please bring it up with me
* or on-list, as this is complicated and non-obvious stuff. Don't just
* change this and hope for the best!
*
* USAGE
*
* This library follows exactly the same interface as the Microsoft Cancel-Safe
* Queue routines (IoCsqXxx()). As such, the authoritative reference is the
* current DDK. There is also a DDK sample called "cancel" that has an
* example of how to use this code. I have also provided a sample driver
* that makes use of this queue. Finally, please do read the header and the
* source if you're curious about the inner workings of these routines.
*/
#pragma once
#define _CSQ_H_
#ifdef __cplusplus
extern "C" {
#endif
/*
* Prevent including the CSQ definitions twice. They're present in NTDDK
* now too, except the *_EX versions.
*/
#ifndef IO_TYPE_CSQ_IRP_CONTEXT
typedef struct _IO_CSQ IO_CSQ, *PIO_CSQ;
/*
* STRUCTURES
*
* NOTE: Please do not use these directly. You will make incompatible code
* if you do. Always only use the documented IoCsqXxx() interfaces and you
* will amass much Good Karma.
*/
#define IO_TYPE_CSQ_IRP_CONTEXT 1
#define IO_TYPE_CSQ 2
/*
* IO_CSQ_IRP_CONTEXT - Context used to track an IRP in the CSQ
*/
typedef struct _IO_CSQ_IRP_CONTEXT {
ULONG Type;
PIRP Irp;
PIO_CSQ Csq;
} IO_CSQ_IRP_CONTEXT, *PIO_CSQ_IRP_CONTEXT;
/*
* CSQ Callbacks
*
* The cancel-safe queue is implemented as a set of IoCsqXxx() OS routines
* copuled with a set of driver callbacks to handle the basic operations of
* the queue. You need to supply one of each of these functions in your own
* driver. These routines are also documented in the DDK under CsqXxx().
* That is the authoritative documentation.
*/
/*
* Function to insert an IRP in the queue. No need to worry about locking;
* just tack it onto your list or something.
*
* Sample implementation:
*
VOID NTAPI CsqInsertIrp(PIO_CSQ Csq, PIRP Irp)
{
KdPrint(("Inserting IRP 0x%x into CSQ\n", Irp));
InsertTailList(&IrpQueue, &Irp->Tail.Overlay.ListEntry);
}
*
*/
typedef VOID
(NTAPI IO_CSQ_INSERT_IRP)(
IN struct _IO_CSQ *Csq,
IN PIRP Irp);
typedef IO_CSQ_INSERT_IRP *PIO_CSQ_INSERT_IRP;
/*
* Function to remove an IRP from the queue.
*
* Sample:
*
VOID NTAPI CsqRemoveIrp(PIO_CSQ Csq, PIRP Irp)
{
KdPrint(("Removing IRP 0x%x from CSQ\n", Irp));
RemoveEntryList(&Irp->Tail.Overlay.ListEntry);
}
*
*/
typedef VOID
(NTAPI IO_CSQ_REMOVE_IRP)(
IN struct _IO_CSQ *Csq,
IN PIRP Irp);
typedef IO_CSQ_REMOVE_IRP *PIO_CSQ_REMOVE_IRP;
/*
* Function to look for an IRP in the queue
*
* Sample:
*
PIRP NTAPI CsqPeekNextIrp(PIO_CSQ Csq, PIRP Irp, PVOID PeekContext)
{
KdPrint(("Peeking for next IRP\n"));
if(Irp)
return CONTAINING_RECORD(&Irp->Tail.Overlay.ListEntry.Flink, IRP, Tail.Overlay.ListEntry);
if(IsListEmpty(&IrpQueue))
return NULL;
return CONTAINING_RECORD(IrpQueue.Flink, IRP, Tail.Overlay.ListEntry);
}
*
*/
typedef PIRP
(NTAPI IO_CSQ_PEEK_NEXT_IRP)(
IN struct _IO_CSQ *Csq,
IN PIRP Irp,
IN PVOID PeekContext);
typedef IO_CSQ_PEEK_NEXT_IRP *PIO_CSQ_PEEK_NEXT_IRP;
/*
* Lock the queue. This can be a spinlock, a mutex, or whatever
* else floats your boat.
*
* Sample:
*
VOID NTAPI CsqAcquireLock(PIO_CSQ Csq, PKIRQL Irql)
{
KdPrint(("Acquiring spin lock\n"));
KeAcquireSpinLock(&IrpQueueLock, Irql);
}
*
*/
typedef VOID
(NTAPI IO_CSQ_ACQUIRE_LOCK)(
IN struct _IO_CSQ *Csq,
OUT PKIRQL Irql);
typedef IO_CSQ_ACQUIRE_LOCK *PIO_CSQ_ACQUIRE_LOCK;
/*
* Unlock the queue:
*
VOID NTAPI CsqReleaseLock(PIO_CSQ Csq, KIRQL Irql)
{
KdPrint(("Releasing spin lock\n"));
KeReleaseSpinLock(&IrpQueueLock, Irql);
}
*
*/
typedef VOID
(NTAPI IO_CSQ_RELEASE_LOCK)(
IN struct _IO_CSQ *Csq,
IN KIRQL Irql);
typedef IO_CSQ_RELEASE_LOCK *PIO_CSQ_RELEASE_LOCK;
/*
* Finally, this is called by the queue library when it wants to complete
* a canceled IRP.
*
* Sample:
*
VOID NTAPI CsqCompleteCancelledIrp(PIO_CSQ Csq, PIRP Irp)
{
KdPrint(("cancelling irp 0x%x\n", Irp));
Irp->IoStatus.Status = STATUS_CANCELLED;
Irp->IoStatus.Information = 0;
IoCompleteRequest(Irp, IO_NO_INCREMENT);
}
*
*/
typedef VOID
(NTAPI IO_CSQ_COMPLETE_CANCELED_IRP)(
IN struct _IO_CSQ *Csq,
IN PIRP Irp);
typedef IO_CSQ_COMPLETE_CANCELED_IRP *PIO_CSQ_COMPLETE_CANCELED_IRP;
/*
* IO_CSQ - Queue control structure
*/
typedef struct _IO_CSQ {
ULONG Type;
PIO_CSQ_INSERT_IRP CsqInsertIrp;
PIO_CSQ_REMOVE_IRP CsqRemoveIrp;
PIO_CSQ_PEEK_NEXT_IRP CsqPeekNextIrp;
PIO_CSQ_ACQUIRE_LOCK CsqAcquireLock;
PIO_CSQ_RELEASE_LOCK CsqReleaseLock;
PIO_CSQ_COMPLETE_CANCELED_IRP CsqCompleteCanceledIrp;
PVOID ReservePointer; /* must be NULL */
} IO_CSQ, *PIO_CSQ;
#endif /* IO_TYPE_CSQ_IRP_CONTEXT */
#ifndef IO_TYPE_CSQ_EX
/* See IO_TYPE_CSQ_* above */
#define IO_TYPE_CSQ_EX 3
/*
* Function to insert an IRP into the queue with extended context information.
* This is useful if you need to be able to de-queue particular IRPs more
* easily in some cases.
*
* Same deal as above; sample implementation:
*
NTSTATUS NTAPI CsqInsertIrpEx(PIO_CSQ Csq, PIRP Irp, PVOID InsertContext)
{
CsqInsertIrp(Csq, Irp);
return STATUS_PENDING;
}
*
*/
typedef NTSTATUS
(NTAPI IO_CSQ_INSERT_IRP_EX)(
IN struct _IO_CSQ *Csq,
IN PIRP Irp,
IN PVOID InsertContext);
typedef IO_CSQ_INSERT_IRP_EX *PIO_CSQ_INSERT_IRP_EX;
#endif /* IO_TYPE_CSQ_EX */
/*
* CANCEL-SAFE QUEUE DDIs
*
* These device driver interfaces are called to make use of the queue. Again,
* authoritative documentation for these functions is in the DDK. The csqtest
* driver also makes use of some of them.
*/
/*
* Call this in DriverEntry or similar in order to set up the Csq structure.
* As long as the Csq struct and the functions you pass in are resident,
* there are no IRQL restrictions.
*/
NTKERNELAPI
NTSTATUS NTAPI IoCsqInitialize(PIO_CSQ Csq,
PIO_CSQ_INSERT_IRP CsqInsertIrp,
PIO_CSQ_REMOVE_IRP CsqRemoveIrp,
PIO_CSQ_PEEK_NEXT_IRP CsqPeekNextIrp,
PIO_CSQ_ACQUIRE_LOCK CsqAcquireLock,
PIO_CSQ_RELEASE_LOCK CsqReleaseLock,
PIO_CSQ_COMPLETE_CANCELED_IRP CsqCompleteCanceledIrp);
/*
* Same as above, except you provide a CsqInsertIrpEx routine instead of
* CsqInsertIrp. This eventually allows you to supply extra tracking
* information for use with the queue.
*/
NTKERNELAPI
NTSTATUS NTAPI IoCsqInitializeEx(PIO_CSQ Csq,
PIO_CSQ_INSERT_IRP_EX CsqInsertIrpEx,
PIO_CSQ_REMOVE_IRP CsqRemoveIrp,
PIO_CSQ_PEEK_NEXT_IRP CsqPeekNextIrp,
PIO_CSQ_ACQUIRE_LOCK CsqAcquireLock,
PIO_CSQ_RELEASE_LOCK CsqReleaseLock,
PIO_CSQ_COMPLETE_CANCELED_IRP CsqCompleteCanceledIrp);
/*
* Insert an IRP into the queue
*/
NTKERNELAPI
VOID NTAPI IoCsqInsertIrp(PIO_CSQ Csq,
PIRP Irp,
PIO_CSQ_IRP_CONTEXT Context);
/*
* Insert an IRP into the queue, with special context maintained that
* makes it easy to find IRPs in the queue
*/
NTKERNELAPI
NTSTATUS NTAPI IoCsqInsertIrpEx(PIO_CSQ Csq,
PIRP Irp,
PIO_CSQ_IRP_CONTEXT Context,
PVOID InsertContext);
/*
* Remove a particular IRP from the queue
*/
NTKERNELAPI
PIRP NTAPI IoCsqRemoveIrp(PIO_CSQ Csq,
PIO_CSQ_IRP_CONTEXT Context);
/*
* Remove the next IRP from the queue
*/
NTKERNELAPI
PIRP NTAPI IoCsqRemoveNextIrp(PIO_CSQ Csq,
PVOID PeekContext);
#ifdef __cplusplus
}
#endif
|