[PATCH 1/3] kernelbase: Preserve last error when GetEnvironmentVariableA succeeds.
From: Vladimir Panteleev <git(a)vladimir.panteleev.md> Avoid clobbering last error with NO_ERROR when GetEnvironmentVariableA succeeds, matching the behavior of GetEnvironmentVariableW and Windows. Instead of naively saving and restoring the last error, call RtlQueryEnvironmentVariable_U directly to avoid unnecessarily setting it in the first place. Signed-off-by: Vladimir Panteleev <git(a)vladimir.panteleev.md> Signed-off-by: Gijs Vermeulen <gijsvrm(a)gmail.com> --- dlls/kernel32/tests/environ.c | 8 ++++---- dlls/kernelbase/process.c | 30 +++++++++++++++++++----------- 2 files changed, 23 insertions(+), 15 deletions(-) diff --git a/dlls/kernel32/tests/environ.c b/dlls/kernel32/tests/environ.c index 26f24caad2..41d4095772 100644 --- a/dlls/kernel32/tests/environ.c +++ b/dlls/kernel32/tests/environ.c @@ -157,10 +157,10 @@ static void test_GetSetEnvironmentVariableA(void) "should not fail with empty value but GetLastError=%d\n", GetLastError()); lstrcpyA(buf, "foo"); - SetLastError(0); + SetLastError(0xdeadbeef); ret_size = GetEnvironmentVariableA(name, buf, lstrlenA(value) + 1); ok(ret_size == 0 && - ((GetLastError() == 0 && lstrcmpA(buf, "") == 0) || + ((GetLastError() == 0xdeadbeef && lstrcmpA(buf, "") == 0) || (GetLastError() == ERROR_ENVVAR_NOT_FOUND)), "%s should be set to \"\" (NT) or removed (Win9x) but ret_size=%d GetLastError=%d and buf=%s\n", name, ret_size, GetLastError(), buf); @@ -262,10 +262,10 @@ static void test_GetSetEnvironmentVariableW(void) ok(ret == TRUE, "should not fail with empty value but GetLastError=%d\n", GetLastError()); lstrcpyW(buf, fooW); - SetLastError(0); + SetLastError(0xdeadbeef); ret_size = GetEnvironmentVariableW(name, buf, lstrlenW(value) + 1); ok(ret_size == 0 && - ((GetLastError() == 0 && lstrcmpW(buf, empty_strW) == 0) || + ((GetLastError() == 0xdeadbeef && lstrcmpW(buf, empty_strW) == 0) || (GetLastError() == ERROR_ENVVAR_NOT_FOUND)), "should be set to \"\" (NT) or removed (Win9x) but ret_size=%d GetLastError=%d\n", ret_size, GetLastError()); diff --git a/dlls/kernelbase/process.c b/dlls/kernelbase/process.c index c426978114..b06706f11b 100644 --- a/dlls/kernelbase/process.c +++ b/dlls/kernelbase/process.c @@ -1345,24 +1345,32 @@ BOOL WINAPI DECLSPEC_HOTPATCH SetEnvironmentStringsW( WCHAR *env ) */ DWORD WINAPI DECLSPEC_HOTPATCH GetEnvironmentVariableA( LPCSTR name, LPSTR value, DWORD size ) { - UNICODE_STRING us_name; + UNICODE_STRING us_name, us_value; PWSTR valueW; - DWORD ret; + NTSTATUS status; + DWORD len, ret; /* limit the size to sane values */ size = min( size, 32767 ); if (!(valueW = HeapAlloc( GetProcessHeap(), 0, size * sizeof(WCHAR) ))) return 0; RtlCreateUnicodeStringFromAsciiz( &us_name, name ); - SetLastError( 0 ); - ret = GetEnvironmentVariableW( us_name.Buffer, valueW, size); - if (ret && ret < size) WideCharToMultiByte( CP_ACP, 0, valueW, ret + 1, value, size, NULL, NULL ); - - /* this is needed to tell, with 0 as a return value, the difference between: - * - an error (GetLastError() != 0) - * - returning an empty string (in this case, we need to update the buffer) - */ - if (ret == 0 && size && GetLastError() == 0) value[0] = 0; + us_value.Length = 0; + us_value.MaximumLength = (size ? size - 1 : 0) * sizeof(WCHAR); + us_value.Buffer = valueW; + + status = RtlQueryEnvironmentVariable_U( NULL, &us_name, &us_value ); + len = us_value.Length / sizeof(WCHAR); + if (status == STATUS_BUFFER_TOO_SMALL) ret = len + 1; + else if (!set_ntstatus( status )) ret = 0; + else if (!size) ret = len + 1; + else + { + if (len) WideCharToMultiByte( CP_ACP, 0, valueW, len + 1, value, size, NULL, NULL ); + value[len] = 0; + ret = len; + } + RtlFreeUnicodeString( &us_name ); HeapFree( GetProcessHeap(), 0, valueW ); return ret; -- 2.26.2
From: Vladimir Panteleev <git(a)vladimir.panteleev.md> Windows doesn't do this (except XP, and then only for empty variables, where it returns ERROR_MORE_DATA). Wine-Bug: https://bugs.winehq.org/show_bug.cgi?id=48471 Signed-off-by: Vladimir Panteleev <git(a)vladimir.panteleev.md> Signed-off-by: Gijs Vermeulen <gijsvrm(a)gmail.com> --- dlls/kernel32/tests/environ.c | 6 ++++++ dlls/kernelbase/process.c | 3 ++- 2 files changed, 8 insertions(+), 1 deletion(-) diff --git a/dlls/kernel32/tests/environ.c b/dlls/kernel32/tests/environ.c index 41d4095772..5de7980bca 100644 --- a/dlls/kernel32/tests/environ.c +++ b/dlls/kernel32/tests/environ.c @@ -106,9 +106,12 @@ static void test_GetSetEnvironmentVariableA(void) GetLastError()); /* Try to retrieve the environment variable we just set */ + SetLastError(0xdeadbeef); ret_size = GetEnvironmentVariableA(name, NULL, 0); ok(ret_size == strlen(value) + 1, "should return length with terminating 0 ret_size=%d\n", ret_size); + ok(GetLastError() == 0xdeadbeef, + "should not fail with zero size but GetLastError=%d\n", GetLastError()); lstrcpyA(buf, "foo"); ret_size = GetEnvironmentVariableA(name, buf, lstrlenA(value)); @@ -208,10 +211,13 @@ static void test_GetSetEnvironmentVariableW(void) GetLastError()); /* Try to retrieve the environment variable we just set */ + SetLastError(0xdeadbeef); ret_size = GetEnvironmentVariableW(name, NULL, 0); ok(ret_size == lstrlenW(value) + 1, "should return length with terminating 0 ret_size=%d\n", ret_size); + ok(GetLastError() == 0xdeadbeef, + "should not fail with zero size but GetLastError=%d\n", GetLastError()); lstrcpyW(buf, fooW); ret_size = GetEnvironmentVariableW(name, buf, lstrlenW(value)); diff --git a/dlls/kernelbase/process.c b/dlls/kernelbase/process.c index b06706f11b..7cad3e6678 100644 --- a/dlls/kernelbase/process.c +++ b/dlls/kernelbase/process.c @@ -1395,7 +1395,8 @@ DWORD WINAPI DECLSPEC_HOTPATCH GetEnvironmentVariableW( LPCWSTR name, LPWSTR val status = RtlQueryEnvironmentVariable_U( NULL, &us_name, &us_value ); len = us_value.Length / sizeof(WCHAR); - if (!set_ntstatus( status )) return (status == STATUS_BUFFER_TOO_SMALL) ? len + 1 : 0; + if (status == STATUS_BUFFER_TOO_SMALL) return len + 1; + if (!set_ntstatus( status )) return 0; if (size) val[len] = 0; return len; } -- 2.26.2
From: Vladimir Panteleev <git(a)vladimir.panteleev.md> Do the same thing as Vista and up. Wine-Bug: https://bugs.winehq.org/show_bug.cgi?id=48471 Signed-off-by: Vladimir Panteleev <git(a)vladimir.panteleev.md> Signed-off-by: Gijs Vermeulen <gijsvrm(a)gmail.com> --- dlls/kernel32/tests/environ.c | 20 ++++++++++++++++++++ dlls/kernelbase/process.c | 3 ++- 2 files changed, 22 insertions(+), 1 deletion(-) diff --git a/dlls/kernel32/tests/environ.c b/dlls/kernel32/tests/environ.c index 5de7980bca..3c1563a331 100644 --- a/dlls/kernel32/tests/environ.c +++ b/dlls/kernel32/tests/environ.c @@ -168,6 +168,16 @@ static void test_GetSetEnvironmentVariableA(void) "%s should be set to \"\" (NT) or removed (Win9x) but ret_size=%d GetLastError=%d and buf=%s\n", name, ret_size, GetLastError(), buf); + SetLastError(0xdeadbeef); + ret_size = GetEnvironmentVariableA(name, NULL, 0); + ok(ret_size == 1 || + broken(ret_size == 0), /* XP */ + "should return 1 for empty string but ret_size=%d GetLastError=%d\n", + ret_size, GetLastError()); + ok(GetLastError() == 0xdeadbeef || + broken(GetLastError() == ERROR_MORE_DATA), /* XP */ + "should not fail with zero size but GetLastError=%d\n", GetLastError()); + /* Test the limits */ SetLastError(0xdeadbeef); ret_size = GetEnvironmentVariableA(NULL, NULL, 0); @@ -277,6 +287,16 @@ static void test_GetSetEnvironmentVariableW(void) ret_size, GetLastError()); ok(lstrcmpW(buf, empty_strW) == 0, "should copy an empty string\n"); + SetLastError(0xdeadbeef); + ret_size = GetEnvironmentVariableW(name, NULL, 0); + ok(ret_size == 1 || + broken(ret_size == 0), /* XP */ + "should return 1 for empty string but ret_size=%d GetLastError=%d\n", + ret_size, GetLastError()); + ok(GetLastError() == 0xdeadbeef || + broken(GetLastError() == ERROR_MORE_DATA), /* XP */ + "should not fail with zero size but GetLastError=%d\n", GetLastError()); + /* Test the limits */ SetLastError(0xdeadbeef); ret_size = GetEnvironmentVariableW(NULL, NULL, 0); diff --git a/dlls/kernelbase/process.c b/dlls/kernelbase/process.c index 7cad3e6678..67fcb5f04e 100644 --- a/dlls/kernelbase/process.c +++ b/dlls/kernelbase/process.c @@ -1397,7 +1397,8 @@ DWORD WINAPI DECLSPEC_HOTPATCH GetEnvironmentVariableW( LPCWSTR name, LPWSTR val len = us_value.Length / sizeof(WCHAR); if (status == STATUS_BUFFER_TOO_SMALL) return len + 1; if (!set_ntstatus( status )) return 0; - if (size) val[len] = 0; + if (!size) return len + 1; + val[len] = 0; return len; } -- 2.26.2
Gijs Vermeulen <gijsvrm(a)gmail.com> writes:
From: Vladimir Panteleev <git(a)vladimir.panteleev.md>
Avoid clobbering last error with NO_ERROR when GetEnvironmentVariableA succeeds, matching the behavior of GetEnvironmentVariableW and Windows.
Instead of naively saving and restoring the last error, call RtlQueryEnvironmentVariable_U directly to avoid unnecessarily setting it in the first place.
Signed-off-by: Vladimir Panteleev <git(a)vladimir.panteleev.md> Signed-off-by: Gijs Vermeulen <gijsvrm(a)gmail.com> --- dlls/kernel32/tests/environ.c | 8 ++++---- dlls/kernelbase/process.c | 30 +++++++++++++++++++----------- 2 files changed, 23 insertions(+), 15 deletions(-)
This is breaking a number of tests, for instance: ../../../tools/runtest -q -P wine -T ../../.. -M advapi32.dll -p advapi32_test.exe security && touch security.ok security.c:2112: Tests skipped: Well known SID 38 not implemented security.c:2112: Tests skipped: Well known SID 39 not implemented security.c:2112: Tests skipped: Well known SID 40 not implemented security.c:2112: Tests skipped: Well known SID 41 not implemented security.c:2112: Tests skipped: Well known SID 42 not implemented security.c:2112: Tests skipped: Well known SID 43 not implemented security.c:2112: Tests skipped: Well known SID 44 not implemented security.c:2112: Tests skipped: Well known SID 45 not implemented security.c:2112: Tests skipped: Well known SID 46 not implemented security.c:2112: Tests skipped: Well known SID 47 not implemented security.c:2112: Tests skipped: Well known SID 48 not implemented security.c:2112: Tests skipped: Well known SID 49 not implemented security.c:2112: Tests skipped: Well known SID 50 not implemented security.c:2112: Tests skipped: Well known SID 62 not implemented security.c:2112: Tests skipped: Well known SID 63 not implemented security.c:2112: Tests skipped: Well known SID 64 not implemented security.c:2112: Tests skipped: Well known SID 65 not implemented security.c:2112: Tests skipped: Well known SID 70 not implemented security.c:2112: Tests skipped: Well known SID 72 not implemented security.c:2112: Tests skipped: Well known SID 73 not implemented security.c:2112: Tests skipped: Well known SID 74 not implemented security.c:2112: Tests skipped: Well known SID 75 not implemented security.c:2112: Tests skipped: Well known SID 76 not implemented security.c:2112: Tests skipped: Well known SID 77 not implemented security.c:2112: Tests skipped: Well known SID 78 not implemented security.c:2112: Tests skipped: Well known SID 79 not implemented security.c:2112: Tests skipped: Well known SID 81 not implemented security.c:2112: Tests skipped: Well known SID 82 not implemented security.c:5060: Test failed: Last error was 3735928559 security.c:5067: Test failed: Last error was 3735928559 security.c:5091: Test failed: Last error was 3735928559 security.c:5112: Test failed: Last error was 3735928559 make: *** [Makefile:422: security.ok] Error 4 -- Alexandre Julliard julliard(a)winehq.org
participants (2)
-
Alexandre Julliard -
Gijs Vermeulen