[NDK][DDK][RTL]
[reactos.git] / reactos / include / ndk / rtlfuncs.h
1 /*++ NDK Version: 0098
2
3 Copyright (c) Alex Ionescu. All rights reserved.
4
5 Header Name:
6
7 rtlfuncs.h
8
9 Abstract:
10
11 Function definitions for the Run-Time Library
12
13 Author:
14
15 Alex Ionescu (alexi@tinykrnl.org) - Updated - 27-Feb-2006
16
17 --*/
18
19 #ifndef _RTLFUNCS_H
20 #define _RTLFUNCS_H
21
22 //
23 // Dependencies
24 //
25 #include <umtypes.h>
26 #include <ntnls.h>
27 #include <rtltypes.h>
28 #include <pstypes.h>
29 #include <extypes.h>
30 #include "in6addr.h"
31 #include "inaddr.h"
32
33 #ifdef __cplusplus
34 extern "C" {
35 #endif
36
37 #ifdef NTOS_MODE_USER
38
39 //
40 // List Functions
41 //
42 FORCEINLINE
43 VOID
44 InitializeListHead(
45 _Out_ PLIST_ENTRY ListHead
46 )
47 {
48 ListHead->Flink = ListHead->Blink = ListHead;
49 }
50
51 FORCEINLINE
52 VOID
53 InsertHeadList(
54 _Inout_ PLIST_ENTRY ListHead,
55 _Inout_ PLIST_ENTRY Entry
56 )
57 {
58 PLIST_ENTRY OldFlink;
59 OldFlink = ListHead->Flink;
60 Entry->Flink = OldFlink;
61 Entry->Blink = ListHead;
62 OldFlink->Blink = Entry;
63 ListHead->Flink = Entry;
64 }
65
66 FORCEINLINE
67 VOID
68 InsertTailList(
69 _Inout_ PLIST_ENTRY ListHead,
70 _Inout_ PLIST_ENTRY Entry
71 )
72 {
73 PLIST_ENTRY OldBlink;
74 OldBlink = ListHead->Blink;
75 Entry->Flink = ListHead;
76 Entry->Blink = OldBlink;
77 OldBlink->Flink = Entry;
78 ListHead->Blink = Entry;
79 }
80
81 _Must_inspect_result_
82 FORCEINLINE
83 BOOLEAN
84 IsListEmpty(
85 _In_ const LIST_ENTRY * ListHead
86 )
87 {
88 return (BOOLEAN)(ListHead->Flink == ListHead);
89 }
90
91 FORCEINLINE
92 PSINGLE_LIST_ENTRY
93 PopEntryList(
94 _Inout_ PSINGLE_LIST_ENTRY ListHead
95 )
96 {
97 PSINGLE_LIST_ENTRY FirstEntry;
98 FirstEntry = ListHead->Next;
99 if (FirstEntry != NULL) {
100 ListHead->Next = FirstEntry->Next;
101 }
102
103 return FirstEntry;
104 }
105
106 FORCEINLINE
107 VOID
108 PushEntryList(
109 _Inout_ PSINGLE_LIST_ENTRY ListHead,
110 _Inout_ PSINGLE_LIST_ENTRY Entry
111 )
112 {
113 Entry->Next = ListHead->Next;
114 ListHead->Next = Entry;
115 }
116
117 FORCEINLINE
118 BOOLEAN
119 RemoveEntryList(
120 _In_ PLIST_ENTRY Entry)
121 {
122 PLIST_ENTRY OldFlink;
123 PLIST_ENTRY OldBlink;
124
125 OldFlink = Entry->Flink;
126 OldBlink = Entry->Blink;
127 OldFlink->Blink = OldBlink;
128 OldBlink->Flink = OldFlink;
129 return (BOOLEAN)(OldFlink == OldBlink);
130 }
131
132 FORCEINLINE
133 PLIST_ENTRY
134 RemoveHeadList(
135 _Inout_ PLIST_ENTRY ListHead)
136 {
137 PLIST_ENTRY Flink;
138 PLIST_ENTRY Entry;
139
140 Entry = ListHead->Flink;
141 Flink = Entry->Flink;
142 ListHead->Flink = Flink;
143 Flink->Blink = ListHead;
144 return Entry;
145 }
146
147 FORCEINLINE
148 PLIST_ENTRY
149 RemoveTailList(
150 _Inout_ PLIST_ENTRY ListHead)
151 {
152 PLIST_ENTRY Blink;
153 PLIST_ENTRY Entry;
154
155 Entry = ListHead->Blink;
156 Blink = Entry->Blink;
157 ListHead->Blink = Blink;
158 Blink->Flink = ListHead;
159 return Entry;
160 }
161
162 //
163 // Unicode string macros
164 //
165 _At_(UnicodeString->Buffer, _Post_equal_to_(Buffer))
166 _At_(UnicodeString->Length, _Post_equal_to_(0))
167 _At_(UnicodeString->MaximumLength, _Post_equal_to_(BufferSize))
168 FORCEINLINE
169 VOID
170 RtlInitEmptyUnicodeString(
171 _Out_ PUNICODE_STRING UnicodeString,
172 _When_(BufferSize != 0, _Notnull_) _Writable_bytes_(BufferSize) __drv_aliasesMem PWCHAR Buffer,
173 _In_ USHORT BufferSize)
174 {
175 UnicodeString->Length = 0;
176 UnicodeString->MaximumLength = BufferSize;
177 UnicodeString->Buffer = Buffer;
178 }
179
180 _At_(AnsiString->Buffer, _Post_equal_to_(Buffer))
181 _At_(AnsiString->Length, _Post_equal_to_(0))
182 _At_(AnsiString->MaximumLength, _Post_equal_to_(BufferSize))
183 FORCEINLINE
184 VOID
185 RtlInitEmptyAnsiString(
186 _Out_ PANSI_STRING AnsiString,
187 _When_(BufferSize != 0, _Notnull_) _Writable_bytes_(BufferSize) __drv_aliasesMem PCHAR Buffer,
188 _In_ USHORT BufferSize)
189 {
190 AnsiString->Length = 0;
191 AnsiString->MaximumLength = BufferSize;
192 AnsiString->Buffer = Buffer;
193 }
194
195 //
196 // LUID Macros
197 //
198 #define RtlEqualLuid(L1, L2) (((L1)->HighPart == (L2)->HighPart) && \
199 ((L1)->LowPart == (L2)->LowPart))
200 FORCEINLINE
201 LUID
202 NTAPI_INLINE
203 RtlConvertUlongToLuid(
204 _In_ ULONG Ulong)
205 {
206 LUID TempLuid;
207
208 TempLuid.LowPart = Ulong;
209 TempLuid.HighPart = 0;
210 return TempLuid;
211 }
212
213 //
214 // ASSERT Macros
215 //
216 #ifndef ASSERT
217 #if DBG
218
219 #define ASSERT( exp ) \
220 ((void)((!(exp)) ? \
221 (RtlAssert( (PVOID)#exp, (PVOID)__FILE__, __LINE__, NULL ),FALSE) : \
222 TRUE))
223
224 #define ASSERTMSG( msg, exp ) \
225 ((void)((!(exp)) ? \
226 (RtlAssert( (PVOID)#exp, (PVOID)__FILE__, __LINE__, (PCHAR)msg ),FALSE) : \
227 TRUE))
228
229 #else
230
231 #define ASSERT( exp ) ((void) 0)
232 #define ASSERTMSG( msg, exp ) ((void) 0)
233
234 #endif
235 #endif
236
237 #ifdef NTOS_KERNEL_RUNTIME
238
239 //
240 // Executing RTL functions at DISPATCH_LEVEL or higher will result in a
241 // bugcheck.
242 //
243 #define RTL_PAGED_CODE PAGED_CODE
244
245 #else
246
247 //
248 // This macro does nothing in user mode
249 //
250 #define RTL_PAGED_CODE NOP_FUNCTION
251
252 #endif
253
254 //
255 // RTL Splay Tree Functions
256 //
257 #ifndef RTL_USE_AVL_TABLES
258
259 NTSYSAPI
260 VOID
261 NTAPI
262 RtlInitializeGenericTable(
263 _Out_ PRTL_GENERIC_TABLE Table,
264 _In_ PRTL_GENERIC_COMPARE_ROUTINE CompareRoutine,
265 _In_opt_ PRTL_GENERIC_ALLOCATE_ROUTINE AllocateRoutine,
266 _In_opt_ PRTL_GENERIC_FREE_ROUTINE FreeRoutine,
267 _In_opt_ PVOID TableContext
268 );
269
270 NTSYSAPI
271 PVOID
272 NTAPI
273 RtlInsertElementGenericTable(
274 _In_ PRTL_GENERIC_TABLE Table,
275 _In_reads_bytes_(BufferSize) PVOID Buffer,
276 _In_ CLONG BufferSize,
277 _Out_opt_ PBOOLEAN NewElement
278 );
279
280 NTSYSAPI
281 PVOID
282 NTAPI
283 RtlInsertElementGenericTableFull(
284 _In_ PRTL_GENERIC_TABLE Table,
285 _In_reads_bytes_(BufferSize) PVOID Buffer,
286 _In_ CLONG BufferSize,
287 _Out_opt_ PBOOLEAN NewElement,
288 _In_ PVOID NodeOrParent,
289 _In_ TABLE_SEARCH_RESULT SearchResult
290 );
291
292 NTSYSAPI
293 BOOLEAN
294 NTAPI
295 RtlDeleteElementGenericTable(
296 _In_ PRTL_GENERIC_TABLE Table,
297 _In_ PVOID Buffer
298 );
299
300 _Must_inspect_result_
301 NTSYSAPI
302 PVOID
303 NTAPI
304 RtlLookupElementGenericTable(
305 _In_ PRTL_GENERIC_TABLE Table,
306 _In_ PVOID Buffer
307 );
308
309 NTSYSAPI
310 PVOID
311 NTAPI
312 RtlLookupElementGenericTableFull(
313 _In_ PRTL_GENERIC_TABLE Table,
314 _In_ PVOID Buffer,
315 _Out_ PVOID *NodeOrParent,
316 _Out_ TABLE_SEARCH_RESULT *SearchResult
317 );
318
319 _Must_inspect_result_
320 NTSYSAPI
321 PVOID
322 NTAPI
323 RtlEnumerateGenericTable(
324 _In_ PRTL_GENERIC_TABLE Table,
325 _In_ BOOLEAN Restart
326 );
327
328 _Must_inspect_result_
329 NTSYSAPI
330 PVOID
331 NTAPI
332 RtlEnumerateGenericTableWithoutSplaying(
333 _In_ PRTL_GENERIC_TABLE Table,
334 _Inout_ PVOID *RestartKey
335 );
336
337 _Must_inspect_result_
338 NTSYSAPI
339 PVOID
340 NTAPI
341 RtlGetElementGenericTable(
342 _In_ PRTL_GENERIC_TABLE Table,
343 _In_ ULONG I
344 );
345
346 NTSYSAPI
347 ULONG
348 NTAPI
349 RtlNumberGenericTableElements(
350 _In_ PRTL_GENERIC_TABLE Table
351 );
352
353 _Must_inspect_result_
354 NTSYSAPI
355 BOOLEAN
356 NTAPI
357 RtlIsGenericTableEmpty(
358 _In_ PRTL_GENERIC_TABLE Table
359 );
360
361 #endif /* !RTL_USE_AVL_TABLES */
362
363 NTSYSAPI
364 PRTL_SPLAY_LINKS
365 NTAPI
366 RtlSplay(
367 _Inout_ PRTL_SPLAY_LINKS Links
368 );
369
370 NTSYSAPI
371 PRTL_SPLAY_LINKS
372 NTAPI
373 RtlDelete(
374 _In_ PRTL_SPLAY_LINKS Links
375 );
376
377 NTSYSAPI
378 VOID
379 NTAPI
380 RtlDeleteNoSplay(
381 _In_ PRTL_SPLAY_LINKS Links,
382 _Inout_ PRTL_SPLAY_LINKS *Root
383 );
384
385 _Must_inspect_result_
386 NTSYSAPI
387 PRTL_SPLAY_LINKS
388 NTAPI
389 RtlSubtreeSuccessor(
390 _In_ PRTL_SPLAY_LINKS Links
391 );
392
393 _Must_inspect_result_
394 NTSYSAPI
395 PRTL_SPLAY_LINKS
396 NTAPI
397 RtlSubtreePredecessor(
398 _In_ PRTL_SPLAY_LINKS Links
399 );
400
401 _Must_inspect_result_
402 NTSYSAPI
403 PRTL_SPLAY_LINKS
404 NTAPI
405 RtlRealSuccessor(
406 _In_ PRTL_SPLAY_LINKS Links
407 );
408
409 _Must_inspect_result_
410 NTSYSAPI
411 PRTL_SPLAY_LINKS
412 NTAPI
413 RtlRealPredecessor(
414 _In_ PRTL_SPLAY_LINKS Links
415 );
416
417 #define RtlIsLeftChild(Links) \
418 (RtlLeftChild(RtlParent(Links)) == (PRTL_SPLAY_LINKS)(Links))
419
420 #define RtlIsRightChild(Links) \
421 (RtlRightChild(RtlParent(Links)) == (PRTL_SPLAY_LINKS)(Links))
422
423 #define RtlRightChild(Links) \
424 ((PRTL_SPLAY_LINKS)(Links))->RightChild
425
426 #define RtlIsRoot(Links) \
427 (RtlParent(Links) == (PRTL_SPLAY_LINKS)(Links))
428
429 #define RtlLeftChild(Links) \
430 ((PRTL_SPLAY_LINKS)(Links))->LeftChild
431
432 #define RtlParent(Links) \
433 ((PRTL_SPLAY_LINKS)(Links))->Parent
434
435 // FIXME: use inline function
436
437 #define RtlInitializeSplayLinks(Links) \
438 { \
439 PRTL_SPLAY_LINKS _SplayLinks; \
440 _SplayLinks = (PRTL_SPLAY_LINKS)(Links); \
441 _SplayLinks->Parent = _SplayLinks; \
442 _SplayLinks->LeftChild = NULL; \
443 _SplayLinks->RightChild = NULL; \
444 }
445
446 #define RtlInsertAsLeftChild(ParentLinks,ChildLinks) \
447 { \
448 PRTL_SPLAY_LINKS _SplayParent; \
449 PRTL_SPLAY_LINKS _SplayChild; \
450 _SplayParent = (PRTL_SPLAY_LINKS)(ParentLinks); \
451 _SplayChild = (PRTL_SPLAY_LINKS)(ChildLinks); \
452 _SplayParent->LeftChild = _SplayChild; \
453 _SplayChild->Parent = _SplayParent; \
454 }
455
456 #define RtlInsertAsRightChild(ParentLinks,ChildLinks) \
457 { \
458 PRTL_SPLAY_LINKS _SplayParent; \
459 PRTL_SPLAY_LINKS _SplayChild; \
460 _SplayParent = (PRTL_SPLAY_LINKS)(ParentLinks); \
461 _SplayChild = (PRTL_SPLAY_LINKS)(ChildLinks); \
462 _SplayParent->RightChild = _SplayChild; \
463 _SplayChild->Parent = _SplayParent; \
464 }
465
466 //
467 // RTL AVL Tree Functions
468 //
469 NTSYSAPI
470 VOID
471 NTAPI
472 RtlInitializeGenericTableAvl(
473 _Out_ PRTL_AVL_TABLE Table,
474 _In_ PRTL_AVL_COMPARE_ROUTINE CompareRoutine,
475 _In_opt_ PRTL_AVL_ALLOCATE_ROUTINE AllocateRoutine,
476 _In_opt_ PRTL_AVL_FREE_ROUTINE FreeRoutine,
477 _In_opt_ PVOID TableContext
478 );
479
480 NTSYSAPI
481 PVOID
482 NTAPI
483 RtlInsertElementGenericTableAvl(
484 _In_ PRTL_AVL_TABLE Table,
485 _In_reads_bytes_(BufferSize) PVOID Buffer,
486 _In_ CLONG BufferSize,
487 _Out_opt_ PBOOLEAN NewElement
488 );
489
490 NTSYSAPI
491 PVOID
492 NTAPI
493 RtlInsertElementGenericTableFullAvl(
494 _In_ PRTL_AVL_TABLE Table,
495 _In_reads_bytes_(BufferSize) PVOID Buffer,
496 _In_ CLONG BufferSize,
497 _Out_opt_ PBOOLEAN NewElement,
498 _In_ PVOID NodeOrParent,
499 _In_ TABLE_SEARCH_RESULT SearchResult
500 );
501
502 NTSYSAPI
503 BOOLEAN
504 NTAPI
505 RtlDeleteElementGenericTableAvl(
506 _In_ PRTL_AVL_TABLE Table,
507 _In_ PVOID Buffer
508 );
509
510 _Must_inspect_result_
511 NTSYSAPI
512 PVOID
513 NTAPI
514 RtlLookupElementGenericTableAvl(
515 _In_ PRTL_AVL_TABLE Table,
516 _In_ PVOID Buffer
517 );
518
519 NTSYSAPI
520 PVOID
521 NTAPI
522 RtlLookupElementGenericTableFullAvl(
523 _In_ PRTL_AVL_TABLE Table,
524 _In_ PVOID Buffer,
525 _Out_ PVOID *NodeOrParent,
526 _Out_ TABLE_SEARCH_RESULT *SearchResult
527 );
528
529 _Must_inspect_result_
530 NTSYSAPI
531 PVOID
532 NTAPI
533 RtlEnumerateGenericTableAvl(
534 _In_ PRTL_AVL_TABLE Table,
535 _In_ BOOLEAN Restart
536 );
537
538 _Must_inspect_result_
539 NTSYSAPI
540 PVOID
541 NTAPI
542 RtlEnumerateGenericTableWithoutSplayingAvl(
543 _In_ PRTL_AVL_TABLE Table,
544 _Inout_ PVOID *RestartKey
545 );
546
547 _Must_inspect_result_
548 NTSYSAPI
549 PVOID
550 NTAPI
551 RtlLookupFirstMatchingElementGenericTableAvl(
552 _In_ PRTL_AVL_TABLE Table,
553 _In_ PVOID Buffer,
554 _Out_ PVOID *RestartKey
555 );
556
557 _Must_inspect_result_
558 NTSYSAPI
559 PVOID
560 NTAPI
561 RtlEnumerateGenericTableLikeADirectory(
562 _In_ PRTL_AVL_TABLE Table,
563 _In_opt_ PRTL_AVL_MATCH_FUNCTION MatchFunction,
564 _In_opt_ PVOID MatchData,
565 _In_ ULONG NextFlag,
566 _Inout_ PVOID *RestartKey,
567 _Inout_ PULONG DeleteCount,
568 _In_ PVOID Buffer
569 );
570
571 _Must_inspect_result_
572 NTSYSAPI
573 PVOID
574 NTAPI
575 RtlGetElementGenericTableAvl(
576 _In_ PRTL_AVL_TABLE Table,
577 _In_ ULONG I
578 );
579
580 NTSYSAPI
581 ULONG
582 NTAPI
583 RtlNumberGenericTableElementsAvl(
584 _In_ PRTL_AVL_TABLE Table
585 );
586
587 _Must_inspect_result_
588 NTSYSAPI
589 BOOLEAN
590 NTAPI
591 RtlIsGenericTableEmptyAvl(
592 _In_ PRTL_AVL_TABLE Table
593 );
594
595 #ifdef RTL_USE_AVL_TABLES
596
597 #define RtlInitializeGenericTable RtlInitializeGenericTableAvl
598 #define RtlInsertElementGenericTable RtlInsertElementGenericTableAvl
599 #define RtlInsertElementGenericTableFull RtlInsertElementGenericTableFullAvl
600 #define RtlDeleteElementGenericTable RtlDeleteElementGenericTableAvl
601 #define RtlLookupElementGenericTable RtlLookupElementGenericTableAvl
602 #define RtlLookupElementGenericTableFull RtlLookupElementGenericTableFullAvl
603 #define RtlEnumerateGenericTable RtlEnumerateGenericTableAvl
604 #define RtlEnumerateGenericTableWithoutSplaying RtlEnumerateGenericTableWithoutSplayingAvl
605 #define RtlGetElementGenericTable RtlGetElementGenericTableAvl
606 #define RtlNumberGenericTableElements RtlNumberGenericTableElementsAvl
607 #define RtlIsGenericTableEmpty RtlIsGenericTableEmptyAvl
608
609 #endif /* RTL_USE_AVL_TABLES */
610
611 //
612 // Error and Exception Functions
613 //
614 NTSYSAPI
615 PVOID
616 NTAPI
617 RtlAddVectoredExceptionHandler(
618 _In_ ULONG FirstHandler,
619 _In_ PVECTORED_EXCEPTION_HANDLER VectoredHandler
620 );
621
622 __analysis_noreturn
623 NTSYSAPI
624 VOID
625 NTAPI
626 RtlAssert(
627 _In_ PVOID FailedAssertion,
628 _In_ PVOID FileName,
629 _In_ ULONG LineNumber,
630 _In_opt_z_ PCHAR Message
631 );
632
633 NTSYSAPI
634 VOID
635 NTAPI
636 RtlSetUnhandledExceptionFilter(
637 _In_ PRTLP_UNHANDLED_EXCEPTION_FILTER TopLevelExceptionFilter
638 );
639
640 #endif /* NTOS_MODE_USER */
641
642 NTSYSAPI
643 VOID
644 NTAPI
645 RtlCaptureContext(
646 _Out_ PCONTEXT ContextRecord
647 );
648
649 NTSYSAPI
650 PVOID
651 NTAPI
652 RtlEncodePointer(
653 _In_ PVOID Pointer
654 );
655
656 NTSYSAPI
657 PVOID
658 NTAPI
659 RtlDecodePointer(
660 _In_ PVOID Pointer
661 );
662
663 NTSYSAPI
664 PVOID
665 NTAPI
666 RtlEncodeSystemPointer(
667 _In_ PVOID Pointer
668 );
669
670 NTSYSAPI
671 PVOID
672 NTAPI
673 RtlDecodeSystemPointer(
674 _In_ PVOID Pointer
675 );
676
677 NTSYSAPI
678 BOOLEAN
679 NTAPI
680 RtlDispatchException(
681 _In_ PEXCEPTION_RECORD ExceptionRecord,
682 _In_ PCONTEXT Context
683 );
684
685 _IRQL_requires_max_(APC_LEVEL)
686 _When_(Status < 0, _Out_range_(>, 0))
687 _When_(Status >= 0, _Out_range_(==, 0))
688 NTSYSAPI
689 ULONG
690 NTAPI
691 RtlNtStatusToDosError(
692 _In_ NTSTATUS Status
693 );
694
695 _When_(Status < 0, _Out_range_(>, 0))
696 _When_(Status >= 0, _Out_range_(==, 0))
697 NTSYSAPI
698 ULONG
699 NTAPI
700 RtlNtStatusToDosErrorNoTeb(
701 _In_ NTSTATUS Status
702 );
703
704 NTSYSAPI
705 VOID
706 NTAPI
707 RtlSetLastWin32ErrorAndNtStatusFromNtStatus(
708 _In_ NTSTATUS Status
709 );
710
711 NTSYSAPI
712 VOID
713 NTAPI
714 RtlRaiseException(
715 _In_ PEXCEPTION_RECORD ExceptionRecord
716 );
717
718 DECLSPEC_NORETURN
719 NTSYSAPI
720 VOID
721 NTAPI
722 RtlRaiseStatus(
723 _In_ NTSTATUS Status
724 );
725
726 NTSYSAPI
727 LONG
728 NTAPI
729 RtlUnhandledExceptionFilter(
730 _In_ struct _EXCEPTION_POINTERS* ExceptionInfo
731 );
732
733 NTSYSAPI
734 VOID
735 NTAPI
736 RtlUnwind(
737 _In_opt_ PVOID TargetFrame,
738 _In_opt_ PVOID TargetIp,
739 _In_opt_ PEXCEPTION_RECORD ExceptionRecord,
740 _In_ PVOID ReturnValue
741 );
742
743 #define RTL_STACK_WALKING_MODE_FRAMES_TO_SKIP_SHIFT 8
744
745 //
746 // Tracing Functions
747 //
748 NTSYSAPI
749 ULONG
750 NTAPI
751 RtlWalkFrameChain(
752 _Out_writes_(Count - (Flags >> RTL_STACK_WALKING_MODE_FRAMES_TO_SKIP_SHIFT)) PVOID *Callers,
753 _In_ ULONG Count,
754 _In_ ULONG Flags
755 );
756
757 NTSYSAPI
758 USHORT
759 NTAPI
760 RtlLogStackBackTrace(
761 VOID
762 );
763
764 #ifdef NTOS_MODE_USER
765 //
766 // Heap Functions
767 //
768 _Must_inspect_result_
769 _Ret_maybenull_
770 _Post_writable_byte_size_(Size)
771 NTSYSAPI
772 PVOID
773 NTAPI
774 RtlAllocateHeap(
775 _In_ PVOID HeapHandle,
776 _In_opt_ ULONG Flags,
777 _In_ SIZE_T Size
778 );
779
780 _Must_inspect_result_
781 NTSYSAPI
782 PVOID
783 NTAPI
784 RtlCreateHeap(
785 _In_ ULONG Flags,
786 _In_opt_ PVOID BaseAddress,
787 _In_opt_ SIZE_T SizeToReserve,
788 _In_opt_ SIZE_T SizeToCommit,
789 _In_opt_ PVOID Lock,
790 _In_opt_ PRTL_HEAP_PARAMETERS Parameters
791 );
792
793 NTSYSAPI
794 ULONG
795 NTAPI
796 RtlCreateTagHeap(
797 _In_ HANDLE HeapHandle,
798 _In_ ULONG Flags,
799 _In_ PWSTR TagName,
800 _In_ PWSTR TagSubName
801 );
802
803 ULONG
804 NTAPI
805 RtlCompactHeap(
806 _In_ HANDLE Heap,
807 _In_ ULONG Flags
808 );
809
810 _Must_inspect_result_
811 NTSYSAPI
812 PVOID
813 NTAPI
814 RtlDebugCreateHeap(
815 _In_ ULONG Flags,
816 _In_opt_ PVOID BaseAddress,
817 _In_opt_ SIZE_T SizeToReserve,
818 _In_opt_ SIZE_T SizeToCommit,
819 _In_opt_ PVOID Lock,
820 _In_opt_ PRTL_HEAP_PARAMETERS Parameters
821 );
822
823 NTSYSAPI
824 HANDLE
825 NTAPI
826 RtlDestroyHeap(
827 _In_ _Post_invalid_ HANDLE Heap
828 );
829
830 NTSYSAPI
831 ULONG
832 NTAPI
833 RtlExtendHeap(
834 _In_ HANDLE Heap,
835 _In_ ULONG Flags,
836 _In_ PVOID P,
837 _In_ SIZE_T Size
838 );
839
840 _Success_(return != 0)
841 NTSYSAPI
842 BOOLEAN
843 NTAPI
844 RtlFreeHeap(
845 _In_ HANDLE HeapHandle,
846 _In_opt_ ULONG Flags,
847 _In_ _Post_invalid_ PVOID P
848 );
849
850 ULONG
851 NTAPI
852 RtlGetProcessHeaps(
853 _In_ ULONG HeapCount,
854 _Out_cap_(HeapCount) HANDLE *HeapArray
855 );
856
857 _Success_(return != 0)
858 BOOLEAN
859 NTAPI
860 RtlGetUserInfoHeap(
861 _In_ PVOID HeapHandle,
862 _In_ ULONG Flags,
863 _In_ PVOID BaseAddress,
864 _Inout_opt_ PVOID *UserValue,
865 _Out_opt_ PULONG UserFlags
866 );
867
868 NTSYSAPI
869 PVOID
870 NTAPI
871 RtlProtectHeap(
872 _In_ PVOID HeapHandle,
873 _In_ BOOLEAN Protect
874 );
875
876 NTSYSAPI
877 NTSTATUS
878 NTAPI
879 RtlQueryHeapInformation(
880 _In_ PVOID HeapHandle,
881 _In_ HEAP_INFORMATION_CLASS HeapInformationClass,
882 _Out_ PVOID HeapInformation,
883 _In_ SIZE_T HeapInformationLength,
884 _When_(HeapInformationClass==HeapCompatibilityInformation, _On_failure_(_Out_opt_))
885 _Out_opt_ PSIZE_T ReturnLength
886 );
887
888 _Ret_opt_z_
889 NTSYSAPI
890 PWSTR
891 NTAPI
892 RtlQueryTagHeap(
893 _In_ PVOID HeapHandle,
894 _In_ ULONG Flags,
895 _In_ USHORT TagIndex,
896 _In_ BOOLEAN ResetCounters,
897 _Out_ PRTL_HEAP_TAG_INFO HeapTagInfo
898 );
899
900 _Must_inspect_result_
901 _Ret_maybenull_
902 _Post_writable_byte_size_(Size)
903 NTSYSAPI
904 PVOID
905 NTAPI
906 RtlReAllocateHeap(
907 _In_ HANDLE Heap,
908 _In_opt_ ULONG Flags,
909 _In_ _Post_invalid_ PVOID Ptr,
910 _In_ SIZE_T Size
911 );
912
913 NTSYSAPI
914 NTSTATUS
915 NTAPI
916 RtlSetHeapInformation(
917 _In_ PVOID HeapHandle,
918 _In_ HEAP_INFORMATION_CLASS HeapInformationClass,
919 _When_(HeapInformationClass==HeapCompatibilityInformation,_In_) PVOID HeapInformation,
920 _In_ SIZE_T HeapInformationLength
921 );
922
923 NTSYSAPI
924 BOOLEAN
925 NTAPI
926 RtlLockHeap(
927 _In_ HANDLE Heap
928 );
929
930 _Must_inspect_result_
931 NTSYSAPI
932 NTSTATUS
933 NTAPI
934 RtlMultipleAllocateHeap (
935 _In_ HANDLE HeapHandle,
936 _In_ ULONG Flags,
937 _In_ SIZE_T Size,
938 _In_ ULONG Count,
939 _Out_cap_(Count) _Deref_post_bytecap_(Size) PVOID * Array
940 );
941
942 NTSYSAPI
943 NTSTATUS
944 NTAPI
945 RtlMultipleFreeHeap (
946 _In_ HANDLE HeapHandle,
947 _In_ ULONG Flags,
948 _In_ ULONG Count,
949 _In_count_(Count) /* _Deref_ _Post_invalid_ */ PVOID * Array
950 );
951
952 NTSYSAPI
953 NTSTATUS
954 NTAPI
955 RtlUsageHeap(
956 _In_ HANDLE Heap,
957 _In_ ULONG Flags,
958 _Out_ PRTL_HEAP_USAGE Usage
959 );
960
961 NTSYSAPI
962 BOOLEAN
963 NTAPI
964 RtlUnlockHeap(
965 _In_ HANDLE Heap
966 );
967
968 BOOLEAN
969 NTAPI
970 RtlSetUserValueHeap(
971 _In_ PVOID HeapHandle,
972 _In_ ULONG Flags,
973 _In_ PVOID BaseAddress,
974 _In_ PVOID UserValue
975 );
976
977 BOOLEAN
978 NTAPI
979 RtlSetUserFlagsHeap(
980 _In_ PVOID HeapHandle,
981 _In_ ULONG Flags,
982 _In_ PVOID BaseAddress,
983 _In_ ULONG UserFlagsReset,
984 _In_ ULONG UserFlagsSet
985 );
986
987 NTSYSAPI
988 BOOLEAN
989 NTAPI
990 RtlValidateHeap(
991 _In_ HANDLE Heap,
992 _In_ ULONG Flags,
993 _In_opt_ PVOID P
994 );
995
996 NTSYSAPI
997 NTSTATUS
998 NTAPI
999 RtlWalkHeap(
1000 _In_ HANDLE HeapHandle,
1001 _In_ PVOID HeapEntry
1002 );
1003
1004 #define RtlGetProcessHeap() (NtCurrentPeb()->ProcessHeap)
1005
1006 #endif // NTOS_MODE_USER
1007
1008 NTSYSAPI
1009 SIZE_T
1010 NTAPI
1011 RtlSizeHeap(
1012 _In_ PVOID HeapHandle,
1013 _In_ ULONG Flags,
1014 _In_ PVOID MemoryPointer
1015 );
1016
1017
1018 //
1019 // Security Functions
1020 //
1021 _IRQL_requires_max_(APC_LEVEL)
1022 NTSYSAPI
1023 NTSTATUS
1024 NTAPI
1025 RtlAbsoluteToSelfRelativeSD(
1026 _In_ PSECURITY_DESCRIPTOR AbsoluteSecurityDescriptor,
1027 _Out_writes_bytes_to_opt_(*BufferLength, *BufferLength) PSECURITY_DESCRIPTOR SelfRelativeSecurityDescriptor,
1028 _Inout_ PULONG BufferLength
1029 );
1030
1031 _IRQL_requires_max_(APC_LEVEL)
1032 NTSYSAPI
1033 NTSTATUS
1034 NTAPI
1035 RtlAddAccessAllowedAce(
1036 _Inout_ PACL Acl,
1037 _In_ ULONG Revision,
1038 _In_ ACCESS_MASK AccessMask,
1039 _In_ PSID Sid
1040 );
1041
1042 _IRQL_requires_max_(APC_LEVEL)
1043 NTSYSAPI
1044 NTSTATUS
1045 NTAPI
1046 RtlAddAccessAllowedAceEx(
1047 _Inout_ PACL pAcl,
1048 _In_ ULONG dwAceRevision,
1049 _In_ ULONG AceFlags,
1050 _In_ ACCESS_MASK AccessMask,
1051 _In_ PSID pSid
1052 );
1053
1054 NTSYSAPI
1055 NTSTATUS
1056 NTAPI
1057 RtlAddAccessAllowedObjectAce(
1058 _Inout_ PACL pAcl,
1059 _In_ ULONG dwAceRevision,
1060 _In_ ULONG AceFlags,
1061 _In_ ACCESS_MASK AccessMask,
1062 _In_opt_ GUID *ObjectTypeGuid,
1063 _In_opt_ GUID *InheritedObjectTypeGuid,
1064 _In_ PSID pSid
1065 );
1066
1067 NTSYSAPI
1068 NTSTATUS
1069 NTAPI
1070 RtlAddAccessDeniedAce(
1071 _Inout_ PACL Acl,
1072 _In_ ULONG Revision,
1073 _In_ ACCESS_MASK AccessMask,
1074 _In_ PSID Sid
1075 );
1076
1077 NTSYSAPI
1078 NTSTATUS
1079 NTAPI
1080 RtlAddAccessDeniedAceEx(
1081 _Inout_ PACL Acl,
1082 _In_ ULONG Revision,
1083 _In_ ULONG Flags,
1084 _In_ ACCESS_MASK AccessMask,
1085 _In_ PSID Sid
1086 );
1087
1088 NTSYSAPI
1089 NTSTATUS
1090 NTAPI
1091 RtlAddAccessDeniedObjectAce(
1092 _Inout_ PACL pAcl,
1093 _In_ ULONG dwAceRevision,
1094 _In_ ULONG AceFlags,
1095 _In_ ACCESS_MASK AccessMask,
1096 _In_opt_ GUID *ObjectTypeGuid,
1097 _In_opt_ GUID *InheritedObjectTypeGuid,
1098 _In_ PSID pSid
1099 );
1100
1101 NTSYSAPI
1102 NTSTATUS
1103 NTAPI
1104 RtlAddAce(
1105 _Inout_ PACL Acl,
1106 _In_ ULONG AceRevision,
1107 _In_ ULONG StartingAceIndex,
1108 _In_reads_bytes_(AceListLength) PVOID AceList,
1109 _In_ ULONG AceListLength
1110 );
1111
1112 NTSYSAPI
1113 NTSTATUS
1114 NTAPI
1115 RtlAddAuditAccessAce(
1116 _Inout_ PACL Acl,
1117 _In_ ULONG Revision,
1118 _In_ ACCESS_MASK AccessMask,
1119 _In_ PSID Sid,
1120 _In_ BOOLEAN Success,
1121 _In_ BOOLEAN Failure
1122 );
1123
1124 NTSYSAPI
1125 NTSTATUS
1126 NTAPI
1127 RtlAcquirePrivilege(
1128 _In_ PULONG Privilege,
1129 _In_ ULONG NumPriv,
1130 _In_ ULONG Flags,
1131 _Out_ PVOID *ReturnedState
1132 );
1133
1134 NTSYSAPI
1135 NTSTATUS
1136 NTAPI
1137 RtlAddAuditAccessAceEx(
1138 _Inout_ PACL Acl,
1139 _In_ ULONG Revision,
1140 _In_ ULONG Flags,
1141 _In_ ACCESS_MASK AccessMask,
1142 _In_ PSID Sid,
1143 _In_ BOOLEAN Success,
1144 _In_ BOOLEAN Failure
1145 );
1146
1147 NTSYSAPI
1148 NTSTATUS
1149 NTAPI
1150 RtlAddAuditAccessObjectAce(
1151 _Inout_ PACL Acl,
1152 _In_ ULONG Revision,
1153 _In_ ULONG Flags,
1154 _In_ ACCESS_MASK AccessMask,
1155 _In_opt_ GUID *ObjectTypeGuid,
1156 _In_opt_ GUID *InheritedObjectTypeGuid,
1157 _In_ PSID Sid,
1158 _In_ BOOLEAN Success,
1159 _In_ BOOLEAN Failure
1160 );
1161
1162 NTSYSAPI
1163 NTSTATUS
1164 NTAPI
1165 RtlAddMandatoryAce(
1166 _Inout_ PACL Acl,
1167 _In_ ULONG Revision,
1168 _In_ ULONG Flags,
1169 _In_ ULONG MandatoryFlags,
1170 _In_ UCHAR AceType,
1171 _In_ PSID LabelSid);
1172
1173 NTSYSAPI
1174 NTSTATUS
1175 NTAPI
1176 RtlAdjustPrivilege(
1177 _In_ ULONG Privilege,
1178 _In_ BOOLEAN NewValue,
1179 _In_ BOOLEAN ForThread,
1180 _Out_ PBOOLEAN OldValue
1181 );
1182
1183 _Must_inspect_result_
1184 NTSYSAPI
1185 NTSTATUS
1186 NTAPI
1187 RtlAllocateAndInitializeSid(
1188 _In_ PSID_IDENTIFIER_AUTHORITY IdentifierAuthority,
1189 _In_ UCHAR SubAuthorityCount,
1190 _In_ ULONG SubAuthority0,
1191 _In_ ULONG SubAuthority1,
1192 _In_ ULONG SubAuthority2,
1193 _In_ ULONG SubAuthority3,
1194 _In_ ULONG SubAuthority4,
1195 _In_ ULONG SubAuthority5,
1196 _In_ ULONG SubAuthority6,
1197 _In_ ULONG SubAuthority7,
1198 _Outptr_ PSID *Sid
1199 );
1200
1201 NTSYSAPI
1202 BOOLEAN
1203 NTAPI
1204 RtlAreAllAccessesGranted(
1205 ACCESS_MASK GrantedAccess,
1206 ACCESS_MASK DesiredAccess
1207 );
1208
1209 NTSYSAPI
1210 BOOLEAN
1211 NTAPI
1212 RtlAreAnyAccessesGranted(
1213 ACCESS_MASK GrantedAccess,
1214 ACCESS_MASK DesiredAccess
1215 );
1216
1217 _IRQL_requires_max_(APC_LEVEL)
1218 NTSYSAPI
1219 VOID
1220 NTAPI
1221 RtlCopyLuid (
1222 _Out_ PLUID DestinationLuid,
1223 _In_ PLUID SourceLuid
1224 );
1225
1226 NTSYSAPI
1227 VOID
1228 NTAPI
1229 RtlCopyLuidAndAttributesArray(
1230 ULONG Count,
1231 PLUID_AND_ATTRIBUTES Src,
1232 PLUID_AND_ATTRIBUTES Dest
1233 );
1234
1235 NTSYSAPI
1236 NTSTATUS
1237 NTAPI
1238 RtlCopySidAndAttributesArray(
1239 ULONG Count,
1240 PSID_AND_ATTRIBUTES Src,
1241 ULONG SidAreaSize,
1242 PSID_AND_ATTRIBUTES Dest,
1243 PVOID SidArea,
1244 PVOID* RemainingSidArea,
1245 PULONG RemainingSidAreaSize
1246 );
1247
1248 _IRQL_requires_max_(APC_LEVEL)
1249 NTSYSAPI
1250 NTSTATUS
1251 NTAPI
1252 RtlConvertSidToUnicodeString(
1253 _Inout_ PUNICODE_STRING UnicodeString,
1254 _In_ PSID Sid,
1255 _In_ BOOLEAN AllocateDestinationString
1256 );
1257
1258 _IRQL_requires_max_(APC_LEVEL)
1259 NTSYSAPI
1260 NTSTATUS
1261 NTAPI
1262 RtlCopySid(
1263 _In_ ULONG DestinationSidLength,
1264 _Out_writes_bytes_(DestinationSidLength) PSID DestinationSid,
1265 _In_ PSID SourceSid
1266 );
1267
1268 NTSYSAPI
1269 NTSTATUS
1270 NTAPI
1271 RtlCreateAcl(
1272 PACL Acl,
1273 ULONG AclSize,
1274 ULONG AclRevision
1275 );
1276
1277 NTSYSAPI
1278 NTSTATUS
1279 NTAPI
1280 RtlCreateSecurityDescriptor(
1281 _Out_ PSECURITY_DESCRIPTOR SecurityDescriptor,
1282 _In_ ULONG Revision
1283 );
1284
1285 NTSYSAPI
1286 NTSTATUS
1287 NTAPI
1288 RtlCreateSecurityDescriptorRelative(
1289 _Out_ PISECURITY_DESCRIPTOR_RELATIVE SecurityDescriptor,
1290 _In_ ULONG Revision
1291 );
1292
1293 NTSYSAPI
1294 NTSTATUS
1295 NTAPI
1296 RtlCopySecurityDescriptor(
1297 _In_ PSECURITY_DESCRIPTOR pSourceSecurityDescriptor,
1298 _Out_ PSECURITY_DESCRIPTOR *pDestinationSecurityDescriptor
1299 );
1300
1301 NTSYSAPI
1302 NTSTATUS
1303 NTAPI
1304 RtlDeleteAce(
1305 PACL Acl,
1306 ULONG AceIndex
1307 );
1308
1309 NTSYSAPI
1310 BOOLEAN
1311 NTAPI
1312 RtlEqualPrefixSid(
1313 PSID Sid1,
1314 PSID Sid2
1315 );
1316
1317 NTSYSAPI
1318 BOOLEAN
1319 NTAPI
1320 RtlEqualSid (
1321 _In_ PSID Sid1,
1322 _In_ PSID Sid2
1323 );
1324
1325 NTSYSAPI
1326 BOOLEAN
1327 NTAPI
1328 RtlFirstFreeAce(
1329 PACL Acl,
1330 PACE* Ace
1331 );
1332
1333 NTSYSAPI
1334 PVOID
1335 NTAPI
1336 RtlFreeSid(
1337 _In_ _Post_invalid_ PSID Sid
1338 );
1339
1340 NTSYSAPI
1341 NTSTATUS
1342 NTAPI
1343 RtlGetAce(
1344 PACL Acl,
1345 ULONG AceIndex,
1346 PVOID *Ace
1347 );
1348
1349 NTSYSAPI
1350 NTSTATUS
1351 NTAPI
1352 RtlGetControlSecurityDescriptor(
1353 _In_ PSECURITY_DESCRIPTOR SecurityDescriptor,
1354 _Out_ PSECURITY_DESCRIPTOR_CONTROL Control,
1355 _Out_ PULONG Revision
1356 );
1357
1358 NTSYSAPI
1359 NTSTATUS
1360 NTAPI
1361 RtlGetDaclSecurityDescriptor(
1362 _In_ PSECURITY_DESCRIPTOR SecurityDescriptor,
1363 _Out_ PBOOLEAN DaclPresent,
1364 _Out_ PACL *Dacl,
1365 _Out_ PBOOLEAN DaclDefaulted
1366 );
1367
1368 NTSYSAPI
1369 NTSTATUS
1370 NTAPI
1371 RtlGetSaclSecurityDescriptor(
1372 _In_ PSECURITY_DESCRIPTOR SecurityDescriptor,
1373 _Out_ PBOOLEAN SaclPresent,
1374 _Out_ PACL* Sacl,
1375 _Out_ PBOOLEAN SaclDefaulted
1376 );
1377
1378 NTSYSAPI
1379 NTSTATUS
1380 NTAPI
1381 RtlGetGroupSecurityDescriptor(
1382 _In_ PSECURITY_DESCRIPTOR SecurityDescriptor,
1383 _Out_ PSID *Group,
1384 _Out_ PBOOLEAN GroupDefaulted
1385 );
1386
1387 NTSYSAPI
1388 NTSTATUS
1389 NTAPI
1390 RtlGetOwnerSecurityDescriptor(
1391 _In_ PSECURITY_DESCRIPTOR SecurityDescriptor,
1392 _Out_ PSID *Owner,
1393 _Out_ PBOOLEAN OwnerDefaulted
1394 );
1395
1396 NTSYSAPI
1397 BOOLEAN
1398 NTAPI
1399 RtlGetSecurityDescriptorRMControl(
1400 _In_ PSECURITY_DESCRIPTOR SecurityDescriptor,
1401 _Out_ PUCHAR RMControl
1402 );
1403
1404 NTSYSAPI
1405 PSID_IDENTIFIER_AUTHORITY
1406 NTAPI
1407 RtlIdentifierAuthoritySid(PSID Sid);
1408
1409 NTSYSAPI
1410 NTSTATUS
1411 NTAPI
1412 RtlImpersonateSelf(IN SECURITY_IMPERSONATION_LEVEL ImpersonationLevel);
1413
1414 _IRQL_requires_max_(APC_LEVEL)
1415 NTSYSAPI
1416 NTSTATUS
1417 NTAPI
1418 RtlInitializeSid(
1419 _Out_ PSID Sid,
1420 _In_ PSID_IDENTIFIER_AUTHORITY IdentifierAuthority,
1421 _In_ UCHAR SubAuthorityCount
1422 );
1423
1424 NTSYSAPI
1425 ULONG
1426 NTAPI
1427 RtlLengthRequiredSid(IN ULONG SubAuthorityCount);
1428
1429 NTSYSAPI
1430 ULONG
1431 NTAPI
1432 RtlLengthSid(IN PSID Sid);
1433
1434 NTSYSAPI
1435 NTSTATUS
1436 NTAPI
1437 RtlMakeSelfRelativeSD(
1438 _In_ PSECURITY_DESCRIPTOR AbsoluteSD,
1439 _Out_ PSECURITY_DESCRIPTOR SelfRelativeSD,
1440 _Inout_ PULONG BufferLength);
1441
1442 NTSYSAPI
1443 VOID
1444 NTAPI
1445 RtlMapGenericMask(
1446 PACCESS_MASK AccessMask,
1447 PGENERIC_MAPPING GenericMapping
1448 );
1449
1450 #ifdef NTOS_MODE_USER
1451
1452 NTSYSAPI
1453 NTSTATUS
1454 NTAPI
1455 RtlQueryInformationAcl(
1456 PACL Acl,
1457 PVOID Information,
1458 ULONG InformationLength,
1459 ACL_INFORMATION_CLASS InformationClass
1460 );
1461
1462 #endif
1463
1464 NTSYSAPI
1465 VOID
1466 NTAPI
1467 RtlReleasePrivilege(
1468 _In_ PVOID ReturnedState
1469 );
1470
1471 _IRQL_requires_max_(APC_LEVEL)
1472 NTSYSAPI
1473 NTSTATUS
1474 NTAPI
1475 RtlSelfRelativeToAbsoluteSD(
1476 _In_ PSECURITY_DESCRIPTOR SelfRelativeSecurityDescriptor,
1477 _Out_writes_bytes_to_opt_(*AbsoluteSecurityDescriptorSize, *AbsoluteSecurityDescriptorSize) PSECURITY_DESCRIPTOR AbsoluteSecurityDescriptor,
1478 _Inout_ PULONG AbsoluteSecurityDescriptorSize,
1479 _Out_writes_bytes_to_opt_(*DaclSize, *DaclSize) PACL Dacl,
1480 _Inout_ PULONG DaclSize,
1481 _Out_writes_bytes_to_opt_(*SaclSize, *SaclSize) PACL Sacl,
1482 _Inout_ PULONG SaclSize,
1483 _Out_writes_bytes_to_opt_(*OwnerSize, *OwnerSize) PSID Owner,
1484 _Inout_ PULONG OwnerSize,
1485 _Out_writes_bytes_to_opt_(*PrimaryGroupSize, *PrimaryGroupSize) PSID PrimaryGroup,
1486 _Inout_ PULONG PrimaryGroupSize
1487 );
1488
1489 NTSYSAPI
1490 NTSTATUS
1491 NTAPI
1492 RtlSelfRelativeToAbsoluteSD2(
1493 _Inout_ PSECURITY_DESCRIPTOR SelfRelativeSD,
1494 _Out_ PULONG BufferSize
1495 );
1496
1497 NTSYSAPI
1498 NTSTATUS
1499 NTAPI
1500 RtlSetAttributesSecurityDescriptor(
1501 _Inout_ PSECURITY_DESCRIPTOR SecurityDescriptor,
1502 _In_ SECURITY_DESCRIPTOR_CONTROL Control,
1503 _Out_ PULONG Revision
1504 );
1505
1506 NTSYSAPI
1507 NTSTATUS
1508 NTAPI
1509 RtlSetControlSecurityDescriptor(
1510 _In_ PSECURITY_DESCRIPTOR SecurityDescriptor,
1511 _In_ SECURITY_DESCRIPTOR_CONTROL ControlBitsOfInterest,
1512 _In_ SECURITY_DESCRIPTOR_CONTROL ControlBitsToSet
1513 );
1514
1515 _IRQL_requires_max_(APC_LEVEL)
1516 NTSYSAPI
1517 NTSTATUS
1518 NTAPI
1519 RtlSetDaclSecurityDescriptor(
1520 _Inout_ PSECURITY_DESCRIPTOR SecurityDescriptor,
1521 _In_ BOOLEAN DaclPresent,
1522 _In_opt_ PACL Dacl,
1523 _In_opt_ BOOLEAN DaclDefaulted
1524 );
1525
1526 _IRQL_requires_max_(APC_LEVEL)
1527 NTSYSAPI
1528 NTSTATUS
1529 NTAPI
1530 RtlSetGroupSecurityDescriptor(
1531 _Inout_ PSECURITY_DESCRIPTOR SecurityDescriptor,
1532 _In_opt_ PSID Group,
1533 _In_opt_ BOOLEAN GroupDefaulted
1534 );
1535
1536 #ifdef NTOS_MODE_USER
1537
1538 NTSYSAPI
1539 NTSTATUS
1540 NTAPI
1541 RtlSetInformationAcl(
1542 PACL Acl,
1543 PVOID Information,
1544 ULONG InformationLength,
1545 ACL_INFORMATION_CLASS InformationClass
1546 );
1547
1548 #endif
1549
1550 _IRQL_requires_max_(APC_LEVEL)
1551 NTSYSAPI
1552 NTSTATUS
1553 NTAPI
1554 RtlSetOwnerSecurityDescriptor(
1555 _Inout_ PSECURITY_DESCRIPTOR SecurityDescriptor,
1556 _In_opt_ PSID Owner,
1557 _In_opt_ BOOLEAN OwnerDefaulted
1558 );
1559
1560 NTSYSAPI
1561 NTSTATUS
1562 NTAPI
1563 RtlSetSaclSecurityDescriptor(
1564 _Inout_ PSECURITY_DESCRIPTOR SecurityDescriptor,
1565 _In_ BOOLEAN SaclPresent,
1566 _In_ PACL Sacl,
1567 _In_ BOOLEAN SaclDefaulted
1568 );
1569
1570 NTSYSAPI
1571 VOID
1572 NTAPI
1573 RtlSetSecurityDescriptorRMControl(
1574 _Inout_ PSECURITY_DESCRIPTOR SecurityDescriptor,
1575 _In_ PUCHAR RMControl
1576 );
1577
1578 NTSYSAPI
1579 PUCHAR
1580 NTAPI
1581 RtlSubAuthorityCountSid(
1582 _In_ PSID Sid
1583 );
1584
1585 NTSYSAPI
1586 PULONG
1587 NTAPI
1588 RtlSubAuthoritySid(
1589 _In_ PSID Sid,
1590 _In_ ULONG SubAuthority
1591 );
1592
1593 _IRQL_requires_max_(APC_LEVEL)
1594 _Must_inspect_result_
1595 NTSYSAPI
1596 BOOLEAN
1597 NTAPI
1598 RtlValidRelativeSecurityDescriptor(
1599 _In_reads_bytes_(SecurityDescriptorLength) PSECURITY_DESCRIPTOR SecurityDescriptorInput,
1600 _In_ ULONG SecurityDescriptorLength,
1601 _In_ SECURITY_INFORMATION RequiredInformation
1602 );
1603
1604 NTSYSAPI
1605 BOOLEAN
1606 NTAPI
1607 RtlValidSecurityDescriptor(IN PSECURITY_DESCRIPTOR SecurityDescriptor);
1608
1609 NTSYSAPI
1610 BOOLEAN
1611 NTAPI
1612 RtlValidSid(IN PSID Sid);
1613
1614 NTSYSAPI
1615 BOOLEAN
1616 NTAPI
1617 RtlValidAcl(PACL Acl);
1618
1619 NTSYSAPI
1620 NTSTATUS
1621 NTAPI
1622 RtlDeleteSecurityObject(
1623 _In_ PSECURITY_DESCRIPTOR *ObjectDescriptor
1624 );
1625
1626 NTSYSAPI
1627 NTSTATUS
1628 NTAPI
1629 RtlNewSecurityObject(
1630 _In_ PSECURITY_DESCRIPTOR ParentDescriptor,
1631 _In_ PSECURITY_DESCRIPTOR CreatorDescriptor,
1632 _Out_ PSECURITY_DESCRIPTOR *NewDescriptor,
1633 _In_ BOOLEAN IsDirectoryObject,
1634 _In_ HANDLE Token,
1635 _In_ PGENERIC_MAPPING GenericMapping
1636 );
1637
1638 NTSYSAPI
1639 NTSTATUS
1640 NTAPI
1641 RtlQuerySecurityObject(
1642 _In_ PSECURITY_DESCRIPTOR ObjectDescriptor,
1643 _In_ SECURITY_INFORMATION SecurityInformation,
1644 _Out_ PSECURITY_DESCRIPTOR ResultantDescriptor,
1645 _In_ ULONG DescriptorLength,
1646 _Out_ PULONG ReturnLength
1647 );
1648
1649 NTSYSAPI
1650 NTSTATUS
1651 NTAPI
1652 RtlSetSecurityObject(
1653 _In_ SECURITY_INFORMATION SecurityInformation,
1654 _In_ PSECURITY_DESCRIPTOR ModificationDescriptor,
1655 _Out_ PSECURITY_DESCRIPTOR *ObjectsSecurityDescriptor,
1656 _In_ PGENERIC_MAPPING GenericMapping,
1657 _In_ HANDLE Token
1658 );
1659
1660 //
1661 // Single-Character Functions
1662 //
1663 NTSYSAPI
1664 NTSTATUS
1665 NTAPI
1666 RtlLargeIntegerToChar(
1667 _In_ PLARGE_INTEGER Value,
1668 _In_ ULONG Base,
1669 _In_ ULONG Length,
1670 _Out_ PCHAR String
1671 );
1672
1673 NTSYSAPI
1674 CHAR
1675 NTAPI
1676 RtlUpperChar(CHAR Source);
1677
1678 NTSYSAPI
1679 WCHAR
1680 NTAPI
1681 RtlUpcaseUnicodeChar(WCHAR Source);
1682
1683 NTSYSAPI
1684 WCHAR
1685 NTAPI
1686 RtlDowncaseUnicodeChar(IN WCHAR Source);
1687
1688 NTSYSAPI
1689 NTSTATUS
1690 NTAPI
1691 RtlIntegerToChar(
1692 _In_ ULONG Value,
1693 _In_ ULONG Base,
1694 _In_ ULONG Length,
1695 _Out_ PCHAR String
1696 );
1697
1698 NTSYSAPI
1699 NTSTATUS
1700 NTAPI
1701 RtlIntegerToUnicode(
1702 _In_ ULONG Value,
1703 _In_opt_ ULONG Base,
1704 _In_opt_ ULONG Length,
1705 _Inout_ LPWSTR String
1706 );
1707
1708 _IRQL_requires_max_(PASSIVE_LEVEL)
1709 _At_(String->MaximumLength, _Const_)
1710 NTSYSAPI
1711 NTSTATUS
1712 NTAPI
1713 RtlIntegerToUnicodeString(
1714 _In_ ULONG Value,
1715 _In_opt_ ULONG Base,
1716 _Inout_ PUNICODE_STRING String
1717 );
1718
1719 NTSYSAPI
1720 NTSTATUS
1721 NTAPI
1722 RtlCharToInteger(
1723 PCSZ String,
1724 ULONG Base,
1725 PULONG Value
1726 );
1727
1728 //
1729 // Byte Swap Functions
1730 //
1731 #ifdef NTOS_MODE_USER
1732
1733 #if (defined(_M_IX86) && (_MSC_FULL_VER > 13009037)) || \
1734 ((defined(_M_AMD64) || \
1735 defined(_M_IA64)) && (_MSC_FULL_VER > 13009175))
1736
1737 unsigned short __cdecl _byteswap_ushort(unsigned short);
1738 unsigned long __cdecl _byteswap_ulong (unsigned long);
1739 unsigned __int64 __cdecl _byteswap_uint64(unsigned __int64);
1740 #pragma intrinsic(_byteswap_ushort)
1741 #pragma intrinsic(_byteswap_ulong)
1742 #pragma intrinsic(_byteswap_uint64)
1743 #define RtlUshortByteSwap(_x) _byteswap_ushort((USHORT)(_x))
1744 #define RtlUlongByteSwap(_x) _byteswap_ulong((_x))
1745 #define RtlUlonglongByteSwap(_x) _byteswap_uint64((_x))
1746
1747 #elif defined (__GNUC__)
1748
1749 #define RtlUshortByteSwap(_x) _byteswap_ushort((USHORT)(_x))
1750 #define RtlUlongByteSwap(_x) _byteswap_ulong((_x))
1751 #define RtlUlonglongByteSwap(_x) _byteswap_uint64((_x))
1752
1753 #else
1754
1755 #if (NTDDI_VERSION >= NTDDI_WIN2K)
1756 NTSYSAPI
1757 USHORT
1758 FASTCALL
1759 RtlUshortByteSwap(IN USHORT Source);
1760
1761 NTSYSAPI
1762 ULONG
1763 FASTCALL
1764 RtlUlongByteSwap(IN ULONG Source);
1765
1766 NTSYSAPI
1767 ULONGLONG
1768 FASTCALL
1769 RtlUlonglongByteSwap(IN ULONGLONG Source);
1770 #endif
1771
1772 #endif
1773 #endif // NTOS_MODE_USER
1774
1775 //
1776 // Unicode->Ansi String Functions
1777 //
1778 NTSYSAPI
1779 ULONG
1780 NTAPI
1781 RtlxUnicodeStringToAnsiSize(IN PCUNICODE_STRING UnicodeString);
1782
1783 #ifdef NTOS_MODE_USER
1784
1785 #define RtlUnicodeStringToAnsiSize(STRING) ( \
1786 NLS_MB_CODE_PAGE_TAG ? \
1787 RtlxUnicodeStringToAnsiSize(STRING) : \
1788 ((STRING)->Length + sizeof(UNICODE_NULL)) / sizeof(WCHAR) \
1789 )
1790
1791 #endif
1792
1793 NTSYSAPI
1794 NTSTATUS
1795 NTAPI
1796 RtlUnicodeStringToAnsiString(
1797 PANSI_STRING DestinationString,
1798 PCUNICODE_STRING SourceString,
1799 BOOLEAN AllocateDestinationString
1800 );
1801
1802 //
1803 // Unicode->OEM String Functions
1804 //
1805 NTSYSAPI
1806 NTSTATUS
1807 NTAPI
1808 RtlUpcaseUnicodeStringToOemString(
1809 POEM_STRING DestinationString,
1810 PCUNICODE_STRING SourceString,
1811 BOOLEAN AllocateDestinationString
1812 );
1813
1814 _IRQL_requires_max_(PASSIVE_LEVEL)
1815 _Must_inspect_result_
1816 //_At_(DestinationString->Buffer, _Post_bytecount_(DestinationString->Length))
1817 NTSYSAPI
1818 NTSTATUS
1819 NTAPI
1820 RtlUpcaseUnicodeStringToCountedOemString(
1821 _When_(AllocateDestinationString, _Out_ _At_(DestinationString->Buffer, __drv_allocatesMem(Mem)))
1822 _When_(!AllocateDestinationString, _Inout_)
1823 POEM_STRING DestinationString,
1824 _In_ PCUNICODE_STRING SourceString,
1825 _In_ BOOLEAN AllocateDestinationString
1826 );
1827
1828 NTSYSAPI
1829 NTSTATUS
1830 NTAPI
1831 RtlUnicodeStringToOemString(
1832 POEM_STRING DestinationString,
1833 PCUNICODE_STRING SourceString,
1834 BOOLEAN AllocateDestinationString
1835 );
1836
1837 NTSYSAPI
1838 NTSTATUS
1839 NTAPI
1840 RtlUpcaseUnicodeToOemN(
1841 PCHAR OemString,
1842 ULONG OemSize,
1843 PULONG ResultSize,
1844 PCWCH UnicodeString,
1845 ULONG UnicodeSize
1846 );
1847
1848 NTSYSAPI
1849 ULONG
1850 NTAPI
1851 RtlxUnicodeStringToOemSize(IN PCUNICODE_STRING UnicodeString);
1852
1853 #ifdef NTOS_MODE_USER
1854
1855 #define RtlUnicodeStringToOemSize(STRING) ( \
1856 NLS_MB_OEM_CODE_PAGE_TAG ? \
1857 RtlxUnicodeStringToOemSize(STRING) : \
1858 ((STRING)->Length + sizeof(UNICODE_NULL)) / sizeof(WCHAR) \
1859 )
1860
1861 #define RtlUnicodeStringToCountedOemSize(STRING) ( \
1862 (ULONG)(RtlUnicodeStringToOemSize(STRING) - sizeof(ANSI_NULL)) \
1863 )
1864
1865 #endif
1866
1867 NTSYSAPI
1868 NTSTATUS
1869 NTAPI
1870 RtlUnicodeToOemN(
1871 PCHAR OemString,
1872 ULONG OemSize,
1873 PULONG ResultSize,
1874 PCWCH UnicodeString,
1875 ULONG UnicodeSize
1876 );
1877
1878 //
1879 // Unicode->MultiByte String Functions
1880 //
1881 NTSYSAPI
1882 NTSTATUS
1883 NTAPI
1884 RtlUnicodeToMultiByteN(
1885 PCHAR MbString,
1886 ULONG MbSize,
1887 PULONG ResultSize,
1888 PCWCH UnicodeString,
1889 ULONG UnicodeSize
1890 );
1891
1892 NTSYSAPI
1893 NTSTATUS
1894 NTAPI
1895 RtlUpcaseUnicodeToMultiByteN(
1896 PCHAR MbString,
1897 ULONG MbSize,
1898 PULONG ResultSize,
1899 PCWCH UnicodeString,
1900 ULONG UnicodeSize
1901 );
1902
1903 NTSYSAPI
1904 NTSTATUS
1905 NTAPI
1906 RtlUnicodeToMultiByteSize(
1907 PULONG MbSize,
1908 PCWCH UnicodeString,
1909 ULONG UnicodeSize
1910 );
1911
1912 NTSYSAPI
1913 ULONG
1914 NTAPI
1915 RtlxOemStringToUnicodeSize(IN PCOEM_STRING OemString);
1916
1917 //
1918 // OEM to Unicode Functions
1919 //
1920 NTSYSAPI
1921 NTSTATUS
1922 NTAPI
1923 RtlOemStringToUnicodeString(
1924 PUNICODE_STRING DestinationString,
1925 PCOEM_STRING SourceString,
1926 BOOLEAN AllocateDestinationString
1927 );
1928
1929 _IRQL_requires_max_(PASSIVE_LEVEL)
1930 NTSYSAPI
1931 NTSTATUS
1932 NTAPI
1933 RtlOemToUnicodeN(
1934 _Out_writes_bytes_to_(MaxBytesInUnicodeString, *BytesInUnicodeString) PWCH UnicodeString,
1935 _In_ ULONG MaxBytesInUnicodeString,
1936 _Out_opt_ PULONG BytesInUnicodeString,
1937 _In_reads_bytes_(BytesInOemString) PCCH OemString,
1938 _In_ ULONG BytesInOemString
1939 );
1940
1941 #ifdef NTOS_MODE_USER
1942
1943 #define RtlOemStringToUnicodeSize(STRING) ( \
1944 NLS_MB_OEM_CODE_PAGE_TAG ? \
1945 RtlxOemStringToUnicodeSize(STRING) : \
1946 ((STRING)->Length + sizeof(ANSI_NULL)) * sizeof(WCHAR) \
1947 )
1948
1949 #define RtlOemStringToCountedUnicodeSize(STRING) ( \
1950 (ULONG)(RtlOemStringToUnicodeSize(STRING) - sizeof(UNICODE_NULL)) \
1951 )
1952
1953 #endif
1954
1955 //
1956 // Ansi->Unicode String Functions
1957 //
1958 NTSYSAPI
1959 ULONG
1960 NTAPI
1961 RtlxAnsiStringToUnicodeSize(
1962 PCANSI_STRING AnsiString
1963 );
1964
1965 NTSYSAPI
1966 NTSTATUS
1967 NTAPI
1968 RtlAnsiStringToUnicodeString(
1969 PUNICODE_STRING DestinationString,
1970 PCANSI_STRING SourceString,
1971 BOOLEAN AllocateDestinationString
1972 );
1973
1974 #ifdef NTOS_MODE_USER
1975
1976 #define RtlAnsiStringToUnicodeSize(STRING) ( \
1977 NLS_MB_CODE_PAGE_TAG ? \
1978 RtlxAnsiStringToUnicodeSize(STRING) : \
1979 ((STRING)->Length + sizeof(ANSI_NULL)) * sizeof(WCHAR) \
1980 )
1981
1982 #endif
1983
1984 NTSYSAPI
1985 BOOLEAN
1986 NTAPI
1987 RtlCreateUnicodeStringFromAsciiz(
1988 _Out_ PUNICODE_STRING Destination,
1989 _In_ PCSZ Source
1990 );
1991
1992 //
1993 // Unicode String Functions
1994 //
1995 NTSYSAPI
1996 NTSTATUS
1997 NTAPI
1998 RtlAppendUnicodeToString(
1999 PUNICODE_STRING Destination,
2000 PCWSTR Source
2001 );
2002
2003 NTSYSAPI
2004 NTSTATUS
2005 NTAPI
2006 RtlAppendUnicodeStringToString(
2007 PUNICODE_STRING Destination,
2008 PCUNICODE_STRING Source
2009 );
2010
2011 NTSYSAPI
2012 LONG
2013 NTAPI
2014 RtlCompareUnicodeString(
2015 PCUNICODE_STRING String1,
2016 PCUNICODE_STRING String2,
2017 BOOLEAN CaseInsensitive
2018 );
2019
2020 NTSYSAPI
2021 VOID
2022 NTAPI
2023 RtlCopyUnicodeString(
2024 PUNICODE_STRING DestinationString,
2025 PCUNICODE_STRING SourceString
2026 );
2027
2028 NTSYSAPI
2029 BOOLEAN
2030 NTAPI
2031 RtlCreateUnicodeString(
2032 PUNICODE_STRING DestinationString,
2033 PCWSTR SourceString
2034 );
2035
2036 #ifdef NTOS_MODE_USER
2037
2038 NTSYSAPI
2039 NTSTATUS
2040 NTAPI
2041 RtlDowncaseUnicodeString(
2042 _Inout_ PUNICODE_STRING UniDest,
2043 _In_ PCUNICODE_STRING UniSource,
2044 _In_ BOOLEAN AllocateDestinationString
2045 );
2046
2047 NTSYSAPI
2048 NTSTATUS
2049 NTAPI
2050 RtlDuplicateUnicodeString(
2051 _In_ ULONG Flags,
2052 _In_ PCUNICODE_STRING SourceString,
2053 _Out_ PUNICODE_STRING DestinationString
2054 );
2055
2056 //
2057 // Memory Functions
2058 //
2059 NTSYSAPI
2060 VOID
2061 NTAPI
2062 RtlFillMemoryUlong(
2063 _In_ PVOID Destination,
2064 _In_ SIZE_T Length,
2065 _In_ ULONG Fill
2066 );
2067
2068 NTSYSAPI
2069 VOID
2070 NTAPI
2071 RtlFillMemoryUlonglong(
2072 _Out_ PVOID Destination,
2073 _In_ SIZE_T Length,
2074 _In_ ULONGLONG Pattern
2075 );
2076
2077
2078 NTSYSAPI
2079 SIZE_T
2080 NTAPI
2081 RtlCompareMemoryUlong(
2082 _In_ PVOID Source,
2083 _In_ SIZE_T Length,
2084 _In_ ULONG Pattern
2085 );
2086
2087 #define RtlEqualMemory(Destination, Source, Length) \
2088 (!memcmp(Destination, Source, Length))
2089
2090 #define RtlCopyBytes RtlCopyMemory
2091 #define RtlFillBytes RtlFillMemory
2092 #define RtlZeroBytes RtlZeroMemory
2093
2094 #endif
2095
2096 NTSYSAPI
2097 BOOLEAN
2098 NTAPI
2099 RtlEqualUnicodeString(
2100 PCUNICODE_STRING String1,
2101 PCUNICODE_STRING String2,
2102 BOOLEAN CaseInsensitive
2103 );
2104
2105 NTSYSAPI
2106 NTSTATUS
2107 NTAPI
2108 RtlFindCharInUnicodeString(
2109 _In_ ULONG Flags,
2110 _In_ PCUNICODE_STRING SearchString,
2111 _In_ PCUNICODE_STRING MatchString,
2112 _Out_ PUSHORT Position
2113 );
2114
2115 NTSYSAPI
2116 VOID
2117 NTAPI
2118 RtlFreeUnicodeString(IN PUNICODE_STRING UnicodeString);
2119
2120 NTSYSAPI
2121 NTSTATUS
2122 NTAPI
2123 RtlHashUnicodeString(
2124 _In_ CONST UNICODE_STRING *String,
2125 _In_ BOOLEAN CaseInSensitive,
2126 _In_ ULONG HashAlgorithm,
2127 _Out_ PULONG HashValue
2128 );
2129
2130 _IRQL_requires_max_(DISPATCH_LEVEL)
2131 _At_(DestinationString->Buffer, _Post_equal_to_(SourceString))
2132 _When_(SourceString != NULL,
2133 _At_(DestinationString->Length, _Post_equal_to_(_String_length_(SourceString) * sizeof(WCHAR)))
2134 _At_(DestinationString->MaximumLength, _Post_equal_to_(DestinationString->Length + sizeof(WCHAR))))
2135 _When_(SourceString == NULL,
2136 _At_(DestinationString->Length, _Post_equal_to_(0))
2137 _At_(DestinationString->MaximumLength, _Post_equal_to_(0)))
2138 NTSYSAPI
2139 VOID
2140 NTAPI
2141 RtlInitUnicodeString(
2142 _Out_ PUNICODE_STRING DestinationString,
2143 _In_opt_z_ __drv_aliasesMem PCWSTR SourceString
2144 );
2145
2146 _IRQL_requires_max_(DISPATCH_LEVEL)
2147 NTSYSAPI
2148 NTSTATUS
2149 NTAPI
2150 RtlInitUnicodeStringEx(
2151 _Out_ PUNICODE_STRING DestinationString,
2152 _In_opt_z_ __drv_aliasesMem PCWSTR SourceString
2153 );
2154
2155 NTSYSAPI
2156 BOOLEAN
2157 NTAPI
2158 RtlIsTextUnicode(
2159 PVOID Buffer,
2160 INT Length,
2161 INT *Flags
2162 );
2163
2164 _IRQL_requires_max_(PASSIVE_LEVEL)
2165 _Must_inspect_result_
2166 NTSYSAPI
2167 BOOLEAN
2168 NTAPI
2169 RtlPrefixString(
2170 _In_ const STRING *String1,
2171 _In_ const STRING *String2,
2172 _In_ BOOLEAN CaseInsensitive
2173 );
2174
2175 _IRQL_requires_max_(PASSIVE_LEVEL)
2176 _Must_inspect_result_
2177 NTSYSAPI
2178 BOOLEAN
2179 NTAPI
2180 RtlPrefixUnicodeString(
2181 _In_ PCUNICODE_STRING String1,
2182 _In_ PCUNICODE_STRING String2,
2183 _In_ BOOLEAN CaseInsensitive
2184 );
2185
2186 _IRQL_requires_max_(PASSIVE_LEVEL)
2187 NTSYSAPI
2188 VOID
2189 NTAPI
2190 RtlUpperString(
2191 _Inout_ PSTRING DestinationString,
2192 _In_ const STRING *SourceString
2193 );
2194
2195 _IRQL_requires_max_(PASSIVE_LEVEL)
2196 _Must_inspect_result_
2197 NTSYSAPI
2198 LONG
2199 NTAPI
2200 RtlCompareString(
2201 _In_ const STRING *String1,
2202 _In_ const STRING *String2,
2203 _In_ BOOLEAN CaseInSensitive
2204 );
2205
2206 NTSYSAPI
2207 VOID
2208 NTAPI
2209 RtlCopyString(
2210 _Out_ PSTRING DestinationString,
2211 _In_opt_ const STRING *SourceString
2212 );
2213
2214 _IRQL_requires_max_(PASSIVE_LEVEL)
2215 _Must_inspect_result_
2216 NTSYSAPI
2217 BOOLEAN
2218 NTAPI
2219 RtlEqualString(
2220 _In_ const STRING *String1,
2221 _In_ const STRING *String2,
2222 _In_ BOOLEAN CaseInSensitive
2223 );
2224
2225 _IRQL_requires_max_(APC_LEVEL)
2226 NTSYSAPI
2227 NTSTATUS
2228 NTAPI
2229 RtlAppendStringToString(
2230 _Inout_ PSTRING Destination,
2231 _In_ const STRING *Source
2232 );
2233
2234 _IRQL_requires_max_(PASSIVE_LEVEL)
2235 _When_(AllocateDestinationString, _Must_inspect_result_)
2236 NTSYSAPI
2237 NTSTATUS
2238 NTAPI
2239 RtlUpcaseUnicodeString(
2240 _When_(AllocateDestinationString, _Out_ _At_(DestinationString->Buffer, __drv_allocatesMem(Mem)))
2241 _When_(!AllocateDestinationString, _Inout_)
2242 PUNICODE_STRING DestinationString,
2243 _In_ PCUNICODE_STRING SourceString,
2244 _In_ BOOLEAN AllocateDestinationString
2245 );
2246
2247 _IRQL_requires_max_(PASSIVE_LEVEL)
2248 NTSYSAPI
2249 NTSTATUS
2250 NTAPI
2251 RtlUnicodeStringToInteger(
2252 _In_ PCUNICODE_STRING String,
2253 _In_opt_ ULONG Base,
2254 _Out_ PULONG Value
2255 );
2256
2257 NTSYSAPI
2258 NTSTATUS
2259 NTAPI
2260 RtlValidateUnicodeString(
2261 _In_ ULONG Flags,
2262 _In_ PCUNICODE_STRING String
2263 );
2264
2265 //
2266 // Ansi String Functions
2267 //
2268 _IRQL_requires_max_(PASSIVE_LEVEL)
2269 NTSYSAPI
2270 VOID
2271 NTAPI
2272 RtlFreeAnsiString(
2273 _Inout_ _At_(AnsiString->Buffer, __drv_freesMem(Mem))
2274 PANSI_STRING AnsiString
2275 );
2276
2277 _IRQL_requires_max_(DISPATCH_LEVEL)
2278 NTSYSAPI
2279 VOID
2280 NTAPI
2281 RtlInitAnsiString(
2282 _Out_ PANSI_STRING DestinationString,
2283 _In_opt_z_ __drv_aliasesMem PCSZ SourceString
2284 );
2285
2286 _IRQL_requires_max_(DISPATCH_LEVEL)
2287 NTSYSAPI
2288 NTSTATUS
2289 NTAPI
2290 RtlInitAnsiStringEx(
2291 _Out_ PANSI_STRING DestinationString,
2292 _In_opt_z_ __drv_aliasesMem PCSZ SourceString
2293 );
2294
2295 //
2296 // OEM String Functions
2297 //
2298 _IRQL_requires_max_(PASSIVE_LEVEL)
2299 NTSYSAPI
2300 VOID
2301 NTAPI
2302 RtlFreeOemString(
2303 _Inout_ _At_(OemString->Buffer, __drv_freesMem(Mem))
2304 POEM_STRING OemString
2305 );
2306
2307 //
2308 // MultiByte->Unicode String Functions
2309 //
2310 _IRQL_requires_max_(PASSIVE_LEVEL)
2311 NTSYSAPI
2312 NTSTATUS
2313 NTAPI
2314 RtlMultiByteToUnicodeN(
2315 _Out_writes_bytes_to_(MaxBytesInUnicodeString, *BytesInUnicodeString) PWCH UnicodeString,
2316 _In_ ULONG MaxBytesInUnicodeString,
2317 _Out_opt_ PULONG BytesInUnicodeString,
2318 _In_reads_bytes_(BytesInMultiByteString) const CHAR *MultiByteString,
2319 _In_ ULONG BytesInMultiByteString
2320 );
2321
2322 _IRQL_requires_max_(PASSIVE_LEVEL)
2323 NTSYSAPI
2324 NTSTATUS
2325 NTAPI
2326 RtlMultiByteToUnicodeSize(
2327 _Out_ PULONG BytesInUnicodeString,
2328 _In_reads_bytes_(BytesInMultiByteString) const CHAR *MultiByteString,
2329 _In_ ULONG BytesInMultiByteString
2330 );
2331
2332 //
2333 // Atom Functions
2334 //
2335 NTSYSAPI
2336 NTSTATUS
2337 NTAPI
2338 RtlAddAtomToAtomTable(
2339 _In_ PRTL_ATOM_TABLE AtomTable,
2340 _In_ PWSTR AtomName,
2341 _Out_ PRTL_ATOM Atom
2342 );
2343
2344 NTSYSAPI
2345 NTSTATUS
2346 NTAPI
2347 RtlCreateAtomTable(
2348 _In_ ULONG TableSize,
2349 _Inout_ PRTL_ATOM_TABLE *AtomTable
2350 );
2351
2352 NTSYSAPI
2353 NTSTATUS
2354 NTAPI
2355 RtlDeleteAtomFromAtomTable(
2356 _In_ PRTL_ATOM_TABLE AtomTable,
2357 _In_ RTL_ATOM Atom
2358 );
2359
2360 NTSYSAPI
2361 NTSTATUS
2362 NTAPI
2363 RtlDestroyAtomTable(IN PRTL_ATOM_TABLE AtomTable);
2364
2365 NTSYSAPI
2366 NTSTATUS
2367 NTAPI
2368 RtlQueryAtomInAtomTable(
2369 _In_ PRTL_ATOM_TABLE AtomTable,
2370 _In_ RTL_ATOM Atom,
2371 _Out_opt_ PULONG RefCount,
2372 _Out_opt_ PULONG PinCount,
2373 _Out_opt_z_bytecap_(*NameLength) PWSTR AtomName,
2374 _Inout_opt_ PULONG NameLength
2375 );
2376
2377 NTSYSAPI
2378 NTSTATUS
2379 NTAPI
2380 RtlPinAtomInAtomTable(
2381 _In_ PRTL_ATOM_TABLE AtomTable,
2382 _In_ RTL_ATOM Atom
2383 );
2384
2385 NTSYSAPI
2386 NTSTATUS
2387 NTAPI
2388 RtlLookupAtomInAtomTable(
2389 _In_ PRTL_ATOM_TABLE AtomTable,
2390 _In_ PWSTR AtomName,
2391 _Out_ PRTL_ATOM Atom
2392 );
2393
2394 //
2395 // Process Management Functions
2396 //
2397 NTSYSAPI
2398 PPEB
2399 NTAPI
2400 RtlGetCurrentPeb(
2401 VOID
2402 );
2403
2404 NTSYSAPI
2405 VOID
2406 NTAPI
2407 RtlAcquirePebLock(VOID);
2408
2409 NTSYSAPI
2410 NTSTATUS
2411 NTAPI
2412 RtlCreateProcessParameters (
2413 _Out_ PRTL_USER_PROCESS_PARAMETERS *ProcessParameters,
2414 _In_ PUNICODE_STRING ImagePathName,
2415 _In_opt_ PUNICODE_STRING DllPath,
2416 _In_opt_ PUNICODE_STRING CurrentDirectory,
2417 _In_opt_ PUNICODE_STRING CommandLine,
2418 _In_opt_ PWSTR Environment,
2419 _In_opt_ PUNICODE_STRING WindowTitle,
2420 _In_opt_ PUNICODE_STRING DesktopInfo,
2421 _In_opt_ PUNICODE_STRING ShellInfo,
2422 _In_opt_ PUNICODE_STRING RuntimeInfo
2423 );
2424
2425 NTSYSAPI
2426 NTSTATUS
2427 NTAPI
2428 RtlCreateUserProcess(
2429 _In_ PUNICODE_STRING ImageFileName,
2430 _In_ ULONG Attributes,
2431 _In_ PRTL_USER_PROCESS_PARAMETERS ProcessParameters,
2432 _In_opt_ PSECURITY_DESCRIPTOR ProcessSecutityDescriptor,
2433 _In_opt_ PSECURITY_DESCRIPTOR ThreadSecurityDescriptor,
2434 _In_opt_ HANDLE ParentProcess,
2435 _In_ BOOLEAN CurrentDirectory,
2436 _In_opt_ HANDLE DebugPort,
2437 _In_opt_ HANDLE ExceptionPort,
2438 _Out_ PRTL_USER_PROCESS_INFORMATION ProcessInfo
2439 );
2440
2441 #if (NTDDI_VERSION >= NTDDI_WIN7)
2442 NTSYSAPI
2443 NTSTATUS
2444 NTAPI
2445 RtlCreateUserThread(
2446 _In_ PVOID ThreadContext,
2447 _Out_ HANDLE *OutThreadHandle,
2448 _Reserved_ PVOID Reserved1,
2449 _Reserved_ PVOID Reserved2,
2450 _Reserved_ PVOID Reserved3,
2451 _Reserved_ PVOID Reserved4,
2452 _Reserved_ PVOID Reserved5,
2453 _Reserved_ PVOID Reserved6,
2454 _Reserved_ PVOID Reserved7,
2455 _Reserved_ PVOID Reserved8
2456 );
2457 #else
2458 NTSYSAPI
2459 NTSTATUS
2460 NTAPI
2461 RtlCreateUserThread(
2462 _In_ HANDLE ProcessHandle,
2463 _In_opt_ PSECURITY_DESCRIPTOR SecurityDescriptor,
2464 _In_ BOOLEAN CreateSuspended,
2465 _In_ ULONG StackZeroBits,
2466 _In_ SIZE_T StackReserve,
2467 _In_ SIZE_T StackCommit,
2468 _In_ PTHREAD_START_ROUTINE StartAddress,
2469 _In_ PVOID Parameter,
2470 _Out_opt_ PHANDLE ThreadHandle,
2471 _Out_opt_ PCLIENT_ID ClientId
2472 );
2473 #endif
2474
2475 NTSYSAPI
2476 PRTL_USER_PROCESS_PARAMETERS
2477 NTAPI
2478 RtlDeNormalizeProcessParams(
2479 _In_ PRTL_USER_PROCESS_PARAMETERS ProcessParameters);
2480
2481 NTSYSAPI
2482 NTSTATUS
2483 NTAPI
2484 RtlDestroyProcessParameters(
2485 _In_ PRTL_USER_PROCESS_PARAMETERS ProcessParameters);
2486
2487 NTSYSAPI
2488 VOID
2489 NTAPI
2490 RtlExitUserThread(
2491 _In_ NTSTATUS Status);
2492
2493 NTSYSAPI
2494 VOID
2495 NTAPI
2496 RtlInitializeContext(
2497 _In_ HANDLE ProcessHandle,
2498 _Out_ PCONTEXT ThreadContext,
2499 _In_opt_ PVOID ThreadStartParam,
2500 _In_ PTHREAD_START_ROUTINE ThreadStartAddress,
2501 _In_ PINITIAL_TEB InitialTeb
2502 );
2503
2504 #ifdef _M_AMD64
2505 typedef struct _WOW64_CONTEXT *PWOW64_CONTEXT;
2506
2507 NTSYSAPI
2508 NTSTATUS
2509 NTAPI
2510 RtlWow64GetThreadContext(
2511 _In_ HANDLE ThreadHandle,
2512 _Inout_ PWOW64_CONTEXT ThreadContext
2513 );
2514
2515
2516 NTSYSAPI
2517 NTSTATUS
2518 NTAPI
2519 RtlWow64SetThreadContext(
2520 _In_ HANDLE ThreadHandle,
2521 _In_ PWOW64_CONTEXT ThreadContext
2522 );
2523 #endif
2524
2525 NTSYSAPI
2526 BOOLEAN
2527 NTAPI
2528 RtlIsThreadWithinLoaderCallout(VOID);
2529
2530 NTSYSAPI
2531 PRTL_USER_PROCESS_PARAMETERS
2532 NTAPI
2533 RtlNormalizeProcessParams(
2534 _In_ PRTL_USER_PROCESS_PARAMETERS ProcessParameters);
2535
2536 NTSYSAPI
2537 VOID
2538 NTAPI
2539 RtlReleasePebLock(VOID);
2540
2541 NTSYSAPI
2542 NTSTATUS
2543 NTAPI
2544 RtlRemoteCall(
2545 _In_ HANDLE Process,
2546 _In_ HANDLE Thread,
2547 _In_ PVOID CallSite,
2548 _In_ ULONG ArgumentCount,
2549 _In_ PULONG Arguments,
2550 _In_ BOOLEAN PassContext,
2551 _In_ BOOLEAN AlreadySuspended
2552 );
2553
2554 NTSYSAPI
2555 NTSTATUS
2556 NTAPI
2557 RtlSetProcessIsCritical(
2558 _In_ BOOLEAN NewValue,
2559 _Out_opt_ PBOOLEAN OldValue,
2560 _In_ BOOLEAN NeedBreaks
2561 );
2562
2563 NTSYSAPI
2564 NTSTATUS
2565 NTAPI
2566 RtlSetThreadIsCritical(
2567 _In_ BOOLEAN NewValue,
2568 _Out_opt_ PBOOLEAN OldValue,
2569 _In_ BOOLEAN NeedBreaks
2570 );
2571
2572 NTSYSAPI
2573 ULONG
2574 NTAPI
2575 RtlGetCurrentProcessorNumber(
2576 VOID
2577 );
2578
2579 #define NtCurrentPeb() (NtCurrentTeb()->ProcessEnvironmentBlock)
2580
2581 //
2582 // Thread Pool Functions
2583 //
2584 //
2585 NTSTATUS
2586 NTAPI
2587 RtlSetThreadPoolStartFunc(
2588 _In_ PRTL_START_POOL_THREAD StartPoolThread,
2589 _In_ PRTL_EXIT_POOL_THREAD ExitPoolThread
2590 );
2591
2592 NTSYSAPI
2593 NTSTATUS
2594 NTAPI
2595 RtlDeregisterWaitEx(
2596 _In_ HANDLE hWaitHandle,
2597 _In_opt_ HANDLE hCompletionEvent
2598 );
2599
2600 NTSYSAPI
2601 NTSTATUS
2602 NTAPI
2603 RtlDeregisterWait(
2604 _In_ HANDLE hWaitHandle
2605 );
2606
2607 NTSYSAPI
2608 NTSTATUS
2609 NTAPI
2610 RtlQueueWorkItem(
2611 _In_ WORKERCALLBACKFUNC Function,
2612 _In_opt_ PVOID Context,
2613 _In_ ULONG Flags
2614 );
2615
2616 NTSYSAPI
2617 NTSTATUS
2618 NTAPI
2619 RtlSetIoCompletionCallback(
2620 _In_ HANDLE FileHandle,
2621 _In_ PIO_APC_ROUTINE Callback,
2622 _In_ ULONG Flags
2623 );
2624
2625 NTSYSAPI
2626 NTSTATUS
2627 NTAPI
2628 RtlRegisterWait(
2629 _In_ PHANDLE phNewWaitObject,
2630 _In_ HANDLE hObject,
2631 _In_ WAITORTIMERCALLBACKFUNC Callback,
2632 _In_ PVOID pvContext,
2633 _In_ ULONG ulMilliseconds,
2634 _In_ ULONG ulFlags
2635 );
2636
2637 //
2638 // Environment/Path Functions
2639 //
2640 NTSYSAPI
2641 NTSTATUS
2642 NTAPI
2643 RtlCreateEnvironment(
2644 _In_ BOOLEAN Inherit,
2645 _Out_ PWSTR *Environment
2646 );
2647
2648 NTSYSAPI
2649 NTSTATUS
2650 NTAPI
2651 RtlComputePrivatizedDllName_U(
2652 _In_ PUNICODE_STRING DllName,
2653 _Out_ PUNICODE_STRING RealName,
2654 _Out_ PUNICODE_STRING LocalName
2655 );
2656
2657 NTSYSAPI
2658 VOID
2659 NTAPI
2660 RtlDestroyEnvironment(
2661 _In_ PWSTR Environment
2662 );
2663
2664 NTSYSAPI
2665 BOOLEAN
2666 NTAPI
2667 RtlDoesFileExists_U(
2668 _In_ PCWSTR FileName
2669 );
2670
2671 NTSYSAPI
2672 RTL_PATH_TYPE
2673 NTAPI
2674 RtlDetermineDosPathNameType_U(
2675 _In_ PCWSTR Path
2676 );
2677
2678 NTSYSAPI
2679 ULONG
2680 NTAPI
2681 RtlDosSearchPath_U(
2682 _In_ PCWSTR Path,
2683 _In_ PCWSTR FileName,
2684 _In_ PCWSTR Extension,
2685 _In_ ULONG BufferSize,
2686 _Out_ PWSTR Buffer,
2687 _Out_ PWSTR *PartName
2688 );
2689
2690 NTSYSAPI
2691 NTSTATUS
2692 NTAPI
2693 RtlDosSearchPath_Ustr(
2694 _In_ ULONG Flags,
2695 _In_ PUNICODE_STRING PathString,
2696 _In_ PUNICODE_STRING FileNameString,
2697 _In_ PUNICODE_STRING ExtensionString,
2698 _In_ PUNICODE_STRING CallerBuffer,
2699 _Inout_opt_ PUNICODE_STRING DynamicString,
2700 _Out_opt_ PUNICODE_STRING* FullNameOut,
2701 _Out_opt_ PSIZE_T FilePartSize,
2702 _Out_opt_ PSIZE_T LengthNeeded
2703 );
2704
2705 NTSYSAPI
2706 BOOLEAN
2707 NTAPI
2708 RtlDosPathNameToNtPathName_U(
2709 _In_opt_z_ PCWSTR DosPathName,
2710 _Out_ PUNICODE_STRING NtPathName,
2711 _Out_opt_ PCWSTR *NtFileNamePart,
2712 _Out_opt_ PRTL_RELATIVE_NAME_U DirectoryInfo
2713 );
2714
2715 NTSYSAPI
2716 BOOLEAN
2717 NTAPI
2718 RtlDosPathNameToRelativeNtPathName_U(
2719 _In_ PCWSTR DosName,
2720 _Out_ PUNICODE_STRING NtName,
2721 _Out_ PCWSTR *PartName,
2722 _Out_ PRTL_RELATIVE_NAME_U RelativeName
2723 );
2724
2725 _At_(Destination->Buffer, _Out_bytecap_(Destination->MaximumLength))
2726 NTSYSAPI
2727 NTSTATUS
2728 NTAPI
2729 RtlExpandEnvironmentStrings_U(
2730 _In_z_ PWSTR Environment,
2731 _In_ PUNICODE_STRING Source,
2732 _Inout_ PUNICODE_STRING Destination,
2733 _Out_ PULONG Length
2734 );
2735
2736 NTSYSAPI
2737 ULONG
2738 NTAPI
2739 RtlGetCurrentDirectory_U(
2740 _In_ ULONG MaximumLength,
2741 _Out_bytecap_(MaximumLength) PWSTR Buffer
2742 );
2743
2744 NTSYSAPI
2745 ULONG
2746 NTAPI
2747 RtlGetFullPathName_U(
2748 _In_ PCWSTR FileName,
2749 _In_ ULONG Size,
2750 _Out_z_bytecap_(Size) PWSTR Buffer,
2751 _Out_opt_ PWSTR *ShortName
2752 );
2753
2754 #if (NTDDI_VERSION >= NTDDI_WIN7)
2755 NTSYSAPI
2756 NTSTATUS
2757 NTAPI
2758 RtlGetFullPathName_UEx(
2759 _In_ PWSTR FileName,
2760 _In_ ULONG BufferLength,
2761 _Out_ PWSTR Buffer,
2762 _Out_opt_ PWSTR *FilePart,
2763 _Out_opt_ RTL_PATH_TYPE *InputPathType
2764 );
2765 #endif
2766
2767 NTSTATUS
2768 NTAPI
2769 RtlGetFullPathName_UstrEx(
2770 _In_ PUNICODE_STRING FileName,
2771 _In_opt_ PUNICODE_STRING StaticString,
2772 _In_opt_ PUNICODE_STRING DynamicString,
2773 _Out_opt_ PUNICODE_STRING *StringUsed,
2774 _Out_opt_ PSIZE_T FilePartSize,
2775 _Out_opt_ PBOOLEAN NameInvalid,
2776 _Out_ RTL_PATH_TYPE* PathType,
2777 _Out_opt_ PSIZE_T LengthNeeded
2778 );
2779
2780 NTSYSAPI
2781 NTSTATUS
2782 NTAPI
2783 RtlGetLengthWithoutTrailingPathSeperators(
2784 _Reserved_ ULONG Flags,
2785 _In_ PCUNICODE_STRING PathString,
2786 _Out_ PULONG Length
2787 );
2788
2789 NTSYSAPI
2790 ULONG
2791 NTAPI
2792 RtlGetLongestNtPathLength(
2793 VOID
2794 );
2795
2796 NTSYSAPI
2797 ULONG
2798 NTAPI
2799 RtlIsDosDeviceName_U(
2800 _In_ PCWSTR Name
2801 );
2802
2803 NTSYSAPI
2804 ULONG
2805 NTAPI
2806 RtlIsDosDeviceName_Ustr(
2807 _In_ PCUNICODE_STRING Name
2808 );
2809
2810 _IRQL_requires_max_(PASSIVE_LEVEL)
2811 _Must_inspect_result_
2812 NTSYSAPI
2813 BOOLEAN
2814 NTAPI
2815 RtlIsNameLegalDOS8Dot3(
2816 _In_ PCUNICODE_STRING Name,
2817 _Inout_opt_ POEM_STRING OemName,
2818 _Out_opt_ PBOOLEAN NameContainsSpaces
2819 );
2820
2821 NTSYSAPI
2822 NTSTATUS
2823 NTAPI
2824 RtlQueryEnvironmentVariable_U(
2825 _In_opt_ PWSTR Environment,
2826 _In_ PUNICODE_STRING Name,
2827 _Out_ PUNICODE_STRING Value
2828 );
2829
2830 VOID
2831 NTAPI
2832 RtlReleaseRelativeName(
2833 _In_ PRTL_RELATIVE_NAME_U RelativeName
2834 );
2835
2836 NTSYSAPI
2837 NTSTATUS
2838 NTAPI
2839 RtlSetCurrentDirectory_U(
2840 _In_ PUNICODE_STRING name
2841 );
2842
2843 NTSYSAPI
2844 NTSTATUS
2845 NTAPI
2846 RtlSetEnvironmentVariable(
2847 _In_z_ PWSTR *Environment,
2848 _In_ PUNICODE_STRING Name,
2849 _In_ PUNICODE_STRING Value
2850 );
2851
2852 //
2853 // Critical Section/Resource Functions
2854 //
2855 NTSYSAPI
2856 NTSTATUS
2857 NTAPI
2858 RtlDeleteCriticalSection (
2859 _In_ PRTL_CRITICAL_SECTION CriticalSection
2860 );
2861
2862 NTSYSAPI
2863 NTSTATUS
2864 NTAPI
2865 RtlEnterCriticalSection(
2866 _In_ PRTL_CRITICAL_SECTION CriticalSection
2867 );
2868
2869 NTSYSAPI
2870 NTSTATUS
2871 NTAPI
2872 RtlInitializeCriticalSection(
2873 _In_ PRTL_CRITICAL_SECTION CriticalSection
2874 );
2875
2876 NTSYSAPI
2877 NTSTATUS
2878 NTAPI
2879 RtlInitializeCriticalSectionAndSpinCount(
2880 _In_ PRTL_CRITICAL_SECTION CriticalSection,
2881 _In_ ULONG SpinCount
2882 );
2883
2884 NTSYSAPI
2885 NTSTATUS
2886 NTAPI
2887 RtlLeaveCriticalSection(
2888 _In_ PRTL_CRITICAL_SECTION CriticalSection
2889 );
2890
2891 NTSYSAPI
2892 BOOLEAN
2893 NTAPI
2894 RtlTryEnterCriticalSection(
2895 _In_ PRTL_CRITICAL_SECTION CriticalSection
2896 );
2897
2898 NTSYSAPI
2899 VOID
2900 NTAPI
2901 RtlpUnWaitCriticalSection(
2902 _In_ PRTL_CRITICAL_SECTION CriticalSection
2903 );
2904
2905 NTSYSAPI
2906 NTSTATUS
2907 NTAPI
2908 RtlpWaitForCriticalSection(
2909 _In_ PRTL_CRITICAL_SECTION CriticalSection
2910 );
2911
2912 NTSYSAPI
2913 BOOLEAN
2914 NTAPI
2915 RtlAcquireResourceExclusive(
2916 _In_ PRTL_RESOURCE Resource,
2917 _In_ BOOLEAN Wait
2918 );
2919
2920 NTSYSAPI
2921 BOOLEAN
2922 NTAPI
2923 RtlAcquireResourceShared(
2924 _In_ PRTL_RESOURCE Resource,
2925 _In_ BOOLEAN Wait
2926 );
2927
2928 NTSYSAPI
2929 VOID
2930 NTAPI
2931 RtlConvertExclusiveToShared(
2932 _In_ PRTL_RESOURCE Resource
2933 );
2934
2935 NTSYSAPI
2936 VOID
2937 NTAPI
2938 RtlConvertSharedToExclusive(
2939 _In_ PRTL_RESOURCE Resource
2940 );
2941
2942 NTSYSAPI
2943 VOID
2944 NTAPI
2945 RtlDeleteResource(
2946 _In_ PRTL_RESOURCE Resource
2947 );
2948
2949 NTSYSAPI
2950 VOID
2951 NTAPI
2952 RtlDumpResource(
2953 _In_ PRTL_RESOURCE Resource
2954 );
2955
2956 NTSYSAPI
2957 VOID
2958 NTAPI
2959 RtlInitializeResource(
2960 _In_ PRTL_RESOURCE Resource
2961 );
2962
2963 NTSYSAPI
2964 VOID
2965 NTAPI
2966 RtlReleaseResource(
2967 _In_ PRTL_RESOURCE Resource
2968 );
2969
2970 //
2971 // Compression Functions
2972 //
2973 NTSYSAPI //NT_RTL_COMPRESS_API
2974 NTSTATUS
2975 NTAPI
2976 RtlCompressBuffer(
2977 _In_ USHORT CompressionFormatAndEngine,
2978 _In_reads_bytes_(UncompressedBufferSize) PUCHAR UncompressedBuffer,
2979 _In_ ULONG UncompressedBufferSize,
2980 _Out_writes_bytes_to_(CompressedBufferSize, *FinalCompressedSize) PUCHAR CompressedBuffer,
2981 _In_ ULONG CompressedBufferSize,
2982 _In_ ULONG UncompressedChunkSize,
2983 _Out_ PULONG FinalCompressedSize,
2984 _In_ PVOID WorkSpace
2985 );
2986
2987 _IRQL_requires_max_(APC_LEVEL)
2988 NTSYSAPI //NT_RTL_COMPRESS_API
2989 NTSTATUS
2990 NTAPI
2991 RtlDecompressBuffer(
2992 _In_ USHORT CompressionFormat,
2993 _Out_writes_bytes_to_(UncompressedBufferSize, *FinalUncompressedSize) PUCHAR UncompressedBuffer,
2994 _In_ ULONG UncompressedBufferSize,
2995 _In_reads_bytes_(CompressedBufferSize) PUCHAR CompressedBuffer,
2996 _In_ ULONG CompressedBufferSize,
2997 _Out_ PULONG FinalUncompressedSize
2998 );
2999
3000 NTSYSAPI
3001 NTSTATUS
3002 NTAPI
3003 RtlGetCompressionWorkSpaceSize(
3004 _In_ USHORT CompressionFormatAndEngine,
3005 _Out_ PULONG CompressBufferWorkSpaceSize,
3006 _Out_ PULONG CompressFragmentWorkSpaceSize
3007 );
3008
3009 //
3010 // Debug Info Functions
3011 //
3012 NTSYSAPI
3013 PRTL_DEBUG_INFORMATION
3014 NTAPI
3015 RtlCreateQueryDebugBuffer(
3016 _In_ ULONG Size,
3017 _In_ BOOLEAN EventPair
3018 );
3019
3020 NTSYSAPI
3021 NTSTATUS
3022 NTAPI
3023 RtlDestroyQueryDebugBuffer(IN PRTL_DEBUG_INFORMATION DebugBuffer);
3024
3025 NTSYSAPI
3026 NTSTATUS
3027 NTAPI
3028 RtlQueryProcessDebugInformation(
3029 _In_ ULONG ProcessId,
3030 _In_ ULONG DebugInfoClassMask,
3031 _Inout_ PRTL_DEBUG_INFORMATION DebugBuffer
3032 );
3033
3034 //
3035 // Bitmap Functions
3036 //
3037 NTSYSAPI
3038 BOOLEAN
3039 NTAPI
3040 RtlAreBitsClear(
3041 _In_ PRTL_BITMAP BitMapHeader,
3042 _In_ ULONG StartingIndex,
3043 _In_ ULONG Length
3044 );
3045
3046 NTSYSAPI
3047 BOOLEAN
3048 NTAPI
3049 RtlAreBitsSet(
3050 _In_ PRTL_BITMAP BitMapHeader,
3051 _In_ ULONG StartingIndex,
3052 _In_ ULONG Length
3053 );
3054
3055 NTSYSAPI
3056 VOID
3057 NTAPI
3058 RtlClearAllBits(
3059 _In_ PRTL_BITMAP BitMapHeader
3060 );
3061
3062 NTSYSAPI
3063 VOID
3064 NTAPI
3065 RtlClearBits(
3066 _In_ PRTL_BITMAP BitMapHeader,
3067 _In_range_(0, BitMapHeader->SizeOfBitMap - NumberToClear) ULONG StartingIndex,
3068 _In_range_(0, BitMapHeader->SizeOfBitMap - StartingIndex) ULONG NumberToClear
3069 );
3070
3071 NTSYSAPI
3072 ULONG
3073 NTAPI
3074 RtlFindClearBits(
3075 _In_ PRTL_BITMAP BitMapHeader,
3076 _In_ ULONG NumberToFind,
3077 _In_ ULONG HintIndex
3078 );
3079
3080 NTSYSAPI
3081 ULONG
3082 NTAPI
3083 RtlFindClearBitsAndSet(
3084 _In_ PRTL_BITMAP BitMapHeader,
3085 _In_ ULONG NumberToFind,
3086 _In_ ULONG HintIndex
3087 );
3088
3089 NTSYSAPI
3090 CCHAR
3091 NTAPI
3092 RtlFindLeastSignificantBit(
3093 _In_ ULONGLONG Value
3094 );
3095
3096 NTSYSAPI
3097 CCHAR
3098 NTAPI
3099 RtlFindMostSignificantBit(
3100 _In_ ULONGLONG Value
3101 );
3102
3103 NTSYSAPI
3104 ULONG
3105 NTAPI
3106 RtlFindNextForwardRunClear(
3107 _In_ PRTL_BITMAP BitMapHeader,
3108 _In_ ULONG FromIndex,
3109 _Out_ PULONG StartingRunIndex
3110 );
3111
3112 NTSYSAPI
3113 ULONG
3114 NTAPI
3115 RtlFindNextForwardRunSet(
3116 _In_ PRTL_BITMAP BitMapHeader,
3117 _In_ ULONG FromIndex,
3118 _Out_ PULONG StartingRunIndex
3119 );
3120
3121 NTSYSAPI
3122 ULONG
3123 NTAPI
3124 RtlFindSetBits(
3125 _In_ PRTL_BITMAP BitMapHeader,
3126 _In_ ULONG NumberToFind,
3127 _In_ ULONG HintIndex
3128 );
3129
3130 NTSYSAPI
3131 ULONG
3132 NTAPI
3133 RtlFindSetBitsAndClear(
3134 _In_ PRTL_BITMAP BitMapHeader,
3135 _In_ ULONG NumberToFind,
3136 _In_ ULONG HintIndex
3137 );
3138
3139 #ifdef _REACTOS_ // ReactOS improvement
3140 _At_(BitMapHeader->SizeOfBitMap, _Post_equal_to_(SizeOfBitMap))
3141 _At_(BitMapHeader->Buffer, _Post_equal_to_(BitMapBuffer))
3142 #endif
3143 NTSYSAPI
3144 VOID
3145 NTAPI
3146 RtlInitializeBitMap(
3147 _Out_ PRTL_BITMAP BitMapHeader,
3148 _In_opt_ __drv_aliasesMem PULONG BitMapBuffer,
3149 _In_opt_ ULONG SizeOfBitMap
3150 );
3151
3152 NTSYSAPI
3153 ULONG
3154 NTAPI
3155 RtlNumberOfClearBits(
3156 _In_ PRTL_BITMAP BitMapHeader
3157 );
3158
3159 NTSYSAPI
3160 ULONG
3161 NTAPI
3162 RtlNumberOfSetBits(
3163 _In_ PRTL_BITMAP BitMapHeader
3164 );
3165
3166 NTSYSAPI
3167 VOID
3168 NTAPI
3169 RtlSetBit(
3170 _In_ PRTL_BITMAP BitMapHeader,
3171 _In_range_(<, BitMapHeader->SizeOfBitMap) ULONG BitNumber
3172 );
3173
3174 NTSYSAPI
3175 VOID
3176 NTAPI
3177 RtlSetBits(
3178 _In_ PRTL_BITMAP BitMapHeader,
3179 _In_range_(0, BitMapHeader->SizeOfBitMap - NumberToSet) ULONG StartingIndex,
3180 _In_range_(0, BitMapHeader->SizeOfBitMap - StartingIndex) ULONG NumberToSet
3181 );
3182
3183 NTSYSAPI
3184 VOID
3185 NTAPI
3186 RtlSetAllBits(
3187 _In_ PRTL_BITMAP BitMapHeader
3188 );
3189
3190 _Must_inspect_result_
3191 NTSYSAPI
3192 BOOLEAN
3193 NTAPI
3194 RtlTestBit(
3195 _In_ PRTL_BITMAP BitMapHeader,
3196 _In_range_(<, BitMapHeader->SizeOfBitMap) ULONG BitNumber
3197 );
3198
3199 //
3200 // Timer Functions
3201 //
3202 NTSYSAPI
3203 NTSTATUS
3204 NTAPI
3205 RtlCreateTimer(
3206 _In_ HANDLE TimerQueue,
3207 _In_ PHANDLE phNewTimer,
3208 _In_ WAITORTIMERCALLBACKFUNC Callback,
3209 _In_ PVOID Parameter,
3210 _In_ ULONG DueTime,
3211 _In_ ULONG Period,
3212 _In_ ULONG Flags
3213 );
3214
3215 NTSYSAPI
3216 NTSTATUS
3217 NTAPI
3218 RtlCreateTimerQueue(PHANDLE TimerQueue);
3219
3220 NTSYSAPI
3221 NTSTATUS
3222 NTAPI
3223 RtlDeleteTimer(
3224 _In_ HANDLE TimerQueue,
3225 _In_ HANDLE Timer,
3226 _In_ HANDLE CompletionEvent
3227 );
3228
3229 NTSYSAPI
3230 NTSTATUS
3231 NTAPI
3232 RtlUpdateTimer(
3233 _In_ HANDLE TimerQueue,
3234 _In_ HANDLE Timer,
3235 _In_ ULONG DueTime,
3236 _In_ ULONG Period
3237 );
3238
3239 NTSYSAPI
3240 NTSTATUS
3241 NTAPI
3242 RtlDeleteTimerQueueEx(
3243 _In_ HANDLE TimerQueue,
3244 _In_opt_ HANDLE CompletionEvent
3245 );
3246
3247 NTSYSAPI
3248 NTSTATUS
3249 NTAPI
3250 RtlDeleteTimerQueue(HANDLE TimerQueue);
3251
3252 //
3253 // SList functions
3254 //
3255 PSLIST_ENTRY
3256 FASTCALL
3257 InterlockedPushListSList(
3258 _Inout_ PSLIST_HEADER ListHead,
3259 _Inout_ __drv_aliasesMem PSLIST_ENTRY List,
3260 _Inout_ PSLIST_ENTRY ListEnd,
3261 _In_ ULONG Count
3262 );
3263
3264 //
3265 // Range List functions
3266 //
3267 NTSYSAPI
3268 VOID
3269 NTAPI
3270 RtlInitializeRangeList(
3271 _Inout_ PRTL_RANGE_LIST RangeList
3272 );
3273
3274 NTSYSAPI
3275 VOID
3276 NTAPI
3277 RtlFreeRangeList(
3278 _In_ PRTL_RANGE_LIST RangeList
3279 );
3280
3281 NTSYSAPI
3282 NTSTATUS
3283 NTAPI
3284 RtlAddRange(
3285 _Inout_ PRTL_RANGE_LIST RangeList,
3286 _In_ ULONGLONG Start,
3287 _In_ ULONGLONG End,
3288 _In_ UCHAR Attributes,
3289 _In_ ULONG Flags,
3290 _In_opt_ PVOID UserData,
3291 _In_opt_ PVOID Owner
3292 );
3293
3294 //
3295 // Debug Functions
3296 //
3297 ULONG
3298 __cdecl
3299 DbgPrint(
3300 _In_z_ _Printf_format_string_ PCSTR Format,
3301 ...
3302 );
3303
3304 NTSYSAPI
3305 ULONG
3306 __cdecl
3307 DbgPrintEx(
3308 _In_ ULONG ComponentId,
3309 _In_ ULONG Level,
3310 _In_z_ _Printf_format_string_ PCSTR Format,
3311 ...
3312 );
3313
3314 NTSYSAPI
3315 ULONG
3316 NTAPI
3317 DbgPrompt(
3318 _In_z_ PCCH Prompt,
3319 _Out_writes_bytes_(MaximumResponseLength) PCH Response,
3320 _In_ ULONG MaximumResponseLength
3321 );
3322
3323 #undef DbgBreakPoint
3324 VOID
3325 NTAPI
3326 DbgBreakPoint(
3327 VOID
3328 );
3329
3330 VOID
3331 NTAPI
3332 DbgLoadImageSymbols(
3333 _In_ PSTRING Name,
3334 _In_ PVOID Base,
3335 _In_ ULONG_PTR ProcessId
3336 );
3337
3338 VOID
3339 NTAPI
3340 DbgUnLoadImageSymbols(
3341 _In_ PSTRING Name,
3342 _In_ PVOID Base,
3343 _In_ ULONG_PTR ProcessId
3344 );
3345
3346 VOID
3347 NTAPI
3348 DbgCommandString(
3349 _In_ PCCH Name,
3350 _In_ PCCH Command
3351 );
3352
3353 //
3354 // Generic Table Functions
3355 //
3356 #if defined(NTOS_MODE_USER) || defined(_NTIFS_)
3357 NTSYSAPI
3358 PVOID
3359 NTAPI
3360 RtlInsertElementGenericTable(
3361 _In_ PRTL_GENERIC_TABLE Table,
3362 _In_reads_bytes_(BufferSize) PVOID Buffer,
3363 _In_ CLONG BufferSize,
3364 _Out_opt_ PBOOLEAN NewElement
3365 );
3366
3367 NTSYSAPI
3368 PVOID
3369 NTAPI
3370 RtlInsertElementGenericTableFull(
3371 _In_ PRTL_GENERIC_TABLE Table,
3372 _In_reads_bytes_(BufferSize) PVOID Buffer,
3373 _In_ CLONG BufferSize,
3374 _Out_opt_ PBOOLEAN NewElement,
3375 _In_ PVOID NodeOrParent,
3376 _In_ TABLE_SEARCH_RESULT SearchResult
3377 );
3378
3379 NTSYSAPI
3380 BOOLEAN
3381 NTAPI
3382 RtlIsGenericTableEmpty(
3383 _In_ PRTL_GENERIC_TABLE Table
3384 );
3385
3386 NTSYSAPI
3387 PVOID
3388 NTAPI
3389 RtlLookupElementGenericTableFull(
3390 _In_ PRTL_GENERIC_TABLE Table,
3391 _In_ PVOID Buffer,
3392 _Out_ PVOID *NodeOrParent,
3393 _Out_ TABLE_SEARCH_RESULT *SearchResult
3394 );
3395 #endif
3396
3397 //
3398 // Handle Table Functions
3399 //
3400 NTSYSAPI
3401 PRTL_HANDLE_TABLE_ENTRY
3402 NTAPI
3403 RtlAllocateHandle(
3404 _In_ PRTL_HANDLE_TABLE HandleTable,
3405 _Inout_ PULONG Index
3406 );
3407
3408 NTSYSAPI
3409 VOID
3410 NTAPI
3411 RtlDestroyHandleTable(
3412 _Inout_ PRTL_HANDLE_TABLE HandleTable);
3413
3414 NTSYSAPI
3415 BOOLEAN
3416 NTAPI
3417 RtlFreeHandle(
3418 _In_ PRTL_HANDLE_TABLE HandleTable,
3419 _In_ PRTL_HANDLE_TABLE_ENTRY Handle
3420 );
3421
3422 NTSYSAPI
3423 VOID
3424 NTAPI
3425 RtlInitializeHandleTable(
3426 _In_ ULONG TableSize,
3427 _In_ ULONG HandleSize,
3428 _In_ PRTL_HANDLE_TABLE HandleTable
3429 );
3430
3431 NTSYSAPI
3432 BOOLEAN
3433 NTAPI
3434 RtlIsValidHandle(
3435 _In_ PRTL_HANDLE_TABLE HandleTable,
3436 _In_ PRTL_HANDLE_TABLE_ENTRY Handle
3437 );
3438
3439 _Success_(return!=FALSE)
3440 NTSYSAPI
3441 BOOLEAN
3442 NTAPI
3443 RtlIsValidIndexHandle(
3444 _In_ PRTL_HANDLE_TABLE HandleTable,
3445 _In_ ULONG Index,
3446 _Out_ PRTL_HANDLE_TABLE_ENTRY *Handle
3447 );
3448
3449 //
3450 // PE Functions
3451 //
3452 NTSYSAPI
3453 NTSTATUS
3454 NTAPI
3455 RtlFindMessage(
3456 _In_ PVOID BaseAddress,
3457 _In_ ULONG Type,
3458 _In_ ULONG Language,
3459 _In_ ULONG MessageId,
3460 _Out_ PMESSAGE_RESOURCE_ENTRY *MessageResourceEntry
3461 );
3462
3463 NTSYSAPI
3464 ULONG
3465 NTAPI
3466 RtlGetNtGlobalFlags(VOID);
3467
3468 _Success_(return!=NULL)
3469 NTSYSAPI
3470 PVOID
3471 NTAPI
3472 RtlImageDirectoryEntryToData(
3473 _In_ PVOID BaseAddress,
3474 _In_ BOOLEAN MappedAsImage,
3475 _In_ USHORT Directory,
3476 _Out_ PULONG Size
3477 );
3478
3479 NTSYSAPI
3480 PVOID
3481 NTAPI
3482 RtlImageRvaToVa(
3483 _In_ PIMAGE_NT_HEADERS NtHeader,
3484 _In_ PVOID BaseAddress,
3485 _In_ ULONG Rva,
3486 _Inout_opt_ PIMAGE_SECTION_HEADER *SectionHeader
3487 );
3488
3489 NTSYSAPI
3490 PIMAGE_NT_HEADERS
3491 NTAPI
3492 RtlImageNtHeader(
3493 _In_ PVOID BaseAddress);
3494
3495 NTSYSAPI
3496 NTSTATUS
3497 NTAPI
3498 RtlImageNtHeaderEx(
3499 _In_ ULONG Flags,
3500 _In_ PVOID BaseAddress,
3501 _In_ ULONGLONG Size,
3502 _Out_ PIMAGE_NT_HEADERS *NtHeader
3503 );
3504
3505 NTSYSAPI
3506 PIMAGE_SECTION_HEADER
3507 NTAPI
3508 RtlImageRvaToSection(
3509 _In_ PIMAGE_NT_HEADERS NtHeader,
3510 _In_ PVOID BaseAddress,
3511 _In_ ULONG Rva
3512 );
3513
3514 NTSYSAPI
3515 ULONG
3516 NTAPI
3517 LdrRelocateImageWithBias(
3518 _In_ PVOID NewAddress,
3519 _In_ LONGLONG AdditionalBias,
3520 _In_ PCCH LoaderName,
3521 _In_ ULONG Success,
3522 _In_ ULONG Conflict,
3523 _In_ ULONG Invalid
3524 );
3525
3526 //
3527 // Activation Context Functions
3528 //
3529 #ifdef NTOS_MODE_USER
3530 NTSYSAPI
3531 NTSTATUS
3532 NTAPI
3533 RtlActivateActivationContextEx(
3534 _In_ ULONG Flags,
3535 _In_ PTEB Teb,
3536 _In_ PVOID Context,
3537 _Out_ PULONG_PTR Cookie
3538 );
3539
3540 NTSYSAPI
3541 NTSTATUS
3542 NTAPI
3543 RtlActivateActivationContext(
3544 _In_ ULONG Flags,
3545 _In_ HANDLE Handle,
3546 _Out_ PULONG_PTR Cookie
3547 );
3548
3549 NTSYSAPI
3550 VOID
3551 NTAPI
3552 RtlAddRefActivationContext(
3553 _In_ PVOID Context
3554 );
3555
3556 NTSYSAPI
3557 PRTL_ACTIVATION_CONTEXT_STACK_FRAME
3558 FASTCALL
3559 RtlActivateActivationContextUnsafeFast(
3560 _In_ PRTL_CALLER_ALLOCATED_ACTIVATION_CONTEXT_STACK_FRAME_EXTENDED Frame,
3561 _In_ PVOID Context
3562 );
3563
3564 NTSYSAPI
3565 NTSTATUS
3566 NTAPI
3567 RtlAllocateActivationContextStack(
3568 _In_ PACTIVATION_CONTEXT_STACK *Stack
3569 );
3570
3571 NTSYSAPI
3572 NTSTATUS
3573 NTAPI
3574 RtlCreateActivationContext(
3575 _In_ ULONG Flags,
3576 _In_ PACTIVATION_CONTEXT_DATA ActivationContextData,
3577 _In_ ULONG ExtraBytes,
3578 _In_ PVOID NotificationRoutine,
3579 _In_ PVOID NotificationContext,
3580 _Out_ PACTIVATION_CONTEXT *ActCtx
3581 );
3582
3583 NTSYSAPI
3584 NTSTATUS
3585 NTAPI
3586 RtlGetActiveActivationContext(
3587 _In_ PVOID *Context
3588 );
3589
3590 NTSYSAPI
3591 VOID
3592 NTAPI
3593 RtlReleaseActivationContext(
3594 _In_ HANDLE handle
3595 );
3596
3597 NTSYSAPI
3598 NTSTATUS
3599 NTAPI
3600 RtlDeactivateActivationContext(
3601 _In_ ULONG dwFlags,
3602 _In_ ULONG_PTR ulCookie
3603 );
3604
3605 NTSYSAPI
3606 VOID
3607 NTAPI
3608 RtlFreeActivationContextStack(
3609 _In_ PACTIVATION_CONTEXT_STACK Stack
3610 );
3611
3612 NTSYSAPI
3613 VOID
3614 NTAPI
3615 RtlFreeThreadActivationContextStack(VOID);
3616
3617 NTSYSAPI
3618 PRTL_ACTIVATION_CONTEXT_STACK_FRAME
3619 FASTCALL
3620 RtlDeactivateActivationContextUnsafeFast(
3621 _In_ PRTL_CALLER_ALLOCATED_ACTIVATION_CONTEXT_STACK_FRAME_EXTENDED Frame
3622 );
3623
3624 NTSYSAPI
3625 NTSTATUS
3626 NTAPI
3627 RtlDosApplyFileIsolationRedirection_Ustr(
3628 _In_ ULONG Flags,
3629 _In_ PUNICODE_STRING OriginalName,
3630 _In_ PUNICODE_STRING Extension,
3631 _Inout_ PUNICODE_STRING StaticString,
3632 _Inout_ PUNICODE_STRING DynamicString,
3633 _Inout_ PUNICODE_STRING *NewName,
3634 _In_ PULONG NewFlags,
3635 _In_ PSIZE_T FileNameSize,
3636 _In_ PSIZE_T RequiredLength
3637 );
3638
3639 NTSYSAPI
3640 NTSTATUS
3641 NTAPI
3642 RtlFindActivationContextSectionString(
3643 _In_ ULONG dwFlags,
3644 _In_ const GUID *ExtensionGuid,
3645 _In_ ULONG SectionType,
3646 _In_ PUNICODE_STRING SectionName,
3647 _Inout_ PVOID ReturnedData
3648 );
3649
3650 NTSYSAPI
3651 NTSTATUS
3652 NTAPI
3653 RtlQueryInformationActivationContext(
3654 _In_ DWORD dwFlags,
3655 _In_opt_ PVOID Context,
3656 _In_opt_ PVOID pvSubInstance,
3657 _In_ ULONG ulInfoClass,
3658 _Out_bytecap_(cbBuffer) PVOID pvBuffer,
3659 _In_opt_ SIZE_T cbBuffer,
3660 _Out_opt_ SIZE_T *pcbWrittenOrRequired
3661 );
3662
3663 NTSYSAPI
3664 NTSTATUS
3665 NTAPI
3666 RtlQueryInformationActiveActivationContext(
3667 _In_ ULONG ulInfoClass,
3668 _Out_bytecap_(cbBuffer) PVOID pvBuffer,
3669 _In_opt_ SIZE_T cbBuffer,
3670 _Out_opt_ SIZE_T *pcbWrittenOrRequired
3671 );
3672
3673 NTSYSAPI
3674 NTSTATUS
3675 NTAPI
3676 RtlZombifyActivationContext(
3677 PVOID Context
3678 );
3679
3680 //
3681 // WOW64 Functions
3682 //
3683 NTSYSAPI
3684 NTSTATUS
3685 NTAPI
3686 RtlWow64EnableFsRedirection(
3687 _In_ BOOLEAN Wow64FsEnableRedirection
3688 );
3689
3690 NTSYSAPI
3691 NTSTATUS
3692 NTAPI
3693 RtlWow64EnableFsRedirectionEx(
3694 _In_ PVOID Wow64FsEnableRedirection,
3695 _Out_ PVOID *OldFsRedirectionLevel
3696 );
3697
3698 #endif
3699
3700 //
3701 // Registry Functions
3702 //
3703 _IRQL_requires_max_(PASSIVE_LEVEL)
3704 _Must_inspect_result_
3705 NTSYSAPI
3706 NTSTATUS
3707 NTAPI
3708 RtlCheckRegistryKey(
3709 _In_ ULONG RelativeTo,
3710 _In_ PWSTR Path
3711 );
3712
3713 NTSYSAPI
3714 NTSTATUS
3715 NTAPI
3716 RtlCreateRegistryKey(
3717 _In_ ULONG RelativeTo,
3718 _In_ PWSTR Path
3719 );
3720
3721 NTSYSAPI
3722 NTSTATUS
3723 NTAPI
3724 RtlFormatCurrentUserKeyPath(
3725 _Out_ _At_(KeyPath->Buffer, __drv_allocatesMem(Mem) _Post_bytecap_(KeyPath->MaximumLength) _Post_bytecount_(KeyPath->Length))
3726 PUNICODE_STRING KeyPath
3727 );
3728
3729 NTSYSAPI
3730 NTSTATUS
3731 NTAPI
3732 RtlOpenCurrentUser(
3733 _In_ ACCESS_MASK DesiredAccess,
3734 _Out_ PHANDLE KeyHandle
3735 );
3736
3737 _IRQL_requires_max_(PASSIVE_LEVEL)
3738 NTSYSAPI
3739 NTSTATUS
3740 NTAPI
3741 RtlQueryRegistryValues(
3742 _In_ ULONG RelativeTo,
3743 _In_ PCWSTR Path,
3744 _Inout_ _At_(*(*QueryTable).EntryContext, _Pre_unknown_)
3745 PRTL_QUERY_REGISTRY_TABLE QueryTable,
3746 _In_opt_ PVOID Context,
3747 _In_opt_ PVOID Environment
3748 );
3749
3750 _IRQL_requires_max_(PASSIVE_LEVEL)
3751 NTSYSAPI
3752 NTSTATUS
3753 NTAPI
3754 RtlWriteRegistryValue(
3755 _In_ ULONG RelativeTo,
3756 _In_ PCWSTR Path,
3757 _In_z_ PCWSTR ValueName,
3758 _In_ ULONG ValueType,
3759 _In_reads_bytes_opt_(ValueLength) PVOID ValueData,
3760 _In_ ULONG ValueLength
3761 );
3762
3763 #ifdef NTOS_MODE_USER
3764 NTSYSAPI
3765 NTSTATUS
3766 NTAPI
3767 RtlpNtCreateKey(
3768 _Out_ HANDLE KeyHandle,
3769 _In_ ACCESS_MASK DesiredAccess,
3770 _In_ POBJECT_ATTRIBUTES ObjectAttributes,
3771 _In_ ULONG TitleIndex,
3772 _In_ PUNICODE_STRING Class,
3773 _Out_ PULONG Disposition
3774 );
3775
3776 NTSYSAPI
3777 NTSTATUS
3778 NTAPI
3779 RtlpNtEnumerateSubKey(
3780 _In_ HANDLE KeyHandle,
3781 _Inout_ PUNICODE_STRING SubKeyName,
3782 _In_ ULONG Index,
3783 _In_ ULONG Unused
3784 );
3785
3786 NTSYSAPI
3787 NTSTATUS
3788 NTAPI
3789 RtlpNtMakeTemporaryKey(
3790 _In_ HANDLE KeyHandle
3791 );
3792
3793 NTSYSAPI
3794 NTSTATUS
3795 NTAPI
3796 RtlpNtOpenKey(
3797 _Out_ HANDLE KeyHandle,
3798 _In_ ACCESS_MASK DesiredAccess,
3799 _In_ POBJECT_ATTRIBUTES ObjectAttributes,
3800 _In_ ULONG Unused
3801 );
3802
3803 NTSYSAPI
3804 NTSTATUS
3805 NTAPI
3806 RtlpNtQueryValueKey(
3807 _In_ HANDLE KeyHandle,
3808 _Out_opt_ PULONG Type,
3809 _Out_opt_ PVOID Data,
3810 _Inout_opt_ PULONG DataLength,
3811 _In_ ULONG Unused
3812 );
3813
3814 NTSYSAPI
3815 NTSTATUS
3816 NTAPI
3817 RtlpNtSetValueKey(
3818 _In_ HANDLE KeyHandle,
3819 _In_ ULONG Type,
3820 _In_ PVOID Data,
3821 _In_ ULONG DataLength
3822 );
3823 #endif
3824
3825 //
3826 // NLS Functions
3827 //
3828 NTSYSAPI
3829 VOID
3830 NTAPI
3831 RtlGetDefaultCodePage(
3832 _Out_ PUSHORT AnsiCodePage,
3833 _Out_ PUSHORT OemCodePage
3834 );
3835
3836 NTSYSAPI
3837 VOID
3838 NTAPI
3839 RtlInitNlsTables(
3840 _In_ PUSHORT AnsiTableBase,
3841 _In_ PUSHORT OemTableBase,
3842 _In_ PUSHORT CaseTableBase,
3843 _Out_ PNLSTABLEINFO NlsTable
3844 );
3845
3846 _IRQL_requires_max_(PASSIVE_LEVEL)
3847 NTSYSAPI
3848 VOID
3849 NTAPI
3850 RtlInitCodePageTable(
3851 _In_ PUSHORT TableBase,
3852 _Out_ PCPTABLEINFO CodePageTable
3853 );
3854
3855 NTSYSAPI
3856 VOID
3857 NTAPI
3858 RtlResetRtlTranslations(
3859 _In_ PNLSTABLEINFO NlsTable);
3860
3861 #if defined(NTOS_MODE_USER) && !defined(NO_RTL_INLINES)
3862
3863 //
3864 // Misc conversion functions
3865 //
3866 static __inline
3867 LARGE_INTEGER
3868 NTAPI_INLINE
3869 RtlConvertLongToLargeInteger(
3870 _In_ LONG SignedInteger
3871 )
3872 {
3873 LARGE_INTEGER Result;
3874
3875 Result.QuadPart = SignedInteger;
3876 return Result;
3877 }
3878
3879 static __inline
3880 LARGE_INTEGER
3881 NTAPI_INLINE
3882 RtlEnlargedIntegerMultiply(
3883 _In_ LONG Multiplicand,
3884 _In_ LONG Multiplier
3885 )
3886 {
3887 LARGE_INTEGER Product;
3888
3889 Product.QuadPart = (LONGLONG)Multiplicand * (ULONGLONG)Multiplier;
3890 return Product;
3891 }
3892
3893 static __inline
3894 ULONG
3895 NTAPI_INLINE
3896 RtlEnlargedUnsignedDivide(
3897 _In_ ULARGE_INTEGER Dividend,
3898 _In_ ULONG Divisor,
3899 _In_opt_ PULONG Remainder
3900 )
3901 {
3902 ULONG Quotient;
3903
3904 Quotient = (ULONG)(Dividend.QuadPart / Divisor);
3905 if (Remainder) {
3906 *Remainder = (ULONG)(Dividend.QuadPart % Divisor);
3907 }
3908
3909 return Quotient;
3910 }
3911
3912 static __inline
3913 LARGE_INTEGER
3914 NTAPI_INLINE
3915 RtlEnlargedUnsignedMultiply(
3916 _In_ ULONG Multiplicand,
3917 _In_ ULONG Multiplier
3918 )
3919 {
3920 LARGE_INTEGER Product;
3921
3922 Product.QuadPart = (ULONGLONG)Multiplicand * (ULONGLONG)Multiplier;
3923 return Product;
3924 }
3925
3926 #if defined(_AMD64_) || defined(_IA64_)
3927 static __inline
3928 LARGE_INTEGER
3929 NTAPI_INLINE
3930 RtlExtendedLargeIntegerDivide(
3931 _In_ LARGE_INTEGER Dividend,
3932 _In_ ULONG Divisor,
3933 _Out_opt_ PULONG Remainder)
3934 {
3935 LARGE_INTEGER ret;
3936 ret.QuadPart = (ULONG64)Dividend.QuadPart / Divisor;
3937 if (Remainder)
3938 *Remainder = (ULONG)(Dividend.QuadPart % Divisor);
3939 return ret;
3940 }
3941
3942 #else
3943 NTSYSAPI
3944 LARGE_INTEGER
3945 NTAPI
3946 RtlExtendedLargeIntegerDivide(
3947 _In_ LARGE_INTEGER Dividend,
3948 _In_ ULONG Divisor,
3949 _Out_opt_ PULONG Remainder
3950 );
3951
3952 #endif /* defined(_AMD64_) || defined(_IA64_) */
3953
3954 #endif
3955
3956
3957 NTSYSAPI
3958 ULONG
3959 NTAPI
3960 RtlUniform(
3961 _In_ PULONG Seed
3962 );
3963
3964 NTSYSAPI
3965 ULONG
3966 NTAPI
3967 RtlRandom(
3968 _Inout_ PULONG Seed
3969 );
3970
3971 NTSYSAPI
3972 ULONG
3973 NTAPI
3974 RtlComputeCrc32(
3975 _In_ ULONG InitialCrc,
3976 _In_ PUCHAR Buffer,
3977 _In_ ULONG Length
3978 );
3979
3980 //
3981 // Network Functions
3982 //
3983 NTSYSAPI
3984 NTSTATUS
3985 NTAPI
3986 RtlIpv4StringToAddressW(
3987 _In_ PCWSTR String,
3988 _In_ BOOLEAN Strict,
3989 _Out_ LPWSTR *Terminator,
3990 _Out_ struct in_addr *Addr
3991 );
3992
3993 NTSYSAPI
3994 NTSTATUS
3995 NTAPI
3996 RtlIpv6StringToAddressA(
3997 _In_ PCHAR Name,
3998 _Out_ PCHAR *Terminator,
3999 _Out_ struct in6_addr *Addr
4000 );
4001
4002 NTSYSAPI
4003 NTSTATUS
4004 NTAPI
4005 RtlIpv6StringToAddressW(
4006 _In_ PWCHAR Name,
4007 _Out_ PCHAR *Terminator,
4008 _Out_ struct in6_addr *Addr
4009 );
4010
4011 NTSYSAPI
4012 NTSTATUS
4013 NTAPI
4014 RtlIpv6StringToAddressExA(
4015 _In_ PCHAR AddressString,
4016 _In_ struct in6_addr *Address,
4017 _In_ PULONG ScopeId,
4018 _In_ PUSHORT Port
4019 );
4020
4021 NTSYSAPI
4022 NTSTATUS
4023 NTAPI
4024 RtlIpv6StringToAddressExW(
4025 _In_ PWCHAR AddressName,
4026 _In_ struct in6_addr *Address,
4027 _In_ PULONG ScopeId,
4028 _In_ PUSHORT Port
4029 );
4030
4031
4032 //
4033 // Time Functions
4034 //
4035 NTSYSAPI
4036 NTSTATUS
4037 NTAPI
4038 RtlQueryTimeZoneInformation(
4039 _Out_ PRTL_TIME_ZONE_INFORMATION TimeZoneInformation);
4040
4041 NTSYSAPI
4042 VOID
4043 NTAPI
4044 RtlSecondsSince1970ToTime(
4045 _In_ ULONG SecondsSince1970,
4046 _Out_ PLARGE_INTEGER Time
4047 );
4048
4049 NTSYSAPI
4050 NTSTATUS
4051 NTAPI
4052 RtlSetTimeZoneInformation(
4053 _In_ PRTL_TIME_ZONE_INFORMATION TimeZoneInformation);
4054
4055 _Success_(return!=FALSE)
4056 _Must_inspect_result_
4057 NTSYSAPI
4058 BOOLEAN
4059 NTAPI
4060 RtlTimeFieldsToTime(
4061 _In_ PTIME_FIELDS TimeFields,
4062 _Out_ PLARGE_INTEGER Time
4063 );
4064
4065 _Success_(return != 0)
4066 _Must_inspect_result_
4067 NTSYSAPI
4068 BOOLEAN
4069 NTAPI
4070 RtlTimeToSecondsSince1970(
4071 _In_ PLARGE_INTEGER Time,
4072 _Out_ PULONG ElapsedSeconds
4073 );
4074
4075 NTSYSAPI
4076 VOID
4077 NTAPI
4078 RtlTimeToTimeFields(
4079 PLARGE_INTEGER Time,
4080 PTIME_FIELDS TimeFields
4081 );
4082
4083 NTSYSAPI
4084 NTSTATUS
4085 NTAPI
4086 RtlSystemTimeToLocalTime(
4087 _In_ PLARGE_INTEGER SystemTime,
4088 _Out_ PLARGE_INTEGER LocalTime
4089 );
4090
4091 //
4092 // Version Functions
4093 //
4094 _IRQL_requires_max_(PASSIVE_LEVEL)
4095 _Must_inspect_result_
4096 NTSYSAPI
4097 NTSTATUS
4098 NTAPI
4099 RtlVerifyVersionInfo(
4100 _In_ PRTL_OSVERSIONINFOEXW VersionInfo,
4101 _In_ ULONG TypeMask,
4102 _In_ ULONGLONG ConditionMask
4103 );
4104
4105 _IRQL_requires_max_(PASSIVE_LEVEL)
4106 NTSYSAPI
4107 NTSTATUS
4108 NTAPI
4109 RtlGetVersion(
4110 _Out_
4111 _At_(lpVersionInformation->dwOSVersionInfoSize, _Pre_ _Valid_)
4112 _When_(lpVersionInformation->dwOSVersionInfoSize == sizeof(RTL_OSVERSIONINFOEXW),
4113 _At_((PRTL_OSVERSIONINFOEXW)lpVersionInformation, _Out_))
4114 PRTL_OSVERSIONINFOW lpVersionInformation
4115 );
4116
4117 NTSYSAPI
4118 BOOLEAN
4119 NTAPI
4120 RtlGetNtProductType(OUT PNT_PRODUCT_TYPE ProductType);
4121
4122 //
4123 // Secure Memory Functions
4124 //
4125 #ifdef NTOS_MODE_USER
4126 NTSYSAPI
4127 NTSTATUS
4128 NTAPI
4129 RtlRegisterSecureMemoryCacheCallback(
4130 _In_ PRTL_SECURE_MEMORY_CACHE_CALLBACK Callback);
4131
4132 NTSYSAPI
4133 BOOLEAN
4134 NTAPI
4135 RtlFlushSecureMemoryCache(
4136 _In_ PVOID MemoryCache,
4137 _In_opt_ SIZE_T MemoryLength
4138 );
4139 #endif
4140
4141 //
4142 // Boot Status Data Functions
4143 //
4144 #ifdef NTOS_MODE_USER
4145 NTSYSAPI
4146 NTSTATUS
4147 NTAPI
4148 RtlCreateBootStatusDataFile(
4149 VOID
4150 );
4151
4152 NTSYSAPI
4153 NTSTATUS
4154 NTAPI
4155 RtlGetSetBootStatusData(
4156 _In_ HANDLE FileHandle,
4157 _In_ BOOLEAN WriteMode,
4158 _In_ RTL_BSD_ITEM_TYPE DataClass,
4159 _In_ PVOID Buffer,
4160 _In_ ULONG BufferSize,
4161 _Out_opt_ PULONG ReturnLength
4162 );
4163
4164 NTSYSAPI
4165 NTSTATUS
4166 NTAPI
4167 RtlLockBootStatusData(
4168 _Out_ PHANDLE FileHandle
4169 );
4170
4171 NTSYSAPI
4172 NTSTATUS
4173 NTAPI
4174 RtlUnlockBootStatusData(
4175 _In_ HANDLE FileHandle
4176 );
4177 #endif
4178
4179 #ifdef NTOS_MODE_USER
4180 _Must_inspect_result_
4181 NTSYSAPI
4182 NTSTATUS
4183 NTAPI
4184 RtlGUIDFromString(
4185 _In_ PUNICODE_STRING GuidString,
4186 _Out_ GUID *Guid);
4187
4188 _Must_inspect_result_
4189 NTSYSAPI
4190 NTSTATUS
4191 NTAPI
4192 RtlStringFromGUID(
4193 _In_ REFGUID Guid,
4194 _Out_ _At_(GuidString->Buffer, __drv_allocatesMem(Mem))
4195 PUNICODE_STRING GuidString);
4196
4197 NTSYSAPI
4198 NTSTATUS
4199 NTAPI
4200 RtlComputeImportTableHash(
4201 _In_ HANDLE hFile,
4202 _Out_ PCHAR Hash,
4203 _In_ ULONG ImportTableHashRevision
4204 );
4205 #endif
4206
4207 //
4208 // MemoryStream functions
4209 //
4210 #ifdef NTOS_MODE_USER
4211
4212 NTSYSAPI
4213 VOID
4214 NTAPI
4215 RtlInitMemoryStream(
4216 _Out_ PRTL_MEMORY_STREAM Stream
4217 );
4218
4219 NTSYSAPI
4220 VOID
4221 NTAPI
4222 RtlInitOutOfProcessMemoryStream(
4223 _Out_ PRTL_MEMORY_STREAM Stream
4224 );
4225
4226 NTSYSAPI
4227 VOID
4228 NTAPI
4229 RtlFinalReleaseOutOfProcessMemoryStream(
4230 _In_ PRTL_MEMORY_STREAM Stream
4231 );
4232
4233 NTSYSAPI
4234 HRESULT
4235 NTAPI
4236 RtlQueryInterfaceMemoryStream(
4237 _In_ struct IStream *This,
4238 _In_ REFIID RequestedIid,
4239 _Outptr_ PVOID *ResultObject
4240 );
4241
4242 NTSYSAPI
4243 ULONG
4244 NTAPI
4245 RtlAddRefMemoryStream(
4246 _In_ struct IStream *This
4247 );
4248
4249 NTSYSAPI
4250 ULONG
4251 NTAPI
4252 RtlReleaseMemoryStream(
4253 _In_ struct IStream *This
4254 );
4255
4256 NTSYSAPI
4257 HRESULT
4258 NTAPI
4259 RtlReadMemoryStream(
4260 _In_ struct IStream *This,
4261 _Out_writes_bytes_(Length) PVOID Buffer,
4262 _In_ ULONG Length,
4263 _Out_opt_ PULONG BytesRead
4264 );
4265
4266 NTSYSAPI
4267 HRESULT
4268 NTAPI
4269 RtlReadOutOfProcessMemoryStream(
4270 _In_ struct IStream *This,
4271 _Out_writes_bytes_(Length) PVOID Buffer,
4272 _In_ ULONG Length,
4273 _Out_opt_ PULONG BytesRead
4274 );
4275
4276 NTSYSAPI
4277 HRESULT
4278 NTAPI
4279 RtlSeekMemoryStream(
4280 _In_ struct IStream *This,
4281 _In_ LARGE_INTEGER RelativeOffset,
4282 _In_ ULONG Origin,
4283 _Out_opt_ PULARGE_INTEGER ResultOffset
4284 );
4285
4286 NTSYSAPI
4287 HRESULT
4288 NTAPI
4289 RtlCopyMemoryStreamTo(
4290 _In_ struct IStream *This,
4291 _In_ struct IStream *Target,
4292 _In_ ULARGE_INTEGER Length,
4293 _Out_opt_ PULARGE_INTEGER BytesRead,
4294 _Out_opt_ PULARGE_INTEGER BytesWritten
4295 );
4296
4297 NTSYSAPI
4298 HRESULT
4299 NTAPI
4300 RtlCopyOutOfProcessMemoryStreamTo(
4301 _In_ struct IStream *This,
4302 _In_ struct IStream *Target,
4303 _In_ ULARGE_INTEGER Length,
4304 _Out_opt_ PULARGE_INTEGER BytesRead,
4305 _Out_opt_ PULARGE_INTEGER BytesWritten
4306 );
4307
4308 NTSYSAPI
4309 HRESULT
4310 NTAPI
4311 RtlStatMemoryStream(
4312 _In_ struct IStream *This,
4313 _Out_ struct tagSTATSTG *Stats,
4314 _In_ ULONG Flags
4315 );
4316
4317 // Dummy functions
4318 NTSYSAPI
4319 HRESULT
4320 NTAPI
4321 RtlWriteMemoryStream(
4322 _In_ struct IStream *This,
4323 _In_reads_bytes_(Length) CONST VOID *Buffer,
4324 _In_ ULONG Length,
4325 _Out_opt_ PULONG BytesWritten
4326 );
4327
4328 NTSYSAPI
4329 HRESULT
4330 NTAPI
4331 RtlSetMemoryStreamSize(
4332 _In_ struct IStream *This,
4333 _In_ ULARGE_INTEGER NewSize
4334 );
4335
4336 NTSYSAPI
4337 HRESULT
4338 NTAPI
4339 RtlCommitMemoryStream(
4340 _In_ struct IStream *This,
4341 _In_ ULONG CommitFlags
4342 );
4343
4344 NTSYSAPI
4345 HRESULT
4346 NTAPI
4347 RtlRevertMemoryStream(
4348 _In_ struct IStream *This
4349 );
4350
4351 NTSYSAPI
4352 HRESULT
4353 NTAPI
4354 RtlLockMemoryStreamRegion(
4355 _In_ struct IStream *This,
4356 _In_ ULARGE_INTEGER Offset,
4357 _In_ ULARGE_INTEGER Length,
4358 _In_ ULONG LockType
4359 );
4360
4361 NTSYSAPI
4362 HRESULT
4363 NTAPI
4364 RtlUnlockMemoryStreamRegion(
4365 _In_ struct IStream *This,
4366 _In_ ULARGE_INTEGER Offset,
4367 _In_ ULARGE_INTEGER Length,
4368 _In_ ULONG LockType
4369 );
4370
4371 NTSYSAPI
4372 HRESULT
4373 NTAPI
4374 RtlCloneMemoryStream(
4375 _In_ struct IStream *This,
4376 _Outptr_ struct IStream **ResultStream
4377 );
4378
4379 #endif // NTOS_MODE_USER
4380
4381 #ifdef __cplusplus
4382 }
4383 #endif
4384
4385 #endif