Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix getting/setting huge env vars on windows #12396

Merged
merged 1 commit into from
Feb 20, 2014

Conversation

alexcrichton
Copy link
Member

On windows, the GetEnvironmentVariable function will return the necessary buffer
size if the buffer provided was too small. This case previously fell through the
checks inside of fill_utf16_buf_and_decode, tripping an assertion in the slice
method.

This adds an extra case for when the return value is >= the buffer size, in
which case we assume the return value as the new buffer size and try again.

Closes #12376

On windows, the GetEnvironmentVariable function will return the necessary buffer
size if the buffer provided was too small. This case previously fell through the
checks inside of fill_utf16_buf_and_decode, tripping an assertion in the `slice`
method.

This adds an extra case for when the return value is >= the buffer size, in
which case we assume the return value as the new buffer size and try again.

Closes rust-lang#12376
@flaper87
Copy link
Contributor

LGTM

@lilyball
Copy link
Contributor

One of the Windows functions called using fill_utf16_buf_and_decode() (GetFinalPathNameByHandleW) is documented as taking a buffer size that does not include the NULL terminator. This has me worried. It sounds like if the function wants to write precisely the same number of characters as is passed, it will attempt to write a NULL byte past the end of the buffer. I would love to be wrong about this, but it sounds to me like someone needs to audit that call.

@alexcrichton
Copy link
Member Author

If the function fails because lpszFilePath is too small to hold the string plus the terminating null character, the return value is the required buffer size, in TCHARs. This value includes the size of the terminating null character.

It sounds like so long as we use the return value as the next length, we'll have the right sized buffer.

@lilyball
Copy link
Contributor

@alexcrichton Yes, my concern does not impact this particular PR. I was looking at it to find out the reasoning for the k == n branch (which is the case for GetFinalPathNameByHandleW). Someone who's actually familiar with the Windows APIs should take a look and decide if GetFinalPathNameByHandleW really is expecting the length to be provided as 1 smaller than the actual size of the buffer, which is my interpretation of the documentation. Because if so, then the call to GetFinalPathNameByHandleW needs to subtract one from the length, which it is not currently doing, in order to ensure the buffer is not overrun.

@huonw
Copy link
Member

huonw commented Feb 19, 2014

(I've removed my r+, just in case.)

@lilyball
Copy link
Contributor

I have filed an issue for my concern as #12406. Given that, since I think this patch is fine as-is, @huonw you should probably restore your r+.

@alexcrichton
Copy link
Member Author

@kballard, thanks!

bors added a commit that referenced this pull request Feb 20, 2014
On windows, the GetEnvironmentVariable function will return the necessary buffer
size if the buffer provided was too small. This case previously fell through the
checks inside of fill_utf16_buf_and_decode, tripping an assertion in the `slice`
method.

This adds an extra case for when the return value is >= the buffer size, in
which case we assume the return value as the new buffer size and try again.

Closes #12376
@bors bors closed this Feb 20, 2014
@bors bors merged commit 9347096 into rust-lang:master Feb 20, 2014
@alexcrichton alexcrichton deleted the windows-env-var branch February 20, 2014 17:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

std::os has a possible infinite loop/OOM crash when running commands that return a lot of text
5 participants