55
88
def debug_memory_win32api(message='', short=True):
56
89
"""Use trace.note() to dump the running memory info."""
58
90
from breezy import trace
59
class PROCESS_MEMORY_COUNTERS_EX(ctypes.Structure):
60
"""Used by GetProcessMemoryInfo"""
61
_fields_ = [('cb', ctypes.c_ulong),
62
('PageFaultCount', ctypes.c_ulong),
63
('PeakWorkingSetSize', ctypes.c_size_t),
64
('WorkingSetSize', ctypes.c_size_t),
65
('QuotaPeakPagedPoolUsage', ctypes.c_size_t),
66
('QuotaPagedPoolUsage', ctypes.c_size_t),
67
('QuotaPeakNonPagedPoolUsage', ctypes.c_size_t),
68
('QuotaNonPagedPoolUsage', ctypes.c_size_t),
69
('PagefileUsage', ctypes.c_size_t),
70
('PeakPagefileUsage', ctypes.c_size_t),
71
('PrivateUsage', ctypes.c_size_t),
73
cur_process = ctypes.windll.kernel32.GetCurrentProcess()
74
mem_struct = PROCESS_MEMORY_COUNTERS_EX()
75
ret = ctypes.windll.psapi.GetProcessMemoryInfo(
76
cur_process, ctypes.byref(mem_struct), ctypes.sizeof(mem_struct))
78
trace.note(gettext('Failed to GetProcessMemoryInfo()'))
92
class PROCESS_MEMORY_COUNTERS_EX(ctypes.Structure):
93
"""Used by GetProcessMemoryInfo"""
94
_fields_ = [('cb', ctypes.c_ulong),
95
('PageFaultCount', ctypes.c_ulong),
96
('PeakWorkingSetSize', ctypes.c_size_t),
97
('WorkingSetSize', ctypes.c_size_t),
98
('QuotaPeakPagedPoolUsage', ctypes.c_size_t),
99
('QuotaPagedPoolUsage', ctypes.c_size_t),
100
('QuotaPeakNonPagedPoolUsage', ctypes.c_size_t),
101
('QuotaNonPagedPoolUsage', ctypes.c_size_t),
102
('PagefileUsage', ctypes.c_size_t),
103
('PeakPagefileUsage', ctypes.c_size_t),
104
('PrivateUsage', ctypes.c_size_t),
106
cur_process = ctypes.windll.kernel32.GetCurrentProcess()
107
mem_struct = PROCESS_MEMORY_COUNTERS_EX()
108
ret = ctypes.windll.psapi.GetProcessMemoryInfo(cur_process,
109
ctypes.byref(mem_struct),
110
ctypes.sizeof(mem_struct))
112
trace.note(gettext('Failed to GetProcessMemoryInfo()'))
114
info = {'PageFaultCount': mem_struct.PageFaultCount,
115
'PeakWorkingSetSize': mem_struct.PeakWorkingSetSize,
116
'WorkingSetSize': mem_struct.WorkingSetSize,
117
'QuotaPeakPagedPoolUsage': mem_struct.QuotaPeakPagedPoolUsage,
118
'QuotaPagedPoolUsage': mem_struct.QuotaPagedPoolUsage,
119
'QuotaPeakNonPagedPoolUsage':
120
mem_struct.QuotaPeakNonPagedPoolUsage,
121
'QuotaNonPagedPoolUsage': mem_struct.QuotaNonPagedPoolUsage,
122
'PagefileUsage': mem_struct.PagefileUsage,
123
'PeakPagefileUsage': mem_struct.PeakPagefileUsage,
124
'PrivateUsage': mem_struct.PrivateUsage,
128
# win32process does not return PrivateUsage, because it doesn't use
129
# PROCESS_MEMORY_COUNTERS_EX (it uses the one without _EX).
130
proc = win32process.GetCurrentProcess()
131
info = win32process.GetProcessMemoryInfo(proc)
133
trace.note(gettext('Cannot debug memory on win32 without ctypes'
80
info = {'PageFaultCount': mem_struct.PageFaultCount,
81
'PeakWorkingSetSize': mem_struct.PeakWorkingSetSize,
82
'WorkingSetSize': mem_struct.WorkingSetSize,
83
'QuotaPeakPagedPoolUsage': mem_struct.QuotaPeakPagedPoolUsage,
84
'QuotaPagedPoolUsage': mem_struct.QuotaPagedPoolUsage,
85
'QuotaPeakNonPagedPoolUsage':
86
mem_struct.QuotaPeakNonPagedPoolUsage,
87
'QuotaNonPagedPoolUsage': mem_struct.QuotaNonPagedPoolUsage,
88
'PagefileUsage': mem_struct.PagefileUsage,
89
'PeakPagefileUsage': mem_struct.PeakPagefileUsage,
90
'PrivateUsage': mem_struct.PrivateUsage,
93
137
# using base-2 units (see HACKING.txt).
94
138
trace.note(gettext('WorkingSize {0:>7}KiB'
95
'\tPeakWorking {1:>7}KiB\t{2}').format(
139
'\tPeakWorking {1:>7}KiB\t{2}').format(
96
140
info['WorkingSetSize'] / 1024,
97
141
info['PeakWorkingSetSize'] / 1024,
101
145
trace.note('%s', message)
102
trace.note(gettext('WorkingSize %8d KiB'),
103
info['WorkingSetSize'] / 1024)
104
trace.note(gettext('PeakWorking %8d KiB'),
105
info['PeakWorkingSetSize'] / 1024)
106
trace.note(gettext('PagefileUsage %8d KiB'),
107
info.get('PagefileUsage', 0) / 1024)
146
trace.note(gettext('WorkingSize %8d KiB'), info['WorkingSetSize'] / 1024)
147
trace.note(gettext('PeakWorking %8d KiB'), info['PeakWorkingSetSize'] / 1024)
148
trace.note(gettext('PagefileUsage %8d KiB'), info.get('PagefileUsage', 0) / 1024)
108
149
trace.note(gettext('PeakPagefileUsage %8d KiB'),
109
150
info.get('PeakPagefileUsage', 0) / 1024)
110
trace.note(gettext('PrivateUsage %8d KiB'),
111
info.get('PrivateUsage', 0) / 1024)
151
trace.note(gettext('PrivateUsage %8d KiB'), info.get('PrivateUsage', 0) / 1024)
112
152
trace.note(gettext('PageFaultCount %8d'), info.get('PageFaultCount', 0))
143
186
Result is always unicode (or None).
147
SHGetSpecialFolderPath = \
148
ctypes.windll.shell32.SHGetSpecialFolderPathW
149
except AttributeError:
152
buf = ctypes.create_unicode_buffer(MAX_PATH)
153
if SHGetSpecialFolderPath(None, buf, csidl, 0):
190
SHGetSpecialFolderPath = \
191
ctypes.windll.shell32.SHGetSpecialFolderPathW
192
except AttributeError:
195
buf = ctypes.create_unicode_buffer(MAX_PATH)
196
if SHGetSpecialFolderPath(None,buf,csidl,0):
199
global has_win32com_shell
200
if has_win32com_shell is None:
202
from win32com.shell import shell
203
has_win32com_shell = True
205
has_win32com_shell = False
206
if has_win32com_shell:
207
# still need to bind the name locally, but this is fast.
208
from win32com.shell import shell
210
return shell.SHGetSpecialFolderPath(0, csidl, 0)
212
# possibly E_NOTIMPL meaning we can't load the function pointer,
213
# or E_FAIL meaning the function failed - regardless, just ignore it
157
218
def get_appdata_location():
199
260
home = _get_sh_special_folder_path(CSIDL_PERSONAL)
202
home = os.environ.get('HOME')
263
home = get_environ_unicode('HOME')
203
264
if home is not None:
205
homepath = os.environ.get('HOMEPATH')
266
homepath = get_environ_unicode('HOMEPATH')
206
267
if homepath is not None:
207
return os.path.join(os.environ.get('HOMEDIR', ''), home)
268
return os.path.join(get_environ_unicode('HOMEDIR', ''), home)
208
269
# at least return windows root directory
209
windir = os.environ.get('WINDIR')
270
windir = get_environ_unicode('WINDIR')
211
272
return os.path.splitdrive(windir)[0] + '/'
212
273
# otherwise C:\ is good enough for 98% users
274
return unicode('C:/')
216
277
def get_user_name():
217
278
"""Return user name as login name.
218
279
If name cannot be obtained return None.
221
advapi32 = ctypes.windll.advapi32
222
GetUserName = getattr(advapi32, 'GetUserNameW')
223
except AttributeError:
226
buf = ctypes.create_unicode_buffer(UNLEN + 1)
227
n = ctypes.c_int(UNLEN + 1)
228
if GetUserName(buf, ctypes.byref(n)):
283
advapi32 = ctypes.windll.advapi32
284
GetUserName = getattr(advapi32, 'GetUserName'+suffix)
285
except AttributeError:
288
buf = create_buffer(UNLEN+1)
289
n = ctypes.c_int(UNLEN+1)
290
if GetUserName(buf, ctypes.byref(n)):
291
return extract_buffer(buf)
230
292
# otherwise try env variables
231
return os.environ.get('USERNAME')
293
return get_environ_unicode('USERNAME')
234
296
# 1 == ComputerNameDnsHostname, which returns "The DNS host name of the local
235
297
# computer or the cluster associated with the local computer."
236
298
_WIN32_ComputerNameDnsHostname = 1
239
300
def get_host_name():
240
301
"""Return host machine name.
241
302
If name cannot be obtained return None.
243
304
:return: A unicode string representing the host name.
246
buf = ctypes.create_unicode_buffer(MAX_COMPUTERNAME_LENGTH + 1)
247
n = ctypes.c_int(MAX_COMPUTERNAME_LENGTH + 1)
249
# Try GetComputerNameEx which gives a proper Unicode hostname
250
GetComputerNameEx = getattr(
251
ctypes.windll.kernel32, 'GetComputerNameExW', None)
252
if (GetComputerNameEx is not None
253
and GetComputerNameEx(_WIN32_ComputerNameDnsHostname,
254
buf, ctypes.byref(n))):
256
return os.environ.get('COMPUTERNAME')
308
return win32api.GetComputerNameEx(_WIN32_ComputerNameDnsHostname)
309
except (NotImplementedError, win32api.error):
310
# NotImplemented will happen on win9x...
314
kernel32 = ctypes.windll.kernel32
315
except AttributeError:
316
pass # Missing the module we need
318
buf = create_buffer(MAX_COMPUTERNAME_LENGTH+1)
319
n = ctypes.c_int(MAX_COMPUTERNAME_LENGTH+1)
321
# Try GetComputerNameEx which gives a proper Unicode hostname
322
GetComputerNameEx = getattr(kernel32, 'GetComputerNameEx'+suffix,
324
if (GetComputerNameEx is not None
325
and GetComputerNameEx(_WIN32_ComputerNameDnsHostname,
326
buf, ctypes.byref(n))):
327
return extract_buffer(buf)
329
# Try GetComputerName in case GetComputerNameEx wasn't found
330
# It returns the NETBIOS name, which isn't as good, but still ok.
331
# The first GetComputerNameEx might have changed 'n', so reset it
332
n = ctypes.c_int(MAX_COMPUTERNAME_LENGTH+1)
333
GetComputerName = getattr(kernel32, 'GetComputerName'+suffix,
335
if (GetComputerName is not None
336
and GetComputerName(buf, ctypes.byref(n))):
337
return extract_buffer(buf)
338
return get_environ_unicode('COMPUTERNAME')
259
341
def _ensure_with_dir(path):
260
342
if (not os.path.split(path)[0] or path.startswith(u'*')
261
or path.startswith(u'?')):
343
or path.startswith(u'?')):
262
344
return u'./' + path, True
264
346
return path, False
267
348
def _undo_ensure_with_dir(path, corrected):
344
425
if type_id == REG_SZ:
427
if type_id == REG_EXPAND_SZ and has_win32api:
428
fullpath = win32api.ExpandEnvironmentStrings(path)
429
if len(fullpath) > 1 and fullpath[0] == '"' and fullpath[-1] == '"':
430
fullpath = fullpath[1:-1] # remove quotes around value
349
435
def set_file_attr_hidden(path):
350
436
"""Set file attributes to hidden if possible"""
351
from ctypes.wintypes import BOOL, DWORD, LPWSTR
353
# <https://docs.microsoft.com/windows/desktop/api/fileapi/nf-fileapi-setfileattributesw>
354
SetFileAttributes = ctypes.windll.kernel32.SetFileAttributesW
355
SetFileAttributes.argtypes = LPWSTR, DWORD
356
SetFileAttributes.restype = BOOL
357
FILE_ATTRIBUTE_HIDDEN = 2
358
if not SetFileAttributes(path, FILE_ATTRIBUTE_HIDDEN):
359
e = ctypes.WinError()
361
trace.mutter('Unable to set hidden attribute on %r: %s', path, e)
438
SetFileAttributes = win32file.SetFileAttributesW
440
SetFileAttributes(path, win32file.FILE_ATTRIBUTE_HIDDEN)
441
except pywintypes.error as e:
443
trace.mutter('Unable to set hidden attribute on %r: %s', path, e)
364
446
def _command_line_to_argv(command_line, argv, single_quotes_allowed=False):
375
457
:return: A list of unicode strings.
377
459
# First, split the command line
378
s = cmdline.Splitter(
379
command_line, single_quotes_allowed=single_quotes_allowed)
381
# Bug #587868 Now make sure that the length of s agrees with sys.argv
382
# we do this by simply counting the number of arguments in each. The counts should
383
# agree no matter what encoding sys.argv is in (AFAIK)
384
# len(arguments) < len(sys.argv) should be an impossibility since python gets
460
s = cmdline.Splitter(command_line, single_quotes_allowed=single_quotes_allowed)
462
# Bug #587868 Now make sure that the length of s agrees with sys.argv
463
# we do this by simply counting the number of arguments in each. The counts should
464
# agree no matter what encoding sys.argv is in (AFAIK)
465
# len(arguments) < len(sys.argv) should be an impossibility since python gets
385
466
# args from the very same PEB as does GetCommandLineW
386
467
arguments = list(s)
388
469
# Now shorten the command line we get from GetCommandLineW to match sys.argv
389
470
if len(arguments) < len(argv):
390
471
raise AssertionError("Split command line can't be shorter than argv")
391
472
arguments = arguments[len(arguments) - len(argv):]
393
474
# Carry on to process globs (metachars) in the command line
394
475
# expand globs if necessary
395
476
# TODO: Use 'globbing' instead of 'glob.glob', this gives us stuff like
406
def _ctypes_is_local_pid_dead(pid):
408
kernel32 = ctypes.wintypes.windll.kernel32
409
"""True if pid doesn't correspond to live process on this machine"""
410
handle = kernel32.OpenProcess(1, False, pid)
412
errorcode = ctypes.GetLastError()
413
if errorcode == 5: # ERROR_ACCESS_DENIED
414
# Probably something alive we're not allowed to kill
416
elif errorcode == 87: # ERROR_INVALID_PARAMETER
418
raise ctypes.WinError(errorcode)
419
Kernel32.CloseHandle(handle)
488
def get_unicode_argv():
489
prototype = ctypes.WINFUNCTYPE(ctypes.c_wchar_p)
490
GetCommandLineW = prototype(("GetCommandLineW",
491
ctypes.windll.kernel32))
492
command_line = GetCommandLineW()
493
if command_line is None:
494
raise ctypes.WinError()
495
# Skip the first argument, since we only care about parameters
496
argv = _command_line_to_argv(command_line, sys.argv)[1:]
500
def get_environ_unicode(key, default=None):
501
"""Get `key` from environment as unicode or `default` if unset
503
The environment is natively unicode on modern windows versions but
504
Python 2 only accesses it through the legacy bytestring api.
506
Environmental variable names are case insenstive on Windows.
508
A large enough buffer will be allocated to retrieve the value, though
509
it may take two calls to the underlying library function.
511
This needs ctypes because pywin32 does not expose the wide version.
513
cfunc = getattr(get_environ_unicode, "_c_function", None)
515
from ctypes.wintypes import DWORD, LPCWSTR, LPWSTR
516
cfunc = ctypes.WINFUNCTYPE(DWORD, LPCWSTR, LPWSTR, DWORD)(
517
("GetEnvironmentVariableW", ctypes.windll.kernel32))
518
get_environ_unicode._c_function = cfunc
519
buffer_size = 256 # heuristic, 256 characters often enough
521
buffer = ctypes.create_unicode_buffer(buffer_size)
522
length = cfunc(key, buffer, buffer_size)
524
code = ctypes.GetLastError()
525
if code == 203: # ERROR_ENVVAR_NOT_FOUND
527
raise ctypes.WinError(code)
528
if buffer_size > length:
529
return buffer[:length]
534
def _pywin32_is_local_pid_dead(pid):
535
"""True if pid doesn't correspond to live process on this machine"""
537
handle = win32api.OpenProcess(1, False, pid) # PROCESS_TERMINATE
538
except pywintypes.error as e:
539
if e[0] == 5: # ERROR_ACCESS_DENIED
540
# Probably something alive we're not allowed to kill
542
elif e[0] == 87: # ERROR_INVALID_PARAMETER
547
is_local_pid_dead = _pywin32_is_local_pid_dead
548
elif has_ctypes and sys.platform == 'win32':
549
from ctypes.wintypes import BOOL, DWORD, HANDLE
550
_kernel32 = ctypes.windll.kernel32
551
_CloseHandle = ctypes.WINFUNCTYPE(BOOL, HANDLE)(
552
("CloseHandle", _kernel32))
553
_OpenProcess = ctypes.WINFUNCTYPE(HANDLE, DWORD, BOOL, DWORD)(
554
("OpenProcess", _kernel32))
555
def _ctypes_is_local_pid_dead(pid):
556
"""True if pid doesn't correspond to live process on this machine"""
557
handle = _OpenProcess(1, False, pid) # PROCESS_TERMINATE
559
errorcode = ctypes.GetLastError()
560
if errorcode == 5: # ERROR_ACCESS_DENIED
561
# Probably something alive we're not allowed to kill
563
elif errorcode == 87: # ERROR_INVALID_PARAMETER
565
raise ctypes.WinError(errorcode)
568
is_local_pid_dead = _ctypes_is_local_pid_dead
571
def _is_pywintypes_error(evalue):
572
"""True if exception instance is an error from pywin32"""
573
if has_pywintypes and isinstance(evalue, pywintypes.error):
422
is_local_pid_dead = _ctypes_is_local_pid_dead