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
|
/*++
Copyright (c) Microsoft Corporation. All rights reserved.
THIS CODE AND INFORMATION IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY
KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND/OR FITNESS FOR A PARTICULAR
PURPOSE.
Module Name:
cancel.h
Abstract:
Environment:
Kernel mode only.
Revision History:
--*/
#include <initguid.h>
//
// Since this driver is a legacy driver and gets installed as a service
// (without an INF file), we will define a class guid for use in
// IoCreateDeviceSecure function. This would allow the system to store
// Security, DeviceType, Characteristics and Exclusivity information of the
// deviceobject in the registery under
// HKLM\SYSTEM\CurrentControlSet\Control\Class\ClassGUID\Properties.
// This information can be overrided by an Administrators giving them the ability
// to control access to the device beyond what is initially allowed
// by the driver developer.
//
// {5D006E1A-2631-466c-B8A0-32FD498E4424} - generated using guidgen.exe
DEFINE_GUID (GUID_DEVCLASS_CANCEL_SAMPLE,
0x5d006e1a, 0x2631, 0x466c, 0xb8, 0xa0, 0x32, 0xfd, 0x49, 0x8e, 0x44, 0x24);
//
// GUID definition are required to be outside of header inclusion pragma to avoid
// error during precompiled headers.
//
#ifndef __CANCEL_H
#define __CANCEL_H
//
// GUID definition are required to be outside of header inclusion pragma to
// avoid error during precompiled headers.
//
#include <ntddk.h>
#include <wdmsec.h> // for IoCreateDeviceSecure
#include <dontuse.h>
// Debugging macros
#if DBG
#define CSAMP_KDPRINT(_x_) \
DbgPrint("CANCEL.SYS: ");\
DbgPrint _x_;
#else
#define CSAMP_KDPRINT(_x_)
#endif
#define CSAMP_DEVICE_NAME_U L"\\Device\\CANCELSAMP"
#define CSAMP_DOS_DEVICE_NAME_U L"\\DosDevices\\CancelSamp"
#define CSAMP_RETRY_INTERVAL 500*1000 //500 ms
#define TAG (ULONG)'MASC'
typedef struct _INPUT_DATA{
ULONG Data; //device data is stored here
} INPUT_DATA, *PINPUT_DATA;
typedef struct _DEVICE_EXTENSION{
BOOLEAN ThreadShouldStop;
// Irps waiting to be processed are queued here
LIST_ENTRY PendingIrpQueue;
// SpinLock to protect access to the queue
KSPIN_LOCK QueueLock;
IO_CSQ CancelSafeQueue;
// Time at which the device was last polled
LARGE_INTEGER LastPollTime;
// Polling interval (retry interval)
LARGE_INTEGER PollingInterval;
KSEMAPHORE IrpQueueSemaphore;
PETHREAD ThreadObject;
} DEVICE_EXTENSION, *PDEVICE_EXTENSION;
typedef struct _FILE_CONTEXT{
//
// Lock to rundown threads that are dispatching I/Os on a file handle
// while the cleanup for that handle is in progress.
//
IO_REMOVE_LOCK FileRundownLock;
} FILE_CONTEXT, *PFILE_CONTEXT;
DRIVER_INITIALIZE DriverEntry;
_Dispatch_type_(IRP_MJ_CREATE)
_Dispatch_type_(IRP_MJ_CLOSE)
DRIVER_DISPATCH CsampCreateClose;
_Dispatch_type_(IRP_MJ_CLEANUP)
DRIVER_DISPATCH CsampCleanup;
_Dispatch_type_(IRP_MJ_READ)
DRIVER_DISPATCH CsampRead;
DRIVER_DISPATCH CsampPollDevice;
DRIVER_UNLOAD CsampUnload;
KSTART_ROUTINE CsampPollingThread;
VOID
CsampPollingThread(
_In_ PVOID Context
);
VOID
CsampInsertIrp (
_In_ PIO_CSQ Csq,
_In_ PIRP Irp
);
VOID
CsampRemoveIrp(
_In_ PIO_CSQ Csq,
_In_ PIRP Irp
);
PIRP
CsampPeekNextIrp(
_In_ PIO_CSQ Csq,
_In_ PIRP Irp,
_In_ PVOID PeekContext
);
_IRQL_raises_(DISPATCH_LEVEL)
_IRQL_requires_max_(DISPATCH_LEVEL)
_Acquires_lock_(CONTAINING_RECORD(Csq,DEVICE_EXTENSION, CancelSafeQueue)->QueueLock)
VOID
CsampAcquireLock(
_In_ PIO_CSQ Csq,
_Out_ _At_(*Irql, _Post_ _IRQL_saves_) PKIRQL Irql
);
_IRQL_requires_(DISPATCH_LEVEL)
_Releases_lock_(CONTAINING_RECORD(Csq,DEVICE_EXTENSION, CancelSafeQueue)->QueueLock)
VOID
CsampReleaseLock(
_In_ PIO_CSQ Csq,
_In_ _IRQL_restores_ KIRQL Irql
);
VOID
CsampCompleteCanceledIrp(
_In_ PIO_CSQ pCsq,
_In_ PIRP Irp
);
#endif
|
