Fix MessageId::getDataAsString() crashed with MSVC debug config #108
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Fixes apache#107 ### Motivation The `MessageId::getDataAsString()` API returns a `std::string` to the application side. In most cases it's not an issue. However, when building Windows DLLs with `LINK_STATIC=ON`, the library will be built with `/MTd` or `/MT` option to link 3rd party dependencies statically. In this case, the DLL and the application have different C runtime libraries that allocate or deallocate memory. The returned `std::string` object is allocated inside the DLL, while it will be destroyed in the application. The destruction could crash because the application C runtime cannot find the heap address from the C runtime in DLL. ### Modifications For MSVC debug build, change the API to return a const reference to `std::string`. Then the original `std::string` object will be deallocated inside the DLL.
|
Though it changes the public API, but it's only for Windows debug artifacts, which should only be used for tests, not in production. For users of Windows debug libraries, returning a const reference won't affect the application code. |
codelipenghui
approved these changes
Nov 9, 2022
BewareMyPower
added a commit
that referenced
this pull request
Nov 9, 2022
Fixes #107 ### Motivation The `MessageId::getDataAsString()` API returns a `std::string` to the application side. In most cases it's not an issue. However, when building Windows DLLs with `LINK_STATIC=ON`, the library will be built with `/MTd` or `/MT` option to link 3rd party dependencies statically. In this case, the DLL and the application have different C runtime libraries that allocate or deallocate memory. The returned `std::string` object is allocated inside the DLL, while it will be destroyed in the application. The destruction could crash because the application C runtime cannot find the heap address from the C runtime in DLL. ### Modifications For MSVC debug build, change the API to return a const reference to `std::string`. Then the original `std::string` object will be deallocated inside the DLL. (cherry picked from commit 1f7fdb8)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #107
Motivation
The
MessageId::getDataAsString()API returns astd::stringto the application side. In most cases it's not an issue. However, when building Windows DLLs withLINK_STATIC=ON, the library will be built with/MTdor/MToption to link 3rd party dependencies statically. In this case, the DLL and the application have different C runtime libraries that allocate or deallocate memory. The returnedstd::stringobject is allocated inside the DLL, while it will be destroyed in the application for debug build because RVO is not applied. The destruction could crash because the application C runtime cannot find the heap address from the C runtime in DLL.Modifications
For MSVC debug build, change the API to return a const reference to
std::string. Then the originalstd::stringobject will be deallocated inside the DLL.