]> mj.ucw.cz Git - pciutils.git/blob - lib/i386-io-windows.h
Merge remote-tracking branch 'github/master'
[pciutils.git] / lib / i386-io-windows.h
1 /*
2  *      The PCI Library -- Access to i386 I/O ports on Windows
3  *
4  *      Copyright (c) 2004 Alexander Stock <stock.alexander@gmx.de>
5  *      Copyright (c) 2006 Martin Mares <mj@ucw.cz>
6  *      Copyright (c) 2021 Pali Rohár <pali@kernel.org>
7  *
8  *      Can be freely distributed and used under the terms of the GNU GPL.
9  */
10
11 #include <io.h>
12 #include <windows.h>
13 #include <aclapi.h>
14
15 #ifdef _MSC_VER
16 /* MSVC compiler provides I/O port intrinsics for both 32 and 64-bit modes. */
17 #pragma intrinsic(_outp)
18 #pragma intrinsic(_outpw)
19 #pragma intrinsic(_outpd)
20 #pragma intrinsic(_inp)
21 #pragma intrinsic(_inpw)
22 #pragma intrinsic(_inpd)
23 #elif defined(_WIN64) || defined(_UCRT)
24 /*
25  * For other compilers I/O port intrinsics are available in <intrin.h> header
26  * file either as inline/external functions or macros. Beware that <intrin.h>
27  * names are different than MSVC intrinsics names and glibc function names.
28  * Usage of <intrin.h> is also the prefered way for 64-bit mode or when using
29  * new UCRT library.
30  */
31 #include <intrin.h>
32 #define _outp(x,y) __outbyte(x,y)
33 #define _outpw(x,y) __outword(x,y)
34 #define _outpd(x,y) __outdword(x,y)
35 #define _inp(x) __inbyte(x)
36 #define _inpw(x) __inword(x)
37 #define _inpd(x) __indword(x)
38 #elif defined(__CRTDLL__)
39 /*
40  * Old 32-bit CRTDLL library does not provide I/O port functions. As this
41  * library exists only in 32-bit mode variant, implement I/O port functions
42  * via 32-bit inline assembly.
43  */
44 static inline int _outp(unsigned short port, int databyte)
45 {
46   asm volatile ("outb %b0, %w1" : : "a" (databyte), "Nd" (port));
47   return databyte;
48 }
49 static inline unsigned short _outpw(unsigned short port, unsigned short dataword)
50 {
51   asm volatile ("outw %w0, %w1" : : "a" (dataword), "Nd" (port));
52   return dataword;
53 }
54 static inline unsigned long _outpd(unsigned short port, unsigned long dataword)
55 {
56   asm volatile ("outl %0, %w1" : : "a" (dataword), "Nd" (port));
57   return dataword;
58 }
59 static inline int _inp(unsigned short port)
60 {
61   unsigned char ret;
62   asm volatile ("inb %w1, %0" : "=a" (ret) : "Nd" (port));
63   return ret;
64 }
65 static inline unsigned short _inpw(unsigned short port)
66 {
67   unsigned short ret;
68   asm volatile ("inw %w1, %0" : "=a" (ret) : "Nd" (port));
69   return ret;
70 }
71 static inline unsigned long _inpd(unsigned short port)
72 {
73   unsigned long ret;
74   asm volatile ("inl %w1, %0" : "=a" (ret) : "Nd" (port));
75   return ret;
76 }
77 #elif !defined(__GNUC__)
78 /*
79  * Old 32-bit MSVCRT (non-UCRT) library provides I/O port functions. Function
80  * prototypes are defined in <conio.h> header file but they are missing in
81  * some MinGW toolchains. So for GCC compiler define them manually.
82  */
83 #include <conio.h>
84 #else
85 int _outp(unsigned short port, int databyte);
86 unsigned short _outpw(unsigned short port, unsigned short dataword);
87 unsigned long _outpd(unsigned short port, unsigned long dataword);
88 int _inp(unsigned short port);
89 unsigned short _inpw(unsigned short port);
90 unsigned long _inpd(unsigned short port);
91 #endif
92
93 #define outb(x,y) _outp(y,x)
94 #define outw(x,y) _outpw(y,x)
95 #define outl(x,y) _outpd(y,x)
96
97 #define inb(x) _inp(x)
98 #define inw(x) _inpw(x)
99 #define inl(x) _inpd(x)
100
101 /*
102  * Define __readeflags() for MSVC and GCC compilers.
103  * MSVC since version 14.00 included in WDK 6001 and since version 15.00
104  * included in VS 2008 provides __readeflags() intrinsic for both 32 and 64-bit
105  * modes. WDK 6001 defines macro __BUILDMACHINE__ to value WinDDK. VS 2008 does
106  * not define this macro at all. MSVC throws error if name of user defined
107  * function conflicts with some MSVC intrinsic.
108  * MSVC supports inline assembly via __asm keyword in 32-bit mode only.
109  * GCC version 4.9.0 and higher provides __builtin_ia32_readeflags_uXX()
110  * builtin for XX-mode.
111  */
112 #if defined(_MSC_VER) && (_MSC_VER >= 1500 || (_MSC_VER >= 1400 && defined(__BUILDMACHINE__)))
113 #pragma intrinsic(__readeflags)
114 #elif defined(__GNUC__) && ((__GNUC__ == 4 && __GNUC_MINOR__ >= 9) || (__GNUC__ > 4))
115 #ifdef __x86_64__
116 #define __readeflags() __builtin_ia32_readeflags_u64()
117 #else
118 #define __readeflags() __builtin_ia32_readeflags_u32()
119 #endif
120 #elif defined(_MSC_VER) && defined(_M_IX86)
121 static inline unsigned int
122 __readeflags(void)
123 {
124   __asm pushfd;
125   __asm pop eax;
126 }
127 #elif defined(__GNUC__)
128 static inline unsigned
129 #ifdef __x86_64__
130 long long
131 #endif
132 int
133 __readeflags(void)
134 {
135   unsigned
136 #ifdef __x86_64__
137   long long
138 #endif
139   int eflags;
140   asm volatile ("pushf\n\tpop %0\n" : "=r" (eflags));
141   return eflags;
142 }
143 #else
144 #error "Unsupported compiler"
145 #endif
146
147 /* Read IOPL of the current process, IOPL is stored in eflag bits [13:12]. */
148 #define read_iopl() ((__readeflags() >> 12) & 0x3)
149
150 /* Unfortunately i586-mingw32msvc toolchain does not provide this constant. */
151 #ifndef PROCESS_QUERY_LIMITED_INFORMATION
152 #define PROCESS_QUERY_LIMITED_INFORMATION 0x1000
153 #endif
154
155 /* Unfortunately some toolchains do not provide this constant. */
156 #ifndef SE_IMPERSONATE_NAME
157 #define SE_IMPERSONATE_NAME TEXT("SeImpersonatePrivilege")
158 #endif
159
160 /*
161  * These psapi functions are available in kernel32.dll library with K32 prefix
162  * on Windows 7 and higher systems. On older Windows systems these functions are
163  * available in psapi.dll libary without K32 prefix. So resolve pointers to
164  * these functions dynamically at runtime from the available system library.
165  * Function GetProcessImageFileNameW() is not available on Windows 2000 and
166  * older systems.
167  */
168 typedef BOOL (WINAPI *EnumProcessesProt)(DWORD *lpidProcess, DWORD cb, DWORD *cbNeeded);
169 typedef DWORD (WINAPI *GetProcessImageFileNameWProt)(HANDLE hProcess, LPWSTR lpImageFileName, DWORD nSize);
170 typedef DWORD (WINAPI *GetModuleFileNameExWProt)(HANDLE hProcess, HMODULE hModule, LPWSTR lpImageFileName, DWORD nSize);
171
172 /*
173  * These aclapi functions are available in advapi.dll library on Windows NT 4.0
174  * and higher systems.
175  */
176 typedef DWORD (WINAPI *GetSecurityInfoProt)(HANDLE handle, SE_OBJECT_TYPE ObjectType, SECURITY_INFORMATION SecurityInfo, PSID *ppsidOwner, PSID *ppsidGroup, PACL *ppDacl, PACL *ppSacl, PSECURITY_DESCRIPTOR *ppSecurityDescriptor);
177 typedef DWORD (WINAPI *SetSecurityInfoProt)(HANDLE handle, SE_OBJECT_TYPE ObjectType, SECURITY_INFORMATION SecurityInfo, PSID psidOwner, PSID psidGroup, PACL pDacl, PACL pSacl);
178 typedef DWORD (WINAPI *SetEntriesInAclProt)(ULONG cCountOfExplicitEntries, PEXPLICIT_ACCESS pListOfExplicitEntries, PACL OldAcl, PACL *NewAcl);
179
180 /*
181  * This errhandlingapi function is available in kernel32.dll library on
182  * Windows 7 and higher systems.
183  */
184 typedef BOOL (WINAPI *SetThreadErrorModeProt)(DWORD dwNewMode, LPDWORD lpOldMode);
185
186 /*
187  * Unfortunately NtSetInformationProcess() function, ProcessUserModeIOPL
188  * constant and all other helpers for its usage are not specified in any
189  * standard WinAPI header file. So define all of required constants and types.
190  * Function NtSetInformationProcess() is available in ntdll.dll library on all
191  * Windows systems but marked as it can be removed in some future version.
192  */
193 #ifndef NTSTATUS
194 #define NTSTATUS LONG
195 #endif
196 #ifndef STATUS_NOT_IMPLEMENTED
197 #define STATUS_NOT_IMPLEMENTED (NTSTATUS)0xC0000002
198 #endif
199 #ifndef STATUS_PRIVILEGE_NOT_HELD
200 #define STATUS_PRIVILEGE_NOT_HELD (NTSTATUS)0xC0000061
201 #endif
202 #ifndef PROCESSINFOCLASS
203 #define PROCESSINFOCLASS DWORD
204 #endif
205 #ifndef ProcessUserModeIOPL
206 #define ProcessUserModeIOPL 16
207 #endif
208 typedef NTSTATUS (NTAPI *NtSetInformationProcessProt)(HANDLE ProcessHandle, PROCESSINFOCLASS ProcessInformationClass, PVOID ProcessInformation, ULONG ProcessInformationLength);
209
210 /*
211  * Check if the current thread has particular privilege in current active access
212  * token. Case when it not possible to determinate it (e.g. current thread does
213  * not have permission to open its own current active access token) is evaluated
214  * as thread does not have that privilege.
215  */
216 static BOOL
217 have_privilege(LUID luid_privilege)
218 {
219   PRIVILEGE_SET priv;
220   HANDLE token;
221   BOOL ret;
222
223   /*
224    * If the current thread does not have active access token then thread
225    * uses primary process access token for all permission checks.
226    */
227   if (!OpenThreadToken(GetCurrentThread(), TOKEN_QUERY, TRUE, &token) &&
228       (GetLastError() != ERROR_NO_TOKEN ||
229        !OpenProcessToken(GetCurrentProcess(), TOKEN_QUERY, &token)))
230     return FALSE;
231
232   priv.PrivilegeCount = 1;
233   priv.Control = PRIVILEGE_SET_ALL_NECESSARY;
234   priv.Privilege[0].Luid = luid_privilege;
235   priv.Privilege[0].Attributes = SE_PRIVILEGE_ENABLED;
236
237   if (!PrivilegeCheck(token, &priv, &ret))
238     return FALSE;
239
240   return ret;
241 }
242
243 /*
244  * Enable or disable particular privilege in specified access token.
245  *
246  * Note that it is not possible to disable privilege in access token with
247  * SE_PRIVILEGE_ENABLED_BY_DEFAULT attribute. This function does not check
248  * this case and incorrectly returns no error even when disabling failed.
249  * Rationale for this decision: Simplification of this function as WinAPI
250  * call AdjustTokenPrivileges() does not signal error in this case too.
251  */
252 static BOOL
253 set_privilege(HANDLE token, LUID luid_privilege, BOOL enable)
254 {
255   TOKEN_PRIVILEGES token_privileges;
256
257   token_privileges.PrivilegeCount = 1;
258   token_privileges.Privileges[0].Luid = luid_privilege;
259   token_privileges.Privileges[0].Attributes = enable ? SE_PRIVILEGE_ENABLED : 0;
260
261   /*
262    * WinAPI function AdjustTokenPrivileges() success also when not all
263    * privileges were enabled. It is always required to check for failure
264    * via GetLastError() call. AdjustTokenPrivileges() always sets error
265    * also when it success, as opposite to other WinAPI functions.
266    */
267   if (!AdjustTokenPrivileges(token, FALSE, &token_privileges, sizeof(token_privileges), NULL, NULL) ||
268       GetLastError() != ERROR_SUCCESS)
269     return FALSE;
270
271   return TRUE;
272 }
273
274 /*
275  * Change access token for the current thread to new specified access token.
276  * Previously active access token is stored in old_token variable and can be
277  * used for reverting to this access token. It is set to NULL if the current
278  * thread previously used primary process access token.
279  */
280 static BOOL
281 change_token(HANDLE new_token, HANDLE *old_token)
282 {
283   HANDLE token;
284
285   if (!OpenThreadToken(GetCurrentThread(), TOKEN_IMPERSONATE, TRUE, &token))
286     {
287       if (GetLastError() != ERROR_NO_TOKEN)
288         return FALSE;
289       token = NULL;
290     }
291
292   if (!ImpersonateLoggedOnUser(new_token))
293     {
294       if (token)
295         CloseHandle(token);
296       return FALSE;
297     }
298
299   *old_token = token;
300   return TRUE;
301 }
302
303 /*
304  * Change access token for the current thread to the primary process access
305  * token. This function fails also when the current thread already uses primary
306  * process access token.
307  */
308 static BOOL
309 change_token_to_primary(HANDLE *old_token)
310 {
311   HANDLE token;
312
313   if (!OpenThreadToken(GetCurrentThread(), TOKEN_IMPERSONATE, TRUE, &token))
314     return FALSE;
315
316   RevertToSelf();
317
318   *old_token = token;
319   return TRUE;
320 }
321
322 /*
323  * Revert to the specified access token for the current thread. When access
324  * token is specified as NULL then revert to the primary process access token.
325  * Use to revert after change_token() or change_token_to_primary() call.
326  */
327 static VOID
328 revert_to_token(HANDLE token)
329 {
330   /*
331    * If SetThreadToken() call fails then there is no option to revert to
332    * the specified previous thread access token. So in this case revert to
333    * the primary process access token.
334    */
335   if (!token || !SetThreadToken(NULL, token))
336     RevertToSelf();
337   if (token)
338     CloseHandle(token);
339 }
340
341 /*
342  * Enable particular privilege for the current thread. And set method how to
343  * revert this privilege (if to revert whole token or only privilege).
344  */
345 static BOOL
346 enable_privilege(LUID luid_privilege, HANDLE *revert_token, BOOL *revert_only_privilege)
347 {
348   HANDLE thread_token;
349   HANDLE new_token;
350
351   if (OpenThreadToken(GetCurrentThread(), TOKEN_ADJUST_PRIVILEGES, TRUE, &thread_token))
352     {
353       if (set_privilege(thread_token, luid_privilege, TRUE))
354         {
355           /*
356            * Indicate that correct revert method is just to
357            * disable privilege in access token.
358            */
359           if (revert_token && revert_only_privilege)
360             {
361               *revert_token = thread_token;
362               *revert_only_privilege = TRUE;
363             }
364           else
365             {
366               CloseHandle(thread_token);
367             }
368           return TRUE;
369         }
370       CloseHandle(thread_token);
371       /*
372        * If enabling privilege failed then try to enable it via
373        * primary process access token.
374        */
375     }
376
377   /*
378    * If the current thread has already active thread access token then
379    * open it with just impersonate right as it would be used only for
380    * future revert.
381    */
382   if (revert_token && revert_only_privilege)
383     {
384       if (!OpenThreadToken(GetCurrentThread(), TOKEN_IMPERSONATE, TRUE, &thread_token))
385         {
386           if (GetLastError() != ERROR_NO_TOKEN)
387             return FALSE;
388           thread_token = NULL;
389         }
390
391       /*
392        * If current thread has no access token (and uses primary
393        * process access token) or it does not have permission to
394        * adjust privileges or it does not have specified privilege
395        * then create a copy of the primary process access token,
396        * assign it for the current thread (= impersonate self)
397        * and then try adjusting privilege again.
398        */
399       if (!ImpersonateSelf(SecurityImpersonation))
400         {
401           if (thread_token)
402             CloseHandle(thread_token);
403           return FALSE;
404         }
405     }
406
407   if (!OpenThreadToken(GetCurrentThread(), TOKEN_ADJUST_PRIVILEGES, TRUE, &new_token))
408     {
409       /* thread_token is set only when we were asked for revert method. */
410       if (revert_token && revert_only_privilege)
411         revert_to_token(thread_token);
412       return FALSE;
413     }
414
415   if (!set_privilege(new_token, luid_privilege, TRUE))
416     {
417       CloseHandle(new_token);
418       /* thread_token is set only when we were asked for revert method. */
419       if (revert_token && revert_only_privilege)
420         revert_to_token(thread_token);
421       return FALSE;
422     }
423
424   /*
425    * Indicate that correct revert method is to change to the previous
426    * access token. Either to the primary process access token or to the
427    * previous thread access token.
428    */
429   if (revert_token && revert_only_privilege)
430     {
431       *revert_token = thread_token;
432       *revert_only_privilege = FALSE;
433     }
434   return TRUE;
435 }
436
437 /*
438  * Revert particular privilege for the current thread was previously enabled by
439  * enable_privilege() call. Either disable privilege in specified access token
440  * or revert to previous access token.
441  */
442 static VOID
443 revert_privilege(LUID luid_privilege, HANDLE revert_token, BOOL revert_only_privilege)
444 {
445   if (revert_only_privilege)
446     {
447       set_privilege(revert_token, luid_privilege, FALSE);
448       CloseHandle(revert_token);
449     }
450   else
451     {
452       revert_to_token(revert_token);
453     }
454 }
455
456 /*
457  * Return owner of the access token used by the current thread. Buffer for
458  * returned owner needs to be released by LocalFree() call.
459  */
460 static TOKEN_OWNER *
461 get_current_token_owner(VOID)
462 {
463   HANDLE token;
464   DWORD length;
465   TOKEN_OWNER *owner;
466
467   /*
468    * If the current thread does not have active access token then thread
469    * uses primary process access token for all permission checks.
470    */
471   if (!OpenThreadToken(GetCurrentThread(), TOKEN_QUERY, TRUE, &token) &&
472       (GetLastError() != ERROR_NO_TOKEN ||
473        !OpenProcessToken(GetCurrentProcess(), TOKEN_QUERY, &token)))
474     return NULL;
475
476   if (!GetTokenInformation(token, TokenOwner, NULL, 0, &length) &&
477       GetLastError() != ERROR_INSUFFICIENT_BUFFER)
478     {
479       CloseHandle(token);
480       return NULL;
481     }
482
483 retry:
484   owner = (TOKEN_OWNER *)LocalAlloc(LPTR, length);
485   if (!owner)
486     {
487       CloseHandle(token);
488       return NULL;
489     }
490
491   if (!GetTokenInformation(token, TokenOwner, owner, length, &length))
492     {
493       /*
494        * Length of token owner (SID) buffer between two get calls may
495        * changes (e.g. by another thread of process), so retry.
496        */
497       if (GetLastError() == ERROR_INSUFFICIENT_BUFFER)
498         {
499           LocalFree(owner);
500           goto retry;
501         }
502       LocalFree(owner);
503       CloseHandle(token);
504       return NULL;
505     }
506
507   CloseHandle(token);
508   return owner;
509 }
510
511 /*
512  * Grant particular permissions in the primary access token of the specified
513  * process for the owner of current thread token and set old DACL of the
514  * process access token for reverting permissions. Security descriptor is
515  * just memory buffer for old DACL.
516  */
517 static BOOL
518 grant_process_token_dacl_permissions(HANDLE process, DWORD permissions, HANDLE *token, PACL *old_dacl, PSECURITY_DESCRIPTOR *security_descriptor)
519 {
520   GetSecurityInfoProt MyGetSecurityInfo;
521   SetSecurityInfoProt MySetSecurityInfo;
522   SetEntriesInAclProt MySetEntriesInAcl;
523   EXPLICIT_ACCESS explicit_access;
524   TOKEN_OWNER *owner;
525   HMODULE advapi32;
526   PACL new_dacl;
527
528   /*
529    * This source file already uses advapi32.dll library, so it is
530    * linked to executable and automatically loaded when starting
531    * current running process.
532    */
533   advapi32 = GetModuleHandle(TEXT("advapi32.dll"));
534   if (!advapi32)
535     return FALSE;
536
537   /*
538    * It does not matter if SetEntriesInAclA() or SetEntriesInAclW() is
539    * called as no string is passed to SetEntriesInAcl function.
540    */
541   MyGetSecurityInfo = (GetSecurityInfoProt)(LPVOID)GetProcAddress(advapi32, "GetSecurityInfo");
542   MySetSecurityInfo = (SetSecurityInfoProt)(LPVOID)GetProcAddress(advapi32, "SetSecurityInfo");
543   MySetEntriesInAcl = (SetEntriesInAclProt)(LPVOID)GetProcAddress(advapi32, "SetEntriesInAclA");
544   if (!MyGetSecurityInfo || !MySetSecurityInfo || !MySetEntriesInAcl)
545     return FALSE;
546
547   owner = get_current_token_owner();
548   if (!owner)
549     return FALSE;
550
551   /*
552    * READ_CONTROL is required for GetSecurityInfo(DACL_SECURITY_INFORMATION)
553    * and WRITE_DAC is required for SetSecurityInfo(DACL_SECURITY_INFORMATION).
554    */
555   if (!OpenProcessToken(process, READ_CONTROL | WRITE_DAC, token))
556     {
557       LocalFree(owner);
558       return FALSE;
559     }
560
561   if (MyGetSecurityInfo(*token, SE_KERNEL_OBJECT, DACL_SECURITY_INFORMATION, NULL, NULL, old_dacl, NULL, security_descriptor) != ERROR_SUCCESS)
562     {
563       LocalFree(owner);
564       CloseHandle(*token);
565       return FALSE;
566     }
567
568   /*
569    * Set new explicit access for the owner of the current thread access
570    * token with non-inherited granting access to specified permissions.
571    */
572   explicit_access.grfAccessPermissions = permissions;
573   explicit_access.grfAccessMode = GRANT_ACCESS;
574   explicit_access.grfInheritance = NO_PROPAGATE_INHERIT_ACE;
575   explicit_access.Trustee.pMultipleTrustee = NULL;
576   explicit_access.Trustee.MultipleTrusteeOperation = NO_MULTIPLE_TRUSTEE;
577   explicit_access.Trustee.TrusteeForm = TRUSTEE_IS_SID;
578   explicit_access.Trustee.TrusteeType = TRUSTEE_IS_USER;
579   /*
580    * Unfortunately i586-mingw32msvc toolchain does not have pSid pointer
581    * member in Trustee union. So assign owner SID to ptstrName pointer
582    * member which aliases with pSid pointer member in the same union.
583    */
584   explicit_access.Trustee.ptstrName = (PVOID)owner->Owner;
585
586   if (MySetEntriesInAcl(1, &explicit_access, *old_dacl, &new_dacl) != ERROR_SUCCESS)
587     {
588       LocalFree(*security_descriptor);
589       LocalFree(owner);
590       CloseHandle(*token);
591       return FALSE;
592     }
593
594   if (MySetSecurityInfo(*token, SE_KERNEL_OBJECT, DACL_SECURITY_INFORMATION, NULL, NULL, new_dacl, NULL) != ERROR_SUCCESS)
595     {
596       LocalFree(*security_descriptor);
597       LocalFree(owner);
598       CloseHandle(*token);
599       return FALSE;
600     }
601
602   LocalFree(owner);
603   return TRUE;
604 }
605
606 /*
607  * Revert particular granted permissions in specified access token done by
608  * grant_process_token_dacl_permissions() call.
609  */
610 static VOID
611 revert_token_dacl_permissions(HANDLE token, PACL old_dacl, PSECURITY_DESCRIPTOR security_descriptor)
612 {
613   SetSecurityInfoProt MySetSecurityInfo;
614   HMODULE advapi32;
615
616   /*
617    * This source file already uses advapi32.dll library, so it is
618    * linked to executable and automatically loaded when starting
619    * current running process.
620    */
621   advapi32 = GetModuleHandle(TEXT("advapi32.dll"));
622   if (advapi32)
623     {
624       MySetSecurityInfo = (SetSecurityInfoProt)(LPVOID)GetProcAddress(advapi32, "SetSecurityInfo");
625       MySetSecurityInfo(token, SE_KERNEL_OBJECT, DACL_SECURITY_INFORMATION, NULL, NULL, old_dacl, NULL);
626     }
627
628   LocalFree(security_descriptor);
629   CloseHandle(token);
630 }
631
632 /*
633  * Change error mode of the current thread. If it is not possible then change
634  * error mode of the whole process. Always returns previous error mode.
635  */
636 static UINT
637 change_error_mode(UINT new_mode)
638 {
639   SetThreadErrorModeProt MySetThreadErrorMode = NULL;
640   HMODULE kernel32;
641   DWORD old_mode;
642
643   /*
644    * Function SetThreadErrorMode() was introduced in Windows 7, so use
645    * GetProcAddress() for compatibility with older systems.
646    */
647   kernel32 = GetModuleHandle(TEXT("kernel32.dll"));
648   if (kernel32)
649     MySetThreadErrorMode = (SetThreadErrorModeProt)(LPVOID)GetProcAddress(kernel32, "SetThreadErrorMode");
650
651   if (MySetThreadErrorMode &&
652       MySetThreadErrorMode(new_mode, &old_mode))
653     return old_mode;
654
655   /*
656    * Fallback to function SetErrorMode() which modifies error mode of the
657    * whole process and returns old mode.
658    */
659   return SetErrorMode(new_mode);
660 }
661
662 /*
663  * Open process handle specified by the process id with the query right and
664  * optionally also with vm read right.
665  */
666 static HANDLE
667 open_process_for_query(DWORD pid, BOOL with_vm_read)
668 {
669   BOOL revert_only_privilege;
670   LUID luid_debug_privilege;
671   OSVERSIONINFO version;
672   DWORD process_right;
673   HANDLE revert_token;
674   HANDLE process;
675
676   /*
677    * Some processes on Windows Vista and higher systems can be opened only
678    * with PROCESS_QUERY_LIMITED_INFORMATION right. This right is enough
679    * for accessing primary process token. But this right is not supported
680    * on older pre-Vista systems. When the current thread on these older
681    * systems does not have Debug privilege then OpenProcess() fails with
682    * ERROR_ACCESS_DENIED. If the current thread has Debug privilege then
683    * OpenProcess() success and returns handle to requested process.
684    * Problem is that this handle does not have PROCESS_QUERY_INFORMATION
685    * right and so cannot be used for accessing primary process token
686    * on those older systems. Moreover it has zero rights and therefore
687    * such handle is fully useless. So never try to use open process with
688    * PROCESS_QUERY_LIMITED_INFORMATION right on older systems than
689    * Windows Vista (NT 6.0).
690    */
691   version.dwOSVersionInfoSize = sizeof(version);
692   if (GetVersionEx(&version) &&
693       version.dwPlatformId == VER_PLATFORM_WIN32_NT &&
694       version.dwMajorVersion >= 6)
695     process_right = PROCESS_QUERY_LIMITED_INFORMATION;
696   else
697     process_right = PROCESS_QUERY_INFORMATION;
698
699   if (with_vm_read)
700     process_right |= PROCESS_VM_READ;
701
702   process = OpenProcess(process_right, FALSE, pid);
703   if (process)
704     return process;
705
706   /*
707    * It is possible to open only processes to which owner of the current
708    * thread access token has permissions. For opening other processing it
709    * is required to have Debug privilege enabled. By default local
710    * administrators have this privilege, but it is disabled. So try to
711    * enable it and then try to open process again.
712    */
713
714   if (!LookupPrivilegeValue(NULL, SE_DEBUG_NAME, &luid_debug_privilege))
715     return NULL;
716
717   if (!enable_privilege(luid_debug_privilege, &revert_token, &revert_only_privilege))
718     return NULL;
719
720   process = OpenProcess(process_right, FALSE, pid);
721
722   revert_privilege(luid_debug_privilege, revert_token, revert_only_privilege);
723
724   return process;
725 }
726
727 /*
728  * Check if process image path name (wide string) matches exe file name
729  * (7-bit ASCII string). Do case-insensitive string comparison. Process
730  * image path name can be in any namespace format (DOS, Win32, UNC, ...).
731  */
732 static BOOL
733 check_process_name(LPCWSTR path, DWORD path_length, LPCSTR exe_file)
734 {
735   DWORD exe_file_length;
736   WCHAR c1;
737   UCHAR c2;
738   DWORD i;
739
740   exe_file_length = 0;
741   while (exe_file[exe_file_length] != '\0')
742     exe_file_length++;
743
744   /* Path must have backslash before exe file name. */
745   if (exe_file_length >= path_length ||
746       path[path_length-exe_file_length-1] != L'\\')
747     return FALSE;
748
749   for (i = 0; i < exe_file_length; i++)
750     {
751       c1 = path[path_length-exe_file_length+i];
752       c2 = exe_file[i];
753       /*
754        * Input string for comparison is 7-bit ASCII and file name part
755        * of path must not contain backslash as it is path separator.
756        */
757       if (c1 >= 0x80 || c2 >= 0x80 || c1 == L'\\')
758         return FALSE;
759       if (c1 >= L'a' && c1 <= L'z')
760         c1 -= L'a' - L'A';
761       if (c2 >= 'a' && c2 <= 'z')
762         c2 -= 'a' - 'A';
763       if (c1 != c2)
764         return FALSE;
765     }
766
767   return TRUE;
768 }
769
770 /* Open process handle with the query right specified by process exe file. */
771 static HANDLE
772 find_and_open_process_for_query(LPCSTR exe_file)
773 {
774   GetProcessImageFileNameWProt MyGetProcessImageFileNameW;
775   GetModuleFileNameExWProt MyGetModuleFileNameExW;
776   EnumProcessesProt MyEnumProcesses;
777   HMODULE kernel32, psapi;
778   UINT prev_error_mode;
779   WCHAR path[MAX_PATH];
780   DWORD size, length;
781   DWORD *processes;
782   HANDLE process;
783   DWORD count;
784   DWORD i;
785
786   psapi = NULL;
787   kernel32 = GetModuleHandle(TEXT("kernel32.dll"));
788   if (!kernel32)
789     return NULL;
790
791   /*
792    * On Windows 7 and higher systems these functions are available in
793    * kernel32.dll library with K32 prefix.
794    */
795   MyGetModuleFileNameExW = NULL;
796   MyGetProcessImageFileNameW = (GetProcessImageFileNameWProt)(LPVOID)GetProcAddress(kernel32, "K32GetProcessImageFileNameW");
797   MyEnumProcesses = (EnumProcessesProt)(LPVOID)GetProcAddress(kernel32, "K32EnumProcesses");
798   if (!MyGetProcessImageFileNameW || !MyEnumProcesses)
799     {
800       /*
801        * On older NT-based systems these functions are available in
802        * psapi.dll library without K32 prefix.
803        */
804       prev_error_mode = change_error_mode(SEM_FAILCRITICALERRORS);
805       psapi = LoadLibrary(TEXT("psapi.dll"));
806       change_error_mode(prev_error_mode);
807
808       if (!psapi)
809         return NULL;
810
811       /*
812        * Function GetProcessImageFileNameW() is available in
813        * Windows XP and higher systems. On older versions is
814        * available function GetModuleFileNameExW().
815        */
816       MyGetProcessImageFileNameW = (GetProcessImageFileNameWProt)(LPVOID)GetProcAddress(psapi, "GetProcessImageFileNameW");
817       MyGetModuleFileNameExW = (GetModuleFileNameExWProt)(LPVOID)GetProcAddress(psapi, "GetModuleFileNameExW");
818       MyEnumProcesses = (EnumProcessesProt)(LPVOID)GetProcAddress(psapi, "EnumProcesses");
819       if ((!MyGetProcessImageFileNameW && !MyGetModuleFileNameExW) || !MyEnumProcesses)
820         {
821           FreeLibrary(psapi);
822           return NULL;
823         }
824     }
825
826   /* Make initial buffer size for 1024 processes. */
827   size = 1024 * sizeof(*processes);
828
829 retry:
830   processes = (DWORD *)LocalAlloc(LPTR, size);
831   if (!processes)
832     {
833       if (psapi)
834         FreeLibrary(psapi);
835       return NULL;
836     }
837
838   if (!MyEnumProcesses(processes, size, &length))
839     {
840       LocalFree(processes);
841       if (psapi)
842         FreeLibrary(psapi);
843       return NULL;
844     }
845   else if (size == length)
846     {
847       /*
848        * There is no indication given when the buffer is too small to
849        * store all process identifiers. Therefore if returned length
850        * is same as buffer size there can be more processes. Call
851        * again with larger buffer.
852        */
853       LocalFree(processes);
854       size *= 2;
855       goto retry;
856     }
857
858   process = NULL;
859   count = length / sizeof(*processes);
860
861   for (i = 0; i < count; i++)
862     {
863       /* Skip System Idle Process. */
864       if (processes[i] == 0)
865         continue;
866
867       /*
868        * Function GetModuleFileNameExW() requires additional
869        * PROCESS_VM_READ right as opposite to function
870        * GetProcessImageFileNameW() which does not need it.
871        */
872       process = open_process_for_query(processes[i], MyGetProcessImageFileNameW ? FALSE : TRUE);
873       if (!process)
874         continue;
875
876       if (MyGetProcessImageFileNameW)
877         length = MyGetProcessImageFileNameW(process, path, sizeof(path)/sizeof(*path));
878       else
879         length = MyGetModuleFileNameExW(process, NULL, path, sizeof(path)/sizeof(*path));
880       if (length && check_process_name(path, length, exe_file))
881         break;
882
883       CloseHandle(process);
884       process = NULL;
885     }
886
887   LocalFree(processes);
888
889   if (psapi)
890     FreeLibrary(psapi);
891
892   return process;
893 }
894
895 /*
896  * Try to open primary access token of the particular process with specified
897  * rights. Before opening access token try to adjust DACL permissions of the
898  * primary process access token, so following open does not fail on error
899  * related to no open permissions. Revert DACL permissions after open attempt.
900  * As following steps are not atomic, try to execute them more times in case
901  * of possible race conditions caused by other threads or processes.
902  */
903 static HANDLE
904 try_grant_permissions_and_open_process_token(HANDLE process, DWORD rights)
905 {
906   PSECURITY_DESCRIPTOR security_descriptor;
907   HANDLE grant_token;
908   PACL old_dacl;
909   HANDLE token;
910   DWORD retry;
911   DWORD error;
912
913   /*
914    * This code is not atomic. Between grant and open calls can other
915    * thread or process change or revert permissions. So try to execute
916    * it more times.
917    */
918   for (retry = 0; retry < 10; retry++)
919     {
920       if (!grant_process_token_dacl_permissions(process, rights, &grant_token, &old_dacl, &security_descriptor))
921         return NULL;
922       if (!OpenProcessToken(process, rights, &token))
923         {
924           token = NULL;
925           error = GetLastError();
926         }
927       revert_token_dacl_permissions(grant_token, old_dacl, security_descriptor);
928       if (token)
929         return token;
930       else if (error != ERROR_ACCESS_DENIED)
931         return NULL;
932     }
933
934   return NULL;
935 }
936
937 /*
938  * Open primary access token of particular process handle with specified rights.
939  * If permissions for specified rights are missing then try to grant them.
940  */
941 static HANDLE
942 open_process_token_with_rights(HANDLE process, DWORD rights)
943 {
944   HANDLE old_token;
945   HANDLE token;
946
947   /* First try to open primary access token of process handle directly. */
948   if (OpenProcessToken(process, rights, &token))
949     return token;
950
951   /*
952    * If opening failed then it means that owner of the current thread
953    * access token does not have permission for it. Try it again with
954    * primary process access token.
955    */
956   if (change_token_to_primary(&old_token))
957     {
958       if (!OpenProcessToken(process, rights, &token))
959         token = NULL;
960       revert_to_token(old_token);
961       if (token)
962         return token;
963     }
964
965   /*
966    * If opening is still failing then try to grant specified permissions
967    * for the current thread and try to open it again.
968    */
969   token = try_grant_permissions_and_open_process_token(process, rights);
970   if (token)
971     return token;
972
973   /*
974    * And if it is still failing then try it again with granting
975    * permissions for the primary process token of the current process.
976    */
977   if (change_token_to_primary(&old_token))
978     {
979       token = try_grant_permissions_and_open_process_token(process, rights);
980       revert_to_token(old_token);
981       if (token)
982         return token;
983     }
984
985   /*
986    * TODO: Sorry, no other option for now...
987    * It could be possible to use Take Ownership Name privilege to
988    * temporary change token owner of specified process to the owner of
989    * the current thread token, grant permissions for current thread in
990    * that process token, change ownership back to original one, open
991    * that process token and revert granted permissions. But this is
992    * not implemented yet.
993    */
994   return NULL;
995 }
996
997 /*
998  * Set x86 I/O Privilege Level to 3 for the whole current NT process. Do it via
999  * NtSetInformationProcess() call with ProcessUserModeIOPL information class,
1000  * which is supported by 32-bit Windows NT kernel versions and requires Tcb
1001  * privilege.
1002  */
1003 static BOOL
1004 SetProcessUserModeIOPL(VOID)
1005 {
1006   NtSetInformationProcessProt MyNtSetInformationProcess;
1007
1008   LUID luid_tcb_privilege;
1009   LUID luid_impersonate_privilege;
1010
1011   HANDLE revert_token_tcb_privilege;
1012   BOOL revert_only_tcb_privilege;
1013
1014   HANDLE revert_token_impersonate_privilege;
1015   BOOL revert_only_impersonate_privilege;
1016
1017   BOOL impersonate_privilege_enabled;
1018
1019   BOOL revert_to_old_token;
1020   HANDLE old_token;
1021
1022   HANDLE lsass_process;
1023   HANDLE lsass_token;
1024
1025   UINT prev_error_mode;
1026   NTSTATUS nt_status;
1027   HMODULE ntdll;
1028   BOOL ret;
1029
1030   impersonate_privilege_enabled = FALSE;
1031   revert_to_old_token = FALSE;
1032   lsass_token = NULL;
1033   old_token = NULL;
1034
1035   /* Fast path when ProcessUserModeIOPL was already called. */
1036   if (read_iopl() == 3)
1037     return TRUE;
1038
1039   /*
1040    * Load ntdll.dll library with disabled critical-error-handler message box.
1041    * It means that NT kernel does not show unwanted GUI message box to user
1042    * when LoadLibrary() function fails.
1043    */
1044   prev_error_mode = change_error_mode(SEM_FAILCRITICALERRORS);
1045   ntdll = LoadLibrary(TEXT("ntdll.dll"));
1046   change_error_mode(prev_error_mode);
1047   if (!ntdll)
1048     goto err_not_implemented;
1049
1050   /* Retrieve pointer to NtSetInformationProcess() function. */
1051   MyNtSetInformationProcess = (NtSetInformationProcessProt)(LPVOID)GetProcAddress(ntdll, "NtSetInformationProcess");
1052   if (!MyNtSetInformationProcess)
1053     goto err_not_implemented;
1054
1055   /*
1056    * ProcessUserModeIOPL is syscall for NT kernel to change x86 IOPL
1057    * of the current running process to 3.
1058    *
1059    * Process handle argument for ProcessUserModeIOPL is ignored and
1060    * IOPL is always changed for the current running process. So pass
1061    * GetCurrentProcess() handle for documentation purpose. Process
1062    * information buffer and length are unused for ProcessUserModeIOPL.
1063    *
1064    * ProcessUserModeIOPL may success (return value >= 0) or may fail
1065    * because it is not implemented or because of missing privilege.
1066    * Other errors are not defined, so handle them as unknown.
1067    */
1068   nt_status = MyNtSetInformationProcess(GetCurrentProcess(), ProcessUserModeIOPL, NULL, 0);
1069   if (nt_status >= 0)
1070     goto verify;
1071   else if (nt_status == STATUS_NOT_IMPLEMENTED)
1072     goto err_not_implemented;
1073   else if (nt_status != STATUS_PRIVILEGE_NOT_HELD)
1074     goto err_unknown;
1075
1076   /*
1077    * If ProcessUserModeIOPL call failed with STATUS_PRIVILEGE_NOT_HELD
1078    * error then it means that the current thread token does not have
1079    * Tcb privilege enabled. Try to enable it.
1080    */
1081
1082   if (!LookupPrivilegeValue(NULL, SE_TCB_NAME, &luid_tcb_privilege))
1083     goto err_not_implemented;
1084
1085   /*
1086    * If the current thread has already Tcb privilege enabled then there
1087    * is some additional unhanded restriction.
1088    */
1089   if (have_privilege(luid_tcb_privilege))
1090     goto err_privilege_not_held;
1091
1092   /* Try to enable Tcb privilege and try ProcessUserModeIOPL call again. */
1093   if (enable_privilege(luid_tcb_privilege, &revert_token_tcb_privilege, &revert_only_tcb_privilege))
1094     {
1095       nt_status = MyNtSetInformationProcess(GetCurrentProcess(), ProcessUserModeIOPL, NULL, 0);
1096       revert_privilege(luid_tcb_privilege, revert_token_tcb_privilege, revert_only_tcb_privilege);
1097       if (nt_status >= 0)
1098         goto verify;
1099       else if (nt_status == STATUS_NOT_IMPLEMENTED)
1100         goto err_not_implemented;
1101       else if (nt_status == STATUS_PRIVILEGE_NOT_HELD)
1102         goto err_privilege_not_held;
1103       else
1104         goto err_unknown;
1105     }
1106
1107   /*
1108    * If enabling of Tcb privilege failed then it means that current thread
1109    * does not this privilege. But current process may have it. So try it
1110    * again with primary process access token.
1111    */
1112
1113   /*
1114    * If system supports Impersonate privilege (Windows 2000 SP4 or higher) then
1115    * all future actions in this function require this Impersonate privilege.
1116    * So try to enable it in case it is currently disabled.
1117    */
1118   if (LookupPrivilegeValue(NULL, SE_IMPERSONATE_NAME, &luid_impersonate_privilege) &&
1119       !have_privilege(luid_impersonate_privilege))
1120     {
1121       /*
1122        * If current thread does not have Impersonate privilege enabled
1123        * then first try to enable it just for the current thread. If
1124        * it is not possible to enable it just for the current thread
1125        * then try it to enable globally for whole process (which
1126        * affects all process threads). Both actions will be reverted
1127        * at the end of this function.
1128        */
1129       if (enable_privilege(luid_impersonate_privilege, &revert_token_impersonate_privilege, &revert_only_impersonate_privilege))
1130         {
1131           impersonate_privilege_enabled = TRUE;
1132         }
1133       else if (enable_privilege(luid_impersonate_privilege, NULL, NULL))
1134         {
1135           impersonate_privilege_enabled = TRUE;
1136           revert_token_impersonate_privilege = NULL;
1137           revert_only_impersonate_privilege = TRUE;
1138         }
1139       else
1140         {
1141           goto err_privilege_not_held;
1142         }
1143
1144       /*
1145        * Now when Impersonate privilege is enabled, try to enable Tcb
1146        * privilege again. Enabling other privileges for the current
1147        * thread requires Impersonate privilege, so enabling Tcb again
1148        * could now pass.
1149        */
1150       if (enable_privilege(luid_tcb_privilege, &revert_token_tcb_privilege, &revert_only_tcb_privilege))
1151         {
1152           nt_status = MyNtSetInformationProcess(GetCurrentProcess(), ProcessUserModeIOPL, NULL, 0);
1153           revert_privilege(luid_tcb_privilege, revert_token_tcb_privilege, revert_only_tcb_privilege);
1154           if (nt_status >= 0)
1155             goto verify;
1156           else if (nt_status == STATUS_NOT_IMPLEMENTED)
1157             goto err_not_implemented;
1158           else if (nt_status == STATUS_PRIVILEGE_NOT_HELD)
1159             goto err_privilege_not_held;
1160           else
1161             goto err_unknown;
1162         }
1163     }
1164
1165   /*
1166    * If enabling Tcb privilege failed then it means that the current
1167    * thread access token does not have this privilege or does not
1168    * have permission to adjust privileges.
1169    *
1170    * Try to use more privileged token from Local Security Authority
1171    * Subsystem Service process (lsass.exe) which has Tcb privilege.
1172    * Retrieving this more privileged token is possible for local
1173    * administrators (unless it was disabled by local administrators).
1174    */
1175
1176   lsass_process = find_and_open_process_for_query("lsass.exe");
1177   if (!lsass_process)
1178     goto err_privilege_not_held;
1179
1180   /*
1181    * Open primary lsass.exe process access token with query and duplicate
1182    * rights. Just these two rights are required for impersonating other
1183    * primary process token (impersonate right is really not required!).
1184    */
1185   lsass_token = open_process_token_with_rights(lsass_process, TOKEN_QUERY | TOKEN_DUPLICATE);
1186
1187   CloseHandle(lsass_process);
1188
1189   if (!lsass_token)
1190     goto err_privilege_not_held;
1191
1192   /*
1193    * After successful open of the primary lsass.exe process access token,
1194    * assign its copy for the current thread.
1195    */
1196   if (!change_token(lsass_token, &old_token))
1197     goto err_privilege_not_held;
1198
1199   revert_to_old_token = TRUE;
1200
1201   nt_status = MyNtSetInformationProcess(GetCurrentProcess(), ProcessUserModeIOPL, NULL, 0);
1202   if (nt_status == STATUS_PRIVILEGE_NOT_HELD)
1203     {
1204       /*
1205        * Now current thread is not using primary process token anymore
1206        * but is using custom access token. There is no need to revert
1207        * enabled Tcb privilege as the whole custom access token would
1208        * be reverted. So there is no need to setup revert method for
1209        * enabling privilege.
1210        */
1211       if (have_privilege(luid_tcb_privilege) ||
1212           !enable_privilege(luid_tcb_privilege, NULL, NULL))
1213         goto err_privilege_not_held;
1214       nt_status = MyNtSetInformationProcess(GetCurrentProcess(), ProcessUserModeIOPL, NULL, 0);
1215     }
1216   if (nt_status >= 0)
1217     goto verify;
1218   else if (nt_status == STATUS_NOT_IMPLEMENTED)
1219     goto err_not_implemented;
1220   else if (nt_status == STATUS_PRIVILEGE_NOT_HELD)
1221     goto err_privilege_not_held;
1222   else
1223     goto err_unknown;
1224
1225 verify:
1226   /*
1227    * Some Windows NT kernel versions (e.g. Windows 2003 x64) do not
1228    * implement ProcessUserModeIOPL syscall at all but incorrectly
1229    * returns success when it is called by user process. So always
1230    * after this call verify that IOPL is set to 3.
1231    */
1232   if (read_iopl() != 3)
1233     goto err_not_implemented;
1234   ret = TRUE;
1235   goto ret;
1236
1237 err_not_implemented:
1238   SetLastError(ERROR_INVALID_FUNCTION);
1239   ret = FALSE;
1240   goto ret;
1241
1242 err_privilege_not_held:
1243   SetLastError(ERROR_PRIVILEGE_NOT_HELD);
1244   ret = FALSE;
1245   goto ret;
1246
1247 err_unknown:
1248   SetLastError(ERROR_GEN_FAILURE);
1249   ret = FALSE;
1250   goto ret;
1251
1252 ret:
1253   if (revert_to_old_token)
1254     revert_to_token(old_token);
1255
1256   if (impersonate_privilege_enabled)
1257     revert_privilege(luid_impersonate_privilege, revert_token_impersonate_privilege, revert_only_impersonate_privilege);
1258
1259   if (lsass_token)
1260     CloseHandle(lsass_token);
1261
1262   if (ntdll)
1263     FreeLibrary(ntdll);
1264
1265   return ret;
1266 }
1267
1268 static int
1269 intel_setup_io(struct pci_access *a)
1270 {
1271 #ifndef _WIN64
1272   /* 16/32-bit non-NT systems allow applications to access PCI I/O ports without any special setup. */
1273   OSVERSIONINFOA version;
1274   version.dwOSVersionInfoSize = sizeof(version);
1275   if (GetVersionExA(&version) && version.dwPlatformId < VER_PLATFORM_WIN32_NT)
1276     {
1277       a->debug("Detected 16/32-bit non-NT system, skipping NT setup...");
1278       return 1;
1279     }
1280 #endif
1281
1282   /* On NT-based systems issue ProcessUserModeIOPL syscall which changes IOPL to 3. */
1283   if (!SetProcessUserModeIOPL())
1284     {
1285       a->warning("NT ProcessUserModeIOPL call failed with error: %lu.", (unsigned long int)GetLastError());
1286       return 0;
1287     }
1288
1289   a->debug("NT ProcessUserModeIOPL call succeeded...");
1290   return 1;
1291 }
1292
1293 static inline void
1294 intel_cleanup_io(struct pci_access *a UNUSED)
1295 {
1296   /*
1297    * 16/32-bit non-NT systems do not use any special setup and on NT-based
1298    * systems ProcessUserModeIOPL permanently changes IOPL to 3 for the current
1299    * NT process, no revert for current process is possible.
1300    */
1301 }
1302
1303 static inline void intel_io_lock(void)
1304 {
1305 }
1306
1307 static inline void intel_io_unlock(void)
1308 {
1309 }