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

[BUILD] Fix exported definitions when building DLL with STL #2387

Merged
merged 9 commits into from
Nov 1, 2023

Conversation

perhapsmaple
Copy link
Contributor

@perhapsmaple perhapsmaple commented Oct 28, 2023

Partially Fixes #2202

Changes

The function definitions for MeterSelectorFactory::Create and InstrumentSelectorFactory::Create are different for the nostd and stl builds, which causes linker errors when trying to build the DLL.

Cmake build WITH_STL=OFF:

?Create@MeterSelectorFactory@metrics@sdk@v1@opentelemetry@@SA?AV?$unique_ptr@VMeterSelector@metrics@sdk@v1@opentelemetry@@U?$default_delete@VMeterSelector@metrics@sdk@v1@opentelemetry@@@std@@@std@@Vstring_view@nostd@45@00@Z

?Create@InstrumentSelectorFactory@metrics@sdk@v1@opentelemetry@@SA?AV?$unique_ptr@VInstrumentSelector@metrics@sdk@v1@opentelemetry@@U?$default_delete@VInstrumentSelector@metrics@sdk@v1@opentelemetry@@@std@@@std@@W4InstrumentType@2345@Vstring_view@nostd@45@1@Z

CMake build WITH_STL=ON:

?Create@MeterSelectorFactory@metrics@sdk@v1@opentelemetry@@SA?AV?$unique_ptr@VMeterSelector@metrics@sdk@v1@opentelemetry@@U?$default_delete@VMeterSelector@metrics@sdk@v1@opentelemetry@@@std@@@std@@V?$basic_string_view@DU?$char_traits@D@std@@@7@00@Z

?Create@InstrumentSelectorFactory@metrics@sdk@v1@opentelemetry@@SA?AV?$unique_ptr@VInstrumentSelector@metrics@sdk@v1@opentelemetry@@U?$default_delete@VInstrumentSelector@metrics@sdk@v1@opentelemetry@@@std@@@std@@W4InstrumentType@2345@V?$basic_string_view@DU?$char_traits@D@std@@@7@1@Z

Introduced a compile definition OPENTELEMETRY_STL_VERSION to the DLL build process to export the correct definitions.

For significant contributions please make sure you have completed the following items:

  • CHANGELOG.md updated for non-trivial changes
  • Unit tests have been added
  • Changes in public API reviewed

Signed-off-by: Harish Shan <140232061+perhapsmaple@users.noreply.github.com>
Signed-off-by: Harish Shan <140232061+perhapsmaple@users.noreply.github.com>
@perhapsmaple perhapsmaple requested a review from a team October 28, 2023 10:58
@codecov
Copy link

codecov bot commented Oct 28, 2023

Codecov Report

Merging #2387 (80f31c5) into main (758687c) will not change coverage.
The diff coverage is 100.00%.

❗ Current head 80f31c5 differs from pull request most recent head 105c1a6. Consider uploading reports for the commit 105c1a6 to get more accurate results

Impacted file tree graph

@@           Coverage Diff           @@
##             main    #2387   +/-   ##
=======================================
  Coverage   87.43%   87.43%           
=======================================
  Files         199      199           
  Lines        6030     6030           
=======================================
  Hits         5272     5272           
  Misses        758      758           
Files Coverage Δ
...entelemetry/sdk/metrics/view/instrument_selector.h 100.00% <ø> (ø)
...de/opentelemetry/sdk/metrics/view/meter_selector.h 100.00% <100.00%> (ø)

Copy link
Member

@marcalff marcalff left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the analysis and fix, see comments.

ext/src/dll/CMakeLists.txt Outdated Show resolved Hide resolved
ext/src/dll/opentelemetry_cpp.src Outdated Show resolved Hide resolved
Signed-off-by: Harish Shan <140232061+perhapsmaple@users.noreply.github.com>
Copy link
Member

@marcalff marcalff left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks for the fix.

Waiting for approval from @ThomsonTan who owns this area.

@lalitb
Copy link
Member

lalitb commented Oct 30, 2023

I think it is better to change the MeterSelector (and so also MeterSelectorFactory) to take const std::string & instead of nostd::string_view for name, version and schema. There is no reason to use nostd::string_view in SDK surface, as we don't guarantee ABI stability there. And so just maintain single export definitions for DLL.

Edit - Same for InstrumentSelector.

lalitb
lalitb previously requested changes Oct 30, 2023
@marcalff
Copy link
Member

I think it is better to change the MeterSelector (and so also MeterSelectorFactory) to take const std::string & instead of nostd::string_view for name, version and schema. There is no reason to use nostd::string_view in SDK surface, as we don't guarantee ABI stability there. And so just maintain single export definitions for DLL.

Edit - Same for InstrumentSelector.

Thanks @lalitb

Agreed, this is a much better solution.

@marcalff marcalff self-requested a review October 30, 2023 15:55
Copy link
Member

@marcalff marcalff left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Per @lalitb findings, opentelemetry-cpp needs to cleanup the SDK exposed interface instead, to not use nostd::string_view.

ext/src/dll/CMakeLists.txt Outdated Show resolved Hide resolved
…d of nostd::string_view

Signed-off-by: Harish Shan <140232061+perhapsmaple@users.noreply.github.com>
Signed-off-by: Harish Shan <140232061+perhapsmaple@users.noreply.github.com>
Copy link
Member

@marcalff marcalff left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Excellent, thanks for revising the patch.

Please add a section in the CHANGELOG, for breaking changes,
listing the APIs affected by the change to const std::string&.

@@ -5,7 +5,6 @@

#include <memory>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need the string header as well ?
Same for every header file touched.

Copy link
Member

@lalitb lalitb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks. LGTM once the string header is included in modified header files.

Signed-off-by: Harish Shan <140232061+perhapsmaple@users.noreply.github.com>
Signed-off-by: Harish Shan <140232061+perhapsmaple@users.noreply.github.com>
@lalitb lalitb merged commit ca08c5a into open-telemetry:main Nov 1, 2023
44 checks passed
@perhapsmaple perhapsmaple deleted the stl_dll_fix branch February 11, 2024 17:16
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.

[BUILD] Link failure using x64 Windows DLL
4 participants