-
Notifications
You must be signed in to change notification settings - Fork 178
/
Copy pathntexapi.h
6845 lines (6034 loc) · 206 KB
/
ntexapi.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
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* Executive support library functions
*
* This file is part of System Informer.
*/
#ifndef _NTEXAPI_H
#define _NTEXAPI_H
#include <ntkeapi.h>
typedef struct _TEB* PTEB;
typedef struct _COUNTED_REASON_CONTEXT* PCOUNTED_REASON_CONTEXT;
typedef struct _FILE_IO_COMPLETION_INFORMATION* PFILE_IO_COMPLETION_INFORMATION;
typedef struct _PORT_MESSAGE* PPORT_MESSAGE;
typedef struct _IMAGE_EXPORT_DIRECTORY* PIMAGE_EXPORT_DIRECTORY;
typedef struct _FILE_OBJECT* PFILE_OBJECT;
typedef struct _DEVICE_OBJECT* PDEVICE_OBJECT;
typedef struct _IRP* PIRP;
typedef struct _RTL_BITMAP* PRTL_BITMAP;
#if (PHNT_MODE != PHNT_MODE_KERNEL)
//
// Thread execution
//
/**
* The NtDelayExecution routine suspends the current thread until the specified condition is met.
*
* @param Alertable The function returns when either the time-out period has elapsed or when the APC function is called.
* @param DelayInterval The time interval for which execution is to be suspended, in milliseconds.
* - A value of zero causes the thread to relinquish the remainder of its time slice to any other thread that is ready to run.
* - If there are no other threads ready to run, the function returns immediately, and the thread continues execution.
* - A value of INFINITE indicates that the suspension should not time out.
* @return NTSTATUS Successful or errant status. The return value is STATUS_USER_APC when Alertable is TRUE, and the function returned due to one or more I/O completion callback functions.
* @remarks Note that a ready thread is not guaranteed to run immediately. Consequently, the thread will not run until some arbitrary time after the sleep interval elapses,
* based upon the system "tick" frequency and the load factor from other processes.
* @see https://learn.microsoft.com/en-us/windows/win32/api/synchapi/nf-synchapi-sleepex
*/
NTSYSCALLAPI
NTSTATUS
NTAPI
NtDelayExecution(
_In_ BOOLEAN Alertable,
_In_ PLARGE_INTEGER DelayInterval
);
//
// Firmware environment values
//
/**
* Retrieves the value of the specified firmware environment variable.
* The user account that the app is running under must have the SE_SYSTEM_ENVIRONMENT_NAME privilege.
*
* @param VariableName The name of the firmware environment variable. The pointer must not be NULL.
* @param VariableValue A pointer to a buffer that receives the value of the specified firmware environment variable.
* @param ValueLength The size of the \c VariableValue buffer, in bytes.
* @param ReturnLength If the function succeeds, the return length is the number of bytes stored in the \c VariableValue buffer.
* @return NTSTATUS Successful or errant status.
*/
NTSYSCALLAPI
NTSTATUS
NTAPI
NtQuerySystemEnvironmentValue(
_In_ PUNICODE_STRING VariableName,
_Out_writes_bytes_(ValueLength) PWSTR VariableValue,
_In_ USHORT ValueLength,
_Out_opt_ PUSHORT ReturnLength
);
// The firmware environment variable is stored in non-volatile memory (e.g. NVRAM).
#define EFI_VARIABLE_NON_VOLATILE 0x00000001
// The firmware environment variable can be accessed during boot service.
#define EFI_VARIABLE_BOOTSERVICE_ACCESS 0x00000002
// The firmware environment variable can be accessed at runtime.
#define EFI_VARIABLE_RUNTIME_ACCESS 0x00000004
// Indicates hardware related errors encountered at runtime.
#define EFI_VARIABLE_HARDWARE_ERROR_RECORD 0x00000008
// Indicates an authentication requirement that must be met before writing to this firmware environment variable.
#define EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS 0x00000010
// Indicates authentication and time stamp requirements that must be met before writing to this firmware environment variable.
// When this attribute is set, the buffer, represented by Buffer, will begin with an instance of a complete (and serialized) EFI_VARIABLE_AUTHENTICATION_2 descriptor.
#define EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS 0x00000020
// Append an existing environment variable with the value of Buffer. If the firmware does not support the operation, the function returns ERROR_INVALID_FUNCTION.
#define EFI_VARIABLE_APPEND_WRITE 0x00000040
// The firmware environment variable will return metadata in addition to variable data.
#define EFI_VARIABLE_ENHANCED_AUTHENTICATED_ACCESS 0x00000080
/**
* Retrieves the value of the specified firmware environment variable and its attributes.
* The user account that the app is running under must have the SE_SYSTEM_ENVIRONMENT_NAME privilege.
*
* @param VariableName The name of the firmware environment variable. The pointer must not be NULL.
* @param VendorGuid The GUID that represents the namespace of the firmware environment variable.
* @param Buffer A pointer to a buffer that receives the value of the specified firmware environment variable.
* @param BufferLength The size of the \c Buffer, in bytes.
* @param Attributes Bitmask identifying UEFI variable attributes associated with the variable.
* @return NTSTATUS Successful or errant status.
*/
NTSYSCALLAPI
NTSTATUS
NTAPI
NtQuerySystemEnvironmentValueEx(
_In_ PCUNICODE_STRING VariableName,
_In_ PCGUID VendorGuid,
_Out_writes_bytes_opt_(*BufferLength) PVOID Buffer,
_Inout_ PULONG BufferLength,
_Out_opt_ PULONG Attributes // EFI_VARIABLE_*
);
/**
* Sets the value of the specified firmware environment variable.
* The user account that the app is running under must have the SE_SYSTEM_ENVIRONMENT_NAME privilege.
*
* @param VariableName The name of the firmware environment variable. The pointer must not be NULL.
* @param VariableValue A pointer to the new value for the firmware environment variable.
* If this parameter is zero, the firmware environment variable is deleted.
* @return NTSTATUS Successful or errant status.
*/
NTSYSCALLAPI
NTSTATUS
NTAPI
NtSetSystemEnvironmentValue(
_In_ PCUNICODE_STRING VariableName,
_In_ PCUNICODE_STRING VariableValue
);
/**
* Sets the value of the specified firmware environment variable and the attributes that indicate how this variable is stored and maintained.
* The user account that the app is running under must have the SE_SYSTEM_ENVIRONMENT_NAME privilege.
*
* @param VariableName The name of the firmware environment variable. The pointer must not be NULL.
* @param VendorGuid The GUID that represents the namespace of the firmware environment variable.
* @param Buffer A pointer to the new value for the firmware environment variable.
* @param BufferLength The size of the pValue buffer, in bytes.
* Unless the VARIABLE_ATTRIBUTE_APPEND_WRITE, VARIABLE_ATTRIBUTE_AUTHENTICATED_WRITE_ACCESS,
* or VARIABLE_ATTRIBUTE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS variable attribute is set via dwAttributes,
* setting this value to zero will result in the deletion of this variable.
* @param Attributes Bitmask to set UEFI variable attributes associated with the variable.
* @return NTSTATUS Successful or errant status.
*/
NTSYSCALLAPI
NTSTATUS
NTAPI
NtSetSystemEnvironmentValueEx(
_In_ PCUNICODE_STRING VariableName,
_In_ PCGUID VendorGuid,
_In_reads_bytes_opt_(BufferLength) PVOID Buffer,
_In_ ULONG BufferLength, // 0 = delete variable
_In_ ULONG Attributes // EFI_VARIABLE_*
);
typedef enum _SYSTEM_ENVIRONMENT_INFORMATION_CLASS
{
SystemEnvironmentNameInformation = 1, // q: VARIABLE_NAME
SystemEnvironmentValueInformation = 2, // q: VARIABLE_NAME_AND_VALUE
MaxSystemEnvironmentInfoClass
} SYSTEM_ENVIRONMENT_INFORMATION_CLASS;
typedef struct _VARIABLE_NAME
{
ULONG NextEntryOffset;
GUID VendorGuid;
WCHAR Name[ANYSIZE_ARRAY];
} VARIABLE_NAME, *PVARIABLE_NAME;
typedef struct _VARIABLE_NAME_AND_VALUE
{
ULONG NextEntryOffset;
ULONG ValueOffset;
ULONG ValueLength;
ULONG Attributes;
GUID VendorGuid;
WCHAR Name[ANYSIZE_ARRAY];
//BYTE Value[ANYSIZE_ARRAY];
} VARIABLE_NAME_AND_VALUE, *PVARIABLE_NAME_AND_VALUE;
NTSYSCALLAPI
NTSTATUS
NTAPI
NtEnumerateSystemEnvironmentValuesEx(
_In_ ULONG InformationClass, // SYSTEM_ENVIRONMENT_INFORMATION_CLASS
_Out_ PVOID Buffer,
_Inout_ PULONG BufferLength
);
// EFI
// private
typedef struct _BOOT_ENTRY
{
ULONG Version;
ULONG Length;
ULONG Id;
ULONG Attributes;
ULONG FriendlyNameOffset;
ULONG BootFilePathOffset;
ULONG OsOptionsLength;
_Field_size_bytes_(OsOptionsLength) UCHAR OsOptions[1];
} BOOT_ENTRY, *PBOOT_ENTRY;
// private
typedef struct _BOOT_ENTRY_LIST
{
ULONG NextEntryOffset;
BOOT_ENTRY BootEntry;
} BOOT_ENTRY_LIST, *PBOOT_ENTRY_LIST;
// private
typedef struct _BOOT_OPTIONS
{
ULONG Version;
ULONG Length;
ULONG Timeout;
ULONG CurrentBootEntryId;
ULONG NextBootEntryId;
WCHAR HeadlessRedirection[1];
} BOOT_OPTIONS, *PBOOT_OPTIONS;
// private
typedef struct _FILE_PATH
{
ULONG Version;
ULONG Length;
ULONG Type;
_Field_size_bytes_(Length) UCHAR FilePath[1];
} FILE_PATH, *PFILE_PATH;
// private
typedef struct _EFI_DRIVER_ENTRY
{
ULONG Version;
ULONG Length;
ULONG Id;
ULONG FriendlyNameOffset;
ULONG DriverFilePathOffset;
} EFI_DRIVER_ENTRY, *PEFI_DRIVER_ENTRY;
// private
typedef struct _EFI_DRIVER_ENTRY_LIST
{
ULONG NextEntryOffset;
EFI_DRIVER_ENTRY DriverEntry;
} EFI_DRIVER_ENTRY_LIST, *PEFI_DRIVER_ENTRY_LIST;
#if (PHNT_VERSION >= PHNT_WINXP)
/**
* The NtAddBootEntry routine adds a new boot entry to the system boot configuration.
*
* @param BootEntry A pointer to a BOOT_ENTRY structure that specifies the boot entry to be added.
* @param Id A pointer to a variable that receives the identifier of the new boot entry.
* @return NTSTATUS Successful or errant status.
*/
NTSYSCALLAPI
NTSTATUS
NTAPI
NtAddBootEntry(
_In_ PBOOT_ENTRY BootEntry,
_Out_opt_ PULONG Id
);
/**
* The NtDeleteBootEntry routine deletes an existing boot entry from the system boot configuration.
*
* @param Id The identifier of the boot entry to be deleted.
* @return NTSTATUS Successful or errant status.
*/
NTSYSCALLAPI
NTSTATUS
NTAPI
NtDeleteBootEntry(
_In_ ULONG Id
);
/**
* The NtModifyBootEntry routine modifies an existing boot entry in the system boot configuration.
*
* @param BootEntry A pointer to a BOOT_ENTRY structure that specifies the new boot entry information.
* @return NTSTATUS Successful or errant status.
*/
NTSYSCALLAPI
NTSTATUS
NTAPI
NtModifyBootEntry(
_In_ PBOOT_ENTRY BootEntry
);
/**
* The NtEnumerateBootEntries routine retrieves information about all boot entries in the system boot configuration.
*
* @param Buffer A pointer to a buffer that receives the boot entries information.
* @param BufferLength A pointer to a variable that specifies the size of the buffer. On return, it contains the size of the data returned.
* @return NTSTATUS Successful or errant status.
*/
NTSYSCALLAPI
NTSTATUS
NTAPI
NtEnumerateBootEntries(
_Out_writes_bytes_opt_(*BufferLength) PVOID Buffer,
_Inout_ PULONG BufferLength
);
/**
* The NtQueryBootEntryOrder routine retrieves the current boot entry order.
*
* @param Ids A pointer to a buffer that receives the identifiers of the boot entries in the current boot order.
* @param Count A pointer to a variable that specifies the number of entries in the buffer. On return, it contains the number of entries returned.
* @return NTSTATUS Successful or errant status.
*/
NTSYSCALLAPI
NTSTATUS
NTAPI
NtQueryBootEntryOrder(
_Out_writes_opt_(*Count) PULONG Ids,
_Inout_ PULONG Count
);
/**
* The NtSetBootEntryOrder routine sets the boot entry order.
*
* @param Ids A pointer to a buffer that specifies the identifiers of the boot entries in the desired boot order.
* @param Count The number of entries in the buffer.
* @return NTSTATUS Successful or errant status.
*/
NTSYSCALLAPI
NTSTATUS
NTAPI
NtSetBootEntryOrder(
_In_reads_(Count) PULONG Ids,
_In_ ULONG Count
);
/**
* The NtQueryBootOptions routine retrieves the current boot options.
*
* @param BootOptions A pointer to a buffer that receives the boot options.
* @param BootOptionsLength A pointer to a variable that specifies the size of the buffer. On return, it contains the size of the data returned.
* @return NTSTATUS Successful or errant status.
*/
NTSYSCALLAPI
NTSTATUS
NTAPI
NtQueryBootOptions(
_Out_writes_bytes_opt_(*BootOptionsLength) PBOOT_OPTIONS BootOptions,
_Inout_ PULONG BootOptionsLength
);
/**
* The NtSetBootOptions routine sets the boot options.
*
* @param BootOptions A pointer to a BOOT_OPTIONS structure that specifies the new boot options.
* @param FieldsToChange A bitmask that specifies which fields in the BOOT_OPTIONS structure are to be changed.
* @return NTSTATUS Successful or errant status.
*/
NTSYSCALLAPI
NTSTATUS
NTAPI
NtSetBootOptions(
_In_ PBOOT_OPTIONS BootOptions,
_In_ ULONG FieldsToChange
);
/**
* The NtTranslateFilePath routine translates a file path from one format to another.
*
* @param InputFilePath A pointer to a FILE_PATH structure that specifies the input file path.
* @param OutputType The type of the output file path.
* @param OutputFilePath A pointer to a buffer that receives the translated file path.
* @param OutputFilePathLength A pointer to a variable that specifies the size of the buffer. On return, it contains the size of the data returned.
* @return NTSTATUS Successful or errant status.
*/
NTSYSCALLAPI
NTSTATUS
NTAPI
NtTranslateFilePath(
_In_ PFILE_PATH InputFilePath,
_In_ ULONG OutputType,
_Out_writes_bytes_opt_(*OutputFilePathLength) PFILE_PATH OutputFilePath,
_Inout_opt_ PULONG OutputFilePathLength
);
/**
* The NtAddDriverEntry routine adds a new driver entry to the system boot configuration.
*
* @param DriverEntry A pointer to an EFI_DRIVER_ENTRY structure that specifies the driver entry to be added.
* @param Id A pointer to a variable that receives the identifier of the new driver entry.
* @return NTSTATUS Successful or errant status.
*/
NTSYSCALLAPI
NTSTATUS
NTAPI
NtAddDriverEntry(
_In_ PEFI_DRIVER_ENTRY DriverEntry,
_Out_opt_ PULONG Id
);
/**
* The NtDeleteDriverEntry routine deletes an existing driver entry from the system boot configuration.
*
* @param Id The identifier of the driver entry to be deleted.
* @return NTSTATUS Successful or errant status.
*/
NTSYSCALLAPI
NTSTATUS
NTAPI
NtDeleteDriverEntry(
_In_ ULONG Id
);
/**
* The NtModifyDriverEntry routine modifies an existing driver entry in the system boot configuration.
*
* @param DriverEntry A pointer to an EFI_DRIVER_ENTRY structure that specifies the new driver entry information.
* @return NTSTATUS Successful or errant status.
*/
NTSYSCALLAPI
NTSTATUS
NTAPI
NtModifyDriverEntry(
_In_ PEFI_DRIVER_ENTRY DriverEntry
);
/**
* The NtEnumerateDriverEntries routine retrieves information about all driver entries in the system boot configuration.
*
* @param Buffer A pointer to a buffer that receives the driver entries information.
* @param BufferLength A pointer to a variable that specifies the size of the buffer. On return, it contains the size of the data returned.
* @return NTSTATUS Successful or errant status.
*/
NTSYSCALLAPI
NTSTATUS
NTAPI
NtEnumerateDriverEntries(
_Out_writes_bytes_opt_(*BufferLength) PVOID Buffer,
_Inout_ PULONG BufferLength
);
/**
* The NtQueryDriverEntryOrder routine retrieves the current driver entry order.
*
* @param Ids A pointer to a buffer that receives the identifiers of the driver entries in the current driver order.
* @param Count A pointer to a variable that specifies the number of entries in the buffer. On return, it contains the number of entries returned.
* @return NTSTATUS Successful or errant status.
*/
NTSYSCALLAPI
NTSTATUS
NTAPI
NtQueryDriverEntryOrder(
_Out_writes_opt_(*Count) PULONG Ids,
_Inout_ PULONG Count
);
/**
* The NtSetDriverEntryOrder routine sets the driver entry order.
*
* @param Ids A pointer to a buffer that specifies the identifiers of the driver entries in the desired driver order.
* @param Count The number of entries in the buffer.
* @return NTSTATUS Successful or errant status.
*/
NTSYSCALLAPI
NTSTATUS
NTAPI
NtSetDriverEntryOrder(
_In_reads_(Count) PULONG Ids,
_In_ ULONG Count
);
#endif
typedef enum _FILTER_BOOT_OPTION_OPERATION
{
FilterBootOptionOperationOpenSystemStore,
FilterBootOptionOperationSetElement,
FilterBootOptionOperationDeleteElement,
FilterBootOptionOperationMax
} FILTER_BOOT_OPTION_OPERATION;
#if (PHNT_VERSION >= PHNT_WIN8)
/**
* The NtFilterBootOption routine filters boot options based on the specified operation, object type, and element type.
*
* @param FilterOperation The operation to be performed on the boot option. This can be one of the values from the FILTER_BOOT_OPTION_OPERATION enumeration.
* @param ObjectType The type of the object to be filtered.
* @param ElementType The type of the element within the object to be filtered.
* @param Data A pointer to a buffer that contains the data to be used in the filter operation. This parameter is optional and can be NULL.
* @param DataSize The size, in bytes, of the data buffer pointed to by the Data parameter.
* @return NTSTATUS Successful or errant status.
*/
NTSYSCALLAPI
NTSTATUS
NTAPI
NtFilterBootOption(
_In_ FILTER_BOOT_OPTION_OPERATION FilterOperation,
_In_ ULONG ObjectType,
_In_ ULONG ElementType,
_In_reads_bytes_opt_(DataSize) PVOID Data,
_In_ ULONG DataSize
);
#endif
//
// Event
//
#ifndef EVENT_QUERY_STATE
#define EVENT_QUERY_STATE 0x0001
#endif
#ifndef EVENT_MODIFY_STATE
#define EVENT_MODIFY_STATE 0x0002
#endif
#ifndef EVENT_ALL_ACCESS
#define EVENT_ALL_ACCESS (EVENT_QUERY_STATE|EVENT_MODIFY_STATE|STANDARD_RIGHTS_REQUIRED|SYNCHRONIZE)
#endif
typedef enum _EVENT_INFORMATION_CLASS
{
EventBasicInformation
} EVENT_INFORMATION_CLASS;
typedef struct _EVENT_BASIC_INFORMATION
{
EVENT_TYPE EventType;
LONG EventState;
} EVENT_BASIC_INFORMATION, *PEVENT_BASIC_INFORMATION;
/**
* The NtCreateEvent routine creates an event object, sets the initial state of the event to the specified value,
* and opens a handle to the object with the specified desired access.
*
* @param EventHandle A pointer to a variable that receives the event object handle.
* @param DesiredAccess The access mask that specifies the requested access to the event object.
* @param ObjectAttributes A pointer to an OBJECT_ATTRIBUTES structure that specifies the object attributes.
* @param EventType The type of the event, which can be SynchronizationEvent or a NotificationEvent.
* @param InitialState The initial state of the event object.
* @return NTSTATUS Successful or errant status.
* @see https://learn.microsoft.com/en-us/windows-hardware/drivers/ddi/ntifs/nf-ntifs-zwcreateevent
*/
NTSYSCALLAPI
NTSTATUS
NTAPI
NtCreateEvent(
_Out_ PHANDLE EventHandle,
_In_ ACCESS_MASK DesiredAccess,
_In_opt_ POBJECT_ATTRIBUTES ObjectAttributes,
_In_ EVENT_TYPE EventType,
_In_ BOOLEAN InitialState
);
/**
* The NtOpenEvent routine opens a handle to an existing event object.
*
* @param EventHandle A pointer to a variable that receives the event object handle.
* @param DesiredAccess The access mask that specifies the requested access to the event object.
* @param ObjectAttributes A pointer to an OBJECT_ATTRIBUTES structure that specifies the object attributes.
* @return NTSTATUS Successful or errant status.
*/
NTSYSCALLAPI
NTSTATUS
NTAPI
NtOpenEvent(
_Out_ PHANDLE EventHandle,
_In_ ACCESS_MASK DesiredAccess,
_In_ POBJECT_ATTRIBUTES ObjectAttributes
);
/**
* The NtSetEvent routine sets an event object to the signaled state.
*
* @param EventHandle A handle to the event object.
* @param PreviousState A pointer to a variable that receives the previous state of the event object.
* @return NTSTATUS Successful or errant status.
*/
NTSYSCALLAPI
NTSTATUS
NTAPI
NtSetEvent(
_In_ HANDLE EventHandle,
_Out_opt_ PLONG PreviousState
);
#if (PHNT_VERSION >= PHNT_WIN11)
/**
* The NtSetEventEx routine sets an event object to the signaled state and optionally acquires a lock.
*
* @param ThreadId A handle to the thread.
* @param Lock A pointer to an RTL_SRWLOCK structure that specifies the lock to acquire.
* @return NTSTATUS Successful or errant status.
*/
NTSYSCALLAPI
NTSTATUS
NTAPI
NtSetEventEx(
_In_ HANDLE ThreadId,
_In_opt_ PRTL_SRWLOCK Lock
);
#endif
/**
* The NtSetEventBoostPriority routine sets an event object to the signaled state and boosts the priority of threads waiting on the event.
*
* @param EventHandle A handle to the event object.
* @return NTSTATUS Successful or errant status.
*/
NTSYSCALLAPI
NTSTATUS
NTAPI
NtSetEventBoostPriority(
_In_ HANDLE EventHandle
);
/**
* The NtClearEvent routine sets an event object to the not-signaled state.
*
* @param EventHandle A handle to the event object.
* @return NTSTATUS Successful or errant status.
*/
NTSYSCALLAPI
NTSTATUS
NTAPI
NtClearEvent(
_In_ HANDLE EventHandle
);
/**
* The NtResetEvent routine sets an event object to the not-signaled state and optionally returns the previous state.
*
* @param EventHandle A handle to the event object.
* @param PreviousState A pointer to a variable that receives the previous state of the event object.
* @return NTSTATUS Successful or errant status.
* @see https://learn.microsoft.com/en-us/windows/win32/api/synchapi/nf-synchapi-resetevent
*/
NTSYSCALLAPI
NTSTATUS
NTAPI
NtResetEvent(
_In_ HANDLE EventHandle,
_Out_opt_ PLONG PreviousState
);
/**
* The NtPulseEvent routine sets an event object to the signaled state and then resets it to the not-signaled state after releasing the appropriate number of waiting threads.
*
* @param EventHandle A handle to the event object.
* @param PreviousState A pointer to a variable that receives the previous state of the event object.
* @return NTSTATUS Successful or errant status.
* @see https://learn.microsoft.com/en-us/windows/win32/api/winbase/nf-winbase-pulseevent
*/
NTSYSCALLAPI
NTSTATUS
NTAPI
NtPulseEvent(
_In_ HANDLE EventHandle,
_Out_opt_ PLONG PreviousState
);
/**
* The NtQueryEvent routine retrieves information about an event object.
*
* @param EventHandle A handle to the event object.
* @param EventInformationClass The type of information to be retrieved.
* @param EventInformation A pointer to a buffer that receives the requested information.
* @param EventInformationLength The size of the buffer pointed to by EventInformation.
* @param ReturnLength A pointer to a variable that receives the size of the data returned in the buffer.
* @return NTSTATUS Successful or errant status.
*/
NTSYSCALLAPI
NTSTATUS
NTAPI
NtQueryEvent(
_In_ HANDLE EventHandle,
_In_ EVENT_INFORMATION_CLASS EventInformationClass,
_Out_writes_bytes_(EventInformationLength) PVOID EventInformation,
_In_ ULONG EventInformationLength,
_Out_opt_ PULONG ReturnLength
);
//
// Event Pair
//
#define EVENT_PAIR_ALL_ACCESS (STANDARD_RIGHTS_REQUIRED | SYNCHRONIZE)
/**
* The NtCreateEventPair routine creates an event pair object and opens a handle to the object with the specified desired access.
*
* @param EventPairHandle A pointer to a variable that receives the event pair object handle.
* @param DesiredAccess The access mask that specifies the requested access to the event pair object.
* @param ObjectAttributes A pointer to an OBJECT_ATTRIBUTES structure that specifies the object attributes.
* @return NTSTATUS Successful or errant status.
*/
NTSYSCALLAPI
NTSTATUS
NTAPI
NtCreateEventPair(
_Out_ PHANDLE EventPairHandle,
_In_ ACCESS_MASK DesiredAccess,
_In_opt_ PCOBJECT_ATTRIBUTES ObjectAttributes
);
/**
* The NtOpenEventPair routine opens a handle to an existing event pair object.
*
* @param EventPairHandle A pointer to a variable that receives the event pair object handle.
* @param DesiredAccess The access mask that specifies the requested access to the event pair object.
* @param ObjectAttributes A pointer to an OBJECT_ATTRIBUTES structure that specifies the object attributes.
* @return NTSTATUS Successful or errant status.
*/
NTSYSCALLAPI
NTSTATUS
NTAPI
NtOpenEventPair(
_Out_ PHANDLE EventPairHandle,
_In_ ACCESS_MASK DesiredAccess,
_In_ PCOBJECT_ATTRIBUTES ObjectAttributes
);
/**
* The NtSetLowEventPair routine sets the low event in an event pair to the signaled state.
*
* @param EventPairHandle A handle to the event pair object.
* @return NTSTATUS Successful or errant status.
*/
NTSYSCALLAPI
NTSTATUS
NTAPI
NtSetLowEventPair(
_In_ HANDLE EventPairHandle
);
/**
* The NtSetHighEventPair routine sets the high event in an event pair to the signaled state.
*
* @param EventPairHandle A handle to the event pair object.
* @return NTSTATUS Successful or errant status.
*/
NTSYSCALLAPI
NTSTATUS
NTAPI
NtSetHighEventPair(
_In_ HANDLE EventPairHandle
);
/**
* The NtWaitLowEventPair routine waits for the low event in an event pair to be set to the signaled state.
*
* @param EventPairHandle A handle to the event pair object.
* @return NTSTATUS Successful or errant status.
*/
NTSYSCALLAPI
NTSTATUS
NTAPI
NtWaitLowEventPair(
_In_ HANDLE EventPairHandle
);
/**
* The NtWaitHighEventPair routine waits for the high event in an event pair to be set to the signaled state.
*
* @param EventPairHandle A handle to the event pair object.
* @return NTSTATUS Successful or errant status.
*/
NTSYSCALLAPI
NTSTATUS
NTAPI
NtWaitHighEventPair(
_In_ HANDLE EventPairHandle
);
/**
* The NtSetLowWaitHighEventPair routine sets the low event in an event pair to the signaled state and waits for the high event to be set to the signaled state.
*
* @param EventPairHandle A handle to the event pair object.
* @return NTSTATUS Successful or errant status.
*/
NTSYSCALLAPI
NTSTATUS
NTAPI
NtSetLowWaitHighEventPair(
_In_ HANDLE EventPairHandle
);
/**
* The NtSetHighWaitLowEventPair routine sets the high event in an event pair to the signaled state and waits for the low event to be set to the signaled state.
*
* @param EventPairHandle A handle to the event pair object.
* @return NTSTATUS Successful or errant status.
*/
NTSYSCALLAPI
NTSTATUS
NTAPI
NtSetHighWaitLowEventPair(
_In_ HANDLE EventPairHandle
);
//
// Mutant
//
#ifndef MUTANT_QUERY_STATE
#define MUTANT_QUERY_STATE 0x0001
#endif
#ifndef MUTANT_ALL_ACCESS
#define MUTANT_ALL_ACCESS (MUTANT_QUERY_STATE|STANDARD_RIGHTS_REQUIRED|SYNCHRONIZE)
#endif
typedef enum _MUTANT_INFORMATION_CLASS
{
MutantBasicInformation, // MUTANT_BASIC_INFORMATION
MutantOwnerInformation // MUTANT_OWNER_INFORMATION
} MUTANT_INFORMATION_CLASS;
/**
* The MUTANT_BASIC_INFORMATION structure contains basic information about a mutant object.
*/
typedef struct _MUTANT_BASIC_INFORMATION
{
LONG CurrentCount;
BOOLEAN OwnedByCaller;
BOOLEAN AbandonedState;
} MUTANT_BASIC_INFORMATION, *PMUTANT_BASIC_INFORMATION;
/**
* The MUTANT_OWNER_INFORMATION structure contains information about the owner of a mutant object.
*/
typedef struct _MUTANT_OWNER_INFORMATION
{
CLIENT_ID ClientId;
} MUTANT_OWNER_INFORMATION, *PMUTANT_OWNER_INFORMATION;
/**
* The NtCreateMutant routine creates a mutant object, sets the initial state of the mutant to the specified value,
* and opens a handle to the object with the specified desired access.
*
* @param MutantHandle A pointer to a variable that receives the mutant object handle.
* @param DesiredAccess The access mask that specifies the requested access to the mutant object.
* @param ObjectAttributes A pointer to an OBJECT_ATTRIBUTES structure that specifies the object attributes.
* @param InitialOwner If TRUE, the calling thread is the initial owner of the mutant object.
* @return NTSTATUS Successful or errant status.
*/
NTSYSCALLAPI
NTSTATUS
NTAPI
NtCreateMutant(
_Out_ PHANDLE MutantHandle,
_In_ ACCESS_MASK DesiredAccess,
_In_opt_ PCOBJECT_ATTRIBUTES ObjectAttributes,
_In_ BOOLEAN InitialOwner
);
/**
* The NtOpenMutant routine opens a handle to an existing mutant object.
*
* @param MutantHandle A pointer to a variable that receives the mutant object handle.
* @param DesiredAccess The access mask that specifies the requested access to the mutant object.
* @param ObjectAttributes A pointer to an OBJECT_ATTRIBUTES structure that specifies the object attributes.
* @return NTSTATUS Successful or errant status.
*/
NTSYSCALLAPI
NTSTATUS
NTAPI
NtOpenMutant(
_Out_ PHANDLE MutantHandle,
_In_ ACCESS_MASK DesiredAccess,
_In_ PCOBJECT_ATTRIBUTES ObjectAttributes
);
/**
* The NtReleaseMutant routine releases ownership of a mutant object.
*
* @param MutantHandle A handle to the mutant object.
* @param PreviousCount A pointer to a variable that receives the previous count of the mutant object.
* @return NTSTATUS Successful or errant status.
*/
NTSYSCALLAPI
NTSTATUS
NTAPI
NtReleaseMutant(
_In_ HANDLE MutantHandle,
_Out_opt_ PLONG PreviousCount
);
/**
* The NtQueryMutant routine retrieves information about a mutant object.
*
* @param MutantHandle A handle to the mutant object.
* @param MutantInformationClass The type of information to be retrieved.
* @param MutantInformation A pointer to a buffer that receives the requested information.
* @param MutantInformationLength The size of the buffer pointed to by MutantInformation.
* @param ReturnLength A pointer to a variable that receives the size of the data returned in the buffer.
* @return NTSTATUS Successful or errant status.
*/
NTSYSCALLAPI
NTSTATUS
NTAPI
NtQueryMutant(
_In_ HANDLE MutantHandle,
_In_ MUTANT_INFORMATION_CLASS MutantInformationClass,
_Out_writes_bytes_(MutantInformationLength) PVOID MutantInformation,
_In_ ULONG MutantInformationLength,
_Out_opt_ PULONG ReturnLength
);
//
// Semaphore
//
#ifndef SEMAPHORE_QUERY_STATE
#define SEMAPHORE_QUERY_STATE 0x0001
#endif
#ifndef SEMAPHORE_MODIFY_STATE
#define SEMAPHORE_MODIFY_STATE 0x0002
#endif
#ifndef SEMAPHORE_ALL_ACCESS
#define SEMAPHORE_ALL_ACCESS (SEMAPHORE_QUERY_STATE|SEMAPHORE_MODIFY_STATE|STANDARD_RIGHTS_REQUIRED|SYNCHRONIZE)
#endif
typedef enum _SEMAPHORE_INFORMATION_CLASS
{
SemaphoreBasicInformation
} SEMAPHORE_INFORMATION_CLASS;
/**
* The SEMAPHORE_BASIC_INFORMATION structure contains basic information about a semaphore object.
*/
typedef struct _SEMAPHORE_BASIC_INFORMATION
{
LONG CurrentCount;
LONG MaximumCount;
} SEMAPHORE_BASIC_INFORMATION, *PSEMAPHORE_BASIC_INFORMATION;
/**
* The NtCreateSemaphore routine creates a semaphore object, sets the initial count of the semaphore to the specified value,
* and opens a handle to the object with the specified desired access.
*
* @param SemaphoreHandle A pointer to a variable that receives the semaphore object handle.
* @param DesiredAccess The access mask that specifies the requested access to the semaphore object.
* @param ObjectAttributes A pointer to an OBJECT_ATTRIBUTES structure that specifies the object attributes.
* @param InitialCount The initial count of the semaphore object.
* @param MaximumCount The maximum count of the semaphore object.
* @return NTSTATUS Successful or errant status.
*/
NTSYSCALLAPI
NTSTATUS
NTAPI
NtCreateSemaphore(
_Out_ PHANDLE SemaphoreHandle,
_In_ ACCESS_MASK DesiredAccess,
_In_opt_ PCOBJECT_ATTRIBUTES ObjectAttributes,
_In_ LONG InitialCount,
_In_ LONG MaximumCount
);
/**
* The NtOpenSemaphore routine opens a handle to an existing semaphore object.
*
* @param SemaphoreHandle A pointer to a variable that receives the semaphore object handle.
* @param DesiredAccess The access mask that specifies the requested access to the semaphore object.
* @param ObjectAttributes A pointer to an OBJECT_ATTRIBUTES structure that specifies the object attributes.
* @return NTSTATUS Successful or errant status.
*/
NTSYSCALLAPI
NTSTATUS
NTAPI
NtOpenSemaphore(
_Out_ PHANDLE SemaphoreHandle,
_In_ ACCESS_MASK DesiredAccess,
_In_ PCOBJECT_ATTRIBUTES ObjectAttributes
);
/**
* The NtReleaseSemaphore routine increases the count of the specified semaphore object by a specified amount.
*
* @param SemaphoreHandle A handle to the semaphore object.
* @param ReleaseCount The amount by which the semaphore object's count is to be increased.
* @param PreviousCount A pointer to a variable that receives the previous count of the semaphore object.
* @return NTSTATUS Successful or errant status.
*/
NTSYSCALLAPI
NTSTATUS
NTAPI
NtReleaseSemaphore(
_In_ HANDLE SemaphoreHandle,
_In_ LONG ReleaseCount,
_Out_opt_ PLONG PreviousCount
);
/**
* The NtQuerySemaphore routine retrieves information about a semaphore object.
*
* @param SemaphoreHandle A handle to the semaphore object.
* @param SemaphoreInformationClass The type of information to be retrieved.
* @param SemaphoreInformation A pointer to a buffer that receives the requested information.
* @param SemaphoreInformationLength The size of the buffer pointed to by SemaphoreInformation.
* @param ReturnLength A pointer to a variable that receives the size of the data returned in the buffer.