1 #ifndef INCLUDE_REACTOS_CAPTURE_H
2 #define INCLUDE_REACTOS_CAPTURE_H
6 #if ! defined(_NTOSKRNL_) && ! defined(_WIN32K_)
7 #error Header intended for use by NTOSKRNL/WIN32K only!
10 static const UNICODE_STRING __emptyUnicodeString
= {0, 0, NULL
};
11 static const LARGE_INTEGER __emptyLargeInteger
= {{0, 0}};
12 static const ULARGE_INTEGER __emptyULargeInteger
= {{0, 0}};
13 static const IO_STATUS_BLOCK __emptyIoStatusBlock
= {{0}, 0};
16 static const LARGE_STRING __emptyLargeString
= {0, 0, 0, NULL
};
20 * NOTE: Alignment of the pointers is not verified!
22 #define ProbeForWriteGenericType(Ptr, Type) \
24 if ((ULONG_PTR)(Ptr) + sizeof(Type) - 1 < (ULONG_PTR)(Ptr) || \
25 (ULONG_PTR)(Ptr) + sizeof(Type) - 1 >= (ULONG_PTR)MmUserProbeAddress) { \
26 ExRaiseAccessViolation(); \
28 *(volatile Type *)(Ptr) = *(volatile Type *)(Ptr); \
31 #define ProbeForWriteBoolean(Ptr) ProbeForWriteGenericType(Ptr, BOOLEAN)
32 #define ProbeForWriteUchar(Ptr) ProbeForWriteGenericType(Ptr, UCHAR)
33 #define ProbeForWriteChar(Ptr) ProbeForWriteGenericType(Ptr, CHAR)
34 #define ProbeForWriteUshort(Ptr) ProbeForWriteGenericType(Ptr, USHORT)
35 #define ProbeForWriteShort(Ptr) ProbeForWriteGenericType(Ptr, SHORT)
36 #define ProbeForWriteUlong(Ptr) ProbeForWriteGenericType(Ptr, ULONG)
37 #define ProbeForWriteLong(Ptr) ProbeForWriteGenericType(Ptr, LONG)
38 #define ProbeForWriteUint(Ptr) ProbeForWriteGenericType(Ptr, UINT)
39 #define ProbeForWriteInt(Ptr) ProbeForWriteGenericType(Ptr, INT)
40 #define ProbeForWriteUlonglong(Ptr) ProbeForWriteGenericType(Ptr, ULONGLONG)
41 #define ProbeForWriteLonglong(Ptr) ProbeForWriteGenericType(Ptr, LONGLONG)
42 #define ProbeForWritePointer(Ptr) ProbeForWriteGenericType(Ptr, PVOID)
43 #define ProbeForWriteHandle(Ptr) ProbeForWriteGenericType(Ptr, HANDLE)
44 #define ProbeForWriteLangid(Ptr) ProbeForWriteGenericType(Ptr, LANGID)
45 #define ProbeForWriteSize_t(Ptr) ProbeForWriteGenericType(Ptr, SIZE_T)
46 #define ProbeForWriteLargeInteger(Ptr) ProbeForWriteGenericType(&((PLARGE_INTEGER)Ptr)->QuadPart, LONGLONG)
47 #define ProbeForWriteUlargeInteger(Ptr) ProbeForWriteGenericType(&((PULARGE_INTEGER)Ptr)->QuadPart, ULONGLONG)
48 #define ProbeForWriteUnicodeString(Ptr) ProbeForWriteGenericType((PUNICODE_STRING)Ptr, UNICODE_STRING)
50 #define ProbeForWriteLargeString(Ptr) ProbeForWriteGenericType((PLARGE_STRING)Ptr, LARGE_STRING)
52 #define ProbeForWriteIoStatusBlock(Ptr) ProbeForWriteGenericType((PIO_STATUS_BLOCK)Ptr, IO_STATUS_BLOCK)
54 #define ProbeForReadGenericType(Ptr, Type, Default) \
55 (((ULONG_PTR)(Ptr) + sizeof(Type) - 1 < (ULONG_PTR)(Ptr) || \
56 (ULONG_PTR)(Ptr) + sizeof(Type) - 1 >= (ULONG_PTR)MmUserProbeAddress) ? \
57 ExRaiseAccessViolation(), Default : \
58 *(const volatile Type *)(Ptr))
60 #define ProbeForReadBoolean(Ptr) ProbeForReadGenericType(Ptr, BOOLEAN, FALSE)
61 #define ProbeForReadUchar(Ptr) ProbeForReadGenericType(Ptr, UCHAR, 0)
62 #define ProbeForReadChar(Ptr) ProbeForReadGenericType(Ptr, CHAR, 0)
63 #define ProbeForReadUshort(Ptr) ProbeForReadGenericType(Ptr, USHORT, 0)
64 #define ProbeForReadShort(Ptr) ProbeForReadGenericType(Ptr, SHORT, 0)
65 #define ProbeForReadUlong(Ptr) ProbeForReadGenericType(Ptr, ULONG, 0)
66 #define ProbeForReadLong(Ptr) ProbeForReadGenericType(Ptr, LONG, 0)
67 #define ProbeForReadUint(Ptr) ProbeForReadGenericType(Ptr, UINT, 0)
68 #define ProbeForReadInt(Ptr) ProbeForReadGenericType(Ptr, INT, 0)
69 #define ProbeForReadUlonglong(Ptr) ProbeForReadGenericType(Ptr, ULONGLONG, 0)
70 #define ProbeForReadLonglong(Ptr) ProbeForReadGenericType(Ptr, LONGLONG, 0)
71 #define ProbeForReadPointer(Ptr) ProbeForReadGenericType(Ptr, PVOID, NULL)
72 #define ProbeForReadHandle(Ptr) ProbeForReadGenericType(Ptr, HANDLE, NULL)
73 #define ProbeForReadLangid(Ptr) ProbeForReadGenericType(Ptr, LANGID, 0)
74 #define ProbeForReadSize_t(Ptr) ProbeForReadGenericType(Ptr, SIZE_T, 0)
75 #define ProbeForReadLargeInteger(Ptr) ProbeForReadGenericType((const LARGE_INTEGER *)(Ptr), LARGE_INTEGER, __emptyLargeInteger)
76 #define ProbeForReadUlargeInteger(Ptr) ProbeForReadGenericType((const ULARGE_INTEGER *)(Ptr), ULARGE_INTEGER, __emptyULargeInteger)
77 #define ProbeForReadUnicodeString(Ptr) ProbeForReadGenericType((const UNICODE_STRING *)(Ptr), UNICODE_STRING, __emptyUnicodeString)
79 #define ProbeForReadLargeString(Ptr) ProbeForReadGenericType((const LARGE_STRING *)(Ptr), LARGE_STRING, __emptyLargeString)
81 #define ProbeForReadIoStatusBlock(Ptr) ProbeForReadGenericType((const IO_STATUS_BLOCK *)(Ptr), IO_STATUS_BLOCK, __emptyIoStatusBlock)
83 #define ProbeAndZeroHandle(Ptr) \
85 if ((ULONG_PTR)(Ptr) + sizeof(HANDLE) - 1 < (ULONG_PTR)(Ptr) || \
86 (ULONG_PTR)(Ptr) + sizeof(HANDLE) - 1 >= (ULONG_PTR)MmUserProbeAddress) { \
87 ExRaiseAccessViolation(); \
89 *(volatile HANDLE *)(Ptr) = NULL; \
93 * Inlined Probing Macros
99 ProbeArrayForRead(IN
const VOID
*ArrayPtr
,
106 /* Check for integer overflow */
107 ArraySize
= ItemSize
* ItemCount
;
108 if (ArraySize
/ ItemSize
!= ItemCount
)
110 ExRaiseStatus(STATUS_INVALID_PARAMETER
);
113 /* Probe the array */
114 _PRAGMA_WARNING_SUPPRESS(__WARNING_PROBE_NO_TRY
) /* Must be inside __try / __except block */
115 ProbeForRead(ArrayPtr
, ArraySize
, Alignment
);
120 ProbeArrayForWrite(IN OUT PVOID ArrayPtr
,
127 /* Check for integer overflow */
128 ArraySize
= ItemSize
* ItemCount
;
129 if (ArraySize
/ ItemSize
!= ItemCount
)
131 ExRaiseStatus(STATUS_INVALID_PARAMETER
);
134 /* Probe the array */
135 _PRAGMA_WARNING_SUPPRESS(__WARNING_PROBE_NO_TRY
) /* Must be inside __try / __except block */
136 ProbeForWrite(ArrayPtr
, ArraySize
, Alignment
);
138 #endif /* _WIN32K_ */
142 ProbeAndCaptureUnicodeString(OUT PUNICODE_STRING Dest
,
143 IN KPROCESSOR_MODE CurrentMode
,
144 IN
const UNICODE_STRING
*UnsafeSrc
)
146 NTSTATUS Status
= STATUS_SUCCESS
;
147 WCHAR
*Buffer
= NULL
;
148 ASSERT(Dest
!= NULL
);
150 /* Probe the structure and buffer*/
151 if(CurrentMode
!= KernelMode
)
155 *Dest
= ProbeForReadUnicodeString(UnsafeSrc
);
156 if(Dest
->Buffer
!= NULL
)
158 if (Dest
->Length
!= 0)
160 ProbeForRead(Dest
->Buffer
,
164 /* Allocate space for the buffer */
165 Buffer
= ExAllocatePoolWithTag(PagedPool
,
166 Dest
->Length
+ sizeof(WCHAR
),
170 Status
= STATUS_INSUFFICIENT_RESOURCES
;
175 RtlCopyMemory(Buffer
, Dest
->Buffer
, Dest
->Length
);
176 Buffer
[Dest
->Length
/ sizeof(WCHAR
)] = UNICODE_NULL
;
178 /* Set it as the buffer */
179 Dest
->Buffer
= Buffer
;
180 Dest
->MaximumLength
= Dest
->Length
+ sizeof(WCHAR
);
184 /* sanitize structure */
185 Dest
->MaximumLength
= 0;
191 /* sanitize structure */
193 Dest
->MaximumLength
= 0;
196 _SEH2_EXCEPT(EXCEPTION_EXECUTE_HANDLER
)
198 /* Free allocated resources and zero the destination string */
204 Dest
->MaximumLength
= 0;
207 /* Return the error code */
208 Status
= _SEH2_GetExceptionCode();
214 /* Just copy the UNICODE_STRING structure, don't allocate new memory!
215 We trust the caller to supply valid pointers and data. */
225 ReleaseCapturedUnicodeString(IN PUNICODE_STRING CapturedString
,
226 IN KPROCESSOR_MODE CurrentMode
)
228 if(CurrentMode
!= KernelMode
&& CapturedString
->Buffer
!= NULL
)
230 ExFreePool(CapturedString
->Buffer
);
234 #endif /* INCLUDE_REACTOS_CAPTURE_H */