Sample Code
Windows Driver Samples/ Windows Filtering Platform Sample/ C++/ syslib/ HelperFunctions_Macros.h/
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 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 | //////////////////////////////////////////////////////////////////////////////////////////////////////// Copyright (c) 2012 Microsoft Corporation. All Rights Reserved.//// Module Name:// HelperFunctions_Macros.h//// Abstract:// This module contains definitions for the various macros used throughout this driver.//// Author:// Dusty Harper (DHarper)//// Revision History://// [ Month ][Day] [Year] - [Revision]-[ Comments ]// May 01, 2010 - 1.0 - Creation//////////////////////////////////////////////////////////////////////////////////////////////////////#ifndef HELPERFUNCTIONS_MACROS_H#define HELPERFUNCTIONS_MACROS_Hextern "C"{ #pragma warning(push) #pragma warning(disable: 4201) /// NAMELESS_STRUCT_UNION #pragma warning(disable: 4324) /// STRUCTURE_PADDED #include <ntifs.h> /// IfsKit\Inc #include <ntddk.h> /// Inc #include <wdf.h> /// Inc\WDF\KMDF\1.9 #include <ndis.h> /// Inc #include <fwpmk.h> /// Inc #include <fwpsk.h> /// Inc #include <netioddk.h> /// Inc #include <ntintsafe.h> /// Inc #include <ntstrsafe.h> /// Inc #include <stdlib.h> /// SDK\Inc\CRT #pragma warning(pop)}#include "Identifiers.h" /// ..\Inc#include "ProviderContexts.h" /// ..\Inc/// Macros#define WFPSAMPLER_SYSLIB_TAG (UINT32)'LSSW'#define WFPSAMPLER_NDIS_POOL_TAG (UINT32)'PNSW'#define SID_LENGTH(pSID) \ (8 + (4 * ((SID*)pSID)->SubAuthorityCount))/** @macro="htonl" Purpose: Convert ULONG in Host Byte Order to Network Byte Order. <br> <br> Notes: <br> <br> MSDN_Ref: <br>*/#define htonl(l) \ ((((l) & 0xFF000000) >> 24) | \ (((l) & 0x00FF0000) >> 8) | \ (((l) & 0x0000FF00) << 8) | \ (((l) & 0x000000FF) << 24))/** @macro="htons" Purpose: Convert USHORT in Host Byte Order to Network Byte Order. <br> <br> Notes: <br> <br> MSDN_Ref: <br>*/#define htons(s) \ ((((s) >> 8) & 0x00FF) | \ (((s) << 8) & 0xFF00))/** @macro="ntohl" Purpose: Convert ULONG in Network Byte Order to Host Byte Order. <br> <br> Notes: <br> <br> MSDN_Ref: <br>*/#define ntohl(l) \ ((((l) >> 24) & 0x000000FFL) | \ (((l) >> 8) & 0x0000FF00L) | \ (((l) << 8) & 0x00FF0000L) | \ (((l) << 24) & 0xFF000000L))/** @macro="ntohs" Purpose: Convert USHORT in Network Byte Order to Host Byte Order. <br> <br> Notes: <br> <br> MSDN_Ref: <br>*/#define ntohs(s) \ ((USHORT)((((s) & 0x00ff) << 8) | \ (((s) & 0xff00) >> 8)))/** @macro="HLPR_CLOSE_HANDLE" Purpose: Close a standard handle and set to 0. <br> <br> Notes: <br> <br> MSDN_Ref: <br>*/#define HLPR_CLOSE_HANDLE(handle)\ if(handle) \ { \ CloseHandle(handle); \ handle = 0; \ }/** @macro="HLPR_REG_CLOSE_KEY" Purpose: Close a registry handle and set to 0. <br> <br> Notes: <br> <br> MSDN_Ref: <br>*/#define HLPR_REG_CLOSE_KEY(keyHandle)\ if(keyHandle) \ { \ RegCloseKey(keyHandle); \ keyHandle = 0; \ }/** @macro="HLPR_DELETE" Purpose: Free memory allocated with ExAllocatePoolWithTag and set the pointer to 0. <br> <br> Notes: <br> <br> MSDN_Ref: <br>*/#define HLPR_DELETE(pPtr, tag) \ if(pPtr) \ { \ ExFreePoolWithTag((VOID*)pPtr, \ tag); \ pPtr = 0; \ }/** @macro="HLPR_DELETE_ARRAY" Purpose: Free memory allocated with ExAllocatePoolWithTag and set the pointer to 0. <br> <br> Notes: <br> <br> MSDN_Ref: <br>*/#define HLPR_DELETE_ARRAY(pPtr, tag) \ HLPR_DELETE(pPtr, tag)/** @macro="HLPR_NEW" Purpose: Allocate memory from NonPaged Pool with ExAllocatePoolWithTag and initialize it's contents with 0's. <br> <br> Notes: Caller responsible for freeing allocated memory using macro HLPR_DELETE. <br> <br> MSDN_Ref: <br>*/#define HLPR_NEW(pPtr, object, tag) \ for(; \ pPtr == 0; \ ) \ { \ pPtr = (object*)ExAllocatePoolWithTag(NonPagedPoolNx, \ sizeof(object), \ tag); \ if(pPtr) \ RtlSecureZeroMemory(pPtr, \ sizeof(object)); \ }/** @macro="HLPR_NEW_ARRAY" Purpose: Allocate memory from NonPaged Pool with ExAllocatePoolWithTag and initialize it's contents with 0's. <br> <br> Notes: Caller responsible for freeing allocated memory using macro HLPR_DELETE_ARRAY. <br> <br> MSDN_Ref: <br>*/#define HLPR_NEW_ARRAY(pPtr, object, count, tag) \ for(; \ pPtr == 0; \ ) \ { \ size_t SAFE_SIZE = 0; \ if(RtlSizeTMult(sizeof(object), \ (size_t)count, \ &SAFE_SIZE) == STATUS_SUCCESS && \ SAFE_SIZE >= (sizeof(object) * count)) \ { \ pPtr = (object*)ExAllocatePoolWithTag(NonPagedPoolNx, \ SAFE_SIZE, \ tag); \ if(pPtr) \ RtlZeroMemory(pPtr, \ SAFE_SIZE); \ } \ else \ break; \ }/** @macro="HLPR_NEW_CASTED_ARRAY" Purpose: Allocate memory from NonPaged Pool with ExAllocatePoolWithTag and initialize it's contents with 0's. <br> <br> Notes: Caller responsible for freeing allocated memory using macro HLPR_DELETE_ARRAY. <br> <br> MSDN_Ref: <br>*/#define HLPR_NEW_CASTED_ARRAY(pPtr, CAST_TYPE, object, count, tag) \ for(; \ pPtr == 0; \ ) \ { \ size_t SAFE_SIZE = 0; \ if(RtlSizeTMult(sizeof(object), \ (size_t)count, \ &SAFE_SIZE) == STATUS_SUCCESS && \ SAFE_SIZE >= (sizeof(object) * count)) \ { \ pPtr = (CAST_TYPE*)ExAllocatePoolWithTag(NonPagedPoolNx, \ SAFE_SIZE, \ tag); \ if(pPtr) \ RtlZeroMemory(pPtr, \ SAFE_SIZE); \ } \ else \ break; \ }/** @macro="HLPR_NEW" Purpose: Allocate memory from NonPaged Pool with ExAllocatePoolWithTag and leave it's contents as is. <br> <br> Notes: Caller responsible for freeing allocated memory using macro HLPR_DELETE. <br> <br> MSDN_Ref: <br>*/#define HLPR_NEW_POPULATED(pPtr, object, tag) \ for(; \ pPtr == 0; \ ) \ { \ pPtr = (object*)ExAllocatePoolWithTag(NonPagedPoolNx, \ sizeof(object), \ tag); \ }/** @macro="HLPR_BAIL_LABEL" Purpose: Tag for the cleanup and exit portion of the function. <br> <br> Notes: <br> <br> MSDN_Ref: <br>*/#define HLPR_BAIL_LABEL \ cleanup/** @macro="HLPR_BAIL_LABEL" Purpose: Tag for the cleanup and exit portion of the function. <br> <br> Notes: Used when there can be more than 1 jump in code. <br> <br> MSDN_Ref: <br>*/#define HLPR_BAIL_LABEL_2 \ cleanup_2/** @macro="HLPR_BAIL_ON_FAILURE_WITH_LABEL" Purpose: Jump in the code's execution to the provided label if an error occurs. <br> <br> Notes: <br> <br> MSDN_Ref: <br>*/#define HLPR_BAIL_ON_FAILURE_WITH_LABEL(status, label) \ if(status != STATUS_SUCCESS) \ goto label#define HLPR_BAIL_ON_ALLOC_FAILURE_WITH_LABEL(pPtr, status, label) \ if(pPtr == 0) \ { \ status = (UINT32)STATUS_NO_MEMORY; \ goto label; \ }/** @macro="HLPR_BAIL_ON_FAILURE" Purpose: Jump in the code's execution path to the HLPR_BAIL_LABEL label if an error occurs. <br> <br> Notes: <br> <br> MSDN_Ref: <br>*/#define HLPR_BAIL_ON_FAILURE(status) \ HLPR_BAIL_ON_FAILURE_WITH_LABEL(status, HLPR_BAIL_LABEL)/** @macro="HLPR_BAIL_ON_FAILURE_2" Purpose: Jump in the code's execution path to the HLPR_BAIL_LABEL_2 label if an error occurs. <br> <br> Notes: <br> <br> MSDN_Ref: <br>*/#define HLPR_BAIL_ON_FAILURE_2(status) \ HLPR_BAIL_ON_FAILURE_WITH_LABEL(status, HLPR_BAIL_LABEL_2)/** @macro="HLPR_BAIL_ON_ALLOC_FAILURE" Purpose: Jump in the code's execution path to the HLPR_BAIL_LABEL label if memory allocation fails. <br> <br> Notes: <br> <br> MSDN_Ref: <br>*/#define HLPR_BAIL_ON_ALLOC_FAILURE(pPtr, status) \ HLPR_BAIL_ON_ALLOC_FAILURE_WITH_LABEL(pPtr, status, HLPR_BAIL_LABEL)/** @macro="HLPR_BAIL_ON_ALLOC_FAILURE_2" Purpose: Jump in the code's execution path to the HLPR_BAIL_LABEL_2 label if memory allocation fails. <br> <br> Notes: <br> <br> MSDN_Ref: <br>*/#define HLPR_BAIL_ON_ALLOC_FAILURE_2(pPtr, status) \ HLPR_BAIL_ON_ALLOC_FAILURE_WITH_LABEL(pPtr, status, HLPR_BAIL_LABEL_2)/** @macro="HLPR_BAIL_WITH_LABEL" Purpose: Jump in the code's execution path to the provided label. <br> <br> Notes: <br> <br> MSDN_Ref: <br>*/#define HLPR_BAIL_WITH_LABEL(label) \ goto label/** @macro="HLPR_BAIL" Purpose: Jump in the code's execution path to the HLPR_BAIL_LABEL label. <br> <br> Notes: <br> <br> MSDN_Ref: <br>*/#define HLPR_BAIL \ HLPR_BAIL_WITH_LABEL(HLPR_BAIL_LABEL)/** @macro="HLPR_BAIL_2" Purpose: Jump in the code's execution path to the HLPR_BAIL_LABEL_2 label. <br> <br> Notes: <br> <br> MSDN_Ref: <br>*/#define HLPR_BAIL_2 \ HLPR_BAIL_WITH_LABEL(HLPR_BAIL_LABEL_2)/** @macro="HLPR_BAIL_ON_NULL_POINTER" Purpose: Jump in the code's execution path to the HLPR_BAIL_LABEL label if the pointer is NULL. <br> <br> Notes: <br> <br> MSDN_Ref: <br>*/#define HLPR_BAIL_ON_NULL_POINTER(pPtr) \ if(pPtr == 0) \ HLPR_BAIL/** @macro="HLPR_BAIL_ON_NULL_POINTER_WITH_STATUS" Purpose: Jump in the code's execution path to the HLPR_BAIL_LABEL label if the pointer is NULL. <br> <br> Notes: Status is set to STATUS_INVALID_ADDRESS. <br> <br> MSDN_Ref: <br>*/#define HLPR_BAIL_ON_NULL_POINTER_WITH_STATUS(pPtr, status) \ if(pPtr == 0) \ { \ status = STATUS_INVALID_ADDRESS; \ HLPR_BAIL; \ }#endif /// HELPERFUNCTIONS_MACROS_H |
Our Services
-
What our customers say about us?
Read our customer testimonials to find out why our clients keep returning for their projects.
View Testimonials
