Sample Code

Windows Driver Samples/ Windows Filtering Platform Sample/ C++/ syslib/ HelperFunctions_PendData.cpp/

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
////////////////////////////////////////////////////////////////////////////////////////////////////
//
//   Copyright (c) 2012 Microsoft Corporation.  All Rights Reserved.
//
//   Module Name:
//      HelperFunctions_PendData.cpp
//
//   Abstract:
//      This module contains kernel helper functions that assist with PEND_DATA.
//
//   Naming Convention:
//
//      <Module><Object><Action>
// 
//      i.e.
//
//       KrnlHlprWorkItemQueue
//
//       <Module>
//          KrnlHlpr   -       Function is located in syslib\ and applies to kernel mode.
//       <Object>
//          PendData   -       Function pertains to PEND_DATA objects.
//       <Action>
//          {
//            Create   -       Function allocates and fills memory.
//            Destroy  -       Function cleans up and frees memory.
//            Populate -       Function fills memory with values
//            Purge    -       Function cleans up values
//          }
//
//   Private Functions:
//
//   Public Functions:
//      KrnlHlprPendDataDataCreate(),
//      KrnlHlprPendDataDataDestroy(),
//      KrnlHlprPendDataDataPopulate(),
//      KrnlHlprPendDataDataPurge(),
//
//   Author:
//      Dusty Harper      (DHarper)
//
//   Revision History:
//
//      [ Month ][Day] [Year] - [Revision]-[ Comments ]
//      May       01,   2010  -     1.0   -  Creation
//
////////////////////////////////////////////////////////////////////////////////////////////////////
 
#include "HelperFunctions_Include.h"    /// .
#include "HelperFunctions_PendData.tmh" /// $(OBJ_PATH)\$(O)\
 
/**
 @kernel_helper_function="KrnlHlprPendDataPurge"
  
   Purpose:  Cleanup a PEND_DATA object.                                                        <br>
                                                                                                <br>
   Notes:                                                                                       <br>
                                                                                                <br>
*/
_IRQL_requires_min_(PASSIVE_LEVEL)
_IRQL_requires_max_(DISPATCH_LEVEL)
_IRQL_requires_same_
inline VOID KrnlHlprPendDataPurge(_Inout_ PEND_DATA* pPendData)
{
#if DBG
    
   DbgPrintEx(DPFLTR_IHVNETWORK_ID,
              DPFLTR_INFO_LEVEL,
              " ---> KrnlHlprPendDataPurge()\n");
 
#endif /// DBG
    
   NT_ASSERT(pPendData);
 
   if(pPendData->completionContext &&
      pPendData->isPended)
   {
      FwpsCompleteOperation(pPendData->completionContext,
                            pPendData->pNBL);
 
      pPendData->completionContext      = 0;
      pPendData->pNBL                   = 0;
      pPendData->pPendAuthorizationData = 0;
      pPendData->isPended               = FALSE;
   }
 
   RtlZeroMemory(pPendData,
                 sizeof(PEND_DATA));
 
#if DBG
    
   DbgPrintEx(DPFLTR_IHVNETWORK_ID,
              DPFLTR_INFO_LEVEL,
              " <--- KrnlHlprPendDataPurge()\n");
 
#endif /// DBG
    
   return;
}
 
/**
 @kernel_helper_function="KrnlHlprPendDataDestroy"
  
   Purpose:  Cleanup and free a PEND_DATA object.                                               <br>
                                                                                                <br>
   Notes:                                                                                       <br>
                                                                                                <br>
   MSDN_Ref:                                                                                    <br>
*/
_At_(ppPendData, _Pre_ _Notnull_)
_At_(*ppPendData, _Post_ _Null_ __drv_freesMem(Pool))
_IRQL_requires_min_(PASSIVE_LEVEL)
_IRQL_requires_max_(DISPATCH_LEVEL)
_IRQL_requires_same_
_Success_(*ppPendData == 0)
inline VOID KrnlHlprPendDataDestroy(_Inout_ PEND_DATA** ppPendData)
{
#if DBG
    
   DbgPrintEx(DPFLTR_IHVNETWORK_ID,
              DPFLTR_INFO_LEVEL,
              " ---> KrnlHlprPendDataDestroy()\n");
 
#endif /// DBG
    
   NT_ASSERT(ppPendData);
 
   if(*ppPendData)
   {
      KrnlHlprPendDataPurge(*ppPendData);
 
      HLPR_DELETE(*ppPendData,
                  WFPSAMPLER_SYSLIB_TAG);
   }
 
#if DBG
    
   DbgPrintEx(DPFLTR_IHVNETWORK_ID,
              DPFLTR_INFO_LEVEL,
              " <--- KrnlHlprPendDataDestroy()\n");
 
#endif /// DBG
    
   return;
}
 
/**
 @kernel_helper_function="KrnlHlprPendDataPopulate"
  
   Purpose:  Populates a PEND_DATA object with the completionContext.                           <br>
                                                                                                <br>
   Notes:                                                                                       <br>
                                                                                                <br>
*/
_IRQL_requires_min_(PASSIVE_LEVEL)
_IRQL_requires_max_(DISPATCH_LEVEL)
_IRQL_requires_same_
_Check_return_
_Success_(return == STATUS_SUCCESS)
NTSTATUS KrnlHlprPendDataPopulate(_Inout_ PEND_DATA* pPendData,
                                  _In_ const FWPS_INCOMING_METADATA_VALUES* pMetadata,
                                  _In_opt_ NET_BUFFER_LIST* pNBL,
                                  _In_ const FWPS_FILTER* pFilter)
{
#if DBG
    
   DbgPrintEx(DPFLTR_IHVNETWORK_ID,
              DPFLTR_INFO_LEVEL,
              " ---> KrnlHlprPendDataPopulate()\n");
 
#endif /// DBG
    
   NT_ASSERT(pPendData);
   NT_ASSERT(pMetadata);
   NT_ASSERT(pFilter);
 
   NTSTATUS status = STATUS_SUCCESS;
 
   if(FWPS_IS_METADATA_FIELD_PRESENT(pMetadata,
                                     FWPS_METADATA_FIELD_COMPLETION_HANDLE))
   {
      status = FwpsPendOperation(pMetadata->completionHandle,
                                 &(pPendData->completionContext));
      if(status != STATUS_SUCCESS)
      {
         DbgPrintEx(DPFLTR_IHVNETWORK_ID,
                    DPFLTR_ERROR_LEVEL,
                    " !!!! KrnlHlprPendDataPopulate : FwpsPendOperation() [status: %#x]\n",
                    status);
 
         HLPR_BAIL;
      }
 
      pPendData->pNBL                   = pNBL;
      pPendData->pPendAuthorizationData = (PC_PEND_AUTHORIZATION_DATA*)pFilter->providerContext->dataBuffer->data;
      pPendData->isPended               = TRUE;
 
      HLPR_BAIL_LABEL:
 
      if(status != STATUS_SUCCESS)
         KrnlHlprPendDataPurge(pPendData);
   }
   else
   {
      status = STATUS_INVALID_HANDLE;
 
      DbgPrintEx(DPFLTR_IHVNETWORK_ID,
                 DPFLTR_ERROR_LEVEL,
                 " !!!! KrnlHlprPendDataPopulate() [status: %#x]\n",
                 status);
   }
 
#if DBG
    
   DbgPrintEx(DPFLTR_IHVNETWORK_ID,
              DPFLTR_INFO_LEVEL,
              " <--- KrnlHlprPendDataPopulate() [status: %#x]\n",
              status);
 
#endif /// DBG
    
   return status;
}
 
/**
 @kernel_helper_function="KrnlHlprPendDataCreate"
  
   Purpose:  Allocates and populates a PEND_DATA object with the completionContext.             <br>
                                                                                                <br>
   Notes:                                                                                       <br>
                                                                                                <br>
   MSDN_Ref:                                                                                    <br>
*/
_At_(*ppPendData, _Pre_ _Null_)
_When_(return != STATUS_SUCCESS, _At_(*ppPendData, _Post_ _Null_))
_When_(return == STATUS_SUCCESS, _At_(*ppPendData, _Post_ _Notnull_ __drv_allocatesMem(Pool)))
_IRQL_requires_min_(PASSIVE_LEVEL)
_IRQL_requires_max_(DISPATCH_LEVEL)
_IRQL_requires_same_
_Check_return_
_Success_(return == STATUS_SUCCESS)
NTSTATUS KrnlHlprPendDataCreate(_Outptr_ PEND_DATA** ppPendData,
                                _In_ const FWPS_INCOMING_METADATA_VALUES* pMetadata,
                                _In_opt_ NET_BUFFER_LIST* pNBL,
                                _In_ const FWPS_FILTER* pFilter)
{
#if DBG
    
   DbgPrintEx(DPFLTR_IHVNETWORK_ID,
              DPFLTR_INFO_LEVEL,
              " ---> KrnlHlprPendDataCreate()\n");
 
#endif /// DBG
    
   NT_ASSERT(ppPendData);
   NT_ASSERT(pMetadata);
   NT_ASSERT(pFilter);
 
   NTSTATUS status = STATUS_SUCCESS;
 
   HLPR_NEW(*ppPendData,
            PEND_DATA,
            WFPSAMPLER_SYSLIB_TAG);
   HLPR_BAIL_ON_ALLOC_FAILURE(*ppPendData,
                              status);
 
   status = KrnlHlprPendDataPopulate(*ppPendData,
                                     pMetadata,
                                     pNBL,
                                     pFilter);
 
   HLPR_BAIL_LABEL:
 
#pragma warning(push)
#pragma warning(disable: 6001) /// *ppPendData initialized with calls to HLPR_NEW & KrnlHlprPendDataPopulate
 
   if(status != STATUS_SUCCESS &&
      *ppPendData)
      KrnlHlprPendDataDestroy(ppPendData);
 
#pragma warning(pop)
 
#if DBG
    
   DbgPrintEx(DPFLTR_IHVNETWORK_ID,
              DPFLTR_INFO_LEVEL,
              " <--- KrnlHlprPendDataCreate() [status: %#x]\n",
              status);
 
#endif /// DBG
    
   return status;
}

Our Services

  • What our customers say about us?

© 2011-2025 All Rights Reserved. Joya Systems. 4425 South Mopac Building II Suite 101 Austin, TX 78735 Tel: 800-DEV-KERNEL

Privacy Policy. Terms of use. Valid XHTML & CSS