ReactOS 0.4.16-dev-1946-g52006dd
Enumerations | Functions
fxvalidatefunctions.hpp File Reference
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Enumerations

enum  FX_VALIDATE_FUNCTIONS_FLAGS {
  FX_VALIDATE_OPTION_NONE_SPECIFIED = 0x00000000 , FX_VALIDATE_OPTION_PARENT_NOT_ALLOWED = 0x00000001 , FX_VALIDATE_OPTION_EXECUTION_LEVEL_ALLOWED = 0x00000002 , FX_VALIDATE_OPTION_SYNCHRONIZATION_SCOPE_ALLOWED = 0x00000004 ,
  FX_VALIDATE_OPTION_ATTRIBUTES_REQUIRED = 0x00000008 , FX_VALIDATE_OPTION_PARENT_REQUIRED_FLAG = 0x00000010 , FX_VALIDATE_OPTION_PARENT_REQUIRED
}
 

Functions

_Must_inspect_result_ NTSTATUS FxValidateObjectAttributes (__in PFX_DRIVER_GLOBALS FxDriverGlobals, __in PWDF_OBJECT_ATTRIBUTES Attributes, __in ULONG Flags=FX_VALIDATE_OPTION_NONE_SPECIFIED)
 
_Must_inspect_result_ NTSTATUS __inline FxValidateObjectAttributesForParentHandle (__in PFX_DRIVER_GLOBALS FxDriverGlobals, __in PWDF_OBJECT_ATTRIBUTES Attributes, __in ULONG Flags=FX_VALIDATE_OPTION_NONE_SPECIFIED)
 
_Must_inspect_result_ NTSTATUS __inline FxValidateUnicodeString (__in PFX_DRIVER_GLOBALS FxDriverGlobals, __in PCUNICODE_STRING String)
 

Enumeration Type Documentation

◆ FX_VALIDATE_FUNCTIONS_FLAGS

enum FX_VALIDATE_FUNCTIONS_FLAGS
Enumerator
FX_VALIDATE_OPTION_NONE_SPECIFIED 
FX_VALIDATE_OPTION_PARENT_NOT_ALLOWED 
FX_VALIDATE_OPTION_EXECUTION_LEVEL_ALLOWED 
FX_VALIDATE_OPTION_SYNCHRONIZATION_SCOPE_ALLOWED 
FX_VALIDATE_OPTION_ATTRIBUTES_REQUIRED 
FX_VALIDATE_OPTION_PARENT_REQUIRED_FLAG 
FX_VALIDATE_OPTION_PARENT_REQUIRED 

Definition at line 44 of file fxvalidatefunctions.hpp.

44 {
45 FX_VALIDATE_OPTION_NONE_SPECIFIED = 0x00000000,
46 FX_VALIDATE_OPTION_PARENT_NOT_ALLOWED = 0x00000001,
47 FX_VALIDATE_OPTION_EXECUTION_LEVEL_ALLOWED = 0x00000002,
48 FX_VALIDATE_OPTION_SYNCHRONIZATION_SCOPE_ALLOWED = 0x00000004,
49 FX_VALIDATE_OPTION_ATTRIBUTES_REQUIRED = 0x00000008,
50
51 // not used directly, use FX_VALIDATE_OPTION_PARENT_REQUIRED instead
52 FX_VALIDATE_OPTION_PARENT_REQUIRED_FLAG = 0x00000010,
53
54 // if a parent is required, the attributes themselves are requried
55 FX_VALIDATE_OPTION_PARENT_REQUIRED = FX_VALIDATE_OPTION_PARENT_REQUIRED_FLAG |
56 FX_VALIDATE_OPTION_ATTRIBUTES_REQUIRED,
57};
FX_VALIDATE_OPTION_PARENT_REQUIRED
@ FX_VALIDATE_OPTION_PARENT_REQUIRED
Definition: fxvalidatefunctions.hpp:55
FX_VALIDATE_OPTION_NONE_SPECIFIED
@ FX_VALIDATE_OPTION_NONE_SPECIFIED
Definition: fxvalidatefunctions.hpp:45
FX_VALIDATE_OPTION_PARENT_REQUIRED_FLAG
@ FX_VALIDATE_OPTION_PARENT_REQUIRED_FLAG
Definition: fxvalidatefunctions.hpp:52
FX_VALIDATE_OPTION_SYNCHRONIZATION_SCOPE_ALLOWED
@ FX_VALIDATE_OPTION_SYNCHRONIZATION_SCOPE_ALLOWED
Definition: fxvalidatefunctions.hpp:48
FX_VALIDATE_OPTION_EXECUTION_LEVEL_ALLOWED
@ FX_VALIDATE_OPTION_EXECUTION_LEVEL_ALLOWED
Definition: fxvalidatefunctions.hpp:47
FX_VALIDATE_OPTION_ATTRIBUTES_REQUIRED
@ FX_VALIDATE_OPTION_ATTRIBUTES_REQUIRED
Definition: fxvalidatefunctions.hpp:49
FX_VALIDATE_OPTION_PARENT_NOT_ALLOWED
@ FX_VALIDATE_OPTION_PARENT_NOT_ALLOWED
Definition: fxvalidatefunctions.hpp:46

Function Documentation

◆ FxValidateObjectAttributes()

_Must_inspect_result_ NTSTATUS FxValidateObjectAttributes ( __in PFX_DRIVER_GLOBALS  FxDriverGlobals,
__in PWDF_OBJECT_ATTRIBUTES  Attributes,
__in ULONG  Flags = FX_VALIDATE_OPTION_NONE_SPECIFIED 
)

Definition at line 45 of file fxvalidatefunctions.cpp.

50{
51 if (Attributes == NULL) {
52 if (Flags & FX_VALIDATE_OPTION_ATTRIBUTES_REQUIRED) {
53 DoTraceLevelMessage(
54 FxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGDEVICE,
55 "WDF_OBJECT_ATTRIBUTES required, %!STATUS!",
56 (ULONG) STATUS_WDF_PARENT_NOT_SPECIFIED);
57
58 return STATUS_WDF_PARENT_NOT_SPECIFIED;
59 }
60 else {
61 return STATUS_SUCCESS;
62 }
63 }
64
65 if (Attributes->Size != sizeof(WDF_OBJECT_ATTRIBUTES)) {
66 //
67 // Size is wrong, bail out
68 //
69 DoTraceLevelMessage(FxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGAPIERROR,
70 "Attributes %p Size incorrect, expected %d, got %d, %!STATUS!",
71 Attributes, sizeof(WDF_OBJECT_ATTRIBUTES),
72 Attributes->Size, STATUS_INFO_LENGTH_MISMATCH);
73
74 return STATUS_INFO_LENGTH_MISMATCH;
75 }
76
77 if (Attributes->ContextTypeInfo != NULL) {
78#pragma prefast(suppress:__WARNING_REDUNDANTTEST, "different structs of the same size")
79 if (Attributes->ContextTypeInfo->Size !=
80 sizeof(WDF_OBJECT_CONTEXT_TYPE_INFO) &&
81 Attributes->ContextTypeInfo->Size !=
82 sizeof(WDF_OBJECT_CONTEXT_TYPE_INFO_V1_0)) {
83 DoTraceLevelMessage(
84 FxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGAPIERROR,
85 "Attributes %p ContextTypeInfo %p Size %d incorrect, expected %d, %!STATUS!",
86 Attributes, Attributes->ContextTypeInfo,
87 Attributes->ContextTypeInfo->Size,
88 sizeof(WDF_OBJECT_CONTEXT_TYPE_INFO), STATUS_INFO_LENGTH_MISMATCH);
89
90 return STATUS_INFO_LENGTH_MISMATCH;
91 }
92
93 //
94 // A ContextName != NULL and a ContextSize of 0 is allowed
95 //
96 if (Attributes->ContextTypeInfo->ContextSize > 0 &&
97 Attributes->ContextTypeInfo->ContextName == NULL) {
98
99 DoTraceLevelMessage(
100 FxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGAPIERROR,
101 "Attributes %p ContextTypeInfo %p ContextSize %I64d is not zero, "
102 "but ContextName is NULL, %!STATUS!",
103 Attributes, Attributes->ContextTypeInfo,
104 Attributes->ContextTypeInfo->ContextSize,
105 STATUS_WDF_OBJECT_ATTRIBUTES_INVALID);
106
107 return STATUS_WDF_OBJECT_ATTRIBUTES_INVALID;
108 }
109 }
110
111 if (Attributes->ContextSizeOverride > 0) {
112 if (Attributes->ContextTypeInfo == NULL) {
113 //
114 // Can't specify additional size without a type
115 //
116 DoTraceLevelMessage(
117 FxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGAPIERROR,
118 "Attributes %p ContextSizeOverride of %I64d specified, but no type "
119 "information, %!STATUS!",
120 Attributes, Attributes->ContextSizeOverride,
121 STATUS_WDF_OBJECT_ATTRIBUTES_INVALID);
122
123 return STATUS_WDF_OBJECT_ATTRIBUTES_INVALID;
124 }
125 else if (Attributes->ContextSizeOverride <
126 Attributes->ContextTypeInfo->ContextSize) {
127 DoTraceLevelMessage(
128 FxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGAPIERROR,
129 "Attributes %p ContextSizeOverride %I64d < "
130 "ContextTypeInfo->ContextSize %I64d, %!STATUS!",
131 Attributes, Attributes->ContextSizeOverride,
132 Attributes->ContextTypeInfo->ContextSize,
133 STATUS_WDF_OBJECT_ATTRIBUTES_INVALID);
134
135 return STATUS_WDF_OBJECT_ATTRIBUTES_INVALID;
136 }
137 }
138
139 if (Flags & FX_VALIDATE_OPTION_PARENT_NOT_ALLOWED) {
140 if (Attributes->ParentObject != NULL) {
141 DoTraceLevelMessage(
142 FxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGAPIERROR,
143 "Attributes %p does not allow a parent object to be set, set to "
144 "%p, %!STATUS!", Attributes, Attributes->ParentObject,
145 STATUS_WDF_PARENT_ASSIGNMENT_NOT_ALLOWED);
146
147 return STATUS_WDF_PARENT_ASSIGNMENT_NOT_ALLOWED;
148 }
149 }
150 else if ((Flags & FX_VALIDATE_OPTION_PARENT_REQUIRED_FLAG) &&
151 Attributes->ParentObject == NULL) {
152 DoTraceLevelMessage(
153 FxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGDEVICE,
154 "ParentObject required in WDF_OBJECT_ATTRIBUTES %p, %!STATUS!",
155 Attributes, STATUS_WDF_PARENT_NOT_SPECIFIED);
156
157 return STATUS_WDF_PARENT_NOT_SPECIFIED;
158 }
159
160 // Enum range checks
161 if ((Attributes->ExecutionLevel == WdfExecutionLevelInvalid) ||
162 (Attributes->ExecutionLevel > WdfExecutionLevelDispatch)) {
163 DoTraceLevelMessage(
164 FxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGAPIERROR,
165 "Attributes %p execution level set to %d, out of range, %!STATUS!",
166 Attributes, Attributes->ExecutionLevel,
167 STATUS_WDF_OBJECT_ATTRIBUTES_INVALID);
168 return STATUS_WDF_OBJECT_ATTRIBUTES_INVALID;
169 }
170
171 if ((Attributes->SynchronizationScope == WdfSynchronizationScopeInvalid) ||
172 (Attributes->SynchronizationScope > WdfSynchronizationScopeNone)) {
173 DoTraceLevelMessage(
174 FxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGAPIERROR,
175 "Attributes %p synchronization scope set to %d, out of range, %!STATUS!",
176 Attributes, Attributes->SynchronizationScope,
177 STATUS_WDF_OBJECT_ATTRIBUTES_INVALID);
178 return STATUS_WDF_OBJECT_ATTRIBUTES_INVALID;
179 }
180
181 if ((Flags & FX_VALIDATE_OPTION_SYNCHRONIZATION_SCOPE_ALLOWED) == 0) {
182
183 //
184 // If synchronization is not allowed for this object,
185 // check the requested level to ensure none was specified.
186 //
187 if ((Attributes->SynchronizationScope != WdfSynchronizationScopeInheritFromParent) &&
188 (Attributes->SynchronizationScope != WdfSynchronizationScopeNone)) {
189
190 DoTraceLevelMessage(
191 FxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGAPIERROR,
192 "Attributes %p does not allow synchronization scope too be set, "
193 "but was set to %!WDF_SYNCHRONIZATION_SCOPE!, %!STATUS!",
194 Attributes, Attributes->SynchronizationScope,
195 STATUS_WDF_SYNCHRONIZATION_SCOPE_INVALID);
196
197 return STATUS_WDF_SYNCHRONIZATION_SCOPE_INVALID;
198 }
199 }
200
201 if ((Flags & FX_VALIDATE_OPTION_EXECUTION_LEVEL_ALLOWED) == 0) {
202
203 //
204 // If execution level restrictions are not allowed for this object,
205 // check the requested level to ensure none was specified.
206 //
207 if (Attributes->ExecutionLevel != WdfExecutionLevelInheritFromParent) {
208 DoTraceLevelMessage(
209 FxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGAPIERROR,
210 "Attributes %p does not allow execution level to be set, but was"
211 " set to %!WDF_EXECUTION_LEVEL!, %!STATUS!",
212 Attributes, Attributes->ExecutionLevel,
213 STATUS_WDF_EXECUTION_LEVEL_INVALID);
214
215 return STATUS_WDF_EXECUTION_LEVEL_INVALID;
216 }
217 }
218
219 return STATUS_SUCCESS;
220}
TRACINGDEVICE
#define TRACINGDEVICE
Definition: dbgtrace.h:58
TRACINGAPIERROR
#define TRACINGAPIERROR
Definition: dbgtrace.h:60
NULL
#define NULL
Definition: types.h:112
DoTraceLevelMessage
DoTraceLevelMessage(pFxDriverGlobals, TRACE_LEVEL_VERBOSE, TRACINGPNP, "Enter, WDFDEVICE %p", Device)
STATUS_SUCCESS
#define STATUS_SUCCESS
Definition: shellext.h:65
TRACE_LEVEL_ERROR
#define TRACE_LEVEL_ERROR
Definition: storswtr.h:27
_WDF_OBJECT_ATTRIBUTES
Definition: wdfobject.h:100
_WDF_OBJECT_CONTEXT_TYPE_INFO_V1_0
Definition: wdf10.h:1326
_WDF_OBJECT_CONTEXT_TYPE_INFO
Definition: wdfobject.h:183
ULONG
uint32_t ULONG
Definition: typedefs.h:59
STATUS_INFO_LENGTH_MISMATCH
#define STATUS_INFO_LENGTH_MISMATCH
Definition: udferr_usr.h:133
Attributes
_Must_inspect_result_ _In_ WDFDMAENABLER _In_ _In_opt_ PWDF_OBJECT_ATTRIBUTES Attributes
Definition: wdfcommonbuffer.h:97
WdfSynchronizationScopeInheritFromParent
@ WdfSynchronizationScopeInheritFromParent
Definition: wdfobject.h:63
WdfSynchronizationScopeNone
@ WdfSynchronizationScopeNone
Definition: wdfobject.h:66
WdfSynchronizationScopeInvalid
@ WdfSynchronizationScopeInvalid
Definition: wdfobject.h:62
WdfExecutionLevelDispatch
@ WdfExecutionLevelDispatch
Definition: wdfobject.h:55
WdfExecutionLevelInheritFromParent
@ WdfExecutionLevelInheritFromParent
Definition: wdfobject.h:53
WdfExecutionLevelInvalid
@ WdfExecutionLevelInvalid
Definition: wdfobject.h:52
STATUS_WDF_PARENT_ASSIGNMENT_NOT_ALLOWED
#define STATUS_WDF_PARENT_ASSIGNMENT_NOT_ALLOWED
Definition: wdfstatus.h:225
STATUS_WDF_OBJECT_ATTRIBUTES_INVALID
#define STATUS_WDF_OBJECT_ATTRIBUTES_INVALID
Definition: wdfstatus.h:171
STATUS_WDF_SYNCHRONIZATION_SCOPE_INVALID
#define STATUS_WDF_SYNCHRONIZATION_SCOPE_INVALID
Definition: wdfstatus.h:234
STATUS_WDF_EXECUTION_LEVEL_INVALID
#define STATUS_WDF_EXECUTION_LEVEL_INVALID
Definition: wdfstatus.h:243
STATUS_WDF_PARENT_NOT_SPECIFIED
#define STATUS_WDF_PARENT_NOT_SPECIFIED
Definition: wdfstatus.h:252
Flags
_Must_inspect_result_ _In_ ULONG Flags
Definition: wsk.h:170

Referenced by FxWmiProvider::_Create(), FxWmiInstanceExternal::_Create(), FxRequest::_Create(), FxDevice::_OpenKey(), FxUsbDevice::CreateIsochUrb(), FxUsbDevice::CreateUrb(), FxObjectAllocateContext(), if(), and VfAllocateContext().

◆ FxValidateObjectAttributesForParentHandle()

_Must_inspect_result_ NTSTATUS __inline FxValidateObjectAttributesForParentHandle ( __in PFX_DRIVER_GLOBALS  FxDriverGlobals,
__in PWDF_OBJECT_ATTRIBUTES  Attributes,
__in ULONG  Flags = FX_VALIDATE_OPTION_NONE_SPECIFIED 
)

Definition at line 70 of file fxvalidatefunctions.hpp.

75{
76 if (Attributes == NULL) {
77 if (Flags & FX_VALIDATE_OPTION_PARENT_REQUIRED) {
78 DoTraceLevelMessage(
79 FxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGDEVICE,
80 "WDF_OBJECT_ATTRIBUTES required, %!STATUS!",
81 (ULONG) STATUS_WDF_PARENT_NOT_SPECIFIED);
82 }
83 return STATUS_WDF_PARENT_NOT_SPECIFIED;
84 }
85
86 if (Attributes->Size != sizeof(WDF_OBJECT_ATTRIBUTES)) {
87 //
88 // Size is wrong, bail out
89 //
90 DoTraceLevelMessage(FxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGAPIERROR,
91 "Attributes %p Size incorrect, expected %d, got %d, %!STATUS!",
92 Attributes, sizeof(WDF_OBJECT_ATTRIBUTES),
93 Attributes->Size, STATUS_INFO_LENGTH_MISMATCH);
94
95 return STATUS_INFO_LENGTH_MISMATCH;
96 }
97
98 if (Attributes->ParentObject == NULL) {
99 if (Flags & FX_VALIDATE_OPTION_PARENT_REQUIRED) {
100 DoTraceLevelMessage(
101 FxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGDEVICE,
102 "ParentObject required in WDF_OBJECT_ATTRIBUTES %p, %!STATUS!",
103 Attributes, STATUS_WDF_PARENT_NOT_SPECIFIED);
104 }
105 return STATUS_WDF_PARENT_NOT_SPECIFIED;
106 }
107
108 return STATUS_SUCCESS;
109}

Referenced by FxUsbDevice::CreateIsochUrb(), and FxUsbDevice::CreateUrb().

◆ FxValidateUnicodeString()

_Must_inspect_result_ NTSTATUS __inline FxValidateUnicodeString ( __in PFX_DRIVER_GLOBALS  FxDriverGlobals,
__in PCUNICODE_STRING  String 
)

Definition at line 114 of file fxvalidatefunctions.hpp.

118{
119 NTSTATUS status;
120
121 status = STATUS_INVALID_PARAMETER;
122
123 if (String->Length & 1) {
124 DoTraceLevelMessage(
125 FxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGAPIERROR,
126 "UNICODE_STRING %p, Length %d is odd, %!STATUS!",
127 String, String->Length, status);
128
129 return status;
130 }
131
132 if (String->MaximumLength & 1) {
133 DoTraceLevelMessage(
134 FxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGAPIERROR,
135 "UNICODE_STRING %p, MaximumLength %d is odd, %!STATUS!",
136 String, String->MaximumLength, status);
137
138 return status;
139 }
140
141 if (String->MaximumLength > 0 && String->Buffer == NULL) {
142 DoTraceLevelMessage(
143 FxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGAPIERROR,
144 "UNICODE_STRING %p, MaximumLength %d > 0, Buffer is NULL, %!STATUS!",
145 String, String->MaximumLength, status);
146
147 return status;
148 }
149
150 if (String->Length > String->MaximumLength) {
151 DoTraceLevelMessage(
152 FxDriverGlobals, TRACE_LEVEL_ERROR, TRACINGAPIERROR,
153 "UNICODE_STRING %p, Length %d > MaximumLength %d, %!STATUS!",
154 String, String->Length, String->MaximumLength, status);
155
156 return status;
157 }
158
159 return STATUS_SUCCESS;
160}
NTSTATUS
LONG NTSTATUS
Definition: precomp.h:26
status
Definition: ps.c:97
STATUS_INVALID_PARAMETER
#define STATUS_INVALID_PARAMETER
Definition: udferr_usr.h:135
String
_Must_inspect_result_ _In_ WDFDEVICE _In_ WDFSTRING String
Definition: wdfdevice.h:2439

Referenced by __in_ecount(), FxIoTargetValidateOpenParams(), FxDevice::FxValidateInterfacePropertyData(), and if().