Skip to content

[llvm] annotate interfaces in llvm/DWARFLinker and llvm/DWP for DLL export #140782

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

Merged
merged 3 commits into from
May 28, 2025

Conversation

andrurogerz
Copy link
Contributor

@andrurogerz andrurogerz commented May 20, 2025

Purpose

This patch is one in a series of code-mods that annotate LLVM’s public interface for export. This patch annotates the llvm/DWARFLinker and llvm/DWP libraries. These annotations currently have no meaningful impact on the LLVM build; however, they are a prerequisite to support an LLVM Windows DLL (shared library) build.

Background

This effort is tracked in #109483. Additional context is provided in this discourse, and documentation for LLVM_ABI and related annotations is found in the LLVM repo here.

These changes were generated automatically using the Interface Definition Scanner (IDS) tool, followed formatting with git clang-format.

Validation

Local builds and tests to validate cross-platform compatibility. This included llvm, clang, and lldb on the following configurations:

  • Windows with MSVC
  • Windows with Clang
  • Linux with GCC
  • Linux with Clang
  • Darwin with Clang

@andrurogerz andrurogerz marked this pull request as ready for review May 20, 2025 19:20
@andrurogerz andrurogerz requested a review from JDevlieghere as a code owner May 20, 2025 19:20
@andrurogerz andrurogerz changed the title [llvm] annotate interfaces in llvm/DWARFLinker, llvm/DWP, and llvm/Demangle for DLL export #140778 [llvm] annotate interfaces in llvm/DWARFLinker, llvm/DWP, and llvm/Demangle for DLL export May 20, 2025
@andrurogerz andrurogerz force-pushed the llvmdll-lib-DWARFLinker branch from f3bab7e to 9f1db78 Compare May 27, 2025 15:19
@nikic nikic requested a review from a team May 27, 2025 20:31
Copy link
Contributor

@nikic nikic left a comment

Choose a reason for hiding this comment

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

I believe the Demangle library is special, and must not have dependencies on other libraries, including Support. The libcxxabi folks can probably comment in more detail on what to do here.

@compnerd
Copy link
Member

I believe the Demangle library is special, and must not have dependencies on other libraries, including Support. The libcxxabi folks can probably comment in more detail on what to do here.

That is perfectly fine. We just need to introduce a new header and macro - Demangle_ABI that would isolate the library as a standalone entity. This would also allow controlling the static/dynamic nature of LLVMDemangle separately from the rest of LLVM.

@andrurogerz andrurogerz force-pushed the llvmdll-lib-DWARFLinker branch from 9f1db78 to 96cb23f Compare May 27, 2025 21:02
@andrurogerz andrurogerz changed the title [llvm] annotate interfaces in llvm/DWARFLinker, llvm/DWP, and llvm/Demangle for DLL export [llvm] annotate interfaces in llvm/DWARFLinker and llvm/DWP for DLL export May 27, 2025
@andrurogerz
Copy link
Contributor Author

I believe the Demangle library is special, and must not have dependencies on other libraries, including Support. The libcxxabi folks can probably comment in more detail on what to do here.

I removed the llvm/Demangle files from the patch and will do as @compnerd suggested in a separate change.

@compnerd compnerd merged commit 1610d41 into llvm:main May 28, 2025
11 checks passed
sivan-shani pushed a commit to sivan-shani/llvm-project that referenced this pull request Jun 3, 2025
…xport (llvm#140782)

## Purpose

This patch is one in a series of code-mods that annotate LLVM’s public
interface for export. This patch annotates the `llvm/DWARFLinker` and
`llvm/DWP` libraries. These annotations currently have no meaningful
impact on the LLVM build; however, they are a prerequisite to support an
LLVM Windows DLL (shared library) build.

## Background

This effort is tracked in llvm#109483. Additional context is provided in
[this
discourse](https://discourse.llvm.org/t/psa-annotating-llvm-public-interface/85307),
and documentation for `LLVM_ABI` and related annotations is found in the
LLVM repo
[here](https://github.com/llvm/llvm-project/blob/main/llvm/docs/InterfaceExportAnnotations.rst).

These changes were generated automatically using the [Interface
Definition Scanner (IDS)](https://github.com/compnerd/ids) tool,
followed formatting with `git clang-format`.

## Validation

Local builds and tests to validate cross-platform compatibility. This
included llvm, clang, and lldb on the following configurations:

- Windows with MSVC
- Windows with Clang
- Linux with GCC
- Linux with Clang
- Darwin with Clang
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.

3 participants